Interface IDeviceManager

Interface that provides the methods that may be used to open a device and start/stop monitoring device connection/disconnection events.

interface IDeviceManager {
    get deviceConnectedEvent(): IDeviceEvent;
    get deviceDisconnectedEvent(): IDeviceEvent;
    openDevice(serialNumber: string): Promise<IDevice>;
    startMonitoring(): Promise<boolean>;
    stopMonitoring(): Promise<boolean>;
}

Index

Accessors

deviceConnectedEvent deviceDisconnectedEvent

Methods

openDevice startMonitoring stopMonitoring

Accessors

deviceConnectedEvent

get deviceConnectedEvent(): IDeviceEvent
Event that notifies subscribers when a Device has been connected.

Returns IDeviceEvent

deviceDisconnectedEvent

get deviceDisconnectedEvent(): IDeviceEvent
Event that notifies subscribers when a Device has been disconnected.

Returns IDeviceEvent

Methods

openDevice

openDevice(serialNumber: string): Promise<IDevice>
Retrieves an interface to a specific device identified by its serial number.
Parameters
- serialNumber: string
  The serial number of the device.
Returns Promise<IDevice>
- A promise that resolves to an interface for the Device.

startMonitoring

startMonitoring(): Promise<boolean>
Starts monitoring for device connection and disconnection events.

Returns Promise<boolean>
- A promise that resolves to True if device monitoring was started successfully, otherwise false.

stopMonitoring

stopMonitoring(): Promise<boolean>
Stops monitoring for device connection and disconnection events.

Returns Promise<boolean>
- A promise that resolves to True if device monitoring was stopped successfully, otherwise false.