Giter VIP home page Giter VIP logo

mmm-fhem's Introduction

Module: MMM-FHEM

This MagicMirror module, shows values like temperature/humidity of FHEM devices.

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.

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: {
      deviceNames: [
                    'FhemDeviceName1',
                    'FhemDeviceName2',
                    'FhemDeviceName3',
                   ],
      deviceReadings: [
                        { name: 'temperature', icon: 'wi wi-thermometer', suffix: '°' },
                        { name: 'humidity', icon: 'wi wi-humidity', suffix: '%' },
                      ],
    },
  },
]

Configuration options

The following properties can be configured:

	<tr>
		<td><code>host</code></td>
		<td>Hostname/IP of the FHEM Server.  
    Is only necessary, if FHEM and Magic-Mirror is <u>not</u> on the same machine (Raspberry Pi).
    <br>
			<br>
    <b>Possible values:</b> <code>localhost</code> or a IP
    <br>
			<b>Default value:</b> <code>localhost</code>
		</td>
	</tr>

	<tr>
		<td><code>port</code></td>
		<td>FHEM Port
    <br>
    <br>
    <b>Possible values:</b> any number
    <br>
			<b>Default value:</b> <code>8083</code>
		</td>
	</tr>

<tr>
		<td><code>deviceNames</code></td>
		<td>Array of FHEM device names.
    <br>
    Go to the FHEM Web-UI, find the device under Unsorted or another room and find <code>NAME</code> under <code>Internals</code>.
    <br>
    <b>Required</b>
    <br>
			<br>
    <code>['...','...','...']</code>
		</td>
	</tr>

<tr>
		<td><code>deviceReadings</code></td>
		<td>Array with Objects of the FHEM device readings name, icon, and suffix.
    <br>
			<br>
    <b>name:</b> Name of the Reading (Required)
    <br>
    <b>icon:</b> 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)
    <br>
    <b>suffix:</b> any string/text
    <br>
    <br>
    <code>
    [
      { name: 'temperature', icon: 'wi wi-thermometer', suffix: '&deg;' },
      { name: 'humidity', icon: 'wi wi-humidity', suffix: '%' },
    ]
    </code>
		</td>
	</tr>

<tr>
		<td><code>initialLoadDelay</code></td>
		<td>The initial delay before loading. (Milliseconds)
    <br>
			<br>
    <b>Default value:</b> <code>1000</code> 1 second
		</td>
	</tr>

<tr>
		<td><code>updateInterval</code></td>
		<td>How often does the content should to be updated? (Milliseconds)
    <br>
    <br>
    <b>Possible values:</b> <code>1000</code> 1 second - <code>86400000</code> 24 hours
    <br>
			<b>Default value:</b> <code>60000</code> 1 minute
		</td>
	</tr>

</tbody>
Option Description

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.