Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
60 commits
Select commit Hold shift + click to select a range
bd5f24c
:shirt: Markdownlint fixes (#5734)
frenck Jul 10, 2018
2295af2
Change steam docs to use configuration tag (#5737)
sjabby Jul 10, 2018
a7bc2e8
Reminder don't mix http and https content in iframe cards
oncleben31 Jul 10, 2018
2a45267
Fix categories (fixes #5689) (#5736)
fabaff Jul 10, 2018
d9b7776
Fixing panel view (#5742)
DubhAd Jul 10, 2018
e4a8faa
fix link to dropbox backup solution (#5741)
rbflurry Jul 10, 2018
4868f38
Update index.markdown
drjared88 Jul 10, 2018
239bae7
Merge pull request #5740 from oncleben31/patch-3
DubhAd Jul 10, 2018
1b2dde7
Respect the existing alignment (#5743)
gsemet Jul 11, 2018
e707862
Merge pull request #5750 from drjared88/patch-1
DubhAd Jul 11, 2018
83955b2
Added possible interfaces for intel nuc - Update samba.markdown (#5755)
isabellaalstrom Jul 11, 2018
e669efb
Fixing minor typo - iframe.markdown - Lovelace docs (#5754)
sjabby Jul 11, 2018
bf50f49
Lovelace: plant correct yaml
Jul 11, 2018
733b693
Lovlelace: update pic glance
Jul 11, 2018
fd93b1a
Update glance.markdown
Jul 11, 2018
19e6b97
Lovelace: entites card correct config
Jul 11, 2018
39398d9
Lovelace: update filter
Jul 11, 2018
f0dd1bb
Rework lovelace views page (#5738)
Jul 11, 2018
e748ea0
Fix mixed up documentation URLs (#5760)
Jul 11, 2018
b0a1e16
Release HassOS (#5747)
pvizeli Jul 11, 2018
d0a5d62
Lovelace: update picture elements (#5767)
Jul 11, 2018
8e3fa61
Lovelace: update picture (#5766)
Jul 11, 2018
68b642a
Just correcting a typo
Jul 11, 2018
e71eb59
Merge pull request #5768 from bonanitech/patch-7
DubhAd Jul 11, 2018
25d47a2
Merge pull request #5759 from home-assistant/c727-ll-pg
DubhAd Jul 11, 2018
cffc411
Merge pull request #5757 from home-assistant/c727-ll-plant
DubhAd Jul 11, 2018
91fa62e
Lovelace: Update horiz stack (#5764)
Jul 11, 2018
d208693
Update 2018-07-11-hassio-images.markdown
balloob Jul 11, 2018
d75a004
Merge pull request #5762 from home-assistant/c727-ll-glance-1
DubhAd Jul 11, 2018
cc3ab25
Merge pull request #5763 from home-assistant/c727-ll-entities
DubhAd Jul 11, 2018
0862da4
Merge pull request #5765 from home-assistant/c727-ll-filter
DubhAd Jul 11, 2018
9b9df71
Lovelace: Add entity object options for entities card
Jul 11, 2018
f5f3283
Update configurator.markdown
Jul 12, 2018
393c6b6
Update _config.yml (#5773)
sjabby Jul 12, 2018
08d83f6
Merge pull request #5774 from BeauBreeden/patch-1
DubhAd Jul 12, 2018
993b9f9
Merge pull request #5770 from home-assistant/c727-ll-ent-obj
DubhAd Jul 12, 2018
4fe15b3
fix 64bit link
pvizeli Jul 12, 2018
21b213a
Update views.markdown (#5777)
Jul 12, 2018
595401a
Lovelace: correct vertical stack (#5756)
Jul 12, 2018
1b56528
Lovelace: update iframe (#5761)
Jul 12, 2018
bc2e5d0
Merge branch 'current' into next
fabaff Jul 13, 2018
a82d2da
The W for the Zero W image was missing (#5783)
hblaschka Jul 13, 2018
97b30a9
Add description for band-pass filter (#4985)
nielstron Jul 13, 2018
7e5da3a
Adds facebox teach service (#5553)
robmarkcole Jul 13, 2018
6dd07cf
Add docs for additional Arlo Baby sensors (#5583)
lukiffer Jul 13, 2018
e4aeefc
Update logo nd change to cloud push type (#5671)
worm-ee Jul 13, 2018
77386b1
Add Tuya component and platform document (#5739)
huangyupeng Jul 13, 2018
c1b46c8
Lovelace: Add support for badges (#5784)
Jul 13, 2018
2f1f301
Add homematicip_cloud-alarm_control-documentation (#5670)
worm-ee Jul 13, 2018
647c913
MyTotalConnectComfort.com Compatibility (#5771)
arretx Jul 13, 2018
bcfbeba
Updating formatting and layout (#5785)
DubhAd Jul 13, 2018
dffdea2
Update rachio.markdown (#5786)
brianharwell Jul 14, 2018
63d1748
Added "Android phones" to reflect infromation from https://owntracks.…
geek65535 Jul 14, 2018
83a7794
Update installation.markdown
pvizeli Jul 14, 2018
a95ea42
Lovelace: correct glance config (#5758)
Jul 15, 2018
1f273e0
Minor changelog fix (#5793)
ciotlosm Jul 15, 2018
d41611b
Added image element type to picture-elements. (#5781)
jeradM Jul 15, 2018
0a77910
Lovelace: Add service icon docs (#5794)
Jul 15, 2018
cb00090
Merge branch 'current' into next
balloob Jul 15, 2018
7ec0e27
Lovelace: new features for glance (#5795)
Jul 15, 2018
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions _config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -142,8 +142,8 @@ social:
# Home Assistant release details
current_major_version: 0
current_minor_version: 73
current_patch_version: 0
date_released: 2018-07-06
current_patch_version: 1
date_released: 2018-07-08

# Either # or the anchor link to latest release notes in the blog post.
# Must be prefixed with a # and have double quotes around it.
Expand Down
2 changes: 1 addition & 1 deletion source/_addons/configurator.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ Screenshot of the HASS Configurator.
}
```

- **username** (*Optional*): Set a username to access your configuration is protected.
- **username** (*Required*): Set a username to access your configuration is protected.
- **password** (*Required*): Set a password for access.
- **ssl** (*Optional*): Enable or Disable SSL/TLS for the editor.
- **allowed_networks** (*Optional*): Limit access to the configurator by adding allowed IP addresses/networks to the list.
Expand Down
2 changes: 1 addition & 1 deletion source/_addons/samba.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ Configuration variables:
- **map** (*Optional*): Control which folders will be exposed. `config` shares the Home Assistant configuration folder. `addons` shares the local custom repository. `share` shares a folder that can be accessed by add-ons and Home Assistant. `backup` shares access to snapshot files. `ssl` shares certificate storage. Be careful with the `ssl` option! Defaults are all set to `true`, except for `ssl`.
- **username** (*Optional*): Username for logging in if guest login is not used.
- **password** (*Optional*): Password for `username`. An empty password is not supported.
- **interface** (*Optional*): Interface that will start the share. Normally this is `eth0` for ethernet wired connection and `wlan0` for wireless connection.
- **interface** (*Optional*): Interface that will start the share. Normally this is `eth0` for ethernet wired connection and `wlan0` for wireless connection. If you are running on an Intel NUC this could also be `enp3s0` for ethernet or `wlp5s0` for wireless connection.

<p class='note warning'>
Be careful when setting up port forwarding to the remote access. If you don't restrict access by requiring authentication and guest access is enabled, your configuration could be exposed to the internet!
Expand Down
21 changes: 21 additions & 0 deletions source/_components/alarm_control_panel.homematicip_cloud.markdown
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
---
layout: page
title: "HomematicIP Cloud Alarm Control Panel"
description: "Instructions on how to integrate HomematicIP alarm control panel into Home Assistant."
date: 2018-05-18 22:40
sidebar: true
comments: false
sharing: true
footer: true
logo: homematicip_cloud.png
ha_category: Sensor
ha_release: 0.73
ha_iot_class: "Cloud Push"
---

The `homematicip_cloud` alarm_control_panel platform allows you to control your [HomematicIP](https://www.homematic-ip.com) `Security Zones` through Home Assistant.

This component will automatically add `Security Zones` configured in your HomematicIP cloud.

Please refer to the
[component](/components/homematicip_cloud/) configuration on how to setup HomematicIP Cloud.
2 changes: 1 addition & 1 deletion source/_components/amcrest.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ Configuration variables:
- **sdcard**: Return the SD card usage by reporting the total and used space
- **ptz_preset**: Return the number of PTZ preset positions configured for the given camera
- **switches** array (*Optional*): Switches to display in the frontend. By default, *none* of the switches are shown. The following switches can be monitored.
- **motion_detection**: Enable/disable motion detection setting
- **motion_detection**: Enable/disable motion detection setting
- **motion_recording**: Enable/disable recording on motion detection setting

**Note:** Amcrest cameras with newer firmware no longer have the ability to stream `high` definition video with MJPEG encoding. You may need to use `low` resolution stream or the `snapshot` stream source instead. If the quality seems too poor, lower the `Frame Rate (FPS)` and max out the `Bit Rate` settings in your camera's configuration manager. If you defined the *stream_source* to **mjpeg**, make sure your camera supports *Basic* HTTP authentication. Newer Amcrest firmware may not work, then **rtsp** is recommended instead.
Expand Down
13 changes: 6 additions & 7 deletions source/_components/binary_sensor.axis.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -19,10 +19,9 @@ See the [Axis main component](/components/axis/) for configuration instructions.

The following sensor types are supported:


* Motion detection
* Passive IR motion detection
* Sound detection
* Day/night mode
* Tampering detection
* Input port
- Motion detection
- Passive IR motion detection
- Sound detection
- Day/night mode
- Tampering detection
- Input port
4 changes: 2 additions & 2 deletions source/_components/binary_sensor.homematicip_cloud.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,10 @@ sidebar: true
comments: false
sharing: true
footer: true
logo: homematic.png
logo: homematicip_cloud.png
ha_category: Binary Sensor
ha_release: 0.70
ha_iot_class: "Local Push"
ha_iot_class: "Cloud Push"
---

The `homematicip_cloud` binary_switch platform allows you to control
Expand Down
1 change: 0 additions & 1 deletion source/_components/bloomsky.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,6 @@ ha_release: 0.14
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 API key from your [BloomSky dashboard](https://dashboard.bloomsky.com). Click `developers` in the bottom left of the screen.
Expand Down
10 changes: 4 additions & 6 deletions source/_components/camera.xeoma.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,6 @@ ha_iot_class: "Local Polling"
ha_release: 0.62
---


The `Xeoma` camera platform allows you to view the video feeds from a [Xeoma](http://felenasoft.com/xeoma) video surveillance server.

To enable Xeoma camera feeds, add the following lines to your `configuration.yaml`:
Expand Down Expand Up @@ -48,7 +47,7 @@ cameras:
required: false
type: list
keys:
image_name:
image_name:
description: The name of the JPEG image for this camera as configured in Xeoma (without .jpg extension).
required: true
type: string
Expand Down Expand Up @@ -82,8 +81,7 @@ camera:
```

To use this platform, you must have the Xeoma Web Server module enabled in at least one of your camera chains.

This platform will parse the Xeoma web interface to find all enabled cameras and add them all to Home Assistant. You can
hide individual cameras using the platform configuration.


This platform will parse the Xeoma web interface to find all enabled cameras and add them all to Home Assistant. You can hide individual cameras using the platform configuration.

The `image_name` configuration value for each camera should match the name supplied to the Xeoma Web Server configuration (under _Path to access images_) with the _.jpg_ extension removed.
4 changes: 4 additions & 0 deletions source/_components/climate.honeywell.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,10 @@ ha_iot_class: "Cloud Polling"

The `honeywell` climate platform let you control [Honeywell Connected](http://getconnected.honeywell.com/en/) thermostats from Home Assistant.

<p class='note'>
This platform does NOT connect to MyTotalConnectComfort.com. If you have a Honeywell WIFI thermostat that is connected through MyTotalConnectComfort.com, you may might to take a look at the IFTTT component which can bridge the gap between Home Assistant and MyTotalConnectComfort.com WIFI thermostats on a limited basis.
</p>

To set it up, add the following information to your `configuration.yaml` file:

```yaml
Expand Down
19 changes: 8 additions & 11 deletions source/_components/cover.opengarage.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,7 @@ ha_category: Cover
ha_release: 0.44
---


The `opengarage` cover platform lets you control the open-source [OpenGarage.io](https://opengarage.io/) device through Home Assistant.
The `opengarage` cover platform lets you control the open-source [OpenGarage.io](https://opengarage.io/) device through Home Assistant.

To enable OpenGarage Covers in your installation, add the following to your `configuration.yaml` file:

Expand All @@ -36,12 +35,10 @@ Configuration variables:

- **covers** array (*Required*): List of your doors.
- **identifier** (*Required*): Name of the cover as slug. Multiple entries are possible.
- **host** (*Required*): IP address of device.
- **port** (*Optional*): HTTP Port. Default is `80`.
- **device_key** (*Required*): Access key to control device. Default is `opendoor`.
- **name** (*Optional*): Name to use in the Frontend. If not provided, it will use name configured in device.


- **host** (*Required*): IP address of device.
- **port** (*Optional*): HTTP Port. Default is `80`.
- **device_key** (*Required*): Access key to control device. Default is `opendoor`.
- **name** (*Optional*): Name to use in the Frontend. If not provided, it will use name configured in device.

**Example with more detail:**
<p class='img'>
Expand All @@ -53,7 +50,7 @@ Configuration variables:
cover:
platform: opengarage
covers:
garage:
garage:
host: 192.168.1.12
device_key: opendoor
name: honda
Expand Down Expand Up @@ -93,12 +90,12 @@ sensor:
{% endif %}'{% endraw %}

group:
garage:
garage:
name: Garage
entities:
- cover.honda
- sensor.garage_status
- sensor.garage_car_present
- sensor.garage_car_present

customize:
cover.honda:
Expand Down
5 changes: 2 additions & 3 deletions source/_components/device_tracker.linksys_smart.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -12,12 +12,11 @@ logo: linksys.png
ha_release: 0.48
---

The `linksys_smart` platform offers presence detection by looking at connected devices to a Linksys Smart Wifi based router.
The `linksys_smart` platform offers presence detection by looking at connected devices to a Linksys Smart Wifi based router.

Tested routers:
Tested routers:
LINKSYS WRT3200ACM MU-MIMO Gigabit Wi-Fi Wireless Router
LINKSYS WRT1900ACS Dual-band Wi-Fi Router


<p class='note'>
For this platform to work correctly, it is necessary to disable the "Access via wireless" feature in the Local Management Access section of the router administration page. If "Access via wireless" is not disabled, a connectivity conflict arises because the Home Assistant integration is trying to pass userid and password, but the router is only expecting a password.
Expand Down
2 changes: 1 addition & 1 deletion source/_components/device_tracker.owntracks.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ featured: false
ha_release: 0.7.4
---

This platform allows you to detect presence using [Owntracks](http://owntracks.org/). OwnTracks allows users to track their location on 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 iOS and Android 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/).

Expand Down
7 changes: 3 additions & 4 deletions source/_components/device_tracker.ubus.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -70,14 +70,13 @@ Configuration variables:
- **password** (*Required*): The password for your given account.
- **dhcp_software** (*Optional*): The DHCP software used in your router: `dnsmasq`, `dhcpd`, or `none`. Defaults to `dnsmasq`.


See the [device tracker component page](/components/device_tracker/) for instructions how to configure the people to be tracked.

## Troubleshooting
## {% linkable_title Troubleshooting %}

If you find that this never creates `known_devices.yaml`, or if you need more information on the communication chain between Home Assistant and OpenWRT, follow these steps to grab the packet stream and gain insight into what's happening.

### Increase Log Level
### {% linkable_title Increase Log Level %}

1. On your Home Assistant device, stop Home Assistant
2. Adjust `configuration.yaml` to log more detail for the `device_tracker` component
Expand Down Expand Up @@ -167,6 +166,6 @@ Connection: keep-alive
```
11. In this case we are actually receiving a valid response with no data. The request says that we are looking for ARP information from `hostapd.*`, which is the access point on the router. In my environment I don't use the AP on the router, and so it was correctly returning no data. Armed with this information, I know that I cannot use this component for device tracking or presence.

### Cleanup
### {% linkable_title Cleanup %}

When you're done troubleshooting, remember to reset your logging configuration and delete any capture files that contain sensitive information.
40 changes: 27 additions & 13 deletions source/_components/discovery.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -57,9 +57,18 @@ discovery:
- homekit
```

Configuration variables:

- **ignore** (*Optional*): A list of platforms that never will be automatically configured by `discovery`.
{% linkable_title Configuration variables: %}

{% configuration discovery %}
ignore:
description: A list of platforms that never will be automatically configured by `discovery`.
required: false
type: string
enable:
description: A list of platforms not enabled by default that `discovery` should discover.
required: false
type: string
{% endconfiguration %}

Valid values for ignore are:

Expand Down Expand Up @@ -92,29 +101,34 @@ Valid values for ignore are:
* `yeelight`: Yeelight Sunflower bulb
* `xiaomi_gw`: Xiaomi Aqara gateway

- **enable** (*Optional*): A list of platforms not enabled by default that `discovery` should discover.

Valid values for enable are:

* `homekit`: HomeKit accessories

<p class='note'>
## {% linkable_title Troubleshooting %}

### {% linkable_title UPnP %}

Home Assistant must be on the same network as the devices for uPnP discovery to work.
If running Home Assistant in a [Docker container](/docs/installation/docker/) use switch `--net=host` to put it on the host's network.
</p>

<p class='note warning'>
### {% linkable_title Windows %}

#### {% linkable_title 64-bit Python %}
There is currently a <a href='https://bitbucket.org/al45tair/netifaces/issues/17/dll-fails-to-load-windows-81-64bit'>known issue</a> with running this component on a 64-bit version of Python and Windows.
</p>

<p class='note'>
#### {% linkable_title Python 3.5 %}

If you are on Windows and you're using Python 3.5, download the [Netifaces](http://www.lfd.uci.edu/~gohlke/pythonlibs/#netifaces) dependency.
</p>

<p class='note'>
### {% linkable_title could not install dependency netdisco %}

If you see `Not initializing discovery because could not install dependency netdisco==0.6.1` in the logs, you will need to install the `python3-dev` or `python3-devel` package on your system manually (eg. `sudo apt-get install python3-dev` or `sudo dnf -y install python3-devel`). On the next restart of Home Assistant, the discovery should work. If you still get an error, check if you have a compiler (`gcc`) available on your system.

### {% linkable_title DSM and Synology %}

For DSM/Synology, install via debian-chroot [see this forum post](https://community.home-assistant.io/t/error-starting-home-assistant-on-synology-for-first-time/917/15).
</p>

## {% linkable_title New platforms %}

If you are developing a new platform, please read [how to make your platform discoverable](/developers/component_discovery/) for further details.
23 changes: 11 additions & 12 deletions source/_components/ecobee.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -14,34 +14,33 @@ ha_release: 0.9
ha_iot_class: "Cloud Push"
---


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 which should be done as part of the ecobee installation. Once you have done that perform the following steps.

1. Click on the **Become a developer** link on the [developer site](https://www.ecobee.com/developers/).
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**.
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 <yournameoralias>-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 **Create**.
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 <yournameoralias>-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 **Create**.

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.
- 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 pop-up 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:
Expand All @@ -62,4 +61,4 @@ Configuration variables:
<img src='{{site_root}}/images/screenshots/ecobee-thermostat-card.png' />
</p>

If for whatever reason you delete and re-create your ecobee app at ecobee.com such that your developer API key changes, you will need to delete your `/conf/ecobee.conf file`. You will also need to update the `api_key:` in the `configuration.yaml` or `secrets.yaml` file.
If for whatever reason you delete and re-create your ecobee app at ecobee.com such that your developer API key changes, you will need to delete your `/conf/ecobee.conf file`. You will also need to update the `api_key:` in the `configuration.yaml` or `secrets.yaml` file.
Loading