Scanbot SDK library initialization and license management. More...

Classes
class	DeviceSession

Functions
None	initialize (Optional[str] license_key, str writeable_path=".")
	Initialize the Scanbot SDK with the given license key.

None	deregister_device ()
	Effectively notifies the server that the license is no longer used by this device.

None	wait_for_device_deregistration_completion (int timeout_ms)
	Wait for the completion of the all device deregistration processes.

None	wait_for_online_license_check_completion (int timeout_ms)

LicenseInfo	get_license_info ()
	Get the status of the license.

str	get_git_version ()
	Get the version of the Scanbot SDK.

None	set_logging (bool enable)
	Enable or disable logging.

Detailed Description

Scanbot SDK library initialization and license management.

Function Documentation

◆ deregister_device()

None deregister_device ( )

Effectively notifies the server that the license is no longer used by this device.

After calling the method SDK behaves like no license is available. You should call this method if you are using floating license to notify the server that the device is no longer using the license and so another device can use it. If you are using a floating license, but you do not call this method, the license will be released automatically after a period specified in the license. If during work with the SDK you initialize the SDK with multiple licenses, there is no need to call the function after finishing work with each of the licenses, only with the last one. For others, the function is implicitly called automatically. The function returns immediately, but the deregistration process may take some time.

◆ initialize()

None initialize	(	Optional[str]	license_key,
		str	writeable_path = "." )

Initialize the Scanbot SDK with the given license key.

Must be called before using any other functions in the SDK.

◆ wait_for_device_deregistration_completion()

None wait_for_device_deregistration_completion ( int timeout_ms )

Wait for the completion of the all device deregistration processes.

Returns immediately if there's no deregistration in progress.

Parameters

timeout_ms Timeout in milliseconds.

◆ wait_for_online_license_check_completion()

None wait_for_online_license_check_completion ( int timeout_ms )

Wait for the completion of the online license check. Returns immediately if there's no online license check in progress.
Parameters

timeout_ms Timeout in milliseconds. */