Background - The problem we are solving.
Your Arduino can only do one thing at a time, when one interrupt occurs no others can run until the current one finishes. This can cause problems in RC Projects which use interrupts for three key functions -
1) The Servo Library uses an internal interrupt to generate the servo signals
2) The Interrupts we use to read incoming RC Signals
3) The Arduino interrupt that drives the timing functions millis() and micros()
When two of our interrupts are triggered at the same time, one will be held waiting until the first one finishes. This introduces errors into our input readings and our output servo pulses.
In the example below an interrupt occurs which blocks the servo library from being able to generate the ideal pulses for our Servos and ESCs, instead we end up with an error - the length of the error is directly determined by the length of the interrupt function.
To reduce glitches, ticks and measurement errors in our RC Projects we have to reduce the time we spend in the input and output interrupts.
RCArduinoFastLib
This post provides an improved approach to reading multiple RC Channels and introduces a new servo library which can be used for smoother, faster RC Projects.
The new library has the following features -
1) Upto 18 Servos available on an Arduino UNO - 50% more than the standard Servo library.
2) Does not reset Timer1 allowing for fast and precise timing in RC Projects using a minimal input interrupt routine
3) Support for higher refresh rates of anywhere from 50 to 500Hz depending on the number of servos
4) Uses a more direct method than digitalWrite for faster ISR Execution
5) Reduces servo glitch frequency by 75% and glitch size by a factor of 2 when used with the RCArduino channel reading code.
6) Provides two banks of upto 10 servos with independent refresh rates for each bank, allowing servos and ESCs to be refreshed at different rates in the same project.
How is the new library able to reduce glitches ?
As described in the introduction typical RC Projects include at least three sets of interrupts -
1) The internal interrupt used by the Arduino Servo library
2) To read incoming RC Signals
3) The internal interrupts used by the Arduino millis and micros functions
Interrupt clashes effect the measurement of incoming RC Signals and the generation of the output signal. The worst case is an input signal being used to generate an output where both input and output have been delayed - an error on an error.
The following plot compares an original sketch published on RCArduino with an optimised version using RCArduinoFastLib. The optimised version (red) reduces interrupt clashes by about 75% and reduces glitches result from interrupt clashes to half their original size. The result is a smoother, more stable Project.
The blue line represents the sketch previously published here on RCArduino -
http://rcarduino.blogspot.com/2012/04/how-to-read-multiple-rc-channels-draft.html
The red line represents the current version using RCArduinoFastLib and outlined in this post.
An Optimised example sketch
Using the RCArduinoFastLib combined with the following optimisations will provide you with smoother glitch free RC Projects.
1) PinChangeInt Version 2.01 - The latest version of the PinChangeInt library includes an optimization which saves 2us over previous versions of the library. Download and install PinChangeInt version 2.01 or later from the library home page here - http://code.google.com/p/arduino-pinchangeint/
2) PCintPort::pinState - The Arduino digitalRead function takes around 1.4 us to complete. The pin change int library gives us a member variable PCintPort::pinState which we use to replace digitalRead inside our ISR and save over 1us of processing time.
3) Timer1 - Steps 1) and 2) each gave us a saving of over 1us, and so will step 3. By accessing timer1 directly to measure the incoming pulse width, we can save a few more micros. In order to do this we need to use the RCArduinoFastServo library in place of the standard servo library, swapping the servo libraries also gets us a speed boost in the servo interrupts.
4) By using timer1 directly we can use a two byte value to store our intermediate times instead of a 4 byte long. This halves the number of read,update,store operations in the ISR leading to another speed boost. It also provides a small boost to the loop function.
The RCArduinoFastLib
Over the next few weeks, I will provide some examples of the different ways in which the RCArduinoFastLib can be used. For now, here is a test sketch for reading and outputting three channels.
The sharp eyed will also notice that RCArduinoFastLib includes a PPM Reading class, next week we will look at using this to access the PPM stream inside standard RC receivers for some ultra smooth RC Projects.
Stay tuned ...
Duane B
The test sketch -
The RCArduinoFastLib.h file
The RCArduinoFastLib.cpp file
/*****************************************************************************************************************************
// RCArduinoFastLib by DuaneB is licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 3.0 Unported License.
//
// http://rcarduino.blogspot.com
//
*****************************************************************************************************************************/
#include "arduino.h"
#include "RCArduinoFastLib.h"
/*----------------------------------------------------------------------------------------
This is essentially a derivative of the Arduino Servo Library created by Michael Margolis
As the technique is very similar to the Servo class, it can be useful to study in order
to understand the servo class.
What does the library do ? It uses a very inexpensive and common 4017 Counter IC
To generate pulses to independently drive up to 10 servos from two Arduino Pins
As previously mentioned, the library is based on the techniques used in the Arduino Servo
library created by Michael Margolis. This means that the library uses Timer1 and Timer1 output
compare register A.
OCR1A is linked to digital pin 9 and so we use digital pin 9 to generate the clock signal
for the 4017 counter.
Pin 12 is used as the reset pin.
*/
void CRCArduinoFastServos::setup()
{
m_sCurrentOutputChannelA = 0;
while(m_sCurrentOutputChannelA < RC_CHANNEL_OUT_COUNT)
{
m_ChannelOutA[m_sCurrentOutputChannelA].m_unPulseWidth = microsecondsToTicks(RCARDUINO_SERIAL_SERVO_MAX);
#if defined (MORE_SERVOS_PLEASE)
m_ChannelOutB[m_sCurrentOutputChannelA].m_unPulseWidth = microsecondsToTicks(RCARDUINO_SERIAL_SERVO_MAX);
#endif
m_sCurrentOutputChannelA++;
}
}
// Timer1 Output Compare A interrupt service routine
// call out class member function OCR1A_ISR so that we can
// access out member variables
ISR(TIMER1_COMPA_vect)
{
CRCArduinoFastServos::OCR1A_ISR();
}
void CRCArduinoFastServos::OCR1A_ISR()
{
// If the channel number is >= 10, we need to reset the counter
// and start again from zero.
// to do this we pulse the reset pin of the counter
// this sets output 0 of the counter high, effectivley
// starting the first pulse of our first channel
if(m_sCurrentOutputChannelA >= RC_CHANNEL_OUT_COUNT)
{
// reset our current servo/output channel to 0
m_sCurrentOutputChannelA = 0;
CRCArduinoFastServos::setChannelPinLowA(RC_CHANNEL_OUT_COUNT-1);
}
else
{
CRCArduinoFastServos::setChannelPinLowA(m_sCurrentOutputChannelA-1);
}
CRCArduinoFastServos::setCurrentChannelPinHighA();
// set the duration of the output pulse
CRCArduinoFastServos::setOutputTimerForPulseDurationA();
// done with this channel so move on.
m_sCurrentOutputChannelA++;
}
void CRCArduinoFastServos::setChannelPinLowA(uint8_t sChannel)
{
volatile CPortPin *pPortPin = m_ChannelOutA + sChannel;
if(pPortPin->m_sPinMask)
*pPortPin->m_pPort ^= pPortPin->m_sPinMask;
}
void CRCArduinoFastServos::setCurrentChannelPinHighA()
{
volatile CPortPin *pPortPin = m_ChannelOutA + m_sCurrentOutputChannelA;
if(pPortPin->m_sPinMask)
*pPortPin->m_pPort |= pPortPin->m_sPinMask;
}
// After we set an output pin high, we need to set the timer to comeback for the end of the pulse
void CRCArduinoFastServos::setOutputTimerForPulseDurationA()
{
OCR1A = TCNT1 + m_ChannelOutA[m_sCurrentOutputChannelA].m_unPulseWidth;
}
#if defined(MORE_SERVOS_PLEASE)
// Timer1 Output Compare B interrupt service routine
// call out class member function OCR1B_ISR so that we can
// access out member variables
ISR(TIMER1_COMPB_vect)
{
CRCArduinoFastServos::OCR1B_ISR();
}
void CRCArduinoFastServos::OCR1B_ISR()
{
if(m_sCurrentOutputChannelB >= RC_CHANNEL_OUT_COUNT)
{
// reset our current servo/output channel to 0
m_sCurrentOutputChannelB = 0;
CRCArduinoFastServos::setChannelPinLowB(RC_CHANNEL_OUT_COUNT-1);
}
else
{
CRCArduinoFastServos::setChannelPinLowB(m_sCurrentOutputChannelB-1);
}
CRCArduinoFastServos::setCurrentChannelPinHighB();
// set the duration of the output pulse
CRCArduinoFastServos::setOutputTimerForPulseDurationB();
// done with this channel so move on.
m_sCurrentOutputChannelB++;
}
void CRCArduinoFastServos::setChannelPinLowB(uint8_t sChannel)
{
volatile CPortPin *pPortPin = m_ChannelOutB + sChannel;
if(pPortPin->m_sPinMask)
*pPortPin->m_pPort ^= pPortPin->m_sPinMask;
}
void CRCArduinoFastServos::setCurrentChannelPinHighB()
{
volatile CPortPin *pPortPin = m_ChannelOutB + m_sCurrentOutputChannelB;
if(pPortPin->m_sPinMask)
*pPortPin->m_pPort |= pPortPin->m_sPinMask;
}
// After we set an output pin high, we need to set the timer to comeback for the end of the pulse
void CRCArduinoFastServos::setOutputTimerForPulseDurationB()
{
OCR1B = TCNT1 + m_ChannelOutB[m_sCurrentOutputChannelB].m_unPulseWidth;
}
#endif
// updates a channel to a new value, the class will continue to pulse the channel
// with this value for the lifetime of the sketch or until writeChannel is called
// again to update the value
void CRCArduinoFastServos::writeMicroseconds(uint8_t nChannel,uint16_t unMicroseconds)
{
// dont allow a write to a non existent channel
if(nChannel > RCARDUINO_MAX_SERVOS)
return;
// constraint the value just in case
unMicroseconds = constrain(unMicroseconds,RCARDUINO_SERIAL_SERVO_MIN,RCARDUINO_SERIAL_SERVO_MAX);
#if defined(MORE_SERVOS_PLEASE)
if(nChannel >= RC_CHANNEL_OUT_COUNT)
{
unMicroseconds = microsecondsToTicks(unMicroseconds);
unsigned char sChannel = nChannel-RC_CHANNEL_OUT_COUNT;
// disable interrupts while we update the multi byte value output value
uint8_t sreg = SREG;
cli();
m_ChannelOutB[sChannel].m_unPulseWidth = unMicroseconds;
// enable interrupts
SREG = sreg;
return;
}
#endif
unMicroseconds = microsecondsToTicks(unMicroseconds);
// disable interrupts while we update the multi byte value output value
uint8_t sreg = SREG;
cli();
m_ChannelOutA[nChannel].m_unPulseWidth = unMicroseconds;
// enable interrupts
SREG = sreg;
}
uint16_t CRCArduinoFastServos::ticksToMicroseconds(uint16_t unTicks)
{
return unTicks / 2;
}
uint16_t CRCArduinoFastServos::microsecondsToTicks(uint16_t unMicroseconds)
{
return unMicroseconds * 2;
}
void CRCArduinoFastServos::attach(uint8_t sChannel,uint8_t sPin)
{
if(sChannel >= RCARDUINO_MAX_SERVOS)
return;
#if defined(MORE_SERVOS_PLEASE)
if(sChannel >= RC_CHANNEL_OUT_COUNT)
{
// disable interrupts while we update the multi byte value output value
uint8_t sreg = SREG;
cli();
m_ChannelOutB[sChannel-RC_CHANNEL_OUT_COUNT].m_unPulseWidth = microsecondsToTicks(RCARDUINO_SERIAL_SERVO_DEFAULT);
m_ChannelOutB[sChannel-RC_CHANNEL_OUT_COUNT].m_pPort = getPortFromPin(sPin);
m_ChannelOutB[sChannel-RC_CHANNEL_OUT_COUNT].m_sPinMask = getPortPinMaskFromPin(sPin);
// enable interrupts
SREG = sreg;
pinMode(sPin,OUTPUT);
return;
}
#endif
// disable interrupts while we update the multi byte value output value
uint8_t sreg = SREG;
cli();
m_ChannelOutA[sChannel].m_unPulseWidth = microsecondsToTicks(RCARDUINO_SERIAL_SERVO_DEFAULT);
m_ChannelOutA[sChannel].m_pPort = getPortFromPin(sPin);
m_ChannelOutA[sChannel].m_sPinMask = getPortPinMaskFromPin(sPin);
// enable interrupts
SREG = sreg;
pinMode(sPin,OUTPUT);
}
// this allows us to run different refresh frequencies on channel A and B
// for example servos at a 70Hz rate on A and ESCs at 250Hz on B
void CRCArduinoFastServos::setFrameSpaceA(uint8_t sChannel,uint16_t unMicroseconds)
{
// disable interrupts while we update the multi byte value output value
uint8_t sreg = SREG;
cli();
m_ChannelOutA[sChannel].m_unPulseWidth = microsecondsToTicks(unMicroseconds);
m_ChannelOutA[sChannel].m_pPort = 0;
m_ChannelOutA[sChannel].m_sPinMask = 0;
// enable interrupts
SREG = sreg;
}
#if defined (MORE_SERVOS_PLEASE)
void CRCArduinoFastServos::setFrameSpaceB(uint8_t sChannel,uint16_t unMicroseconds)
{
// disable interrupts while we update the multi byte value output value
uint8_t sreg = SREG;
cli();
m_ChannelOutB[sChannel].m_unPulseWidth = microsecondsToTicks(unMicroseconds);
m_ChannelOutB[sChannel].m_pPort = 0;
m_ChannelOutB[sChannel].m_sPinMask = 0;
// enable interrupts
SREG = sreg;
}
#endif
// Easy to optimise this, but lets keep it readable instead, its short enough.
volatile uint8_t* CRCArduinoFastServos::getPortFromPin(uint8_t sPin)
{
volatile uint8_t* pPort = RC_CHANNELS_NOPORT;
if(sPin <= 7)
{
pPort = &PORTD;
}
else if(sPin <= 13)
{
pPort = &PORTB;
}
else if(sPin <= A5) // analog input pin 5
{
pPort = &PORTC;
}
return pPort;
}
// Easy to optimise this, but lets keep it readable instead, its short enough.
uint8_t CRCArduinoFastServos::getPortPinMaskFromPin(uint8_t sPin)
{
uint8_t sPortPinMask = RC_CHANNELS_NOPIN;
if(sPin <= A5)
{
if(sPin <= 7)
{
sPortPinMask = (1 << sPin);
}
else if(sPin <= 13)
{
sPin -= 8;
sPortPinMask = (1 << sPin);
}
else if(sPin <= A5)
{
sPin -= A0;
sPortPinMask = (1 << sPin);
}
}
return sPortPinMask;
}
void CRCArduinoFastServos::begin()
{
TCNT1 = 0; // clear the timer count
// Initilialise Timer1
TCCR1A = 0; // normal counting mode
TCCR1B = 2; // set prescaler of 64 = 1 tick = 4us
// ENABLE TIMER1 OCR1A INTERRUPT to enabled the first bank (A) of ten servos
TIFR1 |= _BV(OCF1A); // clear any pending interrupts;
TIMSK1 |= _BV(OCIE1A) ; // enable the output compare interrupt
#if defined(MORE_SERVOS_PLEASE)
// ENABLE TIMER1 OCR1B INTERRUPT to enable the second bank (B) of 10 servos
TIFR1 |= _BV(OCF1B); // clear any pending interrupts;
TIMSK1 |= _BV(OCIE1B) ; // enable the output compare interrupt
#endif
OCR1A = TCNT1 + 4000; // Start in two milli seconds
for(uint8_t sServo = 0;sServo<RC_CHANNEL_OUT_COUNT;sServo++)
{
Serial.println(m_ChannelOutA[sServo].m_unPulseWidth);
#if defined(MORE_SERVOS_PLEASE)
Serial.println(m_ChannelOutB[sServo].m_unPulseWidth);
#endif
}
}
volatile CRCArduinoFastServos::CPortPin CRCArduinoFastServos::m_ChannelOutA[RC_CHANNEL_OUT_COUNT];
uint8_t CRCArduinoFastServos::m_sCurrentOutputChannelA;
#if defined(MORE_SERVOS_PLEASE)
volatile CRCArduinoFastServos::CPortPin CRCArduinoFastServos::m_ChannelOutB[RC_CHANNEL_OUT_COUNT];
uint8_t CRCArduinoFastServos::m_sCurrentOutputChannelB;
#endif
volatile uint16_t CRCArduinoPPMChannels::m_unChannelSignalIn[RC_CHANNEL_IN_COUNT];
uint8_t CRCArduinoPPMChannels::m_sCurrentInputChannel = 0;
uint16_t CRCArduinoPPMChannels::m_unChannelRiseTime = 0;
uint8_t volatile CRCArduinoPPMChannels::m_sOutOfSynchErrorCounter = 0;
void CRCArduinoPPMChannels::begin()
{
m_sOutOfSynchErrorCounter = 0;
attachInterrupt(0,CRCArduinoPPMChannels::INT0ISR,RISING);
}
// we could save a few micros by writting this directly in the signal handler rather than using attach interrupt
void CRCArduinoPPMChannels::INT0ISR()
{
// only ever called for rising edges, so no need to check the pin state
// calculate the interval between this pulse and the last one we received which is recorded in m_unChannelRiseTime
uint16_t ulInterval = TCNT1 - m_unChannelRiseTime;
// if all of the channels have been received we should be expecting the frame space next, lets check it
if(m_sCurrentInputChannel == RC_CHANNEL_IN_COUNT)
{
// we have received all the channels we wanted, this should be the frame space
if(ulInterval < MINIMUM_FRAME_SPACE)
{
// it was not so we need to resynch
forceResynch();
}
else
{
// it was the frame space, next interval will be channel 0
m_sCurrentInputChannel = 0;
}
}
else
{
// if we were expecting a channel, but found a space instead, we need to resynch
if(ulInterval > MAXIMUM_PULSE_SPACE)
{
forceResynch();
}
else
{
// its a good signal, lets record it and move onto the next channel
m_unChannelSignalIn[m_sCurrentInputChannel++] = ulInterval;
}
}
// record the current time
m_unChannelRiseTime = TCNT1;
}
// if we force a resynch we set the channel
void CRCArduinoPPMChannels::forceResynch()
{
m_sCurrentInputChannel = RC_CHANNEL_IN_COUNT;
if(m_sOutOfSynchErrorCounter<255)
m_sOutOfSynchErrorCounter++;
}
uint8_t CRCArduinoPPMChannels::getSynchErrorCounter()
{
uint8_t sErrors = m_sOutOfSynchErrorCounter;
m_sOutOfSynchErrorCounter = 0;
return sErrors;
}
uint16_t CRCArduinoPPMChannels::getChannel(uint8_t sChannel)
{
uint16_t ulPulse;
unsigned char sreg = SREG;
cli();
ulPulse = m_unChannelSignalIn[sChannel];
m_unChannelSignalIn[sChannel] = 0;
SREG = sreg;
return ulPulse>>1;
}
Your Arduino can only do one thing at a time, when one interrupt occurs no others can run until the current one finishes. This can cause problems in RC Projects which use interrupts for three key functions -
1) The Servo Library uses an internal interrupt to generate the servo signals
2) The Interrupts we use to read incoming RC Signals
3) The Arduino interrupt that drives the timing functions millis() and micros()
When two of our interrupts are triggered at the same time, one will be held waiting until the first one finishes. This introduces errors into our input readings and our output servo pulses.
In the example below an interrupt occurs which blocks the servo library from being able to generate the ideal pulses for our Servos and ESCs, instead we end up with an error - the length of the error is directly determined by the length of the interrupt function.
Timing clash between an interrupt and the servo library interrupt
To reduce glitches, ticks and measurement errors in our RC Projects we have to reduce the time we spend in the input and output interrupts.
RCArduinoFastLib
This post provides an improved approach to reading multiple RC Channels and introduces a new servo library which can be used for smoother, faster RC Projects.
The new library has the following features -
1) Upto 18 Servos available on an Arduino UNO - 50% more than the standard Servo library.
2) Does not reset Timer1 allowing for fast and precise timing in RC Projects using a minimal input interrupt routine
3) Support for higher refresh rates of anywhere from 50 to 500Hz depending on the number of servos
4) Uses a more direct method than digitalWrite for faster ISR Execution
5) Reduces servo glitch frequency by 75% and glitch size by a factor of 2 when used with the RCArduino channel reading code.
6) Provides two banks of upto 10 servos with independent refresh rates for each bank, allowing servos and ESCs to be refreshed at different rates in the same project.
How is the new library able to reduce glitches ?
As described in the introduction typical RC Projects include at least three sets of interrupts -
1) The internal interrupt used by the Arduino Servo library
2) To read incoming RC Signals
3) The internal interrupts used by the Arduino millis and micros functions
Interrupt clashes effect the measurement of incoming RC Signals and the generation of the output signal. The worst case is an input signal being used to generate an output where both input and output have been delayed - an error on an error.
The following plot compares an original sketch published on RCArduino with an optimised version using RCArduinoFastLib. The optimised version (red) reduces interrupt clashes by about 75% and reduces glitches result from interrupt clashes to half their original size. The result is a smoother, more stable Project.
The blue line represents the sketch previously published here on RCArduino -
http://rcarduino.blogspot.com/2012/04/how-to-read-multiple-rc-channels-draft.html
The red line represents the current version using RCArduinoFastLib and outlined in this post.
An Optimised example sketch
Using the RCArduinoFastLib combined with the following optimisations will provide you with smoother glitch free RC Projects.
1) PinChangeInt Version 2.01 - The latest version of the PinChangeInt library includes an optimization which saves 2us over previous versions of the library. Download and install PinChangeInt version 2.01 or later from the library home page here - http://code.google.com/p/arduino-pinchangeint/
Original Interrupt Service Routing For Reading An RC Channel Pulse
void calcThrottle()
{
if(digitalRead(THROTTLE_IN_PIN))
{
ulThrottleStart = micros();
}
else
{
unThrottleInShared = (uint16_t)(micros() - ulThrottleStart);
bUpdateFlagsShared |= THROTTLE_FLAG;
}
}
void calcThrottle()
{
if(digitalRead(THROTTLE_IN_PIN))
{
ulThrottleStart = micros();
}
else
{
unThrottleInShared = (uint16_t)(micros() - ulThrottleStart);
bUpdateFlagsShared |= THROTTLE_FLAG;
}
}
2) PCintPort::pinState - The Arduino digitalRead function takes around 1.4 us to complete. The pin change int library gives us a member variable PCintPort::pinState which we use to replace digitalRead inside our ISR and save over 1us of processing time.
3) Timer1 - Steps 1) and 2) each gave us a saving of over 1us, and so will step 3. By accessing timer1 directly to measure the incoming pulse width, we can save a few more micros. In order to do this we need to use the RCArduinoFastServo library in place of the standard servo library, swapping the servo libraries also gets us a speed boost in the servo interrupts.
4) By using timer1 directly we can use a two byte value to store our intermediate times instead of a 4 byte long. This halves the number of read,update,store operations in the ISR leading to another speed boost. It also provides a small boost to the loop function.
Updated ISR
void calcThrottlePulse()
{
if(PCintPort::pinState)
{
unThrottleInStart = TCNT1;
}
else
{
unThrottleInShared = (TCNT1 - unThrottleInStart)>>1;
bUpdateFlagsShared |= THROTTLE_FLAG;
}
}
void calcThrottlePulse()
{
if(PCintPort::pinState)
{
unThrottleInStart = TCNT1;
}
else
{
unThrottleInShared = (TCNT1 - unThrottleInStart)>>1;
bUpdateFlagsShared |= THROTTLE_FLAG;
}
}
Update 04/11/2012- In a forum topic I mentioned to Arduino forum users robtillaart and greygnome that the pin change int library could be improved if a certain part of the code was made optional. The guys took this onboard and as a result the ISR is much now faster while retaining the original functionality. Expect pinchangeint 2.02 to be released shortly.
Forum Topic
http://arduino.cc/forum/index.php/topic,87195.15.html
Resulting improvement in RC signal quality -
The green plot shows the results of repeating the previous test with the modified pinchangeint library combined with RCArduinoFastLib. The graph shows the maximum glitch within a ten second period, the green line hovers between 1 and 2% this means that in many cases the maximum error encountered in a ten second period is only 1%, very few errors over 2% occur. Compare this to the original blue line showing an average error of 3.5% with occasional errors of 4 and 5%.
Forum Topic
http://arduino.cc/forum/index.php/topic,87195.15.html
Resulting improvement in RC signal quality -
The green plot shows the results of repeating the previous test with the modified pinchangeint library combined with RCArduinoFastLib. The graph shows the maximum glitch within a ten second period, the green line hovers between 1 and 2% this means that in many cases the maximum error encountered in a ten second period is only 1%, very few errors over 2% occur. Compare this to the original blue line showing an average error of 3.5% with occasional errors of 4 and 5%.
The RCArduinoFastLib
Over the next few weeks, I will provide some examples of the different ways in which the RCArduinoFastLib can be used. For now, here is a test sketch for reading and outputting three channels.
The sharp eyed will also notice that RCArduinoFastLib includes a PPM Reading class, next week we will look at using this to access the PPM stream inside standard RC receivers for some ultra smooth RC Projects.
Stay tuned ...
Duane B
The test sketch -
#include <RCArduinoFastLib.h>
// MultiChannels
//
// rcarduino.blogspot.com
//
// A simple approach for reading three RC Channels using pin change interrupts
//
// See related posts -
// http://rcarduino.blogspot.co.uk/2012/01/how-to-read-rc-receiver-with.html
// http://rcarduino.blogspot.co.uk/2012/03/need-more-interrupts-to-read-more.html
// http://rcarduino.blogspot.co.uk/2012/01/can-i-control-more-than-x-servos-with.html
//
// rcarduino.blogspot.com
//
// include the pinchangeint library - see the links in the related topics section above for details
#include <PinChangeInt.h>
// Assign your channel in pins
#define THROTTLE_IN_PIN 5
#define STEERING_IN_PIN 6
#define AUX_IN_PIN 7
// Assign your channel out pins
#define THROTTLE_OUT_PIN 8
#define STEERING_OUT_PIN 9
#define AUX_OUT_PIN 10
// Assign servo indexes
#define SERVO_THROTTLE 0
#define SERVO_STEERING 1
#define SERVO_AUX 2
#define SERVO_FRAME_SPACE 3
// These bit flags are set in bUpdateFlagsShared to indicate which
// channels have new signals
#define THROTTLE_FLAG 1
#define STEERING_FLAG 2
#define AUX_FLAG 4
// holds the update flags defined above
volatile uint8_t bUpdateFlagsShared;
// shared variables are updated by the ISR and read by loop.
// In loop we immediatley take local copies so that the ISR can keep ownership of the
// shared ones. To access these in loop
// we first turn interrupts off with noInterrupts
// we take a copy to use in loop and the turn interrupts back on
// as quickly as possible, this ensures that we are always able to receive new signals
volatile uint16_t unThrottleInShared;
volatile uint16_t unSteeringInShared;
volatile uint16_t unAuxInShared;
// These are used to record the rising edge of a pulse in the calcInput functions
// They do not need to be volatile as they are only used in the ISR. If we wanted
// to refer to these in loop and the ISR then they would need to be declared volatile
uint16_t unThrottleInStart;
uint16_t unSteeringInStart;
uint16_t unAuxInStart;
uint16_t unLastAuxIn = 0;
uint32_t ulVariance = 0;
uint32_t ulGetNextSampleMillis = 0;
uint16_t unMaxDifference = 0;
void setup()
{
Serial.begin(115200);
Serial.println("multiChannels");
// attach servo objects, these will generate the correct
// pulses for driving Electronic speed controllers, servos or other devices
// designed to interface directly with RC Receivers
CRCArduinoFastServos::attach(SERVO_THROTTLE,THROTTLE_OUT_PIN);
CRCArduinoFastServos::attach(SERVO_STEERING,STEERING_OUT_PIN);
CRCArduinoFastServos::attach(SERVO_AUX,AUX_OUT_PIN);
// lets set a standard rate of 50 Hz by setting a frame space of 10 * 2000 = 3 Servos + 7 times 2000
CRCArduinoFastServos::setFrameSpaceA(SERVO_FRAME_SPACE,7*2000);
CRCArduinoFastServos::begin();
// using the PinChangeInt library, attach the interrupts
// used to read the channels
PCintPort::attachInterrupt(THROTTLE_IN_PIN, calcThrottle,CHANGE);
PCintPort::attachInterrupt(STEERING_IN_PIN, calcSteering,CHANGE);
PCintPort::attachInterrupt(AUX_IN_PIN, calcAux,CHANGE);
}
void loop()
{
// create local variables to hold a local copies of the channel inputs
// these are declared static so that thier values will be retained
// between calls to loop.
static uint16_t unThrottleIn;
static uint16_t unSteeringIn;
static uint16_t unAuxIn;
// local copy of update flags
static uint8_t bUpdateFlags;
// check shared update flags to see if any channels have a new signal
if(bUpdateFlagsShared)
{
noInterrupts(); // turn interrupts off quickly while we take local copies of the shared variables
// take a local copy of which channels were updated in case we need to use this in the rest of loop
bUpdateFlags = bUpdateFlagsShared;
// in the current code, the shared values are always populated
// so we could copy them without testing the flags
// however in the future this could change, so lets
// only copy when the flags tell us we can.
if(bUpdateFlags & THROTTLE_FLAG)
{
unThrottleIn = unThrottleInShared;
}
if(bUpdateFlags & STEERING_FLAG)
{
unSteeringIn = unSteeringInShared;
}
if(bUpdateFlags & AUX_FLAG)
{
unAuxIn = unAuxInShared;
}
// clear shared copy of updated flags as we have already taken the updates
// we still have a local copy if we need to use it in bUpdateFlags
bUpdateFlagsShared = 0;
interrupts(); // we have local copies of the inputs, so now we can turn interrupts back on
// as soon as interrupts are back on, we can no longer use the shared copies, the interrupt
// service routines own these and could update them at any time. During the update, the
// shared copies may contain junk. Luckily we have our local copies to work with :-)
}
// do any processing from here onwards
// only use the local values unAuxIn, unThrottleIn and unSteeringIn, the shared
// variables unAuxInShared, unThrottleInShared, unSteeringInShared are always owned by
// the interrupt routines and should not be used in loop
// the following code provides simple pass through
// this is a good initial test, the Arduino will pass through
// receiver input as if the Arduino is not there.
// This should be used to confirm the circuit and power
// before attempting any custom processing in a project.
// we are checking to see if the channel value has changed, this is indicated
// by the flags. For the simple pass through we don't really need this check,
// but for a more complex project where a new signal requires significant processing
// this allows us to only calculate new values when we have new inputs, rather than
// on every cycle.
if(bUpdateFlags & THROTTLE_FLAG)
{
CRCArduinoFastServos::writeMicroseconds(SERVO_THROTTLE,unThrottleIn);
}
if(bUpdateFlags & STEERING_FLAG)
{
CRCArduinoFastServos::writeMicroseconds(SERVO_STEERING,unSteeringIn);
}
if(bUpdateFlags & AUX_FLAG)
{
CRCArduinoFastServos::writeMicroseconds(SERVO_AUX,unAuxIn);
}
bUpdateFlags = 0;
}
// simple interrupt service routine
void calcThrottle()
{
if(PCintPort::pinState)
{
unThrottleInStart = TCNT1;
}
else
{
unThrottleInShared = (TCNT1 - unThrottleInStart)>>1;
bUpdateFlagsShared |= THROTTLE_FLAG;
}
}
void calcSteering()
{
if(PCintPort::pinState)
{
unSteeringInStart = TCNT1;
}
else
{
unSteeringInShared = (TCNT1 - unSteeringInStart)>>1;
bUpdateFlagsShared |= STEERING_FLAG;
}
}
void calcAux()
{
if(PCintPort::pinState)
{
unAuxInStart = TCNT1;
}
else
{
unAuxInShared = (TCNT1 - unAuxInStart)>>1;
bUpdateFlagsShared |= AUX_FLAG; }
}
// MultiChannels
//
// rcarduino.blogspot.com
//
// A simple approach for reading three RC Channels using pin change interrupts
//
// See related posts -
// http://rcarduino.blogspot.co.uk/2012/01/how-to-read-rc-receiver-with.html
// http://rcarduino.blogspot.co.uk/2012/03/need-more-interrupts-to-read-more.html
// http://rcarduino.blogspot.co.uk/2012/01/can-i-control-more-than-x-servos-with.html
//
// rcarduino.blogspot.com
//
// include the pinchangeint library - see the links in the related topics section above for details
#include <PinChangeInt.h>
// Assign your channel in pins
#define THROTTLE_IN_PIN 5
#define STEERING_IN_PIN 6
#define AUX_IN_PIN 7
// Assign your channel out pins
#define THROTTLE_OUT_PIN 8
#define STEERING_OUT_PIN 9
#define AUX_OUT_PIN 10
// Assign servo indexes
#define SERVO_THROTTLE 0
#define SERVO_STEERING 1
#define SERVO_AUX 2
#define SERVO_FRAME_SPACE 3
// These bit flags are set in bUpdateFlagsShared to indicate which
// channels have new signals
#define THROTTLE_FLAG 1
#define STEERING_FLAG 2
#define AUX_FLAG 4
// holds the update flags defined above
volatile uint8_t bUpdateFlagsShared;
// shared variables are updated by the ISR and read by loop.
// In loop we immediatley take local copies so that the ISR can keep ownership of the
// shared ones. To access these in loop
// we first turn interrupts off with noInterrupts
// we take a copy to use in loop and the turn interrupts back on
// as quickly as possible, this ensures that we are always able to receive new signals
volatile uint16_t unThrottleInShared;
volatile uint16_t unSteeringInShared;
volatile uint16_t unAuxInShared;
// These are used to record the rising edge of a pulse in the calcInput functions
// They do not need to be volatile as they are only used in the ISR. If we wanted
// to refer to these in loop and the ISR then they would need to be declared volatile
uint16_t unThrottleInStart;
uint16_t unSteeringInStart;
uint16_t unAuxInStart;
uint16_t unLastAuxIn = 0;
uint32_t ulVariance = 0;
uint32_t ulGetNextSampleMillis = 0;
uint16_t unMaxDifference = 0;
void setup()
{
Serial.begin(115200);
Serial.println("multiChannels");
// attach servo objects, these will generate the correct
// pulses for driving Electronic speed controllers, servos or other devices
// designed to interface directly with RC Receivers
CRCArduinoFastServos::attach(SERVO_THROTTLE,THROTTLE_OUT_PIN);
CRCArduinoFastServos::attach(SERVO_STEERING,STEERING_OUT_PIN);
CRCArduinoFastServos::attach(SERVO_AUX,AUX_OUT_PIN);
// lets set a standard rate of 50 Hz by setting a frame space of 10 * 2000 = 3 Servos + 7 times 2000
CRCArduinoFastServos::setFrameSpaceA(SERVO_FRAME_SPACE,7*2000);
CRCArduinoFastServos::begin();
// using the PinChangeInt library, attach the interrupts
// used to read the channels
PCintPort::attachInterrupt(THROTTLE_IN_PIN, calcThrottle,CHANGE);
PCintPort::attachInterrupt(STEERING_IN_PIN, calcSteering,CHANGE);
PCintPort::attachInterrupt(AUX_IN_PIN, calcAux,CHANGE);
}
void loop()
{
// create local variables to hold a local copies of the channel inputs
// these are declared static so that thier values will be retained
// between calls to loop.
static uint16_t unThrottleIn;
static uint16_t unSteeringIn;
static uint16_t unAuxIn;
// local copy of update flags
static uint8_t bUpdateFlags;
// check shared update flags to see if any channels have a new signal
if(bUpdateFlagsShared)
{
noInterrupts(); // turn interrupts off quickly while we take local copies of the shared variables
// take a local copy of which channels were updated in case we need to use this in the rest of loop
bUpdateFlags = bUpdateFlagsShared;
// in the current code, the shared values are always populated
// so we could copy them without testing the flags
// however in the future this could change, so lets
// only copy when the flags tell us we can.
if(bUpdateFlags & THROTTLE_FLAG)
{
unThrottleIn = unThrottleInShared;
}
if(bUpdateFlags & STEERING_FLAG)
{
unSteeringIn = unSteeringInShared;
}
if(bUpdateFlags & AUX_FLAG)
{
unAuxIn = unAuxInShared;
}
// clear shared copy of updated flags as we have already taken the updates
// we still have a local copy if we need to use it in bUpdateFlags
bUpdateFlagsShared = 0;
interrupts(); // we have local copies of the inputs, so now we can turn interrupts back on
// as soon as interrupts are back on, we can no longer use the shared copies, the interrupt
// service routines own these and could update them at any time. During the update, the
// shared copies may contain junk. Luckily we have our local copies to work with :-)
}
// do any processing from here onwards
// only use the local values unAuxIn, unThrottleIn and unSteeringIn, the shared
// variables unAuxInShared, unThrottleInShared, unSteeringInShared are always owned by
// the interrupt routines and should not be used in loop
// the following code provides simple pass through
// this is a good initial test, the Arduino will pass through
// receiver input as if the Arduino is not there.
// This should be used to confirm the circuit and power
// before attempting any custom processing in a project.
// we are checking to see if the channel value has changed, this is indicated
// by the flags. For the simple pass through we don't really need this check,
// but for a more complex project where a new signal requires significant processing
// this allows us to only calculate new values when we have new inputs, rather than
// on every cycle.
if(bUpdateFlags & THROTTLE_FLAG)
{
CRCArduinoFastServos::writeMicroseconds(SERVO_THROTTLE,unThrottleIn);
}
if(bUpdateFlags & STEERING_FLAG)
{
CRCArduinoFastServos::writeMicroseconds(SERVO_STEERING,unSteeringIn);
}
if(bUpdateFlags & AUX_FLAG)
{
CRCArduinoFastServos::writeMicroseconds(SERVO_AUX,unAuxIn);
}
bUpdateFlags = 0;
}
// simple interrupt service routine
void calcThrottle()
{
if(PCintPort::pinState)
{
unThrottleInStart = TCNT1;
}
else
{
unThrottleInShared = (TCNT1 - unThrottleInStart)>>1;
bUpdateFlagsShared |= THROTTLE_FLAG;
}
}
void calcSteering()
{
if(PCintPort::pinState)
{
unSteeringInStart = TCNT1;
}
else
{
unSteeringInShared = (TCNT1 - unSteeringInStart)>>1;
bUpdateFlagsShared |= STEERING_FLAG;
}
}
void calcAux()
{
if(PCintPort::pinState)
{
unAuxInStart = TCNT1;
}
else
{
unAuxInShared = (TCNT1 - unAuxInStart)>>1;
bUpdateFlagsShared |= AUX_FLAG; }
}
The RCArduinoFastLib.h file
/*****************************************************************************************************************************
// RCArduinoFastLib by DuaneB is licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 3.0 Unported License.
//
// http://rcarduino.blogspot.com
//
*****************************************************************************************************************************/
#include "Arduino.h"
// COMMENT OR UNCOMMENT THIS LINE TO ENABLE THE SECOND BANK OF SERVOS
//#define MORE_SERVOS_PLEASE 1
// the first bank of servos uses OC1A - this will disable PWM on digital pin 9 - a small price for 10 fast and smooth servos
// the second bank of servos uses OC1B - this will disable PWM on digital pin 10 - a small price for 10 more fast and smooth servos
// The library blindly pulses all ten servos one and after another
// If you change the RC_CHANNEL_OUT_COUNT to 4 servos, the library will pulse them more frequently than
// it can ten -
// 10 servos at 1500us = 15ms = 66Hz
// 4 Servos at 1500us = 6ms = 166Hz
// if you wanted to go even higher, run two servos on each timer
// 2 Servos at 1500us = 3ms = 333Hz
//
// You might not want a high refresh rate though, so the setFrameSpace function is provided for you to
// add a pause before the library begins its next run through the servos
// for 50 hz, the pause should be to (20,000 - (RC_CHANNEL_OUT_COUNT * 2000))
// Change to set the number of servos/ESCs
#define RC_CHANNEL_OUT_COUNT 4
#if defined (MORE_SERVOS_PLEASE)
#define RCARDUINO_MAX_SERVOS (RC_CHANNEL_OUT_COUNT*2)
#else
#define RCARDUINO_MAX_SERVOS (RC_CHANNEL_OUT_COUNT)
#endif
// Minimum and Maximum servo pulse widths, you could change these,
// Check the servo library and use that range if you prefer
#define RCARDUINO_SERIAL_SERVO_MIN 1000
#define RCARDUINO_SERIAL_SERVO_MAX 2000
#define RCARDUINO_SERIAL_SERVO_DEFAULT 1500
#define RC_CHANNELS_NOPORT 0
#define RC_CHANNELS_PORTB 1
#define RC_CHANNELS_PORTC 2
#define RC_CHANNELS_PORTD 3
#define RC_CHANNELS_NOPIN 255
//////////////////////////////////////////////////////////////////////////////////////////////////////////
//
// CRCArduinoFastServos
//
// A class for generating signals in combination with a 4017 Counter
//
// Output upto 10 Servo channels using just digital pins 9 and 12
// 9 generates the clock signal and must be connected to the clock pin of the 4017
// 12 generates the reset pulse and must be connected to the master reset pin of the 4017
//
// The class uses Timer1, as this prevents use with the servo library
// The class uses pins 9 and 12
// The class does not adjust the servo frame to account for variations in pulse width,
// on the basis that many RC transmitters and receivers designed specifically to operate with servos
// output signals between 50 and 100hz, this is the same range as the library
//
// Use of an additional pin would provide for error detection, however using pin 12 to pulse master reset
// at the end of every frame means that the system is essentially self correcting
//
// Note
// This is a simplified derivative of the Arduino Servo Library created by Michael Margolis
// The simplification has been possible by moving some of the flexibility provided by the Servo library
// from software to hardware.
//
////////////////////////////////////////////////////////////////////////////////////////////////////////////
class CRCArduinoFastServos
{
public:
static void setup();
// configures timer1
static void begin();
// called by the timer interrupt service routine, see the cpp file for details.
static void OCR1A_ISR();
#if defined(MORE_SERVOS_PLEASE)
static void OCR1B_ISR();
#endif
// called to set the pulse width for a specific channel, pulse widths are in microseconds - degrees are for wimps !
static void attach(uint8_t nChannel,uint8_t nPin);
static void writeMicroseconds(uint8_t nChannel,uint16_t nMicroseconds);
static void setFrameSpaceA(uint8_t sChannel,uint16_t unMicroseconds);
static void setFrameSpaceB(uint8_t sChannel,uint16_t unMicroseconds);
protected:
class CPortPin
{
public:
//uint8_t m_sPort;
volatile unsigned char *m_pPort;
uint8_t m_sPinMask;
uint16_t m_unPulseWidth;
};
// this sets the value of the timer1 output compare register to a point in the future
// based on the required pulse with for the current servo
static void setOutputTimerForPulseDurationA() __attribute__((always_inline));
static void setChannelPinLowA(uint8_t sChannel) __attribute__((always_inline));
static void setCurrentChannelPinHighA();
// Easy to optimise this, but lets keep it readable instead, its short enough.
static volatile uint8_t* getPortFromPin(uint8_t sPin) __attribute__((always_inline));
static uint8_t getPortPinMaskFromPin(uint8_t sPin) __attribute__((always_inline));
// Records the current output channel values in timer ticks
// Manually set by calling writeChannel, the function adjusts from
// user supplied micro seconds to timer ticks
volatile static CPortPin m_ChannelOutA[RC_CHANNEL_OUT_COUNT];
// current output channel, used by the timer ISR to track which channel is being generated
static uint8_t m_sCurrentOutputChannelA;
#if defined(MORE_SERVOS_PLEASE)
// Optional channel B for servo number 10 to 19
volatile static CPortPin m_ChannelOutB[RC_CHANNEL_OUT_COUNT];
static uint8_t m_sCurrentOutputChannelB;
static void setOutputTimerForPulseDurationB();
static void setChannelPinLowB(uint8_t sChannel) __attribute__((always_inline));
static void setCurrentChannelPinHighB() __attribute__((always_inline));
#endif
// two helper functions to convert between timer values and microseconds
static uint16_t ticksToMicroseconds(uint16_t unTicks) __attribute__((always_inline));
static uint16_t microsecondsToTicks(uint16_t unMicroseconds) __attribute__((always_inline));
};
// Change to set the number of channels in PPM Input stream
#define RC_CHANNEL_IN_COUNT 3
// two ticks per us, 3000 us * 2 ticks = 6000 minimum frame space
#define MINIMUM_FRAME_SPACE 6000
#define MAXIMUM_PULSE_SPACE 5000
class CRCArduinoPPMChannels
{
public:
static void begin();
static void INT0ISR();
static uint16_t getChannel(uint8_t nChannel);
static uint8_t getSynchErrorCounter();
protected:
static void forceResynch();
static volatile uint16_t m_unChannelSignalIn[RC_CHANNEL_IN_COUNT];
static uint8_t m_sCurrentInputChannel;
static uint16_t m_unChannelRiseTime;
static volatile uint8_t m_sOutOfSynchErrorCounter;
};
// RCArduinoFastLib by DuaneB is licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 3.0 Unported License.
//
// http://rcarduino.blogspot.com
//
*****************************************************************************************************************************/
#include "Arduino.h"
// COMMENT OR UNCOMMENT THIS LINE TO ENABLE THE SECOND BANK OF SERVOS
//#define MORE_SERVOS_PLEASE 1
// the first bank of servos uses OC1A - this will disable PWM on digital pin 9 - a small price for 10 fast and smooth servos
// the second bank of servos uses OC1B - this will disable PWM on digital pin 10 - a small price for 10 more fast and smooth servos
// The library blindly pulses all ten servos one and after another
// If you change the RC_CHANNEL_OUT_COUNT to 4 servos, the library will pulse them more frequently than
// it can ten -
// 10 servos at 1500us = 15ms = 66Hz
// 4 Servos at 1500us = 6ms = 166Hz
// if you wanted to go even higher, run two servos on each timer
// 2 Servos at 1500us = 3ms = 333Hz
//
// You might not want a high refresh rate though, so the setFrameSpace function is provided for you to
// add a pause before the library begins its next run through the servos
// for 50 hz, the pause should be to (20,000 - (RC_CHANNEL_OUT_COUNT * 2000))
// Change to set the number of servos/ESCs
#define RC_CHANNEL_OUT_COUNT 4
#if defined (MORE_SERVOS_PLEASE)
#define RCARDUINO_MAX_SERVOS (RC_CHANNEL_OUT_COUNT*2)
#else
#define RCARDUINO_MAX_SERVOS (RC_CHANNEL_OUT_COUNT)
#endif
// Minimum and Maximum servo pulse widths, you could change these,
// Check the servo library and use that range if you prefer
#define RCARDUINO_SERIAL_SERVO_MIN 1000
#define RCARDUINO_SERIAL_SERVO_MAX 2000
#define RCARDUINO_SERIAL_SERVO_DEFAULT 1500
#define RC_CHANNELS_NOPORT 0
#define RC_CHANNELS_PORTB 1
#define RC_CHANNELS_PORTC 2
#define RC_CHANNELS_PORTD 3
#define RC_CHANNELS_NOPIN 255
//////////////////////////////////////////////////////////////////////////////////////////////////////////
//
// CRCArduinoFastServos
//
// A class for generating signals in combination with a 4017 Counter
//
// Output upto 10 Servo channels using just digital pins 9 and 12
// 9 generates the clock signal and must be connected to the clock pin of the 4017
// 12 generates the reset pulse and must be connected to the master reset pin of the 4017
//
// The class uses Timer1, as this prevents use with the servo library
// The class uses pins 9 and 12
// The class does not adjust the servo frame to account for variations in pulse width,
// on the basis that many RC transmitters and receivers designed specifically to operate with servos
// output signals between 50 and 100hz, this is the same range as the library
//
// Use of an additional pin would provide for error detection, however using pin 12 to pulse master reset
// at the end of every frame means that the system is essentially self correcting
//
// Note
// This is a simplified derivative of the Arduino Servo Library created by Michael Margolis
// The simplification has been possible by moving some of the flexibility provided by the Servo library
// from software to hardware.
//
////////////////////////////////////////////////////////////////////////////////////////////////////////////
class CRCArduinoFastServos
{
public:
static void setup();
// configures timer1
static void begin();
// called by the timer interrupt service routine, see the cpp file for details.
static void OCR1A_ISR();
#if defined(MORE_SERVOS_PLEASE)
static void OCR1B_ISR();
#endif
// called to set the pulse width for a specific channel, pulse widths are in microseconds - degrees are for wimps !
static void attach(uint8_t nChannel,uint8_t nPin);
static void writeMicroseconds(uint8_t nChannel,uint16_t nMicroseconds);
static void setFrameSpaceA(uint8_t sChannel,uint16_t unMicroseconds);
static void setFrameSpaceB(uint8_t sChannel,uint16_t unMicroseconds);
protected:
class CPortPin
{
public:
//uint8_t m_sPort;
volatile unsigned char *m_pPort;
uint8_t m_sPinMask;
uint16_t m_unPulseWidth;
};
// this sets the value of the timer1 output compare register to a point in the future
// based on the required pulse with for the current servo
static void setOutputTimerForPulseDurationA() __attribute__((always_inline));
static void setChannelPinLowA(uint8_t sChannel) __attribute__((always_inline));
static void setCurrentChannelPinHighA();
// Easy to optimise this, but lets keep it readable instead, its short enough.
static volatile uint8_t* getPortFromPin(uint8_t sPin) __attribute__((always_inline));
static uint8_t getPortPinMaskFromPin(uint8_t sPin) __attribute__((always_inline));
// Records the current output channel values in timer ticks
// Manually set by calling writeChannel, the function adjusts from
// user supplied micro seconds to timer ticks
volatile static CPortPin m_ChannelOutA[RC_CHANNEL_OUT_COUNT];
// current output channel, used by the timer ISR to track which channel is being generated
static uint8_t m_sCurrentOutputChannelA;
#if defined(MORE_SERVOS_PLEASE)
// Optional channel B for servo number 10 to 19
volatile static CPortPin m_ChannelOutB[RC_CHANNEL_OUT_COUNT];
static uint8_t m_sCurrentOutputChannelB;
static void setOutputTimerForPulseDurationB();
static void setChannelPinLowB(uint8_t sChannel) __attribute__((always_inline));
static void setCurrentChannelPinHighB() __attribute__((always_inline));
#endif
// two helper functions to convert between timer values and microseconds
static uint16_t ticksToMicroseconds(uint16_t unTicks) __attribute__((always_inline));
static uint16_t microsecondsToTicks(uint16_t unMicroseconds) __attribute__((always_inline));
};
// Change to set the number of channels in PPM Input stream
#define RC_CHANNEL_IN_COUNT 3
// two ticks per us, 3000 us * 2 ticks = 6000 minimum frame space
#define MINIMUM_FRAME_SPACE 6000
#define MAXIMUM_PULSE_SPACE 5000
class CRCArduinoPPMChannels
{
public:
static void begin();
static void INT0ISR();
static uint16_t getChannel(uint8_t nChannel);
static uint8_t getSynchErrorCounter();
protected:
static void forceResynch();
static volatile uint16_t m_unChannelSignalIn[RC_CHANNEL_IN_COUNT];
static uint8_t m_sCurrentInputChannel;
static uint16_t m_unChannelRiseTime;
static volatile uint8_t m_sOutOfSynchErrorCounter;
};
The RCArduinoFastLib.cpp file
/*****************************************************************************************************************************
// RCArduinoFastLib by DuaneB is licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 3.0 Unported License.
//
// http://rcarduino.blogspot.com
//
*****************************************************************************************************************************/
#include "arduino.h"
#include "RCArduinoFastLib.h"
/*----------------------------------------------------------------------------------------
This is essentially a derivative of the Arduino Servo Library created by Michael Margolis
As the technique is very similar to the Servo class, it can be useful to study in order
to understand the servo class.
What does the library do ? It uses a very inexpensive and common 4017 Counter IC
To generate pulses to independently drive up to 10 servos from two Arduino Pins
As previously mentioned, the library is based on the techniques used in the Arduino Servo
library created by Michael Margolis. This means that the library uses Timer1 and Timer1 output
compare register A.
OCR1A is linked to digital pin 9 and so we use digital pin 9 to generate the clock signal
for the 4017 counter.
Pin 12 is used as the reset pin.
*/
void CRCArduinoFastServos::setup()
{
m_sCurrentOutputChannelA = 0;
while(m_sCurrentOutputChannelA < RC_CHANNEL_OUT_COUNT)
{
m_ChannelOutA[m_sCurrentOutputChannelA].m_unPulseWidth = microsecondsToTicks(RCARDUINO_SERIAL_SERVO_MAX);
#if defined (MORE_SERVOS_PLEASE)
m_ChannelOutB[m_sCurrentOutputChannelA].m_unPulseWidth = microsecondsToTicks(RCARDUINO_SERIAL_SERVO_MAX);
#endif
m_sCurrentOutputChannelA++;
}
}
// Timer1 Output Compare A interrupt service routine
// call out class member function OCR1A_ISR so that we can
// access out member variables
ISR(TIMER1_COMPA_vect)
{
CRCArduinoFastServos::OCR1A_ISR();
}
void CRCArduinoFastServos::OCR1A_ISR()
{
// If the channel number is >= 10, we need to reset the counter
// and start again from zero.
// to do this we pulse the reset pin of the counter
// this sets output 0 of the counter high, effectivley
// starting the first pulse of our first channel
if(m_sCurrentOutputChannelA >= RC_CHANNEL_OUT_COUNT)
{
// reset our current servo/output channel to 0
m_sCurrentOutputChannelA = 0;
CRCArduinoFastServos::setChannelPinLowA(RC_CHANNEL_OUT_COUNT-1);
}
else
{
CRCArduinoFastServos::setChannelPinLowA(m_sCurrentOutputChannelA-1);
}
CRCArduinoFastServos::setCurrentChannelPinHighA();
// set the duration of the output pulse
CRCArduinoFastServos::setOutputTimerForPulseDurationA();
// done with this channel so move on.
m_sCurrentOutputChannelA++;
}
void CRCArduinoFastServos::setChannelPinLowA(uint8_t sChannel)
{
volatile CPortPin *pPortPin = m_ChannelOutA + sChannel;
if(pPortPin->m_sPinMask)
*pPortPin->m_pPort ^= pPortPin->m_sPinMask;
}
void CRCArduinoFastServos::setCurrentChannelPinHighA()
{
volatile CPortPin *pPortPin = m_ChannelOutA + m_sCurrentOutputChannelA;
if(pPortPin->m_sPinMask)
*pPortPin->m_pPort |= pPortPin->m_sPinMask;
}
// After we set an output pin high, we need to set the timer to comeback for the end of the pulse
void CRCArduinoFastServos::setOutputTimerForPulseDurationA()
{
OCR1A = TCNT1 + m_ChannelOutA[m_sCurrentOutputChannelA].m_unPulseWidth;
}
#if defined(MORE_SERVOS_PLEASE)
// Timer1 Output Compare B interrupt service routine
// call out class member function OCR1B_ISR so that we can
// access out member variables
ISR(TIMER1_COMPB_vect)
{
CRCArduinoFastServos::OCR1B_ISR();
}
void CRCArduinoFastServos::OCR1B_ISR()
{
if(m_sCurrentOutputChannelB >= RC_CHANNEL_OUT_COUNT)
{
// reset our current servo/output channel to 0
m_sCurrentOutputChannelB = 0;
CRCArduinoFastServos::setChannelPinLowB(RC_CHANNEL_OUT_COUNT-1);
}
else
{
CRCArduinoFastServos::setChannelPinLowB(m_sCurrentOutputChannelB-1);
}
CRCArduinoFastServos::setCurrentChannelPinHighB();
// set the duration of the output pulse
CRCArduinoFastServos::setOutputTimerForPulseDurationB();
// done with this channel so move on.
m_sCurrentOutputChannelB++;
}
void CRCArduinoFastServos::setChannelPinLowB(uint8_t sChannel)
{
volatile CPortPin *pPortPin = m_ChannelOutB + sChannel;
if(pPortPin->m_sPinMask)
*pPortPin->m_pPort ^= pPortPin->m_sPinMask;
}
void CRCArduinoFastServos::setCurrentChannelPinHighB()
{
volatile CPortPin *pPortPin = m_ChannelOutB + m_sCurrentOutputChannelB;
if(pPortPin->m_sPinMask)
*pPortPin->m_pPort |= pPortPin->m_sPinMask;
}
// After we set an output pin high, we need to set the timer to comeback for the end of the pulse
void CRCArduinoFastServos::setOutputTimerForPulseDurationB()
{
OCR1B = TCNT1 + m_ChannelOutB[m_sCurrentOutputChannelB].m_unPulseWidth;
}
#endif
// updates a channel to a new value, the class will continue to pulse the channel
// with this value for the lifetime of the sketch or until writeChannel is called
// again to update the value
void CRCArduinoFastServos::writeMicroseconds(uint8_t nChannel,uint16_t unMicroseconds)
{
// dont allow a write to a non existent channel
if(nChannel > RCARDUINO_MAX_SERVOS)
return;
// constraint the value just in case
unMicroseconds = constrain(unMicroseconds,RCARDUINO_SERIAL_SERVO_MIN,RCARDUINO_SERIAL_SERVO_MAX);
#if defined(MORE_SERVOS_PLEASE)
if(nChannel >= RC_CHANNEL_OUT_COUNT)
{
unMicroseconds = microsecondsToTicks(unMicroseconds);
unsigned char sChannel = nChannel-RC_CHANNEL_OUT_COUNT;
// disable interrupts while we update the multi byte value output value
uint8_t sreg = SREG;
cli();
m_ChannelOutB[sChannel].m_unPulseWidth = unMicroseconds;
// enable interrupts
SREG = sreg;
return;
}
#endif
unMicroseconds = microsecondsToTicks(unMicroseconds);
// disable interrupts while we update the multi byte value output value
uint8_t sreg = SREG;
cli();
m_ChannelOutA[nChannel].m_unPulseWidth = unMicroseconds;
// enable interrupts
SREG = sreg;
}
uint16_t CRCArduinoFastServos::ticksToMicroseconds(uint16_t unTicks)
{
return unTicks / 2;
}
uint16_t CRCArduinoFastServos::microsecondsToTicks(uint16_t unMicroseconds)
{
return unMicroseconds * 2;
}
void CRCArduinoFastServos::attach(uint8_t sChannel,uint8_t sPin)
{
if(sChannel >= RCARDUINO_MAX_SERVOS)
return;
#if defined(MORE_SERVOS_PLEASE)
if(sChannel >= RC_CHANNEL_OUT_COUNT)
{
// disable interrupts while we update the multi byte value output value
uint8_t sreg = SREG;
cli();
m_ChannelOutB[sChannel-RC_CHANNEL_OUT_COUNT].m_unPulseWidth = microsecondsToTicks(RCARDUINO_SERIAL_SERVO_DEFAULT);
m_ChannelOutB[sChannel-RC_CHANNEL_OUT_COUNT].m_pPort = getPortFromPin(sPin);
m_ChannelOutB[sChannel-RC_CHANNEL_OUT_COUNT].m_sPinMask = getPortPinMaskFromPin(sPin);
// enable interrupts
SREG = sreg;
pinMode(sPin,OUTPUT);
return;
}
#endif
// disable interrupts while we update the multi byte value output value
uint8_t sreg = SREG;
cli();
m_ChannelOutA[sChannel].m_unPulseWidth = microsecondsToTicks(RCARDUINO_SERIAL_SERVO_DEFAULT);
m_ChannelOutA[sChannel].m_pPort = getPortFromPin(sPin);
m_ChannelOutA[sChannel].m_sPinMask = getPortPinMaskFromPin(sPin);
// enable interrupts
SREG = sreg;
pinMode(sPin,OUTPUT);
}
// this allows us to run different refresh frequencies on channel A and B
// for example servos at a 70Hz rate on A and ESCs at 250Hz on B
void CRCArduinoFastServos::setFrameSpaceA(uint8_t sChannel,uint16_t unMicroseconds)
{
// disable interrupts while we update the multi byte value output value
uint8_t sreg = SREG;
cli();
m_ChannelOutA[sChannel].m_unPulseWidth = microsecondsToTicks(unMicroseconds);
m_ChannelOutA[sChannel].m_pPort = 0;
m_ChannelOutA[sChannel].m_sPinMask = 0;
// enable interrupts
SREG = sreg;
}
#if defined (MORE_SERVOS_PLEASE)
void CRCArduinoFastServos::setFrameSpaceB(uint8_t sChannel,uint16_t unMicroseconds)
{
// disable interrupts while we update the multi byte value output value
uint8_t sreg = SREG;
cli();
m_ChannelOutB[sChannel].m_unPulseWidth = microsecondsToTicks(unMicroseconds);
m_ChannelOutB[sChannel].m_pPort = 0;
m_ChannelOutB[sChannel].m_sPinMask = 0;
// enable interrupts
SREG = sreg;
}
#endif
// Easy to optimise this, but lets keep it readable instead, its short enough.
volatile uint8_t* CRCArduinoFastServos::getPortFromPin(uint8_t sPin)
{
volatile uint8_t* pPort = RC_CHANNELS_NOPORT;
if(sPin <= 7)
{
pPort = &PORTD;
}
else if(sPin <= 13)
{
pPort = &PORTB;
}
else if(sPin <= A5) // analog input pin 5
{
pPort = &PORTC;
}
return pPort;
}
// Easy to optimise this, but lets keep it readable instead, its short enough.
uint8_t CRCArduinoFastServos::getPortPinMaskFromPin(uint8_t sPin)
{
uint8_t sPortPinMask = RC_CHANNELS_NOPIN;
if(sPin <= A5)
{
if(sPin <= 7)
{
sPortPinMask = (1 << sPin);
}
else if(sPin <= 13)
{
sPin -= 8;
sPortPinMask = (1 << sPin);
}
else if(sPin <= A5)
{
sPin -= A0;
sPortPinMask = (1 << sPin);
}
}
return sPortPinMask;
}
void CRCArduinoFastServos::begin()
{
TCNT1 = 0; // clear the timer count
// Initilialise Timer1
TCCR1A = 0; // normal counting mode
TCCR1B = 2; // set prescaler of 64 = 1 tick = 4us
// ENABLE TIMER1 OCR1A INTERRUPT to enabled the first bank (A) of ten servos
TIFR1 |= _BV(OCF1A); // clear any pending interrupts;
TIMSK1 |= _BV(OCIE1A) ; // enable the output compare interrupt
#if defined(MORE_SERVOS_PLEASE)
// ENABLE TIMER1 OCR1B INTERRUPT to enable the second bank (B) of 10 servos
TIFR1 |= _BV(OCF1B); // clear any pending interrupts;
TIMSK1 |= _BV(OCIE1B) ; // enable the output compare interrupt
#endif
OCR1A = TCNT1 + 4000; // Start in two milli seconds
for(uint8_t sServo = 0;sServo<RC_CHANNEL_OUT_COUNT;sServo++)
{
Serial.println(m_ChannelOutA[sServo].m_unPulseWidth);
#if defined(MORE_SERVOS_PLEASE)
Serial.println(m_ChannelOutB[sServo].m_unPulseWidth);
#endif
}
}
volatile CRCArduinoFastServos::CPortPin CRCArduinoFastServos::m_ChannelOutA[RC_CHANNEL_OUT_COUNT];
uint8_t CRCArduinoFastServos::m_sCurrentOutputChannelA;
#if defined(MORE_SERVOS_PLEASE)
volatile CRCArduinoFastServos::CPortPin CRCArduinoFastServos::m_ChannelOutB[RC_CHANNEL_OUT_COUNT];
uint8_t CRCArduinoFastServos::m_sCurrentOutputChannelB;
#endif
volatile uint16_t CRCArduinoPPMChannels::m_unChannelSignalIn[RC_CHANNEL_IN_COUNT];
uint8_t CRCArduinoPPMChannels::m_sCurrentInputChannel = 0;
uint16_t CRCArduinoPPMChannels::m_unChannelRiseTime = 0;
uint8_t volatile CRCArduinoPPMChannels::m_sOutOfSynchErrorCounter = 0;
void CRCArduinoPPMChannels::begin()
{
m_sOutOfSynchErrorCounter = 0;
attachInterrupt(0,CRCArduinoPPMChannels::INT0ISR,RISING);
}
// we could save a few micros by writting this directly in the signal handler rather than using attach interrupt
void CRCArduinoPPMChannels::INT0ISR()
{
// only ever called for rising edges, so no need to check the pin state
// calculate the interval between this pulse and the last one we received which is recorded in m_unChannelRiseTime
uint16_t ulInterval = TCNT1 - m_unChannelRiseTime;
// if all of the channels have been received we should be expecting the frame space next, lets check it
if(m_sCurrentInputChannel == RC_CHANNEL_IN_COUNT)
{
// we have received all the channels we wanted, this should be the frame space
if(ulInterval < MINIMUM_FRAME_SPACE)
{
// it was not so we need to resynch
forceResynch();
}
else
{
// it was the frame space, next interval will be channel 0
m_sCurrentInputChannel = 0;
}
}
else
{
// if we were expecting a channel, but found a space instead, we need to resynch
if(ulInterval > MAXIMUM_PULSE_SPACE)
{
forceResynch();
}
else
{
// its a good signal, lets record it and move onto the next channel
m_unChannelSignalIn[m_sCurrentInputChannel++] = ulInterval;
}
}
// record the current time
m_unChannelRiseTime = TCNT1;
}
// if we force a resynch we set the channel
void CRCArduinoPPMChannels::forceResynch()
{
m_sCurrentInputChannel = RC_CHANNEL_IN_COUNT;
if(m_sOutOfSynchErrorCounter<255)
m_sOutOfSynchErrorCounter++;
}
uint8_t CRCArduinoPPMChannels::getSynchErrorCounter()
{
uint8_t sErrors = m_sOutOfSynchErrorCounter;
m_sOutOfSynchErrorCounter = 0;
return sErrors;
}
uint16_t CRCArduinoPPMChannels::getChannel(uint8_t sChannel)
{
uint16_t ulPulse;
unsigned char sreg = SREG;
cli();
ulPulse = m_unChannelSignalIn[sChannel];
m_unChannelSignalIn[sChannel] = 0;
SREG = sreg;
return ulPulse>>1;
}
No comments:
Post a Comment