Overview

Akuasense API 1.0.6-module-name

Akuasense REST API — read plus limited write. Authentication by API key (x-api-key). Data is scoped to the key’s company. Writes require an OWNER/MANAGER role (the key’s creator) and accept Idempotency-Key. Times in ISO 8601 UTC; measurements carry their unit; reference data as { code, label }.

Irrigation (since 1.0.2): logging water applications at the probe, versioned setups and schedules. Two things to know before integrating:

Two figures in millimetres. waterMm is the dose over the total area — comparable to rainfall, to ETc or to the water meter. waterMmWetted is the dose in the wetted zone, where the probe is installed: that is the one that explains the observed rise in moisture. Under drip irrigation the ratio is roughly 1 to 3.
Millimetres are frozen at write time, using the equipment valid on the date of the watering and a snapshot of the parameters used. Correcting an emitter flow rate next year will not rewrite history.

Logging refuses the inconsistent, never the incomplete: a watering whose dose cannot be computed is still recorded, with waterMm at null, and warnings says why.

Sensor error codes (since 1.0.4): a sensor that does not respond records a code instead of a measurement. The series (/measurements, /measurements/weighted, /measurements/latest, the /stream feed, MCP tools) serve them as is, without removing or flagging them. In temperature they are recognisable: −50 °C or below. In moisture they are not: once calibrated, they come out as normal-looking values, or pinned to saturation (_vwc_max at 100), and can pull the weighted series down to 0. A moisture code almost always falls on a reading where the temperature is also in error at the same instant: that is the most reliable clue. The water status (/agronomic-state) detects them at the latest reading: sensorError becomes true, state and value become null.

Annotation units (since 1.0.5): on moisture curves, an annotation belongs to the unit it was drawn in — unit: vwc (default), vwc_max or mm — and is only shown in that unit. Existing annotations are in vwc. Agronomic thresholds are set in vwc: that is how the alert and the water status read them. Only the wilting point of the humidity curve arms an alert; on any other curve it is just a marker.

Probe names (since 1.0.6): a module carries name, the name the hub shows it under — the one the customer gave it, otherwise its default name, “Probe 3” or “Sonde 3” depending on lang. It appears on /modules, /modules/{id} and on the module of an alert (/alerts). It is changed in the hub, not through the API. To find a module again from one call to the next, keep its id: the name can change, and the default name follows the language.

Information

OpenAPI version: 3.1.0

Authentication

apiKeyAuth

Security scheme type: apiKey

Header parameter name: x-api-key

Overview

Akuasense API 1.0.6-module-name

Operations

Authentication

apiKeyAuth