Capture2Go Python SDK

Guide

  • Getting Started
    • Introduction
    • Installation
    • Minimal Usage Example
    • Recording, Streaming, Real-Time Streaming
  • Examples
    • Minimal Print Example
    • Real-Time Streaming
    • Live Plotting
    • Recording and Downloading Data
    • Downloading and Managing Files
    • Converting Recordings to MATLAB

Reference

  • Main API Reference
    • Device Classes
      • AbstractDevice
        • AbstractDevice.name
        • AbstractDevice.state
        • AbstractDevice.status
        • AbstractDevice.deviceInfo
        • AbstractDevice.connect()
        • AbstractDevice.disconnect()
        • AbstractDevice.init()
        • AbstractDevice.send()
        • AbstractDevice.sendAndAwaitAck()
        • AbstractDevice.addStateListener()
        • AbstractDevice.removeStateListener()
        • AbstractDevice.addDataWithRtListener()
        • AbstractDevice.removeDataWithRtListener()
        • AbstractDevice.addDataListener()
        • AbstractDevice.removeDataListener()
        • AbstractDevice.addPackageListener()
        • AbstractDevice.removePackageListener()
        • AbstractDevice.poll()
        • AbstractDevice.apoll()
      • BleDevice
        • BleDevice.device
        • BleDevice.rssi
      • UsbDevice
      • FilePlaybackDevice
    • Scanning and Connecting
      • BleScanner
        • BleScanner.scan()
      • connect()
    • Parsing
      • Unpacker
        • Unpacker.feed()
        • Unpacker.clear()
        • Unpacker.extractRtPackages()
      • loadBinaryFile()
    • Exceptions
      • DeviceIsRecording
      • DeviceIsStreaming
    • Type Aliases
      • DeviceState
      • StateListener
      • DataListener
      • PackageListener
  • Package Definitions (c2g.pkg)
    • Introduction
    • All Members
      • packages
      • SensorHeader
        • SensorHeader.CMD_GET_DEVICE_INFO
        • SensorHeader.DATA_DEVICE_INFO
        • SensorHeader.CMD_SLEEP
        • SensorHeader.ACK_SLEEP
        • SensorHeader.CMD_DEEP_SLEEP
        • SensorHeader.ACK_DEEP_SLEEP
        • SensorHeader.CMD_SET_MEASUREMENT_MODE
        • SensorHeader.CMD_GET_MEASUREMENT_MODE
        • SensorHeader.DATA_MEASUREMENT_MODE
        • SensorHeader.CMD_SET_MEASUREMENT_BURST_MODE
        • SensorHeader.CMD_GET_MEASUREMENT_BURST_MODE
        • SensorHeader.DATA_MEASUREMENT_BURST_MODE
        • SensorHeader.CMD_SET_RECORDING_CONFIG
        • SensorHeader.CMD_GET_RECORDING_CONFIG
        • SensorHeader.DATA_RECORDING_CONFIG
        • SensorHeader.CMD_START_STREAMING
        • SensorHeader.ACK_START_STREAMING
        • SensorHeader.CMD_STOP_STREAMING
        • SensorHeader.ACK_STOP_STREAMING
        • SensorHeader.CMD_START_RECORDING
        • SensorHeader.ACK_START_RECORDING
        • SensorHeader.CMD_STOP_RECORDING
        • SensorHeader.ACK_STOP_RECORDING
        • SensorHeader.CMD_STOP_STREAMING_AND_CLEAR_BUFFER
        • SensorHeader.ACK_STOP_STREAMING_AND_CLEAR_BUFFER
        • SensorHeader.CMD_START_REAL_TIME_STREAMING
        • SensorHeader.CMD_GET_REAL_TIME_STREAMING_MODE
        • SensorHeader.DATA_REAL_TIME_STREAMING_MODE
        • SensorHeader.CMD_STOP_REAL_TIME_STREAMING
        • SensorHeader.ACK_STOP_REAL_TIME_STREAMING
        • SensorHeader.CMD_SET_ABSOLUTE_TIME
        • SensorHeader.DATA_ABSOLUTE_TIME
        • SensorHeader.DATA_CLOCK_ROUNDTRIP
        • SensorHeader.CMD_SET_LED_CONFIG
        • SensorHeader.CMD_GET_LED_CONFIG
        • SensorHeader.DATA_LED_CONFIG
        • SensorHeader.CMD_SET_LED_MODE
        • SensorHeader.CMD_GET_LED_MODE
        • SensorHeader.DATA_LED_MODE
        • SensorHeader.CMD_SET_SYNC_OUTPUT_MODE
        • SensorHeader.DATA_SYNC_OUTPUT_MODE
        • SensorHeader.CMD_GET_STATUS
        • SensorHeader.DATA_STATUS
        • SensorHeader.DATA_FULL_PACKED_200HZ
        • SensorHeader.DATA_FULL_PACKED_100HZ
        • SensorHeader.DATA_FULL_PACKED_50HZ
        • SensorHeader.DATA_FULL_PACKED_25HZ
        • SensorHeader.DATA_FULL_PACKED_10HZ
        • SensorHeader.DATA_FULL_PACKED_1HZ
        • SensorHeader.DATA_FULL_6D_PACKED_200HZ
        • SensorHeader.DATA_FULL_6D_PACKED_100HZ
        • SensorHeader.DATA_FULL_6D_PACKED_50HZ
        • SensorHeader.DATA_FULL_6D_PACKED_25HZ
        • SensorHeader.DATA_FULL_6D_PACKED_10HZ
        • SensorHeader.DATA_FULL_6D_PACKED_1HZ
        • SensorHeader.DATA_FULL_FIXED_200HZ
        • SensorHeader.DATA_FULL_FIXED_100HZ
        • SensorHeader.DATA_FULL_FIXED_50HZ
        • SensorHeader.DATA_FULL_FIXED_25HZ
        • SensorHeader.DATA_FULL_FIXED_10HZ
        • SensorHeader.DATA_FULL_FIXED_1HZ
        • SensorHeader.DATA_FULL_FIXED_RT
        • SensorHeader.DATA_FULL_6D_FIXED_200HZ
        • SensorHeader.DATA_FULL_6D_FIXED_100HZ
        • SensorHeader.DATA_FULL_6D_FIXED_50HZ
        • SensorHeader.DATA_FULL_6D_FIXED_25HZ
        • SensorHeader.DATA_FULL_6D_FIXED_10HZ
        • SensorHeader.DATA_FULL_6D_FIXED_1HZ
        • SensorHeader.DATA_FULL_FLOAT_200HZ
        • SensorHeader.DATA_QUAT_PACKED_200HZ
        • SensorHeader.DATA_QUAT_PACKED_100HZ
        • SensorHeader.DATA_QUAT_PACKED_50HZ
        • SensorHeader.DATA_QUAT_PACKED_25HZ
        • SensorHeader.DATA_QUAT_PACKED_10HZ
        • SensorHeader.DATA_QUAT_PACKED_1HZ
        • SensorHeader.DATA_QUAT_FIXED_200HZ
        • SensorHeader.DATA_QUAT_FIXED_100HZ
        • SensorHeader.DATA_QUAT_FIXED_50HZ
        • SensorHeader.DATA_QUAT_FIXED_25HZ
        • SensorHeader.DATA_QUAT_FIXED_10HZ
        • SensorHeader.DATA_QUAT_FIXED_1HZ
        • SensorHeader.DATA_QUAT_FIXED_RT
        • SensorHeader.DATA_QUAT_FLOAT_200HZ
        • SensorHeader.DATA_QUAT_FLOAT_100HZ
        • SensorHeader.DATA_QUAT_FLOAT_50HZ
        • SensorHeader.DATA_QUAT_FLOAT_25HZ
        • SensorHeader.DATA_QUAT_FLOAT_10HZ
        • SensorHeader.DATA_QUAT_FLOAT_1HZ
        • SensorHeader.DATA_RAW_BURST
        • SensorHeader.DATA_ACCZ_BURST
        • SensorHeader.DATA_SYNC_TRIGGER
        • SensorHeader.CMD_FS_LIST_FILES
        • SensorHeader.DATA_FS_FILE_COUNT
        • SensorHeader.DATA_FS_FILE
        • SensorHeader.CMD_FS_GET_BYTES
        • SensorHeader.DATA_FS_BYTES
        • SensorHeader.CMD_FS_STOP_GET_BYTES
        • SensorHeader.ACK_FS_STOP_GET_BYTES
        • SensorHeader.CMD_FS_GET_SIZE
        • SensorHeader.DATA_FS_SIZE
        • SensorHeader.CMD_FS_DELETE_FILE
        • SensorHeader.ACK_FS_DELETE_FILE
        • SensorHeader.CMD_FS_FORMAT_FILESYSTEM
        • SensorHeader.ACK_FS_FORMAT_FILESYSTEM
        • SensorHeader.ERROR
      • ErrorCode
        • ErrorCode.NO_ERROR
        • ErrorCode.FILE_NOT_FOUND
        • ErrorCode.FILE_DELETION_FAILED
        • ErrorCode.FILE_SYSTEM_ERROR
        • ErrorCode.FILE_ALREADY_EXISTS
        • ErrorCode.FILE_TOO_SHORT
        • ErrorCode.FILE_NAME_INVALID
        • ErrorCode.FILE_SYSTEM_FULL
        • ErrorCode.FILE_SYSTEM_BUSY
        • ErrorCode.RECORDING_CONFIG_NOT_SET
        • ErrorCode.CALIB_PARAM_FLASH_ERROR
        • ErrorCode.WRONG_STATE
        • ErrorCode.PKG_ERROR
        • ErrorCode.UNKNOWN_COMMAND
        • ErrorCode.SEND_BUFFER_FULL
        • ErrorCode.UNKNOWN_ERROR
      • SensorState
        • SensorState.OFF
        • SensorState.IDLE
        • SensorState.STREAMING
        • SensorState.RECORDING
      • ConnectionState
        • ConnectionState.OFFLINE
        • ConnectionState.ADVERTISING
        • ConnectionState.BLE_CONNECTED
        • ConnectionState.USB_CONNECTED
      • SamplingMode
        • SamplingMode.MODE_DISABLED
        • SamplingMode.MODE_200HZ
        • SamplingMode.MODE_100HZ
        • SamplingMode.MODE_50HZ
        • SamplingMode.MODE_25HZ
        • SamplingMode.MODE_10HZ
        • SamplingMode.MODE_1HZ
      • SyncMode
        • SyncMode.NO_SYNC
        • SyncMode.SYNC_SENDER
        • SyncMode.SYNC_RECEIVER
      • ProcessExtensionMode
        • ProcessExtensionMode.NO_EXTENSION
      • CalibrationDataMode
        • CalibrationDataMode.CALIB_DATA_DISABLED
        • CalibrationDataMode.CALIB_DATA_FULL
        • CalibrationDataMode.CALIB_DATA_MAG
      • RealTimeDataMode
        • RealTimeDataMode.REAL_TIME_DATA_DISABLED
        • RealTimeDataMode.REAL_TIME_DATA_QUAT
        • RealTimeDataMode.REAL_TIME_DATA_FULL
      • register_package()
      • AbstractPackage
        • AbstractPackage.header
        • AbstractPackage.frombytes()
        • AbstractPackage.pack()
        • AbstractPackage.parse()
      • DataDeviceInfo
        • DataDeviceInfo.header
      • DataMeasurementMode
        • DataMeasurementMode.header
      • DataMeasurementBurstMode
        • DataMeasurementBurstMode.header
      • DataRecordingConfig
        • DataRecordingConfig.header
      • DataRealTimeStreamingMode
        • DataRealTimeStreamingMode.header
      • DataAbsoluteTime
        • DataAbsoluteTime.header
      • DataClockRoundtrip
        • DataClockRoundtrip.header
      • DataLedConfig
        • DataLedConfig.header
      • DataLedMode
        • DataLedMode.header
      • DataSyncOutputMode
        • DataSyncOutputMode.header
      • DataStatus
        • DataStatus.header
      • DataFullPacked
      • DataFull6DPacked
      • DataFullFixed
      • DataFull6DFixed
      • DataFullFloat200Hz
        • DataFullFloat200Hz.header
      • DataQuatPacked
      • DataQuatFixed
      • DataQuatFloat
      • DataRawBurst
        • DataRawBurst.header
      • DataAccZBurst
        • DataAccZBurst.header
      • DataSyncTrigger
        • DataSyncTrigger.header
      • DataFsFileCount
        • DataFsFileCount.header
      • DataFsFile
        • DataFsFile.header
      • CmdFsGetBytes
        • CmdFsGetBytes.header
      • DataFsBytes
        • DataFsBytes.header
      • DataFsFilename
      • DataFsSize
        • DataFsSize.header
      • SensorError
        • SensorError.header
      • SensorSerialPackage
  • Utilities (c2g.utils)
    • qmult()
    • rotate()
    • rotateinv()
    • quatFromGyr()
    • addHeading()
    • eulerAngles()
    • decodeQuat()
    • generateSyncId()

Protocol

  • Capture2Go Communication Protocol
    • Table of Contents
    • Introduction
    • Data Package Format
      • SensorSerialPackage
    • BLE Communication
    • USB Communication
    • Decoding of Fixed-Point Data
    • Error Flags
    • Examples
      • Real-time Streaming of Orientations
      • Streaming of Full Data
      • Offline Measurement (Recording) of Full Data
    • Specification of Commands and Data Packages
      • Enum SensorHeader
      • Enum ErrorCode
      • Enum SensorState
      • Enum ConnectionState
      • Enum SamplingMode
      • Enum SyncMode
      • Enum ProcessExtensionMode
      • Enum CalibrationDataMode
      • Enum RealTimeDataMode
      • Packages without Payload
      • Package DataDeviceInfo
      • Package DataMeasurementMode
      • Package DataMeasurementBurstMode
      • Package DataRecordingConfig
      • Package DataRealTimeStreamingMode
      • Package DataAbsoluteTime
      • Package DataClockRoundtrip
      • Package DataLedConfig
      • Package DataLedMode
      • Package DataSyncOutputMode
      • Package DataStatus
      • Package DataFullPacked
      • Package DataFull6DPacked
      • Package DataFullFixed
      • Package DataFull6DFixed
      • Package DataFullFloat200Hz
      • Package DataQuatPacked
      • Package DataQuatFixed
      • Package DataQuatFloat
      • Package DataRawBurst
      • Package DataAccZBurst
      • Package DataSyncTrigger
      • Package DataFsFileCount
      • Package DataFsFile
      • Package CmdFsGetBytes
      • Package DataFsBytes
      • Package DataFsFilename
      • Package DataFsSize
      • Package SensorError
Capture2Go Python SDK
  • Capture2Go Python SDK Documentation
  • View page source

Capture2Go Python SDK Documentation

Welcome to the Capture2Go Python SDK documentation.

Quick Links

  • Capture2Go website: https://capture2go.com

  • Source code on GitHub: https://github.com/sensorstim/capture2go

  • Python package on PyPI: https://pypi.org/project/capture2go/

Contents

Guide

  • Getting Started
    • Introduction
    • Installation
    • Minimal Usage Example
    • Recording, Streaming, Real-Time Streaming
  • Examples
    • Minimal Print Example
    • Real-Time Streaming
    • Live Plotting
    • Recording and Downloading Data
    • Downloading and Managing Files
    • Converting Recordings to MATLAB

Reference

  • Main API Reference
    • Device Classes
    • Scanning and Connecting
    • Parsing
    • Exceptions
    • Type Aliases
  • Package Definitions (c2g.pkg)
    • Introduction
    • All Members
  • Utilities (c2g.utils)
    • qmult()
    • rotate()
    • rotateinv()
    • quatFromGyr()
    • addHeading()
    • eulerAngles()
    • decodeQuat()
    • generateSyncId()

Protocol

  • Capture2Go Communication Protocol
    • Table of Contents
    • Introduction
    • Data Package Format
    • BLE Communication
    • USB Communication
    • Decoding of Fixed-Point Data
    • Error Flags
    • Examples
    • Specification of Commands and Data Packages

Indices and tables

  • Index

  • Module Index

  • Search Page

Next

© Copyright 2025, SensorStim Neurotechnology GmbH.

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