zephyr/samples/subsys/canbus/isotp
Gerard Marull-Paretas 79e6b0e0f6 includes: prefer <zephyr/kernel.h> over <zephyr/zephyr.h>
As of today <zephyr/zephyr.h> is 100% equivalent to <zephyr/kernel.h>.
This patch proposes to then include <zephyr/kernel.h> instead of
<zephyr/zephyr.h> since it is more clear that you are including the
Kernel APIs and (probably) nothing else. <zephyr/zephyr.h> sounds like a
catch-all header that may be confusing. Most applications need to
include a bunch of other things to compile, e.g. driver headers or
subsystem headers like BT, logging, etc.

The idea of a catch-all header in Zephyr is probably not feasible
anyway. Reason is that Zephyr is not a library, like it could be for
example `libpython`. Zephyr provides many utilities nowadays: a kernel,
drivers, subsystems, etc and things will likely grow. A catch-all header
would be massive, difficult to keep up-to-date. It is also likely that
an application will only build a small subset. Note that subsystem-level
headers may use a catch-all approach to make things easier, though.

NOTE: This patch is **NOT** removing the header, just removing its usage
in-tree. I'd advocate for its deprecation (add a #warning on it), but I
understand many people will have concerns.

Signed-off-by: Gerard Marull-Paretas <gerard.marull@nordicsemi.no>
2022-09-05 16:31:47 +02:00
..
src
CMakeLists.txt
README.rst
prj.conf
sample.yaml

README.rst

.. _isotp-sample:

ISO-TP library
##############

Overview
********
This sample demonstrates how to use the ISO-TP library.
Messages are exchanged between two boards. A long message, that is sent with
a block-size (BS) of eight frames, and a short one that has an minimal
separation-time (STmin) of five milliseconds.
The send function call for the short message is non-blocking, and the send
function call for the long message is blocking.

Building and Running
********************
Use these instructions with integrated CAN controller like in the NXP TWR-KE18F
or Nucleo-F746ZG board.

For the NXP TWR-KE18F board:

.. zephyr-app-commands::
   :zephyr-app: samples/drivers/can
   :board: twr_ke18f
   :goals: build flash

Requirements
************

* Two boards with CAN bus support, connected together

Sample output
=============
.. code-block:: console

    Start sending data
    [00:00:00.000,000] <inf> can_driver: Init of CAN_1 done
    ========================================
    |   ____  ___  ____       ____  ____   |
    |  |_  _|/ __||    | ___ |_  _||  _ \  |
    |   _||_ \__ \| || | ___   ||  | ___/  |
    |  |____||___/|____|       ||  |_|     |
    ========================================
    Got 248 bytes in total
    This is the sample test for the short payload
    TX complete cb [0]

.. note:: The values shown above might differ.