From 7e2f600dea74edf3a392dd1139363bde0a3758a2 Mon Sep 17 00:00:00 2001 From: Caspar Armster Date: Thu, 29 Jul 2021 12:50:58 +0200 Subject: [PATCH] [FEAT] added manual for the things stack community edition and ttn mapper --- README.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/README.md b/README.md index f2334868..23c5e4ab 100644 --- a/README.md +++ b/README.md @@ -263,6 +263,22 @@ Format of the data is CSV, which can easily imported into LibreOffice, Excel, .. If you want to change this please look into src/sdcard.cpp and include/sdcard.h. +# Integration into "The Things Stack Community Edition" aka "The Things Stack V3" + +To use the ESP32-Paxcounter in The Things Stack Community Edition you need an account to reach the console. Go to: +- [The Things Stack Community Edition Console](https://console.cloud.thethings.network/) +- choose your region and go to applications +- create an application by clicking "**+ Add application**" and give it a id, name, etc. +- create a device by clicking "**+ Add end device**" +- Select the end device: choose the Brand "**Open Source Community Projects**" and the Model "**ESP32-Paxcounter**", leave Hardware Version to "**Unknown**" and select your **Firmware Version** and **Profile (Region)** +- Enter registration data: choose the **frequency plan** (for EU choose the recommended), set the **AppEUI** (Fill with zeros), set the **DeviceEUI** (generate), set the **AppKey** (generate), choose a **device ID** and hit "Register end device" +- got to Applications -> "your App ID" -> Payload formatters -> Uplink, choose "**Repository**" and hit "Save changes" + +The "Repository" payload decoder uses the packed format, explained below. If you want to use MyDevices from Cayenne you should use the Cayenne payload decoder instead. + +# TTN Mapper + +If you want your devices to be feeding the [TTN Mapper](https://ttnmapper.org/), just follow this manual: https://docs.ttnmapper.org/integration/tts-integration-v3.html - different than indicated in the manual you can leave the payload decoder to "Repository" for the ESP32-Paxcounter and you are fine. # Payload format @@ -274,12 +290,16 @@ You can select different payload formats in `paxcounter.conf`: - [***CayenneLPP***](https://mydevices.com/cayenne/docs/lora/#lora-cayenne-low-power-payload-reference-implementation) generates MyDevices Cayenne readable fields +**Decrepated information from the things network v2 >>** + If you're using [TheThingsNetwork](https://www.thethingsnetwork.org/) (TTN) you may want to use a payload converter. Go to TTN Console - Application - Payload Formats and paste the code example below in tabs Decoder and Converter. This way your MQTT application can parse the fields `pax`, `ble` and `wifi`. To add your device to myDevices Cayenne platform select "Cayenne-LPP" from Lora device list and use the CayenneLPP payload encoder. To track a paxcounter device with on board GPS and at the same time contribute to TTN coverage mapping, you simply activate the [TTNmapper integration](https://www.thethingsnetwork.org/docs/applications/ttnmapper/) in TTN Console. Both formats *plain* and *packed* generate the fields `latitude`, `longitude` and `hdop` required by ttnmapper. Important: set TTN mapper port filter to '4' (paxcounter GPS Port). +**<< Decrepated information from the things network v2** + Hereafter described is the default *plain* format, which uses MSB bit numbering. Under /TTN in this repository you find some ready-to-go decoders which you may copy to your TTN console: [**plain_decoder.js**](src/TTN/plain_decoder.js) |