├── keywords.txt ├── extras ├── SerialMP3Player_YX5300.png └── Serial MP3 Player v1.0 Manual.pdf ├── library.properties ├── README.md ├── examples ├── PlayHelloWorld │ └── PlayHelloWorld.ino └── BasicCommands │ └── BasicCommands.ino ├── src ├── SerialMP3Player.h └── SerialMP3Player.cpp └── LICENSE /keywords.txt: -------------------------------------------------------------------------------- 1 | SerialMP3Player KEYWORD1 2 | setup KEYWORD2 3 | play KEYWORD2 4 | decodeMP3Answer KEYWORD2 5 | -------------------------------------------------------------------------------- /extras/SerialMP3Player_YX5300.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/salvadorrueda/SerialMP3Player/HEAD/extras/SerialMP3Player_YX5300.png -------------------------------------------------------------------------------- /extras/Serial MP3 Player v1.0 Manual.pdf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/salvadorrueda/SerialMP3Player/HEAD/extras/Serial MP3 Player v1.0 Manual.pdf -------------------------------------------------------------------------------- /library.properties: -------------------------------------------------------------------------------- 1 | name=SerialMP3Player 2 | version=1.1.0 3 | author=Salvador Rueda 4 | maintainer=Salvador Rueda 5 | sentence=A library for Serial MP3 Player board (YX5300 chip). 6 | paragraph=Play mp3 files from the SD card. 7 | category=Uncategorized 8 | url=https://github.com/salvadorrueda/SerialMP3Player 9 | architectures=* 10 | includes=SerialMP3Player.h 11 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # SerialMP3Player 2 | Arduino Library for Serial MP3 Player board (YX5300 chip) 3 | 4 | ![Serial MP3 Player (YX5300 chip)](https://github.com/salvadorrueda/SerialMP3Player/blob/master/extras/SerialMP3Player_YX5300.png) 5 | 6 | 7 | You can buy the MP3 module on 8 | 9 | http://www.dx.com/p/uart-control-serial-mp3-music-player-module-for-arduino-avr-arm-pic-blue-silver-342439#.VfHyobPh5z0 10 | 11 | https://www.aliexpress.com/item/YX5300-UART-Control-Serial-MP3-Music-Player-Module-For-Arduino-AVR-ARM-PIC-CF-Micro-SD/32673728703.html 12 | 13 | 14 | Documentation and some Arduino code examples: 15 | 16 | (Spanish) 17 | http://joanruedapauweb.com/blog/index.php/2017/02/07/arduino-serial-mp3-player-yx5300-es/ 18 | 19 | (Chinese)(Catalex_YX5300_Docs.zip files) 20 | http://pan.baidu.com/s/1hqilpB2 21 | 22 | 23 | ## A Note on Delays: 24 | 25 | To ensure the integrity of serial communication, this library implements a very conservative 20 ms delay before and 1000 ms delay after sending a command. More complicated sketches that can manage their own delays between serial commands can disable this delay with the preprocessor definition NO_SERIALMP3_DELAY. -------------------------------------------------------------------------------- /examples/PlayHelloWorld/PlayHelloWorld.ino: -------------------------------------------------------------------------------- 1 | /****************************************************************************** 2 | Simple SerialMP3Player "Hello World" example of YX5300 chip. 3 | 4 | Copy the "hello.mp3" file to an empty SD card 5 | Connect the Serial MP3 Player to the Arduino board 6 | GND → GND 7 | VCC → 5V 8 | TX → pin 11 9 | RX → pin 10 10 | 11 | After compile and upload the code you must hear “Hello world” over and over. 12 | 13 | 14 | This example code is in the public domain. 15 | 16 | https://github.com/salvadorrueda/ArduinoSerialMP3Player 17 | 18 | by Salvador Rueda 19 | *******************************************************************************/ 20 | 21 | #include "SerialMP3Player.h" 22 | 23 | #define TX 11 24 | #define RX 10 25 | 26 | SerialMP3Player mp3(RX,TX); 27 | 28 | void setup() { 29 | Serial.begin(9600); // start serial interface 30 | mp3.begin(9600); // start mp3-communication 31 | delay(500); // wait for init 32 | 33 | mp3.sendCommand(CMD_SEL_DEV, 0, 2); //select sd-card 34 | delay(500); // wait for init 35 | } 36 | 37 | // the loop function runs over and over again forever 38 | void loop() { 39 | mp3.play(); // Play "hello.mp3". You must hear "Hello World" 40 | delay(3000); // wait 3 seconds 41 | } 42 | -------------------------------------------------------------------------------- /src/SerialMP3Player.h: -------------------------------------------------------------------------------- 1 | /* 2 | * SerialMP3Player.h - Library for Serial MP3 Player board from Catalex (YX5300 chip) 3 | * Created by Salvador Rueda Pau, July 23, 2016. 4 | * License as GPL v3 (http://www.gnu.org/licenses/gpl.html) 5 | */ 6 | 7 | #ifndef SerialMP3Player_h 8 | #define SerialMP3Player_h 9 | 10 | #include 11 | #include 12 | 13 | #define CMD_NEXT 0X01 // Play next file 14 | #define CMD_PREV 0X02 // Play previous file 15 | #define CMD_PLAYN 0X03 // Play n file from (1-255) 16 | #define CMD_VOL_UP 0X04 // Volumen up 17 | #define CMD_VOL_DOWN 0X05 // Volumen down 18 | #define CMD_SET_VOL 0X06 // Set Volume (0-30) 19 | // 0x07 // Reserved. 20 | #define CMD_PLAY_SLOOP 0X08 // Single loop play. 21 | 22 | #define CMD_SEL_DEV 0X09 // Set device. 2 DEV_TF (SD Card) 23 | #define CMD_SLEEP_MODE 0X0A 24 | #define CMD_WAKE_UP 0X0B 25 | #define CMD_RESET 0X0C 26 | 27 | #define CMD_PLAY 0X0D // Play 28 | #define CMD_PAUSE 0X0E // Pause 29 | 30 | //#define CMD_PLAY_F_FILE 0X0F // only avaible for Flash not SD Card. 31 | 32 | #define CMD_STOP_PLAY 0X16 // Stop 33 | #define CMD_FOLDER_CYCLE 0X17 // Play all the files in the f folder 34 | 35 | //#define CMD_PLAY_SHUFFLE 0x18 // Reserved 36 | 37 | #define CMD_PLAY_W_VOL 0X22 // Play with a volumen 38 | 39 | // Query Commands 40 | #define CMD_PLAYING_N 0x4C // qPlaying(); // Ask for the file is playing 41 | #define CMD_QUERY_STATUS 0x42 // qStatus(); // Ask for the status 42 | #define CMD_QUERY_VOLUME 0x43 // qVol(); // Ask for the volumen. // Sometime board fails 43 | #define CMD_QUERY_FLDR_TRACKS 0x4E // qFTracks(); // Ask for the number of tracks folders 44 | #define CMD_QUERY_TOT_TRACKS 0x48 // qTTracks(); // Ask for the total of tracks 45 | #define CMD_QUERY_FLDR_COUNT 0x4F // qTFolders(); // Ask for the number of folders 46 | 47 | 48 | /************ Opitons **************************/ 49 | 50 | class SerialMP3Player{ 51 | 52 | public: 53 | SerialMP3Player(); 54 | SerialMP3Player(int RX, int TX); 55 | 56 | void sendCommand(byte command); 57 | void sendCommand(byte command, byte dat2); 58 | void sendCommand(byte command, byte dat1, byte dat2); 59 | 60 | void begin(int bps); 61 | int available(); 62 | char read(); 63 | String decodeMP3Answer(); 64 | 65 | void playNext(); // Play next file 66 | void playPrevious(); // Play previous file 67 | void play(); // Play 68 | void play(byte n); // Play n file 69 | void play(byte n, byte vol); // Play n file with volume 70 | 71 | void volUp(); // Volumen Up 72 | void volDown(); // Volumen Down 73 | void setVol(byte v); // Set Volumen (0-30) 74 | 75 | void playSL(byte n); // Play Single loop n file. 76 | void playSL(byte f, byte n); // Play Single loop play n file from f folder. 77 | 78 | void pause(); // Pause 79 | 80 | void playF(byte f); // Play all files in the f folder 81 | 82 | void stop(); // Stop playing 83 | 84 | // Query commands 85 | void qPlaying(); // Ask for the file is playing 86 | void qStatus(); // Ask for the status 87 | void qVol(); // Ask for the volumen 88 | void qFTracks(); // Ask for the number of tracks folders 89 | void qTTracks(); // Ask for the total of tracks 90 | void qTFolders(); // Ask for the number of folders 91 | 92 | void sleep(); // Send sleep command 93 | void wakeup(); // Send wake up command 94 | void reset(); // Send reset command 95 | 96 | void showDebug(bool on); // true to show debug messages 97 | 98 | private: 99 | String sanswer(); 100 | int shex2int(char *s, int n); 101 | String sbyte2hex(byte b); 102 | bool _showDebugMessages; 103 | SoftwareSerial *Serial3; 104 | byte ansbuf[36] = {0}; // Buffer for the answers. 105 | 106 | }; 107 | 108 | 109 | #endif 110 | -------------------------------------------------------------------------------- /examples/BasicCommands/BasicCommands.ino: -------------------------------------------------------------------------------- 1 | /****************************************************************************** 2 | Basic Commands examples for the SerialMP3Player YX5300 chip. 3 | 4 | Copy the files of "SDcard_example" to an empty SD card 5 | Connect the Serial MP3 Player to the Arduino board 6 | GND → GND 7 | VCC → 5V 8 | TX → pin 11 9 | RX → pin 10 10 | 11 | After compile and upload the code, 12 | you can test some basic commands by sending the letters 13 | ? - Display Menu options. 14 | P01 - Play 01 file 15 | F01 - Play 01 folder 16 | S01 - Play 01 file in loop 17 | p - play 18 | a - pause 19 | s - stop 20 | > - Next 21 | < - Previous 22 | ... 23 | 24 | Some commands like 'P' must be followed by two digits. 25 | 26 | This example code is in the public domain. 27 | 28 | https://github.com/salvadorrueda/ArduinoSerialMP3Player 29 | 30 | by Salvador Rueda 31 | *******************************************************************************/ 32 | 33 | #include "SerialMP3Player.h" 34 | 35 | #define TX 11 36 | #define RX 10 37 | 38 | SerialMP3Player mp3(RX,TX); 39 | 40 | 41 | void setup() { 42 | mp3.showDebug(1); // print what we are sending to the mp3 board. 43 | 44 | Serial.begin(9600); // start serial interface 45 | mp3.begin(9600); // start mp3-communication 46 | delay(500); // wait for init 47 | 48 | mp3.sendCommand(CMD_SEL_DEV, 0, 2); //select sd-card 49 | delay(500); // wait for init 50 | 51 | menu('?',0); // print the menu options. 52 | } 53 | 54 | char c; // char from Serial 55 | char cmd=' '; 56 | char cmd1=' '; 57 | 58 | 59 | // the loop function runs over and over again forever 60 | void loop() { 61 | 62 | if (Serial.available()){ 63 | c = Serial.read(); 64 | decode_c(); // Decode c. 65 | } 66 | // Check for the answer. 67 | if (mp3.available()){ 68 | Serial.println(mp3.decodeMP3Answer()); // print decoded answers from mp3 69 | } 70 | } 71 | 72 | void menu(char op, int nval){ 73 | // Menu 74 | switch (op){ 75 | case '?': 76 | case 'h': 77 | Serial.println("SerialMP3Player Basic Commands:"); 78 | Serial.println(" ? - Display Menu options. "); 79 | Serial.println(" P01 - Play 01 file"); 80 | Serial.println(" F01 - Play 01 folder"); 81 | Serial.println(" S01 - Play 01 file in loop"); 82 | Serial.println(" V01 - Play 01 file, volume 30"); 83 | Serial.println(" p - Play"); 84 | Serial.println(" a - pause"); 85 | Serial.println(" s - stop "); 86 | Serial.println(" > - Next"); 87 | Serial.println(" < - Previous"); 88 | Serial.println(" + - Volume UP"); 89 | Serial.println(" - - Volume DOWN"); 90 | Serial.println(" v15 - Set Volume to 15"); 91 | Serial.println(" c - Query current file"); 92 | Serial.println(" q - Query status"); 93 | Serial.println(" x - Query folder count"); 94 | Serial.println(" t - Query total file count"); 95 | Serial.println(" r - Reset"); 96 | Serial.println(" e - Sleep"); 97 | Serial.println(" w - Wake up"); 98 | break; 99 | 100 | case 'P': 101 | Serial.println("Play"); 102 | mp3.play(nval); 103 | break; 104 | 105 | case 'F': 106 | Serial.println("Play Folder"); 107 | mp3.playF(nval); 108 | break; 109 | 110 | case 'S': 111 | Serial.println("Play loop"); 112 | mp3.playSL(nval); 113 | break; 114 | 115 | case 'V': 116 | Serial.println("Play file at 30 volume"); 117 | mp3.play(nval,30); 118 | break; 119 | 120 | 121 | case 'p': 122 | Serial.println("Play"); 123 | mp3.play(); 124 | break; 125 | 126 | case 'a': 127 | Serial.println("Pause"); 128 | mp3.pause(); 129 | break; 130 | 131 | case 's': 132 | Serial.println("Stop"); 133 | mp3.stop(); 134 | break; 135 | 136 | case '>': 137 | Serial.println("Next"); 138 | mp3.playNext(); 139 | break; 140 | 141 | case '<': 142 | Serial.println("Previous"); 143 | mp3.playPrevious(); 144 | break; 145 | 146 | case '+': 147 | Serial.println("Volume UP"); 148 | mp3.volUp(); 149 | break; 150 | 151 | case '-': 152 | Serial.println("Volume Down"); 153 | mp3.volDown(); 154 | break; 155 | 156 | case 'v': 157 | Serial.println("Set to Volume"); 158 | mp3.setVol(nval); 159 | mp3.qVol(); 160 | break; 161 | 162 | case 'c': 163 | Serial.println("Query current file"); 164 | mp3.qPlaying(); 165 | break; 166 | 167 | case 'q': 168 | Serial.println("Query status"); 169 | mp3.qStatus(); 170 | break; 171 | 172 | case 'x': 173 | Serial.println("Query folder count"); 174 | mp3.qTFolders(); 175 | break; 176 | 177 | case 't': 178 | Serial.println("Query total file count"); 179 | mp3.qTTracks(); 180 | break; 181 | 182 | case 'r': 183 | Serial.println("Reset"); 184 | mp3.reset(); 185 | break; 186 | 187 | case 'e': 188 | Serial.println("Sleep"); 189 | mp3.sleep(); 190 | break; 191 | 192 | case 'w': 193 | Serial.println("Wake up"); 194 | mp3.wakeup(); 195 | break; 196 | } 197 | } 198 | 199 | void decode_c(){ 200 | // Decode c looking for a specific command or a digit 201 | 202 | // if c is a 'v', 'P', 'F', 'S' or 'V' wait for the number XX 203 | if (c=='v' || c=='P' || c=='F' || c=='S' || c=='V'){ 204 | cmd=c; 205 | }else{ 206 | // maybe c is part of XX number 207 | if(c>='0' && c<='9'){ 208 | // if c is a digit 209 | if(cmd1==' '){ 210 | // if cmd1 is empty then c is the first digit 211 | cmd1 = c; 212 | }else{ 213 | // if cmd1 is not empty c is the second digit 214 | menu(cmd, ((cmd1-'0')*10)+(c-'0')); 215 | cmd = ' '; 216 | cmd1 = ' '; 217 | } 218 | }else{ 219 | // c is not a digit nor 'v', 'P', 'F' or 'S' so just call menu(c, nval); 220 | menu(c, 0); 221 | } 222 | } 223 | } 224 | -------------------------------------------------------------------------------- /src/SerialMP3Player.cpp: -------------------------------------------------------------------------------- 1 | /* 2 | * SerialMP3Player.h - Library for Serial MP3 Player board from Catalex (YX5300 chip) 3 | * Created by Salvador Rueda Pau, July 23, 2016. 4 | * License as GPL v3 (http://www.gnu.org/licenses/gpl.html) 5 | * 6 | */ 7 | 8 | #include "Arduino.h" 9 | #include "SerialMP3Player.h" 10 | 11 | // Uncomment next line if you are using an Arduino Mega. 12 | //#define mp3 Serial3 // Connect the MP3 Serial Player to the Arduino MEGA Serial3 (14 TX3 -> RX, 15 RX3 -> TX) 13 | 14 | SerialMP3Player::SerialMP3Player(){ 15 | //SoftwareSerial Serial3 = SoftwareSerial(10, 11); 16 | Serial3 = new SoftwareSerial(10, 11); 17 | _showDebugMessages = false; 18 | } 19 | SerialMP3Player::SerialMP3Player(int RX, int TX){ 20 | //SoftwareSerial Serial3 = SoftwareSerial(RX, TX); 21 | Serial3 = new SoftwareSerial(RX, TX); 22 | _showDebugMessages = false; 23 | } 24 | 25 | void SerialMP3Player::showDebug(bool op){ 26 | // showDebug (op) 0:OFF 1:ON 27 | _showDebugMessages = op; 28 | } 29 | 30 | void SerialMP3Player::begin(int bps){ 31 | Serial3->begin(bps); 32 | } 33 | 34 | int SerialMP3Player::available(){ 35 | return Serial3->available(); 36 | } 37 | 38 | char SerialMP3Player::read(){ 39 | return Serial3->read(); 40 | } 41 | 42 | void SerialMP3Player::playNext(){ 43 | sendCommand(CMD_NEXT); 44 | } 45 | 46 | void SerialMP3Player::playPrevious(){ 47 | sendCommand(CMD_PREV); 48 | } 49 | 50 | void SerialMP3Player::volUp(){ 51 | sendCommand(CMD_VOL_UP); 52 | } 53 | 54 | void SerialMP3Player::volDown(){ 55 | sendCommand(CMD_VOL_DOWN); 56 | } 57 | 58 | void SerialMP3Player::setVol(byte v){ 59 | // Set volumen (0-30) 60 | sendCommand(CMD_SET_VOL, v); 61 | } 62 | 63 | void SerialMP3Player::playSL(byte n){ 64 | // Play single loop n file 65 | sendCommand(CMD_PLAY_SLOOP, n); 66 | } 67 | 68 | void SerialMP3Player::playSL(byte f, byte n){ 69 | // Single loop play n file from f folder 70 | sendCommand(CMD_PLAY_SLOOP, f, n); 71 | } 72 | 73 | void SerialMP3Player::play(){ 74 | sendCommand(CMD_PLAY); 75 | } 76 | 77 | void SerialMP3Player::pause(){ 78 | sendCommand(CMD_PAUSE); 79 | } 80 | 81 | void SerialMP3Player::play(byte n){ 82 | // n number of the file that must be played. 83 | // n possible values (1-255) 84 | sendCommand(CMD_PLAYN, n); 85 | } 86 | 87 | void SerialMP3Player::play(byte n, byte vol){ 88 | // n number of the file that must be played 89 | 90 | sendCommand(CMD_PLAY_W_VOL, vol, n); 91 | } 92 | 93 | void SerialMP3Player::playF(byte f){ 94 | // Play all files in the f folder 95 | 96 | sendCommand(CMD_FOLDER_CYCLE, f, 0); 97 | } 98 | 99 | void SerialMP3Player::stop(){ 100 | sendCommand(CMD_STOP_PLAY); 101 | } 102 | 103 | void SerialMP3Player::qPlaying(){ 104 | // Ask for the file is playing 105 | sendCommand(CMD_PLAYING_N); 106 | } 107 | 108 | void SerialMP3Player::qStatus(){ 109 | // Ask for the status. 110 | sendCommand(CMD_QUERY_STATUS); 111 | } 112 | 113 | void SerialMP3Player::qVol(){ 114 | // Ask for the volumen 115 | sendCommand(CMD_QUERY_VOLUME); 116 | } 117 | 118 | void SerialMP3Player::qFTracks(){ // !!! Nonsense answer 119 | // Ask for the number of tracks folders 120 | sendCommand(CMD_QUERY_FLDR_TRACKS); 121 | } 122 | 123 | void SerialMP3Player::qTTracks(){ 124 | // Ask for the total of tracks 125 | sendCommand(CMD_QUERY_TOT_TRACKS); 126 | } 127 | 128 | void SerialMP3Player::qTFolders(){ 129 | // Ask for the number of folders 130 | sendCommand(CMD_QUERY_FLDR_COUNT); 131 | } 132 | 133 | void SerialMP3Player::sleep(){ 134 | // Send sleep command 135 | sendCommand(CMD_SLEEP_MODE); 136 | } 137 | 138 | void SerialMP3Player::wakeup(){ 139 | // Send wake up command 140 | sendCommand(CMD_WAKE_UP); 141 | } 142 | 143 | void SerialMP3Player::reset(){ 144 | // Send reset command 145 | sendCommand(CMD_RESET); 146 | } 147 | 148 | 149 | 150 | void SerialMP3Player::sendCommand(byte command){ 151 | sendCommand(command, 0, 0); 152 | } 153 | 154 | void SerialMP3Player::sendCommand(byte command, byte dat2){ 155 | sendCommand(command, 0, dat2); 156 | } 157 | 158 | 159 | void SerialMP3Player::sendCommand(byte command, byte dat1, byte dat2){ 160 | byte Send_buf[8] = {0}; // Buffer for Send commands. 161 | String mp3send = ""; 162 | 163 | // Command Structure 0x7E 0xFF 0x06 CMD FBACK DAT1 DAT2 0xEF 164 | 165 | #ifndef NO_SERIALMP3_DELAY 166 | delay(20); 167 | #endif 168 | 169 | Send_buf[0] = 0x7E; // Start byte 170 | Send_buf[1] = 0xFF; // Version 171 | Send_buf[2] = 0x06; // Command length not including Start and End byte. 172 | Send_buf[3] = command; // Command 173 | Send_buf[4] = 0x01; // Feedback 0x00 NO, 0x01 YES 174 | Send_buf[5] = dat1; // DATA1 datah 175 | Send_buf[6] = dat2; // DATA2 datal 176 | Send_buf[7] = 0xEF; // End byte 177 | 178 | for(int i=0; i<8; i++) 179 | { 180 | Serial3->write(Send_buf[i]) ; 181 | mp3send+=sbyte2hex(Send_buf[i]); 182 | } 183 | if (_showDebugMessages){ 184 | Serial.print("Sending: "); 185 | Serial.println(mp3send); // watch what are we sending 186 | } 187 | 188 | #ifndef NO_SERIALMP3_DELAY 189 | delay(1000); 190 | // Wait between sending commands. 191 | #endif 192 | } 193 | 194 | //String sanswer(void); 195 | //int iansbuf = 0; // Index for answer buffer. 196 | //static uint8_t ansbuf[10] = {0}; // Buffer for the answers. 197 | 198 | String SerialMP3Player::decodeMP3Answer(){ 199 | // Response Structure 0x7E 0xFF 0x06 RSP 0x00 0x00 DAT 0xFE 0xBA 0xEF 200 | // 201 | // RSP Response code 202 | // DAT Response additional data 203 | 204 | String decodedMP3Answer=""; 205 | 206 | decodedMP3Answer=sanswer(); 207 | 208 | switch (ansbuf[3]) 209 | { 210 | case 0x3A: 211 | decodedMP3Answer += " -> Memory card inserted."; 212 | break; 213 | 214 | case 0x3D: 215 | decodedMP3Answer += " -> Completed play num " + String(ansbuf[6], DEC); 216 | break; 217 | 218 | case 0x40: 219 | decodedMP3Answer += " -> Error"; 220 | break; 221 | 222 | case 0x41: 223 | decodedMP3Answer += " -> Data recived correctly. "; 224 | break; 225 | 226 | case 0x42: 227 | switch(ansbuf[6]){ 228 | case 0: decodedMP3Answer += " -> Status: stopped"; break; 229 | case 1: decodedMP3Answer += " -> Status: playing"; break; 230 | case 2: decodedMP3Answer += " -> Status: paused"; break; 231 | default: decodedMP3Answer += " -> Status: unknown"; break; 232 | } 233 | break; 234 | 235 | case 0x43: 236 | decodedMP3Answer += " -> Vol playing: " + String(ansbuf[6], DEC); 237 | break; 238 | 239 | case 0x48: 240 | decodedMP3Answer += " -> File count: " + String(ansbuf[6], DEC); 241 | break; 242 | 243 | case 0x4C: 244 | decodedMP3Answer += " -> Playing: " + String(ansbuf[6], DEC); 245 | break; 246 | 247 | case 0x4E: 248 | decodedMP3Answer += " -> Folder file count: " + String(ansbuf[6], DEC); 249 | break; 250 | 251 | case 0x4F: 252 | decodedMP3Answer += " -> Folder count: " + String(ansbuf[6], DEC); 253 | break; 254 | 255 | default: 256 | decodedMP3Answer += " -> Unrecognized response"; 257 | break; 258 | } 259 | 260 | ansbuf[3] = 0; // Clear ansbuff. 261 | return decodedMP3Answer; 262 | } 263 | 264 | 265 | 266 | 267 | 268 | 269 | /********************************************************************************/ 270 | /*Function: sbyte2hex. Returns a byte data in HEX format. */ 271 | /*Parameter:- uint8_t b. Byte to convert to HEX. */ 272 | /*Return: String */ 273 | 274 | 275 | String SerialMP3Player::sbyte2hex(byte b) 276 | { 277 | String shex; 278 | 279 | //Serial.print("0x"); 280 | shex="0X"; 281 | 282 | //if (b < 16) Serial.print("0"); 283 | if (b < 16) shex+="0"; 284 | //Serial.print(b, HEX); 285 | shex+=String(b,HEX); 286 | //Serial.print(" "); 287 | shex+=" "; 288 | return shex; 289 | } 290 | 291 | 292 | /********************************************************************************/ 293 | /*Function: sanswer. Returns a String answer from mp3 UART module. */ 294 | /*Return: String. the answer */ 295 | 296 | 297 | String SerialMP3Player::sanswer(void){ 298 | // Response Structure 0x7E 0xFF 0x06 RSP 0x00 0x00 DAT 0xFE 0xBA 0xEF 299 | // 300 | // RSP Response code 301 | // DAT Response additional data 302 | 303 | // if there are something available start to read from mp3 serial. 304 | // if there are "0x7E" it's a beginning. 305 | // 306 | // read while something readed and it's not the end "0xEF" 307 | 308 | 309 | byte b; 310 | String mp3answer=""; // Answer from the Serial3. 311 | int iansbuf = 0; 312 | 313 | if (Serial3->available()){ 314 | do{ 315 | b = Serial3->read(); 316 | 317 | if(b == 0x7E){ // if there are "0x7E" it's a beginning. 318 | iansbuf=0; // ansbuf index to zero. 319 | mp3answer=""; 320 | } 321 | 322 | ansbuf[iansbuf] = b; 323 | mp3answer+=sbyte2hex(ansbuf[iansbuf]); 324 | iansbuf++; // increase this index. 325 | 326 | }while(b != 0xEF); 327 | // while there are something to read and it's not the end "0xEF" 328 | 329 | } 330 | return mp3answer; 331 | } 332 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | {one line to give the program's name and a brief idea of what it does.} 635 | Copyright (C) {year} {name of author} 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | {project} Copyright (C) {year} {fullname} 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | --------------------------------------------------------------------------------