driver¶

class timeflux_brainflow.nodes.driver.BrainFlow(board, channels=None, command=None, debug=False, **kwargs)[source]¶

Bases: timeflux.core.node.Node

Driver for BrainFlow.

This plugin provides a unified interface for all boards supported by BrainFlow.

Variables

o (Port) – Default output, provides DataFrame.

Parameters

board (string|int) – The board ID. Allowed values: numeric ID or name (e.g. synthetic, cyton_wifi, brainbit, etc.).
channels (list) – The EEG channel labels. If not set, incrementing numbers will be used.
command (string) – Send a command to the board. Use it carefully and only if you understand what you are doing.
debug (boolean) – Print debug messages.
**kwargs – The parameters specific for each board. Allowed arguments: serial_port, mac_address, ip_address, ip_port, ip_protocol, serial_number, other_info.

See also

List of supported boads.

Example

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

Instantiate the node.

update(self)[source]¶: Update the input and output ports.

terminate(self)[source]¶: Perform cleanup upon termination.