Update huawei_lte auth config (#18467)

* Update huawei_lte authentication config docs

Refs https://github.com/home-assistant/core/pull/49878

* Update username and password schema docs
This commit is contained in:
Ville Skyttä 2021-07-16 10:12:08 +03:00 committed by GitHub
parent 7a360309b3
commit 20de179fb4
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -42,7 +42,8 @@ enabled in Home Assistant, automatically discovered Huawei LTE devices
which support and have UPnP enabled are made available for further
optional configuration in the frontend.
The integration can be run with or without
The integration requires authentication using router credentials at
initial configure time, but after that, it can be run with or without
authentication. Authenticated mode enables all available integration
features and entities, but may interfere with accessing the device web
interface from another source such as a browser while the integration
@ -73,14 +74,8 @@ Click on the `+` sign to add an integration and click on **Huawei
LTE**, and follow the configuration flow. After finishing, the Huawei
LTE integration will be available.
To use unauthenticated mode, leave username and password empty. The
integration will then attempt to first use empty strings to
authenticate and fall back to unauthenticated mode in case that
fails. If this process does not yield desired results, the YAML
configuration (see below) is available for more fine grained control.
Default list of notification recipient phone numbers can be set using
the integration's configuration options.
Unauthenticated mode and default list of notification recipient phone
numbers can be set using the integration's configuration options.
### Configuration via YAML
@ -91,6 +86,8 @@ To enable the component, add the following lines to your
# Example configuration.yaml entry
huawei_lte:
- url: http://192.168.100.1/
username: ROUTER_USERNAME
password: ROUTER_PASSWORD
```
For routers configured via the UI, each configuration item for the
same router in YAML overrides and updates the values set in UI
@ -102,11 +99,11 @@ url:
required: true
type: string
username:
description: The username used for the device web interface in authenticated mode. Typically `admin`, or empty string (`""`) for USB stick modems. To use unauthenticated mode, leave this variable out altogether.
description: The username used for the device web interface. Typically `admin`, or empty string (`""`) for USB stick modems. Required when first setting up the device and in authenticated mode.
required: false
type: string
password:
description: The password used for the device web interface in authenticated mode. Typically empty string (`""`) for USB stick modems. To use unauthenticated mode, leave this variable out altogether.
description: The password used for the device web interface. Typically empty string (`""`) for USB stick modems. Required when first setting up the device and in authenticated mode.
required: false
type: string
notify: