Skip to content

Commit

Permalink
Merge pull request OpenInterpreter#301 from OpenInterpreter/manufactu…
Browse files Browse the repository at this point in the history
…ring-report

Manufacturing report
  • Loading branch information
KillianLucas committed Sep 6, 2024
2 parents 7c091b3 + 9f77cf9 commit 888743c
Show file tree
Hide file tree
Showing 29 changed files with 635 additions and 2 deletions.
7 changes: 7 additions & 0 deletions docs/hardware/01-light/chip.md
Original file line number Diff line number Diff line change
@@ -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.

<div style="display: flex; justify-content: center;">
<img src="../esp32/assets/m5atomecho.png" alt="M5Atom ESP32 Pico" width="60%" />
</div>

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.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/hardware/esp32/assets/M5-atom-library.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/hardware/esp32/assets/Upload.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/hardware/esp32/assets/boards-manager.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/hardware/esp32/assets/connect_usb.jpeg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/hardware/esp32/assets/copy-client.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/hardware/esp32/assets/m5atomecho.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/hardware/esp32/assets/paste-client.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/hardware/esp32/assets/pasted-client.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
96 changes: 96 additions & 0 deletions docs/hardware/esp32/esp32-setup.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,96 @@
---
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.

<div style="display: flex; justify-content: center;">
<img src="assets/copy-client.png" alt="Copy client.ino contents" width="60%" />
</div>

3. Open Arduino IDE and paste the client.ino contents.

<div style="display: flex; justify-content: center;">
<img src="assets/paste-client.png" alt="Paste client.ino contents" width="60%" />

<img src="assets/pasted-client.png" alt="Pasted client.ino contents" width="60%" />
</div>

4. Hardcode your WiFi SSID, WiFi password, and server URL into the code.

<div style="display: flex; justify-content: center;">
<img src="assets/hardcode-wifi-pass-server.png" alt="Hardcode WiFi SSID and password" width="60%" />
</div>

<div style="display: flex; justify-content: center;">
<div style="width: 80%;">
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.
</div>
</div>

5. Go to Tools -> Board -> Boards Manager, search "esp32", then install the boards by Arduino and Espressif.

<div style="display: flex; justify-content: center;">
<img src="assets/boards-manager.png" alt="Install ESP32 boards" width="60%" />
</div>

5. Go to Tools -> Manage Libraries, then install the following:

- M5Atom by M5Stack ([Reference](https://www.arduino.cc/reference/en/libraries/m5atom/))

<div style="display: flex; justify-content: center;">
<img src="assets/M5-atom-library.png" alt="Install M5Atom library" width="60%" />

<img src="assets/m5-atom-install-all.png" alt="Install all M5Atom dependencies" width="60%" />
</div>

- WebSockets by Markus Sattler ([Reference](https://www.arduino.cc/reference/en/libraries/websockets/))

<div style="display: flex; justify-content: center;">
<img src="assets/WebSockets by Markus Sattler.png" alt="Install WebSockets library" width="60%" />
</div>

- AsyncTCP by dvarrel ([Reference](https://github.com/dvarrel/AsyncTCP))

<div style="display: flex; justify-content: center;">
<img src="assets/AsyncTCP by dvarrel.png" alt="Install AsyncTCP library" width="60%" />
</div>

- ESPAsyncWebServer by lacamera ([Reference](https://github.com/lacamera/ESPAsyncWebServer))

<div style="display: flex; justify-content: center;">
<img src="assets/ESPAsyncWebServer by lacamera.png" alt="Install ESPAsyncWebServer library" width="60%" />

<img src="assets/ESPAsyncWebServer-install-all.png" alt="Install all ESPAsyncWebServer dependencies" width="60%" />
</div>

6. To flash the .ino to the board, connect the board to the USB port.

<div style="display: flex; justify-content: center;">
<img src="assets/connect_usb.jpeg" alt="Connect USB" width="60%" />
</div>

7. Select the port from the dropdown on the IDE, then select the M5Atom board (or M5Stack-ATOM if you have that).

<div style="display: flex; justify-content: center;">
<img src="assets/Select Board and Port.png" alt="Select Board and Port" width="60%" />
</div>

8. Click on upload to flash the board.

<div style="display: flex; justify-content: center;">
<img src="assets/Upload.png" alt="Upload firmware" width="60%" />
</div>



---

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")
Original file line number Diff line number Diff line change
Expand Up @@ -27,4 +27,4 @@ Watch this video from Thomas for a step-by-step guide on flashing the ESP32 and
frameBorder="0"
allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture"
allowfullscreen
></iframe>
></iframe>
8 changes: 7 additions & 1 deletion docs/mint.json
Original file line number Diff line number Diff line change
Expand Up @@ -74,10 +74,16 @@
"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",
{
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit 888743c

Please sign in to comment.