From 47eae9077e743b6a2b176645f42f5da5233c8310 Mon Sep 17 00:00:00 2001 From: Paulus Schoutsen Date: Wed, 28 Oct 2015 23:00:29 -0700 Subject: [PATCH] Markdown fixes --- .../alarm_control_panel.mqtt.markdown | 5 +- source/_components/arduino.markdown | 2 +- source/_components/automation.markdown | 87 +++++++------------ source/_components/browser.markdown | 3 +- source/_components/camera.generic.markdown | 1 + source/_components/configurator.markdown | 2 +- source/_components/conversation.markdown | 3 +- .../_components/device_tracker.mqtt.markdown | 3 +- .../device_tracker.nmap_scanner.markdown | 13 +-- .../device_tracker.owntracks.markdown | 7 +- source/_components/ifttt.manything.markdown | 8 +- source/_components/ifttt.markdown | 11 +-- source/_components/keyboard.markdown | 6 +- source/_components/logbook.markdown | 5 +- source/_components/media_player.plex.markdown | 18 ++-- source/_components/modbus.markdown | 1 + source/_components/mqtt.markdown | 35 +++----- source/_components/notify.pushover.markdown | 8 +- source/_components/scene.markdown | 15 +--- source/_components/script.markdown | 3 +- .../sensor.command_sensor.markdown | 10 +-- source/_components/sensor.forecast.markdown | 6 +- source/_components/sensor.mysensors.markdown | 2 +- source/_components/shell_command.markdown | 4 +- source/_components/sun.markdown | 4 +- .../switch.command_switch.markdown | 2 +- source/_components/switch.mqtt.markdown | 8 +- source/_components/tellstick.markdown | 4 +- source/_components/wink.markdown | 9 +- source/_components/zone.markdown | 17 +--- source/_components/zwave.markdown | 10 ++- .../asides/component_navigation.html | 7 +- ...ey-pushbullet-nice-talking-to-you.markdown | 2 +- ...rapping-your-setup-with-discovery.markdown | 2 +- .../2015-01-13-nest-in-da-house.markdown | 2 +- ...-home-assistant-migrating-to-yaml.markdown | 3 +- .../_posts/2015-03-22-release-notes.markdown | 14 ++- .../_posts/2015-04-25-release-notes.markdown | 19 ++-- .../_posts/2015-05-14-release-notes.markdown | 29 +++---- .../_posts/2015-06-10-release-notes.markdown | 33 +++---- ...meras-arduino-kodi-efergy-support.markdown | 24 +++-- ...rry-pi-squeezebox-asuswrt-support.markdown | 34 +++----- ...and-modern-tp-link-router-support.markdown | 5 +- ...h-moteino-mqtt-and-home-assistant.markdown | 2 +- ...mped-ui-and-improved-distribution.markdown | 55 ++++-------- ...s-to-use-mqtt-with-home-assistant.markdown | 10 ++- ...-09-13-home-assistant-meets-ifttt.markdown | 18 ++-- ...g-with-glances-and-home-assistant.markdown | 12 +-- ...19-alarm-sonos-and-itunes-support.markdown | 29 ++----- ...assistant-goes-geo-with-owntracks.markdown | 7 +- ...fxtrx-blinkstick-and-snmp-support.markdown | 7 +- ...retv-and-radiotherm-now-supported.markdown | 27 ++---- 52 files changed, 247 insertions(+), 406 deletions(-) diff --git a/source/_components/alarm_control_panel.mqtt.markdown b/source/_components/alarm_control_panel.mqtt.markdown index 712b68b7ac6..4bf7c911cd7 100644 --- a/source/_components/alarm_control_panel.mqtt.markdown +++ b/source/_components/alarm_control_panel.mqtt.markdown @@ -12,10 +12,7 @@ ha_category: Alarm --- -This platform enables the possibility to control an MQTT alarm. The alarm will only change state after -receiving the a new state from `state_topic`. If these messages are published with RETAIN flag, the MQTT -alarm will receive an instant state update after subscription and will start with correct state. Otherwise, -the initial state will be `unknown`. +This platform enables the possibility to control an MQTT alarm. The alarm will only change state after receiving the a new state from `state_topic`. If these messages are published with RETAIN flag, the MQTT alarm will receive an instant state update after subscription and will start with correct state. Otherwise, the initial state will be `unknown`. ```yaml # Example configuration.yaml entry diff --git a/source/_components/arduino.markdown b/source/_components/arduino.markdown index fcd64090471..d72730e5470 100644 --- a/source/_components/arduino.markdown +++ b/source/_components/arduino.markdown @@ -35,7 +35,7 @@ Configuration variables: - **port** (*Required*): The port where your board is connected to your Home Assistant host. If you are using an original Arduino the port will be named `ttyACM*`. The exact number can be determined with `ls /dev/ttyACM*`. ```bash -ls /dev/ttyACM* +$ ls /dev/ttyACM* ``` If that is not working, check your `dmesg` or `journalctl -f` output. Keep in mind that Arduino clones are often using a different name for the port (e.g. `/dev/ttyUSB*`). diff --git a/source/_components/automation.markdown b/source/_components/automation.markdown index aa05fcd47bf..444ca60ab25 100644 --- a/source/_components/automation.markdown +++ b/source/_components/automation.markdown @@ -10,12 +10,9 @@ footer: true ha_category: Automation --- -This page will go into more detail about the various options the `automation` component offers. If -you haven't yet, read the [getting started page on automation](/getting-started/automation/). +This page will go into more detail about the various options the `automation` component offers. If you haven't yet, read the [getting started page on automation](/getting-started/automation/). -A configuration section of an automation requires a `trigger` and an `action` section. `condition` and -`condition_type` are optional. To keep this page compact, all following sections will not show the -full configuration but only the relevant part. +A configuration section of an automation requires a `trigger` and an `action` section. `condition` and `condition_type` are optional. To keep this page compact, all following sections will not show the full configuration but only the relevant part. ```yaml # Example of entry in configuration.yaml @@ -77,13 +74,10 @@ automation: ## {% linkable_title Triggers %} -Triggers are what starts the processing of an automation rule. It is possible to specify multiple -triggers for the same rule. Once a trigger starts, Home Assistant will validate the conditions, if any, -and call the action. +Triggers are what starts the processing of an automation rule. It is possible to specify multiple triggers for the same rule. Once a trigger starts, Home Assistant will validate the conditions, if any, and call the action. #### {% linkable_title Event trigger %} -Triggers when an event is being processed. Events are the raw building blocks of Home Assistant. -You can match events on just the event name or also require specific event data to be present. +Triggers when an event is being processed. Events are the raw building blocks of Home Assistant. You can match events on just the event name or also require specific event data to be present. ```yaml automation: @@ -96,8 +90,7 @@ automation: ``` #### {% linkable_title MQTT trigger %} -Triggers when a specific message is received on given topic. Optionally can match on the payload -being sent over the topic. +Triggers when a specific message is received on given topic. Optionally can match on the payload being sent over the topic. ```yaml automation: @@ -109,8 +102,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 if value is above and/or below a threshold. ```yaml automation: @@ -123,6 +115,7 @@ automation: ``` #### {% linkable_title State trigger %} + Triggers when the state of an entity changes. If only entity_id given will match all state changes. ```yaml @@ -136,13 +129,11 @@ automation: ```

- Use quotes around your values for from and to to avoid the YAML parser - interpreting some values as booleans. + Use quotes around your values for `from` and `to` to avoid the YAML parser interpreting values as booleans.

