Device as returned by HomeyAPIV2.ManagerDevices.
Classes
Properties
available
available: booleanType
- boolean
capabilities
capabilities: arrayType
- array
capabilitiesObj
capabilitiesObj: objectType
- object
capabilitiesOptions
capabilitiesOptions: objectType
- object
class
class: stringType
- string
color
color: stringType
- string
data
data: objectType
- object
driverId
driverId: stringType
- string
driverUri
driverUri: stringType
- string
energy
energy: objectType
- object
energyObj
energyObj: objectType
- object
flags
flags: arrayType
- array
icon
icon: stringType
- string
iconObj
iconObj: objectType
- object
iconOverride
iconOverride: string|nullType
- string | null
id
id: stringType
- string
images
images: arrayType
- array
insights
insights: arrayType
- array
name
name: stringType
- string
ready
ready: booleanType
- boolean
repair
repair: booleanType
- boolean
settings
settings: objectType
- object
settingsObj
settingsObj: booleanType
- boolean
ui
ui: objectType
- object
uiIndicator
uiIndicator: string|nullType
- string | null
unpair
unpair: booleanType
- boolean
virtualClass
virtualClass: string|nullType
- string | null
zone
zone: stringType
- string
Methods
makeCapabilityInstance
makeCapabilityInstance(capabilityId, listener): HomeyAPIV2.ManagerDevices.Device.DeviceCapabilityCreates an HomeyAPIV2.DeviceCapability for realtime capability updates.
Parameters
Name | Type | Description |
---|---|---|
capabilityId
|
string | |
listener
|
function | |
value
|
number | boolean | string | |
|
Returns
Example
const onOffInstance = device.makeCapabilityInstance('onoff', value => {
console.log('Device onoff changed to:', value);
});
// Turn on
onOffInstance.setValue(true).catch(console.error);
setCapabilityValue
(async) setCapabilityValue(opts): Promise.<void>Sets a capability's value.
Parameters
Name | Type | Description |
---|---|---|
opts
|
object | |
capabilityId
|
string | |
value
|
number | boolean | string | |
opts
|
object
<optional> |
|
duration
|
number
<optional> |
|
|
||
|
Returns
Promise.<void>
Events
delete
.on('delete')update
.on('update')Parameters
Name | Type | Description |
---|---|---|
device
|
object |