LoRaWAN API

Bu sayfa, Hermetry’nin LoRaWAN ağ sunucusunun REST rotalarını tek bir yerde listeler. Her konunun, tam alan anlamlarını içeren bir sayfası LoRaWAN bölümünde bulunur; bu sayfa onlara bağlantı verir. Yollar https://<your host>/tenant/<tenantId> altındadır. Bu rotaların her yanıtı Cache-Control: no-store ile gönderilir.

İzinler

İzin	Varsayılan rol	İzin verir
iot_lorawan.gateways.read	Kullanıcı	Ağ geçitlerini ve ağ sunucusu adresini okuma
iot_lorawan.gateways.manage	Yönetici	Ağ geçitleri ekleme, düzenleme, devre dışı bırakma ve silme, belirteçlerini yenileme
iot_lorawan.devices.read	Kullanıcı	LoRaWAN cihazlarını, profil ayarlarını ve eşleştirmeyi okuma
iot_lorawan.devices.manage	Yönetici	Cihaz ekleme, düzenleme ve silme, anahtar ayarlama, oturumları sonlandırma, eşleştirme
iot_lorawan.keys.read	Yönetici	Bir cihazın AppKey değerini gösterme
iot_lorawan.frames.read	Kullanıcı	Canlı çerçeve günlüğünü okuma

Kurulum

GET /api/iot/lorawan/setup (gateways read), bir Basics Station ağ geçidinin ihtiyaç duyduğu ağ sunucusu adresini ve keşif adresini, bir tc.trust dosyasının sunulup sunulmadığını ve bölgeyi yanıtlar. Gizli bir şey içermez. Bkz. Ağ sunucusu adresiniz.

Ağ geçitleri

Yöntem	Yol	İzin	İşlevi
GET	/api/iot/lorawan/gateways	gateways read	Liste: { data, total, canManage }
POST	/api/iot/lorawan/gateways	gateways manage	Bir Basics Station ağ geçidi ekler: { gateway, token, stationConfig }
GET	/api/iot/lorawan/gateways/{gatewayId}	gateways read	{ gateway, live, devicesHeard }
PATCH	/api/iot/lorawan/gateways/{gatewayId}	gateways manage	name, status (ACTIVE veya DISABLED), latitude, longitude, altitude
DELETE	/api/iot/lorawan/gateways/{gatewayId}	gateways manage	Bağlantısını kapatır, EUI’sini serbest bırakır, kaldırır
POST	/api/iot/lorawan/gateways/{gatewayId}/credentials	gateways manage	Yeni belirteç: { gateway, token, stationConfig }

Liste page (0’dan başlar), pageSize, search, sort (name, eui, protocol, mode, status, region, lastSeen, createdAt; varsayılan name:asc) ve protocol, mode, status, region, deviceId, online filtrelerini alır.

Oluşturma gövdesi:

{ "eui": "AA555A0000000101", "name": "Roof gateway", "latitude": 41.0151, "longitude": 28.9795, "altitude": 45 }

eui zorunludur (16 onaltılık karakter; tire, iki nokta ve boşluklar yok sayılır), name 1 ile 128 karakter arasında olmalıdır. Protokol varsayılan olarak Basics Station, mod cloud ve bölge EU868 (sunulan tek bölge) olur. Belirteç yalnızca bu yanıtta bulunur. Lisanslı yönlendiriciler burada eklenmez: kendi panellerinde cloud moduna geçerler, bkz. LoRaWAN ağ geçidi olarak lisanslı yönlendiriciler. Belirteci olmayan bir ağ geçidinin belirtecini yenileme isteği reddedilir: “This gateway does not use a token.” Bkz. Ağ geçidi ekleme ve Ağ geçidi kimlik bilgileri, devre dışı bırakma ve silme.

Cihazlar

Yöntem	Yol	İzin	İşlevi
GET	/api/iot/lorawan/devices	devices read	Liste: { data, total, canManage }
POST	/api/iot/lorawan/devices	devices manage	Bir OTAA veya ABP cihazı ekler (201 { device })
GET	/api/iot/lorawan/devices/{deviceId}	devices read	{ device }: kayıt ve canlı oturumu, hiçbir zaman anahtar değil
PATCH	/api/iot/lorawan/devices/{deviceId}	devices manage	name, joinEui, appKey, macVersion, class, anyJoinEui, codecId; ABP için devAddr, nwkSKey, appSKey birlikte
DELETE	/api/iot/lorawan/devices/{deviceId}	devices manage	Cihazı, oturumlarını ve DevEUI talebini kaldırır
POST	/api/iot/lorawan/devices/{deviceId}/key	keys read	AppKey’i gösterir: { appKey }; her çağrı denetlenir
DELETE	/api/iot/lorawan/devices/{deviceId}/session	devices manage	Oturumu sonlandırır; cihazın yeniden katılması gerekir
DELETE	/api/iot/lorawan/devices/{deviceId}/counters	devices manage	Bir ABP cihazının çerçeve sayaçlarını sıfırlar
POST	/api/iot/lorawan/devices/{deviceId}/approve	devices manage	Eşleştirme modunun eklediği bir cihazı onaylar

Liste page (0’dan başlar), pageSize, search, sort (name, devEui, macVersion, class, createdAt; varsayılan createdAt:desc) ve macVersion, class, joinState (joined, refused, never) filtrelerini alır.

Bir OTAA cihazı ekleme

{
  "name": "Cold room 3",
  "devEui": "1122334455667701",
  "appKey": "2B7E151628AED2A6ABF7158809CF4F3C",
  "joinEui": "0000000000000000",
  "macVersion": "1.0.3",
  "class": "A",
  "codecId": "auto",
  "anyJoinEui": false
}

Yalnızca name, devEui ve appKey zorunludur; geri kalanı varsayılan değerleri gösterir. macVersion 1.0.2, 1.0.3 veya 1.0.4; class A veya C‘dir. Yanıt hiçbir zaman AppKey taşımaz, yalnızca hasAppKey: true taşır. Yeni bir AppKey, cihazın join nonce geçmişini sıfırlar. Bkz. OTAA cihazı ekleme.

Bir ABP cihazı ekleme

{
  "name": "Water meter 12",
  "activation": "ABP",
  "devEui": "1122334455667712",
  "devAddr": "26011F3A",
  "nwkSKey": "…32 hexadecimal characters…",
  "appSKey": "…32 hexadecimal characters…"
}

Bir appKey içeren ABP gövdesi veya oturum anahtarları içeren bir OTAA gövdesi reddedilir. Bkz. ABP cihazı ekleme.

Profil ayarları ve eşleştirme

Yöntem	Yol	İzin	İşlevi
GET	/api/iot/lorawan/profiles/{profileId}/settings	devices read	Profilin LoRaWAN sekmesinin { settings } değeri
PUT	/api/iot/lorawan/profiles/{profileId}/settings	devices manage	Bunları değiştirir; sharedAppKey yalnızca yazılabilir
GET	/api/iot/lorawan/profiles/{profileId}/pairing	devices read	{ pairing }: pencere ve eklediği cihazlar
POST	/api/iot/lorawan/profiles/{profileId}/pairing	devices manage	{ "minutes": 1–120 } pencereyi açar veya bitiş zamanını değiştirir
DELETE	/api/iot/lorawan/profiles/{profileId}/pairing	devices manage	Pencereyi hemen kapatır

Yalnızca API’nin ayarladığı alanlar dahil ayar alanları LoRaWAN cihaz profilleri sayfasında listelenmiştir. Eşleştirme, Eşleştirme modu ve Eşleştirilmiş cihazları onaylama sayfalarında açıklanmıştır.

Çerçeve günlüğü

GET /api/iot/lorawan/frames?deviceId={deviceId}&gatewayId={gatewayId}&limit=200

{ frames }: kaydedilmeyen kısa bir canlı günlükten, en yeni önce olmak üzere son çerçeveleriniz. Başka bir kuruluşa ait bir cihazın düşürülen çerçevesi yalnızca nedenini gösterir. Bkz. Çerçeve günlüğü.

Aşağı bağlantılar ve kodekler

• Uygulama aşağı bağlantıları, lora.downlink yöntemine sahip komutlardır: { "fPort": 1–223, "data": "<hex or base64>", "confirmed": false }, Komutlar API’si ile gönderilir. Bkz. Aşağı bağlantılar.
• Kodekların kendi rotaları vardır: Kodek API’si.

Reddetmeler

LoRaWAN reddetmeleri düz mesajlar taşır, örneğin “A Basics Station gateway always runs in cloud mode.”, “This gateway does not use a token.” veya 32 onaltılık karakter olmayan bir anahtar. Başarısız olan alan kuralları issues ile birlikte bir 400 döner. Bkz. Hatalar ve hız sınırları.