Aller au contenu principal
CloudStudio

Appareils électroménagers et autres appareils On/Off

Reporting Endpoint Status

The integration de appliances y otros dispositivos on-off (válvulas, lámparas, motores, etc.) por MQTT uses the following structure:

{
	"accessToken": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
	"endpointID": 1,
	"isOn": true,
	"timestamp": "2021-02-23T14:55:03",
	"mqttMethod": "UpdateApplianceStatus",
	"mqttRID": "tkrs34"
}

Parameters

NameDescriptionData Type
accessTokenAccess token with permissions to update endpoint information. See this page for more information.text
endpointIDUnique 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.text
isOnIndica si el artefacto está encendido (true) o apagado (false)bool
timestampOptional 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
mqttMethodMétodo correspondiente del servicio, en este caso UpdateApplianceStatusstring
mqttRIDIdentificador opcional para la petición, en caso de que se desee obtener una respuesta de confirmación.string

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:

{
	"accessToken": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
	"endpointID": 1,
	"rawData": "true",
	"timestamp": "2021-02-23T14:55:03",
	"mqttMethod": "UpdateApplianceStatusRaw",
	"mqttRID": "tkrs34"
}

Parameters

NameDescriptionData Type
accessTokenAccess token with permissions to update endpoint information. See this page for more information.text
endpointIDUnique endpoint identifier, which can be found on the endpoint management page.numeric
rawDataValor 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).text
timestampOptional 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
mqttMethodMétodo correspondiente del servicio, en este caso UpdateApplianceStatusRawstring
mqttRIDIdentificador opcional para la petición, en caso de que se desee obtener una respuesta de confirmación.string

Dernière mise à jour le

Sur cette page