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.
-
LiveScanServiceStub– -
LiveScanServiceBase–
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.
class-attribute
instance-attribute
#
sample_holder_template: str = betterproto.string_field(1)
Gets the type template.
class-attribute
instance-attribute
#
live_scan_detection: bool = betterproto.bool_field(2)
Gets a value indicating whether sample carrier detection is active.
class-attribute
instance-attribute
#
measure_bottom_thickness: bool = betterproto.bool_field(3)
Gets a value indicating whether bottom thickness has to be measured.
class-attribute
instance-attribute
#
determine_bottom_material: bool = betterproto.bool_field(4)
Gets a value indicating whether bottom material determination is active.
class-attribute
instance-attribute
#
create_carrier_overview: bool = betterproto.bool_field(5)
Gets a value indicating whether sample carrier detection is active.
class-attribute
instance-attribute
#
read_barcodes: bool = betterproto.bool_field(6)
Gets a value indicating whether barcodes must be read.
class-attribute
instance-attribute
#
use_left_barcode: bool = betterproto.bool_field(7)
Gets a value indicating whether the left barcode must be read.
class-attribute
instance-attribute
#
use_right_barcode: bool = betterproto.bool_field(8)
Gets a value indicating whether the right barcode must be read.
class-attribute
instance-attribute
#
automatic_live_scan_calibration: bool = betterproto.bool_field(9)
Gets a value indicating whether automatic sample carrier calibration is active.
class-attribute
instance-attribute
#
refractive_index: float = betterproto.double_field(10)
The refractive index of the bottom material of this sample carrier.
class-attribute
instance-attribute
#
material: str = betterproto.string_field(11)
The bottom material of this sample carrier.
dataclass
#
LiveScanServiceEjectTrayRequest()
Bases: Message
The LiveScanServiceEjectTrayRequest class.
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.
class-attribute
instance-attribute
#
notifications: List[str] = betterproto.string_field(1)
The list of notifications.
dataclass
#
LiveScanServiceGetConfigurationRequest()
Bases: Message
The LiveScanServiceGetConfigurationRequest class.
dataclass
#
LiveScanServiceGetConfigurationResponse(config: LiveScanServiceConfiguration = betterproto.message_field(1))
Bases: Message
Request for getting the configuration.
Attributes:
-
config(LiveScanServiceConfiguration) –Configuration.
class-attribute
instance-attribute
#
config: LiveScanServiceConfiguration = betterproto.message_field(1)
Configuration.
dataclass
#
LiveScanServiceLoadTrayAndPrescanRequest()
Bases: Message
The LiveScanServiceLoadTrayAndPrescanRequest class.
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.
class-attribute
instance-attribute
#
notifications: List[str] = betterproto.string_field(1)
The list of notifications.
dataclass
#
LiveScanServiceSetConfigurationRequest(config: LiveScanServiceConfiguration = betterproto.message_field(1))
Bases: Message
Request for setting the configuration.
Attributes:
-
config(LiveScanServiceConfiguration) –Configuration.
class-attribute
instance-attribute
#
config: LiveScanServiceConfiguration = betterproto.message_field(1)
Configuration.
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.
class-attribute
instance-attribute
#
notifications: List[str] = betterproto.string_field(1)
The list of notifications.
Bases: ServiceStub
Methods:
-
eject_tray–Eject tray.
-
get_configuration–Get configuration.
-
load_tray_and_prescan–Load tray and start prescan.
-
set_configuration–Set configuration.
async
#
eject_tray(live_scan_service_eject_tray_request: LiveScanServiceEjectTrayRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> LiveScanServiceEjectTrayResponse
Eject tray.
async
#
get_configuration(live_scan_service_get_configuration_request: LiveScanServiceGetConfigurationRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> LiveScanServiceGetConfigurationResponse
Get configuration.
async
#
load_tray_and_prescan(live_scan_service_load_tray_and_prescan_request: LiveScanServiceLoadTrayAndPrescanRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> LiveScanServiceLoadTrayAndPrescanResponse
Load tray and start prescan.
async
#
set_configuration(live_scan_service_set_configuration_request: LiveScanServiceSetConfigurationRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> LiveScanServiceSetConfigurationResponse
Set configuration.
Bases: ServiceBase
Methods:
-
eject_tray–Eject tray.
-
get_configuration–Get configuration.
-
load_tray_and_prescan–Load tray and start prescan.
-
set_configuration–Set configuration.
async
#
eject_tray(live_scan_service_eject_tray_request: LiveScanServiceEjectTrayRequest) -> LiveScanServiceEjectTrayResponse
Eject tray.
async
#
get_configuration(live_scan_service_get_configuration_request: LiveScanServiceGetConfigurationRequest) -> LiveScanServiceGetConfigurationResponse
Get configuration.
async
#
load_tray_and_prescan(live_scan_service_load_tray_and_prescan_request: LiveScanServiceLoadTrayAndPrescanRequest) -> LiveScanServiceLoadTrayAndPrescanResponse
Load tray and start prescan.
async
#
set_configuration(live_scan_service_set_configuration_request: LiveScanServiceSetConfigurationRequest) -> LiveScanServiceSetConfigurationResponse
Set configuration.