v1.4.0 Added New Timed Events and some minor fixes

Author: neroroxxx

boards.local.txt

@@ -7,9 +7,9 @@
 # To locate boards.txt
 
 # On mac, open your Applications folder, right click on Arduino or Teensyduino (which ever you are using)
-# then select "Show Package Contents" and navigate to "Contents/Java/hardware/teensy/avr/boards.txt"
+# then select "Show Package Contents" and navigate to "Contents/Java/hardware/teensy/avr/"
 
-# On Windows: go to "Program Files (x86)/Arduino/hardware/teensy/avr/boards.txt"
+# On Windows: go to "Program Files (x86)/Arduino/hardware/teensy/avr/"
 # After doing this you can restart Teensyduino and you will then see the "Require BMC Config" option under tools
 
 

library.properties

@@ -1,5 +1,5 @@
 name=BMC
-version=1.3.0
+version=1.4.0
 author=Nero Rox
 maintainer=Nero Rox <info@roxxxtar.com>
 sentence=Fully featured MIDI Controller Library with a Companion Editor App for 32-bit Teensy boards, Requires Teensyduino.

src/BMC-Api.h

@@ -181,6 +181,11 @@ class BMCApi : public BMC {
   void onTriggerCustom(void (*fptr)(uint8_t id)){
 #if BMC_MAX_TRIGGERS > 0
     callback.triggerCustom = fptr;
+#endif
+  }
+  void onTimedEventCustom(void (*fptr)(uint8_t id, uint8_t a, uint8_t b, uint8_t c)){
+#if BMC_MAX_TIMED_EVENTS > 0
+    callback.timedEventCustom = fptr;
 #endif
   }
   // triggered when EEPROM has been updated either by the editor or the API

src/BMC-Version.h

@@ -22,7 +22,7 @@
 
 // BMC Version stored in EEPROM (for editor usage)
 #define BMC_VERSION_MAJ 1
-#define BMC_VERSION_MIN 3
+#define BMC_VERSION_MIN 4
 #define BMC_VERSION_PATCH 0
 
 //16 bits unsigned, LSB byte is minor, MSB byte is major

src/BMC.cpp

@@ -52,6 +52,9 @@ BMC::BMC():
   #if BMC_MAX_PIXEL_PROGRAMS > 0
     ,pixelPrograms(store.global)
   #endif
+  #if BMC_MAX_TIMED_EVENTS > 0
+    ,timedEvents(store.global)
+  #endif
   #if BMC_MAX_BUTTONS > 1
     // second argument is true for global buttons
     // to check which callback to use
@@ -170,6 +173,10 @@ void BMC::update(){
     tempoToTap.update();
   #endif
 
+  #if BMC_MAX_TIMED_EVENTS > 0
+    readTimedEvent();
+  #endif
+
   editor.update();
 
   // read the midi input ports

src/BMC.debug.cpp

@@ -235,6 +235,7 @@ void BMC::readDebug(){
     BMC_PRINTLN("BMC_MAX_PRESET_ITEMS", BMC_MAX_PRESET_ITEMS);
     BMC_PRINTLN("BMC_MAX_CUSTOM_SYSEX", BMC_MAX_CUSTOM_SYSEX);
     BMC_PRINTLN("BMC_MAX_TRIGGERS", BMC_MAX_TRIGGERS);
+    BMC_PRINTLN("BMC_MAX_TIMED_EVENTS", BMC_MAX_TIMED_EVENTS);
     BMC_PRINTLN("BMC_MAX_TEMPO_TO_TAP", BMC_MAX_TEMPO_TO_TAP);
     BMC_PRINTLN("BMC_MAX_SKETCH_BYTES", BMC_MAX_SKETCH_BYTES);
     BMC_PRINTLN("BMC_MAX_GLOBAL_BUTTONS", BMC_MAX_GLOBAL_BUTTONS);
@@ -405,6 +406,10 @@ void BMC::readDebug(){
       BMC_PRINTLN("store.global.triggers",sizeof(store.global.triggers),"bytes");
       BMC_PRINTLN("store.global.triggers[0]",sizeof(store.global.triggers[0]),"bytes");
     #endif
+    #if BMC_MAX_TIMED_EVENTS > 0
+      BMC_PRINTLN("store.global.timedEvents",sizeof(store.global.timedEvents),"bytes");
+      BMC_PRINTLN("store.global.timedEvents[0]",sizeof(store.global.timedEvents[0]),"bytes");
+    #endif
     #if BMC_MAX_TEMPO_TO_TAP > 0
       BMC_PRINTLN("store.global.tempoToTap",sizeof(store.global.tempoToTap),"bytes");
       BMC_PRINTLN("store.global.tempoToTap[0]",sizeof(store.global.tempoToTap[0]),"bytes");

src/BMC.editor.cpp

@@ -147,6 +147,12 @@ void BMC::assignSettings(){
     }
   #endif
 
+  #if BMC_MAX_TIMED_EVENTS > 0
+    if(editor.timedEventsUpdated()){
+      timedEvents.buildListeners();
+    }
+  #endif
+
   #if BMC_MAX_BUTTONS > 32
     buttonStates = ~buttonStates;
     buttonStates2 = ~buttonStates2;

src/BMC.h

@@ -141,6 +141,10 @@
 #if BMC_MAX_TRIGGERS > 0
   #include "utility/BMC-Triggers.h"
 #endif
+#if BMC_MAX_TIMED_EVENTS > 0
+  #include "utility/BMC-TimedEvents.h"
+#endif
+
 // see BMC-Api.h for API calls
 class BMC {
 private:
@@ -257,6 +261,12 @@ class BMC {
     BMCTriggers triggers;
 #endif
 
+#if BMC_MAX_TIMED_EVENTS > 0
+    BMCTimedEvents timedEvents;
+#endif
+
+
+
   uint8_t page = 0;
   uint8_t programBank = 0;
 
@@ -324,6 +334,11 @@ class BMC {
   void processTrigger(uint8_t index);
 #endif
 
+#if BMC_MAX_TIMED_EVENTS > 0
+  void readTimedEvent();
+  void processTimedEvent(uint8_t n);
+#endif
+
 // ** HARDWARE **
 // code @ BMC.hardware.cpp
   void setupHardware();

src/BMC.hardware.buttons.cpp

@@ -138,7 +138,7 @@ void BMC::handleButton(uint8_t index, uint8_t t_trigger){
   for(uint8_t e = 0; e < BMC_MAX_BUTTON_EVENTS; e++){
     bmcStoreButtonEvent &data = store.pages[page].buttons[index].events[e];
     uint8_t type = BMC_GET_BYTE(0,data.event);
-    uint8_t trigger = (data.mode & 0x0F)==t_trigger ? t_trigger : BMC_NONE;
+    uint8_t trigger = ((data.mode&0x0F)==t_trigger) ? t_trigger : BMC_NONE;
 
     if(trigger == BMC_NONE || type == BMC_NONE){
       continue;
@@ -781,6 +781,15 @@ void BMC::handleGlobalButton(uint8_t index, uint8_t t_trigger){
         break;
   #endif
 
+  #if BMC_MAX_TIMED_EVENTS > 0
+    case BMC_BUTTON_EVENT_TYPE_TIMED_EVENT:
+      // byteA = timed event Index
+      timedEvents.trigger(byteA);
+      break;
+  #endif
+
+
+
   #if BMC_MAX_LIBRARY > 0
       case BMC_BUTTON_EVENT_TYPE_LIBRARY:
         // byteA = index of the library item

src/BMC.timedEvents.cpp

@@ -0,0 +1,122 @@
+/*
+  See https://www.RoxXxtar.com/bmc for more details
+  Copyright (c) 2020 RoxXxtar.com
+  Licensed under the MIT license.
+  See LICENSE file in the project root for full license information.
+*/
+#include <BMC.h>
+
+#if BMC_MAX_TIMED_EVENTS > 0
+  void BMC::readTimedEvent(){
+    if(timedEvents.available()==0){
+      return;
+    }
+    for(uint8_t index = 0, n=timedEvents.available(); index < n; index++){
+      if(timedEvents.isReady(index)){
+        processTimedEvent(index);
+      }
+    }
+  }
+  void BMC::processTimedEvent(uint8_t n){
+    // ready to trigger
+    if(n>=BMC_MAX_TIMED_EVENTS){
+      return;
+    }
+    uint32_t event = store.global.timedEvents[n].event;
+    switch(BMC_GET_BYTE(0, event)){
+      case BMC_NONE:
+        return;
+      case BMC_TIMED_EVENT_TYPE_LIBRARY:
+#if BMC_MAX_LIBRARY>0
+        // byteA = index of the library item
+        library.send(BMC_EVENT_TO_LIBRARY_NUM(event>>8));
+#endif
+        break;
+      case BMC_TIMED_EVENT_TYPE_LIBRARY2:
+#if BMC_MAX_LIBRARY>1
+        // byteA = index of the 1st library item to send
+        // byteB = index of the 2nd library item to send
+        library.send(BMC_EVENT_TO_LIBRARY_NUM(event>>8), BMC_EVENT_TO_LIBRARY_NUM(event>>18));
+#endif
+        break;
+      case BMC_TIMED_EVENT_TYPE_RELAY_NL_CONTROL:
+#if BMC_MAX_NL_RELAYS>0
+        if(BMC_GET_BYTE(1, event) < BMC_MAX_NL_RELAYS){
+          relaysNL[BMC_GET_BYTE(1, event)].command(BMC_GET_BYTE(2, event));
+        }
+#endif
+        break;
+      case BMC_TIMED_EVENT_TYPE_RELAY_L_CONTROL:
+#if BMC_MAX_L_RELAYS>0
+        if(BMC_GET_BYTE(1, event) < BMC_MAX_L_RELAYS){
+          relaysL[BMC_GET_BYTE(1, event)].command(BMC_GET_BYTE(2, event));
+        }
+#endif
+        break;
+      case BMC_TIMED_EVENT_TYPE_BUTTON_EVENT:
+#if BMC_MAX_BUTTONS > 0
+        {
+          uint8_t btnN = BMC_GET_BYTE(1, event);
+          uint8_t btnEventN = BMC_GET_BYTE(2, event);
+          bmcStoreButtonEvent &data = store.pages[page].buttons[btnN].events[btnEventN];
+          uint8_t type = BMC_GET_BYTE(0,data.event);
+          if(type!=BMC_NONE){
+            handleButtonEvent(type, data);
+          }
+        }
+#endif
+        break;
+      case BMC_TIMED_EVENT_TYPE_GLOBAL_BUTTON_EVENT:
+#if BMC_MAX_GLOBAL_BUTTONS > 0
+        {
+          uint8_t btnN = BMC_GET_BYTE(1, event);
+          uint8_t btnEventN = BMC_GET_BYTE(2, event);
+          bmcStoreButtonEvent &data = globalData.buttons[btnN].events[btnEventN];
+          uint8_t type = BMC_GET_BYTE(0,data.event);
+          if(type!=BMC_NONE){
+            handleButtonEvent(type, data);
+          }
+        }
+#endif
+        break;
+      case BMC_TIMED_EVENT_TYPE_ENCODER:
+#if BMC_MAX_ENCODERS > 0
+        {
+          uint8_t enc   = BMC_GET_BYTE(1, event);
+          uint8_t inc   = BMC_GET_BYTE(2, event);
+          uint8_t type  = BMC_GET_BYTE(0, store.pages[page].encoders[enc].event);
+          if(type!=BMC_NONE){
+            handleEncoder(store.pages[page].encoders[enc], inc);
+          }
+        }
+#endif
+        break;
+      case BMC_TIMED_EVENT_TYPE_GLOBAL_ENCODER:
+#if BMC_MAX_GLOBAL_ENCODERS > 0
+        {
+          uint8_t enc   = BMC_GET_BYTE(1, event);
+          uint8_t inc   = BMC_GET_BYTE(2, event);
+          uint8_t type  = BMC_GET_BYTE(0, globalData.encoders[enc].event);
+          if(type!=BMC_NONE){
+            handleEncoder(globalData.encoders[enc], inc);
+          }
+        }
+#endif
+        break;
+      case BMC_TIMED_EVENT_TYPE_PAGE:
+#if BMC_MAX_GLOBAL_ENCODERS > 1
+        setPage(BMC_GET_BYTE(1, event));
+#endif
+        break;
+      case BMC_TIMED_EVENT_TYPE_MASTER_CLOCK:
+        midiClock.setBpm((event >> 8) & 0x1FF);
+        break;
+      case BMC_TIMED_EVENT_TYPE_CUSTOM:
+        callback.timedEventCustom(n,
+                              BMC_GET_BYTE(1,event),
+                              BMC_GET_BYTE(2,event),
+                              BMC_GET_BYTE(3,event));
+        break;
+    }
+  }
+#endif

src/BMC.triggers.cpp

@@ -6,7 +6,7 @@
 */
 #include <BMC.h>
 
-#if BMC_MAX_TRIGGERS
+#if BMC_MAX_TRIGGERS > 0
   void BMC::readTrigger(){
     if(!triggers.isAllowed()){
       return;
@@ -58,11 +58,11 @@
         midiClock.tap();
         BMC_PRINTLN("BMCTriggers BMC_TRIGGER_EVENT_TYPE_CLOCK_TAP");
         break;
-      case BMC_TRIGGER_EVENT_TYPE_PAGE_ACTIVE_SENSE:
+      case BMC_TRIGGER_EVENT_TYPE_ACTIVE_SENSE:
         // event (bits 08 to 15) = Command
         // event (bits 16 to 23) = Ports
         midiActiveSense.command(byteA, byteB);
-        BMC_PRINTLN("BMCTriggers BMC_TRIGGER_EVENT_TYPE_PAGE_ACTIVE_SENSE");
+        BMC_PRINTLN("BMCTriggers BMC_TRIGGER_EVENT_TYPE_ACTIVE_SENSE");
         break;
       case BMC_TRIGGER_EVENT_TYPE_PAGE:
         // event (bits 08 to 15) = Page Number

src/editor/BMC-Editor.backup.cpp

@@ -317,9 +317,6 @@ void BMCEditor::backupPixelProgram(uint16_t t_minLength){
 #endif
   sendNotification(BMC_NOTIFY_BACKUP_DATA_ACCEPTED, t_minLength);
 }
-
-
-
 void BMCEditor::backupGlobalTriggers(uint16_t t_minLength){
 #if BMC_MAX_TRIGGERS > 0
   uint8_t index = getMessagePageNumber();
@@ -336,6 +333,22 @@ void BMCEditor::backupGlobalTriggers(uint16_t t_minLength){
 #endif
   sendNotification(BMC_NOTIFY_BACKUP_DATA_ACCEPTED, t_minLength);
 }
+void BMCEditor::backupGlobalTimedEvents(uint16_t t_minLength){
+#if BMC_MAX_TIMED_EVENTS > 0
+  uint8_t index = getMessagePageNumber();
+  if(index >= BMC_MAX_TIMED_EVENTS){
+    sendNotification(BMC_NOTIFY_BACKUP_DATA_ACCEPTED, 0);
+    return;
+  }
+  // does NOT require additional bytes from write message
+  if(incoming.size() == t_minLength){
+    bmcStoreGlobalTimedEvents& item = store.global.timedEvents[index];
+    item.event = incoming.get32Bits(9);
+    item.timeout = incoming.get32Bits(14);
+  }
+#endif
+  sendNotification(BMC_NOTIFY_BACKUP_DATA_ACCEPTED, t_minLength);
+}
 void BMCEditor::backupGlobalLed(uint16_t t_minLength){
 #if BMC_MAX_GLOBAL_LEDS > 0
   uint8_t index = getMessagePageNumber();