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
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:
- First activate the virtual environment, this command must always be run before using the python SDK:
source idun_env/bin/activate
- After the environment is activated, install the Python SDK using the following command:
pip install idun-guardian-sdk
- 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)
1 maintainer
Metadata
1 maintainer
Release files for idun-guardian-sdk 0.1.25
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| idun_guardian_sdk-0.1.25.tar.gz | 24.0 kB | Without provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| idun_guardian_sdk-0.1.25-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 52.8 kB
Release files / idun_guardian_sdk-0.1.25.tar.gz
| Download URL | idun_guardian_sdk-0.1.25.tar.gz |
|---|---|
| Size | 24.0 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
13c1d6bfa1eee8cd0da3536de41f726b4e49726916e33c6f10674951d29c11ad
|
|
BLAKE2b-256 checksum How to use checksums |
9b9041ccafdd50fde22b29ce007856c49ebbea24fe9041a01274db282ed2856f
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/2.5.1 CPython/3.10.22 Linux/7.0.0-1017-azure
|
Release files / idun_guardian_sdk-0.1.25-py3-none-any.whl
| Download URL | idun_guardian_sdk-0.1.25-py3-none-any.whl |
|---|---|
| Size | 28.8 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
0e5f26651df27193452d302dd827c2a3ebad666f42cd0d9349d647edb1bfd540
|
|
BLAKE2b-256 checksum How to use checksums |
6b37a408100e794d05c03c9a549ea5853988ab9bc845050d05b33b90969987a6
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/2.5.1 CPython/3.10.22 Linux/7.0.0-1017-azure
|
Security for idun-guardian-sdk 0.1.25
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
