⚙ MQTT COMMANDER

A robust and easy to use MQTT rule engine

• Configure your MQTT Rules via easy to use YML Files
• Supports JSON encoded MQTT Messages
• Supports all common comparators [<,>,<=,>=,==,!=]
• Supports Cron triggered events
• Supports HTTP calls
• Supports LIVE reload of config files
• Special functions, like Timeout, reminder and auto reset of rules
• Simple Web-Dashbaord ro review the Status of your Rules

How does ist work an what can i do with it ?

The principle is simple:
a rule consists of two components: constraints and actions.
If all constraints are met, the configured actions are triggered.

Example:

  - Name: My Awesome Example Rule
    Constraints: 
      - Mqtt : sensor/temperature >= 25
    Actions:
      - Mqtt : relais/fan = 1
      - Mqtt : system/notification = "Too hot 🔥! Fan has been tunred on 🔌!"

Of course, you can make the rules more complex and use additional conditions. These are described below.

The rules are saved in ".yml" files. These are saved in the "Automations /" folder. When the software is started for the first time, an example file is created there. Sub-folders are also possible.

Changes to the files are automatically transferred to the live system. (Attention: If a ".yml" is changed, all the rules contained therein are restarted)

Getting Started:

Use one of this pre-Compiled Binarys, at the first start an order with the name "Config" is automatically created, here you will also find some sample files.

• Download: MacOS / AMD64
• Download: Linux / AMD64
• Download: Linux / ARMv5 (RaspberryPi)
• Download: Windows / AMD64

Of course, you can also start or compile the program yourself after downloading this repository.

    go run MqttCommander

When the software is started for the first time, the configuration folder structure is created in the same directory as the executable file.

Enter the URI of your MQTT server in the "config.yml" file.

After restarting the software, you will find an overview of the active automations at http://localhost:9090 🔥

Create more complex rules:

  - Name: Full Demo MQTT Automation
    Mode: AND
    Retrigger: true
    Pause: 10s
    Delay: 10s
    Reminder: 1m
    Constraints: 
      - Mqtt : demo/sensor|value <= "3" -Reset 2s  -Timeout 5s -BlockRetained 0
    Actions:
      - Mqtt : demo/actuator = 1 -Retained 0

A more detailed documentation is coming soon!