Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/akeil/mqtt-dbus-notify
D-Bus notifcations from MQTT messages with Go
https://github.com/akeil/mqtt-dbus-notify
dbus desktop-notifications linux-desktop mqtt
Last synced: 26 days ago
JSON representation
D-Bus notifcations from MQTT messages with Go
- Host: GitHub
- URL: https://github.com/akeil/mqtt-dbus-notify
- Owner: akeil
- Created: 2017-01-29T11:10:49.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2017-03-06T22:43:07.000Z (over 7 years ago)
- Last Synced: 2024-09-29T15:43:18.239Z (about 1 month ago)
- Topics: dbus, desktop-notifications, linux-desktop, mqtt
- Language: Go
- Size: 31.3 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# MQTT to D-Bus Notifications
This is a small program which can subscribe to one ore more
[MQTT](http://mqtt.org/) topics and publish them as desktop notifications via
[D-Bus](https://www.freedesktop.org/wiki/Software/dbus/).
The program is intended to run in the background of a desktop session
and generate desktop notifications from MQTT messages.
## Requirements
- A running MQTT message broker (e.g. [Mosquitto](https://mosquitto.org/)).
- A Linux desktop environment which supports notifications
and which publishes a D-Bus interface for creating notifications
## Installation
The only option right no is to install from source.
First, [Install Go](https://golang.org/doc/install).
Next, Install Go dependencies:
- [Go bindings for D-Bus](github.com/godbus/dbus)
- [Go MQTT client](https://github.com/eclipse/paho.mqtt.golang)
```
$ go get github.com/godbus/dbus
$ go get github.com/eclipse/paho.mqtt.golang
```
Next, install the mqtt-dbus-notify app:
```
$ go install github.com/akeil/mqtt-dbus-notify
```
## Configuration
The configuration file is expected at `$HOME/.config/mqtt-dbus-notify.json`.
A sample configuration looks like this:
```json
{
"host": "localhost",
"port": 1883,
"username": "",
"password": "",
"secure": false,
"timeout": 5,
"icon": "dialog-information",
"subscriptions": [
{
"topic": "calendar/alert",
"icon": "appointment-soon",
"title": "Appointment",
"body": "{{.}}"
},
{
"topic": "test/notify",
}
]
}
```
Aside from the `subscriptions`, these are also the default values.
If the MQTT broker is running on the same computer on the default port (`1883`)
and without authentication, no configuration is required.
The `secure` option uses a TLS encrypted connection, usually over port `8883`.
### Subscriptions
To generate notifications, one or more *Subscriptions* need to be configured.
A subscription must at least specify one `topic `.
[Topic wildcards](https://docs.oasis-open.org/mqtt/mqtt/v3.1.1/os/mqtt-v3.1.1-os.html#_Toc398718107)
can be used.
A subscription can also specify a custom `icon`. If none is specified,
the default icon will be used (see below).
By default, the body of the MQTT message is used as the title for the
notification. If the message consists of multiple lines, the first line is used
as the title and the remaining lines as the body.
### Templates for Title and Body
A subscription can have a customized `title` and `body`.
These are [Go templates](https://golang.org/pkg/text/template/).
Use `{{.}}` to refer to the MQTT message payload.
Within the title and body template, the `Topic` function can be used to
return a part of the MQTT topic.
For example:
```json
...
"topic": "weather/berlin/temperature"
"title": "{{.Topic 2}} in {{.Topic 1}}"
...
```
This will display "temperature in berlin" as the notification title.
### Icons
Icons can be specified using
[standard icon names](https://specifications.freedesktop.org/icon-naming-spec/icon-naming-spec-latest.html)
like "appointment-soon".
Look at the directory structure below `/usr/share/icons/` to see which icons
are available.
Alternatively, the absolute path to an image file can be used as an `icon`.
like this:
```json
{
"topic": "my/topic",
"icon": "/home/yourname/myicon.png"
}
```
## Running
The program needs to run within the context of a desktop session.
Otherwise, it would not be able to publish notifications.
A simple way to do this is to create a `mqtt-dbus-notify.desktop` file
and place it in `$HOME/.config/autostart`.
```ini
[Desktop Entry]
Name=MQTT-DBus-Notify
Comment=Desktop notifications from MQTT messages
NoDisplay=false
Exec=$GOHOME/bin/mqtt-dbus-notify
Type=Application
Categories=Accessoires;
```
Most (all?) Desktop Environments should support this and run the command
listed under `Exec` when you log into the DE.