Hermetry’de bazı telemetri anahtarları ve öznitelikleri sabit bir anlama sahiptir. Bunların bir kısmını hiç yazmamanız gerekebilir; diğerlerini platform veya cihaz yazar ve bunları güncelleme, site durumu veya kamera gibi özellikler okur. Bu sayfa bunları listeler; böylece çakışmalardan kaçınabilir ve ihtiyacınız olanları kullanabilirsiniz.
Kurallara genel bakış
| Kural | Telemetri | Öznitelikler |
|---|---|---|
| Karakterler | A–Z a–z 0–9 _ . - | Aynı |
| Uzunluk | 1 ile 64 | 1 ile 128 (cfg.* dışındaki paylaşılan anahtarlar: 57) |
| Asla anahtar olamaz | deleted | |
| Ayrılmış önek | _, fw_, current_fw_, cfg. | _ (platform); fw_, current_fw_ (yazılım) |
| Büyük/küçük harf | Büyük/küçük harfe duyarlı | Büyük/küçük harfe duyarlı |
Ayrılmış önekli bir telemetri anahtarı key_reserved ile atılır; iletinin geri kalanı kaydedilir. Ayrılmış bir anahtarla yapılan öznitelik yazımı keys_invalid ile reddedilir ve anahtarın nedeni reserved olur. Bkz. Telemetri anahtarları ve Öznitelikler.
Asla yazamayacağınız anahtarlar
Kişiler, API ve akışlar bunları sunucu veya paylaşılan öznitelik olarak yazamaz:
| Anahtar veya desen | Sahip | Amaç |
|---|---|---|
_* | Platform | Dahili anahtarlar |
fw_* | Yazılım güncellemeleri | Cihaza sunulan güncelleme (paylaşılan) ve cihazın ilerlemesi (istemci) |
current_fw_* | Cihaz | Cihazın çalıştırdığı yazılım |
*.state, *.reason | Cihaz veya ağ geçidi | İstenen bir değerin sonucu: bir ağ geçidi, alt cihaza uyguladığı paylaşılan bir öznitelik için <key>.state ve <key>.reason yanıtını verir |
cfg_rejected, cfg_applied_ts, cfg_hash | Cihaz | Yapılandırma kayıtları |
attr_error | Cihaz | Uygulayamadığı bir öznitelik |
rpc_result | Cihaz | Uzun süren bir komutun sonucu |
cert_not_after | Cihaz | Sertifikasının sona ereceği zaman |
time_quality | Cihaz veya ağ geçidi | Zaman damgalarının senkronize bir saatten gelip gelmediği |
session_limits | Platform | Cihazın etkin hız sınırları; gönderildiklerinde hesaplanır ve hiçbir zaman saklanmaz |
deleted | Kaldırılan anahtarların tel üzerindeki işareti |
Yazılım anahtarları
Bir güncelleme sunulduğunda Hermetry tarafından paylaşılan öznitelikler olarak yazılır:
| Anahtar | İçerik |
|---|---|
fw_title, fw_version | Paketin adı ve sürümü |
fw_size | Bayt cinsinden boyut |
fw_checksum, fw_checksum_algorithm | Küçük harfli onaltılık değer ve SHA256 |
fw_url | Kısa ömürlü bir HTTPS indirme adresi, 15 dakika geçerli |
fw_sig | Varsa ayrık imza |
fw_allow_metered | Cihazın kotalı bir bağlantı üzerinden indirme yapıp yapamayacağı |
Cihaz tarafından istemci öznitelikleri olarak bildirilir:
| Anahtar | İçerik |
|---|---|
fw_state | DOWNLOADING, DOWNLOADED, VERIFIED, UPDATING, UPDATED, FAILED |
fw_error | FAILED ile birlikte bir hata kodu |
fw_progress | İndirme sırasında 0 ile 100 |
fw_wait | Cihaz güncellemeyi beklettiğinde metered, quota_exhausted veya approval |
current_fw_title, current_fw_version | Şu anda çalışan yazılım; her bağlantıdan sonra gönderilir |
Bkz. Yazılım güncellemeleri (OTA).
Yapılandırma anahtarları
| Anahtar | Kapsam | Anlam |
|---|---|---|
cfg.* | Yalnızca paylaşılan | İstenen yapılandırma; anahtar başına en fazla 128 karakter. Cihaz uyguladığını geri bildirir. Ayarlar sekmesinden yönetilen bir lisanslı cihazda yazma işlemi 409 yanıtı verir: değişikliği orada yapın. |
cfg_rejected, cfg_applied_ts, cfg_hash | İstemci | Cihazın yapılandırmasına ilişkin yanıtı |
Bkz. Uzaktan cihaz ayarları.
Anlamı olan telemetri anahtarları
| Anahtar | Okuyan | Anlam |
|---|---|---|
status | Site durumu, site görünümleri, 3D renklendirmeler | critical, alarm, error, fault, danger, 2, true Kritik anlamına gelir; warning, warn, 1 Uyarı anlamına gelir; diğer her değer Tamam anlamına gelir. Bir kart bunun yerine başka bir anahtarı okuyabilir. Bkz. Site durumu ve durum anahtarı. |
raw | Çözümleyiciler, akışlar | JSON nesnesi olmayan, metin olarak saklanan bir gövde (varsayılan olarak 4.096 bayt). Bkz. Telemetri anahtarları. |
<topic>.<key> | Profil anahtarların başına konu adını eklediğinde, özel bir konunun anahtarları | |
lat, lng | Hazır çözümlerin harita kartları | Konum. Diğer panolar herhangi bir sütun adını kullanabilir. |
<element>.<field> | Proses çizimleri | Çizilmiş bir öğenin okumaları, örneğin p1.running, pt.value |
Not
status içinde true Kritik anlamına gelir. status: true değerini “çalışıyor” anlamında göndermeyin.
Modüller tarafından yazılan öznitelikler
| Anahtar | Kapsam | Yazan | Anlam |
|---|---|---|---|
liveUrl | Sunucu | Kameralar | Canlı görüntü açıkken kameranın canlı bağlantısı |
liveUrlHigh | Sunucu | Kameralar | Kameranın kullanılabilir ikinci bir H.264 akışı olduğunda daha yüksek kaliteli bağlantı |
esim.capability, esim.profiles | İstemci | Lisanslı yönlendiriciler | Yönlendiricinin eSIM çipi ve profilleri. eSIM yönetimi geliştirme aşamasındadır. |
Bkz. Pano üzerindeki kameralar.
Komut metodu aileleri
Bazı komut metodları bir modüle aittir ve yalnızca o modül bunları gönderebilir: örneğin tunnel.* (uzaktan erişim) ve esim.*. Bunlar için yapılan bir istek 403 rpc_method_reserved yanıtı verir. Fabrika ayarlarına döndürme, eşleştirme, Wi-Fi unutma ve cloud.forget buluttan asla gönderilmez. Bkz. Cihazlara komut gönderme.
Hazır çözümlerin kullandığı adlar
Hazır çözümler bu anahtarları ve sunucu özniteliklerini okur. Bunlar ayrılmış değildir; cihazlarınızı bir çözüme uydurmak için kullanın.
| Çözüm | Telemetri anahtarları | Sunucu öznitelikleri |
|---|---|---|
| Su sahası | 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 |
| Uzak sahalar | 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 |
| Hava istasyonları | 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 | |
| Sensör bölgeleri | air_temp, air_hum, battery, plan_x, plan_y; istasyon: acc_rainfall, pressure, light, wind_dir, wind_speed | maxTempThreshold, minTempThreshold, warnTempThreshold, maxHumThreshold, minHumThreshold, warnHumThreshold; bölge varlığı: floorPlan |
| Personel takibi | lat, lng, zone, event, battery, air_temp, light | forbiddenZone; bölge varlığı: beacon |
Bkz. Hazır çözümler.
Diğer ayrılmış adlar
| Ad | Nerede |
|---|---|
provision | Sağlama oturumları için ayrılmış bir MQTT kullanıcı adı |
v1/ altındaki konular | Yalnızca belgelenmiş konular; bilinmeyen bir konu unknown_reserved_topic ile reddedilir |
admin gibi kuruluş adresleri | Ayrılmış adlar bir kuruluşun adresi olamaz. Bkz. Hesabınızı oluşturun ve bölge seçin. |
admin, support, owner gibi görünen adlar | Kişilerin görünen adları için ayrılmıştır; bir kuruluş daha fazlasını ayırabilir. Bkz. Profiliniz, dil ve saat dilimi. |