microspeclib.datatypes.bridge module

class microspeclib.datatypes.bridge.BridgeNull(*args, **kwargs)

This packet doesn’t actually exist, as the request for a Null has no reply. However, to distinguish between an error, when a CommandNull is requested, the API returns this object rather than None.

class microspeclib.datatypes.bridge.BridgeGetBridgeLED(*args, status=None, led_setting=None, **kwargs)

Contains the result of a CommandGetBridgeLED command.

Parameters
  • status (StatusOK or StatusError If there is an error status, the other attributes are not valid) –

  • led_num (0) – Which LED the status applies to

  • led_status (LEDOff, LEDGreen, or LEDRed The color state of the LED) –

class microspeclib.datatypes.bridge.BridgeSetBridgeLED(*args, status=None, **kwargs)

Contains the status of the CommandSetBridgeLED command.

Parameters

status (StatusOK or StatusError If there is an error status, the other attributes are not valid) –

class microspeclib.datatypes.bridge.BridgeGetSensorLED(*args, status=None, **kwargs)

Contains a transitory status of the CommandGetSensorLED command as it passes through the Bridge. This is not the final payload for this command type. If the Simple or Expert API returns this object, then the command failed in the Bridge and did not even make it to the Sensor.

Parameters

status (StatusOK or StatusError If there is an error status, the other attributes are not valid) –

class microspeclib.datatypes.bridge.BridgeSetSensorLED(*args, status=None, **kwargs)

Contains a transitory status of the CommandGetSensorLED command as it passes through the Bridge. This is not the final payload for this command type. If the Simple or Expert API returns this object, then the command failed in the Bridge and did not even make it to the Sensor.

Parameters

status (StatusOK or StatusError If there is an error status, the other attributes are not valid) –

class microspeclib.datatypes.bridge.BridgeReset(*args, status=None, **kwargs)

Contains status status of the CommandReset command.

Parameters

status (StatusOK or StatusError If there is an error status, the other attributes are not valid) –

class microspeclib.datatypes.bridge.BridgeVerify(*args, status=None, **kwargs)

Contains the status of the CommandVerify command.

Parameters

status (StatusOK or StatusError If there is an error status, the other attributes are not valid) –

class microspeclib.datatypes.bridge.BridgeGetSensorConfig(*args, status=None, **kwargs)

Contains a transitory status of the CommandGetSensorConfig command as it passes through the Bridge. This is not the final payload for this command type. If the Simple or Expert API returns this object, then the command failed in the Bridge and did not even make it to the Sensor.

Parameters

status (StatusOK or StatusError If there is an error status, the other attributes are not valid) –

class microspeclib.datatypes.bridge.BridgeSetSensorConfig(*args, status=None, **kwargs)

Contains a transitory status of the CommandSetSensorConfig command as it passes through the Bridge. This is not the final payload for this command type. If the Simple or Expert API returns this object, then the command failed in the Bridge and did not even make it to the Sensor.

Parameters

status (StatusOK or StatusError If there is an error status, the other attributes are not valid) –

class microspeclib.datatypes.bridge.BridgeGetExposure(*args, status=None, **kwargs)

Contains a transitory status of the CommandGetExposure command as it passes through the Bridge. This is not the final payload for this command type. If the Simple or Expert API returns this object, then the command failed in the Bridge and did not even make it to the Sensor.

Parameters

status (StatusOK or StatusError If there is an error status, the other attributes are not valid) –

class microspeclib.datatypes.bridge.BridgeSetExposure(*args, status=None, **kwargs)

Contains a transitory status of the CommandSetExposure command as it passes through the Bridge. This is not the final payload for this command type. If the Simple or Expert API returns this object, then the command failed in the Bridge and did not even make it to the Sensor.

Parameters

status (StatusOK or StatusError If there is an error status, the other attributes are not valid) –

class microspeclib.datatypes.bridge.BridgeCaptureFrame(*args, status=None, **kwargs)

Contains a transitory status of the CommandCaptureFrame command as it passes through the Bridge. This is not the final payload for this command type. If the Simple or Expert API returns this object, then the command failed in the Bridge and did not even make it to the Sensor.

Parameters

status (StatusOK or StatusError If there is an error status, the other attributes are not valid) –

class microspeclib.datatypes.bridge.BridgeAutoExposure(*args, status=None, **kwargs)

Contains a transitory status of the CommandAutoExposure command as it passes through the Bridge. This is not the final payload for this command type. If the Simple or Expert API returns this object, then the command failed in the Bridge and did not even make it to the Sensor.

Parameters

status (StatusOK or StatusError If there is an error status, the other attributes are not valid) –

class microspeclib.datatypes.bridge.BridgeGetAutoExposeConfig(*args, status=None, **kwargs)
class microspeclib.datatypes.bridge.BridgeSetAutoExposeConfig(*args, status=None, **kwargs)
microspeclib.datatypes.bridge.getBridgeReplyByID(cid)
microspeclib.datatypes.bridge.getBridgeReplyByName(name)