Update library to work with v1.1 ICs

Author: nseidle

src/SparkFun_MY1690_MP3_Library.cpp

@@ -32,37 +32,52 @@ bool MY1690::begin(Stream &serialPort, uint8_t pin)
     uint8_t x = 0;
     while (isConnected() == false)
     {
+        while(1)
+            ;
         delay(100);
         if (x++ == 15)
             return (false);
     }
 
-    return (stopPlaying()); // Stop any playing tracks
+    stopPlaying(); // Stop any playing tracks. Stop doesn't always return 'STOP' so don't return it
+
+    return (true);
 }
 
-// Version response seems to have changed. Currently units are repsonding with '1.1'.
-// getVersion returns the rough interpretation of this string in int form. See getNumberReponse for more info.
+// Try to get the version number from the device
 uint16_t MY1690::getVersion(void)
 {
-    commandBytes[0] = MP3_COMMAND_PLAY;
-    // commandBytes[0] = MP3_COMMAND_GET_VERSION_NUMBER;
+    commandBytes[0] = MP3_COMMAND_GET_VERSION_NUMBER;
+
+    // Sometimes it responds with 'OK1.1\r\n'
     sendCommand(1);
+    if(getStringResponse("OK1.1\r\n") == true)
+        return (101);
 
-    return (getNumberResponse());
+    // Sometimes it responds with '1.1\r\n'
+    sendCommand(1);
+    if(getStringResponse("1.1\r\n") == true)
+        return (101);
+
+    sendCommand(1);
+    if(getStringResponse("OK1.0\r\n") == true)
+        return (100);
+
+    sendCommand(1);
+    if(getStringResponse("1.0\r\n") == true)
+        return (100);
+
+    sendCommand(1);
+    int version = getNumberResponse();
+    return (version);
 }
 
 // Verify the device responds correctly with a version number
 bool MY1690::isConnected(void)
 {
-    uint16_t version = getVersion();
-    if (version > 0 && version <= 0x101)
+    int version = getVersion();
+    if (version == 100 || version == 101)
         return (true);
-    else if (version > 0x101)
-    {
-        Serial.print(F("Warning: Unknown MY1690 Protocol version: 0x"));
-        Serial.println(version, HEX);
-        return (true);
-    }
 
     return (false);
 }
@@ -156,10 +171,18 @@ bool MY1690::playTrackNumber(uint16_t trackNumber)
 bool MY1690::setVolume(uint8_t volumeLevel)
 {
     // Any number above 30 will be automatically set to 30 by MY1690
+    // Trim value so return is true
+    if(volumeLevel > 30)
+        volumeLevel = 30;
+
     commandBytes[0] = MP3_COMMAND_SET_VOLUME;
     commandBytes[1] = volumeLevel;
     sendCommand(2);
-    return (getOKResponse());
+
+    // In v1.1, setVolume no longer responds with an OK. We must query it
+    if (getVolume() == volumeLevel)
+        return (true);
+    return (false);
 }
 
 uint8_t MY1690::getVolume(void)
@@ -227,18 +250,21 @@ bool MY1690::isPlaying(void)
     return (false);
 }
 
+// Responds with '0000 \r\n' (note the space), '0001 \r\n', etc
 uint8_t MY1690::getPlayStatus(void)
 {
     commandBytes[0] = MP3_COMMAND_GET_STATUS;
     sendCommand(1);
     return (getNumberResponse());
 }
 
-bool MY1690::play(void)
+void MY1690::play(void)
 {
     commandBytes[0] = MP3_COMMAND_PLAY;
     sendCommand(1);
-    return (getOKResponse());
+
+    // In v1.1 there are no OK responses. Busy goes high after ~30ms.
+    // User can also use the isPlaying() after 30ms to see if song has started
 }
 
 bool MY1690::pause(void)
@@ -266,18 +292,22 @@ bool MY1690::playPrevious(void)
 // If a song is playing, then ~14ms later 'STOP' is reported
 bool MY1690::stopPlaying(void)
 {
-    bool currentlyPlaying = isPlaying();
+    //Use hardware pins or software command
+    if (isPlaying() == false)
+        return (true);
 
     commandBytes[0] = MP3_COMMAND_STOP;
     sendCommand(1);
+    
+    //v1.1 doesn't respond with OK or STOP, instead the isPlaying can be used    
+    //getOKResponse();
 
-    if (currentlyPlaying == false)
-        return (getOKResponse());
+    delay(10); // IC takes 5ms to stop a track
 
-    getOKResponse();
+    if (isPlaying() == false)
+        return (true);
 
-    // Wait 15ms for 'STOP' to come through
-    return (getSTOPResponse());
+    return (false);
 }
 
 bool MY1690::reset(void)
