From 822346c838dc17834cac85708bc388cdd8a9cb07 Mon Sep 17 00:00:00 2001 From: human-bee <130510994+human-bee@users.noreply.github.com> Date: Wed, 28 Aug 2024 22:01:15 -0700 Subject: [PATCH] Updated image formatting in esp32.md --- docs/hardware/01-light/esp32/esp32.md | 84 ++++++++++++++++++ docs/hardware/01-light/esp32/esp32.mdx | 113 ++----------------------- 2 files changed, 91 insertions(+), 106 deletions(-) create mode 100644 docs/hardware/01-light/esp32/esp32.md diff --git a/docs/hardware/01-light/esp32/esp32.md b/docs/hardware/01-light/esp32/esp32.md new file mode 100644 index 0000000..75543e8 --- /dev/null +++ b/docs/hardware/01-light/esp32/esp32.md @@ -0,0 +1,84 @@ +--- +title: "ESP32" +description: "How to setup the ESP32" +--- + +To set up the ESP32 for use with 01, follow this guide to install the firmware: + +1. Download [Arduino IDE](https://www.arduino.cc/en/software). + +2. Get the firmware by copying the contents of [client.ino](https://github.com/OpenInterpreter/01/blob/main/software/source/clients/esp32/src/client/client.ino) from the 01 repository. + +
+ Copy client.ino contents +
+ +3. Open Arduino IDE and paste the client.ino contents. + +
+ Paste client.ino contents + + Pasted client.ino contents +
+ +4. Go to Tools -> Board -> Boards Manager, search "esp32", then install the boards by Arduino and Espressif. + +
+ Install ESP32 boards +
+ +5. Go to Tools -> Manage Libraries, then install the following: + +- M5Atom by M5Stack ([Reference](https://www.arduino.cc/reference/en/libraries/m5atom/)) + +
+ Install M5Atom library + + Install all M5Atom dependencies +
+ +- WebSockets by Markus Sattler ([Reference](https://www.arduino.cc/reference/en/libraries/websockets/)) + +
+ Install WebSockets library +
+ +- AsyncTCP by dvarrel ([Reference](https://github.com/dvarrel/AsyncTCP)) + +
+ Install AsyncTCP library +
+ +- ESPAsyncWebServer by lacamera ([Reference](https://github.com/lacamera/ESPAsyncWebServer)) + +
+ Install ESPAsyncWebServer library + + Install all ESPAsyncWebServer dependencies +
+ +6. To flash the .ino to the board, connect the board to the USB port. + +
+ Connect USB +
+ +7. Select the port from the dropdown on the IDE, then select the M5Atom board (or M5Stack-ATOM if you have that). + +
+ Select Board and Port +
+ +8. Click on upload to flash the board. + +
+ Upload firmware +
+ + + +--- + +Watch this video from Thomas for a step-by-step guide on flashing the ESP32 and connecting the 01. + +[![ESP32 Flashing Tutorial](https://img.youtube.com/vi/Y76zed8nEE8/0.jpg)](https://www.youtube.com/watch?v=Y76zed8nEE8 "ESP32 Flashing Tutorial") diff --git a/docs/hardware/01-light/esp32/esp32.mdx b/docs/hardware/01-light/esp32/esp32.mdx index bb7a358..6a3c091 100644 --- a/docs/hardware/01-light/esp32/esp32.mdx +++ b/docs/hardware/01-light/esp32/esp32.mdx @@ -6,118 +6,19 @@ description: "How to setup the ESP32" To set up the ESP32 for use with 01, follow this guide to install the firmware: 1. Download [Arduino IDE](https://www.arduino.cc/en/software). - 2. Get the firmware by copying the contents of [client.ino](https://github.com/OpenInterpreter/01/blob/main/software/source/clients/esp32/src/client/client.ino) from the 01 repository. - -Copy client.ino contents - 3. Open Arduino IDE and paste the client.ino contents. - -
- Paste client.ino contents - Pasted client.ino contents -
- 4. Go to Tools -> Board -> Boards Manager, search "esp32", then install the boards by Arduino and Espressif. - -Install ESP32 boards - 5. Go to Tools -> Manage Libraries, then install the following: -- M5Atom by M5Stack ([Reference](https://www.arduino.cc/reference/en/libraries/m5atom/)) -
- Install M5Atom library - Install all M5Atom dependencies -
- -- WebSockets by Markus Sattler ([Reference](https://www.arduino.cc/reference/en/libraries/websockets/)) -Install WebSockets library - -- AsyncTCP by dvarrel ([Reference](https://github.com/dvarrel/AsyncTCP)) -Install AsyncTCP library - -- ESPAsyncWebServer by lacamera ([Reference](https://github.com/lacamera/ESPAsyncWebServer)) -
- Install ESPAsyncWebServer library - Install all ESPAsyncWebServer dependencies -
- -6. To flash the .ino to the board, connect the board to the USB port. - -Connect USB - -7. Select the port from the dropdown on the IDE, then select the M5Atom board (or M5Stack-ATOM if you have that). - -Select Board and Port +- 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/) +- AsyncTCP by dvarrel [Reference](https://github.com/dvarrel/AsyncTCP) +- ESPAsyncWebServer by lacamera [Reference](https://github.com/lacamera/ESPAsyncWebServer) -8. Click on upload to flash the board. +6. 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. -Upload firmware +Watch this video from Thomas for a step-by-step guide on flashing the ESP32 and connecting the 01. +> \ No newline at end of file