WaterMeter

Get water meter by ID

GET

http://localhost:8080

/api/water-meter/by-id/{id}

Get water meter by ID › path Parameters

id

string · required

Get water meter by ID › Responses

200

WaterMeter

_id

string · required

Primary ID of the Device

Example: 64b7f1e6f9c9d4e5b8a9f7c3

deviceType

string · enum · required

Type of device (discriminator field)

Enum values:

PLUG

MCB

ENV_SENSOR

SMART_SWITCH

AIRCON_CONTROL

WATER_METER

Example: PLUG

macId

string · required

MAC ID of the Device (from IoT device)

Example: 1092384701928347

deviceName

string · required

Name of the Device

Example: Living Room AC

deviceNumber

number · required

Unique device number for identification

Example: 1

onStatus

string · enum · required

Status of the Device (ON / OFF / INACTIVE / ERROR)

Enum values:

OFF

INACTIVE

ERROR

ACTIVE

Example: ON

location

string · required

Physical location or address where the device is installed

Example: Room 101, Building A

remarks

string · required

Remarks for the Device

batchNumber

number · required

Manufacturing batch number for tracking production groups

Example: 1

chipModel

string · enum · required

Hardware chip model identifier used in the device

Enum values:

ESP8266

ESP32C2

ESP32C5

ESP32

ESP32C3

Example: ESP32C2

versionNumber

string · required

Firmware version number currently running on the device

Example: 1.0.0

ssid

string · required

Network SSID (Wi-Fi name) that the device is connected to

Example: IoT-Network-5G

tenant

string · required

Tenant ID reference

object · required

Tagged Zone

room

string · required

Room ID reference

system

string · required

System ID reference

createdAt

string · date-time · required

Date Time of the Creation

Example: 2021-09-01

updatedAt

string · date-time · required

Date Time of the Update

Example: 2021-09-01

lastSeen

string · date-time · required

Last time the device was seen/reported

Example: 2021-09-01

isLocked

boolean · required

Whether the device is locked. When locked, the device on/off status cannot be toggled.

Example: false

totalEnergyUsage

number · required

Total cumulative energy usage in kWh

Example: 0

totalEnergySaved

number · required

Total energy saved through optimization in kWh

Example: 0

autoUpdateAttempts

number · required

Number of auto-update OTA attempts sent to this device

Example: 0

autoUpdateBlacklisted

boolean · required

Whether device is blacklisted from auto-updates (max retries exceeded)

Example: false

manualUpdateBlacklist

boolean · required

Whether device is manually blacklisted from auto-updates by admin

Example: false

inactivityNotificationEnabled

boolean · required

Whether inactivity notifications are enabled for this device

Default: false

meterSize

string · enum · required

Pipe diameter size (DN15, DN20, DN25, etc.)

Enum values:

DN15

DN20

DN25

DN32

DN40

DN50

realTimeFlowRate

number · required

Current flow rate in liters per minute

realTimePressure

number · required

Water pressure in bar

waterConsumption

number · required

Total water consumption in liters (incremented hourly)

Default: 0

isLeakDetected

boolean · required

Whether a leak is currently detected

leakThresholdFlowRate

number · required

Current leak detection threshold in liters per minute

Default: 5

deviceModel

string

Model name or identifier of the device

Example: TP-Link HS110

deviceBrand

string

Brand or manufacturer of the device

Example: TP-Link

isSpare

boolean

Whether the device is a spare/inventory device. Spare devices can be filtered out of user-facing dashboards.

Example: false

object

Schedule configuration for the device. Contains recurring weekly schedules and one-time scheduled tasks.

realTimePower

number

Real-time power consumption in watts

Example: 1500

realTimeCurrent

number

Real-time current in amperes

Example: 6.5

lastAutoUpdateAttempt

string · date-time

Timestamp of last auto-update OTA attempt

inactivityNotificationSentAt

string · date-time

Timestamp when the last inactivity notification was sent for this device

meterModel

string

Meter model/manufacturer

realTimeTemperature

number

Water temperature in Celsius (optional)

flowRateMax

number

Max Threshold flow rate reading in L/min

Example: 10

flowRateMin

number

Min Threshold flow rate reading in L/min

Example: 10

pressureMax

number

Max Threshold pressure reading in bar

Example: 10

pressureMin

number

Min Threshold pressure reading in bar

Example: 10

temperatureMin

number

Min Threshold temperature reading in degrees Celsius

Example: 24

temperatureMax

number

Max Threshold temperature reading in degrees Celsius

Example: 24

lastLeakNotificationAt

string · date-time

Timestamp of last leak notification received

notificationThresholdHour

number

Hourly notification threshold — minimum hours between repeat notifications of the same type

Example: 4

GET/api/water-meter/by-id/{id}

curl http://localhost:8080/api/water-meter/by-id/:id

Example Responses

{
  "_id": "64b7f1e6f9c9d4e5b8a9f7c3",
  "deviceType": "PLUG",
  "macId": "1092384701928347",
  "deviceName": "Living Room AC",
  "deviceNumber": 1,
  "onStatus": "ON",
  "location": "Room 101, Building A",
  "remarks": "remarks",
  "deviceModel": "TP-Link HS110",
  "deviceBrand": "TP-Link",
  "batchNumber": 1,
  "chipModel": "ESP32C2",
  "versionNumber": "1.0.0",
  "ssid": "IoT-Network-5G",
  "tenant": "tenant",
  "zone": {
    "_id": "64b7f1e6f9c9d4e5b8a9f7c3",
    "name": "Glenn Quah Han Rong",
    "email": "glenn@gmail.com",
    "remarks": "remarks",
    "zoneType": "LABORATORY",
    "zoneEnergyReport": "64b7f1e6f9c9d4e5b8a9f7c3",
    "tenant": "tenant",
    "rooms": [
      "string"
    ],
    "devices": [
      {
        "_id": "64b7f1e6f9c9d4e5b8a9f7c3",
        "deviceType": "PLUG",
        "macId": "1092384701928347",
        "deviceName": "Living Room AC",
        "deviceNumber": 1,
        "onStatus": "ON",
        "location": "Room 101, Building A",
        "remarks": "remarks",
        "deviceModel": "TP-Link HS110",
        "deviceBrand": "TP-Link",
        "batchNumber": 1,
        "chipModel": "ESP32C2",
        "versionNumber": "1.0.0",
        "ssid": "IoT-Network-5G",
        "tenant": "tenant",
        "zone": {
          "_id": "64b7f1e6f9c9d4e5b8a9f7c3",
          "name": "Glenn Quah Han Rong",
          "email": "glenn@gmail.com",
          "remarks": "remarks",
          "zoneType": "LABORATORY",
          "zoneEnergyReport": "64b7f1e6f9c9d4e5b8a9f7c3",
          "tenant": "tenant",
          "rooms": [
            "string"
          ],
          "devices": [
            null
          ],
          "distributionBoxes": [
            {
              "_id": "64b7f1e6f9c9d4e5b8a9f7c3",
              "name": "Main DB Box - Floor 1",
              "boxNumber": 1,
              "numberOfRows": 1,
              "mcbs": [
                "64b7f1e6f9c9d4e5b8a9f7c3"
              ],
              "hasMainBreaker": true,
              "mainBreakerRating": 63,
              "location": "Ground Floor, Electrical Room",
              "remarks": "Main distribution panel installed in 2024",
              "system": "64b7f1e6f9c9d4e5b8a9f7c3",
              "tenant": "64b7f1e6f9c9d4e5b8a9f7c4",
              "zone": "64b7f1e6f9c9d4e5b8a9f7c5",
              "room": "64b7f1e6f9c9d4e5b8a9f7c6",
              "sandboxDevices": [
                {
                  "id": "sandbox-device-1",
                  "type": "DUMB_MCB",
                  "name": "Kitchen Lights",
                  "digitalTwinX": 400,
                  "rowLine": 2,
                  "ratedCurrent": 16,
                  "ratedVoltage": 230,
                  "mcbType": "BUILT_IN",
                  "mcbPoles": "SINGLE_POLE",
                  "leakageCurrent": 30,
                  "color": "#94a3b8",
                  "notes": "Connected to kitchen circuit"
                }
              ],
              "sandboxWires": [
                {
                  "id": "wire-1",
                  "from": {
                    "deviceId": "sandbox-device-1",
                    "deviceType": "DUMB_MCB",
                    "side": "LEFT"
                  },
                  "to": {
                    "deviceId": "sandbox-device-1",
                    "deviceType": "DUMB_MCB",
                    "side": "LEFT"
                  },
                  "color": "#fbbf24",
                  "thickness": 3,
                  "label": "Phase 1"
                }
              ],
              "digitalTwinWidth": 1200,
              "digitalTwinHeight": 800,
              "singleLineDiagramKey": "single-line-diagrams/abc123-def456.png",
              "singleLineDiagramUrl": "https://cdn.example.com/single-line-diagrams/abc123-def456.png",
              "createdAt": "2024-08-25T15:00:00Z",
              "updatedAt": "2024-08-25T15:00:00Z"
            }
          ],
          "floorPlanKey": "floor-plans/uuid.png",
          "floorPlanUrl": "https://cdn.ecovolt.ai/floor-plans/uuid.png",
          "floorPlan": "floorPlan"
        },
        "room": "room",
        "system": "system",
        "createdAt": "2021-09-01",
        "updatedAt": "2021-09-01",
        "lastSeen": "2021-09-01",
        "isLocked": false,
        "isSpare": false,
        "deviceSchedule": {
          "oneTimeSchedules": [
            {
              "dateTime": "2023-10-31T06:00:00Z",
              "action": "OFF",
              "actionValue": 24,
              "ruleName": "ruleName"
            }
          ],
          "monday": [
            {
              "time": "06:00",
              "action": "OFF",
              "actionValue": 24,
              "ruleName": "ruleName"
            }
          ],
          "tuesday": [
            {
              "time": "06:00",
              "action": "OFF",
              "actionValue": 24,
              "ruleName": "ruleName"
            }
          ],
          "wednesday": [
            {
              "time": "06:00",
              "action": "OFF",
              "actionValue": 24,
              "ruleName": "ruleName"
            }
          ],
          "thursday": [
            {
              "time": "06:00",
              "action": "OFF",
              "actionValue": 24,
              "ruleName": "ruleName"
            }
          ],
          "friday": [
            {
              "time": "06:00",
              "action": "OFF",
              "actionValue": 24,
              "ruleName": "ruleName"
            }
          ],
          "saturday": [
            {
              "time": "06:00",
              "action": "OFF",
              "actionValue": 24,
              "ruleName": "ruleName"
            }
          ],
          "sunday": [
            {
              "time": "06:00",
              "action": "OFF",
              "actionValue": 24,
              "ruleName": "ruleName"
            }
          ],
          "confirmationState": "PENDING"
        },
        "realTimePower": 1500,
        "realTimeCurrent": 6.5,
        "totalEnergyUsage": 0,
        "totalEnergySaved": 0,
        "autoUpdateAttempts": 0,
        "autoUpdateBlacklisted": false,
        "manualUpdateBlacklist": false,
        "lastAutoUpdateAttempt": "2024-08-25T15:00:00Z",
        "inactivityNotificationEnabled": false,
        "inactivityNotificationSentAt": "2024-08-25T15:00:00Z"
      }
    ],
    "distributionBoxes": [
      {
        "_id": "64b7f1e6f9c9d4e5b8a9f7c3",
        "name": "Main DB Box - Floor 1",
        "boxNumber": 1,
        "numberOfRows": 1,
        "mcbs": [
          "64b7f1e6f9c9d4e5b8a9f7c3"
        ],
        "hasMainBreaker": true,
        "mainBreakerRating": 63,
        "location": "Ground Floor, Electrical Room",
        "remarks": "Main distribution panel installed in 2024",
        "system": "64b7f1e6f9c9d4e5b8a9f7c3",
        "tenant": "64b7f1e6f9c9d4e5b8a9f7c4",
        "zone": "64b7f1e6f9c9d4e5b8a9f7c5",
        "room": "64b7f1e6f9c9d4e5b8a9f7c6",
        "sandboxDevices": [
          {
            "id": "sandbox-device-1",
            "type": "DUMB_MCB",
            "name": "Kitchen Lights",
            "digitalTwinX": 400,
            "rowLine": 2,
            "ratedCurrent": 16,
            "ratedVoltage": 230,
            "mcbType": "BUILT_IN",
            "mcbPoles": "SINGLE_POLE",
            "leakageCurrent": 30,
            "color": "#94a3b8",
            "notes": "Connected to kitchen circuit"
          }
        ],
        "sandboxWires": [
          {
            "id": "wire-1",
            "from": {
              "deviceId": "sandbox-device-1",
              "deviceType": "DUMB_MCB",
              "side": "LEFT"
            },
            "to": {
              "deviceId": "sandbox-device-1",
              "deviceType": "DUMB_MCB",
              "side": "LEFT"
            },
            "color": "#fbbf24",
            "thickness": 3,
            "label": "Phase 1"
          }
        ],
        "digitalTwinWidth": 1200,
        "digitalTwinHeight": 800,
        "singleLineDiagramKey": "single-line-diagrams/abc123-def456.png",
        "singleLineDiagramUrl": "https://cdn.example.com/single-line-diagrams/abc123-def456.png",
        "createdAt": "2024-08-25T15:00:00Z",
        "updatedAt": "2024-08-25T15:00:00Z"
      }
    ],
    "floorPlanKey": "floor-plans/uuid.png",
    "floorPlanUrl": "https://cdn.ecovolt.ai/floor-plans/uuid.png",
    "floorPlan": "floorPlan"
  },
  "room": "room",
  "system": "system",
  "createdAt": "2021-09-01",
  "updatedAt": "2021-09-01",
  "lastSeen": "2021-09-01",
  "isLocked": false,
  "isSpare": false,
  "deviceSchedule": {
    "oneTimeSchedules": [
      {
        "dateTime": "2023-10-31T06:00:00Z",
        "action": "OFF",
        "actionValue": 24,
        "ruleName": "ruleName"
      }
    ],
    "monday": [
      {
        "time": "06:00",
        "action": "OFF",
        "actionValue": 24,
        "ruleName": "ruleName"
      }
    ],
    "tuesday": [
      {
        "time": "06:00",
        "action": "OFF",
        "actionValue": 24,
        "ruleName": "ruleName"
      }
    ],
    "wednesday": [
      {
        "time": "06:00",
        "action": "OFF",
        "actionValue": 24,
        "ruleName": "ruleName"
      }
    ],
    "thursday": [
      {
        "time": "06:00",
        "action": "OFF",
        "actionValue": 24,
        "ruleName": "ruleName"
      }
    ],
    "friday": [
      {
        "time": "06:00",
        "action": "OFF",
        "actionValue": 24,
        "ruleName": "ruleName"
      }
    ],
    "saturday": [
      {
        "time": "06:00",
        "action": "OFF",
        "actionValue": 24,
        "ruleName": "ruleName"
      }
    ],
    "sunday": [
      {
        "time": "06:00",
        "action": "OFF",
        "actionValue": 24,
        "ruleName": "ruleName"
      }
    ],
    "confirmationState": "PENDING"
  },
  "realTimePower": 1500,
  "realTimeCurrent": 6.5,
  "totalEnergyUsage": 0,
  "totalEnergySaved": 0,
  "autoUpdateAttempts": 0,
  "autoUpdateBlacklisted": false,
  "manualUpdateBlacklist": false,
  "lastAutoUpdateAttempt": "2024-08-25T15:00:00Z",
  "inactivityNotificationEnabled": false,
  "inactivityNotificationSentAt": "2024-08-25T15:00:00Z",
  "meterSize": "DN15",
  "meterModel": "meterModel",
  "realTimeFlowRate": 0,
  "realTimePressure": 0,
  "realTimeTemperature": 0,
  "flowRateMax": 10,
  "flowRateMin": 10,
  "pressureMax": 10,
  "pressureMin": 10,
  "temperatureMin": 24,
  "temperatureMax": 24,
  "waterConsumption": 0,
  "isLeakDetected": true,
  "lastLeakNotificationAt": "2024-08-25T15:00:00Z",
  "leakThresholdFlowRate": 5,
  "notificationThresholdHour": 4
}

