From c2cc95e30e1f027bed38d57246e1fcfea4a6fbd5 Mon Sep 17 00:00:00 2001 From: midilab Date: Sun, 3 Nov 2024 11:19:02 -0300 Subject: [PATCH] - library interface suggestions for generic fallback support. --- README.md | 17 +++++---- library.json | 2 +- library.properties | 2 +- src/platforms/{generic.h => software.h} | 8 ++-- src/uClock.cpp | 49 +++++++++++++++---------- src/uClock.h | 5 ++- 6 files changed, 50 insertions(+), 33 deletions(-) rename src/platforms/{generic.h => software.h} (76%) diff --git a/README.md b/README.md index e3c496a..4c9568d 100755 --- a/README.md +++ b/README.md @@ -17,22 +17,23 @@ The uClock library API operates through attached callback functions mechanism: 4. **setOnClockStart(onClockStartCallback) > onClockStartCallback()** on uClock Start event 5. **setOnClockStop(onClockStopCallback) > onClockStopCallback()** on uClock Stop event -### (optional) Generic mode - for unsupported boards (or avoiding usage of interrupts) +### (optional) Software Timer mode - for unsupported boards (or avoiding usage of interrupts) If a supported board isn't detected during compilation then a generic fallback approach will be used. This does not utilise any interrupts and so does not ensure accurate timekeeping. This can be useful to port your projects to boards that do not have support in uClock yet, or to test if suspected bugs in your code are related to interactions with interrupts or task handling. -You can force this non-interrupt "generic mode" even on supported boards by defining the build flag `USE_UCLOCK_GENERIC`. +You can force this non-interrupt "software timer mode" even on supported boards by defining the build flag `USE_UCLOCK_SOFTWARE_TIMER`. -In order for generic mode to work, you need to add a call to your `loop()` function to process ticks. For example, +In order for software timer mode to work, you need to add a call to your `loop()` function to process ticks. For example, ```c++ - -// pre-declare this function somewhere, so that compiler knows about it. -void uClockCheckTime(uint32_t micros_time); - void loop() { - uClockCheckTime(micros()); + uClock.run(); // do anything else you need to do inside loop()... + // you can intercalate your main processing with other uClock.run() calls to avoid timming accuracy loss. + //uClock.run(); + // do anything other inside loop()... + //uClock.run(); + // the faster you can call uClock.run() without blocking the better and accurate timming you can achieve. } ``` diff --git a/library.json b/library.json index 20a3781..c66d060 100644 --- a/library.json +++ b/library.json @@ -1,6 +1,6 @@ { "name": "uClock", - "version": "2.1.0", + "version": "2.2.0", "description": "A Library to implement BPM clock tick calls using hardware interruption. Supported and tested on AVR boards(ATmega168/328, ATmega16u4/32u4 and ATmega2560) and ARM boards(Teensy, STM32XX, ESP32, Raspberry Pico, Seedstudio XIAO M0 and RP2040)", "keywords": "bpm, clock, timing, tick, music, generator", "repository": diff --git a/library.properties b/library.properties index 8911b8b..0f4cce0 100755 --- a/library.properties +++ b/library.properties @@ -1,5 +1,5 @@ name=uClock -version=2.1.0 +version=2.2.0 author=Romulo Silva maintainer=Romulo Silva sentence=BPM clock generator for Arduino platform. diff --git a/src/platforms/generic.h b/src/platforms/software.h similarity index 76% rename from src/platforms/generic.h rename to src/platforms/software.h index 4e381a4..1363aeb 100644 --- a/src/platforms/generic.h +++ b/src/platforms/software.h @@ -3,8 +3,10 @@ /* Generic fallback approach that doesn't rely on any particular MCU's interrupts or RTOS threads etc. Simply checks micros() and compares last time tick happened and interval size to determine when a tick is due. - requires calling uClockCheckTime(micros()); inside loop() in order to trigger tick processing. - function signature: void uClockCheckTime(uint32_t micros_time); + requires calling softwareTimerHandler(micros()); inside loop() in order to trigger tick processing. + function signature: void softwareTimerHandler(uint32_t micros_time); + + @author Doctea */ #define ATOMIC(X) X; @@ -16,7 +18,7 @@ uint32_t uclock_last_time_ticked; uint32_t uclock_us_interval; // call this as often as possible to tick the uClock -void uClockCheckTime(uint32_t micros_time) { +void softwareTimerHandler(uint32_t micros_time) { if (micros_time - uclock_last_time_ticked >= uclock_us_interval) { uclock_last_time_ticked = micros_time; uClockHandler(); diff --git a/src/uClock.cpp b/src/uClock.cpp index ffa97a5..9f27935 100755 --- a/src/uClock.cpp +++ b/src/uClock.cpp @@ -2,7 +2,7 @@ * @file uClock.cpp * Project BPM clock generator for Arduino * @brief A Library to implement BPM clock tick calls using hardware interruption. Supported and tested on AVR boards(ATmega168/328, ATmega16u4/32u4 and ATmega2560) and ARM boards(RPI2040, Teensy, Seedstudio XIAO M0 and ESP32) - * @version 2.1.0 + * @version 2.2.0 * @author Romulo Silva * @date 10/06/2017 * @license MIT - (c) 2024 - Romulo Silva - contact@midilab.co @@ -27,10 +27,8 @@ */ #include "uClock.h" -// -// Generic, board-agnostic, not-accurate, no-interrupt, software-only port -// -#if !defined(USE_UCLOCK_GENERIC) +// no hardware timer clock? use USE_UCLOCK_SOFTWARE_TIMER +#if !defined(USE_UCLOCK_SOFTWARE_TIMER) // // General Arduino AVRs port // @@ -66,17 +64,21 @@ #include "platforms/stm32.h" #define UCLOCK_PLATFORM_FOUND #endif + // + // RP2040 (Raspberry Pico) family + // + #if defined(ARDUINO_ARCH_RP2040) + #include "platforms/rp2040.h" + #define UCLOCK_PLATFORM_FOUND + #endif #endif -#if !defined(UCLOCK_PLATFORM_FOUND) - #pragma message ("NOTE: uClock is using the 'generic' approach instead of specific board support, because board is not supported or because of USE_UCLOCK_GENERIC build flag.") - #include "platforms/generic.h" -#endif // -// RP2040 (Raspberry Pico) family +// Software Timer for generic, board-agnostic, not-accurate, no-interrupt, software-only port // -#if defined(ARDUINO_ARCH_RP2040) - #include "platforms/rp2040.h" +#if !defined(UCLOCK_PLATFORM_FOUND) + #pragma message ("NOTE: uClock is using the 'software timer' approach instead of specific board interrupted support, because board is not supported or because of USE_UCLOCK_SOFTWARE_TIMER build flag. Remember to call uClock.run() inside your loop().") + #include "platforms/software.h" #endif @@ -209,13 +211,6 @@ void uClockClass::setTempo(float bpm) setTimerTempo(bpm); } -// this function is based on sync24PPQN -float inline uClockClass::freqToBpm(uint32_t freq) -{ - float usecs = 1/((float)freq/1000000.0); - return (float)((float)(usecs/(float)24) * 60.0); -} - float uClockClass::getTempo() { if (mode == EXTERNAL_CLOCK) { @@ -234,6 +229,22 @@ float uClockClass::getTempo() return tempo; } +// for software timer implementation(fallback for no board support) +void uClockClass::run() +{ +#if !defined(UCLOCK_PLATFORM_FOUND) + // call software timer implementation of software + softwareTimerHandler(micros()); +#endif +} + +// this function is based on sync24PPQN +float inline uClockClass::freqToBpm(uint32_t freq) +{ + float usecs = 1/((float)freq/1000000.0); + return (float)((float)(usecs/(float)24) * 60.0); +} + void uClockClass::setMode(SyncMode tempo_mode) { mode = tempo_mode; diff --git a/src/uClock.h b/src/uClock.h index 9b438c2..df1a08d 100755 --- a/src/uClock.h +++ b/src/uClock.h @@ -2,7 +2,7 @@ * @file uClock.h * Project BPM clock generator for Arduino * @brief A Library to implement BPM clock tick calls using hardware interruption. Supported and tested on AVR boards(ATmega168/328, ATmega16u4/32u4 and ATmega2560) and ARM boards(RPI2040, Teensy, Seedstudio XIAO M0 and ESP32) - * @version 2.1.0 + * @version 2.2.0 * @author Romulo Silva * @date 10/06/2017 * @license MIT - (c) 2024 - Romulo Silva - contact@midilab.co @@ -130,6 +130,9 @@ class uClockClass { void setTempo(float bpm); float getTempo(); + // for software timer implementation(fallback for no board support) + void run(); + // external timming control void setMode(SyncMode tempo_mode); SyncMode getMode();