Appliances y otros dispositivos on-off
Reporte de estado del endpoint
La integración de appliances y otros dispositivos on-off (válvulas, lámparas, motores, etc.) por HTTP lleva la siguiente estructura:
POST /services/gear/DeviceIntegrationService.svc/UpdateApplianceStatus HTTP/1.1
Host: gear.cloud.studio
Content-Type: application/json
{
"accessToken": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
"endpointID": 1,
"isOn": 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 |
| isOn | Indica si el artefacto está encendido (true) o apagado (false) | bool |
| 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/UpdateApplianceStatusRaw HTTP/1.1
Host: gear.cloud.studio
Content-Type: application/json
{
"accessToken": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
"endpointID": 1,
"rawData": "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. Debe indicarse una expresión en el conversor de expresiones. La expresión debe devolver un valor booleano indicando si el artefacto está encendido (true) o apagado (false). | 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 |
Última actualización
Sensores genéricos de flujo
Cómo enviar a Gear Studio por la API HTTP el flujo de un sensor genérico, en la unidad de su tipo de variable: estructura de la petición, parámetros y ejemplo.
Dimmers
Cómo enviar a Gear Studio por la API HTTP el nivel de un dimmer o regulador de velocidad: estructura de la petición, parámetros y ejemplo.