mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-07-19 07:17:14 +00:00
Merge branch 'current' into next
This commit is contained in:
Fabian Affolter
commit
b0b7ee801b
@ -21,20 +21,20 @@ The requirement is that you have setup the [`xiaomi aqara` component](/component
|
||||
|
||||
### {% linkable_title Type of sensors supported %}
|
||||
|
||||
| Name | ZigBee entity | Model no. | States | Event | Event key | Event values |
|
||||
|-----------------------------------|---------------------|----------------------|----------------------------------------------------|-----------------------------------------|--------------------------------------------------------------------------------------------------------------------------|
|
||||
| Motion Sensor (1st gen) | motion | RTCGQ01LM | on, off | `motion` | | |
|
||||
| Motion Sensor (2nd gen) | sensor_motion.aq2 | RTCGQ11LM | on, off | `motion` | | |
|
||||
| Door and Window Sensor (1st gen) | magnet | WSDCGQ01LM | on, off | | | |
|
||||
| Door and Window Sensor (2nd gen) | sensor_magnet.aq2 | MCCGQ11LM | on, off | | | |
|
||||
| Smoke Detector | smoke | JTYJ-GD-01LM/BW | on, off | | | |
|
||||
| Gas Leak Detector | natgas | JTQJ-BF-01LM/BW | on, off | | | |
|
||||
| Water Leak Sensor | sensor_wleak.aq1 | SJCGQ11LM | on, off | | | |
|
||||
| Button (1st gen) | switch | WXKG01LM | on (thru long_click_press), off | `click` | `click_type` | `long_click_press`, `long_click_release`, `hold`, `single`, `double` |
|
||||
| Button (2nd gen) | sensor_switch.aq2 | WXKG11LM | off (always) | `click` | `click_type` | `single`, `double` |
|
||||
| Aqara Wireless Switch (Single) | 86sw1 | WXKG03LM | off (always) | `click` | `click_type` | `single` |
|
||||
| Aqara Wireless Switch (Double) | 86sw2 | WXKG02LM | off (always) | `click` | `click_type` | `single`, `both` |
|
||||
| Cube | cube | MFKZQ01LM | off (always) | `cube_action` | `action_type`, `action_value` (rotate) | `flip90`, `flip180`, `move`, `tap_twice`, `shake_air`, `swing`, `alert`, `free_fall`, `rotate` (degrees at action_value) |
|
||||
| Name | ZigBee entity | Model no. | States | Event | Event key | Event values |
|
||||
| ---- | ------------- | --------- | ------ | ----- | --------- | ------------ |
|
||||
| Motion Sensor (1st gen) | motion | RTCGQ01LM | on, off | `motion` | | |
|
||||
| Motion Sensor (2nd gen) | sensor_motion.aq2 | RTCGQ11LM | on, off | `motion` | | |
|
||||
| Door and Window Sensor (1st gen) | magnet | WSDCGQ01LM | on, off | | | |
|
||||
| Door and Window Sensor (2nd gen) | sensor_magnet.aq2 | MCCGQ11LM | on, off | | | |
|
||||
| Smoke Detector | smoke | JTYJ-GD-01LM/BW | on, off | | | |
|
||||
| Gas Leak Detector | natgas | JTQJ-BF-01LM/BW | on, off | | | |
|
||||
| Water Leak Sensor | sensor_wleak.aq1 | SJCGQ11LM | on, off | | | |
|
||||
| Button (1st gen) | switch | WXKG01LM | on (thru long_click_press), off | `click`| `click_type`| `long_click_press`, `long_click_release`, `hold`, `single`, `double` |
|
||||
| Button (2nd gen) | sensor_switch.aq2 | WXKG11LM | off (always) | `click` | `click_type` | `single`, `double` |
|
||||
| Aqara Wireless Switch (Single) | 86sw1 | WXKG03LM | off (always) | `click` | `click_type` | `single` |
|
||||
| Aqara Wireless Switch (Double) | 86sw2 | WXKG02LM | off (always) | `click` | `click_type` | `single`, `both` |
|
||||
| Cube | cube | MFKZQ01LM | off (always) | `cube_action` | `action_type`, `action_value` (rotate) | `flip90`, `flip180`, `move`, `tap_twice`, `shake_air`, `swing`, `alert`, `free_fall`, `rotate` (degrees at action_value) |
|
||||
|
||||
### {% linkable_title Automation examples %}
|
||||
|
||||
|
||||
@ -57,3 +57,14 @@ camera:
|
||||
still_image_url: https://www.yr.no/place/Norway/Oslo/Oslo/Oslo/meteogram.svg
|
||||
content_type: 'image/svg+xml'
|
||||
```
|
||||
|
||||
### {% linkable_title Local image with Hass.io %}
|
||||
|
||||
You can show an static image with this platform. Just place the image here: `/config/www/your_image.png`
|
||||
|
||||
```yaml
|
||||
camera:
|
||||
- platform: generic
|
||||
name: Some Image
|
||||
still_image_url: https://127.0.0.1:8123/local/your_image.png
|
||||
```
|
||||
|
||||
@ -45,6 +45,18 @@ Take a snapshot from a camera.
|
||||
|
||||
The path part of `filename` must be an entry in the `whitelist_external_dirs` in your [`homeassistant:`](/docs/configuration/basic/) section of your `configuration.yaml` file.
|
||||
|
||||
For example, the following action in an automation would take a snapshot from "yourcamera" and save it to /tmp with a timestamped filename.
|
||||
|
||||
{% raw %}
|
||||
```yaml
|
||||
action:
|
||||
service: camera.snapshot
|
||||
data:
|
||||
entity_id: camera.yourcamera
|
||||
filename: '/tmp/yourcamera_{{ now().strftime("%Y%m%d-%H%M%S") }}.jpg'
|
||||
```
|
||||
{% endraw %}
|
||||
|
||||
### {% linkable_title Test if it works %}
|
||||
|
||||
A simple way to test if you have set up your `camera` platform correctly, is to use <img src='/images/screenshots/developer-tool-services-icon.png' alt='service developer tool icon' class="no-shadow" height="38" /> **Services** from the **Developer Tools**. Choose your service from the dropdown menu **Service**, enter something like the sample below into the **Service Data** field, and hit **CALL SERVICE**.
|
||||
|
||||
@ -14,8 +14,8 @@ ha_release: 0.59
|
||||
|
||||
To use your tahoma covers in your installation, add the following to your `configuration.yaml` file:
|
||||
|
||||
``yaml
|
||||
```yaml
|
||||
# Example configuration.yml entry
|
||||
cover:
|
||||
platform: tahoma
|
||||
```
|
||||
```
|
||||
|
||||
@ -30,7 +30,7 @@ $ sudo apt install bluetooth libbluetooth-dev pkg-config libboost-python-dev lib
|
||||
Before you get started with this platform, please note that:
|
||||
|
||||
- This platform is incompatible with Windows
|
||||
- This platform requires root privileges
|
||||
- This platform requires access to the bluetooth stack, see [Rootless Setup section](#rootless-setup) for further infomation
|
||||
|
||||
To use the Bluetooth tracker in your installation, add the following to your `configuration.yaml` file:
|
||||
|
||||
@ -50,7 +50,9 @@ Configuration variables:
|
||||
As some BT LE devices change their MAC address regularly, a new device is only discovered when it has been seen 5 times.
|
||||
Some BTLE devices (e.g. fitness trackers) are only visible to the devices that they are paired with. In this case, the BTLE tracker won't see this device.
|
||||
|
||||
For running Home Assistant as non root user we can give python3 the missing capabilities to access the Bluetooth stack. Quite like setting the setuid bit (see [Stack Exchange](http://unix.stackexchange.com/questions/96106/bluetooth-le-scan-as-non-root) for more information).
|
||||
## {% linkable_title Rootless Setup %}
|
||||
|
||||
Normaly accessing the Bluetooth stack is reserved for root, but running programs that are networked as root is a bad security wise. To allow non-root access to the Bluetooth stack we can give Python 3 the missing capabilities to access the Bluetooth stack. Quite like setting the setuid bit (see [Stack Exchange](http://unix.stackexchange.com/questions/96106/bluetooth-le-scan-as-non-root) for more information).
|
||||
|
||||
```bash
|
||||
$ sudo apt-get install libcap2-bin
|
||||
|
||||
@ -70,6 +70,10 @@ devicename:
|
||||
hide_if_away: no
|
||||
```
|
||||
|
||||
<p class='note warning'>
|
||||
In the example above, `devicename` refers to the detected name of the device. For instance, `my_iphone`.
|
||||
</p>
|
||||
|
||||
| Parameter | Default | Description |
|
||||
|----------------|-------------------------------|---------------------------------------------------------------------------------------------------------|
|
||||
| `name` | Host name or "Unnamed Device" | The friendly name of the device. |
|
||||
|
||||
@ -13,8 +13,8 @@ ha_release: 0.27
|
||||
ha_iot_class: "Local Push"
|
||||
---
|
||||
|
||||
<p class='warning'>
|
||||
At this time `emulated_hue` doesn't appear to be working for new Google Home users.
|
||||
<p class='note warning'>
|
||||
Be aware that `emulated_hue` doesn't work for new **Google Home** users. If you're a new user of Google Home, use the [Google Assistant component](https://home-assistant.io/components/google_assistant/).
|
||||
</p>
|
||||
|
||||
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
|
||||
|
||||
@ -129,6 +129,7 @@ Entity Customization Keys:
|
||||
4. Configure your client. Add scopes for `email` and `name`
|
||||
5. Testing instructions: doesn't matter since you won't submit this app
|
||||
7. Back on the main app draft page. Click `Test Draft`. That will take you to the simulator (which won't work) so just close that window.
|
||||
8. If you haven't already added the configuration to `configuration.yaml` and restarted Home Assistant, you'll be unable to continue until you have.
|
||||
8. Open the Google Assistant app and go into `Settings > Home Control`
|
||||
9. Click the `+` sign, and near the bottom, you should have `[test] your app name`. Selecting that should lead to you the screen where you can set rooms for your devices or nicknames for your devices.
|
||||
10. If you want to allow other houshold users to control the devices:
|
||||
|
||||
@ -36,7 +36,7 @@ Configuration variables:
|
||||
- **host** (*Optional*): IP address of the device, eg. 192.168.1.10. Required if not using the `discovery` component to discover Hue bridges.
|
||||
- **allow_unreachable** (*Optional*): (true/false) This will allow unreachable bulbs to report their state correctly.
|
||||
- **filename** (*Optional*): Make this unique if specifying multiple Hue hubs.
|
||||
- **allow_in_emulated_hue** (*Optional*): )true/false) Enable this to block all Hue entities from being added to the `emulated_hue` component.
|
||||
- **allow_in_emulated_hue** (*Optional*): (true/false) Enable this to block all Hue entities from being added to the `emulated_hue` component.
|
||||
- **allow_hue_groups** (*Optional*): (true/false) Enable this to stop Home Assistant from importing the groups defined on the Hue bridge.
|
||||
|
||||
### {% linkable_title Migrating from older configuration %}
|
||||
|
||||
@ -42,7 +42,7 @@ light:
|
||||
{% endraw %}
|
||||
|
||||
{% configuration %}
|
||||
switches:
|
||||
lights:
|
||||
description: List of your lights.
|
||||
required: true
|
||||
type: map
|
||||
|
||||
@ -25,6 +25,7 @@ light:
|
||||
- platform: x10
|
||||
devices:
|
||||
- id: a2
|
||||
name: Guest Room
|
||||
- id: a3
|
||||
name: Bedroom Lamp
|
||||
```
|
||||
@ -32,4 +33,4 @@ light:
|
||||
Configuration variables:
|
||||
|
||||
- **id** (*Required*): Device identifier. Composed of house code and unit id.
|
||||
- **name** (*Optional*): A friendly name for the device. By default *id* from the device is used.
|
||||
- **name** (*Required*): A friendly name for the device.
|
||||
|
||||
@ -48,7 +48,8 @@ Per default the bulb limits the amount of requests per minute to 60, a limitatio
|
||||
<p class='note'>
|
||||
Before trying to control your light through Home Assistant, you have to setup your bulb using Yeelight app. ( [Android](https://play.google.com/store/apps/details?id=com.yeelight.cherry&hl=fr), [IOS](https://itunes.apple.com/us/app/yeelight/id977125608?mt=8) ).
|
||||
In the bulb property, you have to enable "LAN Mode" (previously called "Developer mode"). LAN mode may only be available with the latest firmware installed on your bulb. Firmware can be updated in the application after connecting the bulb.
|
||||
Determine your bulb IP (using router, software, ping ...)
|
||||
Determine your bulb IP (using router, software, ping ...).
|
||||
Information on how to enable "LAN Mode" can be found [here](https://getyeti.co/posts/how-to-control-yeelight-and-your-smarthome-with-yeti).
|
||||
</p>
|
||||
|
||||
<p class='note warning'>
|
||||
@ -58,6 +59,7 @@ This component is tested to work with the following models. If you have a differ
|
||||
- **YLDP01YL**: LED Bulb (White)
|
||||
- **YLDP02YL**: LED Bulb (Color)
|
||||
- **YLDP03YL**: LED Bulb (Color) - E26
|
||||
- **YLDD01YL**: Lightstrip (Color)
|
||||
- **YLDD02YL**: Lightstrip (Color)
|
||||
|
||||
|
||||
|
||||
@ -59,6 +59,7 @@ Currently known supported models:
|
||||
- KS7502 (port must be set to 8001, and `pip3 install websocket-client` must be executed, turn on doesn't work, turn off works fine)
|
||||
- K5600AK (partially supported, turn on works but state is not updated)
|
||||
- UE65KS8005 (port must be set to 8001, On/Off, Forward/Backward, Volume are OK, but no Play button)
|
||||
- UE6199UXZG (port must be set to 8001, On/Off, Forward/Backward, Volume control, but no Play button)
|
||||
|
||||
Currently tested but not working models:
|
||||
|
||||
|
||||
@ -33,8 +33,10 @@ The Home Assistant Neato platform has not been tested with all models of Botvac.
|
||||
| BotVac Model | Tested |
|
||||
| --- | --- |
|
||||
| Botvac Connected | SUCCESS |
|
||||
| Botvac D3 Connected (firmware 4.0+) | UNTESTED |
|
||||
| Botvac D5 Connected (firmware 4.0+) | PARTIALLY WORKING |
|
||||
| Botvac D7 Connected | SUCCESS |
|
||||
|
||||
<p class='note'>
|
||||
There is no support for the Botvac D3 Connected and Botvac D5 Connected robots at this time.
|
||||
After the update to firmware 4.0 (which adds cleaning maps) there is also support for displaying the maps of the Botvac D3 Connected and Botvac D5 Connected robots. The start/stop functionality does not work. More information on how to update here: https://support.neatorobotics.com/hc/en-us/articles/115004320694-Software-Update-4-0-for-Neato-Botvac-Connected-D3-D5-
|
||||
</p>
|
||||
|
||||
@ -42,7 +42,7 @@ Configuration variables:
|
||||
|
||||
### {% linkable_title Slack service data %}
|
||||
|
||||
The following attributes can be placed `data` for extended functionality.
|
||||
The following attributes can be placed inside `data` for extended functionality.
|
||||
|
||||
| Service data attribute | Optional | Description |
|
||||
| ---------------------- | -------- | ----------- |
|
||||
|
||||
@ -13,9 +13,9 @@ ha_release: 0.26
|
||||
ha_iot_class: "Local Push"
|
||||
---
|
||||
|
||||
[Pilight](https://www.pilight.org/) is a modular and open source solution to communicate with 433 MHz devices and runs on various small form factor computers. A lot of common [protocols](https://wiki.pilight.org/doku.php/protocols) are already available.
|
||||
[Pilight](https://www.pilight.org/) is a modular and open source solution to communicate with 433 MHz devices and runs on various small form factor computers. A lot of common [protocols](https://manual.pilight.org/protocols/index.html) are already available.
|
||||
|
||||
This pilight hub connects to the [pilight-daemon](https://wiki.pilight.org/doku.php/pdaemon) via a socket connection to receive and send codes. Thus Home Assistant does not have to run on the computer in charge of the RF communication.
|
||||
This pilight hub connects to the [pilight-daemon](https://manual.pilight.org/programs/daemon.html) via a socket connection to receive and send codes. Thus Home Assistant does not have to run on the computer in charge of the RF communication.
|
||||
|
||||
The received and supported RF codes are put on the event bus of Home Assistant and are therefore directly usable by other components (e.g. automation). Additionally a send service is provided to send RF codes.
|
||||
|
||||
@ -31,11 +31,11 @@ pilight:
|
||||
Configuration variables:
|
||||
|
||||
- **host** (*Required*): The IP address of the computer running the pilight-daemon, e.g. 192.168.1.32.
|
||||
- **port** (*Required*): The network port to connect to. The usual port is [5000](https://www.pilight.org/development/api/).
|
||||
- **port** (*Required*): The network port to connect to. The usual port is [5000](https://manual.pilight.org/development/api.html).
|
||||
- **send_delay** (*Optional*): You can define a send delay as a fraction of seconds if you experience transmission problems when you try to switch multiple switches at once. This can happen when you use a [pilight USB Nano](https://github.com/pilight/pilight-usb-nano) as hardware and switches a whole group of multiple switches on or off. Tested values are between 0.3 and 0.8 seconds depending on the hardware.
|
||||
- **whitelist** (*Optional*): You can define a whitelist to prevent that too many unwanted RF codes (e.g. the neighbours weather station) are put on your HA event bus. All defined subsections have to be matched. A subsection is matched if one of the items are true.
|
||||
|
||||
In this example only received RF codes using a daycom or Intertechno protocol are put on the event bus and only when the device id is 42. For more possible settings please look at the receiver section of the pilight [API](https://www.pilight.org/development/api/).
|
||||
In this example only received RF codes using a daycom or Intertechno protocol are put on the event bus and only when the device id is 42. For more possible settings please look at the receiver section of the pilight [API](https://manual.pilight.org/development/api.html).
|
||||
|
||||
A full configuration sample could look like the sample below:
|
||||
|
||||
@ -55,9 +55,9 @@ pilight:
|
||||
|
||||
## {% linkable_title Troubleshooting %}
|
||||
|
||||
- A list of tested RF transceiver hardware is available [here](https://wiki.pilight.org/doku.php/electronics). This might be useful before buying.
|
||||
- A list of tested RF transceiver hardware is available [here](https://manual.pilight.org/electronics/index.html). This might be useful before buying.
|
||||
- Sending commands is simple when the protocol is known by pilight, but receiving commands can be rather difficult. It can happen that the code is not correctly recognized due to different timings in the sending hardware or the RF receiver. If this happens follow these steps:
|
||||
|
||||
1. [Install](https://www.pilight.org/get-started/installation/) pilight from source (do not worry that is very easy) and only activate the protocols you are expecting in the pop up menu. This reduces false positives.
|
||||
1. [Install](https://manual.pilight.org/installation.html) pilight from source (do not worry that is very easy) and only activate the protocols you are expecting in the pop up menu. This reduces false positives.
|
||||
2. Check the real timings of your device + RF receiver by running `pilight-debug`. Remember the `pulslen` parameter.
|
||||
3. Go to the `libs/pilight/protocols/433.92` subfolder of the pilight source code and open the .c file of your protocol. Search for `MIN_PULSE_LENGTH`, `MAX_PULSE_LENGTH ` and `AVG_PULSE_LENGTH`. Change the pulse lengths to match your measured one. Recompile and install pilight by re-running `$ sudo ./setup.sh`.
|
||||
|
||||
@ -105,21 +105,21 @@ action:
|
||||
| Database engine | `db_url` |
|
||||
| :---------------|:---------------------------------------------------------|
|
||||
| SQLite | `sqlite:///PATH/TO/DB_NAME` |
|
||||
| MariaDB | `mysql://SERVER_IP/DB_NAME` |
|
||||
| MariaDB | `mysql://user:password@SERVER_IP/DB_NAME` |
|
||||
| MySQL | `mysql://SERVER_IP/DB_NAME` |
|
||||
| MySQL | `mysql://user:password@SERVER_IP/DB_NAME` |
|
||||
| MySQL (pymysql) | `mysql+pymysql://SERVER_IP/DB_NAME` |
|
||||
| MySQL (pymysql) | `mysql+pymysql://user:password@SERVER_IP/DB_NAME` |
|
||||
| MariaDB | `mysql://SERVER_IP/DB_NAME?charset=utf8` |
|
||||
| MariaDB | `mysql://user:password@SERVER_IP/DB_NAME?charset=utf8` |
|
||||
| MySQL | `mysql://SERVER_IP/DB_NAME?charset=utf8` |
|
||||
| MySQL | `mysql://user:password@SERVER_IP/DB_NAME?charset=utf8` |
|
||||
| MySQL (pymysql) | `mysql+pymysql://SERVER_IP/DB_NAME?charset=utf8` |
|
||||
| MySQL (pymysql) | `mysql+pymysql://user:password@SERVER_IP/DB_NAME?charset=utf8` |
|
||||
| PostgreSQL | `postgresql://SERVER_IP/DB_NAME` |
|
||||
| PostgreSQL | `postgresql://scott:tiger@SERVER_IP/DB_NAME` |
|
||||
| MS SQL Server | `mssql+pymssql://user:pass@SERVER_IP/DB_NAME?charset=utf8` |
|
||||
| MS SQL Server | `mssql+pymssql://user:pass@SERVER_IP/DB_NAME?charset=utf8` |
|
||||
|
||||
## {% linkable_title Installation notes %}
|
||||
|
||||
Not all Python bindings for the chosen database engine can be installed directly. This section contains additional details which should help you to get it working.
|
||||
|
||||
### {% linkable_title MariDB and MySQL %}
|
||||
### {% linkable_title MariaDB and MySQL %}
|
||||
|
||||
For MariaDB you may have to install a few dependencies. On the Python side we use the `mysqlclient`:
|
||||
|
||||
|
||||
@ -143,7 +143,6 @@ sensor:
|
||||
- platform: command_line
|
||||
name: Brightness
|
||||
command: "python3 /path/to/script/arest-value.py"
|
||||
unit_of_measurement: "°C"
|
||||
```
|
||||
|
||||
### {% linkable_title Usage of templating in `command:` %}
|
||||
@ -155,6 +154,6 @@ sensor:
|
||||
sensor:
|
||||
- platform: command_line
|
||||
name: wind direction
|
||||
command: 'sh /home/pi/.homeassistant/scripts/wind_direction.sh {{ states.sensor.wind_direction.state }}'
|
||||
command: 'sh /home/pi/.homeassistant/scripts/wind_direction.sh {% raw %}{{ states.sensor.wind_direction.state }}{% endraw %}'
|
||||
unit_of_measurement: "Direction"
|
||||
```
|
||||
|
||||
@ -44,6 +44,7 @@ Your location will be detected from your home `latitude` and `longitude` setting
|
||||
Configuration variables:
|
||||
|
||||
- **api_key** (*Required*): Your personal API key from the [Datapoint website][datapoint].
|
||||
- **name** (*Optional*): Name to use in the frontend, will be the prefix.
|
||||
|
||||
<p class='note'>
|
||||
This sensor is an alternative to the [`metoffice`](/components/weather.metoffice/) weather platform.
|
||||
|
||||
@ -15,7 +15,13 @@ ha_release: 0.11
|
||||
|
||||
The `tellduslive` component let you connect to [Telldus Live](https://live.telldus.com). It's cloud platform that connects to your Tellstick Net or Tellstick ZNet connected gear at home.
|
||||
|
||||
Home Assistant will automatically discover the presence of a Tellstick Net or Tellstick ZNet on your local network if the [discovery]({{site_root}}/components/discovery/) component is enabled. To manually integrate your Telldus Live with Home Assistant, e.g. if your device is on another network or in another location, add the following section to your `configuration.yaml` file:
|
||||
<p class='note warning'>
|
||||
If you are upgrading from 0.58 or older, you need to remove all Telldus configuration from your `configuration.yaml` file before continuing.
|
||||
</p>
|
||||
|
||||
Home Assistant will automatically discover the presence of a Tellstick Net or Tellstick ZNet on your local network if the [discovery]({{site_root}}/components/discovery/) component is enabled. When discovery and the key exchange with Telldus Live have been completed, you will be presented with an option to integrate with the cloud or local API for direct communication with your hardware in your LAN. Local API supports only one device at this stage. Local API is only supported with the Znet Lite products, the older hardware (such as Tellstick Net) does not support local API.
|
||||
|
||||
To manually integrate your Telldus Live with Home Assistant, e.g. if your device is on another network or in another location, add the following section to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
|
||||
@ -24,7 +24,8 @@ tts:
|
||||
|
||||
Configuration variables:
|
||||
|
||||
- **language** (*Optional*): The language to use. Defaults to `en`.
|
||||
- **language** (*Optional*): The language to use. Defaults to `en`.
|
||||
- [Complete list of supported languages](https://cloud.google.com/speech/docs/languages).
|
||||
|
||||
A full configuration sample:
|
||||
|
||||
|
||||
@ -63,7 +63,7 @@ light:
|
||||
|
||||
There are some rules for packages that will be merged:
|
||||
|
||||
1. Component names may only use the basic form (e.g. `switch` and `switch 1` or `switch aa` is not accepted).
|
||||
1. Component names may only use the basic form (e.g. `switch`, but not `switch 1` or `switch aa`).
|
||||
2. Platform based components (`light`, `switch`, etc) can always be merged.
|
||||
3. Components where entities are identified by a key that will represent the entity_id (`{key: config}`) need to have unique 'keys' between packages and the main configuration file.
|
||||
|
||||
|
||||
@ -10,7 +10,7 @@ footer: true
|
||||
redirect_from: /getting-started/basic/#remote-access
|
||||
---
|
||||
|
||||
If you're interested in logging in to Home Assistant while away, you'll have to make your instance remotely accessible.
|
||||
If you're interested in logging in to Home Assistant while away, you'll have to make your instance remotely accessible. Remember to follow the [securing checklist](/docs/configuration/securing/) before doing this.
|
||||
|
||||
The most common approach is to set up port forwarding from your router to port 8123 on the computer that is hosting Home Assistant. General instructions on how to do this can be found by searching `<router model> port forwarding instructions`.
|
||||
|
||||
|
||||
@ -33,7 +33,7 @@ Create an `/etc/rc.local` file to enable Home Assistant to start when the jail s
|
||||
|
||||
|
||||
```bash
|
||||
# cd / && mkdir /home && /home/.homeassistant/
|
||||
# cd / && mkdir -p /home/.homeassistant
|
||||
```
|
||||
|
||||
```bash
|
||||
|
||||
@ -72,6 +72,8 @@ Start Home Assistant for the first time. This will complete the installation, cr
|
||||
```bash
|
||||
(homeassistant) $ hass
|
||||
```
|
||||
|
||||
You can now reach your installation on your Raspberry Pi over the web interface on [http://ipaddress:8123](http://ipaddress:8123).
|
||||
|
||||
<p class='note'>
|
||||
When you run the `hass` command for the first time, it will download, install and cache the necessary libraries/dependencies. This procedure may take anywhere between 5 to 10 minutes. During that time, you may get "site cannot be reached" error when accessing the web interface. This will only happen for the first time, and subsequent restarts will be much faster.
|
||||
</p>
|
||||
|
||||
@ -12,36 +12,57 @@ redirect_from: /getting-started/installation-virtualenv/
|
||||
|
||||
If you already have Python 3.5 or later installed, you can easily give Home Assistant a spin.
|
||||
|
||||
It's recommended when installing Python packages that you use a virtual environment. This will make sure that your Python installation and Home Assistant installation won't impact one another.
|
||||
It's recommended when installing Python packages that you use a [virtual environment](https://docs.python.org/3.5/library/venv.html#module-venv). This will make sure that your Python installation and Home Assistant installation won't impact one another. The following steps will work on most unix like systems.
|
||||
|
||||
_(If you're on a Debian based system, you will need to install Python virtual environment support using `apt-get install python3-pip python3-venv`.)_
|
||||
|
||||
1. Create a virtual environment:
|
||||
### {% linkable_title Install %}
|
||||
|
||||
1. Create a virtual environment in your current directory:
|
||||
```
|
||||
$ python3 -m venv homeassistant
|
||||
```
|
||||
2. Open virtual environment:
|
||||
2. Open the virtual environment:
|
||||
```
|
||||
$ cd homeassistant
|
||||
```
|
||||
3. Activate virtual environment:
|
||||
3. Activate the virtual environment:
|
||||
```
|
||||
$ source bin/activate
|
||||
```
|
||||
4. Install Home Assistant:
|
||||
```
|
||||
$ python3 -m pip install --upgrade homeassistant
|
||||
$ python3 -m pip install homeassistant
|
||||
```
|
||||
5. Run Home Assistant:
|
||||
5. Configure it to [autostart](docs/autostart/)
|
||||
6. Or run Home Assistant manually:
|
||||
```
|
||||
$ hass --open-ui
|
||||
```
|
||||
|
||||
### {% linkable_title Upgrade %}
|
||||
|
||||
1. Stop Home Assistant
|
||||
|
||||
2. Open the directory where the virtual environment is located:
|
||||
```
|
||||
$ cd homeassistant
|
||||
```
|
||||
3. Activate the virtual environment:
|
||||
```
|
||||
$ source bin/activate
|
||||
```
|
||||
4. Upgrade Home Assistant:
|
||||
```
|
||||
$ python3 -m pip install --upgrade homeassistant
|
||||
```
|
||||
5. Start Home Assistant
|
||||
|
||||
### {% linkable_title Notes %}
|
||||
|
||||
- In the future, if you want to start Home Assistant again, follow step 2, 3 and 5.
|
||||
- If you want to upgrade Home Assistant, follow step 2, 3 and 4.
|
||||
- In the future, if you want to start Home Assistant manually again, follow step 2, 3 and 5.
|
||||
- It's recommanded to run Home Assistant as a dedicated user.
|
||||
|
||||
<p class='info'>
|
||||
Looking for more advanced guides? Check our [Rasbian guide](/docs/installation/raspberry-pi/) or the [available installation guides](/docs/installation/]. For details about autostarting, refer to the [autostart section](/docs/autostart/) in the documentation.
|
||||
Looking for more advanced guides? Check our [Rasbian guide](/docs/installation/raspberry-pi/) or the [other installation guides](/docs/installation/).
|
||||
</p>
|
||||
|
||||
@ -26,13 +26,19 @@ Don't use the OpenZWave control panel (OZWCP), **or the physical button on a con
|
||||
|
||||
When you add a device, it may initially appear without a specific entity ID (eg `zwave.__`) and without other identifying information. Running a *Heal* should help speed this process up, and you'll need to run a *Heal* anyway so that all the devices in your Z-Wave network learn about the new device. You *might* need to restart Home Assistant (not reboot the system) to have the entity ID fully visible.
|
||||
|
||||
## {% linkable_title Adding Secure Devices %}
|
||||
## {% linkable_title Network Key %}
|
||||
|
||||
Security Z-Wave devices require a network key. You must set the *network_key* configuration variable to use a network key before adding these devices. Some devices only expose their full capabilities when included this way, you should always read the manual for your device to find out the recommended inclusion method. Note, secure devices that had been connected to another hub/network in the past may have a "theft protection" feature which requires to first exclude the device successfully from the previous hub using the previous hub/Software setup before it can be enrolled in a new hub/network. To add (include) a secure Z-Wave device:
|
||||
Security Z-Wave devices require a network key. Some devices only expose their full capabilities when included this way. You should always read the manual for your device to find out the recommended inclusion method. Note, secure devices that had been connected to another hub/network in the past may have a "theft protection" feature which requires to first exclude the device successfully from the previous hub using the previous hub/Software setup before it can be enrolled in a new hub/network.
|
||||
|
||||
1. Go to the [Z-Wave control panel](/docs/z-wave/control-panel/) in the Home Assistant frontend
|
||||
2. Click the **Add Node Secure** button in the *Z-Wave Network Management* card - this will place the controller in inclusion mode
|
||||
3. Activate your device to be included by following the instructions provided with the device
|
||||
A valid network key will be a 16 byte value, defined in the zwave section of your configuration, such as the following example:
|
||||
|
||||
```
|
||||
zwave:
|
||||
usb_path: /dev/ttyACM0
|
||||
network_key: "0x01, 0x02, 0x03, 0x04, 0x05, 0x06, 0x07, 0x08, 0x09, 0x0A, 0x0B, 0x0C, 0x0D, 0x0E, 0x0F 0x10"
|
||||
```
|
||||
|
||||
Each individual value in the defined key can be anywhere from 0x00 to 0xFF. Define your own key by making changes to the above example key or for additional security try one of the two scripts mentioned below.
|
||||
|
||||
### {% linkable_title Network Key %}
|
||||
|
||||
@ -50,6 +56,14 @@ cat /dev/urandom | LC_CTYPE=C tr -dc '0-9A-F' | fold -w 32 | head -n 1 | sed -e
|
||||
Ensure you keep a backup of this key. If you have to rebuild your system and don't have a backup of this key, you won't be able to reconnect to any security devices. This may mean you have to do a factory reset on those devices, and your controller, before rebuilding your Z-Wave network.
|
||||
</p>
|
||||
|
||||
## {% linkable_title Adding Secure Devices %}
|
||||
|
||||
After defining your network key, follow these steps to add (include) a secure Z-Wave device:
|
||||
|
||||
1. Go to the [Z-Wave control panel](/docs/z-wave/control-panel/) in the Home Assistant frontend
|
||||
2. Click the **Add Node Secure** button in the *Z-Wave Network Management* card - this will place the controller in inclusion mode
|
||||
3. Activate your device to be included by following the instructions provided with the device
|
||||
|
||||
## {% linkable_title Removing Devices %}
|
||||
|
||||
To remove (exclude) a Z-Wave device from your system:
|
||||
|
||||
@ -208,10 +208,18 @@ Below is a table of the action/scenes for the Wallmote (as a reference for other
|
||||
|
||||
**Action**|**scene\_id**|**scene\_data**
|
||||
:-----:|:-----:|:-----:
|
||||
Button one single tap|1|TBC
|
||||
Button two single tap|2|TBC
|
||||
Button three single tap|3|TBC
|
||||
Button four single tap|4|TBC
|
||||
Button one single tap|1|0
|
||||
Button one hold|1|2
|
||||
Button one release|1|1
|
||||
Button two single tap|2|0
|
||||
Button two hold|2|2
|
||||
Button two release|2|1
|
||||
Button three single tap|3|0
|
||||
Button three hold|3|2
|
||||
Button three release|3|1
|
||||
Button four single tap|4|0
|
||||
Button four hold|4|2
|
||||
Button four release|4|1
|
||||
|
||||
### {% linkable_title Zooz Toggle Switches %}
|
||||
|
||||
|
||||
44
source/_posts/2017-12-28-thank-you.markdown
Normal file
44
source/_posts/2017-12-28-thank-you.markdown
Normal file
@ -0,0 +1,44 @@
|
||||
---
|
||||
layout: post
|
||||
title: "Thank You"
|
||||
description: "Thanks to all our contributors, dependencies and companies that help make Home Assistant awesome."
|
||||
date: 2017-12-28 22:00:00 UTC
|
||||
date_formatted: "December 28, 2017"
|
||||
author: Fabian affolter
|
||||
author_twitter: fabaff
|
||||
comments: true
|
||||
categories: Community
|
||||
og_image:
|
||||
---
|
||||
|
||||
2017 is almost over and this means it's time to do a little recap of our 2017. This was a great year for Home Assistant. Again, we were able to stick to our bi-weekly release cycle. There were 25 releases over the year and each release included the work of around 60 contributors.
|
||||
|
||||
We got 10.000 stars on [GitHub], reached 10.000 commits in the main repo (over 4300 were made in 2017), got a [Thomas-Krenn award], participated in [Hacktoberfest], we have now almost 1000 integrations (the exact number is 938), we [moved to Discord] and we are up to over 2 million pageviews per month on our forum. Beside that we announced the [Home Assistant cloud] and have regular [Home Assistant Podcasts].
|
||||
|
||||
We also do not want to forget to mention [Hass.io] and all the great Hass.io add-ons.
|
||||
|
||||
Uff, what a year...Thank you, dear community for being so helpful, supportive and awesome 🙇.
|
||||
|
||||
A very big thanks goes out to the developers of the Python language and all the open source libraries and tools that Home Assistant depends on. You are the foundation for our success and all of you can be proud of yourself.
|
||||
|
||||
We would also like to thanks all the companies that offer their services for free to open source projects. Without these we would not be able to operate at our speed or scale. Thank you [GitHub], [TravisCI], [CloudFlare], [Discord] and [Discourse]!
|
||||
|
||||
Some of us are taking a break and spending some quality time with family and loved ones.
|
||||
|
||||
Stay tuned for more Home Assistant awesomeness in 2018. We will keep the pace but first: Happy New Year!
|
||||
|
||||
-- Home Assistant Organization
|
||||
|
||||
[CloudFlare]: https://CloudFlare.com
|
||||
[Discord]: https://discordapp.com
|
||||
[Discourse]: https://Discourse.com
|
||||
[forum]: https://community.home-assistant.io
|
||||
[GitHub]: https://GitHub.com
|
||||
[Hacktoberfest]: /blog/2017/11/04/release-57/#hacktoberfest
|
||||
[Hass.io]: https://home-assistant.io/hassio/
|
||||
[Home Assistant cloud]: /blog/2017/12/17/introducing-home-assistant-cloud/
|
||||
[Home Assistant Podcasts]: https://hasspodcast.io/
|
||||
[moved to Discord]: /blog/2017/07/03/home-assistant-is-moving-to-discord/
|
||||
[Thomas-Krenn award]: /blog/2017/04/01/thomas-krenn-award/
|
||||
[TravisCI]: https://Travis-ci.org
|
||||
|
||||
Binary file not shown.
|
Before Width: | Height: | Size: 4.7 KiB After Width: | Height: | Size: 29 KiB |
Loading…
x
Reference in New Issue
Block a user