Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
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 @@ -5,10 +5,10 @@

url: https://www.home-assistant.io
title: Home Assistant
subtitle: Open-source home automation platform running on Python 3
subtitle: Open source home automation that puts local control and privacy first.
author: Home Assistant
simple_search: https://www.google.com/search
description: Home Assistant is an open-source home automation platform running on Python 3.
description: Open source home automation that puts local control and privacy first.

# Default date format is "ordinal" (resulting in "July 22nd 2007")
# You can customize the format as defined in
Expand Down
2 changes: 1 addition & 1 deletion source/_components/device_tracker.locative.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -38,4 +38,4 @@ To configure Locative, you must set up the app to send a `GET` request to your H

When you enter a geofence, your location name in Home Assistant will be set to the name of the geofence in Locative. When you exit a geofence, your location name in Home Assistant will be set to "not home".

To use Locative in combination with another device tracker, such as [nmap](/components/device_tracker.nmap_tracker/) or [Netgear](/components/device_tracker.netgear/), fill in the `mac` field to the Locative entry in `known_devices.yaml` with the MAC address of the device you want to track. The state of the device will be determined by the source that reported last.
To use Locative in combination with another device tracker, such as [Nmap](/components/device_tracker.nmap_tracker/) or [Netgear](/components/device_tracker.netgear/), fill in the `mac` field to the Locative entry in `known_devices.yaml` with the MAC address of the device you want to track. The state of the device will be determined by the source that reported last.
12 changes: 6 additions & 6 deletions source/_components/device_tracker.nmap_tracker.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -38,17 +38,17 @@ device_tracker:

Configuration variables:

- **hosts** (*Required*): The network address to scan (in any supported NMap format). Mixing subnets and IPs is possible.
- **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. Scanning the host where Home Assistant is running can cause problems (websocket error), so excluding that host is a good idea.
- **scan_options** (*Optional*): Configurable scan options for nmap. Default to `-F --host-timeout 5s`
- **hosts** (*Required*): The network address to scan (in any supported Nmap format). Mixing subnets and IPs is possible.
- **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. Scanning the host where Home Assistant is running can cause problems (websocket error), so excluding that host is a good idea.
- **scan_options** (*Optional*): Configurable scan options for Nmap. Default to `-F --host-timeout 5s`

## {% linkable_title Examples %}

A full example for the `nmap` tracker could look like the following sample:

```yaml
# Example configuration.yaml entry for nmap
# Example configuration.yaml entry for Nmap
# One whole subnet, and skipping two specific IPs.
device_tracker:
- platform: nmap_tracker
Expand All @@ -60,7 +60,7 @@ device_tracker:
```

