microspeclib.datatypes.sensor module¶
-
class
microspeclib.datatypes.sensor.
SensorGetSensorLED
(*args, status=None, led_setting=None, **kwargs)¶ Contains the result of a
CommandGetSensorLED
command.- Parameters
status (
StatusOK
orStatusError
If there is an error status, the other attributes are not valid) –led_num (0 or 1) – Which LED the status applies to
led_status (
LEDOff
,LEDGreen
, orLEDRed
The color state of the LED) –
-
class
microspeclib.datatypes.sensor.
SensorSetSensorLED
(*args, status=None, **kwargs)¶ Contains the status of the
CommandSetSensorLED
command.- Parameters
status (
StatusOK
orStatusError
If there is an error status, the other attributes are not valid) –
-
class
microspeclib.datatypes.sensor.
SensorGetSensorConfig
(*args, status=None, binning=None, gain=None, row_bitmap=None, **kwargs)¶ Contains the result of a
CommandGetSensorConfig
command.- Parameters
status (
StatusOK
orStatusError
If there is an error status, the other attributes are not valid) –binning (0-1) – Whether or not to bin adjacent pixels. 0: binning off, LIS-770i has 784 7.8µm-pitch pixels, 770 optically active 1: binning on, LIS-770i has 392 15.6µm-pitch pixels, 385 optically active
gain (0-255) – Analog pixel voltage gain. Allowed values: 0x01: 1x gain 0x25: 2.5x gain (37 in decimal) 0x04: 4x gain 0x05: 5x gain
row_bitmap – Which rows to permit sensing on. There are 5, and can all be activated with a binary bitmap of 5 1’s, i.e. 011111 or 0x1F. The three most significant bits must be 0. Otherwise, any combination is permitted except 0x00.
-
class
microspeclib.datatypes.sensor.
SensorSetSensorConfig
(*args, status=None, **kwargs)¶ Contains the result of a
CommandSetSensorConfig
command.- Parameters
status (
StatusOK
orStatusError
If there is an error status, the other attributes are not valid) –
-
class
microspeclib.datatypes.sensor.
SensorGetExposure
(*args, status=None, cycles=None, **kwargs)¶ Contains the result of a
CommandGetExposure
command.- Parameters
status (
StatusOK
orStatusError
If there is an error status, the other attributes are not valid) –cycles (1-65535) – Number of cycles to expose pixels. Each cycle is 20µs.
-
class
microspeclib.datatypes.sensor.
SensorSetExposure
(*args, status=None, **kwargs)¶ Contains the result of a
CommandSetExposure
command.- Parameters
status (
StatusOK
orStatusError
If there is an error status, the other attributes are not valid) –
-
class
microspeclib.datatypes.sensor.
SensorCaptureFrame
(*args, status=None, num_pixels=None, pixels=None, **kwargs)¶ Contains the result of a
CommandCaptureFrame
command.- Parameters
status (
StatusOK
orStatusError
If there is an error status, the other attributes are not valid) –num_pixels (0-784) – The number of pixels to expect in the pixels parameter. Using the recommended (default) configuration, num_pixels is 392.
pixels (Array of values, each from 0-65535) – The pixel values for one capture frame.
-
class
microspeclib.datatypes.sensor.
SensorAutoExposure
(*args, status=None, success=None, iterations=None, **kwargs)¶ Contains the result of a
CommandAutoExposure
command.- Parameters
status (
StatusOK
orStatusError
If there is an error status, the other attributes are not valid) –success (0 or 1) –
- 1: success
Auto-expose settled on an exposure time that put the sensor peak value within the target range.
- 0: failure
Auto-expose gave up on finding an exposure time, either because it reached the maximum number of tries or the exposure time is already at the maximum allowed value.
iterations (1-255) –
Number of exposures tried by auto-expose.
iterations never exceeds AutoExposeConfig parameter max_tries, as this sets the maximum number of iterations to try.
-
class
microspeclib.datatypes.sensor.
SensorGetAutoExposeConfig
(*args, status=None, max_tries=None, start_pixel=None, stop_pixel=None, target=None, target_tolerance=None, max_exposure=None, **kwargs)¶
-
class
microspeclib.datatypes.sensor.
SensorSetAutoExposeConfig
(*args, status=None, **kwargs)¶
-
microspeclib.datatypes.sensor.
getSensorReplyByID
(cid)¶
-
microspeclib.datatypes.sensor.
getSensorReplyByName
(name)¶