ManagerVirtualDevice

Access this instance at HomeyAPIV3Local.vdevice.

Extends

  • HomeyAPIV3.ManagerVirtualDevice

Classes

Instance Methods

getState

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

Scopes

homey.system.readonly

HTTP

GET /api/manager/vdevice/state

Returns

Promise.<any>

Events

virtualdevicebridge.create

.on('virtualdevicebridge.create')

Parameters

Name Type Description
virtualdevicebridge 		HomeyAPIV3Local.ManagerVirtualDevice.VirtualDeviceHomeyBridge

virtualdevicebridge.delete

.on('virtualdevicebridge.delete')

Parameters

Name Type Description
virtualdevicebridge 		HomeyAPIV3Local.ManagerVirtualDevice.VirtualDeviceHomeyBridge

virtualdevicebridge.update

.on('virtualdevicebridge.update')

Parameters

Name Type Description
virtualdevicebridge 		HomeyAPIV3Local.ManagerVirtualDevice.VirtualDeviceHomeyBridge
info 		object
newValues 		object

An object with only the new values of the virtualdevicebridge
oldValues 		object

An object with only the old values of the virtualdevicebridge
changedKeys 		Array.<string>

An array of keys of the properties that have changed
}

virtualdevicedummysocket.create

.on('virtualdevicedummysocket.create')

Parameters

Name Type Description
virtualdevicedummysocket 		HomeyAPIV3Local.ManagerVirtualDevice.VirtualDeviceDummySocket

virtualdevicedummysocket.delete

.on('virtualdevicedummysocket.delete')

Parameters

Name Type Description
virtualdevicedummysocket 		HomeyAPIV3Local.ManagerVirtualDevice.VirtualDeviceDummySocket

virtualdevicedummysocket.update

.on('virtualdevicedummysocket.update')

Parameters

Name Type Description
virtualdevicedummysocket 		HomeyAPIV3Local.ManagerVirtualDevice.VirtualDeviceDummySocket
info 		object
newValues 		object

An object with only the new values of the virtualdevicedummysocket
oldValues 		object

An object with only the old values of the virtualdevicedummysocket
changedKeys 		Array.<string>

An array of keys of the properties that have changed
}

virtualdeviceenergydongle.create

.on('virtualdeviceenergydongle.create')

Parameters

Name Type Description
virtualdeviceenergydongle 		HomeyAPIV3Local.ManagerVirtualDevice.VirtualDeviceEnergyDongle

virtualdeviceenergydongle.delete

.on('virtualdeviceenergydongle.delete')

Parameters

Name Type Description
virtualdeviceenergydongle 		HomeyAPIV3Local.ManagerVirtualDevice.VirtualDeviceEnergyDongle

virtualdeviceenergydongle.update

.on('virtualdeviceenergydongle.update')

Parameters

Name Type Description
virtualdeviceenergydongle 		HomeyAPIV3Local.ManagerVirtualDevice.VirtualDeviceEnergyDongle
info 		object
newValues 		object

An object with only the new values of the virtualdeviceenergydongle
oldValues 		object

An object with only the old values of the virtualdeviceenergydongle
changedKeys 		Array.<string>

An array of keys of the properties that have changed
}

virtualdevicegroup.create

.on('virtualdevicegroup.create')

Parameters

Name Type Description
virtualdevicegroup 		HomeyAPIV3Local.ManagerVirtualDevice.VirtualDeviceGroup

virtualdevicegroup.delete

.on('virtualdevicegroup.delete')

Parameters

Name Type Description
virtualdevicegroup 		HomeyAPIV3Local.ManagerVirtualDevice.VirtualDeviceGroup

virtualdevicegroup.update

.on('virtualdevicegroup.update')

Parameters

Name Type Description
virtualdevicegroup 		HomeyAPIV3Local.ManagerVirtualDevice.VirtualDeviceGroup
info 		object
newValues 		object

An object with only the new values of the virtualdevicegroup
oldValues 		object

An object with only the old values of the virtualdevicegroup
changedKeys 		Array.<string>

An array of keys of the properties that have changed
}

virtualdeviceinfrared.create

.on('virtualdeviceinfrared.create')

Parameters

Name Type Description
virtualdeviceinfrared 		HomeyAPIV3Local.ManagerVirtualDevice.VirtualDeviceInfrared

virtualdeviceinfrared.delete

.on('virtualdeviceinfrared.delete')

Parameters

Name Type Description
virtualdeviceinfrared 		HomeyAPIV3Local.ManagerVirtualDevice.VirtualDeviceInfrared

virtualdeviceinfrared.update

