Přeskočit na hlavní obsah

Konfigurace (config)

Nastavení zařízení se čte a zapisuje příkazem config ve vývojářském shellu. Přípravu firmwaru a otevření konzole popisuje stránka Nastavení firmwaru.

Firmware v2.0.0

Příkaz config a parametry na této stránce platí pro firmware STICKER v2.0.0. Hlavní změny oproti v1.4.x:

  • Rádio P2P: radio-mode p2p komunikuje přímo s modemem HARDWARIO FIBER a hubem ProXimos přes rádiový protokol HARDWARIO TOWER, bez sítě LoRaWAN (viz P2P).
  • Společné parametry rádia: z lrw-deveui / lrw-appkey jsou radio-deveui / radio-appkey a kontroly spojení nastavují radio-link-check-interval / radio-link-check-fail-rejoin. Platí pro LoRaWAN i P2P.
  • Piny GP: cap-gpio-mode a cap-gpio-input-a / cap-gpio-input-b nahrazují cap-input-a/-b a cap-pir-detector. Externí vstup může být digitální, analogový (0–24 V) nebo čítač impulzů.
  • Nové parametry: cap-sht, sensor1-type…sensor4-type, lrw-datarate, lrw-region as923, alarm-buzzer-mode, radio-alarm-ack a interval-announce.
  • Mailbox NFC: telefon komunikuje se zařízením STICKER přes mailbox čipu NFC (jedno přiložení, na Androidu i iOS) místo záznamů NDEF hio.stck:cmd / hio.stck:rsp.
Přechod z v1.4.x

Přejmenované parametry nemají aliasy, takže upravte své skripty pro zprovoznění a testování. Po aktualizaci:

  • radio-deveui a radio-appkey zachovají hodnoty uložené jako lrw-deveui / lrw-appkey.
  • radio-link-check-interval a radio-link-check-fail-rejoin se nepřevádějí: vrátí se na výchozí hodnoty (5 / 5). Pokud jste je měnili, nastavte je znovu.
  • Schopnosti pinů GP se nepřevádějí: cap-gpio-mode, cap-gpio-input-a a cap-gpio-input-b začínají na none. Nastavte je znovu.
  • Nepřevádějí se ani pravidla alarmů a výběr kanálů historie, viz Pravidla alarmů a Historie senzorů.
Konfigurace v terénu a vývojářská konfigurace

Tato stránka popisuje interaktivní příkazy shellu (config) dostupné přes ladicí připojení RTT. Běžná konfigurace v terénu i uvedení do provozu ale probíhají bezdrátově přes NFC v aplikaci HARDWARIO Manager.


Syntaxe příkazu​

config <subcommand> [value]
  • Zavolaný bez hodnoty podpříkaz aktuální nastavení přečte a vypíše.
  • Zavolaný s hodnotou nové nastavení zapíše.

Výpis všech aktuálních hodnot najednou:

config show
Uložení změn

Zápis přes config změní nastavení v RAM a projeví se okamžitě, ale neuloží se, dokud nespustíte settings save, který zapíše konfiguraci do flash paměti a zařízení restartuje (viz Údržba). Neuložená změna se při dalším vypnutí a zapnutí ztratí. Pravidla alarmů nastavená příkazem alarm (viz Pravidla alarmů) se ukládají okamžitě a nevyvolávají restart.


Intervaly vzorkování a hlášení​

PříkazArgumentPopis
config interval-sample0, nebo 5-3600 (sekundy)Jak často se vzorkují senzory. 0 znamená jeden vzorek vždy těsně před odesláním hlášení.
config interval-report60-86400 (sekundy)Jak často se uplinkem odesílá hlášení. Výchozí 900 (15 minut).
config interval-announce0, nebo 1-168 (hodiny)Jak často zařízení STICKER znovu odešle uplink Info a své klíčové nastavení (intervaly, schopnosti, nalezené senzory 1-Wire). Po startu a po připojení k síti se odesílají vždy. 0 = bez pravidelného opakování. Výchozí 24.

Příklad: hlášení každých 10 minut:

config interval-report 600
settings save

Nastavení rádia​

PříkazArgumentPopis
config radio-modeoff / lorawan / p2pRádio pro všechny uplinky a downlinky. off = režim Radio-Silent: senzory, alarmy i historie dál běží, ale nic se nevysílá. Výchozí off. Zapsat ho lze jen přes shell nebo NFC, nikdy downlinkem přes rádio. Rádio se volí při startu, takže se změna projeví po settings save.
config radio-deveui16 hex číslicDevEUI, identita zařízení v síti LoRaWAN i P2P.
config radio-appkey32 hex číslicAppKey: kořenový klíč pro OTAA v LoRaWAN; v P2P základ klíčů pro připojení a relaci.

LoRaWAN​

PříkazArgumentPopis
config lrw-regioneu868 / us915 / au915 / as923Frekvenční region (as923 = AS923-1). Region, který v image firmwaru není, nechá rádio mlčet (zařízení hlásí lrw-disabled); na jiné pásmo nikdy nepřejde. Image release obsahují všechny čtyři regiony, image debug jen EU868.
config lrw-sub-band0-8Sub-band pro US915/AU915. 0 = všechny kanály. Výchozí 2.
config lrw-networkpublic / privateTyp sítě.
config lrw-activationotaa / abpMetoda aktivace.
config lrw-adrtrue / falseAdaptivní datová rychlost (ADR). Výchozí true.
config lrw-datarateauto, dr0-dr7Pevná datová rychlost uplinku; použije se jen s lrw-adr false a až po připojení k síti. auto nechá datovou rychlost na stacku. Výchozí auto.
config lrw-joineui16 hex číslicJoin EUI (AppEUI).
config lrw-nwkkey32 hex číslicNetwork Key (OTAA).
config lrw-devaddr8 hex číslicDevice Address (ABP).
config lrw-nwkskey32 hex číslicNetwork Session Key (ABP).
config lrw-appskey32 hex číslicApplication Session Key (ABP).

Příklad: EU868 s aktivací OTAA a zapnutým vysíláním:

config lrw-region eu868
config lrw-activation otaa
config radio-deveui 0102030405060708
config lrw-joineui 0807060504030201
config radio-appkey 0102030405060708090A0B0C0D0E0F10
config radio-mode lorawan
settings save

P2P​

S radio-mode p2p komunikuje zařízení STICKER přímo s modemem HARDWARIO FIBER a hubem ProXimos přes rádiový protokol HARDWARIO TOWER, bez sítě LoRaWAN. Telemetrie, alarmy, příkazy, opětovné odeslání historie, síťový čas i dohled nad spojením fungují stejně jako přes LoRaWAN. Parametry P2P lze zapsat jen přes shell a musí odpovídat nastavení hubu. P2P je součástí image release; image debug ho vynechává. Nastavení na straně sítě popisuje stránka Režim LoRa P2P.

PříkazArgumentPopis
config p2p-frequency863000000-870000000 (Hz)Nosná frekvence v pásmu EU868. Výchozí 869525000.
config p2p-spreading-factor6-12Spreading factor LoRa; vyšší hodnota znamená delší dosah a nižší datovou rychlost. Pevná konstanta sítě (bez ADR). Výchozí 7.
config p2p-tx-power2-14 (dBm)Vysílací výkon. Výchozí 14.
config p2p-modulationlora / fskModulace. fsk slouží pro komunikaci se standardní bránou TOWER. Při přepnutí mezi lora a fsk se zařízení páruje znovu. Výchozí lora.

Tyto parametry platí pro obě rádia.

PříkazArgumentPopis
config radio-link-check-interval0-255Každé N-té hlášení je kontrola spojení: v LoRaWAN LinkCheckReq; v P2P (kde se potvrzuje každé hlášení) se za kontrolu počítá N-té hlášení. 0 = vypnuto. Výchozí 5.
config radio-link-check-fail-rejoin1-255Počet selhání kontroly spojení, po kterých se spojení naváže znovu (rejoin OTAA v LoRaWAN, nové připojení v P2P). Výchozí 5.

Senzory a schopnosti​

Příznaky schopností říkají firmwaru, jaký hardware je na dané variantě osazený. Nastavují se obvykle při zprovoznění ve výrobě a v terénu se nemají měnit.

