DeviceManager Class

Namespace: id3.Devices

Definition

Central management entity for devices, facilitating plug-and-play functionality, device tracking, and interaction through a unified interface.

Python

class DeviceManager

Dart

class DeviceManager implements Finalizable

C#

public static partial class DeviceManager

Java

public class DeviceManager implements AutoCloseable, Serializable

Usage

Python

deviceManagerInstance = DeviceManager()
# ...

Explicit destruction

# ...
del deviceManagerInstance

Dart

final deviceManagerInstance = sdk.DeviceManager();
// ...

Explicit destruction

// ...
deviceManagerInstance.dispose()

C#

DeviceManager.Initialize();

Explicit destruction

deviceManagerInstance.Dispose()

Java

try (DeviceManager deviceManagerInstance = new DeviceManager()) {
// ...
}

Explicit destruction

DeviceManager deviceManagerInstance = new DeviceManager();
// ...
deviceManagerInstance.close();

Properties

Name	Type	Description
deviceAddedCallback	PlugAndPlayCallback	Callback for when a new device is added to the system.
deviceChannelList	DeviceChannelList	Maintains a list of all device channels currently in use.
deviceCount	int	Indicates the total number of devices currently active or open.
deviceModelCount	int	Reflects the number of device models currently recognized by the system.
deviceModelList	DeviceModelList	Provides a list of all loaded device models.
deviceRemovedCallback	PlugAndPlayCallback	Callback for when a device is removed from the system.
deviceTypeList	DeviceTypeList	Contains information on different device types managed by the system.
plugAndPlugEnabled	bool	Toggles the plug-and-play process for device detection and management.
pluginList	PluginList	Lists all plugins loaded into the system.

Methods

Name	Description
addPluginPath	Adds a search path for locating device plugins.
checkDeviceModel	Verifies the existence of a specified device model within the system, providing a mechanism to determine if a device model is recognized and managed by the device manager.
doEvent	Executes pending messages in the message loop, applicable when the internal message loop is disabled.
freePlugin	Releases resources associated with a loaded plugin.
getDeviceInfo	Fetches a device object by its ID.
getDeviceInfoList	Retrieves a list of all devices managed by the system.
getDeviceInfoListByType	Gets devices filtered by a specific type.
getDeviceLink	Retrieves the connection link for a specified device.
getDeviceModelName	Gets the model name of a device.
getDeviceName	Obtains the name of a device given its ID.
getDeviceType	Retrieves the type for a specified device.
initialize	Prepares the device manager for operation, optionally initializing an internal message loop.
loadPlugin	Loads a device plugin into the manager.
onDeviceEvent	(C++) Notifies the device manager about specific events occurring for a device, such as state changes or significant operational updates
onDeviceListChanged	(C++) Serves as a notification mechanism within the device manager to signal that the list of devices has been updated
registerDeviceModel	(C++): Incorporates a new device model into the device manager’s registry, enabling the system to recognize and interact with devices of this model
sendDeviceCommand	(C++/dotnet): Sends a command directly to a device.
sendDeviceModelCommand	(C++/dotnet): Dispatches a command to a specific device model.
setPluginDescription	(C++): Defines or updates the description of a plugin within the device manager framework
setPluginVersion	(C++): Assigns a version number to a plugin, typically called during the plugin’s initialization phase
start	Activates the manager and begins the plug-and-play detection process.
stop	Deactivates the manager, halting plug-and-play operations.
unregisterDeviceModel	(C++) Removes a previously registered device model from the device manager’s registry