cloud.smarthq.service.dash¶

Configuration

Describes boundaries and fixed properties for the service.

Go There
State

A list of the states this service can be in.

Go There
Data Types

All the data types used for this service.

Go There

Description¶

Service that represents the Alexa dash links.

Example Device Response (Digital Twin API)¶

Example of String service for a dishwasher with alexa replenishment dashboard

{
  "adapterId": "0000000000000000000000000000000000000000",
  "alertTypes": [],
  "createdDateTime": "2022-03-04T12:12:12.123Z",
  "deviceId": "0000000000000000000000000000000000000000000000000000000000000000",
  "deviceType": "cloud.smarthq.device.dishwasher",
  "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.dash",
      "lastSyncTime": "2022-03-04T12:12:12.123Z",
      "domainType": "cloud.smarthq.domain.alexa",
      "supportedCommands": [],
      "state": {},
      "serviceId": "0000000000000000000000000000000000000000000000000000000000000000",
      "serviceDeviceType": "cloud.smarthq.device.dishwasher",
      "config": {
        "deepLinkUrl": "https://alexa.amazon.com/spa/index.html#v2/drs/partner/page/settings?vendorCode=GEAPQ\u0026modelId=Dishwasher_Pod_Counting_FLD",
        "modelId": "Dishwasher_Pod_Counting_FLD",
        "webUrl": "https://drs-web.amazon.com/drs/partner/page/settings?vendorCode=GEAPQ\u0026settings=true\u0026modelId=Dishwasher_Pod_Counting_FLD"
      },
      "lastStateTime": "2022-03-04T12:12:12.123Z"
    }
  ],
  "userId": "000000000000000"
}

Configuration¶

The following are properties for the gateway/device sync as part of the "config" object for each individual service.

Field Name	Property Type	Required
deepLinkUrl	STRING	No
modelId	STRING	No
webUrl	STRING	No

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

Data Types¶

BOOLEAN¶

Value must be either true or false.

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.