Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/kartben/iotc-device-bridge-standalone-multidps


https://github.com/kartben/iotc-device-bridge-standalone-multidps

Last synced: about 5 hours ago
JSON representation

Awesome Lists containing this project

README 

        
# Azure IoT Central Device Bridge



NOTE: This repository was initially created as a fork of https://github.com/Azure/iotc-device-bridge, as a way to address the requirements of bridging a LoRaWAN network server to IoT Central (or potentially IoT Hub) more easily, and experiment with how to leverage [IoT Plug-and-Play](https://github.com/Azure/IoTPlugandPlay) in the context of LoRaWAN communication.



NOTE 2: You should still use the original and official Device Bridge for production use cases, as this experiment is using features that are in preview and therefore subject to changes (ex. IoT Plug and Play), as well as the fact that it is, out of the box, exposing unsecured configuration endpoints, in order to help with rapid prototyping.



The main differences/evolutions with regard to the original IoT Central Device Bridge are highlighted below:

- Runs as a full-blown Node.js application (instead of Azure functions), conveniently made available as a container. It simplifies the implementation of downlink support (which is still to be implemented though!), and makes it easier to persist

- Allows to bridge to multiple IoT Central applications (or more generally, multiple DPS Group Enrollments), with a configurable per-device mapping ;

- Optionally: can be configured as a Slack bot which allows to interactively configure new mappings between a device EUI and a DPS group enrollment (which can of course be an IoT Central application's group enrollment).



Note: switching from an Azure Function based architecture + Consumption Plan to a Node.js app was done mainly to 



You may want to refer to the [documentation of the original bridge](https://github.com/Azure/iotc-device-bridge/blob/master/README.md).



# Instructions



To use the device bridge solution, you will need the following:

- an Azure account. You can create a free Azure account from [here](https://aka.ms/aft-iot)

- an Azure IoT Central application to connect the devices to. Create a free app by following [these instructions](https://docs.microsoft.com/en-us/azure/iot-central/quick-deploy-iot-central)

  - Note: you can also go for an Azure IoT DPS + Azure IoT Hub setup



[![Deploy to Azure](https://azuredeploy.net/deploybutton.png)](https://portal.azure.com/#create/Microsoft.Template/uri/https%3A%2F%2Fraw.githubusercontent.com%2Fkartben%2Fiotc-device-bridge-standalone-multidps%2Fmaster%2Fazuredeploy.json)



Once running, the bridge exposes a REST API for easily listing/adding mappings between a TTN devices and Azure IoT, by providing the following information:



* the EUID of the LoRaWAN device for which you want telemetry to be forwarded to IoT Central

* the ID Scope for the Azure IoT DPS instance used to manage your devices, and in which you have already created a group enrollment

* the symmetric key for your group enrollment (if using IoT Central, this would be available in Administration / Device Connection / View keys)

* optionally: the PnP capability model ID that you want to associate to this device. 

  * Note: this bridge currently only supports "urn:seeedstudio:sensecap:1" which corresponds to a [SenseCAP Temperature & Humidity sensor](https://www.seeedstudio.com/LoRaWAN-Air-Temperature-and-Humidity-Sensor-EU868-p-4307.html).



In practice, you would issue a POST similar to the following:



```

POST http://:3000/deviceEnrollments



 "2CF7F12010700028": {

   "idScope": "0ne000B89D7",

   "primaryKey": "4nUUafbKnOwX/JsjZ2nUU11bH+fHfd98oRx2yN9N5bY42yRfs+oA/cIT5clo2SvJz79NGTYvCXu6JFlc7BA0pg==",

   "capabilityModelId": "urn:seeedstudio:sensecap:1"

 }

```



# Contributing



This project welcomes contributions and suggestions.  Most contributions require you to agree to a

Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us

the rights to use your contribution. For details, visit https://cla.microsoft.com.



When you submit a pull request, a CLA-bot will automatically determine whether you need to provide

a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions

provided by the bot. You will only need to do this once across all repos using our CLA.



This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).

For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or

contact [[email protected]](mailto:[email protected]) with any additional questions or comments.