Skip to content

Commit fc7c32b

Browse files
committed
Update documentation
1 parent cf1df34 commit fc7c32b

File tree

1 file changed

+16
-16
lines changed

1 file changed

+16
-16
lines changed

docs/api.md

+16-16
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
`class ` [`OutdoorAirQualitySensor`](#class_outdoor_air_quality_sensor) | Class representing an outdoor air quality sensor (ZMOD4510)
1010
`class ` [`RGBLED`](#class_r_g_b_l_e_d) | Represents the on-board RGB LED that can be controlled using I2C communication.
1111
`class ` [`TemperatureHumiditySensor`](#class_temperature_humidity_sensor) | Represents a temperature and humidity sensor.
12-
`struct ` [`Color`](#struct_color) | Represents a color with red, green, and blue components.
12+
`struct ` [`LEDColor`](#struct_l_e_d_color) | Represents a color with red, green, and blue components.
1313
`struct ` [`RegisterInfo`](#struct_register_info) | Structure representing information about a register.
1414

1515
# class `I2CDevice` <a id="class_i2_c_device" class="anchor"></a>
@@ -1030,8 +1030,8 @@ The [RGBLED](#class_r_g_b_l_e_d) class provides methods to control the color and
10301030
| [`RGBLED`](#class_r_g_b_l_e_d_1a350a112613fac1242743e4b1de07a057) | Initializes an instance of the [RGBLED](#class_r_g_b_l_e_d) class with the specified device address. |
10311031
| [`enableIndoorAirQualityStatus`](#class_r_g_b_l_e_d_1aa6fbd29854537566dee74d73875615c6) | Enables the indoor air quality status indicator on the RGB LED. When enabled, the RGB LED will change color based on the air quality (red = bad, green = good) |
10321032
| [`setColor`](#class_r_g_b_l_e_d_1a04058a97af30f3eb3836f7dd1eeb1c01) | Sets the RGB values of the LED. |
1033-
| [`setColor`](#class_r_g_b_l_e_d_1ac5fff451e2e16b7498917fbe02134adb) | Sets the RGB color of the LED using a [Color](#struct_color) object. The [Color](#struct_color) object contains the red, green, and blue values that can be changed individually. Note: A value of 0, 0, 0 will set the color based on the IAQ value from the Indoor Air Quality sensor. |
1034-
| [`color`](#class_r_g_b_l_e_d_1a6ce467b464540233311718ac5055e7bc) | Gets the current RGB color of the LED. |
1033+
| [`setColor`](#class_r_g_b_l_e_d_1aac7fba93bc4437940f6a525886135983) | Sets the RGB color of the LED using a [LEDColor](#struct_l_e_d_color) object. The [LEDColor](#struct_l_e_d_color) object contains the red, green, and blue values that can be changed individually. Note: A value of 0, 0, 0 will set the color based on the IAQ value from the Indoor Air Quality sensor. |
1034+
| [`color`](#class_r_g_b_l_e_d_1a0b5c265b6940d324faf112103e60e5ff) | Gets the current RGB color of the LED. |
10351035
| [`brightness`](#class_r_g_b_l_e_d_1ae0d4a3a49a797220fe19ee70e8f3ec67) | Get the brightness of the RGB LED (0-255) |
10361036
| [`setBrightness`](#class_r_g_b_l_e_d_1a72dd5b87e665205ca86de73a193ce42f) | Sets the brightness of the RGB LED. This function allows you to adjust the brightness of the RGB LED. |
10371037

@@ -1101,13 +1101,13 @@ This function sets the red, green, and blue values of the LED using individual v
11011101
True if the color was set successfully, false otherwise.
11021102
<hr />
11031103

1104-
### `setColor` <a id="class_r_g_b_l_e_d_1ac5fff451e2e16b7498917fbe02134adb" class="anchor"></a>
1104+
### `setColor` <a id="class_r_g_b_l_e_d_1aac7fba93bc4437940f6a525886135983" class="anchor"></a>
11051105

11061106
```cpp
1107-
bool setColor( Color color, bool persist)
1107+
bool setColor( LEDColor color, bool persist)
11081108
```
11091109
1110-
Sets the RGB color of the LED using a [Color](#struct_color) object. The [Color](#struct_color) object contains the red, green, and blue values that can be changed individually. Note: A value of 0, 0, 0 will set the color based on the IAQ value from the Indoor Air Quality sensor.
1110+
Sets the RGB color of the LED using a [LEDColor](#struct_l_e_d_color) object. The [LEDColor](#struct_l_e_d_color) object contains the red, green, and blue values that can be changed individually. Note: A value of 0, 0, 0 will set the color based on the IAQ value from the Indoor Air Quality sensor.
11111111
11121112
#### Parameters
11131113
* `color` The RGB color to set.
@@ -1118,16 +1118,16 @@ Sets the RGB color of the LED using a [Color](#struct_color) object. The [Color]
11181118
True if the color was set successfully, false otherwise.
11191119
<hr />
11201120
1121-
### `color` <a id="class_r_g_b_l_e_d_1a6ce467b464540233311718ac5055e7bc" class="anchor"></a>
1121+
### `color` <a id="class_r_g_b_l_e_d_1a0b5c265b6940d324faf112103e60e5ff" class="anchor"></a>
11221122
11231123
```cpp
1124-
Color color()
1124+
LEDColor color()
11251125
```
11261126

11271127
Gets the current RGB color of the LED.
11281128

11291129
#### Returns
1130-
The current RGB color as a [Color](#struct_color) object.
1130+
The current RGB color as a [LEDColor](#struct_l_e_d_color) object.
11311131
<hr />
11321132

11331133
### `brightness` <a id="class_r_g_b_l_e_d_1ae0d4a3a49a797220fe19ee70e8f3ec67" class="anchor"></a>
@@ -1262,21 +1262,21 @@ Sets the enabled state of the temperature and humidity sensor. When disabled the
12621262
true if the operation was successful, false otherwise.
12631263
<hr />
12641264
1265-
# struct `Color` <a id="struct_color" class="anchor"></a>
1265+
# struct `LEDColor` <a id="struct_l_e_d_color" class="anchor"></a>
12661266
12671267
Represents a color with red, green, and blue components.
12681268
12691269
## Summary
12701270
12711271
Members | Descriptions
12721272
--------------------------------|---------------------------------------------
1273-
| [`red`](#struct_color_1a8c55aa73e839e57527559cd732bda475) | The red component of the color. |
1274-
| [`green`](#struct_color_1a4f8414e1814c166da1859ce388149d78) | The green component of the color. |
1275-
| [`blue`](#struct_color_1acad45c325d520d1c24ea774099821c7c) | The blue component of the color. |
1273+
| [`red`](#struct_l_e_d_color_1ae7023d24a0d94b1b77a32d2f3aadd581) | The red component of the color. |
1274+
| [`green`](#struct_l_e_d_color_1a2ea3a2b138f2281a3d861e0e377dd84f) | The green component of the color. |
1275+
| [`blue`](#struct_l_e_d_color_1a4580c3efc87cb738b66e95fc7b1818db) | The blue component of the color. |
12761276
12771277
## Members
12781278
1279-
### `red` <a id="struct_color_1a8c55aa73e839e57527559cd732bda475" class="anchor"></a>
1279+
### `red` <a id="struct_l_e_d_color_1ae7023d24a0d94b1b77a32d2f3aadd581" class="anchor"></a>
12801280
12811281
```cpp
12821282
uint8_t red
@@ -1285,7 +1285,7 @@ uint8_t red
12851285
The red component of the color.
12861286
<hr />
12871287

1288-
### `green` <a id="struct_color_1a4f8414e1814c166da1859ce388149d78" class="anchor"></a>
1288+
### `green` <a id="struct_l_e_d_color_1a2ea3a2b138f2281a3d861e0e377dd84f" class="anchor"></a>
12891289

12901290
```cpp
12911291
uint8_t green
@@ -1294,7 +1294,7 @@ uint8_t green
12941294
The green component of the color.
12951295
<hr />
12961296

1297-
### `blue` <a id="struct_color_1acad45c325d520d1c24ea774099821c7c" class="anchor"></a>
1297+
### `blue` <a id="struct_l_e_d_color_1a4580c3efc87cb738b66e95fc7b1818db" class="anchor"></a>
12981298

12991299
```cpp
13001300
uint8_t blue

0 commit comments

Comments
 (0)