cloud.smarthq.service.dish.config.v1

• 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 for config json

Example Device Response (Digital Twin API)

Example of service for cycle options

{
  "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.dish.config.v1",
      "lastSyncTime": "2022-03-04T12:12:12.123Z",
      "domainType": "cloud.smarthq.domain.cycle.options",
      "supportedCommands": [],
      "state": {},
      "serviceId": "0000000000000000000000000000000000000000000000000000000000000000",
      "serviceDeviceType": "cloud.smarthq.device.dishwasher",
      "config": {
        "cycleOptions": [
          {
            "washZone": [
              "None",
              "Both"
            ],
            "bottleJets": false,
            "delayStart": false,
            "washTemp": [
              "Boost",
              "Sani"
            ],
            "dryTemp": [
              "None"
            ],
            "cycleId": 1.0,
            "steam": true,
            "silverwareWash": false
          }
        ]
      },
      "lastStateTime": "2022-03-04T12:12:12.123Z"
    }
  ],
  "userId": "000000000000000"
}

Example of service for cycle options with unsupported options

{
  "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.dish.config.v1",
      "lastSyncTime": "2022-03-04T12:12:12.123Z",
      "domainType": "cloud.smarthq.domain.cycle.options",
      "supportedCommands": [],
      "state": {},
      "serviceId": "0000000000000000000000000000000000000000000000000000000000000000",
      "serviceDeviceType": "cloud.smarthq.device.dishwasher",
      "config": {
        "cycleOptions": [
          {
            "bottleJets": false,
            "delayStart": false,
            "dryTemp": [
              "None"
            ],
            "cycleId": 1.0,
            "steam": true
          }
        ]
      },
      "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
cycleOptions	DISH_CYCLES_OPTIONS	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.

DISH_CYCLES_OPTIONS

Value must be a JSON array with json objects which attributes are: - cycleId: integer value - steam: boolean value - bottleJets: boolean value - delayStart: boolean value - silverwareWash: boolean value - washZones: boolean value - dryTemp: array of strings, valid enum values: - None - Added Heat - Max Dry - washTemp: array of strings, valid enum values: - None - Boost - Sani - Sani And Boost - Only Sani