DeviceStorageclass Module: zaber_motion.ascii
Class providing access to device storage.
Requires at least Firmware 7.30.
The following example illustrates how you can obtain an instance of this type:
from zaber_motion.ascii import Connection
connection = Connection.open_serial_port('COM3' )
device = connection.get_device(1 )
device_storage = device.storageCopy Methods m erase_key() async available device_storage.erase_key(key)
Erases the device value stored at the provided key.
Arguments Name Type Description key strKey to erase.
Return Value bool A boolean indicating if the key existed.
m get_bool() async available device_storage.get_bool(key)
Gets the value at the provided key interpreted as a boolean.
Arguments Name Type Description key strKey to get the value at.
Return Value bool Stored value.
m get_number() async available device_storage.get_number(key)
Gets the value at the provided key interpreted as a number.
Arguments Name Type Description key strKey to get the value at.
Return Value float Stored value.
m get_string() async available device_storage.get_string(key, decode = False)
Gets the device value stored with the provided key.
Arguments Name Type Description key strKey to read the value of. decode boolWhether the stored value should be decoded. Only use this when reading values set by storage.set with "encode" true.
Return Value str Stored value.
m key_exists() async available device_storage.key_exists(key)
Determines whether a given key exists in device storage.
Arguments Name Type Description key strKey which existence to determine.
Return Value bool True indicating that the key exists, false otherwise.
m list_keys() async available device_storage.list_keys(prefix = None)
Lists the device storage keys matching a given prefix. Omit the prefix to list all the keys.
Arguments Name Type Description prefix Optional[str]Optional key prefix.
Return Value List[str] Storage keys matching the given prefix.
m set_bool() async available device_storage.set_bool(key, value)
Sets the value at the provided key to the provided boolean.
Arguments Name Type Description key strKey to set the value at. value boolValue to set.
m set_number() async available device_storage.set_number(key, value)
Sets the value at the provided key to the provided number.
Arguments Name Type Description key strKey to set the value at. value floatValue to set.
m set_string() async available device_storage.set_string(key, value, encode = False)
Sets the device value stored at the provided key.
Arguments Name Type Description key strKey to set the value at. value strValue to set. encode boolWhether the stored value should be base64 encoded before being stored. This makes the string unreadable to humans using the ASCII protocol, however, values stored this way can be of any length and use non-ASCII and protocol reserved characters.