Aksal/nuttx
3
1
Fork 1
mirror of https://github.com/apache/nuttx.git synced 2026-08-01 20:28:58 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

docs/baromonitor: Add some documentation about the baromonitor example

Browse source 
Documents how to use the baromonitor example, shows its visualization
and explains its default behaviour.

Signed-off-by: Matteo Golin <matteo.golin@gmail.com>
This commit is contained in:
Matteo Golin 2026-07-19 09:48:20 -04:00 • committed by Alan C. Assis
parent 981ef0f1a7
commit a62f4b42aa
2 changed files with 28 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

BIN
Documentation/applications/examples/baromonitor/baromonitor.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 90 KiB

28
Documentation/applications/examples/baromonitor/index.rst Normal file
View file

@ -0,0 +1,28 @@
===========================================
``baromonitor`` Barometer Dashboard Example
===========================================
This example is used to demonstrate a practical use case for an LVGL application
on NuttX. It subscribes to a barometer sensor topic and displays the pressure
and temperature information on animated gauges.
.. figure:: baromonitor.png
:figwidth: 70%
:align: center
:alt: The barometer dashboard in action
The barometer dashboard in action
To use the barometer dashboard, just ensure there is a ``sensor_baro`` topic
registered on the target and then run ``baromonitor``. These sensor topics are
registered by NuttX barometer sensor drivers (see
:doc:`/components/drivers/special/sensors/sensors_uorb`).
By default, the application attempts to subscribe to ``sensor_baro0``, but if
you wish to monitor a different barometer topic you can pass the instance number
as an argument (i.e. ``baromonitor 2`` subscribes to ``sensor_baro2``).
For maximum compatibility with all sensors (those that publish on their own via
interrupts/kernel threads _and_ those that only fetch data when read from), the
application takes the approach of reading sensor data in a loop at a rate
defined by ``CONFIG_EXAMPLES_BAROMONITOR_SAMPLERATE``.