```yaml
# Example configuration.yaml for nmap
# Example configuration.yaml for Nmap
# One subnet, and two specific IPs in another subnet.
device_tracker:
- platform: nmap_tracker
Expand Down
2 changes: 1 addition & 1 deletion source/_components/device_tracker.snmp.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ A lot of WiFi access points and WiFi routers support the Simple Network Manageme
This device tracker needs SNMP to be enabled on the router. It could be that you need to install the SNMP support manually.
</p>

The following OID examples pull the current MAC Address table from a router. This reflects all recent devices seen on the network. However, since devices are not removed until they time out, this is less effective for [device tracker component page](/components/device_tracker/) than desirable. It is recommended to use [Ping](/components/device_tracker.ping/) or [NMAP](/components/device_tracker.nmap_tracker/) instead.
The following OID examples pull the current MAC Address table from a router. This reflects all recent devices seen on the network. However, since devices are not removed until they time out, this is less effective for [device tracker component page](/components/device_tracker/) than desirable. It is recommended to use [Ping](/components/device_tracker.ping/) or [Nmap](/components/device_tracker.nmap_tracker/) instead.

| Brand | Device/Firmware | OID |
|---|---|---|---|
Expand Down
2 changes: 1 addition & 1 deletion source/_components/device_tracker.tomato.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ ha_release: pre 0.7

The `tomato` platform requires an extra config variable called `http_id`. The value can be obtained by logging in to the Tomato admin interface and search for `http_id` in the page source code.

Because of a limitation in Tomato's API, this platform will only track wireless devices. If tracking wired devices like a Philips Hue Hub is necessary, it is possible to use another platform like [NMAP](/components/device_tracker.nmap_tracker/).
Because of a limitation in Tomato's API, this platform will only track wireless devices. If tracking wired devices like a Philips Hue Hub is necessary, it is possible to use another platform like [Nmap](/components/device_tracker.nmap_tracker/).

To use this device tracker in your installation, add the following to your `configuration.yaml` file:

Expand Down
9 changes: 5 additions & 4 deletions source/_components/google_assistant.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -29,21 +29,22 @@ To use Google Assistant, your Home Assistant configuration has to be externally

You need to create an API Key with the [Google Console](https://console.cloud.google.com/apis/api/homegraph.googleapis.com/overview) which allows you to update devices without unlinking and relinking an account (see [below](/#troubleshooting-the-request_sync-service)). If you don't provided it the `google_assistant.request_sync` service is not exposed. It is recommended to set up this configuration key as it also allows the usage of the following command, "Ok Google, sync my devices". Once you have setup this component you will need to call this service (or command) each time you add a new device that you wish to control via the Google Assistant integration.

1. Create a new project in the [developer console](https://console.actions.google.com/).
1. Create a new project in the [Actions on Google console](https://console.actions.google.com/).
a. Add/Import project, give it a name
b. Click on `Home Control` card, select the `Smart home` recommendation.
c. Create an Action, under the build section. Add in your Home Assistant URL: `https://[YOUR HOME ASSISTANT URL:PORT]/api/google_assistant`, replace the `[YOUR HOME ASSISTANT URL:PORT]` with the domain / ip address and the port under which your Home Assistant is reachable. If you have set `api_password:` add this password to the URL. E.g., `https://[YOUR HOME ASSISTANT URL:PORT]/api/google_assistant?api_password=[YOUR API PASSWORD]`)
c. Create an Action, under the build section. Add in your Home Assistant URL: `https://[YOUR HOME ASSISTANT URL:PORT]/api/google_assistant`, replace the `[YOUR HOME ASSISTANT URL:PORT]` with the domain / ip address and the port under which your Home Assistant is reachable.
d. Click `Done`. Then click on `Overview`, which will lead you back to the app details screen.
2. `Account linking` is required for your app to interact with Home Assistant. Set this up under the `Quick Setup` section
a. Leave it at the default `No, I only want to allow account creation on my website` and select Next
b. For the `Linking type` select `OAuth` and `Implicit`
c. Client ID: The `client_id` from your Home Assistant configuration above
d. Authorization URL (replace with your actual URL): `https://[YOUR HOME ASSISTANT URL:PORT]/api/google_assistant/auth`. If you have set `api_password:` add this password to the URL `https://[YOUR HOME ASSISTANT URL:PORT]/api/google_assistant/auth?api_password=[YOUR API PASSWORD]`)
d. Authorization URL (replace with your actual URL): `https://[YOUR HOME ASSISTANT URL:PORT]/api/google_assistant/auth`.
e. Configure your client. Add scopes for `email` and `name`.
f. Testing instructions: Enter anything. It doesn't matter since you won't submit this app.
3. Back on the overview page. Click `Simulator` under `TEST`. You don't have to actually test .
4. If you haven't already added the component configuration to `configuration.yaml` file and restarted Home Assistant, you'll be unable to continue until you have.
5. Open the Google Assistant app and go into `Settings > Home Control`
5. Open the Google Assistant app and go into `Settings > Home Control`. Or on your Android phone or tablet, touch and hold the Home button or say "Ok Google.". At the top right, tap compass icon and then more icon and then `Settings > Home Control`.
> If you have added the [Home Assistant "web app"](/docs/frontend/mobile/) to your phone's homescreen before, you need remove it before next step
6. Click the `+` sign, and near the bottom, you should have `[test] your app name`. Selecting that should lead you the screen where you can set rooms for your devices or nicknames for your devices.
7. If you want to allow other household users to control the devices:
a. Go to the settings for the project you created in point 1 in the developer console.
Expand Down
2 changes: 1 addition & 1 deletion source/_components/media_player.kodi.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -196,7 +196,7 @@ media_player:
```

<p class='note'>
This example and the following requires to have the [script.json-cec](https://github.com/joshjowen/script.json-cec) plugin installed on your kodi player. It'll also expose th endpoints standy, toggle and activate without authentication on your kodi player. Use this with caution.
This example and the following requires to have the [script.json-cec](https://github.com/joshjowen/script.json-cec) plugin installed on your kodi player. It'll also expose the endpoints standby, toggle and activate without authentication on your kodi player. Use this with caution.
</p>

### {% linkable_title Kodi services samples %}
Expand Down
2 changes: 2 additions & 0 deletions source/_components/sensor.dnsip.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@ sensor:
Configuration variables:

- **hostname** (*Optional*): The hostname for which to perform the DNS query. Default: `myip.opendns.com` (special hostname that resolves to your public IP)
- **name** (*Optional*): Name of the sensor. Default `myip` or hostname without dots if specified.
- **resolver** (*Optional*): The DNS server to target the query at. Default: `208.67.222.222` (OpenDNS)
- **ipv6** (*Optional*): Set this to `true` or `false` if IPv6 should be used. When resolving the public IP, this will be the IP of the machine where Home Assistant is running on.
- **resolver_ipv6** (*Optional*): The IPv6 DNS server to target the query at. Default: `2620:0:ccc::2` (OpenDNS)
Expand All @@ -49,5 +50,6 @@ sensor:
# Resolve IP address of home-assistant.io via Google DNS
- platform: dnsip
hostname: home-assistant.io
name: hass
resolver: 8.8.8.8
```
1 change: 1 addition & 0 deletions source/_components/sensor.tibber.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ ha_iot_class: "Cloud Polling"
---

