lm.live_scan.v1#
zen_api.lm.live_scan.v1
#
Classes:
-
LiveScanServiceConfiguration–Response object representing the configuration.
-
LiveScanServiceEjectTrayRequest–The LiveScanServiceEjectTrayRequest class.
-
LiveScanServiceEjectTrayResponse–Empty response upon ejecting the tray.
-
LiveScanServiceGetConfigurationRequest–The LiveScanServiceGetConfigurationRequest class.
-
LiveScanServiceGetConfigurationResponse–Request for getting the configuration.
-
LiveScanServiceLoadTrayAndPrescanRequest–The LiveScanServiceLoadTrayAndPrescanRequest class.
-
LiveScanServiceLoadTrayAndPrescanResponse–Empty response upon loading the tray.
-
LiveScanServiceSetConfigurationRequest–Request for setting the configuration.
-
LiveScanServiceSetConfigurationResponse–Empty response upon setting the configuration.
LiveScanServiceConfiguration
dataclass
#
LiveScanServiceConfiguration(sample_holder_template: str = betterproto.string_field(1), live_scan_detection: bool = betterproto.bool_field(2), measure_bottom_thickness: bool = betterproto.bool_field(3), determine_bottom_material: bool = betterproto.bool_field(4), create_carrier_overview: bool = betterproto.bool_field(5), read_barcodes: bool = betterproto.bool_field(6), use_left_barcode: bool = betterproto.bool_field(7), use_right_barcode: bool = betterproto.bool_field(8), automatic_live_scan_calibration: bool = betterproto.bool_field(9), refractive_index: float = betterproto.double_field(10), material: str = betterproto.string_field(11))
Bases: Message
Response object representing the configuration.
Attributes:
-
sample_holder_template(str) –Gets the type template.
-
live_scan_detection(bool) –Gets a value indicating whether sample carrier detection is active.
-
measure_bottom_thickness(bool) –Gets a value indicating whether bottom thickness has to be measured.
-
determine_bottom_material(bool) –Gets a value indicating whether bottom material determination is active.
-
create_carrier_overview(bool) –Gets a value indicating whether sample carrier detection is active.
-
read_barcodes(bool) –Gets a value indicating whether barcodes must be read.
-
use_left_barcode(bool) –Gets a value indicating whether the left barcode must be read.
-
use_right_barcode(bool) –Gets a value indicating whether the right barcode must be read.
-
automatic_live_scan_calibration(bool) –Gets a value indicating whether automatic sample carrier calibration is active.
-
refractive_index(float) –The refractive index of the bottom material of this sample carrier.
-
material(str) –The bottom material of this sample carrier.
sample_holder_template
class-attribute
instance-attribute
#
sample_holder_template: str = string_field(1)
Gets the type template.
live_scan_detection
class-attribute
instance-attribute
#
live_scan_detection: bool = bool_field(2)
Gets a value indicating whether sample carrier detection is active.
measure_bottom_thickness
class-attribute
instance-attribute
#
measure_bottom_thickness: bool = bool_field(3)
Gets a value indicating whether bottom thickness has to be measured.
determine_bottom_material
class-attribute
instance-attribute
#
determine_bottom_material: bool = bool_field(4)
Gets a value indicating whether bottom material determination is active.
create_carrier_overview
class-attribute
instance-attribute
#
create_carrier_overview: bool = bool_field(5)
Gets a value indicating whether sample carrier detection is active.
read_barcodes
class-attribute
instance-attribute
#
read_barcodes: bool = bool_field(6)
Gets a value indicating whether barcodes must be read.
use_left_barcode
class-attribute
instance-attribute
#
use_left_barcode: bool = bool_field(7)
Gets a value indicating whether the left barcode must be read.
use_right_barcode
class-attribute
instance-attribute
#
use_right_barcode: bool = bool_field(8)
Gets a value indicating whether the right barcode must be read.
automatic_live_scan_calibration
class-attribute
instance-attribute
#
automatic_live_scan_calibration: bool = bool_field(9)
Gets a value indicating whether automatic sample carrier calibration is active.
refractive_index
class-attribute
instance-attribute
#
refractive_index: float = double_field(10)
The refractive index of the bottom material of this sample carrier.
material
class-attribute
instance-attribute
#
material: str = string_field(11)
The bottom material of this sample carrier.
LiveScanServiceEjectTrayRequest
dataclass
#
LiveScanServiceEjectTrayRequest()
Bases: Message
The LiveScanServiceEjectTrayRequest class.
LiveScanServiceEjectTrayResponse
dataclass
#
LiveScanServiceEjectTrayResponse(notifications: List[str] = betterproto.string_field(1))
Bases: Message
Empty response upon ejecting the tray.
Attributes:
-
notifications(List[str]) –The list of notifications.
notifications
class-attribute
instance-attribute
#
notifications: List[str] = string_field(1)
The list of notifications.
LiveScanServiceGetConfigurationRequest
dataclass
#
LiveScanServiceGetConfigurationRequest()
Bases: Message
The LiveScanServiceGetConfigurationRequest class.
LiveScanServiceGetConfigurationResponse
dataclass
#
LiveScanServiceGetConfigurationResponse(config: LiveScanServiceConfiguration = betterproto.message_field(1))
Bases: Message
Request for getting the configuration.
Attributes:
-
config(LiveScanServiceConfiguration) –Configuration.
config
class-attribute
instance-attribute
#
config: LiveScanServiceConfiguration = message_field(1)
Configuration.
LiveScanServiceLoadTrayAndPrescanRequest
dataclass
#
LiveScanServiceLoadTrayAndPrescanRequest()
Bases: Message
The LiveScanServiceLoadTrayAndPrescanRequest class.
LiveScanServiceLoadTrayAndPrescanResponse
dataclass
#
LiveScanServiceLoadTrayAndPrescanResponse(notifications: List[str] = betterproto.string_field(1))
Bases: Message
Empty response upon loading the tray.
Attributes:
-
notifications(List[str]) –The list of notifications.
notifications
class-attribute
instance-attribute
#
notifications: List[str] = string_field(1)
The list of notifications.
LiveScanServiceSetConfigurationRequest
dataclass
#
LiveScanServiceSetConfigurationRequest(config: LiveScanServiceConfiguration = betterproto.message_field(1))
Bases: Message
Request for setting the configuration.
Attributes:
-
config(LiveScanServiceConfiguration) –Configuration.
config
class-attribute
instance-attribute
#
config: LiveScanServiceConfiguration = message_field(1)
Configuration.
LiveScanServiceSetConfigurationResponse
dataclass
#
LiveScanServiceSetConfigurationResponse(notifications: List[str] = betterproto.string_field(1))
Bases: Message
Empty response upon setting the configuration.
Attributes:
-
notifications(List[str]) –The list of notifications.
notifications
class-attribute
instance-attribute
#
notifications: List[str] = string_field(1)
The list of notifications.