Skip to content

Commit 1dd1b35

Browse files
aviscontikartben
authored andcommitted
samples/sensor: stream_fifo: fix documentation
Add some info and sensortile_box_pro board description in README file. Signed-off-by: Armando Visconti <[email protected]>
1 parent 7b0e431 commit 1dd1b35

File tree

1 file changed

+12
-3
lines changed

1 file changed

+12
-3
lines changed

samples/sensor/stream_fifo/README.rst

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,8 @@
88
Overview
99
********
1010

11-
This sample application demonstrates how to stream FIFO data using the :ref:`RTIO framework <rtio>`.
11+
This sample application demonstrates how to stream FIFO data using the
12+
:ref:`RTIO framework <rtio>` based :ref:`Read and Decode method <sensor-read-and-decode>`.
1213

1314
The streaming is started using the sensor_stream() API and it is self-sustained by the
1415
SENSOR_TRIG_FIFO_WATERMARK trigger.
@@ -39,8 +40,16 @@ to be aliased as :samp:`stream{N}` where ``N`` goes from ``0`` to ``9``. For exa
3940
.. note::
4041
Note that NUM_SENSORS defined in main.c must match ``N`` and should be set accordingly.
4142

42-
Example devicetree overlays and configurations are already available for nucleo_f401re and
43-
nucleo_h503rb in the boards directory:
43+
Example devicetree overlays and configurations are already available for sensortile_box_pro,
44+
nucleo_f401re and nucleo_h503rb in the boards directory:
45+
46+
- :zephyr_file:`samples/sensor/stream_fifo/boards/sensortile_box_pro.overlay`
47+
48+
DT overlay file for the sensortile_box_pro board.
49+
50+
- :zephyr_file:`samples/sensor/stream_fifo/boards/sensortile_box_pro.conf`
51+
52+
Configuration file for the sensortile_box_pro board.
4453

4554
- :zephyr_file:`samples/sensor/stream_fifo/boards/nucleo_f401re.overlay`
4655

0 commit comments

Comments
 (0)