iblrig.video.CameraSessionNetworked

class iblrig.video.CameraSessionNetworked

__init__(subject=None, config_name='default', **kwargs)

A camera session that listens for run commands from a remote computer.

Parameters:

• subject (str, optional) – The subject name.

• config_name (str=``’default’``) – The name of the camera configuration key in the hardware settings to use.

status

This status will be returned when messages received during the main loop and determines response to remote events.

Type:

str

communicator

A Communicator object that can be used to communicate with the behaviour rig.

Type:

iblutil.io.net.app.EchoProtocol

close()

End experiment and cleanup object.

This should be called before destroying the session object.

async initialize_recording()

async listen(service_uri=None)

Listen for remote rig.

Parameters:

service_uri (str) – The service URI.

async on_alyx(data, addr)

async on_cleanup(data, addr)

async on_end(data, addr)

async on_info(_, addr)

async on_init(data, addr)

Process init command from remote rig.

This method will initialize the recording and send a response to the remote rig. If an acquisition is already running it will assert that the received experiment description matches the current one (this should be the case when running chained protocols). If the expRef is wrong, the method will raise an error before responding, which should be caught by the calling run method. Thus one should be able to re-start the behaviour session with the correct subject expRef or turn off UDPs at the behaviour rig without affecting the camera session.

async on_interrupt(data, addr)

async on_start(data, addr)

Process init command from remote rig.

async on_status(_, addr)

reset()

Reset object for next session.

async run(service_uri=None)

Main loop networked with behaviour rig.

start_recording()

Start cameras (i.e. spawn Bonsai process).

async stop_recording()

property is_connected: bool

True if communicator is connected.

Type:

bool