Skip to content

Commit 0ac6a2b

Browse files
authored
chore(apds9999): update copyright + naming
1 parent 935d46b commit 0ac6a2b

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

src/components/i2c/drivers/WipperSnapper_I2C_Driver_APDS9999.h

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
/*!
22
* @file WipperSnapper_I2C_Driver_APDS9999.h
33
*
4-
* Device driver for the APDS9999 proximity, lux light, and color sensor.
4+
* Device driver for the APDS-9999 proximity, lux light, and color sensor.
55
*
66
* Adafruit invests time and resources providing this open source code,
77
* please support Adafruit and open-source hardware by purchasing
88
* products from Adafruit!
99
*
10-
* Copyright (c) Adafruit Industries 2025.
10+
* Copyright (c) Tyeth Gundry for Adafruit Industries 2026.
1111
*
1212
* MIT license, all text here must be included in any redistribution.
1313
*
@@ -20,14 +20,14 @@
2020

2121
/**************************************************************************/
2222
/*!
23-
@brief Class that provides a driver interface for an APDS9999 sensor.
23+
@brief Class that provides a driver interface for an APDS-9999 sensor.
2424
*/
2525
/**************************************************************************/
2626
class WipperSnapper_I2C_Driver_APDS9999 : public WipperSnapper_I2C_Driver {
2727
public:
2828
/*******************************************************************************/
2929
/*!
30-
@brief Constructor for an APDS9999 sensor.
30+
@brief Constructor for an APDS-9999 sensor.
3131
@param i2c
3232
The I2C interface.
3333
@param sensorAddress
@@ -42,14 +42,14 @@ class WipperSnapper_I2C_Driver_APDS9999 : public WipperSnapper_I2C_Driver {
4242

4343
/*******************************************************************************/
4444
/*!
45-
@brief Destructor for an APDS9999 sensor.
45+
@brief Destructor for an APDS-9999 sensor.
4646
*/
4747
/*******************************************************************************/
4848
~WipperSnapper_I2C_Driver_APDS9999() { delete _apds9999; }
4949

5050
/*******************************************************************************/
5151
/*!
52-
@brief Initializes the APDS9999 sensor and begins I2C.
52+
@brief Initializes the APDS-9999 sensor and begins I2C.
5353
@returns True if initialized successfully, False otherwise.
5454
*/
5555
/*******************************************************************************/
@@ -79,7 +79,7 @@ class WipperSnapper_I2C_Driver_APDS9999 : public WipperSnapper_I2C_Driver {
7979

8080
/*******************************************************************************/
8181
/*!
82-
@brief Reads the APDS9999 sensor data.
82+
@brief Reads the APDS-9999 sensor data.
8383
@returns True if the sensor was read successfully, False otherwise.
8484
*/
8585
/*******************************************************************************/
@@ -105,7 +105,7 @@ class WipperSnapper_I2C_Driver_APDS9999 : public WipperSnapper_I2C_Driver {
105105

106106
/*******************************************************************************/
107107
/*!
108-
@brief Gets the APDS9999's current light reading in lux.
108+
@brief Gets the APDS-9999's current light reading in lux.
109109
@param lightEvent
110110
Pointer to an Adafruit_Sensor event.
111111
@returns True if the light reading was obtained successfully, False
@@ -122,7 +122,7 @@ class WipperSnapper_I2C_Driver_APDS9999 : public WipperSnapper_I2C_Driver {
122122

123123
/*******************************************************************************/
124124
/*!
125-
@brief Gets the APDS9999's current proximity reading.
125+
@brief Gets the APDS-9999's current proximity reading.
126126
@param proximityEvent
127127
Pointer to an Adafruit_Sensor event.
128128
@returns True if the proximity was obtained successfully, False
@@ -138,7 +138,7 @@ class WipperSnapper_I2C_Driver_APDS9999 : public WipperSnapper_I2C_Driver {
138138
}
139139

140140
protected:
141-
Adafruit_APDS9999 *_apds9999 = nullptr; ///< APDS9999 driver object
141+
Adafruit_APDS9999 *_apds9999 = nullptr; ///< APDS-9999 driver object
142142
unsigned long _lastRead = 0; ///< Last sensor read time
143143
sensors_event_t _cachedLight = {0}; ///< Cached light reading
144144
sensors_event_t _cachedProximity = {0}; ///< Cached proximity reading

0 commit comments

Comments
 (0)