Skip to content

Commit

Permalink
Merge branch 'current' into next
Browse files Browse the repository at this point in the history
  • Loading branch information
frenck committed Feb 17, 2020
2 parents 973e476 + 8a8c31a commit 67bbf07
Show file tree
Hide file tree
Showing 28 changed files with 217 additions and 74 deletions.
23 changes: 22 additions & 1 deletion .textlintrc.json
Original file line number Diff line number Diff line change
Expand Up @@ -77,11 +77,14 @@
"CalDAV",
"CardDAV",
"Cisco IOS",
"CLI",
"Daikin",
"Danfoss",
"Dark Sky",
"Debian",
"deCONZ",
"Dialogflow",
"DIY",
"DNS",
"Docker Hub",
"Docker",
Expand All @@ -98,6 +101,7 @@
"ESPHome",
"Essent",
"Everspring",
"Fast.com",
"FFmpeg",
"Fibaro",
"Flexit",
Expand All @@ -112,6 +116,7 @@
"GraphiQL",
"GraphQL",
"Growatt",
"HDMI",
"Heatmiser",
"Home Assistant Companion",
"Home Assistant Core",
Expand Down Expand Up @@ -143,18 +148,24 @@
"Kafka",
"KEF",
"KNX",
"Kodi",
"LaCrosse",
"LED",
"Let's Encrypt",
"Life360",
"LinkedIn",
"Linky",
"Linux",
"LMS",
"Logitech Harmony",
"Logitech Media Server",
"Logitech",
"Lovelace",
"LTE",
"MacBook",
"macOS",
"Markdown",
"mDNS",
"Microsoft",
"MikroTik",
"MIME",
Expand All @@ -169,6 +180,8 @@
"Norway",
"NuHeat",
"NZBGet",
"ODRIOD-N2",
"ODROID",
"OpenTherm",
"OpenWrt",
"PayPal",
Expand Down Expand Up @@ -204,8 +217,10 @@
"Sonarr",
"Sonos",
"Sony",
"Speedtest.net",
"Spotify",
"SQL",
"Squeezebox",
"SSID",
"SSL",
"StarLine",
Expand Down Expand Up @@ -236,8 +251,10 @@
"UI",
"UniFi",
"unRAID",
"UPnP",
"UPS",
"URL",
"USB",
"Velbus",
"Velux",
"Venstar",
Expand Down Expand Up @@ -273,6 +290,8 @@
[" HA ", "Home Assistant"],
["\\(s\\)he", "they"],
["2 ?steps? authentication", "two-step authentication"],
["addon", "add-on"],
["addons", "add-ons"],
["Alarm ?dot ?com", "Alarm.com"],
["an URL", "a URL"],
["analyse", "analyze"],
Expand All @@ -287,13 +306,15 @@
["end ?to ?end", "end-to-end"],
["FRITZ!? ?Box", "FRITZ!Box"],
["grey", "gray"],
["Hass\\.?io", "Home Assistant"],
["hass", "Home Assistant"],
["Hass\\.?io", "Home Assistant"],
["HassOS", "Home Assistant Operating System"],
["he or she", "they"],
["he/she", "they"],
["Home-?Ass?s?iss?tt?ant", "Home Assistant"],
["IFF?TTT?T?", "IFTTT"],
["ISY ?994", "ISY994"],
["JSONRPC", "JSON-RPC"],
["licence", "license"],
["licences", "licenses"],
["Mac ?OS", "macOS"],
Expand Down
4 changes: 2 additions & 2 deletions _config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -101,8 +101,8 @@ social:
# Home Assistant release details
current_major_version: 0
current_minor_version: 105
current_patch_version: 3
date_released: 2020-02-10
current_patch_version: 4
date_released: 2020-02-14

# 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: 2 additions & 0 deletions source/_docs/authentication.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,8 @@ INFO (MainThread) [homeassistant.components.http.auth] You need to use a bearer

### Lost owner password

Before using the procedure below, make sure you explore options provided [here](/docs/locked_out).

While you should hopefully be storing your passwords in a password manager, if you lose the password associated with the owner account the only way to resolve this is to delete *all* the authentication data. You do this by shutting down Home Assistant and deleting the following files from the `.storage/` folder in your [configuration folder](/docs/configuration/):

