MMM-SystemStats

KO | EN

gitlite — search

#hacktoberfest #react #golang #android #machine-learning #rust #linux #docker #macos #awesome #cli #kubernetes #pytorch #openai

MMM-SystemStats

(★ 94)

A module for the MagicMirror, to display system stats (cpu tmp, free ram, cpu load)

MMM-SystemStats Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Module: MMM-SystemStats
<img src="https://img.shields.io/badge/Maintained%3F-no-red.svg?style=flat-square">

This [MagicMirror](https://github.com/MichMich/MagicMirror) modules, shows the processor temperature, system load, available RAM, uptime and free disk space.

![Magic-Mirror Module MMM-SystemStats screenshot](https://raw.githubusercontent.com/BenRoe/MMM-SystemStats/master/screenshot.png)

Tested with:
- Raspberry Pi

## Dependencies
- An installation of [MagicMirror2](https://github.com/MichMich/MagicMirror)
- npm
- [async](https://www.npmjs.com/package/async)

## 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:
```javascript
modules: [
	{
		module: 'MMM-SystemStats',
		position: 'top_center', // This can be any of the regions.
		// classes: 'small dimmed', // Add your own styling. OPTIONAL.
		// header: 'System Stats', // Set the header text OPTIONAL
		config: {
			updateInterval: 10000, // every 10 seconds
			align: 'right', // align labels
			//header: 'System Stats', // This is optional
			units: 'metric', // default, metric, imperial
			view: 'textAndIcon',
		},
	},
]
```

## Configuration options

The following properties can be configured:

<table width="100%">
	<thead>
		<tr>
			<th>Option</th>
			<th width="100%">Description</th>
		</tr>
	</thead>
	<tbody>
		<tr>
			<td><code>updateInterval</code></td>
			<td>How often does the content needs to be fetched? (Milliseconds)
				 Possible values: <code>1000</code> - <code>86400000</code>
				 Default value: <code>10000</code> (10 seconds)
			</td>
		</tr>
		<tr>
			<td><code>animationSpeed</code></td>
			<td>Speed of the update animation. (Milliseconds)
				 Possible values: <code>0</code> - <code>5000</code>
				 Default value: <code>0</code> (animation off)
			</td>
		</tr>
		<tr>
			<td><code>language</code></td>
			<td>language id for text can be different from MM.
				 Default value: <code>config.language</code>
			</td>
		</tr>
		<tr>
			<td><code>units</code></td>
			<td>What units to use.
				 Possible values: <code>config.units</code> = Specified by config.js, <code>default</code> = Kelvin, <code>metric</code> = Celsius, <code>imperial</code> = Fahrenheit
				 Default value: <code>config.units</code>
			</td>
		</tr>
		<tr>
			<td><code>align</code></td>
			<td>Align the labels.
				 Possible values: <code>left</code> or <code>right</code>
				 Default value: <code>right</code>
			</td>
		</tr>
		<tr>
			<td><code>label</code></td>
			<td>Show text labels with icons, only text, or only icons.
				 Possible values: <code>textAndIcon</code>, <code>text</code> or <code>icon</code>
				 Default value: <code>textAndIcon</code>
			</td>
		</tr>
		<tr>
			<td><code>useSyslog</code></td>
			<td>log event to MMM-syslog?
				 Default value: <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)
				 Default value: <code>70</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>
				 Default value: <code>http://127.0.0.1:8080/syslog</code>
			</td>
		</tr>
	</tbody>
</table>

## ToDo
- better indication for the system load

MMM-SystemStats

MMM-SystemStats Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

MMM-SystemStats

MMM-SystemStats Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README