@@ -314,46 +344,58 @@ bool MY1690::playPause(void)
     return (getOKResponse());
 }
 
-// MY1690 responds with OK0004\n\r in ASCII to a get command
-// The ASCII response is HEX so OK000d is 14.
+// In version 1.1, sometimes MY1690 responds with '0000 \r\n' to a get command. No OK, and a space.
+// Sometimes 'OK0001 \r\n'. Ok, and a space. Yay!
+// In version 1.0 it was lower case letters. In v1.1, it's upper case HEX.
 // Convert the four letters to a decimal value
 uint16_t MY1690::getNumberResponse(void)
 {
-#define EXPECTED_LENGTH 8
+    const uint8_t maxLength = 9;
+    uint8_t okResponseOffset = 0;
+
     if (responseAvailable() == false)
         return (0); // Timeout
 
     // Get four byte response
     uint16_t responseValue = 0;
     uint8_t i = 0;
 
-    while (_serialPort->available() && i < EXPECTED_LENGTH)
+    while (_serialPort->available() && i <= maxLength)
     {
         uint8_t incoming = _serialPort->read();
-        if (i == 0 || i == 1)
-            ; // This is throw away value 'O' and 'K'
-        else if (i >= 2 && i <= 5)
+        if ((i == 0 && incoming == 'O') || (i == 1 && incoming == 'K'))
         {
-            if (incoming != '\r' && incoming != '\n') // Added because version response is 3 characters long
+            // Throw away chars
+
+            okResponseOffset = 2; // Increase scanning i by 2 more
+        }
+        else if (i <= (3 + okResponseOffset))
+        {
+            //Added because getVersion response is three characters long
+            if (incoming != '\r' && incoming != '\n') 
             {
-                // Convert ASCII HEX values to decimal
-                responseValue <<= 4;
-                if (incoming >= '0' && incoming <= '9')
-                    responseValue += (incoming - '0');
-                else if (incoming >= 'a' && incoming <= 'z')
-                    responseValue += (incoming - 'a') + 10;
+            // Convert ASCII HEX values to decimal
+            responseValue <<= 4;
+            if (incoming >= '0' && incoming <= '9')
+                responseValue += (incoming - '0');
+            else if (incoming >= 'A' && incoming <= 'Z')
+                responseValue += (incoming - 'A') + 10;
+            else if (incoming >= 'a' && incoming <= 'z')
+                responseValue += (incoming - 'a') + 10;
             }
         }
+        else if (incoming == '\n')
+            break; // End of response
         else
         {
-            ; // These are the \n \r characters
+            ; // Throw out \r and ' ' characters
         }
 
         i++;
 
         // The device can take a few ms between response chars
         uint8_t escapeCounter = 0;
-        while (_serialPort->available() == 0 && i < EXPECTED_LENGTH)
+        while (_serialPort->available() == 0 && i <= maxLength)
         {
             if (escapeCounter++ > 10)
                 return (responseValue); // Give up
@@ -368,19 +410,14 @@ uint16_t MY1690::getNumberResponse(void)
 // MY1690 responds with OK (no \n \r) in ASCII to a control command
 bool MY1690::getOKResponse(void)
 {
-    return (getStringResponse("OK", 2));
+    return (getStringResponse("OK"));
 }
 
-// MY1690 responds with STOP (no \n \r) in ASCII to stop command
-// if a song is currently playing
-bool MY1690::getSTOPResponse(void)
+// Returns true if MY1690 responds with a given string
+bool MY1690::getStringResponse(const char *expectedResponse)
 {
-    return (getStringResponse("STOP", 4));
-}
+    uint8_t expectedLength = strlen(expectedResponse);
 
-// Returns true if MY1690 reponds with a given string
-bool MY1690::getStringResponse(const char *expectedResponse, uint8_t expectedLength)
-{
     if (responseAvailable() == false)
         return (false); // Timeout
 

src/SparkFun_MY1690_MP3_Library.h

@@ -87,7 +87,7 @@ class MY1690
 	bool begin(Stream &serialPort = Serial, uint8_t pin = 255);
 
 	// Control functions
-	bool play(void);
+	void play(void);
 	bool pause(void);
 	bool playNext(void);
 	bool playPrevious(void);
@@ -129,9 +129,9 @@ class MY1690
 	uint16_t getNumberResponse(void);
 	bool getOKResponse(void);
 	bool getSTOPResponse(void);
-	bool getStringResponse(const char *expectedResponse, uint8_t expectedLength);
+	bool getStringResponse(const char *expectedResponse);
 
-	bool responseAvailable(uint8_t maxTimeout = 50);
+	bool responseAvailable(uint8_t maxTimeout = 100);
 
 	void clearBuffer(void);
 };