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

omi SDK ($1100) #2073

Open
kodjima33 opened this issue Mar 25, 2025 · 4 comments
Open

omi SDK ($1100) #2073

kodjima33 opened this issue Mar 25, 2025 · 4 comments

Comments

@kodjima33
Copy link
Collaborator

kodjima33 commented Mar 25, 2025

omi needs an SDK so that developers could build directly with the omi device without our app

best SDK examples

SDKs we need:

  • python
  • swift
  • react native

How should it be for users (please disagree with me)

  1. install sdk (smth like pip install omi)
  2. connect device to computer / mobile phone
  3. Start streaming audio bytes and get battery level
  4. the user sees real-time transcription

--
thinh's comment: update the requirements #2073 (comment)

Minimum requirements(2):

  1. Build an SDK that can connect with the Omi device and perform the current actions that the Omi AI app has - focus on mic, button, battery. Code: https://github.com/BasedHardware/omi/blob/main/app/lib/services/devices/omi_connection.dart

  2. Build examples for using the SDK to:

  • Stream audio bytes from the Omi device and send it to the Deepgram API to receive the transcript.
  • Stream audio bytes from the Omi device and save it locally.
  • Trigger the button click (hold the button, check the Omi AI app with Omi device firmware 2.0.8) and capture the audio bytes, then send it to Deepgram to receive the transcript.
  • Listen to the battery level of the Omi device and notify the user if the battery level is < 20%.

Nice to have on the first version of omi SDK (v0.0.1):

  • Work with sdcard (storage)
  • Work with speaker, haptic
  • Work with accel(imu 6dots)
@kodjima33 kodjima33 moved this to TODO (This week) in omi TODO / bounties Mar 25, 2025
@beastoin
Copy link
Collaborator

Minimum requirements(2):

  1. Build an SDK that can connect with the Omi device and perform the current actions that the Omi AI app has - focus on mic, button, battery. Code: https://github.com/BasedHardware/omi/blob/main/app/lib/services/devices/omi_connection.dart

  2. Build examples for using the SDK to:

  • Stream audio bytes from the Omi device and send it to the Deepgram API to receive the transcript.
  • Stream audio bytes from the Omi device and save it locally.
  • Trigger the button click (hold the button, check the Omi AI app with Omi device firmware 2.0.8) and capture the audio bytes, then send it to Deepgram to receive the transcript.
  • Listen to the battery level of the Omi device and notify the user if the battery level is < 20%.

Nice to have on the first version of omi SDK (v0.0.1):

  • Work with sdcard (storage)
  • Work with speaker, haptic
  • Work with accel(imu 6dots)

@kodjima33 kodjima33 changed the title omi SDK omi SDK ($1100) Mar 25, 2025
@AnkushMalaker
Copy link

The python SDK only works for macos due to pyobjc dependency.

PyObjC is specifically designed for macOS and does not support other operating systems like Linux or Windows.

Is this dependency required?

@ibrahimnd2000
Copy link

This issue will need access to the omi device right ?

@beastoin beastoin moved this from TODO (This week) to In progress in omi TODO / bounties Mar 27, 2025
@kodjima33
Copy link
Collaborator Author

completed

@kodjima33 kodjima33 moved this from In progress to Done in omi TODO / bounties Mar 28, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: Done
Development

No branches or pull requests

4 participants