Refactor documentation for server setup, including livekit and light servers, and add information about required dependencies for MacOS and Ubuntu, including PortAudio, FFmpeg, and CMake.
parent
4a69ab1494
commit
8b9aa68633
@ -1,16 +0,0 @@
|
|||||||
---
|
|
||||||
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,19 @@
|
|||||||
|
---
|
||||||
|
title: "Choosing a server"
|
||||||
|
description: "The servers that powers 01"
|
||||||
|
---
|
||||||
|
|
||||||
|
<CardGroup cols={2}>
|
||||||
|
<Card title="Light" href="/software/server/light-server">
|
||||||
|
Light Server
|
||||||
|
</Card>
|
||||||
|
<Card title="Livekit" href="/software/server/livekit">
|
||||||
|
Livekit Server
|
||||||
|
</Card>
|
||||||
|
</CardGroup>
|
||||||
|
|
||||||
|
## Livekit vs. Light Server
|
||||||
|
|
||||||
|
- **Livekit Server**: Designed for devices with higher processing power, such as phones, web browsers, and more capable hardware. It offers a full range of features and robust performance.
|
||||||
|
|
||||||
|
- **Light Server**: We have another lightweight server called the Light server, specifically designed for ESP32 devices. It's optimized for low-power, constrained environments.
|
@ -0,0 +1,28 @@
|
|||||||
|
---
|
||||||
|
title: "Light Server"
|
||||||
|
description: "A lightweight voice server for your 0"
|
||||||
|
---
|
||||||
|
|
||||||
|
## Overview
|
||||||
|
|
||||||
|
The Light server streams bytes of audio to an ESP32 and the Light Python client.
|
||||||
|
|
||||||
|
### Key Features
|
||||||
|
|
||||||
|
- Lightweight
|
||||||
|
- Works with ESP32
|
||||||
|
- Can use local options for Speech-to-Text and Text-to-Speech
|
||||||
|
|
||||||
|
## Getting Started
|
||||||
|
|
||||||
|
### Prerequisites
|
||||||
|
|
||||||
|
Make sure you have navigated to the `software` directory before proceeding.
|
||||||
|
|
||||||
|
### Starting the Server
|
||||||
|
|
||||||
|
To start the Light server, run the following command:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
poetry run 01 --server light
|
||||||
|
```
|
Loading…
Reference in new issue