json

application/json

Get all water meters in a system (with filtering and sorting)

GET

http://localhost:8080

/api/water-meter/system/{systemId}

Retrieve all water meters in a system with support for pagination, search, filtering, and sorting. Filterable fields: tenantId, zoneId, roomId, meterSize, isLeakDetected, isLocked, onStatus, versionNumber. Sortable fields: createdAt, updatedAt, deviceName, meterSize, realTimeFlowRate, realTimePressure, realTimeTemperature, waterConsumption, isLeakDetected, location, lastSeen, tenantName, userName, roomName, chipModel, versionNumber, batchNumber, systemName, onStatus. Use comma-separated values for multiple sorts, e.g., "realTimeFlowRate,createdAt" with corresponding "desc,asc".

Get all water meters in a system (with filtering and sorting) › path Parameters

systemId

string · required

Get all water meters in a system (with filtering and sorting) › query Parameters

page

number · min: 1

Page number for pagination

Example: 1

Default: 1

size

number · min: 1 · max: 1000

Items per page

Example: 50

Default: 50

search

string

Search keyword in error message or metadata

Example: overheat

sort_by

string

Fields to sort by (comma-separated for multiple fields)

Example: createdAt,name

sort_order

string[]

Sort order for each field (comma-separated, must match sort_by length)

Enum values:

asc

desc

Example: desc,asc

tenantId

string

Filter by tenant ID

Example: 507f1f77bcf86cd799439011

zoneId

string

Filter by zone ID

Example: 507f1f77bcf86cd799439012

roomId

string

Filter by room ID

Example: 507f1f77bcf86cd799439013

onStatus

DeviceStatus · enum

Filter by device status

Status of the device (ON / OFF)

Enum values:

OFF

INACTIVE

ERROR

ACTIVE

versionNumber

string

Filter by firmware version

Example: 1.0.0

meterSize

WaterMeterSize · enum

Filter by meter size

Pipe diameter size (DN15, DN20, DN25, etc.)

Enum values:

DN15

DN20

DN25

DN32

DN40

DN50

isLeakDetected

boolean

Filter by leak detection status

Example: false

isLocked

boolean

Filter by lock status

Example: false

isSpare

boolean

Filter by spare status. When true, returns only spare devices. When false, returns only non-spare devices. Omit to return all.

Example: false

Get all water meters in a system (with filtering and sorting) › Responses

List of water meters with pagination metadata

GetWaterMetersResponseDto

FilteredWaterMeterDto[] · required

List of water meters with organizational hierarchy details

total

number · required

page

number · required

size

number · required

totalPages

number · min: 0 · required

