michaelh/zephyr
1
0
Fork 0
Code Releases Activity

doc: sensing: fix structure and remove top doxygen reference

Browse source 
Move sections out of the Overview section and put API documentation in
one section without bullets, which was causing duplication in headers
and text.

This also fixes the issue with PDF generation which is currently
blocking publication of HTML pages on docs.zephyrproject.org.

Signed-off-by: Anas Nashif <anas.nashif@intel.com>
This commit is contained in:
Anas Nashif 2023-06-19 19:35:22 -04:00
commit 9fd9c9dd4f
1 changed files with 10 additions and 32 deletions
Download patch file Download diff file Expand all files Collapse all files

42
doc/services/sensing/index.rst
View file

@ -52,7 +52,7 @@ The diagram below illustrates how the Sensing Subsystem integrates with up-layer
:alt: Unified Zephyr sensing architecture. :alt: Unified Zephyr sensing architecture.
Configurability Configurability
=============== ***************
* Reusable and configurable standalone subsystem. * Reusable and configurable standalone subsystem.
* Based on Zephyr existing low-level Sensor API (reuse 100+ existing sensor device drivers) * Based on Zephyr existing low-level Sensor API (reuse 100+ existing sensor device drivers)
@ -62,7 +62,7 @@ Configurability
protocols (MQTT, HID or Private, all configurable) protocols (MQTT, HID or Private, all configurable)
Main Features Main Features
============= *************
* Scope * Scope
* Focus on framework for sensor fusion, multiple clients, arbitration, data sampling, timing * Focus on framework for sensor fusion, multiple clients, arbitration, data sampling, timing
@ -84,28 +84,6 @@ Main Features
* Configurable Via Device Tree * Configurable Via Device Tree
API Design
**********
API Organization
================
* Sensing Subsystem
* Sensor Types
.. doxygengroup:: sensing_sensor_types
* Data Types
.. doxygengroup:: sensing_datatypes
* Sensing Subsystem API
.. doxygengroup:: sensing_api
* Sensing Sensor API
.. doxygengroup:: sensing_sensor
Below diagram shows the API position and scope: Below diagram shows the API position and scope:
@ -118,7 +96,7 @@ Below diagram shows the API position and scope:
Major Flows Major Flows
========================= ***********
* Sensor Configuration Flow * Sensor Configuration Flow
@ -133,7 +111,7 @@ Major Flows
:alt: Sensor Data Flow (App receive hinge angel data through data event callback example). :alt: Sensor Data Flow (App receive hinge angel data through data event callback example).
Sensor Types And Instance Sensor Types And Instance
========================= *************************
The ``Sensing Subsystem`` supports multiple instances of the same sensor type, The ``Sensing Subsystem`` supports multiple instances of the same sensor type,
there're two methods for Applications to identify and open an unique sensor instance: there're two methods for Applications to identify and open an unique sensor instance:
@ -171,7 +149,7 @@ sensor(s).
See :zephyr_file:`include/zephyr/sensing/sensing_sensor_types.h` See :zephyr_file:`include/zephyr/sensing/sensing_sensor_types.h`
Sensor Instance Handler Sensor Instance Handler
========================= ***********************
Clients using a :c:type:`sensing_sensor_handle_t` type handler to handle a opened sensor Clients using a :c:type:`sensing_sensor_handle_t` type handler to handle a opened sensor
instance, and all subsequent operations on this sensor instance need use this handler, instance, and all subsequent operations on this sensor instance need use this handler,
@ -201,7 +179,7 @@ to it's reporter sensors.
Application(s) need to call :c:func:`sensing_open_sensor` to explicitly open the sensor instance. Application(s) need to call :c:func:`sensing_open_sensor` to explicitly open the sensor instance.
Sensor Sample Value Sensor Sample Value
================================== *******************
* Data Structure * Data Structure
@ -268,7 +246,7 @@ See the example :zephyr_file:`samples/subsys/sensing/simple/boards/native_posix.
API Reference API Reference
************* *************
Sensing .. doxygengroup:: sensing_sensor_types
======== .. doxygengroup:: sensing_datatypes
.. doxygengroup:: sensing_api
.. doxygengroup:: sensing .. doxygengroup:: sensing_sensor