diff --git a/source/_components/automation.markdown b/source/_components/automation.markdown index 3585196f9b0..e52207795e2 100644 --- a/source/_components/automation.markdown +++ b/source/_components/automation.markdown @@ -11,6 +11,12 @@ logo: home-assistant.png ha_category: Automation --- -Please see the [getting started section] for in-depth documentation on how to use the automation component. +Please see the [getting started section](/getting-started/automation/) for in-depth documentation on how to use the automation component. -[getting started section]: /getting-started/automation/ +Starting with 0.28 your automation rules can be controlled with the frontend. + +

+ +

+ +This allows one to reload the automation without restarting Home Assistant itself. diff --git a/source/_components/binary_sensor.ffmpeg.markdown b/source/_components/binary_sensor.ffmpeg.markdown index 89007c3c609..3481e8c6264 100644 --- a/source/_components/binary_sensor.ffmpeg.markdown +++ b/source/_components/binary_sensor.ffmpeg.markdown @@ -22,7 +22,7 @@ To enable your FFmpeg with noise detection in your installation, add the followi ```yaml # Example configuration.yaml entry -camera: +binary_sensor: - platform: ffmpeg tool: noise input: FFMPEG_SUPPORTED_INPUT @@ -57,7 +57,7 @@ To enable your FFmpeg with motion detection in your installation, add the follow ```yaml # Example configuration.yaml entry -camera: +binary_sensor: - platform: ffmpeg tool: motion input: FFMPEG_SUPPORTED_INPUT diff --git a/source/_components/binary_sensor.knx.markdown b/source/_components/binary_sensor.knx.markdown index ff99d54be20..ffe81a04d85 100644 --- a/source/_components/binary_sensor.knx.markdown +++ b/source/_components/binary_sensor.knx.markdown @@ -10,6 +10,7 @@ footer: true logo: knx.png ha_category: Binary Sensor ha_release: 0.24 +ha_iot_class: "Local Polling" --- To get your KNX binary sensors working with Home Assistant, follow the instructions for the [KNX component](/components/knx/). diff --git a/source/_components/bloomsky.markdown b/source/_components/bloomsky.markdown index c34d8a75931..25ab683a228 100644 --- a/source/_components/bloomsky.markdown +++ b/source/_components/bloomsky.markdown @@ -16,7 +16,7 @@ ha_iot_class: "Cloud Polling" The `bloomsky` component allows you to access your [BloomSky](https://www.bloomsky.com/) weather station's [sensors](/components/sensor.bloomsky), [binary sensors](/components/binary_sensor.bloomsky), and [camera](/components/camera.bloomsky) from Home Assistant. -Obtain your PI key from your [BloomSky dashboard](https://dashboard.bloomsky.com). Click `developers` in the bottom left of the screen. +Obtain your API key from your [BloomSky dashboard](https://dashboard.bloomsky.com). Click `developers` in the bottom left of the screen. To integrate your BloomSky hub with Home Assistant, add the following section to your `configuration.yaml` file: diff --git a/source/_components/climate.eq3btsmart.markdown b/source/_components/climate.eq3btsmart.markdown index 1d16168cb11..6bb20c45227 100644 --- a/source/_components/climate.eq3btsmart.markdown +++ b/source/_components/climate.eq3btsmart.markdown @@ -58,7 +58,7 @@ to the start function of /etc/init.d/hass-daemon. # Example configuration.yaml entry climate: platform: eq3btsmart - devices: - room1: - mac: '00:11:22:33:44:55' + devices: + room1: + mac: '00:11:22:33:44:55' ``` diff --git a/source/_components/climate.generic_thermostat.markdown b/source/_components/climate.generic_thermostat.markdown index bca038ff904..0f4caf9ae5b 100644 --- a/source/_components/climate.generic_thermostat.markdown +++ b/source/_components/climate.generic_thermostat.markdown @@ -40,6 +40,6 @@ Configuration variables: - **target_sensor** (*Required*): `entity_id` for a temperature sensor, target_sensor.state must be temperature. - **min_temp** (*Optional*): Set minimum set point available (default: 7) - **max_temp** (*Optional*): Set maximum set point available (default: 35) -- **target_temp** (*Required*): Set intital target temperature. Failure to set this variable will result in target temperature being set to null on startup. +- **target_temp** (*Optional*): Set intital target temperature. Failure to set this variable will result in target temperature being set to null on startup. - **ac_mode** (*Optional*): Set the switch specified in the *heater* option to be treated as a cooling device instead of a heating device. - **min_cycle_duration** (*Optional*): Set a minimum amount of time that the switch specified in the *heater* option must be in it's current state prior to being switched either off or on. diff --git a/source/_components/climate.knx.markdown b/source/_components/climate.knx.markdown index 9f89dcfa73c..2f8db8ff022 100644 --- a/source/_components/climate.knx.markdown +++ b/source/_components/climate.knx.markdown @@ -10,6 +10,7 @@ footer: true logo: knx.png ha_category: DIY ha_release: 0.25 +ha_iot_class: "Local Polling" --- @@ -20,16 +21,18 @@ KNX thermostats use at least 2 group addresses: one for the current temperature To use your KNX thermostats in your installation, add the following to your `configuration.yaml` file: ```yaml +# Example configuration.yaml entry climate: - platform: knx name: KNX Thermostat + address : KNX_ADDRESS temperature_address: 0/1/1 setpoint_address: 0/1/0 ``` - **name** (*Optional*): A name for this devices used within Home assistant - **address** (*Required*): The KNX group address that is used to turn on/off this actuator channel -- **temperature_address** (*Required*): The group address that is used to communicate the current temperature. Data format must be datapoint type 9.001 DPT_Value_Temp (2-Octet float value) (see http://www.knx.org/fileadmin/template/documents/downloads_support_menu/KNX_tutor_seminar_page/Advanced_documentation/05_Interworking_E1209.pdf) +- **temperature_address** (*Required*): The group address that is used to communicate the current temperature. Data format must be datapoint type 9.001 DPT_Value_Temp (2-Octet float value), check [details](http://www.knx.org/fileadmin/template/documents/downloads_support_menu/KNX_tutor_seminar_page/Advanced_documentation/05_Interworking_E1209.pdf). - **setpoint_address** (*Required*): The group address that is used to set/read the target temperature. Data format must be datapoint type 9.001 DPT_Value_Temp (2-Octet float value). Make sure, you set the read-flag for the thermostat to allow Home Assistant to read the target temperature. With the current version of the module, no advanced KNX thermostat functionalities (e.g. HVAC mode) are supported. diff --git a/source/_components/cover.mqtt.markdown b/source/_components/cover.mqtt.markdown index 9723c560553..a1859e425f4 100644 --- a/source/_components/cover.mqtt.markdown +++ b/source/_components/cover.mqtt.markdown @@ -33,7 +33,7 @@ cover: qos: 0 retain: true payload_open: "PAYLOAD_OPEN" - payload_close: "PAYLOD__CLOSE" + payload_close: "PAYLOAD_CLOSE" payload_stop: "PAYLOAD_STOP" state_open: "STATE_OPEN" state_closed: "STATE_CLOSED" @@ -60,6 +60,6 @@ Configuration variables: For a quick check you can use the commandline tools shipped with `mosquitto` to send MQTT messages. Set the state of your sensor manually: ```bash -$ mosquitto_pub -h 127.0.0.1 -t home-assistant/cover/set -m "OFF" +$ mosquitto_pub -h 127.0.0.1 -t home-assistant/cover/set -m "PAYLOAD_CLOSE" ``` diff --git a/source/_components/device_tracker.bluetooth_le_tracker.markdown b/source/_components/device_tracker.bluetooth_le_tracker.markdown index 62effa6f6d9..335a38bfb77 100644 --- a/source/_components/device_tracker.bluetooth_le_tracker.markdown +++ b/source/_components/device_tracker.bluetooth_le_tracker.markdown @@ -32,4 +32,13 @@ Some BTLE devices (e.g. fitness trackers) are only visible to the devices that t BTLE tracking requires root privileges. +For running Home Assistant as non root user we can give python3 the missing capabilities to access the bluetooth stack. Quite like setting the setuid bit (see [Stack Exchange](http://unix.stackexchange.com/questions/96106/bluetooth-le-scan-as-non-root) for more information). + +```bash +sudo apt-get install libcap2-bin +sudo setcap 'cap_net_raw,cap_net_admin+eip' `readlink -f \`which python3\`` +``` + +A restart of Home Assistant is required. + For additional configuration variables check the [Device tracker page](/components/device_tracker/). diff --git a/source/_components/device_tracker.nmap_scanner.markdown b/source/_components/device_tracker.nmap_tracker.markdown similarity index 92% rename from source/_components/device_tracker.nmap_scanner.markdown rename to source/_components/device_tracker.nmap_tracker.markdown index cd9019b38f8..6334ab3a0b1 100644 --- a/source/_components/device_tracker.nmap_scanner.markdown +++ b/source/_components/device_tracker.nmap_tracker.markdown @@ -25,11 +25,15 @@ device_tracker: platform: nmap_tracker hosts: 192.168.1.1/24 home_interval: 10 + exclude: + - 192.168.1.12 + - 192.168.1.13 ``` Configuration variables: - **hosts** (*Required*): The network range to scan in CIDR notation, eg. 192.168.1.1/24 - **home_interval** (*Optional*): The number of minutes nmap will not scan this device, assuming it is home, in order to preserve the device battery. +- **exclude** (*Optional*): Hosts not to include in nmap scanning. See the [device tracker component page](/components/device_tracker/) for instructions how to configure the people to be tracked. diff --git a/source/_components/ecobee.markdown b/source/_components/ecobee.markdown index b1b3eca6f6c..5caa423d5f9 100644 --- a/source/_components/ecobee.markdown +++ b/source/_components/ecobee.markdown @@ -1,6 +1,6 @@ --- layout: page -title: "Ecobee" +title: "ecobee" description: "Instructions for how to integrate Ecobee thermostats and sensors within Home Assistant." date: 2015-11-30 17:54 sidebar: true @@ -15,13 +15,37 @@ featured: true The `ecobee` component lets you control a thermostats and view sensor data from [ecobee](https://ecobee.com) thermostats. -You will need to obtain an API key from ecobee's [developer site](https://www.ecobee.com/developers/) to use this component. To get the key, first you need to register your thermostat. Once you have done that, click on the **Become a developer** link on the developer site. Login with your Ecobee credentials, accept the SDK agreement, fill in the fields, and click **save**. Now login to the regular consumer portal, and in the hamburger menu there will be a new option **Developer**. Select that, then select **Create New**. Give your app a name (it appears to need to be unique across all users, as I tried 'home-assistant' and it said it was already in use) and a summary (neither of these are important as they are not used anywhere). For Authorization method select **ecobee PIN**. You don't need an Application Icon or Detailed Description. Click **Save**. Now under the Name and Summary Section you will have an API key. Copy this key and use it in you configuration section below. Click the **X** to close the Developer section. +You will need to obtain an API key from ecobee's [developer site](https://www.ecobee.com/developers/) to use this component. To get the key, first you need to register your thermostat which should be done as part of the ecobee installation. Once you have done that perform the following steps. -The first time you run Home Assistant with this component it will give you a PIN code that you need to authorize in the [ecobee consumer portal](https://www.ecobee.com/consumerportal/index.html). You can do this by clicking **Add Application** in the **My Apps** section in the sidebar. Enter the PIN code from the Home Assistant screeen. To get the PIN code select the item in the ecobee card. If you do not have an ecobee card, you may be using groups with `default_view` that don't show the card. To get around this you can temporarily comment out the `default_view` section or add the `configurator.ecobee` component to your `default_view` and restart Home Assistant. Once you enter the PIN on the ecobee site, wait approximately 5 minutes and then click on the **I have authorized the app** link at the bottom of the ecobee popup window. If everything worked correctly, you should now be able to restart Home Assistant again to see the full ecobee card with all of the sensors populated or see the list of sensors in the developer tools. Now you can re-enable your `default_view` (if you had to disable it) and add the ecobee sensors to a group and/or view. +1. Click on the **Become a developer** link on the [developer site](https://www.ecobee.com/developers/). +2. Login with your ecobee credentials. +3. Accept the SDK agreement. +4. Fill in the fields. +5. Click **save**. + +Now login to the regular consumer portal, and in the hamburger menu there will be a new option **Developer**. Now we can create the Application to hook up to Home Assistant. + +1. Select the Developer option. +2. Select **Create New**. +3. Give your app a name (it appears to need to be unique across all users, as I tried 'home-assistant' and it said it was already in use. Try -home-assistant) and a summary (neither of these are important as they are not used anywhere). +4. For Authorization method select **ecobee PIN**. +5. You don't need an Application Icon or Detailed Description. +6. Click **Save**. + +Now under the Name and Summary Section you will have an API key. Copy this key and use it in you configuration section below. Click the **X** to close the Developer section. + +The first time you run Home Assistant with this component it will give you a PIN code that you need to authorize in the [ecobee consumer portal](https://www.ecobee.com/consumerportal/index.html). You can do this by clicking **Add Application** in the **My Apps** section in the sidebar. + +The PIN can be found from the Home Assistant portal on the Ecobee card or from the **configurator.ecobee** entity in states in the portal. + +- If you do not have an ecobee card, you may be using groups with `default_view` that don't show the card. To get around this you can temporarily comment out the `default_view` section or add the `configurator.ecobee` component to your `default_view` and restart Home Assistant. + +Once you enter the PIN on the ecobee site, wait approximately 5 minutes and then click on the **I have authorized the app** link at the bottom of the ecobee popup window. If everything worked correctly, you should now be able to restart Home Assistant again to see the full ecobee card with all of the sensors populated or see the list of sensors in the developer tools. Now you can re-enable your `default_view` (if you had to disable it) and add the ecobee sensors to a group and/or view. To set it up, add the following information to your `configuration.yaml` file: ```yaml +# Example configuration.yaml entry ecobee: api_key: asdfghjklqwertyuiopzxcvbnm hold_temp: True @@ -29,7 +53,7 @@ ecobee: Configuration variables: -- **api_key** (*Required*): Your ecobee API key. +- **api_key** (*Required*): Your ecobee API key. This is only needed for the inital setup of the component. Once registered it can be removed. If you revoke the key in the ecobee portal you will need to update this again and remove the ecobee.conf file in the `.homeassistant` configuration path. - **hold_temp** (*Optional*): True/False whether or not to hold changes indefinitely (True) or until the next scheduled event. Defaults to `False`.

