Ir para o conteúdo principal
CloudStudio

IAS Sensors (Motion, Occupancy, and Binary Sensors)

Reporting Sensor Status

The MQTT integration of IAS sensors uses the following structure:

{
	"accessToken": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
	"endpointID": 1,
	"state": 2,
	"timestamp": "2021-02-23T14:55:03",
	"mqttMethod": "UpdateIASSensorStatus",
	"mqttRID": "Prafw6H"
}

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
stateThe sensor state. Possible values: 1 = inactive, the sensor detects no activity; 2 = active, the sensor detects activity; 3 = cleaning, the sensor's space is being cleaned; 4 = needs cleaning; 5 = test mode; 6 = tampered, the sensor may not be working properly; 7 = under maintenance, the sensor may not be working properly; 8 = a vehicle is entering the parking space; 9 = a vehicle is leaving the parking space; 10 = the parking space is in violation.numeric
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
mqttMethodService method to call, in this case UpdateIASSensorStatus.string
mqttRIDOptional request identifier, used to get a confirmation response.string

Reporting Status in "raw" Format

The sensor state 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.

Here is an example of a request in raw format:

{
	"accessToken": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
	"endpointID": 1,
	"rawData": "2",
	"timestamp": "2021-02-23T14:55:03",
	"mqttMethod": "UpdateIASSensorStatusRaw",
	"mqttRID": "RXmp123"
}

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. The expression must return a numeric value matching one of the states in the table above.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
mqttMethodService method to call, in this case UpdateIASSensorStatusRaw.string
mqttRIDOptional request identifier, used to get a confirmation response.string

Última atualização em

Nesta página