You can use this repository to find and share payload decoders for use in OS2iot. NOTE: If your desired device isn't listed, you might be able to find inspiration in The Things Network's LoRaWAN devices repository, which includes codec functions for some devices.
In each folder you can find a JavaScript file with the payload decoder and a readme file with more information.
To make sure we keep this repository nice and tidy, please follow these guidelines.
Please name the folder with the name of the IoT-device model name followed by a number based on the other folders related to the same IoT-device. For example:
ELSYS_ERS-1
ELSYS_ERS-2
Sensit_3.0-1
Sensit_3.0-2
- Please name the JavaScript file with the same name as the folder.
- Please name the readme file "readme".
In order to help others understand and use your payload decoder, please fill out the requested information about it. You can copy a template of the description from the "Template"-folder.
- IoT-device model: Add the name of the IoT-device model
- Transmission type: Indicate if this is for LoRaWAN, Sigfox etc.
- Description: Descripe the purpose of the payload decoder
- Source: If possible add a link to the source of the payload decoder - for example https://www.elsys.se/en/elsys-payload/
- Based on: If your payload decoder is based on an excisting payload decoder, please provide details about it.
- Author: Add the name and/or GitHub user name of the person who is responsible for the payload decoder.
- Contact: If wanted add a mail address so others can get in contact about the payload decoder.
For now you can just copy/paste the content of the JavaScript file into the field "Payload decoder funktion" when creating a new payload decoder in OS2iot.
See OS2iot-docs for information on how to contribute. If you want to share a payload decoder, but don't know how to use Github or just don't have the time, feel free to email a readme file and a JavaScript file to os2@os2.eu. Then we'll take care of putting it in this repository.
The OS2iot project is licensed under the MPL-2.0 License - see the LICENSE file for details. Please be aware of this, if you contribute payload decoders to this repository.