v1.6.2 adds new Pixels Rainbow Fade mode.

docs/README.md

@@ -41,6 +41,7 @@ For now here are some topics I want to cover tho they are not complete:
 - [User Defined Events](user-events.md)
 
 ## In-Depth
+- [Constants](constants.md)
 - [Callbacks](advanced-callbacks.md)
 - [Max Length Constants](advanced-max-length-constants.md)
 - [Names & Strings](advanced-names-and-strings.md)

docs/advanced-names-and-strings.md

@@ -45,10 +45,12 @@ This list represents the current list of names available at the time of this wri
 * `BMC_NAME_LEN_ENCODERS` applies to encoders and global encoders
 * `BMC_NAME_LEN_RELAYS` applies to Latching and Non-Latching Relays
 * `BMC_NAME_LEN_PAGES` applies to Pages
-* `BMC_NAME_LEN_STRING_LIBRARY` applies to String Library names
 * `BMC_NAME_LEN_LIBRARY` applies to midi library
 * `BMC_NAME_LEN_PRESETS` applies to BMC presets
 * `BMC_NAME_LEN_SETLISTS` applies to set lists
+* `BMC_NAME_LEN_STRING_LIBRARY` applies to String Library names
+* `BMC_NAME_LEN_TIMED_EVENTS` applies to Timed Event names
+
 
 ### Name retrieving methods
 

docs/buttons.md

