You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
01/docs/client/setup.mdx

48 lines
1.4 KiB

10 months ago
---
title: "Setup"
description: "Get your 01 client up and running"
---
(lets you pick from a grid of avaliable clients)
## ESP32 Playback
To set up audio recording + playback on the ESP32 (M5 Atom), do the following:
1. Open Arduino IDE, and open the client/client.ino file
2. Go to Tools -> Board -> Boards Manager, search "esp32", then install the boards by Arduino and Espressif
3. Go to Tools -> Manage Libraries, then install the following:
- M5Atom by M5Stack [Reference](https://www.arduino.cc/reference/en/libraries/m5atom/)
- WebSockets by Markus Sattler [Reference](https://www.arduino.cc/reference/en/libraries/websockets/)
4. The board needs to connect to WiFi. Once you flash, connect to ESP32 wifi "captive" which will get wifi details. Once it connects, it will ask you to enter 01OS server address in the format "domain.com:port" or "ip:port". Once its able to connect you can use the device.
5. To flash the .ino to the board, connect the board to the USB port, select the port from the dropdown on the IDE, then select the M5Atom board (or M5Stack-ATOM if you have that). Click on upload to flash the board.
## Desktop
### Server with a client
```bash
# install dependencies
poetry install
# run start.py with no args
poetry run 01
```
### Client only
```bash
poetry run 01 --client
```
### Flags
- `--client`
Run client.
- `--client-type TEXT`
Specify the client type.
Default: `auto`.