Skip to content

cloud.smarthq.service.enhancedfeature.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

  • 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 controlling the digital enhanced features on an appliance.Features are presented as set of opaque ids.

Example Device Response (Digital Twin API)

Service representing the digital goods.

{
  "adapterId": "0000000000000000000000000000000000000000",
  "alertTypes": [],
  "createdDateTime": "2022-03-04T12:12:12.123Z",
  "deviceId": "0000000000000000000000000000000000000000000000000000000000000000",
  "deviceType": "cloud.smarthq.device.appliance",
  "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.enhancedfeature.v1",
      "lastSyncTime": "2022-03-04T12:12:12.123Z",
      "domainType": "cloud.smarthq.domain.enhanced.feature",
      "supportedCommands": [
        "cloud.smarthq.command.enhancedfeature.v1.sync"
      ],
      "state": {
        "lastTransactionId": 155.0,
        "enabledFeaturesIds": [
          1.0
        ]
      },
      "serviceId": "0000000000000000000000000000000000000000000000000000000000000000",
      "serviceDeviceType": "cloud.smarthq.device.appliance",
      "config": {
        "maxSupportedFeaturesIds": [
          1.0,
          32.0
        ]
      },
      "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
featureCatalog STRING No
maxSupportedFeaturesIds INTEGER_ARRAY Yes

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
enabledFeaturesIds INTEGER_ARRAY Yes
lastTransactionId INTEGER 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.enhancedfeature.v1.sync

Command used to sync the current set of digital features on an appliance based on the request

Field Name Property Type Required
requestedFeaturesIds INTEGER_ARRAY Yes
transactionId INTEGER Yes

Example Commands

Command to sync the digital feature.

{
  "command": {
    "commandType": "cloud.smarthq.command.enhancedfeature.v1.sync",
    "requestedFeaturesIds": [
      1.0,
      32.0
    ],
    "transactionId": 155.0
  },
  "deviceId": "00000000000000000000000000000000000000000000000000000000000000",
  "domainType": "cloud.smarthq.domain.enhanced.feature",
  "kind": "service#command",
  "serviceDeviceType": "cloud.smarthq.device.standmixer",
  "serviceType": "cloud.smarthq.service.enhancedfeature.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.

INTEGER_ARRAY

Value must be an array of integers.