- `auth`
Expand Down
4 changes: 4 additions & 0 deletions source/_docs/configuration/templating.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -179,10 +179,14 @@ The same thing can also be expressed as a filter:
- Filter `timestamp_local` converts an UNIX timestamp to its string representation as date/time in your local timezone.
- Filter `timestamp_utc` converts a UNIX timestamp to its string representation representation as date/time in UTC timezone.
- Filter `timestamp_custom(format_string, local_time=True)` converts an UNIX timestamp to its string representation based on a custom format, the use of a local timezone is default. Supports the standard [Python time formatting options](https://docs.python.org/3/library/time.html#time.strftime).

Note: [UNIX timestamp](https://en.wikipedia.org/wiki/Unix_time) is the number of seconds that have elapsed since 00:00:00 UTC on 1 January 1970. Therefore, if used as a function's argument, it can be substituted with a numeric value (`int` or `float`):

{% raw %}
```yaml
{{ 120 | timestamp_local }}
```
{% endraw %}

### To/From JSON

Expand Down
2 changes: 1 addition & 1 deletion source/_docs/installation/armbian.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: "Installation on a Armbian system"
description: "Instructions to install Home Assistant on an Armbian-powered systems."
---

[armbian](https://www.armbian.com) runs on a wide-variety of [ARM development boards](https://www.armbian.com/download/). Currently there are around 50 boards supported inclusive the OrangePi family, Cubieboard, Pine64, and Odroid.
[armbian](https://www.armbian.com) runs on a wide-variety of [ARM development boards](https://www.armbian.com/download/). Currently there are around 50 boards supported inclusive the OrangePi family, Cubieboard, Pine64, and ODROID.

Setup Python and `pip`:

Expand Down
64 changes: 64 additions & 0 deletions source/_docs/locked_out.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
---
title: "I'm Locked Out!"
description: "Options for regaining access"
---

The sections below deal with recovering from a situation where you are not able to sign in,
or need to recover your data.

## Forgot Password

### Home Assistant (including Supervised)

If you’ve forgotten your user, then deleting the files mentioned above will be necessary to start a new onboarding process.

If you know the user, but not the password and you can access the [Home Assistant console](https://www.home-assistant.io/hassio/commandline/) and use the command below:

Connect a keyboard and monitor to your device.

`ha auth reset --username "<existing_user>" --password "<new_password>"`

### Home Assistant Core

While you should hopefully be storing your passwords in a password manager, if you lose the password associated with the owner account the only way to resolve this is to delete *all* the authentication data. You do this by shutting down Home Assistant and deleting the following files from the `.storage/` folder in your [configuration folder](/docs/configuration/):

- `auth`
- `auth_provider.homeassistant`
- `onboarding`
- `hassio`
- `cloud`

## Recovering Data for Home Assistant (including Supervised)

Unless your SD card/data is corrupted, you can still get to your files or troubleshoot further.
There are a few routes:

- Connect a USB keyboard and HDMI monitor directly to the Raspberry Pi.
- Remove the SD and access the files from another machine (preferably one running Linux).

## Connect directly

If you’re using a Raspberry Pi, you're likely going to have to pull the power in order to get your monitor recognized at boot. Pulling power has a risk of corrupting the SD, but you may not have another option. Most standard USB keyboards should be recognized easily.

Once you're connected, you'll see a running dmesg log. Hit the enter key to interrupt the log.
Sign in as "root". There is no password.

You will then be at the Home Assistant CLI, where you can run the custom commands. These are the same as you would run using the SSH add-on but without using `ha` in front of it. For example:

- `core logs` for Home Assistant Core log
- `supervisor logs` for supervisor logs
- `host reboot` to reboot the host
- `dns logs` for checking DNS
- etc (typing `help` will show more)

## Accessing Files from the SD/HDD

### Remove the SD and access the files from another computer

The files are on an EXT4 partition (`hassos-data`) and the path is `/mnt/data/supervisor`.
These are easily accessed using another Linux machine with EXT support.

For Windows or macOS you will need third party software. Below are some options.

- Windows: <https://www.diskinternals.com/linux-reader/> (read-only access to the SD)
- Mac: <https://osxfuse.github.io/>
2 changes: 1 addition & 1 deletion source/_docs/mqtt/broker.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ The MQTT integration needs you to run an MQTT broker for Home Assistant to conne

This is the most private option, is running your own MQTT broker.

The recommended setup method is to use the [Mosquitto MQTT broker addon](/addons/mosquitto).
The recommended setup method is to use the [Mosquitto MQTT broker add-on](/addons/mosquitto).

## Configuration

Expand Down
2 changes: 1 addition & 1 deletion source/_integrations/androidtv.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -180,7 +180,7 @@ Prior to Home Assistant 0.101, this approach did not work well for newer devices

The second option is to use an ADB server to connect to your Android TV and Fire TV devices.

For Home Assistant users, you can install the [Android Debug Bridge](https://github.com/hassio-addons/addon-adb/blob/master/README.md) addon. Using this approach, Home Assistant will send the ADB commands to the server, which will then send them to the Android TV / Fire TV device and report back to Home Assistant. To use this option, add the `adb_server_ip` option to your configuration. If you are running the server on the same machine as Home Assistant, you can use `127.0.0.1` for this value.
For Home Assistant users, you can install the [Android Debug Bridge](https://github.com/hassio-addons/addon-adb/blob/master/README.md) add-on. Using this approach, Home Assistant will send the ADB commands to the server, which will then send them to the Android TV / Fire TV device and report back to Home Assistant. To use this option, add the `adb_server_ip` option to your configuration. If you are running the server on the same machine as Home Assistant, you can use `127.0.0.1` for this value.

## ADB Troubleshooting

Expand Down
2 changes: 1 addition & 1 deletion source/_integrations/apple_tv.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@ Found Apple TVs:
Note: You must use 'pair' with devices that have home sharing disabled
```

Just copy and paste the `login_id` from the device you want to add. For more details about `atvremote`, see: [this page](https://pyatv.readthedocs.io/en/master/atvremote.html).
Just copy and paste the `login_id` from the device you want to add. For more details about `atvremote`, see: [this page](https://postlund.github.io/pyatv).

### Setting up device authentication

Expand Down
9 changes: 5 additions & 4 deletions source/_integrations/climate.modbus.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -61,15 +61,16 @@ data_type:
required: false
type: string
default: float
count:
data_count:
description: Number of registers to read.
required: false
type: integer
default: 2
precision:
description: Number of valid decimals.
required: false
type: integer
default: 0
default: 1
scale:
description: Scale factor (output = scale * value + offset).
required: false
Expand All @@ -89,12 +90,12 @@ min_temp:
description: Maximum setpoint temperature.
required: false
type: integer
default: 5
default: 5
temp_step:
description: The supported step size a target temperature can be increased/decreased.
required: false
type: float
default: 0.5
default: 0.5
temperature_unit:
description: Temperature unit reported by the current_temp_register. C or F
required: false
Expand Down
2 changes: 1 addition & 1 deletion source/_integrations/cover.rfxtrx.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ Example configuration:
cover:
- platform: rfxtrx
automatic_add: false
signal_repetitions: 2
signal_repetitions: 2 # signal_repetitions: 1 for the Somfy covers (avoid to stop the motion after start)
devices:
0b1100ce3213c7f210010f70: # Siemens/LightwaveRF
name: Bedroom Shutter
Expand Down
2 changes: 1 addition & 1 deletion source/_integrations/dialogflow.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ ha_config_flow: true

The `dialogflow` integration is designed to be used with the [webhook](https://dialogflow.com/docs/fulfillment#webhook) integration of [Dialogflow](https://dialogflow.com/). When a conversation ends with a user, Dialogflow sends an action and parameters to the webhook.

To be able to receive messages from DialogFlow, your Home Assistant instance needs to be accessible from the web and you need to have the `base_url` configured for the HTTP integration ([docs](/integrations/http/#base_url)). Dialogflow will return fallback answers if your server does not answer or takes too long (more than 5 seconds).
To be able to receive messages from Dialogflow, your Home Assistant instance needs to be accessible from the web and you need to have the `base_url` configured for the HTTP integration ([docs](/integrations/http/#base_url)). Dialogflow will return fallback answers if your server does not answer or takes too long (more than 5 seconds).

Dialogflow could be [integrated](https://dialogflow.com/docs/integrations/) with many popular messaging, virtual assistant and IoT platforms.

Expand Down
8 changes: 4 additions & 4 deletions source/_integrations/discovery.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ ha_release: 0.7
ha_quality_scale: internal
---

Home Assistant can discover and automatically configure [zeroconf](https://en.wikipedia.org/wiki/Zero-configuration_networking)/[mDNS](https://en.wikipedia.org/wiki/Multicast_DNS) and [uPnP](https://en.wikipedia.org/wiki/Universal_Plug_and_Play) devices on your network. Currently the `discovery` integration can detect:
Home Assistant can discover and automatically configure [zeroconf](https://en.wikipedia.org/wiki/Zero-configuration_networking)/[mDNS](https://en.wikipedia.org/wiki/Multicast_DNS) and [UPnP](https://en.wikipedia.org/wiki/Universal_Plug_and_Play) devices on your network. Currently the `discovery` integration can detect:

* [Apple TV](/integrations/apple_tv/)
* [Belkin WeMo switches](/integrations/wemo/)
Expand All @@ -21,7 +21,7 @@ Home Assistant can discover and automatically configure [zeroconf](https://en.wi
* [Frontier Silicon internet radios](/integrations/frontier_silicon)
* [Linn / Openhome](/integrations/openhome)
* [Logitech Harmony Hub](/integrations/harmony)
* [Logitech media server (Squeezebox)](/integrations/squeezebox)
* [Logitech Media Server (Squeezebox)](/integrations/squeezebox)
* [NETGEAR routers](/integrations/netgear)
* [Panasonic Viera](/integrations/panasonic_viera)
* [Philips Hue](/integrations/hue)
Expand Down Expand Up @@ -80,7 +80,7 @@ Valid values for ignore are:
* `frontier_silicon`: Frontier Silicon internet radios
* `harmony`: Logitech Harmony Hub
* `igd`: Internet Gateway Device
* `logitech_mediaserver`: Logitech media server (Squeezebox)
* `logitech_mediaserver`: Logitech Media Server (Squeezebox)
* `netgear_router`: NETGEAR routers
* `octoprint`: Octoprint
* `openhome`: Linn / Openhome
Expand All @@ -106,7 +106,7 @@ Valid values for enable are:

### UPnP

Home Assistant must be on the same network as the devices for uPnP discovery to work.
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.

### Windows
Expand Down
3 changes: 2 additions & 1 deletion source/_integrations/fastdotcom.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,8 @@ The `fastdotcom` integration uses the [Fast.com](https://fast.com/) web service

<div class='note'>

Currently fast.com only supports measuring download bandwidth. If you want to measure bandwidth metrics other then download such as ping and upload, utilize the [speedtest](/integrations/speedtestdotnet) component.
Currently, the Fast.com integration only supports measuring download bandwidth.
If you want to measure bandwidth metrics other then download such as ping and upload, utilize the [Speedtest.net](/integrations/speedtestdotnet) integration.

</div>

Expand Down
4 changes: 4 additions & 0 deletions source/_integrations/fritzbox_netmonitor.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,10 @@ ha_iot_class: Local Polling

The `fritzbox_netmonitor` sensor monitors the network statistics exposed by [AVM FRITZ!Box](https://avm.de/produkte/fritzbox/) routers.

## Configuration

For this integration to function properly, you need to have "UPnP Statusinformation transfer" activated on the AVM FRITZ!Box. Please make sure you have that enabled.

To use the FRITZ!Box network monitor in your installation, add the following to your `configuration.yaml` file:

```yaml
Expand Down
2 changes: 1 addition & 1 deletion source/_integrations/google_maps.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ device_tracker:
username: YOUR_USERNAME
```
Once enabled and you have rebooted devices discovered through this integration wil be listed in the `known_devices.yaml`file within your configuration directory.
Once enabled and you have rebooted devices discovered through this integration will be listed in the `known_devices.yaml` file within your configuration directory.

They will be created with indentifiers like `google_maps_<numeric_id>`. To be able to properly track entities you must set the `track` attribute to `true`.

Expand Down
6 changes: 4 additions & 2 deletions source/_integrations/greeneye_monitor.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -34,8 +34,10 @@ greeneye_monitor:
counted_quantity_per_pulse: 1
time_unit: "min"
temperature_sensors:
- number: 1
name: back_porch_temperature
temperature_unit: "C"
sensors:
- number: 1
name: back_porch_temperature
voltage:
- number: 1
name: house_volts
Expand Down
Loading

0 comments on commit 67bbf07

Please sign in to comment.