From 644b7218c19c516bddddbe46f8e8615423734a28 Mon Sep 17 00:00:00 2001 From: human-bee <130510994+human-bee@users.noreply.github.com> Date: Wed, 28 Aug 2024 21:50:42 -0700 Subject: [PATCH] Added photos to ESP32 setup guide - Included images for IDE, board, and library installations - Added USB connection and firmware upload photos --- docs/hardware/01-light/esp32.mdx | 30 ---- .../assets}/AsyncTCP by dvarrel.png | Bin .../assets}/ESPAsyncWebServer by lacamera.png | Bin .../assets}/ESPAsyncWebServer-install-all.png | Bin .../{ => esp32/assets}/M5-atom-library.png | Bin .../assets}/Select Board and Port.png | Bin .../01-light/{ => esp32/assets}/Upload.png | Bin .../assets}/WebSockets by Markus Sattler.png | Bin .../{ => esp32/assets}/boards-manager.png | Bin .../{ => esp32/assets}/connect-usb.jpeg | Bin .../{ => esp32/assets}/copy-client.png | Bin .../assets}/m5-atom-install-all.png | Bin .../{ => esp32/assets}/paste-client.png | Bin .../{ => esp32/assets}/pasted-client.png | Bin docs/hardware/01-light/esp32/esp32.mdx | 129 ++++++++++++++++++ 15 files changed, 129 insertions(+), 30 deletions(-) delete mode 100644 docs/hardware/01-light/esp32.mdx rename docs/hardware/01-light/{ => esp32/assets}/AsyncTCP by dvarrel.png (100%) rename docs/hardware/01-light/{ => esp32/assets}/ESPAsyncWebServer by lacamera.png (100%) rename docs/hardware/01-light/{ => esp32/assets}/ESPAsyncWebServer-install-all.png (100%) rename docs/hardware/01-light/{ => esp32/assets}/M5-atom-library.png (100%) rename docs/hardware/01-light/{ => esp32/assets}/Select Board and Port.png (100%) rename docs/hardware/01-light/{ => esp32/assets}/Upload.png (100%) rename docs/hardware/01-light/{ => esp32/assets}/WebSockets by Markus Sattler.png (100%) rename docs/hardware/01-light/{ => esp32/assets}/boards-manager.png (100%) rename docs/hardware/01-light/{ => esp32/assets}/connect-usb.jpeg (100%) rename docs/hardware/01-light/{ => esp32/assets}/copy-client.png (100%) rename docs/hardware/01-light/{ => esp32/assets}/m5-atom-install-all.png (100%) rename docs/hardware/01-light/{ => esp32/assets}/paste-client.png (100%) rename docs/hardware/01-light/{ => esp32/assets}/pasted-client.png (100%) create mode 100644 docs/hardware/01-light/esp32/esp32.mdx diff --git a/docs/hardware/01-light/esp32.mdx b/docs/hardware/01-light/esp32.mdx deleted file mode 100644 index 08ebefa..0000000 --- a/docs/hardware/01-light/esp32.mdx +++ /dev/null @@ -1,30 +0,0 @@ ---- -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. -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/) -- AsyncTCP by dvarrel [Reference](https://github.com/dvarrel/AsyncTCP) -- ESPAsyncWebServer by lacamera [Reference](https://github.com/lacamera/ESPAsyncWebServer) - -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. - -Watch this video from Thomas for a step-by-step guide on flashing the ESP32 and connecting the 01. - - diff --git a/docs/hardware/01-light/AsyncTCP by dvarrel.png b/docs/hardware/01-light/esp32/assets/AsyncTCP by dvarrel.png similarity index 100% rename from docs/hardware/01-light/AsyncTCP by dvarrel.png rename to docs/hardware/01-light/esp32/assets/AsyncTCP by dvarrel.png diff --git a/docs/hardware/01-light/ESPAsyncWebServer by lacamera.png b/docs/hardware/01-light/esp32/assets/ESPAsyncWebServer by lacamera.png similarity index 100% rename from docs/hardware/01-light/ESPAsyncWebServer by lacamera.png rename to docs/hardware/01-light/esp32/assets/ESPAsyncWebServer by lacamera.png diff --git a/docs/hardware/01-light/ESPAsyncWebServer-install-all.png b/docs/hardware/01-light/esp32/assets/ESPAsyncWebServer-install-all.png similarity index 100% rename from docs/hardware/01-light/ESPAsyncWebServer-install-all.png rename to docs/hardware/01-light/esp32/assets/ESPAsyncWebServer-install-all.png diff --git a/docs/hardware/01-light/M5-atom-library.png b/docs/hardware/01-light/esp32/assets/M5-atom-library.png similarity index 100% rename from docs/hardware/01-light/M5-atom-library.png rename to docs/hardware/01-light/esp32/assets/M5-atom-library.png diff --git a/docs/hardware/01-light/Select Board and Port.png b/docs/hardware/01-light/esp32/assets/Select Board and Port.png similarity index 100% rename from docs/hardware/01-light/Select Board and Port.png rename to docs/hardware/01-light/esp32/assets/Select Board and Port.png diff --git a/docs/hardware/01-light/Upload.png b/docs/hardware/01-light/esp32/assets/Upload.png similarity index 100% rename from docs/hardware/01-light/Upload.png rename to docs/hardware/01-light/esp32/assets/Upload.png diff --git a/docs/hardware/01-light/WebSockets by Markus Sattler.png b/docs/hardware/01-light/esp32/assets/WebSockets by Markus Sattler.png similarity index 100% rename from docs/hardware/01-light/WebSockets by Markus Sattler.png rename to docs/hardware/01-light/esp32/assets/WebSockets by Markus Sattler.png diff --git a/docs/hardware/01-light/boards-manager.png b/docs/hardware/01-light/esp32/assets/boards-manager.png similarity index 100% rename from docs/hardware/01-light/boards-manager.png rename to docs/hardware/01-light/esp32/assets/boards-manager.png diff --git a/docs/hardware/01-light/connect-usb.jpeg b/docs/hardware/01-light/esp32/assets/connect-usb.jpeg similarity index 100% rename from docs/hardware/01-light/connect-usb.jpeg rename to docs/hardware/01-light/esp32/assets/connect-usb.jpeg diff --git a/docs/hardware/01-light/copy-client.png b/docs/hardware/01-light/esp32/assets/copy-client.png similarity index 100% rename from docs/hardware/01-light/copy-client.png rename to docs/hardware/01-light/esp32/assets/copy-client.png diff --git a/docs/hardware/01-light/m5-atom-install-all.png b/docs/hardware/01-light/esp32/assets/m5-atom-install-all.png similarity index 100% rename from docs/hardware/01-light/m5-atom-install-all.png rename to docs/hardware/01-light/esp32/assets/m5-atom-install-all.png diff --git a/docs/hardware/01-light/paste-client.png b/docs/hardware/01-light/esp32/assets/paste-client.png similarity index 100% rename from docs/hardware/01-light/paste-client.png rename to docs/hardware/01-light/esp32/assets/paste-client.png diff --git a/docs/hardware/01-light/pasted-client.png b/docs/hardware/01-light/esp32/assets/pasted-client.png similarity index 100% rename from docs/hardware/01-light/pasted-client.png rename to docs/hardware/01-light/esp32/assets/pasted-client.png diff --git a/docs/hardware/01-light/esp32/esp32.mdx b/docs/hardware/01-light/esp32/esp32.mdx new file mode 100644 index 0000000..bb7a358 --- /dev/null +++ b/docs/hardware/01-light/esp32/esp32.mdx @@ -0,0 +1,129 @@ +--- +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 + +