|
1 |
| -# Open RealtimeAPI Embedded SDK |
| 1 | +# OpenAI Realtime API Embedded SDK |
2 | 2 |
|
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. |
4 | 4 |
|
5 |
| -- [Docs](#docs) |
6 |
| -- [Installation](#installation) |
7 |
| -- [Usage](#usage) |
| 5 | +### Espressif |
8 | 6 |
|
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. |
10 | 8 |
|
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 |
13 | 10 |
|
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 |
0 commit comments