Skip to content

Commit ea15f2a

Browse files
per1234per1234
committed
Correct typos in comments and documentation
1 parent b657055 commit ea15f2a

32 files changed

+86
-88
lines changed

‎README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
# MKRMotorCarrier library
1+
# ArduinoMotorCarrier library
22

33
[![Spell Check status](https://github.com/arduino-libraries/ArduinoMotorCarrier/actions/workflows/spell-check.yml/badge.svg)](https://github.com/arduino-libraries/ArduinoMotorCarrier/actions/workflows/spell-check.yml)
44

5-
This library is designed to use the MKR Motor carrier. The shield supports micro servo motors, dc motors and dc motors with encoder. This library, therefore, has functions and creates objects to support such hardware. Objects are automatically created when "ArduinoMotorCarrier.h" is included, hence no need to initiate objects manually.
5+
This library is designed to use the MKR Motor Carrier. The shield supports micro servo motors, DC motors and DC motors with encoder. This library, therefore, has functions and creates objects to support such hardware. Objects are automatically created when "ArduinoMotorCarrier.h" is included, hence no need to initiate objects manually.
66

77
For more information about this library please visit us at
88

‎examples/Motor_test/Motor_test.ino

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -13,15 +13,15 @@ void setup()
1313
Serial.begin(115200);
1414
while (!Serial);
1515

16-
//Establishing the communication with the motor shield
16+
//Establishing the communication with the Motor Carrier
1717
if (controller.begin())
1818
{
19-
Serial.print("MKR Motor Shield connected, firmware version ");
19+
Serial.print("MKR Motor Connected connected, firmware version ");
2020
Serial.println(controller.getFWVersion());
2121
}
2222
else
2323
{
24-
Serial.println("Couldn't connect! Is the red led blinking? You may need to update the firmware with FWUpdater sketch");
24+
Serial.println("Couldn't connect! Is the red LED blinking? You may need to update the firmware with FWUpdater sketch");
2525
while (1);
2626
}
2727

@@ -44,7 +44,7 @@ void loop() {
4444
//Take the battery status
4545
float batteryVoltage = (float)battery.getConverted();
4646

47-
//Reset to the default values if the battery level is lower than 11V
47+
//Reset to the default values if the battery level is lower than 11 V
4848
if (batteryVoltage < 11)
4949
{
5050
Serial.println(" ");
@@ -83,8 +83,8 @@ void loop() {
8383
delay(50);
8484
}
8585

86-
//Keep active the communication MKR1000 & MKRMotorCarrier
87-
//Ping the samd11
86+
//Keep active the communication between MKR board & MKR Motor Carrier
87+
//Ping the SAMD11
8888
controller.ping();
8989
//wait
9090
delay(50);

‎examples/Motor_test_encoder/Motor_test_encoder.ino

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -13,15 +13,15 @@ void setup()
1313
Serial.begin(115200);
1414
while (!Serial);
1515

16-
//Establishing the communication with the motor shield
16+
//Establishing the communication with the Motor Carrier
1717
if (controller.begin())
1818
{
19-
Serial.print("MKR Motor Shield connected, firmware version ");
19+
Serial.print("Motor Carrier connected, firmware version ");
2020
Serial.println(controller.getFWVersion());
2121
}
2222
else
2323
{
24-
Serial.println("Couldn't connect! Is the red led blinking? You may need to update the firmware with FWUpdater sketch");
24+
Serial.println("Couldn't connect! Is the red LED blinking? You may need to update the firmware with FWUpdater sketch");
2525
while (1);
2626
}
2727

@@ -49,7 +49,7 @@ void loop() {
4949
//Take the battery status
5050
float batteryVoltage = (float)battery.getConverted();
5151

52-
//Reset to the default values if the battery level is lower than 11V
52+
//Reset to the default values if the battery level is lower than 11 V
5353
if (batteryVoltage < 11)
5454
{
5555
Serial.println(" ");
@@ -78,8 +78,8 @@ void loop() {
7878
Serial.println(encoder1.getCountPerSecond());
7979
}
8080

81-
//Keep active the communication MKR1000 & MKRMotorCarrier
82-
//Ping the samd11
81+
//Keep active the communication between MKR board & MKR Motor Carrier
82+
//Ping the SAMD11
8383
controller.ping();
8484
//wait
8585
delay(50);

‎examples/Nano/DCMotorTest/DCMotorTest.ino

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -13,15 +13,15 @@ void setup()
1313
Serial.begin(115200);
1414
//while (!Serial);
1515

16-
//Establishing the communication with the motor shield
16+
//Establishing the communication with the Motor Carrier
1717
if (controller.begin())
1818
{
19-
Serial.print("MKR Motor Shield connected, firmware version ");
19+
Serial.print("Motor Carrier connected, firmware version ");
2020
Serial.println(controller.getFWVersion());
2121
}
2222
else
2323
{
24-
Serial.println("Couldn't connect! Is the red led blinking? You may need to update the firmware with FWUpdater sketch");
24+
Serial.println("Couldn't connect! Is the red LED blinking? You may need to update the firmware with FWUpdater sketch");
2525
while (1);
2626
}
2727

@@ -30,7 +30,7 @@ void setup()
3030
controller.reboot();
3131
delay(500);
3232

33-
int dutyInit = 0; // at 50 it works as espected, at 60 shift sides and is too small duty to move, at 70 is very big duty.
33+
int dutyInit = 0; // at 50 it works as expected, at 60 shift sides and is too small duty to move, at 70 is very big duty.
3434
M1.setDuty(dutyInit);
3535
M2.setDuty(dutyInit);
3636
M3.setDuty(dutyInit);
@@ -49,7 +49,7 @@ void loop() {
4949
//Take the battery status
5050
//float batteryVoltage = (float)battery.getConverted();
5151

52-
//Reset to the default values if the battery level is lower than 11V
52+
//Reset to the default values if the battery level is lower than 11 V
5353
// if (batteryVoltage < 11)
5454
// {
5555
// Serial.println(" ");
@@ -89,8 +89,8 @@ void loop() {
8989
delay(10);
9090
}
9191

92-
//Keep active the communication MKR1000 & MKRMotorCarrier
93-
//Ping the samd11
92+
//Keep active the communication between Nano & Motor Carrier
93+
//Ping the SAMD11
9494
controller.ping();
9595
//wait
9696
delay(50);

‎examples/Nano/EncoderTest/EncoderTest.ino

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,15 +9,15 @@ static int duty = 0;
99

1010
void setup()
1111
{
12-
//Establishing the communication with the motor shield
12+
//Establishing the communication with the Motor Carrier
1313
if (controller.begin())
1414
{
15-
Serial.print("MKR Motor Shield connected, firmware version ");
15+
Serial.print("Motor Carrier connected, firmware version ");
1616
Serial.println(controller.getFWVersion());
1717
}
1818
else
1919
{
20-
Serial.println("Couldn't connect! Is the red led blinking? You may need to update the firmware with FWUpdater sketch");
20+
Serial.println("Couldn't connect! Is the red LED blinking? You may need to update the firmware with FWUpdater sketch");
2121
while (1);
2222
}
2323

@@ -55,8 +55,8 @@ void loop() {
5555
Serial.println(encoder2.getCountPerSecond());
5656
Serial.println("");
5757

58-
//Keep active the communication MKR1000 & MKRMotorCarrier
59-
//Ping the samd11
58+
//Keep active the communication between Nano & Motor Carrier
59+
//Ping the SAMD11
6060
controller.ping();
6161
//wait
6262
delay(50);

‎examples/Nano/IMU_Test/IMU_Test.ino

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ void setup() //This code is executed once
6666

6767
void loop() //This code is looped forever
6868
{
69-
if ((millis() - lastTime) >= 100) //To stream at 10Hz without using additional timers
69+
if ((millis() - lastTime) >= 100) //To stream at 10 Hz without using additional timers
7070
{
7171
lastTime = millis();
7272

‎examples/Nano/PID_Position_test/PID_Position_test.ino

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -16,15 +16,15 @@ void setup()
1616
Serial.begin(115200);
1717
while (!Serial);
1818

19-
//Establishing the communication with the motor shield
19+
//Establishing the communication with the Motor Carrier
2020
if (controller.begin())
2121
{
22-
Serial.print("MKR Motor Shield connected, firmware version ");
22+
Serial.print("Motor Carrier connected, firmware version ");
2323
Serial.println(controller.getFWVersion());
2424
}
2525
else
2626
{
27-
Serial.println("Couldn't connect! Is the red led blinking? You may need to update the firmware with FWUpdater sketch");
27+
Serial.println("Couldn't connect! Is the red LED blinking? You may need to update the firmware with FWUpdater sketch");
2828
while (1);
2929
}
3030

@@ -40,7 +40,7 @@ void setup()
4040
Serial.print("V, Raw ");
4141
Serial.println(battery.getRaw());
4242

43-
int dutyInit = 0; // at 50 it works as espected, at 60 shift sides and is too small duty to move, at 70 is very big duty.
43+
int dutyInit = 0; // at 50 it works as expected, at 60 shift sides and is too small duty to move, at 70 is very big duty.
4444
M1.setDuty(dutyInit);
4545
M2.setDuty(dutyInit);
4646
M3.setDuty(dutyInit);

‎examples/Nano/ServoTest/ServoTest.ino

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -11,15 +11,15 @@ void setup()
1111
Serial.begin(115200);
1212
//while (!Serial);
1313

14-
//Establishing the communication with the motor shield
14+
//Establishing the communication with the Motor Carrier
1515
if (controller.begin())
1616
{
17-
Serial.print("MKR Motor Shield connected, firmware version ");
17+
Serial.print("Motor Carrier connected, firmware version ");
1818
Serial.println(controller.getFWVersion());
1919
}
2020
else
2121
{
22-
Serial.println("Couldn't connect! Is the red led blinking? You may need to update the firmware with FWUpdater sketch");
22+
Serial.println("Couldn't connect! Is the red LED blinking? You may need to update the firmware with FWUpdater sketch");
2323
while (1);
2424
}
2525

@@ -43,7 +43,7 @@ void loop() {
4343
//Servo sweep from 0 position to 180
4444
for (int i = 0; i < 180; i += 1)
4545
{
46-
//Choose what of all the servo connectors do you want to use: servo1(default), servo2, servo3 or servo4
46+
//Choose which of the servo connectors you want to use: servo1(default), servo2, servo3 or servo4
4747
servo1.setAngle(i);
4848
servo2.setAngle(i);
4949
servo3.setAngle(i);
@@ -58,7 +58,7 @@ void loop() {
5858
//Servo sweep from 180 position to 0
5959
for (int i = 180; i > 0; i -= 1)
6060
{
61-
//Choose what of all the servo connectors do you want to use: servo1(default), servo2, servo3 or servo4
61+
//Choose which of the servo connectors you want to use: servo1(default), servo2, servo3 or servo4
6262
servo1.setAngle(i);
6363
servo2.setAngle(i);
6464
servo3.setAngle(i);
@@ -69,8 +69,8 @@ void loop() {
6969
}
7070

7171

72-
//Keep active the communication MKR1000 & MKRMotorCarrier
73-
//Ping the samd11
72+
//Keep active the communication between MKR board & MKR Motor Carrier
73+
//Ping the SAMD11
7474
controller.ping();
7575
//wait
7676
delay(50);

‎examples/Servo_test/Servo_test.ino

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
21
#include <ArduinoMotorCarrier.h>
32
#define INTERRUPT_PIN 6
43

@@ -11,15 +10,15 @@ void setup()
1110
Serial.begin(115200);
1211
while (!Serial);
1312

14-
//Establishing the communication with the motor shield
13+
//Establishing the communication with the Motor Carrier
1514
if (controller.begin())
1615
{
17-
Serial.print("MKR Motor Shield connected, firmware version ");
16+
Serial.print("MKR Motor Carrier connected, firmware version ");
1817
Serial.println(controller.getFWVersion());
1918
}
2019
else
2120
{
22-
Serial.println("Couldn't connect! Is the red led blinking? You may need to update the firmware with FWUpdater sketch");
21+
Serial.println("Couldn't connect! Is the red LED blinking? You may need to update the firmware with FWUpdater sketch");
2322
while (1);
2423
}
2524

@@ -42,7 +41,7 @@ void loop() {
4241
//Take the battery status
4342
float batteryVoltage = (float)battery.getConverted();
4443

45-
//Reset to the default values if the battery level is lower than 11V
44+
//Reset to the default values if the battery level is lower than 11 V
4645
if (batteryVoltage < 11)
4746
{
4847
Serial.println(" ");
@@ -57,7 +56,7 @@ void loop() {
5756
//Servo sweep from 0 position to 180
5857
for (int i=0; i<180; i+=5)
5958
{
60-
//Choose what of all the servo connectors do you want to use: servo1(default), servo2, servo3 or servo4
59+
//Choose which of the servo connectors you want to use: servo1(default), servo2, servo3 or servo4
6160
servo1.setAngle(i);
6261
Serial.print("Servo position");
6362
Serial.println(i);
@@ -69,16 +68,16 @@ void loop() {
6968
//Servo sweep from 180 position to 0
7069
for (int i=180; i>0; i-=5)
7170
{
72-
//Choose what of all the servo connectors do you want to use: servo1(default), servo2, servo3 or servo4
71+
//Choose which of the servo connectors you want to use: servo1(default), servo2, servo3 or servo4
7372
servo1.setAngle(i);
7473
Serial.print("Servo position");
7574
Serial.println(i);
7675
delay(50);
7776
}
7877
}
7978

80-
//Keep active the communication MKR1000 & MKRMotorCarrier
81-
//Ping the samd11
79+
//Keep active the communication between MKR board & MKR Motor Carrier
80+
//Ping the SAMD11
8281
controller.ping();
8382
//wait
8483
delay(50);

‎examples/Test/Test.ino

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
/*
2-
MKR Motor Shield Test sketch
3-
This sketch demonstrates some APIs exposed by the MKR Motor Shield library.
2+
MKR Motor Carrier Test sketch
3+
This sketch demonstrates some APIs exposed by the ArduinoMotorCarrier library.
44
For the complete list, visit the reference page on https://www.arduino.cc/en/Reference/MKRMotorCarrier
55
This example code is in the public domain.
66
*/
@@ -12,12 +12,12 @@ void setup() {
1212
Serial.begin(115200);
1313
while (!Serial);
1414

15-
// Start communicationg with the motor shield
15+
// Start communication with the Motor Carrier
1616
if (controller.begin()) {
17-
Serial.print("MKR Motor Shield connected, firmware version ");
17+
Serial.print("MKR Motor Carrier connected, firmware version ");
1818
Serial.println(controller.getFWVersion());
1919
} else {
20-
Serial.println("Couldn't connect! Is the red led blinking? You may need to update the firmware with FWUpdater sketch");
20+
Serial.println("Couldn't connect! Is the red LED blinking? You may need to update the firmware with FWUpdater sketch");
2121
while (1);
2222
}
2323

0 commit comments

Comments
 (0)