Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document config flow ability for plum_lightpad integrtaion #13869

Closed
wants to merge 35 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
35 commits
Select commit Hold shift + click to select a range
b1410e3
Remove stale MQTT JSON processing documentation (#13836)
emontnemery Jun 24, 2020
05d148b
Added IGMP no response information (#13527)
svh1985 Jun 24, 2020
bba38fd
Warn against using the RabbitMQ MQTT Plugin (#13837)
emontnemery Jun 24, 2020
3bab194
Bump jekyll from 4.1.0 to 4.1.1 (#13838)
dependabot-preview[bot] Jun 24, 2020
1b351f3
Adding configuration value for name (#13839)
atxbyea Jun 25, 2020
e96c6b9
Update denonavr.markdown (#13852)
bevosangryghost Jun 26, 2020
5dac14e
Add Denon AVR-S720W to supported device list (#13850)
Jun 26, 2020
a7245e3
Clarify Update on Docker HA Core install (#13542)
fhoekstra Jun 26, 2020
06df812
Fix trusted_user - point toward user IDs (#13846)
northox Jun 26, 2020
9777f81
Add support for Inovelli LZW36 (#13862)
DanPatten Jun 28, 2020
854e00b
Fix typo in state trigger warning (#13863)
kocsenc Jun 28, 2020
102197d
Update binary_sensor.xiaomi_aqara.markdown (#13858)
wowgamr Jun 28, 2020
7d99053
Fix H.264 mention
robbiet480 Jun 29, 2020
4f6ba61
Bump kramdown from 2.2.1 to 2.3.0 (#13866)
dependabot-preview[bot] Jun 29, 2020
c237d11
Update links to yi hack projects for new models (#13865)
roleoroleo Jun 29, 2020
662d924
Clarified on connection (#13867)
bachtron Jun 29, 2020
bba862b
Update plum_lightpad docs to mention flow config
prystupa Jun 29, 2020
2ffbdb9
Remove stale MQTT JSON processing documentation (#13836)
emontnemery Jun 24, 2020
0e47a0e
Added IGMP no response information (#13527)
svh1985 Jun 24, 2020
42cc9ba
Warn against using the RabbitMQ MQTT Plugin (#13837)
emontnemery Jun 24, 2020
495494b
Bump jekyll from 4.1.0 to 4.1.1 (#13838)
dependabot-preview[bot] Jun 24, 2020
5923c30
Adding configuration value for name (#13839)
atxbyea Jun 25, 2020
22c380a
Update denonavr.markdown (#13852)
bevosangryghost Jun 26, 2020
593df2e
Add Denon AVR-S720W to supported device list (#13850)
Jun 26, 2020
43d65cf
Clarify Update on Docker HA Core install (#13542)
fhoekstra Jun 26, 2020
1cbf47a
Fix trusted_user - point toward user IDs (#13846)
northox Jun 26, 2020
4dbab4c
Add support for Inovelli LZW36 (#13862)
DanPatten Jun 28, 2020
140bf99
Fix typo in state trigger warning (#13863)
kocsenc Jun 28, 2020
97596a4
Update binary_sensor.xiaomi_aqara.markdown (#13858)
wowgamr Jun 28, 2020
6850f37
Fix H.264 mention
robbiet480 Jun 29, 2020
26525df
Bump kramdown from 2.2.1 to 2.3.0 (#13866)
dependabot-preview[bot] Jun 29, 2020
b3edc5b
Update links to yi hack projects for new models (#13865)
roleoroleo Jun 29, 2020
53bd2aa
Clarified on connection (#13867)
bachtron Jun 29, 2020
5d56247
Update plum_lightpad docs to mention flow config
prystupa Jun 29, 2020
d04e873
Merge branch 'patch-1' of github.com:prystupa/home-assistant.io into …
prystupa Jun 29, 2020
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion Gemfile
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ ruby '> 2.5.0'

group :development do
gem 'rake', '13.0.1'
gem 'jekyll', '4.1.0'
gem 'jekyll', '4.1.1'
gem 'compass', '1.0.3'
gem 'sass-globbing', '1.1.5'
gem 'stringex', '2.8.5'
Expand Down
6 changes: 3 additions & 3 deletions Gemfile.lock
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ GEM
http_parser.rb (0.6.0)
i18n (1.8.3)
concurrent-ruby (~> 1.0)
jekyll (4.1.0)
jekyll (4.1.1)
addressable (~> 2.4)
colorator (~> 1.0)
em-websocket (~> 0.5)
Expand Down Expand Up @@ -60,7 +60,7 @@ GEM
jekyll
jekyll-watch (2.2.1)
listen (~> 3.0)
kramdown (2.2.1)
kramdown (2.3.0)
rexml
kramdown-parser-gfm (1.1.0)
kramdown (~> 2.0)
Expand Down Expand Up @@ -121,7 +121,7 @@ PLATFORMS

DEPENDENCIES
compass (= 1.0.3)
jekyll (= 4.1.0)
jekyll (= 4.1.1)
jekyll-commonmark (= 1.3.1)
jekyll-paginate (= 1.1.0)
jekyll-redirect-from (= 0.16.0)
Expand Down
4 changes: 2 additions & 2 deletions source/_docs/authentication/providers.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -87,8 +87,8 @@ trusted_users:
required: false
type: map
keys:
IP_ADDRESS:
description: List of users available to select on this IP address or network.
USER_ID:
description: List of user ids available to select on this IP address or network.
required: false
type: [list, string]
allow_bypass_login:
Expand Down
2 changes: 1 addition & 1 deletion source/_docs/automation/trigger.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -180,7 +180,7 @@ The `for` template(s) will be evaluated when an entity changes as specified.

<div class='note warning'>

Use quotes around your values for `from` and `to` to avoid the YAML parser interpreting values as booleans.
Use quotes around your values for `from` and `to` to avoid the YAML parser from interpreting values as booleans.

</div>

Expand Down
21 changes: 20 additions & 1 deletion source/_docs/installation/docker.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -16,10 +16,29 @@ Note that Docker command line option `--net=host` or the compose file equivalent

Installation with Docker is straightforward. Adjust the following command so that `/PATH_TO_YOUR_CONFIG` points at the folder where you want to store your configuration and run it:

## Autostart using Docker

<div class='note warning'>

Do not try to combine Docker `restart` policies with host-level process managers (such as `systemd`), because this creates conflicts.

</div>

Add `--restart=always` to your `docker run` command before homeassistant/home-assistant:stable. See [the Docker autostart documentation](https://docs.docker.com/config/containers/start-containers-automatically/) for details and more options.

### Linux

```bash
docker run --init -d --name="home-assistant" -e "TZ=America/New_York" -v /PATH_TO_YOUR_CONFIG:/config --net=host homeassistant/home-assistant:stable
docker run -d --name="home-assistant" -v /PATH_TO_YOUR_CONFIG:/config -v /etc/localtime:/etc/localtime:ro --net=host homeassistant/home-assistant:stable
```

Updating:

```bash
docker pull homeassistant/home-assistant:stable # if this returns "Image is up to date" then you can stop here
docker stop home-assistant # stop the running container
docker rm home-assistant # remove it from Docker's list of containers
docker run -d --name="home-assistant" -v /PATH_TO_YOUR_CONFIG:/config -v /etc/localtime:/etc/localtime:ro --net=host homeassistant/home-assistant:stable # finally, start a new one
```

### Raspberry Pi 3 (Raspberry Pi OS)
Expand Down
1 change: 0 additions & 1 deletion source/_docs/mqtt.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,5 @@ For detailed setup instructions, please refer to the [MQTT broker](/docs/mqtt/br
- [Birth and last will messages](/docs/mqtt/birth_will/)
- [Testing your setup](/docs/mqtt/testing/)
- [Logging](/docs/mqtt/logging/)
- [Processing JSON](/docs/mqtt/processing_json/)

See the [MQTT example component](/cookbook/python_component_mqtt_basic/) how to integrate your own component.
8 changes: 8 additions & 0 deletions source/_docs/mqtt/broker.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,14 @@ This is the most private option, is running your own MQTT broker.

The recommended setup method is to use the [Mosquitto MQTT broker add-on](https://github.com/home-assistant/hassio-addons/blob/master/mosquitto/DOCS.md).

</div>

<div class='note warning'>

There is [an issue](https://github.com/rabbitmq/rabbitmq-mqtt/issues/154) with the RabbitMQ MQTT Plugin which break MQTT message retention. Don't use the RabbitMQ MQTT plugin, instead use another broker like Mosquitto.

</div>

## Configuration

```yaml
Expand Down
30 changes: 0 additions & 30 deletions source/_docs/mqtt/processing_json.markdown

This file was deleted.

11 changes: 11 additions & 0 deletions source/_docs/z-wave/device-specific.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -161,6 +161,17 @@ Here's a handy configuration for the Aeon Labs Minimote that defines all possibl

Some models of the Zooz Toggle switches ship with an instruction manual with incorrect instruction for Z-Wave inclusion/exclusion. The instructions say that the switch should be quickly switched on-off-on for inclusion and off-on-off for exclusion. However, the correct method is on-on-on for inclusion and off-off-off for exclusion.

### Inovelli Light/Fan Combo (LZW36)
Follow the [instructions](https://support.inovelli.com/portal/kb/articles/installation-setup-lzw36-fan-light-red-series-gen-2-home-assistant-hass-io) provided by Inovelli. You will need to uncomment command class 38 in the imported configuration file.

```xml
<CommandClass id="38">
<Instance index="1" label="Fan/Light" />
<Instance index="2" endpoint="1" label="Light" />
<Instance index="3" endpoint="2" label="Fan" />
</CommandClass>
```

## Central Scene configuration

To provide Central Scene support you need to **stop your Z-Wave network** and modify your `zwcfg_*.xml` file according to the following guides. Start your Z-Wave network again after editing `zwcfg_*.xml`.
Expand Down
4 changes: 2 additions & 2 deletions source/_integrations/binary_sensor.xiaomi_aqara.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ The requirement is that you have setup the [`xiaomi aqara` integration](/integra
| Gas Leak Detector | natgas | JTQJ-BF-01LM/BW | on, off | | | |
| Water Leak Sensor | sensor_wleak.aq1 | SJCGQ11LM | on, off | | | |
| Button (1st gen) | switch | WXKG01LM | on (through long_click_press), off | `xiaomi_aqara.click`| `click_type`| `long_click_press`, `long_click_release`, `hold`, `single`, `double` |
| Button (2nd gen) | sensor_switch.aq2, remote.b1acn01 | WXKG11LM | off (always) | `xiaomi_aqara.click` | `click_type` | `single`, `double` |
| Button (2nd gen) | sensor_switch.aq2, remote.b1acn01 | WXKG11LM | on (through long_click_press), off | `xiaomi_aqara.click` | `click_type` | `single`, `double`, `long_click_press`, `hold` |
| Button (2nd gen, model b) | sensor_switch.aq3 | WXKG12LM | off (always) | `xiaomi_aqara.click` | `click_type` | `single`, `double`, `long_click_press`, `shake` |
| Aqara Wireless Switch (Single) | 86sw1 | WXKG03LM | off (always) | `xiaomi_aqara.click` | `click_type` | `single` |
| Aqara Wireless Switch (Double) | 86sw2 | WXKG02LM | off (always) | `xiaomi_aqara.click` | `click_type` | `single`, `both` |
Expand Down Expand Up @@ -154,7 +154,7 @@ The requirement is that you have setup the [`xiaomi aqara` integration](/integra

#### Xiaomi Wireless Button

As indicated in the table on top of this page there are 3 versions of the button. For the round shaped button the available events are `single`, `double`, `hold`, `long_click_press` and `long_click_release`. Aqara branded buttons are square shaped. Model WXKG11LM only supports `single` and `double` events. WXKG12LM supports `single`, `double`, `long_click_press` and `shake` events. For the Aqara versions the delay between two clicks to generate a double click must be larger than with the round button. Clicking too quickly generates a single click event.
As indicated in the table on top of this page there are 3 versions of the button. For the round shaped button the available events are `single`, `double`, `hold`, `long_click_press` and `long_click_release`. Aqara branded buttons are square shaped. Model WXKG11LM only supports `single`, `double`, `long_click_press`and `hold` events. WXKG12LM supports `single`, `double`, `long_click_press` and `shake` events. For the Aqara versions the delay between two clicks to generate a double click must be larger than with the round button. Clicking too quickly generates a single click event.

```yaml
- alias: Toggle dining light on single press
Expand Down
2 changes: 2 additions & 0 deletions source/_integrations/denonavr.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ Known supported devices:
- Denon AVR-X2300W
- Denon AVR-X3300W
- Denon AVR-X3400H
- Denon AVR-X3600H
- Denon AVR-X4100W
- Denon AVR-X4300H
- Denon AVR-X4500H
Expand All @@ -34,6 +35,7 @@ Known supported devices:
- Denon AVR-3312
- Denon AVR-4810
- Denon AVR-S710W
- Denon AVR-S720W
- Denon AVR-S750H
- Marantz M-CR510
- Marantz M-CR603
Expand Down
2 changes: 2 additions & 0 deletions source/_integrations/homekit.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -611,6 +611,8 @@ If you have any iOS 12.x devices signed into your iCloud account, media player e

#### Accessories are all listed as not responding

There are reports where the IGMP settings in a router were causing issues with HomeKit. This resulted in a situation where all of the Home Assistant HomeKit accessories stopped responding a few minutes after Home Assistant (re)started. Double check your router's IGPM settings if you experiencing this issue. The default IGMP settings typically work best.

See [specific entity doesn't work](#specific-entity-doesnt-work)

#### Accessory not responding - after restart or update
Expand Down
1 change: 0 additions & 1 deletion source/_integrations/mqtt.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -37,4 +37,3 @@ mqtt:
- [Birth and last will messages](/docs/mqtt/birth_will/)
- [Testing your setup](/docs/mqtt/testing/)
- [Logging](/docs/mqtt/logging/)
- [Processing JSON](/docs/mqtt/processing_json/)
5 changes: 5 additions & 0 deletions source/_integrations/nut.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,11 @@ sensor:
required: false
default: 3493
type: integer
name:
description: Custom name of the sensor
required: false
default: NUT UPS
type: string
alias:
description: Name of the UPS on the NUT server.
required: false
Expand Down
2 changes: 1 addition & 1 deletion source/_integrations/onvif.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ If running Home Asssistant Core in a venv, ensure that libxml2 and libxslt pytho

### Configuration Notes

Most of the ONVIF devices support more than one audio/video profile. Each profile provides different image quality, or in the case of an NVR, separate connected cameras. This integration will add entities for all compatible profiles with the video encoding set to H254. Usually, the first profile has the highest quality and it is the profile used by default. However, you may want to use a lower quality image. You may disable unwanted entities through the Home Assistant UI.
Most of the ONVIF devices support more than one audio/video profile. Each profile provides different image quality, or in the case of an NVR, separate connected cameras. This integration will add entities for all compatible profiles with the video encoding set to H.264. Usually, the first profile has the highest quality and it is the profile used by default. However, you may want to use a lower quality image. You may disable unwanted entities through the Home Assistant UI.

### Extra configuration of the integration

Expand Down
5 changes: 4 additions & 1 deletion source/_integrations/plum_lightpad.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,12 @@ description: Instructions on setting up Plum Lightpads within Home Assistant.
ha_category:
- Switch
ha_iot_class: Local Push
ha_config_flow: true
ha_release: 0.85
ha_domain: plum_lightpad
ha_codeowners:
- '@ColinHarrington'
- '@prystupa'
---

Configurable/Dimmable Wi-Fi Lightswitch
Expand All @@ -20,7 +22,8 @@ Configurable/Dimmable Wi-Fi Lightswitch

## Configuration

To enable Plum Lightpad support, add the following lines to your `configuration.yaml` file:
To use Plum Lightpad devices in your installation, add your Plum account from the integrations page.
Alternatively, add the following lines to your `configuration.yaml` file:

```yaml
# Example configuration.yaml entry
Expand Down
2 changes: 2 additions & 0 deletions source/_integrations/xiaomi_aqara.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -235,6 +235,8 @@ That means that Home Assistant is not getting any response from your Xiaomi gate
- Turn on the gateway (220V).
- Open a serial terminal application (e.g., PuTTY) and connect to the serial port assigned to the USB-UART module (baudrate: 115200).
- Wait until the gateway is booted up, connect the RX, TX and GND wires to the UART module (don't connect the Vcc (power) wire!).
- RX on UART to TX on gateway
- TX on UART to RX on gateway
- You will see all the messages from the gateway.
- Send the command `psm-set network open_pf 3` (the command has to end with a `CR` newline character).
- Check your settings executing the command `psm-get network open_pf` to be sure it's OK.
Expand Down
3 changes: 2 additions & 1 deletion source/_integrations/yi.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,8 @@ To successfully implement this platform, the Home Assistant host should be capab

### Installing Alternative Firmware

In order to integrate the camera with Home Assistant, it is necessary to install a custom firmware on the device. Instructions for doing so can be found via the [yi-hack-v3 GitHub project](https://github.com/shadow-1/yi-hack-v3) or if you have a 2019 version camera [yi-hack-6FUS_4.5.0 GitHub project](https://github.com/roleoroleo/yi-hack-6FUS_4.5.0).
In order to integrate the camera with Home Assistant, it is necessary to install a custom firmware on the device. Instructions for doing so can be found via the [yi-hack-v3 GitHub project](https://github.com/shadow-1/yi-hack-v3).
If you have a 2019/2020 version camera use [yi-hack-MStar GitHub project](https://github.com/roleoroleo/yi-hack-MStar) or [yi-hack-Allwinner GitHub project](https://github.com/roleoroleo/yi-hack-Allwinner). In this case configure the cam as ONVIF and read the wiki for further details.

Once installed, please ensure that you have enabled FTP and Telnet on your device.

Expand Down