Telemetry v2

One of the major functionalities of Ability-enabled devices is sending data to the cloud. This way, all the measurements, events, etc. that your device produces may be provided to end-users via a web interface.

The Data Processing Pipeline identifies all the valid JSON schemas that are allowed.

PUB Send variable telemetry

from/module/{module_id}/variable

Parameters:

Name	Type	Description	Accepted values
module_id	string	Module identifier	name of module

Message format

Payload information:

Key	Value	Notes	Mandatory
objectId	<string>	Format: uuid	Yes
model	<string>		Yes
variable	<string>		Yes
value	<string / number / integer / boolean / object>		Yes
timestamp	<string>	Date time in ISO-8601 format	Yes
quality	<integer>	Greater than or equal to 0	No

Have a look at these payload examples to see what they should look like:

PUB Send alarm telemetry

from/module/{module_id}/alarm

Parameters:

Name	Type	Description	Accepted values
module_id	string	Module identifier	Name of module

Message format

Payload information:

Key	Value	Notes	Mandatory
objectId	<string>	Format: uuid	Yes
model	<string>		Yes
alarm	<string>		Yes
alarmKey	<string>		No
value	<object>		Yes
timestamp	<string>	Date time in ISO-8601 format	Yes
quality	<integer>	Greater than or equal to 0	No

Have a look at these payload examples to see what they should look like:

PUB Send event telemetry

from/module/{module_id}/event

Parameters:

Name	Type	Description	Accepted values
module_id	string	Module identifier	Name of module

Message format

Payload information:

Key	Value	Notes	Mandatory
objectId	<string>	Format: uuid	Yes
model	<string>		Yes
event	<string>		Yes
value	<object>		Yes
timestamp	<string>	Date time in ISO-8601 format	Yes
quality	<integer>	Greater than or equal to 0	No

Have a look at these payload examples to see what they should look like.