PříkazArgumentPopis
config cap-shttrue / falseOsazený senzor teploty a vlhkosti na desce (SHT4x). Výchozí true.
config cap-barometertrue / falseOsazený senzor barometrického tlaku.
config cap-light-sensortrue / falseOsazený senzor okolního světla.
config cap-accelerometertrue / falseOsazený akcelerometr (orientace, pohyb, volný pád).
config cap-w1-sensorstrue / falseZapnutá sběrnice 1-Wire; připojené senzory se najdou automaticky při skenování.
config cap-hall-lefttrue / falseOsazený levý Hallův spínač.
config cap-hall-righttrue / falseOsazený pravý Hallův spínač.

Piny GP (vstupy, PIR, bzučák)​

Piny GP_A a GP_B obsluhují externí vstupy A a B, detektor pohybu PIR nebo variantu s bzučákem. Vlastníka pinů určuje jediný parametr, takže konfliktní nastavení nejde uložit.

PříkazArgumentPopis
config cap-gpio-modenone / inputs / pir / buzzerVlastník pinů GP_A a GP_B. inputs předá každý pin jeho režimu vstupu níže; pir a buzzer zaberou oba piny. Výchozí none.
config cap-gpio-input-anone / digital / analog / pulseRežim vstupu A, použije se jen s cap-gpio-mode inputs. digital = stav a počet impulzů, analog = napětí 0–24 V, pulse = čítač impulzů (například z výstupu S0 měřiče, libovolné polarity). Výchozí none.
config cap-gpio-input-bnone / digital / analog / pulseRežim vstupu B, hodnoty jako u vstupu A. Výchozí none.
Přepínač DIP u STICKER Input

U varianty STICKER Input připojuje přepínač DIP S1 externí svorky ke vstupům nebo ke sběrnici 1-Wire. Firmware polohu přepínače nezjistí, takže režim vstupu a poloha přepínače si musí odpovídat. Vstup v režimu analog s přepínačem v poloze 1-Wire měří nezapojený pin. Viz Zapojení vstupů STICKER Input.

Sloty 1-Wire​

PříkazArgumentPopis
config sensor1-rom ... config sensor4-rom16 hex číslicSériové číslo z ROM senzoru 1-Wire přiřazeného ke slotu 1-4. Samé nuly = prázdný slot. Obvykle ho nastaví w1 enroll nebo automatické přiřazení.
config sensor1-type ... config sensor4-type0 / 2 / 3Typ senzoru, který slot očekává: 0 žádný, 2 dallas (DS18B20), 3 machine probe. Nastaví se při přiřazení senzoru nebo předem při zprovoznění. Když se ve slotu objeví senzor jiného typu, zařízení STICKER vyvolá alarm sensor_mismatch a pravidla alarmů daného slotu se přestanou vyhodnocovat.

Nastavení senzorů​

PříkazArgumentPopis
config accel-motion-sensitivityoff / low / medium / highCitlivost detekce pohybu akcelerometrem. Výchozí off: detekce pohybu je vypnutá (žádné události accel-motion / accel-count) a akcelerometr mezi pravidelnými odečty orientace spí v úsporném režimu.

Čítače impulzů​

PříkazArgumentPopis
config hall-left-countertrue / falsePočítat impulzy na levém Hallově spínači.
config hall-right-countertrue / falsePočítat impulzy na pravém Hallově spínači.
config input-a-countertrue / falsePočítat impulzy na externím vstupu A v režimu digital. Vstup v režimu pulse počítá vždy.
config input-b-countertrue / falsePočítat impulzy na externím vstupu B v režimu digital. Vstup v režimu pulse počítá vždy.

Podrobnosti k zapojení (přepínače DIP, 1-Wire, bezpotenciálový kontakt, analogový vstup) najdete na stránce Zapojení vstupů STICKER Input.


Alarmy, bzučák a baterie​

