├── ESP32_WebRadio.ino ├── LICENSE ├── README.md ├── config.ino ├── data ├── config.json ├── favicon.ico ├── index.html ├── loader.gif └── streams.json ├── images ├── banner.png ├── esp32_webradio.jpg ├── esp32_webradio_front.jpg ├── esp32_webradio_inside.jpg ├── esp32_webradio_lateral.jpg ├── esp32_webradio_overview.jpg └── schematic.png └── webserver.ino /ESP32_WebRadio.ino: -------------------------------------------------------------------------------- 1 | // 2 | // ESP32 WebRadio 3 | // 4 | // Released under GNU General Public License v3.0 5 | // 6 | // Compile with DOIT ESP32 WebKit v1 and burn /data directory into SPIFFS (1M) 7 | // 8 | // 0.0.1 - 08.05.2020 9 | // - First public release 10 | // 11 | // 0.0.2 - 09.05.2020 12 | // - Added streams.json with lists of stream URL to be played 13 | // - Some minon bugs fixed 14 | // 15 | // 0.0.3 - 14.05.2020 16 | // - Some design changes, like 3 mechanical buttons (but you can use capacitive one, if you want) 17 | // - Streams list also on webpage, with the ability to play each with a click 18 | // - Display graphic improvementes 19 | // - Lots of new features and bugs fixed 20 | // - Other minor changes 21 | // 22 | // 0.0.4 - 20.05.2020 23 | // - Better OTA handling 24 | // - Display now show scrolling title and stream name, current time and wifi power in top bar 25 | // 26 | // 0.0.5 - 03.06.2020 27 | // - Better wifi icon 28 | // - Display now show more info about radio and songs 29 | // - Adding streams URL via Web now work 30 | // - Minor bugs fixed 31 | // 32 | // 0.0.6 - 30.07.2020 33 | // - Just small remarks to fix some compiler errors 34 | // 35 | // 0.0.7 - 16.0.4.2021 36 | // - Just some small fixes and a refresh for library dependencies. Tested with: 37 | // - ESP32-audioI2S (https://github.com/schreibfaul1/ESP32-audioI2S) 783f67c 38 | // - ESP32-Arduino (https://github.com/espressif/arduino-esp32) 1.0.6 39 | 40 | #define __DEBUG__ 41 | //#define __NEOPIXEL__ // Uncomment if you plain to use one or more NeoPixel 42 | 43 | // Firmware data 44 | const char BUILD[] = __DATE__ " " __TIME__; 45 | #define FW_NAME "esp32-webradio" 46 | #define FW_VERSION "0.0.7" 47 | 48 | #include 49 | #include 50 | #include 51 | #include 52 | #include 53 | 54 | #include "time.h" 55 | 56 | // Audio to PCM5102 DAC 57 | // "https://github.com/schreibfaul1/ESP32-audioI2S" 58 | #include "Audio.h" 59 | 60 | #define I2S_DOUT 22 61 | #define I2S_BCLK 26 62 | #define I2S_LRC 25 63 | 64 | #define MAX_VOLUME 21 65 | #define MIN_VOLUME 0 66 | 67 | Audio audio; 68 | 69 | // Control buttons 70 | #define BUTTONS_NUM 3 71 | const int BUTTONS_PINS[BUTTONS_NUM] = {34, 35, 32}; 72 | 73 | // Icons 74 | #define audio_icon_width 5 75 | #define audio_icon_height 10 76 | static const uint8_t PROGMEM audio_icon_bits[] = { 77 | 0x10, 0x18, 0x1c, 0x1f, 0x1f, 0x1f, 0x1f, 0x1c, 0x18, 0x10 }; 78 | 79 | #define wifi_icon_width 8 80 | #define wifi_icon_height 8 81 | static const uint8_t PROGMEM wifi_icon_bits[] = { 82 | 0x00, 0x1f, 0x20, 0x4e, 0x50, 0x56, 0x56, 0x40 }; 83 | 84 | 85 | // LCD PCD8544 - NOKIA 5110 86 | #include 87 | #include 88 | #include 89 | #include 90 | 91 | #define DISPLAY_SCLK 23 92 | #define DISPLAY_DIN 19 93 | #define DISPLAY_DC 21 94 | #define DISPLAY_CS 18 // CE 95 | #define DISPLAY_RST 14 96 | 97 | #define DISPLAY_BL 27 98 | #define DISPLAY_BL_DEFAULT 100 // Backlight LEDs PWM duty-cycle 99 | 100 | // Serial clock out (SCLK), Serial data out (DIN), Data/Command select (D/C), LCD chip select (CS), LCD reset (RST) 101 | Adafruit_PCD8544 display = Adafruit_PCD8544(DISPLAY_SCLK, DISPLAY_DIN, DISPLAY_DC, DISPLAY_CS, DISPLAY_RST); 102 | 103 | #ifdef __NEOPIXEL__ 104 | 105 | // Neopixel 106 | // https://github.com/adafruit/Adafruit_NeoPixel 107 | #include 108 | 109 | #define PIN 2 110 | #define NUMPIXELS 1 // Popular NeoPixel ring size 111 | Adafruit_NeoPixel pixels(NUMPIXELS, PIN, NEO_GRB + NEO_KHZ800); 112 | 113 | #endif 114 | 115 | // WebServer 116 | #include 117 | #include 118 | 119 | AsyncWebServer server(80); 120 | 121 | // ArduinoJson 122 | // https://arduinojson.org/ 123 | #include 124 | 125 | // File System 126 | #include 127 | #include "SPIFFS.h" 128 | 129 | // Format SPIFFS if mount failed 130 | #define FORMAT_SPIFFS_IF_FAILED 1 131 | 132 | #include "soc/soc.h" //disable brownour problems 133 | #include "soc/rtc_cntl_reg.h" //disable brownour problems 134 | 135 | // Config 136 | struct Config { 137 | // WiFi config 138 | char wifi_essid[24]; 139 | char wifi_password[16]; 140 | // NTP Config 141 | char ntp_server[16]; 142 | int8_t ntp_timezone; 143 | int8_t ntp_daylightOffset; 144 | // Host config 145 | char hostname[16]; 146 | bool ota_enable; 147 | char ota_password[8]; 148 | // Radio podcast 149 | int8_t stream_id; 150 | int8_t stream_count; 151 | char stream_url[64]; 152 | int8_t volume; 153 | // Display config 154 | int8_t contrast; 155 | }; 156 | 157 | #define CONFIG_FILE "/config.json" 158 | File configFile; 159 | Config config; // Global config object 160 | 161 | // JSON file contains an array of streams URL 162 | #define DB_FILE "/streams.json" 163 | 164 | static int last; // millis counter 165 | bool streamIsValid = false; 166 | bool streamChanged = true; 167 | bool streamIsPaused = false; 168 | bool streamIsPlaying = false; 169 | bool deviceIsOTA = false; 170 | 171 | DynamicJsonDocument env(256); 172 | 173 | /* 174 | * Esternal procedures definition 175 | */ 176 | bool loadConfigFile(); 177 | void initWebServer(); 178 | void printStreamsDB(); 179 | bool getStreamURL(uint8_t); 180 | 181 | // ************************************ 182 | // DEBUG_PRINT() and DEBUG_PRINTLN() 183 | // 184 | // send message to Serial 185 | // ************************************ 186 | void DEBUG_PRINT(String message) { 187 | #ifdef __DEBUG__ 188 | Serial.print(message); 189 | #endif 190 | } 191 | 192 | void DEBUG_PRINTLN(String message) { 193 | #ifdef __DEBUG__ 194 | Serial.println(message); 195 | #endif 196 | } 197 | 198 | // ************************************ 199 | // connectToWifi() 200 | // 201 | // connect to configured WiFi network 202 | // ************************************ 203 | bool connectToWifi() { 204 | uint8_t timeout=0; 205 | 206 | if(strlen(config.wifi_essid) > 0) { 207 | DEBUG_PRINT("[INIT] Connecting to "+String(config.wifi_essid)+"..."); 208 | 209 | WiFi.begin(config.wifi_essid, config.wifi_password); 210 | 211 | while((WiFi.status() != WL_CONNECTED)&&(timeout < 10)) { 212 | delay(250); 213 | timeout++; 214 | } 215 | if(WiFi.status() == WL_CONNECTED) { 216 | DEBUG_PRINTLN("CONNECTED. IP:"+WiFi.localIP().toString()+" GW:"+WiFi.gatewayIP().toString()); 217 | 218 | env["ip"] = WiFi.localIP().toString(); 219 | if (MDNS.begin(config.hostname)) { 220 | DEBUG_PRINTLN("[INIT] MDNS responder started: "+String(config.hostname)); 221 | // Add service to MDNS-SD 222 | MDNS.addService("http", "tcp", 80); 223 | } 224 | 225 | configTime(config.ntp_timezone * 3600, config.ntp_daylightOffset * 3600, config.ntp_server); 226 | 227 | return true; 228 | } else { 229 | DEBUG_PRINTLN("[ERROR] Failed to connect to WiFi"); 230 | return false; 231 | } 232 | } else { 233 | DEBUG_PRINTLN("[ERROR] Please configure Wifi"); 234 | return false; 235 | } 236 | } 237 | 238 | // 239 | // high priority audioTask on CORE0 240 | // 241 | void audioTask(void *pvParameters) { 242 | while(1) { 243 | if(!streamIsPaused) { 244 | if(streamChanged) { 245 | playStream(config.stream_id); 246 | streamChanged=false; 247 | } 248 | audio.loop(); 249 | 250 | streamIsPlaying = audio.isRunning(); 251 | } 252 | } 253 | } 254 | 255 | // 256 | // SETUP() 257 | // 258 | void setup() { 259 | Serial.begin(115200); 260 | Serial.setDebugOutput(true); 261 | Serial.println(); 262 | Serial.println(); 263 | Serial.println(); 264 | Serial.print("ESP32 SDK: "); 265 | Serial.println(ESP.getSdkVersion()); 266 | Serial.println(); 267 | Serial.print(FW_NAME); 268 | Serial.print(" "); 269 | Serial.print(FW_VERSION); 270 | Serial.print(" "); 271 | Serial.println(BUILD); 272 | delay(1000); 273 | 274 | // Initialize SPIFFS 275 | DEBUG_PRINT("[INIT] Initializing SPIFFS..."); 276 | if(!SPIFFS.begin()){ 277 | DEBUG_PRINTLN("[ERROR] SPIFFS mount failed. Try formatting..."); 278 | if(SPIFFS.format()) { 279 | DEBUG_PRINTLN("[INIT] SPIFFS initialized successfully"); 280 | } else { 281 | DEBUG_PRINTLN("[FATAL] SPIFFS fatal error"); 282 | ESP.restart(); 283 | } 284 | } else { 285 | DEBUG_PRINTLN("OK"); 286 | } 287 | 288 | // Initialize buttons control board 289 | for (int i = 0; i < BUTTONS_NUM; i++) { 290 | pinMode(BUTTONS_PINS[i], INPUT); 291 | } 292 | 293 | // Load configuration 294 | loadConfigFile(); 295 | 296 | // Initialize DISPLAY 297 | DEBUG_PRINT("[INIT] Initialize display..."); 298 | 299 | display.begin(); 300 | display.setContrast(100); 301 | 302 | pinMode(DISPLAY_BL,OUTPUT); 303 | ledcSetup(0, 12000, 8); 304 | ledcAttachPin(DISPLAY_BL, 0); 305 | // Fade-in 306 | for(uint8_t i=0;i()); 368 | DEBUG_PRINTLN("OK"); 369 | 370 | #ifdef __NEOPIXEL__ 371 | DEBUG_PRINT("[INIT] Initialize NeoPixel..."); 372 | pixels.begin(); 373 | pixels.setBrightness(80); 374 | pixels.show(); // Initialize all pixels to 'off' 375 | DEBUG_PRINTLN("OK"); 376 | #endif 377 | 378 | // 379 | printStreamsDB(); 380 | 381 | // let's fly! 382 | DEBUG_PRINTLN("[INIT] Ready: let's fly!"); 383 | env["status"] = "Ready"; 384 | 385 | // Launch audioTask on CORE0 with high priority 386 | disableCore0WDT(); // Disable watchdog on CORE0 387 | xTaskCreatePinnedToCore( 388 | audioTask, /* Function to implement the task */ 389 | "audioTask", /* Name of the task */ 390 | 10000, /* Stack size in words */ 391 | NULL, /* Task input parameter */ 392 | 15, /* Priority of the task */ 393 | NULL, /* Task handle. */ 394 | 0); /* Core where the task should run */ 395 | } 396 | 397 | String zeroPadding(int digit) { 398 | if(digit < 10) { 399 | return String("0"+String(digit)); 400 | } 401 | return String(digit); 402 | } 403 | 404 | uint8_t t_idx=0, d_cycle=0, d_cnt=0; 405 | 406 | void updateDisplay() { 407 | d_cnt++; 408 | if((d_cnt % 5)==0) { 409 | d_cycle++; 410 | if(d_cycle > 2) { 411 | d_cycle=0; 412 | } 413 | } 414 | 415 | // Graphic display of 84×48 pixels 416 | display.clearDisplay(); 417 | display.setContrast(config.contrast); 418 | 419 | // If there's an OTA running... 420 | if(deviceIsOTA) { 421 | display.setCursor(2,16); 422 | display.println("Updating.Please wait!"); 423 | display.display(); 424 | return; 425 | } 426 | 427 | display.setTextSize(1); 428 | // Top black BAR with WiFi signal power 429 | display.fillRect(0, 0, 84, 8, BLACK); 430 | display.drawXBitmap(0, 0, wifi_icon_bits, wifi_icon_width, wifi_icon_height, 0x00); 431 | display.setTextColor(WHITE, BLACK); 432 | display.setCursor(12,6); 433 | display.println(String(WiFi.RSSI())+"dB"); 434 | 435 | display.setCursor(48,6); 436 | struct tm timeinfo; 437 | if(!getLocalTime(&timeinfo)){ 438 | DEBUG_PRINTLN("[TIME] Failed to obtain time"); 439 | } else { 440 | display.println(&timeinfo, "%H:%M:%S"); 441 | } 442 | 443 | // Display stream name and song title (scrolling) 444 | display.setTextColor(BLACK, WHITE); 445 | display.setCursor(4,16); 446 | String title = env["stream_station"].as(); 447 | 448 | if(env["stream_title"]) { 449 | title = title + " - "+env["stream_title"].as()+" "; 450 | } 451 | 452 | if(streamIsPlaying) { 453 | if(title.length() > 0) { 454 | display.println(title.substring(t_idx, t_idx+15).c_str()); 455 | t_idx++; 456 | if((t_idx+15) > title.length()) { 457 | t_idx=0; 458 | } 459 | } 460 | display.setCursor(2,24); 461 | display.println(env["stream_genre"].as()); 462 | display.setCursor(4,34); 463 | switch(d_cycle) { 464 | case 0: 465 | display.println(env["stream_bitrate"].as()+" brate"); 466 | break; 467 | case 1: 468 | display.println(env["stream_channels"].as()+" chans"); 469 | break; 470 | case 2: 471 | display.println(env["stream_bitspersample"].as()+" bps"); 472 | break; 473 | default: 474 | d_cycle=0; 475 | } 476 | } else { 477 | display.setCursor(2,24); 478 | if(streamIsPaused) { 479 | display.println("*** PAUSE ***"); 480 | } else { 481 | display.println("Loading..."); 482 | } 483 | } 484 | 485 | // Draw volume bar 486 | display.drawXBitmap(2, 38, audio_icon_bits, audio_icon_width, audio_icon_height, 0xff); 487 | uint8_t volume=map(config.volume, 0, 22, 0, 72); 488 | display.drawRect(10, 40, 72, 6, BLACK); 489 | display.fillRect(10, 40, volume, 6, BLACK); 490 | // 491 | 492 | display.display(); 493 | } 494 | 495 | bool playStream(uint8_t stream_id) { 496 | if(getStreamURL(stream_id)) { 497 | streamIsPlaying = audio.connecttohost(config.stream_url); 498 | return true; 499 | } 500 | DEBUG_PRINTLN("[AUDIO] No STREAM URL defined!"); 501 | env["status"] = "No stream URL defined at index "+stream_id; 502 | return false; 503 | } 504 | 505 | void audio_info(const char *info){ 506 | String sinfo=String(info); 507 | 508 | if(sinfo.startsWith("Bitrate=")) { 509 | env["stream_bitrate"] = sinfo.substring(8).toInt(); 510 | } else if(sinfo.startsWith("StreamTitle=")) { 511 | env["stream_title"] = sinfo.substring(12,44); // Take only the first 32 chars (max) 512 | } else if(sinfo.startsWith("Channels=")) { 513 | env["stream_channels"] = sinfo.substring(8).toInt(); 514 | } else if(sinfo.startsWith("SampleRate=")) { 515 | env["stream_samplerate"] = sinfo.substring(11).toInt(); 516 | } else if(sinfo.startsWith("BitsPerSample=")) { 517 | env["stream_bitspersample"] = sinfo.substring(14).toInt(); 518 | } else if(sinfo.startsWith("icy-genre:")) { // Get the stream genre, if present 519 | env["stream_genre"] = sinfo.substring(10,24); 520 | } else { 521 | DEBUG_PRINT("[AUDIO] "); DEBUG_PRINTLN(info); 522 | } 523 | } 524 | 525 | void audio_showstation(const char *info){ 526 | String sinfo=String(info); 527 | env["stream_station"] = sinfo.substring(0,16); // First 16 chars only (max) 528 | } 529 | 530 | // Stream actions 531 | void nextStream() { 532 | config.stream_id++; 533 | if(config.stream_id >= config.stream_count) { 534 | config.stream_id=0; 535 | } 536 | streamChanged=true; 537 | } 538 | 539 | void togglePlay() { 540 | streamIsPlaying = audio.pauseResume(); 541 | DEBUG_PRINT("[AUDIO] pauseResume(): "); 542 | if(streamIsPlaying) { 543 | DEBUG_PRINTLN("PLAY"); 544 | streamIsPaused = false; 545 | env["status"] = "Playing "+config.stream_id; 546 | } else { 547 | DEBUG_PRINTLN("PAUSE"); 548 | streamIsPaused = true; 549 | env["status"] = "Pause"; 550 | } 551 | } 552 | 553 | // Control buttons 554 | uint8_t buttons=0; 555 | 556 | void checkButtons() { 557 | for (int i = 0; i < BUTTONS_NUM; i++) { 558 | if(digitalRead(BUTTONS_PINS[i])) { 559 | buttons |= 1 << i; 560 | } else { 561 | buttons &= ~(1 << i); 562 | } 563 | } 564 | 565 | if(buttons) { 566 | DEBUG_PRINT("[BUTTON] Pressed "); 567 | DEBUG_PRINTLN(String(buttons)); 568 | switch(buttons) { 569 | case 1: // BUTTONS 1 - Volume UP 570 | if(config.volume < MAX_VOLUME) { 571 | config.volume = config.volume+1; 572 | } 573 | break; 574 | case 2: // BUTTONS 2 - Volume DOWN 575 | if(config.volume > MIN_VOLUME) { 576 | config.volume = config.volume-1; 577 | } 578 | break; 579 | case 3: // BUTTONS 1+2 - Play/Pause 580 | togglePlay(); 581 | break; 582 | case 4: // BUTTONS 3 - Next stream 583 | nextStream(); 584 | break; 585 | case 5: // BUTTONS 3+1 586 | break; 587 | case 6: // BUTTONS 2+3 588 | break; 589 | case 7: // BUTTONS 1+2+3 590 | break; 591 | default: 592 | break; 593 | } 594 | } 595 | } 596 | 597 | uint8_t tickCounter=0; 598 | 599 | void loop() { 600 | if(config.ota_enable) { 601 | ArduinoOTA.handle(); 602 | } 603 | 604 | if((millis() - last) > 1100) { 605 | checkButtons(); 606 | 607 | if(WiFi.status() != WL_CONNECTED) { 608 | // Not connected? RETRY! 609 | connectToWifi(); 610 | } 611 | 612 | audio.setVolume(config.volume); 613 | env["volume"] = config.volume; 614 | 615 | tickCounter++; 616 | if((tickCounter % 10)==0) { 617 | if(!streamIsPlaying) { 618 | playStream(config.stream_id); 619 | } 620 | } 621 | 622 | updateDisplay(); 623 | last = millis(); 624 | } 625 | } 626 | -------------------------------------------------------------------------------- /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 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # ESP32_WebRadio 2 | An Internet web radio based to ESP32 3 | 4 | ESP32 connect to the Internet via WiFI (support WEP/WPA/WPA2), fetching MP3/AAC/M4A audio stream from your favourites webradio (mine is Dance Wave!). Then decode MP3 and send via I2S to DAC. The DAC simply output audio to a PAM8403 3W amplifier. 5 | 6 | My grandpa made for me a fantastic wood case that sits perfectly on my book shelf in the linving room ;-) 7 | 8 | ![ESP32 WebRadio](https://raw.githubusercontent.com/michelep/ESP32_WebRadio/master/images/esp32_webradio_overview.jpg) 9 | 10 | This is the inside, with the mainboard, battery, charge/discharge module, speakers and, on the right, hide by a panel, the 4 buttons control board: 11 | 12 | ![ESP32 WebRadio inside](https://raw.githubusercontent.com/michelep/ESP32_WebRadio/master/images/esp32_webradio_inside.jpg) 13 | 14 | This is a detail of the Nokia 5110 LCD display: 15 | 16 | ![ESP32 WebRadio](https://raw.githubusercontent.com/michelep/ESP32_WebRadio/master/images/esp32_webradio_front.jpg) 17 | 18 | ## Configuration 19 | 20 | Edit data/config.json file with your wifi ESSID and password. Fill data/streams.json with your favourites streams. Then burn the whole data directory into SPIFFS partition. Other stuff can be edited via web interface, available after successfull contection to the net. 21 | 22 | ## Bill of materials 23 | 24 | For a basic board: 25 | 26 | - DOIT ESP32 WebKit v1 (or other suitable ESP32 board...) (On [AliExpress](https://it.aliexpress.com/item/4000141080480.html)) 27 | - CJMCU 5102 DAC [AliExpress](https://it.aliexpress.com/item/33023894667.html) 28 | - PCD8544 LCD Display (aka NOKIA 5110 display) module (On [AliExpress](https://it.aliexpress.com/item/32959195226.html)) 29 | - PAM8403 2*3W Amplifier board (On [AliExpress](https://it.aliexpress.com/item/32968752490.html)) 30 | - One or more NeoPixel, but they are not mandatory ;-) 31 | - Two 8 Ohm speaker 32 | - 3 x 10K Ohm 1/8W resistors 33 | - 2 x 100K Ohm trimmer 34 | - 330 Ohm 1/8W resistor 35 | - 860 Ohm 1/8 W resistor, only if you want to add one or more NeoPixels 36 | - 3 push buttons (On [AliExpress](https://it.aliexpress.com/item/32995191209.html)) 37 | 38 | On mine, i've added an 18650 LiBo battery and a voltage charge/discharge regulator (on [Aliexpress](https://it.aliexpress.com/item/32824032545.html)), with key pin (connected to the fourth button) to power on and off. With this module, i can power (anche charge the battery) 39 | using USB. I've choosed an USB B connector (i have some lying on the table...) and it works perfecly ;-). With a fully charged battery, it can play sound at reasonable volume for about 2 hours. 40 | 41 | ## Schematic 42 | ![Schematic](https://raw.githubusercontent.com/michelep/ESP32_WebRadio/master/images/schematic.png) 43 | 44 | ## ChangeLog 45 | 0.0.7 - 16.0.4.2021 46 | - Just some small fixes and a refresh for library dependencies. Tested with: 47 | - ESP32-audioI2S (https://github.com/schreibfaul1/ESP32-audioI2S) 783f67c 48 | - ESP32-Arduino (https://github.com/espressif/arduino-esp32) 1.0.6 49 | 50 | 0.0.6 - 30.07.2020 51 | - Just small remarks to fix some compiler errors 52 | 53 | 0.0.5 - 03.06.2020 54 | - Better wifi icon 55 | - Display now show more info about radio and songs 56 | - Adding streams URL via Web now work 57 | - Minor bugs fixed 58 | 59 | 0.0.4 - 20.05.2020 60 | - Better OTA handling 61 | - Display now show scrolling title and stream name, current time and wifi power in top bar, volume in bottom (WIP) 62 | - Miscellaneous improvements and bug fixed 63 | 64 | 0.0.3 - 14.05.2020 65 | - Some design changes, like 3 mechanical buttons (but you can use capacitive ones, if you want) 66 | - Streams list also on webpage, with the ability to play each with a click 67 | - Display graphic improvementes 68 | - Lots of new features and bugs fixed 69 | - Other minor changes 70 | 71 | 0.0.2 - 09.05.2020 72 | - Added streams.json with lists of stream URL to be played 73 | - Some minon bugs fixed 74 | 75 | 0.0.1 - 08.05.2020 76 | - First public release 77 | 78 | ## Other resources 79 | 80 | Start with ESP32 pinouts from here: https://randomnerdtutorials.com/esp32-pinout-reference-gpios/ 81 | 82 | Needs the great work from Wolle for MP3 stream decoding and I2S interface: https://github.com/schreibfaul1/ESP32-audioI2S 83 | 84 | A great tutorial for Nokia 5110 LCD displays is there: https://lastminuteengineers.com/nokia-5110-lcd-arduino-tutorial/ 85 | 86 | ## Contributions 87 | 88 | This work is free and far to be perfect nor complete. Contributions and PR are welcome and strongly encouraged! 89 | -------------------------------------------------------------------------------- /config.ino: -------------------------------------------------------------------------------- 1 | // Written by Michele Pinassi 2 | // Released under GPLv3 - No any warranty 3 | 4 | #include 5 | // File System 6 | #include 7 | #include "SPIFFS.h" 8 | 9 | // ************************************ 10 | // Config, save and load functions 11 | // 12 | // save and load configuration from config file in SPIFFS. JSON format (need ArduinoJson library) 13 | // ************************************ 14 | bool loadConfigFile() { 15 | DynamicJsonDocument root(512); 16 | 17 | DEBUG_PRINT("[CONFIG] Loading config..."); 18 | 19 | configFile = SPIFFS.open(CONFIG_FILE, "r"); 20 | if (!configFile) { 21 | DEBUG_PRINTLN("ERROR: Config file not available"); 22 | return false; 23 | } else { 24 | // Get the root object in the document 25 | DeserializationError err = deserializeJson(root, configFile); 26 | if (err) { 27 | DEBUG_PRINTLN("ERROR: "+String(err.c_str())); 28 | return false; 29 | } else { 30 | strlcpy(config.wifi_essid, root["wifi_essid"], sizeof(config.wifi_essid)); 31 | strlcpy(config.wifi_password, root["wifi_password"], sizeof(config.wifi_password)); 32 | strlcpy(config.hostname, root["hostname"] | "aiq-sensor", sizeof(config.hostname)); 33 | strlcpy(config.ntp_server, root["ntp_server"] | "time.ien.it", sizeof(config.ntp_server)); 34 | config.ntp_timezone = root["ntp_timezone"] | 1; 35 | config.ntp_daylightOffset = root["ntp_timezone"] | 1; 36 | config.stream_id = root["stream_id"] | 0; 37 | config.volume = root["volume"] | 20; 38 | config.contrast = root["contrast"] | 50; 39 | config.ota_enable = root["ota_enable"] | true; 40 | 41 | DEBUG_PRINTLN("OK"); 42 | } 43 | } 44 | configFile.close(); 45 | return true; 46 | } 47 | 48 | bool saveConfigFile() { 49 | DynamicJsonDocument root(512); 50 | DEBUG_PRINT("[CONFIG] Saving config..."); 51 | 52 | root["wifi_essid"] = config.wifi_essid; 53 | root["wifi_password"] = config.wifi_password; 54 | root["hostname"] = config.hostname; 55 | root["ntp_server"] = config.ntp_server; 56 | root["ntp_timezone"] = config.ntp_timezone; 57 | root["stream_id"] = config.stream_id; 58 | root["volume"] = config.volume; 59 | root["contrast"] = config.contrast; 60 | root["ota_enable"] = config.ota_enable; 61 | 62 | configFile = SPIFFS.open(CONFIG_FILE, "w"); 63 | if(!configFile) { 64 | DEBUG_PRINTLN("ERROR: Failed to create config file !"); 65 | return false; 66 | } 67 | serializeJson(root,configFile); 68 | configFile.close(); 69 | DEBUG_PRINTLN("OK"); 70 | return true; 71 | } 72 | 73 | // Debug function that return stream URLs list 74 | void printStreamsDB() { 75 | DynamicJsonDocument doc(512); 76 | 77 | DEBUG_PRINT("[DB] printStreamDB()"); 78 | 79 | File dbFile = SPIFFS.open(DB_FILE, "r"); 80 | if (!dbFile) { 81 | DEBUG_PRINTLN("ERROR: file not found"); 82 | return; 83 | } 84 | 85 | // Get the root object in the document 86 | DeserializationError err = deserializeJson(doc, dbFile); 87 | if (err) { 88 | DEBUG_PRINTLN("[ERROR: "+String(err.c_str())); 89 | return; 90 | } 91 | 92 | JsonArray streams = doc["streams"]; 93 | // streams[0] => "http://stream.dancewave.online:8080/dance.mp3" 94 | 95 | DEBUG_PRINTLN("OK. DB memory usage:"+String(streams.memoryUsage())+" bytes"); 96 | 97 | for(uint8_t i=0;i 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | ESP32 WebRadio - %hostname% 10 | 11 | 12 | 13 | 25 | 26 | 27 |
28 |
 
