Skip to content
Snippets Groups Projects
Commit 021448c3 authored by schneider's avatar schneider
Browse files

doc(bsec): Better linking

parent 9e807b8d
No related branches found
No related tags found
1 merge request!380BSEC support
......@@ -57,7 +57,7 @@ Option name Type Description
------------------ ---------- -----------
``retrigger_ms`` Integer Defines the timespan for repeating key presses when a key is hold in milliseconds.
------------------ ---------- -----------
``bsec_enable`` Boolean Activate the Bosch :ref:`BSEC` binary blob to compute an Indoor Air Quality indication.
``bsec_enable`` Boolean Activate the Bosch :ref:`bsec_api` binary blob to compute an Indoor Air Quality indication.
------------------ ---------- -----------
``bsec_debug`` Boolean Turn on debug output of the BSEC system. Prints each meaurement on the console.
------------------ ---------- -----------
......
......@@ -919,6 +919,19 @@ API(API_BME680_GET_DATA, int epic_bme680_read_sensors(
struct bme680_sensor_data *data
));
/**
* .. _bsec_api:
*
* BSEC
* ----
* The Bosch BSEC libary allows to compute an indoor air
* qualtiy (IAQ) metric as well as CO2 and VOC content
* equivalents using the gas sensor of the BME680.
*
* As it is a proprietary binary blob, it has to be enabled using
* the ``bsec_enabled`` configuration option (see :ref:`card10_cfg`).
*/
/**
* BSEC Sensor Data
*/
......@@ -1001,15 +1014,10 @@ struct bsec_sensor_data {
/**
*
* .. _BSEC:
* Get the current BME680 data filtered by Bosch BSEC library
*
* The Bosch BSEC libary allows to compute an indoor air
* qualtiy (IAQ)metric as well as CO2 and VOC content
* equivalents using the gas sensor of the BME680.
*
* As it is a proprietary binary blob, it has to be enabled using
* the ``bsec_enabled`` configuration option (see <link to config>).
* the ``bsec_enabled`` configuration option (see :ref:`card10_cfg`).
*
* The sample rate is currently fixed to one sample every 3 seconds.
* Querying the sensor more often will return cached data.
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment