OrgZephyr/zephyr
OrgZephyr
/
zephyr
mirror of https://github.com/zephyrproject-rtos/zephyr.git
1
0
Fork 0
Code Issues Releases Wiki Activity
zephyr/samples/subsys/zbus/hello_world/README.rst

51 lines
1.4 KiB
ReStructuredText
Raw Normal View History

doc: zbus: samples: Use new Sphinx extension to document samples Use the new code-sample directive and roles to document the zbus samples so that they show up as "Related samples" when browsing zbus API. Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2023-09-07 01:35:31 +08:00
.. zephyr:code-sample:: zbus-hello-world
:name: zbus Hello World
:relevant-api: zbus_apis
samples: zbus: Add the hello world sample to zbus The hello world sample illustrates a simple way of using zbus. There is a listener and a subscriber interacting each other by using a read-only and a regular channel. The APIs are called by using the function and macro variation. Signed-off-by: Rodrigo Peixoto <rodrigopex@gmail.com>
2022-08-01 03:40:51 +08:00
doc: zbus: samples: Use new Sphinx extension to document samples Use the new code-sample directive and roles to document the zbus samples so that they show up as "Related samples" when browsing zbus API. Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2023-09-07 01:35:31 +08:00
Make three threads talk to each other using zbus.
samples: zbus: Add the hello world sample to zbus The hello world sample illustrates a simple way of using zbus. There is a listener and a subscriber interacting each other by using a read-only and a regular channel. The APIs are called by using the function and macro variation. Signed-off-by: Rodrigo Peixoto <rodrigopex@gmail.com>
2022-08-01 03:40:51 +08:00
Overview
********
This sample implements a simple hello world application using zbus to make the threads talk to each other.
Building and Running
********************
This project outputs to the console. It can be built and executed
on QEMU as follows:
.. zephyr-app-commands::
:zephyr-app: samples/subsys/zbus/hello_world
:host-os: unix
:board: qemu_x86
:goals: run
Sample Output
=============
.. code-block:: console
D: Sensor sample started raw reading, version 0.1-2!
D: Channel list:
D: 0 - Channel acc_data:
D: Message size: 12
D: Observers:
D: - my_listener
D: - my_subscriber
D: 1 - Channel version:
D: Message size: 4
D: Observers:
D: Observers list:
D: 0 - Listener my_listener
D: 1 - Subscriber my_subscriber
D: START processing channel acc_data change
D: From listener -> Acc x=1, y=1, z=1
D: FINISH processing channel acc_data change
D: From subscriber -> Acc x=1, y=1, z=1
D: START processing channel acc_data change
D: From listener -> Acc x=2, y=2, z=2
D: FINISH processing channel acc_data change
D: From subscriber -> Acc x=2, y=2, z=2
Exit QEMU by pressing :kbd:`CTRL+A` :kbd:`x`.