The `tibber` sensor provides the current electricity price if you are a [Tibber](https://tibber.com/) customer.
If you have a Tibber Pulse it will also show the electricity consumption in real time.

To add Tibber to your installation, add the following to your `configuration.yaml` file:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ footer: true
ha_category: Automation Examples
---

This will send a message when someone in your known devices list connects to your local network. In other words, when someone arrives home. It will only work if you are using the [nmap](/components/device_tracker.nmap_tracker/) device tracker or a similar component.
This will send a message when someone in your known devices list connects to your local network. In other words, when someone arrives home. It will only work if you are using the [Nmap](/components/device_tracker.nmap_tracker/) device tracker or a similar component.

This example uses [Telegram](/components/notify.telegram/) to send the notification.

Expand Down
4 changes: 0 additions & 4 deletions source/_docs/authentication/providers.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,6 @@ sharing: true
footer: true
---

<p class='note warning'>
This page only apply to release 0.77 and above.
</p>

<p class='note warning'>
This is an advanced feature. If misconfigured, you will not be able to access Home Assistant anymore!
</p>
Expand Down
2 changes: 1 addition & 1 deletion source/_docs/ecosystem/appdaemon/api.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -1596,7 +1596,7 @@ for tracker in trackers:

### {% linkable_title get_tracker_state() %}

Get the state of a tracker. The values returned depend in part on the configuration and type of device trackers in the system. Simpler tracker types like `Locative` or `NMAP` will return one of 2 states:
Get the state of a tracker. The values returned depend in part on the configuration and type of device trackers in the system. Simpler tracker types like `Locative` or `Nmap` will return one of 2 states:

- `home`
- `not_home`
Expand Down
2 changes: 1 addition & 1 deletion source/_docs/security/webserver.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ redirect_from: /docs/frontend/webserver/

It was only a matter of time until the first queries for tools like [https://www.shodan.io](https://www.shodan.io/search?query=Home+Assistant) to search for Home Assistant instances showed up.

To get an idea about how your Home Assistant instance looks to a network scanner, you can use `nmap`. The `nmap` tool is already available if you are using the [nmap device tracker](/components/device_tracker/).
To get an idea about how your Home Assistant instance looks to a network scanner, you can use `nmap`. The `nmap` tool is already available if you are using the [Nmap device tracker](/components/device_tracker/).

```bash
$ nmap -sV -p 8123 --script=http-title,http-headers 192.168.0.3
Expand Down
1 change: 1 addition & 0 deletions source/_posts/2018-09-15-release-78.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,7 @@ The configuration value type should no longer be used. ([@endor-force] - [#15935
- Fix Mi Flora median calculation. Removed `retries` and `timeout` config parameters, they were not used for several months. Replaced `cache_value` config with `scan_interval` to fix a bug in the PR. ([@PaulAnnekov] - [#16085]) ([sensor.miflora docs]) (breaking change)
- Twitch now requires a `client_id` and so the platform got updated. ([@ioangogo] - [#16428]) ([sensor.twitch docs]) (breaking change)
- The radiotherm `fan` and `mode` state attributes were updated to reflect the real-time fan and mode states of the thermostat, rather than the overall selected state (automatic, mostly). The mode attributes still contain the selected modes (fan on/auto, heat/cool/auto). ([@cpw] - [#15031]) ([climate.radiotherm docs]) (breaking change)
- The `dnsip` sensor now uses `myip` as default name. ([@grea09] - [#16205]) ([sensor.dnsip docs]) (breaking change)

## {% linkable_title Beta Fixes %}

Expand Down
4 changes: 2 additions & 2 deletions source/getting-started/configuration.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -36,9 +36,9 @@ From the Hass.io main panel open the add-on store.

### {% linkable_title Editing config via HASS Configurator %}

The first add-on we should install is the HASS Configurator. With the HASS Configurator you'll be able to edit your Home Assistant configuration from the web interface.
The first add-on we should install is the HASS Configurator. With the HASS Configurator, you'll be able to edit your Home Assistant configuration from the web interface.

Go to the add-on store (see previous step), click on Configurator and click on "INSTALL". When installation is complete, the UI will go to the add-on details page for the configurator. Here you will be able to change settings, start and stop the add-on. Follow the steps below to setup the add-on.
Go to the add-on store (see the previous step), click on Configurator and click on "INSTALL". When installation is complete, the UI will go to the add-on details page for the configurator. Here you will be able to change settings, start and stop the add-on. Follow the steps below to setup the add-on.

- Set a password on the Config box, don't forget to use quotes on your password

Expand Down
2 changes: 1 addition & 1 deletion source/getting-started/index.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ sharing: true
footer: true
---

The goal of this getting started guide is to install [Hass.io](/hassio/) on a Raspberry Pi. Hass.io is our own all in one solution that turns your Raspberry Pi or other device into the ultimate home automation hub.
The goal of this getting started guide is to install [Hass.io](/hassio/) on a Raspberry Pi. Hass.io is our own all in one solution that turns your Raspberry Pi or another device into the ultimate home automation hub.

Follow this guide if you want to get started with Home Assistant easily, or if you have no or little Linux experience. For advanced users or if you have no Raspberry Pi at hand, check our [alternative installation methods](/docs/installation/). The [FAQ](/faq/#home-assistant-vs-hassio) explains more about the differences.

Expand Down
4 changes: 2 additions & 2 deletions source/getting-started/presence-detection.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -27,13 +27,13 @@ Screenshot of Home Assistant showing a school, work and home zone and two people

The device tracker component offers presence detection for Home Assistant. It supports three different methods for presence detection: scan for connected devices on the local network, scan for Bluetooth devices within range, and connect to third-party service.

Scanning for connected devices is easy to setup; options include [supported routers][routers] and [scanning the network using nmap][nmap]. This approach does have its limitations, however: it will only be able to detect if a device is at home, and modern smartphones may show as not home inaccurately (as they disconnect from WiFi if idle).
Scanning for connected devices is easy to setup; options include [supported routers][routers] and [scanning the network using Nmap][nmap]. This approach does have its limitations, however: it will only be able to detect if a device is at home, and modern smartphones may show as not home inaccurately (as they disconnect from WiFi if idle).

You can scan for [Bluetooth][ha-bluetooth] and [Bluetooth LE][ha-bluetooth-le] devices. Unlike with WiFi, modern smartphones don't turn off Bluetooth automatically, though the range is lower.

Home Assistant currently supports multiple third-party services for presence detection, such as [OwnTracks over MQTT][ha-owntracks-mqtt], [OwnTracks over HTTP][ha-owntracks-http] [GPSLogger][ha-gpslogger] and [Locative][ha-locative].

There are a wide [range of options][ha-presence] available, both for scanning your local network and third-party services.
There is a wide [range of options][ha-presence] available, both for scanning your local network and third-party services.

### {% linkable_title Zones %}

Expand Down
12 changes: 6 additions & 6 deletions source/hassio/installation.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -77,14 +77,14 @@ A detailed guide about running Hass.io as a virtual machine is available in the
[etcher]: https://etcher.io/
[Virtual Appliance]: https://github.com/home-assistant/hassos/blob/dev/Documentation/boards/ova.md
[hassos-network]: https://github.com/home-assistant/hassos/blob/dev/Documentation/network.md
[pi0-w]: https://github.com/home-assistant/hassos/releases/download/1.10/hassos_rpi0-w-1.10.img.gz
[pi1]: https://github.com/home-assistant/hassos/releases/download/1.10/hassos_rpi-1.10.img.gz
[pi2]: https://github.com/home-assistant/hassos/releases/download/1.10/hassos_rpi2-1.10.img.gz
[pi3-32]: https://github.com/home-assistant/hassos/releases/download/1.10/hassos_rpi3-1.10.img.gz
[pi3-64]: https://github.com/home-assistant/hassos/releases/download/1.10/hassos_rpi3-64-1.10.img.gz
[pi0-w]: https://github.com/home-assistant/hassos/releases/download/1.11/hassos_rpi0-w-1.11.img.gz
[pi1]: https://github.com/home-assistant/hassos/releases/download/1.11/hassos_rpi-1.11.img.gz
[pi2]: https://github.com/home-assistant/hassos/releases/download/1.11/hassos_rpi2-1.11.img.gz
[pi3-32]: https://github.com/home-assistant/hassos/releases/download/1.11/hassos_rpi3-1.11.img.gz
[pi3-64]: https://github.com/home-assistant/hassos/releases/download/1.11/hassos_rpi3-64-1.11.img.gz
[tinker]: https://github.com/home-assistant/hassos/releases/download/2.2/hassos_tinker-2.2.img.gz
[odroid-c2]: https://github.com/home-assistant/hassos/releases/download/2.2/hassos_odroid-c2-2.2.img.gz
[vmdk]: https://github.com/home-assistant/hassos/releases/download/1.10/hassos_ova-1.10.vmdk
[vmdk]: https://github.com/home-assistant/hassos/releases/download/1.11/hassos_ova-1.11.vmdk
[linux]: https://github.com/home-assistant/hassio-build/tree/master/install#install-hassio
[local]: http://hassio.local:8123
[samba]: /addons/samba/
Expand Down
Loading