Skip to content

Commit a0545ef

Browse files
Revise README with library updates and setup guide (#98)
Updated library version and added setup instructions for Arduino IDE.
1 parent 59078ec commit a0545ef

1 file changed

Lines changed: 11 additions & 3 deletions

File tree

README.md

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

2121
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.
2222
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.
23-
2423
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.
2524

26-
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.
25+
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.
2726

2827
### platformio.ini example
2928

@@ -32,9 +31,18 @@ platform = https://github.com/pioarduino/platform-espressif32/releases/download/
3231

3332
lib_deps =
3433
https://github.com/CelliesProjects/ESP_VS1053_Library#make-SCI-registers-readable
35-
https://github.com/CelliesProjects/ESP32_VS1053_Stream@3.0.2
34+
https://github.com/CelliesProjects/ESP32_VS1053_Stream@3.0.4
3635
```
3736

37+
### Arduino IDE setup for 3.0.0 or later releases
38+
39+
- Browse to [the forked 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`.
40+
- In the Arduino IDE go to `Sketch->Include Library->Add .ZIP library` and select the downloaded zip file to install.
41+
- Answer `YES` when asked to overwrite the existing library.
42+
43+
That's it.
44+
With the forked vs1053 library installed 3.0.x releases can be compiled in the Arduino IDE.
45+
3846
## Example: play a stream
3947
```c++
4048
#include <Arduino.h>

0 commit comments

Comments
 (0)