jeena/home-assistant.github.io
1
0
Fork 0
Code Issues Pull requests Projects Packages Wiki Activity Actions

Merge remote-tracking branch 'origin/current' into next

Browse source
This commit is contained in:
Paulus Schoutsen 2017-10-05 09:24:55 -07:00
commit f9e3f7e099
54 changed files with 398 additions and 296 deletions
Download patch file Download diff file Expand all files Collapse all files

2
source/_docs/automation/trigger.markdown
View file

@ -56,7 +56,7 @@ automation:
```
### {% linkable_title Numeric state trigger %}
On state change of a specified entity, attempts to parse the state as a number and triggers if value is above and/or below a threshold.
On state change of a specified entity, attempts to parse the state as a number and triggers once if value is changing from above to below a threshold, or from below to above the given threshold.
```yaml
automation:

2
source/_docs/configuration/group_visibility.markdown
View file

@ -104,7 +104,7 @@ sensor:
command: "python3 occasion.py"
```
<p class='note'>
If you are using docker to run home assistant then the occasion.py script will be placed under /config. Your command should instead be: command: "python3 /command/occasion.py"
If you are using docker to run Home Assistant then the occasion.py script will be placed under /config. Your command should instead be: command: "python3 /command/occasion.py"
</p>

6
source/_docs/ecosystem/apache.markdown
View file

@ -14,7 +14,7 @@ This example demonstrates how you can configure Apache to act as a proxy for Hom
This is useful if you want to have:
* a subdomain redirecting to your home assistant instance
* a subdomain redirecting to your Home Assistant instance
* several subdomain for several instance
* HTTPS redirection
@ -73,8 +73,8 @@ You already have Home Assistant running on http://localhost:8123 and available a
You want another instance available at https://countryside.example.org
You can either :
* Create a new user, `bob`, to hold the configuration file in `/home/bob/.homeassistant/configuration.yaml` and run home assistant as this new user
* Create another configuration directory in `/home/alice/.homeassistan2/configuration.yaml` and run home assistant using `hass --config /home/alice/.homeassistant2/`
* Create a new user, `bob`, to hold the configuration file in `/home/bob/.homeassistant/configuration.yaml` and run Home Assistant as this new user
* Create another configuration directory in `/home/alice/.homeassistan2/configuration.yaml` and run Home Assistant using `hass --config /home/alice/.homeassistant2/`
In both solution, change port number used by modifying `configuration.yaml`

2
source/_docs/ecosystem/appdaemon/api.markdown
View file

@ -1552,7 +1552,7 @@ The custom event `MODE_CHANGE` would be subscribed to with:
self.listen_event(self.mode_event, "MODE_CHANGE")
```
Home Assistant can send these events in a variety of other places - within automations, and also directly from Alexa intents. Home Assistant can also listen for custom events with it's automation component. This can be used to signal from AppDaemon code back to home assistant. Here is a sample automation:
Home Assistant can send these events in a variety of other places - within automations, and also directly from Alexa intents. Home Assistant can also listen for custom events with it's automation component. This can be used to signal from AppDaemon code back to Home Assistant. Here is a sample automation:
```yaml
automation:

4
source/_docs/ecosystem/appdaemon/configuration.markdown
View file

@ -31,13 +31,13 @@ module = hello
class = HelloWorld
```
- `ha_url` is a reference to your home assistant installation and must include the correct port number and scheme (`http://` or `https://` as appropriate)
- `ha_url` is a reference to your Home Assistant installation and must include the correct port number and scheme (`http://` or `https://` as appropriate)
- `ha_key` should be set to your key if you have one, otherwise it can be removed.
- `logfile` (optional) is the path to where you want `AppDaemon` to keep its main log. When run from the command line this is not used - log messages come out on the terminal. When running as a daemon this is where the log information will go. In the example above I created a directory specifically for AppDaemon to run from, although there is no reason you can't keep it in the `appdaemon` directory of the cloned repository. If `logfile = STDOUT`, output will be sent to stdout instead of stderr when running in the foreground, if not specified, output will be sent to STDOUT.
- `errorfile` (optional) is the name of the logfile for errors - this will usually be errors during compilation and execution of the apps. If `errorfile = STDERR` errors will be sent to stderr instead of a file, if not specified, output will be sent to STDERR.
- `app_dir` (optional) is the directory the apps are placed in. If not specified, AppDaemon will look first in `~/.homeassistant` then `/etc/appdaemon` for a subdirectory named `apps`
- `threads` - the number of dedicated worker threads to create for running the apps. Note, this will bear no resembelance to the number of apps you have, the threads are re-used and only active for as long as required to tun a particular callback or initialization, leave this set to 10 unless you experience thread starvation
- `latitude`, `longitude`, `elevation`, `timezone` - should all be copied from your home assistant configuration file
- `latitude`, `longitude`, `elevation`, `timezone` - should all be copied from your Home Assistant configuration file
- `cert_path` (optional) - path to root CA cert directory - use only if you are using self signed certs.
The `#Apps` section is the configuration for the Hello World program and should be left in place for initial testing but can be removed later if desired, as other Apps are added, App configuration is described in the [API doc](API.md).