.on('virtualdeviceinfrared.update')

Parameters

Name Type Description
virtualdeviceinfrared 		HomeyAPIV3Local.ManagerVirtualDevice.VirtualDeviceInfrared
info 		object
newValues 		object

An object with only the new values of the virtualdeviceinfrared
oldValues 		object

An object with only the old values of the virtualdeviceinfrared
changedKeys 		Array.<string>

An array of keys of the properties that have changed
}

virtualdevicematter.create

.on('virtualdevicematter.create')

Parameters

Name Type Description
virtualdevicematter 		HomeyAPIV3Local.ManagerVirtualDevice.VirtualDeviceMatter

virtualdevicematter.delete

.on('virtualdevicematter.delete')

Parameters

Name Type Description
virtualdevicematter 		HomeyAPIV3Local.ManagerVirtualDevice.VirtualDeviceMatter

virtualdevicematter.update

.on('virtualdevicematter.update')

Parameters

Name Type Description
virtualdevicematter 		HomeyAPIV3Local.ManagerVirtualDevice.VirtualDeviceMatter
info 		object
newValues 		object

An object with only the new values of the virtualdevicematter
oldValues 		object

An object with only the old values of the virtualdevicematter
changedKeys 		Array.<string>

An array of keys of the properties that have changed
}

virtualdevicerf433.create

.on('virtualdevicerf433.create')

Parameters

Name Type Description
virtualdevicerf433 		HomeyAPIV3Local.ManagerVirtualDevice.VirtualDeviceRF433

virtualdevicerf433.delete

.on('virtualdevicerf433.delete')

Parameters

Name Type Description
virtualdevicerf433 		HomeyAPIV3Local.ManagerVirtualDevice.VirtualDeviceRF433

virtualdevicerf433.update

.on('virtualdevicerf433.update')

Parameters

Name Type Description
virtualdevicerf433 		HomeyAPIV3Local.ManagerVirtualDevice.VirtualDeviceRF433
info 		object
newValues 		object

An object with only the new values of the virtualdevicerf433
oldValues 		object

An object with only the old values of the virtualdevicerf433
changedKeys 		Array.<string>

An array of keys of the properties that have changed
}

virtualdevicevirtualbutton.create

.on('virtualdevicevirtualbutton.create')

Parameters

Name Type Description
virtualdevicevirtualbutton 		HomeyAPIV3Local.ManagerVirtualDevice.VirtualDeviceVirtualButton

virtualdevicevirtualbutton.delete

.on('virtualdevicevirtualbutton.delete')

Parameters

Name Type Description
virtualdevicevirtualbutton 		HomeyAPIV3Local.ManagerVirtualDevice.VirtualDeviceVirtualButton

virtualdevicevirtualbutton.update

.on('virtualdevicevirtualbutton.update')

Parameters

Name Type Description
virtualdevicevirtualbutton 		HomeyAPIV3Local.ManagerVirtualDevice.VirtualDeviceVirtualButton
info 		object
newValues 		object

An object with only the new values of the virtualdevicevirtualbutton
oldValues 		object

An object with only the old values of the virtualdevicevirtualbutton
changedKeys 		Array.<string>

An array of keys of the properties that have changed
}

virtualdevicevirtualipcamera.create

.on('virtualdevicevirtualipcamera.create')

Parameters

Name Type Description
virtualdevicevirtualipcamera 		HomeyAPIV3Local.ManagerVirtualDevice.VirtualDeviceVirtualIPCamera

virtualdevicevirtualipcamera.delete

.on('virtualdevicevirtualipcamera.delete')

Parameters

Name Type Description
virtualdevicevirtualipcamera 		HomeyAPIV3Local.ManagerVirtualDevice.VirtualDeviceVirtualIPCamera

virtualdevicevirtualipcamera.update

.on('virtualdevicevirtualipcamera.update')

Parameters

Name Type Description
virtualdevicevirtualipcamera 		HomeyAPIV3Local.ManagerVirtualDevice.VirtualDeviceVirtualIPCamera
info 		object
newValues 		object

An object with only the new values of the virtualdevicevirtualipcamera
oldValues 		object

An object with only the old values of the virtualdevicevirtualipcamera
changedKeys 		Array.<string>

An array of keys of the properties that have changed
}

virtualdevicevirtualsocket.create

.on('virtualdevicevirtualsocket.create')

Parameters

Name Type Description
virtualdevicevirtualsocket 		HomeyAPIV3Local.ManagerVirtualDevice.VirtualDeviceVirtualSocket

virtualdevicevirtualsocket.delete

