IDUN Guardian Python 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.

Python version

3.9 - 3.13

Installation

pip install idun-guardian-sdk

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 from PyPI:

   pip install idun-guardian-sdk
   

Contents:

• Getting started
  • About the IDUN Guardian SDK
  • Pre Recording
  • Recording
  • Post Recording
• Example Scripts
  • Check Battery
  • Check Impedance
  • Check Impedance For a Specific Time
  • Delete Recording
  • Download Data
  • Download Daytime Report
  • Download Sleep Report
  • Get Recordings
  • Record Data
  • Record Data and Subscribe to Realtime Insights and Predictions
  • Stream Data to LSL
  • Stream Data to LSL and Check Battery
• Demo Tutorials
  • Hands-Free Spotify Control
  • Control Philips Hue Lights with our Eye Movement Classifier
  • Visualize Real-Time Data and Predictions from the IDUN Guardian
  • Brain-Art demo on Touchdesigner with the IDUN Guardian
• Hints on Data Analysis
  • What data do we get from the Guardian Earbud?
  • What’s the difference between raw EEG and filtered EEG?
  • How do I process raw EEG data?
  • How do I know if my EEG data is clean?
  • Where can I find public data for analysis?
• idun_guardian_sdk
  • GuardianClient
  • GuardianHttpAPI
  • GuardianRecording
  • GuardianBLE
  • FileTypes
  • APIRequestError
• Index

About us

For more information, visit our website: IDUN Technologies