Skip to content

Latest commit

 

History

History
75 lines (54 loc) · 2.86 KB

README.md

File metadata and controls

75 lines (54 loc) · 2.86 KB
Raw

MqttSql

A simple .Net Core Windows/systemd service that subscribes to MQTT brokers and writes the messages into a local SQLite database.

Configuration

The service will look for a config.json file in the same directory with the executable. A sample of the configuration file:

[
 {
   "host": "192.168.0.101",
   "port": 1883,
   "user": "user1",
   "password": "password1",
   "topic": "some/topic/1",
   "table": "table1"
 },
 {
   "host": "192.168.0.102",
   "port": 1883,
   "user": "user2",
   "password": "password2",
   "topic": "some/topic/2",
   "table": "table2"
 }
]

Where table is the name of the table to create and write to in the SQLite database. The database will also be placed in the same directory with the name database.sqlite.

Installation

Make sure that .Net Core 3.1 or higher is installed. Example for Ubuntu 20.04:

wget https://packages.microsoft.com/config/ubuntu/20.04/packages-microsoft-prod.deb -O packages-microsoft-prod.deb
sudo dpkg -i packages-microsoft-prod.deb
sudo rm packages-microsoft-prod.deb
sudo apt update
sudo apt install -y dotnet-runtime-3.1=3.1.21-1

This project uses Topshelf to manage the Windows service. The Linux systemd installation will be the same as with Topshelf.

To install the service, open an elevated shell window and navigate to the directory with the executable, for example:

cd "C:\Program Files\MqttSql for Windows and cd ~/MqttSql for Linux.

And run the executable with install and start arguments, for example:

.\MqttSql.exe install start for Windows and sudo ./MqttSql install --user user1 start for Linux, where -u or --user arguments can be used to set the user the service should run with (default root).

To unregister and uninstall the service, run the executable with the uninstall argument, for example:

.\MqttSql.exe uninstall for Windows and sudo ./MqttSql uninstall for Linux.

Alternatively on Windows, you can use the Extractor tool included in the project, which will put all the necesary files into the target directory, install the .Net Core runtime if necesary and install the service.

GPLv3 License

Copyright (C) 2024 Guiorgy

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see https://www.gnu.org/licenses/.