cloud.smarthq.service.timeframe.v1¶
Description¶
Service for actions within a timeframe
Example Device Response (Digital Twin API)¶
Service for timeframe actions.
{
"adapterId": "0000000000000000000000000000000000000000",
"alertTypes": [],
"createdDateTime": "2022-03-04T12:12:12.123Z",
"deviceId": "0000000000000000000000000000000000000000000000000000000000000000",
"deviceType": "cloud.smarthq.device.plug",
"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.timeframe.v1",
"lastSyncTime": "2022-03-04T12:12:12.123Z",
"domainType": "cloud.smarthq.domain.power",
"supportedCommands": [
"cloud.smarthq.command.timeframe.v1.set",
"cloud.smarthq.command.timeframe.v1.clear"
],
"state": {
"action": "cloud.smarthq.type.timeframe.action.on",
"startEpoch": 1.7884512E9
},
"serviceId": "0000000000000000000000000000000000000000000000000000000000000000",
"serviceDeviceType": "cloud.smarthq.device.plug",
"config": {
"supportedActions": [
"cloud.smarthq.type.timeframe.action.on",
"cloud.smarthq.type.timeframe.action.off"
],
"requiredSetFields": [
"action",
"startTime"
]
},
"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 |
|---|---|---|
| requiredSetFields | STRING_ARRAY | No |
| supportedActions | SET<TIMEFRAME_ACTION> | 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 | Minimum | Maximum |
|---|---|---|---|---|
| action | TIMEFRAME_ACTION | No | ||
| endEpoch | LONG | No | 0 | 4294967295 |
| startEpoch | LONG | No | 0 | 4294967295 |
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.timeframe.v1.set¶
Command used to set a timeframe action.
| Field Name | Property Type | Required | Minimum | Maximum |
|---|---|---|---|---|
| action | TIMEFRAME_ACTION | Yes | ||
| endEpoch | LONG | No | 0 | 4294967295 |
| startEpoch | LONG | No | 0 | 4294967295 |
Example Commands¶
Command to set a timeframe action.
{
"command": {
"commandType": "cloud.smarthq.command.timeframe.v1.set",
"action": "cloud.smarthq.type.timeframe.action.on",
"startEpoch": 1.7884512E9
},
"deviceId": "00000000000000000000000000000000000000000000000000000000000000",
"domainType": "cloud.smarthq.domain.power",
"kind": "service#command",
"serviceDeviceType": "cloud.smarthq.device.plug",
"serviceType": "cloud.smarthq.service.timeframe.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 |
cloud.smarthq.command.timeframe.v1.clear¶
Command used to clear a timeframe action.
Example Commands¶
Command to clear a timeframe action.
{
"command": {
"commandType": "cloud.smarthq.command.timeframe.v1.clear"
},
"deviceId": "00000000000000000000000000000000000000000000000000000000000000",
"domainType": "cloud.smarthq.domain.power",
"kind": "service#command",
"serviceDeviceType": "cloud.smarthq.device.plug",
"serviceType": "cloud.smarthq.service.timeframe.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.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¶
STRING_ARRAY¶
Value must be an array of strings.
LONG¶
Value must be a long. Field specific restrictions such as a minimum and maximum may apply depending on the field.
SET<TIMEFRAME_ACTION>¶
| SET<TIMEFRAME_ACTION> | Documentation |
|---|---|
| cloud.smarthq.type.timeframe.action.off | Turn off during the timeframe |
| cloud.smarthq.type.timeframe.action.on | Turn on during the timeframe |
TIMEFRAME_ACTION¶
| TIMEFRAME_ACTION | Documentation |
|---|---|
| cloud.smarthq.type.timeframe.action.off | Turn off during the timeframe |
| cloud.smarthq.type.timeframe.action.on | Turn on during the timeframe |