https://github.com/openai/openai-realtime-embedded-sdk

Skip to content

Navigation Menu

Toggle navigation
 
Sign in

  * Product
      +  
        GitHub Copilot
        Write better code with AI
      +  
        Security
        Find and fix vulnerabilities
      +  
        Actions
        Automate any workflow
      +  
        Codespaces
        Instant dev environments
      +  
        Issues
        Plan and track work
      +  
        Code Review
        Manage code changes
      +  
        Discussions
        Collaborate outside of code
      +  
        Code Search
        Find more, search less
    Explore
      + All features
      + Documentation
      + GitHub Skills
      + Blog
  * Solutions
    By company size
      + Enterprises
      + Small and medium teams
      + Startups
    By use case
      + DevSecOps
      + DevOps
      + CI/CD
      + View all use cases
    By industry
      + Healthcare
      + Financial services
      + Manufacturing
      + Government
      + View all industries
    View all solutions
  * Resources
    Topics
      + AI
      + DevOps
      + Security
      + Software Development
      + View all
    Explore
      + Learning Pathways
      + White papers, Ebooks, Webinars
      + Customer Stories
      + Partners
      + Executive Insights
  * Open Source
      +  
        GitHub Sponsors
        Fund open source developers
      +  
        The ReadME Project
        GitHub community articles
    Repositories
      + Topics
      + Trending
      + Collections
  * Enterprise
      +  
        Enterprise platform
        AI-powered developer platform
    Available add-ons
      +  
        Advanced Security
        Enterprise-grade security features
      +  
        GitHub Copilot
        Enterprise-grade AI features
      +  
        Premium Support
        Enterprise-grade 24/7 support
  * Pricing

Search or jump to...

Search code, repositories, users, issues, pull requests...

Search
[                    ]
Clear

Search syntax tips

Provide feedback

We read every piece of feedback, and take your input very seriously.

[                    ] [ ] Include my email address so I can be
contacted
Cancel Submit feedback

Saved searches

Use saved searches to filter your results more quickly

Name [                    ] 
Query [                    ]

To see all available qualifiers, see our documentation.

Cancel Create saved search
Sign in
Sign up Reseting focus
You signed in with another tab or window. Reload to refresh your
session. You signed out in another tab or window. Reload to refresh
your session. You switched accounts on another tab or window. Reload
to refresh your session. Dismiss alert
{{ message }}
openai / openai-realtime-embedded-sdk Public

  * Notifications You must be signed in to change notification
    settings
  * Fork 12
  * Star 154

A SDK to using the Realtime API with Microcontrollers like the ESP32

License

MIT license
154 stars 12 forks Branches Tags Activity
Star
Notifications You must be signed in to change notification settings

  * Code
  * Issues 2
  * Pull requests 0
  * Actions
  * Projects 0
  * Security
  * Insights

Additional navigation options

  * Code
  * Issues
  * Pull requests
  * Actions
  * Projects
  * Security
  * Insights

openai/openai-realtime-embedded-sdk

 main
BranchesTags
  
[                    ]
Go to file
Code

Folders and files

       Name                Name          Last commit     Last commit
                                           message          date
Latest commit

 

History

3 Commits
 
.github/workflows   .github/workflows                    
components          components                           
deps                deps                                 
src                 src                                  
.clang-format       .clang-format                        
.gitignore          .gitignore                           
.gitmodules         .gitmodules                          
CMakeLists.txt      CMakeLists.txt                       
LICENSE             LICENSE                              
README.md           README.md                            
dependencies.lock   dependencies.lock                    
partitions.csv      partitions.csv                       
sdkconfig.defaults  sdkconfig.defaults                   
View all files

Repository files navigation

  * README
  * MIT license

Open RealtimeAPI Embedded SDK

 

Table of Contents

 

  * Docs
  * Installation
  * Usage

Platform/Device Support

 

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.

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
  * Sonatino - ESP32-S3 Audio Development Board

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

Installation

 

protoc must be in your path with protobufc installed.

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 for a Docker command to do this all in one step.

Usage

 

About

A SDK to using the Realtime API with Microcontrollers like the ESP32

Resources

Readme

License

MIT license
Activity
Custom properties

Stars

154 stars

Watchers

98 watching

Forks

12 forks
Report repository

Releases

No releases published

Packages 0

No packages published

Languages

  * C++ 78.6%
  * CMake 19.0%
  * C 2.4%

Footer

 (c) 2024 GitHub, Inc.

Footer navigation

  * Terms
  * Privacy
  * Security
  * Status
  * Docs
  * Contact
  * Manage cookies
  * Do not share my personal information

You can't perform that action at this time.