MQTT to InfluxDB¶
For storing data from our sensors we like to use
InfluxDB - time-series database.
As a bridge between MQTT and InfluxDB we created a
Service connects to InfluxDB and MQTT broker and by users config subscribe MQTT topics and store data from messages.
Step 1: Install the MQTT to InfluxDB service¶
sudo pip3 install --upgrade mqtt2influxdb
Step 2: Create the
sudo mkdir /etc/hardwario
Step 3: Open the configuration file¶
For text editing, we use nano editor. You can save changes by pressing key combination
Ctrl + O and exit editor by pressing
Ctrl + X.
sudo nano /etc/hardwario/mqtt2influxdb.yml
Step 4: Paste this snippet to the configuration file¶
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74
mqtt: host: 127.0.0.1 port: 1883 influxdb: host: 127.0.0.1 port: 8086 database: node points: - measurement: temperature topic: node/+/thermometer/+/temperature fields: value: $.payload tags: id: $.topic channel: $.topic - measurement: relative-humidity topic: node/+/hygrometer/0:4/relative-humidity fields: value: $.payload tags: id: $.topic - measurement: illuminance topic: node/+/lux-meter/0:0/illuminance fields: value: $.payload tags: id: $.topic - measurement: pressure topic: node/+/barometer/0:0/pressure fields: value: $.payload tags: id: $.topic - measurement: co2 topic: node/+/co2-meter/-/concentration fields: value: $.payload tags: id: $.topic - measurement: voltage topic: node/+/battery/+/voltage fields: value: $.payload tags: id: $.topic - measurement: button topic: node/+/push-button/+/event-count fields: value: $.payload tags: id: $.topic channel: $.topic
In the section tags you can use identifiers, e.g.:
tags: room: bedroom
Step 5: Configuration file test¶
mqtt2influxdb -c /etc/hardwario/mqtt2influxdb.yml --test
Step 6: Start the MQTT to InfluxDB service¶
pm2 start `which python3` --name "mqtt2influxdb" -- `which mqtt2influxdb` -c /etc/hardwario/mqtt2influxdb.yml
Step 7: Save the PM2 state (so it will start after reboot)¶
If you want to see temperature records from the database in CSV format, use this command:
influx -database node -execute "select * from temperature;" -format csv
Then you must restart the service when you change the configuration file
pm2 restart mqtt2influxdb
Configuration file structure and possibilities¶
In Step 4 we paste the configuration file, here will be described possibilities in the configuration. In configuration you can use JSONPath. For example in measurement you can identify tag id from MQTT topic by syntax $.topic as you can see in Step 4.
MQTT part of the configuration file is where you define a connection to MQTT broker.
mqtt2influxdb supports secured connection! This section is required.
1 2 3 4 5 6 7 8
mqtt: host: MQTT Broker adress (required) port: MQTT Broker port (required) username: Username to secured MQTT broker (optional) password: Users password to secured MQTT broker (optional) cafile: CA to secured MQTT broker (optional) certfile: Certificate to secured MQTT broker (optional) keyfile: Certificate Key file to secured MQTT broker (optional)
You can define web hooks so data can be posted to your endpoint. This section is optional.
1 2 3 4 5
http: destination: Endpoint url (required) action: Request type (required) username: Username for secured request (optional) password: Password for secured request (optional)
An important part of the config is of course the definition of InfluxDB connection. This section is required.
1 2 3 4 5 6 7
influxdb: host: InfluxDB adress (required) port: InfluxDB port (required) database: Database name (required) username: Username to InfluxDB (optional) password: Users password to InfluxDB (optional) ssl: SSL connection (optional)
Decode base64 messages. This section is optional.
1 2 3
base64decode: source: base64 coded message (required) target: encoded message (required)
Points section is where you define messages you want to store in database. This section is required.
1 2 3 4 5 6 7
points: measurement: Measurement name in database (required) topic: Define MQTT topic where messages are posting to (required) httpcontent: Define payload in http request if filled in HTTP chapter (optional) fields: value: Value field in InfluxDB (required) type: Variable type (required)
For every measurement you can define specific database name. This field is optional.
database: Specific database to store measurement (optional)