-
Notifications
You must be signed in to change notification settings - Fork 522
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
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.
- Loading branch information
1 parent
4a69ab1
commit 8b9aa68
Showing
8 changed files
with
82 additions
and
19 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 | ||
``` |
File renamed without changes.