diff --git a/_config.yml b/_config.yml index d0cf0b4ca15..f75ef6d8ad2 100644 --- a/_config.yml +++ b/_config.yml @@ -77,6 +77,8 @@ collections: output: true addons: output: true + faq: + output: true # ----------------------- # # 3rd Party Settings # @@ -141,12 +143,12 @@ social: # Home Assistant release details current_major_version: 0 current_minor_version: 47 -current_patch_version: 0 -date_released: 2017-06-17 +current_patch_version: 1 +date_released: 2017-06-21 # Either # or the anchor link to latest release notes in the blog post. # Must be prefixed with a # and have double quotes around it. # Major release: -patch_version_notes: "#" +patch_version_notes: "#release-0471---june-21" # Minor release (Example #release-0431---april-25): diff --git a/source/_addons/dnsmasq.markdown b/source/_addons/dnsmasq.markdown index dd1e52a5170..31ddd01fcfd 100644 --- a/source/_addons/dnsmasq.markdown +++ b/source/_addons/dnsmasq.markdown @@ -11,10 +11,6 @@ footer: true Setup and manage a [Dnsmasq](http://thekelleys.org.uk/dnsmasq/doc.html) dns server. This allow your to manipulate some dns requests. I.e. that inside your network, your homeassistant domain will resolve with a internal address. -

-At the moment, it will not work with resinos! -

