diff --git a/docs/hardware/01-light.mdx b/docs/hardware/01-light.mdx deleted file mode 100644 index e4deb695..00000000 --- a/docs/hardware/01-light.mdx +++ /dev/null @@ -1,52 +0,0 @@ ---- -title: "01 Light" -description: "Use your 01 Light" ---- - -# Materials - -The Bill of Materials for the 01 Light can be found [here](https://github.com/OpenInterpreter/01/blob/main/hardware/light/BOM.md). - -# Chip (ESP32) - -To setup the ESP32 to work with 01, follow this guide to install the firmware: - -To set up audio recording + playback on the ESP32 (M5 Atom), do the following: - -1. Download the [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/) - -6. The board needs to connect to WiFi. Once you flash, connect to ESP32 wifi "captive" which will get wifi details. Once it connects, it will ask you to enter 01OS server address in the format "domain.com:port" or "ip:port". Once its able to connect you can use the device. -7. 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. - -Check out [this video from Thomas](https://www.youtube.com/watch?v=Y76zed8nEE8) for flashing the ESP32 and connecting the 01. - -# Case - -This case of the 01 can be 3d printed at home. It is recommended to use a resin printer for improved quality. - -Check out [this video from James at CAD9 Design](https://www.youtube.com/watch?v=BjoO0Kt-IWM) for a deep dive on his design. - -The stl files can be found [here](https://github.com/OpenInterpreter/01/tree/main/hardware/light/bodies) - -# Assembly - -Check out [this video from James at CAD9 Design](https://www.youtube.com/watch?v=37a5bgvoZy8) on how to assemble your 01 - -# Connect - -### 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! diff --git a/docs/hardware/01-light/assembly.mdx b/docs/hardware/01-light/assembly.mdx new file mode 100644 index 00000000..1aebf289 --- /dev/null +++ b/docs/hardware/01-light/assembly.mdx @@ -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. + + + +## Wiring Diagram + +![Wiring Diagram](/hardware/light/wiring-diagram.jpg) diff --git a/docs/hardware/01-light/case.mdx b/docs/hardware/01-light/case.mdx new file mode 100644 index 00000000..fe85b198 --- /dev/null +++ b/docs/hardware/01-light/case.mdx @@ -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. + + + +The STL files can be found [here](https://github.com/OpenInterpreter/01/tree/main/hardware/light/bodies) diff --git a/docs/hardware/01-light/esp32.mdx b/docs/hardware/01-light/esp32.mdx new file mode 100644 index 00000000..e7d9ef62 --- /dev/null +++ b/docs/hardware/01-light/esp32.mdx @@ -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. + + diff --git a/hardware/light/BOM.md b/docs/hardware/01-light/materials.mdx similarity index 97% rename from hardware/light/BOM.md rename to docs/hardware/01-light/materials.mdx index 0ae5ec86..9df3db72 100644 --- a/hardware/light/BOM.md +++ b/docs/hardware/01-light/materials.mdx @@ -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 | diff --git a/docs/mint.json b/docs/mint.json index d8fea555..469806eb 100644 --- a/docs/mint.json +++ b/docs/mint.json @@ -44,6 +44,7 @@ "pages": [ "software/introduction", "software/installation", + "software/connect", "software/run", "software/configure", "software/flags" @@ -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" diff --git a/docs/software/connect.mdx b/docs/software/connect.mdx new file mode 100644 index 00000000..58f70e56 --- /dev/null +++ b/docs/software/connect.mdx @@ -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! diff --git a/docs/software/introduction.mdx b/docs/software/introduction.mdx index 2966a0b3..d419aaa8 100644 --- a/docs/software/introduction.mdx +++ b/docs/software/introduction.mdx @@ -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. diff --git a/hardware/light/README.md b/hardware/light/README.md deleted file mode 100644 index bcdff8ea..00000000 --- a/hardware/light/README.md +++ /dev/null @@ -1,36 +0,0 @@ -# ESP32 Setup - -## Flashing - -To set up audio recording + playback on the ESP32 (M5 Atom), do the following: - -1. Open Arduino IDE, and open the [client.ino](https://github.com/OpenInterpreter/01/blob/main/software/source/clients/esp32/src/client/client.ino) file -2. Go to Tools -> Board -> Boards Manager, search "esp32", then install the boards by Arduino and Espressif -3. 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) - -Finally, 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. - -### Alternative - PlatformIO - -You don't need anything, PlatformIO will install everything for you, dependencies, tool chains, etc. - -Please install first [PlatformIO](http://platformio.org/) open source ecosystem for IoT development compatible with **Arduino** IDE and its command line tools (Windows, MacOs and Linux), and then enter to the firmware directory: - -```bash -cd software/source/clients/esp32/src/client/ -``` - -And build and upload the firmware with a simple command: - -```bash -pio run --target upload -``` - -## Wifi - -The board needs to connect to WiFi. Once you flash, connect to the ESP32 WiFi portal "01-Light" which will get WiFi details. Once it connects, it will ask you to enter 01OS server address. Once its able to connect, you can use the device. diff --git a/hardware/light/wiring diagram.jpg b/hardware/light/wiring-diagram.jpg similarity index 100% rename from hardware/light/wiring diagram.jpg rename to hardware/light/wiring-diagram.jpg