Skip to content

Commit 239a522

Browse files
actions-useractions-user
committed
Update documentation
1 parent 861ab62 commit 239a522

File tree

1 file changed

+102
-102
lines changed

1 file changed

+102
-102
lines changed

‎docs/api.md

Lines changed: 102 additions & 102 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,10 @@
55
`class ` [`I2CDevice`](#class_i2_c_device) | Class for interacting with I2C devices.
66
`class ` [`IndoorAirQualitySensor`](#class_indoor_air_quality_sensor) | Represents an indoor air quality sensor.
77
`class ` [`NiclaSenseEnv`](#class_nicla_sense_env) | The [NiclaSenseEnv](#class_nicla_sense_env) class represents a [NiclaSenseEnv](#class_nicla_sense_env) device.
8+
`class ` [`OrangeLED`](#class_orange_l_e_d) | Represents the orange on-board LED controlled via I2C.
89
`class ` [`OutdoorAirQualitySensor`](#class_outdoor_air_quality_sensor) | Class representing an outdoor air quality sensor (ZMOD4510)
910
`class ` [`RGBLED`](#class_r_g_b_l_e_d) | Represents the on-board RGB LED that can be controlled using I2C communication.
1011
`class ` [`TemperatureHumiditySensor`](#class_temperature_humidity_sensor) | Represents a temperature and humidity sensor.
11-
`class ` [`WhiteLED`](#class_white_l_e_d) | Represents the white on-board LED controlled via I2C.
1212
`struct ` [`Color`](#struct_color) | Represents a color with red, green, and blue components.
1313
`struct ` [`RegisterInfo`](#struct_register_info) | Structure representing information about a register.
1414

@@ -335,7 +335,7 @@ This class provides methods to interact with the device to enable and disable fe
335335
| [`indoorAirQualitySensor`](#class_nicla_sense_env_1a4c36a3cc7c0dc351a720fe3bd8ce2ede) | Returns the [IndoorAirQualitySensor](#class_indoor_air_quality_sensor) object to interact with the indoor air quality sensor. |
336336
| [`outdoorAirQualitySensor`](#class_nicla_sense_env_1a13c8a3127acea0364f1e771a49ad89d6) | Returns the [OutdoorAirQualitySensor](#class_outdoor_air_quality_sensor) object to interact with the outdoor air quality sensor. |
337337
| [`rgbLED`](#class_nicla_sense_env_1aea2da7e61de2736756eba56b417eaa0b) | Returns the [RGBLED](#class_r_g_b_l_e_d) object to interact with the RGB LED. |
338-
| [`whiteLED`](#class_nicla_sense_env_1a1af09dea01d88457cb8cb68ba200254f) | Returns a reference to the [WhiteLED](#class_white_l_e_d) object to interact with the white LED. |
338+
| [`orangeLED`](#class_nicla_sense_env_1a7938bdcc03918a9900538373e0c02156) | Returns a reference to the [OrangeLED](#class_orange_l_e_d) object to interact with the orange LED. |
339339
| [`end`](#class_nicla_sense_env_1abba16f72b55ddfd648c8cde348eb6338) | Ends the operation of the [NiclaSenseEnv](#class_nicla_sense_env) class. |
340340
| [`storeSettingsInFlash`](#class_nicla_sense_env_1a907e93c5063c85f3d686fe87a0b1218b) | Writes the current configuration to the flash memory. Stores board register 0x00 … 0x0B in flash to be default after reset. |
341341
| [`serialNumber`](#class_nicla_sense_env_1a8c580892d180c058380e6e497b36230a) | Retrieves the serial number of the device. |
@@ -440,16 +440,16 @@ Returns the [RGBLED](#class_r_g_b_l_e_d) object to interact with the RGB LED.
440440
[RGBLED](#class_r_g_b_l_e_d)& The reference to the [RGBLED](#class_r_g_b_l_e_d) object.
441441
<hr />
442442

443-
### `whiteLED` <a id="class_nicla_sense_env_1a1af09dea01d88457cb8cb68ba200254f" class="anchor"></a>
443+
### `orangeLED` <a id="class_nicla_sense_env_1a7938bdcc03918a9900538373e0c02156" class="anchor"></a>
444444

445445
```cpp
446-
WhiteLED & whiteLED()
446+
OrangeLED & orangeLED()
447447
```
448448

449-
Returns a reference to the [WhiteLED](#class_white_l_e_d) object to interact with the white LED.
449+
Returns a reference to the [OrangeLED](#class_orange_l_e_d) object to interact with the orange LED.
450450

451451
#### Returns
452-
[WhiteLED](#class_white_l_e_d)& Reference to the [WhiteLED](#class_white_l_e_d) object.
452+
[OrangeLED](#class_orange_l_e_d)& Reference to the [OrangeLED](#class_orange_l_e_d) object.
453453
<hr />
454454

455455
### `end` <a id="class_nicla_sense_env_1abba16f72b55ddfd648c8cde348eb6338" class="anchor"></a>
@@ -489,9 +489,9 @@ This affects the following properties:
489489

490490
* Temperature sensor enabled
491491

492-
* White LED brightness
492+
* Orange LED brightness
493493

494-
* White LED error status enabled
494+
* Orange LED error status enabled
495495

496496
* RGB LED brightness
497497

@@ -682,6 +682,100 @@ Sets the I2C address of the device. Call [storeSettingsInFlash()](#class_nicla_s
682682
* `address` The new I2C address. Valid values are 0 to 127.
683683
<hr />
684684

685+
# class `OrangeLED` <a id="class_orange_l_e_d" class="anchor"></a>
686+
687+
```cpp
688+
class OrangeLED
689+
: public I2CDevice
690+
```
691+
692+
Represents the orange on-board LED controlled via I2C.
693+
694+
The [OrangeLED](#class_orange_l_e_d) class provides methods to control the brightness and error status of the orange LED. It inherits from the [I2CDevice](#class_i2_c_device) class.
695+
696+
## Summary
697+
698+
Members | Descriptions
699+
--------------------------------|---------------------------------------------
700+
| [`OrangeLED`](#class_orange_l_e_d_1af92a1e92f3505ff5cc30b364e142a710) | Constructs a [OrangeLED](#class_orange_l_e_d) object. |
701+
| [`OrangeLED`](#class_orange_l_e_d_1a31e760ce8acade6fdb3d42f4c0e2d9cd) | Constructs a [OrangeLED](#class_orange_l_e_d) object with the specified device address. |
702+
| [`brightness`](#class_orange_l_e_d_1a62c8337f91700b78fdfaba6ab401d080) | Gets the brightness of the orange LED. |
703+
| [`setBrightness`](#class_orange_l_e_d_1af489b380c5a3ffc78ee4754f8875edd3) | Sets the brightness of the orange LED. Call storeSettingsInFlash() on [NiclaSenseEnv](#class_nicla_sense_env) instance after changing the orange LED brightness to make the change persistent. |
704+
| [`errorStatusEnabled`](#class_orange_l_e_d_1a01b9f52a9cc4490df7ed2e0e59f17b71) | Determines whether the orange LED is used to indicate an error status of one of the sensors. |
705+
| [`setErrorStatusEnabled`](#class_orange_l_e_d_1aac531fa45b968ca6662b3dc6f698065a) | Enables or disables the orange LED to indicate an error status of one of the sensors. Call storeSettingsInFlash() on [NiclaSenseEnv](#class_nicla_sense_env) instance after enabling/disabling the orange LED error status to make the change persistent. |
706+
707+
## Members
708+
709+
### `OrangeLED` <a id="class_orange_l_e_d_1af92a1e92f3505ff5cc30b364e142a710" class="anchor"></a>
710+
711+
```cpp
712+
OrangeLED(TwoWire & bus, uint8_t deviceAddress)
713+
```
714+
715+
Constructs a [OrangeLED](#class_orange_l_e_d) object.
716+
717+
#### Parameters
718+
* `bus` The I2C bus to use (default is Wire).
719+
720+
* `deviceAddress` The I2C device address (default is 0x21).
721+
<hr />
722+
723+
### `OrangeLED` <a id="class_orange_l_e_d_1a31e760ce8acade6fdb3d42f4c0e2d9cd" class="anchor"></a>
724+
725+
```cpp
726+
OrangeLED(uint8_t deviceAddress)
727+
```
728+
729+
Constructs a [OrangeLED](#class_orange_l_e_d) object with the specified device address.
730+
731+
#### Parameters
732+
* `deviceAddress` The I2C address of the [OrangeLED](#class_orange_l_e_d) device.
733+
<hr />
734+
735+
### `brightness` <a id="class_orange_l_e_d_1a62c8337f91700b78fdfaba6ab401d080" class="anchor"></a>
736+
737+
```cpp
738+
uint8_t brightness()
739+
```
740+
741+
Gets the brightness of the orange LED.
742+
#### Returns
743+
The brightness of the orange LED. Range is 0 to 63.
744+
<hr />
745+
746+
### `setBrightness` <a id="class_orange_l_e_d_1af489b380c5a3ffc78ee4754f8875edd3" class="anchor"></a>
747+
748+
```cpp
749+
void setBrightness(uint8_t brightness)
750+
```
751+
752+
Sets the brightness of the orange LED. Call storeSettingsInFlash() on [NiclaSenseEnv](#class_nicla_sense_env) instance after changing the orange LED brightness to make the change persistent.
753+
#### Parameters
754+
* `brightness` : The brightness of the orange LED. Range is 0 to 63.
755+
<hr />
756+
757+
### `errorStatusEnabled` <a id="class_orange_l_e_d_1a01b9f52a9cc4490df7ed2e0e59f17b71" class="anchor"></a>
758+
759+
```cpp
760+
bool errorStatusEnabled()
761+
```
762+
763+
Determines whether the orange LED is used to indicate an error status of one of the sensors.
764+
#### Returns
765+
True if the orange LED is used for error status, false otherwise.
766+
<hr />
767+
768+
### `setErrorStatusEnabled` <a id="class_orange_l_e_d_1aac531fa45b968ca6662b3dc6f698065a" class="anchor"></a>
769+
770+
```cpp
771+
void setErrorStatusEnabled(bool enabled)
772+
```
773+
774+
Enables or disables the orange LED to indicate an error status of one of the sensors. Call storeSettingsInFlash() on [NiclaSenseEnv](#class_nicla_sense_env) instance after enabling/disabling the orange LED error status to make the change persistent.
775+
#### Parameters
776+
* `enabled` : Whether to enable or disable the orange LED error status.
777+
<hr />
778+
685779
# class `OutdoorAirQualitySensor` <a id="class_outdoor_air_quality_sensor" class="anchor"></a>
686780
687781
```cpp
@@ -1131,100 +1225,6 @@ Sets the enabled state of the temperature and humidity sensor. When disabled the
11311225
* `enabled` The desired enabled state. True to enable the sensor, false to disable it.
11321226
<hr />
11331227
1134-
# class `WhiteLED` <a id="class_white_l_e_d" class="anchor"></a>
1135-
1136-
```cpp
1137-
class WhiteLED
1138-
: public I2CDevice
1139-
```
1140-
1141-
Represents the white on-board LED controlled via I2C.
1142-
1143-
The [WhiteLED](#class_white_l_e_d) class provides methods to control the brightness and error status of the white LED. It inherits from the [I2CDevice](#class_i2_c_device) class.
1144-
1145-
## Summary
1146-
1147-
Members | Descriptions
1148-
--------------------------------|---------------------------------------------
1149-
| [`WhiteLED`](#class_white_l_e_d_1adcf1e382e477873960da30a0bb400ad6) | Constructs a [WhiteLED](#class_white_l_e_d) object. |
1150-
| [`WhiteLED`](#class_white_l_e_d_1a1dc4ba991f873c157e2f7b20184fea20) | Constructs a [WhiteLED](#class_white_l_e_d) object with the specified device address. |
1151-
| [`brightness`](#class_white_l_e_d_1a2f317399b282682c6ba4aacb81dec7d2) | Gets the brightness of the white LED. |
1152-
| [`setBrightness`](#class_white_l_e_d_1a0bb03cf87162ca9eb2ddeb502d24b77c) | Sets the brightness of the white LED. Call storeSettingsInFlash() on [NiclaSenseEnv](#class_nicla_sense_env) instance after changing the white LED brightness to make the change persistent. |
1153-
| [`errorStatusEnabled`](#class_white_l_e_d_1af45fbcf2de55ec9550c68a64203e0a2b) | Determines whether the white LED is used to indicate an error status of one of the sensors. |
1154-
| [`setErrorStatusEnabled`](#class_white_l_e_d_1a6b9457558f6fc4408a4f9f89153d1c9d) | Enables or disables the white LED to indicate an error status of one of the sensors. Call storeSettingsInFlash() on [NiclaSenseEnv](#class_nicla_sense_env) instance after enabling/disabling the white LED error status to make the change persistent. |
1155-
1156-
## Members
1157-
1158-
### `WhiteLED` <a id="class_white_l_e_d_1adcf1e382e477873960da30a0bb400ad6" class="anchor"></a>
1159-
1160-
```cpp
1161-
WhiteLED(TwoWire & bus, uint8_t deviceAddress)
1162-
```
1163-
1164-
Constructs a [WhiteLED](#class_white_l_e_d) object.
1165-
1166-
#### Parameters
1167-
* `bus` The I2C bus to use (default is Wire).
1168-
1169-
* `deviceAddress` The I2C device address (default is 0x21).
1170-
<hr />
1171-
1172-
### `WhiteLED` <a id="class_white_l_e_d_1a1dc4ba991f873c157e2f7b20184fea20" class="anchor"></a>
1173-
1174-
```cpp
1175-
WhiteLED(uint8_t deviceAddress)
1176-
```
1177-
1178-
Constructs a [WhiteLED](#class_white_l_e_d) object with the specified device address.
1179-
1180-
#### Parameters
1181-
* `deviceAddress` The I2C address of the [WhiteLED](#class_white_l_e_d) device.
1182-
<hr />
1183-
1184-
### `brightness` <a id="class_white_l_e_d_1a2f317399b282682c6ba4aacb81dec7d2" class="anchor"></a>
1185-
1186-
```cpp
1187-
uint8_t brightness()
1188-
```
1189-
1190-
Gets the brightness of the white LED.
1191-
#### Returns
1192-
The brightness of the white LED. Range is 0 to 63.
1193-
<hr />
1194-
1195-
### `setBrightness` <a id="class_white_l_e_d_1a0bb03cf87162ca9eb2ddeb502d24b77c" class="anchor"></a>
1196-
1197-
```cpp
1198-
void setBrightness(uint8_t brightness)
1199-
```
1200-
1201-
Sets the brightness of the white LED. Call storeSettingsInFlash() on [NiclaSenseEnv](#class_nicla_sense_env) instance after changing the white LED brightness to make the change persistent.
1202-
#### Parameters
1203-
* `brightness` : The brightness of the white LED. Range is 0 to 63.
1204-
<hr />
1205-
1206-
### `errorStatusEnabled` <a id="class_white_l_e_d_1af45fbcf2de55ec9550c68a64203e0a2b" class="anchor"></a>
1207-
1208-
```cpp
1209-
bool errorStatusEnabled()
1210-
```
1211-
1212-
Determines whether the white LED is used to indicate an error status of one of the sensors.
1213-
#### Returns
1214-
True if the white LED is used for error status, false otherwise.
1215-
<hr />
1216-
1217-
### `setErrorStatusEnabled` <a id="class_white_l_e_d_1a6b9457558f6fc4408a4f9f89153d1c9d" class="anchor"></a>
1218-
1219-
```cpp
1220-
void setErrorStatusEnabled(bool enabled)
1221-
```
1222-
1223-
Enables or disables the white LED to indicate an error status of one of the sensors. Call storeSettingsInFlash() on [NiclaSenseEnv](#class_nicla_sense_env) instance after enabling/disabling the white LED error status to make the change persistent.
1224-
#### Parameters
1225-
* `enabled` : Whether to enable or disable the white LED error status.
1226-
<hr />
1227-
12281228
# struct `Color` <a id="struct_color" class="anchor"></a>
12291229
12301230
Represents a color with red, green, and blue components.

0 commit comments

Comments
 (0)