.. | ||
.github/workflows | ||
examples | ||
test | ||
.arduino-ci.yml | ||
keywords.txt | ||
library.json | ||
library.properties | ||
LICENSE | ||
PulsePattern.cpp | ||
PulsePattern.h | ||
README.md |
PulsePattern
Arduino Library to generate repeating pulse patterns AVR ONLY
Description
This is an experimental library to generate pulse patterns by means of an Arduino UNO. As the library uses AVR hardware timers it is definitely NOT working for ESP or other non-AVR processors.
The library uses timer1 for the timing of the pulses. Therefor the class is implemented with a static instance called PPO. Still by calling init() one can change all parameters of the process. One should note that calling init() forces the timer to stop.
The timer code is based upon the website of Nick Gammon which holds quite a lot of good solid material (Thanks Nick!). https://gammon.com.au/forum/bbshowpost.php?bbtopic_id=123
Use with care.
Interface
- PulsePattern() constructor
- init(pin, *ar, size, level, prescaler) initializer of the Timer1
- pin that outputs the pattern
- array of durations
- size (or part) of the array to be used
- starting level HIGH/LOW
- prescaler, one of the 5 defines from .h file (table below)
- setFactor(perc) percentage = factor to correct timing (relative).
- getFactor() get the internal used factor. Due to rounding it can be slightly different.
- stop() stop the pattern generator
- start() start the pattern generator
- cont() continue the pattern generator from the last stopped place (approx).
- isRunning() status indicator
- worker() must be public otherwise the ISR cannot call it.
There is some bad understood __vector_11() error when worker() is private.
Prescaler constants
Value | Prescaler | Timer1 | notes |
---|---|---|---|
0 | NO_CLOCK | timer off | |
1 | PRESCALE_1 | clk / 1 | |
2 | PRESCALE_8 | clk / 8 | |
3 | PRESCALE_64 | clk / 64 | |
4 | PRESCALE_256 | clk / 250 | |
5 | PRESCALE_1024 | clk / 1024 | about 1 ms / pulse |
6 | EXT_T1_FALLING | T1 = pin 5 | not tested |
7 | EXT_T2_RISING | not tested |
Future
- ESP32 variant of this class (baseclass -> AVR -> ESP class)
- pulse recorder class to record / generate patterns
if time permits ...
Operation
See example