This documentation is for development version 0.18.dev0.

mne.realtime.StimClient

class mne.realtime.StimClient(host, port=4218, timeout=5.0, verbose=None)[source]

Stimulation Client.

Client to communicate with StimServer

Parameters:
host : str

Hostname (or IP address) of the host where StimServer is running.

port : int

Port to use for the connection.

timeout : float

Communication timeout in seconds.

verbose : bool, str, int, or None

If not None, override default verbose level (see mne.verbose() and Logging documentation for more).

See also

StimServer

Methods

__hash__($self, /) Return hash(self).
close() Close the socket object.
get_trigger([timeout, verbose]) Get triggers from StimServer.
__hash__($self, /)

Return hash(self).

close()[source]

Close the socket object.

get_trigger(timeout=5.0, verbose=None)[source]

Get triggers from StimServer.

Parameters:
timeout : float

maximum time to wait for a valid trigger from the server

verbose : bool, str, int, or None

If not None, override default verbose level (see mne.verbose() and Logging documentation for more). Defaults to self.verbose.