diff --git a/Documentation/card10-cfg.rst b/Documentation/card10-cfg.rst index b24c7b545d60fab45272144d1c277e120b344cc3..1980f6c8c607c524f14ec0f19b365c2e052c56cf 100644 --- a/Documentation/card10-cfg.rst +++ b/Documentation/card10-cfg.rst @@ -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. ------------------ ---------- ----------- diff --git a/epicardium/epicardium.h b/epicardium/epicardium.h index 5a980443595b63e7afd7ffef266044de8c7a397e..2912e1b88d99758c4f8411ba457090b3d36ba22c 100644 --- a/epicardium/epicardium.h +++ b/epicardium/epicardium.h @@ -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.