# NetSpeaker

NetSpeaker is a project that aims to make it easier to build your own sound system, just like sqeezebox, for example.

## Example of building an little MP3-Player

### Hardware

**Necessary** hardware:

- ESP32 breakout board (e.g. ESP32-WROOM-DEVKIT)
- microSD card reader (connectable via SPI; has to be supported by the [Arduino SD library](https://github.com/arduino-libraries/SD))
- external Digital-Analog converter (the ESP has one inside), for better sound quality (has to be supported by the [ESP32 audio library](https://github.com/schreibfaul1/ESP32-audioI2S); e.g. PCM5102 breakout board)

**Optional** hardware (for example if you want to have physical buttons for pause/play, volume, etc.):

- Potentiometer (currently only linear potentiometers are supported)
- Buttons for pause/play, next track, previous track, stop, eject sd card, etc.


### Connecting together

_**WARNING:** The SPI pins are board specific! The SPI pins given here correspondent to the SPI pins of the ESP32 WROOM DEVKIT_

| Component | Pin (name) on component | Pin on ESP32 Wroom DEVKIT |
| --------- | --- |
| SD card reader |  |

_**TODO:** Finish this section_ 



# Credits

Thanks to...

- the makers of Arduino IDE
- schreibfaul1 (github) for creating the audio library used in this project
- the makers of Bootstrap Icons for creating wonderful icons
- espressif for making the best microprocessor I've ever seen
- ArduinoJson by Benoit Blanchon

# License

This is free and unencumbered software released into the public domain.

Anyone is free to copy, modify, publish, use, compile, sell, or distribute this software, either in source code form or as a compiled binary, for any purpose, commercial or non-commercial, and by any means.

In jurisdictions that recognize copyright laws, the author or authors of this software dedicate any and all copyright interest in the software to the public domain. We make this dedication for the benefit of the public at large and to the detriment of our heirs and
successors. We intend this dedication to be an overt act of relinquishment in perpetuity of all present and future rights to this software under copyright law.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

For more information, please refer to <http://unlicense.org/>


# External Licenses and other links:

Icons used for webpage (currently in progress!)

```
The MIT License (MIT)

Copyright (c) 2019-2021 The Bootstrap Authors

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
```

---
ESP32-audioI2S library  © schreibfaul1 (https://github.com/schreibfaul1/ESP32-audioI2S as of November 2022)


