|
| 1 | +--- |
| 2 | +layout: page |
| 3 | +title: "Emulated Hue Bridge" |
| 4 | +description: "Emulated Hue Bridge" |
| 5 | +sidebar: true |
| 6 | +comments: false |
| 7 | +sharing: true |
| 8 | +footer: true |
| 9 | +--- |
| 10 | + |
| 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. |
| 16 | + |
| 17 | +To enable the emulated Hue bridge, add the following to your `configuration.yaml` |
| 18 | +file: |
| 19 | + |
| 20 | +```yaml |
| 21 | +# Example configuration.yaml entry |
| 22 | +emulated_hue: |
| 23 | + host_ip: 192.168.1.186 |
| 24 | + listen_port: 8300 |
| 25 | + off_maps_to_on_domains: |
| 26 | + - script |
| 27 | + - scene |
| 28 | + expose_by_default: true |
| 29 | + exposed_domains: |
| 30 | + - light |
| 31 | + |
| 32 | +# Example customization |
| 33 | +homeassistant: |
| 34 | + customize: |
| 35 | + light.bedroom_light: |
| 36 | + # Don't allow light.bedroom_light to be controlled by the |
| 37 | + # emulated Hue bridge |
| 38 | + emulated_hue: false |
| 39 | + light.office_light: |
| 40 | + # Address light.office_light as "back office light" |
| 41 | + emulated_hue_name: "back office light" |
| 42 | +``` |
| 43 | +
|
| 44 | +Configuration variables: |
| 45 | +
|
| 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. |
| 49 | +
|
| 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. |
| 55 | + |
| 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. |
| 59 | + |
| 60 | + If not specified, this defaults to the following list: |
| 61 | + |
| 62 | + - `script` |
| 63 | + - `scene` |
| 64 | + |
| 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: |
| 72 | + |
| 73 | + - `switch` |
| 74 | + - `light` |
| 75 | + - `group` |
| 76 | + - `input_boolean` |
| 77 | + - `media_player` |
| 78 | + |
| 79 | +The following are attributes that can be applied in the `customize` section: |
| 80 | + |
| 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. |
| 84 | + |
| 85 | +- **emulated_hue_name** (*Optional*): The name that the emulated Hue will use. |
| 86 | + The default for this is the entity's friendly name. |
| 87 | + |
| 88 | +### {% linkable_title License %} |
| 89 | + |
| 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 reproduced below: |
| 92 | + |
| 93 | +The MIT License (MIT) |
| 94 | + |
| 95 | +Copyright (c) 2016 Bruce Locke |
| 96 | + |
| 97 | +Permission is hereby granted, free of charge, to any person obtaining a copy |
| 98 | +of this software and associated documentation files (the "Software"), to deal |
| 99 | +in the Software without restriction, including without limitation the rights |
| 100 | +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell |
| 101 | +copies of the Software, and to permit persons to whom the Software is |
| 102 | +furnished to do so, subject to the following conditions: |
| 103 | + |
| 104 | +The above copyright notice and this permission notice shall be included in all |
| 105 | +copies or substantial portions of the Software. |
| 106 | + |
| 107 | +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
| 108 | +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
| 109 | +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE |
| 110 | +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER |
| 111 | +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, |
| 112 | +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE |
| 113 | +SOFTWARE. |
0 commit comments