OS2iot brugermanual

Owned by Mogens Kjeldsen
Last updated: Jun 28, 2023
5 min read

Work in progress

 

Introduktion

På denne og underliggende sider opbygges en brugermanual til OS2iot. Det er endnu ikke afgjort om den skal bo i Confluence eller en anden platform.

Har du behov for en manuel til en særlig del af OS2iot, så send et ønske om det til produktkoordinator Mogens Kjeldsen

Bemærk at der også kan være hjælp at hente i den tekniske dokumentation.

Ønskede emner i manualen

  • Oprettelse af enheder

  • Oprettelse af data targets

  • Oprettelse af gateways

  • Brug af payload decoder

  • Forklaring af LoRaWAN profiler

Videoguide

Leverandøren Iterator IT har lavet en videoguide til OS2iot, der både forklarer om produktets formål og indeholder vejledning til specifik funktionalitet: https://iterator-it.dk/os2iot-vejledning/

Erfaringsudveksling og implementeringshjælp

Nye anvendere af OS2iot kan få hjælp flere steder til implementering og udveksling af erfaringer:

  • OS2iot driftsfællesskaberne GovTech Midtjylland og Fællesskabet for Dynamiske Data tilbyder hjælp til medlemmer

  • Nogle af de eksisterende anvendere af OS2iot tilbyder at udveksle erfaringer med OS2iot

  • Nogle leverandører tilbyder konsulenthjælp til at tage OS2iot i brug og til generel opsætning. Vi er bekendt med følgende, der tilbyder dette:

Bruger- og rettighedsstyring

Struktur

OS2iot er en såkaldt multi-tenant løsning, der er udviklet til at blive driftet i fællesskab af flere myndigheder. Hvis man ikke følger den tiltænkte struktur, kan man risikere problemer med at give brugerne adgang til det, man ønsker.

Opbygningen af brugere og rettigheder er tænkt således:

  • En organisation dækker en overordnet organisation som fx en enkelt kommune eller en region.

    • Hvis man har sin egen driftsinstans af OS2iot, bør man altså ikke oprette flere organisationer og benytte dem til at adskille adgangen mellem fx afdelinger i organisationen!

  • En brugergruppe tilknyttes brugerrettigheder, brugere og applikationer, så man kan benytte den til at adskille dele af OS2iot og have brugere med forskellige rettigheder.

    • Brugergrupper skal altså benyttes til de afdelinger i organisationen, man gerne vil oprette og styre adgang til.

    • Brugergrupper kan fx også benyttes til at give en leverandør begrænset adgang til en del af OS2iot.

Brugerrettigheder

Overordnet findes rettigheden Global administrator, som giver adgang til alt i OS2iot. Herudover findes fire typer af brugerrettigheder, som kan kombineres til at sammensætte brugergrupper til afgrænsede formål.

Rettighed

Beskrivelse

Tildeling

Global administrator

Har adgang til at oprette, redigere og slette alt på tværs af organisationer

 

Tildeles på en brugers profil

Brugeradministrator

Har adgang til at oprette, redigere og slette brugere i den tilknyttede organisation

Har adgang til at oprette, redigere og slette brugergrupper i den tilknyttede organisation

 

Defineres i en brugergruppe og tildeles derefter til en bruger ved at knytte denne til brugergruppen

Gateway-administrator

Har adgang til at oprette, redigere og slette gateways i den tilknyttede organisation

OBS! Gateways deles på tværs af organisationer, men denne rettighed giver ikke mulighed for at redigere gateways i andre organisationer

 

Defineres i en brugergruppe og tildeles derefter til en bruger ved at knytte denne til brugergruppen

Applikationsadministrator

Har adgang til at oprette, redigere og slette applikationer (og dermed IoT-enheder og data targets) i den tilknyttede organisation

Har adgang til alt vedr. Sigfox administration

 

Defineres i en brugergruppe og tildeles derefter til en bruger ved at knytte denne til brugergruppen

Læserettigheder

Har adgang til at se flg.:

  • gateways på tværs af organisationer

  • applikationer i tilknyttet brugergruppe

  • device modeller i organisationen

Defineres i en brugergruppe og tildeles derefter til en bruger ved at knytte denne til brugergruppen

Brugergrupper i en organisation

Ved oprettelse af en organisation oprettes disse brugergrupper automatisk (dog uden tilknyttede applikationer):

  1. Organisationsadministrator

    1. Brugerrettigheder: Applikationsadministrator, Brugeradministrator, Gateway administrator, Læserettigheder

  2. Applikationsadministrator

    1. Brugerrettigheder: Applikationsadministrator, Læserettigheder

  3. Læserettigheder

    1. Brugerrettigheder: Læserettigheder

Man kan oprette alle de brugergrupper, man måtte have behov for. Ved at kombinere brugerrettigheder og applikationer i en brugergruppe er det altså muligt at afgrænse adgangen til dele af OS2iot til udvalgte brugere - fx alle fra en forvaltning eller afdeling i myndigheden.

Batteristatus på IoT-enheder

OS2iot understøtter visning af batteristatus på de LoRaWAN-enheder, der understøtter det. Det kræver, at man anmoder om batteristatus fra enhederne, hvilket gøres på denne måde:

  1. Gå til LoRaWAN profiler

  2. Rediger de relevante Service profiler, som I benytter:

    1. Sæt Device status request frequency til mindst 1. Tallet bestemmer hvor mange gange pr. dag batteristatus efterspørges)

    2. Sæt et flueben i Rapporter enhedens batteriniveau til applikationsserveren

    3. Gem service profile

 

Deling af payload decoders

