qpc-database / aws-iot-core-lorawan

Examples to quickly get started with AWS IoT Core for LoRaWAN with fully functional sample applications - e.g. Grafana dashboards, binary decoding of uplink, sending downlink, Thing shadow update. Decoder examples in Python and Node.js for > 10 LoRaWAN devices.

AWS IoT Core for LoRaWAN sample applications

AWS IoT Core for LoRaWAN enables you to set up a private LoRaWAN network by connecting your devices and gateways with no LoRaWAN Network Server setup required. This repository contains resources to quickly get started developing solutions using AWS IoT Core for LoRaWAN. It includes samples for typical design patterns (binary decoder, downlink messaging, Thing shadow update) and fully functional applications (dashboards, condition monitoring and alarming).

Please consider our developer guide to learn how to connect your wireless devices and gateways to AWS IoT Core for LoRaWAN. Please also consider automation guidelines and observability implementation guidelines.

Decoding binary payloads

LoRaWAN devices typically send uplink payloads as binary encoded messages. Below you will find various options for an implementation of binary payload decoding.

• Decoding binary payloads from LoRaWAN devices with Python and Node.js
  In this sample you will learn how to decode a binary message from your LoRaWAN device using Python or Node.js and integrate the decoded payload with more than 17 AWS services using AWS IoT Rules. Guidelines for an integration of existing decoder code in Node.js and Python and building your own decoders are included. See a list of >12 included examples decoders here, new contributions are welcome.

• Decoding binary payloads from LoRaWAN devices using Pilot Things Sensor Library
  This repository can help you to accelerate development of your LoRaWAN-based IoT solutions by providing a deployable reference architecture which will decode binary data using the Pilot Things Sensor Library. The Pilot Things Sensor Library is a SaaS offering that can be purchased from the AWS marketplace

• Decoding Cayenne Low Power Payload (LPP)
  Cayenne LPP format allows the device to send multiple sensor data at one time. Different kinds of sensor data are sent in the individual frames and each sensor data is prefixed with two bytes: data channel (a unique sensor identifier) and one of predefined data types (e.g. analog input, humidity or GPS location).

Samples for typical design patterns

• Sending downlink payload to a LoRaWAN device
  In this sample you will learn how to implement different options for sending downlink payload to your LoRaWAN devices. It includes examples for AWS SDK, AWS CLI and AWS IoT Core message broker.

• Updating IoT Thing shadow with decoded device payload
  AWS IoT Thing Shadows can make a device’s state available to apps and other services whether the device is connected to AWS IoT or not. In this sample you will learn how to update the shadow of an AWS IoT Thing with the telemetry from a LoRaWAN device.

Deployable sample applications

• Visualizing telemetry and transmission metadata from LoRaWAN devices with Amazon Timestream and Grafana plugin
  In this sample you will learn how to store telemetry from your LoRaWAN Devices as well as transmission metadata (e.g. RSSI and SNR per gateway) into Amazon Timestream. Afterwards you will learn how to visualize time series data in Grafana using a Grafana plugin for Amazon Timestream.

• Monitoring and alarming of soil moisture by using AWS IoT Core for LoRaWAN and AWS IoT Events
  Detecting events based on telemetry data from connected devices is a common use case in IoT across many industries. This sample explains how to integrate AWS IoT Events with LoRaWAN for IoT Core. You can learn how to translate telemetry values from a LoRaWAN device into events and notify users about these events using E-Mail and SMS.

Useful guidelines

• Automation guidelines explain how to use AWS CLI to automate tasks (e.g. configuration of a new gateway).
• Observability guidelines explaion how to retrieve statistics about the state of your LoRaWAN gateways and devices

Included binary decoders

LoRaWAN devices often encode transmitted data in a binary format, as it increases transmission efficiency and improves battery lifetime. However, as the data arrive in the cloud, many use cases require a structured format. Transforming the binary data into JSON, for example, enables filtering and enrichment using AWS IoT SQL as well as integration with further AWS services using AWS IoT Rule Actions.

The sample Decoding binary payloads from LoRaWAN devices repository contains examples of binary decoders. Please note that all decoders are provided without any guarantee to fit for any specific purpose and are only intended for use in a laboratory or prototyping environment. The list below is not to be understood as a recommendation of specific manufacturers or specific device models. AWS IoT Core for LoRaWAN supports any LoRaWAN device that complies with LoRaWAN specifications 1.0.x and 1.1. Please consult AWS Partner Device Catalog for an overview of qualified devices. Said that, please find an overview of examples below:

• Air quality / CO2 / environment measurement
  • Elsys ERS CO2
• Door and window opening
  • Elsys EMS Door
  • Dragino LDS01
• GNSS tracking
  • Dragino LGT92
  • Globalsat LT-100
  • Browan Tabs Object Locator
• Presence and smart home
  • Tektelic Smart Room Sensor
• Sound level measurement
  • Elsys ERS Sound
• Temperature, humidity and moisture
  • Dragino LHT65 (temperature and humidity)
  • Dragino LSE01 (temperature and moisture)
  • Elsys ERS Lite
  • Laird Senstrius RS1xx
• Water Metering
  • Axioma W1
• Cayenne Low Power Payload (LPP)
• Network tester
  • Adeunis FTD2
• Digital Contact Sensor
  • Adeunis Dry Contacts
• Weather station
  • MeteoHelix Iot Pro

Contributions to example binary decoders are welcome.

Getting help

• API Reference
• Developer guide
• FAQs
• Support forums
• Partner catalog

Test results

Branch	Result
main