From 1cd75dcedce8dfd28e6987a631eca27cd09c28d7 Mon Sep 17 00:00:00 2001 From: killian <63927363+KillianLucas@users.noreply.github.com> Date: Thu, 21 Mar 2024 07:55:37 -0700 Subject: [PATCH] Create README.md --- hardware/light/README.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) create mode 100644 hardware/light/README.md diff --git a/hardware/light/README.md b/hardware/light/README.md new file mode 100644 index 00000000..a7b1bddc --- /dev/null +++ b/hardware/light/README.md @@ -0,0 +1,13 @@ +## ESP32 Setup + +To set up audio recording + playback on the ESP32 (M5 Atom), do the following: + +1. Open Arduino IDE, and open the client/client.ino file +2. Go to Tools -> Board -> Boards Manager, search "esp32", then install the boards by Arduino and Espressif +3. Go to Tools -> Manage Libraries, then install the following: + +- M5Atom by M5Stack [Reference](https://www.arduino.cc/reference/en/libraries/m5atom/) +- WebSockets by Markus Sattler [Reference](https://www.arduino.cc/reference/en/libraries/websockets/) + +4. 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. +5. 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.