From a5d01d8ecce23b8564bf5975f5f17716d679d33e Mon Sep 17 00:00:00 2001 From: Dimitar Dimitrov Date: Wed, 3 Jul 2024 20:28:07 +0300 Subject: [PATCH] Documentation update Signed-off-by: Dimitar Dimitrov --- README.md | 5 ++++- integration/README.md | 25 ++++++++++++++++++++----- 2 files changed, 24 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 1fdb4e3..575398e 100644 --- a/README.md +++ b/README.md @@ -65,12 +65,14 @@ Type `help` to get a list of supported commands. In order to connect to the Helium network, you must first set the [keys](https://docs.helium.com/console/adding-devices/). Reboot the board after that for the settings to take effect. ``` lorawan dev_eui AABBCCDDEEFF0011 -lorawan app_eui 0102030405060708 +lorawan app_eui 0000000000000000 lorawan app_key 123456789ABCDEFFEDCBA98765432101 lorawan auto_join true kernel reboot cold ``` +Note: With the new ChirpStack, `app_eui` should be set to 0. Only the now-deprecated Helium Console requires a valid `app_eui`. + ## Acknowledgements This project is heavily based on https://github.com/retfie/helium_mapper . @@ -80,3 +82,4 @@ This project is heavily based on https://github.com/retfie/helium_mapper . - Create a custom board definition for Zephyr instead of inheriting stm32wl_devkit. - Add more documentation (e.g. how to setup Helium/LoRaWan keys). - Add battery voltage measurement to the Lora packet. + - Add driver for AHT20 sensor, so that firmware can run directly on [LoRa-STM32WL-DevKit](https://www.olimex.com/Products/IoT/LoRa/LoRa-STM32WL-DevKit/open-source-hardware), no custom wiring required. diff --git a/integration/README.md b/integration/README.md index eedd847..bc97757 100644 --- a/integration/README.md +++ b/integration/README.md @@ -6,15 +6,30 @@ This project provides an integration HTTP server for accepting data from Helium This server is rather simple. Currently all it does is to record the POSTed temperature data in a local [SQLite](https://www.sqlite.org) database. Even then, it fulfills my own need to track data. -## Helium setup +## Pick a LoRaWAN Network Server Provider +First you need to pick a LoRaWAN Network Server Provider from the [official list](https://docs.helium.com/iot/find-a-lns-provider/). It is needed to route the data packets sent by the sensor to your integration HTTP server. + +Make an account in the LNS you picked. Some LNS offer a small number of free initial [DC](https://docs.helium.com/tokens/data-credit/), but in general you'd need to pay a small sum to buy a batch of DC. -From the Helium [console](https://console.helium.com/flows) do: - 1. Add your [device](https://console.helium.com/devices). Make sure you can see packets coming from the device. - 2. Add a new HTTP [integration](https://console.helium.com/integrations). Leave the default POST method option. Write the URL of your server. - 3. Go to the [Flows](https://console.helium.com/flows) menu and connect your device straight to your new integration. A decoder function is not needed. +## Helium setup +The following instructions are a summary of the [official manual](https://docs.helium.com/console/adding-devices/) from Helium. + +Login in your provider and: + * Create a new Device Profile. + * Create a new Application. + ** In the Application page, add a new Device. + ** Generate a new `dev_eui` for the device by clicking on the spiral arrow button. + ** Leave the `join_eui` field empty. + ** Select the profile you previously created. + ** Click Submit. You'll be prompted for Application key. Generate a new one, and click Submit. + * In the Application page click on Integrations. + ** Add HTTP integration. + ** Fill-in the URL of your integration server (i.e. the python program in this directory). With the above steps you should be able to see Helium POST requests to the URL you have provided. +Don't forget to configure your device with the `dev_eui` and `app_key` generated from the above steps. + ## Server setup Before you start the HTTP server on your premises, you need to initialize the database: