API Reference

octopus_sensing

• Device Coordinator
  • RealtimeDataCache
    • RealtimeDataCache.get_cache()
    • RealtimeDataCache.cache()
  • DeviceCoordinator
    • DeviceCoordinator.get_devices()
    • DeviceCoordinator.add_device()
    • DeviceCoordinator.add_devices()
    • DeviceCoordinator.dispatch()
    • DeviceCoordinator.health_check()
    • DeviceCoordinator.terminate()
    • DeviceCoordinator.get_realtime_data()
• HTTP Endpoint
  • DeviceMessageHTTPEndpoint
• Devices
  • Device (Base class)
    • Device
      • Device.run()
      • Device.set_queue()
      • Device.get_name()
  • RealtimeDataDevice
    • RealtimeDataDevice
      • RealtimeDataDevice.set_realtime_data_queues()
      • RealtimeDataDevice.run()
  • Camera
    • CameraStreaming
  • Audio
    • AudioStreaming
      • AudioStreaming.get_saving_mode()
  • Shimmer3
    • Shimmer3Streaming
      • Shimmer3Streaming.get_saving_mode()
      • Shimmer3Streaming.get_output_path()
  • OpenBCI (brainflow)
    • BrainFlowOpenBCIStreaming
      • BrainFlowOpenBCIStreaming.get_output_path()
      • BrainFlowOpenBCIStreaming.get_channels()
      • BrainFlowOpenBCIStreaming.get_saving_mode()
  • OpenBCI (pyOpenBCI)
    • OpenBCIStreaming
      • OpenBCIStreaming.get_saving_mode()
      • OpenBCIStreaming.get_output_path()
      • OpenBCIStreaming.get_channels()
  • Brainflow
    • BrainFlowStreaming
      • BrainFlowStreaming.device_id
      • BrainFlowStreaming.sampling_rate
      • BrainFlowStreaming.brain_flow_input_params
      • BrainFlowStreaming.name
      • BrainFlowStreaming.output_path
      • BrainFlowStreaming.saving_mode
      • BrainFlowStreaming.get_channels()
  • Open Vibe
    • OpenVibeStreaming
      • OpenVibeStreaming.run()
  • Network
    • SocketNetworkDevice
    • HttpNetworkDevice
  • Common
    • SavingModeEnum
      • SavingModeEnum.CONTINIOUS_SAVING_MODE
      • SavingModeEnum.SEPARATED_SAVING_MODE
• Common
  • Message
    • Message
  • Predefined Messages
    • MessageType
      • MessageType.START
      • MessageType.STOP
      • MessageType.TERMINATE
    • start_message()
    • stop_message()
    • terminate_message()
• Stimuli
  • Image Stimulus
  • Video Stimulus
    • VideoStimulus
      • VideoStimulus.show()
• Questionnaire
  • Questionnaire
  • Base question
  • Text Question
  • Opinion question
• Windows
  • Message Window
  • Image Window
  • Timer Window
• Preprocessing
  • OpenBCI
    • openbci_preprocess()
    • EegPreprocessing
      • EegPreprocessing.get_data()
      • EegPreprocessing.filter_data()
    • clean_eeg()
  • Shimmer3
    • shimmer3_preprocess()
    • clean_gsr()
    • clean_ppg()
  • Preprocess Devices
    • preprocess_devices()
    • preprocess_devices_by_path()