Added 'ChirpStack and InfluxDB Integration' by Davide D'Asaro (#52)

Merged as discussed with Davide.
matthias-bs · Jun 12, 2024 · bc7a7ea · bc7a7ea
1 parent e3a9f1a
commit bc7a7ea
Show file tree

Hide file tree

Showing 22 changed files with 145 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -58,6 +58,7 @@ This is a remake of [BresserWeatherSensorTTN](https://github.com/matthias-bs/Bre
   * [The Things Network Payload Formatters Setup](#the-things-network-payload-formatters-setup)
 * [MQTT Integration](#mqtt-integration)
   * [The Things Network MQTT Integration](#the-things-network-mqtt-integration)
+  * [ChirpStack and InfluxDB Integration](#chirpstack-and-influxdb-integration)
 * [Datacake Integration](#datacake-integration)
   * [Datacake / The Things Network Setup](#datacake--the-things-network-setup)
   * [Desktop Dashboard](#desktop-dashboard)
@@ -347,6 +348,10 @@ JSON-Path with Uplink-Decoder (see [scripts/uplink_formatter.js](scripts/uplink_
 
 `.uplink_message.decoded_payload.bytes.<variable>`
 
+### ChirpStack and InfluxDB Integration
+
+[ChirpStack and InfluxDB Integration](docs/influxdb_integration/influxdb_integration.md) kindly provided by [Davide D'Asaro](https://github.com/evon800c).
+
 ## Datacake Integration
 
 ### Datacake / The Things Network Setup

diff --git a/docs/influxdb_integration/images/image-00.png b/docs/influxdb_integration/images/image-00.png
diff --git a/docs/influxdb_integration/images/image-01.png b/docs/influxdb_integration/images/image-01.png
diff --git a/docs/influxdb_integration/images/image-02.png b/docs/influxdb_integration/images/image-02.png
diff --git a/docs/influxdb_integration/images/image-03.png b/docs/influxdb_integration/images/image-03.png
diff --git a/docs/influxdb_integration/images/image-04.png b/docs/influxdb_integration/images/image-04.png
diff --git a/docs/influxdb_integration/images/image-05.png b/docs/influxdb_integration/images/image-05.png
diff --git a/docs/influxdb_integration/images/image-06.png b/docs/influxdb_integration/images/image-06.png
diff --git a/docs/influxdb_integration/images/image-07.png b/docs/influxdb_integration/images/image-07.png
diff --git a/docs/influxdb_integration/images/image-08.png b/docs/influxdb_integration/images/image-08.png
diff --git a/docs/influxdb_integration/images/image-09.png b/docs/influxdb_integration/images/image-09.png
diff --git a/docs/influxdb_integration/images/image-10.png b/docs/influxdb_integration/images/image-10.png
diff --git a/docs/influxdb_integration/images/image-11.png b/docs/influxdb_integration/images/image-11.png
diff --git a/docs/influxdb_integration/images/image-12.png b/docs/influxdb_integration/images/image-12.png
diff --git a/docs/influxdb_integration/images/image-13.png b/docs/influxdb_integration/images/image-13.png
diff --git a/docs/influxdb_integration/images/image-14.png b/docs/influxdb_integration/images/image-14.png
diff --git a/docs/influxdb_integration/images/image-15.png b/docs/influxdb_integration/images/image-15.png
diff --git a/docs/influxdb_integration/images/image-16.png b/docs/influxdb_integration/images/image-16.png
diff --git a/docs/influxdb_integration/images/image-17.png b/docs/influxdb_integration/images/image-17.png
diff --git a/docs/influxdb_integration/images/image-18.png b/docs/influxdb_integration/images/image-18.png
diff --git a/docs/influxdb_integration/images/image-19.png b/docs/influxdb_integration/images/image-19.png
diff --git a/docs/influxdb_integration/influxdb_integration.md b/docs/influxdb_integration/influxdb_integration.md
@@ -0,0 +1,140 @@
+# ChirpStack and InfluxDB Integration
+
+by [Davide D'Asaro](https://github.com/evon800c)
+
+## Introduction
+
+I don’t know if my experience with LoRaWAN and my personal use of the BresserWeatherSensorLW project is interesting for anyone, but I am happy to share what I have realized for my experiment.
+
+LoRa and LoRaWAN and all other components that I have decided to use were completely new to me. My approch was very basic and I think that my description is not useful for advanced users. I think that it could be useful for users who are now starting the trip into this world.
+
+When we start talking about LoRaWAN, we should also talk about its fundamental elements.<br>
+Some note from https://www.thethingsnetwork.org/docs/lorawan/architecture/
+
+![LoRaWAN Architecture](images/image-00.png)
+
+- Network Server
+- Gateway
+- Device
+- Application Server
+
+Instead of using a public LoRaWAN network (as for example TTN), I have decided to implement my personal, private one.
+
+### Network Server
+
+To implement a LoRaWAN Network Server, I have decided to use ChirpStack (https://www.chirpstack.io) installed on a virtual machine in my lab enviroment.
+ChirpStack is an open source solution to implement a LoRaWAN Network Server. Documentation is available, clear and simple, so it is not necessary to explain it here.
+
+### Gateway
+
+It is necessary to choose a solution that covers your personal needs.
+For my personal needs, I have decided to use a Raspberry PI 4 with RAK2245 PI HAT and ChirpStack Gateway OS (https://www.chirpstack.io/docs/chirpstack-gateway-os/index.html).
+Also in this case, documentation is quite simple and clear.
+
+### Device
+
+I have used a "Heltec wifi LoRa 32 v3" board, but for Matthias' **BresserWeatherSensorLW** firmware, each compatible hardware listed in the initial project documentation can be a good choice.
+
+After initial configuration of the LoRaWAN Network Server and in **BresserWeatherSensorLW** code, we can flash the board. If everything goes right, you can see data (such as air temp, but not only that) on the LoRaWAN Network Server console coming as uplink from the device.
+
+### Application Server
+
+Now we can speak about the Application Server.
+I have decided to use InfluxDB to store my data as timeseries. So an InfluxDB server will assume the Application Server role (you can have multiple application servers based on your needs).
+We need to install an InfluxDB server, and at https://docs.influxdata.com/influxdb/v2/install/ we can choose the InfluxDB installation that we prefer and find all information required to do that.
+
+After InfluxDB installation, we need to configure: Organization, Bucket and Token.
+
+In the images below, you can see how do this.
+
+#### Create Organization and Bucket
+
+![InfluxDB - Create Organization](images/image-01.png)
+
+![InfluxDB - Create Bucket](images/image-02.png)
+
+#### Create API Token
+
+![InfluxDB - API Tokens](images/image-03.png)
+
+![InfluxDb - Configure API Token](images/image-04.png)
+
+![InfluxDb - Create API Token](images/image-05.png)
+
+![InfluxDB - Copy API Token](images/image-06.png)
+
+Now, we have all elements and parameters, including the URL to access the management API, needed for next step.
+
+>  [!NOTE]
+> Each public LoRaWAN Network Provider offers some specific interface and features to connect to an Application Server. Also ChirpStack (as a LoRaWAN Network Server) is not different. What I'm going to write will cover a large amount of situations, I think.
+
+
+For integrating ChirpStack and InfluxDB we need to:
+
+#### Create an Application in ChirpSTack
+
+![Chirpstack - Create Application](images/image-07.png)
+
+#### Create a Connection in ChirpStack to the Application Server (InfluxDB in our case)
+
+This can be done using a small number of simple paramenters, such as:
+
+- InfluxDB version 
+- API endpoint (write) &rarr; http://InfluxDB:8086/api/v2/write (as example)
+- Organization (defined on InfluxDB side) &rarr; in my case "labnet"
+- Bucket       (defined on InfluxDB side) &rarr; in my case "ChirpStack"
+- Token        (defined on InfluxDB side)
+
+![ChirpStack - Applications - Integrations](images/image-08.png)
+
+![ChirpStack - Applications](images/image-09.png)
+
+![ChirpStack - Applications - InfluxDB](images/image-10.png)
+
+Now, ChirpStack writes data coming from the device into InfluxDB.
+
+## Exploring Data inside InfluxDB
+
+At this point, my first challenge was to understand how to explore data in InfluxDB.
+
+From the left column, switch to 'Organization' created before:
+
+![InfluxDB - Switch Organizations](images/image-12.png)
+
+![InfluxDB - Choose an Organization](images/image-13.png)
+
+Always from the left column on icon "arrow up", click on the 'Buckets' label and select the bucket created before (mybucket).
+
+![InfluxDB - Get Started](images/image-14.png)
+
+![InfluxDB - Load Data](images/image-15.png)
+
+Now, a data exploration interface is presented. Here we will be guided through the query construction.
+
+From left to right, you can select parameters for the query &mdash; in my case: 
++ From:		chirpstack
++ Filter:	device_name &rarr; and select device name create on LoRaWan console
++ Filter:	_measurement &rarr; device_frmpayload_data_bytes_air_temp_c - the name defined by Matthias code (for air temp)
++ Filter:	_field &rarr; value
+
+Now click on 'Submit' button.
+
+![InfluxDB - Submit](images/image-16.png)
+
+I suppose that you receive an error `unsupported input type for mean aggregate: string`, too. If so, near the "Submit" button, click on "Script Editor". Now you switch to the manual query writer and you can see the query code that you write.<br>
+The issue is caused by the data type, which initially is string insteat of float.
+
+![InfluxDB - unsupported input type](images/image-17.png)
+
+To be able to represent data in a "graph" visualization type, you need to cast the data from string to float, so add "|> toFloat()" as shown below and click the 'Submit' button.
+
+![InfluxDB - Type conversion from string to float](images/image-18.png)
+
+This is the first simple query that I have written.
+
+If you want, you can save your query and visualization (graph) in a dashboard. If you don't have any dashboard, you can create one on the fly.<br>
+On the same dashboard, you can add all visualizations/queries that you want.<br>
+
+From the dashboard, you can select the time frame that you need to analyze.
+
+![Dashboard](images/image-19.png)