Skip to content

DigisparkTinyPpmReader

Directory actions

More options

Directory actions

More options

Latest commit

 

History

History
 
 

DigisparkTinyPpmReader

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
examples
examples
 
 
Readme.md
Readme.md
 
 
TinyPpmReader.cpp
TinyPpmReader.cpp
 
 
TinyPpmReader.h
TinyPpmReader.h
 
 
keywords.txt
keywords.txt
 
 

Readme.md

TinyPpmReader library

TinyPpmReader is an interrupt-driven RC PPM reader library relying on TinyPinChange library: this means the PPM frame input pin shall support pin change interrupt.

This PPM reader can extract up to 9 RC channels and supports positive and negative PPM modulation.

Some examples of use cases:

  • Standalone RC PPM reader
  • Channel substitution in an existing PPM frame (in conjunction with TinyPpmGen library)
  • Channels addition to an existing PPM frame: eg. read 4 channels and generate 6 channels (in conjunction with TinyPpmGen library)
  • Digital data transmission over PPM (in conjunction with TinyPpmGen library)

Supported Arduinos:

  • ATtiny167 (Standalone or Digispark pro)
  • ATtiny85 (Standalone or Digispark)
  • ATmega368P (UNO)
  • ATmega2560 (MEGA)
  • ATmega32U4 (Leonardo, Micro, Pro Micro)

Tip and Tricks:

Develop your project on an arduino UNO, and then shrink it by loading the sketch in an ATtiny or Digispark (pro).

API/methods:

  • TinyPpmReader: The object constructor

  • uint8_t attach(uint8_t PpmInputPin): attach the TinyPpmReader object to a pin. With:

    • PpmInputPin: The PPM input pin. The modulation can be Positive or Negative: it doesn't matter, since sampling on rising edges or on falling edges is equivalent.
    • Returns 1 in case of success, and 0 if the PpmInputPin doesn't support pin change interrupt (unusable pin).

  • uint8_t detectedChannelNb(): returns the number of detected RC channels in the PPM frame.

  • uint16_t width_us(uint8_t Ch): With:

    • Ch: The Channel (from 1 to Detected Channel Number).
    • Returns the requested channel pulse width in µs

  • uint16_t ppmPeriod_us():

    • Returns the measured PPM period in µs

  • uint8_t isSynchro():

    • PPM Synchronization indicator: indicates that the largest pulse value (Synchro) has just been received. This is a "clear on read" fonction (no need to clear explicitely the indicator).

  • suspend(): supends the PPM acquisition. This can be useful whilst displaying results through a software serial port which disables interrupts during character transmission.

  • resume(): resumes the PPM acquisition.

Design considerations:

As this library relies on TinyPinChange library, see TinyPinChange library to check for the supported input pins depending of the target: for example, not all the arduino MEGA pins are supported pin change interrupt.

Contact

If you have some ideas of enhancement, please contact me by clicking on: RC Navy.