Algunas claves y atributos de telemetría tienen un significado fijo en Hermetry. Algunos no pueden ser escritos por ti en absoluto; otros son escritos por la plataforma o por el dispositivo y leídos por funciones como las actualizaciones de firmware, el estado de la instalación o las cámaras. Esta página los enumera, para que puedas evitar conflictos y usar los que necesites.
Reglas de un vistazo
| Regla | Telemetría | Atributos |
|---|---|---|
| Caracteres | A–Z a–z 0–9 _ . - | Igual |
| Longitud | 1 a 64 | 1 a 128 (claves compartidas distintas de cfg.*: 57) |
| Nunca una clave | deleted | |
| Prefijo reservado | _, fw_, current_fw_, cfg. | _ (plataforma); fw_, current_fw_ (firmware) |
| Mayúsculas | Distingue mayúsculas y minúsculas | Distingue mayúsculas y minúsculas |
Una clave de telemetría con un prefijo reservado se descarta con key_reserved; el resto del mensaje se almacena. Una escritura de atributo con una clave reservada se rechaza con keys_invalid y el motivo de la clave reserved. Consulta Claves de telemetría y Atributos.
Claves que nunca puedes escribir
Las personas, la API y los flujos no pueden escribir estas como atributos de servidor o compartidos:
| Clave o patrón | Propietario | Finalidad |
|---|---|---|
_* | La plataforma | Claves internas |
fw_* | Actualizaciones de firmware | La actualización ofrecida al dispositivo (compartido) y el progreso del dispositivo (cliente) |
current_fw_* | El dispositivo | Lo que ejecuta el dispositivo |
*.state, *.reason | El dispositivo o la pasarela | El resultado de un valor deseado: una pasarela responde <key>.state y <key>.reason para un atributo compartido que aplicó a un hijo |
cfg_rejected, cfg_applied_ts, cfg_hash | El dispositivo | Su contabilidad de configuración |
attr_error | El dispositivo | Un atributo que no pudo aplicar |
rpc_result | El dispositivo | El resultado de un comando de larga duración |
cert_not_after | El dispositivo | Cuándo caduca su certificado |
time_quality | El dispositivo o la pasarela | Si las marcas de tiempo proceden de un reloj sincronizado |
session_limits | La plataforma | Los límites de tasa efectivos del dispositivo, calculados al enviarse y nunca almacenados |
deleted | El marcador de claves eliminadas en el cable |
Claves de firmware
Hermetry las escribe como atributos compartidos cuando se ofrece una actualización:
| Clave | Contenido |
|---|---|
fw_title, fw_version | El nombre y la versión del paquete |
fw_size | Tamaño en bytes |
fw_checksum, fw_checksum_algorithm | Hexadecimal en minúsculas y SHA256 |
fw_url | Una dirección HTTPS de descarga de corta duración, válida 15 minutos |
fw_sig | La firma separada, cuando existe |
fw_allow_metered | Si el dispositivo puede descargar a través de un enlace medido |
Notificado por el dispositivo como atributos de cliente:
| Clave | Contenido |
|---|---|
fw_state | DOWNLOADING, DOWNLOADED, VERIFIED, UPDATING, UPDATED, FAILED |
fw_error | Un código de error, con FAILED |
fw_progress | De 0 a 100 durante la descarga |
fw_wait | metered, quota_exhausted o approval mientras el dispositivo retiene la actualización |
current_fw_title, current_fw_version | Lo que se ejecuta ahora; se envía tras cada conexión |
Consulta Actualizaciones de firmware (OTA).
Claves de configuración
| Clave | Ámbito | Significado |
|---|---|---|
cfg.* | Solo compartido | Configuración deseada, hasta 128 caracteres por clave. El dispositivo informa de lo que aplicó. En un dispositivo con licencia cuyos ajustes se gestionan en su pestaña Settings, una escritura responde 409: cámbialo allí. |
cfg_rejected, cfg_applied_ts, cfg_hash | Cliente | La respuesta del dispositivo sobre su configuración |
Consulta Ajustes remotos del dispositivo.
Claves de telemetría con significado
| Clave | Lo lee | Significado |
|---|---|---|
status | Estado de la instalación, vistas de instalación, tintes 3D | critical, alarm, error, fault, danger, 2, true significan Crítico; warning, warn, 1 significan Advertencia; cualquier otro valor, OK. Una tarjeta puede leer otra clave en su lugar. Consulta Estado de la instalación y la clave de estado. |
raw | Decodificadores, flujos | Un cuerpo que no es un objeto JSON, almacenado como texto (4.096 bytes por defecto). Consulta Claves de telemetría. |
<topic>.<key> | Claves de un tema personalizado cuando el perfil antepone el tema a las claves | |
lat, lng | Tarjetas de mapa de las soluciones listas | Posición. Otras placas pueden usar cualquier nombre de columna. |
<element>.<field> | Diagramas de proceso | Lecturas de un elemento dibujado, por ejemplo p1.running, pt.value |
Nota
true en status significa Crítico. No envíes status: true para indicar «en marcha».
Atributos escritos por módulos
| Clave | Ámbito | Lo escribe | Significado |
|---|---|---|---|
liveUrl | Servidor | Cámaras | El enlace en directo de la cámara mientras la vista en directo está activada |
liveUrlHigh | Servidor | Cámaras | El enlace de mayor calidad, cuando la cámara tiene un segundo flujo H.264 utilizable |
esim.capability, esim.profiles | Cliente | Routers con licencia | El chip eSIM del router y sus perfiles. La gestión de eSIM está en desarrollo. |
Consulta Cámaras en paneles.
Familias de métodos de comando
Algunos métodos de comando pertenecen a un módulo y solo ese módulo puede enviarlos: por ejemplo tunnel.* (acceso remoto) y esim.*. Una solicitud para ellos responde 403 rpc_method_reserved. El restablecimiento de fábrica, el emparejamiento, el olvido de Wi-Fi y cloud.forget nunca se envían desde la nube. Consulta Enviar comandos a dispositivos.
Nombres usados por las soluciones listas
Las soluciones listas leen estas claves y atributos de servidor. No están reservados; úsalos para que tus dispositivos encajen en una solución.
| Solución | Claves de telemetría | Atributos de servidor |
|---|---|---|
| Instalación de agua | 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 |
| Sitios remotos | 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 |
| Estaciones meteorológicas | 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 | |
| Regiones de sensores | air_temp, air_hum, battery, plan_x, plan_y; estación: acc_rainfall, pressure, light, wind_dir, wind_speed | maxTempThreshold, minTempThreshold, warnTempThreshold, maxHumThreshold, minHumThreshold, warnHumThreshold; activo de región: floorPlan |
| Seguimiento de personal | lat, lng, zone, event, battery, air_temp, light | forbiddenZone; activo de zona: beacon |
Consulte Soluciones listas.
Otros nombres reservados
| Nombre | Dónde |
|---|---|
provision | Un nombre de usuario MQTT reservado para las sesiones de aprovisionamiento |
Temas bajo v1/ | Solo los temas documentados; uno desconocido se rechaza como unknown_reserved_topic |
Direcciones de organización como admin | Los nombres reservados no pueden usarse como dirección de una organización. Consulte Cree su cuenta y elija una región. |
Nombres visibles como admin, support, owner | Reservados para los nombres visibles de las personas; una organización puede reservar más. Consulte Su perfil, idioma y zona horaria. |