Skip to content

Commit ecaaa12

Browse files
Update README.md (#92)
1 parent 107d503 commit ecaaa12

1 file changed

Lines changed: 17 additions & 10 deletions

File tree

README.md

Lines changed: 17 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -3,26 +3,31 @@
33
[![Codacy Badge](https://api.codacy.com/project/badge/Grade/7571166c872e4dc8a899382389b73f8e)](https://app.codacy.com/gh/CelliesProjects/ESP32_VS1053_Stream?utm_source=github.com&utm_medium=referral&utm_content=CelliesProjects/ESP32_VS1053_Stream&utm_campaign=Badge_Grade_Settings)
44

55
A streaming library for esp32, esp32-wrover, esp32-c3, esp32-s2 and esp32-s3 with a separate VS1053 codec chip.
6-
This library plays mp3, ogg, aac-adts, aac-adif, aac-mp4 and <strike>flac</strike> files and streams and uses [ESP_VS1053_Library](https://github.com/baldram/ESP_VS1053_Library) to communicate with the decoder.
6+
This library plays mp3, ogg, aac and flac files and streams.
77

8-
Supported stream methods are http and insecure https. Streams can be chunked.
9-
Also plays mp3 and ogg files from sdcard or any mounted filesystem.
8+
- Supported codecs are **mp3**, **ogg**, **aac-adts**, **aac-adif**, **aac-mp4** and **16 bit flac**.
9+
- Supported stream methods are http and insecure https.
10+
- Streams can be chunked.
11+
- Also plays **mp3**, **ogg** and **flac** files from sdcard or any mounted filesystem.
1012

1113
Very lightweight, has a binary footprint of less than 7kB excluding the psram buffer.
1214

15+
[ESP_VS1053_Library](https://github.com/baldram/ESP_VS1053_Library) is used to communicate with the decoder.
16+
1317
## How to install and use
1418

1519
~~Install [ESP_VS1053_Library](https://github.com/baldram/ESP_VS1053_Library) and this library in your Arduino library folder.~~
1620

17-
Release 3.0.0 or later releases require read access to the vs1053 registers which the [ESP_VS1053_Library](https://github.com/baldram/ESP_VS1053_Library) does not provide. (yet)
21+
Release 3.0.0 and later require read access to the vs1053 registers which the [ESP_VS1053_Library](https://github.com/baldram/ESP_VS1053_Library) does not provide.
22+
There is a [PR](https://github.com/baldram/ESP_VS1053_Library/pull/119) fixing this issue waiting to be merged in the ESP_VS1053_Library repo.
1823

19-
While a [PR](https://github.com/baldram/ESP_VS1053_Library/pull/119) fixing this issue is waiting to be merged in the ESP_VS1053_Library repo, using this [fork](baldram/ESP_VS1053_Library) it is possible to compile the 3.0.0 release or later releases.
24+
While that is waiting you can use [this fork](https://github.com/CelliesProjects/ESP_VS1053_Library/tree/make-SCI-registers-readable) to compile the 3.0.0 and later releases.
2025

2126
Use the [latest Arduino ESP32 core version](https://github.com/espressif/arduino-esp32/releases/latest) for Arduino IDE or the corresponding [PIOArduino release](https://github.com/pioarduino/platform-espressif32/releases/latest) if you use PlatformIO in VSCode.
2227

2328
### platformio.ini example
2429

25-
```
30+
```bash
2631
platform = https://github.com/pioarduino/platform-espressif32/releases/download/55.03.37/platform-espressif32.zip
2732

2833
lib_deps =
@@ -237,23 +242,25 @@ void loop() {
237242
```
238243

239244
## Known issues
240-
Ogg files can not be started with an offset without first playing a couple of seconds from the start of the file.
245+
`Ogg` and `flac` files can not be resumed from an offset without first playing a couple of seconds from the start of the file.
241246

242247
## Tips for troublefree streaming
243248

244249
### WiFi setup
245250

246-
Do not forget to switch WiFi out of power save mode:
251+
Switch off the BlueTooth radio if unused.
252+
Do not forget to switch WiFi out of power save mode.
247253

248254
```c++
249255
...
256+
btStop();
250257
WiFi.begin(SSID, PSK);
251258
WiFi.setSleep(false);
252259
...
253260
```
254261

255-
### Prevent reboots while playing
256-
Early version of the esp32 have issues with the external psram cache, resulting in reboots.
262+
### Prevent reboots when used on early esp32
263+
Early versions of the esp32 have issues with the external psram cache, resulting in reboots.
257264
Workarounds are possible depending on the hardware revision.
258265

259266
#### Revision V0.0

0 commit comments

Comments
 (0)