#### {% linkable_title Sun trigger %} -Trigger when the sun is setting or rising. An optional time offset can be given to have it trigger for -example 45 minutes before sunset, when dusk is setting in. +Trigger when the sun is setting or rising. An optional time offset can be given to have it trigger for example 45 minutes before sunset, when dusk is setting in. ```yaml automation: @@ -155,10 +146,8 @@ automation: ``` #### {% linkable_title Time trigger %} -Time can be triggered in many ways. The most common is to specify `after` and trigger at a specific -point in time each day. Alternatively, you can also match if the hour, minute or second of the current -time has a specific value. For example, by only setting minutes in the config to 5 it will trigger every -hour when it is 5 minutes past whole. You cannot use `after` together with hour, minute or second. + +Time can be triggered in many ways. The most common is to specify `after` and trigger at a specific point in time each day. Alternatively, you can also match if the hour, minute or second of the current time has a specific value. For example, by only setting minutes in the config to 5 it will trigger every hour when it is 5 minutes past whole. You cannot use `after` together with hour, minute or second. ```yaml automation: @@ -176,16 +165,13 @@ automation: - sun ``` -You can use `weekday` to limit the trigger times to speific days as well (also available in conditions). -Valid values for `weekday` are (`sun`, `mon`, `tue`, `wed`, `thu`, `fri` & `sat`) +You can use `weekday` to limit the trigger times to speific days as well (also available in conditions). Valid values for `weekday` are (`sun`, `mon`, `tue`, `wed`, `thu`, `fri` & `sat`) The above example will trigger on Saturday and Sunday every hour on the 5 (2:05, 3:05, 4:05, etc). - #### {% linkable_title Zone trigger %} -Zone triggers can trigger when an entity is entering or leaving the zone. For zone automation to work, -you need to have setup a device tracker platform that supports reporting GPS coordinates. Currently -this is limited to the [OwnTracks platform](/components/device_tracker.owntracks/). + +Zone triggers can trigger when an entity is entering or leaving the zone. For zone automation to work, you need to have setup a device tracker platform that supports reporting GPS coordinates. Currently this is limited to the [OwnTracks platform](/components/device_tracker.owntracks/). ```yaml automation: @@ -199,15 +185,9 @@ automation: ## {% linkable_title Conditions %} -Conditions are an optional part of an automation rule and be used to prevent an action from happening -when triggered. Conditions look very familiar to triggers but are very different. A trigger will look -at events happening at the system while a condition only looks at how the system looks right now. -A trigger can observe that a switch is being turned on. A condition can only see if a switch is on -or off. +Conditions are an optional part of an automation rule and be used to prevent an action from happening when triggered. Conditions look very familiar to triggers but are very different. A trigger will look at events happening at the system while a condition only looks at how the system looks right now. A trigger can observe that a switch is being turned on. A condition can only see if a switch is on or off. -An automation rule can have mulitiple triggers. By default the action will only fire if all conditions -pass. An optional key `condition_type: 'or'` can be set on the automation rule to fire action if any -condition matches. In the example below, the automation would trigger if the time is before 05:00 _OR_ after 20:00. +An automation rule can have mulitiple triggers. By default the action will only fire if all conditions pass. An optional key `condition_type: 'or'` can be set on the automation rule to fire action if any condition matches. In the example below, the automation would trigger if the time is before 05:00 _OR_ after 20:00. ```yaml automation: @@ -219,16 +199,16 @@ automation: after: '20:00' ``` -If your triggers and conditions are exactly the same, you can use a shortcut to specify conditions. -In this case, triggers that are not valid conditions will be ignored. +If your triggers and conditions are exactly the same, you can use a shortcut to specify conditions. In this case, triggers that are not valid conditions will be ignored. + ```yaml automation: condition: use_trigger_values ``` #### {% linkable_title Numeric state condition %} -Attempts to parse the state of specified entity as a number and triggers if value is above and/or -below a threshold. + +Attempts to parse the state of specified entity as a number and triggers if value is above and/or below a threshold. ```yaml automation: @@ -241,6 +221,7 @@ automation: ``` #### {% linkable_title State condition %} + Tests if an entity is a specified state. ```yaml @@ -252,8 +233,8 @@ automation: ``` #### {% linkable_title Time condition %} -The time condition can test if it is after a specified time, before a specified time or if it is a -certain day of the week + +The time condition can test if it is after a specified time, before a specified time or if it is a certain day of the week ```yaml automation: @@ -268,12 +249,11 @@ automation: - fri ``` -Valid values for `weekday` are (sun, mon, tue, wed, thu, fri & sat) +Valid values for `weekday` are (`sun`, `mon`, `tue`, `wed`, `thu`, `fri` & `sat`) #### {% linkable_title Zone condition %} -Zone conditions test if an entity is in a certain zone. For zone automation to work, -you need to have setup a device tracker platform that supports reporting GPS coordinates. Currently -this is limited to the [OwnTracks platform](/components/device_tracker.owntracks/). + +Zone conditions test if an entity is in a certain zone. For zone automation to work, you need to have setup a device tracker platform that supports reporting GPS coordinates. Currently this is limited to the [OwnTracks platform](/components/device_tracker.owntracks/). ```yaml automation: @@ -285,8 +265,7 @@ automation: ## {% linkable_title Actions %} -When an automation rule fires, it calls a service. For this service you can specify an entity id it -should apply to and optional service parameters (to specify for example the brightness). +When an automation rule fires, it calls a service. For this service you can specify an entity id it should apply to and optional service parameters (to specify for example the brightness). ```yaml automation: @@ -310,23 +289,19 @@ automation: message: Something just happened, better take a look! ``` -If you want to specify multiple services to be called or include a delay, have a look at the -[script component](/components/script/). If you want to describe how certain entities should look, -check out the [scene component](/components/scene/). +If you want to specify multiple services to be called or include a delay, have a look at the [script component](/components/script/). If you want to describe how certain entities should look, check out the [scene component](/components/scene/). ## {% linkable_title Troubleshooting %} -You can verify that your automation rules are being initialized correctly by watching both the realtime -logs and also the logbook. The realtime logs will show the rules being initialized (once for each trigger): +You can verify that your automation rules are being initialized correctly by watching both the realtime logs and also the logbook. The realtime logs will show the rules being initialized (once for each trigger): -```bash +```plain INFO [homeassistant.components.automation] Initialized rule Rainy Day INFO [homeassistant.components.automation] Initialized rule Rainy Day INFO [homeassistant.components.automation] Initialized rule Rainy Day INFO [homeassistant.components.automation] Initialized rule Rain is over ``` -The Logbook component will show a line entry when an automation is triggered. You can look at the -previous entry to determine which trigger in the rule triggered the event. +The Logbook component will show a line entry when an automation is triggered. You can look at the previous entry to determine which trigger in the rule triggered the event. ![Logbook example](/images/components/automation/logbook.png) diff --git a/source/_components/browser.markdown b/source/_components/browser.markdown index 0a31cfca145..6bf017554fb 100644 --- a/source/_components/browser.markdown +++ b/source/_components/browser.markdown @@ -15,7 +15,8 @@ The browser component provides a service to open urls in the default browser on To load this component, add the following lines to your `configuration.yaml`: -``` +```yaml +# Example configuration.yaml entry browser: ``` diff --git a/source/_components/camera.generic.markdown b/source/_components/camera.generic.markdown index 63729d80ac2..065207f37b8 100644 --- a/source/_components/camera.generic.markdown +++ b/source/_components/camera.generic.markdown @@ -16,6 +16,7 @@ This component allows you to integrate any IP camera into Home Assistant. It sup Home Assistant will serve the images via its server, making it possible to view your IP camera's while outside of your network. As part of the basic support the following features will be provided: + - MJPEG video streaming - Saving a snapshot - Recording(JPEG frame capture) diff --git a/source/_components/configurator.markdown b/source/_components/configurator.markdown index 9757234f2f3..eaa14aae299 100644 --- a/source/_components/configurator.markdown +++ b/source/_components/configurator.markdown @@ -20,6 +20,6 @@ The configurator component allows components to request information from the use - Input fields can be defined with a description, and optional type - It will trigger a callback when the button is pressed -The Hue component in [the demo](/demo) and Plex are implemented using the configurator. See [the source of the demo component](https://github.com/balloob/home-assistant/blob/master/homeassistant/components/demo.py#L72) for a simple example. +The Hue component in [the demo](/demo) and Plex are implemented using the configurator. See [the source of the demo component](https://github.com/balloob/home-assistant/blob/master/homeassistant/components/demo.py#L132) for a simple example. See [the source](https://github.com/balloob/home-assistant/blob/master/homeassistant/components/configurator.py#L39) for more details on how to use the configurator component. diff --git a/source/_components/conversation.markdown b/source/_components/conversation.markdown index aea3972f39d..7ca6eb0147a 100644 --- a/source/_components/conversation.markdown +++ b/source/_components/conversation.markdown @@ -15,7 +15,8 @@ The conversation component can process sentences into commands for Home Assistan To enable the conversion option in your installation, add the following to your `configuration.yaml` file: -``` +```yaml +# Example configuration.yaml entry conversation: ``` diff --git a/source/_components/device_tracker.mqtt.markdown b/source/_components/device_tracker.mqtt.markdown index b6619412fde..a8369e5c47b 100644 --- a/source/_components/device_tracker.mqtt.markdown +++ b/source/_components/device_tracker.mqtt.markdown @@ -12,8 +12,7 @@ ha_category: Presence Detection --- -This platform allows you to detect presence by monitoring an MQTT topic for new locations. To use this -platform, you specify a unique topic for each device. +This platform allows you to detect presence by monitoring an MQTT topic for new locations. To use this platform, you specify a unique topic for each device. ```yaml # Example configuration.yaml entry diff --git a/source/_components/device_tracker.nmap_scanner.markdown b/source/_components/device_tracker.nmap_scanner.markdown index bdee0d2da9e..25676566e60 100644 --- a/source/_components/device_tracker.nmap_scanner.markdown +++ b/source/_components/device_tracker.nmap_scanner.markdown @@ -12,12 +12,9 @@ featured: true --- -As an alternative to the router-based device tracking, it is possible to directly scan the network -for devices by using Nmap. The IP addresses to scan can be specified in any format that Nmap understands, -including the network-prefix notation (`192.168.1.1/24`) and the range notation (`192.168.1.1-255`). +As an alternative to the router-based device tracking, it is possible to directly scan the network for devices by using Nmap. The IP addresses to scan can be specified in any format that Nmap understands, including the network-prefix notation (`192.168.1.1/24`) and the range notation (`192.168.1.1-255`). -If you're on Debian or Ubuntu, you might have to install the packages for arp and nmap. Do so by -running `apt-get install net-tools nmap`. +If you're on Debian or Ubuntu, you might have to install the packages for arp and nmap. Do so by running `apt-get install net-tools nmap`. ```yaml # Example configuration.yaml entry @@ -27,8 +24,6 @@ device_tracker: home_interval: 10 ``` -`home_interval` is an optional value set in minutes. This will be the number of minutes nmap will not -scan this device, assuming it is home, in order to preserve the device battery. +`home_interval` is an optional value set in minutes. This will be the number of minutes nmap will not scan this device, assuming it is home, in order to preserve the device battery. -See the [device tracker component page](/components/device_tracker/) for instructions how to -configure the people to be tracked. +See the [device tracker component page](/components/device_tracker/) for instructions how to configure the people to be tracked. diff --git a/source/_components/device_tracker.owntracks.markdown b/source/_components/device_tracker.owntracks.markdown index 4ba7cbd9ef5..68281a87146 100644 --- a/source/_components/device_tracker.owntracks.markdown +++ b/source/_components/device_tracker.owntracks.markdown @@ -13,12 +13,9 @@ featured: true --- -This platform allows you to detect presence using [Owntracks](http://owntracks.org/). OwnTracks allows -users to track their location on Android and iOS phones and publish it to an MQTT broker. This platform -will connect to the broker and monitor for new locations. +This platform allows you to detect presence using [Owntracks](http://owntracks.org/). OwnTracks allows users to track their location on Android and iOS phones and publish it to an MQTT broker. This platform will connect to the broker and monitor for new locations. -This component requires [the MQTT component](/components/mqtt/) to be set up and works very well -together with [the zone component](/components/zone/). +This component requires [the MQTT component](/components/mqtt/) to be set up and works very well together with [the zone component](/components/zone/). To integrate Owntracks in Home Assistant, add the following section to your `configuration.yaml` file: diff --git a/source/_components/ifttt.manything.markdown b/source/_components/ifttt.manything.markdown index e59ccac1ed7..dd9b53751fa 100644 --- a/source/_components/ifttt.manything.markdown +++ b/source/_components/ifttt.manything.markdown @@ -11,11 +11,9 @@ logo: manything.png ha_category: Camera --- -[Manything](https://manything.com) is a smart app that turns your iPhone, iPod, or iPad into a wifi -camera for monitoring your home, your pets, anything! Comes with live streaming, motion activated alerts, cloud video recording, and more. +[Manything](https://manything.com) is a smart app that turns your iPhone, iPod, or iPad into a wifi camera for monitoring your home, your pets, anything! Comes with live streaming, motion activated alerts, cloud video recording, and more. -To get manything support, HA will use IFTTT's [Maker Channel](https://ifttt.com/maker) and the [ManyThing Channel](https://ifttt.com/manything). -Use the [IFTTT Setup instructions](/components/ifttt/) to activate the IFTTT Platform. +To get manything support, HA will use IFTTT's [Maker Channel](https://ifttt.com/maker) and the [ManyThing Channel](https://ifttt.com/manything). Use the [IFTTT Setup instructions](/components/ifttt/) to activate the IFTTT Platform. After setting up IFTTT, Maker Channel and ManyThing Channel, you can use the following examples to configure Home Assistant. @@ -62,7 +60,7 @@ automation:

You need to setup a unique trigger for each event you sent to IFTTT. -For ManyThing support, you need to set up an on and off event. +For ManyThing support, you need to set up an `on` and `off` event.

### {% linkable_title Testing your trigger %} diff --git a/source/_components/ifttt.markdown b/source/_components/ifttt.markdown index 97ce8c5876d..67d3dcb42e2 100644 --- a/source/_components/ifttt.markdown +++ b/source/_components/ifttt.markdown @@ -12,10 +12,7 @@ ha_category: Automation featured: true --- -[IFTTT](https://ifttt.com) is a web service that allows users to create chains of simple conditional -statements, so called "recipes". With the ifttt component you can trigger recipes through the "maker" -channel. See the [announcement blog post](/blog/2015/09/13/home-assistant-meets-ifttt/) for examples -how to use it. +[IFTTT](https://ifttt.com) is a web service that allows users to create chains of simple conditional statements, so called "recipes". With the IFTTT component you can trigger recipes through the "maker" channel. See the [announcement blog post](/blog/2015/09/13/home-assistant-meets-ifttt/) for examples how to use it. ```yaml # Example configuration.yaml entry @@ -60,10 +57,7 @@ You need to setup a unique trigger for each event you sent to IFTTT. ### {% linkable_title Sending events from IFTTT to Home Assistant %} -To be able to receive events from IFTTT, your Home Assistant instance needs to be accessible from -the web. This can be achieved by forwarding port 8123 from your router to the device running Home -Assistant. If your ISP is giving you a new IP address from time to time, consider using -[DuckDNS][duck-dns]. +To be able to receive events from IFTTT, your Home Assistant instance needs to be accessible from the web. This can be achieved by forwarding port 8123 from your router to the device running Home Assistant. If your ISP is giving you a new IP address from time to time, consider using [DuckDNS][duck-dns]. [duck-dns]: https://duckdns.org @@ -72,6 +66,7 @@ Assistant. If your ISP is giving you a new IP address from time to time, conside