OS2iot tilbyder mulighed for at dele payload decoders på tværs af organisationer i den samme driftsinstans. Da der eksisterer forskellige driftsinstanser, er der blevet oprettet et GitHub repository, hvor man kan dele sine payload decoders og finde andres. På den måde sikres deling på tværs af endnu flere myndigheder og brugere.

Du kan finde alle tilgængelige payload decoders i dette repository.

Sammen med selve JavaScriptet ligger en beskrivelse af payload decoderen, hvor du kan se dens formål, finde kontaktperson mm.

Del en payload decoder

Det styrker samarbejdet om OS2iot, hvis flere vil være dele deres payload decoders.

Hvis du er hjemmevant med Github, så opret en payload decoder baseret på denne beskrivelse og template.

Hvis du ikke er bekendt med GitHub, skal du også være velkommen til at maile den til os2@os2.eu. Så lægger OS2iot's produktkoordinator den i repositoriet. Eneste krav er, at man udfylder en readme-fil om payload decoderen ud fra skabelonen og sender med, så beskrivelsen er på plads.

GovTech Midtjylland har udarbejdet guides til, hvordan man konfigurer tre forskellige Kerlink gateways til OS2iot. De deles her, så andre kan få gavn af dem.

Login

  1. SSH via din terminal eller hent eks. puTTY og login på følgende måde(r)

    1. SSH via navn eller ip-adresse

      1. eks. ssh klk-lbps-XXXXX (XXXXX = sidste 6 i serial) / ssh xx.xx.xx.xx (x = GW ip)

    2. User: root

    3. Password: pdmk-XXXXXX (XXXXXX = sidste 6 i serial)

    4. Eksempel: ssh root@10.1.2.300 -> pdmk-010203 = success

Konfigurer til OS2iot

  1. SSH ind

  2. Kør kommandoen: klk_apps_config --activate-cpf --lns-server ”[indsæt url til jeres gw-bridge]” --lns-dport 1700 --lns-uport 1700 --loradconf /etc/lorad/ibts/EU868-FR_16CH.json

    1. Eksempel på gw-bridge url: chirpstack-gw.prod.os2iot.kmd.dk

    2. Dette laver den rette konfiguration til GovTech Midtjyllands os2iot instans, samt det rette port nummer. Den nye common packet forwarder aktiveres og fpga delen /lora delen opdatreres til nyeste version

    3. EU868-FR_16CH.json kan skiftes ud med EU868-FR_2X8CH.json, hvis man ønsker 2x8 kanaler i stedet for 16, det er også muligt at lave sin egen custom json fil med kanalkonfiguration.

GSM konfiguration

  1. Log på webinterface

    1. Bruger: admin

    2. Pass: a

  2. Indtast følgende oplysning under GSM

    1. Pin: xxxx?

    2. Operatør info:

      1. A:

      2. B:

      3. C: 

Login

  1. SSH via din terminal eller hent eks. puTTY og login på følgende måde(r)

    1. SSH via navn eller ip-adresse

      1. eks. ssh klk-lbps-XXXXX (XXXXX = sidste 6 i serial) / ssh xx.xx.xx.xx (x = GW ip)

    2. User: root

    3. Password: pdmk-XXXXXX (XXXXXX = sidste 6 i serial)

  2. Eksempel: ssh root@10.1.2.300 -> pdmk-010203 = success

Konfigurer til OS2iot

  1. SSH ind

  2. Kør kommandoen: klk_apps_config --activate-cpf --lns-server ”[indsæt url til jeres gw-bridge]” --lns-dport 1700 --lns-uport 1700 --loradconf /etc/lorad/fevo/EU868-FR.json

    1. Eksempel på gw-bridge url: chirpstack-gw.prod.os2iot.kmd.dk

    2. Dette laver den rette konfiguration til GovTech Midtjyllands OS2iot instans, samt det rette port nummer. Den nye common packet forwarder aktiveres og fpga delen /lora delen opdateres til nyeste version

    3. EU868-FR_16CH.json kan skiftes ud med EU868-FR_2X8CH.json, hvis man ønsker 2x8 kanaler i stedet for 16, det er også muligt at lave sin egen custom json fil med kanalkonfiguration.

GSM konfiguration

  1. Log på webinterface

    1. Bruger: admin

    2. Pass: a

  2. Indtast følgende oplysning under GSM

    1. Pin: xxxx?

    2. Operatør info:

      1. A:

      2. B:

      3. C:

Login

  1. SSH via din terminal eller hent eks. puTTY og login på følgende måde(r)

    1. SSH via navn eller ip-adresse

      1. eks. ssh klk-lbps-XXXXX(XXXXX = sidste 6 i serial) / ssh xx.xx.xx.xx (x = GW ip)

    2. User: root

    3. Password: pdmk-XXXXXX (XXXXXX = sidste 6 i serial)

    4. Eksempel: ssh root@10.1.2.300 -> pdmk-010203 = success

Konfigurer til OS2iot

  1. SSH ind

  2. Kør kommandoen: klk_apps_config --activate-cpf --lns-server "[indsæt url til jeres gw-bridge]” --lns-dport 1700 --lns-uport 1700 --loradconf /etc/lorad/wiis/EU868-FR.json

    1. Eksempel på gw-bridge url: chirpstack-gw.prod.os2iot.kmd.dk

    2. Dette laver den rette konfiguration til GovTech Midtjyllands OS2iot instans, samt det rette port nummer. Den nye common packet forwarder aktiveres og fpga delen /lora delen opdatreres til nyeste version

GSM konfiguration

  1. Log på webinterface

    1. Bruger: admin

    2. Pass: a

  2. Indtast følgende oplysning under GSM

    1. Pin: xxxx?

    2. Operatør info:

      1. A:

      2. B:

      3. C: