User Reference:ConnectorFilters

From BCI2000 Wiki
Jump to navigation Jump to search

Function

The ConnectorFilters provide an implementation of the BCI2000 App Connector protocol.

Filter Placement

Typically, the ConnectorInput filter is the first filter in the Application Module, which allows external changes to BCI2000 state to affect the application module's behavior immediately. Similarly, the ConnectorOutput filter is placed last in the application module, such that state information read over the protocol will immediately reflect the application module's state changes.

Detailed Description

A description of the connector protocol, along with client example code, and configuration examples, is provided on a separate App Connector page.

Parameters

ConnectorInputAddress

An address:port combination that specifies a local UDP socket. Addresses may be host names, or numerical IP addresses. Incoming data is read from this socket.

ConnectorInputFilter

For incoming values, messages are filtered by state name using a list of allowed names present in this parameter. To allow signal messages, allowed signal elements must be specified including their indices. To allow all names, enter an asterisk (*) as the only list entry.

ConnectorOutputAddress

Ad address:port combination that specifies a local or remote UDP socket. Addresses may be host names, or numerical IP addresses. For each data block, values of all state variables and the control signal are written out to this socket, using the App Connector Protocol.

States

All states present in the system are transmitted over the App Connector protocol.

See also

Technical Reference:App Connector