ManagerDevices - Homey Web API

Access this instance at HomeyAPIV3Cloud.devices.

Extends

HomeyAPIV3.ManagerDevices

Classes

Instance Methods

createGroup

(async) createGroup(opts): Promise.<any>

Scopes

homey.device

HTTP

POST /api/manager/devices/group

Parameters

Name	Type	Description
`opts`	object
`group`	object	In `body`
`name`	string
`class`	string
`zoneId`	string
`deviceIds`	array
`iconOverride`	string <optional>
`iconDeviceId`	string <optional>
}
}

Returns

Promise.<any>

deleteDevice

(async) deleteDevice(opts)

Scopes

homey.device

HTTP

DELETE /api/manager/devices/device/:id

Parameters

Name	Type	Description
`opts`	object
`id`	string	In `path`
}

deleteDeviceFromGroup

(async) deleteDeviceFromGroup(opts): Promise.<any>

Scopes

homey.device

HTTP

DELETE /api/manager/devices/group/:groupId/device/:deviceId

Parameters

Name	Type	Description
`opts`	object
`deviceId`	string	In `path`
`groupId`	string	In `path`
}

Returns

Promise.<any>

getCapabilityValue

(async) getCapabilityValue(opts): Promise.<any>

Scopes

homey.device.readonly

HTTP

GET /api/manager/devices/device/:deviceId/capability/:capabilityId

Parameters

Name	Type	Description
`opts`	object
`capabilityId`	string	In `path`
`deviceId`	string	In `path`
}

Returns

Promise.<any>

getDevice

(async) getDevice(opts): Promise.<HomeyAPIV3Cloud.ManagerDevices.Device>

Scopes

homey.device.readonly

HTTP

GET /api/manager/devices/device/:id

Parameters

Name	Type	Description
`opts`	object
`id`	string	In `path`
}

Returns

Promise.<HomeyAPIV3Cloud.ManagerDevices.Device>

getDeviceSettingsObj

(async) getDeviceSettingsObj(opts): Promise.<any>

Scopes

homey.device.readonly

HTTP

GET /api/manager/devices/device/:id/settings_obj

Parameters

Name	Type	Description
`opts`	object
`id`	string	In `path`
}

Returns

Promise.<any>

getDevices

(async) getDevices(): Promise.<Object.<string, HomeyAPIV3Cloud.ManagerDevices.Device>>

Scopes

homey.device.readonly

HTTP

GET /api/manager/devices/device

Returns

Promise.<Object.<string, HomeyAPIV3Cloud.ManagerDevices.Device>>

getState

(async) getState(): Promise.<any>

Scopes

homey.system.readonly

HTTP

GET /api/manager/devices/state

Returns

Promise.<any>

hideDeviceFromExternalService

(async) hideDeviceFromExternalService(opts): Promise.<any>

Scopes

homey.device

HTTP

PUT /api/manager/devices/device/:id/external-service-hide

Parameters

Name	Type	Description
`opts`	object
`id`	string	In `path`
`service`	string	In `body`
}

Returns

Promise.<any>

setCapabilityValue

(async) setCapabilityValue(opts): Promise.<any>

Scopes

homey.device.control

HTTP

PUT /api/manager/devices/device/:deviceId/capability/:capabilityId

Parameters

Name	Type	Description
`opts`	object
`capabilityId`	string	In `path`
`deviceId`	string	In `path`
`value`	string \| number \| boolean	In `body`
`opts`	object <optional>	In `body`
`transactionId`	string <optional>	In `body`
}

Returns

Promise.<any>

setDeviceSettings

(async) setDeviceSettings(opts): Promise.<any>

Scopes

homey.device

HTTP

PUT /api/manager/devices/device/:id/settings

Parameters

Name	Type	Description
`opts`	object
`id`	string	In `path`
`settings`	object	In `body`
}

Returns

Promise.<any>

unhideDeviceFromExternalService

(async) unhideDeviceFromExternalService(opts): Promise.<any>

Scopes

homey.device

HTTP

PUT /api/manager/devices/device/:id/external-service-unhide

Parameters

Name	Type	Description
`opts`	object
`id`	string	In `path`
`service`	string	In `body`
}

Returns

Promise.<any>

updateDevice

(async) updateDevice(opts): Promise.<HomeyAPIV3Cloud.ManagerDevices.Device>

Scopes

homey.device

HTTP

PUT /api/manager/devices/device/:id

Parameters

Name	Type	Description
`opts`	object
`id`	string	In `path`
`device`	object	In `body`
`name`	string <optional>
`zone`	string <optional>
`note`	string <optional>
`iconOverride`	string <optional>
`virtualClass`	string <optional>
`uiIndicator`	string <optional>
`hidden`	boolean <optional>
}
}

Returns

Promise.<HomeyAPIV3Cloud.ManagerDevices.Device>

updateGroup

(async) updateGroup(opts): Promise.<any>

Scopes

homey.device

HTTP

PUT /api/manager/devices/group/:id

Parameters

Name	Type	Description
`opts`	object
`id`	string	In `path`
`group`	object	In `body`
`name`	string <optional>
`deviceIds`	array <optional>
`iconOverride`	string <optional>
`iconDeviceId`	string <optional>
}
}

Returns

Promise.<any>

Events

capability.create

.on('capability.create')

Parameters

Name	Type	Description
`capability`	HomeyAPIV3Cloud.ManagerDevices.Capability

capability.delete

.on('capability.delete')

Parameters

Name	Type	Description
`capability`	HomeyAPIV3Cloud.ManagerDevices.Capability

capability.update

.on('capability.update')

Parameters

Name	Type	Description
`capability`	HomeyAPIV3Cloud.ManagerDevices.Capability

device.create

.on('device.create')

Parameters

Name	Type	Description
`device`	HomeyAPIV3Cloud.ManagerDevices.Device

device.delete

.on('device.delete')

Parameters

Name	Type	Description
`device`	HomeyAPIV3Cloud.ManagerDevices.Device

device.update

.on('device.update')

Parameters

Name	Type	Description
`device`	HomeyAPIV3Cloud.ManagerDevices.Device