mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-07-23 17:27:19 +00:00
Adds Terminology Textlint plugin, fixes use of Home Assistant (#12063)
This commit is contained in:
Franck Nijhof
GitHub
parent
5488d9d0d7
commit
752dec4047
@ -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
package-lock.json
generated
31
package-lock.json
generated
@ -2316,6 +2316,37 @@
|
||||
"unist-util-visit": "^1.1.0"
|
||||
}
|
||||
},
|
||||
"textlint-rule-terminology": {
|
||||
"version": "2.1.1",
|
||||
"resolved": "https://registry.npmjs.org/textlint-rule-terminology/-/textlint-rule-terminology-2.1.1.tgz",
|
||||
"integrity": "sha512-955Q289wCubt67iar/U3jnsPvwHkRhWnOM0gqE3fQDBMJkFsoDnYNummU8CmAPXK7usnbwa2r48q0s4FtATWbw==",
|
||||
"dev": true,
|
||||
"requires": {
|
||||
"lodash": "^4.17.15",
|
||||
"strip-json-comments": "^3.0.1",
|
||||
"textlint-rule-helper": "^2.1.1"
|
||||
},
|
||||
"dependencies": {
|
||||
"strip-json-comments": {
|
||||
"version": "3.0.1",
|
||||
"resolved": "https://registry.npmjs.org/strip-json-comments/-/strip-json-comments-3.0.1.tgz",
|
||||
"integrity": "sha512-VTyMAUfdm047mwKl+u79WIdrZxtFtn+nBxHeb844XBQ9uMNTuTHdx2hc5RiAJYqwTj3wc/xe5HLSdJSkJ+WfZw==",
|
||||
"dev": true
|
||||
},
|
||||
"textlint-rule-helper": {
|
||||
"version": "2.1.1",
|
||||
"resolved": "https://registry.npmjs.org/textlint-rule-helper/-/textlint-rule-helper-2.1.1.tgz",
|
||||
"integrity": "sha512-6fxgHzoJVkjl3LaC1b2Egi+5wbhG4i0pU0knJmQujVhxIJ3D3AcQQZPs457xKAi5xKz1WayYeTeJ5jrD/hnO7g==",
|
||||
"dev": true,
|
||||
"requires": {
|
||||
"@textlint/ast-node-types": "^4.2.1",
|
||||
"@textlint/types": "^1.1.2",
|
||||
"structured-source": "^3.0.2",
|
||||
"unist-util-visit": "^1.1.0"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"to-regex-range": {
|
||||
"version": "5.0.1",
|
||||
"resolved": "https://registry.npmjs.org/to-regex-range/-/to-regex-range-5.0.1.tgz",
|
||||
|
||||
@ -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 .",
|
||||
|
||||
@ -4,7 +4,8 @@ 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
|
||||
@ -12,6 +13,7 @@ The [Home Assistant Companion Apps](https://companion.home-assistant.io/) for iO
|
||||
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
|
||||
@ -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
|
||||
@ -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'
|
||||
@ -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
|
||||
@ -68,6 +74,7 @@ sensor:
|
||||
value_template: '{{ value_json.batt }}'
|
||||
device_class: battery
|
||||
```
|
||||
|
||||
{% endraw %}
|
||||
|
||||
#### HTTP
|
||||
@ -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
|
||||
@ -84,4 +92,5 @@ sensor:
|
||||
value_template: "{{ state_attr('device_tracker.deviceid', 'battery_level') }}"
|
||||
unit_of_measurement: '%'
|
||||
```
|
||||
|
||||
{% endraw %}
|
||||
|
||||
@ -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:
|
||||
|
||||
|
||||
@ -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.
|
||||
|
||||
@ -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:
|
||||
|
||||
@ -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`
|
||||
|
||||
@ -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
|
||||
@ -58,13 +56,13 @@ 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
|
||||
@ -72,6 +70,7 @@ Create homeassistant config directory & switch to it
|
||||
# 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)
|
||||
|
||||
@ -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
|
||||
|
||||
@ -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
|
||||
|
||||
@ -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
|
||||
|
||||
@ -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/).
|
||||
|
||||
|
||||
@ -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
|
||||
|
||||
@ -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
|
||||
|
||||
@ -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:
|
||||
|
||||
|
||||
@ -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:
|
||||
|
||||
|
||||
@ -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
|
||||
|
||||
|
||||
@ -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:
|
||||
|
||||
@ -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>
|
||||
|
||||
@ -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>
|
||||
|
||||
|
||||
@ -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
|
||||
|
||||
|
||||
@ -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
|
||||
|
||||
@ -113,7 +113,7 @@ fire_event_filter:
|
||||
required: inclusive
|
||||
type: [list, string]
|
||||
state_updater:
|
||||
description: The integration will collect the current state of each configured device from the KNX bus to display it correctly within Home-Assistant. Set this option to False to prevent this behavior.
|
||||
description: The integration will collect the current state of each configured device from the KNX bus to display it correctly within Home Assistant. Set this option to False to prevent this behavior.
|
||||
required: false
|
||||
default: true
|
||||
type: boolean
|
||||
|
||||
@ -98,7 +98,7 @@ Many KNX devices can change their state internally without a message to the swit
|
||||
|
||||
For switching/light actuators that are only controlled by a single group address and don't have dedicated state communication objects you can set `state_address` to the same value as `address`.
|
||||
|
||||
*Note on tunable white:* Home-Assistant uses Mireds as the unit for color temperature, whereas KNX typically uses Kelvin. The Kelvin/Mireds relationship is reciprocal, not linear, therefore the color temperature pickers (sliders) in Home-Assistant may not align with ones of KNX visualizations. This is the expected behavior.
|
||||
*Note on tunable white:* Home Assistant uses Mireds as the unit for color temperature, whereas KNX typically uses Kelvin. The Kelvin/Mireds relationship is reciprocal, not linear, therefore the color temperature pickers (sliders) in Home Assistant may not align with ones of KNX visualizations. This is the expected behavior.
|
||||
|
||||
## Extended configuration example
|
||||
|
||||
|
||||
@ -12,7 +12,7 @@ The `london_air` integration [queries](https://api.erg.kcl.ac.uk/AirQuality/Hour
|
||||
|
||||
Boroughs can have multiple monitoring sites at different geographical positions within the borough, and each of those sites can monitor up to six different kinds of pollutant. The pollutants are described [here](https://api.erg.kcl.ac.uk/AirQuality/Information/Species/Json) and are Carbon Monoxide ([CO2](https://www.londonair.org.uk/LondonAir/guide/WhatIsCO.aspx)), Nitrogen Dioxide ([NO2](https://www.londonair.org.uk/LondonAir/guide/WhatIsNO2.aspx)), Ozone ([O3](https://www.londonair.org.uk/LondonAir/guide/WhatIsO3.aspx)), Sulfur Dioxide ([SO2](https://www.londonair.org.uk/LondonAir/guide/WhatIsSO2.aspx)), PM2.5 & PM10 [particulates](https://www.londonair.org.uk/LondonAir/guide/WhatIsPM.aspx). The `latitude` and `longitude` of each site is accessible through a `data` attribute of the sensor, as are details about the pollutants monitored at that site. The `sites` attribute of a sensor displays how many monitoring sites that sensor covers. The `updated` attribute of a sensor states when the data was last published. Nominally data is published hourly, but in my experience this can vary. To limit the number of requests made by the sensor, a single API request is made every 30 minutes.
|
||||
|
||||
To add sensors to Home-assistant for all possible areas/boroughs add the following to your `configuration.yaml` file:
|
||||
To add sensors to Home Assistant for all possible areas/boroughs add the following to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry for a single sensor
|
||||
@ -56,7 +56,7 @@ locations:
|
||||
type: list
|
||||
{% endconfiguration %}
|
||||
|
||||
To explore the data available within the `data` attribute of a sensor use the `dev-template` tool on the Home-assistant frontend. `data` contains a list of monitored sites, where the number of monitored sites are given by the `sites` attribute. If a sensor has four sites, access the fourth site by indexing the list of sites using data[3]. Each site is a dictionary with multiple fields, with entries for the `latitude` and `longitude` of that site, a `pollution_status`, `site_code`, `site_name` and `site_type`. The field `number_of_pollutants` states how many pollutants are monitored (of the possible six) and the field `pollutants` returns a list with data for each pollutant. To access the first pollutant in the list for site zero use `attributes.data[0].pollutants[0]`. Each entry in `pollutants` is a dictionary with fields for the pollutant `code`, `description`, `index`, `quality` and a `summary`. [Template sensors](/integrations/template) can then be added to display these attributes, for example:
|
||||
To explore the data available within the `data` attribute of a sensor use the `dev-template` tool on the Home Assistant frontend. `data` contains a list of monitored sites, where the number of monitored sites are given by the `sites` attribute. If a sensor has four sites, access the fourth site by indexing the list of sites using data[3]. Each site is a dictionary with multiple fields, with entries for the `latitude` and `longitude` of that site, a `pollution_status`, `site_code`, `site_name` and `site_type`. The field `number_of_pollutants` states how many pollutants are monitored (of the possible six) and the field `pollutants` returns a list with data for each pollutant. To access the first pollutant in the list for site zero use `attributes.data[0].pollutants[0]`. Each entry in `pollutants` is a dictionary with fields for the pollutant `code`, `description`, `index`, `quality` and a `summary`. [Template sensors](/integrations/template) can then be added to display these attributes, for example:
|
||||
|
||||
```yaml
|
||||
# Example template sensors
|
||||
|
||||
@ -76,7 +76,7 @@ The min_volume and max_volume are there to protect you against misclicks on the
|
||||
|
||||
<div class='note warning'>
|
||||
|
||||
On linux the user running home-assistant needs `dialout` permissions to access the serial port.
|
||||
On linux the user running Home Assistant needs `dialout` permissions to access the serial port.
|
||||
This can be added to the user by doing `sudo usermod -a -G dialout <username>`.
|
||||
Be aware that the user might need to logout and logon again to activate these permissions.
|
||||
|
||||
|
||||
@ -139,6 +139,6 @@ To apply the user and role just created, we need to give it permissions
|
||||
* Click `Permissions`
|
||||
* Open `Add` and click `User Permission`
|
||||
* Select "\" for the path
|
||||
* Select your hass user ("hass")
|
||||
* Select the Home Assistant role ("home-assistant")
|
||||
* Select your Home Assistant user (`hass`)
|
||||
* Select the Home Assistant role (`home-assistant`)
|
||||
* Make sure `Propigate` is checked
|
||||
|
||||
@ -43,7 +43,7 @@ send_test_msg:
|
||||
type: boolean
|
||||
{% endconfiguration %}
|
||||
|
||||
It's easy to test your Pushetta setup outside of Home Assistant. Assuming you have a channel *home-assistant*, just fire a request and check the channel page in the dashboard for a new message.
|
||||
It's easy to test your Pushetta setup outside of Home Assistant. Assuming you have a channel `home-assistant`, just fire a request and check the channel page in the dashboard for a new message.
|
||||
|
||||
```bash
|
||||
curl -X POST \
|
||||
|
||||
@ -86,7 +86,7 @@ $ sudo raspi-config
|
||||
|
||||
Select `Interfacing options->I2C` choose `<Yes>` and hit `Enter`, then go to `Finish`.
|
||||
|
||||
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
|
||||
@ -194,7 +194,7 @@ $ sudo raspi-config
|
||||
|
||||
Select `Interfacing options->I2C` choose `<Yes>` and hit `Enter`, then go to `Finish`.
|
||||
|
||||
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
|
||||
|
||||
@ -11,7 +11,7 @@ ha_codeowners:
|
||||
- '@squishykid'
|
||||
---
|
||||
|
||||
The `solax` integration connects home-assistant to Solax solar power inverters. Solax inverters may be connected to a home Wi-Fi network and expose a REST API. This integration retrieves information such as photovoltaic power production, battery levels and power, and how much power is being fed back into the grid.
|
||||
The `solax` integration connects Home Assistant to Solax solar power inverters. Solax inverters may be connected to a home Wi-Fi network and expose a REST API. This integration retrieves information such as photovoltaic power production, battery levels and power, and how much power is being fed back into the grid.
|
||||
|
||||
## Configuration
|
||||
|
||||
|
||||
@ -54,7 +54,7 @@ action:
|
||||
|
||||
## Streaming in Lovelace
|
||||
|
||||
As of Homeassistant version 0.92 you can now live-stream a camera feed directly in lovelace.
|
||||
As of Home Assistant version 0.92 you can now live-stream a camera feed directly in lovelace.
|
||||
To do this add either [picture-entity](/lovelace/picture-entity/), [picture-glance](/lovelace/picture-glance/) or [picture-elements](/lovelace/picture-elements/), set `camera_image` to a stream-ready camera entity and set `camera_view` to `live` in one of your lovelace views.
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
@ -62,6 +62,7 @@ sensor:
|
||||
i2c_address: 0x29
|
||||
xshut: 16
|
||||
```
|
||||
|
||||
Several devices may be attached and a GPIO port from RPI is used for reset. XSHUT signal is generated pulsing LOW at initialization and after that, it is kept HIGH all time. This version uses VL53L1X long-range mode that may reach up to 4 meters.
|
||||
|
||||
## Directions for installing i2c on Raspberry Pi
|
||||
@ -75,7 +76,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
|
||||
|
||||
@ -130,7 +130,7 @@ You can use the service wink/refresh_state_from_wink to pull the most recent sta
|
||||
|
||||
## Service `pull_newly_added_devices_from_wink`
|
||||
|
||||
You can use the service wink/add_new_devices to pull any newly paired Wink devices to an already running instance of Home-Assistant. Any new devices will also be added if Home-Assistant is restarted.
|
||||
You can use the service wink/add_new_devices to pull any newly paired Wink devices to an already running instance of Home Assistant. Any new devices will also be added if Home Assistant is restarted.
|
||||
|
||||
## Service `delete_wink_device`
|
||||
|
||||
|
||||
@ -104,7 +104,7 @@ To send files and images, your jabber server must support [XEP_0363](https://xmp
|
||||
|
||||
Be aware that images are uploaded onto the Jabber server of your provider. They reside there un-encrypted and could be accessed by the server admins. Usually images are deleted after a few days.<br>
|
||||
<br>
|
||||
Home-Assistant supports TLS encryption to ensure transport encryption. TLS is enforced by default. You can disable it with the [`tls`](#tls) flag -- which is not recommended.
|
||||
Home Assistant supports TLS encryption to ensure transport encryption. TLS is enforced by default. You can disable it with the [`tls`](#tls) flag -- which is not recommended.
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
@ -149,7 +149,7 @@ Using a Philips Hue Dimmer Switch is probably the easiest way to factory-reset y
|
||||
|
||||
Follow the instructions on [https://github.com/vanviegen/hue-thief/](https://github.com/vanviegen/hue-thief/) (EZSP-based Zigbee USB stick required)
|
||||
|
||||
### ZHA Start up issue with Home-Assistant Docker/Hass.io installs on linux hosts
|
||||
### ZHA Start up issue with Home Assistant Docker/Hass.io installs on linux hosts
|
||||
|
||||
On Linux hosts ZHA can fail to start during HA startup or restarts because the Zigbee USB device is being claimed by the host's modemmanager service. To fix this disable the modemmanger on the host system.
|
||||
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user