- ```json { "defaults": ["8.8.8.8", "8.8.4.4"], @@ -24,6 +20,7 @@ At the moment, it will not work with resinos! "hosts": [ {"host": "home.mydomain.io", "ip": "192.168.1.10"} ], + "interface": "eth1" } ``` @@ -32,3 +29,4 @@ Configuration variables: - **defaults** (*Required*): A list of dns server to forward default requests. - **forwards** (*Optional*): A list of domains that will forward to a specific server. - **hosts** (*Optional*): A list of hosts to resolve it static. +- **interface** (*Optional*): If a interface is set, it listen only on this interface. Need to set for resinos. diff --git a/source/_components/image_processing.dlib_face_identify.markdown b/source/_components/image_processing.dlib_face_identify.markdown index f7f1ab1e75b..1e47bf13e40 100644 --- a/source/_components/image_processing.dlib_face_identify.markdown +++ b/source/_components/image_processing.dlib_face_identify.markdown @@ -13,7 +13,7 @@ featured: false ha_release: 0.44 --- -The `dlib_face_identify` image processing platform allows you to use the [Dlib](http://www.dlib.net/) through Home Assistant. This platform allow you do identify persons on camera and fire a event with identify persons. +The `dlib_face_identify` image processing platform allows you to use the [Dlib](http://www.dlib.net/) through Home Assistant. This platform allow you to identify persons on camera and fire a event with identify persons. For using the result inside an automation rule, take a look at the [component](/components/image_processing/) page. diff --git a/source/_components/python_script.markdown b/source/_components/python_script.markdown index ddb26a0e7e8..48bd6a1a149 100644 --- a/source/_components/python_script.markdown +++ b/source/_components/python_script.markdown @@ -43,3 +43,5 @@ hass.bus.fire(name, { "wow": "from a Python script!" }) "name": "you" } ``` + +For [`python_script:` examples](/components/python_script/) visit the [Scripts section](https://community.home-assistant.io/c/projects/scripts) in our forum. diff --git a/source/_components/sensor.buienradar.markdown b/source/_components/sensor.buienradar.markdown index 25b5bd45799..94d354fbd56 100644 --- a/source/_components/sensor.buienradar.markdown +++ b/source/_components/sensor.buienradar.markdown @@ -10,11 +10,11 @@ footer: true logo: buienradar.png ha_category: Weather ha_release: 0.47 +ha_iot_class: "Cloud Polling" --- -The `buienradar` platform uses [buienradar.nl](http://buienradar.nl/) as an source for current meteorological data for your location. The -weather forecast is delivered by Buienradar, who provides a webservice that provides detailed weather information for users in The Netherlands. +The `buienradar` platform uses [buienradar.nl](http://buienradar.nl/) as an source for current meteorological data for your location. The weather forecast is delivered by Buienradar, who provides a webservice that provides detailed weather information for users in The Netherlands. The relevant weatherstation used will be automatically selected based on the location specified in the Home Assistant configuration (or in the buienradar weather/sensor component). To integrate `buienradar` with Home Assistant, add the following section to your `configuration.yaml` file: @@ -33,11 +33,10 @@ sensor: Configuration variables: -- **platform** (*Required*): buienradar. -- **latitude** (*Optional*): latitude to use for selection of data source location. Longitude & latitude will be taken from Home Assistant configuration, but can be overridden/changed in this component to select a different location for buienradar. -- **longitude** (*Optional*): longitude to use for selection of data source location. Longitude & latitude will be taken from Home Assistant configuration, but can be overridden/changed in this component to select a different location for buienradar. -- **monitored_conditions** array (*Required*): one or more conditions to display in the frontend. - - **stationname**: the name of the selected meteo-station. +- **latitude** (*Optional*): Latitude to use for selection of data source location. Longitude and latitude will be taken from Home Assistant configuration, but can be overridden/changed in this component to select a different location for buienradar. +- **longitude** (*Optional*): Longitude to use for selection of data source location. Longitude & latitude will be taken from Home Assistant configuration, but can be overridden/changed in this component to select a different location for buienradar. +- **monitored_conditions** array (*Required*): One or more conditions to display in the frontend. + - **stationname**: The name of the selected meteo-station. - **symbol**: A symbol for the current weather. - **humidity**: The relative humidity (%). - **temperature**: The current temperature (in C). @@ -45,11 +44,11 @@ Configuration variables: - **windspeed**: The wind speed in m/s. - **windforce**: The wind speed/force in Bft. - **winddirection**: Where the wind is coming from in degrees, with true north at 0° and progressing clockwise. - - **windazimuth**: Where the wind is coming from: N (North),Z (south), NO (Noth-East), etc.. + - **windazimuth**: Where the wind is coming from: N (North),Z (south), NO (Noth-East), etc. - **pressure**: The sea-level air pressure in hPa. - **visibility**: Visibility in meters (m). - **windgust**: The windspeed of wind gusts (m/s). - - **precipitation**: the amount of precipitation/rain in mm/h. + - **precipitation**: The amount of precipitation/rain in mm/h. - **irradiance**: Sun intensity in Watt per square meter (W/m2). Full configuration example where location is manually specified: diff --git a/source/_components/sensor.radarr.markdown b/source/_components/sensor.radarr.markdown index c31402ea428..48ddacc1fee 100644 --- a/source/_components/sensor.radarr.markdown +++ b/source/_components/sensor.radarr.markdown @@ -15,7 +15,7 @@ ha_release: 0.47 This `radarr` sensor platform pulls data from a given Radarr instance. -To use your [Radarr](https://radarr.tv/) sensor in your installation, add the following to your `configuration.yaml` file: +To use your [Radarr](https://radarr.video/) sensor in your installation, add the following to your `configuration.yaml` file: ```yaml # Example configuration.yml entry diff --git a/source/_components/weather.buienradar.markdown b/source/_components/weather.buienradar.markdown index b154475b766..4c1994705b1 100644 --- a/source/_components/weather.buienradar.markdown +++ b/source/_components/weather.buienradar.markdown @@ -10,10 +10,10 @@ footer: true logo: buienradar.png ha_category: Weather ha_release: 0.47 +ha_iot_class: "Cloud Polling" --- -The `buienradar` platform uses [buienradar.nl](http://buienradar.nl/) as an source for current meteorological data for your location. The -weather forecast is delivered by Buienradar, who provides a webservice that provides detailed weather information for users in The Netherlands. +The `buienradar` platform uses [buienradar.nl](http://buienradar.nl/) as an source for current meteorological data for your location. The weather forecast is delivered by Buienradar, who provides a webservice that provides detailed weather information for users in The Netherlands. The relevant weatherstation used will be automatically selected based on the location specified in the Home Assistant configuration (or in the buienradar weather/sensor component). To add the buienradar weather to your installation, add the following to your `configuration.yaml` file: @@ -25,15 +25,16 @@ weather: ``` Configuration variables: -- **platform** (*Required*): buienradar -- **latitude** (*Optional*): latitude to use for selection of data source location. Longitude & latitude will be taken from Home Assistant configuration, but can be overridden/changed in this component to select a different location for buienradar. -- **longitude** (*Optional*): longitude to use for selection of data source location. Longitude & latitude will be taken from Home Assistant configuration, but can be overridden/changed in this component to select a different location for buienradar. -- **forecast** (*Optional*): 'True' to add a temperature forecast, 'False' to suppress it + +- **latitude** (*Optional*): Latitude to use for selection of data source location. Longitude & latitude will be taken from Home Assistant configuration, but can be overridden/changed in this component to select a different location for buienradar. +- **longitude**(*Optional*): Longitude to use for selection of data source location. Longitude & latitude will be taken from Home Assistant configuration, but can be overridden/changed in this component to select a different location for buienradar. +- **forecast** (*Optional*): 'True' to add a temperature forecast, 'False' to suppress it. A full configuration example: ```yaml +# Example configuration.yaml entry weather: - platform: buienradar name: buienradar diff --git a/source/_docs/configuration/events.markdown b/source/_docs/configuration/events.markdown index 48cb5df1af0..5219757d73f 100644 --- a/source/_docs/configuration/events.markdown +++ b/source/_docs/configuration/events.markdown @@ -17,7 +17,6 @@ Home Assistant contains a few built-in events that are used to coordinate betwee ### {% linkable_title Event `homeassistant_start` %} Event `homeassistant_start` is fired when all components from the configuration have been intitialized. This is the event that will start the timer firing off `time_changed` events. - ### {% linkable_title Event `homeassistant_stop` %} Event `homeassistant_stop` is fired when Home Assistant is shutting down. It should be used to close any open connection or release any resources. diff --git a/source/_docs/installation/freenas.markdown b/source/_docs/installation/freenas.markdown index cdda8f6b1d7..b333f400d2d 100644 --- a/source/_docs/installation/freenas.markdown +++ b/source/_docs/installation/freenas.markdown @@ -2,7 +2,7 @@ layout: page title: "Installation on FreeNAS 9.10" description: "Installation of Home Assistant on your FreeNAS." -date: 2017-04-06 17:00 +date: 2017-06-20 11:00 sidebar: true comments: false sharing: true @@ -29,10 +29,20 @@ Install Home Assistant itself. # pip3 install homeassistant ``` -Finally start Home Assistant. +Create an `/etc/rc.local` file to enable Home Assistant to start when the jail starts. The command in `/etc/rc.local` can also be run in a terminal session but Home Assistant will exit when that session is closed. ```bash -# hass --open-ui +# /usr/local/bin/hass --open-ui --config /home/.homeassistant/ & ``` -Some suggestions on using a tmux to keep it running can be found in the FreeNAS forums [HERE](https://forums.freenas.org/index.php?threads/how-to-home-assistant-in-a-jail-tested-on-9-10.50371/) +Make `/etc/rc.local` executable so it runs on startup + +```bash +# chmod 755 /etc/rc.local +``` + +Finally restart the jail from the Freenas GUI. + +

+USB Z-wave sticks may give `dmesg` warnings similar to "data interface 1, has no CM over data, has no break". This doesn't impact the function of the Z-wave stick in Hass. Just make sure the proper `/dev/cu*` is used in the Home Assistant `configuration.yaml` file. +

diff --git a/source/_docs/mqtt/broker.markdown b/source/_docs/mqtt/broker.markdown index 55e3a8a1463..6a89113b26b 100644 --- a/source/_docs/mqtt/broker.markdown +++ b/source/_docs/mqtt/broker.markdown @@ -31,9 +31,13 @@ Home Assistant contains an embedded MQTT broker. If no broker configuration is g mqtt: ``` -

-This broker does not currently work with OwnTracks because of a protocol version issue. -

+### {% linkable_title Owntracks%} + +To use Owntracks with the internal broker a small configuration change must be made in order for the app to use MQTT protocol 3.1.1 (Protocol Level 4). + +In the Owntracks preferences (Android: v1.2.3+, iOS: v9.5.1+) open **Configuration Management**; Find the value named `mqttProtocolLevel` and set the value to `4`. The application will now use MQTT 3.1.1 to connect, which is compatible with the embedded broker. + +### {% linkable_title Settings %} If you want to customize the settings of the embedded broker, use `embedded:` and the values shown in the [HBMQTT Broker configuration](http://hbmqtt.readthedocs.org/en/latest/references/broker.html#broker-configuration). This will replace the default configuration. diff --git a/source/_docs/tools/scripts.markdown b/source/_docs/tools/scripts.markdown index c5b0cce18a8..896632aeeeb 100644 --- a/source/_docs/tools/scripts.markdown +++ b/source/_docs/tools/scripts.markdown @@ -37,7 +37,7 @@ $ hass --script keyring ### {% linkable_title Benchmark %} -For testing the performance of Home Assistant the Benchmark scipt runs until you exit using Control+C. +For testing the performance of Home Assistant the Benchmark script runs until you exit using Control+C. Firing and handling of a million events. diff --git a/source/_docs/z-wave.markdown b/source/_docs/z-wave.markdown index c00488faef3..615cbb9b5db 100644 --- a/source/_docs/z-wave.markdown +++ b/source/_docs/z-wave.markdown @@ -154,7 +154,7 @@ Example: platform: event event_type: zwave.node_event event_data: - object_id: aeon_labs_minimote_1 + entity_id: zwave.aeon_labs_minimote_1 basic_level: 255 ``` @@ -172,7 +172,7 @@ automation: platform: event event_type: zwave.scene_activated event_data: - object_id: zwaveme_zme_wallcs_secure_wall_controller_8 + entity_id: zwave.zwaveme_zme_wallcs_secure_wall_controller_8 scene_id: 11 ``` diff --git a/source/_faq/after-upgrading.markdown b/source/_faq/after-upgrading.markdown new file mode 100644 index 00000000000..1c137fc726f --- /dev/null +++ b/source/_faq/after-upgrading.markdown @@ -0,0 +1,16 @@ +--- +layout: page +title: "After upgrading, your browser login gets stuck" +description: "After upgrading, your browser login gets stuck" +date: 2017-06-18 09:00 +comments: false +sharing: true +footer: true +ha_category: Usage +--- + + +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" diff --git a/source/_faq/component.markdown b/source/_faq/component.markdown new file mode 100644 index 00000000000..0f46cf01cf7 --- /dev/null +++ b/source/_faq/component.markdown @@ -0,0 +1,15 @@ +--- +layout: page +title: "My component does not show up" +description: "My component does not show up" +date: 2017-06-18 09:00 +comments: false +sharing: true +footer: true +ha_category: Configuration +--- + + +When a component does not show up, many different things can be the case. Before you try any of these steps, make sure to look at the `home-assistant.log` file and see if there are any errors related to your component you are trying to set up. + +If you have incorrect entries in your configuration files you can use the `check_config` script to assist in identifying them: `hass --script check_config`. diff --git a/source/_faq/connection-error.markdown b/source/_faq/connection-error.markdown new file mode 100644 index 00000000000..3acb6edd3dc --- /dev/null +++ b/source/_faq/connection-error.markdown @@ -0,0 +1,19 @@ +--- +layout: page +title: "Connection error" +description: "Connection error" +date: 2017-06-18 09:00 +comments: false +sharing: true +footer: true +ha_category: Usage +--- + + +It can happen that you get a traceback that notify you about connection issues while running Home Assistant. Eg. + +```bash +ConnectionRefusedError: [Errno 111] Connection refused +``` + +The chance is very high that this is not a bug but an issue with the service/daemon itself. Check your network (DNS, DHCP, uplink, etc.) first and make sure that Home Assistant and the service are poperly configured. Keep in mind that webservices can be down. diff --git a/source/_faq/dependencies.markdown b/source/_faq/dependencies.markdown new file mode 100644 index 00000000000..3e8e5781f8b --- /dev/null +++ b/source/_faq/dependencies.markdown @@ -0,0 +1,13 @@ +--- +layout: page +title: "Dependencies" +description: "Dependencies" +date: 2017-06-18 09:00 +comments: false +sharing: true +footer: true +ha_category: Usage +--- + +The dependencies which are used by Home Assistant are stored in the folder `deps` of the [configuration folder](/docs/configuration/) directory. After an [upgrade](/docs/installation/updating/) the dependences will be upgraded as well. + diff --git a/source/_faq/distutils.markdown b/source/_faq/distutils.markdown new file mode 100644 index 00000000000..75f9a72e615 --- /dev/null +++ b/source/_faq/distutils.markdown @@ -0,0 +1,12 @@ +--- +layout: page +title: "distutils.errors.DistutilsOptionError" +description: "distutils.errors.DistutilsOptionError: must supply either home or prefix/exec-prefix -- not both" +date: 2017-06-18 09:00 +comments: false +sharing: true +footer: true +ha_category: Installation +--- + +The problem which leads to `distutils.errors.DistutilsOptionError: must supply either home or prefix/exec-prefix -- not both` is a known issue if you're on a Mac using Homebrew to install Python. Please follow [these instructions](https://github.com/Homebrew/brew/blob/master/docs/Homebrew-and-Python.md#note-on-pip-install---user) to resolve it. diff --git a/source/_faq/libyaml.markdown b/source/_faq/libyaml.markdown new file mode 100644 index 00000000000..59b89bee0b3 --- /dev/null +++ b/source/_faq/libyaml.markdown @@ -0,0 +1,13 @@ +--- +layout: page +title: "libyaml is not found or a compiler error" +description: "libyaml is not found or a compiler error" +date: 2017-06-18 09:00 +comments: false +sharing: true +footer: true +ha_category: Installation +--- + + +On a Debian system, install the Python 3 YAML library by `sudo apt-get install python3-yaml`. diff --git a/source/_faq/missing-documentation.markdown b/source/_faq/missing-documentation.markdown new file mode 100644 index 00000000000..329dc05f6a7 --- /dev/null +++ b/source/_faq/missing-documentation.markdown @@ -0,0 +1,16 @@ +--- +layout: page +title: "Missing Documentation" +description: "The docs are missing or outdated" +date: 2017-06-18 09:00 +sidebar: true +comments: false +sharing: true +footer: true +ha_category: Documentation +--- + + +Home Assistant is a FAST moving open source project. This means occasionally the official documentation will not be 100% current or complete. Since this is an open source volunteer project, we would encourage anyone who finds gaps in the documentation to click the `edit this page on Github` link in the top right and submit any corrections/enhancements they may find useful. + +In the absence of information, many users find it beneficial to look at other people's configurations to find examples of what they want to accomplish in thier own configurations. The easiest way to find these configurations is through this [Github search](https://github.com/search?q=topic%3Ahome-assistant-config&type=Repositories). diff --git a/source/_faq/pip.markdown b/source/_faq/pip.markdown new file mode 100644 index 00000000000..45b3d127318 --- /dev/null +++ b/source/_faq/pip.markdown @@ -0,0 +1,17 @@ +--- +layout: page +title: "No module named pip" +description: "No module named pip" +date: 2017-06-18 09:00 +comments: false +sharing: true +footer: true +ha_category: Installation +--- + + +[Pip](https://pip.pypa.io/en/stable/) should come bundled with the latest Python 3 but is omitted by some distributions. If you are unable to run `python3 -m pip --version` you can install `pip` by [downloading the installer](https://bootstrap.pypa.io/get-pip.py) and running it with Python 3: + +```bash +$ python3 get-pip.py +``` diff --git a/source/_faq/pip3.markdown b/source/_faq/pip3.markdown new file mode 100644 index 00000000000..cb957a7cf43 --- /dev/null +++ b/source/_faq/pip3.markdown @@ -0,0 +1,21 @@ +--- +layout: page +title: "pip3: command not found" +description: "pip3: command not found" +date: 2017-06-18 09:00 +comments: false +sharing: true +footer: true +ha_category: Installation +--- + + +This utility should have been installed as part of the Python 3.4 installation. Check if Python 3.4 is installed by running `python3 --version`. If it is not installed, [download it here](https://www.python.org/getit/). + +If you are able to successfully run `python3 --version` but not `pip3`, install Home Assistant by running the following command instead: + +```bash +$ python3 -m pip install homeassistant +``` + +On a Debian system, you can also install python3 by `sudo apt-get install python3`d and pip3 by `sudo apt-get install python3-pip`. diff --git a/source/_faq/problems-with-dependencies.markdown b/source/_faq/problems-with-dependencies.markdown new file mode 100644 index 00000000000..a2535ee7943 --- /dev/null +++ b/source/_faq/problems-with-dependencies.markdown @@ -0,0 +1,14 @@ +--- +layout: page +title: "Problems with dependencies" +description: "Problems with dependencies" +date: 2017-06-18 09:00 +comments: false +sharing: true +footer: true +ha_category: Usage +--- + +Almost all components have external dependencies to communicate with your devices and services. Sometimes Home Assistant is unable to install the necessary dependencies. If this is the case, it should show up in `home-assistant.log`. + +The first step is trying to restart Home Assistant and see if the problem persists. If it does, look at the log to see what the error is. If you can't figure it out, please [report it](https://github.com/home-assistant/home-assistant/issues) so we can investigate what is going on. diff --git a/source/_includes/asides/docs_navigation.html b/source/_includes/asides/docs_navigation.html index f3351b1d62f..31cd0fd62bb 100644 --- a/source/_includes/asides/docs_navigation.html +++ b/source/_includes/asides/docs_navigation.html @@ -3,7 +3,10 @@

Topics