Total number of pages

Example: 3

GET/api/water-meter/system/{systemId}

curl http://localhost:8080/api/water-meter/system/:systemId

Example Responses

{
  "data": [
    {
      "_id": "64b7f1e6f9c9d4e5b8a9f7c3",
      "macId": "1092384701928347",
      "deviceName": "Living Room AC",
      "onStatus": "ON",
      "totalEnergyUsage": 500,
      "deviceNumber": 3,
      "batchNumber": 23,
      "chipModel": "ESP8266",
      "versionNumber": "1.0.0",
      "tenantId": "64b7f1e6f9c9d4e5b8a9f7c4",
      "tenantName": "Faculty of Engineering",
      "zoneId": "64b7f1e6f9c9d4e5b8a9f7c5",
      "zoneName": "Zone A",
      "roomId": "64b7f1e6f9c9d4e5b8a9f7c6",
      "roomName": "Room 101",
      "dbId": "64b7f1e6f9c9d4e5b8a9f7c7",
      "dbName": "Main Distribution Box",
      "systemId": "64b7f1e6f9c9d4e5b8a9f7c3",
      "systemName": "NUS Engineering Building",
      "realTimePower": 115,
      "realTimeCurrent": 0.5,
      "ssid": "XH001",
      "deviceSchedule": {
        "oneTimeSchedules": [
          {
            "dateTime": "2023-10-31T06:00:00Z",
            "action": "OFF",
            "actionValue": 24,
            "ruleName": "ruleName"
          }
        ],
        "monday": [
          {
            "time": "06:00",
            "action": "OFF",
            "actionValue": 24,
            "ruleName": "ruleName"
          }
        ],
        "tuesday": [
          {
            "time": "06:00",
            "action": "OFF",
            "actionValue": 24,
            "ruleName": "ruleName"
          }
        ],
        "wednesday": [
          {
            "time": "06:00",
            "action": "OFF",
            "actionValue": 24,
            "ruleName": "ruleName"
          }
        ],
        "thursday": [
          {
            "time": "06:00",
            "action": "OFF",
            "actionValue": 24,
            "ruleName": "ruleName"
          }
        ],
        "friday": [
          {
            "time": "06:00",
            "action": "OFF",
            "actionValue": 24,
            "ruleName": "ruleName"
          }
        ],
        "saturday": [
          {
            "time": "06:00",
            "action": "OFF",
            "actionValue": 24,
            "ruleName": "ruleName"
          }
        ],
        "sunday": [
          {
            "time": "06:00",
            "action": "OFF",
            "actionValue": 24,
            "ruleName": "ruleName"
          }
        ],
        "confirmationState": "PENDING"
      },
      "lastSeen": "2024-10-15T12:30:00.000Z",
      "isLocked": false,
      "inactivityNotificationEnabled": false,
      "meterSize": "DN15",
      "meterModel": "meterModel",
      "realTimeFlowRate": 0,
      "realTimePressure": 0,
      "realTimeTemperature": 0,
      "waterConsumption": 0,
      "isLeakDetected": false,
      "lastLeakNotificationAt": "2024-08-25T15:00:00Z",
      "leakThresholdFlowRate": 5,
      "flowRateMax": 10,
      "flowRateMin": 10,
      "pressureMax": 10,
      "pressureMin": 10,
      "temperatureMin": 24,
      "temperatureMax": 24
    }
  ],
  "total": 0,
  "page": 0,
  "size": 0,
  "totalPages": 3
}

json

application/json

Get leak alert history

GET

http://localhost:8080

/api/water-meter/{systemId}/{waterMeterId}/leak-history

Get leak alert history › path Parameters

systemId

string · required

waterMeterId

string · required

Get leak alert history › query Parameters

page

number

size

number

Get leak alert history › Responses

200

LeakHistoryResponseDto

Notification[] · required

Array of leak detection notifications

total

number · required

Total number of leak notifications

Example: 25

page

number · required

Current page number

Example: 1

size

number · required

Number of items per page

Example: 10

totalPages

number · min: 0 · required

Total number of pages

Example: 3

Get threshold configuration history

GET

http://localhost:8080

/api/water-meter/{systemId}/{waterMeterId}/threshold-history

Get threshold configuration history › path Parameters

systemId

string · required

waterMeterId

string · required

Get threshold configuration history › query Parameters

page

number

size

number

Get threshold configuration history › Responses

200

ThresholdHistoryResponseDto

AlertThresholdHistory[] · required

Array of threshold configuration history records

total

number · required

Total number of threshold history records

Example: 50

page

number · required

Current page number

Example: 1

size

number · required

Number of records per page

Example: 10

totalPages

number · min: 0 · required

Total number of pages

Example: 5

Get latest real-time reading

GET

http://localhost:8080

/api/water-meter/{systemId}/{waterMeterId}/latest-reading

Returns the current real-time readings from the water meter device (flow rate, pressure, temperature)

Get latest real-time reading › path Parameters

systemId

string · required

waterMeterId

string · required

Get latest real-time reading › Responses

200

WaterMeterLatestReadingDto

realTimeFlowRate

number · required

Current flow rate in liters per minute

Example: 12.5

realTimePressure

number · required

Water pressure in bar

Example: 3.2

lastSeen

string · date-time · required

Last time the device sent data

Example: 2026-01-14T10:08:20.717Z

realTimeTemperature

number

Water temperature in Celsius (optional)

Example: 22

Smart Switch - Control Water Meter - Management

Get water meter by ID

GET

http://localhost:8080

/api/water-meter/by-id/{id}

Get water meter by ID › path Parameters

id

string · required

Get water meter by ID › Responses

200

WaterMeter

_id

string · required

Primary ID of the Device

Example: 64b7f1e6f9c9d4e5b8a9f7c3

