├── Documentation └── ch376ds1.pdf ├── library.properties ├── keywords.txt ├── README.md ├── CH376s.h ├── examples └── CH376 │ └── CH376.ino ├── CH376s.cpp └── LICENSE /Documentation/ch376ds1.pdf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Abraxas666/CH376s/HEAD/Documentation/ch376ds1.pdf -------------------------------------------------------------------------------- /library.properties: -------------------------------------------------------------------------------- 1 | name=CH376s 2 | version=1.0.0 3 | author=Abraxas666 4 | maintainer=Abraxas 5 | sentence=An Arduino library for the serial USB CH376s 6 | paragraph= 7 | category=Uncategorized 8 | url= 9 | architectures=* 10 | -------------------------------------------------------------------------------- /keywords.txt: -------------------------------------------------------------------------------- 1 | /* 2 | Keywords - Arduino library support for the CH376s USB integrated circuit 3 | Author: Abraxas666 4 | 5 | This library has been made to easily interface and use the CH376s IC with the Arduino Uno/Mega 6 | This library makes use of the SoftwareSerial library, Rx and Tx pins can be directly configured from the main program 7 | 8 | */ 9 | 10 | CH376s KEYWORD1 11 | checkConnection KEYWORD1 12 | checkUnexpectMsg KEYWORD1 13 | init KEYWORD1 14 | 15 | readFile KEYWORD2 16 | writeFile KEYWORD2 17 | deleteFile KEYWORD2 18 | appendFile KEYWORD2 19 | openDir KEYWORD2 20 | deleteDir KEYWORD2 -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # CH376s library v1.0.0 2 | 3 | This is an Arduino library for control the serial USB CH376s IC, it work with Aruino Uno/Mega ( other to be tested ) using the SoftwareSerial 4 | 5 | Original functions founded on http://arduinobasics.blogspot.cz/2015/05/ch376s-usb-readwrite-module.html 6 | and from the foxik, ScottC library https://github.com/foxik0070/arduino_CH376s 7 | 8 | Thanks for the efforts guys, you made a great basic struture of the software to control the CH376s IC. 9 | 10 | What's more in the library: 11 | 12 | - According with the chip datasheet, for every possible command accepted by the CH376 a dedicated funtion has been added. 13 | This to make the library more understandable and remove the existing exadecimal part of code present in the old projects. 14 | 15 | - In the old projects to execute a single command it was necessary to execute more funcions consecutively in the the main code. 16 | For this reason some additional macro-functions were created to allow the final users to execute only a single funtion in the main code and obtain the expected result. 17 | 18 | - The software serial was used and the Tx and Rx pins can be directly selected from the main program, this to give more flexibily as possible. 19 | 20 | - The necessary code to create and delete directories has been added. It is possible to create up to ten levels of subdirectories. 21 | The code allows to create and manipulate files inside to the directories and subdirectories as well. 22 | 23 | - The serial terminal is used to monitor the commands executions and the reply received from the CH376s IC 24 | 25 | 26 | 27 | 28 | 29 | 30 | -------------------------------------------------------------------------------- /CH376s.h: -------------------------------------------------------------------------------- 1 | #include "Arduino.h" 2 | #include 3 | 4 | #ifndef __CH376s_h__ 5 | #define __CH376s_h__ 6 | extern int const RX_pin; 7 | extern int const TX_pin; 8 | #endif 9 | 10 | class CH376s 11 | { 12 | private: 13 | 14 | void CMD_Reset_All(); 15 | void CMD_Check_Exist(); 16 | void CMD_Set_Usb(); 17 | void CMD_Read_Usb_Data(); 18 | void CMD_Get_File_Size(); 19 | void CMD_Write_Data(); 20 | void CMD_Set_File_Name(); 21 | void CMD_Disk_Connect(); 22 | void CMD_Disk_Mount(); 23 | void CMD_Open(); 24 | void CMD_Set_File_Create(); 25 | void CMD_Set_File_Erase(); 26 | void CMD_Close(); 27 | void CMD_Set_Pointer(); 28 | void CMD_Byte_Read(); 29 | void CMD_Byte_Cont_Read(); 30 | void CMD_Byte_Write(); 31 | void CMD_Byte_Cont_Write(); 32 | void CMD_Dir_Create(); 33 | void CMD_Set_Begin(); 34 | void CMD_Set_End(); 35 | void CMD_End_Byte(); 36 | 37 | void USBdiskMount(); 38 | void set_USB_Mode (); 39 | void resetALL(); 40 | void begin(long speed); 41 | void diskConnectionStatus(); 42 | 43 | void fileWrite(String); 44 | void fileRead(); 45 | void fileOpen(); 46 | void tryOpen(); 47 | void fileClose(); 48 | void fileUpdate(); 49 | void filePointer(boolean); 50 | void setFileName(String); 51 | void writeFolder(String); 52 | void folderUpdate(); 53 | void folderOpen(String,String); 54 | void setFolderName(String); 55 | 56 | 57 | boolean fileCreate(); 58 | boolean continueRead(); 59 | boolean waitForResponse(String); 60 | byte getResponseFromUSB(); 61 | boolean setByteRead(byte); 62 | boolean folderCreate(); 63 | int getFileSize(); 64 | 65 | public: 66 | 67 | CH376s(uint8_t defRX,uint8_t defTX); // Define Class 68 | 69 | void checkConnection(); // Check connection with the CH376s IC 70 | void checkUnexpectMsg(); // Check if unexpected messages was sent by the CH376s IC 71 | void init(); // Init the CH376s connection and check the USB status 72 | 73 | void readFile(String,String); // Read an existing file 74 | void writeFile(String,String,String); // Overwrite an existing file. If the file does not exist create a new file. 75 | void deleteFile(String,String); // Delete an existing file 76 | void appendFile(String,String,String); // Append data to an existing file or create a new one 77 | 78 | void openDir(String); // Create or open a directory 79 | void deleteDir(String,String); // Delete an existing directory 80 | 81 | }; 82 | -------------------------------------------------------------------------------- /examples/CH376/CH376.ino: -------------------------------------------------------------------------------- 1 | 2 | // The serial terminal is used to monitor the commands executions and the reply received from the CH376s IC 3 | // The example shows how to crete,manipulate and delete files and directories 4 | // The example shows also how to log data to a csv file 5 | 6 | #include 7 | 8 | #define Tx 49 9 | #define Rx 51 10 | 11 | int const TX_pin = Tx; 12 | int const RX_pin = Rx; 13 | 14 | byte computerByte; //used to store data coming from the computer 15 | 16 | String wrData = "What is the meaning of life?"; 17 | String wrData2 = "The answer is 42."; 18 | String wrData3 = "\tTime\tTemperature\tPressure\tHumidity"; 19 | 20 | String root = "root"; 21 | String path1 = "DIR1"; 22 | String path2 = "DIR1/DIR2/DIR3"; 23 | String path3 = "DIR1/DIR2/DIR3/DIR4"; 24 | 25 | String folderName = "DIR3"; 26 | 27 | String fileName1 = "FILETXT.TXT"; 28 | String fileName2 = "FILECSV.CSV"; 29 | 30 | 31 | CH376s CH376(Rx,Tx); // define class name 32 | 33 | //============================================================================================================================================== 34 | void setup() { 35 | Serial.begin(9600); // Setup serial communication with the computer (using a baud rate of 9600 on serial monitor) 36 | CH376.init(); // Init the connection with CH376 and check the USB status 37 | } 38 | 39 | void loop() { 40 | if(Serial.available()){ 41 | computerByte = Serial.read(); 42 | if(computerByte==49){ // If number 1 from the serial monitor is received 43 | CH376.checkConnection(); // Check for successful connection and communication with the CH376S module. 44 | } 45 | if(computerByte==50){ // If number 2 from the serial monitor is received 46 | CH376.writeFile(fileName1,wrData,root); // Create a file. If file exists,overwrite it. 47 | } 48 | if(computerByte==51){ // If number 3 from the serial monitor is received 49 | CH376.appendFile(fileName1,wrData2,path1); // Create a file inside a dir. If folder exist open it,file exists,append it. 50 | } 51 | if(computerByte==52){ // If number 4 from the serial monitor is received 52 | CH376.readFile(fileName1,root); // Read the file called "FILETXT.TXT" in the main root 53 | } 54 | if(computerByte==53){ // If number 5 from the serial monitor is received 55 | CH376.appendFile(fileName1,wrData2,path3); // Append a file called FILETXT.TXT on path /DIR1/DIR2/DIR3/DIR4 if folder and/or files does not exist it create it. 56 | } 57 | if(computerByte==54){ // If number 6 from the serial monitor is received 58 | CH376.readFile(fileName1,path3); // Read the file called "FILETXT.TXT" on path /DIR1/DIR2/DIR3/DIR4 59 | } 60 | if(computerByte==55){ // If number 7 from the serial monitor is received 61 | CH376.deleteFile(fileName1,root); // Delete the file called "FILETXT.TXT" inside the main root 62 | } 63 | if(computerByte==56){ // If number 8 from the serial monitor is received 64 | CH376.deleteFile(fileName1,path3); // Delete the file called "FILETXT.TXT" on path /DIR1/DIR2/DIR3/DIR4 65 | } 66 | if(computerByte==57){ // If number 9 from the serial monitor is received 67 | CH376.deleteDir(folderName,path2); // Delete the entire directory called DIR3 on path /DIR1/DIR2/DIR3 68 | } 69 | if(computerByte==48){ // If number 0 from the serial monitor is received 70 | CH376.writeFile(fileName2,wrData3,root); // Create a file called FILECSV.CSV and then Write the contents of wrData to this file 71 | int time =0; // CSV file can normally opened with excel using text to coluumns function, splittig the columns by tab 72 | float temp = 26; 73 | float press = 1013.25; 74 | float humidity = 60; 75 | String wrData4 = ""; 76 | String wrData5 = "\t"; 77 | String wrData6 = "\n"; 78 | for ( int i = 0; i < 10; i++ ){ // put some data in the table, time,temp,press and humidity. 79 | time += i; 80 | temp += i; 81 | press += i; 82 | humidity += i; 83 | wrData4 += wrData6; 84 | wrData4 += wrData5; 85 | wrData4 += time; 86 | wrData4 += wrData5; 87 | wrData4 += temp; 88 | wrData4 += wrData5; 89 | wrData4 += press; 90 | wrData4 += wrData5; 91 | wrData4 += humidity; 92 | CH376.appendFile(fileName2,wrData4,root); // Append data to this file 93 | wrData4 = ""; 94 | delay(250); 95 | } 96 | } 97 | } 98 | CH376.checkUnexpectMsg(); // Check for unexpected data transmitted by the CH376S module 99 | } 100 | 101 | -------------------------------------------------------------------------------- /CH376s.cpp: -------------------------------------------------------------------------------- 1 | #include "CH376s.h" 2 | 3 | SoftwareSerial USB(RX_pin,TX_pin); 4 | 5 | #define NULL_CHAR 0x00 6 | #define USB_INT_SUCCESS 0x14 7 | #define USB_INT_DISK_READ 0x1D 8 | #define USB_INT_DISK_WRITE 0x1E 9 | #define ERR_OPEN_DIR 0x41 10 | #define FIRST_BYTE 0x00 11 | #define NUM_BYTES 0x40 12 | #define CLOSE 0x00 13 | #define UPDATE 0x01 14 | #define CHECK 0x01 15 | #define CHECK_OK 0xFE 16 | #define USB_SET_MODE 0x06 17 | #define CMD_RET_SUCCESS 0x51 18 | #define USB_INT_CONNECT 0x15 19 | 20 | 21 | ////////////////////////////////////////////// CH376S COMMANDS ///////////////////////////////////////////////////// 22 | 23 | void CH376s::CMD_Reset_All() { 24 | USB.write(0x57); 25 | USB.write(0xAB); 26 | USB.write(0x05); 27 | } 28 | void CH376s::CMD_Check_Exist() { 29 | USB.write(0x57); 30 | USB.write(0xAB); 31 | USB.write(0x06); 32 | } 33 | void CH376s::CMD_Set_Usb() { 34 | USB.write(0x57); 35 | USB.write(0xAB); 36 | USB.write(0x15); 37 | } 38 | void CH376s::CMD_Read_Usb_Data() { 39 | USB.write(0x57); 40 | USB.write(0xAB); 41 | USB.write(0x27); 42 | } 43 | void CH376s::CMD_Get_File_Size() { 44 | USB.write(0x57); 45 | USB.write(0xAB); 46 | USB.write(0x0C); 47 | USB.write(0x68); 48 | } 49 | void CH376s::CMD_Write_Data() { 50 | USB.write(0x57); 51 | USB.write(0xAB); 52 | USB.write(0x2D); 53 | } 54 | void CH376s::CMD_Set_File_Name() { 55 | USB.write(0x57); 56 | USB.write(0xAB); 57 | USB.write(0x2F); 58 | } 59 | void CH376s::CMD_Disk_Connect() { 60 | USB.write(0x57); 61 | USB.write(0xAB); 62 | USB.write(0x30); 63 | } 64 | void CH376s::CMD_Disk_Mount() { 65 | USB.write(0x57); 66 | USB.write(0xAB); 67 | USB.write(0x31); 68 | } 69 | void CH376s::CMD_Open() { 70 | USB.write(0x57); 71 | USB.write(0xAB); 72 | USB.write(0x32); 73 | } 74 | void CH376s::CMD_Set_File_Create() { 75 | USB.write(0x57); 76 | USB.write(0xAB); 77 | USB.write(0x34); 78 | } 79 | void CH376s::CMD_Set_File_Erase() { 80 | USB.write(0x57); 81 | USB.write(0xAB); 82 | USB.write(0x35); 83 | } 84 | void CH376s::CMD_Close() { 85 | USB.write(0x57); 86 | USB.write(0xAB); 87 | USB.write(0x36); 88 | } 89 | void CH376s::CMD_Set_Pointer() { 90 | USB.write(0x57); 91 | USB.write(0xAB); 92 | USB.write(0x39); 93 | } 94 | void CH376s::CMD_Byte_Read() { 95 | USB.write(0x57); 96 | USB.write(0xAB); 97 | USB.write(0x3A); 98 | } 99 | void CH376s::CMD_Byte_Cont_Read() { 100 | USB.write(0x57); 101 | USB.write(0xAB); 102 | USB.write(0x3B); 103 | } 104 | void CH376s::CMD_Byte_Write() { 105 | USB.write(0x57); 106 | USB.write(0xAB); 107 | USB.write(0x3C); 108 | } 109 | void CH376s::CMD_Byte_Cont_Write() { 110 | USB.write(0x57); 111 | USB.write(0xAB); 112 | USB.write(0x3D); 113 | } 114 | void CH376s::CMD_Dir_Create() { 115 | USB.write(0x57); 116 | USB.write(0xAB); 117 | USB.write(0x40); 118 | } 119 | void CH376s::CMD_Set_Begin() { 120 | USB.write((byte)0x00); // Beginning of file 121 | USB.write((byte)0x00); 122 | USB.write((byte)0x00); 123 | USB.write((byte)0x00); 124 | } 125 | void CH376s::CMD_Set_End() { 126 | USB.write((byte)0xFF); // End of file 127 | USB.write((byte)0xFF); 128 | USB.write((byte)0xFF); 129 | USB.write((byte)0xFF); 130 | } 131 | void CH376s::CMD_End_Byte() { 132 | USB.write((byte)0x00); // End of file name 133 | } 134 | 135 | ////////////////////////////////////////////////////////////// PRIVATE FUNCTIONS ///////////////////////////////////////////////////////////////////// 136 | 137 | void CH376s::USBdiskMount(){ // Initialise the USB disk and check that it is ready.This process is required if you want to find the manufacturing information of the USB disk 138 | Serial.println("Mounting USB disk"); 139 | CMD_Disk_Mount(); 140 | 141 | if(waitForResponse("Connecting to USB disk")){ 142 | if(getResponseFromUSB()== USB_INT_SUCCESS){ 143 | Serial.println("Disk mounted - OK"); 144 | } else { 145 | Serial.println(getResponseFromUSB()); 146 | Serial.println("Failed to mount USB disk."); 147 | } 148 | } 149 | } 150 | 151 | void CH376s::set_USB_Mode (){ // Make sure that the USB is inserted 152 | CMD_Set_Usb(); 153 | USB.write(USB_SET_MODE); 154 | delay(20); 155 | 156 | if(USB.available()){ 157 | byte USB_Byte; 158 | USB_Byte = USB.read(); 159 | 160 | if(USB_Byte == CMD_RET_SUCCESS){ 161 | Serial.println("Set_USB_Mode command acknowledged"); 162 | USB_Byte = USB.read(); 163 | if(USB_Byte == USB_INT_CONNECT){ 164 | Serial.println("USB is present"); 165 | } 166 | else { 167 | Serial.print("USB Not present. Error code:"); 168 | Serial.print(USB_Byte, HEX); 169 | Serial.println("H"); 170 | } 171 | } 172 | else { 173 | Serial.print("CH3765 error! Error code:"); 174 | Serial.print(USB_Byte, HEX); 175 | Serial.println("H"); 176 | } 177 | } 178 | delay(20); 179 | } 180 | 181 | void CH376s::resetALL(){ // Perform a hardware reset of the CH376S module 182 | CMD_Reset_All(); 183 | Serial.println("The CH376S module has been reset !"); 184 | delay(200); 185 | } 186 | 187 | void CH376s::begin(long speed) // Initizialize the connection 188 | { 189 | USB.begin(speed); 190 | } 191 | 192 | void CH376s::diskConnectionStatus(){ // Check the disk connection status 193 | Serial.println("Checking USB disk connection status"); 194 | CMD_Disk_Connect(); 195 | 196 | if(waitForResponse("Connecting to USB disk")){ 197 | if(getResponseFromUSB()== USB_INT_SUCCESS){ 198 | Serial.println("Connection to USB OK"); 199 | } else { 200 | Serial.print("Connection to USB - FAILED."); 201 | } 202 | } 203 | } 204 | 205 | void CH376s::fileWrite(String data){ // Used for write into a file 206 | Serial.print("Writing to file:"); 207 | byte dataLength = (byte) data.length(); 208 | Serial.println(data); 209 | Serial.print("Data Length:"); 210 | Serial.println(dataLength); 211 | delay(100); 212 | CMD_Byte_Write(); 213 | USB.write((byte) dataLength); 214 | CMD_End_Byte(); 215 | if(waitForResponse("setting data Length")){ 216 | if(getResponseFromUSB()== USB_INT_DISK_WRITE){ 217 | CMD_Write_Data(); 218 | USB.print(data); 219 | 220 | if(waitForResponse("writing data to file")){ 221 | } 222 | Serial.print("Write code (normally FF and 14): "); 223 | Serial.print(USB.read(),HEX); 224 | Serial.print(","); 225 | CMD_Byte_Cont_Write(); 226 | if(waitForResponse("updating file size")){ 227 | } 228 | Serial.println(USB.read(),HEX); 229 | } 230 | } 231 | } 232 | 233 | void CH376s::fileRead(){ // Used to read the contents of the file 234 | Serial.println("Reading file:"); 235 | byte firstByte = FIRST_BYTE; 236 | byte numBytes = NUM_BYTES; 237 | while(setByteRead(numBytes)){ 238 | CMD_Read_Usb_Data(); 239 | if(waitForResponse("reading data")){ 240 | firstByte=USB.read(); 241 | while(USB.available()){ 242 | Serial.write(USB.read()); 243 | delay(1); 244 | } 245 | } 246 | if(!continueRead()){ 247 | break; 248 | } 249 | } 250 | Serial.println(); 251 | Serial.println("NO MORE DATA"); 252 | } 253 | 254 | void CH376s::fileOpen(){ // Used the file for reading or writing 255 | Serial.println("Opening file."); 256 | CMD_Open(); 257 | if(waitForResponse("file Open")){ 258 | if(getResponseFromUSB()== USB_INT_SUCCESS){ 259 | Serial.println("File opened successfully."); 260 | } else { 261 | Serial.println("Failed to open file."); 262 | fileCreate(); 263 | } 264 | } 265 | } 266 | 267 | void CH376s::tryOpen(){ // Used the file for reading or writing 268 | Serial.println("Opening file."); 269 | CMD_Open(); 270 | if(waitForResponse("file Open")){ 271 | if(getResponseFromUSB()== USB_INT_SUCCESS){ 272 | Serial.println("File opened successfully."); 273 | } else { 274 | Serial.println("Failed to open file."); 275 | } 276 | } 277 | } 278 | 279 | void CH376s::fileClose(){ // Used to close the files 280 | Serial.print("Closing file:"); 281 | CMD_Close(); 282 | USB.write((byte)CLOSE); 283 | 284 | if(waitForResponse("closing file")){ 285 | byte resp = getResponseFromUSB(); 286 | if(resp == USB_INT_SUCCESS){ 287 | Serial.println(" File closed successfully."); 288 | } else { 289 | Serial.print(" Failed to close file. Error code:"); 290 | Serial.println(resp, HEX); 291 | } 292 | } 293 | } 294 | 295 | void CH376s::fileUpdate(){ // Used to close and update the files 296 | Serial.print("Closing file:"); 297 | CMD_Close(); 298 | USB.write((byte)UPDATE); 299 | 300 | if(waitForResponse("Closing file")){ 301 | byte resp = getResponseFromUSB(); 302 | if(resp == USB_INT_SUCCESS){ 303 | Serial.println("File updated successfully."); 304 | } else { 305 | Serial.print("Failed to update file. Error code:"); 306 | Serial.println(resp, HEX); 307 | } 308 | } 309 | } 310 | 311 | void CH376s::filePointer(boolean fileBeginning){ // FilePointer is used to set the file pointer position. True for beginning of file, false for the end of the file. 312 | CMD_Set_Pointer(); 313 | if(fileBeginning){ 314 | CMD_Set_Begin();} 315 | else {CMD_Set_End();} 316 | if(waitForResponse("setting file pointer")){ 317 | if(getResponseFromUSB()== USB_INT_SUCCESS){ 318 | Serial.println("Pointer successfully applied"); 319 | } 320 | } 321 | } 322 | 323 | void CH376s::setFileName(String fileName){ // Sets the name of the file to work with 324 | Serial.print("Setting filename to:"); 325 | Serial.println(fileName); 326 | CMD_Set_File_Name(); 327 | USB.print(fileName); 328 | CMD_End_Byte(); 329 | delay(20); 330 | } 331 | 332 | void CH376s::writeFolder(String folderName){ // Used to create a new folder 333 | 334 | setFolderName(folderName); 335 | if(folderCreate()){ 336 | Serial.println("Folder created successfully"); 337 | } 338 | else {Serial.println("Folder could not be created, or it already exists"); 339 | } 340 | folderUpdate(); 341 | } 342 | 343 | void CH376s::folderUpdate(){ // Used to update a folder 344 | Serial.print("Closing folder:"); 345 | CMD_Close(); 346 | USB.write((byte)UPDATE); 347 | 348 | if(waitForResponse("closing folder")){ 349 | byte resp = getResponseFromUSB(); 350 | if(resp == USB_INT_SUCCESS){ 351 | Serial.println(" Folder updated successfully."); 352 | } else { 353 | Serial.print(" Failed to update folder. Error code:"); 354 | Serial.println(resp, HEX); 355 | } 356 | } 357 | } 358 | 359 | void CH376s::folderOpen(String folderName, String path){ // FolderOpen is used to navigate inside a folder, if the folder does not exist, create the folder first 360 | Serial.println("--------------------- OPEN FOLDER ---------------------"); 361 | Serial.println("Opening folder."); 362 | setFolderName(path); 363 | CMD_Open(); 364 | if(waitForResponse("file Open")){ 365 | if(getResponseFromUSB()== ERR_OPEN_DIR){ 366 | Serial.println("Folder opened successfully."); 367 | } 368 | else { 369 | int length = folderName.length(); 370 | folderName = folderName.substring(1,length); 371 | Serial.print("foldername = "); 372 | Serial.println(folderName); 373 | writeFolder(folderName); 374 | Serial.println("Folder was not present,folder created!"); 375 | } 376 | } 377 | Serial.println("------------------ END OF OPEN FOLDER -----------------"); 378 | } 379 | 380 | void CH376s::setFolderName(String folderName){ // Sets the name of the folder to work with 381 | Serial.print("Setting folder name to:"); 382 | Serial.println(folderName); 383 | CMD_Set_File_Name(); 384 | USB.print(folderName); 385 | CMD_End_Byte(); 386 | delay(20); 387 | } 388 | 389 | boolean CH376s::fileCreate(){ // Used to create a file 390 | boolean createdFile = false; 391 | CMD_Set_File_Create(); 392 | if(waitForResponse("creating file")){ 393 | if(getResponseFromUSB()== USB_INT_SUCCESS){ 394 | createdFile=true; 395 | } 396 | } 397 | return(createdFile); 398 | } 399 | 400 | boolean CH376s::continueRead(){ // Continue to read the file : I could not get this function to work as intended. 401 | boolean readAgain = false; 402 | CMD_Byte_Cont_Read(); 403 | if(waitForResponse("continueRead")){ 404 | if(getResponseFromUSB()== USB_INT_SUCCESS){ 405 | readAgain=true; 406 | } 407 | } 408 | return(readAgain); 409 | } 410 | 411 | boolean CH376s::waitForResponse(String errorMsg){ // WaitForResponse. Returns true when bytes become available, false if it times out. 412 | boolean bytesAvailable = true; 413 | int counter=0; 414 | int timeOut = 400; 415 | 416 | while(!USB.available()){ 417 | delay(1); 418 | counter++; 419 | if(counter > timeOut){ 420 | Serial.print("TimeOut waiting for response: Error while: "); 421 | Serial.println(errorMsg); 422 | bytesAvailable = false; 423 | break; 424 | } 425 | } 426 | delay(1); 427 | return(bytesAvailable); 428 | } 429 | 430 | byte CH376s::getResponseFromUSB(){ // ResponseFromUSB.Get any error codes or messages from the CH376S 431 | byte response = NULL_CHAR; 432 | if (USB.available()){ 433 | response = USB.read(); 434 | } 435 | return(response); 436 | } 437 | 438 | boolean CH376s::setByteRead(byte numBytes){ // This function is required if you want to read data from the file. 439 | boolean bytesToRead=false; 440 | int timeCounter = 0; 441 | CMD_Byte_Read(); 442 | USB.write((byte)numBytes); 443 | CMD_End_Byte(); 444 | if(waitForResponse("setByteRead")){ 445 | if(getResponseFromUSB()== USB_INT_DISK_READ){ 446 | bytesToRead=true; 447 | } 448 | } 449 | return(bytesToRead); 450 | } 451 | 452 | boolean CH376s::folderCreate(){ // The command sequence to create a folder 453 | boolean createdFolder = false; 454 | CMD_Dir_Create(); 455 | if(waitForResponse("creating file")){ 456 | if(getResponseFromUSB()== USB_INT_SUCCESS){ 457 | createdFolder=true; 458 | } 459 | } 460 | return(createdFolder); 461 | } 462 | 463 | int CH376s::getFileSize(){ // GetFileSize() is used to writes the file size to the serial Monitor. 464 | int fileSize=0; 465 | Serial.println("Getting File Size"); 466 | CMD_Get_File_Size(); 467 | delay(100); 468 | Serial.print("FileSize = "); 469 | if(USB.available()){ 470 | fileSize = fileSize + USB.read(); 471 | } 472 | if(USB.available()){ 473 | fileSize = fileSize + (USB.read()*255); 474 | } 475 | if(USB.available()){ 476 | fileSize = fileSize + (USB.read()*255*255); 477 | } 478 | if(USB.available()){ 479 | fileSize = fileSize + (USB.read()*255*255*255); 480 | } 481 | Serial.println(fileSize); 482 | delay(10); 483 | return(fileSize); 484 | } 485 | 486 | 487 | 488 | //////////////////////////////////////////////////////// PUBLIC FUNCTIONS ///////////////////////////////////////////////////////////////////////////// 489 | 490 | CH376s::CH376s(uint8_t defRX,uint8_t defTX) { // define class name 491 | } 492 | 493 | void CH376s::init(){ // initialize connection with CH376s and check the USB status 494 | begin(9600); 495 | Serial.println("-------------------- INIT CH376 ---------------------"); 496 | resetALL(); 497 | set_USB_Mode(); 498 | diskConnectionStatus(); 499 | USBdiskMount(); 500 | Serial.println("---------------- END OF INTIALIZATION ----------------"); 501 | } 502 | 503 | void CH376s::checkConnection(){ // This function is used to check for successful communication with the CH376S module. 504 | CMD_Check_Exist(); 505 | USB.write((byte)CHECK); 506 | Serial.println("------------------ CHECK CONNECTION -------------------"); 507 | if(waitForResponse("checking connection")){ 508 | if(getResponseFromUSB()== CHECK_OK){ 509 | Serial.println("Connection to CH376S was successful."); 510 | } 511 | else { 512 | Serial.print("Connection to CH376S - FAILED."); 513 | } 514 | } 515 | Serial.println("------------------ CHECK COMPLETED -------------------"); 516 | } 517 | 518 | void CH376s::checkUnexpectMsg(){ 519 | if(USB.available()){ // If unexpected data transmitted by the CH376S module 520 | Serial.print("CH376S has just sent the message: "); 521 | Serial.println(USB.read(), HEX); 522 | } 523 | } 524 | 525 | void CH376s::readFile(String fileName,String path){ // Used to read a file 526 | 527 | openDir(path); 528 | Serial.println("------------------ FILE READING -----------------------"); 529 | setFileName(fileName); 530 | fileOpen(); 531 | int fs = getFileSize(); 532 | fileRead(); 533 | fileClose(); 534 | Serial.println("-------------- FILE READING COMPLETED -----------------"); 535 | } 536 | 537 | void CH376s::writeFile(String fileName, String data,String path){ // Used to write a file 538 | openDir(path); 539 | setFileName(fileName); 540 | if(fileCreate()){ 541 | fileWrite(data); 542 | } 543 | else { 544 | Serial.println("File could not be created, or it already exists"); 545 | } 546 | fileUpdate(); 547 | Serial.println("------------------ FILE CREATED -----------------------"); 548 | } 549 | 550 | void CH376s::deleteFile(String fileName,String path){ // Used to delete a file 551 | openDir(path); 552 | Serial.println("----------------- FILE DELETING -----------------------"); 553 | setFileName(fileName); 554 | tryOpen(); 555 | delay(20); 556 | CMD_Set_File_Erase(); 557 | if(waitForResponse("deleting file")){ 558 | if(getResponseFromUSB()== USB_INT_SUCCESS){ 559 | Serial.println("Successfully deleted file"); 560 | } 561 | else { 562 | Serial.println("File could not be deleted, or it does not exists"); 563 | } 564 | } 565 | Serial.println("---------------- FILE DELETE END ----------------------"); 566 | } 567 | void CH376s::appendFile(String fileName, String data, String path){ // AppendFile is used to write data to the end of the file, without erasing the contents of the file. 568 | openDir(path); 569 | Serial.println("-------------------- APPEND FILE ----------------------"); 570 | setFileName(fileName); 571 | fileOpen(); 572 | filePointer(false); 573 | fileWrite(data); 574 | fileUpdate(); 575 | Serial.println("------------------- END OF APPEND FILE ----------------"); 576 | } 577 | 578 | void CH376s::deleteDir(String fileName,String path){ // Used to delete a file 579 | openDir(path); 580 | Serial.println("----------------- FOLDER DELETING -----------------------"); 581 | setFileName(fileName); 582 | delay(20); 583 | CMD_Set_File_Erase(); 584 | if(waitForResponse("deleting folder")){ 585 | if(getResponseFromUSB()== USB_INT_SUCCESS){ 586 | Serial.println("Successfully deleted folder"); 587 | } 588 | else { 589 | Serial.println("Folder could not be deleted, or it does not exists"); 590 | } 591 | } 592 | Serial.println("---------------- FOLDER DELETE END ----------------------"); 593 | } 594 | 595 | void CH376s::openDir(String dirNames){ // Used to open or create a directory 596 | 597 | int count =0; 598 | int index[] = {-1,0,0,0,0,0,0,0,0,0,0,0}; 599 | String folderName; 600 | String path; 601 | String root = "/\0"; 602 | 603 | for ( int i = 0; i < dirNames.length() +1; i++ ){ 604 | if (dirNames[i] == '/'){ 605 | count++; 606 | index[count]=i; 607 | } 608 | } 609 | index[count+1] = dirNames.length(); 610 | folderOpen(root,root); 611 | 612 | for ( int i = 0; i < count+1; i++ ){ 613 | String dirName = dirNames.substring(index[i]+1,index[i+1]); 614 | if (dirName.length() > 8) { Serial.println("ERROR name too long! Dir will not be created!");folderName = ""; path = "";break;} 615 | else if (dirName == "root" ) { folderName = ""; path = "";break;} 616 | else { 617 | if ( i == 0 ){ 618 | folderName = "/"; 619 | folderName+= dirName; 620 | folderName+= "\0"; 621 | path = dirName; 622 | folderOpen(folderName,path); 623 | } 624 | else { 625 | folderName = " "; 626 | folderName+= dirName; 627 | folderName+= "\0"; 628 | path = dirName; 629 | folderOpen(folderName,path); 630 | } 631 | } 632 | folderName = ""; 633 | } 634 | path = ""; 635 | } 636 | ////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// 637 | -------------------------------------------------------------------------------- /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 | 635 | Copyright (C) 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 | Copyright (C) 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 | --------------------------------------------------------------------------------