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 fonctionnalités 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 un coup d’œil
| Règle | Télémétrie | Attributs |
|---|---|---|
| Caractères | A–Z a–z 0–9 _ . - | Identique |
| Longueur | 1 à 64 | 1 à 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) |
| Casse | Sensible à la casse | Sensible à la casse |
Une clé de télémétrie avec un préfixe réservé est supprimée avec key_reserved ; le reste du message est enregistré. Une écriture d’attribut avec une clé réservée est refusée avec keys_invalid et la raison 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 comme attributs serveur ou partagés :
| Clé ou motif | Propriétaire | Finalité |
|---|---|---|
_* | La plateforme | Clés internes |
fw_* | Mises à jour du micrologiciel | La mise à jour proposée à l’appareil (partagé) et la progression de l’appareil (client) |
current_fw_* | L’appareil | Ce que l’appareil exécute |
*.state, *.reason | L’appareil ou la passerelle | Le 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_hash | L’appareil | Sa gestion de configuration |
attr_error | L’appareil | Un attribut qu’il n’a pas pu appliquer |
rpc_result | L’appareil | Le résultat d’une commande de longue durée |
cert_not_after | L’appareil | Date d’expiration de son certificat |
time_quality | L’appareil ou la passerelle | Indique si les horodatages proviennent d’une horloge synchronisée |
session_limits | La plateforme | Les limites de débit effectives de l’appareil, calculées à l’envoi et jamais stockées |
deleted | Le marqueur des clés supprimées sur le fil |
Clés du micrologiciel
Écrites par Hermetry comme attributs partagés lorsqu’une mise à jour est proposée :
| Clé | Contenu |
|---|---|
fw_title, fw_version | Le nom et la version du paquet |
fw_size | Taille en octets |
fw_checksum, fw_checksum_algorithm | Hexadécimal en minuscules et SHA256 |
fw_url | Une adresse de téléchargement HTTPS à courte durée de validité, valable 15 minutes |
fw_sig | La signature détachée, lorsqu’elle existe |
fw_allow_metered | Indique si l’appareil peut télécharger via une connexion facturée au volume |
Signalées par l’appareil comme attributs client :
| Clé | Contenu |
|---|---|
fw_state | DOWNLOADING, DOWNLOADED, VERIFIED, UPDATING, UPDATED, FAILED |
fw_error | Un code d’erreur, avec FAILED |
fw_progress | 0 à 100 pendant le téléchargement |
fw_wait | metered, quota_exhausted ou approval pendant que l’appareil conserve la mise à jour |
current_fw_title, current_fw_version | Ce qui s’exécute actuellement ; envoyé après chaque connexion |
Voir Mises à jour du micrologiciel (OTA).
Clés de configuration
| Clé | Portée | Signification |
|---|---|---|
cfg.* | Partagé uniquement | Configuration 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 renvoie 409 : modifiez-les à cet endroit. |
cfg_rejected, cfg_applied_ts, cfg_hash | Client | La réponse de l’appareil concernant sa configuration |
Voir Réglages à distance des appareils.
Clés de télémétrie ayant une signification
| Clé | Lu par | Signification |
|---|---|---|
status | État du site, vues de site, teintes 3D | critical, alarm, error, fault, danger, 2, true signifient Critique ; warning, warn, 1 signifient Avertissement ; toute autre valeur signifie OK. Une carte peut lire une autre clé à la place. Voir État du site et la clé status. |
raw | Décodeurs, flux | Un 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 topic personnalisé lorsque le profil préfixe les clés avec le topic | |
lat, lng | Cartes de carte des solutions prêtes à l’emploi | Position. Les autres tableaux peuvent utiliser n’importe quels noms de colonnes. |
<element>.<field> | Schémas de procédés | Relevés d’un élément dessiné, par exemple p1.running, pt.value |
Remarque
true dans status signifie Critique. N’envoyez pas status: true pour signifier « en marche ».
Attributs écrits par les modules
| Clé | Portée | Écrit par | Signification |
|---|---|---|---|
liveUrl | Serveur | Caméras | Le lien en direct de la caméra lorsque la vue en direct est activée |
liveUrlHigh | Serveur | Caméras | Le lien de meilleure qualité, lorsque la caméra dispose d’un second flux H.264 utilisable |
esim.capability, esim.profiles | Client | Routeurs sous licence | La puce eSIM du routeur et ses profils. La gestion eSIM est en cours de développement. |
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 pour ces méthodes renvoie 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 Envoi de 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.
| Solution | Clés de télémétrie | Attributs serveur |
|---|---|---|
| Site d’eau | 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 |
| Sites distants | 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 |
| Stations météo | 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 | |
| Zones de capteurs | air_temp, air_hum, battery, plan_x, plan_y ; station : acc_rainfall, pressure, light, wind_dir, wind_speed | maxTempThreshold, minTempThreshold, warnTempThreshold, maxHumThreshold, minHumThreshold, warnHumThreshold ; actif de zone : floorPlan |
| Suivi du personnel | lat, lng, zone, event, battery, air_temp, light | forbiddenZone ; actif de zone : beacon |
Voir Solutions prêtes à l’emploi.
Autres noms réservés
| Nom | Où |
|---|---|
provision | Un nom d’utilisateur MQTT réservé aux sessions de provisionnement |
Sujets sous v1/ | Seuls les sujets documentés sont acceptés ; un sujet inconnu est rejeté avec unknown_reserved_topic |
Adresses d’organisation telles que admin | Les 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, owner | Réservés aux noms d’affichage des personnes ; une organisation peut en réserver davantage. Voir Votre profil, langue et fuseau horaire. |