Neu: Die KI-Firewall überwacht die gesamte Plattform und erklärt jeden Vorfall in einfachen Worten. So funktioniert es

Reservierte Schlüssel und Attribute

Schlüsselnamen, die Hermetry verwaltet oder liest – reservierte Präfixe, Firmware- und Konfigurationsattribute, interne Schlüssel, Status, Raw, Kamera, eSIM- und Lösungsschlüssel.

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 vom 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 im Überblick

RegelTelemetrieAttribute
ZeichenA–Z a–z 0–9 _ . -Gleich
Länge1 bis 641 bis 128 (gemeinsam genutzte Schlüssel außer cfg.*: 57)
Niemals ein Schlüsseldeleted
Reserviertes Präfix_, fw_, current_fw_, cfg._ (Plattform); fw_, current_fw_ (Firmware)
Groß-/KleinschreibungGroß-/Kleinschreibung beachtenGroß-/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 und dem Grund reserved des Schlüssels abgelehnt. Siehe Telemetrie-Schlüssel und Attribute.

Schlüssel, die Sie niemals schreiben dürfen

Personen, die API und Flows dürfen diese nicht als Server- oder gemeinsame Attribute schreiben:

Schlüssel oder MusterEigentümerZweck
_*Die PlattformInterne Schlüssel
fw_*Firmware-UpdatesDas dem Gerät angebotene Update (gemeinsam) und der Fortschritt des Geräts (Client)
current_fw_*Das GerätWas das Gerät ausführt
*.state, *.reasonDas Gerät oder GatewayDas Ergebnis eines Sollwerts: Ein Gateway antwortet mit <key>.state und <key>.reason für ein gemeinsames Attribut, das es auf ein Kindgerät angewendet hat
cfg_rejected, cfg_applied_ts, cfg_hashDas GerätSeine Buchhaltung der Konfiguration
attr_errorDas GerätEin Attribut, das es nicht anwenden konnte
rpc_resultDas GerätDas Ergebnis eines langlaufenden Befehls
cert_not_afterDas GerätWann sein Zertifikat abläuft
time_qualityDas Gerät oder GatewayOb Zeitstempel von einer synchronisierten Uhr stammen
session_limitsDie PlattformDie effektiven Ratenbegrenzungen des Geräts, bei jedem Senden berechnet und nie gespeichert
deletedDie Markierung entfernter Schlüssel auf der Leitung

Firmware-Schlüssel

Von Hermetry als gemeinsame Attribute geschrieben, wenn ein Update angeboten wird:

SchlüsselInhalt
fw_title, fw_versionName und Version des Pakets
fw_sizeGröße in Bytes
fw_checksum, fw_checksum_algorithmKleinbuchstabiges Hex und SHA256
fw_urlEine kurzlebige HTTPS-Download-Adresse, 15 Minuten gültig
fw_sigDie losgelöste Signatur, falls vorhanden
fw_allow_meteredOb das Gerät über eine volumenabhängige Verbindung herunterladen darf

Vom Gerät als Client-Attribute gemeldet:

SchlüsselInhalt
fw_stateDOWNLOADING, DOWNLOADED, VERIFIED, UPDATING, UPDATED, FAILED
fw_errorEin Fehlercode, mit FAILED
fw_progress0 bis 100 während des Herunterladens
fw_waitmetered, quota_exhausted oder approval, solange das Gerät das Update zurückhält
current_fw_title, current_fw_versionWas jetzt läuft; wird nach jeder Verbindung gesendet

Siehe Firmware-Updates (OTA).

Konfigurationsschlüssel

SchlüsselGeltungsbereichBedeutung
cfg.*Nur gemeinsamGewü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 dessen Registerkarte Einstellungen verwaltet werden, antwortet ein Schreibvorgang mit 409: Ändern Sie es dort.
cfg_rejected, cfg_applied_ts, cfg_hashClientDie Antwort des Geräts zu seiner Konfiguration

Siehe Remote-Geräteeinstellungen.

Telemetrie-Schlüssel mit Bedeutung

SchlüsselGelesen vonBedeutung
statusStandortstatus, Standortansichten, 3D-Einfärbungencritical, 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 Statusschlüssel.
rawDecoder, FlowsEin Body, der kein JSON-Objekt ist, als Text gespeichert (standardmäßig 4.096 Bytes). Siehe Telemetrie-Schlüssel.
<topic>.<key>Schlüssel eines benutzerdefinierten Topics, wenn das Profil die Schlüssel mit dem Topic präfixiert
lat, lngKartenkacheln der fertigen LösungenPosition. Andere Boards können beliebige Spaltennamen verwenden.
<element>.<field>ProzesszeichnungenMesswerte eines gezeichneten Elements, zum Beispiel p1.running, pt.value

Hinweis

true in status bedeutet Critical. Senden Sie status: true nicht, um „läuft“ anzuzeigen.

Von Modulen geschriebene Attribute

SchlüsselGeltungsbereichGeschrieben vonBedeutung
liveUrlServerKamerasDer Live-Link der Kamera, solange die Live-Ansicht eingeschaltet ist
liveUrlHighServerKamerasDer Link in höherer Qualität, wenn die Kamera einen zweiten brauchbaren H.264-Stream hat
esim.capability, esim.profilesClientLizenzierte RouterDer eSIM-Chip und die Profile des Routers.

Siehe Kameras auf Dashboards.

Befehlsmethoden-Familien

Einige Befehlsmethoden gehören zu einem Modul, und nur dieses Modul darf sie senden, zum Beispiel tunnel.* (Fernzugriff) und esim.*. Eine Anfrage dafür wird mit 403 rpc_method_reserved beantwortet. Werkseinstellungen zurücksetzen, Kopplung, Wi-Fi-Vergessen 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 Serverattribute. Sie sind nicht reserviert; verwenden Sie sie, damit Ihre Geräte zu einer Lösung passen.

LösungTelemetrie-SchlüsselServerattribute
Wasserstandortlevel_cm, level_pct, rssi; p1.running, p2.running, pt.value, fm.value, *.status, manual, p1_run, p2_run, phase1–phase3, thermal1, thermal2, consumptionlowLevelThreshold, highLevelThreshold, capacityCm, minPressure
Außenstandorteair_temp, air_hum, door_open, water_leak, smoke, battery_env, battery_water, battery_door, battery_smoke; ups_a_*, ups_b_*highTempThreshold, lowTempThreshold, highHumThreshold, lowHumThreshold
Wetterstationenair_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
Sensorbereicheair_temp, air_hum, battery, plan_x, plan_y; Station: acc_rainfall, pressure, light, wind_dir, wind_speedmaxTempThreshold, minTempThreshold, warnTempThreshold, maxHumThreshold, minHumThreshold, warnHumThreshold; Bereichs-Asset: floorPlan
Personenortunglat, lng, zone, event, battery, air_temp, lightforbiddenZone; Zonen-Asset: beacon

Siehe Fertige Lösungen.

Andere reservierte Namen

NameWo
provisionEin 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 adminReservierte Namen können nicht als Adresse einer Organisation verwendet werden. Siehe Konto erstellen und Region wählen.
Anzeigenamen wie admin, support, ownerFür Anzeigenamen von Personen reserviert; eine Organisation kann weitere reservieren. Siehe Ihr Profil, Sprache und Zeitzone.

Verwandt