diff --git a/docs/hardware/01-light/chip.md b/docs/hardware/01-light/chip.md new file mode 100644 index 0000000..ad86487 --- /dev/null +++ b/docs/hardware/01-light/chip.md @@ -0,0 +1,7 @@ +For the 01 Light project, we've chosen the M5Atom, which features an ESP32 Pico chip. This compact and powerful microcontroller is ideal for our needs, offering built-in Wi-Fi and Bluetooth capabilities, a microphone, speaker, and button. + +
+ M5Atom ESP32 Pico +
+ +To set up the M5Atom for use with 01 Light, please follow the detailed instructions in our [ESP32 Setup Guide](../esp32/esp32-setup.md). This guide will walk you through the process of installing the necessary firmware and configuring your device. diff --git a/docs/hardware/01-light/esp32/assets/AsyncTCP by dvarrel.png b/docs/hardware/esp32/assets/AsyncTCP by dvarrel.png similarity index 100% rename from docs/hardware/01-light/esp32/assets/AsyncTCP by dvarrel.png rename to docs/hardware/esp32/assets/AsyncTCP by dvarrel.png diff --git a/docs/hardware/01-light/esp32/assets/ESPAsyncWebServer by lacamera.png b/docs/hardware/esp32/assets/ESPAsyncWebServer by lacamera.png similarity index 100% rename from docs/hardware/01-light/esp32/assets/ESPAsyncWebServer by lacamera.png rename to docs/hardware/esp32/assets/ESPAsyncWebServer by lacamera.png diff --git a/docs/hardware/01-light/esp32/assets/ESPAsyncWebServer-install-all.png b/docs/hardware/esp32/assets/ESPAsyncWebServer-install-all.png similarity index 100% rename from docs/hardware/01-light/esp32/assets/ESPAsyncWebServer-install-all.png rename to docs/hardware/esp32/assets/ESPAsyncWebServer-install-all.png diff --git a/docs/hardware/01-light/esp32/assets/M5-atom-library.png b/docs/hardware/esp32/assets/M5-atom-library.png similarity index 100% rename from docs/hardware/01-light/esp32/assets/M5-atom-library.png rename to docs/hardware/esp32/assets/M5-atom-library.png diff --git a/docs/hardware/01-light/esp32/assets/Select Board and Port.png b/docs/hardware/esp32/assets/Select Board and Port.png similarity index 100% rename from docs/hardware/01-light/esp32/assets/Select Board and Port.png rename to docs/hardware/esp32/assets/Select Board and Port.png diff --git a/docs/hardware/01-light/esp32/assets/Upload.png b/docs/hardware/esp32/assets/Upload.png similarity index 100% rename from docs/hardware/01-light/esp32/assets/Upload.png rename to docs/hardware/esp32/assets/Upload.png diff --git a/docs/hardware/01-light/esp32/assets/WebSockets by Markus Sattler.png b/docs/hardware/esp32/assets/WebSockets by Markus Sattler.png similarity index 100% rename from docs/hardware/01-light/esp32/assets/WebSockets by Markus Sattler.png rename to docs/hardware/esp32/assets/WebSockets by Markus Sattler.png diff --git a/docs/hardware/01-light/esp32/assets/boards-manager.png b/docs/hardware/esp32/assets/boards-manager.png similarity index 100% rename from docs/hardware/01-light/esp32/assets/boards-manager.png rename to docs/hardware/esp32/assets/boards-manager.png diff --git a/docs/hardware/esp32/assets/connect_usb.jpeg b/docs/hardware/esp32/assets/connect_usb.jpeg new file mode 100644 index 0000000..543d7f1 Binary files /dev/null and b/docs/hardware/esp32/assets/connect_usb.jpeg differ diff --git a/docs/hardware/01-light/esp32/assets/copy-client.png b/docs/hardware/esp32/assets/copy-client.png similarity index 100% rename from docs/hardware/01-light/esp32/assets/copy-client.png rename to docs/hardware/esp32/assets/copy-client.png diff --git a/docs/hardware/esp32/assets/hardcode-wifi-pass-server.png b/docs/hardware/esp32/assets/hardcode-wifi-pass-server.png new file mode 100644 index 0000000..d6e2c44 Binary files /dev/null and b/docs/hardware/esp32/assets/hardcode-wifi-pass-server.png differ diff --git a/docs/hardware/01-light/esp32/assets/m5-atom-install-all.png b/docs/hardware/esp32/assets/m5-atom-install-all.png similarity index 100% rename from docs/hardware/01-light/esp32/assets/m5-atom-install-all.png rename to docs/hardware/esp32/assets/m5-atom-install-all.png diff --git a/docs/hardware/esp32/assets/m5atomecho.png b/docs/hardware/esp32/assets/m5atomecho.png new file mode 100644 index 0000000..5d465c0 Binary files /dev/null and b/docs/hardware/esp32/assets/m5atomecho.png differ diff --git a/docs/hardware/01-light/esp32/assets/paste-client.png b/docs/hardware/esp32/assets/paste-client.png similarity index 100% rename from docs/hardware/01-light/esp32/assets/paste-client.png rename to docs/hardware/esp32/assets/paste-client.png diff --git a/docs/hardware/01-light/esp32/assets/pasted-client.png b/docs/hardware/esp32/assets/pasted-client.png similarity index 100% rename from docs/hardware/01-light/esp32/assets/pasted-client.png rename to docs/hardware/esp32/assets/pasted-client.png diff --git a/docs/hardware/01-light/esp32/esp32.md b/docs/hardware/esp32/esp32-setup.md similarity index 81% rename from docs/hardware/01-light/esp32/esp32.md rename to docs/hardware/esp32/esp32-setup.md index 75543e8..2624218 100644 --- a/docs/hardware/01-light/esp32/esp32.md +++ b/docs/hardware/esp32/esp32-setup.md @@ -21,7 +21,19 @@ To set up the ESP32 for use with 01, follow this guide to install the firmware: Pasted client.ino contents -4. Go to Tools -> Board -> Boards Manager, search "esp32", then install the boards by Arduino and Espressif. +4. Hardcode your WiFi SSID, WiFi password, and server URL into the code. + +
+ Hardcode WiFi SSID and password +
+ +
+
+ Hardcoding is recommended for a more streamlined setup and development environment. However, if you don't hardcode these values or if the ESP32 can't connect using the provided information, it will automatically default to a captive portal for configuration. +
+
+ +5. Go to Tools -> Board -> Boards Manager, search "esp32", then install the boards by Arduino and Espressif.
Install ESP32 boards @@ -60,7 +72,7 @@ To set up the ESP32 for use with 01, follow this guide to install the firmware: 6. To flash the .ino to the board, connect the board to the USB port.
- Connect USB + Connect USB
7. Select the port from the dropdown on the IDE, then select the M5Atom board (or M5Stack-ATOM if you have that). diff --git a/docs/hardware/01-light/esp32/esp32.mdx b/docs/hardware/esp32/esp32.mdx similarity index 100% rename from docs/hardware/01-light/esp32/esp32.mdx rename to docs/hardware/esp32/esp32.mdx diff --git a/docs/mint.json b/docs/mint.json index c1baca8..5321e66 100644 --- a/docs/mint.json +++ b/docs/mint.json @@ -55,18 +55,29 @@ { "group": "01 Light", "pages": [ + "hardware/01-light/introduction", "hardware/01-light/materials", "hardware/01-light/case", "hardware/01-light/assembly", - "hardware/01-light/esp32", + "hardware/01-light/chip", "hardware/01-light/connect" ] }, + { + "group": "ESP32", + "pages": [ + "hardware/esp32/esp32-setup" + ] + }, "hardware/custom_hardware", "hardware/desktop", { "group": "Mobile", - "pages": ["hardware/mobile/ios", "hardware/mobile/android", "hardware/mobile/privacy"] + "pages": [ + "hardware/mobile/ios", + "hardware/mobile/android", + "hardware/mobile/privacy" + ] } ] },