From 51436dcb2fad64ef24e2287af2cd0f09eb08b05f Mon Sep 17 00:00:00 2001 From: Franck Nijhof Date: Wed, 12 Feb 2020 22:50:56 +0100 Subject: [PATCH] Extends textlint Terminology list; part 4 --- .textlintrc.json | 48 +++ source/_docs/autostart/upstart.markdown | 4 +- source/_integrations/deconz.markdown | 2 +- source/_integrations/fan.xiaomi_miio.markdown | 362 +++++++++--------- source/_integrations/flux_led.markdown | 2 +- source/_integrations/lcn.markdown | 4 +- source/_integrations/light.mqtt.markdown | 2 +- source/_integrations/lirc.markdown | 2 +- source/_integrations/media_player.markdown | 4 +- source/_integrations/nad.markdown | 2 +- source/_integrations/picotts.markdown | 4 +- source/_integrations/plex.markdown | 2 +- source/_integrations/rpi_gpio_pwm.markdown | 2 +- source/_integrations/skybell.markdown | 22 +- source/_integrations/slack.markdown | 4 +- source/_integrations/streamlabswater.markdown | 6 +- .../_integrations/switch.xiaomi_miio.markdown | 4 +- source/_integrations/switchbot.markdown | 10 +- source/_integrations/twilio.markdown | 2 +- source/_integrations/unifi.markdown | 10 +- source/_integrations/unifi_direct.markdown | 8 +- source/_integrations/unifiled.markdown | 10 +- source/_integrations/uvc.markdown | 2 +- source/_integrations/versasense.markdown | 4 +- source/_integrations/vivotek.markdown | 6 +- source/_integrations/webostv.markdown | 2 +- source/_integrations/yamaha.markdown | 2 +- source/_integrations/yeelight.markdown | 2 +- source/_integrations/zha.markdown | 15 +- 29 files changed, 299 insertions(+), 250 deletions(-) diff --git a/.textlintrc.json b/.textlintrc.json index 9e4bd0562859..ac4efb6c32a4 100644 --- a/.textlintrc.json +++ b/.textlintrc.json @@ -65,9 +65,11 @@ "AWS", "Axis", "Beckhoff", + "Bravia", "BSSID", "Cisco IOS", "Dark Sky", + "Debian", "deCONZ", "DNS", "Docker Hub", @@ -105,13 +107,16 @@ "iOS", "IoT", "IP", + "ISY994", "iTunes", "JSON", "Kafka", "KEF", + "LED", "Let's Encrypt", "Life360", "Linky", + "Linux", "Lovelace", "macOS", "Microsoft", @@ -126,6 +131,7 @@ "OpenWrt", "PDU", "Philips", + "PlayStation", "Plex Media Server", "Plex", "PTZ", @@ -136,45 +142,87 @@ "Samung", "Sentry", "Signal Messenger", + "SkyBell", + "Slack", + "SleepIQ", "SmartThings", + "SMS", "Sonos", + "Sony", "Spotify", + "SQL", "SSID", "SSL", + "StarLine", "Stookalert", + "StreamLabs", + "STT", "Sure Petcare", + "SwitchBot", "Synology", "Tahoma", "TCP/IP", + "Tesla", "TMB", + "Todoist", + "Toon", + "TTS", + "Tuya", + "TV", + "Twilio", "TwinCAT", + "Twitch", "Twitter", "UART", + "Ubiquiti", + "Ubuntu", "UI", + "UniFi", "unRAID", "UPS", "URL", "Velbus", + "Velux", + "Venstar", "Vera", + "Verisure", + "VersaSense", + "ViCare", + "Viessmann", + "VIVOTEK", "Vizio", + "Vultr", "Wink", "WLED", + "Wunderlist", + "WWLLN", "Xiaomi", + "Yamaha MusicCast", + "Yamaha", "YAML", + "Yandex", "Yeelight", "YouTube", "Z-Wave", "ZHA", "Zigbee", + "Ziggo Mediabox XL", + "Ziggo", + "ZoneMinder", [" HA ", "Home Assistant"], ["Alarm ?dot ?com", "Alarm.com"], ["an URL", "a URL"], ["API['’]?s", "APIs"], + ["DarkSky", "Dark Sky"], ["FRITZ!? ?Box", "FRITZ!Box"], ["hass", "Home Assistant"], ["Home-?Ass?s?iss?tt?ant", "Home Assistant"], + ["ISY ?994", "ISY994"], ["Mac ?OS", "macOS"], ["OS ?X", "macOS"], + ["Sky Bell", "SkyBell"], + ["Sleep IQ", "SleepIQ"], + ["Twill?o", "Twilio"], ["URL['’]?s", "URLs"], ["ZWave", "Z-Wave"] ] diff --git a/source/_docs/autostart/upstart.markdown b/source/_docs/autostart/upstart.markdown index 5870aa065014..716c62fa628d 100644 --- a/source/_docs/autostart/upstart.markdown +++ b/source/_docs/autostart/upstart.markdown @@ -3,10 +3,10 @@ title: "Autostart using Upstart" description: "Instructions on how to setup Home Assistant to launch on boot using Upstart." --- -Many linux distributions use the Upstart system (or similar) for managing daemons. Typically, systems based on Debian 7 or previous use Upstart. This includes Ubuntu releases before 15.04. If you are unsure if your system is using Upstart, you may check with the following command: +Many Linux distributions use the Upstart system (or similar) for managing daemons. Typically, systems based on Debian 7 or previous use Upstart. This includes Ubuntu releases before 15.04. If you are unsure if your system is using Upstart, you may check with the following command: ```bash -$ ps -p 1 -o comm= +ps -p 1 -o comm= ``` If the preceding command returns the string `init`, you are likely using Upstart. diff --git a/source/_integrations/deconz.markdown b/source/_integrations/deconz.markdown index 6b0649c982cb..5a3b9a937add 100644 --- a/source/_integrations/deconz.markdown +++ b/source/_integrations/deconz.markdown @@ -444,7 +444,7 @@ The `entity_id` names will be `light.device_name`, where `device_name` is define - Philips Hue Hue White ambiance Milliskin (recessed spotlight) LTW013 - Philips Hue LightStrip Plus - Busch Jaeger Zigbee Light Link univ. relai (6711 U) with Zigbee Light Link control element 6735-84 -- Xiaomi Aqara Smart Led Bulb (white) E27 ZNLDP12LM +- Xiaomi Aqara Smart LED Bulb (white) E27 ZNLDP12LM ## Scene diff --git a/source/_integrations/fan.xiaomi_miio.markdown b/source/_integrations/fan.xiaomi_miio.markdown index 17bb3e5fd101..e161c5f590dc 100644 --- a/source/_integrations/fan.xiaomi_miio.markdown +++ b/source/_integrations/fan.xiaomi_miio.markdown @@ -44,30 +44,30 @@ Air Fresh VA2 | zhimi.airfresh.va2 | | - LED (on, off), LED brightness (bright, dim, off) - Favorite Level (0...16) - Attributes - - model - - temperature - - humidity - - aqi - - mode - - filter_hours_used - - filter_life_remaining - - favorite_level - - child_lock - - led - - motor_speed - - average_aqi - - purify_volume - - learn_mode - - sleep_time - - sleep_mode_learn_count - - extra_features - - turbo_mode_supported - - auto_detect - - use_time - - button_pressed - - buzzer - - led_brightness - - sleep_mode + - `model` + - `temperature` + - `humidity` + - `aqi` + - `mode` + - `filter_hours_used` + - `filter_life_remaining` + - `favorite_level` + - `child_lock` + - `led` + - `motor_speed` + - `average_aqi` + - `purify_volume` + - `learn_mode` + - `sleep_time` + - `sleep_mode_learn_count` + - `extra_features` + - `turbo_mode_supported` + - `auto_detect` + - `use_time` + - `button_pressed` + - `buzzer` + - `led_brightness` + - `sleep_mode` ### Air Purifier Pro (zhimi.airpurifier.v6) @@ -77,33 +77,33 @@ Air Fresh VA2 | zhimi.airfresh.va2 | | - LED (on, off) - Favorite Level (0...16) - Attributes - - model - - temperature - - humidity - - aqi - - mode - - filter_hours_used - - filter_life_remaining - - favorite_level - - child_lock - - led - - motor_speed - - average_aqi - - purify_volume - - learn_mode - - sleep_time - - sleep_mode_learn_count - - extra_features - - turbo_mode_supported - - auto_detect - - use_time - - button_pressed - - filter_rfid_product_id - - filter_rfid_tag - - filter_type - - illuminance - - motor2_speed - - volume + - `model` + - `temperature` + - `humidity` + - `aqi` + - `mode` + - `filter_hours_used` + - `filter_life_remaining` + - `favorite_level` + - `child_lock` + - `led` + - `motor_speed` + - `average_aqi` + - `purify_volume` + - `learn_mode` + - `sleep_time` + - `sleep_mode_learn_count` + - `extra_features` + - `turbo_mode_supported` + - `auto_detect` + - `use_time` + - `button_pressed` + - `filter_rfid_product_id` + - `filter_rfid_tag` + - `filter_type` + - `illuminance` + - `motor2_speed` + - `volume` ### Air Purifier Pro V7 (zhimi.airpurifier.v7) @@ -113,28 +113,28 @@ Air Fresh VA2 | zhimi.airfresh.va2 | | - LED (on, off) - Favorite Level (0...16) - Attributes - - model - - temperature - - humidity - - aqi - - mode - - filter_hours_used - - filter_life_remaining - - favorite_level - - child_lock - - led - - motor_speed - - average_aqi - - learn_mode - - extra_features - - turbo_mode_supported - - button_pressed - - filter_rfid_product_id - - filter_rfid_tag - - filter_type - - illuminance - - motor2_speed - - volume + - `model` + - `temperature` + - `humidity` + - `aqi` + - `mode` + - `filter_hours_used` + - `filter_life_remaining` + - `favorite_level` + - `child_lock` + - `led` + - `motor_speed` + - `average_aqi` + - `learn_mode` + - `extra_features` + - `turbo_mode_supported` + - `button_pressed` + - `filter_rfid_product_id` + - `filter_rfid_tag` + - `filter_type` + - `illuminance` + - `motor2_speed` + - `volume` ### Air Purifier 2S (zhimi.airpurifier.mc1) @@ -145,27 +145,27 @@ Air Fresh VA2 | zhimi.airfresh.va2 | | - LED (on, off) - Favorite Level (0...16) - Attributes - - model - - temperature - - humidity - - aqi - - mode - - filter_hours_used - - filter_life_remaining - - favorite_level - - child_lock - - led - - motor_speed - - average_aqi - - learn_mode - - extra_features - - turbo_mode_supported - - button_pressed - - filter_rfid_product_id - - filter_rfid_tag - - filter_type - - illuminance - - buzzer + - `model` + - `temperature` + - `humidity` + - `aqi` + - `mode` + - `filter_hours_used` + - `filter_life_remaining` + - `favorite_level` + - `child_lock` + - `led` + - `motor_speed` + - `average_aqi` + - `learn_mode` + - `extra_features` + - `turbo_mode_supported` + - `button_pressed` + - `filter_rfid_product_id` + - `filter_rfid_tag` + - `filter_type` + - `illuminance` + - `buzzer` ### Air Purifier V3 (zhimi.airpurifier.v3) @@ -174,30 +174,30 @@ Air Fresh VA2 | zhimi.airfresh.va2 | | - Child lock (on, off) - LED (on, off) - Attributes - - model - - aqi - - mode - - led - - buzzer - - child_lock - - illuminance - - filter_hours_used - - filter_life_remaining - - motor_speed - - average_aqi - - volume - - motor2_speed - - filter_rfid_product_id - - filter_rfid_tag - - filter_type - - purify_volume - - learn_mode - - sleep_time - - sleep_mode_learn_count - - extra_features - - auto_detect - - use_time - - button_pressed + - `model` + - `aqi` + - `mode` + - `led` + - `buzzer` + - `child_lock` + - `illuminance` + - `filter_hours_used` + - `filter_life_remaining` + - `motor_speed` + - `average_aqi` + - `volume` + - `motor2_speed` + - `filter_rfid_product_id` + - `filter_rfid_tag` + - `filter_type` + - `purify_volume` + - `learn_mode` + - `sleep_time` + - `sleep_mode_learn_count` + - `extra_features` + - `auto_detect` + - `use_time` + - `button_pressed` ### Air Humidifier (zhimi.humidifier.v1) @@ -208,18 +208,18 @@ Air Fresh VA2 | zhimi.airfresh.va2 | | - LED (on, off), LED brightness (bright, dim, off) - Target humidity (30, 40, 50, 60, 70, 80) - Attributes - - model - - temperature - - humidity - - mode - - buzzer - - child_lock - - trans_level - - target_humidity - - led_brightness - - button_pressed - - use_time - - hardware_version + - `model` + - `temperature` + - `humidity` + - `mode` + - `buzzer` + - `child_lock` + - `trans_level` + - `target_humidity` + - `led_brightness` + - `button_pressed` + - `use_time` + - `hardware_version` ### Air Humidifier CA (zhimi.humidifier.ca1) @@ -231,21 +231,21 @@ Air Fresh VA2 | zhimi.airfresh.va2 | | - Target humidity (30, 40, 50, 60, 70, 80) - Dry mode (on, off) - Attributes - - model - - temperature - - humidity - - mode - - buzzer - - child_lock - - trans_level - - target_humidity - - led_brightness - - button_pressed - - use_time - - hardware_version - - motor_speed - - depth - - dry + - `model` + - `temperature` + - `humidity` + - `mode` + - `buzzer` + - `child_lock` + - `trans_level` + - `target_humidity` + - `led_brightness` + - `button_pressed` + - `use_time` + - `hardware_version` + - `motor_speed` + - `depth` + - `dry` ### Air Humidifier CB (zhimi.humidifier.cb1) @@ -257,23 +257,23 @@ Air Fresh VA2 | zhimi.airfresh.va2 | | - Target humidity (30, 40, 50, 60, 70, 80) - Dry mode (on, off) - Attributes - - speed - - speed_list - - model - - temperature - - humidity - - mode - - buzzer - - child_lock - - target_humidity - - led_brightness - - use_time - - hardware_version - - motor_speed - - depth - - dry - - supported_features - + - `speed` + - `speed_list` + - `model` + - `temperature` + - `humidity` + - `mode` + - `buzzer` + - `child_lock` + - `target_humidity` + - `led_brightness` + - `use_time` + - `hardware_version` + - `motor_speed` + - `depth` + - `dry` + - `supported_features` + ### Air Fresh VA2 * Power (on, off) @@ -282,22 +282,22 @@ Air Fresh VA2 | zhimi.airfresh.va2 | | * Child lock (on, off) * LED (on, off), LED brightness (bright, dim, off) * Attributes - - model - - aqi - - average_aqi - - temperature - - humidity - - co2 - - mode - - led - - led_brightness - - buzzer - - child_lock - - filter_life_remaining - - filter_hours_used - - use_time - - motor_speed - - extra_features + - `model` + - `aqi` + - `average_aqi` + - `temperature` + - `humidity` + - `co2` + - `mode` + - `led` + - `led_brightness` + - `buzzer` + - `child_lock` + - `filter_life_remaining` + - `filter_hours_used` + - `use_time` + - `motor_speed` + - `extra_features` Please follow the instructions on [Retrieving the Access Token](/integrations/vacuum.xiaomi_miio/#retrieving-the-access-token) to get the API token to use in the `configuration.yaml` file. @@ -360,7 +360,7 @@ Turn the buzzer off. ### Service `xiaomi_miio.fan_set_led_on` (Air Purifiers only) -Turn the led on. +Turn the LED on. | Service data attribute | Optional | Description | |---------------------------|----------|---------------------------------------------------------| @@ -368,7 +368,7 @@ Turn the led on. ### Service `xiaomi_miio.fan_set_led_off` (Air Purifiers only) -Turn the led off. +Turn the LED off. | Service data attribute | Optional | Description | |---------------------------|----------|---------------------------------------------------------| @@ -392,7 +392,7 @@ Turn the child lock off. ### Service `xiaomi_miio.fan_set_led_brightness` (Air Purifier 2S and Air Purifier Pro excluded) -Set the led brightness. Supported values are 0 (Bright), 1 (Dim), 2 (Off). +Set the LED brightness. Supported values are 0 (Bright), 1 (Dim), 2 (Off). | Service data attribute | Optional | Description | |---------------------------|----------|---------------------------------------------------------| diff --git a/source/_integrations/flux_led.markdown b/source/_integrations/flux_led.markdown index 12d90b1a6503..0f633d44383b 100644 --- a/source/_integrations/flux_led.markdown +++ b/source/_integrations/flux_led.markdown @@ -158,7 +158,7 @@ light: ### Effects -The Flux Led light offers a number of effects which are not included in other lighting packages. These can be selected from the front-end, or sent in the effect field of the `light.turn_on` command. +The Flux LED light offers a number of effects which are not included in other lighting packages. These can be selected from the front-end, or sent in the effect field of the `light.turn_on` command. | Effect Name | Description | |--------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------| diff --git a/source/_integrations/lcn.markdown b/source/_integrations/lcn.markdown index de2f8d805b30..f3b81fb26da1 100644 --- a/source/_integrations/lcn.markdown +++ b/source/_integrations/lcn.markdown @@ -577,12 +577,12 @@ data: ### Service `led` -Set the led status. +Set the LED status. | Service data attribute | Optional | Description | Values | | ---------------------- | -------- | ----------- | ------ | | `address` | No | [LCN address](#lcn-addresses) | -| `state` | No | Led state as string | [LED_STATE](#states) | +| `state` | No | LED state as string | [LED_STATE](#states) | Example: diff --git a/source/_integrations/light.mqtt.markdown b/source/_integrations/light.mqtt.markdown index 04fd833be6fe..19053fb0baa6 100644 --- a/source/_integrations/light.mqtt.markdown +++ b/source/_integrations/light.mqtt.markdown @@ -650,7 +650,7 @@ light: - [AiLight](https://github.com/stelgenhof/AiLight) is a custom firmware for the Ai-Thinker (and equivalent) RGBW WiFi light bulbs that has an ESP8266 onboard and controlled by the MY9291 LED driver. It implements the [MQTT JSON light](/integrations/light.mqtt) platform and supports ON/OFF, RGBW colours, brightness, colour temperature, flashing and transitions. Also it includes [MQTT Auto Discovery](/docs/mqtt/discovery/)) and the MQTT Last Will and Testament is enabled as well. -- [h801-mqtt-json](https://github.com/starkillerOG/h801-mqtt-json) is a custom firmware for the H801 LED dimmer, a 5 channel (RGBWWCW) WiFi LED strip controller for 12V LED strips. The firmware is meant to control the 5 channels of the H801 to simultaneously control an RGB and a Warm-white/Cold-white Led strip such as a 5050 RGB LED strip and a 5025 Dual White strip. It implements the [MQTT JSON light](/integrations/light.mqtt) platform and supports ON/OFF, RGBW colours (RGB strip), brightness, color temperature (CW/WW strip) and transitions. +- [h801-mqtt-json](https://github.com/starkillerOG/h801-mqtt-json) is a custom firmware for the H801 LED dimmer, a 5 channel (RGBWWCW) WiFi LED strip controller for 12V LED strips. The firmware is meant to control the 5 channels of the H801 to simultaneously control an RGB and a Warm-white/Cold-white LED strip such as a 5050 RGB LED strip and a 5025 Dual White strip. It implements the [MQTT JSON light](/integrations/light.mqtt) platform and supports ON/OFF, RGBW colours (RGB strip), brightness, color temperature (CW/WW strip) and transitions. ## Template schema diff --git a/source/_integrations/lirc.markdown b/source/_integrations/lirc.markdown index ab39eb36de55..630f429501bc 100644 --- a/source/_integrations/lirc.markdown +++ b/source/_integrations/lirc.markdown @@ -22,7 +22,7 @@ sudo apt-get install lirc liblircclient-dev
-If you are configuring on a Raspberry Pi, there are excellent instructions with GPIO schematics and driver configurations [here](http://alexba.in/blog/2013/01/06/setting-up-lirc-on-the-raspberrypi/). Take notice, the instructions in this blog are valid for Raspian Jesse where lirc 0.9.0 was included in the debian package. In Raspian Stretch lirc 0.9.4 is included in the Debian package. +If you are configuring on a Raspberry Pi, there are excellent instructions with GPIO schematics and driver configurations [here](http://alexba.in/blog/2013/01/06/setting-up-lirc-on-the-raspberrypi/). Take notice, the instructions in this blog are valid for Raspian Jesse where lirc 0.9.0 was included in the Debian package. In Raspian Stretch lirc 0.9.4 is included in the Debian package. The configuration is slightly different : - The `hardware.conf` file is not supported, obsoleted by a new `lirc_options.conf` file and systemd unit definitions. diff --git a/source/_integrations/media_player.markdown b/source/_integrations/media_player.markdown index 2a4d30f80a54..8ea3e3c525c1 100644 --- a/source/_integrations/media_player.markdown +++ b/source/_integrations/media_player.markdown @@ -77,5 +77,5 @@ Currently only supported on [Sonos](/integrations/sonos), [Spotify](/integration The way media players are displayed in the frontend can be modified in the [customize section](/getting-started/customizing-devices/). The following device classes are supported for media players: -- **tv**: Device is a television type device. -- **speaker**: Device is speaker or stereo type device. +- `tv`: Device is a television type device. +- `speaker`: Device is speaker or stereo type device. diff --git a/source/_integrations/nad.markdown b/source/_integrations/nad.markdown index 14bc9d88d109..57e3a40da74f 100644 --- a/source/_integrations/nad.markdown +++ b/source/_integrations/nad.markdown @@ -76,7 +76,7 @@ The min_volume and max_volume are there to protect you against misclicks on the
-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 `. Be aware that the user might need to logout and logon again to activate these permissions. diff --git a/source/_integrations/picotts.markdown b/source/_integrations/picotts.markdown index a814c1f5ee53..20aa2b554e29 100644 --- a/source/_integrations/picotts.markdown +++ b/source/_integrations/picotts.markdown @@ -8,8 +8,8 @@ ha_release: 0.36 --- The `picotts` text-to-speech platform uses offline pico Text-to-Speech engine to read a text with natural sounding voices. -This requires to install the pico tts library on the system, typically on debian just do `sudo apt-get install libttspico-utils` -On some Raspbian release, this package is missing but you can just copy the arm deb package from debian. +This requires to install the pico TTS library on the system, typically on Debian just do `sudo apt-get install libttspico-utils` +On some Raspbian release, this package is missing but you can just copy the arm deb package from Debian. On Debian Buster, the package is missing, use the following commands to install it: diff --git a/source/_integrations/plex.markdown b/source/_integrations/plex.markdown index b9e255c9e5dd..c3264595d39c 100644 --- a/source/_integrations/plex.markdown +++ b/source/_integrations/plex.markdown @@ -22,7 +22,7 @@ There is currently support for the following device types within Home Assistant: If your Plex server has been claimed by a Plex account via the [claim interface](https://plex.tv/claim), Home Assistant will require authentication to connect. -The preferred way to enable the Plex integration is via **Configuration** -> **Integrations**. You will be redirected to the [plex.tv](https://plex.tv) website to sign in with your Plex account. Once access is granted, Home Assistant will connect to the server linked to the associated account. If multiple Plex servers are available on the account, you will be prompted to complete the configuration by selecting the desired server on the Integrations page. Home Assistant will show as an authorized device on the [Plex Web](https://app.plex.tv/web/app) interface under **Settings** -> **Authorized Devices**. +The preferred way to enable the Plex integration is via **Configuration** -> **Integrations**. You will be redirected to the [Plex](https://plex.tv) website to sign in with your Plex account. Once access is granted, Home Assistant will connect to the server linked to the associated account. If multiple Plex servers are available on the account, you will be prompted to complete the configuration by selecting the desired server on the Integrations page. Home Assistant will show as an authorized device on the [Plex Web](https://app.plex.tv/web/app) interface under **Settings** -> **Authorized Devices**.
diff --git a/source/_integrations/rpi_gpio_pwm.markdown b/source/_integrations/rpi_gpio_pwm.markdown index 15835e16054e..fcc13105bef5 100644 --- a/source/_integrations/rpi_gpio_pwm.markdown +++ b/source/_integrations/rpi_gpio_pwm.markdown @@ -8,7 +8,7 @@ ha_release: 0.43 logo: raspberry-pi.png --- -The `rpi_gpio_pwm` platform allows to control multiple lights using pulse-width modulation, for example led strips. It supports one-color, RGB and RGBW LEDs driven by GPIOs of a Raspberry Pi or a PCA9685 controller. +The `rpi_gpio_pwm` platform allows to control multiple lights using pulse-width modulation, for example LED strips. It supports one-color, RGB and RGBW LEDs driven by GPIOs of a Raspberry Pi or a PCA9685 controller. For controlling the GPIOs, the platform connects to the [pigpio-daemon](http://abyz.me.uk/rpi/pigpio/pigpiod.html), which must be running. On Raspbian Jessie 2016-05-10 or newer the `pigpio` library is already included. On other operating systems it needs to be installed first (see [installation instructions](https://github.com/soldag/python-pwmled#installation)). diff --git a/source/_integrations/skybell.markdown b/source/_integrations/skybell.markdown index 34c7945c2895..a820c3e3ef64 100644 --- a/source/_integrations/skybell.markdown +++ b/source/_integrations/skybell.markdown @@ -23,7 +23,7 @@ There is currently support for the following device types within Home Assistant: - [Sensor](/integrations/skybell/#sensor) - [Switch](/integrations/skybell/#switch) -Currently only the Skybell HD is supported by this platform. +Currently only the SkyBell HD is supported by this platform. ## Configuration @@ -38,18 +38,18 @@ skybell: {% configuration %} username: - description: The username for accessing your Skybell account. + description: The username for accessing your SkyBell account. required: true type: string password: - description: The password for accessing your Skybell account. + description: The password for accessing your SkyBell account. required: true type: string {% endconfiguration %} ### Binary Sensor -Once you have enabled the Skybell component, add the following to your `configuration.yaml` file: +Once you have enabled the SkyBell component, add the following to your `configuration.yaml` file: ```yaml # Example configuration.yaml entry @@ -69,12 +69,12 @@ monitored_conditions: button: description: Returns whether the doorbell button was pressed. motion: - description: Returns whether movement was detected by the Skybell doorbell. + description: Returns whether movement was detected by the SkyBell doorbell. {% endconfiguration %} ### Camera -Once you have enabled the Skybell component, add the following to your `configuration.yaml` file: +Once you have enabled the SkyBell component, add the following to your `configuration.yaml` file: ```yaml # Example configuration.yaml entry @@ -99,11 +99,11 @@ activity_name: #### Camera Types -There are two available camera types "Avatar", which is the default, displays the Skybell avatar image. +There are two available camera types "Avatar", which is the default, displays the SkyBell avatar image. It is periodically updated with a fresh image. The other type is "Activity", which displays a snapshot from the latest event (motion, bell, or on demand) captured by the camera. You may show either camera, or both, by specifying its name under monitored_condtions. It's recommended, but not required, to set either avatar_name or activity_name -if you are showing both cameras so you can tell them apart. The name will be appended to the skybell device name. +if you are showing both cameras so you can tell them apart. The name will be appended to the SkyBell device name. ```yaml # Example configuration.yaml with both images @@ -125,7 +125,7 @@ camera: ### Light -Once you have enabled the Skybell component, add the following to your `configuration.yaml` file: +Once you have enabled the SkyBell component, add the following to your `configuration.yaml` file: ```yaml # Example configuration.yaml entry @@ -135,7 +135,7 @@ light: ### Sensor -Once you have enabled the Skybell component, add the following to your `configuration.yaml` file: +Once you have enabled the SkyBell component, add the following to your `configuration.yaml` file: ```yaml # Example configuration.yaml entry @@ -157,7 +157,7 @@ monitored_conditions: ### Switch -Once you have enabled the Skybell component, add the following to your `configuration.yaml` file: +Once you have enabled the SkyBell integration, add the following to your `configuration.yaml` file: ```yaml # Example configuration.yaml entry diff --git a/source/_integrations/slack.markdown b/source/_integrations/slack.markdown index 4e4e998f8533..e89f5ed0376e 100644 --- a/source/_integrations/slack.markdown +++ b/source/_integrations/slack.markdown @@ -75,8 +75,8 @@ The following attributes can be placed inside `data` for extended functionality. | Service data attribute | Optional | Description | | ---------------------- | -------- | ----------- | | `file` | yes | Groups the attributes for file upload. If present, either `url` or `path` have to be provided. -| `path ` | yes | Local path of file, photo etc to post to slack. Is placed inside `file`. -| `url` | yes | URL of file, photo etc to post to slack. Is placed inside `file`. +| `path ` | yes | Local path of file, photo etc to post to Slack. Is placed inside `file`. +| `url` | yes | URL of file, photo etc to post to Slack. Is placed inside `file`. | `username` | yes | Username if the URL requires authentication. Is placed inside `file`. | `password` | yes | Password if the URL requires authentication. Is placed inside `file`. | `auth` | yes | If set to `digest` HTTP-Digest-Authentication is used. If missing HTTP-BASIC-Authentication is used. Is placed inside `file`. diff --git a/source/_integrations/streamlabswater.markdown b/source/_integrations/streamlabswater.markdown index 3bc8a2bdfcb1..9f7f12635007 100644 --- a/source/_integrations/streamlabswater.markdown +++ b/source/_integrations/streamlabswater.markdown @@ -9,7 +9,7 @@ ha_release: '0.95' ha_iot_class: Cloud Polling --- -The `Streamlabs Water` integration platform is used to interact with [Streamlabs water monitoring devices](https://www.streamlabswater.com/) in order to retrieve usage information and manage the away mode of the device. The [Streamlabs Water API](https://developer.streamlabswater.com) is used to retrieve daily, monthly, and yearly water usage along with the current away mode. +The `Streamlabs Water` integration platform is used to interact with [StreamLabs water monitoring devices](https://www.streamlabswater.com/) in order to retrieve usage information and manage the away mode of the device. The [StreamLabs Water API](https://developer.streamlabswater.com) is used to retrieve daily, monthly, and yearly water usage along with the current away mode.
@@ -22,7 +22,7 @@ There is currently support for the following device types within Home Assistant: - Binary Sensor - Sensor -In preparation for using this integration you will need to request an API key following the instructions in the [Streamlabs API Getting Started Section](https://developer.streamlabswater.com/docs/getting-started.html). Be sure to request an API key and not an OAuth token. +In preparation for using this integration you will need to request an API key following the instructions in the [StreamLabs API Getting Started Section](https://developer.streamlabswater.com/docs/getting-started.html). Be sure to request an API key and not an OAuth token. ## Configuration @@ -36,7 +36,7 @@ streamlabswater: {% configuration %} api_key: - description: Your api_key for the Streamlabs API. + description: Your api_key for the StreamLabs API. required: true type: string location_id: diff --git a/source/_integrations/switch.xiaomi_miio.markdown b/source/_integrations/switch.xiaomi_miio.markdown index a6dd3f74fcc0..ac8bd31df4c8 100644 --- a/source/_integrations/switch.xiaomi_miio.markdown +++ b/source/_integrations/switch.xiaomi_miio.markdown @@ -90,7 +90,7 @@ model: ### Service `xiaomi_miio.switch_set_wifi_led_on` (Power Strip only) -Turn the wifi led on. +Turn the wifi LED on. | Service data attribute | Optional | Description | |---------------------------|----------|---------------------------------------------------------| @@ -98,7 +98,7 @@ Turn the wifi led on. ### Service `xiaomi_miio.switch_set_wifi_led_off` (Power Strip only) -Turn the wifi led off. +Turn the wifi LED off. | Service data attribute | Optional | Description | |---------------------------|----------|---------------------------------------------------------| diff --git a/source/_integrations/switchbot.markdown b/source/_integrations/switchbot.markdown index 3a8a86debf89..053ad161f711 100644 --- a/source/_integrations/switchbot.markdown +++ b/source/_integrations/switchbot.markdown @@ -10,7 +10,7 @@ ha_codeowners: - '@danielhiversen' --- -The `switchbot` switch platform allows you to control Switchbot [devices](https://www.switch-bot.com/). +The `switchbot` switch platform allows you to control SwitchBot [devices](https://www.switch-bot.com/). ## Manual Configuration @@ -33,9 +33,9 @@ name: type: string {% endconfiguration %} -## Switchbot Entity +## SwitchBot Entity -There are two attributes available on the Switchbot entity to give you more information about your device. +There are two attributes available on the SwitchBot entity to give you more information about your device. -- `last_run_success`: If `true` if the last action sent to the Switchbot succeeded. This attribute is useful for error trapping when Bluetooth connectivity is intermittent. If `false`, see home-assistant.log for specific error messgages. -- `assumed_state`: Always `true`. If the state of the Switchbot entity cannot be determined, it is assumed to be `on`. +- `last_run_success`: If `true` if the last action sent to the SwitchBot succeeded. This attribute is useful for error trapping when Bluetooth connectivity is intermittent. If `false`, see home-assistant.log for specific error messages. +- `assumed_state`: Always `true`. If the state of the SwitchBot entity cannot be determined, it is assumed to be `on`. diff --git a/source/_integrations/twilio.markdown b/source/_integrations/twilio.markdown index d3f532fecfe7..230ba85268ad 100644 --- a/source/_integrations/twilio.markdown +++ b/source/_integrations/twilio.markdown @@ -37,7 +37,7 @@ auth_token: ### Usage -After configuring the base Twilio component, add and configure either or both of the [twilio SMS](/integrations/twilio_sms) and [twilio Phone](/integrations/twilio_call) integrations to utilize the notification functionality. +After configuring the base Twilio component, add and configure either or both of the [Twilio SMS](/integrations/twilio_sms) and [Twilio Phone](/integrations/twilio_call) integrations to utilize the notification functionality. To be able to receive events from Twilio, your Home Assistant instance needs to be accessible from the web ([Hass.io instructions](/addons/duckdns/)) and you need to have the `base_url` configured for the HTTP integration ([docs](/integrations/http/#base_url)). diff --git a/source/_integrations/unifi.markdown b/source/_integrations/unifi.markdown index 78aca8b6b63e..77f18ead3c7a 100644 --- a/source/_integrations/unifi.markdown +++ b/source/_integrations/unifi.markdown @@ -87,13 +87,13 @@ ssid_filter: ### Configuring Users -The UniFi controller allows you to create multiple users on it besides the main administrator. If all you want to use is the device tracker then it is recommended that you create a limited user that has `read-only` permissions for the Unifi device tracker. If you want blocking of network access or POE control as well you would need to have 'admin' permissions. +The UniFi controller allows you to create multiple users on it besides the main administrator. If all you want to use is the device tracker then it is recommended that you create a limited user that has `read-only` permissions for the UniFi device tracker. If you want blocking of network access or POE control as well you would need to have 'admin' permissions. ### Conflicts with MQTT -The Unifi controller can either be a dedicated hardware device (UniFi's cloud key), or as software any Linux system. If you run the Unifi controller on the same operating system as Home Assistant there may be conflicts in ports if you have the MQTT integration as well. +The UniFi controller can either be a dedicated hardware device (UniFi's cloud key), or as software any Linux system. If you run the UniFi controller on the same operating system as Home Assistant there may be conflicts in ports if you have the MQTT integration as well. -It is recommended that you run the Unifi controller in a dedicated virtual machine to avoid that situation. +It is recommended that you run the UniFi controller in a dedicated virtual machine to avoid that situation. ## Presence detection @@ -111,11 +111,11 @@ If Home Assistant and the UniFi controller are running on separate machines or V ### Block network access for clients -Allow control of network access to clients configured in the `configuration.yaml` file by adding a list of the MAC addresses. Items in this list will have a Home Assistant switch created, using the Unifi Device name, allowing for blocking and unblocking. +Allow control of network access to clients configured in the `configuration.yaml` file by adding a list of the MAC addresses. Items in this list will have a Home Assistant switch created, using the UniFi Device name, allowing for blocking and unblocking. ### Control clients powered by POE -Entities appear automatically for each connected POE client. If no POE client device is in operation, no entity will be visible. Note: Unifi infrastructure devices such as access points and other switches are not (yet) supported, even if they are powered over ethernet themselves. +Entities appear automatically for each connected POE client. If no POE client device is in operation, no entity will be visible. Note: UniFi infrastructure devices such as access points and other switches are not (yet) supported, even if they are powered over ethernet themselves. Note that POE control actually configures the network port of the switch which the client is connected to. diff --git a/source/_integrations/unifi_direct.markdown b/source/_integrations/unifi_direct.markdown index dbc20717f95b..5fd06268816c 100644 --- a/source/_integrations/unifi_direct.markdown +++ b/source/_integrations/unifi_direct.markdown @@ -8,7 +8,7 @@ ha_iot_class: Local Polling ha_release: 0.59 --- -This platform allows you to detect presence by looking at devices connected to a [UniFi AP](https://www.ubnt.com/products/#unifi). This device tracker differs form [Ubiquiti Unifi WAP](/integrations/unifi) because it doesn't require the Unifi controller software. +This platform allows you to detect presence by looking at devices connected to a [UniFi AP](https://www.ubnt.com/products/#unifi). This device tracker differs form [Ubiquiti UniFi WAP](/integrations/unifi) because it doesn't require the UniFi controller software. To use this device tracker in your installation, add the following to your `configuration.yaml` file: @@ -23,15 +23,15 @@ device_tracker: {% configuration %} host: - description: The hostname or IP address of your Unifi AP. + description: The hostname or IP address of your UniFi AP. required: true type: string username: - description: The SSH device username used to connect to your Unifi AP. + description: The SSH device username used to connect to your UniFi AP. required: true type: string password: - description: The SSH device password used to connect to your Unifi AP. + description: The SSH device password used to connect to your UniFi AP. required: true type: string {% endconfiguration %} diff --git a/source/_integrations/unifiled.markdown b/source/_integrations/unifiled.markdown index 7333f0864563..5f0661bfdc6c 100644 --- a/source/_integrations/unifiled.markdown +++ b/source/_integrations/unifiled.markdown @@ -10,7 +10,7 @@ ha_codeowners: - '@florisvdk' --- -[UniFi LED](https://unifi-led.ui.com/) by [Ubiquiti Networks, inc.](https://www.ubnt.com/) is a system of controller managed led light panels and dimmers. +[UniFi LED](https://unifi-led.ui.com/) by [Ubiquiti Networks, inc.](https://www.ubnt.com/) is a system of controller managed LED light panels and dimmers. There is currently support for the following device type within Home Assistant: @@ -29,22 +29,22 @@ light: {% configuration %} host: - description: IP address or hostname used to connect to the Unifi LED controller. + description: IP address or hostname used to connect to the UniFi LED controller. type: string required: true default: None port: - description: Port used to connect to the Unifi LED controller. + description: Port used to connect to the UniFi LED controller. type: string required: false default: 20443 username: - description: Username used to log into the Unifi LED controller. + description: Username used to log into the UniFi LED controller. type: string required: true default: None password: - description: Password used to log into the Unifi LED controller. + description: Password used to log into the UniFi LED controller. type: string required: true default: None diff --git a/source/_integrations/uvc.markdown b/source/_integrations/uvc.markdown index a24c9b985a00..44d02b547dda 100644 --- a/source/_integrations/uvc.markdown +++ b/source/_integrations/uvc.markdown @@ -10,7 +10,7 @@ ha_iot_class: Local Polling The `uvc` camera platform allows you to integrate [UniFi Video Camera (UVC)](https://www.ubnt.com/products/#unifivideo) into Home Assistant. -The platform connects to the Unifi NVR software and automatically discovers/adds any camera connected to the NVR. +The platform connects to the UniFi NVR software and automatically discovers/adds any camera connected to the NVR. ### Setup diff --git a/source/_integrations/versasense.markdown b/source/_integrations/versasense.markdown index 5ba9198c8ff1..0add4a8ec1e6 100644 --- a/source/_integrations/versasense.markdown +++ b/source/_integrations/versasense.markdown @@ -25,14 +25,14 @@ versasense: {% configuration %} host: - description: "The IP address or hostname of the VersaSense gateway. Including *protocol* and *port*, e.g., https://gateway.versasense.com:8889" + description: "The IP address or hostname of the VersaSense gateway. Including *protocol* and *port*, e.g., `https://gateway.versasense.com:8889`" required: true type: string {% endconfiguration %} ## Supported hardware -All Versasense gateways with software version >= 1.0.2.10 +All VersaSense gateways with software version >= 1.0.2.10 The integration is tested with following peripherals and devices: diff --git a/source/_integrations/vivotek.markdown b/source/_integrations/vivotek.markdown index 4c4e63b41b21..af3b7bff23b3 100644 --- a/source/_integrations/vivotek.markdown +++ b/source/_integrations/vivotek.markdown @@ -1,6 +1,6 @@ --- title: Vivotek -description: Instructions on how to integrate Vivotek cameras within Home Assistant. +description: Instructions on how to integrate VIVOTEK cameras within Home Assistant. ha_category: - Camera logo: vivotek.jpg @@ -10,7 +10,7 @@ ha_codeowners: - '@HarlemSquirrel' --- -The `vivotek` camera platform allows you to integrate a Vivotek IP camera into Home Assistant. +The `vivotek` camera platform allows you to integrate a VIVOTEK IP camera into Home Assistant. Home Assistant will serve the images via its server, making it possible to view your IP cameras while outside of your network. The endpoint is `/api/camera_proxy/camera.[name]`. @@ -35,7 +35,7 @@ ip_address: name: description: This parameter allows you to override the name of your camera. required: false - default: Vivotek Camera + default: VIVOTEK Camera type: string username: description: The username for accessing your camera. diff --git a/source/_integrations/webostv.markdown b/source/_integrations/webostv.markdown index 27dae016b11e..94b43e66b0ec 100644 --- a/source/_integrations/webostv.markdown +++ b/source/_integrations/webostv.markdown @@ -133,7 +133,7 @@ To obtain complete list of available sources currently configured on the TV, onc ## Change channel through play_media service -The `play_media` service can be used in a script to switch to the specified tv channel. It selects the best matching channel according to the `media_content_id` parameter: +The `play_media` service can be used in a script to switch to the specified TV channel. It selects the best matching channel according to the `media_content_id` parameter: 1. Channel number *(i.e. '1' or '6')* 2. Exact channel name *(i.e. 'France 2' or 'CNN')* diff --git a/source/_integrations/yamaha.markdown b/source/_integrations/yamaha.markdown index 2b5e0e3bcff3..94b551021775 100644 --- a/source/_integrations/yamaha.markdown +++ b/source/_integrations/yamaha.markdown @@ -70,7 +70,7 @@ zone_names: ### Supported operations -- Media players created by yamaha support powering on/off, mute, +- Media players created by Yamaha support powering on/off, mute, volume control and source selection. Playback controls, for instance play and stop are available for sources that supports it. - The `play_media` service is implemented for `NET RADIO` source diff --git a/source/_integrations/yeelight.markdown b/source/_integrations/yeelight.markdown index 6c4d8b98df2b..5d11ed4014b6 100644 --- a/source/_integrations/yeelight.markdown +++ b/source/_integrations/yeelight.markdown @@ -142,7 +142,7 @@ This integration is tested to work with the following models. If you have a diff | ? | YLDD04YL | Lightstrip (Color) | | `bslamp1` | MJCTD01YL | Xiaomi Mijia Bedside Lamp - Wi-Fi Version! | | `bslamp1` | MJCTD02YL | Xiaomi Mijia Bedside Lamp II | -| `RGBW` | MJDP02YL | Mi Led smart Lamp - white and color Wi-Fi Version| +| `RGBW` | MJDP02YL | Mi LED smart Lamp - white and color Wi-Fi Version| | `lamp1` | MJTD01YL | Xiaomi Mijia Smart LED Desk Lamp (autodiscovery isn't possible because the device doesn't support mDNS due to the small amount of RAM) | | `ceiling1` | YLXD01YL | Yeelight Ceiling Light | | `ceiling2` | YLXD03YL | Yeelight Ceiling Light - Youth Version | diff --git a/source/_integrations/zha.markdown b/source/_integrations/zha.markdown index 0f257dcb3704..81c317ec8629 100644 --- a/source/_integrations/zha.markdown +++ b/source/_integrations/zha.markdown @@ -70,7 +70,7 @@ Use the plus button in the bottom right to add a new integration called **ZHA**. In the popup: -- USB Device Path - on a linux system will be something like `/dev/ttyUSB0` +- USB Device Path - on a Linux system will be something like `/dev/ttyUSB0` - Radio type - select device type `ezsp`, `deconz` or `xbee` - Submit @@ -90,9 +90,10 @@ zha: ``` If you are use ZiGate, you have to use some special usb_path configuration: - - ZiGate USB TTL or DIN: `/dev/ttyUSB0` or `auto` to auto discover the zigate - - PiZigate : `pizigate:/dev/serial0` - - Wifi Zigate : `socket://[IP]:[PORT]` for example `socket://192.168.1.10:9999` + +- ZiGate USB TTL or DIN: `/dev/ttyUSB0` or `auto` to auto discover the zigate +- PiZigate : `pizigate:/dev/serial0` +- Wifi Zigate : `socket://[IP]:[PORT]` for example `socket://192.168.1.10:9999` {% configuration %} radio_type: @@ -149,7 +150,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. @@ -165,7 +166,7 @@ If you are using Docker and can't connect, you most likely need to forward your #### Docker Compose -Install Docker-Compose for your platform (linux - `sudo apt-get install docker-compose`). +Install Docker-Compose for your platform (Linux - `sudo apt-get install docker-compose`). Create a `docker-compose.yml` with the following data: @@ -175,7 +176,7 @@ services: homeassistant: # customisable name container_name: home-assistant - + # must be image for your platform, this is the rpi3 variant image: homeassistant/raspberrypi3-homeassistant volumes: