Mike Bird
6 months ago
parent
7bafa0db28
commit
ca28f165b5
@ -1,12 +0,0 @@
|
|||||||
---
|
|
||||||
title: "01 Light"
|
|
||||||
description: "Build your 01 Light"
|
|
||||||
---
|
|
||||||
|
|
||||||
## ESP32 client
|
|
||||||
|
|
||||||
Instructions to set up your ESP32 client can be found <a href="/client/setup">here</a>
|
|
||||||
|
|
||||||
## Suppliementary files
|
|
||||||
|
|
||||||
For CAD files, wiring diagram, and images, please visit the [01 Light hardware repository](https://github.com/OpenInterpreter/01/tree/main/hardware/light).
|
|
||||||
@ -0,0 +1,39 @@
|
|||||||
|
---
|
||||||
|
title: "Getting Started"
|
||||||
|
description: "Preparing your machine"
|
||||||
|
---
|
||||||
|
|
||||||
|
## Prerequisites
|
||||||
|
|
||||||
|
There are a few packages that need to be installed in order to run 01OS on your computer
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# Install poetry
|
||||||
|
curl -sSL https://install.python-poetry.org | python3 -
|
||||||
|
```
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# MacOS
|
||||||
|
brew install portaudio ffmpeg cmake
|
||||||
|
|
||||||
|
# Ubuntu (wayland not supported, only ubuntu 20.04 and below)
|
||||||
|
sudo apt-get install portaudio19-dev ffmpeg cmake
|
||||||
|
|
||||||
|
# Windows
|
||||||
|
On Windows you will need to install the following:
|
||||||
|
```
|
||||||
|
|
||||||
|
- [Git for Windows](https://git-scm.com/download/win).
|
||||||
|
- [virtualenv](https://virtualenv.pypa.io/en/latest/installation.html) or [MiniConda](https://docs.anaconda.com/free/miniconda/miniconda-install/) to manage virtual environments.
|
||||||
|
- [Chocolatey](https://chocolatey.org/install#individual) to install the required packages.
|
||||||
|
- [Microsoft C++ Build Tools](https://visualstudio.microsoft.com/visual-cpp-build-tools):
|
||||||
|
- Choose [**Download Build Tools**](https://visualstudio.microsoft.com/visual-cpp-build-tools/).
|
||||||
|
- Run the downloaded file **vs_BuildTools.exe**.
|
||||||
|
- In the installer, select **Workloads** > **Desktop & Mobile** > **Desktop Development with C++**.
|
||||||
|
|
||||||
|
With these installed, you can run the following commands in a **PowerShell terminal as an administrator**:
|
||||||
|
|
||||||
|
```powershell
|
||||||
|
# Install the required packages
|
||||||
|
choco install -y ffmpeg
|
||||||
|
```
|
||||||
@ -1,93 +0,0 @@
|
|||||||
---
|
|
||||||
title: 'Setup'
|
|
||||||
description: 'Get your 01 up and running'
|
|
||||||
---
|
|
||||||
|
|
||||||
## Captive portal
|
|
||||||
|
|
||||||
To connect your 01, you will use the captive portal.
|
|
||||||
|
|
||||||
1. Turn on your computer or laptop and connect to the '01 light' Wi-Fi network.
|
|
||||||
2. Enter your Wi-Fi/hotspot name and password in the captive portal page.
|
|
||||||
3. Enter the server URL generated on their computer and hit 'Connect'.
|
|
||||||
|
|
||||||
Now you're connected and ready to go!
|
|
||||||
|
|
||||||
# Local 01OS
|
|
||||||
|
|
||||||
## Prerequisites
|
|
||||||
|
|
||||||
There are a few packages that need to be installed in order to run 01OS on your computer
|
|
||||||
|
|
||||||
```bash
|
|
||||||
# MacOS
|
|
||||||
brew install portaudio ffmpeg cmake
|
|
||||||
|
|
||||||
# Ubuntu (wayland not supported, only ubuntu 20.04 and below)
|
|
||||||
sudo apt-get install portaudio19-dev ffmpeg cmake
|
|
||||||
|
|
||||||
# Install poetry
|
|
||||||
curl -sSL https://install.python-poetry.org | python3 -
|
|
||||||
```
|
|
||||||
|
|
||||||
#### Windows
|
|
||||||
|
|
||||||
On Windows you will need to install the following:
|
|
||||||
|
|
||||||
- [Git for Windows](https://git-scm.com/download/win).
|
|
||||||
- [virtualenv](https://virtualenv.pypa.io/en/latest/installation.html) or [MiniConda](https://docs.anaconda.com/free/miniconda/miniconda-install/) to manage virtual environments.
|
|
||||||
- [Chocolatey](https://chocolatey.org/install#individual) to install the required packages.
|
|
||||||
- [Microsoft C++ Build Tools](https://visualstudio.microsoft.com/visual-cpp-build-tools):
|
|
||||||
- Choose [**Download Build Tools**](https://visualstudio.microsoft.com/visual-cpp-build-tools/).
|
|
||||||
- Run the downloaded file **vs_BuildTools.exe**.
|
|
||||||
- In the installer, select **Workloads** > **Desktop & Mobile** > **Desktop Development with C++**.
|
|
||||||
|
|
||||||
With these installed, you can run the following commands in a **PowerShell terminal as an administrator**:
|
|
||||||
|
|
||||||
```powershell
|
|
||||||
# Install the required packages
|
|
||||||
choco install -y ffmpeg
|
|
||||||
```
|
|
||||||
|
|
||||||
## Install 01
|
|
||||||
|
|
||||||
To install the 01 CLI
|
|
||||||
|
|
||||||
```bash
|
|
||||||
# Clone the repo and navigate into the 01OS directory
|
|
||||||
git clone https://github.com/OpenInterpreter/01.git
|
|
||||||
```
|
|
||||||
|
|
||||||
## Run the 01
|
|
||||||
|
|
||||||
In order to run 01 on your computer, use [Poetry](https://python-poetry.org/docs/#installing-with-the-official-installer).
|
|
||||||
|
|
||||||
Navigate to the project's software directory:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
cd software
|
|
||||||
```
|
|
||||||
|
|
||||||
Install your project along with its dependencies in a virtual environment managed by Poetry.
|
|
||||||
|
|
||||||
```bash
|
|
||||||
poetry install
|
|
||||||
```
|
|
||||||
|
|
||||||
Run your local version of 01 with:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
poetry run 01
|
|
||||||
```
|
|
||||||
|
|
||||||
## Swap out service providers
|
|
||||||
|
|
||||||
You have the ability to set your <a href="/services/language-model">LLM</a>, <a href="/services/speech-to-text">STT</a>, and <a href="/services/text-to-speech">TTS</a> service providers
|
|
||||||
|
|
||||||
## Server setup
|
|
||||||
|
|
||||||
You are able to run just the <a href="/server/setup">server</a>.
|
|
||||||
|
|
||||||
## Client setup
|
|
||||||
|
|
||||||
You are able to run just the <a href="/client/setup">client</a>.
|
|
||||||
@ -0,0 +1,22 @@
|
|||||||
|
---
|
||||||
|
title: "01 Light"
|
||||||
|
description: "Use your 01 Light"
|
||||||
|
---
|
||||||
|
|
||||||
|
## Captive portal
|
||||||
|
|
||||||
|
To connect your 01, you will use the captive portal.
|
||||||
|
|
||||||
|
1. Turn on your computer or laptop and connect to the '01 light' Wi-Fi network.
|
||||||
|
2. Enter your Wi-Fi/hotspot name and password in the captive portal page.
|
||||||
|
3. Enter the server URL generated on their computer and hit 'Connect'.
|
||||||
|
|
||||||
|
Now you're connected and ready to go!
|
||||||
|
|
||||||
|
## ESP32 client
|
||||||
|
|
||||||
|
Instructions to set up your ESP32 client can be found <a href="/client/setup">here</a>
|
||||||
|
|
||||||
|
## Suppliementary files
|
||||||
|
|
||||||
|
For CAD files, wiring diagram, and images, please visit the [01 Light hardware repository](https://github.com/OpenInterpreter/01/tree/main/hardware/light).
|
||||||
@ -0,0 +1,41 @@
|
|||||||
|
---
|
||||||
|
title: "Installation"
|
||||||
|
description: "Get your 01 up and running"
|
||||||
|
---
|
||||||
|
|
||||||
|
## Install 01
|
||||||
|
|
||||||
|
To install the 01 software
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# Clone the repo and navigate into the 01OS directory
|
||||||
|
git clone https://github.com/OpenInterpreter/01.git
|
||||||
|
```
|
||||||
|
|
||||||
|
## Run the 01
|
||||||
|
|
||||||
|
In order to run 01 on your computer, use [Poetry](https://python-poetry.org/docs/#installing-with-the-official-installer).
|
||||||
|
|
||||||
|
Navigate to the project's software directory:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
cd software
|
||||||
|
```
|
||||||
|
|
||||||
|
Install your project along with its dependencies in a virtual environment managed by Poetry.
|
||||||
|
|
||||||
|
```bash
|
||||||
|
poetry install
|
||||||
|
```
|
||||||
|
|
||||||
|
Run your local version of 01 with:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
poetry run 01
|
||||||
|
```
|
||||||
|
|
||||||
|
Use 01 with your <a href="/hardware/01-light">01 Light</a>
|
||||||
|
|
||||||
|
```bash
|
||||||
|
poetry run 01 --server
|
||||||
|
```
|
||||||
@ -0,0 +1,4 @@
|
|||||||
|
---
|
||||||
|
title: "FAQ"
|
||||||
|
description: "Frequently Asked Questions"
|
||||||
|
---
|
||||||
Loading…
Reference in new issue