Update documentation to include new Livekit and Light server setup guides, remove outdated run guide, and reflect changes to 01 platform introduction and hardware documentation.
parent
f0037fba37
commit
dad2c37395
@ -0,0 +1,16 @@
|
|||||||
|
---
|
||||||
|
title: "Light Server"
|
||||||
|
description: "Run your 01"
|
||||||
|
---
|
||||||
|
|
||||||
|
<Info> Make sure that you have navigated to the `software` directory. </Info>
|
||||||
|
|
||||||
|
The Light server streams bytes of audio to an ESP32 and the Light Python client.
|
||||||
|
|
||||||
|
It is very lightweight.
|
||||||
|
|
||||||
|
To run the Light server:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
poetry run 01 --server light
|
||||||
|
```
|
@ -0,0 +1,23 @@
|
|||||||
|
---
|
||||||
|
title: "Livekit Server"
|
||||||
|
description: "Run your 01"
|
||||||
|
---
|
||||||
|
|
||||||
|
<Info> Make sure that you have navigated to the `software` directory. </Info>
|
||||||
|
|
||||||
|
This server leverages the Livekit SDK and is used for the mobile apps.
|
||||||
|
|
||||||
|
It uses WebRTC for real-time communication and is very robust.
|
||||||
|
|
||||||
|
To run the Livekit server:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
poetry run 01 --server livekit
|
||||||
|
```
|
||||||
|
|
||||||
|
<Note>
|
||||||
|
Speech to Text and Text to Speech are handled by Livekit plugins which
|
||||||
|
requires a Deepgram or ElevenLabs API key.
|
||||||
|
</Note>
|
||||||
|
|
||||||
|
Set env var API keys.
|
@ -1,18 +0,0 @@
|
|||||||
---
|
|
||||||
title: "Run"
|
|
||||||
description: "Run your 01"
|
|
||||||
---
|
|
||||||
|
|
||||||
<Info> Make sure that you have navigated to the `software` directory. </Info>
|
|
||||||
|
|
||||||
To run the server and the client:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
poetry run 01
|
|
||||||
```
|
|
||||||
|
|
||||||
To run the 01 server:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
poetry run 01 --server
|
|
||||||
```
|
|
Loading…
Reference in new issue