deviceType

string · enum · required

Type of device (discriminator field)

Enum values:

PLUG

MCB

ENV_SENSOR

SMART_SWITCH

AIRCON_CONTROL

WATER_METER

Example: PLUG

macId

string · required

MAC ID of the Device (from IoT device)

Example: 1092384701928347

deviceName

string · required

Name of the Device

Example: Living Room AC

deviceNumber

number · required

Unique device number for identification

Example: 1

onStatus

string · enum · required

Status of the Device (ON / OFF / INACTIVE / ERROR)

Enum values:

OFF

INACTIVE

ERROR

ACTIVE

Example: ON

location

string · required

Physical location or address where the device is installed

Example: Room 101, Building A

remarks

string · required

Remarks for the Device

batchNumber

number · required

Manufacturing batch number for tracking production groups

Example: 1

chipModel

string · enum · required

Hardware chip model identifier used in the device

Enum values:

ESP8266

ESP32C2

ESP32C5

ESP32

ESP32C3

Example: ESP32C2

versionNumber

string · required

Firmware version number currently running on the device

Example: 1.0.0

ssid

string · required

Network SSID (Wi-Fi name) that the device is connected to

Example: IoT-Network-5G

tenant

string · required

Tenant ID reference

object · required

Tagged Zone

room

string · required

Room ID reference

system

string · required

System ID reference

createdAt

string · date-time · required

Date Time of the Creation

Example: 2021-09-01

updatedAt

string · date-time · required

Date Time of the Update

Example: 2021-09-01

lastSeen

string · date-time · required

Last time the device was seen/reported

Example: 2021-09-01

isLocked

boolean · required

Whether the device is locked. When locked, the device on/off status cannot be toggled.

Example: false

totalEnergyUsage

number · required

Total cumulative energy usage in kWh

Example: 0

totalEnergySaved

number · required

Total energy saved through optimization in kWh

Example: 0

autoUpdateAttempts

number · required

Number of auto-update OTA attempts sent to this device

Example: 0

autoUpdateBlacklisted

boolean · required

Whether device is blacklisted from auto-updates (max retries exceeded)

Example: false

manualUpdateBlacklist

boolean · required

Whether device is manually blacklisted from auto-updates by admin

Example: false

inactivityNotificationEnabled

boolean · required

Whether inactivity notifications are enabled for this device

Default: false

meterSize

string · enum · required

Pipe diameter size (DN15, DN20, DN25, etc.)

Enum values:

DN15

DN20

DN25

DN32

DN40

DN50

realTimeFlowRate

number · required

Current flow rate in liters per minute

realTimePressure

number · required

Water pressure in bar

waterConsumption

number · required

Total water consumption in liters (incremented hourly)

Default: 0

isLeakDetected

boolean · required

Whether a leak is currently detected

leakThresholdFlowRate

number · required

Current leak detection threshold in liters per minute

Default: 5

deviceModel

string

Model name or identifier of the device

Example: TP-Link HS110

deviceBrand

string

Brand or manufacturer of the device

Example: TP-Link

isSpare

boolean

Whether the device is a spare/inventory device. Spare devices can be filtered out of user-facing dashboards.

Example: false

object

Schedule configuration for the device. Contains recurring weekly schedules and one-time scheduled tasks.

realTimePower

number

Real-time power consumption in watts

Example: 1500

realTimeCurrent

number

Real-time current in amperes

Example: 6.5

lastAutoUpdateAttempt

string · date-time

Timestamp of last auto-update OTA attempt

inactivityNotificationSentAt

string · date-time

Timestamp when the last inactivity notification was sent for this device

meterModel

string

Meter model/manufacturer

realTimeTemperature

number

Water temperature in Celsius (optional)

flowRateMax

number

Max Threshold flow rate reading in L/min

Example: 10

flowRateMin

number

Min Threshold flow rate reading in L/min

Example: 10

pressureMax

number

Max Threshold pressure reading in bar

Example: 10

pressureMin

number

Min Threshold pressure reading in bar

Example: 10

temperatureMin

number

Min Threshold temperature reading in degrees Celsius

Example: 24

temperatureMax

number

Max Threshold temperature reading in degrees Celsius

