Skip to content

Latest commit

 

History

History
executable file
·
142 lines (125 loc) · 4.85 KB

README.md

File metadata and controls

executable file
·
142 lines (125 loc) · 4.85 KB
Raw

Module: MMM-FHEM

This MagicMirror module, shows values like temperature/humidity of FHEM 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.

Magic-Mirror Module MMM-FHEM screenshot Magic-Mirror Module MMM-FHEM screenshot

Dependencies

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:

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)