Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rainu/mqtt-executor
A simple MQTT client written in go that subscribes to a configurable list of MQTT topics on the specified broker and executes a given shell script/command whenever a message arrives.
https://github.com/rainu/mqtt-executor
arm command customizable homeassistant iot linux mqtt mqtt-client platform-independent windows
Last synced: 4 months ago
JSON representation
A simple MQTT client written in go that subscribes to a configurable list of MQTT topics on the specified broker and executes a given shell script/command whenever a message arrives.
- Host: GitHub
- URL: https://github.com/rainu/mqtt-executor
- Owner: rainu
- License: mit
- Created: 2020-05-03T15:33:27.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2022-11-23T16:19:18.000Z (about 2 years ago)
- Last Synced: 2024-10-01T05:20:57.394Z (4 months ago)
- Topics: arm, command, customizable, homeassistant, iot, linux, mqtt, mqtt-client, platform-independent, windows
- Language: Go
- Size: 41 KB
- Stars: 11
- Watchers: 4
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# mqtt-executor
A simple MQTT client written in go that subscribes to a configurable list of MQTT topics on the specified broker and
executes a given shell script/command whenever a message arrives. Furthermore you can define commands that are executed
in a configurable interval. This can be useful for sensor data. Also this application supports [Homeassitant](https://www.home-assistant.io)
[mqtt descovery](https://www.home-assistant.io/docs/mqtt/discovery/).
# Get the Binary
You can build it on your own (you will need [golang](https://golang.org/) installed):
```bash
go build -a -installsuffix cgo ./cmd/mqtt-executor/
```
Or you can download the release binaries: [here](https://github.com/rainu/mqtt-executor/releases/latest)
# Configuration
Create a configuration file named "config.json"
```json5
{
"availability": {
"topic": "tele/__DEVICE_ID__/status",
"payload": {
"available": "On",
"unavailable": "Off"
}
},
"trigger": [{
"name": "Touch file",
"topic": "cmnd/touch/file",
"command": {
"name": "/usr/bin/touch",
"arguments": ["/tmp/example"]
}
}],
"sensor": [{
"name": "Free Memory",
"topic": "tele/__DEVICE_ID__/memory/free",
"retained": false,
"unit": "kB", //used for hassio
"icon": "hass:eye", //used for hassio
"interval": "10s",
"command": {
"name": "/bin/sh",
"arguments": [
"-c",
"cat /proc/meminfo | grep MemFree | cut -d\\: -f2 | sed 's/ //g' | grep -o [0-9]*"
]
}
}],
"multi_sensor": [{
"topic": "tele/__DEVICE_ID__/stats",
"retained": false,
"interval": "10s",
"command": {
"name": "/bin/sh",
"arguments": [
"echo",
"{\"mem\":1, \"cpu\":2}"
]
},
"values": [{
"name": "Memory",
"unit": "kB", //used for hassio
"icon": "hass:eye", //used for hassio
"template": "{{value_json.mem}}" //used for hassio
},{
"name": "CPU",
"unit": "%", //used for hassio
"icon": "hass:eye", //used for hassio
"template": "{{value_json.cpu}}" //used for hassio
}]
}]
}
```
# Usage
Start the tool with the path to the config file and the URL of the MQTT broker
```bash
mqtt-executor -broker tcp://127.0.0.1:1883 -config /path/to/config.json
```
Enable the Homeassitant discovery support
```bash
mqtt-executor -broker tcp://127.0.0.1:1883 -config /path/to/config.json -home-assistant
```
## Trigger command execution
To execute a trigger:
```bash
mosquitto_pub -t cmnd/touch/file -m "START"
```
To interrupt a trigger
```bash
mosquitto_pub -t cmnd/touch/file -m "STOP"
```
Read the trigger state:
```bash
mosquitto_sub -t cmnd/touch/file/STATE
```
* RUNNING -> the command is running
* STOPPED -> the command has (not) been executed
Read the trigger result (command's output):
```bash
mosquitto_sub -t cmnd/touch/file/RESULT
```
### Get the trigger results
Read the trigger state:
```bash
mosquitto_sub -t cmnd/touch/file/STATE
```
* RUNNING -> the command is running
* STOPPED -> the command has (not) been executed
Read the trigger result (command's output):
```bash
mosquitto_sub -t cmnd/touch/file/RESULT
```
## Get the (multi) sensor results
Read the trigger state:
```bash
mosquitto_sub -t tele/+/memory/free
```