Skip to content

Commit

Permalink
Servo Library - Updated to work with ZPUino.
Browse files Browse the repository at this point in the history
  • Loading branch information
jackgassett committed May 7, 2015
1 parent 5a34f72 commit 54f6fc7
Show file tree
Hide file tree
Showing 5 changed files with 326 additions and 3 deletions.
55 changes: 55 additions & 0 deletions libraries/Servo/examples/Pan_Tilt/Pan_Tilt.ino
@@ -0,0 +1,55 @@
/*
Gadget Factory - Servo Pan and Tilt
To learn more about using DesignLab please visit http://learn.gadgetfactory.net
Tutorials:
Related library documentation:
Hardware:
Any Papilio board - Works with ZPUino or AVR
Special Notes:
created 2014
by Jack Gassett
http://www.gadgetfactory.net
This example code is in the public domain.
*/

#define circuit ZPUino_Vanilla

#include <Servo.h>
#include <Timer.h>

Servo tilt; // create servo object to control a servo
Servo pan;
// twelve servo objects can be created on most boards

int pos = 0; // variable to store the servo position
int panpos = 0;

void setup()
{
Serial.begin(115200);
tilt.attach(6); // attaches the servo on pin 9 to the servo object
pan.attach(7);
}

void loop()
{
for(pos = 90; pos <= 180; pos += 1) // goes from 0 degrees to 180 degrees
{ // in steps of 1 degree
tilt.write(pos); // tell servo to go to position in variable 'pos'
pan.write(pos);
delay(15); // waits 15ms for the servo to reach the position
}
for(pos = 180; pos>=90; pos-=1) // goes from 180 degrees to 0 degrees
{
tilt.write(pos); // tell servo to go to position in variable 'pos'
pan.write(pos);
delay(15); // waits 15ms for the servo to reach the position
}
}

4 changes: 2 additions & 2 deletions libraries/Servo/library.properties
Expand Up @@ -2,7 +2,7 @@ name=Servo
version=1.0
author=Michael Margolis, Arduino
maintainer=Arduino <info@arduino.cc>
sentence=Allows Arduino boards to control a variety of servo motors. For all Arduino boards.
sentence=Controls a lot of Servos.
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 />
url=http://arduino.cc/en/Reference/Servo
architectures=avr,sam
architectures=avr,sam,zpu20
6 changes: 5 additions & 1 deletion libraries/Servo/src/Servo.h
Expand Up @@ -57,16 +57,20 @@
* timer16_Sequence_t enumerates the sequence that the timers should be allocated
* _Nbr_16timers indicates how many 16 bit timers are available.
*/

// Architecture specific include
#if defined(ARDUINO_ARCH_AVR)
#include "avr/ServoTimers.h"
#elif defined(ARDUINO_ARCH_SAM)
#include "sam/ServoTimers.h"
#elif defined(ZPU)
#include "zpu20/ServoTimers.h"
#else
#error "This library only supports boards with an AVR or SAM processor."
#endif



#define Servo_VERSION 2 // software version of this library

#define MIN_PULSE_WIDTH 544 // the shortest pulse sent to a servo
Expand Down
230 changes: 230 additions & 0 deletions libraries/Servo/src/zpu20/Servo.cpp
@@ -0,0 +1,230 @@
/*
Copyright (c) 2013 Arduino LLC. All right reserved.
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Lesser General Public
License as published by the Free Software Foundation; either
version 2.1 of the License, or (at your option) any later version.
This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public
License along with this library; if not, write to the Free Software
Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
*/
//#define ZPUINO
#if defined(ZPU)

#include <Arduino.h>
#include <Servo.h>
#include <Timer.h>
#include "ServoTimers.h"

#define usToTicks(_us) (( 10 * _us)) // converts microseconds to tick
#define ticksToUs(_ticks) (( (unsigned)_ticks )/ 10 ) // converts from ticks back to microseconds

#define usToHz(_us) (( 1000000/_us)) // converts microseconds to Hz
#define HzToUs(_hz) (( 1000000/_hz) // converts from Hz back to microseconds

