Skip to content

Commit aeef55f

Browse files
authored
Merge pull request #136 from edgar-bonet/doc-read
Doc: clarify that Servo::read() does not read the servo angle
2 parents 1f25386 + 9635b6a commit aeef55f

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

docs/api.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -118,7 +118,9 @@ void loop() {}
118118

119119
### `read()`
120120

121-
Read the current angle of the servo (the value passed to the last call to [write()](#write)).
121+
Read the current setpoint of the servo (the angle passed to the last call to [write()](#write)).
122+
123+
Note that the servo has no way of reporting its current physical orientation. This method returns the angle to which the sketch program has requested the servo to move, regardless of whether the servo has already reached that angle.
122124

123125
#### Syntax
124126

@@ -132,7 +134,7 @@ servo.read()
132134

133135
#### Returns
134136

135-
The angle of the servo, from 0 to 180 degrees.
137+
The setpoint of the servo, as an angle from 0 to 180 degrees.
136138

137139
#### See also
138140

0 commit comments

Comments
 (0)