diff --git a/source/_components/group.markdown b/source/_components/group.markdown index 732a3c84684..86ee16d6693 100644 --- a/source/_components/group.markdown +++ b/source/_components/group.markdown @@ -13,7 +13,7 @@ ha_category: Organization Groups allow the user to combine multiple entities into one. A group can be promoted to a **view** by setting the `view` option to `yes`. This will make the group available as a new tab in the frontend. -Check the **Set State** page from the **Developer Tools** and browse the **Current entities:** listing for all available entities. +Check the **Set State** page from the **Developer Tools** and browse the **Current entities:** listing for all available entities. By default, every group appears in the HOME tab. If you name a group `default_view` it will REPLACE the contents of the HOME tab so you can customize it as you wish. diff --git a/source/_components/homematic.markdown b/source/_components/homematic.markdown index cde222f974f..0809338a341 100644 --- a/source/_components/homematic.markdown +++ b/source/_components/homematic.markdown @@ -49,6 +49,7 @@ Configuration variables: - **username** (*Optional*): When fetching names via JSON-RPC, you need to specify a user with guest-access to the CCU. - **password** (*Optional*): When fetching names via JSON-RPC, you need to specify the password of the user you have configured above. - **delay** (*Optional*): Delay fetching of current state per deivce on startup. Used to prevent overloading of the CCU. Defaults to 0.5. +- **variables** (*Optional*): True or False if you want use CCU2/Homegear variables. Default False. To further explain the `resolvenames` option: We use three approaches to fetch the names of devices. Each assumes you have properly named your devices in your existing Homematic setup. As a general advice: Use ASCII for your devices names. Home Assistant won't include non-ASCII characters in entity-names. diff --git a/source/_components/ifttt.markdown b/source/_components/ifttt.markdown index ce87fdaf248..d00a95ba70d 100644 --- a/source/_components/ifttt.markdown +++ b/source/_components/ifttt.markdown @@ -58,7 +58,7 @@ You need to setup a unique trigger for each event you sent to IFTTT. ```yaml # Example configuration.yaml Automation entry automation: - - alias: Startup Notification + alias: Startup Notification trigger: platform: event event_type: homeassistant_start diff --git a/source/_components/influxdb.markdown b/source/_components/influxdb.markdown index 50c5aaa7d41..20c652125fc 100644 --- a/source/_components/influxdb.markdown +++ b/source/_components/influxdb.markdown @@ -33,16 +33,17 @@ influxdb: - entity.id3 - entity.id4 tags: - - instance: prod + instance: prod + source: hass ``` Configuration variables: -- **host** (*Required*): IP address of your database host, eg. http://192.168.1.10. +- **host** (*Optional*): IP address of your database host, eg. http://192.168.1.10. Defaults to localhost. +- **username** (*Required*): The username of the database user. +- **password** (*Required*): The password for the database user account. - **port** (*Optional*): Port to use. Defaults to 8086. - **database** (*Optional*): Name of the database to use. Defaults to `home_assistant`. The database must already exist. -- **username** (*Optional*): The username of the database user. -- **password** (*Optional*): The password for the database user account. - **ssl** (*Optional*): Use https instead of http to connect. Defaults to false. - **verify_ssl** (*Optional*): Verify SSL certificate for https request. Defaults to false. - **blacklist** (*Optional*): List of entities not logged to InfluxDB. diff --git a/source/_components/input_slider.markdown b/source/_components/input_slider.markdown index 4d9765bec0f..a61f1d062de 100644 --- a/source/_components/input_slider.markdown +++ b/source/_components/input_slider.markdown @@ -28,10 +28,10 @@ input_slider: Configuration variables: - **[alias]** (*Required*): Alias for the slider input. +- **min** (*Required*): Minimum value for the slider. +- **max** (*Required*): Maximum value for the slider. - **name** (*Optional*): Friendly name of the slider input. - **initial** (*Optional*): Initial value when Home Assistant starts. -- **min** (*Optional*): Minimum value for the slider. -- **max** (*Optional*): Maximum value for the slider. - **step** (*Optional*): Step value for the slider. ## {% linkable_title Automation Examples %} @@ -52,7 +52,7 @@ input_slider: step: 1 # Automation. -automation: +automation: - alias: Bedroom Light - Adjust Brightness trigger: platform: state diff --git a/source/_components/knx.markdown b/source/_components/knx.markdown index 2ee725fa5cf..28b36941936 100644 --- a/source/_components/knx.markdown +++ b/source/_components/knx.markdown @@ -10,6 +10,7 @@ footer: true logo: knx.png ha_category: DIY ha_release: 0.24 +ha_iot_class: "Local Polling" --- [KNX/EIB](http://www.knx.org) integration for Home Assistant allows you to connect to a KNX bus. The component requires a local KNX/IP interface like the [Weinzierl 730](http://www.weinzierl.de/index.php/en/all-knx/knx-devices-en/knx-ip-interface-730-en). Through this it will send and receive commands to and from other devices to the KNX bus. @@ -24,6 +25,7 @@ There is currently support for the following device types within Home Assistant: A `knx` section must be present in the `configuration.yaml` file and contain the following options as required: ```yaml +# Example configuration.yaml entry knx: host: IP_ADDRESS port: PORT diff --git a/source/_components/light.hue.markdown b/source/_components/light.hue.markdown index c6bc83680df..4fa87bb5561 100644 --- a/source/_components/light.hue.markdown +++ b/source/_components/light.hue.markdown @@ -15,6 +15,10 @@ featured: true Philips Hue support is integrated into Home Assistant as a light platform. The preferred way to setup the Philips Hue platform is by enabling the [the discovery component](/components/discovery/). +Once discovered, locate "configurator.philips_hue" in the entities list ( < > ) and add it to configuration.yaml. Restart home assistant so that it is visible in the home assistant dashboard. Once home assistant is restarted, locate and click on configurator.philips_hue to bring up the intitiation dialog. This will prompt you to press the Hue button to register the Hue hub in home assistant. Once complete, the configurator entity can be removed from configuration.yaml. + +Restarting home assistant once more should result in the Hue lights listed as "light" entities. Add these light entities to configuration.yaml and restart home assistant once more to complete the installation. + If you want to enable the light component directly, add the following lines to your `configuration.yaml`: ```yaml diff --git a/source/_components/light.insteon_hub.markdown b/source/_components/light.insteon_hub.markdown new file mode 100644 index 00000000000..0791c7c370b --- /dev/null +++ b/source/_components/light.insteon_hub.markdown @@ -0,0 +1,17 @@ +--- +layout: page +title: "Insteon Hub Light" +description: "Instructions how to setup the Insteon Hub Lights within Home Assistant." +date: 2016-09-10 08:00 +sidebar: true +comments: false +sharing: true +footer: true +logo: insteon.png +ha_category: Light +ha_release: 0.21 +--- + +The `insteon_hub` light component lets you control your lights connected to an [Insteon Hub](http://www.insteon.com/insteon-hub/) with Home Assistant. + +To get your Insteon Hub fan working with Home Assistant, follow the instructions for the general [Insteon Hub component](/components/insteon_hub/). diff --git a/source/_components/media_player.denon.markdown b/source/_components/media_player.denon.markdown index eba9b5fe1bd..f6ab14cae35 100644 --- a/source/_components/media_player.denon.markdown +++ b/source/_components/media_player.denon.markdown @@ -38,7 +38,7 @@ Configuration variables: A few notes: - The receiver handles only one telnet connection and refuses others. -- Be careful with the volume. 50% or even 100% are very loud. +- Be careful with the volume. 100% or even 50% is very loud. - To be able to wake up the receiver, activate the "remote" setting in the receiver's settings. - Play and pause are supported, toggling is not possible. - Seeking cannot be implemented as the UI sends absolute positions. Only seeking via simulated button presses is possible. diff --git a/source/_components/media_player.gpmdp.markdown b/source/_components/media_player.gpmdp.markdown index e97f1948bdd..3f35c1d1442 100644 --- a/source/_components/media_player.gpmdp.markdown +++ b/source/_components/media_player.gpmdp.markdown @@ -24,12 +24,12 @@ Then just add the following to your `configuration.yaml` file: # Example configuration.yaml entry media_player: platform: gpmdp - address: IP_ADDRESS + host: IP_ADDRESS name: NAME ``` Configuration variables: -- **address** (*Required*): IP address of the computer running GPMDP +- **host** (*Required*): IP address of the computer running GPMDP - **name** (*Optional*): Name of the player diff --git a/source/_components/media_player.kodi.markdown b/source/_components/media_player.kodi.markdown index 849b3cd9c0f..9e129f99039 100644 --- a/source/_components/media_player.kodi.markdown +++ b/source/_components/media_player.kodi.markdown @@ -25,7 +25,7 @@ media_player: host: http://192.168.0.123 port: 8080 name: Kodi - user: USERNAME + username: USERNAME password: PASSWORD turn_off_action: shutdown ``` diff --git a/source/_components/media_player.samsungtv.markdown b/source/_components/media_player.samsungtv.markdown index da430989421..bfcb7af4f11 100644 --- a/source/_components/media_player.samsungtv.markdown +++ b/source/_components/media_player.samsungtv.markdown @@ -57,3 +57,4 @@ There's currently a [known issue](https://github.com/home-assistant/home-assista Currently tested but not working models: - KU6300 - Shows in GUI but unable to control. +- UE75H6400 - Shows in GUI but unable to control. diff --git a/source/_components/media_player.snapcast.markdown b/source/_components/media_player.snapcast.markdown index 080d3a2e2b3..576d639b04d 100644 --- a/source/_components/media_player.snapcast.markdown +++ b/source/_components/media_player.snapcast.markdown @@ -21,4 +21,5 @@ To add Snapcast to your installation, add the following to your `configuration.y # Example configuration.yaml entry media_player: platform: snapcast + host: xxx.xxx.xxx.xxx ``` diff --git a/source/_components/modbus.markdown b/source/_components/modbus.markdown index 3b3295bda08..6e2c129749a 100644 --- a/source/_components/modbus.markdown +++ b/source/_components/modbus.markdown @@ -20,7 +20,11 @@ To add modbus to your installation, add the following to your `configuration.yam For a network connection: ```yaml +<<<<<<< HEAD # Modbus TCP +======= +# Example configuration.yaml entry for a TCP connection +>>>>>>> current modbus: type: tcp host: IP_ADDRESS @@ -31,12 +35,12 @@ Configuration variables: - **type** (*Required*): Type of the connection to Modbus. - **host** (*Required*): The IP address of your router, eg. 192.168.1.1. -- **port** (*Required*): The port for the comminication. +- **port** (*Required*): The port for the communication. For a serial connection: ```yaml -# Example configuration.yaml entry +# Example configuration.yaml entry for a serial connection modbus: type: serial method: rtu diff --git a/source/_components/octoprint.markdown b/source/_components/octoprint.markdown index 9103ad5e9c5..ed7f6724c5a 100644 --- a/source/_components/octoprint.markdown +++ b/source/_components/octoprint.markdown @@ -26,7 +26,7 @@ octoprint: Configuration variables: -- **host** (*Required*): The octoprint host. +- **host** (*Required*): IP address or hostname of Octoprint host. - **api_key** (*Required*): The retrieved api key. diff --git a/source/_components/rpi_gpio.markdown b/source/_components/rpi_gpio.markdown new file mode 100644 index 00000000000..18d2bab9479 --- /dev/null +++ b/source/_components/rpi_gpio.markdown @@ -0,0 +1,16 @@ +--- +layout: page +title: "Raspberry PI GPIO" +description: "Instructions how to integrate the GPIO capability of a Raspberry PI into Home Assistant." +date: 2016-08-30 19:00 +sidebar: true +comments: false +sharing: true +footer: true +logo: raspberry-pi.png +ha_category: DIY +ha_release: pre 0.7 +--- + +The `rpi_gpio` component is the base for all related GPIO platforms in Home Assistant. There is no setup needed for the component itself, for the platforms please check their corresponding pages. + diff --git a/source/_components/sensor.pi_hole.markdown b/source/_components/sensor.pi_hole.markdown index a0b475fd04e..7545dd91738 100644 --- a/source/_components/sensor.pi_hole.markdown +++ b/source/_components/sensor.pi_hole.markdown @@ -23,9 +23,13 @@ To enable this sensor, add the following lines to your `configuration.yaml` file sensor: - platform: pi_hole host: 192.168.1.2 + ssl: True + verify_ssl: ``` Configuration variables: - **host** (*Optional*): The IP address of the Pi-Hole system. Defaults to `localhost`. +- **ssl** (*Optional*): If `true`, use SSL/TLS to connect to the Pi-Hole system. Defaults to `False`. +- **verify_ssl** (*Optional*): Verify the certification of the system. Default to True. diff --git a/source/_components/splunk.markdown b/source/_components/splunk.markdown index 514b908b14a..92f588561e6 100644 --- a/source/_components/splunk.markdown +++ b/source/_components/splunk.markdown @@ -22,7 +22,7 @@ splunk: host: SPLUNK_HOST_IP_ADDRESS_OR_HOST_NAME port: 8088 token: B4415DFF-683C-5C6C-3994-4F6D4A5DB03A - SSL: True + ssl: True ``` Configuration variables: @@ -30,4 +30,4 @@ Configuration variables: - **host** (*Optional*): IP address or host name of your Splunk host, eg. http://192.168.1.10. Will default to `localhost` if not supplied. - **port** (*Optional*): Port to use. Defaults to 8088. - **token** (*Required*): The HTTP Event Collector Token already created in your Splunk instance. -- **SSL** (*Optional*): Use https instead of http to connect. Defaults to False. +- **ssl** (*Optional*): Use https instead of http to connect. Defaults to False. diff --git a/source/_components/switch.knx.markdown b/source/_components/switch.knx.markdown index ab15243bc07..2591f5d0af1 100644 --- a/source/_components/switch.knx.markdown +++ b/source/_components/switch.knx.markdown @@ -10,6 +10,7 @@ footer: true logo: knx.png ha_category: DIY ha_release: 0.24 +ha_iot_class: "Local Polling" --- @@ -18,6 +19,7 @@ The `knx` switch component is used as in interface to switching actuators. To use your KNX switch in your installation, add the following to your `configuration.yaml` file: ```yaml +# Example configuration.yaml entry switch: - platform: knx name: KNX Switch diff --git a/source/_components/vera.markdown b/source/_components/vera.markdown index aba2fabbb66..1a153ea1622 100644 --- a/source/_components/vera.markdown +++ b/source/_components/vera.markdown @@ -22,6 +22,10 @@ vera: vera_controller_url: http://192.168.1.161:3480/ ``` +

