idun-guardian-sdk 0.1.23

No project description provided

Idun Guardian SDK

Idun Guardian SDK is a Python package for interacting with the Guardian Earbud. It enables device search, battery monitoring, impedance streaming, real-time data collection, and report generation.

📖 Read the full documentation here

🎧 Have a look at the user manual here

🔗 Learn more about us here

---

Main features

• 🔍 Search for Device: Locate the Guardian Earbud.
• 🔋 Check Battery: Monitor battery levels.
• 📡 Stream Impedance: Analyze impedance in real-time.
• 🎧 Connect & Record Data:
  • Real-time insights (raw & filtered EEG)
  • Real-time predictions (FFT, jaw clench, eye movements, quality score)
• 💾 Download & Manage Data:
  • Retrieve recorded sessions
  • Delete unwanted recordings
• 📊 Generate Reports:
  • Sleep report
  • Daytime report

---

Python version

3.9 - 3.13

---

Installation

It is advised to create a new Python Virtual Environment:

  python -m venv idun_env
  source idun_env/bin/activate

Alternatively you can use third party tools such as Conda or Pipenv:

1. First activate the virtual environment, this command must always be run before using the python SDK:

  source idun_env/bin/activate

2. After the environment is activated, install the Python SDK using the following command:

  pip install idun-guardian-sdk

3. After installing the package, make sure that the dependencies are correctly installed by running the following command and inspecting the packages installed in the terminal output:

  pip list

You should see as output a package named idun-guardian-sdk

---

Quick Start

📖 Read the full documentation here

Authentication

To use the API, set your token:

export IDUN_API_TOKEN=my-api-token

Or initialize the client in Python:

from idun_guardian_sdk import GuardianClient
client = GuardianClient(api_token="my-api-token")

Search for Device

import asyncio
from idun_guardian_sdk import GuardianClient

client = GuardianClient()
device_address = asyncio.run(client.search_device())

Check Battery Level

battery_level = asyncio.run(client.check_battery())
print(f"Battery Level: {battery_level}%")

Stream Impedance

asyncio.run(client.stream_impedance(mains_freq_60hz=False))

Start a Recording

RECORDING_TIMER = 600  # 10 minutes
asyncio.run(client.start_recording(recording_timer=RECORDING_TIMER))

Retrieve & Download Recording

recordings = client.get_recordings(status="COMPLETED", limit=10)
recording_id = recordings[0]['id']
client.download_file(recording_id=recording_id)

Generate Reports

client.generate_and_download_sleep_report(recording_id=recording_id)