Correct typos in comments and documentation

per1234 · per1234 · commit 6f710d6b0287 · 2021-04-11T11:54:09.000-07:00
diff --git a/docs/api.md b/docs/api.md
@@ -4,7 +4,7 @@
 
 ### `attach()`
 
-Attach the Servo variable to a pin. Note that in Arduino 0016 and earlier, the Servo library supports only servos on only two pins: 9 and 10.
+Attach the Servo variable to a pin. Note that in Arduino 0016 and earlier, the Servo library supports servos on only two pins: 9 and 10.
 
 #### Syntax
 
@@ -17,8 +17,8 @@ servo.attach(pin, min, max)
 
 * _servo_: a variable of type `Servo`
 * _pin_: the number of the pin that the servo is attached to
-* _min_ (optional): the pulse width, in microseconds, corresponding to the minimum (0-degree) angle on the servo (defaults to 544)
-* _max_ (optional): the pulse width, in microseconds, corresponding to the maximum (180-degree) angle on the servo (defaults to 2400)
+* _min_ (optional): the pulse width, in microseconds, corresponding to the minimum (0 degree) angle on the servo (defaults to 544)
+* _max_ (optional): the pulse width, in microseconds, corresponding to the maximum (180 degree) angle on the servo (defaults to 2400)
 
 #### Example
 
@@ -77,7 +77,7 @@ void loop() {}
 
 ### `writeMicroseconds()`
 
-Writes a value in microseconds (uS) to the servo, controlling the shaft accordingly. On a standard servo, this will set the angle of the shaft. On standard servos a parameter value of 1000 is fully counter-clockwise, 2000 is fully clockwise, and 1500 is in the middle.
+Writes a value in microseconds (us) to the servo, controlling the shaft accordingly. On a standard servo, this will set the angle of the shaft. On standard servos a parameter value of 1000 is fully counter-clockwise, 2000 is fully clockwise, and 1500 is in the middle.
 
 Note that some manufactures do not follow this standard very closely so that servos often respond to values between 700 and 2300. Feel free to increase these endpoints until the servo no longer continues to increase its range. Note however that attempting to drive a servo past its endpoints (often indicated by a growling sound) is a high-current state, and should be avoided.
 
@@ -86,13 +86,13 @@ Continuous-rotation servos will respond to the writeMicrosecond function in an a
 #### Syntax
 
 ````
-servo.writeMicroseconds(uS)
+servo.writeMicroseconds(us)
 ````
 
 #### Parameters
 
 * _servo_: a variable of type Servo
-* _uS_: the value of the parameter in microseconds (int)
+* _us_: the value of the parameter in microseconds (int)
 
 #### Example
 
@@ -163,7 +163,7 @@ servo.attached()
 
 ### `detach()`
 
