Skip to content

Commit

Permalink
"Refactor hardware documentation: Consolidate ESP32 setup instructions"
Browse files Browse the repository at this point in the history
  • Loading branch information
MikeBirdTech committed Jul 22, 2024
1 parent 976ebd4 commit a5eeb8d
Show file tree
Hide file tree
Showing 10 changed files with 103 additions and 89 deletions.
52 changes: 0 additions & 52 deletions docs/hardware/01-light.mdx

This file was deleted.

19 changes: 19 additions & 0 deletions docs/hardware/01-light/assembly.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
---
title: "Assembly"
description: "How to build your 01 Light"
---

Watch this video from James at CAD9 Design for a detailed guide on assembling your 01.

<iframe
width="560"
height="315"
src="https://www.youtube.com/embed/37a5bgvoZy8"
frameborder="0"
allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture"
allowfullscreen
></iframe>

## Wiring Diagram

![Wiring Diagram](/hardware/light/wiring-diagram.jpg)
21 changes: 21 additions & 0 deletions docs/hardware/01-light/case.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
---
title: "Case"
description: "The Body of the 01 Light"
---

# Case

You can 3D print the 01 case at home. For the best quality, it's recommended to use a resin printer.

Watch this video from James at CAD9 Design for a deep dive on his design.

<iframe
width="560"
height="315"
src="https://www.youtube.com/embed/BjoO0Kt-IWM"
frameborder="0"
allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture"
allowfullscreen
></iframe>

The STL files can be found [here](https://github.com/OpenInterpreter/01/tree/main/hardware/light/bodies)
30 changes: 30 additions & 0 deletions docs/hardware/01-light/esp32.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
---
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.

<iframe
width="560"
height="315"
src="https://www.youtube.com/embed/Y76zed8nEE8"
frameborder="0"
allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture"
allowfullscreen
></iframe>
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: "Materials"
description: "Bill of Materials for the 01 Light"
---

# 01 Light Bill of Materials

| Part Name | Part Number | How Many | Unit Price | Units per order | Purchase Link | Mouser Link | $42.38 |
Expand Down
11 changes: 10 additions & 1 deletion docs/mint.json
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,7 @@
"pages": [
"software/introduction",
"software/installation",
"software/connect",
"software/run",
"software/configure",
"software/flags"
Expand All @@ -52,7 +53,15 @@
{
"group": "Hardware Setup",
"pages": [
"hardware/01-light",
{
"group": "01 Light",
"pages": [
"hardware/01-light/materials",
"hardware/01-light/case",
"hardware/01-light/assembly",
"hardware/01-light/esp32"
]
},
"hardware/custom_hardware",
"hardware/desktop",
"hardware/mobile"
Expand Down
14 changes: 14 additions & 0 deletions docs/software/connect.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
---
title: "Connect"
description: "Connect your 01 device"
---

### Captive portal

To connect your 01, you will use the captive portal.

1. Turn on your computer or laptop and connect to the '01 light' Wi-Fi network.
2. Enter your Wi-Fi/hotspot name and password in the captive portal page.
3. Enter the server URL generated on their computer and hit 'Connect'.

Now you're connected and ready to go!
4 changes: 4 additions & 0 deletions docs/software/introduction.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,8 @@ description: "The software that powers 01"

## What is the server?

Runs on your computer

## What is the client?

Captures audio for controlling computers running the 01 server.
36 changes: 0 additions & 36 deletions hardware/light/README.md

This file was deleted.

File renamed without changes

0 comments on commit a5eeb8d

Please sign in to comment.