@@ -140,74 +140,47 @@ void onButtonsUserEvent(void (*fptr)(uint8_t n, uint32_t event, uint8_t ports, u
 // @t_index the index of the button you want to retrieve
 // @t_item a reference to the bmcStoreButton to put data in
 void getButton(uint8_t t_index, bmcStoreButton& t_item);
-```
-
 
-```c++
 // get button data of a specific page
 void getButton(uint8_t t_page, uint8_t t_index, bmcStoreButton& t_item);
-```
 
-
-```c++
 // get button name in the current page
 // @n the index of the button
 // @t_string a pointer to a string to put the button name in
-// the length of the pointer must be BMC_NAME_LEN_BUTTONS
+// see "advanced names and strings" documentation for length of char string
 void getButtonName(uint8_t n, char* t_string);
-```
-
 
-```c++
-// get button name of a specific page
+// get button name of a specific button
+// see "advanced names and strings" documentation for length of char string
 void getButtonName(uint8_t t_page, uint8_t n, char* t_string);
-```
 
-
-```c++
 // Trigger a button being pressed, this button will remain pressed until you call triggerButtonRelease
 // @n the index of the button being triggered
 void triggerButtonPress(uint8_t n);
-```
-
 
-```c++
 // Trigger a button being depressed, this function will only work on the button if triggerButtonPress was called before
 // @n the index of the button being triggered
 void triggerButtonRelease(uint8_t n);
-```
 
-
-```c++
 // Get a global button's data
 // @t_index the index of the button you want to retrieve
 // @t_item a reference to the bmcStoreButton to put data in
 void getGlobalButton(uint8_t t_index, bmcStoreButton& t_item);
-```
 
-```c++
 // get global button name
 // @n the index of the button
 // @t_string a pointer to a string to put the button name in
-// the length of the pointer must be BMC_NAME_LEN_BUTTONS
-void getButtonName(uint8_t n, char* t_string);
-```
+// see "advanced names and strings" documentation for length of char string
+void getGlobalButtonName(uint8_t n, char* t_string);
 
-```c++
 // Trigger a global button being pressed, this button will remain pressed until you call triggerButtonRelease
 // @n the index of the button being triggered
 void triggerGlobalButtonPress(uint8_t n);
-```
 
-
-```c++
 // Trigger a global button being depressed, this function will only work on the button if triggerButtonPress was called before
 // @n the index of the button being triggered
 void triggerGlobalButtonRelease(uint8_t n);
-```
-
 
-```c++
 // Change the Buttons Hold Time Setting for Buttons
 // if @save is true it will call the settingsSave() writing the store to EEPROM
 // @value must be a value from 0 to 15, where 0 is 500ms, 1 is 750ms, 2 is 1000ms, etc.
@@ -216,10 +189,7 @@ void triggerGlobalButtonRelease(uint8_t n);
 // this is so that with a value of 0 the hold threshold is 500ms, that's the minimum
 // since during testing i've found that a value any lower than that is unusable.
 void settingsSetButtonHold(uint8_t value, bool save=false);
-```
 
-
-```c++
 // Get the Buttons Hold Threshold Setting for Buttons
 // this value will range from 0 to 15
 // to get the actual time in milliseconds set inMillis to true

docs/constants.md

@@ -0,0 +1,19 @@
+*Under MIT license.*
+
+[Official BMC Website >> RoxXxtar.com/bmc](https://www.roxxxtar.com/bmc)
+
+[< Back to Documentation](README.md)
+
+# BMC Constants
+Coming Soon
+
+### API
+There are many API callbacks and functions available for use, these may not reflect the latest version
+
+##### FUNCTIONS
+```c++
+```
+
+##### CALLBACKS
+```c++
+```

docs/encoders.md

@@ -21,9 +21,11 @@ void getEncoder(uint8_t t_index, bmcStoreEncoder& t_item);
 void getEncoder(uint8_t t_page, uint8_t t_index, bmcStoreEncoder& t_item);
 
 // get encoder name on current page passing a pointer string
+// see "advanced names and strings" documentation for length of char string
 void getEncoderName(uint8_t t_index, char* t_string);
 
 // get encoder name on specified page passing a pointer string
+// see "advanced names and strings" documentation for length of char string
 void getEncoderName(uint8_t t_page, uint8_t t_index, char* t_string);
 ```
 

docs/leds-and-pixels.md

@@ -135,8 +135,10 @@ void getLed(uint8_t t_index, bmcStoreLed& t_item);
 
 void getLed(uint8_t t_page, uint8_t t_index, bmcStoreLed& t_item);
 
+// see "advanced names and strings" documentation for length of char string
 void getLedName(uint8_t t_index, char* t_string);
 
+// see "advanced names and strings" documentation for length of char string
 void getLedName(uint8_t t_page, uint8_t t_index, char* t_string);
 
 // used to control leds only by the sketch, no matter what page
@@ -150,6 +152,7 @@ uint32_t getLedStates();
 // get GLOBAL_LED Data
 void getGlobalLed(uint8_t n, bmcStoreLed& t_item);
 
+// see "advanced names and strings" documentation for length of char string
 void getGlobalLedName(uint8_t n, char* t_string);
 
 // used to control leds only by the sketch, no matter what page
@@ -166,8 +169,10 @@ void getPwmLed(uint8_t n, bmcStoreLed& t_item);
 
 void getPwmLed(uint8_t t_page, uint8_t n, bmcStoreLed& t_item);
 
+// see "advanced names and strings" documentation for length of char string
 void getPwmLedName(uint8_t n, char* t_string);
 
+// see "advanced names and strings" documentation for length of char string
 void getPwmLedName(uint8_t t_page, uint8_t n, char* t_string);
 
 // used to control pwm leds only by the sketch, no matter what page
@@ -184,8 +189,10 @@ void getPixel(uint8_t n, bmcStoreLed& t_item);
 
 void getPixel(uint8_t t_page, uint8_t n, bmcStoreLed& t_item);
 
+// see "advanced names and strings" documentation for length of char string
 void getPixelName(uint8_t n, char* t_string);
 
+// see "advanced names and strings" documentation for length of char string
 void getPixelName(uint8_t t_page, uint8_t n, char* t_string);
 
 // used to control pixels only by the sketch, no matter what page
@@ -214,8 +221,10 @@ void getRgbPixel(uint8_t n, bmcStoreRgbLed& t_item);
 
 void getRgbPixel(uint8_t t_page, uint8_t n, bmcStoreRgbLed& t_item);
 
+// see "advanced names and strings" documentation for length of char string
 void getRgbPixelName(uint8_t n, char* t_string);
 
+// see "advanced names and strings" documentation for length of char string
 void getRgbPixelName(uint8_t t_page, uint8_t n, char* t_string);
 
 // used to control rgb pixels only by the sketch, no matter what page

docs/pots.md

@@ -21,9 +21,11 @@ void getPot(uint8_t n, bmcStorePot& t_item);
 void getPot(uint8_t t_page, uint8_t n, bmcStorePot& t_item);
 
 // get pot name on current page passing a pointer string
+// see "advanced names and strings" documentation for length of char string
 void getPotName(uint8_t n, char* t_string);
 
 // get pot name on specified page passing a pointer string
+// see "advanced names and strings" documentation for length of char string
 void getPotName(uint8_t t_page, uint8_t n, char* t_string);
 
 // start/stop pot calibration, pot calibration data is global

docs/relays.md

@@ -26,6 +26,32 @@ Relays have 1 event each and have the ability to be reverse polarity.
 ### API
 There are many API callbacks and functions available for use, these may not reflect the latest version
 
+```c++
+// *******************
+// NON-LATCHING RELAYS
+// *******************
+
+// get NL RELAY Data
+void getRelayNL(uint8_t n, bmcStoreGlobalRelay& t_item);
+
+// get NL RELAY Name Data
+// see "advanced names and strings" documentation for length of char string
+void getRelayNLName(uint8_t n, char* t_string);
+
+// ***************
+// LATCHING RELAYS
+// ***************
+
+// get L RELAY Data
+void getRelayL(uint8_t t_index, bmcStoreGlobalRelay& t_item);
+
+// get L RELAY Name Data
+// see "advanced names and strings" documentation for length of char string
+void getRelayLName(uint8_t t_index, char* t_string);
+
+```
+
+
 ##### FUNCTIONS
 
 ##### CALLBACKS

library.properties

@@ -1,5 +1,5 @@
 name=BMC
-version=1.6.0
+version=1.6.2
 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-Version.h

@@ -23,7 +23,7 @@
 // BMC Version stored in EEPROM (for editor usage)
 #define BMC_VERSION_MAJ 1
 #define BMC_VERSION_MIN 6
-#define BMC_VERSION_PATCH 0
+#define BMC_VERSION_PATCH 2
 
 //16 bits unsigned, LSB byte is minor, MSB byte is major
 #define BMC_VERSION ((BMC_VERSION_MAJ<<8) | BMC_VERSION_MIN)