Skip to content

Dam

Irrigation dams and reservoirs with water level monitoring.

Irrigation dams and reservoirs with water level monitoring. Send readings for this device type with the field names in the metrics table. Every table on this page is generated from the platform, so it matches what the ingest service accepts today.

Metrics#

These are the registered field names for the data object. A reading may carry any subset. A missing field is not an error, so a device can report one value at a time. Any field you send that is not listed here is a custom data point. Custom data points appear on dashboards. They never drive alerts or forecasts.

Dam metric fields
FieldTypeRequiredUnitDescription
levelnumberYes%Water level. In "level" mode this is a percentage of full supply level; in "ultrasonic" mode the device sends the raw sensor distance and ingest normalizes it to a percentage before storage.
distancenumberNoNot setRaw ultrasonic sensor distance from the sensor to the water surface, in the device's configured sensorUnit. Populated by ingest when trackingMode is "ultrasonic".

Configuration#

Configuration is set on the device in the app. It is not sent with a reading. It tells Logable how to read the values, for example which unit a weight is in.

Dam configuration fields
FieldTypeRequiredDefaultDescription
trackingModelevel | ultrasonicYeslevelHow the device reports level. "level": device sends a percentage directly. "ultrasonic": device sends a distance reading (as the level metric) that ingest converts to a percentage using damDepth and sensorHeight.
sensorUnitmm | cm | mNommUnit of the raw distance reported by the ultrasonic sensor. When set, damDepth/sensorHeight are interpreted as METRES and ingest converts the raw reading to metres before normalizing. Only relevant when trackingMode is "ultrasonic".
damDepthnumberNoNot setDepth of the dam at full supply level, in metres. Required when trackingMode is "ultrasonic" (used to normalize the sensor distance) or when capacitySource is "dimensions" (used as the depth dimension for size-based capacity).
sensorHeightnumberNo0How far the ultrasonic sensor sits above the full-supply line, in metres. Defaults to 0.
capacitySourcemanual | dimensionsNomanualHow total capacity is determined. "manual": user enters capacity + capacityUnit. "dimensions": capacity is computed from the dam geometry (damShape + dimensions + damDepth).
capacitynumberNoNot setTotal storage capacity (manual entry).
capacityUnitML | kL | m3 | LYesMLUnit of measurement for the manually-entered capacity.
damShaperound | rectangularYesroundGeometry used to compute size-based capacity. Only relevant when capacitySource is "dimensions".
damDiameternumberYesNot setDiameter of the dam across the surface, in metres (round shape). Use the diameter, not the radius, because it is easier to measure across a dam.
damLengthnumberYesNot setLength of the dam, in metres (rectangular shape).
damWidthnumberYesNot setWidth of the dam, in metres (rectangular shape).
locationstringNoNot setDam location

Example payload#

A complete request body for this device type.

{
  "timestamp": "2026-07-01T10:00:00.000Z",
  "status": "online",
  "data": {
    "level": 64.8,
    "distance": 100
  }
}

Code samples#

Replace the placeholder id and token with the values from the device's Connection tab.

Over HTTP

# Dam - Quick Test (curl)
# Device Type: dam | Device ID: <DEVICE_ID>
#
# The "data" fields shown are this device type's registered metrics.
# Optionally add your OWN custom fields to "data" (e.g. "totalizer": 1284300.0).
# Custom keys: start with a letter; letters/digits/underscores; max 64 chars.
# Up to 20 custom fields; values: number, string (max 256 chars) or boolean.
# Custom values appear on dashboards via a widget's "Show Custom Data" option.

curl -X POST "https://ingest.logable.app/ingest/<DEVICE_ID>" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <DEVICE_TOKEN>" \
  -d '{"timestamp":"2026-07-01T10:00:00.000Z","status":"online","data":{"level":64.8,"distance":100}}'

Over MQTT

"""
Dam - Logable MQTT Integration (Python)
Device Type: dam
Device ID: <DEVICE_ID>

Broker: MQTT over TLS on port 8883 (Let's Encrypt certificate; standard system CAs validate it). WebSocket: wss://mqtt.logable.app/mqtt
Client ID must be unique per connection - a duplicate ID disconnects the other client.
Access: this device may publish/subscribe only under devices/<DEVICE_ID>/* - everything else is denied.

Installation: pip install paho-mqtt
"""

import paho.mqtt.client as mqtt
import json
from datetime import datetime, timezone
import time

MQTT_HOST = "mqtt.logable.app"
MQTT_PORT = 8883
MQTT_USERNAME = "<DEVICE_ID>"
MQTT_PASSWORD = "<DEVICE_TOKEN>"
MQTT_CLIENT_ID = "logable-<DEVICE_ID>"
MQTT_TOPIC = "devices/<DEVICE_ID>/data"

def on_connect(client, userdata, flags, reason_code, properties):
    if reason_code.is_failure:
        print(f"Connection failed: {reason_code}")
    else:
        print(f"Connected to MQTT broker at {MQTT_HOST}:{MQTT_PORT}")

def send_data(client):
    # The "data" fields shown are this device type's registered metrics.
    # Optionally add your OWN custom fields to "data" (e.g. "totalizer": 1284300.0).
    # Custom keys: start with a letter; letters/digits/underscores; max 64 chars.
    # Up to 20 custom fields; values: number, string (max 256 chars) or boolean.
    # Custom values appear on dashboards via a widget's "Show Custom Data" option.
    payload = {
        "timestamp": datetime.now(timezone.utc).isoformat(),
        "status": "online",
        "data": {
            "level": 64.8,
            "distance": 100
        }
    }
    result = client.publish(MQTT_TOPIC, json.dumps(payload), qos=1)
    if result.rc == mqtt.MQTT_ERR_SUCCESS:
        print(f"Data sent to {MQTT_TOPIC}")

def main():
    client = mqtt.Client(mqtt.CallbackAPIVersion.VERSION2, client_id=MQTT_CLIENT_ID)
    client.on_connect = on_connect
    client.username_pw_set(MQTT_USERNAME, MQTT_PASSWORD)
    # TLS with the default system CA store - validates the broker's
    # Let's Encrypt certificate out of the box.
    client.tls_set()

    try:
        client.connect(MQTT_HOST, MQTT_PORT, keepalive=60)
        client.loop_start()
        time.sleep(1)
        send_data(client)
        time.sleep(1)
        client.loop_stop()
        client.disconnect()
    except Exception as e:
        print(f"Error: {e}")

if __name__ == "__main__":
    main()

Widgets#

Widgets you can put on a dashboard for this device type.

  • Data Table. Tabular view of device metrics with pagination, sorting, and real-time updates
  • Line Chart. Time-series line chart for visualizing metrics over time with multiple devices
  • Area Chart. Filled area chart for volume and trend visualization
  • Bar Chart. Categorical comparison with vertical or horizontal bars
  • Pie Chart. Proportional distribution visualization
  • Radar Chart. Multi-dimensional data comparison
  • Gauge. Radial gauge for single metric monitoring with thresholds
  • Stat Card. Single-value KPI display with optional trend sparkline
  • Status Card. Device health and connectivity status indicator
  • Dam Visualization. Visual representation of dam water level with metrics
  • Plant Status. Fleet-wide asset health, ranked by concern

Guides#

How to put this equipment on a dashboard, and what to alert on.

Search the docs

Find a guide, an integration page, or a device type.