README.rst
1.. zephyr:code-sample:: isotp
2 :name: ISO-TP library
3 :relevant-api: can_isotp
4
5 Use ISO-TP library to exchange messages between two boards.
6
7Overview
8********
9This sample demonstrates how to use the :ref:`ISO-TP library <can_isotp>`.
10
11Messages are exchanged between two boards. A long message, that is sent with
12a block-size (BS) of eight frames, and a short one that has a minimal
13separation-time (STmin) of five milliseconds.
14
15The send function call for the short message is non-blocking, and the send
16function call for the long message is blocking.
17
18Building and Running
19********************
20Use these instructions with integrated CAN controller like in the NXP TWR-KE18F
21or Nucleo-F746ZG board.
22
23For the NXP TWR-KE18F board:
24
25.. zephyr-app-commands::
26 :zephyr-app: samples/subsys/canbus/isotp
27 :board: twr_ke18f
28 :goals: build flash
29
30Requirements
31************
32
33* Two boards with CAN bus support, connected together
34
35Sample output
36=============
37.. code-block:: console
38
39 Start sending data
40 [00:00:00.000,000] <inf> can_driver: Init of CAN_1 done
41 ========================================
42 | ____ ___ ____ ____ ____ |
43 | |_ _|/ __|| | ___ |_ _|| _ \ |
44 | _||_ \__ \| || | ___ || | ___/ |
45 | |____||___/|____| || |_| |
46 ========================================
47 Got 248 bytes in total
48 This is the sample test for the short payload
49 TX complete cb [0]
50
51.. note:: The values shown above might differ.
52
