cloud.smarthq.service.pricingstructure¶

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 pricing structure.

Example Device Response (Digital Twin API)¶

Service to set the electrical pricing structure.

{
  "adapterId": "0000000000000000000000000000000000000000",
  "alertTypes": [],
  "createdDateTime": "2022-03-04T12:12:12.123Z",
  "deviceId": "0000000000000000000000000000000000000000000000000000000000000000",
  "deviceType": "cloud.smarthq.device.energy",
  "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.pricingstructure",
      "lastSyncTime": "2022-03-04T12:12:12.123Z",
      "domainType": "cloud.smarthq.domain.pricingstructure.electrical",
      "supportedCommands": [
        "cloud.smarthq.command.pricingstructure.set"
      ],
      "state": {
        "pricingStructure": "cloud.smarthq.type.pricestructure.timeofuse"
      },
      "serviceId": "0000000000000000000000000000000000000000000000000000000000000000",
      "serviceDeviceType": "cloud.smarthq.device.energy",
      "config": {
        "supportedPricingStructures": [
          "cloud.smarthq.type.pricestructure.none",
          "cloud.smarthq.type.pricestructure.tierblock",
          "cloud.smarthq.type.pricestructure.timeofuse"
        ]
      },
      "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
supportedPricingStructures	SET<PRICE_STRUCTURE>	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
pricingStructure	PRICE_STRUCTURE	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.pricingstructure.set¶

Command used to set the pricing structure of an appliance.

Field Name	Property Type	Required
pricingStructure	PRICE_STRUCTURE	Yes

Example Commands¶

Command to set the pricing structure.

{
  "command": {
    "commandType": "cloud.smarthq.command.pricingstructure.set",
    "pricingStructure": "cloud.smarthq.type.pricestructure.timeofuse"
  },
  "deviceId": "00000000000000000000000000000000000000000000000000000000000000",
  "domainType": "cloud.smarthq.domain.pricingstructure.electrical",
  "kind": "service#command",
  "serviceDeviceType": "cloud.smarthq.device.energy",
  "serviceType": "cloud.smarthq.service.pricingstructure"
}

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.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¶

BOOLEAN¶

Value must be either true or false.

PRICE_STRUCTURE¶

PRICE_STRUCTURE	Documentation
cloud.smarthq.type.pricestructure.block	Block
cloud.smarthq.type.pricestructure.blocktier	BlockTier
cloud.smarthq.type.pricestructure.none	None
cloud.smarthq.type.pricestructure.tierblock	TierBlock
cloud.smarthq.type.pricestructure.timeofuse	Time Of Use

SET<PRICE_STRUCTURE>¶

SET<PRICE_STRUCTURE>	Documentation
cloud.smarthq.type.pricestructure.block	Block
cloud.smarthq.type.pricestructure.blocktier	BlockTier
cloud.smarthq.type.pricestructure.none	None
cloud.smarthq.type.pricestructure.tierblock	TierBlock
cloud.smarthq.type.pricestructure.timeofuse	Time Of Use