Application settings

  Understanding how IoTRoutes works

1. Exchange of messages:

         Before you begin using or configuring the platform, it is essential to understand the architecture and concept of the IoTRoutes solution. Please read the sections referenced by the previous links before proceeding with the configuration.

As described in previous chapters of this guide, the platform receives messages of various types and formats from devices. Acquisition flows are responsible for converting messages into a single structure that the application can understand, called a Platform Message Structure (PMS).

Also for outgoing commands from the platform to the devices, the messages are initially emitted according to the platform structure and the outgoing flows ensure the conversion of the messages to a well-defined structure, understandable by the devices (or gateways).

2.   Attributes :

Attributes are data elements used to describe, configure, monitor, and control connected devices (sensors, lights, controllers, etc.) within the IoT network. Examples include DeviceID, Position, Temperature, Status, etc.

Attributes are classified into different types or functional scopes, depending on their role in managing connected objects. This allows data to be organized according to its purpose: configuration, measurement, operational status, events, etc. 

In IoTRoutes we find attributes with the four types below:

• Configuration : Attributes that define static or semi-static parameters of the device, Example: GatewayAddress.
• Measurement : Values measured by sensors or recorded periodically. Example: AirQualityIndex, Temperature
• Operational :  Data on the current operating status of devices. Indicates whether devices are operating correctly or report a particular status. Example: LampFailure, DeviceStatus .
• Event :  Data generated in response to changes or anomalies. Example: MotionDetected, OverVoltageDetected.

Below is a Json message with two measurement attributes (temperature and humidity). This is an example of a simple, flat structure containing the ID of the device sending the message, the date, and the measurements as key and value.

{
  "deviceId": "d15922X",
  "timestamp": "2023-11-23T18:25:43.511Z",
  "temperature": 32.8,
  "humidity": 12.0,
}

 Defining attributes

Attribute Definition: the object that describes the characteristics of an attribute in the application such as Name, Identifier (ID), Scope, Value Type, Max/Min Value, etc.

Thus, the attributes are predefined in the platform and can be consulted as well as the values from several screens of the application. Approximately 500 attributes are automatically preconfigured in the application and are activated according to the IoT classes used and the domain to be covered by the deployment.

Below is an example of attributes defined in IoTRoutes.

A complete description of the attributes can be retrieved via the definitions API hosted on the AOS.

This API (/api/Definition) is used to retrieve all the definitions used by the application such as the definition of attributes, functions and commands. To access the attribute definitions, from the AOS use the link  [Aos-URL]/api/Definition/Attributes/List

Next:  Configure the application