Skip to content

MichMich/mmm-systemtemperature

Repository files navigation

Module: MMM-SystemTemperature

This MagicMirror modules allows you to show your processor temperature on you mirror. It also allows to safely shutdown the Raspberry Pi using MMM-Remote-Control if you configure it.

Installation

In your terminal, go to your MagicMirror's Module folder:

cd ~/MagicMirror/modules

Clone this repository:

git clone https://github.com/MichMich/mmm-systemtemperature.git

Install dependencies:

npm install

Configure the module in your config.js file.

Using the module

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

modules: [
	{
		module: 'mmm-systemtemperature',
		position: 'top_center',	// This can be any of the regions.
		classes: 'small dimmed', // Add your own styling. Optional.
		config: {
			// See 'Configuration options' for more information.
		}
	}
]

Configuration options

The following properties can be configured:

Option Description
prependString The text that will be shown before the temperature.
Default value: 'System temperature: '
updateInterval How often does the content needs to be fetched? (Milliseconds)
Possible values: 1000 - 86400000
Default value: 5000 (5 seconds)
animationSpeed Speed of the update animation. (Milliseconds)
Possible values: 0 - 5000
Default value: 0 (animation off)
unit Temperature unit of measurement
Possible values: c (Celsius), f (fahrenheit), k (Kelvin)
Default value: c (Celsius)
warning Specific config for warning state
Possible values: { temp: 0-999, color: '#HEX', command: Object }
Default value: { temp: 60, color: 'orange', command: undefined }
critical Specific config for critical state
Possible values: { temp: 0-999, color: '#HEX', command: Object }
Default value: { temp: 75, color: 'red', command: { notification: 'REMOTE_ACTION', payload: { action: 'SHUTDOWN' } } }
NOTE: The REMOTE_ACTION notification (SHUTDOWN and MONITOROFF) actions require the MMM-Remote-Control module to be installed.

About

Display the temperature of your Raspberry Pi on your Magic Mirror.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 9