29 |

ESP32 Web Radio

30 |
%hostname%
31 | 32 |
33 |
34 |
35 |

Stream

36 |
37 |
38 |

39 | ... 40 |

41 |

42 | ... 43 |

44 |

45 | ... 46 |

47 |
48 |
49 |
50 |
51 |

Controls

52 |
53 |
54 |
55 | 56 |
57 | 58 |
59 |
60 |
61 | 62 |
63 | 64 |
65 |
66 |
67 |
68 | Next stream 69 | Play/Pause 70 |
71 |
72 |
73 |
74 |
75 |
76 |
77 | 80 |
81 |
82 |
83 |
84 |
85 | 86 |
87 |
88 |
89 | 90 |
91 | 92 |
93 |
94 | or Backup streams JSON 95 | 96 |
97 |
98 |
99 |
100 |
101 |
102 |
103 |
104 |
105 | 108 |
109 |
110 |
111 |
112 |
113 | 114 |
115 |
116 | 117 | 118 |

Set your Wifi network name

119 |
120 |
121 | 122 | 123 |

Your wifi password

124 |
125 |
126 |

WiFi signal strenght (RSSI):

127 |

%wifi_rssi% dBm

128 |

0-30dBm=Very Good, 31-50dBm=Good, 51-67dBm=Fair, 67-80dBm=Poor, >80dBm=Unstable