2
source/_docs/ecosystem/ios/notifications/sounds.markdown
View file

@ -37,7 +37,7 @@ The app allows you to use your own custom sounds in push notifications. The soun
2. Go to the device in iTunes.
3. Select "Apps" on the left sidebar.
4. Scroll down until you see the section labeled "File Sharing".
5. Select HomeAssistant.
5. Select Home Assistant.
6. Drag and drop properly formatted sounds.
7. Click Sync in the lower right.
8. Once sync is complete, disconnect the device from the computer.

6
source/_docs/ecosystem/nginx_subdomain.markdown
View file

@ -13,7 +13,7 @@ This example demonstrates how you can configure NGINX to act as a proxy for Home
This is useful if you want to have:
* a subdomain redirecting to your home assistant instance
* a subdomain redirecting to your Home Assistant instance
* several subdomain for several instance
* HTTPS redirection
@ -63,8 +63,8 @@ You already have Home Assistant running on http://localhost:8123 and available a
You want another instance available at https://countryside.example.org
You can either :
* Create a new user, `bob`, to hold the configuration file in `/home/bob/.homeassistant/configuration.yaml` and run home assistant as this new user
* Create another configuration directory in `/home/alice/.homeassistan2/configuration.yaml` and run home assistant using `hass --config /home/alice/.homeassistant2/`
* Create a new user, `bob`, to hold the configuration file in `/home/bob/.homeassistant/configuration.yaml` and run Home Assistant as this new user
* Create another configuration directory in `/home/alice/.homeassistan2/configuration.yaml` and run Home Assistant using `hass --config /home/alice/.homeassistant2/`
In both solution, change port number used by modifying `configuration.yaml` file.

2
source/_docs/ecosystem/scenegen.markdown
View file

@ -100,7 +100,7 @@ For a more advanced way to use the output try the following. In configuration.ya
scene: !include_dir_list scenes
```
This will tell home assistant to look in the subdirectory `scenes` for yaml files containing scene information. Each file will be named for the scene it will create and should contain information formatted as above. Then simply run Scenegen and redirect its output to the scenes subdirectory:
This will tell Home Assistant to look in the subdirectory `scenes` for yaml files containing scene information. Each file will be named for the scene it will create and should contain information formatted as above. Then simply run Scenegen and redirect its output to the scenes subdirectory:
```
$ ./scenegen.py https://<some url> -k <some api key> > scenes/my_new_scene.yaml

6
source/_docs/frontend/browsers.markdown
View file

@ -12,6 +12,8 @@ redirect_from: /getting-started/browsers/
Home Assistant requires a web browser to show the frontend and supports all major modern browsers. We don't test the web interface against all available browsers but this page tracks different browsers on various operating systems and should help you to pick a browser which works.
If a browser is listed as working but you are still having problems, it is possible that some add-on or extension may be the problem. Some add-ons or extenstion are known to cause issue with the frontend, but it's not possible to test them all. If you are having issues with the frontend displaying correctly, you should disable all your add-ons or extensions and enable them one at a time.
We would appreciate if you help to keep this page up-to-date and add feedback.
## {% linkable_title Microsoft Windows %}
@ -20,8 +22,8 @@ We would appreciate if you help to keep this page up-to-date and add feedback.
| :------------------------ |:---------------|:-----------|:-------------------------|
| Internet Explorer ([IE]) | 11 | Not supported | Does not support promises. |
| Microsoft [Edge] | deli. Win 10 | works | Streaming updates not working. |
| [Chrome] | 50.0.2661.102 | works | |
| [Firefox] | 43.0.1 | works | |
| [Chrome] | 61.0.3163.100 | works | |
| [Firefox] | 56.0 | works | |
| [Iridium] | 48.2 | works | |
| [Opera] | 42.0.2393.351 | works | |

2
source/_docs/installation.markdown
View file

