Add GroveMP3V3

Author: matsujirushi

examples/GroveMP3V3/GroveMP3V3.ino

@@ -0,0 +1,44 @@
+// BOARD Seeed Wio LTE M1/NB1(BG96)
+// GROVE UART <-> Grove - MP3 V3 -Music Player (SKU#107020069)
+
+#include <GroveDriverPack.h>
+
+#define VOLUME  (2)
+
+WioCellular Wio;
+
+GroveBoard Board;
+GroveMP3V3 MP3(&Board.UART);
+
+void setup() {
+  delay(200);
+  SerialUSB.begin(115200);
+
+  Wio.Init();
+  Wio.PowerSupplyGrove(true);
+  
+  Board.UART.Enable(9600, 8, HalUART::PARITY_NONE, 1);
+  if (!MP3.Init())
+  {
+    SerialUSB.println("Grove-MP3V3 not found.");
+    return;
+  }
+
+  int n = MP3.QueryNumberOfMusic();
+  SerialUSB.print("Number of music = ");
+  SerialUSB.println(n);
+
+  MP3.SetVolume(VOLUME);
+
+  for (int i = 0; i < n; ++i)
+  {
+    SerialUSB.print("Play ");
+    SerialUSB.println(i);
+    
+    MP3.Play(i);
+    while (MP3.QueryStatus() == GroveMP3V3::STATUS_PLAY) delay(100);
+  }
+}
+
+void loop() {
+}

readme.md

