Skip to content

Commit a22ced9

Browse files
Direct users to esp-webrtc-solution repo
1 parent 464a9f0 commit a22ced9

18 files changed

+6
-632
lines changed

CMakeLists.txt

-36
This file was deleted.

README.md

+6-41
Original file line numberDiff line numberDiff line change
@@ -1,46 +1,11 @@
1-
# Open RealtimeAPI Embedded SDK
1+
# OpenAI Realtime API Embedded SDK
22

3-
# Table of Contents
3+
This repo provides instructions on how to use the [OpenAI Realtime API](https://platform.openai.com/docs/guides/realtime) on Microcontrollers and Embedded Platforms. This repository will be expanded as we support more platforms.
44

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

9-
## Platform/Device Support
7+
Espressif provides an example of using the Realtime API with their [esp_webrtc](https://github.com/espressif/esp-webrtc-solution/tree/main/solutions/openai_demo) library.
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.
9+
## License
1310

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
11+
MIT

components/esp-libopus

Submodule esp-libopus deleted from 260b16c

components/esp-protocols

Submodule esp-protocols deleted from b65cff3

components/peer/CMakeLists.txt

-19
This file was deleted.

components/srtp

Submodule srtp deleted from f39a4a2

dependencies.lock

-10
This file was deleted.

deps/libpeer

Submodule libpeer deleted from 3c8a8be

partitions.csv

-6
This file was deleted.

sdkconfig.defaults

-31
This file was deleted.

src/CMakeLists.txt

-22
This file was deleted.

src/http.cpp

-97
This file was deleted.

src/idf_component.yml

-3
This file was deleted.

src/main.cpp

-32
This file was deleted.

src/main.h

-13
This file was deleted.

0 commit comments

Comments
 (0)