From d7f65209898d97aaff6a2dd8e8cb13c46ba124d2 Mon Sep 17 00:00:00 2001 From: Mike Bird Date: Thu, 11 Jul 2024 11:22:27 -0400 Subject: [PATCH] Incorporate updated firmware instructions into '01-light.mdx' --- docs/hardware/01-light.mdx | 20 +++++++++++++++++++- docs/hardware/m5atom.mdx | 20 -------------------- docs/mint.json | 2 +- 3 files changed, 20 insertions(+), 22 deletions(-) diff --git a/docs/hardware/01-light.mdx b/docs/hardware/01-light.mdx index 59d6364..8c0acf8 100644 --- a/docs/hardware/01-light.mdx +++ b/docs/hardware/01-light.mdx @@ -23,7 +23,25 @@ Check out [this video from James at CAD9 Design](https://www.youtube.com/watch?v ### M5 Atom Prep -Instructions to set up your M5 Atom can be found here +The recommended hardware for the developer kit is based around the M5 Atom. It contains an ESP32 board, as well as a microphone and speaker. + +The ESP32 needs to be setup to work with the 01OS server. We've created the firmware needed, just follow this guide. + +## ESP32 + +To set up audio recording + playback on the ESP32 (M5 Atom), do the following: + +1. Download the [Arduino IDE](https://www.arduino.cc/en/software) +2. Get the firmware by copying the contents of `software/source/clients/esp32/src/client/client.ino` from the 01 repository. +3. Open Arduino IDE and paste the client.ino contents +4. Go to Tools -> Board -> Boards Manager, search "esp32", then install the boards by Arduino and Espressif +5. 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/) + +6. 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. +7. 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. ### Suppliementary files diff --git a/docs/hardware/m5atom.mdx b/docs/hardware/m5atom.mdx index e7d34fa..c5e6954 100644 --- a/docs/hardware/m5atom.mdx +++ b/docs/hardware/m5atom.mdx @@ -2,23 +2,3 @@ title: "M5 Atom" description: "Prep your M5 Atom" --- - -The recommended hardware for the developer kit is based around the M5 Atom. It contains an ESP32 board, as well as a microphone and speaker. - -The ESP32 needs to be setup to work with the 01OS server. We've created the firmware needed, just follow this guide. - -## ESP32 - -To set up audio recording + playback on the ESP32 (M5 Atom), do the following: - -1. Download the [Arduino IDE](https://www.arduino.cc/en/software) -2. Get the firmware by copying the contents of `software/source/clients/esp32/src/client/client.ino` from the 01 repository. -3. Open Arduino IDE and paste the client.ino contents -4. Go to Tools -> Board -> Boards Manager, search "esp32", then install the boards by Arduino and Espressif -5. 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/) - -6. 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. -7. 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. diff --git a/docs/mint.json b/docs/mint.json index e763131..69479db 100644 --- a/docs/mint.json +++ b/docs/mint.json @@ -50,7 +50,7 @@ }, { "group": "Hardware Setup", - "pages": ["hardware/01-light", "hardware/m5atom"] + "pages": ["hardware/01-light"] }, { "group": "Troubleshooting",