ifm3dpy.device.O3RSealedBox
- class ifm3dpy.device.O3RSealedBox
Bases:
None
The O3RSealedBox class provides access to the SealedBox. The SealedBox is used to for accessing the password protected features of the device
- __init__(*args, **kwargs)
Methods
__init__
(*args, **kwargs)get_public_key
(self)Get the public key of the device used for sending encrypted messages
is_password_protected
(self)Returns whether the device is password protected
remove_password
(self, password)Removes the password protection from the device
set
(self, password, configuration)Sets the configuration of the device.
set_password
(self, new_password[, old_password])Locks the password for the device.
- get_public_key(self: ifm3dpy.device.O3RSealedBox) numpy.ndarray
Get the public key of the device used for sending encrypted messages
- Returns:
The public key of the device
- Return type:
numpy.ndarray
- is_password_protected(self: ifm3dpy.device.O3RSealedBox) bool
Returns whether the device is password protected
- remove_password(self: ifm3dpy.device.O3RSealedBox, password: str) None
Removes the password protection from the device
- Parameters:
password (str) – The current password for the device
- set(self: ifm3dpy.device.O3RSealedBox, password: str, configuration: dict) None
Sets the configuration of the device. This allows setting password protected parameters.
- Parameters:
password (str) – The current password for the device
configuration (dict) – The new configuration for the device
- set_password(self: ifm3dpy.device.O3RSealedBox, new_password: str, old_password: Optional[str] = None) None
Locks the password for the device. If the device is currently locked, requires the correct old password.
- Parameters:
new_password (str) – The new password for the device
old_password (str, optional) – The old password for the device. Required if the device is currently locked.