Everactive Edge MQTT Subscriptions 1.0.0 documentation

The Everactive Edge IoT Platform allows you to create MQTT subscriptions to publish the data to an MQTT broker. The connection will use the client id provided when the subcription is created or one will be assigned using the "everactive-{random UUID}" string.

The messages are published with the QoS defined in the subscription request (etiher 0 or 1). The destination topic names are assembled following this convention:

{prefix}/{projectid}/sensor_reading/{schema}/{version}/reading/{mac}

Example:

my/tree/fdbc6d04-dba4-48cf-9b8e-fc4bbb38e001/sensor_reading/temperature-humidity/v1/reading/bc:5e:a1:00:00:00:2a:f1

Strict Topics

Some services, like Azure IoT Hub, have a more restrictive topic model for receiving messages. For cases like this one, if the topic prefix begins with strict: the messages will be published to that specific topic path plus the mac address of the sensor.

Example:

For a prefix

strict:devices/eversensor-data-01/messages/events

Messages are published to

devices/eversensor-data-01/messages/events/{mac address}
Specification tags
NameDescriptionDocumentation
Sensor Readings--

Table of Contents

Servers

customer Server

  • URL: mqtt://target.mqtt.server.com:8883
  • Protocol: mqtt

The customer specific MQTT broker to receive the sensor data.

Operations

PUB [prefix/]{projectid}/sensor_reading/{schema}/{version}/reading/{mac} Operation

The MQTT subscription publishes to this topic when new sensor data arrives.

  • Operation ID: onSensorData
Operation tags
NameDescriptionDocumentation
Sensor Readings--

Parameters

NameTypeDescriptionValueConstraintsNotes
prefixstringOptional topic segment defined by the user.allowed ("mqtt topic", null), examples ("my/topic")-required
projectidstringUUID of the Everactive Edge Platform projectexamples ("fdbc6d04-dba4-48cf-9b8e-fc4bbb38e001")-required
schemastringDesignates the type of message eg. temperature-humidity or vibration-electricalexamples ("temperature-humidity", "vibration-electrical")-required
versionstringSchema versionexamples ("v1")-required
macstringSensor MAC addressexamples ("bc:5e:a1:00:00:00:2a:f1")-required

mqtt Operation specific information

NameTypeDescriptionValueConstraintsNotes
cleanSession--"true"--
clientId--"{clientid_prefix}|{random UUID}"--
qos--"0 or 1"--
retain--"false"--

Message sensor_reading

Refer to https://docs.api.everactive.com/reference/eversensors-overview#sensor-readings-data-schema

A sensor reading message in Json format