MMM-MQTTbridge
MMM-MQTTbridge allows you to integrate your MagicMirror into your smart home system via MQTT protocol and manage MagicMirror via MQTT messages by converting them into MM Notifications and vise verse - listen to your MM’s Notifications and convert them into MQTT mesages.
So, this module for MagicMirror do the following:
- Listens to MQTT messages from your MQTT broker and, if mqtt-message arrives, module sends MM Notifications based on the pre-configured mqtt-to-notification Dictionary rules.
- Listens to the MM Notifications within your MagicMirror environment. If Notification arrives, module sends MQTT message based on the preconfigured notification-to-mqtt Dictionary rules.
DOWNLOAD
CONFIG STRUCTURE
For better understanding, we have divided config into 3 sections:
- General configurations in
config.js; - “NOTIFICATION to MQTT” dictionary rules;
- “MQTT to NOTIFICATION” dictionary rules;
GENERAL SECTION
{
module: 'MMM-MQTTbridge',
disabled: false,
config: {
mqttServer: "mqtt://:@localhost:1883",
mqttConfig:
{
listenMqtt: true,
useMqttBridgeFromatOnly: false,
interval: 300000,
topicSubscr: ["home/smartmirror/bathroom/light/set", "home/smartmirror/kitchen/light/set"],
},
notiConfig:
{
listenNoti: true,
useMqttBridgeFromatOnly: false,
ignoreNotiId: ["CLOCK_MINUTE", "NEWS_FEED"],
ignoreNotiSender: ["system", "NEWS_FEED"],
},
// set "NOTIFICATIONS -> MQTT" dictionary at /dict/notiDictionary.js
// set "MQTT -> NOTIFICATIONS" dictionary at /dict/mqttDictionary.js
},
},
MQTT part
mqttServerset you server address using the following format: “mqtt://”+USERNAME+":"+PASSWORD+"@"+IPADDRESS+":"+PORT. E.g. if you are using your broker without username/password on localhost with port 1883, you config should looks “mqtt://:@localhost:1883”,listenMqtt- turn on/off the listening of MQTT messages. Set tofalseif you are going to use only NOTI->MQTT dictionary to save CPU usage;useMqttBridgeFromatOnly- you can use native MQTTbridge MQTT message format. It saves CPU usage. Native MQTT message format looks: “NOTIFICATION_ID:NOTIFICATION_PAYLOAD”. E.g. if you want to use Native format, send the MQTT message like “VOLUME_SET:20” and the module will convert it to NOTIFICATION “VOLUME:20” without Dictionary use (save CPU usage).interval- interwal for MQTT status update, default is 300000ms.topicSubscr- list of MQTT topics, to which the module will be subscribe and receive messages. :E.g.: [“home/smartmirror/bathroom/light/set”, “home/smartmirror/kitchen/light/set”],
NOTIFICATION part
listenNoti- turn on/off the listening of NOTIFICATIONS. Set tofalseif you are going to use only MQTT->NOTI dictionary to save CPU usage;useMqttBridgeFromatOnly- - you can use native MQTTbridge NOTIFICATION format. It saves CPU usage. Native NOTIFICATION format looks: “NOTI_TO_MQTT: {mqttTopic: “”, mqttPayload: “”}”. E.g. if you want to use Native format, send the NOTIFICATIONS from other MM modules like "NOTI_TO_MQTT: {mqttTopic: “home/kitchen/light/set”, mqttPayload: “{State:ON}” and the module will convert it to MQTT massage to the topic “home/kitchen/light/set” with payload “{State:ON}” without Dictionary use (save CPU usage).ignoreNotiId- list your NOTIFICATION ID that should be ignored from processing, this saves CPU usage. E.g. [“CLOCK_MINUTE”, “NEWS_FEED”],ignoreNotiSender- list your NOTIFICATION SENDERS that should be ignored from processing, this saves CPU usage. E.g. [“system”, “NEWS_FEED”]
NOTIFICATIONS to MQTT DICTIONARY SECTION
Should be set within ~/MagicMirror/modules/MMM-MQTTbridge/dict/notiDictionary.js
var notiHook = [
{
notiId: "CLOCK_SECOND",
notiPayload: [
{
payloadValue: '10',
notiMqttCmd: ["Command 1", "Command 2"]
},
{
payloadValue: '20',
notiMqttCmd: ["Command 2"]
},
{
payloadValue: '30',
notiMqttCmd: ["Command 1", "Command 2"]
},
],
},
];
var notiMqttCommands = [
{
commandId: "Command 1",
mqttTopic: "myhome/kitchen/light/set",
mqttMsgPayload: '{"state":"OFF"}'
},
{
commandId: "Command 2",
mqttTopic: "myhome/kitchen/light/set",
mqttMsgPayload: '{"state":"ON"}'
},
];
MQTT to NOTIFICATIONS DICTIONARY SECTION
Should be set within ~/MagicMirror/modules/MMM-MQTTbridge/dict/mqttDictionary.js
var mqttHook = [
{
mqttPayload: "ASSISTANT_LISTEN",
mqttNotiCmd: ["Command 1"]
},
{
mqttPayload: "ASSISTANT_SPEAK",
mqttNotiCmd: ["Command 2"]
},
{
mqttPayload: "ASSISTANT_NOTHING",
mqttNotiCmd: ["Command 1", "Command 2"]
},
];
var mqttNotiCommands = [
{
commandId: "Command 1",
notiID: "ASSISTANT_LISTEN",
notiPayload: 'BLABLABLA-1'
},
{
commandId: "Command 2",
notiID: "ASSISTANT_LISTEN",
notiPayload: 'BLABLABLA-2'
},
];
TESTED ENVIRONMENT
- Raspberry Pi 3 B+;
- Clean Updated Upgarded Raspbian Buster;
- MagicMirror ^2.10.1;
- mqtt-broker eclipse-mosquitto run in docker on the same RPi;
- mqtt-client on Windows10.
CREDITS