### {% linkable_title Additional Channel Examples %} + Additional examples of using IFTTT channels can be found below. Channel | Description diff --git a/source/_components/keyboard.markdown b/source/_components/keyboard.markdown index 5eb147d6919..4bf2672e14b 100644 --- a/source/_components/keyboard.markdown +++ b/source/_components/keyboard.markdown @@ -22,7 +22,7 @@ The `keyboard` component simulates key presses on the host machine. It currently To load this component, add the following lines to your `configuration.yaml`: -``` +```yaml keyboard: ``` @@ -30,8 +30,8 @@ keyboard: You may need to install platform-specific [dependencies for PyUserInput](https://github.com/SavinaRoja/PyUserInput#dependencies) in order to use the keyboard component. In most cases this can be done by running: -``` -pip3 install [package name] +```bash +$ pip3 install [package name] ``` #### {% linkable_title Windows %} diff --git a/source/_components/logbook.markdown b/source/_components/logbook.markdown index 903039d26ae..6ac779cd1e4 100644 --- a/source/_components/logbook.markdown +++ b/source/_components/logbook.markdown @@ -10,10 +10,7 @@ footer: true ha_category: "History" --- - -The logbook component provides a different perspective on the history of your house by showing all -the changes that happened to your house in reverse chronological order. -[See the demo for a live example](/demo/). + The logbook component provides a different perspective on the history of your house by showing all the changes that happened to your house in reverse chronological order. [See the demo for a live example](/demo/). To enable the logbook in your installation, add the following to your `configuration.yaml` file: diff --git a/source/_components/media_player.plex.markdown b/source/_components/media_player.plex.markdown index f33b7cf72e1..42ddf605342 100644 --- a/source/_components/media_player.plex.markdown +++ b/source/_components/media_player.plex.markdown @@ -13,11 +13,9 @@ featured: true --- -The Plex platform allows you to connect a [Plex Media Server](https://plex.tv) to Home Assistant. It will allow you to control media playback and see the current playing item. -The preferred way to setup the Plex platform is by enabling the the [the discovery component]({{site_root}}/components/discovery/) and requires GDM to be enabled. - -If local authentication is enabled or multiple users are defined, HASS requires an authentication token to be entered in the webinterface. See Finding your account token / X-Plex-Token. +The Plex platform allows you to connect a [Plex Media Server](https://plex.tv) to Home Assistant. It will allow you to control media playback and see the current playing item. The preferred way to setup the Plex platform is by enabling the the [the discovery component](/components/discovery/) and requires GDM to be enabled. +If local authentication is enabled or multiple users are defined, HASS requires an authentication token to be entered in the webinterface. See [Finding your account token / X-Plex-Token](https://support.plex.tv/hc/en-us/articles/204059436). If you want to enable the plex platform directly, add the following lines to your `configuration.yaml`: @@ -27,14 +25,14 @@ media_player: - platform: plex ``` -You may also need to create the file `plex.conf`. +You may also need to create the file `plex.conf`. -``` -{'IP_ADDRESS:PORT': {'token': 'TOKEN'}} +```json +{":": {"token": ""}} ``` -- **IP_ADDRESS** *Required*: IP address of the Plex Media Server -- **PORT** *required*: Default is 32400 -- **TOKEN** *Optional*: Only is authentication is required. Set to `None` (without quotes) otherwise. +- `` *Required*: IP address of the Plex Media Server +- `` *required*: Default is 32400 +- `` *Optional*: Only is authentication is required. Set to `None` (without quotes) otherwise. At this moment, the Plex platform only supports one Plex Media Server. diff --git a/source/_components/modbus.markdown b/source/_components/modbus.markdown index fa1fdabcb5e..f33ca58ca30 100644 --- a/source/_components/modbus.markdown +++ b/source/_components/modbus.markdown @@ -18,6 +18,7 @@ To add modbus to your installation, add the following to your `configuration.yam For a network connection: +```yaml #Modbus TCP modbus: type: tcp diff --git a/source/_components/mqtt.markdown b/source/_components/mqtt.markdown index 2d9ff6688da..e01d5016cec 100644 --- a/source/_components/mqtt.markdown +++ b/source/_components/mqtt.markdown @@ -40,14 +40,11 @@ Configuration variables: ## {% linkable_title Picking a broker %} -The MQTT component needs you to run an MQTT broker for Home Assistant to connect to. - -There are three options, each with various degrees of ease of setup and privacy. +The MQTT component needs you to run an MQTT broker for Home Assistant to connect to. There are three options, each with various degrees of ease of setup and privacy. #### {% linkable_title Run your own %} -Most private option but requires a bit more work. There are two free and open-source brokers to pick -from: [Mosquitto](http://mosquitto.org/) and [Mosca](http://www.mosca.io/). +Most private option but requires a bit more work. There are two free and open-source brokers to pick from: [Mosquitto](http://mosquitto.org/) and [Mosca](http://www.mosca.io/). ```yaml # Example configuration.yaml entry @@ -62,9 +59,7 @@ mqtt: #### {% linkable_title Public MQTT %} -The Mosquitto project runs a [public broker](http://test.mosquitto.org). Easiest to setup but there -is 0 privacy as all messages are public. Use this only for testing purposes and not for real tracking -of your devices. +The Mosquitto project runs a [public broker](http://test.mosquitto.org). Easiest to setup but there is 0 privacy as all messages are public. Use this only for testing purposes and not for real tracking of your devices. ```yaml mqtt: @@ -80,9 +75,7 @@ mqtt: #### {% linkable_title CloudMQTT %} -[CloudMQTT](https://www.cloudmqtt.com) is a hosted private MQTT instance that is free up to 10 -connected devices. This is enough to get started with for example -[OwnTracks](/components/device_tracker.owntracks/) and give you a taste of what is possible. +[CloudMQTT](https://www.cloudmqtt.com) is a hosted private MQTT instance that is free up to 10 connected devices. This is enough to get started with for example [OwnTracks](/components/device_tracker.owntracks/) and give you a taste of what is possible.

Home Assistant is not affiliated with CloudMQTT nor will receive any kickbacks. @@ -97,17 +90,17 @@ Home Assistant is not affiliated with CloudMQTT nor will receive any kickbacks. a. Under manage users, fill in username, password and click add b. Under ACLs, select user, topic `#`, check 'read access' and 'write access' 5. Copy the instance info to your configuration.yaml: + ```yaml - mqtt: - broker: - port: - username: - password: +mqtt: + broker: + port: + username: + password: ```

-Home Assistant will automatically load the correct certificate if you connect to an encrypted channel -of CloudMQTT (port range 20 000 - 30 000). +Home Assistant will automatically load the correct certificate if you connect to an encrypted channel of CloudMQTT (port range 20 000 - 30 000).

