ManagerDrivers

Access this instance at HomeyAPIV3Local.drivers.

Extends

Classes

Methods

connect

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

Connect to the realtime namespace.

Returns

Promise.<void>

createPairSession

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

Scopes

homey.device

HTTP

POST /api/manager/drivers/pairsession

Parameters

Name Type Description
opts
object
pairsession
object
type
string
driverId
string
deviceId
string <optional>
zoneId
string <optional>
}
}

Returns

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
object
name
string
data
*
zone
string <optional>
store
object <optional>
capabilities
array <optional>
capabilitiesOptions
object <optional>
class
string <optional>
icon
string <optional>
iconOverride
string <optional>
settings
object <optional>
energy
object <optional>
}
}

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>

disconnect

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

Disconnect from the realtime namespace.

Returns

Promise.<void>

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
callbackId
string
data
object
}

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
event
string
data
object
}

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>

getDrivers

(async) getDrivers(): Promise.<HomeyAPIV3Local.ManagerDrivers.Driver>

Scopes

homey.device.readonly

HTTP

GET /api/manager/drivers/driver

Returns

getPairSession

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

Scopes

homey.device

HTTP

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

Parameters

Name Type Description
opts
object
id
string
}

Returns

getState

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

Scopes

homey.system.readonly

HTTP

GET /api/manager/drivers/state

Returns

Promise.<any>

isConnected

isConnected(): Boolean

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

Returns

Boolean

Events

driver.create

.on('driver.create')

Parameters

Name Type Description
driver
HomeyAPIV3Local.ManagerDrivers.Driver

driver.delete

.on('driver.delete')

Parameters

Name Type Description
driver
HomeyAPIV3Local.ManagerDrivers.Driver

driver.update

.on('driver.update')

Parameters

Name Type Description
driver
HomeyAPIV3Local.ManagerDrivers.Driver

pairsession.create

.on('pairsession.create')

Parameters

Name Type Description
pairsession
HomeyAPIV3Local.ManagerDrivers.PairSession

pairsession.delete

.on('pairsession.delete')

Parameters

Name Type Description
pairsession
HomeyAPIV3Local.ManagerDrivers.PairSession

pairsession.update

.on('pairsession.update')

Parameters

Name Type Description
pairsession
HomeyAPIV3Local.ManagerDrivers.PairSession