ManagerDrivers

Access this instance at HomeyAPIV2.drivers.

Extends

Classes

Instance Properties

homey

homey: HomeyAPIV3

The Homey of the Manager.

Type

uri

uri: String

The URI of the Item, e.g. homey:manager:bar.

Type

  • String

Instance Methods

addListener

addListener(event, callback)

Parameters

Name Type Description
event 		string
callback 		function

connect

(async) connect(): Promise.<void>

Connect to this manager's Socket.io namespace.

Returns

Promise.<void>

createPairSession

(async) createPairSession(opts): Promise.<HomeyAPIV2.ManagerDrivers.PairSession>

Scopes

homey.device

HTTP

POST /api/manager/drivers/pairsession

Parameters

Name Type Description
opts 		object
pairsession 		*
}

Returns

Promise.<HomeyAPIV2.ManagerDrivers.PairSession>

createPairSessionDevice

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

Scopes

homey.device

HTTP

POST /api/manager/drivers/pairsession/:id/device

Parameters

Name Type Description
opts 		object
id 		string
device 		*
}

Returns

Promise.<any>

deletePairSession

(async) deletePairSession(opts)

Scopes

homey.device

HTTP

DELETE /api/manager/drivers/pairsession/:id

Parameters

Name Type Description
opts 		object
id 		string
}

deletePairSessionDevice

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

Scopes

homey.device

HTTP

DELETE /api/manager/drivers/pairsession/:id/device

Parameters

Name Type Description
opts 		object
id 		string
}

Returns

Promise.<any>

destroy

destroy()

Destroy this Manager by cleaning up all references, unbinding event listeners and disconnecting from the Socket.io namespace.

disconnect

(async) disconnect(): Promise.<void>

Disconnect from this manager's Socket.io namespace.

Returns

Promise.<void>

emit

emit(event, …data)

Parameters

Name Type Description
event 		string
data 		any <repeatable>

emitPairingCallback

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

Scopes

homey.device

HTTP

POST /api/manager/drivers/pairsession/:id/callback

Parameters

Name Type Description
opts 		object
id 		string
data 		object <optional>
callbackId 		string
}

Returns

Promise.<any>

emitPairingEvent

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

Scopes

homey.device

HTTP

POST /api/manager/drivers/pairsession/:id/emit

Parameters

Name Type Description
opts 		object
id 		string
data 		*
event 		string
}

Returns

Promise.<any>

emitPairingHeartbeat

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

Scopes

homey.device

HTTP

POST /api/manager/drivers/pairsession/:id/heartbeat

Parameters

Name Type Description
opts 		object
id 		string
}

Returns

Promise.<any>

getDriver

(async) getDriver(opts): Promise.<HomeyAPIV2.ManagerDrivers.Driver>

Scopes

homey.device

HTTP

GET /api/manager/drivers/driver/:uri/:id

Parameters

Name Type Description
opts 		object
id 		string
uri 		string
}

Returns

Promise.<HomeyAPIV2.ManagerDrivers.Driver>

getDrivers

(async) getDrivers(): Promise.<Object.<string, HomeyAPIV2.ManagerDrivers.Driver>>

Scopes

homey.device.readonly

HTTP

GET /api/manager/drivers/driver

Returns

Promise.<Object.<string, HomeyAPIV2.ManagerDrivers.Driver>>

getPairSession

(async) getPairSession(opts): Promise.<HomeyAPIV2.ManagerDrivers.PairSession>

Scopes

homey.device

HTTP

GET /api/manager/drivers/pairsession/:id

Parameters

Name Type Description
opts 		object
id 		string
}

Returns

Promise.<HomeyAPIV2.ManagerDrivers.PairSession>

getPairSessions

(async) getPairSessions(): Promise.<Object.<string, HomeyAPIV2.ManagerDrivers.PairSession>>

Scopes

homey.device

HTTP

GET /api/manager/drivers/pairsession

Returns

Promise.<Object.<string, HomeyAPIV2.ManagerDrivers.PairSession>>

isConnected

isConnected(): Boolean

If this manager's namespace is connected to Socket.io.

Returns

Boolean

off

off(event, callback)

Parameters

Name Type Description
event 		string
callback 		function

on

on(event, callback)

Parameters

Name Type Description
event 		string
callback 		function

once

once(event, callback)

Parameters

Name Type Description
event 		string
callback 		function

removeAllListeners

removeAllListeners(eventopt)

Parameters

Name Type Description
event 		string <optional>

removeListener

removeListener(event, callback)

Shortcut to EventEmitter#off

Parameters

Name Type Description
event 		string
callback 		function

Events

device.create

.on('device.create')

Parameters

Name Type Description
device 		HomeyAPIV2.ManagerDrivers.Device

device.delete

.on('device.delete')

Parameters

Name Type Description
device 		HomeyAPIV2.ManagerDrivers.Device

device.update

.on('device.update')

Parameters

Name Type Description
device 		HomeyAPIV2.ManagerDrivers.Device

driver.create

.on('driver.create')

Parameters

Name Type Description
driver 		HomeyAPIV2.ManagerDrivers.Driver

driver.delete

.on('driver.delete')

Parameters

Name Type Description
driver 		HomeyAPIV2.ManagerDrivers.Driver

driver.update

.on('driver.update')

Parameters

Name Type Description
driver 		HomeyAPIV2.ManagerDrivers.Driver

pairsession.create

.on('pairsession.create')

Parameters

Name Type Description
pairsession 		HomeyAPIV2.ManagerDrivers.PairSession

pairsession.delete

.on('pairsession.delete')

Parameters

Name Type Description
pairsession 		HomeyAPIV2.ManagerDrivers.PairSession

pairsession.update

.on('pairsession.update')

Parameters

Name Type Description
pairsession 		HomeyAPIV2.ManagerDrivers.PairSession