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 | Indica la posición actual del cerramiento como porcentaje, entre 0 (completamente cerrado) y 100 (completamente abierto). | bool |
| isMoving | Indica si el cerramiento está actualmente en movimiento. El valor true indica que el cerramiento está siendo cerrado o abierto, mientras que el valor false indica que está detenido. | 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
El estado del endpoint 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 | Valor reportado por el sensor, como texto. Deben indicarse dos expresiones en el conversor de expresiones:La primera expresión debe devolver un valor numérico indicando la posición actual del cerramiento como porcentaje, entre 0 (completamente cerrado) y 100 (completamente abierto).La segunda expresión debe devolver un valor booleano indicando si el cerramiento está actualmente en movimiento. El valor true indica que el cerramiento está siendo cerrado o abierto, mientras que el valor false indica que está detenido. | 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 |