Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Direct users to esp-webrtc-solution repo #30

Closed
wants to merge 1 commit into from
Closed
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
28 changes: 0 additions & 28 deletions .github/workflows/build.yaml

This file was deleted.

13 changes: 0 additions & 13 deletions .github/workflows/clang-format-check.yml

This file was deleted.

36 changes: 0 additions & 36 deletions CMakeLists.txt

This file was deleted.

47 changes: 6 additions & 41 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,46 +1,11 @@
# Open RealtimeAPI Embedded SDK
# OpenAI Realtime API Embedded SDK

# Table of Contents
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.

- [Docs](#docs)
- [Installation](#installation)
- [Usage](#usage)
### Espressif

## Platform/Device Support
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.

This SDK has been developed tested on a `esp32s3` and `linux`. You don't need any physical hardware
to run this SDK. You can use it from Linux directly.
## License

To use it on hardware purchase either of these microcontrollers. Others may work, but this is what
has been developed against.

* [Freenove ESP32-S3-WROOM](https://www.amazon.com/gp/product/B0BMQ8F7FN)
* [Sonatino - ESP32-S3 Audio Development Board](https://www.amazon.com/gp/product/B0BVY8RJNP)

You can get a ESP32S3 for much less money on eBay/AliExpress.

## Installation

Call `set-target` with the platform you are targetting. Today only `linux` and `esp32s3` are supported.
* `idf.py set-target esp32s3`

Configure device specific settings. None needed at this time
* `idf.py menuconfig`

Set your Wifi SSID + Password as env variables
* `export WIFI_SSID=foo`
* `export WIFI_PASSWORD=bar`
* `export OPENAI_API_KEY=bing`

Build
* `idf.py build`

If you built for `esp32s3` run the following to flash to the device
* `sudo -E idf.py flash`

If you built for `linux` you can run the binary directly
* `./build/src.elf`

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

## Usage
MIT
1 change: 0 additions & 1 deletion components/esp-libopus
Submodule esp-libopus deleted from 260b16
1 change: 0 additions & 1 deletion components/esp-protocols
Submodule esp-protocols deleted from b65cff
19 changes: 0 additions & 19 deletions components/peer/CMakeLists.txt

This file was deleted.

1 change: 0 additions & 1 deletion components/srtp
Submodule srtp deleted from f39a4a
10 changes: 0 additions & 10 deletions dependencies.lock

This file was deleted.

1 change: 0 additions & 1 deletion deps/libpeer
Submodule libpeer deleted from 3c8a8b
6 changes: 0 additions & 6 deletions partitions.csv

This file was deleted.

31 changes: 0 additions & 31 deletions sdkconfig.defaults

This file was deleted.

22 changes: 0 additions & 22 deletions src/CMakeLists.txt

This file was deleted.

97 changes: 0 additions & 97 deletions src/http.cpp

This file was deleted.

3 changes: 0 additions & 3 deletions src/idf_component.yml

This file was deleted.

32 changes: 0 additions & 32 deletions src/main.cpp

This file was deleted.

13 changes: 0 additions & 13 deletions src/main.h

This file was deleted.

144 changes: 0 additions & 144 deletions src/media.cpp

This file was deleted.

113 changes: 0 additions & 113 deletions src/webrtc.cpp

This file was deleted.

61 changes: 0 additions & 61 deletions src/wifi.cpp

This file was deleted.