|
1 | 1 | #include "I2CDevice.h"
|
2 | 2 |
|
3 | 3 | /**
|
4 |
| - * @brief Represents the white on-board LED controlled via I2C. |
| 4 | + * @brief Represents the orange on-board LED controlled via I2C. |
5 | 5 | *
|
6 |
| - * The WhiteLED class provides methods to control the brightness and error status of the white LED. |
| 6 | + * The OrangeLED class provides methods to control the brightness and error status of the orange LED. |
7 | 7 | * It inherits from the I2CDevice class.
|
8 | 8 | */
|
9 |
| -class WhiteLED : public I2CDevice { |
| 9 | +class OrangeLED : public I2CDevice { |
10 | 10 | public:
|
11 | 11 |
|
12 | 12 | /**
|
13 |
| - * @brief Constructs a WhiteLED object. |
| 13 | + * @brief Constructs a OrangeLED object. |
14 | 14 | *
|
15 | 15 | * @param bus The I2C bus to use (default is Wire).
|
16 | 16 | * @param deviceAddress The I2C device address (default is 0x21).
|
17 | 17 | */
|
18 |
| - WhiteLED(TwoWire& bus = Wire, uint8_t deviceAddress = DEFAULT_DEVICE_ADDRESS); |
| 18 | + OrangeLED(TwoWire& bus = Wire, uint8_t deviceAddress = DEFAULT_DEVICE_ADDRESS); |
19 | 19 |
|
20 | 20 | /**
|
21 |
| - * @brief Constructs a WhiteLED object with the specified device address. |
| 21 | + * @brief Constructs a OrangeLED object with the specified device address. |
22 | 22 | *
|
23 |
| - * @param deviceAddress The I2C address of the WhiteLED device. |
| 23 | + * @param deviceAddress The I2C address of the OrangeLED device. |
24 | 24 | */
|
25 |
| - WhiteLED(uint8_t deviceAddress); |
| 25 | + OrangeLED(uint8_t deviceAddress); |
26 | 26 |
|
27 | 27 | /**
|
28 |
| - * Gets the brightness of the white LED. |
29 |
| - * @return The brightness of the white LED. Range is 0 to 63. |
| 28 | + * Gets the brightness of the orange LED. |
| 29 | + * @return The brightness of the orange LED. Range is 0 to 63. |
30 | 30 | */
|
31 | 31 | uint8_t brightness();
|
32 | 32 |
|
33 | 33 | /**
|
34 |
| - * Sets the brightness of the white LED. |
35 |
| - * Call storeSettingsInFlash() on NiclaSenseEnv instance after changing the white LED brightness to make the change persistent. |
36 |
| - * @param brightness : The brightness of the white LED. Range is 0 to 63. |
| 34 | + * Sets the brightness of the orange LED. |
| 35 | + * Call storeSettingsInFlash() on NiclaSenseEnv instance after changing the orange LED brightness to make the change persistent. |
| 36 | + * @param brightness : The brightness of the orange LED. Range is 0 to 63. |
37 | 37 | */
|
38 | 38 | void setBrightness(uint8_t brightness = 63);
|
39 | 39 |
|
40 | 40 | /**
|
41 |
| - * Determines whether the white LED is used to indicate an error status of one of the sensors. |
42 |
| - * @return True if the white LED is used for error status, false otherwise. |
| 41 | + * Determines whether the orange LED is used to indicate an error status of one of the sensors. |
| 42 | + * @return True if the orange LED is used for error status, false otherwise. |
43 | 43 | */
|
44 | 44 | bool errorStatusEnabled();
|
45 | 45 |
|
46 | 46 | /**
|
47 |
| - * Enables or disables the white LED to indicate an error status of one of the sensors. |
48 |
| - * Call storeSettingsInFlash() on NiclaSenseEnv instance after enabling/disabling the white LED error status to make the change persistent. |
49 |
| - * @param enabled : Whether to enable or disable the white LED error status. |
| 47 | + * Enables or disables the orange LED to indicate an error status of one of the sensors. |
| 48 | + * Call storeSettingsInFlash() on NiclaSenseEnv instance after enabling/disabling the orange LED error status to make the change persistent. |
| 49 | + * @param enabled : Whether to enable or disable the orange LED error status. |
50 | 50 | */
|
51 | 51 | void setErrorStatusEnabled(bool enabled);
|
52 | 52 | };
|
0 commit comments