nspyre.instrument.manager

Module Contents

Classes

InstrumentManager

For consolidating connections to multiple instrument gateways.

class nspyre.instrument.manager.InstrumentManager(*register_gateway_args, register_gateway=True, **register_gateway_kwargs)

For consolidating connections to multiple instrument gateways. If only connecting to a single InstrumentGateway, you can simply pass the arguments and keyword arguments that you’d normally pass to the gateway here.

Parameters:

• register_gateway_args – See arguments for register_gateway().

• register_gateway (bool) – if True, call register_gateway().

• register_gateway_kwargs – See keyword arguments for register_gateway().

register_gateway(*gateway_args, default_exclude=False, exclude=None, name_mapping=None, **gateway_kwargs)

Parameters:

• gateway_args – See arguments for InstrumentGateway.

• gateway_kwargs – See keyword arguments for InstrumentGateway.

• default_exclude (bool) – If True, only add those devices specified in the name_mapping.

• exclude (Optional[list[str]]) – List of device names on the InstrumentServer that won’t be added to the InstrumentManager.

• name_mapping (Optional[Dict[str, str]]) – Keys should be the device names on the InstrumentServer whose values are the corresponding desired name on the InstrumentManager. Otherwise their name on the InstrumentManager will be the same as that on the InstrumentServer.

disconnect()

Disconnect from all InstrumentGateway.