Controladores de cortinas y cerramientos
Reporte de estado del endpoint
La integración por HTTP de controladores de cortinas y otros cerramientos lleva la siguiente estructura:
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"
}Parámetros
| Nombre | Descripción | Tipo de datos |
|---|---|---|
| accessToken | Token de acceso con permisos para actualizar información del endpoint. Vea esta página para más información. | texto |
| endpointID | Identificador único del endpoint o combinación de dirección del dispositivo y dirección del endpoint con formato [deviceAddress]:endpointAddress (Ej: [device-1234]:1). Estos valores pueden verse en la página de administración de endpoints. | numérico |
| 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. | numérico |
| timestamp | Valor opcional indicando la fecha y hora UTC correspondiente a la medición. El formato en que se indique esta fecha debe coincidir con alguno de los indicados en la sección formatos de fecha. En caso de que el campo sea omitido, la plataforma asumirá que la medición corresponde a la fecha y hora actuales. | text |
Reporte de estado en formato "raw"
El estado del endpoint puede ser reportado como un valor crudo (raw), utilizando el conversor de expresiones. Esta opción es conveniente cuando el dispositivo no es capaz de realizar conversiones, y emite valores que necesitan ser transformados antes de inyectarse en la plataforma.
A continuación, se muestra un ejemplo de una petición en formato raw:
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"
}Parámetros
| Nombre | Descripción | Tipo de datos |
|---|---|---|
| accessToken | Token de acceso con permisos para actualizar información del endpoint. Vea esta página para más información. | texto |
| endpointID | Identificador único del endpoint, que puede verse en la página de administración de endpoints. | numérico |
| 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. | texto |
| timestamp | Valor opcional indicando la fecha y hora UTC correspondiente a la medición. El formato en que se indique esta fecha debe coincidir con alguno de los indicados en la sección formatos de fecha. En caso de que el campo sea omitido, la plataforma asumirá que la medición corresponde a la fecha y hora actuales. | text |
Dimmers
Reporte de estado del endpoint La integración por HTTP de dimmers y otros dispositivos similares (variadores de velocidad, etc.) lleva la siguiente estructura:...
Run-time meters (horómetros)
La integración de run-time meters utiliza la misma API que los sensores de flujo no-genéricos. La única diferencia es que los run time meters deben informar el...