(Снежное радио - Sneeuwradio)
Snow Radio was greatly improved and extended due to the generous support, useful suggestions and rigorous testing of Alexander Semenov (https://github.com/Semenov-Alexander)
Playlists ( .pls, .m3u, .dash etc.) are not supported. No plans exist to support these, but this may change one day.
User friendly install of VS1053 plugins and patches, just upload the .plg files to your SPIFFS/LittleFS/FFat flash disk.
- plg files for patches can be downloaded from the VLSI website. http://www.vlsi.fi/en/support/software/vs10xxpatches.html
- plg files for plugins ( like the spectrum analyzer plugin) can be downloaded here: http://www.vlsi.fi/en/support/software/vs10xxplugins.html
- The VS10xx series website is very interesting for more ideas: http://www.vlsi.fi/en/support/software.html
An effort has been made to maximize use of PSRAM, if available.
Snow Radio uses the following libraries:
- ArduinoJSON ( https://github.com/bblanchon/ArduinoJson.git )
- Gesture_PAJ7620 ( https://github.com/Seeed-Studio/Gesture_PAJ7620 )
- ESP_VS1053 ( https://github.com/baldram/ESP_VS1053_Library )
- TFT_eSPI ( https://github.com/Bodmer/TFT_eSPI )
- AsyncTCP (https://github.com/me-no-dev/AsyncTCP)
- ESPAsyncWebServer (https://github.com/me-no-dev/ESPAsyncWebServer.git )
- If you want to use LittleFS (recommended), LittleFS_ESP32 ( https://github.com/lorol/LITTLEFS )
Grateful use has been made of the spectrum analyzer code of blotfi at https://github.com/blotfi/ESP32-Radio-with-Spectrum-analyzer
Honourable mentions should be made for the support and inspiration taken from:
- https://github.com/Semenov-Alexander
- https://github.com/Edzelf/ESP32-Radio
- https://github.com/RalphBacon/205-Internet-Radio Thanks to all the authors.
You can use the suggested versions "as is" or use this as the basis for creating your project. Snow Radio uses unique software solutions and solves many of the problems necessary to create this project. We will be grateful for honouring the Apache license and mention this project as the origin for your own efforts. The project we created allows you to create your own unique interface for Snow Radio. The possibilities are limited only by your imagination. Use all the features of Snow Radio, or just some that you need. Creating a music center with gesture control and touch screen is now easy! Use the LINE-IN and Bluetooth buttons to control the output levels of the control pins. To manage external devices, you can use the MCP23017 port expander, for example.
Pictures of various incarnations of Snow Radio, including the ST7796_RU branch, can be found in the Images subdirectory of this repositoryAn ESP32 with plenty of PSRAM is recommended. For the touchscreen an ILI9341 320x240 SPI (NOT parallel, you will run out of pins) screen is used.
In branch ST7796_RU ( https://github.com/gitpeut/SnowRadio/tree/ST7796-RU )a highly modified version is available that makes use of a 480x320 ST7796 display, and has some other unique features like traffic information. All VS1053 breakouts should work ok, consult the 0pins.h file for a possible way of connecting this hardware.
In the current version, a separate SPI bus is used for the VS1053 (VSPI) and the screen (HSPI). This works but so far, there is no evidence this improves speed or reliability, so feel free to operate both devices on the same SPI bus.
Should compile with the Arduino IDE, but make sure a file wificredentials.h is available in folder wificredentials of your Arduino library folder. (credits: Andreas Spiess https://www.youtube.com/channel/UCu7_D0o48KbfhpEohoP7YSQ ) This file should contain the following variables for SnowRadio.
#ifndef WIFICREDENTIALS_H
#define WIFICREDENTIALS_H
// optional, necessary if LOADSSIDS is defined and used
const char* wifiSsid[] = {"yourssid", "yourotherssid","yourmotherssid", ""};
const char* wifiPassword[] = ("yourWiFipassword", "yourotherssidpassword","yourmotherssidpassword", ""} ;
// ntp
const char* ntpServers[] = { "nl.pool.ntp.org", "ru.pool.ntp.org", "de.pool.ntp.org"};
//Use a valid TZ string, docs e.g. https://www.di-mgt.com.au/src/wclocktz.ini
//
const char* ntpTimezone = "CET-1CEST,M3.5.0/2,M10.5.0/3";
// const char* ntpTimezone = "MSK-3"; // For Moscow, no daylight saving time Moscow
// Key and IV for G Radio used to encrypt wifi credentials for networks connected to by ESP touch
const char* gr_iv = "DummyValyeWIthallkindsofNUmbers&****ssss";
const char* gr_key = "OtherDummyValyeWIthallkindsof*&DGD";
#ifdef USEOWM
//openweathermap ( see https://openweathermap.org/current for docs )
const char *owm_id = "2756252";// 2756252 = eindhoven, nl. 532615 = moscow, ru
const char *owm_key = "123456789012345678901234567890"; // get your key at openweathermap.org
const char *owm_unit = "metric";
const char *owm_lang = "nl"; // en, ru....
#endif
#endif
In SnowRadio.ino a number of defines enable you to turn on or off some features. Generally they are called USE. Be aware that not all possible combinations have been tested (although many have) , and that a random combination of features may show random and undefined behaviour.
Use "#define USE..." for to enable an option, "#undef USE..." to disable an option Currently, the following options are defined:
/*define or undef */
#define USEOWM // to enable Open weathermap owm_key,
// owm_id (city id), owm_lang (language),
//owm_unit (metric, imperial) in wificredentials.h
// should be defined as const char *, e.g.
// const char* owm_unit = "metric";
#undef USEOTA // disable Arduino OTA. http update is always on and works
// as well.
#define USETLS 1 // allow for https
#undef USEPIXELS // use pixels as an indicator for the gestures
#define USEGESTURES // Use the PAJ7620 gesture sensor
#undef MULTILEVELGESTURES // gestures as used in Oranje radio. Not very well tested or maintained
#define USETOUCH // use a touchscreen. Tested and developed with an ILI9341
#define USEINPUTSELECT // input selection between AV(LINE IN), BLUETOOTH and RADIO
// if undefined, volume buttons are displayed on the touchscreen, otherwise
// buttons to select BLUETOOTH and AV (LINE IN)
#define USESPECTRUM // install and run the spectrum patch as supplied by VLSI
// and gracefully adapted from the Web Radio of Blotfi
#define SHOWMETA // show meta data ( artist/track info in variable meta.metadata ) in the default
// define one of below 3 if metadata is desired
#undef METASPRITE // use a sprite to display metadata and scroll the sprite if text is too long
#define METAPOPUP // diplay long txt per 2 lines every ~10 seconds
#undef METASTATIC // display as much as possible, but overflow if too long // place under the station name.
#define USESPTOUCH 1 //use the ESP TOUCH phone app to connect when no known WiFi network is seen.
//for some this is very user friendly, for others it is a source of frustration.
#undef LOADSSIDS // If you want to preload the encrypted netpass file with ssid and passwords
// define LOADSSIDS. If not using ESPTOUCH, this will be a necessary step.
// For this to work, in wificredentials.h,
// WiFiNetworks are defined as follows, make sure the arrays have a "" as last element
// const char* wifiSsid[] = {"yourssid", "yourotherssid","yourmotherssid", ""};
// const char* wifiPassword[] = ("yourWiFipassword", "yourotherssidpassword","yourmotherssidpassword", ""} ;
// ATTENTION: After an encrypted /netpass file is generated, it is better to recompile without this option, the loading
// is not necessary anymore but more importantly, the credentials will remain readable in the compiled code.
//
Compiling and uploading can be done in the Arduino IDE. Creating and populating the flash filesystem is required, and should be done using the ESP32 Sketch data upload utility. Currently, this is the most feature-rich version: https://github.com/lorol/arduino-esp32fs-plugin, it allows for SPIFFS, LittleFS and FFat filesystems.
- Touch calibration
When attaching a touch display,touch calibration data for an other display will not work properly or not at all. Open a browser and connect to URL snowradio.local, or to the ip address of Snow radio and click on button "Delete touch calibration", then on the button "Reboot". When the Snow radio restarts, it ask you to touch the 4 corners of the display. If done correctly, the display should work. - Adding, changing or deleting stations
Stations can be added on the Web page by pressing button "Add station". A valid url and a station name is required. Changing or deleting a station can be done by pressing the button to the right of the station name in the stationlist. There is a hardcoded limit of 100 stations. with a generous amount of PSRAM this limit can probably be increased. Stations are saved in a file called stations.json, which can also be edited on your computer. A very comprehensive and meticulously maintained website with more internet radio stations is : https://www.hendrikjansen.nl/henk/streaming.html - Gesture sensor
Gestures work as follows:- circle clockwise or anti-clockwise: wake up sensor ( a little hand shows up on the screen) or put to sleep if active (the little hand disappears)
- up: increase volume
- down: decrease volume
- right: go to next station
- left: go to previous station
- Update firmware
By default firmware can be updated using http. Press the button "Update firmware" on the Web page to upload a new bin file, created in the Arduino IDE by selecting "Export compiled binary" in the Sketch menu. - Backup and restore
Use the "Directory" button to see which files you may want to backup.
Restoring files can be done by a complete flash of the file system, or by using the "Upload file" button. Make sure you enter the full path of the file, including the preceding / For the netpassfile and the statonlist there are buttons on the webpage to easily backup these files. All other files can be downloaded and saved by typing http://snowradio.local/<filename>?download=1 in your browser. For example, to download the touch calibration data, access this url in your browser:http://snowradio.local/TouchCal.dat?download=1 - Delete files
Files can be can be deleted by typing in this URL: http://snowradio/delete?file=, e.g. http://snowradio/delete?file=/netpass - Languages
Default language for monthnames and days is Dutch. Provisions have been made to also display these in Russian and English. For Russian fonts with Cyrillic characters are available. English can be set by uncommenting #define MONTHNAMES_EN in SnowRadio.ino, Russian by uncommenting MONTHNAMES_RU. - Only one SSL connection
The Snow radio can receive https Internet radio stations. However, when experimenting, bear in mind that Arduino does not allow for SSL to use PSRAM. For Snow radio this means that more than 1 SSL ( https) connection is not possible. This also makes it unlikely newer protocols like dash or HLS can be supported. - When connection to an internet radio station fails, the radio connects to the next station in the list. This could surprise you, but is intentional.
- Restart at failing connection
When reception of the internet radio is bad, the radio cannot supply the VS1053 with enough data to supply sound. As a last resort the radio will then restart. This usually solves the issue, but could in some extraordinary cases lead to a reboot loop. Via the web page or the screen you can try to switch to another station before the reboot occurs again. If this doesn't work a reflash of the filesystem can be the only way out, but this will also mean that more data is lost, like your last station, last volume and tone settiongs, your display calibration data and your netpass file. - syslog
A logfile (/syslog.txt) mainly containing boot reasons is maintained and can be viewed on the Web page by pressing the"Show Log" button. When this log grows beyond 20k it is deleted. - File system
For development LittleFS has been used, but the Radio can work with FFAT and SPIFFS as well. We recommend LittleFS for it's robustness and better locking of files. Nevertheless, in SnowRadio.ino there are options to set the filesystem used. Just uncomment the one you prefer://choose file system // //fs::FS RadioFS = SPIFFS; //const int RadioFSNO = FSNO_SPIFFS; //const char *RadioMount = "/spiffs"; fs::FS RadioFS = LITTLEFS; const int RadioFSNO = FSNO_LITTLEFS; const char *RadioMount = "/littlefs"; //fs::FS RadioFS = FFat; //const int RadioFSNO = FSNO_FFAT; //const char *RadioMount = "/ffat"; - Timezones
It is surprisingly difficult to find a good source for TZ strings online. Best method is to log in to an up-to-date Linux system and view for instance /usr/share/zoneinfo/Europe/Moscow, ignore the binary information, the TZ string will be in there. - Pins
In file 0pins.h an example configuration of the pins can be found. Pins for the display and the touch sensor should be defined in the tft_eSPI setup file for your display.