.on('virtualdevicevirtualsocket.delete')

Parameters

Name Type Description
virtualdevicevirtualsocket 		HomeyAPIV3Local.ManagerVirtualDevice.VirtualDeviceVirtualSocket

virtualdevicevirtualsocket.update

.on('virtualdevicevirtualsocket.update')

Parameters

Name Type Description
virtualdevicevirtualsocket 		HomeyAPIV3Local.ManagerVirtualDevice.VirtualDeviceVirtualSocket
info 		object
newValues 		object

An object with only the new values of the virtualdevicevirtualsocket
oldValues 		object

An object with only the old values of the virtualdevicevirtualsocket
changedKeys 		Array.<string>

An array of keys of the properties that have changed
}

virtualdevicezigbee.create

.on('virtualdevicezigbee.create')

Parameters

Name Type Description
virtualdevicezigbee 		HomeyAPIV3Local.ManagerVirtualDevice.VirtualDeviceZigbee

virtualdevicezigbee.delete

.on('virtualdevicezigbee.delete')

Parameters

Name Type Description
virtualdevicezigbee 		HomeyAPIV3Local.ManagerVirtualDevice.VirtualDeviceZigbee

virtualdevicezigbee.update

.on('virtualdevicezigbee.update')

Parameters

Name Type Description
virtualdevicezigbee 		HomeyAPIV3Local.ManagerVirtualDevice.VirtualDeviceZigbee
info 		object
newValues 		object

An object with only the new values of the virtualdevicezigbee
oldValues 		object

An object with only the old values of the virtualdevicezigbee
changedKeys 		Array.<string>

An array of keys of the properties that have changed
}

virtualdevicezwave.create

.on('virtualdevicezwave.create')

Parameters

Name Type Description
virtualdevicezwave 		HomeyAPIV3Local.ManagerVirtualDevice.VirtualDeviceZwave

virtualdevicezwave.delete

.on('virtualdevicezwave.delete')

Parameters

Name Type Description
virtualdevicezwave 		HomeyAPIV3Local.ManagerVirtualDevice.VirtualDeviceZwave

virtualdevicezwave.update

.on('virtualdevicezwave.update')

Parameters

Name Type Description
virtualdevicezwave 		HomeyAPIV3Local.ManagerVirtualDevice.VirtualDeviceZwave
info 		object
newValues 		object

An object with only the new values of the virtualdevicezwave
oldValues 		object

An object with only the old values of the virtualdevicezwave
changedKeys 		Array.<string>

An array of keys of the properties that have changed
}

virtualdriverbridge.create

.on('virtualdriverbridge.create')

Parameters

Name Type Description
virtualdriverbridge 		HomeyAPIV3Local.ManagerVirtualDevice.VirtualDriverHomeyBridge

virtualdriverbridge.delete

.on('virtualdriverbridge.delete')

Parameters

Name Type Description
virtualdriverbridge 		HomeyAPIV3Local.ManagerVirtualDevice.VirtualDriverHomeyBridge

virtualdriverbridge.update

.on('virtualdriverbridge.update')

Parameters

Name Type Description
virtualdriverbridge 		HomeyAPIV3Local.ManagerVirtualDevice.VirtualDriverHomeyBridge
info 		object
newValues 		object

An object with only the new values of the virtualdriverbridge
oldValues 		object

An object with only the old values of the virtualdriverbridge
changedKeys 		Array.<string>

An array of keys of the properties that have changed
}

virtualdriverdummysocket.create

.on('virtualdriverdummysocket.create')

Parameters

Name Type Description
virtualdriverdummysocket 		HomeyAPIV3Local.ManagerVirtualDevice.VirtualDriverDummySocket

virtualdriverdummysocket.delete

.on('virtualdriverdummysocket.delete')

Parameters

Name Type Description
virtualdriverdummysocket 		HomeyAPIV3Local.ManagerVirtualDevice.VirtualDriverDummySocket

virtualdriverdummysocket.update

.on('virtualdriverdummysocket.update')

Parameters

Name Type Description
virtualdriverdummysocket 		HomeyAPIV3Local.ManagerVirtualDevice.VirtualDriverDummySocket
info 		object
newValues 		object

An object with only the new values of the virtualdriverdummysocket
oldValues 		object

An object with only the old values of the virtualdriverdummysocket
changedKeys 		Array.<string>

An array of keys of the properties that have changed
}

virtualdriverenergydongle.create

.on('virtualdriverenergydongle.create')

Parameters

Name Type Description
virtualdriverenergydongle 		HomeyAPIV3Local.ManagerVirtualDevice.VirtualDriverEnergyDongle

virtualdriverenergydongle.delete

.on('virtualdriverenergydongle.delete')

Parameters

Name Type Description
virtualdriverenergydongle 		HomeyAPIV3Local.ManagerVirtualDevice.VirtualDriverEnergyDongle

virtualdriverenergydongle.update

.on('virtualdriverenergydongle.update')

Parameters

Name Type Description
virtualdriverenergydongle 		HomeyAPIV3Local.ManagerVirtualDevice.VirtualDriverEnergyDongle
info 		object
newValues 		object

An object with only the new values of the virtualdriverenergydongle
oldValues 		object

An object with only the old values of the virtualdriverenergydongle
changedKeys 		Array.<string>

An array of keys of the properties that have changed
}

virtualdrivergroup.create

.on('virtualdrivergroup.create')

Parameters

Name Type Description
virtualdrivergroup 		HomeyAPIV3Local.ManagerVirtualDevice.VirtualDriverGroup

virtualdrivergroup.delete

.on('virtualdrivergroup.delete')

Parameters

Name Type Description
virtualdrivergroup 		HomeyAPIV3Local.ManagerVirtualDevice.VirtualDriverGroup

virtualdrivergroup.update

.on('virtualdrivergroup.update')

Parameters

Name Type Description
virtualdrivergroup 		HomeyAPIV3Local.ManagerVirtualDevice.VirtualDriverGroup
info 		object
newValues 		object

An object with only the new values of the virtualdrivergroup
oldValues 		object

An object with only the old values of the virtualdrivergroup
changedKeys 		Array.<string>

An array of keys of the properties that have changed
}

virtualdriverinfrared.create

.on('virtualdriverinfrared.create')

Parameters

Name Type Description
virtualdriverinfrared 		HomeyAPIV3Local.ManagerVirtualDevice.VirtualDriverInfrared

virtualdriverinfrared.delete

.on('virtualdriverinfrared.delete')

Parameters

Name Type Description
virtualdriverinfrared 		HomeyAPIV3Local.ManagerVirtualDevice.VirtualDriverInfrared

virtualdriverinfrared.update

.on('virtualdriverinfrared.update')

Parameters

Name Type Description
virtualdriverinfrared 		HomeyAPIV3Local.ManagerVirtualDevice.VirtualDriverInfrared
info 		object
newValues 		object

An object with only the new values of the virtualdriverinfrared
oldValues 		object

An object with only the old values of the virtualdriverinfrared
changedKeys 		Array.<string>

An array of keys of the properties that have changed
}

virtualdrivermatter.create

.on('virtualdrivermatter.create')

Parameters

Name Type Description
virtualdrivermatter 		HomeyAPIV3Local.ManagerVirtualDevice.VirtualDriverMatter

virtualdrivermatter.delete

.on('virtualdrivermatter.delete')

Parameters

Name Type Description
virtualdrivermatter 		HomeyAPIV3Local.ManagerVirtualDevice.VirtualDriverMatter

virtualdrivermatter.update

.on('virtualdrivermatter.update')

Parameters

Name Type Description
virtualdrivermatter 		HomeyAPIV3Local.ManagerVirtualDevice.VirtualDriverMatter
info 		object
newValues 		object

An object with only the new values of the virtualdrivermatter
oldValues 		object

An object with only the old values of the virtualdrivermatter
changedKeys 		Array.<string>

An array of keys of the properties that have changed
}

virtualdriverrf433.create

.on('virtualdriverrf433.create')

Parameters

Name Type Description
virtualdriverrf433 		HomeyAPIV3Local.ManagerVirtualDevice.VirtualDriverRF433

virtualdriverrf433.delete

.on('virtualdriverrf433.delete')

Parameters

Name Type Description
virtualdriverrf433 		HomeyAPIV3Local.ManagerVirtualDevice.VirtualDriverRF433

virtualdriverrf433.update

.on('virtualdriverrf433.update')

Parameters

Name Type Description
virtualdriverrf433 		HomeyAPIV3Local.ManagerVirtualDevice.VirtualDriverRF433
info 		object
newValues 		object

An object with only the new values of the virtualdriverrf433
oldValues 		object

An object with only the old values of the virtualdriverrf433
changedKeys 		Array.<string>

An array of keys of the properties that have changed
}

virtualdrivervirtualbutton.create

.on('virtualdrivervirtualbutton.create')

Parameters

Name Type Description
virtualdrivervirtualbutton 		HomeyAPIV3Local.ManagerVirtualDevice.VirtualDriverVirtualButton

virtualdrivervirtualbutton.delete

.on('virtualdrivervirtualbutton.delete')

Parameters

Name Type Description
virtualdrivervirtualbutton 		HomeyAPIV3Local.ManagerVirtualDevice.VirtualDriverVirtualButton

virtualdrivervirtualbutton.update

.on('virtualdrivervirtualbutton.update')

Parameters

Name Type Description
virtualdrivervirtualbutton 		HomeyAPIV3Local.ManagerVirtualDevice.VirtualDriverVirtualButton
info 		object
newValues 		object

An object with only the new values of the virtualdrivervirtualbutton
oldValues 		object

An object with only the old values of the virtualdrivervirtualbutton
changedKeys 		Array.<string>

An array of keys of the properties that have changed
}

virtualdrivervirtualipcamera.create

.on('virtualdrivervirtualipcamera.create')

Parameters

Name Type Description
virtualdrivervirtualipcamera 		HomeyAPIV3Local.ManagerVirtualDevice.VirtualDriverVirtualIPCamera

virtualdrivervirtualipcamera.delete

.on('virtualdrivervirtualipcamera.delete')

Parameters

Name Type Description
virtualdrivervirtualipcamera 		HomeyAPIV3Local.ManagerVirtualDevice.VirtualDriverVirtualIPCamera

virtualdrivervirtualipcamera.update

.on('virtualdrivervirtualipcamera.update')

Parameters

Name Type Description
virtualdrivervirtualipcamera 		HomeyAPIV3Local.ManagerVirtualDevice.VirtualDriverVirtualIPCamera
info 		object
newValues 		object

An object with only the new values of the virtualdrivervirtualipcamera
oldValues 		object

An object with only the old values of the virtualdrivervirtualipcamera
changedKeys 		Array.<string>

An array of keys of the properties that have changed
}

virtualdrivervirtualsocket.create

.on('virtualdrivervirtualsocket.create')

Parameters

Name Type Description
virtualdrivervirtualsocket 		HomeyAPIV3Local.ManagerVirtualDevice.VirtualDriverVirtualSocket

virtualdrivervirtualsocket.delete

.on('virtualdrivervirtualsocket.delete')

Parameters

Name Type Description
virtualdrivervirtualsocket 		HomeyAPIV3Local.ManagerVirtualDevice.VirtualDriverVirtualSocket

virtualdrivervirtualsocket.update

.on('virtualdrivervirtualsocket.update')

Parameters

Name Type Description
virtualdrivervirtualsocket 		HomeyAPIV3Local.ManagerVirtualDevice.VirtualDriverVirtualSocket
info 		object
newValues 		object

An object with only the new values of the virtualdrivervirtualsocket
oldValues 		object

An object with only the old values of the virtualdrivervirtualsocket
changedKeys 		Array.<string>

An array of keys of the properties that have changed
}

virtualdriverzigbee.create

.on('virtualdriverzigbee.create')

Parameters

Name Type Description
virtualdriverzigbee 		HomeyAPIV3Local.ManagerVirtualDevice.VirtualDriverZigbee

virtualdriverzigbee.delete

.on('virtualdriverzigbee.delete')

Parameters

Name Type Description
virtualdriverzigbee 		HomeyAPIV3Local.ManagerVirtualDevice.VirtualDriverZigbee

virtualdriverzigbee.update

.on('virtualdriverzigbee.update')

Parameters

Name Type Description
virtualdriverzigbee 		HomeyAPIV3Local.ManagerVirtualDevice.VirtualDriverZigbee
info 		object
newValues 		object

An object with only the new values of the virtualdriverzigbee
oldValues 		object

An object with only the old values of the virtualdriverzigbee
changedKeys 		Array.<string>

An array of keys of the properties that have changed
}

virtualdriverzwave.create

.on('virtualdriverzwave.create')

Parameters

Name Type Description
virtualdriverzwave 		HomeyAPIV3Local.ManagerVirtualDevice.VirtualDriverZwave

virtualdriverzwave.delete

.on('virtualdriverzwave.delete')

Parameters

Name Type Description
virtualdriverzwave 		HomeyAPIV3Local.ManagerVirtualDevice.VirtualDriverZwave

virtualdriverzwave.update

.on('virtualdriverzwave.update')

Parameters

Name Type Description
virtualdriverzwave 		HomeyAPIV3Local.ManagerVirtualDevice.VirtualDriverZwave
info 		object
newValues 		object

An object with only the new values of the virtualdriverzwave
oldValues 		object

An object with only the old values of the virtualdriverzwave
changedKeys 		Array.<string>

An array of keys of the properties that have changed
}