Nouveau : le pare-feu IA surveille toute la plateforme et explique chaque incident en termes simples. Découvrez comment ça marche

Clés et attributs réservés

Noms de clés que Hermetry possède ou lit : préfixes réservés, attributs de micrologiciel et de configuration, clés de gestion interne, clés d'état, brutes, caméra, eSIM et solutions.

Certaines clés et certains attributs de télémétrie ont une signification fixe dans Hermetry. Certains ne peuvent pas être écrits par vous ; d’autres sont écrits par la plateforme ou l’appareil et lus par des fonctions telles que les mises à jour du micrologiciel, l’état des sites ou les caméras. Cette page les répertorie, afin que vous puissiez éviter les conflits et utiliser ceux dont vous avez besoin.

Règles en bref

RègleTélémétrieAttributs
CaractèresA–Z a–z 0–9 _ . -Identiques
Longueur1 à 641 à 128 (clés partagées autres que cfg.* : 57)
Jamais une clédeleted
Préfixe réservé_, fw_, current_fw_, cfg._ (plateforme) ; fw_, current_fw_ (micrologiciel)
CasseSensible à la casseSensible à la casse

Une clé de télémétrie au préfixe réservé est rejetée avec key_reserved ; le reste du message est stocké. Une écriture d’attribut avec une clé réservée est refusée avec keys_invalid et le motif de la clé reserved. Voir Clés de télémétrie et Attributs.

Clés que vous ne pouvez jamais écrire

Les personnes, l’API et les flux ne peuvent pas écrire ces éléments en tant qu’attributs serveur ou partagés :

Clé ou motifPropriétaireFinalité
_*La plateformeClés internes
fw_*Mises à jour du micrologicielLa mise à jour proposée à l’appareil (partagée) et la progression de l’appareil (client)
current_fw_*L’appareilCe que l’appareil exécute
*.state, *.reasonL’appareil ou la passerelleLe résultat d’une valeur souhaitée : une passerelle répond <key>.state et <key>.reason pour un attribut partagé qu’elle a appliqué à un enfant
cfg_rejected, cfg_applied_ts, cfg_hashL’appareilSa comptabilité de configuration
attr_errorL’appareilUn attribut qu’il n’a pas pu appliquer
rpc_resultL’appareilLe résultat d’une commande de longue durée
cert_not_afterL’appareilDate d’expiration de son certificat
time_qualityL’appareil ou la passerelleIndique si les horodatages proviennent d’une horloge synchronisée
session_limitsLa plateformeLes limites de débit effectives de l’appareil, calculées à l’envoi et jamais stockées
deletedLe marqueur des clés supprimées sur le réseau

Clés du micrologiciel

Écrites par Hermetry en tant qu’attributs partagés lorsqu’une mise à jour est proposée :

CléContenu
fw_title, fw_versionLe nom et la version du paquet
fw_sizeTaille en octets
fw_checksum, fw_checksum_algorithmHexadécimal en minuscules et SHA256
fw_urlUne adresse de téléchargement HTTPS de courte durée, valable 15 minutes
fw_sigLa signature détachée, lorsqu’il en existe une
fw_allow_meteredIndique si l’appareil peut télécharger via une connexion limitée (à forfait)

Remontées par l’appareil en tant qu’attributs client :

CléContenu
fw_stateDOWNLOADING, DOWNLOADED, VERIFIED, UPDATING, UPDATED, FAILED
fw_errorUn code d’erreur, avec FAILED
fw_progressDe 0 à 100 pendant le téléchargement
fw_waitmetered, quota_exhausted ou approval tant que l’appareil conserve la mise à jour
current_fw_title, current_fw_versionCe qui est en cours d’exécution ; envoyé après chaque connexion

Voir Mises à jour du micrologiciel (OTA).

Clés de configuration

CléPortéeSignification
cfg.*Partagé uniquementConfiguration souhaitée, jusqu’à 128 caractères par clé. L’appareil renvoie ce qu’il a appliqué. Sur un appareil sous licence dont les réglages sont gérés dans son onglet Settings, une écriture répond 409 : modifiez-les à cet endroit.
cfg_rejected, cfg_applied_ts, cfg_hashClientLa réponse de l’appareil concernant sa configuration

Voir Réglages à distance des appareils.

Clés de télémétrie à signification

CléLu parSignification
statusÉtat du site, vues de site, teintes 3Dcritical, alarm, error, fault, danger, 2, true signifient Critical ; warning, warn, 1 signifient Warning ; toute autre valeur signifie OK. Une carte peut lire une autre clé à la place. Voir État du site et la clé status.
rawDécodeurs, fluxUn corps qui n’est pas un objet JSON, stocké sous forme de texte (4 096 octets par défaut). Voir Clés de télémétrie.
<topic>.<key>Clés d’un sujet personnalisé lorsque le profil préfixe les clés par le sujet
lat, lngCartes de position des solutions prêtes à l’emploiPosition. Les autres cartes peuvent utiliser n’importe quels noms de colonnes.
<element>.<field>Schémas de procédésRelevés d’un élément dessiné, par exemple p1.running, pt.value

Remarque

true dans status signifie Critical. N’envoyez pas status: true pour signifier « en fonctionnement ».

Attributs écrits par les modules

CléPortéeÉcrit parSignification
liveUrlServeurCamérasLe lien de diffusion en direct de la caméra lorsque la vue en direct est activée
liveUrlHighServeurCamérasLe lien de meilleure qualité, lorsque la caméra dispose d’un second flux H.264 utilisable
esim.capability, esim.profilesClientRouteurs sous licenceLa puce eSIM du routeur et ses profils.

Voir Caméras sur les tableaux de bord.

Familles de méthodes de commande

Certaines méthodes de commande appartiennent à un module, et seul ce module peut les envoyer : par exemple tunnel.* (accès à distance) et esim.*. Une requête les concernant reçoit 403 rpc_method_reserved. La réinitialisation d’usine, l’appairage, l’oubli du Wi-Fi et cloud.forget ne sont jamais envoyés depuis le cloud. Voir Envoyer des commandes aux appareils.

Noms utilisés par les solutions prêtes à l’emploi

Les solutions prêtes à l’emploi lisent ces clés et attributs serveur. Ils ne sont pas réservés ; utilisez-les pour adapter vos appareils à une solution.

SolutionClés de télémétrieAttributs serveur
Site d’eaulevel_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
Sites distantsair_temp, air_hum, door_open, water_leak, smoke, battery_env, battery_water, battery_door, battery_smoke ; ups_a_*, ups_b_*highTempThreshold, lowTempThreshold, highHumThreshold, lowHumThreshold
Stations météoair_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
Zones de capteursair_temp, air_hum, battery, plan_x, plan_y ; station : acc_rainfall, pressure, light, wind_dir, wind_speedmaxTempThreshold, minTempThreshold, warnTempThreshold, maxHumThreshold, minHumThreshold, warnHumThreshold ; actif de zone : floorPlan
Suivi du personnellat, lng, zone, event, battery, air_temp, lightforbiddenZone ; actif de zone : beacon

Voir Solutions prêtes à l’emploi.

Autres noms réservés

NomOù
provisionUn nom d’utilisateur MQTT réservé aux sessions de provisionnement
Sujets sous v1/Seuls les sujets documentés ; un sujet inconnu est rejeté avec unknown_reserved_topic
Adresses d’organisation telles que adminLes noms réservés ne peuvent pas être l’adresse d’une organisation. Voir Créer votre compte et choisir une région.
Noms d’affichage tels que admin, support, ownerRéservés aux noms d’affichage des personnes ; une organisation peut en réserver davantage. Voir Votre profil, langue et fuseau horaire.

Liens connexes