Skip to content

Commit cd40fbe

Browse files
committed
Correct typos in comments
1 parent b1483c3 commit cd40fbe

File tree

7 files changed

+27
-27
lines changed

7 files changed

+27
-27
lines changed

README.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55

66
image:https://github.com/{repository-owner}/{repository-name}/actions/workflows/spell-check.yml/badge.svg["Spell Check status", link="https://github.com/{repository-owner}/{repository-name}/actions/workflows/spell-check.yml"]
77

8-
A library for the APDS9960 sensor, allows you to read gestures, color, and proximity on your Arduino Nano 33 BLE Sense board and other boards with sensor attached via I2C.
8+
A library for the APDS-9960 sensor, allows you to read gestures, color, and proximity on your Arduino Nano 33 BLE Sense board and other boards with sensor attached via I2C.
99

1010
== License ==
1111

examples/ColorSensor/ColorSensor.ino

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
/*
2-
APDS9960 - Color Sensor
2+
APDS-9960 - Color Sensor
33
4-
This example reads Color data from the on-board APDS9960 sensor of the
4+
This example reads color data from the on-board APDS-9960 sensor of the
55
Nano 33 BLE Sense and prints the color RGB (red, green, blue) values
66
to the Serial Monitor once a second.
77
@@ -18,7 +18,7 @@ void setup() {
1818
while (!Serial);
1919

2020
if (!APDS.begin()) {
21-
Serial.println("Error initializing APDS9960 sensor.");
21+
Serial.println("Error initializing APDS-9960 sensor.");
2222
}
2323
}
2424

examples/FullExample/FullExample.ino

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
/*
2-
APDS9960 - All sensor data from APDS9960
2+
APDS-9960 - All sensor data from APDS-9960
33
4-
This example reads all data from the on-board APDS9960 sensor of the
4+
This example reads all data from the on-board APDS-9960 sensor of the
55
Nano 33 BLE Sense:
66
- color RGB (red, green, blue)
77
- proximity
@@ -18,10 +18,10 @@
1818

1919
void setup() {
2020
Serial.begin(9600);
21-
while (!Serial); // Wait for serial monitor to open
21+
while (!Serial); // Wait for Serial Monitor to open
2222

2323
if (!APDS.begin()) {
24-
Serial.println("Error initializing APDS9960 sensor.");
24+
Serial.println("Error initializing APDS-9960 sensor.");
2525
while (true); // Stop forever
2626
}
2727
}
@@ -37,7 +37,7 @@ void loop() {
3737
proximity = APDS.readProximity();
3838
}
3939

40-
// check if a gesture reading is available
40+
// Check if a gesture reading is available
4141
if (APDS.gestureAvailable()) {
4242
int gesture = APDS.readGesture();
4343
switch (gesture) {
@@ -58,22 +58,22 @@ void loop() {
5858
break;
5959

6060
default:
61-
// ignore
61+
// Ignore
6262
break;
6363
}
6464
}
6565

66-
// check if a color reading is available
66+
// Check if a color reading is available
6767
if (APDS.colorAvailable()) {
6868
APDS.readColor(r, g, b);
6969
}
7070

71-
// Print updates every 100ms
71+
// Print updates every 100 ms
7272
if (millis() - lastUpdate > 100) {
7373
lastUpdate = millis();
7474
Serial.print("PR=");
7575
Serial.print(proximity);
76-
Serial.print(" rgb=");
76+
Serial.print(" RGB=");
7777
Serial.print(r);
7878
Serial.print(",");
7979
Serial.print(g);

examples/GestureSensor/GestureSensor.ino

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
/*
2-
APDS9960 - Gesture Sensor
2+
APDS-9960 - Gesture Sensor
33
4-
This example reads gesture data from the on-board APDS9960 sensor of the
4+
This example reads gesture data from the on-board APDS-9960 sensor of the
55
Nano 33 BLE Sense and prints any detected gestures to the Serial Monitor.
66
77
Gesture directions are as follows:
@@ -23,21 +23,21 @@ void setup() {
2323
while (!Serial);
2424

2525
if (!APDS.begin()) {
26-
Serial.println("Error initializing APDS9960 sensor!");
26+
Serial.println("Error initializing APDS-9960 sensor!");
2727
}
2828

2929
// for setGestureSensitivity(..) a value between 1 and 100 is required.
30-
// Higher values makes the gesture recognition more sensible but less accurate
30+
// Higher values make the gesture recognition more sensitive but less accurate
3131
// (a wrong gesture may be detected). Lower values makes the gesture recognition
32-
// more accurate but less sensible (some gestures may be missed).
32+
// more accurate but less sensitive (some gestures may be missed).
3333
// Default is 80
3434
//APDS.setGestureSensitivity(80);
3535

3636
Serial.println("Detecting gestures ...");
3737
}
3838
void loop() {
3939
if (APDS.gestureAvailable()) {
40-
// a gesture was detected, read and print to serial monitor
40+
// a gesture was detected, read and print to Serial Monitor
4141
int gesture = APDS.readGesture();
4242

4343
switch (gesture) {

examples/ProximitySensor/ProximitySensor.ino

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
/*
2-
APDS9960 - Proximity Sensor
2+
APDS-9960 - Proximity Sensor
33
4-
This example reads proximity data from the on-board APDS9960 sensor of the
4+
This example reads proximity data from the on-board APDS-9960 sensor of the
55
Nano 33 BLE Sense and prints the proximity value to the Serial Monitor
6-
every 100ms.
6+
every 100 ms.
77
88
The circuit:
99
- Arduino Nano 33 BLE Sense
@@ -18,7 +18,7 @@ void setup() {
1818
while (!Serial);
1919

2020
if (!APDS.begin()) {
21-
Serial.println("Error initializing APDS9960 sensor!");
21+
Serial.println("Error initializing APDS-9960 sensor!");
2222
}
2323
}
2424

library.properties

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@ name=Arduino_APDS9960
22
version=1.0.3
33
author=Arduino
44
maintainer=Arduino <[email protected]>
5-
sentence=A library for the APDS9960 sensor
6-
paragraph=allows to read gestures, color, and proximity on your Arduino Nano 33 BLE Sense board and other boards with sensor attached via I2C.
5+
sentence=A library for the APDS-9960 sensor
6+
paragraph=allows reading gestures, color, and proximity on your Arduino Nano 33 BLE Sense board and other boards with a sensor attached via I2C.
77
category=Sensors
88
url=https://github.com/arduino-libraries/Arduino_APDS9960
99
architectures=*

src/Arduino_APDS9960.cpp

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -160,7 +160,7 @@ bool APDS9960::disableColor() {
160160
}
161161
r &= 0b11111101;
162162
bool res = setENABLE(r);
163-
_colorEnabled = !res; // (res == true) if succesfully disabled
163+
_colorEnabled = !res; // (res == true) if successfully disabled
164164
return res;
165165
}
166166

@@ -186,7 +186,7 @@ bool APDS9960::disableProximity() {
186186
}
187187
r &= 0b11111011;
188188
bool res = setENABLE(r);
189-
_proximityEnabled = !res; // (res == true) if succesfully disabled
189+
_proximityEnabled = !res; // (res == true) if successfully disabled
190190
return res;
191191
}
192192

0 commit comments

Comments
 (0)