Merge pull request #299 from OpenInterpreter/livekit-docs-update
Docs Update - Livekit and Light Serverpull/300/head
killian
1 year ago
committed by
GitHub
commit
575754ed7f
@ -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
|
||||
```
|
||||
@ -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
|
||||
```
|
||||
@ -0,0 +1,99 @@
|
||||
---
|
||||
title: "Livekit Server"
|
||||
description: "A robust, feature-rich voice server for your 01"
|
||||
---
|
||||
|
||||
## Overview
|
||||
|
||||
[Livekit](https://livekit.io/) is a powerful, open-source WebRTC server and client SDK that enables real-time audio communication. It's designed for applications that require robust, scalable real-time features.
|
||||
|
||||
### Key Features
|
||||
- Scalable architecture
|
||||
- Extensive documentation and community support
|
||||
- SDKs for various languages and platforms (web, mobile, desktop)
|
||||
|
||||
## Getting Started
|
||||
|
||||
### Prerequisites
|
||||
Make sure you have navigated to the `software` directory before proceeding.
|
||||
|
||||
### Installing Livekit
|
||||
|
||||
Before setting up the environment, you need to install Livekit. Follow the instructions for your operating system:
|
||||
|
||||
- **macOS**:
|
||||
```bash
|
||||
brew install livekit
|
||||
```
|
||||
|
||||
- **Linux**:
|
||||
```bash
|
||||
curl -sSL https://get.livekit.io | bash
|
||||
```
|
||||
|
||||
- **Windows**:
|
||||
Download the latest release from: [Livekit Releases](https://github.com/livekit/livekit/releases/tag/v1.7.2)
|
||||
|
||||
### Environment Setup
|
||||
|
||||
1. Create a `.env` file in the `/software` directory with the following content:
|
||||
|
||||
```env
|
||||
ELEVEN_API_KEY=your_eleven_labs_api_key
|
||||
DEEPGRAM_API_KEY=your_deepgram_api_key
|
||||
NGROK_AUTHTOKEN=your_ngrok_auth_token
|
||||
```
|
||||
|
||||
Replace the placeholders with your actual API keys.
|
||||
|
||||
<CardGroup cols={3}>
|
||||
<Card title="Eleven Labs" icon="microphone" href="https://beta.elevenlabs.io">
|
||||
Get your Eleven Labs API key for text-to-speech
|
||||
</Card>
|
||||
<Card title="Deepgram" icon="waveform-lines" href="https://console.deepgram.com">
|
||||
Obtain your Deepgram API key for speech recognition
|
||||
</Card>
|
||||
<Card title="Ngrok" icon="wifi" href="https://dashboard.ngrok.com">
|
||||
Sign up for Ngrok and get your auth token
|
||||
</Card>
|
||||
</CardGroup>
|
||||
|
||||
### Starting the Server
|
||||
|
||||
To start the Livekit server, run the following command:
|
||||
|
||||
```bash
|
||||
poetry run 01 --server livekit
|
||||
```
|
||||
|
||||
<Note>
|
||||
Currently, our Livekit server only works with Deepgram and Eleven Labs. We are working to introduce all-local functionality as soon as possible. By setting your profile (see [Configure Your Profile](/software/configure)), you can still change your LLM to be a local LLM, but the `interpreter.tts` value will be ignored for the Livekit server.
|
||||
</Note>
|
||||
|
||||
## 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.
|
||||
|
||||
## SDK Integration
|
||||
|
||||
Livekit provides SDKs for various programming languages and platforms, allowing you to easily integrate real-time communication features into your applications.
|
||||
|
||||
### Available SDKs
|
||||
|
||||
- JavaScript/TypeScript
|
||||
- React
|
||||
- React Native
|
||||
- iOS (Swift)
|
||||
- Android (Kotlin)
|
||||
- Flutter
|
||||
- Unity
|
||||
|
||||
<Card
|
||||
title="Explore Livekit SDKs"
|
||||
icon="code"
|
||||
href="https://docs.livekit.io/client-sdk-js/"
|
||||
>
|
||||
Find documentation and integration guides for all Livekit SDKs.
|
||||
</Card>
|
||||
Loading…
Reference in new issue