README.md

Module: MMM-PhilipsHue

The MMM-PhilipsHue module is a third party module for MagicMirror. It is a simple way to display the status of groups or lights in your Philips Hue setup.

Module was forked from MMM-Hue by MitchSS and updated to replace XmlHttpRequest with node-fetch.

Support

If you like my module you can support my work by giving me a star ir buy me a coffee.

Installing the Module

Navigate into your MagicMirror's modules folder and execute
git clone https://github.com/mumblebaj/MMM-PhilipsHue.git
cd ~/MagicMirror/modules/MMM-PhilipsHue/
npm install

Updates v1.2.3

• Updated the module to exclude an array of lights when either groups and lights are selected as lightsOrGroups

Dependencies

• [email protected]

Using the module

To use this module, add it to the modules array in the config/config.js file:

{
		    module: 'MMM-PhilipsHue',
		    position: 'top_right',
		    config: {
			bridgeip: "192.168.1.1", //Your Bridge IP
			userid: "my user id", //User ID created in the steps below
			colour: false
		    }
}

Please visit Philips Hue API page to get an userid.

Configuration options

The following properties can be configured:

Option	Description
bridgeip	The ip address of your Philips Hue Bridge. Type: string
userid	This is the user id created to access your Philips Hue Bridge. See here for more details - http://www.developers.meethue.com/documentation/getting-started Type: string
colour	This boolean determines whether the icons should be displayed in colour when the lights are on in a given room. Type: boolean
refreshTime	How often should the lamp states refreshed Type: number Default: 60 * 10000
animationSpeed	Animation Speed Type: number Default: 2 * 1000
lightsOrGroups	Should the module show groups or lights Type: string Default: "groups"
showOnlyOn	If set to true the module shows only the lights which are on Type: boolean
hideSpecificGroups	Ignore some groups by a given string (requires hideGroupsWithString option) Type: boolean Default: false
hideGroupsWithString	Ignore an array of groups (requires hideSpecificGroups option to be set as true) Sample array: ["Kitchen", "Den"] Type: string
showLabel	Show header label? Type: boolean Default: true