#define usToMs(_us) (( _us / 1000)) // converts microseconds to milliseconds
#define msToUs(_hz) (( _ms * 1000) // converts from milliseconds back to microseconds

#define TRIM_DURATION 1 // compensation ticks to trim adjust for digitalWrite delays

static servo_t servos[MAX_SERVOS]; // static array of servo structures

uint8_t ServoCount = 0; // the total number of attached servos

static volatile int8_t Channel[_Nbr_16timers ]; // counter for the servo being pulsed for each timer (or -1 if refresh interval)

// convenience macros
#define SERVO_INDEX_TO_TIMER(_servo_nbr) ((timer16_Sequence_t)(_servo_nbr / SERVOS_PER_TIMER)) // returns the timer controlling this servo
#define SERVO_INDEX_TO_CHANNEL(_servo_nbr) (_servo_nbr % SERVOS_PER_TIMER) // returns the index of the servo on this timer
#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

/************ static functions common to all instances ***********************/

//------------------------------------------------------------------------------
/// Servo handler. Acts when timer in
//------------------------------------------------------------------------------

bool Servo_Handler_0(void*)
{
timer16_Sequence_t timer = _timer1;
if (Channel[timer] < 0) {
//Timers.periodicHz(10000000, Servo_Handler_0, 0, 0); // channel set to -1 indicated that refresh interval completed so reset the timer

} else {
if (SERVO_INDEX(timer,Channel[timer]) < ServoCount && SERVO(timer,Channel[timer]).Pin.isActive == true) {
digitalWrite(SERVO(timer,Channel[timer]).Pin.nbr, LOW); // pulse this channel low if activated
}
}

Channel[timer]++; // increment to the next channel
if( SERVO_INDEX(timer,Channel[timer]) < ServoCount && Channel[timer] < SERVOS_PER_TIMER) {
Timers.timer(timer)->setFrequency(usToHz(ticksToUs(SERVO(timer,Channel[timer]).ticks)));

if(SERVO(timer,Channel[timer]).Pin.isActive == true) { // check if activated
digitalWrite( SERVO(timer,Channel[timer]).Pin.nbr,HIGH); // its an active channel so pulse it high
}
}
else {
Timers.timer(timer)->setFrequency(usToHz(REFRESH_INTERVAL));

Channel[timer] = -1; // this will get incremented at the end of the refresh period to start again at the first channel
}
return true;
}

bool Servo_Handler_1(void*)
{
timer16_Sequence_t timer = _timer2;
if (Channel[timer] < 0) {
//Timers.periodicHz(10000000, Servo_Handler_0, 0, 0); // channel set to -1 indicated that refresh interval completed so reset the timer

} else {
if (SERVO_INDEX(timer,Channel[timer]) < ServoCount && SERVO(timer,Channel[timer]).Pin.isActive == true) {
digitalWrite(SERVO(timer,Channel[timer]).Pin.nbr, LOW); // pulse this channel low if activated
}
}

Channel[timer]++; // increment to the next channel
if( SERVO_INDEX(timer,Channel[timer]) < ServoCount && Channel[timer] < SERVOS_PER_TIMER) {
Timers.timer(timer)->setFrequency(usToHz(ticksToUs(SERVO(timer,Channel[timer]).ticks)));

if(SERVO(timer,Channel[timer]).Pin.isActive == true) { // check if activated
digitalWrite( SERVO(timer,Channel[timer]).Pin.nbr,HIGH); // its an active channel so pulse it high
}
}
else {
Timers.timer(timer)->setFrequency(usToHz(REFRESH_INTERVAL));

Channel[timer] = -1; // this will get incremented at the end of the refresh period to start again at the first channel
}
return true;
}

static void initISR()
{
// Just init the Timer with the initial frequency
Timers.begin();
Timers.periodicHz(usToHz(REFRESH_INTERVAL), Servo_Handler_0, 0, 0); // All channel passed. Waut for refresh time
//Timers.periodicHz(usToHz(REFRESH_INTERVAL), Servo_Handler_1, 0, 1); // Not working for some reason...

}

