Repository files navigation

This repository contains device-profiles for LoRaWAN devices grouped byvendor. A device-profile contains important information about the capabilitiesof the device. For example which LoRaWAN mac-version has been implemented,which regions are supported, if the device supports Class-B or Class-C, etc...The aim is to build a complete list of LoRaWAN device-profiles that then canbe imported by ChirpStack or potentially any other LNS.

• Create a fork of this repository (if not done already).
• Clone your local fork to your computer.

• Please make sure that you have Docker Compose installed.
• In the root of this repository, executedocker compose up.
• OnceStarting server, bind: 0.0.0.0:8090 appears, open the web-interface in your browser by navigating tohttp://localhost:8090.

• In the left menu, click theAdd vendor button.
• Fill in the form and clickSubmit.

• Select a vendor in the left menu (if no vendor is selected).
• ClickProfiles in the left menu.
• Click theAdd profile menu entry.
• Fill in the form and clickSubmit.

• Select a vendor in the left menu (if no vendor is selected).
• ClickCodecs in the left menu.
• Click theAdd codec menu entry.
• Fill in the form, before clickingSubmit it is a good idea to clickRun codec tests.

• Select a vendor in the left menu (if no vendor is selected).
• ClickDevices in the left menu.
• Click theAdd device menu entry.
• Fill in the form and add at least one firmware version by clicking theAdd firmware version button.
  • For each firmware version you can select one or multiple profiles and optionally a codec.

• Select a vendor in the left menu (if no vendor is selected).
• ClickUpdate vendor in the left menu.
• Update the vendor by selecting the devices that you added in the previous step.
• ClickSubmit.

Once you have added the vendor(s), profile(s), codec(s) and device(s) you wishto add to this repository you must commit the changes usinggit, push theseto your fork of this repository and create a pull-request in GitHub.

Example structure for anexample-vendor with anexample device:

vendors/└── example-vendor    ├── codecs    │   ├── example.js    │   ├── test_decode_example.json    │   └── test_encode_example.json    ├── devices    │   └── example.toml    ├── profiles    │   └── example-EU868.toml    └── vendor.toml

Please take a look at thevendors/example-vendor example documentedconfiguration files.

This is the root of the example vendor. It must contain avendor.tomlfile. Thisvendor.toml.

This directory contains the payload codecs. Codecs can be used by one ormultiple devices. E.g. some vendors have a generic payload codec.

Each codec is expected to have tests for encoding and decoding. If thecodec filename isexample.js, then you should create two test-filescalledtest_decode_example.json (thus +test_decode_ prefix and.jsonextension) andtest_encode_example.json.

This directory contains the devices. Each device will have its own.tomlconfiguration.

This directory contains the profiles. These profiles can be used by oneor multiple devices. The profile also defines the region.

This repository is distributed under the MIT license. See alsoLICENSE.