Documentation

Module: xcf/manager/DeviceManager

new (require("xcf/manager/DeviceManager"))()

Common base class, for server and client.

Source:
xcf/manager/DeviceManager.js

Methods

<inner> createDriverInstance(deviceInfo, driverBase, device)

Creates a driver instance per device

Parameters:
Name Type Description
deviceInfo module:xide/types~DeviceInfo

The device info
driverBase module:xcf/driver/DriverBase

The driver base class
device module:xcf/model/Device

The device model item
Source:
xcf/manager/DeviceManager.js

<inner> getDeviceByHost(host, port)

Return device by host and port

Parameters:
Name Type Description
host string
port string
Source:
xcf/manager/DeviceManager.js
Returns:
Type
module:xcf/model/Device | null

<inner> getDeviceById(id)

Returns a device by id

Parameters:
Name Type Description
id string
Source:
xcf/manager/DeviceManager.js
Returns:
Type
module:xcf/model/Device | null

<inner> getDevices(enabledOnly, addDriver)

Get all enabled devices

Parameters:
Name Type Description
enabledOnly
addDriver
Source:
xcf/manager/DeviceManager.js
Returns:
Type
Array.<module:xcf/model/Device>

<inner> getDevicesByDriverId(id)

Returns all devices by driver id

Parameters:
Name Type Description
id string

the driver id
Source:
xcf/manager/DeviceManager.js
Returns:
Type
Array.<module:xcf/model/Device>

<inner> getDeviceStatusIcon(item)

Return the device's status icon

Parameters:
Name Type Description
item module:xcf/model/Device

The device
Source:
xcf/manager/DeviceManager.js
Returns:

an icon class string

Type
string

<inner> getItemById(itemId)

Return device model item by device id

Parameters:
Name Type Description
itemId
Source:
xcf/manager/DeviceManager.js
Returns:

The device

Type
module:xcf/model/Device

<inner> getMetaValue(item, name)

Parameters:
Name Type Description
item module:xcf/model/Device

the device
name string

the name of the CI
Source:
xcf/manager/DeviceManager.js
Returns:
Type
string | int | object | null

<inner> onDeviceStarted(driverInstance, deviceStoreItem, driver)

Callback when we are connected to a device.
We use this to fire all looping blocks

Parameters:
Name Type Description
driverInstance module:xcf/driver/DriverBase

the instance of the driver
deviceStoreItem module:xcf/model/Device

the device model item
driver module:xcf/model/Driver

the driver model item
Source:
xcf/manager/DeviceManager.js

<inner> stopDevice(item)

Stops a device with a device model item

Parameters:
Name Type Description
item module:xcf/model/Device | string
Source:
xcf/manager/DeviceManager.js

<inner> toDeviceControlInfo(item)

Return handy info for a device

Parameters:
Name Type Description
item module:xcf/model/Device
Source:
xcf/manager/DeviceManager.js
Returns:
Type
module:xide/types~DeviceInfo