@@ -55,6 +55,7 @@ Grove
 |<img src="https://statics3.seeedstudio.com/seeed/img/2017-02/lJ51OXkwCFgmT6iAjE030rSd.jpg" width="100">|GroveBuzzer|107020000|[Grove - Buzzer](http://wiki.seeedstudio.com/Grove-Buzzer/)||
 |<img src="https://statics3.seeedstudio.com/images/product/High%20Temperature%20Sensor.jpg" width="100">|GroveHighTemp|111020002|[Grove - High Temperature Sensor](http://wiki.seeedstudio.com/Grove-High_Temperature_Sensor/)||
 |<img src="https://statics3.seeedstudio.com/seeed/img/2016-11/txvkIZ9IGno10T8UYi8KTvPS.jpg" width="100">|GroveGPS|113020003|[Grove - GPS](http://wiki.seeedstudio.com/Grove-GPS/)||
+|<img src="https://files.seeedstudio.com/wiki/Grove-MP3-V3/img/Grove-MP3-V3-preview.jpg" width="100">|GroveMP3V3|107020069|[Grove - MP3 V3 -Music Player](http://wiki.seeedstudio.com/Grove-MP3-v3/)||
 
 ### 拡張基板
 

src/GroveDriverPack.h

@@ -41,6 +41,7 @@
 #include "Module/OmronBaro2SMPB02E.h"
 #include "Module/GroveTempHumiSHT35.h"
 #include "Module/Grove6AxisAccelGyroLSM6DS3.h"
+#include "Module/GroveMP3V3.h"
 
 #if defined ARDUINO_ARCH_STM32F4 || defined ARDUINO_ARCH_STM32
 

src/Module/GroveMP3V3.cpp

@@ -0,0 +1,167 @@
+#include "GroveMP3V3.h"
+
+static constexpr uint8_t CMD_ROOT_INDEX_PLAY_SD             = 0xa2;
+static constexpr uint8_t CMD_STOP                           = 0xab;
+static constexpr uint8_t CMD_VOLUME_CONTROL                 = 0xae;
+static constexpr uint8_t CMD_QUERY_CURRENT_VOLUME_SETTING   = 0xc1;
+static constexpr uint8_t CMD_QUERY_CURRENT_OPERATION_STATE  = 0xc2;
+static constexpr uint8_t CMD_QUERY_TOTAL_NUMBER_OF_MUSIC_SD = 0xc5;
+
+void GroveMP3V3::WriteCommand(uint8_t commandCode, const uint8_t* parameter, int parameterSize)
+{
+    uint8_t length = 1 + 1 + parameterSize + 1;
+    uint8_t sum = 0;
+    sum += length;
+    sum += commandCode;
+    for (int i = 0; i < parameterSize; ++i) sum += parameter[i];
+
+    _UART->Write(0x7e);
+    _UART->Write(length);
+    _UART->Write(commandCode);
+    for (int i = 0; i < parameterSize; ++i) _UART->Write(parameter[i]);
+    _UART->Write(sum);
+    _UART->Write(0xef);
+}
+
+bool GroveMP3V3::ReadReturn(uint8_t* operationCode, uint8_t* returnValue, uint8_t returnValueSize, int timeout)
+{
+
+    int elapsed = 0;
+    while (_UART->ReadAvailable() < 1)
+    {
+        if (elapsed * 10 >= timeout) return false;
+        HalSystem::DelayMs(10);
+        ++elapsed;
+    }
+    *operationCode = _UART->Read();
+
+    for (int i = 0; i < returnValueSize; ++i)
+    {
+        elapsed = 0;
+        while (_UART->ReadAvailable() < 1)
+        {
+            if (elapsed * 10 >= timeout) return false;
+            HalSystem::DelayMs(10);
+            ++elapsed;
+        }
+        returnValue[i] = _UART->Read();
+    }
+
+    return true;
+}
+
+bool GroveMP3V3::Init()
+{
+    int retry = 0;
+    while (true)
+    {
+        GroveMP3V3::WriteCommand(CMD_QUERY_TOTAL_NUMBER_OF_MUSIC_SD, nullptr, 0);
+
+        uint8_t operationCode;
+        uint8_t totalNumberOfFiles[2];
+        if (GroveMP3V3::ReadReturn(&operationCode, totalNumberOfFiles, sizeof(totalNumberOfFiles), 100))    // timeout = 100[msec.]
+        {
+            if (operationCode == CMD_QUERY_TOTAL_NUMBER_OF_MUSIC_SD) break;
+        }
+
+        if (retry >= 100) return false; // retry * timeout = 100 * 100 = 10[sec.]
+        ++retry;
+    }
+
+    _IsExist = true;
+    return true;
+}
+
+void GroveMP3V3::Play(int index)
+{
+    if (!_IsExist) return;
+
+    ++index;
+
+    const uint8_t parameter[]{ static_cast<uint8_t>(index / 256), static_cast<uint8_t>(index % 256) };
+    GroveMP3V3::WriteCommand(CMD_ROOT_INDEX_PLAY_SD, parameter, sizeof(parameter));
+
+    uint8_t operationCode;
+    if (!GroveMP3V3::ReadReturn(&operationCode, nullptr, 0)) HalSystem::Abort();
+    if (operationCode != 0x00) HalSystem::Abort();
+}
+
+void GroveMP3V3::Stop()
+{
+    if (!_IsExist) return;
+
+    GroveMP3V3::WriteCommand(CMD_STOP, nullptr, 0);
+
+    uint8_t operationCode;
+    if (!GroveMP3V3::ReadReturn(&operationCode, nullptr, 0)) HalSystem::Abort();
+    if (operationCode != 0x00) HalSystem::Abort();
+}
+
+void GroveMP3V3::SetVolume(int volume)
+{
+    if (!_IsExist) return;
+
+    if (volume < 0) volume = 0;
+    if (31 < volume) volume = 31;
+
+    const uint8_t parameter[]{ static_cast<uint8_t>(volume) };
+    GroveMP3V3::WriteCommand(CMD_VOLUME_CONTROL, parameter, sizeof(parameter));
+
+    uint8_t operationCode;
+    if (!GroveMP3V3::ReadReturn(&operationCode, nullptr, 0)) HalSystem::Abort();
+    if (operationCode != 0x00) HalSystem::Abort();
+}
+
+int GroveMP3V3::QueryVolume()
+{
+    if (!_IsExist) return 0;
+
+    GroveMP3V3::WriteCommand(CMD_QUERY_CURRENT_VOLUME_SETTING, nullptr, 0);
+
+    uint8_t operationCode;
+    uint8_t currentVolume;
+    if (!GroveMP3V3::ReadReturn(&operationCode, &currentVolume, 1)) HalSystem::Abort();
+    if (operationCode != CMD_QUERY_CURRENT_VOLUME_SETTING) HalSystem::Abort();
+
+    return currentVolume;
+}
+
+GroveMP3V3::STATUS GroveMP3V3::QueryStatus()
+{
+    if (!_IsExist) return STATUS_STOP;
+
+    GroveMP3V3::WriteCommand(CMD_QUERY_CURRENT_OPERATION_STATE, nullptr, 0);
+
+    uint8_t operationCode;
+    uint8_t currentOperationState;
+    if (!GroveMP3V3::ReadReturn(&operationCode, &currentOperationState, 1)) HalSystem::Abort();
+    if (operationCode != CMD_QUERY_CURRENT_OPERATION_STATE) HalSystem::Abort();
+
+    switch (currentOperationState)
+    {
+    case 1:
+        return STATUS_PLAY;
+    case 2:
+        return STATUS_STOP;
+    case 3:
+        return STATUS_PAUSE;
+    default:
+        HalSystem::Abort();
+    }
+
+    return STATUS_STOP; // Dummy
+}
+
+int GroveMP3V3::QueryNumberOfMusic()
+{
+    if (!_IsExist) return 0;
+
+    GroveMP3V3::WriteCommand(CMD_QUERY_TOTAL_NUMBER_OF_MUSIC_SD, nullptr, 0);
+
+    uint8_t operationCode;
+    uint8_t totalNumberOfFiles[2];
+    if (!GroveMP3V3::ReadReturn(&operationCode, totalNumberOfFiles, sizeof(totalNumberOfFiles))) HalSystem::Abort();
+    if (operationCode != CMD_QUERY_TOTAL_NUMBER_OF_MUSIC_SD) HalSystem::Abort();
+
+    return totalNumberOfFiles[0] * 256 + totalNumberOfFiles[1];
+}

src/Module/GroveMP3V3.h

@@ -0,0 +1,40 @@
+//GROVE_NAME        "Grove - MP3 V3 -Music Player"
+//SKU               107020069
+//WIKI_URL          http://wiki.seeedstudio.com/Grove-MP3-v3/
+
+#pragma once
+
+#include "Abstract/GroveModule2.h"
+#include "../Connector/GroveConnectorUART.h"
+
+class GroveMP3V3 : public GroveModule2
+{
+public:
+	enum STATUS
+	{
+		STATUS_PLAY,
+		STATUS_STOP,
+		STATUS_PAUSE,
+	};
+
+private:
+	HalUART* _UART;
+
+	void WriteCommand(uint8_t commandCode, const uint8_t* parameter, int parameterSize);
+	bool ReadReturn(uint8_t* operationCode, uint8_t* returnValue, uint8_t returnValueSize, int timeout = 1000);
+
+public:
+	GroveMP3V3(GroveConnectorUART* connector)
+	{
+		_UART = &connector->UART;
+	}
+
+	bool Init();
+	void Play(int index);		// index=1-
+	void Stop();
+	void SetVolume(int volume);	// volume=0-31
+	int QueryVolume();			// 0-31
+	STATUS QueryStatus();
+	int QueryNumberOfMusic();
+
+};