cloud.smarthq.service.matter.v1¶

State

A list of the states this service can be in.

Go There
Commands

How to change the state of the service.

Go There
Data Types

All the data types used for this service.

Go There

Description¶

Service for allow Matter communication

Example Device Response (Digital Twin API)¶

Service representing matter service connectivity

{
  "adapterId": "0000000000000000000000000000000000000000",
  "alertTypes": [],
  "createdDateTime": "2022-03-04T12:12:12.123Z",
  "deviceId": "0000000000000000000000000000000000000000000000000000000000000000",
  "deviceType": "cloud.smarthq.device.airconditioner",
  "gatewayId": "0000000000000000000000000000000000000000000000000000000000000000",
  "kind": "device#item",
  "lastPresenceTime": "2022-03-04T12:12:12.123Z",
  "lastSyncTime": "2022-03-04T12:12:12.123Z",
  "presence": "OFFLINE",
  "removable": true,
  "services": [
    {
      "serviceType": "cloud.smarthq.service.matter.v1",
      "lastSyncTime": "2022-03-04T12:12:12.123Z",
      "domainType": "cloud.smarthq.domain.matter.v1",
      "supportedCommands": [
        "cloud.smarthq.command.matter.v1.commisioning.open"
      ],
      "state": {
        "matterCommisioningStatus": "Open",
        "matterPairingCode": "1231-123123R-123123123-1234",
        "matterCommissioningCounter": 4.0,
        "matterMobileRequestId": "AASF12FAS",
        "matterProductId": "DC12SAASDSA",
        "matterDeviceRequestId": "AASF12FAS"
      },
      "serviceId": "0000000000000000000000000000000000000000000000000000000000000000",
      "serviceDeviceType": "cloud.smarthq.device.airconditioner",
      "config": {},
      "lastStateTime": "2022-03-04T12:12:12.123Z"
    }
  ],
  "userId": "000000000000000"
}

State¶

The following are properties for the device state report as part of the "state" object for each individual service.

Field Name	Property Type	Required
disabled	BOOLEAN	No
matterCommisioningStatus	STRING	Yes
matterCommissioningCounter	INTEGER	Yes
matterDeviceRequestId	STRING	Yes
matterMobileRequestId	STRING	No
matterPairingCode	STRING	No
matterProductId	STRING	Yes

Commands¶

The following are properties for both the Digital Twin API to send a command to the device as well as the properties passed as part of a command to the gateway to be processed by the device itself.

cloud.smarthq.command.matter.v1.commisioning.open¶

Command to open commissioning window for matter device enabled.

Field Name	Property Type	Required
requestId	STRING	Yes
requestState	STRING	Yes

Example Commands¶

Command to set matter connectivity

{
  "command": {
    "commandType": "cloud.smarthq.command.matter.v1.commisioning.open",
    "requestId": "FA1241M-0124",
    "requestState": "0"
  },
  "deviceId": "00000000000000000000000000000000000000000000000000000000000000",
  "domainType": "cloud.smarthq.domain.matter.v1",
  "kind": "service#command",
  "serviceDeviceType": "cloud.smarthq.device.airconditioner",
  "serviceType": "cloud.smarthq.service.matter.v1"
}

Supported Outcomes¶

Each service has an allow listed set of outcomes that the device may return when asked to execute a command.

Outcome	Documentation
cloud.smarthq.outcome.badrequest	The request was invalid.
cloud.smarthq.outcome.developererror	Only used when there is a server side bug
cloud.smarthq.outcome.deviceoffline	The device is offline.
cloud.smarthq.outcome.forbidden	The request is forbidden due to permissions.
cloud.smarthq.outcome.internalerror	The server had an issue processing the request
cloud.smarthq.outcome.missingconfig	The service config is missing
cloud.smarthq.outcome.missingstate	The service state is missing
cloud.smarthq.outcome.notallowed	The command is not allowed.
cloud.smarthq.outcome.notfound	The request is forbidden due to permissions.
cloud.smarthq.outcome.notsupported	The command is not supported.
cloud.smarthq.outcome.outofbounds	General out of bounds error
cloud.smarthq.outcome.servicedisabled	Feature is currently disabled
cloud.smarthq.outcome.success	Successful request
cloud.smarthq.outcome.timeout	The server experienced timeout waiting for a response from the gateway
cloud.smarthq.outcome.unavailablemode	The mode is unavailable.

Data Types¶

BOOLEAN¶

Value must be either true or false.

INTEGER¶

Value must be an integer. Field specific restrictions such as a minimum and maximum may apply depending on the field.

STRING¶

Value must be a sequence of characters, inserted between " and " (double quotes). Field specific restrictions such as a regular expression may apply depending on the field.