129 |
130 |
131 |
132 |
133 | 134 | 135 |

Set hostname

136 |
137 |
138 | 139 | 140 |

Check to allow OTA firmware updates

141 | 142 |
143 |
144 |
145 |
146 | 147 | 148 |

NTP server

149 |
150 |
151 | 152 | 153 |

NTP time zone

154 |
155 |
156 |
157 |
158 | 159 | 160 |

ID of the stream playing

161 |
162 |
163 | 164 | 165 |

Streaming URL (MP3/AAC) override (warning: this URL will not be saved!)

166 |
167 |
168 | or Backup config 169 |
170 |
 
171 |
172 | 173 | 174 |
175 |
176 |
177 |
178 |
179 |
180 |
181 |

Firmware %fw_name% %fw_version% - Uptime %uptime% secs - %timedate%

182 |
183 |
184 |
185 |
186 |
187 |
188 |

by Michele <o-zone@zerozone.it> Pinassi - zerozone.it

189 |
190 |
191 |
192 |
193 | 247 | 248 | -------------------------------------------------------------------------------- /data/loader.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/michelep/ESP32_WebRadio/25585b7b7381ca308ceb14fe4add14c51fe93522/data/loader.gif -------------------------------------------------------------------------------- /data/streams.json: -------------------------------------------------------------------------------- 1 | {"streams":["http://stream.dancewave.online:8080/dance.mp3","http://mxsel.maksmedia.ru:8000/maksfm128","https://icecast.unitedradio.it/Radio105.mp3","http://onair18.xdevel.com:8042/","http://stream.live.vc.bbcmedia.co.uk/bbc_radio_fourfm"]} -------------------------------------------------------------------------------- /images/banner.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/michelep/ESP32_WebRadio/25585b7b7381ca308ceb14fe4add14c51fe93522/images/banner.png -------------------------------------------------------------------------------- /images/esp32_webradio.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/michelep/ESP32_WebRadio/25585b7b7381ca308ceb14fe4add14c51fe93522/images/esp32_webradio.jpg -------------------------------------------------------------------------------- /images/esp32_webradio_front.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/michelep/ESP32_WebRadio/25585b7b7381ca308ceb14fe4add14c51fe93522/images/esp32_webradio_front.jpg -------------------------------------------------------------------------------- /images/esp32_webradio_inside.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/michelep/ESP32_WebRadio/25585b7b7381ca308ceb14fe4add14c51fe93522/images/esp32_webradio_inside.jpg -------------------------------------------------------------------------------- /images/esp32_webradio_lateral.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/michelep/ESP32_WebRadio/25585b7b7381ca308ceb14fe4add14c51fe93522/images/esp32_webradio_lateral.jpg -------------------------------------------------------------------------------- /images/esp32_webradio_overview.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/michelep/ESP32_WebRadio/25585b7b7381ca308ceb14fe4add14c51fe93522/images/esp32_webradio_overview.jpg -------------------------------------------------------------------------------- /images/schematic.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/michelep/ESP32_WebRadio/25585b7b7381ca308ceb14fe4add14c51fe93522/images/schematic.png -------------------------------------------------------------------------------- /webserver.ino: -------------------------------------------------------------------------------- 1 | // Written by Michele Pinassi 2 | // Released under GPLv3 - No any warranty 3 | 4 | String templateProcessor(const String& var) 5 | { 6 | // 7 | // System values 8 | // 9 | if(var == "hostname") { 10 | return String(config.hostname); 11 | } 12 | if(var == "fw_name") { 13 | return String(FW_NAME); 14 | } 15 | if(var=="fw_version") { 16 | return String(FW_VERSION); 17 | } 18 | if(var=="uptime") { 19 | return String(millis()/1000); 20 | } 21 | if(var=="timedate") { 22 | struct tm timeinfo; 23 | if(!getLocalTime(&timeinfo)){ 24 | DEBUG_PRINTLN("Failed to obtain time"); 25 | return String("Error"); 26 | } 27 | return String(String(timeinfo.tm_hour)+":"+String(timeinfo.tm_min)+":"+String(timeinfo.tm_sec)); 28 | } 29 | if(var == "ota_enable") { 30 | if(config.ota_enable) { 31 | return String("checked"); 32 | } else { 33 | return ""; 34 | } 35 | } 36 | 37 | // 38 | // Config values 39 | // 40 | if(var=="wifi_essid") { 41 | return String(config.wifi_essid); 42 | } 43 | if(var=="wifi_password") { 44 | return String(config.wifi_password); 45 | } 46 | if(var=="wifi_rssi") { 47 | return String(WiFi.RSSI()); 48 | } 49 | if(var=="ntp_server") { 50 | return String(config.ntp_server); 51 | } 52 | if(var=="ntp_timezone") { 53 | return String(config.ntp_timezone); 54 | } 55 | // 56 | if(var=="stream_url") { 57 | return String(config.stream_url); 58 | } 59 | if(var=="stream_id") { 60 | return String(config.stream_id); 61 | } 62 | if(var=="volume") { 63 | return String(config.volume); 64 | } 65 | if(var=="contrast") { 66 | return String(config.contrast); 67 | } 68 | // 69 | return String(); 70 | } 71 | // ************************************ 72 | // initWebServer 73 | // 74 | // initialize web server 75 | // ************************************ 76 | void initWebServer() { 77 | server.serveStatic("/", SPIFFS, "/").setDefaultFile("index.html").setTemplateProcessor(templateProcessor); 78 | 79 | server.on("/restart", HTTP_POST, [](AsyncWebServerRequest *request) { 80 | ESP.restart(); 81 | }); 82 | 83 | server.on("/post", HTTP_POST, [](AsyncWebServerRequest *request) { 84 | String action; 85 | if(request->hasParam("action", true)) { 86 | action = request->getParam("action", true)->value(); 87 | if(action.equals("config")) { 88 | if(request->hasParam("wifi_essid", true)) { 89 | strcpy(config.wifi_essid,request->getParam("wifi_essid", true)->value().c_str()); 90 | } 91 | if(request->hasParam("wifi_password", true)) { 92 | strcpy(config.wifi_password,request->getParam("wifi_password", true)->value().c_str()); 93 | } 94 | if(request->hasParam("ntp_server", true)) { 95 | strcpy(config.ntp_server, request->getParam("ntp_server", true)->value().c_str()); 96 | } 97 | if(request->hasParam("ntp_timezone", true)) { 98 | config.ntp_timezone = atoi(request->getParam("ntp_timezone", true)->value().c_str()); 99 | } 100 | if(request->hasParam("stream_url", true)) { 101 | strcpy(config.stream_url, request->getParam("stream_url", true)->value().c_str()); 102 | streamChanged=true; 103 | } 104 | saveConfigFile(); 105 | } else if(action.equals("streams")) { 106 | DynamicJsonDocument doc(512); 107 | JsonArray streams = doc["streams"].to(); 108 | // POST variable stream[] contains all streams 109 | // {"action":"streams","stream[]":["http://stream.dancewave.online:8080/dance.mp3","http://mxsel.maksmedia.ru:8000/maksfm128","https://icecast.unitedradio.it/Radio105.mp3",""]} 110 | int paramsNr = request->params(); 111 | // Iterate over all POST params... 112 | for(int i=0;igetParam(i); 114 | if(p->name().equals("stream[]")) { 115 | if(p->value().length() > 0) { 116 | streams.add(p->value()); 117 | } 118 | } 119 | } 120 | // Save JSON to streams.json 121 | File dbFile = SPIFFS.open(DB_FILE, "w"); 122 | if(!dbFile) { 123 | DEBUG_PRINTLN("ERROR: Failed to create db file !"); 124 | return false; 125 | } 126 | serializeJson(doc,dbFile); 127 | dbFile.close(); 128 | } 129 | } 130 | request->redirect("/?result=ok"); 131 | }); 132 | 133 | server.on("/ajax", HTTP_POST, [] (AsyncWebServerRequest *request) { 134 | String action,value,response=""; 135 | char outputJson[256]; 136 | 137 | if(request->hasParam("action", true)) { 138 | action = request->getParam("action", true)->value(); 139 | if(action.equals("get")) { 140 | value = request->getParam("value", true)->value(); 141 | if(value.equals("env")) { 142 | serializeJson(env,outputJson); 143 | response = String(outputJson); 144 | } 145 | } else if(action.equals("set_volume")) { 146 | config.volume = atoi(request->getParam("value", true)->value().c_str()); 147 | response = String("{\"status\":200, \"volume\": "+String(config.volume)+"}"); 148 | } else if(action.equals("set_contrast")) { 149 | config.contrast = atoi(request->getParam("value", true)->value().c_str()); 150 | response = String("{\"status\":200}"); 151 | } else if(action.equals("toggle_play")) { 152 | togglePlay(); 153 | response = String("{\"status\":200, \"status\": "+String(streamIsPlaying)+"}"); 154 | } else if(action.equals("play_stream")) { 155 | config.stream_id=atoi(request->getParam("value", true)->value().c_str()) | 0; 156 | streamChanged=true; 157 | response = String("{\"status\":200, \"stream_id\": "+String(config.stream_id)+"}"); 158 | } else if(action.equals("next_stream")) { 159 | nextStream(); 160 | response = String("{\"status\":200, \"stream_id\": "+String(config.stream_id)+"}"); 161 | } 162 | } 163 | request->send(200, "text/plain", response); 164 | }); 165 | 166 | server.onNotFound([](AsyncWebServerRequest *request) { 167 | Serial.printf("[404] Not Found: http://%s%s

", request->host().c_str(), request->url().c_str()); 168 | 169 | request->send(404); 170 | }); 171 | 172 | server.begin(); 173 | } 174 | --------------------------------------------------------------------------------