Skip to content

Commit f1a4253

Browse files
committed
Update layout and add details
1 parent 6577635 commit f1a4253

File tree

1 file changed

+32
-45
lines changed

1 file changed

+32
-45
lines changed
Lines changed: 32 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,23 @@
11
---
22
layout: page
33
title: "Emulated Hue Bridge"
4-
description: "Emulated Hue Bridge"
4+
description: "Instructions how to emulated Hue Bridge within Home Assistant."
5+
date: 2016-08-26 08:00
56
sidebar: true
67
comments: false
78
sharing: true
89
footer: true
10+
ha_category: Hub
11+
ha_release: 0.27
12+
ha_iot_class: "Local Push"
913
---
1014

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.
1617

1718
### {% linkable_title Configuration %}
1819

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:
2121

2222
```yaml
2323
# Example configuration.yaml entry
@@ -30,62 +30,49 @@ emulated_hue:
3030
expose_by_default: true
3131
exposed_domains:
3232
- 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"
4433
```
4534
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:
4936
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.
5540
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.
5942

6043
If not specified, this defaults to the following list:
6144

6245
- `script`
6346
- `scene`
6447

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.
7249

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:
7351
- `switch`
7452
- `light`
7553
- `group`
7654
- `input_boolean`
7755
- `media_player`
7856

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.
8058

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:
8472

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.
8775

8876
### {% linkable_title License %}
8977

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

Comments
 (0)