Merge pull request #34 from gpstar81/v109

Rapid Track System

Author: gpstar81

README.md

@@ -47,6 +47,10 @@ Example code to demonstrate some of the GPStar Audio's features can be found in
 
 **GPStarAudio.trackPlayPoly(uint16_t trk, bool lock, uint16_t i_trk_start_delay, uint16_t trk2, bool loop_trk2, uint16_t trk2_start_time)** - Same as above with the following addition: Setting `trk2` allows you to "queue" a second audio file to play once the first finishes playing, allowing seamless transition between tracks. `loop_trk2` defines whether the second track will loop forever, and `trk2_start_time` specifies how many milliseconds before the end of the first track the second track will begin playing. `Requires GPStar Audio Firmware v1.04 or higher.`
 
+**GPStarAudio.trackRapidPlay(uint16_t trk, uint16_t i_rapid_delay)** - This will tell GPStar Audio to take two channels with the same track, locks them and sets them to repeat. The first channel plays first and when the rapid delay timer ends, it will trigger the second channel to start playing, while channel 1 still continues to play. When the timer for channel 2 ends, it will tell channel 1 to rewind and play again. This process will continue until you tell the track to stop or turn off track looping for the track which allows the channels to finish playing out. `Requires GPStar Audio Firmware v1.09 or higher.`
+
+**GPStarAudio.trackRapidDelay(uint16_t trk, uint16_t i_rapid_delay)** - This updates the rapid delay timers for the track that is using trackRapidPlay. `Requires GPStar Audio Firmware v1.09 or higher.`
+
 **GPStarAudio.trackQueueClear()** - If `GPStarAudio.trackPlaySolo()` or `GPStarAudio.trackPlayPoly()` are called with the `trk2` parameters, calling this afterwards will clear out the queue to prevent the second track from playing when the first track finishes playback. `Requires GPStar Audio Firmware v1.04 or higher.`
 
 **GPStarAudio.trackStop(uint16_t trk)** - This stops the provided track number if it is currently playing and frees the channel it was using.
@@ -106,6 +110,8 @@ Example code to demonstrate some of the GPStar Audio's features can be found in
 
 **GPStarAudio.getVersion(char\* version)** - Returns a `bool` for whether the `RSP_VERSION_STRING` packet was received. Pass a `char` array of size `VERSION_STRING_LEN` as the parameter to store the version string value.  `This is no longer used by GPStar Audio.`
 
+**GPStarAudio.setTriggerBank(uint8_t bank)** - Provided for backwards compatibility with existing polyphonic audio boards, but has no effect on GPStar Audio (which does not support creation of audio banks).
+
 ## <img src='images/gpstar_logo.png' width=50 align="left"/>GPStar Audio - Connection Details
 
 ![](images/GPStarAudioPCB.png)

examples/BasicExample/BasicExample.ino

@@ -45,7 +45,6 @@ void setup() {
   delay(1000);
 
   // Please note: GPStar Audio uses 57600 baudrate by default. You can configure this by adding the setting to the Micro SD Card ini configuration file. Please see the README.MD file for more information.
-
   altSerial.begin(57600); // When using AltSoftSerial.
   gpstar.start(altSerial);
 
@@ -57,7 +56,7 @@ void setup() {
   // Allow time for hello command and other data to respond.
   gpstar.hello();
 
-  delay(400);
+  delay(500);
 
   if(gpstar.gpstarAudioHello()) {
     // Stop all tracks.
@@ -70,7 +69,7 @@ void setup() {
   }
 }
 
-void loop() {
+void loop() {  
   if(b_gpstar_audio_found == true) {
     // Play track 1 at 100% volume and set it to loop.
     gpstar.trackGain(1, 0);
@@ -95,6 +94,7 @@ void loop() {
 
     // Pause track 1
     gpstar.trackPause(1);
+
     delay(5000);
 
     // Stop track 2

library.json

@@ -1,6 +1,6 @@
 {
     "name": "GPStar Audio Serial Library",
-    "version": "1.3.4",
+    "version": "1.3.5",
     "description": "A serial communication control library for the GPStar Audio and GPStar Audio XL series of audio boards from GPStar Technologies.",
     "keywords": "audio, serial, music, wav",
     "authors":

library.properties

@@ -1,5 +1,5 @@
 name=GPStar Audio Serial Library
-version=1.3.4
+version=1.3.5
 author=Michael Rajotte
 license=GPL-3.0-or-later
 maintainer=Michael Rajotte <michael.rajotte@gpstartechnologies.com>

src/GPStarAudio.cpp

@@ -359,6 +359,38 @@ void gpstarAudio::trackLoop(uint16_t trk, bool enable) {
   }
 }
 
+void gpstarAudio::trackRapidPlay(uint16_t trk, uint16_t i_rapid_delay) {
+  uint8_t txbuf[10];
+
+  txbuf[0] = SOM1;
+  txbuf[1] = SOM2;
+  txbuf[2] = 0x0a;
+  txbuf[3] = CMD_TRACK_CONTROL;
+  txbuf[4] = TRK_RAPID_PLAY;
+  txbuf[5] = (uint8_t)trk;
+  txbuf[6] = (uint8_t)(trk >> 8);
+  txbuf[7] = (uint8_t)i_rapid_delay;
+  txbuf[8] = (uint8_t)(i_rapid_delay >> 8);
+  txbuf[9] = EOM;
+  GPStarSerial->write(txbuf, 10);
+}
+
+void gpstarAudio::trackRapidDelay(uint16_t trk, uint16_t i_rapid_delay) {
+  uint8_t txbuf[10];
+
+  txbuf[0] = SOM1;
+  txbuf[1] = SOM2;
+  txbuf[2] = 0x0a;
+  txbuf[3] = CMD_TRACK_CONTROL;
+  txbuf[4] = TRK_RAPID_DELAY;
+  txbuf[5] = (uint8_t)trk;
+  txbuf[6] = (uint8_t)(trk >> 8);
+  txbuf[7] = (uint8_t)i_rapid_delay;
+  txbuf[8] = (uint8_t)(i_rapid_delay >> 8);
+  txbuf[9] = EOM;
+  GPStarSerial->write(txbuf, 10);
+}
+
 void gpstarAudio::trackControl(uint16_t trk, uint8_t code) {
   uint8_t txbuf[8];
 

src/GPStarAudio.h

@@ -57,6 +57,8 @@
 #define TRK_LOOP_ON              5
 #define TRK_LOOP_OFF             6
 #define TRK_LOAD                 7
+#define TRK_RAPID_PLAY           8
+#define TRK_RAPID_DELAY          9
 
 #define RSP_VERSION_STRING     129
 #define RSP_SYSTEM_INFO        130
@@ -98,6 +100,8 @@ class gpstarAudio
   void trackPlayPoly(uint16_t trk, bool lock);
   void trackPlayPoly(uint16_t trk, bool lock, uint16_t i_trk_start_delay);
   void trackPlayPoly(uint16_t trk, bool lock, uint16_t i_trk_start_delay, uint16_t trk2, bool loop_trk2, uint16_t trk2_start_time);
+  void trackRapidPlay(uint16_t trk, uint16_t i_rapid_delay);
+  void trackRapidDelay(uint16_t trk, uint16_t i_rapid_delay);
   void trackQueueClear(void);
   void trackLoad(uint16_t trk);
   void trackLoad(uint16_t trk, bool lock);