HydroVu ingestion

Overview

hydrovu collects per-device physical series from the HydroVu API. Source API metadata determines parameter and unit column names.

Example configuration

client_id: "${env:HYDROVU_CLIENT_ID}"          # Required: credential reference.
client_secret: "${env:HYDROVU_CLIENT_SECRET}"  # Required: secret reference.
max_points_per_run: 1000                     # Required: example collection limit.
hydrovu_path: /hydrovu                       # Required: example output path.
archive_path: null                          # Default: no read-only seed archive.
devices:                                   # Required: devices to collect.
  - name: example-device                    # Required: example local name.
    id: 123                                 # Required: replace with a real device ID.
    active: true                            # Default: collect this device.
    comment: null                           # Default: no operator comment.

Use and behavior

Install with pond mknod hydrovu /etc/hydrovu --config-path hydrovu.yaml, then run pond run /etc/hydrovu -- collect. Incremental collection resumes from existing temporal data. Inactive devices are skipped.

An optional archive_path supplies read-only seed snapshots only when the writable device has no temporal data; it is not an output. OAuth credentials, API access, and real device IDs are live prerequisites.

Full configuration

Settings

FieldAccepted typeRequiredDefaultDescription
archive_pathstring | nullnonullOptional path within pond holding read-only seed archives (e.g. "/hydrovu-archive"), typically git-ingested FileDynamic Parquet .series snapshots laid out as {archive_path}/devices/{id}/*.series. Consulted by find_youngest_timestamp ONLY when the writeable device directory has no temporal data (a freshly reset pond), so live collection resumes from the archive's youngest timestamp instead of crawling from epoch. These archives are NOT written to.
client_idstringyesnot specifiedOAuth client ID (sensitive - redacted from debug output)
client_secretstringyesnot specifiedOAuth client secret (sensitive - redacted from debug output)
devicesarray of Hydro Vu Deviceyesnot specifiedDevice list
hydrovu_pathstringyesnot specifiedPath within pond for hydrovu data (e.g., "/hydrovu")
max_points_per_runintegeryesnot specifiedConstraints: format="uint"; minimum=0.

Hydro Vu Device

Device configuration specifying which HydroVu location to collect

FieldAccepted typeRequiredDefaultDescription
activebooleannotrueWhen false, device is skipped during collect. Default: true.
commentstring | nullnonot specified
idintegeryesnot specifiedConstraints: format="int64".
namestringyesnot specified