cloud.smarthq.service.timeintervals.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 time intervals. This service is used for the representation of time intervals.

Example Device Response (Digital Twin API)¶

Service for time intervals.

{
  "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.timeintervals.v1",
      "lastSyncTime": "2022-03-04T12:12:12.123Z",
      "domainType": "cloud.smarthq.domain.demandresponse",
      "supportedCommands": [
        "cloud.smarthq.command.timeintervals.v1.set"
      ],
      "state": {
        "intervals": [
          {
            "duration": 1.0,
            "fahrenheitOffset": 5.0,
            "startTime": 3.0
          }
        ]
      },
      "serviceId": "0000000000000000000000000000000000000000000000000000000000000000",
      "serviceDeviceType": "cloud.smarthq.device.airconditioner",
      "config": {
        "temperatureSupported": "cloud.smarthq.type.parameter.required"
      },
      "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	Minimum
granularity	TIME_GRANULARITY	No
maximumIntervals	INTEGER	No	0
temperatureSupported	SUPPORTED_PARAMETER	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
intervals	TIME_INTERVALS	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.timeintervals.v1.set¶

Command used to set time intervals.

Field Name	Property Type	Required
intervals	TIME_INTERVALS	Yes

Example Commands¶

Command to set timeintervals.

{
  "command": {
    "commandType": "cloud.smarthq.command.timeintervals.v1.set",
    "intervals": [
      {
        "duration": 1.0,
        "startTime": 3.0
      }
    ]
  },
  "deviceId": "00000000000000000000000000000000000000000000000000000000000000",
  "domainType": "cloud.smarthq.domain.demandresponse",
  "kind": "service#command",
  "serviceDeviceType": "cloud.smarthq.device.airconditioner",
  "serviceType": "cloud.smarthq.service.timeintervals.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.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.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

Data Types¶

INTEGER¶

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

TIME_INTERVALS¶

Value must be an array with 3 attributes. - startTime: defined in epoch seconds, must be an integer - duration: positive integer - fahrenheitOffset: double value - celsiusOffset: double value

SUPPORTED_PARAMETER¶

SUPPORTED_PARAMETER	Documentation
cloud.smarthq.type.parameter.defaulted	Associated parameter may be provided, the value defaults if not provided
cloud.smarthq.type.parameter.optional	Associated parameter may be provided
cloud.smarthq.type.parameter.prohibited	Associated parameter cannot be used, this is the implied behavior when not provided.
cloud.smarthq.type.parameter.required	Associated parameter must be provided

TIME_GRANULARITY¶

TIME_GRANULARITY	Documentation
cloud.smarthq.type.timergranularity.days	Granularity of days
cloud.smarthq.type.timergranularity.hours	Granularity of hours
cloud.smarthq.type.timergranularity.minutes	Granularity of minutes
cloud.smarthq.type.timergranularity.seconds	Granularity of seconds