bpod_core.bpod.discover_remote_bpod

bpod_core.bpod.discover_remote_bpod(name=None, serial_number=None, location=None, timeout=10.0, poll_interval=1, *, local=True, remote=True) → Iterator[ServiceEvent]

Identify available Bpod devices connected via ZeroMQ.

Parameters:

  • name (str, optional) – Name of the Bpod device.

  • serial_number (str, optional) – Serial number of the Bpod device.

  • location (str, optional) – Location of the Bpod device.

  • local (bool, optional) – Whether to search for services on the local machine, by default True.

  • remote (bool, optional) – Whether to also search for services on the network, by default True.

  • timeout (float or None, optional) – How many seconds to monitor, by default 10. Pass None to monitor indefinitely until the iterator is closed.

  • poll_interval (float, optional) – How often to poll for local service changes, in seconds. Default is 1.

Yields:

ServiceEvent – A named tuple with the following fields:

  • kind: str, either ‘added’ or ‘removed’

  • address: str, the service address, e.g., ‘tcp://192.168.1.10:1234’

  • properties: dict, the service properties, e.g., {‘name’: ‘MyDevice’}

Return type:

Iterator[ServiceEvent]