Skip to content
Merged
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
17 changes: 17 additions & 0 deletions .textlintrc.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,23 @@
"rules": {
"common-misspellings": {
"ignore": ["Proove", "Alot"]
},
"terminology": {
"defaultTerms": false,
"skip": ["Blockquote"],
"terms": [
"Abode",
"Home Assistant Companion",
"Home Assistant Core",
"Home Assistant Supervised",
"Home Assistant Supervisor",
"Home Assistant Operating System",
"Home Assistant OS",
"Home Assistant",
["hass", "Home Assistant"],
["Home-?Ass?s?iss?tt?ant", "Home Assistant"],
[" HA ", "Home Assistant"]
]
}
}
}
31 changes: 31 additions & 0 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 2 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,8 @@
"remark-lint-no-shell-dollars": "^1.0.3",
"remark-stringify": "^7.0.3",
"textlint": "^11.6.3",
"textlint-rule-common-misspellings": "^1.0.1"
"textlint-rule-common-misspellings": "^1.0.1",
"textlint-rule-terminology": "^2.1.1"
},
"scripts": {
"markdown:lint": "remark --quiet --frail .",
Expand Down
13 changes: 11 additions & 2 deletions source/_cookbook/track_battery_level.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,16 @@ description: "Basic example how to track the battery level of your mobile device
ha_category: Automation Examples
---

### Android and iOS Devices
## Android and iOS Devices

The [Home Assistant Companion Apps](https://companion.home-assistant.io/) for iOS and Android pass the current battery level to Home Assistant with every location update. The default name of the sensor used is `sensor.battery_level`.

### iOS Devices

If you have a device running iOS (iPhone, iPad, etc), The [iCloud](/integrations/icloud) integration is gathering various details about your device including the battery level. To display it in the Frontend use a [template sensor](/integrations/template). You can also use the `battery` [sensor device class](/integrations/sensor/#device-class) to dynamically change the icon with the battery level.

{% raw %}

```yaml
sensor:
- platform: template
Expand All @@ -27,13 +29,15 @@ sensor:
{%- endif %}
device_class: battery
```

{% endraw %}

### Android Devices

On your Android device, once the official [Home Assistant companion app](https://companion.home-assistant.io/) is installed and connected to your Home Assistance instance, you will be able to display the battery level in the frontend by adding a [template sensor](/integrations/template) to your configuration YAML file. You can also use the battery [sensor device class](/integrations/sensor/#device-class) to dynamically change the icon with the battery level.
On your Android device, once the official [Home Assistant Companion app](https://companion.home-assistant.io/) is installed and connected to your Home Assistance instance, you will be able to display the battery level in the frontend by adding a [template sensor](/integrations/template) to your configuration YAML file. You can also use the battery [sensor device class](/integrations/sensor/#device-class) to dynamically change the icon with the battery level.

{% raw %}

```yaml
sensor:
- platform: template
Expand All @@ -49,6 +53,7 @@ sensor:
{%- endif %}
device_class: battery
```

{% endraw %}

Replace 'device_tracker.xxxxx' with your phone name as shown under Configuration/Devices Device Info/Entities, for example: 'device_tracker.mi_a1'
Expand All @@ -59,6 +64,7 @@ If you have configured Owntracks to send reports via MQTT you can use the receiv
Replace username with your MQTT username (for the embedded MQTT it's simply homeassistant), and deviceid with the set Device ID in Owntracks.

{% raw %}

```yaml
sensor:
- platform: mqtt
Expand All @@ -68,6 +74,7 @@ sensor:
value_template: '{{ value_json.batt }}'
device_class: battery
```

{% endraw %}

#### HTTP
Expand All @@ -76,6 +83,7 @@ If you have configured Owntracks to send reports to your Home Assistant instance
Replace `deviceid` with the set Device ID in Owntracks.

{% raw %}

```yaml
sensor:
- platform: template
Expand All @@ -84,4 +92,5 @@ sensor:
value_template: "{{ state_attr('device_tracker.deviceid', 'battery_level') }}"
unit_of_measurement: '%'
```

{% endraw %}
2 changes: 1 addition & 1 deletion source/_docs/ecosystem/certificates/lets_encrypt.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -198,7 +198,7 @@ duckdns:

The access token is available on your DuckDNS page. Restart Home Assistant after the change.

What you have now done is set up DuckDNS so that whenever you type examplehome.duckdns.org in to your browser it will convert that to your router's external IP address. Your external IP address will always be up to date because Homeassistant will update DuckDNS every time it changes.
What you have now done is set up DuckDNS so that whenever you type examplehome.duckdns.org in to your browser it will convert that to your router's external IP address. Your external IP address will always be up to date because Home Assistant will update DuckDNS every time it changes.

Now type your new URL in to your address bar on your browser with port 8123 on the end:

Expand Down
4 changes: 2 additions & 2 deletions source/_docs/ecosystem/notebooks/database.markdown
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Database"
description: "Accessing the Home-Assistant database from a Jupyter notebook."
description: "Accessing the Home Assistant database from a Jupyter notebook."
redirect_from: /ecosystem/notebooks/database/
---

You can directly access the Home-Assistant database from Jupyter notebooks. The [Database example](https://nbviewer.jupyter.org/github/home-assistant/home-assistant-notebooks/blob/master/other/database-examples.ipynb) shows you how you can work with stored database values.
You can directly access the Home Assistant database from Jupyter notebooks. The [Database example](https://nbviewer.jupyter.org/github/home-assistant/home-assistant-notebooks/blob/master/other/database-examples.ipynb) shows you how you can work with stored database values.
9 changes: 4 additions & 5 deletions source/_docs/installation/armbian.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ sudo apt-get install python3-dev python3-pip
```

Now that you installed python, there are two ways to install Home Assistant:

1. It is recommended to install Home Assistant in a virtual environment to avoid using `root`, using the [VirtualEnv instructions](/docs/installation/virtualenv/)
2. Alternatively, you can install Home Assistant for the user you created when first booting Armbian:

Expand All @@ -23,8 +24,6 @@ hass --open-ui

Running these commands will:

- Install Home Assistant
- Launch Home Assistant and serve the web interface on `http://localhost:8123`
- the configuration files will be created in /home/{user}/.homeassistant


- Install Home Assistant
- Launch Home Assistant and serve the web interface on `http://localhost:8123`
- The configuration files will be created in `/home/{user}/.homeassistant`
19 changes: 9 additions & 10 deletions source/_docs/installation/synology.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -23,29 +23,27 @@ The main benefit from this method is that you can assign Home Assistant its own

Option 2 is described below.


The following configuration has been tested on Synology 413j running DSM 6.0-7321 Update 1.

Running these commands will:

- Install Home Assistant
- Enable Home Assistant to be launched on `http://localhost:8123`
- Install Home Assistant
- Enable Home Assistant to be launched on `http://localhost:8123`

Using the Synology webadmin:

- Install python3 using the Synology Package Center
- Create homeassistant user and add to the "users" group
- Install python3 using the Synology Package Center
- Create a `homeassistant` user and add to the "users" group

SSH onto your synology & login as admin or root

- Log in with your own administrator account
- Switch to root using:
- Log in with your own administrator account
- Switch to root using:

```bash
$ sudo -i
```


Check the path to python3 (assumed to be /volume1/@appstore/py3k/usr/local/bin)

```bash
Expand All @@ -58,20 +56,21 @@ Install PIP (Python's package management system)
# ./python3 -m ensurepip
```

Use PIP to install Homeassistant package 0.64.3
Use PIP to install the Home Assistant package 0.64.3

```bash
# ./python3 -m pip install homeassistant==0.64.3
```

Create homeassistant config directory & switch to it
Create a Home Assistant config directory & switch to it

```bash
# mkdir /volume1/homeassistant
# chown homeassistant /volume1/homeassistant
# chmod 755 /volume1/homeassistant
# cd /volume1/homeassistant
```

Hint: alternatively you can also create a "Shared Folder" via Synology WebUI (e.g., via "File Station") - this has the advantage that the folder is visible via "File Station".

Create hass-daemon file using the following code (edit the variables in uppercase if necessary)
Expand Down
14 changes: 7 additions & 7 deletions source/_docs/mqtt/broker.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -142,14 +142,14 @@ If you experience an error message like `Failed to connect due to exception: [SS

Home Assistant contains an embedded MQTT broker called [HBMQTT](https://pypi.python.org/pypi/hbmqtt). If you don't have an MQTT broker, you can configure this one to be used. If configured, Home Assistant will automatically connect to it.

| Setting | Value |
| -------------- | ----- |
| Host | localhost |
| Port | 1883 |
| Protocol | 3.1.1 |
| User | homeassistant |
| Setting | Value |
| -------------- | ---------------------------------- |
| Host | localhost |
| Port | 1883 |
| Protocol | 3.1.1 |
| User | `homeassistant` |
| Password | _password set under mqtt settings_ |
| Websocket port | 8080 |
| Websocket port | 8080 |

```yaml
# Example configuration.yaml entry
Expand Down
2 changes: 1 addition & 1 deletion source/_docs/z-wave/installation.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -181,7 +181,7 @@ Or, if there is no result, try to find detailed USB connection info with:
dmesg | grep USB
```

If Home Assistant (`hass`) runs with another user (e.g., *homeassistant*) you need to give access to the stick with:
If Home Assistant (`hass`) runs with another user (e.g., `homeassistant`) you need to give access to the stick with:

```bash
sudo usermod -aG dialout homeassistant
Expand Down
2 changes: 1 addition & 1 deletion source/_integrations/bh1750.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@ $ sudo raspi-config

Select `Interfacing options->I2C` choose `<Yes>` and hit `Enter`, then go to `Finish` and you'll be prompted to reboot.

Install dependencies for use the `smbus-cffi` module and enable your _homeassistant_ user to join the _i2c_ group:
Install dependencies for use the `smbus-cffi` module and enable your `homeassistant` user to join the _i2c_ group:

```bash
# pi user environment: Install i2c dependencies and utilities
Expand Down
2 changes: 1 addition & 1 deletion source/_integrations/blink.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -203,7 +203,7 @@ Similar to the previous example, this automation will disarm blink when arriving

### Save Video Locally When Motion Detected

When motion is detected, you can use the Blink Home-Assistant integration to save the last recorded video locally, rather than relying on Blink's servers to save your data.
When motion is detected, you can use the Blink Home Assistant integration to save the last recorded video locally, rather than relying on Blink's servers to save your data.

Again, this example assumes your camera's name (in the blink app) is `My Camera` and your sync module name is `My Sync Module`. The file will be saved to `/tmp/videos/blink_video_{YYYMMDD_HHmmSS}.mp4` where `{YYYYMMDD_HHmmSS}` will be a timestamp create via the use of [templating](/docs/configuration/templating/).

Expand Down
2 changes: 1 addition & 1 deletion source/_integrations/bme280.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -149,7 +149,7 @@ $ sudo raspi-config

Select `Interfacing options->I2C` choose `<Yes>` and hit `Enter`, then go to `Finish` and you'll be prompted to reboot.

Install dependencies for use the `smbus-cffi` module and enable your _homeassistant_ user to join the _i2c_ group:
Install dependencies for use the `smbus-cffi` module and enable your `homeassistant` user to join the _i2c_ group:

```bash
# pi user environment: Install i2c dependencies and utilities
Expand Down
2 changes: 1 addition & 1 deletion source/_integrations/bme680.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -195,7 +195,7 @@ $ sudo raspi-config

Select `Interfacing options->I2C` choose `<Yes>` and hit `Enter`, then go to `Finish` and you'll be prompted to reboot.

Install dependencies to use the `smbus-cffi` module and add your _homeassistant_ user to the _i2c_ group:
Install dependencies to use the `smbus-cffi` module and add your `homeassistant` user to the _i2c_ group:

```bash
# pi user environment: Install I2C dependencies and utilities
Expand Down
2 changes: 1 addition & 1 deletion source/_integrations/climate.knx.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ climate:
```

`operation_mode_frost_protection_address` / `operation_mode_night_address` / `operation_mode_comfort_address` are not necessary if `operation_mode_address` is specified.
If the actor doesn't support explicit state communication objects the *_state_address can be configured with the same group address as the writeable *_address. The Read-Flag for the *_state_address communication object has to be set in ETS to support initial reading eg. when starting home-assistant.
If the actor doesn't support explicit state communication objects the *_state_address can be configured with the same group address as the writeable *_address. The Read-Flag for the *_state_address communication object has to be set in ETS to support initial reading e.g., when starting Home Assistant.

The following values are valid for the `hvac_mode` attribute:

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 @@ -23,7 +23,7 @@ cover:
automatic_add: true
```

Launch your homeassistant and go the website (e.g `http://localhost:8123`). Push your remote and your device should be added.
Launch your Home Assistant and go the website (e.g., `http://localhost:8123`). Push your remote and your device should be added.

Once added it will show an ID (e.g `0b11000102ef9f210010f70`) and you can verify that it works from the frontend. Then you should update your configuration to:

Expand Down
6 changes: 3 additions & 3 deletions source/_integrations/environment_canada.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -35,9 +35,9 @@ Each platform automatically determines which weather station's data to use. Howe

For each platform, the location to use is determined according to the following hierarchy:

- Location ID specified in platform configuration (optional)
- Closest station to latitude/longitude specified in platform configuration (optional
- Closest station to latitude/longitude specified in Home Assistant core configuration
- Location ID specified in platform configuration (optional)
- Closest station to latitude/longitude specified in platform configuration (optional)
- Closest station to latitude/longitude specified in Home Assistant configuration

## Weather

Expand Down
2 changes: 1 addition & 1 deletion source/_integrations/hdmi_cec.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -137,7 +137,7 @@ hdmi_cec:
hdmi_cec.hdmi_5: media_player
```

And the last option is `host`. PyCEC supports bridging CEC commands over TCP. When you start pyCEC on machine with HDMI port (`python -m pycec`), you can then run homeassistant on another machine and connect to CEC over TCP. Specify TCP address of pyCEC server:
And the last option is `host`. PyCEC supports bridging CEC commands over TCP. When you start pyCEC on machine with HDMI port (`python -m pycec`), you can then run Home Assistant on another machine and connect to CEC over TCP. Specify TCP address of pyCEC server:

```yaml
hdmi_cec:
Expand Down
2 changes: 1 addition & 1 deletion source/_integrations/history_stats.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -188,6 +188,6 @@ Here, last Monday is _today_ as a timestamp, minus 86400 times the current weekd

<div class='note'>

The `/developer-tools/template` page of your home-assistant UI can help you check if the values for `start`, `end` or `duration` are correct. If you want to check if your period is right, just click on your component, the `from` and `to` attributes will show the start and end of the period, nicely formatted.
The `/developer-tools/template` page of your Home Assistant UI can help you check if the values for `start`, `end` or `duration` are correct. If you want to check if your period is right, just click on your component, the `from` and `to` attributes will show the start and end of the period, nicely formatted.

</div>
2 changes: 1 addition & 1 deletion source/_integrations/homematic.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ Device support is available for most of the wired and wireless devices, as well

<div class='note info'>

Since CCU Version 3, the internal firewalls are enabled by default. You have to grant full access for the `XML-RPC API` or specify the IP-address of the Home-Assistant server and whitelist it, inside the CCU's security settings.
Since CCU Version 3, the internal firewalls are enabled by default. You have to grant full access for the `XML-RPC API` or specify the IP-address of the Home Assistant server and whitelist it, inside the CCU's security settings.

</div>

Expand Down
8 changes: 4 additions & 4 deletions source/_integrations/homematicip_cloud.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -78,10 +78,10 @@ authtoken:

## Adding and removing devices and group via native HomematicIP APP

Devices and groups are instantly removed from Homeassistant when removed in the native HomematicIP APP.
Groups are instantly created in Homeassistant when created in the native HomematicIP APP.
Devices are created with a delay of 30 seconds in Homeassistant when created in the native HomematicIP APP.
Within this delay the device registration should be completed in the App, otherwise the device name will be a default one based on the device type. This can easily be fixed in the Homeassistant entity registry afterwards.
Devices and groups are instantly removed from Home Assistant when removed in the native HomematicIP APP.
Groups are instantly created in Home Assistant when created in the native HomematicIP APP.
Devices are created with a delay of 30 seconds in Home Assistant when created in the native HomematicIP APP.
Within this delay the device registration should be completed in the App, otherwise the device name will be a default one based on the device type. This can easily be fixed in the Home Assistant entity registry afterwards.

## Implemented and tested devices

Expand Down
2 changes: 1 addition & 1 deletion source/_integrations/htu21d.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ $ sudo raspi-config

Select `Interfacing options->I2C` choose `<Yes>` and hit `Enter`, then go to `Finish` and you'll be prompted to reboot.

Install dependencies for use the `smbus-cffi` module and enable your _homeassistant_ user to join the _i2c_ group:
Install dependencies for use the `smbus-cffi` module and enable your `homeassistant` user to join the _i2c_ group:

```bash
# pi user environment: Install i2c dependencies and utilities
Expand Down
Loading