killian
5 months ago
committed by
GitHub
commit
d4259759d1
@ -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!
|
||||
@ -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
|
||||
|
||||
|
||||
@ -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).
|
||||
@ -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!
|
||||
@ -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>
|
||||
@ -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 |
|
||||
@ -0,0 +1,41 @@
|
||||
---
|
||||
title: "Android"
|
||||
description: "Control 01 from your Android phone"
|
||||
---
|
||||
|
||||
Using your phone is a great way to control 01. There are multiple options available.
|
||||
|
||||
## [React Native app](https://github.com/OpenInterpreter/01/tree/main/software/source/clients/mobile)
|
||||
|
||||
Work in progress, we will continue to improve this application.
|
||||
|
||||
If you want to run it on your device, you will need to install [Expo Go](https://expo.dev/go) on your mobile device.
|
||||
|
||||
### Setup Instructions
|
||||
|
||||
- [Install 01 software](/software/installation) on your machine
|
||||
|
||||
- Run the Expo server:
|
||||
|
||||
```shell
|
||||
cd software/source/clients/mobile/react-native
|
||||
npm install # install dependencies
|
||||
npx expo start # start local expo development server
|
||||
```
|
||||
|
||||
This will produce a QR code that you can scan with Expo Go on your mobile device.
|
||||
|
||||
Open **Expo Go** on your mobile device and select _Scan QR code_ to scan the QR code produced by the `npx expo start` command.
|
||||
|
||||
- Run 01:
|
||||
|
||||
```shell
|
||||
cd software # cd into `software`
|
||||
poetry run 01 --mobile # exposes QR code for 01 Light server
|
||||
```
|
||||
|
||||
### Using the App
|
||||
|
||||
In the 01 mobile app, select _Scan Code_ to scan the QR code produced by the `poetry run 01 --mobile` command.
|
||||
|
||||
Press and hold the button to speak, release to make the request. To rescan the QR code, swipe left on the screen to go back.
|
||||
@ -0,0 +1,53 @@
|
||||
---
|
||||
title: "Software"
|
||||
description: "The software that powers 01"
|
||||
---
|
||||
|
||||
## Overview
|
||||
|
||||
The 01 project is an open-source ecosystem for artificially intelligent devices. By combining code-interpreting language models ("interpreters") with speech recognition and voice synthesis, the 01's flagship operating system ("01OS") can power conversational, computer-operating AI devices similar to the Rabbit R1 or the Humane Pin.
|
||||
|
||||
Our goal is to become the "Linux" of this new space—open, modular, and free for personal or commercial use.
|
||||
|
||||
<Note>The current version of 01OS is a developer preview.</Note>
|
||||
|
||||
## Components
|
||||
|
||||
The 01 software consists of two main components:
|
||||
|
||||
### Server
|
||||
|
||||
The server runs on your computer and acts as the brain of the 01 system. It:
|
||||
|
||||
- Passes input to the interpreter
|
||||
- Executes commands on your computer
|
||||
- Returns responses
|
||||
|
||||
### Client
|
||||
|
||||
The client is responsible for capturing audio for controlling computers running the 01 server. It:
|
||||
|
||||
- Transmits audio to the server
|
||||
- Plays back responses
|
||||
|
||||
## Customization
|
||||
|
||||
One of the key features of the 01 ecosystem is its modularity. You can:
|
||||
|
||||
- Use different language models
|
||||
- Customize the system's behavior through profiles
|
||||
- Create and integrate custom hardware
|
||||
|
||||
## Getting Started
|
||||
|
||||
To begin using 01:
|
||||
|
||||
1. [Install](/software/installation) the software
|
||||
2. [Run](/software/run) the Server
|
||||
3. [Connect](/hardware/01-light/connect) the Client
|
||||
|
||||
For more advanced usage, check out our guides on [configuration](/software/configure).
|
||||
|
||||
## Contributing
|
||||
|
||||
As an open-source project, we welcome contributions from the community. Whether you're interested in improving the core software, developing new features, or creating custom hardware integrations, there are many ways to get involved.
|
||||
@ -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.
|
||||
|
Before Width: | Height: | Size: 278 KiB After Width: | Height: | Size: 278 KiB |
Loading…
Reference in new issue