History

Austin Ramsdale 169a0b0b68 Update client.ino Utilizing Preferences, detect successful WiFi connection, store to ssid preferences, and recall on reboot. Same for server URL - storing under preference 'network'		2024-04-01 13:33:46 -04:00
..
src/client	Update client.ino	2024-04-01 13:33:46 -04:00
README.md	added missing documentation in the client directory	2024-03-29 00:11:57 +01:00
__init__.py	Rename directories to software and source	2024-03-21 14:20:50 -07:00
websocket_test.py	Rename directories to software and source	2024-03-21 14:20:50 -07:00

README.md

ESP32 Playback

To set up audio recording + playback on the ESP32 (M5 Atom), do the following:

Open Arduino IDE, and open the client/client.ino file
Go to Tools -> Board -> Boards Manager, search "esp32", then install the boards by Arduino and Espressif
Go to Tools -> Manage Libraries, then install the following (with dependencies, if it prompts you to install with/without dependencies):
- M5Atom by M5Stack
- WebSockets by Markus Sattler
- ESPAsyncWebServer by lacamera
The board needs to connect to WiFi. Once you flash, connect to ESP32 wifi "captive" which will get wifi details. Once it connects, it will ask you to enter 01OS server address in the format "domain.com:port" or "ip:port". Once its able to connect you can use the device.
To flash the .ino to the board, connect the board to the USB port, select the port from the dropdown on the IDE, then select the M5Atom board (or M5Stack-ATOM if you have that). Click on upload to flash the board.

Alternative - PlatformIO

You don't need anything, PlatformIO will install everything for you, dependencies, tool chains, etc.

Please install first PlatformIO open source ecosystem for IoT development compatible with Arduino IDE and its command line tools (Windows, MacOs and Linux), and then enter to the firmware directory:

cd client/

And build and upload the firmware with a simple command:

pio run --target upload