From b32484e1299384a8c73791492c6da66fc45f57ab Mon Sep 17 00:00:00 2001 From: Mike Bird Date: Thu, 11 Jul 2024 15:57:09 -0400 Subject: [PATCH] Added instructions on how to use custom hardware with the 01 server in hardware documentation. --- docs/hardware/01-light.mdx | 2 +- docs/hardware/custom_hardware.mdx | 12 ++++++++++++ docs/hardware/desktop.mdx | 8 ++++++++ docs/hardware/mobile.mdx | 6 ++++++ docs/mint.json | 2 +- 5 files changed, 28 insertions(+), 2 deletions(-) diff --git a/docs/hardware/01-light.mdx b/docs/hardware/01-light.mdx index 7465ff3..ea4c5ea 100644 --- a/docs/hardware/01-light.mdx +++ b/docs/hardware/01-light.mdx @@ -9,7 +9,7 @@ The Bill of Materials for the 01 Light can be found [here](https://github.com/Op # Chip (ESP32) -The ESP32 needs to be setup to work with 01. We've created the firmware needed, just follow this guide. +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: diff --git a/docs/hardware/custom_hardware.mdx b/docs/hardware/custom_hardware.mdx index 4430d29..d3c00b7 100644 --- a/docs/hardware/custom_hardware.mdx +++ b/docs/hardware/custom_hardware.mdx @@ -2,3 +2,15 @@ title: "Custom Hardware" description: "Control 01 from your own device" --- + +You can build your own custom hardware that uses the 01 server. + +To use 01 with your custom hardware, run the server: + +```bash +poetry run 01 --server +``` + +You may need to set additional parameters via [flags](/software/flags) depending on your setup. + +To transmit audio commands to 01, send LMC audio chunks to the websocket defined by your server. diff --git a/docs/hardware/desktop.mdx b/docs/hardware/desktop.mdx index e27a389..782e006 100644 --- a/docs/hardware/desktop.mdx +++ b/docs/hardware/desktop.mdx @@ -2,3 +2,11 @@ title: "Desktop" description: "Control 01 from your computer" --- + + Make sure that you have navigated to the `software` directory. + +To run 01 with your computer's microphone and speaker, run: + +```bash +poetry run 01 +``` diff --git a/docs/hardware/mobile.mdx b/docs/hardware/mobile.mdx index 816a404..e83bcf7 100644 --- a/docs/hardware/mobile.mdx +++ b/docs/hardware/mobile.mdx @@ -2,3 +2,9 @@ title: "iOS & Android" description: "Control 01 from your mobile phone" --- + +1. our react-native WIP app, and mostly is similar to its README that explains how to use it with Expo, and + https://github.com/OpenInterpreter/01/tree/main/software/source/clients/mobile + +2. the community native iOS app by eladekkal. + https://github.com/OpenInterpreter/01/tree/main/software/source/clients/ios diff --git a/docs/mint.json b/docs/mint.json index 5c116d4..3bdf7f4 100644 --- a/docs/mint.json +++ b/docs/mint.json @@ -52,7 +52,7 @@ "group": "Hardware Setup", "pages": [ "hardware/01-light", - "hardware/custom-hardware", + "hardware/custom_hardware", "hardware/desktop", "hardware/mobile" ]