Skip to content

Commit 7c6a6f4

Browse files
Update documentation
1 parent 0941c7f commit 7c6a6f4

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

docs/api.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -341,11 +341,11 @@ This class provides methods to interact with the device to enable and disable fe
341341
| [`NiclaSenseEnv`](#class_nicla_sense_env_1af28c5f5a56ca984525a4939b5d5287d7) | Constructs a new [NiclaSenseEnv](#class_nicla_sense_env) object. |
342342
| [`NiclaSenseEnv`](#class_nicla_sense_env_1a8b3c73e53693c753b56f1fecc3a6c484) | Constructs a new [NiclaSenseEnv](#class_nicla_sense_env) object. |
343343
| [`~NiclaSenseEnv`](#class_nicla_sense_env_1a4e86e540c8d0ab99d89dc3242029fe39) | Destroy the Nicla Sense Env object. This will call the [end()](#class_nicla_sense_env_1abba16f72b55ddfd648c8cde348eb6338) method while frees up allocated resources. |
344-
| [`temperatureHumiditySensor`](#class_nicla_sense_env_1a73d8ae251e1463315f00da6d6420b9c6) | Returns the [TemperatureHumiditySensor](#class_temperature_humidity_sensor) object to interact with the temperature and humidity sensor. |
345-
| [`indoorAirQualitySensor`](#class_nicla_sense_env_1a4c36a3cc7c0dc351a720fe3bd8ce2ede) | Returns the [IndoorAirQualitySensor](#class_indoor_air_quality_sensor) object to interact with the indoor air quality sensor. |
346-
| [`outdoorAirQualitySensor`](#class_nicla_sense_env_1a13c8a3127acea0364f1e771a49ad89d6) | Returns the [OutdoorAirQualitySensor](#class_outdoor_air_quality_sensor) object to interact with the outdoor air quality sensor. |
347-
| [`rgbLED`](#class_nicla_sense_env_1aea2da7e61de2736756eba56b417eaa0b) | Returns the [RGBLED](#class_r_g_b_l_e_d) object to interact with the RGB LED. |
348-
| [`orangeLED`](#class_nicla_sense_env_1a7938bdcc03918a9900538373e0c02156) | Returns a reference to the [OrangeLED](#class_orange_l_e_d) object to interact with the orange LED. |
344+
| [`temperatureHumiditySensor`](#class_nicla_sense_env_1aef089a2229eb0e26a06c972226b6adeb) | Returns the [TemperatureHumiditySensor](#class_temperature_humidity_sensor) object to interact with the temperature and humidity sensor. |
345+
| [`indoorAirQualitySensor`](#class_nicla_sense_env_1ac42944c69523a78572da38a86f065f57) | Returns the [IndoorAirQualitySensor](#class_indoor_air_quality_sensor) object to interact with the indoor air quality sensor. |
346+
| [`outdoorAirQualitySensor`](#class_nicla_sense_env_1a6c46868908a15f4794b5fe52cf5c1027) | Returns the [OutdoorAirQualitySensor](#class_outdoor_air_quality_sensor) object to interact with the outdoor air quality sensor. |
347+
| [`rgbLED`](#class_nicla_sense_env_1a310c7d26d0468f362d70d89953e8e445) | Returns the [RGBLED](#class_r_g_b_l_e_d) object to interact with the RGB LED. |
348+
| [`orangeLED`](#class_nicla_sense_env_1a5212ca3dd32af22c22c5302f2af33ceb) | Returns a reference to the [OrangeLED](#class_orange_l_e_d) object to interact with the orange LED. |
349349
| [`end`](#class_nicla_sense_env_1abba16f72b55ddfd648c8cde348eb6338) | Ends the operation of the [NiclaSenseEnv](#class_nicla_sense_env) class. |
350350
| [`persistSettings`](#class_nicla_sense_env_1a6f53bfdf4e8cc338b51089c393c52102) | Writes the current configuration to the flash memory. Stores board register 0x00 … 0x0B in flash to be default after reset. |
351351
| [`serialNumber`](#class_nicla_sense_env_1a8c580892d180c058380e6e497b36230a) | Retrieves the serial number of the device. |
@@ -402,7 +402,7 @@ Destroy the Nicla Sense Env object. This will call the [end()](#class_nicla_sens
402402

403403
<hr />
404404

405-
### `temperatureHumiditySensor` <a id="class_nicla_sense_env_1a73d8ae251e1463315f00da6d6420b9c6" class="anchor"></a>
405+
### `temperatureHumiditySensor` <a id="class_nicla_sense_env_1aef089a2229eb0e26a06c972226b6adeb" class="anchor"></a>
406406

407407
```cpp
408408
TemperatureHumiditySensor & temperatureHumiditySensor()
@@ -414,7 +414,7 @@ Returns the [TemperatureHumiditySensor](#class_temperature_humidity_sensor) obje
414414
The [TemperatureHumiditySensor](#class_temperature_humidity_sensor) object.
415415
<hr />
416416

417-
### `indoorAirQualitySensor` <a id="class_nicla_sense_env_1a4c36a3cc7c0dc351a720fe3bd8ce2ede" class="anchor"></a>
417+
### `indoorAirQualitySensor` <a id="class_nicla_sense_env_1ac42944c69523a78572da38a86f065f57" class="anchor"></a>
418418

419419
```cpp
420420
IndoorAirQualitySensor & indoorAirQualitySensor()
@@ -426,7 +426,7 @@ Returns the [IndoorAirQualitySensor](#class_indoor_air_quality_sensor) object to
426426
A reference to the [IndoorAirQualitySensor](#class_indoor_air_quality_sensor) object.
427427
<hr />
428428

429-
### `outdoorAirQualitySensor` <a id="class_nicla_sense_env_1a13c8a3127acea0364f1e771a49ad89d6" class="anchor"></a>
429+
### `outdoorAirQualitySensor` <a id="class_nicla_sense_env_1a6c46868908a15f4794b5fe52cf5c1027" class="anchor"></a>
430430

431431
```cpp
432432
OutdoorAirQualitySensor & outdoorAirQualitySensor()
@@ -438,7 +438,7 @@ Returns the [OutdoorAirQualitySensor](#class_outdoor_air_quality_sensor) object
438438
The [OutdoorAirQualitySensor](#class_outdoor_air_quality_sensor) object.
439439
<hr />
440440

441-
### `rgbLED` <a id="class_nicla_sense_env_1aea2da7e61de2736756eba56b417eaa0b" class="anchor"></a>
441+
### `rgbLED` <a id="class_nicla_sense_env_1a310c7d26d0468f362d70d89953e8e445" class="anchor"></a>
442442

443443
```cpp
444444
RGBLED & rgbLED()
@@ -450,7 +450,7 @@ Returns the [RGBLED](#class_r_g_b_l_e_d) object to interact with the RGB LED.
450450
[RGBLED](#class_r_g_b_l_e_d)& The reference to the [RGBLED](#class_r_g_b_l_e_d) object.
451451
<hr />
452452

453-
### `orangeLED` <a id="class_nicla_sense_env_1a7938bdcc03918a9900538373e0c02156" class="anchor"></a>
453+
### `orangeLED` <a id="class_nicla_sense_env_1a5212ca3dd32af22c22c5302f2af33ceb" class="anchor"></a>
454454

455455
```cpp
456456
OrangeLED & orangeLED()

0 commit comments

Comments
 (0)