A MagicMirror² module that creates an MQTT device with Home Assistant autodiscovery.

Note: This module was greatly inspired by MMM-Remote-Control.

Example: MagicMirror entities in Home Assistant

When the MagicMirror starts, the first browser client to load the module will establish the MQTT connection and handle all communication with Home Assistant. This ensures only one active MQTT connection per MagicMirror instance, even if multiple browsers are open.

The module uses MQTT autodiscovery to automatically create entities in Home Assistant, allowing you to control your MagicMirror from the Home Assistant dashboard or automations without manual configuration.

• MQTT device integration with Home Assistant via autodiscovery
• Control MagicMirror monitor (on/off)
• Adjust MagicMirror brightness
• Control visibility of individual MagicMirror modules as switches
• Restart MagicMirror process via Home Assistant
• Execute custom bash commands/scripts via Home Assistant

In your terminal, go to your MagicMirror² Module folder and clone MMM-HomeAssistant:

cd ~/MagicMirror/modules
git clone https://github.com/ambarusa/MMM-HomeAssistant/
cd MMM-HomeAssistant
npm install

cd ~/MagicMirror/modules/MMM-HomeAssistant
git pull
npm install

To use this module, add it to the modules array in the config/config.js file:

{
    module: 'MMM-HomeAssistant',
    config: {
        mqttServer: 'mqtt://localhost',
        mqttPort: 1883,
        username: 'mqtt_username',
        password: 'mqtt_password',
        deviceName: 'My MagicMirror',
        autodiscoveryTopic: 'homeassistant',
        monitorControl: true,
        brightnessControl: true,
        moduleControl: true,
        monitorStatusCommand: 'xrandr --query | awk \'/Screen/ {print ($8 > 320) ? "true" : "false"}\'',
        monitorOnCommand: 'xrandr -d :0 --output HDMI-1 --auto --rotate right',
        monitorOffCommand: 'xrandr -d :0 --output HDMI-1 --off',
        pm2ProcessName: 'mm',
        refreshBrowser: true,
        customCommands: [
            {
                name: 'Update MagicMirror',
                command: 'bash ~/MagicMirror/modules/MMM-HomeAssistant/custom_commands/update_MM.sh'
            }
        ]
    }
},

Using Wayland, the xrandr commands to pull monitor status and control on/off do not work. Replace the following in the 'config/config.js' file to use with wayland.

        monitorStatusCommand: 'wlr-randr | awk \'/HDMI-A-2/ {found=1} found && /Enabled:/ {print ($2 == "yes") ? "true" : "false"; exit} END {if(!found) print "false"}\'',
        monitorOnCommand: 'wlr-randr --output HDMI-A-2 --on',
        monitorOffCommand: 'wlr-randr --output HDMI-A-2 --off',

Example config for a Raspberry Pi 4B running MagicMirror server and client with PM2

Entities will appear automatically in Home Assistant if MQTT autodiscovery is enabled. You can control your MagicMirror from the Home Assistant dashboard or automations.

You can define custom bash commands or scripts that Home Assistant can trigger. Each command will appear as a button entity in Home Assistant.

The sample script at custom_commands/update_MM.sh performs a full MagicMirror update cycle with logging and safety checks. In short, it:

• Rotates its log every 5 runs and writes to custom_commands/update_MM.log.
• Uses a lock file to prevent concurrent runs.
• Updates the MagicMirror base repo with git pull, then runs npm run install-mm if changes were pulled.
• Updates every MMM-* module under modules/ with git pull and npm install when needed.
• Restarts MagicMirror with pm2 restart if updates were applied (configurable via PM2_PROCESS_NAME, default mm).

Notes:

• The script does a git reset --hard HEAD in the base repo and in each module to avoid conflicts. If you keep local changes, they will be discarded.
• You can pass a MagicMirror path as the first argument; otherwise it defaults to ~/MagicMirror.
• If pm2 is not installed, the script will skip restart and log a reminder.

Add a customCommands array to your config:

customCommands: [
  {
    name: 'Update MagicMirror',
    command: 'bash ~/MagicMirror/modules/MMM-HomeAssistant/custom_commands/update_MM.sh'
  },
  {
    name: 'Say Hello',
    command: 'echo "Hello from MagicMirror!"'
  }
]

• Open your browser's developer console to check for JavaScript errors or warnings.
• Check the MagicMirror logs for errors or warnings (run npm start npm run server or pm2 restart xx; pm2 logs xx from your MagicMirror directory and watch the terminal output).
• Use MQTT Explorer or a similar tool to easily investigate MQTT messages and topics.
• Optionally, you can temporarily change the autodiscoveryTopic in your config to something like debug to see what messages are intended to be sent for Home Assistant autodiscovery.

• npm install - Install devDependencies like ESLint.
• npm run lint - Run linting and formatter checks.
• npm run lint:fix - Fix linting and formatter issues.