Example: 24

lastLeakNotificationAt

string · date-time

Timestamp of last leak notification received

notificationThresholdHour

number

Hourly notification threshold — minimum hours between repeat notifications of the same type

Example: 4

Get all water meters in a system (with filtering and sorting)

GET

http://localhost:8080

/api/water-meter/system/{systemId}

Get all water meters in a system (with filtering and sorting) › path Parameters

systemId

string · required

Get all water meters in a system (with filtering and sorting) › query Parameters

page

number · min: 1

Page number for pagination

Example: 1

Default: 1

size

number · min: 1 · max: 1000

Items per page

Example: 50

Default: 50

search

string

Search keyword in error message or metadata

Example: overheat

sort_by

string

Fields to sort by (comma-separated for multiple fields)

Example: createdAt,name

sort_order

string[]

Sort order for each field (comma-separated, must match sort_by length)

Enum values:

asc

desc

Example: desc,asc

tenantId

string

Filter by tenant ID

Example: 507f1f77bcf86cd799439011

zoneId

string

Filter by zone ID

Example: 507f1f77bcf86cd799439012

roomId

string

Filter by room ID

Example: 507f1f77bcf86cd799439013

onStatus

DeviceStatus · enum

Filter by device status

Status of the device (ON / OFF)

Enum values:

OFF

INACTIVE

ERROR

ACTIVE

versionNumber

string

Filter by firmware version

Example: 1.0.0

meterSize

WaterMeterSize · enum

Filter by meter size

Pipe diameter size (DN15, DN20, DN25, etc.)

Enum values:

DN15

DN20

DN25

DN32

DN40

DN50

isLeakDetected

boolean

Filter by leak detection status

Example: false

isLocked

boolean

Filter by lock status

Example: false

isSpare

boolean

Filter by spare status. When true, returns only spare devices. When false, returns only non-spare devices. Omit to return all.

Example: false

Get all water meters in a system (with filtering and sorting) › Responses

List of water meters with pagination metadata

GetWaterMetersResponseDto

FilteredWaterMeterDto[] · required

List of water meters with organizational hierarchy details

total

number · required

page

number · required

size

number · required

totalPages

number · min: 0 · required

Total number of pages

Example: 3

Get leak alert history

GET

http://localhost:8080

/api/water-meter/{systemId}/{waterMeterId}/leak-history

Get leak alert history › path Parameters

systemId

string · required

waterMeterId

string · required

Get leak alert history › query Parameters

page

number

size

number

Get leak alert history › Responses

200

LeakHistoryResponseDto

Notification[] · required

Array of leak detection notifications

total

number · required

Total number of leak notifications

Example: 25

page

number · required

Current page number

Example: 1

size

number · required

Number of items per page

Example: 10

totalPages

number · min: 0 · required

Total number of pages

Example: 3

Get threshold configuration history

GET

http://localhost:8080

/api/water-meter/{systemId}/{waterMeterId}/threshold-history

Get threshold configuration history › path Parameters

systemId

string · required

waterMeterId

string · required

Get threshold configuration history › query Parameters

page

number

size

number

Get threshold configuration history › Responses

200

ThresholdHistoryResponseDto

AlertThresholdHistory[] · required

Array of threshold configuration history records

total

number · required

Total number of threshold history records

Example: 50

page

number · required

Current page number

Example: 1

size

number · required

Number of records per page

Example: 10

totalPages

number · min: 0 · required

Total number of pages

Example: 5

Get latest real-time reading

GET

http://localhost:8080

/api/water-meter/{systemId}/{waterMeterId}/latest-reading

Returns the current real-time readings from the water meter device (flow rate, pressure, temperature)

Get latest real-time reading › path Parameters

systemId

string · required

waterMeterId

string · required

Get latest real-time reading › Responses

200

WaterMeterLatestReadingDto

realTimeFlowRate

number · required

Current flow rate in liters per minute

Example: 12.5

realTimePressure

number · required

Water pressure in bar

Example: 3.2

lastSeen

string · date-time · required

Last time the device sent data

Example: 2026-01-14T10:08:20.717Z

realTimeTemperature

number

Water temperature in Celsius (optional)

Example: 22