In the Arcules platform there is the option to report the data produced by a sensor (e.g., an accelerometer) using REST API calls and then configure specific alerting options in the Arcules portal's Rules section. In this way, you can receive notifications and alarms triggered by changes in the sensor's data, fostering a comprehensive and centralized approach to event monitoring.
For a better usability experience in the management of your sensors, in the Arcules platform, a sensor or a set of sensors are grouped in a concept called User Defined Device. You can access the User Defined Devices section by:
1. Clicking on the Devices section on the left navigation bar:
2. Clicking on the User Defined Devices section:
To understand the way these devices, its sensors, and how the alerting options of the Arcules platform work together, the following diagram depicts the general User Defined Device Workflow:
The remaining sections of this article explain the details of this workflow.
User Defined Devices Section Overview
The User Defined Devices section includes a table with the list of all the devices and its details:
1. Adding a User Defined Device
When clicking on the '+' icon you will have the option to add a User Defined Device. First, you will be presented with a dialog to enter the information of the device's name, site and location:
Then, you will need to add the information of the sensor (name and type*) that will be associated with this device:
* type refers to the data type the sensor will be sending to the Arcules platform. For the current version, only Boolean data type is supported.
In the last step, you will see a confirmation dialog with the details of the device added:
2. Device Details
When clicking on any of the rows from the User Defined Devices table, you will see the details for the selected device:
Overview Tab
In this tab you will find additional information of the device:
UUID: Unique identifier related to this device.
Added date: The date when the device was created in the Arcules Platform.
Site: The site (a logical grouping of locations) associated to this device.
Location: The location (a physical place with an address) associated to this device.
Timezone: Information about the time zone associated to this device.
Remove a User Defined Device
At the bottom-right side of the Overview tab, you will find the Remove Device button, when clicking it, you will be presented with a dialog where you can remove the selected User Defined Device (you will need to mark the "Yes, delete this user defined device" checkbox in order for the "Delete" button to be enabled).
Sensors Tab
This tab lists all the different sensors associated to the selected device.
In this tab you will find information about the sensor that includes:
The name of the sensor.
UUID: Unique identifier related to this sensor.
Boolean: The data type use by this sensor.
Added Date: The date and time on which the sensor was added.
Additionally, in this tab you will have the option to Edit a Sensor (by clicking on the icon: ), Remove a Sensor (by clicking on the icon: ), or Create a Rule (by clicking on the icon: ) for the corresponding sensor.
Note: For the current version, a user defined device can only have one sensor.
Edit a Sensor
When clicking on this option, you will have the option to change the sensor name.
Note: For the current version, only Boolean data type is supported.
Create a Rule
When clicking on this option, you will be redirected to the Rules section of the Arcules Platform. In the Rules section you can configure actions such as notifications or alarms triggered by changes in the sensor's data.
Remove a Sensor
When clicking on this option, you will be presented with a dialog where you can remove the selected sensor (you will need to mark the "Yes, delete this sensor" checkbox in order for the "Delete" button to be enabled).
Sending Sensor's Data to the Arcules Platform
The data produced by a sensor can be sent to the Arcules platform using the Arcules API. The following steps describe this process:
Note: For this process, we would call the specific device that has the sensor for which you want to send its data, DeviceA, and the sensor attach it to it, SensorA.
The user should have the API User role, along with the Publish Sensor Data goal assigned.
Use the /login service to request a JWT token (the JWT token will be used in the subsequent calls of the API).
From the Arcules Portal, go to the User Defined Device section, select the DeviceA:
In the Sensors tab of this device, copy the SensorA's UUID (in the image below: c176cbba-bfe0-4376-8892-bc9237ea5264).
Use the /sensor/{sensorId}/data service to send the sensor data:
/sensor/c176cbba-bfe0-4376-8892-bc9237ea5264/data
More information about the Arcules API can be found here.
Logs
Logs allows you to have an audit trail of user activity within the Arcules platform. For the User Defined Devices feature, you will be able to understand things like:
When a User Defined Device is added, updated, or deleted.
When a sensor is added, updated, or deleted.
The user that performed these activities.
More information about logs can be found here.