Skip to content

Commit 3d42e74

Browse files
Update README (#123)
1 parent ac0b1bf commit 3d42e74

1 file changed

Lines changed: 9 additions & 9 deletions

File tree

README.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -16,11 +16,6 @@ Very lightweight, has a binary footprint of less than 7kB excluding the psram bu
1616

1717
## How to install and use
1818

19-
~~Install [ESP_VS1053_Library](https://github.com/baldram/ESP_VS1053_Library) and this library in your Arduino library folder.~~
20-
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-
While that is getting fixed 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.
23-
2419
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.
2520

2621
### platformio.ini example
@@ -29,18 +24,23 @@ Use the [latest Arduino ESP32 core version](https://github.com/espressif/arduino
2924
platform = https://github.com/pioarduino/platform-espressif32/releases/download/55.03.37/platform-espressif32.zip
3025

3126
lib_deps =
32-
https://github.com/CelliesProjects/ESP_VS1053_Library#make-SCI-registers-readable
27+
https://github.com/baldram/ESP_VS1053_Library#master
3328
https://github.com/CelliesProjects/ESP32_VS1053_Stream@3.0.6
3429
```
3530

3631
### Arduino IDE setup
3732

38-
- Browse to [the patched vs1053 repository](https://github.com/CelliesProjects/ESP_VS1053_Library/tree/make-SCI-registers-readable) and download the zip file found under the green button marked `<> Code`.
33+
The `ESP_VS1053_Library` library is not available in the Arduino IDE library manager.
34+
You will have to install manually.
35+
36+
Follow these steps to install the vs1053 library in the Arduino IDE:
37+
38+
- Browse to the [vs1053 repository](https://github.com/baldram/ESP_VS1053_Library) and download the zip file found under the green button marked `<> Code`.
3939
- In the Arduino IDE go to `Sketch->Include Library->Add .ZIP library` and select the downloaded zip file to install.
4040
- Answer `YES` when asked to overwrite the existing library.
4141

4242
That's it.
43-
With the patched vs1053 library installed 3.x.x releases can be compiled in the Arduino IDE.
43+
With the vs1053 library installed this library can be compiled in the Arduino IDE.
4444

4545
## Example: play a stream
4646
```c++
@@ -342,7 +342,7 @@ void stopSong();
342342
void loop();
343343
```
344344
This function has to called every couple of ms to feed the decoder with data.
345-
For bitrates up to 320kbps somewhere between 5-10 ms is about right.
345+
For bitrates up to 320kbps somewhere between 2-5 ms is about right.
346346
### Check if stream is running
347347
```c++
348348
bool isRunning();

0 commit comments

Comments
 (0)