You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
description: "Instructions how to emulated Hue Bridge within Home Assistant."
5
+
date: 2016-08-26 08:00
5
6
sidebar: true
6
7
comments: false
7
8
sharing: true
8
9
footer: true
10
+
ha_category: Hub
11
+
ha_release: 0.27
12
+
ha_iot_class: "Local Push"
9
13
---
10
14
11
-
The `emulated_hue` component provides a virtual Philips Hue bridge, written entirely in software,
12
-
that allows services that work with the Hue API to interact with Home Assistant
13
-
entities. The driving use case behind this functionality is to allow Home
14
-
Assistant to work with an Amazon Echo with no set up cost outside of
15
-
configuration changes.
15
+
The `emulated_hue` component provides a virtual Philips Hue bridge, written entirely in software, that allows services that work with the Hue API to interact with Home Assistant
16
+
entities. The driving use case behind this functionality is to allow Home Assistant to work with an Amazon Echo with no set up cost outside of configuration changes.
16
17
17
18
### {% linkable_title Configuration %}
18
19
19
-
To enable the emulated Hue bridge, add the following to your `configuration.yaml`
20
-
file:
20
+
To enable the emulated Hue bridge, add the following to your `configuration.yaml` file:
21
21
22
22
```yaml
23
23
# Example configuration.yaml entry
@@ -30,62 +30,49 @@ emulated_hue:
30
30
expose_by_default: true
31
31
exposed_domains:
32
32
- light
33
-
34
-
# Example customization
35
-
homeassistant:
36
-
customize:
37
-
light.bedroom_light:
38
-
# Don't allow light.bedroom_light to be controlled by the
39
-
# emulated Hue bridge
40
-
emulated_hue: false
41
-
light.office_light:
42
-
# Address light.office_light as "back office light"
43
-
emulated_hue_name: "back office light"
44
33
```
45
34
46
-
- **host_ip** (*Optional*): The IP address that your Home Assistant installation is
47
-
running on. If you do not specify this option, the component will attempt to
48
-
determine the IP address on its own.
35
+
Configuration variables:
49
36
50
-
- **listen_port** (*Optional*): The port the Hue bridge API web server will run on. If
51
-
not specified, this defaults to 8300. This can be any free port on your system.
52
-
53
-
- **off_maps_to_on_domains** (*Optional*): The domains that maps an "off" command to
54
-
an "on" command.
37
+
- **host_ip** (*Optional*): The IP address that your Home Assistant installation is running on. If you do not specify this option, the component will attempt to determine the IP address on its own.
38
+
- **listen_port** (*Optional*): The port the Hue bridge API web server will run on. If not specified, this defaults to 8300. This can be any free port on your system.
39
+
- **off_maps_to_on_domains** (*Optional*): The domains that maps an "off" command to an "on" command.
55
40
56
-
For example, if `script` is included in the list, and you
57
-
ask Alexa to "turn off the *water plants* script," the command will be handled
58
-
as if you asked her to turn on the script.
41
+
For example, if `script` is included in the list, and you ask Alexa to "turn off the *water plants* script," the command will be handled as if you asked her to turn on the script.
59
42
60
43
If not specified, this defaults to the following list:
61
44
62
45
- `script`
63
46
- `scene`
64
47
65
-
- **expose_by_default** (*Optional*): Whether or not entities should be exposed via the
66
-
bridge by default instead of explicitly (see the 'echo' attribute later on).
67
-
If not specified, this defaults to true.
68
-
69
-
- **exposed_domains** (*Optional*): The domains that are exposed by default if
70
-
`expose_by_default`is set to true. If not specified, this defaults to the
71
-
following list:
48
+
- **expose_by_default** (*Optional*): Whether or not entities should be exposed via the bridge by default instead of explicitly (see the 'echo' attribute later on). If not specified, this defaults to true.
72
49
50
+
- **exposed_domains** (*Optional*): The domains that are exposed by default if `expose_by_default` is set to true. If not specified, this defaults to the following list:
73
51
- `switch`
74
52
- `light`
75
53
- `group`
76
54
- `input_boolean`
77
55
- `media_player`
78
56
79
-
The following are attributes that can be applied in the `customize` section:
57
+
With additional customization you will be able to specify the behaviour of the existing entities.
80
58
81
-
- **emulated_hue** (*Optional*): Whether or not the entity should be
82
-
exposed by the emulated Hue bridge. The default value for this attribute is controlled
83
-
by the `expose_by_default` option.
59
+
```yaml
60
+
# Example customization
61
+
homeassistant:
62
+
customize:
63
+
light.bedroom_light:
64
+
# Don't allow light.bedroom_light to be controlled by the emulated Hue bridge
65
+
emulated_hue: false
66
+
light.office_light:
67
+
# Address light.office_light as "back office light"
68
+
emulated_hue_name: "back office light"
69
+
```
70
+
71
+
The following are attributes that can be applied in the `customize` section:
84
72
85
-
- **emulated_hue_name** (*Optional*): The name that the emulated Hue will use.
86
-
The default for this is the entity's friendly name.
73
+
- **emulated_hue** (*Optional*): Whether or not the entity should be exposed by the emulated Hue bridge. The default value for this attribute is controlled by the `expose_by_default` option.
74
+
- **emulated_hue_name** (*Optional*): The name that the emulated Hue will use. The default for this is the entity's friendly name.
87
75
88
76
### {% linkable_title License %}
89
77
90
-
Much of this code is based on work done by Bruce Locke on his [ha-local-echo](https://github.com/blocke/ha-local-echo)
91
-
project, originally released under the MIT License. The license is located [here](https://github.com/blocke/ha-local-echo/blob/b9bf5dcaae6d8e305e2283179ffba64bde9ed29e/LICENSE).
78
+
Much of this code is based on work done by Bruce Locke on his [ha-local-echo](https://github.com/blocke/ha-local-echo) project, originally released under the MIT License. The license is located [here](https://github.com/blocke/ha-local-echo/blob/b9bf5dcaae6d8e305e2283179ffba64bde9ed29e/LICENSE).
0 commit comments