Access this instance at HomeyAPIV3Local.matter
.
Extends
- HomeyAPIV3.ManagerMatter
Classes
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 |
fabricIndex
|
number | In |
|
Returns
deleteMatterNode
(async) deleteMatterNode(opts)Scopes
homey.system
HTTP
DELETE /api/manager/matter/node/:id
Parameters
Name | Type | Description |
---|---|---|
opts
|
object | |
id
|
string | In |
|
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 |
id
|
string | In |
|
Returns
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 |
|
Returns
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 |
|
Returns
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 |
|
Returns
getMatterNodes
(async) getMatterNodes(): Promise.<Object.<string, HomeyAPIV3Local.ManagerMatter.MatterNode>>Scopes
homey.system.readonly
HTTP
GET /api/manager/matter/nodes
Returns
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 |
|
Returns
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 |
|
Returns
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 |
|
Returns
getOptionPaaSettings
(async) getOptionPaaSettings(): Promise.<any>Scopes
homey.system
HTTP
GET /api/manager/matter/option/paaSettings
Returns
getState
(async) getState(): Promise.<any>Scopes
homey.system.readonly
HTTP
GET /api/manager/matter/state
Returns
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 |
softwareVersion
|
number | In |
|
Returns
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 |
|
Returns
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 |
|
Returns
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 |
|
Returns
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 |
|
Returns
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 |
|
Returns
setOptionPaaSettings
(async) setOptionPaaSettings(opts): Promise.<any>Scopes
homey.system
HTTP
PUT /api/manager/matter/option/paaSettings
Parameters
Name | Type | Description |
---|---|---|
opts
|
object | |
value
|
* | In |
|
Returns
unsetOptionPaaSettings
(async) unsetOptionPaaSettings(): Promise.<any>Scopes
homey.system
HTTP
DELETE /api/manager/matter/option/paaSettings
Returns
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 |