Each page is dedicated to a Device Type available.

For each Device Type you will find:

  • A brief description
  • A list of message

For each message you will find:

  • A list of resource

Message

A message is sent by a device following a state change or periodically.

It is composed of:

  • an eventId
  • a list of resource

The eventId is unique for each message of a given Device Type.

Note

If there is a configured callback in IDIAG Push, when a message is sent by a device, a HTTP POST is made to the specified URL with a payload in the body.
The payload is a representation of the messages with a list of measure.
A measure represents the state of a resource at a specific point in time.

Resource

A resource represent a series of measure.

It is composed of:

  • a name
  • a category
  • a unit
  • a type
  • a min value optional
  • a max value optional
  • an error value optional

Name

For a Device Type, a resource name represent a unique series.

Note

A resource with the same name can be found in multiple message of the same Device Type.
In that case they are representing the same series.

Category

The category group resources in a different way than units do.

Example

A resource with the unit unit.volt and a second resource with the unit unit.volt.milli are under the same voltage category.

Note

The category gives a way to distinguish measurements with no unit.

Unit

The measurement unit of the resource.

Note

If a resource don't have a measurement unit the unit unit.nounit is used.

Type

The type of the resource can be :

  • bool
  • number

Min/Max Values

The min and max values gives the boundaries of the resource values.

Error Value

The error value is sent when the sensor is in error.

Warning

The error value is often outside the min/max boundaries.