@ -99,5 +99,5 @@ For more details about `hass`, please refer to the [tools section](/docs/tools/h
If you're running a Linux-based platform, we suggest you follow the [VirtualEnv instructions](/docs/installation/virtualenv/) to avoid using `root`.
It may be needed that you install additional library depending on the platforms/components you want to use.
You may need to install additional libraries depending on the platforms/components you want to use.

6
source/_docs/installation/centos.markdown
View file

@ -27,7 +27,7 @@ Then install the Python 3.5 package:
$ yum install rh-python35
```
Once installed, switch to your homeassistant user (if you've set one up), enable the software collection and check that it has set up the new version of Python:
Once installed, switch to your `homeassistant` user (if you've set one up), enable the software collection and check that it has set up the new version of Python:
```bash
$ scl enable rh-python35 bash
@ -35,13 +35,13 @@ $ python --version
Python 3.5.1
```
You will be in a command shell set up with Python 3.5 as your default version. The virtualenv and pip commands will be correct for this version, so you can now create a virtual environment and install home assistant following the main [instructions](https://home-assistant.io/docs/installation/virtualenv/#step-4-set-up-the-virtualenv).
You will be in a command shell set up with Python 3.5 as your default version. The virtualenv and pip commands will be correct for this version, so you can now create a virtual environment and install Home Assistant following the main [instructions](https://home-assistant.io/docs/installation/virtualenv/#step-4-set-up-the-virtualenv).
You will need to enable the software collection each time you log on before you activate your virtual environment.
### {% linkable_title Systemd with Software Collections %}
To autostart homeassistant using systemd follow the main [instructions](https://home-assistant.io/docs/autostart/systemd/) and adjust the template as follows:
To autostart Home Assistant using systemd follow the main [instructions](https://home-assistant.io/docs/autostart/systemd/) and adjust the template as follows:
```
[Unit]

2
source/_docs/installation/troubleshooting.markdown
View file

@ -70,5 +70,5 @@ $ iptables-save > /etc/network/iptables.rules # your rules may be saved elsewhe
After upgrading to a new version, you may notice your browser gets stuck at the "loading data" login screen. Close the window/tab and go into your browser settings and delete all the cookies for your URL. You can then log back in and it should work.
Android Chrome
chrome -> settings -> site settings -> storage -> search for your URL for home assistant-> "clear & reset"
chrome -> settings -> site settings -> storage -> search for your URL for Home Assistant-> "clear & reset"

10
source/_docs/mqtt/discovery.markdown
View file

@ -11,7 +11,7 @@ logo: mqtt.png
redirect_from: /components/mqtt/#discovery
---
The discovery of MQTT devices will enable one to use MQTT devices with only minimal configuration effort on the side of Home Assistant. The configuration is done on the device itself and the topic used by the device. Similar to the [HTTP binary sensor](/components/binary_sensor.http/) and the [HTTP sensor](/components/sensor.http/).
The discovery of MQTT devices will enable one to use MQTT devices with only minimal configuration effort on the side of Home Assistant. The configuration is done on the device itself and the topic used by the device. Similar to the [HTTP binary sensor](/components/binary_sensor.http/) and the [HTTP sensor](/components/sensor.http/). The basic idea is that the device itself adds its configuration into your `configuration.yaml` automatically. To prevent multiple identical entries if a device reconnects a unique identifier is necessary. Two parts are required on the device side: The configuration topic which contains the necessary device type and unique identifier and the remaining device configuration without the device type.
Supported by MQTT discovery:
@ -84,3 +84,11 @@ Set the state.
```bash
$ mosquitto_pub -h 127.0.0.1 -p 1883 -t "homeassistant/switch/irrigation/set" -m ON
```
Setting up a sensor with multiple measurement values requires multiple consecutive configuration topic submissions.
- Configuration topic no1: `homeassistant/sensor/sensorBedroomT/config`
- Configuration payload no1: `{"device_class": "sensor", "name": "Temperature", "state_topic": "homeassistant/sensor/sensorBedroom/state", "unit_of_measurement": "°C", "value_template": "{{ value_json.temperature}}" }`
- Configuration topic no2: `homeassistant/sensor/sensorBedroomH/config`
- Configuration payload no2: `{"device_class": "sensor", "name": "Humidity", "state_topic": "homeassistant/sensor/sensorBedroom/state", "unit_of_measurement": "%", "value_template": "{{ value_json.humidity}}" }`
- Common state payload: `{ "temperature": 23.20, "humidity": 43.70 }`