Curtain and Closure Controllers
Reporting Endpoint Status
The HTTP integration of curtain controllers and other closures uses the following structure:
POST /services/gear/DeviceIntegrationService.svc/UpdateClosureControllerStatus HTTP/1.1
Host: gear.cloud.studio
Content-Type: application/json
{
"accessToken": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
"endpointID": 1,
"position": 75,
"isMoving": true,
"timestamp": "2021-02-23T14:55:03"
}Parameters
| Name | Description | Data Type |
|---|---|---|
| accessToken | Access token with permissions to update endpoint information. See this page for more information. | text |
| endpointID | Unique endpoint identifier or combination of device address and endpoint address in format [deviceAddress]:endpointAddress (e.g.: [device-1234]:1). These values can be found on the endpoint management page. | numeric |
| position | The current position of the closure as a percentage, from 0 (fully closed) to 100 (fully open). | bool |
| isMoving | Whether the closure is currently moving: true means it is opening or closing, false means it is stopped. | numeric |
| timestamp | Optional value indicating the UTC date and time corresponding to the measurement. The date format must match one of those specified in the date formats section. If the field is omitted, the platform will assume the measurement corresponds to the current date and time. | text |
Reporting Status in "raw" Format
The endpoint state can be reported as a raw value using the expression converter. This option is convenient when the device is unable to perform conversions and emits values that need to be transformed before being injected into the platform.
Below is an example of a raw format request:
POST /services/gear/DeviceIntegrationService.svc/UpdateClosureControllerStatus HTTP/1.1
Host: gear.cloud.studio
Content-Type: application/json
{
"accessToken": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
"endpointID": 1,
"rawData": "75/true",
"timestamp": "2021-02-23T14:55:03"
}Parameters
| Name | Description | Data Type |
|---|---|---|
| accessToken | Access token with permissions to update endpoint information. See this page for more information. | text |
| endpointID | Unique endpoint identifier, which can be found on the endpoint management page. | numeric |
| rawData | Value reported by the sensor, as text. Two expressions must be specified in the expression converter. The first must return a numeric value with the closure's current position as a percentage, from 0 (fully closed) to 100 (fully open). The second must return a boolean that is true while the closure is opening or closing and false when it is stopped. | text |
| timestamp | Optional value indicating the UTC date and time corresponding to the measurement. The date format must match one of those specified in the date formats section. If the field is omitted, the platform will assume the measurement corresponds to the current date and time. | text |
Last updated on