Alarms
Alarms
In the water/gas BATCH integration, along with the readings file, an alarm file is sent with the alarms detected by the devices during the period.
The file name follows the pattern alarm.<unit>.<measurement type>.<window end date and time>.<extension>, for example: alarm.DEFAULT..2024-05-24T17:00:00.000Z.csv
Columns
| Column | Description |
|---|---|
| device_id | Device identifier |
| channel | Device channel |
| unity | Device's organizational unit |
| city | Device's city |
| remote_id | Device's remote identifier |
| device_name | Device name (optional) |
| alarm_type | Alarm origin. In the alarm file, always `device` |
| alarm_code | Code of the detected alarm |
| alarm_date | Date and time the alarm was first detected within the window |
| alarm_criticality | Alarm criticality: `LOW`, `MEDIUM`, or `HIGH` |
Each alarm appears only once per device and channel within the exported window, with the date of its first detection — an alarm active throughout the period does not generate one row per reading.
Alarm codes
| alarm_code | Description | alarm_criticality |
|---|---|---|
| MAX_FLOW | Maximum flow | LOW |
| REVERSE_FLOW | Reverse flow | HIGH |
| MAGNETIC_FRAUDULENCE | Magnetic fraud | MEDIUM |
| LEAKAGE | Leakage | LOW |
| WIRE_CUTTING | Wire cutting | LOW |
| CALIBRATING | Calibrating | MEDIUM |
| VIOLATION | Violation | MEDIUM |
The available codes vary according to the device model — not every meter reports all of the alarms above.
Example
| device_id | channel | unity | city | remote_id | device_name | alarm_type | alarm_code | alarm_date | alarm_criticality |
|---|---|---|---|---|---|---|---|---|---|
| 3617000001 | 0 | DEFAULT | São Paulo | E00XX000000 | Water meter, Rua das Palmeiras 45 | device | REVERSE_FLOW | 2024-05-24 16:12:00+00 | HIGH |
| 3617000002 | 0 | DEFAULT | São Paulo | E00XX000001 | Water meter, Av. Sete de Setembro 1200 | device | WIRE_CUTTING | 2024-05-24 16:09:00+00 | LOW |
| 3617000003 | 0 | DEFAULT | São Paulo | E00XX000002 | Water meter, Rua XV de Novembro 89 | device | MAGNETIC_FRAUDULENCE | 2024-05-24 16:30:00+00 | MEDIUM |
| 3617000004 | 0 | DEFAULT | São Paulo | E00XX000003 | Water meter, Rua Marechal Deodoro 300 | device | LEAKAGE | 2024-05-24 16:07:00+00 | LOW |
| 3617000005 | 0 | DEFAULT | São Paulo | E00XX000004 | Water meter, Rua Comendador Araújo 55 | device | CALIBRATING | 2024-05-24 16:12:00+00 | MEDIUM |
How to set it up
The alarm file is not a separate report: it is sent automatically along with the Leituras dos Dispositivos report, configured in the Format step of the BATCH integration creation.
Technical Support
If you have any questions or technical issues during the process, our technical support team is available. You can reach us by email at [email protected] or via WhatsApp at (11) 91162-6684.