-Detach the Servo variable from its pin. If all Servo variables are detached, then pins 9 and 10 can be used for PWM output with [analogWrite()](#analogwrite).
+Detach the Servo variable from its pin. If all Servo variables are detached, then pins 9 and 10 can be used for PWM output with [analogWrite()](https://www.arduino.cc/reference/en/language/functions/analog-io/analogwrite/).
 
 #### Syntax
 
diff --git a/docs/readme.md b/docs/readme.md
@@ -13,9 +13,9 @@ To use this library:
 
 ## Circuit
 
-Servo motors have three wires: power, ground, and signal. The power wire is typically red, and should be connected to the 5V pin on the Arduino board. The ground wire is typically black or brown and should be connected to a ground pin on the Arduino board. The signal pin is typically yellow, orange or white and should be connected to a digital pin on the Arduino board. Note that servos draw considerable power, so if you need to drive more than one or two, you'll probably need to power them from a separate supply (i.e. not the +5V pin on your Arduino). Be sure to connect the grounds of the Arduino and external power supply together.
+Servo motors have three wires: power, ground, and signal. The power wire is typically red, and should be connected to the 5V pin on the Arduino board. The ground wire is typically black or brown and should be connected to a ground pin on the Arduino board. The signal pin is typically yellow, orange or white and should be connected to a digital pin on the Arduino board. Note that servos draw considerable power, so if you need to drive more than one or two, you'll probably need to power them from a separate supply (i.e. not the 5V pin on your Arduino). Be sure to connect the grounds of the Arduino and external power supply together.
 
 ## Examples
 
 * [Knob](https://www.arduino.cc/en/Tutorial/Knob): control the shaft of a servo motor by turning a potentiometer
-* [Sweep](https://www.arduino.cc/en/Tutorial/Sweep): sweeps the shaft of a servo motor back and forth
+* [Sweep](https://www.arduino.cc/en/Tutorial/LibraryExamples/Sweep): sweeps the shaft of a servo motor back and forth
diff --git a/examples/Knob/Knob.ino b/examples/Knob/Knob.ino
@@ -20,8 +20,7 @@ void setup() {
 
 void loop() {
   val = analogRead(potpin);            // reads the value of the potentiometer (value between 0 and 1023)
-  val = map(val, 0, 1023, 0, 180);     // scale it to use it with the servo (value between 0 and 180)
+  val = map(val, 0, 1023, 0, 180);     // scale it for use with the servo (value between 0 and 180)
   myservo.write(val);                  // sets the servo position according to the scaled value
   delay(15);                           // waits for the servo to get there
 }
-
diff --git a/examples/Knob/readme.md b/examples/Knob/readme.md
@@ -13,7 +13,7 @@ This example makes use of the Arduino `Servo` library.
 
 ## Circuit
 
-Servo motors have three wires: power, ground, and signal. The power wire is typically red, and should be connected to the 5V pin on the Arduino or Genuino board. The ground wire is typically black or brown and should be connected to a ground pin on the board. The signal pin is typically yellow or orange and should be connected to pin 9 on the board.
+Servo motors have three wires: power, ground, and signal. The power wire is typically red, and should be connected to the 5V pin on the Arduino board. The ground wire is typically black or brown and should be connected to a ground pin on the board. The signal pin is typically yellow or orange and should be connected to pin 9 on the board.
 
 The potentiometer should be wired so that its two outer pins are connected to power (+5V) and ground, and its middle pin is connected to analog input 0 on the board.
 
diff --git a/examples/Sweep/Sweep.ino b/examples/Sweep/Sweep.ino
@@ -4,7 +4,7 @@
 
  modified 8 Nov 2013
  by Scott Fitzgerald
- http://www.arduino.cc/en/Tutorial/Sweep
+ https://www.arduino.cc/en/Tutorial/LibraryExamples/Sweep
 */
 
 #include <Servo.h>
@@ -22,11 +22,10 @@ void loop() {
   for (pos = 0; pos <= 180; pos += 1) { // goes from 0 degrees to 180 degrees
     // in steps of 1 degree
     myservo.write(pos);              // tell servo to go to position in variable 'pos'
-    delay(15);                       // waits 15ms for the servo to reach the position
+    delay(15);                       // waits 15 ms for the servo to reach the position
   }
   for (pos = 180; pos >= 0; pos -= 1) { // goes from 180 degrees to 0 degrees
     myservo.write(pos);              // tell servo to go to position in variable 'pos'
-    delay(15);                       // waits 15ms for the servo to reach the position
+    delay(15);                       // waits 15 ms for the servo to reach the position
   }
 }
-
diff --git a/examples/Sweep/readme.md b/examples/Sweep/readme.md
@@ -10,7 +10,7 @@ Sweeps the shaft of a RC [servo motor](http://en.wikipedia.org/wiki/Servo_motor#
 
 ## Circuit
 
-Servo motors have three wires: power, ground, and signal. The power wire is typically red, and should be connected to the 5V pin on the Arduino or Genuino board. The ground wire is typically black or brown and should be connected to a ground pin on the board. The signal pin is typically yellow, orange or white and should be connected to pin 9 on the board.
+Servo motors have three wires: power, ground, and signal. The power wire is typically red, and should be connected to the 5V pin on the Arduino board. The ground wire is typically black or brown and should be connected to a ground pin on the board. The signal pin is typically yellow, orange or white and should be connected to pin 9 on the board.
 
 ![](images/sweep_bb.png)
 
@@ -26,4 +26,4 @@ Servo motors have three wires: power, ground, and signal. The power wire is typi
 * [write()](/docs/api.md#write)
 * [map()](https://www.arduino.cc/en/Reference/Map)
 * [Servo library reference](/docs/readme.md)
-* [Knob](../Knob) - Sweep the shaft of a servo motor back and forth
+* [Knob](../Knob) - Control the position of a servo with a potentiometer
diff --git a/library.properties b/library.properties
@@ -2,8 +2,8 @@ name=Servo
 version=1.1.7
 author=Michael Margolis, Arduino
 maintainer=Arduino <info@arduino.cc>
-sentence=Allows Arduino/Genuino boards to control a variety of servo motors.
-paragraph=This library can control a great number of servos.<br />It makes careful use of timers: the library can control 12 servos using only 1 timer.<br />On the Arduino Due you can control up to 60 servos.<br />
+sentence=Allows Arduino boards to control a variety of servo motors.
+paragraph=This library can control a great number of servos.<br />It makes careful use of timers: the library can control 12 servos using only 1 timer.<br />On the Arduino Due you can control up to 60 servos.
 category=Device Control
-url=http://www.arduino.cc/en/Reference/Servo
+url=https://www.arduino.cc/reference/en/libraries/servo/
 architectures=avr,megaavr,sam,samd,nrf52,stm32f4,mbed
diff --git a/src/Servo.h b/src/Servo.h
@@ -27,13 +27,13 @@
   disabled when the first servo is attached.
   Timers are seized as needed in groups of 12 servos - 24 servos use two 
   timers, 48 servos will use four.
-  The sequence used to sieze timers is defined in timers.h
+  The sequence used to seize timers is defined in timers.h
 
   The methods are:
 
     Servo - Class for manipulating servo motors connected to Arduino pins.
 
-    attach(pin )  - Attaches a servo motor to an i/o pin.
+    attach(pin )  - Attaches a servo motor to an I/O pin.
     attach(pin, min, max  ) - Attaches to a pin setting min and max values in microseconds
     default min is 544, max is 2400  
  
@@ -42,7 +42,7 @@
     read()      - Gets the last written servo pulse width as an angle between 0 and 180. 
     readMicroseconds()   - Gets the last written servo pulse width in microseconds. (was read_us() in first release)
     attached()  - Returns true if there is a servo attached. 
-    detach()    - Stops an attached servos from pulsing its i/o pin. 
+    detach()    - Stops an attached servos from pulsing its I/O pin. 
  */
 
 #ifndef Servo_h
@@ -51,7 +51,7 @@
 #include <inttypes.h>
 
 /* 
- * Defines for 16 bit timers used with  Servo library 
+ * Defines for 16 bit timers used with Servo library 
  *
  * If _useTimerX is defined then TimerX is a 16 bit timer on the current board
  * timer16_Sequence_t enumerates the sequence that the timers should be allocated
@@ -82,7 +82,7 @@
 #define MIN_PULSE_WIDTH       544     // the shortest pulse sent to a servo  
 #define MAX_PULSE_WIDTH      2400     // the longest pulse sent to a servo 
 #define DEFAULT_PULSE_WIDTH  1500     // default pulse width when servo is attached
-#define REFRESH_INTERVAL    20000     // minumim time to refresh servos in microseconds 
+#define REFRESH_INTERVAL    20000     // minimum time to refresh servos in microseconds 
 
 #define SERVOS_PER_TIMER       12     // the maximum number of servos controlled by one timer 
 #define MAX_SERVOS   (_Nbr_16timers  * SERVOS_PER_TIMER)
diff --git a/src/avr/Servo.cpp b/src/avr/Servo.cpp
@@ -44,8 +44,8 @@ uint8_t ServoCount = 0;                                     // the total number
 #define SERVO_INDEX(_timer,_channel)  ((_timer*SERVOS_PER_TIMER) + _channel)     // macro to access servo index by timer and channel
 #define SERVO(_timer,_channel)  (servos[SERVO_INDEX(_timer,_channel)])            // macro to access servo class by timer and channel
 
-#define SERVO_MIN() (MIN_PULSE_WIDTH - this->min * 4)  // minimum value in uS for this servo
-#define SERVO_MAX() (MAX_PULSE_WIDTH - this->max * 4)  // maximum value in uS for this servo
+#define SERVO_MIN() (MIN_PULSE_WIDTH - this->min * 4)  // minimum value in us for this servo
+#define SERVO_MAX() (MAX_PULSE_WIDTH - this->max * 4)  // maximum value in us for this servo
 
 /************ static functions common to all instances ***********************/
 
@@ -129,11 +129,11 @@ static void initISR(timer16_Sequence_t timer)
     TCCR1B = _BV(CS11);     // set prescaler of 8
     TCNT1 = 0;              // clear the timer count
 #if defined(__AVR_ATmega8__)|| defined(__AVR_ATmega128__)
-    TIFR |= _BV(OCF1A);      // clear any pending interrupts;
+    TIFR |= _BV(OCF1A);      // clear any pending interrupts
     TIMSK |=  _BV(OCIE1A) ;  // enable the output compare interrupt
 #else
     // here if not ATmega8 or ATmega128
-    TIFR1 |= _BV(OCF1A);     // clear any pending interrupts;
+    TIFR1 |= _BV(OCF1A);     // clear any pending interrupts
     TIMSK1 |=  _BV(OCIE1A) ; // enable the output compare interrupt
 #endif
 #if defined(WIRING)
@@ -148,10 +148,10 @@ static void initISR(timer16_Sequence_t timer)
     TCCR3B = _BV(CS31);     // set prescaler of 8
     TCNT3 = 0;              // clear the timer count
 #if defined(__AVR_ATmega128__)
-    TIFR |= _BV(OCF3A);     // clear any pending interrupts;
+    TIFR |= _BV(OCF3A);     // clear any pending interrupts
 	ETIMSK |= _BV(OCIE3A);  // enable the output compare interrupt
 #else
-    TIFR3 = _BV(OCF3A);     // clear any pending interrupts;
+    TIFR3 = _BV(OCF3A);     // clear any pending interrupts
     TIMSK3 =  _BV(OCIE3A) ; // enable the output compare interrupt
 #endif
 #if defined(WIRING)
@@ -165,7 +165,7 @@ static void initISR(timer16_Sequence_t timer)
     TCCR4A = 0;             // normal counting mode
     TCCR4B = _BV(CS41);     // set prescaler of 8
     TCNT4 = 0;              // clear the timer count
-    TIFR4 = _BV(OCF4A);     // clear any pending interrupts;
+    TIFR4 = _BV(OCF4A);     // clear any pending interrupts
     TIMSK4 =  _BV(OCIE4A) ; // enable the output compare interrupt
   }
 #endif
@@ -175,7 +175,7 @@ static void initISR(timer16_Sequence_t timer)
     TCCR5A = 0;             // normal counting mode
     TCCR5B = _BV(CS51);     // set prescaler of 8
     TCNT5 = 0;              // clear the timer count
-    TIFR5 = _BV(OCF5A);     // clear any pending interrupts;
+    TIFR5 = _BV(OCF5A);     // clear any pending interrupts
     TIMSK5 =  _BV(OCIE5A) ; // enable the output compare interrupt
   }
 #endif
@@ -202,7 +202,7 @@ static void finISR(timer16_Sequence_t timer)
     timerDetach(TIMER3OUTCOMPAREA_INT);
   }
 #else
-  //For arduino - in future: call here to a currently undefined function to reset the timer
+  //For Arduino - in future: call here to a currently undefined function to reset the timer
   (void) timer;  // squash "unused parameter 'timer' [-Wunused-parameter]" warning
 #endif
 }
@@ -241,7 +241,7 @@ uint8_t Servo::attach(int pin, int min, int max)
     pinMode( pin, OUTPUT) ;                                   // set servo pin to output
     servos[this->servoIndex].Pin.nbr = pin;
     // todo min/max check: abs(min - MIN_PULSE_WIDTH) /4 < 128
-    this->min  = (MIN_PULSE_WIDTH - min)/4; //resolution of min/max is 4 uS
+    this->min  = (MIN_PULSE_WIDTH - min)/4; //resolution of min/max is 4 us
     this->max  = (MAX_PULSE_WIDTH - max)/4;
     // initialize the timer if it has not already been initialized
     timer16_Sequence_t timer = SERVO_INDEX_TO_TIMER(servoIndex);
@@ -315,4 +315,3 @@ bool Servo::attached()
 }
 
 #endif // ARDUINO_ARCH_AVR
-
diff --git a/src/avr/ServoTimers.h b/src/avr/ServoTimers.h
@@ -18,7 +18,7 @@
 */
 
 /*
- * Defines for 16 bit timers used with  Servo library
+ * Defines for 16 bit timers used with Servo library
  *
  * If _useTimerX is defined then TimerX is a 16 bit timer on the current board
  * timer16_Sequence_t enumerates the sequence that the timers should be allocated
@@ -56,4 +56,3 @@ typedef enum { _timer3, _timer1, _Nbr_16timers } timer16_Sequence_t;
 #define _useTimer1
 typedef enum { _timer1, _Nbr_16timers } timer16_Sequence_t;
 #endif
-
diff --git a/src/mbed/Servo.cpp b/src/mbed/Servo.cpp
@@ -40,10 +40,10 @@ class ServoImpl {
 static ServoImpl* servos[MAX_SERVOS];                      // static array of servo structures
 uint8_t ServoCount = 0;                                    // the total number of attached servos
 
-#define SERVO_MIN() (MIN_PULSE_WIDTH - this->min)   // minimum value in uS for this servo
-#define SERVO_MAX() (MAX_PULSE_WIDTH - this->max)   // maximum value in uS for this servo
+#define SERVO_MIN() (MIN_PULSE_WIDTH - this->min)   // minimum value in us for this servo
+#define SERVO_MAX() (MAX_PULSE_WIDTH - this->max)   // maximum value in us for this servo
 
-#define TRIM_DURATION   15                           //callback overhead (35 uS) -> 15uS if toggle() is called after starting the timeout
+#define TRIM_DURATION   15                           //callback overhead (35 us) -> 15 us if toggle() is called after starting the timeout
 
 Servo::Servo()
 {
@@ -130,4 +130,4 @@ bool Servo::attached()
   return servos[this->servoIndex] != NULL;
 }
 
-#endif
+#endif
diff --git a/src/mbed/ServoTimers.h b/src/mbed/ServoTimers.h
@@ -1 +1 @@
-#define _Nbr_16timers 32
+#define _Nbr_16timers 32
diff --git a/src/megaavr/Servo.cpp b/src/megaavr/Servo.cpp
@@ -20,8 +20,8 @@ static volatile int8_t currentServoIndex[_Nbr_16timers];   // index for the serv
 #define SERVO_INDEX(_timer,_channel)  ((_timer*SERVOS_PER_TIMER) + _channel)                     // macro to access servo index by timer and channel
 #define SERVO(_timer,_channel)  (servos[SERVO_INDEX(_timer,_channel)])                           // macro to access servo class by timer and channel
 
-#define SERVO_MIN() (MIN_PULSE_WIDTH - this->min * 4)   // minimum value in uS for this servo
-#define SERVO_MAX() (MAX_PULSE_WIDTH - this->max * 4)   // maximum value in uS for this servo
+#define SERVO_MIN() (MIN_PULSE_WIDTH - this->min * 4)   // minimum value in us for this servo
+#define SERVO_MAX() (MAX_PULSE_WIDTH - this->max * 4)   // maximum value in us for this servo
 
 #undef REFRESH_INTERVAL
 #define REFRESH_INTERVAL 16000
@@ -135,7 +135,7 @@ uint8_t Servo::attach(int pin, int min, int max)
     pinMode(pin, OUTPUT);                                   // set servo pin to output
     servos[this->servoIndex].Pin.nbr = pin;
     // todo min/max check: abs(min - MIN_PULSE_WIDTH) /4 < 128
-    this->min  = (MIN_PULSE_WIDTH - min)/4; //resolution of min/max is 4 uS
+    this->min  = (MIN_PULSE_WIDTH - min)/4; //resolution of min/max is 4 us
     this->max  = (MAX_PULSE_WIDTH - max)/4;
     // initialize the timer if it has not already been initialized
     timer = SERVO_INDEX_TO_TIMER(servoIndex);
@@ -211,4 +211,4 @@ bool Servo::attached()
   return servos[this->servoIndex].Pin.isActive;
 }
 
-#endif
+#endif
diff --git a/src/nrf52/Servo.cpp b/src/nrf52/Servo.cpp
@@ -88,13 +88,13 @@ void Servo::writeMicroseconds(int value)
 {
 	uint8_t channel, instance;
 	uint8_t pin = servos[this->servoIndex].Pin.nbr;
-	//instance of pwm module is MSB - look at VWariant.h
+	//instance of PWM module is MSB - look at VWariant.h
 	instance=(g_APinDescription[pin].ulPWMChannel & 0xF0)/16;
-	//index of pwm channel is LSB - look at VWariant.h
+	//index of PWM channel is LSB - look at VWariant.h
 	channel=g_APinDescription[pin].ulPWMChannel & 0x0F;
 	group_pins[instance][channel]=g_APinDescription[pin].ulPin;
 	NRF_PWM_Type * PWMInstance = instance == 0 ? NRF_PWM0 : (instance == 1 ? NRF_PWM1 : NRF_PWM2);
-	//configure pwm instance and enable it
+	//configure PWM instance and enable it
 	seq_values[instance][channel]= value | 0x8000;
 	nrf_pwm_sequence_t const seq={
 								seq_values[instance],
@@ -131,4 +131,4 @@ bool Servo::attached()
   return servos[this->servoIndex].Pin.isActive;
 }
 
-#endif // ARDUINO_ARCH_NRF52
+#endif // ARDUINO_ARCH_NRF52
diff --git a/src/nrf52/ServoTimers.h b/src/nrf52/ServoTimers.h
@@ -17,15 +17,15 @@
 */
 
 /*
- * NRF52 doesn't use timer, but pwm. This file include definitions to keep
+ * nRF52 doesn't use timer, but PWM. This file include definitions to keep
  * compatibility with the Servo library standards.
  */
 
 #ifndef __SERVO_TIMERS_H__
 #define __SERVO_TIMERS_H__
 
 /**
- * NRF52 Only definitions
+ * nRF52 only definitions
  * ---------------------
  */
 
@@ -35,4 +35,4 @@
 // define one timer in order to have MAX_SERVOS = 12
 typedef enum { _timer1, _Nbr_16timers } timer16_Sequence_t;
 
-#endif   // __SERVO_TIMERS_H__
+#endif   // __SERVO_TIMERS_H__
diff --git a/src/sam/Servo.cpp b/src/sam/Servo.cpp
diff --git a/src/sam/ServoTimers.h b/src/sam/ServoTimers.h
diff --git a/src/samd/Servo.cpp b/src/samd/Servo.cpp
diff --git a/src/samd/ServoTimers.h b/src/samd/ServoTimers.h
diff --git a/src/stm32f4/ServoTimers.h b/src/stm32f4/ServoTimers.h

Original file line number	Diff line number	Diff line change
`@@ -20,8 +20,7 @@ void setup() {`
`20`	`20`
`21`	`21`	`void loop() {`
`22`	`22`	`val = analogRead(potpin); // reads the value of the potentiometer (value between 0 and 1023)`
`23`		`- val = map(val, 0, 1023, 0, 180); // scale it to use it with the servo (value between 0 and 180)`
	`23`	`+ val = map(val, 0, 1023, 0, 180); // scale it for use with the servo (value between 0 and 180)`
`24`	`24`	`myservo.write(val); // sets the servo position according to the scaled value`
`25`	`25`	`delay(15); // waits for the servo to get there`
`26`	`26`	`}`
`27`		`-`