static boolean isTimerActive(timer16_Sequence_t timer)
{
// returns true if any servo is active on this timer
for(uint8_t channel=0; channel < SERVOS_PER_TIMER; channel++) {
if(SERVO(timer,channel).Pin.isActive == true)
return true;
}
return false;
}

/****************** end of static functions ******************************/

Servo::Servo()
{
if (ServoCount < MAX_SERVOS) {
this->servoIndex = ServoCount++; // assign a servo index to this instance
servos[this->servoIndex].ticks = usToTicks(DEFAULT_PULSE_WIDTH); // store default values
} else {
this->servoIndex = INVALID_SERVO; // too many servos
}
}

uint8_t Servo::attach(int pin)
{
return this->attach(pin, MIN_PULSE_WIDTH, MAX_PULSE_WIDTH);
}

uint8_t Servo::attach(int pin, int min, int max)
{
timer16_Sequence_t timer;

if (this->servoIndex < MAX_SERVOS) {
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->max = (MAX_PULSE_WIDTH - max)/4;
// initialize the timer if it has not already been initialized
timer = SERVO_INDEX_TO_TIMER(servoIndex);
if (isTimerActive(timer) == false) {
initISR();
}
servos[this->servoIndex].Pin.isActive = true; // this must be set after the check for isTimerActive
}
return this->servoIndex;
}

void Servo::detach()
{
timer16_Sequence_t timer;

servos[this->servoIndex].Pin.isActive = false;
timer = SERVO_INDEX_TO_TIMER(servoIndex);
//if(isTimerActive(timer) == false) {
// finISR(timer);
}

void Servo::write(int value)
{
// treat values less than 544 as angles in degrees (valid values in microseconds are handled as microseconds)
if (value < MIN_PULSE_WIDTH)
{
if (value < 0)
value = 0;
else if (value > 180)
value = 180;

value = map(value, 0, 180, SERVO_MIN(), SERVO_MAX());
}
writeMicroseconds(value);
}

void Servo::writeMicroseconds(int value)
{
// calculate and store the values for the given channel
byte channel = this->servoIndex;
if( (channel < MAX_SERVOS) ) // ensure channel is valid
{
if (value < SERVO_MIN()) // ensure pulse width is valid
value = SERVO_MIN();
else if (value > SERVO_MAX())
value = SERVO_MAX();

value = value - TRIM_DURATION;
value = usToTicks(value); // convert to ticks after compensating for interrupt overhead
servos[channel].ticks = value;
}
}

int Servo::read() // return the value as degrees
{
return map(readMicroseconds()+1, SERVO_MIN(), SERVO_MAX(), 0, 180);
}

int Servo::readMicroseconds()
{
unsigned int pulsewidth;
if (this->servoIndex != INVALID_SERVO)
pulsewidth = ticksToUs(servos[this->servoIndex].ticks) + TRIM_DURATION;
else
pulsewidth = 0;

return pulsewidth;
}

bool Servo::attached()
{
return servos[this->servoIndex].Pin.isActive;
}

#endif // ARDUINO_ARCH_SAM
34 changes: 34 additions & 0 deletions libraries/Servo/src/zpu20/ServoTimers.h
@@ -0,0 +1,34 @@
/*
Servo.h - Interrupt driven Servo library for ZPUino- Version 2
Copyright (c) 2009 Michael Margolis. All right reserved.
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Lesser General Public
License as published by the Free Software Foundation; either
version 2.1 of the License, or (at your option) any later version.
This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public
License along with this library; if not, write to the Free Software
Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
*/

/*
* Defines for ZPUino 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
* _Nbr_16timers indicates how many 16 bit timers are available.
*/

/**
* ZPUino Only definitions
* --------------------
*/
#ifndef ServoTimers_h
#define ServoTimers_h

typedef enum { _timer1, _timer2, _Nbr_16timers } timer16_Sequence_t;

#endif

0 comments on commit 54f6fc7

Please sign in to comment.