Skip to content

IdReader#

This is the class for python devices that act as an id reader. Inherit from this class instead of Device to mark the device as an id reader. This class inherits from Device.


property caption#

The name of the id reader in a good human-readable format as this may be used in a user interface.

Returns#

Type Description
str The name of the id reader.

property identification#

The identification string of the id reader that could contain the model number, serial number, or any other unique identifier of the id reader.

Returns#

Type Description
str The identification string of the id reader.

method read_id()#

Method can be overridden and reads and returns the id (e.g. the wafer id).

Returns#

Type Description
str The id that was read.

method get_last_image(file_path: str)#

Method can be overridden and saves the image of the last read to the given file. Only called if the configuration of the id reader indicates image capture support (see supports_image_capture of the IdReaderConfiguration).

Parameters#

Name Description
file_path The file the image is saved to.

Returns#

Type Description
str The file path.

method shutdown()#

Method can be overridden and shuts down the id reader. This method must take care that the id reader is in a safe condition.