Skip to content

🚜 Merges/Redirect Huawei LTE component pages #8768

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

Merged
merged 2 commits into from
Feb 28, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
32 changes: 0 additions & 32 deletions source/_components/device_tracker.huawei_lte.markdown

This file was deleted.

141 changes: 126 additions & 15 deletions source/_components/huawei_lte.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -8,17 +8,28 @@ comments: false
sharing: true
footer: true
logo: huawei.svg
ha_category: Network
ha_category:
- Network
- Presence Detection
- Notifications
- Sensor
ha_release: 0.79
ha_iot_class: "Local Polling"
redirect_from:
- /components/notify.huawei_lte/
- /components/device_tracker.huawei_lte/
- /components/sensor.huawei_lte/
---

The Huawei LTE router integration for Home Assistant allows you to observe
and control [Huawei LTE routers](https://consumer.huawei.com/en/smart-home/).
The Huawei LTE router integration for Home Assistant allows you to observe and control [Huawei LTE routers](https://consumer.huawei.com/en/smart-home/).

The integration provides:
There is currently support for the following device types within Home Assistant:

* a sensor with device, signal, and traffic information
* a device tracker for connected devices
- [Presence Detection](#presence-detection) - a device tracker for connected devices
- [Notifications](#notifications)
- [Sensor](#sensor) - with device, signal, and traffic information

All platform requires you to have set up the [Huawei LTE component](#configuration).

## {% linkable_title Configuration %}

Expand All @@ -35,17 +46,17 @@ huawei_lte:

{% configuration %}
url:
description: URL of the router web interface.
required: true
type: url
description: URL of the router web interface.
required: true
type: url
username:
description: The username used for the router web interface.
required: true
type: string
description: The username used for the router web interface.
required: true
type: string
password:
description: The password used for the router web interface.
required: true
type: string
description: The password used for the router web interface.
required: true
type: string
{% endconfiguration %}

### {% linkable_title Tested routers %}
Expand All @@ -58,3 +69,103 @@ Routers we know to be working with this component based on the documentation of
- Huawei B618

This is not a complete list. The component can probably connect to other Huawei LTE routers running similar firmware.

## {% linkable_title Presence Detection %}

This platform offers presence detection by looking at connected devices to a [Huawei LTE router](https://consumer.huawei.com/en/smart-home/).

To enable the sensor, add the following lines to your `configuration.yaml` file:

```yaml
# Example configuration.yaml entry
device_tracker:
- platform: huawei_lte
```

See the [device tracker component page](/components/device_tracker/) for instructions how to configure the people to be tracked.

## {% linkable_title Notifications %}

The `huawei_lte` platform allows you to use a Huawei LTE router for notifications from Home Assistant. The messages will be sent as SMS text messages.

```yaml
# Example configuration.yaml entry
notify:
- platform: huawei_lte
recipient: "+15105550123"
```

{% configuration %}
recipient:
description: The phone number of a default recipient or a list with multiple recipients.
required: true
type: string, list
name:
description: Setting the optional parameter `name` allows multiple notifiers to be created. The notifier will bind to the service `notify.NOTIFIER_NAME`.
required: false
default: notify
type: string
url:
description: The router to use. Not needed if you only have one.
required: false
type: url
{% endconfiguration %}

To use notifications, please see the [getting started with automation page](/getting-started/automation/).

## {% linkable_title Sensor %}

The `huawei_lte` sensor platform allows you to monitor Huawei LTE routers.

The names for the item you want to monitor are dot separated paths to information returned by the router. The data set varies by router model. To see what your router provides, set logging level to debug and watch `homeassistant.components.huawei_lte` debug entries. The configuration variable description contains a few example paths just to illustrate the syntax. These may not be available on all routers or their semantics may differ, and there are quite likely many more that are not listed here.

To enable the sensor, add the following lines to your `configuration.yaml` file:

```yaml
# Example configuration.yaml entry
sensor:
- platform: huawei_lte
monitored_conditions:
- device_information.SoftwareVersion
- device_signal.rssi
- traffic_statistics.CurrentDownloadRate
- traffic_statistics.TotalConnectTime
```

{% configuration %}
monitored_conditions:
description: Defines the data to monitor as sensors. Defaults to a few generally available data items expected to be available on most boxes.
required: false
default: Below is indicated which conditions are the default.
type: list
keys:
device_information.SoftwareVersion:
description: Software version.
device_information.WanIPAddress:
description: WAN interface IPv4 address.
default: default
device_information.WanIPv6Address:
description: WAN interface IPv6 address.
device_signal.rsrq:
description: The signal RSRQ value.
default: default
device_signal.rsrp:
description: The signal RSRP value.
default: default
device_signal.rssi:
description: The signal RSSI value.
default: default
device_signal.sinr:
description: The signal SINR value.
default: default
traffic_statistics.CurrentDownloadRate:
description: Current download rate, bytes/sec.
traffic_statistics.CurrentUploadRate:
description: Current upload rate, bytes/sec.
traffic_statistics.TotalUpload:
description: Total bytes uploaded since last reset.
traffic_statistics.TotalDownload:
description: Total bytes downloaded since last reset.
traffic_statistics.TotalConnectTime:
description: Total time connected since last reset.
{% endconfiguration %}
46 changes: 0 additions & 46 deletions source/_components/notify.huawei_lte.markdown

This file was deleted.

75 changes: 0 additions & 75 deletions source/_components/sensor.huawei_lte.markdown

This file was deleted.