idun-guardian-sdk

Contents:

  • Getting started
    • About the IDUN Guardian SDK
      • What can I do with the IDUN Guardian SDK?
      • How do I record data with the IDUN Guardian SDK?
      • What is the general process for recording data?
    • About Asynchronous Operations with Asyncio
      • Basic usage of asyncio
      • Multiple asynchronous operations
    • Pre Recording
      • Search the earbud manually
      • Setup your API Token
      • Connect to the device
      • Check battery level
      • Check impedance values
    • Recording
      • Start a recording
      • Subscribe to real time insights and predictions
        • Functions
        • Handler
        • Message Format
        • Prediction Results format
        • Examples
      • Stream data to LSL
    • Post Recording
      • Get all recorded info
      • Download recording
      • Generate Sleep Report for a Recording
      • Generate Daytime Report for a Recording
      • Disconnect from the device
  • 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
  • API reference
    • GuardianClient
      • GuardianClient.check_battery()
      • GuardianClient.connect_device()
      • GuardianClient.delete_recording()
      • GuardianClient.disconnect_device()
      • GuardianClient.download_daytime_report_raw_data()
      • GuardianClient.download_file()
      • GuardianClient.download_sleep_report_raw_data()
      • GuardianClient.end_recording()
      • GuardianClient.generate_and_download_daytime_report()
      • GuardianClient.generate_and_download_sleep_report()
      • GuardianClient.get_device_mac_address()
      • GuardianClient.get_recording_id()
      • GuardianClient.get_recording_reports()
      • GuardianClient.get_recordings()
      • GuardianClient.get_user_info()
      • GuardianClient.search_device()
      • GuardianClient.start_recording()
      • GuardianClient.stop_impedance()
      • GuardianClient.stream_impedance()
      • GuardianClient.subscribe_live_insights()
      • GuardianClient.subscribe_realtime_predictions()
      • GuardianClient.update_recording_display_name()
      • GuardianClient.update_recording_tags()
      • GuardianClient.api_token
      • GuardianClient.guardian_ble
      • GuardianClient.guardian_http_api
      • GuardianClient.guardian_recording
    • GuardianHttpAPI
      • GuardianHttpAPI.delete_recording()
      • GuardianHttpAPI.download_daytime_report()
      • GuardianHttpAPI.download_daytime_report_raw_data()
      • GuardianHttpAPI.download_recording()
      • GuardianHttpAPI.download_sleep_report()
      • GuardianHttpAPI.download_sleep_report_by_id()
      • GuardianHttpAPI.download_sleep_report_raw_data()
      • GuardianHttpAPI.end_recording()
      • GuardianHttpAPI.generate_daytime_report()
      • GuardianHttpAPI.generate_sleep_report()
      • GuardianHttpAPI.get_recording_reports()
      • GuardianHttpAPI.get_recordings()
      • GuardianHttpAPI.get_user_info()
      • GuardianHttpAPI.save_file_from_s3()
      • GuardianHttpAPI.update_recording_display_name()
      • GuardianHttpAPI.update_recording_tags()
    • GuardianRecording
      • GuardianRecording.set_init_recording()
      • GuardianRecording.start_streaming()
    • GuardianBLE
      • GuardianBLE.connect_device()
      • GuardianBLE.connect_to_device()
      • GuardianBLE.disconnect_device()
      • GuardianBLE.get_device_mac()
      • GuardianBLE.read_battery_level()
      • GuardianBLE.run_ble_record()
      • GuardianBLE.search_device()
      • GuardianBLE.stream_impedance()
    • FileTypes
      • FileTypes.EEG
      • FileTypes.IMPEDANCE
      • FileTypes.IMU
    • APIRequestError
  • Troubleshooting
    • Debugging
    • Bluetooth connection issues
    • Support
  • Hints on Data Analysis
    • What data do we get from the Guardian Earbud?
      • EEG
      • IMU
    • What’s the difference between raw EEG and filtered EEG?
      • Raw EEG
      • 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?
  • Public Demos Tutorials
    • Hands-Free Spotify Control
      • Prerequisites and Setup
      • Steps
      • Source Code
    • Control Philips Hue Lights with our Eye Movement Classifier
      • Prerequisites and Setup
      • Steps
      • Source Code
    • Visualize Real-Time Data and Predictions from the IDUN Guardian
      • Prerequisites and Setup
      • Steps
      • Source Code
    • Brain-Art demo on Touchdesigner with the IDUN Guardian
      • Prerequisites and Setup
      • Steps
      • Source Code
  • Index
idun-guardian-sdk
  • Search

© Copyright 2024, IDUN Technologies AG.

Built with Sphinx using a theme provided by Read the Docs.