Skip to content
Snippets Groups Projects
Commit a123c0ad authored by Martinez Rodriguez, Belen's avatar Martinez Rodriguez, Belen
Browse files

Update README.md

parent b9c51fdc
Branches
No related tags found
1 merge request!2Update README.md
...@@ -18,6 +18,7 @@ AFarCloud component / version 1.1 ...@@ -18,6 +18,7 @@ AFarCloud component / version 1.1
* * * * * * * * * *
Introduction Introduction
------------
The Alarm Processing & Reporter processes the alarms triggered by the devices, validating the data received to ensure that the format is clean and correct, and forwards them to the Farm Management System. We consider as alarms any message sent from a sensor (i.e., standalone sensor, collar, WSN, etc.), actuator, UAV or GV to the middleware, to inform about abnormal behaviour at equipment or functional levels. The alarm at equipment level indicates that the equipment is not functioning correctly e.g., the IMU in a UAV, collar battery warning, etc. The Alarm Processing & Reporter processes the alarms triggered by the devices, validating the data received to ensure that the format is clean and correct, and forwards them to the Farm Management System. We consider as alarms any message sent from a sensor (i.e., standalone sensor, collar, WSN, etc.), actuator, UAV or GV to the middleware, to inform about abnormal behaviour at equipment or functional levels. The alarm at equipment level indicates that the equipment is not functioning correctly e.g., the IMU in a UAV, collar battery warning, etc.
Functional level represents a higher level of abstraction than equipment level. An alarm at functional level means that an entity will not be able to execute an action that requires a certain functionality like localisation or navigation, probably due to an alarm at equipment level. Functional level represents a higher level of abstraction than equipment level. An alarm at functional level means that an entity will not be able to execute an action that requires a certain functionality like localisation or navigation, probably due to an alarm at equipment level.
...@@ -42,7 +43,7 @@ Besides, the Alarm Processing & Reporter also processes the notifications/warnin ...@@ -42,7 +43,7 @@ Besides, the Alarm Processing & Reporter also processes the notifications/warnin
Finally, the Alarm Processing & Reporter processes updates on the status of an existing alarm. Finally, the Alarm Processing & Reporter processes updates on the status of an existing alarm.
Interfaces Interfaces
* * * * * ----------
NOTIFICATION OF NEW ALARMS - AFarCloud offers two different interfaces to connected entities, so they can send alarms triggered to the platform: NOTIFICATION OF NEW ALARMS - AFarCloud offers two different interfaces to connected entities, so they can send alarms triggered to the platform:
...@@ -57,7 +58,7 @@ MQTT interface for reporting new alarms ...@@ -57,7 +58,7 @@ MQTT interface for reporting new alarms
The MQTT topic for reporting alarms from MQTT compatible entities is provided below: The MQTT topic for reporting alarms from MQTT compatible entities is provided below:
afc/[scenario]/[service]/[type\_of\_device]/[entityName]/alarm {.text-center} afc/[scenario]/[service]/[type\_of\_device]/[entityName]/alarm {.text-center}
-------------------------------------------------------------- *****
Where: Where:
...@@ -92,7 +93,7 @@ Where: ...@@ -92,7 +93,7 @@ Where:
8. status defines the state of the alarm according to the alarm lifecycle 8. status defines the state of the alarm according to the alarm lifecycle
REST interface for reporting new alarms REST interface for reporting new alarms
* * * * * ---------------------------------------
The following REST service is available for reporting alarms to the Alarm Processing & Reporter. The following REST service is available for reporting alarms to the Alarm Processing & Reporter.
...@@ -125,12 +126,12 @@ You can check REST inferface with Swagger. ...@@ -125,12 +126,12 @@ You can check REST inferface with Swagger.
[Link.](https://alarm-processing-reporter-afarcloud.qa.pdmfc.com/rest.html) [Link.](https://alarm-processing-reporter-afarcloud.qa.pdmfc.com/rest.html)
MQTT interface for updating the status of an existing alarm MQTT interface for updating the status of an existing alarm
* * * * * --------------------------------------------------------------
The MQTT topic for updating the status of an existing alarm is provided below: The MQTT topic for updating the status of an existing alarm is provided below:
afc/[scenario]/[service]/[type\_of\_device]/[entityName]/updatealarm {.text-center} afc/[scenario]/[service]/[type\_of\_device]/[entityName]/updatealarm {.text-center}
-------------------------------------------------------------------- *****
Where: Where:
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please to comment