| 1 |
ron |
1 |
/**
|
|
|
2 |
* Marlin 3D Printer Firmware
|
|
|
3 |
* Copyright (C) 2016 MarlinFirmware [https://github.com/MarlinFirmware/Marlin]
|
|
|
4 |
*
|
|
|
5 |
* Based on Sprinter and grbl.
|
|
|
6 |
* Copyright (C) 2011 Camiel Gubbels / Erik van der Zalm
|
|
|
7 |
*
|
|
|
8 |
* This program is free software: you can redistribute it and/or modify
|
|
|
9 |
* it under the terms of the GNU General Public License as published by
|
|
|
10 |
* the Free Software Foundation, either version 3 of the License, or
|
|
|
11 |
* (at your option) any later version.
|
|
|
12 |
*
|
|
|
13 |
* This program is distributed in the hope that it will be useful,
|
|
|
14 |
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
|
15 |
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
|
16 |
* GNU General Public License for more details.
|
|
|
17 |
*
|
|
|
18 |
* You should have received a copy of the GNU General Public License
|
|
|
19 |
* along with this program. If not, see <http://www.gnu.org/licenses/>.
|
|
|
20 |
*
|
|
|
21 |
*/
|
|
|
22 |
|
|
|
23 |
/**
|
|
|
24 |
* servo.h - Interrupt driven Servo library for Arduino using 16 bit timers- Version 2
|
|
|
25 |
* Copyright (c) 2009 Michael Margolis. All right reserved.
|
|
|
26 |
*
|
|
|
27 |
* This library is free software; you can redistribute it and/or
|
|
|
28 |
* modify it under the terms of the GNU Lesser General Public
|
|
|
29 |
* License as published by the Free Software Foundation; either
|
|
|
30 |
* version 2.1 of the License, or (at your option) any later version.
|
|
|
31 |
*
|
|
|
32 |
* This library is distributed in the hope that it will be useful,
|
|
|
33 |
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
|
34 |
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
|
35 |
* Lesser General Public License for more details.
|
|
|
36 |
*
|
|
|
37 |
* You should have received a copy of the GNU Lesser General Public
|
|
|
38 |
* License along with this library; if not, write to the Free Software
|
|
|
39 |
* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
|
|
|
40 |
*/
|
|
|
41 |
|
|
|
42 |
/**
|
|
|
43 |
*
|
|
|
44 |
* A servo is activated by creating an instance of the Servo class passing the desired pin to the attach() method.
|
|
|
45 |
* The servos are pulsed in the background using the value most recently written using the write() method
|
|
|
46 |
*
|
|
|
47 |
* Note that analogWrite of PWM on pins associated with the timer are disabled when the first servo is attached.
|
|
|
48 |
* Timers are seized as needed in groups of 12 servos - 24 servos use two timers, 48 servos will use four.
|
|
|
49 |
* The sequence used to seize timers is defined in timers.h
|
|
|
50 |
*
|
|
|
51 |
* The methods are:
|
|
|
52 |
*
|
|
|
53 |
* Servo - Class for manipulating servo motors connected to Arduino pins.
|
|
|
54 |
*
|
|
|
55 |
* attach(pin ) - Attaches a servo motor to an i/o pin.
|
|
|
56 |
* attach(pin, min, max ) - Attaches to a pin setting min and max values in microseconds
|
|
|
57 |
* default min is 544, max is 2400
|
|
|
58 |
*
|
|
|
59 |
* write() - Sets the servo angle in degrees. (invalid angle that is valid as pulse in microseconds is treated as microseconds)
|
|
|
60 |
* writeMicroseconds() - Sets the servo pulse width in microseconds
|
|
|
61 |
* read() - Gets the last written servo pulse width as an angle between 0 and 180.
|
|
|
62 |
* readMicroseconds() - Gets the last written servo pulse width in microseconds. (was read_us() in first release)
|
|
|
63 |
* attached() - Returns true if there is a servo attached.
|
|
|
64 |
* detach() - Stops an attached servos from pulsing its i/o pin.
|
|
|
65 |
* move(angle) - Sequence of attach(0), write(angle),
|
|
|
66 |
* With DEACTIVATE_SERVOS_AFTER_MOVE wait SERVO_DELAY and detach.
|
|
|
67 |
*/
|
|
|
68 |
|
|
|
69 |
#ifndef SERVO_H
|
|
|
70 |
#define SERVO_H
|
|
|
71 |
|
|
|
72 |
#include <inttypes.h>
|
|
|
73 |
|
|
|
74 |
/**
|
|
|
75 |
* Defines for 16 bit timers used with Servo library
|
|
|
76 |
*
|
|
|
77 |
* If _useTimerX is defined then TimerX is a 16 bit timer on the current board
|
|
|
78 |
* timer16_Sequence_t enumerates the sequence that the timers should be allocated
|
|
|
79 |
* _Nbr_16timers indicates how many 16 bit timers are available.
|
|
|
80 |
*
|
|
|
81 |
*/
|
|
|
82 |
|
|
|
83 |
// Say which 16 bit timers can be used and in what order
|
|
|
84 |
#if defined(__AVR_ATmega1280__) || defined(__AVR_ATmega2560__)
|
|
|
85 |
//#define _useTimer1 // Timer 1 is used by the stepper ISR
|
|
|
86 |
#define _useTimer3
|
|
|
87 |
#define _useTimer4
|
|
|
88 |
#if !HAS_MOTOR_CURRENT_PWM
|
|
|
89 |
#define _useTimer5 // Timer 5 is used for motor current PWM and can't be used for servos.
|
|
|
90 |
#endif
|
|
|
91 |
#elif defined(__AVR_ATmega32U4__)
|
|
|
92 |
#define _useTimer3
|
|
|
93 |
#elif defined(__AVR_AT90USB646__) || defined(__AVR_AT90USB1286__)
|
|
|
94 |
#define _useTimer3
|
|
|
95 |
#elif defined(__AVR_ATmega128__) || defined(__AVR_ATmega1281__) || defined(__AVR_ATmega1284P__) || defined(__AVR_ATmega2561__)
|
|
|
96 |
#define _useTimer3
|
|
|
97 |
#else
|
|
|
98 |
// everything else
|
|
|
99 |
#endif
|
|
|
100 |
|
|
|
101 |
typedef enum {
|
|
|
102 |
#if ENABLED(_useTimer1)
|
|
|
103 |
_timer1,
|
|
|
104 |
#endif
|
|
|
105 |
#if ENABLED(_useTimer3)
|
|
|
106 |
_timer3,
|
|
|
107 |
#endif
|
|
|
108 |
#if ENABLED(_useTimer4)
|
|
|
109 |
_timer4,
|
|
|
110 |
#endif
|
|
|
111 |
#if ENABLED(_useTimer5)
|
|
|
112 |
_timer5,
|
|
|
113 |
#endif
|
|
|
114 |
_Nbr_16timers
|
|
|
115 |
} timer16_Sequence_t;
|
|
|
116 |
|
|
|
117 |
#define Servo_VERSION 2 // software version of this library
|
|
|
118 |
|
|
|
119 |
#define MIN_PULSE_WIDTH 544 // the shortest pulse sent to a servo
|
|
|
120 |
#define MAX_PULSE_WIDTH 2400 // the longest pulse sent to a servo
|
|
|
121 |
#define DEFAULT_PULSE_WIDTH 1500 // default pulse width when servo is attached
|
|
|
122 |
#define REFRESH_INTERVAL 20000 // minimum time to refresh servos in microseconds
|
|
|
123 |
|
|
|
124 |
#define SERVOS_PER_TIMER 12 // the maximum number of servos controlled by one timer
|
|
|
125 |
#define MAX_SERVOS (_Nbr_16timers * SERVOS_PER_TIMER)
|
|
|
126 |
|
|
|
127 |
#define INVALID_SERVO 255 // flag indicating an invalid servo index
|
|
|
128 |
|
|
|
129 |
typedef struct {
|
|
|
130 |
uint8_t nbr : 6 ; // a pin number from 0 to 63
|
|
|
131 |
uint8_t isActive : 1 ; // true if this channel is enabled, pin not pulsed if false
|
|
|
132 |
} ServoPin_t;
|
|
|
133 |
|
|
|
134 |
typedef struct {
|
|
|
135 |
ServoPin_t Pin;
|
|
|
136 |
unsigned int ticks;
|
|
|
137 |
} ServoInfo_t;
|
|
|
138 |
|
|
|
139 |
class Servo {
|
|
|
140 |
public:
|
|
|
141 |
Servo();
|
|
|
142 |
int8_t attach(const int pin); // attach the given pin to the next free channel, set pinMode, return channel number (-1 on fail)
|
|
|
143 |
int8_t attach(const int pin, const int min, const int max); // as above but also sets min and max values for writes.
|
|
|
144 |
void detach();
|
|
|
145 |
void write(int value); // if value is < 200 it is treated as an angle, otherwise as pulse width in microseconds
|
|
|
146 |
void writeMicroseconds(int value); // write pulse width in microseconds
|
|
|
147 |
void move(const int value); // attach the servo, then move to value
|
|
|
148 |
// if value is < 200 it is treated as an angle, otherwise as pulse width in microseconds
|
|
|
149 |
// if DEACTIVATE_SERVOS_AFTER_MOVE wait SERVO_DELAY, then detach
|
|
|
150 |
int read(); // returns current pulse width as an angle between 0 and 180 degrees
|
|
|
151 |
int readMicroseconds(); // returns current pulse width in microseconds for this servo (was read_us() in first release)
|
|
|
152 |
bool attached(); // return true if this servo is attached, otherwise false
|
|
|
153 |
|
|
|
154 |
private:
|
|
|
155 |
uint8_t servoIndex; // index into the channel data for this servo
|
|
|
156 |
int8_t min; // minimum is this value times 4 added to MIN_PULSE_WIDTH
|
|
|
157 |
int8_t max; // maximum is this value times 4 added to MAX_PULSE_WIDTH
|
|
|
158 |
};
|
|
|
159 |
|
|
|
160 |
#endif // SERVO_H
|