+ It is recommended to assign a static IP address to your Vera Controller. This ensures that it won't change IP addresses, so you won't have to change the `vera_controller_url` if it reboots and comes up with a different IP address. See your router's manual for details on how to set this up. If you need the MAC address of your Vera, check the label on the bottom. +

+ By default your switches will be added to HA as switches, however if some of them are light switches, you can tell HA this using the optional ```lights``` parameter as shown below. Vera imports detailed zwave devices into HA - this can include system devices and other devices that you don't use, you can tell HA not to load these devices using the ```exclude:``` parameter as shown below. diff --git a/source/_posts/2016-09-10-notify-group-reload-api-pihole.markdown b/source/_posts/2016-09-10-notify-group-reload-api-pihole.markdown index 6ee3da75b91..36b773715eb 100644 --- a/source/_posts/2016-09-10-notify-group-reload-api-pihole.markdown +++ b/source/_posts/2016-09-10-notify-group-reload-api-pihole.markdown @@ -14,7 +14,7 @@ It's already time for 0.28 thanks to our super short release cycles. Now, it' of ### {% linkable_title Reload automation rules %} -This release brings you a huge improvement of the [automation] and [group] handling. Both can be reloaded without a Home Assistant restart. The automations can be controlled directly from the frontend. +This release brings you a huge improvement of the [automation] and [group] handling. Both can be reloaded without a Home Assistant restart by calling their new reload services. The automations can be controlled directly from the frontend.

