zephyr

History

Henrik Brix Andersen c817a09b0a canbus: rename zephyr,can-primary chosen property to zephyr,canbus Rename the Zephyr chosen property for specifying the default CAN bus controller from "zephyr,can-primary" to "zephyr,canbus". The "zephyr,can-primary" property name was selected in antipation of adding support for redundant CAN networks, which we have yet to add. Meanwhile, the "primary" term causes confusion for non-redundant CAN bus configurations (and the "can" term doesn't match the name of the Zephyr CAN bus subsystem). The CAN in Automation (CiA) 302-6, which deals with CANopen network redundancy, uses the terms "default interface" and "redundant interface". If/when we add support for redundant CAN networks, the "zephyr,canbus" chosen property can be supplemented with a "zephyr,canbus-redundant" chosen property. Signed-off-by: Henrik Brix Andersen <hebad@vestas.com>		2021-11-07 09:05:39 -05:00
..
boards	samples: can: devicetree cleanups	2021-05-05 20:46:43 +02:00
src	canbus: rename zephyr,can-primary chosen property to zephyr,canbus	2021-11-07 09:05:39 -05:00
CMakeLists.txt	cmake: increase minimal required version to 3.20.0	2021-08-20 09:47:34 +02:00
Kconfig
prj.conf	samples: can: shell send fix	2021-03-17 11:25:50 +01:00
README.rst	doc: can: fix build commands	2021-05-25 09:40:27 -04:00
sample.yaml

README.rst

.. _can-sample:

Controller Area Network
#######################

Overview
********

This sample demonstrates how to use the Controller Area Network (CAN) API.
Messages with standard and extended identifiers are sent over the bus.
Messages are received using message-queues and work-queues.
Reception is indicated by blinking the LED (if present) and output to the console.

Building and Running
********************

In loopback mode, the board receives its own messages. This could be used for
standalone testing.

The LED output pin is defined in the board's devicetree.

The sample can be built and executed for boards with a SoC that have an
integrated CAN controller or for boards with a SoC that has been augmented
with a stand alone CAN controller.

Integrated CAN controller
=========================

For the NXP TWR-KE18F board:

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

Stand alone CAN controller
==========================

For the nrf52dk_nrf52832 board combined with the DFRobot CAN bus V2.0 shield that
provides the MCP2515 CAN controller:

.. zephyr-app-commands::
   :zephyr-app: samples/drivers/can
   :board: nrf52dk_nrf52832
   :shield: dfrobot_can_bus_v2_0
   :goals: build flash

Sample output
=============

.. code-block:: console

   Change LED filter ID: 0
   Finished init.
   Counter filter id: 4

   uart:~$ Counter received: 0
   Counter received: 1
   Counter received: 2
   Counter received: 3

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