Einige Telemetrie-Schlüssel und Attribute haben in Hermetry eine feste Bedeutung. Manche dürfen Sie gar nicht schreiben; andere werden von der Plattform oder dem Gerät geschrieben und von Funktionen wie Firmware-Updates, Standortstatus oder Kameras gelesen. Diese Seite listet sie auf, damit Sie Konflikte vermeiden und die benötigten verwenden können.
Regeln auf einen Blick
| Regel | Telemetrie | Attribute |
|---|---|---|
| Zeichen | A–Z a–z 0–9 _ . - | Gleich |
| Länge | 1 bis 64 | 1 bis 128 (geteilte Schlüssel außer cfg.*: 57) |
| Nie ein Schlüssel | deleted | |
| Reserviertes Präfix | _, fw_, current_fw_, cfg. | _ (Plattform); fw_, current_fw_ (Firmware) |
| Groß-/Kleinschreibung | Groß-/Kleinschreibung beachten | Groß-/Kleinschreibung beachten |
Ein Telemetrie-Schlüssel mit reserviertem Präfix wird mit key_reserved verworfen; der Rest der Nachricht wird gespeichert. Ein Attributschreibvorgang mit einem reservierten Schlüssel wird mit keys_invalid abgelehnt, mit dem Grund reserved für den Schlüssel. Siehe Telemetrie-Schlüssel und Attribute.
Schlüssel, die Sie nie schreiben dürfen
Personen, die API und Flows dürfen diese nicht als Server- oder geteilte Attribute schreiben:
| Schlüssel oder Muster | Eigentümer | Zweck |
|---|---|---|
_* | Die Plattform | Interne Schlüssel |
fw_* | Firmware-Updates | Das dem Gerät angebotene Update (geteilt) und der Fortschritt des Geräts (Client) |
current_fw_* | Das Gerät | Was das Gerät aktuell ausführt |
*.state, *.reason | Das Gerät oder Gateway | Das Ergebnis eines Sollwerts: Ein Gateway antwortet mit <key>.state und <key>.reason für ein geteiltes Attribut, das es auf ein Kind-Gerät angewendet hat |
cfg_rejected, cfg_applied_ts, cfg_hash | Das Gerät | Seine Konfigurationsverwaltung |
attr_error | Das Gerät | Ein Attribut, das es nicht anwenden konnte |
rpc_result | Das Gerät | Das Ergebnis eines länger laufenden Befehls |
cert_not_after | Das Gerät | Wann sein Zertifikat abläuft |
time_quality | Das Gerät oder Gateway | Ob Zeitstempel von einer synchronisierten Uhr stammen |
session_limits | Die Plattform | Die wirksamen Ratenlimits des Geräts, beim Senden berechnet und nie gespeichert |
deleted | Die Markierung entfernter Schlüssel auf der Leitung |
Firmware-Schlüssel
Von Hermetry als geteilte Attribute geschrieben, wenn ein Update angeboten wird:
| Schlüssel | Inhalt |
|---|---|
fw_title, fw_version | Name und Version des Pakets |
fw_size | Größe in Bytes |
fw_checksum, fw_checksum_algorithm | Kleingeschriebenes Hex und SHA256 |
fw_url | Eine kurzlebige HTTPS-Download-Adresse, 15 Minuten gültig |
fw_sig | Die losgelöste Signatur, falls vorhanden |
fw_allow_metered | Ob das Gerät über eine Datenvolumen-begrenzte Verbindung laden darf |
Vom Gerät als Client-Attribute gemeldet:
| Schlüssel | Inhalt |
|---|---|
fw_state | DOWNLOADING, DOWNLOADED, VERIFIED, UPDATING, UPDATED, FAILED |
fw_error | Ein Fehlercode, mit FAILED |
fw_progress | 0 bis 100 während des Ladens |
fw_wait | metered, quota_exhausted oder approval, solange das Gerät das Update zurückhält |
current_fw_title, current_fw_version | Was jetzt läuft; wird nach jeder Verbindung gesendet |
Siehe Firmware-Updates (OTA).
Konfigurationsschlüssel
| Schlüssel | Geltungsbereich | Bedeutung |
|---|---|---|
cfg.* | Nur geteilt | Gewünschte Konfiguration, bis zu 128 Zeichen je Schlüssel. Das Gerät meldet zurück, was es angewendet hat. Bei einem lizenzierten Gerät, dessen Einstellungen auf dem Reiter Einstellungen verwaltet werden, antwortet ein Schreibvorgang mit 409: Ändern Sie es dort. |
cfg_rejected, cfg_applied_ts, cfg_hash | Client | Die Antwort des Geräts zu seiner Konfiguration |
Siehe Geräte-Fernkonfiguration.
Telemetrie-Schlüssel mit Bedeutung
| Schlüssel | Gelesen von | Bedeutung |
|---|---|---|
status | Standortstatus, Standortansichten, 3D-Färbungen | critical, alarm, error, fault, danger, 2, true bedeuten Critical; warning, warn, 1 bedeuten Warning; alles andere OK. Eine Karte kann stattdessen einen anderen Schlüssel lesen. Siehe Standortstatus und der Status-Schlüssel. |
raw | Decoder, Flows | Ein Body, der kein JSON-Objekt ist, als Text gespeichert (standardmäßig 4.096 Bytes). Siehe Telemetrie-Schlüssel. |
<topic>.<key> | Schlüssel eines eigenen Topics, wenn das Profil die Schlüssel mit dem Topic präfixiert | |
lat, lng | Kartenkacheln der fertigen Lösungen | Position. Andere Boards können beliebige Spaltennamen verwenden. |
<element>.<field> | Prozesszeichnungen | Messwerte eines gezeichneten Elements, zum Beispiel p1.running, pt.value |
Hinweis
true in status bedeutet Critical. Senden Sie status: true nicht als „läuft“.
Von Modulen geschriebene Attribute
| Schlüssel | Geltungsbereich | Geschrieben von | Bedeutung |
|---|---|---|---|
liveUrl | Server | Kameras | Der Live-Link der Kamera, solange die Live-Ansicht eingeschaltet ist |
liveUrlHigh | Server | Kameras | Der hochauflösende Link, wenn die Kamera einen zweiten brauchbaren H.264-Stream hat |
esim.capability, esim.profiles | Client | Lizenzierte Router | Der eSIM-Chip und die Profile des Routers. Die eSIM-Verwaltung ist in Entwicklung. |
Siehe Kameras auf Dashboards.
Befehlsmethoden-Familien
Einige Befehlsmethoden gehören zu einem Modul, und nur dieses Modul darf sie senden, z. B. tunnel.* (Fernzugriff) und esim.*. Eine Anfrage dafür wird mit 403 rpc_method_reserved beantwortet. Werksreset, Kopplung, Vergessen von WLAN und cloud.forget werden nie aus der Cloud gesendet. Siehe Befehle an Geräte senden.
Namen, die von den fertigen Lösungen verwendet werden
Die fertigen Lösungen lesen diese Schlüssel und Server-Attribute. Sie sind nicht reserviert; verwenden Sie sie, damit Ihre Geräte zu einer Lösung passen.
| Lösung | Telemetrie-Schlüssel | Server-Attribute |
|---|---|---|
| Wasserstandort | level_cm, level_pct, rssi; p1.running, p2.running, pt.value, fm.value, *.status, manual, p1_run, p2_run, phase1–phase3, thermal1, thermal2, consumption | lowLevelThreshold, highLevelThreshold, capacityCm, minPressure |
| Außenstandorte | air_temp, air_hum, door_open, water_leak, smoke, battery_env, battery_water, battery_door, battery_smoke; ups_a_*, ups_b_* | highTempThreshold, lowTempThreshold, highHumThreshold, lowHumThreshold |
| Wetterstationen | air_temp, air_hum, baro_pressure, rain_intensity, acc_rainfall, wind_speed_avg, wind_speed_min, wind_speed_max, wind_dir_avg, wind_dir_min, wind_dir_max, rain_reset | |
| Sensorbereiche | air_temp, air_hum, battery, plan_x, plan_y; Station: acc_rainfall, pressure, light, wind_dir, wind_speed | maxTempThreshold, minTempThreshold, warnTempThreshold, maxHumThreshold, minHumThreshold, warnHumThreshold; Regionen-Asset: floorPlan |
| Personenortung | lat, lng, zone, event, battery, air_temp, light | forbiddenZone; Zonen-Asset: beacon |
Siehe Fertige Lösungen.
Weitere reservierte Namen
| Name | Wo |
|---|---|
provision | Ein MQTT-Benutzername, der für Provisionierungssitzungen reserviert ist |
Topics unter v1/ | Nur die dokumentierten Topics; ein unbekanntes wird als unknown_reserved_topic abgelehnt |
Organisationsadressen wie admin | Reservierte Namen können nicht als Adresse einer Organisation verwendet werden. Siehe Konto erstellen und Region wählen. |
Anzeigenamen wie admin, support, owner | Für Anzeigenamen von Personen reserviert; eine Organisation kann weitere reservieren. Siehe Ihr Profil, Sprache und Zeitzone. |