@@ -32,22 +32,6 @@ The [Home Assistant API Documentation](https://dev-docs.home-assistant.io/en/dev ### {% linkable_title Configuration validation %} The validation of the configuration is still on-going. Approximatly 80 % is done. This means that we will propably talk about this topic in the next release notes again. To align the configuration of components and platforms we needed to break some. Please refer to the Breaking changes section to check if you need to update your configuration or simple check your log for configuration validation errors. Thanks to [@kellerza], [@fabaff], [@Teagan42], and [@pvizeli] for your effort! -### {% linkable_title Templating %} -`data_template` needs to be present in all notify templates for the future. - -```yaml -action: - service: notify.telegram - data_template: - message: "Test from your Home" - data: - location: - latitude: "{{ state.device_tracker.phone.attributes.latitude }}" - longitude: "{{ state.device_tracker.phone.attributes.longitude }}" -``` - -Stay tuned for more details. - ### {% linkable_title All changes %} @@ -87,6 +71,22 @@ Stay tuned for more details. - Modbus: New `write_registers` [Modbus] service ([@persandstrom]) - Device tracker: Fix TP-Link Archer C7 long passwords ([@snikch]) +### {% linkable_title Hotfix 0.28.1 - September 12 %} + +- Fix: Simplisafe alarm control panels accept any string for code ([@tchellomello]) +- Fix: Z-Wave would sometimes not detect all thermostats ([@turbokongen]) +- Fix: Automatic device tracker when 2 or more cars are tracked ([@teagan42]) +- Fix: Group ordering is now based on config again ([@balloob], [@kellerza]) + +### {% linkable_title Hotfix 0.28.2 - September 13 %} + +- Light - pilight: Fix send RF code ([@DavidLP]) +- Recorder: Fix specifying SQLite ([@pvizeli]) +- Wink: Fix garage door detection ([@turbokongen]) +- Climate - Ecobee: Fix inverted high and low temperatures ([@turbokongen]) +- Allow changing covers using scenes ([@nvella]) +- Device tracker - Automatic: Fix polling ([@teagan42]) + ### {% linkable_title Breaking changes %} - [OpenweatherMap] entity IDs are now like `sensor.owm_temperature`. Previously they were like `sensor.weather_temperature`. Apologies for this change, but we needed to make OpenWeatherMap more generic now that we have many weather platforms. @@ -94,7 +94,7 @@ Stay tuned for more details. - [OctoPrint] component - mFi platform ([switch][mfi-switch] and [sensor][mfi-sensor]) - NX584 Alarm Control Panel - - Mediaplayer platforms [FireTV] and [MPD] + - Mediaplayer platforms [FireTV], [Kodi] and [MPD] - [switch][command-line-switch] and the [cover][command-line-cover] `command_line` platforms - Custom components extending `BaseNotificationService` need to be aware that `kwargs.get(ATTR_TITLE)` will now return `None` if a title has not been set, and will need to specify `kwargs.get(ATTR_TITLE, ATTR_TITLE_DEFAULT)` if they always require a title. @@ -102,6 +102,8 @@ Stay tuned for more details. ...don't hesitate to use our [Forum](https://community.home-assistant.io/) or join us for a little [chat](https://gitter.im/home-assistant/home-assistant). +[@DavidLP]: https://github.com/DavidLP +[@nvella]: https://github.com/nvella [@Ardetus]: https://github.com/Ardetus [@arsaboo]: https://github.com/arsaboo [@auchter]: https://github.com/auchter @@ -153,5 +155,6 @@ Stay tuned for more details. [mfi-switch]: /components/switch.mfi/ [mfi-sensor]: /components/sensor.mfi/ [FireTV]: /components/media_player.firetv/ +[Kodi]: /components/media_player.kodi/ [command-line-switch]: /components/switch.command_line/ [command-line-cover]: /components/cover.command_line/ diff --git a/source/_topics/templating.markdown b/source/_topics/templating.markdown index 7c51ebc2315..efd7660c255 100644 --- a/source/_topics/templating.markdown +++ b/source/_topics/templating.markdown @@ -49,7 +49,7 @@ script: {% raw %}{% if is_state('device_tracker.paulus', 'home') %} Ha, Paulus is home! {% else %} - Paulus is at {{ states('device_tracker.paulus')) }}. + Paulus is at {{ states('device_tracker.paulus') }}. {% endif %}{% endraw %} ``` diff --git a/source/developers/development_environment.markdown b/source/developers/development_environment.markdown index eb567b48ffd..50d978a8b25 100644 --- a/source/developers/development_environment.markdown +++ b/source/developers/development_environment.markdown @@ -24,5 +24,11 @@ On Windows you can use `python setup.py develop` instead of the setup script. After following these steps, running `hass` will invoke your local installation. +###Developing on Windows If you are using Windows as a development platform ensure you have the correct Microsoft Visual C++ build tools installed. Please check [the Windows Compilers](https://wiki.python.org/moin/WindowsCompilers) section on the [Python website](https://www.python.org/) for details. Validation using `tox` will fail if this is not done correctly. +Ensure you install or upgrade the Setuptools Python package. It contains compatibility improvements and adds automatic use of compilers: +```bash +pip install --upgrade setuptools +``` + diff --git a/source/developers/frontend_creating_custom_panels.markdown b/source/developers/frontend_creating_custom_panels.markdown index 0c1e82da327..2cb06255c1e 100644 --- a/source/developers/frontend_creating_custom_panels.markdown +++ b/source/developers/frontend_creating_custom_panels.markdown @@ -27,7 +27,7 @@ The `hello.html` contains the needed building blocks to create the elements insi - +