Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/BenRoe/MMM-FHEM
A module for the MagicMirror, to display data from FHEM devices.
https://github.com/BenRoe/MMM-FHEM
Last synced: about 2 months ago
JSON representation
A module for the MagicMirror, to display data from FHEM devices.
- Host: GitHub
- URL: https://github.com/BenRoe/MMM-FHEM
- Owner: BenRoe
- License: mit
- Created: 2016-09-24T22:16:01.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2019-10-28T16:57:07.000Z (about 5 years ago)
- Last Synced: 2024-08-04T10:03:30.345Z (5 months ago)
- Language: JavaScript
- Size: 43.9 KB
- Stars: 10
- Watchers: 10
- Forks: 14
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-mmm - **MMM-FHEM**
README
# Module: MMM-FHEM
This [MagicMirror](https://github.com/MichMich/MagicMirror) module, shows values like temperature/humidity of [FHEM](http://fhem.de) devices.
## 🔴 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.__
## 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: '°' },
{ name: 'humidity', icon: 'wi wi-humidity', suffix: '%' },
],
},
{ deviceName: 'FhemDeviceName2',
deviceReadings: [
{ name: 'temperature', icon: 'wi wi-thermometer', suffix: '°' },
{ name: 'battery', icon: 'fa fa-battery-half', suffix: '' },
],
},
],
},
},
]
```
## Configuration options
The following properties can be configured:
Option
Description
host
Hostname/IP of the FHEM Server.
Is only necessary, if FHEM and Magic-Mirror is not on the same machine (Raspberry Pi).
Possible values: localhost or a IP
Default value: localhost
port
FHEM Port
Possible values: any number
Default value: 8083
https
If your FHEM use https
Possible values: true or false
Default value: false
devices
Array of objects. Object for the different FHEM devices.
{ deviceName: 'FhemDeviceName1',
deviceReadings: [
{ name: 'temperature', icon: 'wi wi-thermometer', suffix: '°' },
{ name: 'humidity', icon: 'wi wi-humidity', suffix: '%' },
],
},
deviceName: Go to the FHEM Web-UI, find the device under Unsorted or another room and find NAME under Internals.
deviceReadings: array of objects for the device readings you want to display.
name: Name of the Reading (Required)
icon: CSS class of an icon (Font-Awesome and Weather Icons are pre installed)
suffix: any string/text
initialLoadDelay
The initial delay before loading. (Milliseconds)
Default value: 1000 (1 second)
updateInterval
Content update interval in Milliseconds.
Possible values: 1000 (1 second) to 86400000 (24 hours)
Default value: 60000 (1 minute)