open-interpreter-ai
/
01
mirror of https://github.com/OpenInterpreter/01
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Docs update

Browse Source
pull/308/head
killian 4 months ago
parent df011c2d87
commit c78c458122
4 changed files with 16 additions and 17 deletions
Show Stats Download Patch File Download Diff File

0
docs/banner.png → docs/assets/banner.png
Unescape View File

Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 1.2 MiB

After

Width:  |  Height:  |  Size: 1.2 MiB

28
docs/client/esp32.mdx
Unescape View File

@ -34,21 +34,21 @@ To set up the ESP32 for use with 01, follow this guide to install the firmware:
View the ESP32 firmware source code View the ESP32 firmware source code
</Card> </Card>
<img src="assets/copy-client.png" alt="Copy client.ino contents" width="60%" /> <img src="https://raw.githubusercontent.com/OpenInterpreter/01/main/docs/assets/copy-client.png" alt="Copy client.ino contents" width="60%" />
</Step> </Step>
<Step title="Paste firmware into Arduino IDE"> <Step title="Paste firmware into Arduino IDE">
Open Arduino IDE and paste the client.ino contents. Open Arduino IDE and paste the client.ino contents.
<img src="assets/paste-client.png" alt="Paste client.ino contents" width="60%" /> <img src="https://raw.githubusercontent.com/OpenInterpreter/01/main/docs/assets/paste-client.png" alt="Paste client.ino contents" width="60%" />
<img src="assets/pasted-client.png" alt="Pasted client.ino contents" width="60%" /> <img src="https://raw.githubusercontent.com/OpenInterpreter/01/main/docs/assets/pasted-client.png" alt="Pasted client.ino contents" width="60%" />
</Step> </Step>
<Step title="(Optional) Hardcode credentials"> <Step title="(Optional) Hardcode credentials">
Hardcode your WiFi SSID, WiFi password, and server URL into the top of the `client.ino` file. Hardcode your WiFi SSID, WiFi password, and server URL into the top of the `client.ino` file.
<img src="assets/hardcode-wifi-pass-server.png" alt="Hardcode WiFi SSID and password" width="60%" /> <img src="https://raw.githubusercontent.com/OpenInterpreter/01/main/docs/assets/hardcode-wifi-pass-server.png" alt="Hardcode WiFi SSID and password" width="60%" />
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. 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.
</Step> </Step>
@ -56,7 +56,7 @@ To set up the ESP32 for use with 01, follow this guide to install the firmware:
<Step title="Install ESP32 boards"> <Step title="Install ESP32 boards">
Go to Tools -> Board -> Boards Manager, search "esp32", then install the boards by Arduino and Espressif. Go to Tools -> Board -> Boards Manager, search "esp32", then install the boards by Arduino and Espressif.
<img src="assets/boards-manager.png" alt="Install ESP32 boards" width="60%" /> <img src="https://raw.githubusercontent.com/OpenInterpreter/01/main/docs/assets/boards-manager.png" alt="Install ESP32 boards" width="60%" />
</Step> </Step>
<Step title="Install required libraries"> <Step title="Install required libraries">
@ -64,41 +64,41 @@ To set up the ESP32 for use with 01, follow this guide to install the firmware:
- M5Atom by M5Stack ([Reference](https://www.arduino.cc/reference/en/libraries/m5atom/)) - M5Atom by M5Stack ([Reference](https://www.arduino.cc/reference/en/libraries/m5atom/))
<img src="assets/M5-atom-library.png" alt="Install M5Atom library" width="60%" /> <img src="https://raw.githubusercontent.com/OpenInterpreter/01/main/docs/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%" /> <img src="https://raw.githubusercontent.com/OpenInterpreter/01/main/docs/assets/m5-atom-install-all.png" alt="Install all M5Atom dependencies" width="60%" />
- WebSockets by Markus Sattler ([Reference](https://www.arduino.cc/reference/en/libraries/websockets/)) - WebSockets by Markus Sattler ([Reference](https://www.arduino.cc/reference/en/libraries/websockets/))
<img src="assets/WebSockets by Markus Sattler.png" alt="Install WebSockets library" width="60%" /> <img src="https://raw.githubusercontent.com/OpenInterpreter/01/main/docs/assets/WebSockets by Markus Sattler.png" alt="Install WebSockets library" width="60%" />
- AsyncTCP by dvarrel ([Reference](https://github.com/dvarrel/AsyncTCP)) - AsyncTCP by dvarrel ([Reference](https://github.com/dvarrel/AsyncTCP))
<img src="assets/AsyncTCP by dvarrel.png" alt="Install AsyncTCP library" width="60%" /> <img src="https://raw.githubusercontent.com/OpenInterpreter/01/main/docs/assets/AsyncTCP by dvarrel.png" alt="Install AsyncTCP library" width="60%" />
- ESPAsyncWebServer by lacamera ([Reference](https://github.com/lacamera/ESPAsyncWebServer)) - ESPAsyncWebServer by lacamera ([Reference](https://github.com/lacamera/ESPAsyncWebServer))
<img src="assets/ESPAsyncWebServer by lacamera.png" alt="Install ESPAsyncWebServer library" width="60%" /> <img src="https://raw.githubusercontent.com/OpenInterpreter/01/main/docs/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%" /> <img src="https://raw.githubusercontent.com/OpenInterpreter/01/main/docs/assets/ESPAsyncWebServer-install-all.png" alt="Install all ESPAsyncWebServer dependencies" width="60%" />
</Step> </Step>
<Step title="Connect the board"> <Step title="Connect the board">
To flash the .ino to the board, connect the board to the USB port. To flash the .ino to the board, connect the board to the USB port.
<img src="assets/connect_usb.jpeg" alt="Connect USB" width="60%" /> <img src="https://raw.githubusercontent.com/OpenInterpreter/01/main/docs/assets/connect_usb.jpeg" alt="Connect USB" width="60%" />
</Step> </Step>
<Step title="Select board and port"> <Step title="Select board and port">
Select the port from the dropdown on the IDE, then select the M5Atom board (or M5Stack-ATOM if you have that). Select the port from the dropdown on the IDE, then select the M5Atom board (or M5Stack-ATOM if you have that).
<img src="assets/Select Board and Port.png" alt="Select Board and Port" width="60%" /> <img src="https://raw.githubusercontent.com/OpenInterpreter/01/main/docs/assets/Select Board and Port.png" alt="Select Board and Port" width="60%" />
</Step> </Step>
<Step title="Upload firmware"> <Step title="Upload firmware">
Click on upload to flash the board. Click on upload to flash the board.
<img src="assets/Upload.png" alt="Upload firmware" width="60%" /> <img src="https://raw.githubusercontent.com/OpenInterpreter/01/main/docs/assets/Upload.png" alt="Upload firmware" width="60%" />
</Step> </Step>
<Step title="Start the 01 server"> <Step title="Start the 01 server">

3
docs/hardware/grimes-build.mdx
Unescape View File

@ -30,5 +30,4 @@ This guide describes the simple DIY setup used by Grimes and Bella Poarch to int
1. Start the 01 Desktop Client on your computer. 1. Start the 01 Desktop Client on your computer.
2. Press the remapped button on the macro keypad to activate the 01 AI assistant. 2. Press the remapped button on the macro keypad to activate the 01 AI assistant.
3. Speak into the attached microphone to interact with the AI. 3. Speak into the attached microphone to interact with the AI.

2
docs/setup/introduction.mdx
Unescape View File

@ -4,7 +4,7 @@ description: "The #1 open-source voice interface"
--- ---
<img <img
src="banner.png" src="https://raw.githubusercontent.com/OpenInterpreter/01/main/docs/assets/banner.png"
/> />
The **01** is an open-source platform for conversational devices, inspired by the *Rabbit R1* and *Star Trek* computer. The **01** is an open-source platform for conversational devices, inspired by the *Rabbit R1* and *Star Trek* computer.

Write Preview
Loading…
Cancel
Save