Skip to content

Commit 474f6d1

Browse files
Direct users to Espressif implementation
1 parent 464a9f0 commit 474f6d1

20 files changed

+5
-649
lines changed

.gitignore

Lines changed: 0 additions & 4 deletions
This file was deleted.

.gitmodules

Lines changed: 0 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +0,0 @@
1-
[submodule "components/srtp"]
2-
path = components/srtp
3-
url = https://[email protected]/sepfy/esp_ports
4-
[submodule "deps/libpeer"]
5-
path = deps/libpeer
6-
url = https://github.com/sean-der/libpeer
7-
[submodule "components/esp-libopus"]
8-
path = components/esp-libopus
9-
url = https://github.com/XasWorks/esp-libopus.git
10-
[submodule "components/esp-protocols"]
11-
path = components/esp-protocols
12-
url = https://github.com/espressif/esp-protocols.git

CMakeLists.txt

Lines changed: 0 additions & 36 deletions
This file was deleted.

README.md

Lines changed: 5 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -1,46 +1,9 @@
1-
# Open RealtimeAPI Embedded SDK
1+
# Open Realtime API Embedded
22

3-
# Table of Contents
3+
This repo contains links to use the [OpenAI Realtime API](https://platform.openai.com/docs/guides/realtime) with [WebRTC](https://platform.openai.com/docs/guides/realtime-webrtc) on different embedded platforms.
44

5-
- [Docs](#docs)
6-
- [Installation](#installation)
7-
- [Usage](#usage)
5+
## Espressif (ESP32)
86

9-
## Platform/Device Support
7+
Espressif maintains a offical example at [openai_demo](https://github.com/espressif/esp-webrtc-solution/tree/main/solutions/openai_demo).
108

11-
This SDK has been developed tested on a `esp32s3` and `linux`. You don't need any physical hardware
12-
to run this SDK. You can use it from Linux directly.
13-
14-
To use it on hardware purchase either of these microcontrollers. Others may work, but this is what
15-
has been developed against.
16-
17-
* [Freenove ESP32-S3-WROOM](https://www.amazon.com/gp/product/B0BMQ8F7FN)
18-
* [Sonatino - ESP32-S3 Audio Development Board](https://www.amazon.com/gp/product/B0BVY8RJNP)
19-
20-
You can get a ESP32S3 for much less money on eBay/AliExpress.
21-
22-
## Installation
23-
24-
Call `set-target` with the platform you are targetting. Today only `linux` and `esp32s3` are supported.
25-
* `idf.py set-target esp32s3`
26-
27-
Configure device specific settings. None needed at this time
28-
* `idf.py menuconfig`
29-
30-
Set your Wifi SSID + Password as env variables
31-
* `export WIFI_SSID=foo`
32-
* `export WIFI_PASSWORD=bar`
33-
* `export OPENAI_API_KEY=bing`
34-
35-
Build
36-
* `idf.py build`
37-
38-
If you built for `esp32s3` run the following to flash to the device
39-
* `sudo -E idf.py flash`
40-
41-
If you built for `linux` you can run the binary directly
42-
* `./build/src.elf`
43-
44-
See [build.yaml](.github/workflows/build.yaml) for a Docker command to do this all in one step.
45-
46-
## Usage
9+
The original implementation of the OpenAI Embedded SDK is still available on the `esp32` branch.

components/esp-libopus

Lines changed: 0 additions & 1 deletion
This file was deleted.

components/esp-protocols

Lines changed: 0 additions & 1 deletion
This file was deleted.

components/peer/CMakeLists.txt

Lines changed: 0 additions & 19 deletions
This file was deleted.

components/srtp

Lines changed: 0 additions & 1 deletion
This file was deleted.

dependencies.lock

Lines changed: 0 additions & 10 deletions
This file was deleted.

deps/libpeer

Lines changed: 0 additions & 1 deletion
This file was deleted.

0 commit comments

Comments
 (0)