MMM-FHEM

KO | EN

gitlite — search

#python #java #python3 #arduino #golang #machine-learning #rust #html #flask #javascript #seismology #nodejs

★ 12 Open GitHub ↗

A module for the MagicMirror, to display data from FHEM devices.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Module: MMM-FHEM
This [MagicMirror](https://github.com/MichMich/MagicMirror) module, shows values like temperature/humidity of [FHEM](http://fhem.de) devices.

## &#x1F534; This repository is no longer maintained.
__If you are interested to maintain this project, please contact me and i will add you to this repository.__

![Magic-Mirror Module MMM-FHEM screenshot](https://github.com/BenRoe/MMM-FHEM/blob/gh-pages/Screenshot1.png?raw=true)
![Magic-Mirror Module MMM-FHEM screenshot](https://github.com/BenRoe/MMM-FHEM/blob/gh-pages/Screenshot2.png?raw=true)

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

## Installation

Navigate into your MagicMirror's `modules` folder:
```
cd ~/MagicMirror/modules
```

Clone this repository:
```
git clone https://github.com/BenRoe/MMM-FHEM
```

Navigate to the new `MMM-FHEM` folder and install the node dependencies.
```
npm install
```

Configure the module in your `config.js` file.

## Update the module

Navigate into the `MMM-FHEM` folder with `cd ~/MagicMirror/modules/MMM-FHEM` 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-FHEM',
    position: 'bottom_bar',
    config: {
      host: 'localhost',
      port: '8083',
      https: false,
      devices: [
                  { deviceName: 'FhemDeviceName1',
                    deviceReadings: [
                                      { name: 'temperature', icon: 'wi wi-thermometer', suffix: '&deg;' },
                                      { name: 'humidity', icon: 'wi wi-humidity', suffix: '%' },
                                    ],
                  },
                  { deviceName: 'FhemDeviceName2',
                    deviceReadings: [
                                      { name: 'temperature', icon: 'wi wi-thermometer', suffix: '&deg;' },
                                      { name: 'battery', icon: 'fa fa-battery-half', suffix: '' },                                      
                                    ],
                  },
                ],
    },
  },
]
```

## 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>host</code></td>
			<td>Hostname/IP of the FHEM Server.
 Is only necessary, if FHEM and Magic-Mirror is not on the same machine (Raspberry Pi). 
 Possible values: <code>localhost</code> or a IP 
			Default value: <code>localhost</code>
			</td>
		</tr>
		<tr>
			<td><code>port</code></td>
			<td>FHEM Port 
 Possible values: any number 
 Default value: <code>8083</code>
			</td>
		</tr>
 <tr>
			<td><code>https</code></td>
			<td>If your FHEM use https 
 Possible values: <code>true</code> or <code>false</code> 
 Default value: <code>false</code>
			</td>
		</tr>
 <tr>
			<td><code>devices</code></td>
			<td>Array of objects. Object for the different FHEM devices.
<pre><code>
{ deviceName: 'FhemDeviceName1',
 deviceReadings: [
 { name: 'temperature', icon: 'wi wi-thermometer', suffix: '&deg;' },
 { name: 'humidity', icon: 'wi wi-humidity', suffix: '%' },
 ],
},
</code></pre>
 deviceName: Go to the FHEM Web-UI, find the device under Unsorted or another room and find <code>NAME</code> under <code>Internals</code>.
 
 deviceReadings: array of objects for the device readings you want to display.
 
 name: Name of the Reading (Required)
 
 icon: CSS class of an icon (<a href="http://fontawesome.io/icons/">Font-Awesome</a> and <a href="https://erikflowers.github.io/weather-icons/">Weather Icons</a> are pre installed)
 
 suffix: any string/text
 </td>
		</tr>
 <tr>
			<td><code>initialLoadDelay</code></td>
			 <td>The initial delay before loading. (Milliseconds) 
 Default value: <code>1000</code> (1 second)
			</td>
 </tr>
 <tr>
			<td><code>updateInterval</code></td>
			<td>Content update interval in Milliseconds. 
 Possible values: <code>1000</code> (1 second) to <code>86400000</code> (24 hours) 
			 Default value: <code>60000</code> (1 minute)
			</td>
		</tr>
	</tbody>
</table>

MMM-FHEM

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README