driver¶

class timeflux_openbci.nodes.driver.OpenBCI(board, channels=None, gain=24, disable=None, debug=False, **kwargs)[source]¶

Bases: timeflux_brainflow.nodes.driver.BrainFlow

OpenBCI driver.

This plugin provides a unified interface for all OpenBCI boards.

Variables

o (Port) – Default output, provides DataFrame.

Parameters

board (string) – The OpenBCI board type. Allowed values: synthetic, cyton, ganglion, cyton_daisy, ganglion_wifi, cyton_wifi, cyton_daisy_wifi
channels (list of string) – The EEG channel labels. If not set, incrementing numbers will be used.
gain (int) – The amplifier gain. Only for Cyton-based boards. Possible values: 1, 2, 4, 6, 8, 12, 24. Default: 24.
disable (list of int) – Disable given channels. Only for Cyton-based boards. Default: None
debug (boolean) – Print debug messages.
**kwargs – The parameters specific for each board. Allowed arguments: serial_port, mac_address, ip_address, ip_port, ip_protocol.

Example

graphs:
  - id: OpenBCI
    nodes:
    - id: acquire
      module: timeflux_openbci.nodes.driver
      class: OpenBCI
      params:
        board: synthetic
    - id: display
      module: timeflux.nodes.debug
      class: Display
    edges:
    - source: acquire
      target: display
    rate: 10

Instantiate the node.