Merge pull request #37 from alranel/master

Port documentation to repository - DO NOT MERGE

Author: matteosuppo

docs/api.md

@@ -0,0 +1,181 @@
+# Servo library
+
+## Methods
+
+### `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.
+
+#### Syntax
+
+```
+servo.attach(pin) 
+servo.attach(pin, min, max)
+```
+
+#### Parameters
+
+* _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)
+
+#### Example
+
+```
+#include <Servo.h> 
+
+Servo myservo;
+
+void setup() 
+{ 
+  myservo.attach(9);
+} 
+
+void loop() {} 
+```
+
+#### See also
+
+* [attached()](#attached)
+* [detach()](#detach)
+
+### `write()`
+
+Writes a value to the servo, controlling the shaft accordingly. On a standard servo, this will set the angle of the shaft (in degrees), moving the shaft to that orientation. On a continuous rotation servo, this will set the speed of the servo (with 0 being full-speed in one direction, 180 being full speed in the other, and a value near 90 being no movement).
+
+#### Syntax
+
+```
+servo.write(angle)
+```
+
+#### Parameters
+
+* _servo_: a variable of type Servo
+* _angle_: the value to write to the servo, from 0 to 180
+
+#### Example
+
+````
+#include <Servo.h> 
+
+Servo myservo;
+
+void setup() 
+{ 
+  myservo.attach(9);
+  myservo.write(90);  // set servo to mid-point
+} 
+
+void loop() {} 
+````
+#### See also
+
+* [attach()](#attach)
+* [read()](#read)
+
+### `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.
+
+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.
+
+Continuous-rotation servos will respond to the writeMicrosecond function in an analogous manner to the write function.
+
+#### Syntax
+
+````
+servo.writeMicroseconds(uS)
+````
+
+#### Parameters
+
+* _servo_: a variable of type Servo
+* _uS_: the value of the parameter in microseconds (int)
+
+#### Example
+
+````
+#include <Servo.h> 
+
+Servo myservo;
+
+void setup() 
+{ 
+  myservo.attach(9);
+  myservo.writeMicroseconds(1500);  // set servo to mid-point
+} 
+
+void loop() {} 
+````
+
+#### See also
+
+* [attach()](#attach)
+* [read()](#read)
+
+
+### `read()`
+
+Read the current angle of the servo (the value passed to the last call to [write()](#write)).
+
+#### Syntax
+
+````
+servo.read()
+````
+
+#### Parameters
+
+* _servo_: a variable of type `Servo`
+
+#### Returns
+
+The angle of the servo, from 0 to 180 degrees.
+
+#### See also
+
+* [write()](#write)
+
+### `attached()`
+
+Check whether the Servo variable is attached to a pin.
+
+#### Syntax
+
+```
+servo.attached()
+```
+
+#### Parameters
+
+* _servo_: a variable of type `Servo`
+
+#### Returns
+
+`true` if the servo is attached to pin; `false` otherwise.
+
+#### See also
+
+* [attach()](#attach)
+* [detach()](#detach)
+
+### `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).
+
+#### Syntax
+
+```
+servo.detach()
+```
+
+#### Parameters
+
+* _servo_: a variable of type `Servo`
+
+#### See also
+
+* [attach()](#attach)
+* [attached()](#attached)

docs/readme.md

@@ -0,0 +1,21 @@
+# Servo library
+
+
+This library allows an Arduino board to control RC (hobby) servo motors. Servos have integrated gears and a shaft that can be precisely controlled. Standard servos allow the shaft to be positioned at various angles, usually between 0 and 180 degrees. Continuous rotation servos allow the rotation of the shaft to be set to various speeds.
+
+The Servo library supports up to 12 motors on most Arduino boards and 48 on the Arduino Mega. On boards other than the Mega, use of the library disables `analogWrite()` (PWM) functionality on pins 9 and 10, whether or not there is a Servo on those pins. On the Mega, up to 12 servos can be used without interfering with PWM functionality; use of 12 to 23 motors will disable PWM on pins 11 and 12. 
+
+To use this library:
+
+```
+#include <Servo.h>
+```
+
+## 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.
+
+## 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

examples/Knob/images/knob_BB.png

@@ -0,0 +1,35 @@
+# Knob
+
+Control the position of a RC (hobby) [servo motor](http://en.wikipedia.org/wiki/Servo_motor#RC_servos) with your Arduino and a potentiometer.
+
+This example makes use of the Arduino `Servo` library.
+
+## Hardware Required
+
+* an Arduino board
+* Servo motor
+* 10k ohm potentiometer
+* hook-up wires
+
+## 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.
+
+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.
+
+![](images/knob_BB.png)
+
+(Images developed using Fritzing. For more circuit examples, see the [Fritzing project page](http://fritzing.org/projects/))
+
+## Schematic
+
+![](images/knob_schem.png)
+
+## See also
+
+* [attach()](/docs/api.md#attach)
+* [write()](/docs/api.md#write)
+* [map()](https://www.arduino.cc/en/Reference/Map)
+* [analogRead()](https://www.arduino.cc/en/Reference/AnalogRead)
+* [Servo library reference](/docs/readme.md)
+* [Sweep](../Sweep) - Sweep the shaft of a servo motor back and forth

examples/Knob/images/knob_schem.png

@@ -0,0 +1,29 @@
+# Sweep
+
+Sweeps the shaft of a RC [servo motor](http://en.wikipedia.org/wiki/Servo_motor#RC_servos) back and forth across 180 degrees.
+
+## Hardware Required
+
+* Arduino Board
+* Servo Motor
+* Hook-up wires
+
+## 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.
+
+![](images/sweep_bb.png)
+
+(Images developed using Fritzing. For more circuit examples, see the [Fritzing project page](http://fritzing.org/projects/))
+
+## Schematic
+
+![](images/sweep_schem.png)
+
+## See also
+
+* [attach()](/docs/api.md#attach)
+* [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