Skip to content

Commit 655e715

Browse files
committed
Correct typos in comments and documentation
1 parent 42920fe commit 655e715

File tree

5 files changed

+21
-23
lines changed

5 files changed

+21
-23
lines changed

examples/ReadSensors/ReadSensors.ino

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
/*
2-
Arduino_MCHPTouch - Sensor data read Example
2+
Arduino_MCHPTouch - Sensor data read example
33
This example shows how to configure and read data
4-
from touch sensors bottons on MKR IoT Carrier and
4+
from touch sensor buttons on MKR IoT Carrier and
55
prints updates to the Serial Monitor.
66
77
The circuit:
8-
- Arduino MKR baord;
9-
- MKR IoT carrier.
8+
- Arduino MKR board
9+
- MKR IoT Carrier
1010
1111
This example code is in the public domain.
1212
*/
@@ -17,7 +17,7 @@ void setup()
1717
Serial.begin(9600);
1818
while (!Serial)
1919
;
20-
// Qtouch initialization
20+
// QTouch initialization
2121
if (!TOUCH.begin())
2222
{
2323
Serial.println("Error in sensors initialization!");
@@ -29,7 +29,7 @@ void setup()
2929

3030
void loop()
3131
{
32-
// polling the sensor for new measure
32+
// polling the sensor for new data
3333
TOUCH.poll();
3434

3535
// Checks if new data are available
@@ -49,4 +49,4 @@ void loop()
4949
Serial.println();
5050
}
5151
delay(100);
52-
}
52+
}

examples/setCustomSensitivity/setCustomSensitivity.ino

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,12 @@
11
/*
2-
Arduino_MCHPTouch - Sensor data read Example
2+
Arduino_MCHPTouch - Sensor data read example
33
This example shows how to configure and read data
44
from touch sensor buttons on MKR IoT Carrier and
5-
65
prints updates to the Serial Monitor.
76
87
The circuit:
9-
- Arduino MKR board;
10-
11-
- MKR IoT carrier.
8+
- Arduino MKR board
9+
- MKR IoT Carrier
1210
1311
This example code is in the public domain.
1412
*/
@@ -19,10 +17,10 @@ void setup()
1917
Serial.begin(9600);
2018
while (!Serial)
2119
;
22-
//Set custom sens on X channel
20+
//Set custom sensitivity on X channel
2321
//TOUCH.setSensorsSensitivity(*newSensitivity*, channel);
2422
TOUCH.setSensorsSensitivity(98, 0);
25-
// Qtouch initialization
23+
// QTouch initialization
2624
if (!TOUCH.begin())
2725
{
2826
Serial.println("Error in sensors initialization!");

keywords.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
#######################################
2-
# Syntax Coloring Map For MCHPTouch
2+
# Syntax Coloring Map For Arduino_MCHPTouch
33
#######################################
44

55
#######################################

library.properties

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ version=1.1.0
33
author=Arduino
44
maintainer=Arduino <[email protected]>
55
sentence=A library for the Atmel touch sensors
6-
paragraph=allows you to read touch sensors values from your Arduino SAMD boards with touch sensors connected. Microchip Technology Inc., provides the Microchip Touch Library software subject to the license terms contained at the link below.  By using the Microchip Touch Library, you acknowledge and agree to the terms of the license contained at the link below.
6+
paragraph=allows you to read touch sensor values from your Arduino SAMD boards with touch sensors connected. Microchip Technology Inc., provides the Microchip Touch Library software subject to the license terms contained at the link below.  By using the Microchip Touch Library, you acknowledge and agree to the terms of the license contained at the link below.
77
category=Sensors
88
url=https://github.com/arduino-libraries/Arduino_MCHPTouch
99
architectures=samd

src/Arduino_MCHPTouch.cpp

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ QtouchClass::~QtouchClass()
1818

1919
/*******************************************************************************
2020
* Function Name : begin
21-
* Description : Initializes Qtouch sensors
21+
* Description : Initializes QTouch sensors
2222
* Input : NONE
2323
* Return : false on Error, true on Success
2424
*******************************************************************************/
@@ -29,7 +29,7 @@ bool QtouchClass::begin()
2929
{
3030
return false;
3131
}
32-
// set starting measure time to 0 and chenge the analog resolution to 10
32+
// set starting measure time to 0 and change the analog resolution to 10
3333
touch_time.current_time_ms = 0;
3434
analogReadResolution(10);
3535
return true;
@@ -53,7 +53,7 @@ int QtouchClass::available()
5353
}
5454
/*******************************************************************************
5555
* Function Name : poll
56-
* Description : Polls the qotuch sensors for new measure
56+
* Description : Polls the QTouch sensors for new measure
5757
* Input : NONE
5858
* Return : NONE
5959
*******************************************************************************/
@@ -69,8 +69,8 @@ void QtouchClass::poll()
6969

7070
/*******************************************************************************
7171
* Function Name : read
72-
* Description : Querys the Qtouch and returns new touch measure
73-
* Input : sensor_id - Sensor identificator
72+
* Description : Queries the QTouch and returns new touch measure
73+
* Input : sensor_id - Sensor identification
7474
* Return : -1 on Error, touch measure state on Success
7575
*******************************************************************************/
7676
int QtouchClass::read(int sensor_id)
@@ -124,7 +124,7 @@ void QtouchClass::setSensorsHysteresis(hysteresis_t newHyst)
124124

125125
/*******************************************************************************
126126
* Function Name : getSensorsSensitivity
127-
* Description : Querys the Qtouch and returns the configured Sensitivity
127+
* Description : Queries the QTouch and returns the configured Sensitivity
128128
* value
129129
* Input : NONE
130130
* Return : The Sensitivity value
@@ -136,7 +136,7 @@ unsigned int QtouchClass::getSensorsSensitivity()
136136

137137
/*******************************************************************************
138138
* Function Name : getSensorsHysteresis
139-
* Description : Querys the Qtouch and returns the configured hysteresis
139+
* Description : Queries the QTouch and returns the configured hysteresis
140140
* value
141141
* Input : NONE
142142
* Return : The hysteresis value

0 commit comments

Comments
 (0)