https://github.com/MitchSS/MMM-Hue

Philips Hue Module for MagicMirror2
https://github.com/MitchSS/MMM-Hue

Last synced: 23 days ago
JSON representation

Philips Hue Module for MagicMirror2

• Host: GitHub
• URL: https://github.com/MitchSS/MMM-Hue
• Owner: MitchSS
• Created: 2016-09-12T23:14:20.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2022-11-10T15:27:39.000Z (about 2 years ago)
• Last Synced: 2024-08-04T10:03:27.412Z (4 months ago)
• Language: JavaScript
• Size: 128 KB
• Stars: 28
• Watchers: 6
• Forks: 13
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

• awesome-mmm - **MMM-Hue**

README

        
# Module: MMM-Hue

The `MMM-Hue` 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.

## Installing the Module

Navigate into your MagicMirror's modules folder and execute 


`git clone https://github.com/MitchSS/MMM-Hue.git`

## Using the module

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

````javascript

{

		    module: 'MMM-Hue',

		    position: 'top_right',

		    config: {

			bridgeip: "192.168.1.1",

			userid: "my user id",

			colour: false

		    }

}

````

Please visit [Philips Hue API page](https://www.developers.meethue.com/documentation/getting-started) 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 |

| `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` | false |

| `hideSpecificGroups` | Ignore some groups by a given string (requires hideGroupsWithString option) 
**Type:** `boolean` 
**Default:** false |

| `hideGroupsWithString` | Ignore some groups which including this string (requires hideSpecificGroups option) 
**Type:** `string` |

| `showLabel` | Show header label? 
**Type:** `boolean` 
**Default:** true |