Extends textlint Terminology list; part 3 (#12069)

* Extends textlint Terminology list; part 3

* Fix apcupsd
This commit is contained in:
Franck Nijhof 2020-02-12 22:24:59 +01:00 committed by GitHub
parent f0d37f49db
commit bbdefa833e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
35 changed files with 145 additions and 95 deletions

View File

@ -9,6 +9,8 @@
"skip": ["Blockquote"],
"terms": [
" API ",
"ABB Solar PV",
"ABB",
"Abode",
"Acer",
"Actiontec",
@ -32,23 +34,55 @@
"Ambiclimate",
"Ambient Weather Station",
"Amcrest",
"Ampio Smart Smog System",
"Android IP Webcam",
"Android",
"Ankuoo REC Switch",
"Ankuoo",
"Antifurto365",
"Apache Kafka",
"Apache",
"APC Smart UPS",
"apcupsd",
"APNS",
"Apple iCloud",
"Apple TV",
"AppleScript",
"Apprise",
"AquaLogic",
"aREST",
"Arlo",
"Aruba",
"Arube ClearPass",
"ASUS",
"ASUS",
"ASUSWRT",
"ATEN",
"Atome",
"August",
"Avi-on",
"AVM FRITZ!Box",
"AWS",
"Axis",
"Beckhoff",
"BSSID",
"Cisco IOS",
"Dark Sky",
"deCONZ",
"DNS",
"Docker Hub",
"Docker",
"ecobee",
"Elgato Key Light",
"Elgato",
"Emoncms",
"Entur",
"ESPHome",
"Everspring",
"FFmpeg",
"Fibaro",
"FreeNAS",
"FRITZ!Box",
"GitHub",
"Google Assistant",
"Google Home",
@ -71,16 +105,26 @@
"iOS",
"IoT",
"IP",
"iTunes",
"JSON",
"Kafka",
"KEF",
"Let's Encrypt",
"Life360",
"Linky",
"Lovelace",
"macOS",
"Microsoft",
"MikroTik",
"MJPEG",
"MQTT",
"NAS",
"Network Information Server",
"NGINX",
"NodeMCU",
"Norway",
"OpenWrt",
"PDU",
"Philips",
"Plex Media Server",
"Plex",
@ -88,15 +132,18 @@
"REST API",
"RFXtrx",
"RouterOS",
"RTSP",
"Samung",
"Sentry",
"Signal Messenger",
"SmartThings",
"Sonos",
"Spotify",
"SSID",
"SSL",
"Stookalert",
"Sure Petcare",
"Synology",
"Tahoma",
"TCP/IP",
"TMB",
@ -104,6 +151,8 @@
"Twitter",
"UART",
"UI",
"unRAID",
"UPS",
"URL",
"Velbus",
"Vera",
@ -121,6 +170,7 @@
["Alarm ?dot ?com", "Alarm.com"],
["an URL", "a URL"],
["API[']?s", "APIs"],
["FRITZ!? ?Box", "FRITZ!Box"],
["hass", "Home Assistant"],
["Home-?Ass?s?iss?tt?ant", "Home Assistant"],
["Mac ?OS", "macOS"],

View File

@ -6,7 +6,7 @@ redirect_from: /getting-started/autostart-synology/
To get Home Assistant to automatically start when you boot your Synology NAS:
SSH into your synology & login as admin or root
SSH into your Synology & login as admin or root
```bash
$ cd /volume1/homeassistant
@ -32,13 +32,13 @@ exec /bin/sh /volume1/homeassistant/hass-daemon start
Register the autostart
```bash
$ ln -s homeassistant.conf /etc/init/homeassistant.conf
ln -s homeassistant.conf /etc/init/homeassistant.conf
```
Make the relevant files executable:
```bash
$ chmod -r 777 /etc/init/homeassistant.conf
chmod -r 777 /etc/init/homeassistant.conf
```
That's it - reboot your NAS and Home Assistant should automatically start

View File

@ -7,7 +7,7 @@ redirect_from: /ecosystem/appdaemon/updating/
To update AppDaemon after I have released new code, just run the following command to update your copy:
```bash
$ sudo pip3 install --upgrade appdaemon
sudo pip3 install --upgrade appdaemon
```
If you are using docker, rerun the steps to grab the latest docker image.
If you are using Docker, rerun the steps to grab the latest Docker image.

View File

@ -10,8 +10,7 @@ Using NGINX as a proxy for Home Assistant allows you to serve Home Assistant sec
Chances are, you have a dynamic IP address (your ISP changes your address periodically). If this is true, you can use a Dynamic DNS service to obtain a domain and set it up to update with you IP. If you purchase your own domain name, you will be able to easily get a trusted SSL certificate later.
### 2 Install nginx on your server
### 2 Install NGINX on your server
This will vary depending on your OS. Check out Google for this. After installing, ensure that NGINX is not running.
@ -24,7 +23,8 @@ You will at least need nginx >= 1.3.13, as WebSocket support is required for the
There are two ways of obtaining an SSL certificate.
#### Using Let's Encrypt
If you purchased your own domain, you can use https://letsencrypt.org/ to obtain a free, publicly trusted SSL certificate. This will allow you to work with services like IFTTT. Download and install per the instructions online and get a certificate using the following command.
If you purchased your own domain, you can use <https://letsencrypt.org> to obtain a free, publicly trusted SSL certificate. This will allow you to work with services like IFTTT. Download and install per the instructions online and get a certificate using the following command.
```bash
$ sudo ./letsencrypt-auto certonly --standalone -d example.com -d www.example.com
@ -53,7 +53,7 @@ cd /etc/nginx/ssl
sudo openssl dhparam -out dhparams.pem 2048
```
### 5. Install configuration file in nginx.
### 5. Install configuration file in NGINX
Create a new file `/etc/nginx/sites-available/hass` and copy the configuration file at the bottom of the page into it.
@ -63,7 +63,7 @@ Some Linux distributions (including CentOS and Fedora) will not have the `/etc/n
</div>
### 6. Enable the Home Assistant configuration.
### 6. Enable the Home Assistant configuration
```bash
cd /etc/nginx/sites-enabled
@ -71,11 +71,11 @@ sudo unlink default
sudo ln ../sites-available/hass default
```
### 7. Start NGINX.
### 7. Start NGINX
Double check this configuration to ensure all settings are correct and start nginx.
Double check this configuration to ensure all settings are correct and start NGINX.
### 8. Port forwarding.
### 8. Port forwarding
Forward ports 443 and 80 to your server on your router. Do not forward port 8123.

View File

@ -30,7 +30,7 @@ docker run --init -d --name="home-assistant" -e "TZ=America/New_York" -v /home/p
When using `docker-ce` (or `boot2docker`) on macOS, you are unable to map the local timezone to your Docker container ([Docker issue](https://github.com/docker/for-mac/issues/44)). Instead of `-v /etc/localtime:/etc/localtime:ro`, just pass in the timezone environment variable when you launch the container, e.g, `-e "TZ=America/Los_Angeles"`. Replace "America/Los_Angeles" with [your timezone](http://en.wikipedia.org/wiki/List_of_tz_database_time_zones).
If you wish to browse directly to `http://localhost:8123` from your macOS host, meaning forward ports directly to the container, replace the `--net=host` switch with `-p 8123:8123`. More detail can be found in [the docker forums](https://forums.docker.com/t/should-docker-run-net-host-work/14215/10).
If you wish to browse directly to `http://localhost:8123` from your macOS host, meaning forward ports directly to the container, replace the `--net=host` switch with `-p 8123:8123`. More detail can be found in [the Docker forums](https://forums.docker.com/t/should-docker-run-net-host-work/14215/10).
```bash
docker run --init -d --name="home-assistant" -e "TZ=America/Los_Angeles" -v /PATH_TO_YOUR_CONFIG:/config -p 8123:8123 homeassistant/home-assistant:stable
@ -42,7 +42,7 @@ Alternatively, `docker-compose` works with any recent release of `docker-ce` on
Docker containers are completely isolated from its Windows host system. So when you delete a container, all the changes you made to that container are also removed. If you want to have configuration files or other assets remain persistent, try mounting Windows folders on containers.
Before proceeding, make sure you have shared out a drive for docker to mount to. This will allow the saving of config files to persist on the local machine rather than in the docker container (which may be destroyed when upgraded).
Before proceeding, make sure you have shared out a drive for Docker to mount to. This will allow the saving of config files to persist on the local machine rather than in the Docker container (which may be destroyed when upgraded).
<https://docs.docker.com/docker-for-windows/#shared-drives>
<https://docs.docker.com/docker-for-windows/troubleshoot/#verify-domain-user-has-permissions-for-shared-drives-volumes>
@ -64,11 +64,11 @@ netsh interface portproxy add v4tov4 listenaddress=192.168.1.10 listenport=8123
netsh interface portproxy add v4tov4 listenaddress=0.0.0.0 listenport=8123 connectaddress=10.0.50.2 connectport=8123
```
This will let you access your Home Assistant portal from `http://localhost:8123`, and if you forward port 8123 on your router to your machine IP, the traffic will be forwarded on through to the docker container.
This will let you access your Home Assistant portal from `http://localhost:8123`, and if you forward port 8123 on your router to your machine IP, the traffic will be forwarded on through to the Docker container.
### Synology NAS
As Synology within DSM now supports Docker (with a neat UI), you can simply install Home Assistant using docker without the need for command-line. For details about the package (including compatibility-information, if your NAS is supported), see <https://www.synology.com/en-us/dsm/packages/Docker>
As Synology within DSM now supports Docker (with a neat UI), you can simply install Home Assistant using Docker without the need for command-line. For details about the package (including compatibility-information, if your NAS is supported), see <https://www.synology.com/en-us/dsm/packages/Docker>
The steps would be:
@ -131,13 +131,13 @@ If you want to use a USB Bluetooth adapter or Z-Wave USB Stick with Home Assista
### QNAP NAS
As QNAP within QTS now supports Docker (with a neat UI), you can simply install Home Assistant using docker without the need for command-line. For details about the package (including compatibility-information, if your NAS is supported), see <https://www.qnap.com/solution/container_station/en/index.php>
As QNAP within QTS now supports Docker (with a neat UI), you can simply install Home Assistant using Docker without the need for command-line. For details about the package (including compatibility-information, if your NAS is supported), see <https://www.qnap.com/solution/container_station/en/index.php>
The steps would be:
- Install "Container Station" package on your Qnap NAS
- Launch Container Station and move to "Create Container"-section
- Search image "homeassistant/home-assistant" with Docker hub and click on "Install"
- Search image "homeassistant/home-assistant" with Docker Hub and click on "Install"
Make attention to CPU architecture of your NAS. For ARM CPU types the correct image is "homeassistant/armhf-homeassistant"
- Choose "latest" version and click next
- Choose a container-name you want (e.g., "homeassistant")
@ -156,7 +156,7 @@ If you want to use a USB Bluetooth adapter or Z-Wave USB stick with Home Assista
#### Z-Wave
- Connect to your NAS over SSH
- Load cdc-acm kernel module(when nas restart need to run this command)
- Load cdc-acm kernel module(when NAS restart need to run this command)
`insmod /usr/local/modules/cdc-acm.ko`
- Find USB devices attached. Type command:
`ls /dev/tty*`
@ -202,7 +202,7 @@ If you change the configuration you have to restart the server. To do that you h
## Docker Compose
As the docker command becomes more complex, switching to `docker-compose` can be preferable and support automatically restarting on failure or system restart. Create a `docker-compose.yml` file:
As the Docker command becomes more complex, switching to `docker-compose` can be preferable and support automatically restarting on failure or system restart. Create a `docker-compose.yml` file:
```yaml
version: '3'
@ -232,7 +232,7 @@ docker-compose restart
## Exposing Devices
In order to use Z-Wave, Zigbee or other integrations that require access to devices, you need to map the appropriate device into the container. Ensure the user that is running the container has the correct privileges to access the `/dev/tty*` file, then add the device mapping to your docker command:
In order to use Z-Wave, Zigbee or other integrations that require access to devices, you need to map the appropriate device into the container. Ensure the user that is running the container has the correct privileges to access the `/dev/tty*` file, then add the device mapping to your Docker command:
```bash
$ docker run --init -d --name="home-assistant" -v /PATH_TO_YOUR_CONFIG:/config \

View File

@ -35,7 +35,7 @@ Using the Synology webadmin:
- 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
SSH onto your Synology & login as admin or root
- Log in with your own administrator account
- Switch to root using:

View File

@ -164,7 +164,7 @@ android_ip_webcam:
## Binary Sensor
The `android_ip_webcam` binary sensor platform lets you observe the motion state of [Android IP webcam](https://play.google.com/store/apps/details?id=com.pas.webcam) sensors through Home Assistant. Devices will be configured automatically.
The `android_ip_webcam` binary sensor platform lets you observe the motion state of [Android IP Webcam](https://play.google.com/store/apps/details?id=com.pas.webcam) sensors through Home Assistant. Devices will be configured automatically.
## Examples
@ -200,6 +200,6 @@ camera:
## Sensor
The `android_ip_webcam` sensor platform lets you observe states of [Android IP webcam](https://play.google.com/store/apps/details?id=com.pas.webcam) sensors through Home Assistant. Devices will be configured automatically.
The `android_ip_webcam` sensor platform lets you observe states of [Android IP Webcam](https://play.google.com/store/apps/details?id=com.pas.webcam) sensors through Home Assistant. Devices will be configured automatically.
You can setup your own sensors by examining the JSON file from the webcam server: `http://IP:8080/sensors.json`

View File

@ -10,7 +10,7 @@ ha_release: 0.13
ha_iot_class: Local Polling
---
[APCUPSd](http://www.apcupsd.org/) status information can be integrated into Home Assistant when the Network Information Server (NIS) [is configured](http://www.apcupsd.org/manual/manual.html#nis-server-client-configuration-using-the-net-driver) on the APC device.
[Apcupsd](http://www.apcupsd.org/) status information can be integrated into Home Assistant when the Network Information Server (NIS) [is configured](http://www.apcupsd.org/manual/manual.html#nis-server-client-configuration-using-the-net-driver) on the APC device.
There is currently support for the following device types within Home Assistant:
@ -34,12 +34,12 @@ apcupsd:
{% configuration %}
host:
description: The hostname/IP address on which the APCUPSd NIS is being served.
description: The hostname/IP address on which the apcupsd NIS is being served.
required: false
type: string
default: localhost
port:
description: The port on which the APCUPSd NIS is listening.
description: The port on which the apcupsd NIS is listening.
required: false
type: integer
default: 3551
@ -47,13 +47,13 @@ port:
<div class='note'>
If you get `ConnectionRefusedError: Connection refused` errors in the Home Assistant logs, ensure the [APCUPSd](http://www.apcupsd.org/) configuration directives used by its Network Information Server is set to permit connections from all addresses [NISIP 0.0.0.0](http://www.apcupsd.org/manual/manual.html#configuration-directives-used-by-the-network-information-server), else non-local addesses will not connect. This includes Hass.io running in Docker, even when hosted on the same machine or a virtual machine.
If you get `ConnectionRefusedError: Connection refused` errors in the Home Assistant logs, ensure the [Apcupsd](http://www.apcupsd.org/) configuration directives used by its Network Information Server is set to permit connections from all addresses [NISIP 0.0.0.0](http://www.apcupsd.org/manual/manual.html#configuration-directives-used-by-the-network-information-server), else non-local addesses will not connect. This includes Hass.io running in Docker, even when hosted on the same machine or a virtual machine.
</div>
## Binary sensor
In addition to the [APCUPSd Sensor](#sensor) devices, you may also create a device which is simply "on" when the UPS status is online and "off" at all other times.
In addition to the [Apcupsd Sensor](#sensor) devices, you may also create a device which is simply "on" when the UPS status is online and "off" at all other times.
### Configuration

View File

@ -11,7 +11,7 @@ This platform allows you to detect presence by looking at connected devices to a
Supported devices (tested):
- ARUBA AP-105
- Aruba AP-105
<div class='note warning'>
This device tracker needs telnet to be enabled on the router.

View File

@ -1,6 +1,6 @@
---
title: Asuswrt
description: Instructions on how to integrate Asuswrt into Home Assistant.
title: ASUSWRT
description: Instructions on how to integrate ASUSWRT into Home Assistant.
logo: asus.png
ha_category:
- Hub
@ -16,8 +16,8 @@ The `asuswrt` integration is the main integration to connect to a [ASUSWRT](http
There is currently support for the following device types within Home Assistant:
- **Presence Detection** - The asuswrt platform offers presence detection by looking at connected devices to a ASUSWRT based router.
- **Sensor** - The asuswrt sensor platform allows you to get upload and download data from your ASUSWRT within Home Assistant.
- **Presence Detection** - The ASUSWRT platform offers presence detection by looking at connected devices to a ASUSWRT based router.
- **Sensor** - The ASUSWRT sensor platform allows you to get upload and download data from your ASUSWRT within Home Assistant.
## Configuration

View File

@ -7,7 +7,7 @@ ha_release: 0.39
logo: noaa.png
---
The `aurora` platform uses the [NOAA aurora forecast](https://www.swpc.noaa.gov/products/aurora-30-minute-forecast) service to let you know if an aurora might be visible at your home location in the next 30 minutes, based off of current solar flare activity.
The `aurora` platform uses the [NOAA Aurora Forecast](https://www.swpc.noaa.gov/products/aurora-30-minute-forecast) service to let you know if an aurora might be visible at your home location in the next 30 minutes, based off of current solar flare activity.
This service gives a number 0-100 representing the current likelihood of visible auroras at your latitude/longitude. By default this sensor is set up to trigger when the reported likelihood for your location is > 75. It updates every 5 minutes.

View File

@ -8,7 +8,7 @@ logo: avi-on.png
ha_release: 0.37
---
Support for the Avi-on Bluetooth dimmer switch [Avi-On](https://avi-on.com/).
Support for the Avi-on Bluetooth dimmer switch [Avi-on](https://avi-on.com/).
## Setup
@ -76,7 +76,7 @@ light:
api_key: YOUR_API_KEY
```
For independent control of multiple devices, you must specify each device's ID (integer starting with 1). Each switch's ID can be guessed or detected from the Avi-On API.
For independent control of multiple devices, you must specify each device's ID (integer starting with 1). Each switch's ID can be guessed or detected from the Avi-on API.
```yaml
# Manual device configuration.yaml entry

View File

@ -42,7 +42,7 @@ name:
required: false
type: string
callback_url_override:
description: Override the advertised callback URL. In case the Home Assistant instance is not directly reachable (e.g., running in a docker container without bridged-networking), advertise this callback URL for events.
description: Override the advertised callback URL. In case the Home Assistant instance is not directly reachable (e.g., running in a Docker container without bridged-networking), advertise this callback URL for events.
required: false
type: string
{% endconfiguration %}

View File

@ -11,7 +11,7 @@ The `doods` image processing platform allows you to detect and recognize objects
## Setup
You need to have DOODS running somewhere. It's easiest to run as a docker container and deployment is described on docker hub
You need to have DOODS running somewhere. It's easiest to run as a Docker container and deployment is described on Docker Hub
[DOODS - Docker](https://hub.docker.com/r/snowzach/doods)
## Configuration

View File

@ -35,9 +35,9 @@ sensor:
## Default naming scheme
The names of the sensors created by this integration will use the feed names defined in EmonCMS if available,
or the feed ID otherwise, and will be prefixed with "EmonCMS", e.g., "EmonCMS Total Power" or "EmonCMS Feed 5".
If the `id` property is anything but `1`, the ID will be shown as well, e.g., "EmonCMS 2 Feed 5".
The names of the sensors created by this integration will use the feed names defined in Emoncms if available,
or the feed ID otherwise, and will be prefixed with "Emoncms", e.g., "Emoncms Total Power" or "Emoncms Feed 5".
If the `id` property is anything but `1`, the ID will be shown as well, e.g., "Emoncms 2 Feed 5".
If `sensor_names` is used, any feeds with defined names will get those names exactly, with no prefix.

View File

@ -54,11 +54,11 @@ For most setups, you can follow [this tutorial](/cookbook/fail2ban/) to set up `
<div class='note'>
These steps assume you already have the Home Assistant docker running behind NGINX and that it is externally accessible. It also assumes the docker is running with the `--net='host'` flag.
These steps assume you already have the Home Assistant Docker running behind NGINX and that it is externally accessible. It also assumes the Docker is running with the `--net='host'` flag.
</div>
For those of us using Docker, the above tutorial may not be sufficient. The following steps specifically outline how to set up `fail2ban` and Home Assistant when running Home Assistant within a Docker behind NGINX. The setup this was tested on was an unRAID server using the [let's encrypt docker](https://github.com/linuxserver/docker-letsencrypt) from linuxserver.io.
For those of us using Docker, the above tutorial may not be sufficient. The following steps specifically outline how to set up `fail2ban` and Home Assistant when running Home Assistant within a Docker behind NGINX. The setup this was tested on was an unRAID server using the [Let's Encrypt Docker](https://github.com/linuxserver/docker-letsencrypt) from linuxserver.io.
#### Set HTTP logger
@ -72,7 +72,7 @@ logger:
#### Edit the `jail.local` file
Next, we need to edit the `jail.local` file that is included with the Let's Encrypt docker linked above. Note, for this tutorial, we'll only be implementing the `[hass-iptables]` jail from the [previously linked tutorial](/cookbook/fail2ban/).
Next, we need to edit the `jail.local` file that is included with the Let's Encrypt Docker linked above. Note, for this tutorial, we'll only be implementing the `[hass-iptables]` jail from the [previously linked tutorial](/cookbook/fail2ban/).
Edit `/mnt/user/appdata/letsencrypt/fail2ban/jail.local` and append the following to the end of the file:
@ -123,7 +123,7 @@ Now do the same for the Home Assistant docker, but this time we'll be mapping th
By default, the IP address that Home Assistant sees will be that of the container (something like `172.17.0.16`). What this means is that for any failed login attempt, assuming you have correctly configured `fail2ban`, the Docker IP will be logged as banned, but the originating IP is still allowed to make attempts. We need `fail2ban` to recognize the originating IP to properly ban it.
First, we have to add the following to the nginx configuration file located in `/mnt/user/appdata/letsencrypt/nginx/site-confs/default`.
First, we have to add the following to the NGINX configuration file located in `/mnt/user/appdata/letsencrypt/nginx/site-confs/default`.
```bash
proxy_set_header X-Real-IP $remote_addr;
@ -158,7 +158,7 @@ server {
}
```
Once that's added to the nginx configuration, we need to modify the Home Assistant `configuration.yaml` such that the `X-Forwarded-For` header can be parsed. This is done by adding the following to the `http` component:
Once that's added to the NGINX configuration, we need to modify the Home Assistant `configuration.yaml` such that the `X-Forwarded-For` header can be parsed. This is done by adding the following to the `http` component:
```yaml
http:

View File

@ -1,5 +1,5 @@
---
title: AVM Fritzbox
title: AVM FRITZ!Box
description: Instructions on how to integrate AVM FRITZ!Box based routers into Home Assistant.
logo: avm.png
ha_category:
@ -7,11 +7,11 @@ ha_category:
ha_release: '0.10'
---
The `fritz` platform offers presence detection by looking at connected devices to a [AVM Fritz!Box](https://avm.de/produkte/fritzbox/) based router.
The `fritz` platform offers presence detection by looking at connected devices to a [AVM FRITZ!Box](https://avm.de/produkte/fritzbox/) based router.
## Configuration
To use an Fritz!Box router in your installation, add the following to your `configuration.yaml` file:
To use an FRITZ!Box router in your installation, add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
@ -21,7 +21,7 @@ device_tracker:
{% configuration %}
host:
description: The IP address of your router, e.g., `192.168.1.1`. It is optional since every fritzbox is also reachable by using the IP address 169.254.1.1.
description: The IP address of your router, e.g., `192.168.1.1`. It is optional since every FRITZ!Box is also reachable by using the IP address 169.254.1.1.
required: false
type: string
username:
@ -35,7 +35,7 @@ password:
{% endconfiguration %}
<div class='note'>
It seems that it is not necessary to use the password in current generation Fritz!Box routers because the necessary data can be retrieved anonymously.
It seems that it is not necessary to use the password in current generation FRITZ!Box routers because the necessary data can be retrieved anonymously.
</div>
See the [device tracker integration page](/integrations/device_tracker/) for instructions how to configure the people to be tracked.

View File

@ -11,7 +11,7 @@ ha_release: 0.68
ha_iot_class: Local Polling
---
The [AVM](https://en.avm.de) Fritzbox integration for Home Assistant allows you to integrate the switch and climate devices.
The [AVM](https://en.avm.de) FRITZ!Box integration for Home Assistant allows you to integrate the switch and climate devices.
There is currently support for the following device types within Home Assistant:
@ -42,12 +42,12 @@ fritzbox:
{% configuration %}
devices:
description: A list of Fritzbox devices.
description: A list of FRITZ!Box devices.
required: true
type: map
keys:
host:
description: The hostname or IP address of the Fritzbox.
description: The hostname or IP address of the FRITZ!Box.
required: true
type: string
username:
@ -62,7 +62,7 @@ devices:
## Switch & Thermostat
To get AVM Fritzbox switch and thermostat follow the instructions above.
To get AVM FRITZ!Box switch and thermostat follow the instructions above.
### Attributes
@ -71,7 +71,7 @@ There are several attributes that can be useful for automations and templates.
| Attribute | Description |
| --------- | ----------- |
| `device_locked` | The state of the key lock at the device.
| `locked` | The state of the lock for configuring the device via the app or the Fritzbox web interface.
| `locked` | The state of the lock for configuring the device via the app or the FRITZ!Box web interface.
| `low_battery` | The low battery state indication.
| `battery_level` | The battery level (only available since Fritz!OS 7).
| `holiday_mode` | The state of the holiday mode (only available since Fritz!OS 7).
@ -84,7 +84,7 @@ There are several attributes that can be useful for automations and templates.
## Sensor
To get AVM Fritzbox temperature sensor (e.g. FRITZ!DECT Repeater 100) follow the instructions for the [Fritzbox component](#setup).
To get AVM FRITZ!Box temperature sensor (e.g. FRITZ!DECT Repeater 100) follow the instructions for the [FRITZ!Box integration](#setup).
### Attributes
@ -93,6 +93,6 @@ There are several attributes that can be useful for automations and templates.
| Attribute | Description |
| --------- | ----------- |
| `device_locked` | The state of the key lock at the device.
| `locked` | The state of the lock for configuring the device via the app or the Fritzbox web interface.
| `locked` | The state of the lock for configuring the device via the app or the FRITZ!Box web interface.
| `temperature_unit` | The unit of the temperature sensor.
| `temperature` | The current temperature sensor reading.

View File

@ -8,16 +8,16 @@ ha_release: 0.27
ha_iot_class: Local Polling
---
The `fritzbox_callmonitor` sensor monitors the call monitor exposed by [AVM Fritz!Box](https://avm.de/produkte/fritzbox/) routers on TCP port 1012. It will assume the values `idle`, `ringing`, `dialing` or `talking` with the phone numbers involved contained in the state attributes.
The `fritzbox_callmonitor` sensor monitors the call monitor exposed by [AVM FRITZ!Box](https://avm.de/produkte/fritzbox/) routers on TCP port 1012. It will assume the values `idle`, `ringing`, `dialing` or `talking` with the phone numbers involved contained in the state attributes.
It can also access the internal phone book of the router to look up the names corresponding to the phone numbers and store them in the state attributes.
## Setup
To activate the call monitor on your Fritz!Box, dial #96\*5\* from any phone connected to it.
To activate the call monitor on your FRITZ!Box, dial #96\*5\* from any phone connected to it.
## Configuration
To use the Fritz!Box call monitor in your installation, add the following to your `configuration.yaml` file:
To use the FRITZ!Box call monitor in your installation, add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
@ -42,11 +42,11 @@ port:
default: 1012
type: integer
username:
description: Fritz!Box user's user name. This is required to use the phone book lookup feature. The user needs to have the "voice message, fax message, Fritz!App Fon and call list" permission.
description: FRITZ!Box user's user name. This is required to use the phone book lookup feature. The user needs to have the "voice message, fax message, Fritz!App Fon and call list" permission.
required: false
type: string
password:
description: Fritz!Box user's user password. This is required to use the phone book lookup feature.
description: FRITZ!Box user's user password. This is required to use the phone book lookup feature.
required: false
type: string
phonebook:

View File

@ -8,9 +8,9 @@ ha_release: 0.36
ha_iot_class: Local Polling
---
The `fritzbox_netmonitor` sensor monitors the network statistics exposed by [AVM Fritz!Box](https://avm.de/produkte/fritzbox/) routers.
The `fritzbox_netmonitor` sensor monitors the network statistics exposed by [AVM FRITZ!Box](https://avm.de/produkte/fritzbox/) routers.
To use the Fritz!Box network monitor in your installation, add the following to your `configuration.yaml` file:
To use the FRITZ!Box network monitor in your installation, add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
@ -20,7 +20,7 @@ sensor:
{% configuration %}
host:
description: The IP address of your router, e.g., 192.168.1.1. It is optional since every fritzbox is also reachable by using the IP address 169.254.1.1.
description: The IP address of your router, e.g., 192.168.1.1. It is optional since every FRITZ!Box is also reachable by using the IP address 169.254.1.1.
required: false
default: 169.254.1.1
type: string
@ -35,8 +35,8 @@ The following statistics will be exposed as attributes.
|Attribute |Description |
|:----------------------|:------------------------------------------------------------|
|is_linked |True if the FritzBox is physically linked to the provider |
|is_connected |True if the FritzBox has established an internet-connection |
|is_linked |True if the FRITZ!Box is physically linked to the provider |
|is_connected |True if the FRITZ!Box has established an internet-connection |
|external_ip |External IP address |
|uptime |Uptime in seconds |
|bytes_sent |Bytes sent |
@ -49,5 +49,5 @@ The following statistics will be exposed as attributes.
The sensor's state corresponds to the `is_linked` attribute and is either `online`, `offline`, or `unavailable` (in case connection to the router is lost).
<div class='note info'>
This integration does not support "Fritz!Box 6490 Cable" with FritzOS 6.87 installed.
This integration does not support "FRITZ!Box 6490 Cable" with FritzOS 6.87 installed.
</div>

View File

@ -8,7 +8,7 @@ ha_iot_class: Local Polling
ha_release: 0.38
---
The `fritzdect` switch platform allows you to control the state of your [AVM FRITZ!DECT DECT-based wireless switches](https://en.avm.de/products/fritzdect/). The AVM FRITZ!DECT switches need to be paired to your Fritz!Box and then can be monitored and controlled via Home Assistant.
The `fritzdect` switch platform allows you to control the state of your [AVM FRITZ!DECT DECT-based wireless switches](https://en.avm.de/products/fritzdect/). The AVM FRITZ!DECT switches need to be paired to your FRITZ!Box and then can be monitored and controlled via Home Assistant.
Supported devices (tested):

View File

@ -437,7 +437,7 @@ Pairing works fine when the filter is set to only include `demo.demo`, but fails
#### Pairing hangs - no error
1. Make sure that you don't try to add more than 100 accessories, see [device limit](#device-limit). In rare cases, one of your entities doesn't work with the HomeKit component. Use the [filter](#configure-filter) to find out which one. Feel free to open a new issue in the `home-assistant` repo, so we can resolve it.
2. Check logs, and search for `Starting accessory Home Assistant Bridge on address`. Make sure Home Assistant Bridge hook ups to a correct interface. If it did not, explicitly set `homekit.ip_address` configuration variable.
2. Check logs, and search for `Starting accessory Home Assistant Bridge on address`. Make sure Home Assistant Bridge hook up to a correct interface. If it did not, explicitly set `homekit.ip_address` configuration variable.
#### Duplicate AID found when attempting to add accessory

View File

@ -313,7 +313,7 @@ You will receive an event named `html5_notification.closed` when the notificatio
If you use [NGINX](/ecosystem/nginx/) as a proxy with authentication in front of your Home Assistant instance, you may have trouble with receiving events back to Home Assistant. It's because of authentication token that cannot be passed through the proxy.
To solve the issue put additional location into your nginx site's configuration:
To solve the issue put additional location into your NGINX site's configuration:
```bash
location /api/notify.html5/callback {

View File

@ -98,7 +98,7 @@ scan_interval:
milliseconds: 0
```
You can find a list of public Iperf3 servers [here](https://iperf.fr/iperf-servers.php). You can also start your own Iperf3 server using the [mlabbe/iperf3's](https://hub.docker.com/r/mlabbe/iperf3/) docker image or just refer to your `iperf3` command's man page.
You can find a list of public Iperf3 servers [here](https://iperf.fr/iperf-servers.php). You can also start your own Iperf3 server using the [mlabbe/iperf3's](https://hub.docker.com/r/mlabbe/iperf3/) Docker image or just refer to your `iperf3` command's man page.
The frequency when the test will be automatically triggered can be adjusted by setting the value `scan_interval` in seconds.

View File

@ -26,7 +26,7 @@ This integration uses the [`discovery`](/integrations/discovery) component, whic
<div class='note info'>
Konnected devices communicate with Home Assistant over your local LAN -- there is no cloud component! For best performance we recommend allowing unsecured HTTP API traffic between Konnected devices and Home Assistant on your LAN. This means that you should not use the `http` integration to serve SSL/TLS certificates. Instead, use a proxy like Nginx or Caddy to serve SSL/TLS. [Read more.](https://help.konnected.io/support/solutions/articles/32000023964-set-up-hass-io-with-secure-remote-access-using-duckdns-and-nginx-proxy)
Konnected devices communicate with Home Assistant over your local LAN -- there is no cloud component! For best performance we recommend allowing unsecured HTTP API traffic between Konnected devices and Home Assistant on your LAN. This means that you should not use the `http` integration to serve SSL/TLS certificates. Instead, use a proxy like NGINX or Caddy to serve SSL/TLS. [Read more.](https://help.konnected.io/support/solutions/articles/32000023964-set-up-hass-io-with-secure-remote-access-using-duckdns-and-nginx-proxy)
</div>

View File

@ -10,9 +10,9 @@ ha_codeowners:
- '@mzdrale'
---
_This is one of multiple ways we support OpenWRT. For an overview, see [openwrt](/integrations/openwrt/)._
_This is one of multiple ways we support OpenWrt. For an overview, see [OpenWrt](/integrations/openwrt/)._
This is a presence detection scanner for OpenWRT using [luci](https://openwrt.org/docs/techref/luci).
This is a presence detection scanner for OpenWrt using [luci](https://openwrt.org/docs/techref/luci).
Before this scanner can be used you have to install the luci RPC package on OpenWRT:
@ -58,11 +58,11 @@ verify_ssl:
See the [device tracker integration page](/integrations/device_tracker/) for instructions how to configure the people to be tracked.
This device tracker provides a number of additional attributes for each tracked device (if it is at home): `flags`, `ip`, `device`, and `host`. The first three attributes are taken from the ARP table returned by the luci RPC. The `host` attribute is taken from the platform configuration and can be used to distinguish in which router a device is logged in, if you are using multiple OpenWRT routers.
This device tracker provides a number of additional attributes for each tracked device (if it is at home): `flags`, `ip`, `device`, and `host`. The first three attributes are taken from the ARP table returned by the luci RPC. The `host` attribute is taken from the platform configuration and can be used to distinguish in which router a device is logged in, if you are using multiple OpenWrt routers.
<div class='note warning'>
Some installations have [a small bug](https://github.com/openwrt/luci/issues/576). The timeout for luci RPC calls is not set and this makes the call fail.
If you want to locally fix your OpenWRT installation, you can apply the change manually to `/usr/lib/lua/luci/controller/rpc.lua`, or simply set a fixed timeout. The default is 3600.
If you want to locally fix your OpenWrt installation, you can apply the change manually to `/usr/lib/lua/luci/controller/rpc.lua`, or simply set a fixed timeout. The default is 3600.
</div>

View File

@ -42,7 +42,7 @@ sensor:
default: 3493
type: integer
alias:
description: Name of the ups on the NUT server.
description: Name of the UPS on the NUT server.
required: false
default: Will default to the first UPS name listed.
type: string

View File

@ -1,13 +1,13 @@
---
title: "OpenWRT"
description: "Instructions on how to integrate OpenWRT routers into Home Assistant."
description: "Instructions on how to integrate OpenWrt routers into Home Assistant."
logo: openwrt.png
ha_category:
- Presence Detection
ha_release: pre 0.7
---
There are _multiple_ ways of integrating an OpenWRT router for presence detection. A broad distinction can be made between presence detection methods which actively scan for devices (by default every 12 seconds) and those that are notified by some external service on changes. It is essentially a problem of synchronizing states between two remote machines.
There are _multiple_ ways of integrating an OpenWrt router for presence detection. A broad distinction can be made between presence detection methods which actively scan for devices (by default every 12 seconds) and those that are notified by some external service on changes. It is essentially a problem of synchronizing states between two remote machines.
* __active scanning__
Scan for devices regularly.
@ -32,7 +32,7 @@ There are _multiple_ ways of integrating an OpenWRT router for presence detectio
### Event-based device tracker
This can be achieved by running a simple shell script on the OpenWRT router which calls the appropriate Home Assistant service. An OpenWRT package which does this is listed above. As this method directly calls the [service API](https://developers.home-assistant.io/docs/en/external_api_rest.html#post-api-services-lt-domain-lt-service), no special configuration is necessary on the Home Assistant side, except for ensuring the device_tracker API is running, which is achieved by adding the following to your `configuration.yaml` file:
This can be achieved by running a simple shell script on the OpenWrt router which calls the appropriate Home Assistant service. An OpenWrt package which does this is listed above. As this method directly calls the [service API](https://developers.home-assistant.io/docs/en/external_api_rest.html#post-api-services-lt-domain-lt-service), no special configuration is necessary on the Home Assistant side, except for ensuring the device_tracker API is running, which is achieved by adding the following to your `configuration.yaml` file:
```yaml
device_tracker:

View File

@ -155,7 +155,7 @@ Some installations of MariaDB/MySQL may require an ALTERNATE_PORT (3rd-party hos
<div class='note'>
If using an external MariaDB backend (e.g., running on a separate NAS) with Home Assistant, you should omit `pymysql` from the URL. `pymysql` is not included in the base docker image, and is not necessary for this to work.
If using an external MariaDB backend (e.g., running on a separate NAS) with Home Assistant, you should omit `pymysql` from the URL. `pymysql` is not included in the base Docker image, and is not necessary for this to work.
</div>

View File

@ -1,6 +1,6 @@
---
title: Ankuoo REC Switch
description: Instructions on how to integrate Ankuoo Rec Switch into Home Assistant.
description: Instructions on how to integrate Ankuoo REC Switch into Home Assistant.
logo: ankuoo_recswitch.png
ha_release: 0.81
ha_category:
@ -8,7 +8,7 @@ ha_category:
ha_iot_class: Local Polling
---
The `recswitch` switch platform allows you to control the Ankuoo Rec Switch devices.
The `recswitch` switch platform allows you to control the Ankuoo REC Switch devices.
Supported devices (tested):

View File

@ -59,10 +59,10 @@ sensors:
### Note
Inverter models with newer firmware (and also those using devices like PocketWifi) no longer expose an API when connected to your wireless network, they do however continue to expose it on their own broadcasted SSID. To use this sensor in this case it is necessary to set up a reverse proxy with something like Nginx and use a raspberry pi (or similar) with two network connections (one being wifi that connects to the inverters SSID).
Inverter models with newer firmware (and also those using devices like PocketWifi) no longer expose an API when connected to your wireless network, they do however continue to expose it on their own broadcasted SSID. To use this sensor in this case it is necessary to set up a reverse proxy with something like NGINX and use a raspberry pi (or similar) with two network connections (one being wifi that connects to the inverters SSID).
Example Nginx configuration
Example NGINX configuration
```text
location / {

View File

@ -81,7 +81,7 @@ You can also play HTTP (not HTTPS) URLs:
You can use TTS services like [Google Text-to-Speech](/integrations/google_translate) or [Amazon Polly](/integrations/amazon_polly) only if your Home Assistant is configured in HTTP and not HTTPS (current device limitation, a firmware upgrade is planned).
A workaround if you want to publish your Home Assistant installation on Internet in SSL is to configure an HTTPS Web Server as a reverse proxy ([nginx](/docs/ecosystem/nginx/) for example) and let your Home Assistant configuration in HTTP on your local network. The Soundtouch devices will be available to access the TTS files in HTTP in local and your configuration will be in HTTPS on the Internet.
A workaround if you want to publish your Home Assistant installation on Internet in SSL is to configure an HTTPS Web Server as a reverse proxy ([NGINX](/docs/ecosystem/nginx/) for example) and let your Home Assistant configuration in HTTP on your local network. The Soundtouch devices will be available to access the TTS files in HTTP in local and your configuration will be in HTTPS on the Internet.
### Service `play_everywhere`

View File

@ -7,9 +7,9 @@ ha_category:
ha_release: 0.7.6
---
_This is one of multiple ways we support OpenWRT. For an overview, see [openwrt](/integrations/openwrt)._
_This is one of multiple ways we support OpenWrt. For an overview, see [OpenWrt](/integrations/openwrt)._
This is a presence detection scanner for [OpenWRT](https://openwrt.org/) using [ubus](https://wiki.openwrt.org/doc/techref/ubus). It scans for changes in `hostapd.*`, which will detect and report changes in devices connected to the access point on the router.
This is a presence detection scanner for [OpenWrt](https://openwrt.org/) using [ubus](https://wiki.openwrt.org/doc/techref/ubus). It scans for changes in `hostapd.*`, which will detect and report changes in devices connected to the access point on the router.
Before this scanner can be used you have to install the ubus RPC package on OpenWRT:
@ -17,7 +17,7 @@ Before this scanner can be used you have to install the ubus RPC package on Open
opkg install rpcd-mod-file
```
For OpenWRT version 18.06.x the package uhttpd-mod-ubus should also be installed:
For OpenWrt version 18.06.x the package uhttpd-mod-ubus should also be installed:
```bash
opkg install uhttpd-mod-ubus

View File

@ -161,7 +161,7 @@ sudo apt-get purge modemmanager
### Can't connect to USB device and using Docker
If you are using Docker and can't connect, you most likely need to forward your device from the host machine to the Docker instance. This can be achieved by adding the device mapping to the end of the startup string or ideally using docker compose.
If you are using Docker and can't connect, you most likely need to forward your device from the host machine to the Docker instance. This can be achieved by adding the device mapping to the end of the startup string or ideally using Docker compose.
#### Docker Compose

View File

@ -141,7 +141,7 @@ You also need to have Docker-CE installed. There are well-documented procedures
Some distributions, like Ubuntu, have a `docker.io` package available. Using that package will cause issues!
Be sure to install the official Docker-CE from the above-listed URL.
Docker is not always ready with a release when a new Ubuntu version is out. Check if your version of Ubuntu is supported by docker [here](https://docs.docker.com/install/linux/docker-ce/ubuntu/).
Docker is not always ready with a release when a new Ubuntu version is out. Check if your version of Ubuntu is supported by Docker [here](https://docs.docker.com/install/linux/docker-ce/ubuntu/).
</div>