Add docs for Netgear LTE config flow (#27283)

* Add docs for Netgear LTE config flow

* Update source/_integrations/netgear_lte.markdown

Co-authored-by: c0ffeeca7 <38767475+c0ffeeca7@users.noreply.github.com>

---------

Co-authored-by: c0ffeeca7 <38767475+c0ffeeca7@users.noreply.github.com>
This commit is contained in:
Robert Hillis 2023-12-25 23:21:13 -05:00 committed by GitHub
parent a60692e506
commit 28597905ab
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -8,11 +8,14 @@ ha_category:
- Notifications
- Sensor
ha_iot_class: Local Polling
ha_config_flow: true
ha_domain: netgear_lte
ha_platforms:
- binary_sensor
- notify
- sensor
ha_codeowners:
- '@tkdrob'
ha_integration_type: integration
ha_codeowners:
- '@tkdrob'
@ -34,106 +37,11 @@ Splitting of long SMS messages is not supported so notifications can contain a m
</div>
## Configuration
{% include integrations/config_flow.md %}
To enable the integration, add the following lines to your `configuration.yaml` file:
## Notification Service
```yaml
# Example configuration.yaml entry
netgear_lte:
- host: IP_ADDRESS
password: SECRET
notify:
- name: sms
recipient: "+15105550123"
sensor:
monitored_conditions:
- usage
- sms
binary_sensor:
monitored_conditions:
- wire_connected
- mobile_connected
```
{% configuration %}
host:
description: The IP address of the modem web interface.
required: true
type: string
password:
description: The password used for the modem web interface.
required: true
type: string
notify:
description: A list of notification services connected to this specific host.
required: false
type: list
keys:
recipient:
description: The phone number of a default recipient or a list with multiple recipients.
required: false
type: [string, list]
name:
description: The name of the notification service.
required: false
default: "`netgear_lte`"
type: string
sensor:
description: Configuration options for sensors.
required: false
type: map
keys:
monitored_conditions:
description: Sensor types to create.
required: false
default: usage
type: list
keys:
cell_id:
description: The Cell ID, a number identifying the base station.
connection_text:
description: A connection text, e.g., "4G".
connection_type:
description: The connection type, e.g., "IPv4Only".
current_band:
description: The radio band used, e.g., "LTE B3".
current_ps_service_type:
description: The service type, e.g., "LTE".
radio_quality:
description: A number with the radio quality in percent, e.g., "55"
register_network_display:
description: The name of the service provider.
rx_level:
description: The RSRP value, a measurement of the received power level, e.g., "-95".
sms:
description: Number of unread SMS messages in the modem inbox.
sms_total:
description: Number of SMS messages in the modem inbox.
tx_level:
description: Transmit power, e.g., "23".
upstream:
description: Current upstream connection, "WAN" or "LTE".
usage:
description: Amount of data transferred.
binary_sensor:
description: Configuration options for binary sensors.
required: false
type: map
keys:
monitored_conditions:
description: Binary sensor types to create.
required: false
default: mobile_connected
type: list
keys:
mobile_connected:
description: The LTE connection state.
wire_connected:
description: The wired uplink connection state.
roaming:
description: The current roaming state.
{% endconfiguration %}
The integration will create a `notify` service matching the name of the integration entry. This is the model name of the device by default.
## Events