Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
43 changes: 42 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,4 +43,45 @@ If you built for `linux` you can run the binary directly

See [build.yaml](.github/workflows/build.yaml) for a Docker command to do this all in one step.

## Usage
### Full Installation Guide
#### Export Wifi Credentials and OpenAI API Key
You need to export your Wifi credentials and OpenAI API Key as environment variables. This is required for the SDK to connect to the internet and access OpenAI services.

```bash
export WIFI_SSID="your_wifi_ssid"
export WIFI_PASSWORD="your_wifi_password"
export OPENAI_API_KEY="your_openai_api_key"
```

#### Install correct version of ESP-IDF
```bash
mkdir ~/esp
cd ~/esp
git clone -b release/v5.5 https://github.com/espressif/esp-idf.git esp-idf-v5.5.0
cd esp-idf-v5.5.0
./install.sh
chmod 777 ./export.sh
./export.sh
```

#### Test IDF
`idf.py --version`
The above didn't work for me so I included this line in ~/.bashrc and reloaded the terminal: `. $HOME/esp/esp-idf-v5.5.0/export.sh`

#### Clone repo including dependencies
```bash
git clone --recursive https://github.com/DFRobot/openai-realtime-embedded-sdk.git
cd openai-realtime-embedded-sdk
```

#### Set target
`idf.py set-target esp32s3`

#### Build
`idf.py build`

#### Allow idf.py flash to be used with current user
`sudo usermod -a -G dialout $USER`

#### Flash to device
`idf.py flash`