https://github.com/mumblebaj/mmm-philipshue
Philips Hue lights module for MagicMirror²
https://github.com/mumblebaj/mmm-philipshue
hue-lights magicmirror2 philips-hue
Last synced: 2 months ago
JSON representation
Philips Hue lights module for MagicMirror²
- Host: GitHub
- URL: https://github.com/mumblebaj/mmm-philipshue
- Owner: mumblebaj
- License: mit
- Created: 2022-01-04T14:16:50.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-03-06T16:49:31.000Z (about 2 years ago)
- Last Synced: 2024-03-06T18:38:24.340Z (about 2 years ago)
- Topics: hue-lights, magicmirror2, philips-hue
- Language: JavaScript
- Homepage:
- Size: 42 KB
- Stars: 4
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 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.
[](LICENSE)
## 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
- node-fetch@2.6.1
## Using the module
To use this module, add it to the modules array in the `config/config.js` file:
````javascript
{
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](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 |
| `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` | false |
| `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 |