plangdon/mmm-mqtt_display

MagicMirror Module that displays contents of a MQTT message

MMM-mqtt_display

MagicMirror² Module that displays contents of a MQTT message

Installation

1. Navigate into your MagicMirror's modules folder and execute git clone https://github.com/plangdon/MMM-mqtt_display.git. A new folder will appear, likely called MMM-mqtt_display. Navigate into it.
2. Execute npm install to install the node dependencies.

Using the module

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

modules: [
	{
		module: 'MMM-mqtt_display',
		position: 'top_right',	// This can be any of the regions. Best results in left or right regions.
		header: 'Alexa Speaks', // This is optional
		config: {
			// See 'Configuration options' for more information.
		}
	}
]

Configuration options

The following options can be configured:

Option	Description
mqttServer	Connection string for the server to connect to (mqtt://localhost)
loadingText	Text to display while waiting for data to load
topic	MQTT Topic to subscribe to on the server (alexa/mmm/display)
showTitle	Boolean to show/hide a title (default: false)
title	Title to show if showTitle is true
interval	Refresh interval, not including MQTT subscription deliveries. (default: 300000)
postText	Text to append after the data received from MQTT (default: '')

Known Limitations

• Currently only supports unencrypted/unauthenticated MQTT connections.

Dependencies

• mqtt (installed via npm install)