Aller au contenu principal
CloudStudio

Appareils électroménagers et autres appareils On/Off

Reporting Endpoint Status

The HTTP integration of appliances and other on/off devices (valves, lamps, motors, etc.) uses the following structure:

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"
}

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.numeric
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

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/UpdateApplianceStatusRaw HTTP/1.1
Host: gear.cloud.studio
Content-Type: application/json

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

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
rawDataValue reported by the sensor, as text. An expression must be specified in the expression converter. 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

Dernière mise à jour le

Sur cette page