zephyr

History

Fabio Baltieri 5c32300861 yamllint: fix all yamllint truthy errors Fix all thruthy errors detected by yamllint: yamllint -f parsable -c .yamllint $( find -regex '.\.y[a]ml' ) \| \ grep '(truthy)' This only accepts true/false for boolean properties. Seems like python takes all sort of formats: https://github.com/yaml/pyyaml/blob/master/lib/yaml/constructor.py#L224-L235 But the current specs only mention "true" or "false" https://yaml.org/spec/1.2.2/#10212-boolean Which is the standard yamllint config. Excluding codeconv and workflow files, as some are using yes/no instead in the respective documentation. Signed-off-by: Fabio Baltieri <fabiobaltieri@google.com>		2023-01-04 01:16:45 +09:00
..
boards	boards: posix: native_posix: enable can_loopback0 by default	2022-10-03 10:17:12 +02:00
src	drivers: can: use flags fields for can_frame and can_filter structs	2022-10-25 16:32:10 +02:00
CMakeLists.txt
Kconfig
prj.conf	samples: net: sockets: can: add console harness configuration	2022-07-19 10:31:10 +02:00
README.rst
sample.yaml	yamllint: fix all yamllint truthy errors	2023-01-04 01:16:45 +09:00

README.rst

.. _socket-can-sample:

Socket CAN
##########

Overview
********

The socket CAN sample is a server/client application that sends and receives
raw CAN frames using BSD socket API.

The application consists of these functions:

* Setup function which creates a CAN socket, binds it to a CAN network
  interface, and then installs a CAN filter to the socket so that the
  application can receive CAN frames.
* Receive function which starts to listen the CAN socket and prints
  information about the CAN frames.
* Send function which starts to send raw CAN frames to the bus.

The source code for this sample application can be found at:
:zephyr_file:`samples/net/sockets/can`.

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

You need a CANBUS enabled board like :ref:`nucleo_l432kc_board` or
:ref:`stm32f072b_disco_board`.

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

Build the socket CAN sample application like this:

.. zephyr-app-commands::
   :zephyr-app: samples/net/sockets/can
   :board: <board to use>
   :conf: <config file to use>
   :goals: build
   :compact:

Example building for the nucleo_l432kc:

.. zephyr-app-commands::
   :zephyr-app: samples/net/sockets/can
   :host-os: unix
   :board: nucleo_l432kc
   :goals: run
   :compact: