ManagerMatter - Homey Web API

Access this instance at HomeyAPIV3Local.matter.

Extends

HomeyAPIV3.ManagerMatter

Classes

MatterNode

Instance Methods

deleteFabric

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

Scopes

homey.system

HTTP

POST /api/manager/matter/delete-fabric

Parameters

Name	Type	Description
`opts`	object
`deviceId`	string	In `body`
`fabricIndex`	number	In `body`
}

Returns

Promise.<any>

deleteMatterNode

(async) deleteMatterNode(opts)

Scopes

homey.system

HTTP

DELETE /api/manager/matter/node/:id

Parameters

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

deleteNodeFabric

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

Scopes

homey.system

HTTP

DELETE /api/manager/matter/node/:id/fabric/:fabricIndex

Parameters

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

Returns

Promise.<any>

forceNodeUpdate

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

Scopes

homey.system

HTTP

POST /api/manager/matter/node/:id/force-update

Parameters

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

Returns

Promise.<any>

getFabrics

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

Scopes

homey.system.readonly

HTTP

GET /api/manager/matter/fabrics

Parameters

Name	Type	Description
`opts`	object
`deviceId`	string	In `query`
}

Returns

Promise.<any>

getMatterNode

(async) getMatterNode(opts): Promise.<HomeyAPIV3Local.ManagerMatter.MatterNode>

Scopes

homey.system.readonly

HTTP

GET /api/manager/matter/node/:id

Parameters

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

Returns

Promise.<HomeyAPIV3Local.ManagerMatter.MatterNode>

getMatterNodes

(async) getMatterNodes(): Promise.<Object.<string, HomeyAPIV3Local.ManagerMatter.MatterNode>>

Scopes

homey.system.readonly

HTTP

GET /api/manager/matter/nodes

Returns

Promise.<Object.<string, HomeyAPIV3Local.ManagerMatter.MatterNode>>

getNodeAttributes

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

Scopes

homey.system.readonly

HTTP

GET /api/manager/matter/node/:id/attributes

Parameters

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

Returns

Promise.<any>

getNodeAvailableFirmwareUpdate

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

Scopes

homey.system.readonly

HTTP

GET /api/manager/matter/node/:id/firmware-update

Parameters

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

Returns

Promise.<any>

getNodeFabrics

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

Scopes

homey.system.readonly

HTTP

GET /api/manager/matter/node/:id/fabrics

Parameters

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

Returns

Promise.<any>

getOptionPaaSettings

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

Scopes

homey.system

HTTP

GET /api/manager/matter/option/paaSettings

Returns

Promise.<any>

getState

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

Scopes

homey.system.readonly

HTTP

GET /api/manager/matter/state

Returns

Promise.<any>

installNodeAvailableFirmwareUpdate

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

Scopes

homey.system.readonly

HTTP

POST /api/manager/matter/node/:id/firmware-update

Parameters

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

Returns

Promise.<any>

nodeDiagnosticReport

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

Scopes

homey.system.readonly

HTTP

POST /api/manager/matter/node/:id/diagnostic-report

Parameters

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

Returns

Promise.<any>

nodeThreadNetworkInformation

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

Scopes

homey.system.readonly

HTTP

GET /api/manager/matter/node/:id/thread-network

Parameters

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

Returns

Promise.<any>

nodeWiFiNetworkInformation

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

Scopes

homey.system.readonly

HTTP

GET /api/manager/matter/node/:id/wifi-network

Parameters

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

Returns

Promise.<any>

pingNode

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

Scopes

homey.system

HTTP

POST /api/manager/matter/node/:id/ping

Parameters

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

Returns

Promise.<any>

resolveNodeAddress

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

Scopes

homey.system.readonly

HTTP

POST /api/manager/matter/node/:id/resolve-address

Parameters

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

Returns

Promise.<any>

setOptionPaaSettings

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

Scopes

homey.system

HTTP

PUT /api/manager/matter/option/paaSettings

Parameters

Name	Type	Description
`opts`	object
`value`	*	In `body`
}

Returns

Promise.<any>

unsetOptionPaaSettings

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

Scopes

homey.system

HTTP

DELETE /api/manager/matter/option/paaSettings

Returns

Promise.<any>

Events

matternode.create

.on('matternode.create')

Parameters

Name	Type	Description
`matternode`	HomeyAPIV3Local.ManagerMatter.MatterNode

matternode.delete

.on('matternode.delete')

Parameters

Name	Type	Description
`matternode`	HomeyAPIV3Local.ManagerMatter.MatterNode

matternode.update

.on('matternode.update')

Parameters

Name	Type	Description
`matternode`	HomeyAPIV3Local.ManagerMatter.MatterNode