Sensors

A sensor reports for one asset¶

A sensor is what holds a key and sends readings for one asset — a controller on a pump, a logger, a gateway posting for the equipment behind it. It belongs to one asset of one class, and stays on it: to report for another asset, delete it and make one there.

On the class's page, once the class measures something, Sensors › New sensor:

1. A name (Pump 2 outlet unit).
2. The asset it reports for, chosen from the class's assets (past 200 of them, found by typing its name).
3. Its channels — the sensor's own names for what it sends, each mapped to one of the class's measurements: t1 → Temperature, p1 → Pressure. A channel is letters, digits and _ . : -, up to 64, starting with a letter or digit; two channels cannot share a measurement.
4. Make the sensor.

The sensor sends its own names; the platform stores the class's. A firmware never has to change to fit a class: change the mapping instead (the sensor's page › Channels › Edit the channels).

Its key¶

A sensor sends with a key of its own, hyzsn_…. On the sensor's page (Hyz Assets › the class › the sensor), Make a key: it is shown once, in a dialog with a first request already carrying it — copy it into the sensor. Afterwards the page shows only its last four characters.

• Replace the key makes a new one; the old one stops at once.
• Revoke the key leaves the sensor without one; everything it sends is refused.
• Making, replacing or revoking asks for a recent confirmation of who you are.
• The key opens that sensor's endpoint and nothing else. It is not a session and acts as no one; an agent's token or a personal key cannot make one.

The same keys are in Hyz Console › Licenses and apps › Sensors, beside every sensor of the enterprise.

On and off¶

Switch off a sensor and everything it sends is refused (SENSOR_DISABLED) until it is switched on. A switched-off sensor is never stale, and an asset whose sensors are all off reads None.

Haiyz can switch a sensor off too — it then reads Switched off by Haiyz, with the reason, and its enterprise cannot switch it on until Haiyz releases it (Holds and limits).

Its page¶

• Send readings — the address, the key's preview and a request built from its channels, ready to paste. The contract in full is the sensor endpoint.
• Channels.
• Readings — its own lines on a chart per measurement, with its events marked (Readings).
• Traffic — per day (UTC): calls, readings accepted, already received and refused, requests refused whole, the reasons with their counts, and the last refusal in words with its time and channel.
• Settings — its name and a description.

A sensor's calls are counted there, not written to the audit trail: the trail keeps what a person does to it — made, changed, deleted, its key made, replaced or revoked, a hold set or released.

Deleting a sensor¶

Delete says first what goes: its readings — those its events keep said apart — and its open events, which close and stay on the events list. When it was the last sensor reporting on its asset, the asset's latest values are cleared and it reads None; its point stays.