EdgieD Library v1.0.1

Crunchysteve, ©2024.

Proudly developed in VS Code, by an Apple fanboi, and tested in Wokwi

ALERT - It's been brougfht to my attention that, in an incremental update earlier this year, EdgieD stopped working as multi object code and now only works as a "singleton." Finding this bug is taxing my limited skill. Yeah, that's how we learn I guess, meanwhile, I feel obbliged to recommend people use Bounce2, Bugtton or similar. My apologies. As an amateur and self taught coder, I can't promise a repair will be quick. Hopefully I can get my head around this monster I've created.

I'm also not too proud to ask for help. If anybody can see what I've done wrong and explain it for a "bear of little brain" I will be eternally grateful, even if, like John Cleese's grumpy centurian, you make me write it out 100 times before dawn...

Apologies, Crunchy

Quick Install

For most people, use the Arduino Library Manager in Arduino IDE but...

1. if you strike problems, go to release 1.0.1,
2. download your preference of achive, open ArduinoIDE,
3. open the Sketch/Include Library/Add .ZIP Library menu,
4. navigate to where you downloaded the zip, and click "Install".

For PlatformIO, update ~/[your_project/]/platformio.ini lib_deps parammeter to include https://github.com/crunchysteve/EdgieD-1.0.0.git

I'm still learning this git stuff, I'm a hobbyist coder trying to leave my mark, and I'm both fascinated with git and utterly flabbergasted at the mind boggling complexity of git all at once. A huge thanks to @per1234 for their patient guidance through getting my library updated. I was getting quite "flappy" for a while there, they never gave up on helping me understand. (As of 20240116@1050, I have everything crossed that I've got it right at last. 24 hours or so should tell me.)

What is EdgieD?

Loosely based on the button edge detection tutorial at... https://www.arduino.cc/en/Tutorial/BuiltInExamples/StateChangeDetection

...but generalised for working with variables and other coded binary state changes. It can read digital inputs to detect a button state change, the state change of a variable during runtime, the output state of a timer or the output states of other custom libraries.

The included example detects the default "leading edge" (as pressed) of a button, attached between pin 2 and ground, not changing output state again until released, then pressed again.

It can be used for...

1. timing functions to repeat on a trigger input,
2. debouncing input buttons (use delay() around 5 to 20mS in your test "if()")
3. synchronising output signals to input signals, such as triggering a sinusoid function to run one phase, in sync with the triggering edge of the input. (I'll add that as an example sketch soon, hopefully.)

These are just a few examples!

How It Works

EdgieD compares the states of an input, a variable or output from another function with the previously measured state and whether the edge is leading or trailing, to precisely time function calls to the edge of a frequently changing state. By passing the current state, the previous state (as variables) and the preferred edge (via custom macros, LEADING and TRAILING) to a decalred instance of the library (eg "myEdge.detect(state,oldState,LEADING)" to detect a leading/rising edge), one can time other functions precise to the moment of the state change with no more than normal Arduino latencies. The code is basic C++ with now hardware specific calls, so it should work an anything from an Adafruit to a Wio-Terminal and beyond.

How To Use It In Your Code

• Include the EdgieD library header, ,
• initialise an instance, Edge myEdge;,
• then call it, if(myEdge.detect(test_value,Rising){ // do something }
  • if a Rising edge has been detected, the functions inside the if statement runs,
  • "Rising" is the default state and this parameter can be left out for rising edges,
• the previous edge state is held in a private static variable inside each instance

See the included example, EdgieD_Basic.ino for more details.

EdgieD is non-blocking and only takes as long as its lines of code to run.

The Quick Start guide is available on the wiki, as is the more detailed Documentation and feature roadmap.

Licence

The EdgieD Library is free software, please see "LICENCE". for more details.