https://github.com/kollokollo/MQTT-Hyperdash
A fast MQTT dashboard application and rule engine framework written in C for Linux, Raspberry Pi and WINDOWS.
https://github.com/kollokollo/MQTT-Hyperdash
cockpit control-systems dashboard dashgen-naming-conventions internet-of-things iot linux monitoring mqtt mqtt-hyperdash raspberry-pi rule-engines smarthome
Last synced: 13 days ago
JSON representation
A fast MQTT dashboard application and rule engine framework written in C for Linux, Raspberry Pi and WINDOWS.
- Host: GitHub
- URL: https://github.com/kollokollo/MQTT-Hyperdash
- Owner: kollokollo
- License: gpl-2.0
- Created: 2019-12-19T15:29:55.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2022-02-09T07:14:55.000Z (almost 4 years ago)
- Last Synced: 2023-02-27T16:28:24.479Z (almost 3 years ago)
- Topics: cockpit, control-systems, dashboard, dashgen-naming-conventions, internet-of-things, iot, linux, monitoring, mqtt, mqtt-hyperdash, raspberry-pi, rule-engines, smarthome
- Language: C
- Homepage:
- Size: 5.91 MB
- Stars: 8
- Watchers: 1
- Forks: 2
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: COPYING
Awesome Lists containing this project
- awesome-mqtt - MQTT-Hyperdash - A universal independent MQTT Dashboard for Linux/Raspberry Pi. (Visualization, Dashboards / Misc)
README
## MQTT-Hyperdash
(C) 2019-2021 by Markus Hoffmann
A universal MQTT dashboard and rule engine framework.
Version : 1.03
License : GPLv2
Description :
MQTT-Hyperdash is a fast and efficient dashboard (GUI) for the MQTT framework.
It uses the SDL library for graphics rendering, the paho.mqtt.c library for
communication and the gtk2 framework for user input.
The dashboard runs on Linux, but a port to other operating systems is possible.
Special features:
* Very simple and basic set of base elements.
* animated analog input elements, potentiometers.
* Fast update rates of 20 Hz are possible.
* Easy to use: Each panel/dashboard is configured in a single .dash file.
This repository contains following set of applications:
#### hyperdash
hyperdash runs a panel/dashboard, which has been defined in a dash file. It
opens a window, draws all elements, updates with each new topic message and
takes user input with the mouse to manipulate topics contents.
A description of the [dash file format](doc/MQTT-Hyperdash-file-format.md) can
be found in the doc/ section.
#### dashdesign (HyperDash Dashboard Designer)
Dashdesign is a graphical tool to create and edit the .dash files.
A brief explanation how to use dashdesign is in its man-page
[dashdesign man-page](src/dashdesign.1).
The usage with the graphical interface should be more or less self-explanatory.
But maybe you want to have a look at its
[user manual](doc/MQTT-dashdesign-user-manual.md).
#### hddashgen (HyperDash Dashboard-Generator)
Making dashboard files by hand with a text editor can be a lot of annoying
manual work. To help this, there is the tool hddashgen to automatically create
dash files from topic lists, so one has a good starting point to work with.
hddashgen will do this job in combination with mqtt-list-topics (see below).
The default appearance is derived from the topics names, if they follow a
naming convention. The naming convention used is explained in
[Dashgen Naming Conventions](doc/MQTT-dashgen-naming-conventions.md).
A brief explanation how to use hddashgen is in its man-page
[hddashgen man-page](src/hddashgen.1).
#### mqtt-list-topics
A tool to connect to a mqtt broker and list all topics available there to
stdout.
mqtt-list-topics also performs a brief analysis on the topics content to
classify the topic into binary, string, number, and integer. This
classification is not perfect, since it is based on a single payload value only,
but it can help making automatic dashboards for MQTT-Hyperdash.
A good starting point for the usage of mqtt-list-topics is its man-page
[mqtt-list-topics man-page](src/mqtt-list-topics.1).
#### rule-engine sysmeasure and syslogger
Rule engines are meant to be applications running completely in the background.
They do not interact directly with user. Their function is to subscribe to a
set of topics, watch their updates and trigger a routine, which calculates
something based on the input topics and finally publish the result to output
topics, which then can trigger other rules or rule engines. They also can
perform actions on the machine they are running, like executing shell scripts
when a topic content matches a certain pattern, or perform measurements by
accessing local hardware components and publish the results to the mqtt network.
With multiple rule engines running even on different computers using the same
broker, one can implement a full automation control, which would create the
Internet of Things.
The concept of rule engines is not new and can be found in other automation
concepts as well. This implementation is focused on high performance quick
reaction, and reliability. And the realization is not very complicated. Please
read the the [rule engine howto](doc/MQTT-rule-engine-howto.md) in
the doc/ section.
#### mqtt2serial
mqtt2serial connects to a mqtt broker and a serial (tty) device. This is
a generic application (similar to the rule engine framework) to asynchronoulsy
pass mqtt content to a serial line, and also accept asynchronously content from
that line.
This way, an arduino could be easily hooked to the serial line and pass its
values and accept commands from it.
A good starting point for the usage of mqtt2serial is its man-page
[mqtt2serial man-page](src/mqtt2serial.1).
## Remarks
The project is not complete. Please see the file
[CONTRIBUTING.md](CONTRIBUTING.md) how you can help to improve the project.
I had the impression, an application like this was still missing in 2019.
So I started this project. Please let me know, if I am right....
Also I am thinking of a
[MQTT payload convention](doc/MQTT-Hyperdash-payload-conventions.md)
. This could be a field for discussions. Please feel free to join.
## Installation
### Preparation
First you should make sure, that all necessary packages are installed.
In doubt, do a
sudo apt-get install libsdl-gfx1.2-dev libsdl1.2-dev libsdl-ttf2.0-dev
sudo apt-get install libgtk2.0-dev
Also, it is essential, that the eclipse paho library
(for the MQTT communication) is installed.
Here is their homepage: https://www.eclipse.org/paho/
You will need the "C client library". Eclipse provides a download link
and installation instructions. However, if you do not want to install
binary packages, it is totally fine to start from the git repository:
https://github.com/eclipse/paho.mqtt.c
The "Build instructions for GNU Make" worked for me. Especially you should
install the package libssl-dev.
sudo apt-get install libssl-dev
And finally, you may want to install the core set of true type fonts:
sudo apt-get install ttf-mscorefonts-installer
(If you do not have this package installed, you can still use MQTT Hyperdash,
but it would be necessary to specify an alternative font path.)
### Compilation
When this is prepared, to make MQTT-Hyperdash,
you can simply do a
cd src/
make
sudo make install
### Test run
Open a terminal and do a
hyperdash main.dash &
have fun....
## Download
There is an (inofficial) binary distribution of MQTT-Hyperdash and the paho c
library (.deb files) for 32bit linux, 64bit linux, Raspberry Pi and an alpha
version for MS WINDOWS on codeberg in the releases section. But it is highly
recommended to compile the most recent version from sources (see above).
## Screenshots
### Important Note:
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 2 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, write to the Free Software
Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
Acknowledgements
================
Thanks to all people, who helped me to realize this package.