PříkazArgumentPopis
config alarm-limit0-3600 (sekundy)Okno pro sběr alarmů. Výchozí 10. Viz Pravidla alarmů.
config alarm-buzzer-modeoff / once / slow / normal / fast / continuousMelodie bzučáku během aktivního alarmu. Každý režim kromě off zahraje melodii, když se aktivuje nový alarm; once ji neopakuje, slow / normal / fast ji opakují každých 120 / 30 / 10 s, dokud alarm trvá, continuous ji hraje bez přestávky. Vyžaduje variantu s bzučákem a cap-gpio-mode buzzer. Výchozí off.
config radio-alarm-acktrue / falseOdesílat alarmy na obou rádiích jako potvrzované uplinky: každý alarm čeká na potvrzení ze sítě a odešle se až třikrát znovu. Výchozí false.
config battery-level1000-3600 (mV)Práh alarmu slabé baterie. Výchozí 2400.

Identita zařízení a bezpečnostní architektura NFC​

Tyto parametry určují identitu zařízení, řízení přístupu přes NFC a claim token. Nastavují se ve výrobě a za běžného provozu se nemají měnit.

PříkazArgumentPopis
config serial-number10 dekadických číslicSériové číslo zařízení.
config secret-key32 hex číslicSecret key zařízení, kterým se zabezpečuje lokální kanál NFC pomocí AES-CCM. Číst i zapisovat ho lze jen přes shell.
config nonce-counterCelé čísloČítač nonce, který chrání šifrovaný příkazový kanál NFC proti opakovanému odeslání (replay).
config claim-token32 hex číslic128bitový claim token zařízení zapisovatelný jen jednou. Po nastavení při uvedení do provozu už ho nelze změnit a vlastnictví zařízení zůstane vázané k jednomu backendu.
config vendor-token32 hex číslicVendor token zapisovatelný jen jednou, nastavuje se při uvedení do provozu.
config vendor-reset-allowtrue / falseZda zařízení přijme vendor reset. Bezdrátově ho lze změnit jen přes kanál NFC výrobce. Výchozí true.
config calibrationtrue / falseZapne kalibrační režim (pro výrobu).

Mailbox NFC a claim okno​

Od firmwaru v2.0.0 komunikuje telefon se zařízením STICKER přes mailbox Fast Transfer Mode čipu NFC ST25DV:

  • Jedno přiložení: když telefon držíte v klidu, proběhne celá výměna (například přečtení celé konfigurace nebo její zápis a uložení) na jedno přiložení, na Androidu i na iOS.
  • Jen zapnuté zařízení: mailbox potřebuje běžící zařízení. Tag neobsahuje žádné záznamy NDEF, takže obecná čtečka NFC nebo zařízení s vybitou baterií ukáže prázdný tag. Vypnuté zařízení už konfigurovat nejde.
  • Zabezpečení AES-CCM: příkazy z aplikace HARDWARIO Manager se šifrují klíčem secret-key a každá transakce ověří a zvýší nonce-counter, takže zachycenou komunikaci nelze zneužít k útoku jejím opakovaným odesláním (replay).
  • Nešifrovaný kanál: bez šifrování odpovídají jen dva příkazy, které nic nemění: get_basic_info (sériové číslo, nonce a verze, které telefon potřebuje, než začne šifrovat) a get_claim_info. Nešifrovaný kanál není nikdy dostupný přes rádio.
  • Claim okno: okno je buď active (výchozí stav z výroby), nebo done. Dokud je active, vrátí get_claim_info sériové číslo a claim token. Aplikace okno po převzetí zařízení zavře příkazem claim_done. claim_active okno znovu otevře, vygeneruje nový claim token, pokud žádný není nastavený, a vrátí ho šifrovaným kanálem. Vendor reset claim token smaže a okno zavře. Ze shellu okno ovládá ats claim active|done|status (viz Diagnostika).
Přechod z v1.4.x: smažte staré záznamy NDEF

Firmware v2.0.0 do paměti NFC nikdy nezapisuje, takže na zařízení aktualizovaném z v1.4.x zůstanou staré záznamy NDEF včetně nešifrovaného záznamu hio.stck:clm s claim tokenem. Jednou je smažte: příkazem nfc clear v sestavení debug, nebo zápisem prázdné zprávy NDEF z telefonu.