## {% linkable_title Building on top of MQTT %} @@ -118,14 +111,14 @@ of CloudMQTT (port range 20 000 - 30 000). - [OwnTracks Device Tracker](/components/device_tracker.owntracks/) - [MQTT automation rule](/components/automation/#mqtt-based-automation) - [MQTT alarm](/components/alarm_control_panel.mqtt/) - - Integrating it into a component. See the [MQTT example component](https://github.com/balloob/home-assistant/blob/dev/config/custom_components/mqtt_example.py) how to do this. + - Integrating it into own component. See the [MQTT example component](https://github.com/balloob/home-assistant/blob/dev/config/custom_components/mqtt_example.py) how to do this. ## {% linkable_title Testing your setup %} For debugging purposes `mosquitto` is shipping commandline tools to send and recieve MQTT messages. For sending test messages to a broker running on localhost: ```bash -mosquitto_pub -h 127.0.0.1 -t home-assistant/switch/1/on -m "Switch is ON" +$ mosquitto_pub -h 127.0.0.1 -t home-assistant/switch/1/on -m "Switch is ON" ``` Another way to send MQTT messages by hand is to use the "Developer Tools" in the Frontend. Choose "Call Service" and then `mqtt/mqtt_send` under "Available Services". Enter something similar to the example below into the "Service Data" field. @@ -146,5 +139,5 @@ The message should appear on the bus: For reading all messages sent on the topic `home-assistant` to a broker running on localhost: ```bash -mosquitto_sub -h 127.0.0.1 -v -t "home-assistant/#" +$ mosquitto_sub -h 127.0.0.1 -v -t "home-assistant/#" ``` diff --git a/source/_components/notify.pushover.markdown b/source/_components/notify.pushover.markdown index 0ce601da210..02aa891990a 100644 --- a/source/_components/notify.pushover.markdown +++ b/source/_components/notify.pushover.markdown @@ -32,9 +32,9 @@ Configuration variables: - **user_key** (*Required*): To retrieve this value log into your account at https://pushover.net This is a quote from the pushover website regarding free/open source apps: -> "If you are creating a client-side library, application, or open source project that will be redistributed and installed by end-users, you may want to require each of your users to register their own application rather than including your own API token with the software." + +
+ If you are creating a client-side library, application, or open source project that will be redistributed and installed by end-users, you may want to require each of your users to register their own application rather than including your own API token with the software. +
When setting up the application you can use this [icon](https://home-assistant.io/images/favicon-192x192.png). - -For more automation examples, see the [getting started with automation page]({{site_root}}/components/automation/). - diff --git a/source/_components/scene.markdown b/source/_components/scene.markdown index b1072178a01..a887ecc06a0 100644 --- a/source/_components/scene.markdown +++ b/source/_components/scene.markdown @@ -10,25 +10,14 @@ footer: true ha_category: Organization --- -A user can create scenes that capture the states you want certain entities to be. For example a scene -can contain that light A should be turned on and light B should be bright red. +A user can create scenes that capture the states you want certain entities to be. For example a scene can contain that light A should be turned on and light B should be bright red. -A scene is active if all states of the scene match the actual states. An optional `fuzzy_match` option -can be given to allow entities to match if attributes are not exact but are in range of the preferred -state. - -If a scene is manually activated it will store the previous state of the entities. These will be -restored when the state is deactivated manually. If one of the enties that are being tracked change -state on its own, the old state will not be restored when it is being deactivated. - -Scenes can be activated using the service `scene.turn_on` and deactivated using the service `scene.turn_off`. +Scenes can be activated using the service `scene.turn_on`. ```yaml # Example configuration.yaml entry scene: - name: Romantic - # Optional, allow fuzzy matching number atttributes to check if scene is on - fuzzy_match: 0.2 entities: light.tv_back_light: on light.ceiling: diff --git a/source/_components/script.markdown b/source/_components/script.markdown index 205098fcb86..7031ae1b495 100644 --- a/source/_components/script.markdown +++ b/source/_components/script.markdown @@ -10,8 +10,7 @@ footer: true ha_category: Automation --- -The script component allows users to create a sequence of service calls and delays. Scripts can be -started using the service `script/turn_on` and interrupted using the service `script/turn_off`. +The script component allows users to create a sequence of service calls and delays. Scripts can be started using the service `script/turn_on` and interrupted using the service `script/turn_off`. ```yaml # Example configuration.yaml entry diff --git a/source/_components/sensor.command_sensor.markdown b/source/_components/sensor.command_sensor.markdown index 66eee729462..37acffe19ce 100644 --- a/source/_components/sensor.command_sensor.markdown +++ b/source/_components/sensor.command_sensor.markdown @@ -43,7 +43,7 @@ In this section you find some real life examples of how to use this sensor. There are several ways to get the temperature of your hard drive. A simple solution is to use [hddtemp](https://savannah.nongnu.org/projects/hddtemp/). ```bash -hddtemp -n /dev/sda +$ hddtemp -n /dev/sda ``` To use those information, the entry for a sensor in the `configuration.yaml` file will look like this. @@ -59,8 +59,7 @@ sensor: ### {% linkable_title CPU temperature %} -Thanks to the [`proc`](https://en.wikipedia.org/wiki/Procfs) file system, various details about a system can be retrieved. Here the CPU temperature -is of interest. Add something similar to your `configuration.yaml` file: +Thanks to the [`proc`](https://en.wikipedia.org/wiki/Procfs) file system, various details about a system can be retrieved. Here the CPU temperature is of interest. Add something similar to your `configuration.yaml` file: ```yaml # Example configuration.yaml entry @@ -79,15 +78,14 @@ The example is doing the same as the [aREST sensor](/components/sensor.arest/) b The one-line script to retrieve a value is shown below. Of course would it be possible to use this directly in the `configuration.yaml` file but need extra care about the quotation marks. -```python -python3 -c "import requests; print(requests.get('http://10.0.0.48/analog/2').json()['return_value'])" +```bash +$ python3 -c "import requests; print(requests.get('http://10.0.0.48/analog/2').json()['return_value'])" ``` The script (saved as `arest-value.py`) that is used looks like the example below. ```python #!/usr/bin/python3 -# from requests import get response = get('http://10.0.0.48/analog/2') print(response.json()['return_value']) diff --git a/source/_components/sensor.forecast.markdown b/source/_components/sensor.forecast.markdown index 536248c5cf8..0cc7f2aa96b 100644 --- a/source/_components/sensor.forecast.markdown +++ b/source/_components/sensor.forecast.markdown @@ -14,7 +14,7 @@ featured: true The forecast platform uses the [Forecast.io](https://forecast.io/) web service as a source for meteorological data for your location. The location is based on the Longitude and Latitude cooridinates configured in `configuration.yaml`. The cooridinates are auto detected but to take advantage of the hyper-local weather reported by forecast.io, you can refine them down to your exact home address. GPS cooridinates can be found by using Google Maps and clicking on your home. -You need an API key which is free but requires a [registration](https://developer.forecast.io/register). You can make 1000 requests per day. This means that you could create approximately every 1.4 minute one. +You need an API key which is free but requires a [registration](https://developer.forecast.io/register). You can make 1000 requests per day. This means that you could create one approximately every 1.4 minutes. To add Forecast.io to your installation, add the following to your `configuration.yaml` file: @@ -45,7 +45,7 @@ sensor: Configuration variables: -- **api_key** (*Required*): Your API key for http://forecast.io/. +- **api_key** (*Required*): Your API key for http://forecast.io/. - **monitored_conditions** array (*Required*): Conditions to display in the frontend. - **summary**: A human-readable text summary. - **precip_type**: The type of precipitation occurring. @@ -59,7 +59,7 @@ Configuration variables: - **pressure**: The sea-level air pressure in millibars. - **visibility**: The average visibility. - **ozone**: The columnar density of total atmospheric ozone in Dobson. -- **units** (*Optional*): Specify the unit system. Default to `si` or `us` based on the temperature preference in Home Assistant. Other options are auto, us, si, ca, and uk2. +- **units** (*Optional*): Specify the unit system. Default to `si` or `us` based on the temperature preference in Home Assistant. Other options are `auto`, `us`, `si`, `ca`, and `uk2`. `auto` will let forecast.io decide the unit system based on location. Details about the API are available in the [Forecast.io documentation](https://developer.forecast.io/docs/v2). diff --git a/source/_components/sensor.mysensors.markdown b/source/_components/sensor.mysensors.markdown index acdcc355040..d4580c676fb 100644 --- a/source/_components/sensor.mysensors.markdown +++ b/source/_components/sensor.mysensors.markdown @@ -35,6 +35,6 @@ Configuration variables: If you are using an original Arduino the port will be named `ttyACM*`. The exact number can be determined with the command shown below. ```bash -ls /dev/ttyACM* +$ ls /dev/ttyACM* ``` diff --git a/source/_components/shell_command.markdown b/source/_components/shell_command.markdown index dec04c801ca..08b116f090f 100644 --- a/source/_components/shell_command.markdown +++ b/source/_components/shell_command.markdown @@ -10,9 +10,7 @@ footer: true ha_category: Automation --- - -This component can expose regular shell commands as services. Services can be called from a script -or in automation. +This component can expose regular shell commands as services. Services can be called from a script or in automation. ```yaml # Example configuration.yaml entry diff --git a/source/_components/sun.markdown b/source/_components/sun.markdown index 98770e33731..b4e66dc1e93 100644 --- a/source/_components/sun.markdown +++ b/source/_components/sun.markdown @@ -10,9 +10,7 @@ footer: true ha_category: Weather --- - -The `sun` component will use your current location to track if the sun is above or below the horizon. -The sun can be used within automation as [a trigger with an optional offset to simulate dawn/dusk][automation-trigger]. +The sun component will use your current location to track if the sun is above or below the horizon.The sun can be used within automation as [a trigger with an optional offset to simulate dawn/dusk][automation-trigger]. [automation-trigger]: /components/automation/#sun-trigger diff --git a/source/_components/switch.command_switch.markdown b/source/_components/switch.command_switch.markdown index f8282a19767..1407b512214 100644 --- a/source/_components/switch.command_switch.markdown +++ b/source/_components/switch.command_switch.markdown @@ -38,7 +38,7 @@ In this section you find some real life examples of how to use this switch. ### {% linkable_title aREST device %} -The example below is doing the same as the [aREST switch](/components/switch.arest/). The commandline tool `[curl](http://curl.haxx.se/)` is used to toogle a pin which is controllable through REST. +The example below is doing the same as the [aREST switch](/components/switch.arest/). The commandline tool [`curl`](http://curl.haxx.se/) is used to toogle a pin which is controllable through REST. ```yaml # Example configuration.yaml entry diff --git a/source/_components/switch.mqtt.markdown b/source/_components/switch.mqtt.markdown index 26d81154b25..0abacd12517 100644 --- a/source/_components/switch.mqtt.markdown +++ b/source/_components/switch.mqtt.markdown @@ -12,11 +12,9 @@ ha_category: Switch --- -In an ideal scenario, the MQTT device will have a state topic to publish state changes. If these messages are published with RETAIN flag, the MQTT switch will receive an instant state update after subscription and will -start with correct state. Otherwise, the initial state of the switch will be false/off. +In an ideal scenario, the MQTT device will have a state topic to publish state changes. If these messages are published with RETAIN flag, the MQTT switch will receive an instant state update after subscription and will start with correct state. Otherwise, the initial state of the switch will be false/off. -When a state topic is not available, the switch will work in optimistic mode. In this mode, the switch will immediately change state after every command. Otherwise, the switch will wait for state confirmation from device -(message from `state_topic`). +When a state topic is not available, the switch will work in optimistic mode. In this mode, the switch will immediately change state after every command. Otherwise, the switch will wait for state confirmation from device (message from `state_topic`). Optimistic mode can be forced, even if state topic is available. Try to enable it, if experiencing incorrect switch operation. @@ -44,5 +42,5 @@ Configuration variables: - **optimistic** (*Optional*): Flag that defines if switch works in optimistic mode. Default is true if no state topic defined, else false.

-Make sure that your topics match exact. some-topic/ and some-topic are different topics. + Make sure that your topics match exact. `some-topic/` and `some-topic` are different topics.

diff --git a/source/_components/tellstick.markdown b/source/_components/tellstick.markdown index 7ff9fd47440..913415ece60 100644 --- a/source/_components/tellstick.markdown +++ b/source/_components/tellstick.markdown @@ -12,8 +12,7 @@ ha_category: Hub --- -The tellstick component integrates [TellStick](http://www.telldus.se/products/tellstick) devices into Home Assistant. This integration allows users to add switches, lights, and sensors which are communicating with 433 Mhz. There are couple of vendors (Capidi -Elro, Intertechno, Nexa, Proove, Sartano, and Viking) how are selling products which works with TellStick. For more details, please check the TellStick [compatibility list](http://telldus.se/products/compability). +The tellstick component integrates [TellStick](http://www.telldus.se/products/tellstick) devices into Home Assistant. This integration allows users to add switches, lights, and sensors which are communicating with 433 Mhz. There are couple of vendors (Capidi Elro, Intertechno, Nexa, Proove, Sartano, and Viking) how are selling products which works with TellStick. For more details, please check the TellStick [compatibility list](http://telldus.se/products/compability). To get started, add the devices to your `configuration.yaml` file. @@ -28,6 +27,5 @@ sensor: # All dimmers will be picked up as lights. light: platform: tellstick - ``` diff --git a/source/_components/wink.markdown b/source/_components/wink.markdown index e0c02aa0ba4..5f7ecf0cbe3 100644 --- a/source/_components/wink.markdown +++ b/source/_components/wink.markdown @@ -12,14 +12,15 @@ ha_category: Hub featured: true --- - [Wink](http://www.wink.com/) is a home automation hub that can control a whole wide range of devices on the market. Or, as they say in their own words: -
Wink offers one, quick and simple way to connect people with the products they rely on every day in their home.
+
+ Wink offers one, quick and simple way to connect people with the products they rely on every day in their home. +
Home Assistant integrates the Wink hub and allows you to get the status and control connected switches, lights and sensors. -To get started with the Wink API, you will first need to get yourself an API access token. Because it is very difficult right now to get access to their API, John McLaughlin has created the form below to get you one. +To get started with the Wink API, you will first need to get yourself an API access token. Because it is very difficult right now to get access to their API, John McLaughlin has created the form below to get you one. @@ -38,5 +39,5 @@ Configuration variables: This will connect to the Wink hub and automatically set up any lights, switches and sensors that it finds.

-The Wink hub can only be accessed via the cloud. This means it requires an active internet connection and you will experience delays when controlling devices (~3s) and getting an updated device state (~15s). +The Wink hub can only be accessed via the cloud. This means it requires an active internet connection and you will experience delays when controlling devices (~3s) and getting an updated device state (~15s).

diff --git a/source/_components/zone.markdown b/source/_components/zone.markdown index 7cb36f455f8..bce45416b23 100644 --- a/source/_components/zone.markdown +++ b/source/_components/zone.markdown @@ -10,10 +10,7 @@ footer: true ha_category: Organization --- -Zones allow you to specify certain regions on earth (for now). When a device tracker sees a device -to be within a zone, the state will take the name from the zone. Zones can also be used as a -[trigger](/components/automation/#zone-trigger) or [condition](/components/automation/#zone-condition) -inside automation setups. +Zones allow you to specify certain regions on earth (for now). When a device tracker sees a device to be within a zone, the state will take the name from the zone. Zones can also be used as a [trigger](/components/automation/#zone-trigger) or [condition](/components/automation/#zone-condition) inside automation setups. Zones support the usual method to specify multiple zones, use keys `zone:`, `zone 2:` etc. @@ -44,18 +41,12 @@ zone 3: #### {% linkable_title Home zone %} -If no configuration is given, the zone component will create a zone for home. This zone will use -location given in the `configuration.yaml` file and have a radius of 100 meters. To override this, -create a zone configuration and name it 'Home'. +If no configuration is given, the zone component will create a zone for home. This zone will use location given in the `configuration.yaml` file and have a radius of 100 meters. To override this, create a zone configuration and name it 'Home'. #### {% linkable_title Icons %} -It is preferred to pick an icon to use for your zone. By default, Home Assistant includes most of the -[material icons](https://www.google.com/design/icons/). See [the source][icon-source] for a specific list which -categories are included. +It is preferred to pick an icon to use for your zone. By default, Home Assistant includes most of the [material icons](https://www.google.com/design/icons/). See [the source][icon-source] for a specific list which categories are included. -For all but the action category you will need to prefix the icon name with its category. For example -`social:people` or `av:radio`. For the action category, you will not need to do this, examples are -`home`, `work,`, `group-work` and `shopping-cart`. +For all but the action category you will need to prefix the icon name with its category. For example `social:people` or `av:radio`. For the action category, you will not need to do this, examples are `home`, `work,`, `group-work` and `shopping-cart`. [icon-source]: https://github.com/balloob/home-assistant-polymer/blob/master/src/resources/home-assistant-icons.html#L3 diff --git a/source/_components/zwave.markdown b/source/_components/zwave.markdown index 132d033772e..ac3b720bbe7 100644 --- a/source/_components/zwave.markdown +++ b/source/_components/zwave.markdown @@ -19,9 +19,9 @@ To allow Home Assistant to talk to your Z-Wave USB stick you will have to compil Please make sure you have the correct dependencies installed: -``` -apt-get install cython3 libudev-dev python-sphinx python3-setuptools -pip3 install "cython<0.23" +```bash +$ apt-get install cython3 libudev-dev python-sphinx python3-setuptools +$ pip3 install "cython<0.23" ``` As an alternative, the Home Assistant docker image has support for Z-Wave built-in. @@ -36,6 +36,8 @@ Configuration variables: - **usb_path** (*Required*): The port where your device is connected to your Home Assistant host. +To find the path of your Z-Wave stick, run: + ```bash -ls /dev/ttyUSB* +$ ls /dev/ttyUSB* ``` diff --git a/source/_includes/asides/component_navigation.html b/source/_includes/asides/component_navigation.html index 2ff27e24935..9a040bf2658 100644 --- a/source/_includes/asides/component_navigation.html +++ b/source/_includes/asides/component_navigation.html @@ -7,7 +7,8 @@ {% assign file_parts = page.url | split: '/' | last | split: '.' %} - {% if file_parts.size == 3 %} + + {% if file_parts.size == 2 %} {% assign is_platform = true %} {% assign imp_name = file_parts[1] %} {% assign parent_name = file_parts[0] %} @@ -54,8 +55,8 @@ {% for component in components %} {% if component.url != page.url %} {% assign comp_file_parts = component.url | split: '/' | last | split: '.' %} - {% if comp_file_parts.size == 3 %} - {% assign comp_imp_name = comp_file_parts[1] %} + {% if comp_file_parts.size == 2 %} + {% assign comp_imp_name = comp_file_parts | last %} {% else %} {% assign comp_imp_name = comp_file_parts | first %} {% endif %} diff --git a/source/_posts/2015-01-04-hey-pushbullet-nice-talking-to-you.markdown b/source/_posts/2015-01-04-hey-pushbullet-nice-talking-to-you.markdown index 2df775edf5d..74f864dec63 100644 --- a/source/_posts/2015-01-04-hey-pushbullet-nice-talking-to-you.markdown +++ b/source/_posts/2015-01-04-hey-pushbullet-nice-talking-to-you.markdown @@ -25,7 +25,7 @@ Read on to learn how to enable the notify component and integrate it with other To enable the new notify component, add the following to your `home-assistant.conf`: -``` +```conf [notify] platform=pushbullet api_key=ABCDEFGHJKLMNOPQRSTUVXYZ diff --git a/source/_posts/2015-01-11-bootstrapping-your-setup-with-discovery.markdown b/source/_posts/2015-01-11-bootstrapping-your-setup-with-discovery.markdown index 6f1f1a03fa4..828b9c44b69 100644 --- a/source/_posts/2015-01-11-bootstrapping-your-setup-with-discovery.markdown +++ b/source/_posts/2015-01-11-bootstrapping-your-setup-with-discovery.markdown @@ -16,7 +16,7 @@ Most devices still require some sort of interaction from the user after being di To enable the discovery component, add the following to your `home-assistant.conf`: -``` +```conf [discovery] ``` diff --git a/source/_posts/2015-01-13-nest-in-da-house.markdown b/source/_posts/2015-01-13-nest-in-da-house.markdown index c074aa7c0c0..a4ef36a9f90 100644 --- a/source/_posts/2015-01-13-nest-in-da-house.markdown +++ b/source/_posts/2015-01-13-nest-in-da-house.markdown @@ -18,7 +18,7 @@ The new integration exists out of two parts: a generic thermostat component and If you own a Nest thermostat, add the following lines to your `home-assistant.conf`: -``` +```conf [thermostat] platform=nest username=YOUR_USERNAME diff --git a/source/_posts/2015-02-28-home-assistant-migrating-to-yaml.markdown b/source/_posts/2015-02-28-home-assistant-migrating-to-yaml.markdown index 37aee5eef18..b3fc0b1554c 100644 --- a/source/_posts/2015-02-28-home-assistant-migrating-to-yaml.markdown +++ b/source/_posts/2015-02-28-home-assistant-migrating-to-yaml.markdown @@ -9,8 +9,7 @@ comments: true categories: core --- -Home Assistant is now using [YAML](http://yaml.org/) for it's configuration file. -YAML allows the use of lists, which should make the configuration file a bit more flexible and useful. The new configuration file format is backwards compatible with existing components. Because of this, there is no need for component developers to update their components. +Home Assistant is now using [YAML](http://yaml.org/) for it's configuration file. YAML allows the use of lists, which should make the configuration file a bit more flexible and useful. The new configuration file format is backwards compatible with existing components. Because of this, there is no need for component developers to update their components. The new file is named configuration.yaml and if it can't be found in your config directory, Home Assistant will instead try to find the old configuration file, home-assistant.conf. diff --git a/source/_posts/2015-03-22-release-notes.markdown b/source/_posts/2015-03-22-release-notes.markdown index 39320e1314b..fd729755652 100644 --- a/source/_posts/2015-03-22-release-notes.markdown +++ b/source/_posts/2015-03-22-release-notes.markdown @@ -9,7 +9,7 @@ categories: release-notes --- A new version of Home Assistant has just been pushed out. It contains bugfixes contributed by [jamespcole](https://github.com/jamespcole), [andythigpen](https://github.com/andythigpen), [trainman419](https://github.com/trainman419) and [me](https://github.com/balloob). It also adds a bunch of great new features: -__Script__
+__Script__ Andythigpen has contributed a script component. This allows users to create a sequence of service calls and delays. Scripts can be started using the service `script/turn_on` and interrupted using the service `script/turn_off`. A separate page has been added to the frontend to see the status of your scripts. ```yaml @@ -34,7 +34,7 @@ script: -__Scene__
+__Scene__ I (Paulus) have contributed a scene component. A user can create scenes that capture the states you want certain entities to be. For example a scene can contain that light A should be turned on and light B should be bright red. Deactivating a scene will restore the previous state from before the scene was activated. Just like scripts, scenes have their own separate page to see which scenes are on. ```yaml @@ -50,9 +50,8 @@ scene: ``` -__SABnzbd__
- -James Cole has contributed support to integrate SABnzbd. This will allow you to monitor your downloads from within Home Assistant and setup automation based on the information. +__SABnzbd__ + James Cole has contributed support to integrate SABnzbd. This will allow you to monitor your downloads from within Home Assistant and setup automation based on the information. ```yaml # Example configuration.yaml entry @@ -72,9 +71,8 @@ sensor: ``` -__PushOver__
- -James Cole has also contributed support for the PushOver service as a platform for the notify component. This allows components to send messages to the user using PushOver. +__PushOver__ + James Cole has also contributed support for the PushOver service as a platform for the notify component. This allows components to send messages to the user using PushOver. ```yaml # Example configuration.yaml entry diff --git a/source/_posts/2015-04-25-release-notes.markdown b/source/_posts/2015-04-25-release-notes.markdown index 85091861e86..e1f35b1ce3f 100644 --- a/source/_posts/2015-04-25-release-notes.markdown +++ b/source/_posts/2015-04-25-release-notes.markdown @@ -10,16 +10,15 @@ categories: release-notes It's been a month since the latest update and a lot has happened again. Here a quick overview of the new things. -__Line Charts__
+__Line Charts__ [James](https://github.com/jamespcole) has upgraded the history in the frontend to support line graphs. Line graphs will be shown for any entity that has a unit of measurement. The line graphs will also be shown in the more info card of an entity. [See the demo for a live example.](/demo/)

-__ISY994 hub support__
- -[Ryan](https://github.com/rmkraus) has contributed support to integrate the ISY994 hub by Universal Devices. This allows you to integrate your X10/Insteon sensors, switches and lights. +__ISY994 hub support__ + [Ryan](https://github.com/rmkraus) has contributed support to integrate the ISY994 hub by Universal Devices. This allows you to integrate your X10/Insteon sensors, switches and lights. He has created an extensive getting started guide which can be found on [the ISY994 component page](/components/isy994/). @@ -28,9 +27,8 @@ He has created an extensive getting started guide which can be found on [the ISY isy994: ``` -__Logbook__
- -I (Paulus) have added a logbook component. The logbook component provides a different perspective on the history of your house by showing all the changes that happened to your house in chronological order. [See the demo for a live example.](/demo/) +__Logbook__ + I (Paulus) have added a logbook component. The logbook component provides a different perspective on the history of your house by showing all the changes that happened to your house in chronological order. [See the demo for a live example.](/demo/) ```yaml @@ -40,9 +38,8 @@ logbook: -__Transmission support__
- -James has also contributed support for integrating Transmission into Home Assistant. +__Transmission support__ + James has also contributed support for integrating Transmission into Home Assistant. ```yaml # Example configuration.yaml entry @@ -59,7 +56,7 @@ sensor: - type: 'upload_speed' ``` -__Modbus support__
+__Modbus support__ [Kixam](https://github.com/kixam) has contributed support for modbus, a serial communication protocol to control PLCs. It currently supports sensors and switches which can be controlled over serial, TCP and UDP connections. ```yaml diff --git a/source/_posts/2015-05-14-release-notes.markdown b/source/_posts/2015-05-14-release-notes.markdown index 286106f52ec..67be7543c83 100644 --- a/source/_posts/2015-05-14-release-notes.markdown +++ b/source/_posts/2015-05-14-release-notes.markdown @@ -20,7 +20,7 @@ To update to the latest version, run scripts/update. Please report -__Overwriting Entity Attributes__
+__Overwriting Entity Attributes__ Before diving into the newly supported devices and services, I want to highlight an awesome configuration enhancement by [rmkraus](https://github.com/rmkraus): overwriting entity attributes. These new configuration settings allow you to overwrite entity state attributes. The main usage for this is being able to overwrite attributes that influence how an entity is shown in the interface. @@ -37,9 +37,8 @@ homeassistant: entity_picture: http://graph.facebook.com/schoutsen/picture ``` -__MySensors__
- -[Andythigpen](https://github.com/andythigpen) and [Theolind](https://github.com/theolind) have added support for the [MySensors platform](http://www.mysensors.org) to Home Assistant. +__MySensors__ + [Andythigpen](https://github.com/andythigpen) and [Theolind](https://github.com/theolind) have added support for the [MySensors platform](http://www.mysensors.org) to Home Assistant. ```yaml # Example configuration.yaml entry @@ -48,9 +47,8 @@ sensor: port: /dev/ttyACM0 ``` -__OpenWeatherMap__
- -[Fabaff](https://github.com/fabaff) has contributed support for [OpenWeatherMap](http://openweathermap.org). This will allow you to integrate local meteorological data into Home Assistant. +__OpenWeatherMap__ + [Fabaff](https://github.com/fabaff) has contributed support for [OpenWeatherMap](http://openweathermap.org). This will allow you to integrate local meteorological data into Home Assistant. ```yaml # Example configuration.yaml entry @@ -68,9 +66,8 @@ sensor: - type: 'snow' ``` -__InstaPush__
- -[Fabaff](https://github.com/fabaff) has contributed support for [InstaPush](https://instapush.im). This will allow you send messages from Home Assistant to your iOS and Android devices. +__InstaPush__ + [Fabaff](https://github.com/fabaff) has contributed support for [InstaPush](https://instapush.im). This will allow you send messages from Home Assistant to your iOS and Android devices. ```yaml # Example configuration.yaml entry @@ -83,9 +80,8 @@ notify: tracker: ABCDEFGHJKLMNOPQRSTUVXYZ ``` -__XMPP__
- -[Fabaff](https://github.com/fabaff) has contributed support for Jabber/XMPP. This will allow you send messages from Home Assistant to anyone on Jabber/XMPP. +__XMPP__ + [Fabaff](https://github.com/fabaff) has contributed support for Jabber/XMPP. This will allow you send messages from Home Assistant to anyone on Jabber/XMPP. ```yaml # Example configuration.yaml entry @@ -96,9 +92,8 @@ notify: recipient: YOUR_RECIPIENT ``` -__Notify My Android__
- -[Fabaff](https://github.com/fabaff) has contributed support for [Notify My Android](http://www.notifymyandroid.com/). This will allow you to send messages from Home Assistant to your Android device. +__Notify My Android__ + [Fabaff](https://github.com/fabaff) has contributed support for [Notify My Android](http://www.notifymyandroid.com/). This will allow you to send messages from Home Assistant to your Android device. ```yaml # Example configuration.yaml entry @@ -108,7 +103,7 @@ notify: api_key: ABCDEFGHJKLMNOPQRSTUVXYZ ``` -__Time & Date sensor__
+__Time & Date sensor__ [Fabaff](https://github.com/fabaff) has contributed a time & date sensor. This will allow you to show the current time/date on the dashboard. ```yaml diff --git a/source/_posts/2015-06-10-release-notes.markdown b/source/_posts/2015-06-10-release-notes.markdown index 985eba9c910..942ab82f099 100644 --- a/source/_posts/2015-06-10-release-notes.markdown +++ b/source/_posts/2015-06-10-release-notes.markdown @@ -15,8 +15,7 @@ This release sets a record for the amount of people involved: 8! [Andythigpen](h A big improvement has been brought this release by wind-rider. He took the time to revive the Chromecast support and started improving the media player integration. This triggered other people to join in resulting in a revamped media player experience and support for the Music Player Daemon.

- - Example of the new media player cards + Example of the new media player cards

@@ -39,9 +38,8 @@ Before jumping into the newly supported platforms, here are the other improvemen * Fix the device tracker getting in a deadlock by @balloob * Update documentation by @fabaff -__Music Player Daemon__
- -Fabaff has contributed MusicPlayerDaemon support. The mpd platform allows you to control a [Music Player Daemon](http://www.musicpd.org/) from Home Assistant. Right now, only playback is supported and not playlist manipulation. +__Music Player Daemon__ + Fabaff has contributed MusicPlayerDaemon support. The mpd platform allows you to control a [Music Player Daemon](http://www.musicpd.org/) from Home Assistant. Right now, only playback is supported and not playlist manipulation. ```yaml # Example configuration.yaml entry @@ -52,7 +50,7 @@ media_player: location: bedroom ``` -__Command line switch__
+__Command line switch__ A switch platform that issues specific commands when it is turned on and off. This might very well become our most popular platform as it allows anyone to integrate any type of switch into Home Assistant that can be controlled from the command line, including calling other scripts! ```yaml @@ -65,7 +63,7 @@ switch: offcmd: switch_command off kitchen ``` -__LimitlessLED__
+__LimitlessLED__ This new platform can control your LimitlessLED lights from within Home Assistant. The lights are also known as EasyBulb, AppLight, AppLamp, MiLight, LEDme, dekolight or iLight. ```yaml @@ -80,9 +78,8 @@ light: ``` -__Bitcoin sensor__
- -The bitcoin platform displays various details about the [Bitcoin](https://bitcoin.org) network. If you have an online wallet from [Blockchain.info](https://blockchain.info/) the sensor is capable to show your current balance. +__Bitcoin sensor__ + The bitcoin platform displays various details about the [Bitcoin](https://bitcoin.org) network. If you have an online wallet from [Blockchain.info](https://blockchain.info/) the sensor is capable to show your current balance. ```yaml # Example configuration.yaml entry @@ -116,9 +113,8 @@ sensor: ``` -__SMTP notificatoin platform__
- -The smtp platform allows you to deliver notifications from Home Assistant to an e-mail recipient. +__SMTP notificatoin platform__ + The smtp platform allows you to deliver notifications from Home Assistant to an e-mail recipient. ```yaml # Example configuration.yaml entry @@ -134,7 +130,7 @@ notify: ``` -__Syslog notification platform__
+__Syslog notification platform__ The syslog platform allows you to deliver notifications from Home Assistant to the local syslog. ```yaml @@ -144,13 +140,12 @@ notify: ``` -__Swiss Public transport sensor__
+__Swiss Public transport sensor__ The swiss public transport sensor will give you the next two departure times from a given location to another one in Switzerland. See the [component page](/components/sensor.swiss_public_transport/) for more information how to set it up. -__Transmission turtle mode switch__
- -The transmission platform allows you to control your [Transmission](http://www.transmissionbt.com/) client from within Home Assistant. The platform enables you switch to your 'Alternative Speed Limits' (aka 'Turtle mode') setting. +__Transmission turtle mode switch__ + The transmission platform allows you to control your [Transmission](http://www.transmissionbt.com/) client from within Home Assistant. The platform enables you switch to your 'Alternative Speed Limits' (aka 'Turtle mode') setting. ```yaml # Example configuration.yaml entry @@ -164,7 +159,7 @@ switch: ``` -__Hikvision camera motion detection support__
+__Hikvision camera motion detection support__ This switch platform allows you to control your motion detection setting on your Hikvision camera. ```yaml diff --git a/source/_posts/2015-07-11-ip-cameras-arduino-kodi-efergy-support.markdown b/source/_posts/2015-07-11-ip-cameras-arduino-kodi-efergy-support.markdown index fef996e3e1d..cb010250f7b 100644 --- a/source/_posts/2015-07-11-ip-cameras-arduino-kodi-efergy-support.markdown +++ b/source/_posts/2015-07-11-ip-cameras-arduino-kodi-efergy-support.markdown @@ -12,7 +12,7 @@ Another month has passed and some great new features have landed in Home Assista This release includes some architectural changes by me. The first is that the frontend is now based on a [NuclearJS](http://optimizely.github.io/nuclear-js/) JavaScript backend. This has greatly helped to organize and optimize the frontend code. Another change is that Home Assistant will now install dependencies on-demand instead of installing dependencies for all supported devices. -__IP Camera Support__
+__IP Camera Support__ James has worked very hard to add support for IP cameras to Home Assistant which is included in this release. The initial release focusses on providing generic IP camera support. This means that any webcam that can exposes a JPEG image via a url can be integrated. Home Assistant will route the requests to your camera via the server allowing you to expose IP camera's inside your network via the Home Assistant app. @@ -33,9 +33,8 @@ To update to the latest version, run scripts/update. Please report -__Arduino__
- -Fabian has contributed support for interfacing with Arduinos. This makes it possible to connect your Arduino via USB and expose pins as sensor data and write to pins via switches. Have a look at [the docs](/components/arduino/) for an extensive guide to get started. +__Arduino__ + Fabian has contributed support for interfacing with Arduinos. This makes it possible to connect your Arduino via USB and expose pins as sensor data and write to pins via switches. Have a look at [the docs](/components/arduino/) for an extensive guide to get started. ```yaml # Example configuration.yaml entry @@ -60,9 +59,8 @@ sensor: type: analog ``` -__Kodi (XBMC)__
- -Ettisan has contributed a Kodi (XBMC) platform for the media player component. This allows you to track all the media that you are playing and allow you to control it. +__Kodi (XBMC)__ + Ettisan has contributed a Kodi (XBMC) platform for the media player component. This allows you to track all the media that you are playing and allow you to control it. ```yaml # Example configuration.yaml entry @@ -74,9 +72,8 @@ media_player: password: my_secure_password ``` -__TP-Link__
- -Michael has added TP-Link support to the device tracker. This allows you to now detect presence if you have a TP-Link router. +__TP-Link__ + Michael has added TP-Link support to the device tracker. This allows you to now detect presence if you have a TP-Link router. ```yaml # Example configuration.yaml entry @@ -87,9 +84,8 @@ device_tracker: password: YOUR_ADMIN_PASSWORD ``` -__Efergy energy monitor__
- -Miniconfig has contributed support for the [Efergy energy meters](https://efergy.com). To get an app token, log in to your efergy account, go to the Settings page, click on App tokens, and click "Add token". +__Efergy energy monitor__ + Miniconfig has contributed support for the [Efergy energy meters](https://efergy.com). To get an app token, log in to your efergy account, go to the Settings page, click on App tokens, and click "Add token". ```yaml # Example configuration.yaml entry @@ -105,7 +101,7 @@ sensor: currency: $ ``` -__Forecast.io__
+__Forecast.io__ Fabian has added support for [Forecast.io](https://forecast.io/) to get weather forecasts for Home Assistant. You need an API key which is free but requires a [registration](https://developer.forecast.io/register). To add Forecast.io to your installation, add the following to your `configuration.yaml` file: ```yaml diff --git a/source/_posts/2015-08-09-mqtt-raspberry-pi-squeezebox-asuswrt-support.markdown b/source/_posts/2015-08-09-mqtt-raspberry-pi-squeezebox-asuswrt-support.markdown index 18710bdafbc..8cb94322f4a 100644 --- a/source/_posts/2015-08-09-mqtt-raspberry-pi-squeezebox-asuswrt-support.markdown +++ b/source/_posts/2015-08-09-mqtt-raspberry-pi-squeezebox-asuswrt-support.markdown @@ -10,9 +10,8 @@ categories: release-notes It's time for the August release and there is some serious good stuff this time. The core of Home Assistant has gone some serious clean up and a bump in test coverage thanks to [@balloob](https://github.com/balloob). If you're a developer, make sure you read up on [the deprecation notices](https://github.com/balloob/home-assistant/pull/251). [@fabaff](https://github.com/fabaff) did another great round of documentating all the various components. -__MQTT Support__
- -The big new addition in this release is the support for the MQTT protocol by [@fabaff](https://github.com/fabaff) with some help from [@balloob](https://github.com/balloob). It will now be possible to integrate any IoT device that talks via MQTT. For the initial release we support connecting Home Assistant to a broker (no TLS yet). Components can now subscribe and publish to MQTT topics ([see the example][mqtt-example]) and also support for the automation component [has been added][mqtt-automation]. For more information, see [the MQTT component page][mqtt-component]. +__MQTT Support__ + The big new addition in this release is the support for the MQTT protocol by [@fabaff](https://github.com/fabaff) with some help from [@balloob](https://github.com/balloob). It will now be possible to integrate any IoT device that talks via MQTT. For the initial release we support connecting Home Assistant to a broker (no TLS yet). Components can now subscribe and publish to MQTT topics ([see the example][mqtt-example]) and also support for the automation component [has been added][mqtt-automation]. For more information, see [the MQTT component page][mqtt-component]. [mqtt-example]: https://github.com/balloob/home-assistant/blob/dev/config/custom_components/mqtt_example.py [mqtt-automation]: /components/automation/#mqtt-based-automation @@ -32,9 +31,8 @@ mqtt: -__Raspberry PI GPIO Support__
- -[@gbarba](https://github.com/gbarba) has contributed support to use the general purpose input and output pins on a Raspberry PI as switches inside Home Assistant. +__Raspberry PI GPIO Support__ + [@gbarba](https://github.com/gbarba) has contributed support to use the general purpose input and output pins on a Raspberry PI as switches inside Home Assistant. ```yaml # Example configuration.yaml entry @@ -45,9 +43,8 @@ switch: 12: Light Desk ``` -__ASUSWRT based routers__
- -[@persandstrom](https://github.com/persandstrom) has contributed support to do prescence detection using ASUSWRT based routers. +__ASUSWRT based routers__ + [@persandstrom](https://github.com/persandstrom) has contributed support to do prescence detection using ASUSWRT based routers. ```yaml # Example configuration.yaml entry @@ -58,9 +55,8 @@ device_tracker: password: YOUR_ADMIN_PASSWORD ``` -__Logitech Squeezebox media player support__
- -[@persandstrom](https://github.com/persandstrom) also contributed support for the Logitech Squeezebox media player. This allows you to control your Logitech Squeezebox from Home Assistant. +__Logitech Squeezebox media player support__ + [@persandstrom](https://github.com/persandstrom) also contributed support for the Logitech Squeezebox media player. This allows you to control your Logitech Squeezebox from Home Assistant. ```yaml # Example configuration.yaml entry @@ -72,9 +68,8 @@ media_player: password: password ``` -__Slack notification support__
- -[@jamespcole](https://github.com/jamespcole) has contributed a Slack platform for the notification platform. This allows you to deliver messages to any channel. +__Slack notification support__ + [@jamespcole](https://github.com/jamespcole) has contributed a Slack platform for the notification platform. This allows you to deliver messages to any channel. ```yaml # Example configuration.yaml entry @@ -84,9 +79,8 @@ notify: default_channel: '#general' ``` -__Edimax Smart Switches support__
- -[@rkabadi](https://github.com/rkabadi) has contributed support for integrating Edimax Smart Switches into Home Assistant. +__Edimax Smart Switches support__ + [@rkabadi](https://github.com/rkabadi) has contributed support for integrating Edimax Smart Switches into Home Assistant. ```yaml # Example configuration.yaml entry @@ -98,7 +92,7 @@ switch: name: Edimax Smart Plug ``` -__RFXtrx sensor support__
+__RFXtrx sensor support__ [@danielhiversen](https://github.com/danielhiversen) has contributed support for RFXtrx sensors. It supports sensors that communicate in the frequency range of 433.92 MHz. ```yaml @@ -110,7 +104,7 @@ sensor: The path to your device, e.g. `/dev/serial/by-id/usb-RFXCOM_RFXtrx433_A1Y0NJGR-if00-port0` -__TEMPer temperature sensor support__
+__TEMPer temperature sensor support__ Support for Temper temperature sensors has been contributed by [@rkabadi](https://github.com/rkabadi). ```yaml diff --git a/source/_posts/2015-08-17-verisure-and-modern-tp-link-router-support.markdown b/source/_posts/2015-08-17-verisure-and-modern-tp-link-router-support.markdown index 983d48d3370..9484565a1b7 100644 --- a/source/_posts/2015-08-17-verisure-and-modern-tp-link-router-support.markdown +++ b/source/_posts/2015-08-17-verisure-and-modern-tp-link-router-support.markdown @@ -17,9 +17,8 @@ As we didn't want to just push out bug fixes, this release includes a few additi - Support for modern TP-Link routers like the ArcherC9 line has been contributed by [@chrisvis](https://github.com/chrisvis). - Improved support for MQTT topic subscriptions has been contributed by [@qrtn](https://github.com/qrtn) -__Verisure Support__
- -Home Assistant support to integrate your [Verisure](https://www.verisure.com/) alarms, hygrometers, sensors and thermometers has been contributed by [@persandstrom](https://github.com/persandstrom). +__Verisure Support__ + Home Assistant support to integrate your [Verisure](https://www.verisure.com/) alarms, hygrometers, sensors and thermometers has been contributed by [@persandstrom](https://github.com/persandstrom). ```yaml # Example configuration.yaml entry diff --git a/source/_posts/2015-08-26-laundry-automation-with-moteino-mqtt-and-home-assistant.markdown b/source/_posts/2015-08-26-laundry-automation-with-moteino-mqtt-and-home-assistant.markdown index 80fd3206ed3..428fefd5ee9 100644 --- a/source/_posts/2015-08-26-laundry-automation-with-moteino-mqtt-and-home-assistant.markdown +++ b/source/_posts/2015-08-26-laundry-automation-with-moteino-mqtt-and-home-assistant.markdown @@ -54,7 +54,7 @@ Materials used: Home Assistant Configuration: -``` +```yaml mqtt: broker: 192.168.1.100 port: 1883 diff --git a/source/_posts/2015-08-31-version-7-revamped-ui-and-improved-distribution.markdown b/source/_posts/2015-08-31-version-7-revamped-ui-and-improved-distribution.markdown index c22d422060c..961a5eb0dec 100644 --- a/source/_posts/2015-08-31-version-7-revamped-ui-and-improved-distribution.markdown +++ b/source/_posts/2015-08-31-version-7-revamped-ui-and-improved-distribution.markdown @@ -9,31 +9,19 @@ categories: user-stories og_image: /images/screenshots/ui2015.png --- -As Home Assistant is gaining more and more users we started to feel the pain from not having a -proper release mechanism. We had no version numbering and required users to checkout the source -using Git to get started. On top of that, as the number of devices that we support keeps raising, so -did the number of dependencies that are used. That's why we decided to change the way we roll. From -now on: +As Home Assistant is gaining more and more users we started to feel the pain from not having a proper release mechanism. We had no version numbering and required users to checkout the source using Git to get started. On top of that, as the number of devices that we support keeps raising, so did the number of dependencies that are used. That's why we decided to change the way we roll. From now on: - - Each release will have a version number, starting with version 0.7. This was chosen because it - shows that we have been around for some time but are not considering ourselves to be fully - stable. + - Each release will have a version number, starting with version 0.7. This was chosen because it shows that we have been around for some time but are not considering ourselves to be fully stable. - Each release will be pushed to PyPi. This will be the only supported method of distribution. - Home Assistant is available after installation as a command-line utility `hass`. - - The default configuration location has been moved from `config` in the current working directory - to `~/.homeassistant` (`%APPDATA%/.homeassistant` on Windows). - - Requirements for components and platforms are no longer installed into the current Python - environment (being virtual or not) but will be installed in `/lib`. + - The default configuration location has been moved from `config` in the current working directory to `~/.homeassistant` (`%APPDATA%/.homeassistant` on Windows). + - Requirements for components and platforms are no longer installed into the current Python environment (being virtual or not) but will be installed in `/lib`. -A huge shout out to [Ryan Kraus](https://github.com/rmkraus) for making this all possible. Please -make sure you read [the full blog post][self] for details on how to migrate your existing setup. +A huge shout out to [Ryan Kraus](https://github.com/rmkraus) for making this all possible. Please make sure you read [the full blog post][self] for details on how to migrate your existing setup. [self]: /blog/2015/08/31/version-7-revamped-ui-and-improved-distribution/#read-more -And while Ryan was fixing distribution, I have been hard at work in giving Home Assistant a face -lift. We already looked pretty good but lacked proper form of organization for users with many -devices. The new UI moves away from a card per entity and has cards per group and domain instead. -[The demo](/demo/) has been updated so give it a spin. +And while Ryan was fixing distribution, I have been hard at work in giving Home Assistant a face lift. We already looked pretty good but lacked proper form of organization for users with many devices. The new UI moves away from a card per entity and has cards per group and domain instead. [The demo](/demo/) has been updated so give it a spin.

@@ -46,32 +34,26 @@ devices. The new UI moves away from a card per entity and has cards per group an ### {% linkable_title Migration to version 0.7 %} -For this example, let's say we have an old Home Assistant installation in -`/home/paulus/home-assistant`. +For this example, let's say we have an old Home Assistant installation in `/home/paulus/home-assistant`. If you want to migrate your existing configuration to be used as the default configuration: ```bash -cp -r /home/paulus/home-assistant ~/.homeassistant +$ cp -r /home/paulus/home-assistant ~/.homeassistant ``` -It If you want to have the configuration in a different location, for example -`/home/paulus/home-assistant-config`, you will have to point Home Assistant at this configuration -folder when launching: +It If you want to have the configuration in a different location, for example `/home/paulus/home-assistant-config`, you will have to point Home Assistant at this configuration folder when launching: ```bash -hass --config /home/paulus/home-assistant-config +$ hass --config /home/paulus/home-assistant-config ``` ### {% linkable_title New platforms %} And last, but not least: new platforms! -__MQTT Sensors and Switches__
- -[@sfam](https://github.com/sfam) has blessed us with two more MQTT platforms to extend our -integration with MQTTT: [sensor][mqtt-sensor] and [switch][mqtt-switch]. Both platforms require the -MQTT component to be connected to a broker. +__MQTT Sensors and Switches__ + [@sfam](https://github.com/sfam) has blessed us with two more MQTT platforms to extend our integration with MQTTT: [sensor][mqtt-sensor] and [switch][mqtt-switch]. Both platforms require the MQTT component to be connected to a broker. [mqtt-sensor]: /components/sensor.mqtt/ [mqtt-switch]: /components/switch.mqtt/ @@ -94,9 +76,8 @@ switch: optimistic: false ``` -__Actiontec MI424WR Verizon FIOS Wireless router__
- -[Nolan](https://github.com/nkgilley) has contributed support for Actiontec wireless routers. +__Actiontec MI424WR Verizon FIOS Wireless router__ + [Nolan](https://github.com/nkgilley) has contributed support for Actiontec wireless routers. ```yaml # Example configuration.yaml entry @@ -107,10 +88,8 @@ device_tracker: password: YOUR_ADMIN_PASSWORD ``` -__DHT temperature and humidty sensors__
-[@MakeMeASandwich](https://github.com/makemeasandwich) has contributed support for DHT temperature -and humidity sensors. It allows you to get the current temperature and humidity from a DHT11, DHT22, -or AM2302 device. +__DHT temperature and humidty sensors__ +[@MakeMeASandwich](https://github.com/makemeasandwich) has contributed support for DHT temperature and humidity sensors. It allows you to get the current temperature and humidity from a DHT11, DHT22, or AM2302 device. ```yaml # Example configuration.yaml entry @@ -123,7 +102,7 @@ sensor: - humidity ``` -__Aruba device tracker__
+__Aruba device tracker__ [Michael Arnauts](https://github.com/michaelarnauts) has contributed support for Aruba wireless routers for presence detection. ```yaml diff --git a/source/_posts/2015-09-11-different-ways-to-use-mqtt-with-home-assistant.markdown b/source/_posts/2015-09-11-different-ways-to-use-mqtt-with-home-assistant.markdown index e7806bd8097..16c614f0402 100644 --- a/source/_posts/2015-09-11-different-ways-to-use-mqtt-with-home-assistant.markdown +++ b/source/_posts/2015-09-11-different-ways-to-use-mqtt-with-home-assistant.markdown @@ -10,14 +10,16 @@ categories: how-to mqtt og_image: /images/blog/2015-09-mqtt/arduino.png --- - -The [MQTT](https://en.wikipedia.org/wiki/MQTT) support was added to Home Assistant recently. The [MQTT component](https://home-assistant.io/components/mqtt/) will enable you to do all sort of things. Most likely you will use it to communicate with your devices. But Home Assistant doesn't care where the data is coming from or is limited to real hardware as long as there is MQTT support. This means that it doesn't matter if the data is coming from a human, a web service, or a device. +{::options coderay_line_numbers="table" /} + + [MQTT](https://en.wikipedia.org/wiki/MQTT) support was added to Home Assistant recently. The [MQTT component](https://home-assistant.io/components/mqtt/) will enable you to do all sort of things. Most likely you will use it to communicate with your devices. But Home Assistant doesn't care where the data is coming from or is limited to real hardware as long as there is MQTT support. This means that it doesn't matter if the data is coming from a human, a web service, or a device. A great example is shown in a [Laundry Automation](https://home-assistant.io/blog/2015/08/26/laundry-automation-with-moteino-mqtt-and-home-assistant/) post in this blog. This post will give you a small overview of some other possibilities on how to use MQTT with Home Assistant. + ### {% linkable_title Manual usage %} The simplest but not the coolest way as a human to interact with a Home Assistant sensor is launching a command manually. Let's create a "Mood" sensor. For simplicity Home Assistant and the MQTT broker are both running on the same host. The needed configuration snipplets to add to the `configuration.yaml` file consists of two parts: one for the broker and one for the sensor. @@ -37,7 +39,7 @@ After a restart of Home Assistant the "Mood" sensor will show up in the frontend Now we can set the mood. The commandline tool (`mosquitto_pub`) which is shipped with `mosquitto` is used to send an MQTT message. ```bash -mosquitto_pub -h 127.0.0.1 -t "home-assistant/fabian/mood" -m "bad" +$ mosquitto_pub -h 127.0.0.1 -t "home-assistant/fabian/mood" -m "bad" ```

@@ -45,7 +47,7 @@ mosquitto_pub -h 127.0.0.1 -t "home-assistant/fabian/mood" -m "bad" The Mood sensor

-This is a really bad example. Don't do this in the real world because you won't be able to create diagrams of historical data. Better use a numerical value. +This is a really bad example. Don't do this in the real world because you won't be able to create diagrams of historical data. Better use a numerical value. ### {% linkable_title Python MQTT bindings %} diff --git a/source/_posts/2015-09-13-home-assistant-meets-ifttt.markdown b/source/_posts/2015-09-13-home-assistant-meets-ifttt.markdown index e5d27400333..703a24d323e 100644 --- a/source/_posts/2015-09-13-home-assistant-meets-ifttt.markdown +++ b/source/_posts/2015-09-13-home-assistant-meets-ifttt.markdown @@ -10,13 +10,9 @@ categories: how-to release-notes og_image: /images/blog/2015-09-ifttt/og_facebook.png --- -Today we announce the release of Home Assistant v0.7.2 which includes brand new support by -[@sfam][github-sfam] to integrate with [IFTTT][ifttt]. IFTTT stands for If This, Then That and is a -webservice that integrates with almost every possible webservice out there. Adding Home -Assistant to this mix means Home Assistant can connect with all via IFTTT. +Today we announce the release of Home Assistant v0.7.2 which includes brand new support by [@sfam][github-sfam] to integrate with [IFTTT][ifttt]. IFTTT stands for If This, Then That and is a webservice that integrates with almost every possible webservice out there. Adding Home Assistant to this mix means Home Assistant can connect with all via IFTTT. -It is now possible to disable your irregation system if it is going to be cloudy tomorrow or tweet -if your smoke alarm goes off. +It is now possible to disable your irregation system if it is going to be cloudy tomorrow or tweet if your smoke alarm goes off. [github-sfam]: https://github.com/sfam [ifttt]: https://ifttt.com @@ -25,13 +21,11 @@ if your smoke alarm goes off.

-Head over to the [setup instructions](/components/ifttt/) to get started with IFTTT. Click the -read more button for some example recipes. +Head over to the [setup instructions](/components/ifttt/) to get started with IFTTT. Click the read more button for some example recipes. -In each of the following examples, make sure to replace the XXX in the url with your correct -host address and api password. +In each of the following examples, make sure to replace the XXX in the url with your correct host address and api password. ## {% linkable_title Turn off irregation system when not needed %} @@ -54,9 +48,7 @@ Maker channel setup:

-This will tweet a message when an MQTT message is received that the smoke alarm has been triggered. -Setup Maker channel with event name `HA_FIRE_ALARM` and Twitter channel to tweet the message in -`value1`. +This will tweet a message when an MQTT message is received that the smoke alarm has been triggered. Setup Maker channel with event name `HA_FIRE_ALARM` and Twitter channel to tweet the message in `value1`. ```yaml # Configuration.yaml entry diff --git a/source/_posts/2015-09-18-monitoring-with-glances-and-home-assistant.markdown b/source/_posts/2015-09-18-monitoring-with-glances-and-home-assistant.markdown index 59e7499be26..545cf7ae4e6 100644 --- a/source/_posts/2015-09-18-monitoring-with-glances-and-home-assistant.markdown +++ b/source/_posts/2015-09-18-monitoring-with-glances-and-home-assistant.markdown @@ -23,21 +23,21 @@ In this post a default Fedora 22 Workstation installation is used on the host th First some extra packages are needed beside Glances, especially the [bottle](http://bottlepy.org/docs/dev/index.html) webserver. I guess that Glances is available for your distribution as well. Otherwise follow those [instructions](https://github.com/nicolargo/glances#installation). -``` -sudo dnf -y install glances python-bottle +```bash +$ sudo dnf -y install glances python-bottle ``` On Fedora the Firewall settings are strict. Let's open port 61208 to allow other hosts to connect to that port. This is not needed if you just want to observe your local machine. ```bash -sudo firewall-cmd --permanent --add-port=61208/tcp -sudo firewall-cmd --reload +$ sudo firewall-cmd --permanent --add-port=61208/tcp +$ sudo firewall-cmd --reload ``` Launch `glances` and keep an eye on the output. ```bash -glances -w +$ glances -w Glances web server started on http://0.0.0.0:61208/ ``` @@ -51,7 +51,7 @@ Now browse to http://IP_ADRRESS:61208/. You should see the webified view of Glan Another check is to access the API located at http://IP_ADRRESS:61208/api/2/mem/used and to confirm that a detail about your memory usage is provided as a JSON response. If so, you are good to proceed. ```bash -curl -X GET http://IP_ADDRESS:61208/api/2/mem/used +$ curl -X GET http://IP_ADDRESS:61208/api/2/mem/used {"used": 203943936} ``` diff --git a/source/_posts/2015-09-19-alarm-sonos-and-itunes-support.markdown b/source/_posts/2015-09-19-alarm-sonos-and-itunes-support.markdown index f10625982b0..0f5eaa51447 100644 --- a/source/_posts/2015-09-19-alarm-sonos-and-itunes-support.markdown +++ b/source/_posts/2015-09-19-alarm-sonos-and-itunes-support.markdown @@ -9,24 +9,17 @@ comments: true categories: release-notes --- -It's like someone opened a can of rock solid developers and emptied it above our -[chat channel](https://gitter.im/balloob/home-assistant) because it exploded with -great conversations and solid contributions. Featured in release 0.7.3: Sonos, iTunes, Alarm component and Automation upgrade. +It's like someone opened a can of rock solid developers and emptied it above our [chat channel](https://gitter.im/balloob/home-assistant) because it exploded with great conversations and solid contributions. Featured in release 0.7.3: Sonos, iTunes, Alarm component and Automation upgrade. See [GitHub](https://github.com/balloob/home-assistant/releases/tag/0.7.3) for more detailed release notes. _Migration note: the `scheduler` component has been removed in favor of the `automation` component._ -__Sonos__
- -Sonos support has been added by [@rhooper](https://github.com/rhooper) and [@SEJeff](https://github.com/SEJeff). Home Assistant is now able to automatically -detect Sonos devices in your network and set them up for you. It will allow you to control music -playing on your Sonos and change the volume. +__Sonos__ + Sonos support has been added by [@rhooper](https://github.com/rhooper) and [@SEJeff](https://github.com/SEJeff). Home Assistant is now able to automatically detect Sonos devices in your network and set them up for you. It will allow you to control music playing on your Sonos and change the volume. -__iTunes and airplay speakers__
- -[@maddox](https://github.com/maddox) has contributed support for controlling iTunes and airplay speakers. For this to work you will -have to run [itunes-api](https://github.com/maddox/itunes-api) on your Mac as middleware. +__iTunes and airplay speakers__ + [@maddox](https://github.com/maddox) has contributed support for controlling iTunes and airplay speakers. For this to work you will have to run [itunes-api](https://github.com/maddox/itunes-api) on your Mac as middleware. ```yaml # Example configuration.yaml entry @@ -39,10 +32,8 @@ media_player: -__Automation__
-Automation has gotten a lot of love. It now supports conditions, multiple triggers and new types of -triggers. The best to get started with it is to head over to the new -[getting started with automation](/getting-started/automation/) page. +__Automation__ +Automation has gotten a lot of love. It now supports conditions, multiple triggers and new types of triggers. The best to get started with it is to head over to the new [getting started with automation](/getting-started/automation/) page. ```yaml # Example of entry in configuration.yaml @@ -67,7 +58,5 @@ automation: entity_id: group.living_room ``` -__Verisure Alarms__
- -We now support arming and disarming your verisure alarm from within Home Assistant thanks to added -support by [@persandstrom](https://github.com/persandstrom). +__Verisure Alarms__ + We now support arming and disarming your verisure alarm from within Home Assistant thanks to added support by [@persandstrom](https://github.com/persandstrom). diff --git a/source/_posts/2015-10-05-home-assistant-goes-geo-with-owntracks.markdown b/source/_posts/2015-10-05-home-assistant-goes-geo-with-owntracks.markdown index e7581bf807b..e548fc3eff6 100644 --- a/source/_posts/2015-10-05-home-assistant-goes-geo-with-owntracks.markdown +++ b/source/_posts/2015-10-05-home-assistant-goes-geo-with-owntracks.markdown @@ -10,9 +10,7 @@ categories: release-notes og_image: /images/screenshots/map.png --- -A few weeks have past and it is time again for another release: version 0.7.4. This time we're very -glad to be able to introduce brand new integration with OwnTracks to allow tracking of people on a map. -The geo support consists of three different parts: +A few weeks have past and it is time again for another release: version 0.7.4. This time we're very glad to be able to introduce brand new integration with OwnTracks to allow tracking of people on a map. The geo support consists of three different parts: - [OwnTracks platform for the device tracker][platform-owntracks] to get locations for devices - Brand new [zone component][component-zone] to define zones to identify locations and [trigger automation][zone-automation] @@ -30,8 +28,7 @@ We have added a new [getting started section][start-presence] to get up and runn Map in Home Assistant showing two people and three zones (home, school, work)

-Ofcourse more things happened in the last three weeks. I'm moving away from my usual long post to a -short summary of highlights: +Ofcourse more things happened in the last three weeks. I'm moving away from my usual long post to a short summary of highlights: diff --git a/source/_posts/2015-10-11-rfxtrx-blinkstick-and-snmp-support.markdown b/source/_posts/2015-10-11-rfxtrx-blinkstick-and-snmp-support.markdown index 1b8197e8df1..63b445ea210 100644 --- a/source/_posts/2015-10-11-rfxtrx-blinkstick-and-snmp-support.markdown +++ b/source/_posts/2015-10-11-rfxtrx-blinkstick-and-snmp-support.markdown @@ -16,9 +16,7 @@ We discovered two issues annoying enough to warrent the release of 0.7.5: This release also includes some new platforms (because they keep coming!): - - - + - Light: [blinkstick platform](/components/light.blinksticklight/) added ([@alanbowman](https://github.com/alanbowman)) - Device Tracker: [SNMP platform](/components/device_tracker.snmp/) added ([@tomduijf](https://github.com/tomduijf)) @@ -26,5 +24,4 @@ This release also includes some new platforms (because they keep coming!): - Switch: [rfxtrx platform](/components/switch.rfxtrx/) added ([@badele](https://github.com/badele)) - Notify: [telegram platform](/components/notify.telegram/) added ([@fabaff](https://github.com/fabaff)) -Also, the media player was extended by [@maddox](https://github.com/maddox) to support the play media command. -This has been implemented for the [iTunes platform](/components/media_player.itunes/). +Also, the media player was extended by [@maddox](https://github.com/maddox) to support the play media command. This has been implemented for the [iTunes platform](/components/media_player.itunes/). diff --git a/source/_posts/2015-10-26-firetv-and-radiotherm-now-supported.markdown b/source/_posts/2015-10-26-firetv-and-radiotherm-now-supported.markdown index 90c3e8f15cd..e9689665cf6 100644 --- a/source/_posts/2015-10-26-firetv-and-radiotherm-now-supported.markdown +++ b/source/_posts/2015-10-26-firetv-and-radiotherm-now-supported.markdown @@ -9,17 +9,11 @@ comments: true categories: release-notes --- -After two weeks of hard work I'm proud to announce the release of Home Assistant v0.7.6. For this release the main -focus was bugs, test coverage and documentation. And we exceeded expectations on all three fronts. Bugs have been -squashed, [test coverage increased to 85%](https://coveralls.io/builds/3946399) and thanks to the hard work by -[@fabaff](https://github.com/fabaff) and myself the [component section](/components/) on the website has gotten a -complete revamp. +After two weeks of hard work I'm proud to announce the release of Home Assistant v0.7.6. For this release the main focus was bugs, test coverage and documentation. And we exceeded expectations on all three fronts. Bugs have been squashed, [test coverage increased to 85%](https://coveralls.io/builds/3946399) and thanks to the hard work by [@fabaff](https://github.com/fabaff) and myself the [component section](/components/) on the website has gotten a complete revamp. #### Changes - - - + - Device tracker: Newer [TP-Link routers](/components/device_tracker.tplink/) now supported ([@mKeRix](https://github.com/mKeRix)) - Alarm Control Panel: [Manual alarm](/components/alarm_control_panel.manual/) added ([@sfam](https://github.com/sfam)) @@ -44,17 +38,14 @@ complete revamp. As part of this release we did some cleanup which introduced backwards incompatible changes: -**Heat Control thermostat no longer includes scheduling features.**
-This feature has been removed completely. Use the [automation component](/components/automation/) -instead to control target temperature. +**Heat Control thermostat no longer includes scheduling features.** +This feature has been removed completely. Use the [automation component](/components/automation/) instead to control target temperature. -**Config changed for calling a service from a script.**
-`execute_service:` has been replaced with `service:`. See [component page](/components/script/) -for example. The old method will continue working for some time. +**Config changed for calling a service from a script.** +`execute_service:` has been replaced with `service:`. See [component page](/components/script/) for example. The old method will continue working for some time. -**Scenes can no longer be turned off.**
-It is no longer possible to turn a scene off after it has been activated. The way it worked was unpredictable -and causes a lot of confusion. +**Scenes can no longer be turned off.** +It is no longer possible to turn a scene off after it has been activated. The way it worked was unpredictable and causes a lot of confusion. -**Downloader treats relative paths now relative to the config dir instead of the current working dir.**
+**Downloader treats relative paths now relative to the config dir instead of the current working dir.** This makes more sense as most people run Home Assistant as a daemon