Git Product home page Git Product logo

mmm-systemstats's Introduction

Module: MMM-SystemStats

This MagicMirror modules, shows the processor temperature, system load and available RAM.

Magic-Mirror Module MMM-SystemStats screenshot

Tested with:

  • Raspberry Pi

Dependencies

Installation

Navigate into your MagicMirror's modules folder:

cd ~/MagicMirror/modules

Clone this repository:

git clone https://github.com/BenRoe/MMM-SystemStats

Navigate to the new MMM-SystemStats folder and install the node dependencies.

cd MMM-SystemStats/ && npm install

Configure the module in your config.js file.

Update the module

Navigate into the MMM-SystemStats folder with cd ~/MagicMirror/modules/MMM-SystemStats and get the latest code from Github with git pull.

If you haven't changed the modules, this should work without any problems. Type git status to see your changes, if there are any, you can reset them with git reset --hard. After that, git pull should be possible.

Using the module

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

modules: [
	{
		module: 'MMM-SystemStats',
		position: 'top_center', // This can be any of the regions.
		classes: 'small dimmed', // Add your own styling. Optional.
		config: {
			updateInterval: 10000,
			animationSpeed: 0,
			align: 'right', // align labels
			//header: 'System Stats', // This is optional
			units: 'metric', // default, metric, imperial
		},
	},
]

Configuration options

The following properties can be configured:

	<tr>
		<td><code>align</code></td>
		<td>Align the labels.
			<br><b>Possible values:</b> <code>left</code> or <code>right</code>
			<br><b>Default value:</b> <code>right</code>
		</td>
	</tr>
	<tr>
		<td><code>useSyslog</code></td>
		<td>log event to MMM-syslog?
			<br><b>Default value:</b> <code>false</code>
		</td>
	</tr>
	<tr>
		<td><code>thresholdCPUTemp</code></td>
		<td>upper-threshold for CPU Temp. If CPU Temp is more than this value, log to MMM-syslog if useSyslog=true. (celcius)
			<br><b>Default value:</b> <code>75</code>
		</td>
	</tr>
	<tr>
		<td><code>baseURLSyslog</code></td>
		<td>URL base of <a href="https://github.com/paviro/MMM-syslog">MMM-syslog module</a>
			<br><b>Default value:</b> <code>http://127.0.0.1:8080/syslog</code>
		</td>
	</tr>
</tbody>
Option Description
updateInterval How often does the content needs to be fetched? (Milliseconds)
Possible values: 1000 - 86400000
Default value: 10000 (10 seconds)
animationSpeed Speed of the update animation. (Milliseconds)
Possible values: 0 - 5000
Default value: 0 (animation off)
language language id for text can be different from MM.
Default value: config.language
units What units to use.
Possible values: config.units = Specified by config.js, default = Kelvin, metric = Celsius, imperial = Fahrenheit
Default value: config.units

ToDo

  • icons
  • sd-card available space
  • better indication for the system load

mmm-systemstats's People

Contributors

benroe avatar bruce17 avatar flyingchipmunk avatar slametps avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.