Skip to content

Commit 12d889a

Browse files
klaasnicolaasfabaff
authored andcommitted
🚜 Merges/Redirect Huawei LTE component pages (#8768)
* 🚜 Merges/Redirect Huawei LTE component pages * ✏️ Tweak
1 parent 1891388 commit 12d889a

File tree

4 files changed

+126
-168
lines changed

4 files changed

+126
-168
lines changed

β€Žsource/_components/device_tracker.huawei_lte.markdown

Lines changed: 0 additions & 32 deletions
This file was deleted.

β€Žsource/_components/huawei_lte.markdown

Lines changed: 126 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -8,17 +8,28 @@ comments: false
88
sharing: true
99
footer: true
1010
logo: huawei.svg
11-
ha_category: Network
11+
ha_category:
12+
- Network
13+
- Presence Detection
14+
- Notifications
15+
- Sensor
1216
ha_release: 0.79
17+
ha_iot_class: "Local Polling"
18+
redirect_from:
19+
- /components/notify.huawei_lte/
20+
- /components/device_tracker.huawei_lte/
21+
- /components/sensor.huawei_lte/
1322
---
1423

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

18-
The integration provides:
26+
There is currently support for the following device types within Home Assistant:
1927

20-
* a sensor with device, signal, and traffic information
21-
* a device tracker for connected devices
28+
- [Presence Detection](#presence-detection) - a device tracker for connected devices
29+
- [Notifications](#notifications)
30+
- [Sensor](#sensor) - with device, signal, and traffic information
31+
32+
All platform requires you to have set up the [Huawei LTE component](#configuration).
2233

2334
## {% linkable_title Configuration %}
2435

@@ -35,17 +46,17 @@ huawei_lte:
3546
3647
{% configuration %}
3748
url:
38-
description: URL of the router web interface.
39-
required: true
40-
type: url
49+
description: URL of the router web interface.
50+
required: true
51+
type: url
4152
username:
42-
description: The username used for the router web interface.
43-
required: true
44-
type: string
53+
description: The username used for the router web interface.
54+
required: true
55+
type: string
4556
password:
46-
description: The password used for the router web interface.
47-
required: true
48-
type: string
57+
description: The password used for the router web interface.
58+
required: true
59+
type: string
4960
{% endconfiguration %}
5061
5162
### {% linkable_title Tested routers %}
@@ -58,3 +69,103 @@ Routers we know to be working with this component based on the documentation of
5869
- Huawei B618
5970
6071
This is not a complete list. The component can probably connect to other Huawei LTE routers running similar firmware.
72+
73+
## {% linkable_title Presence Detection %}
74+
75+
This platform offers presence detection by looking at connected devices to a [Huawei LTE router](https://consumer.huawei.com/en/smart-home/).
76+
77+
To enable the sensor, add the following lines to your `configuration.yaml` file:
78+
79+
```yaml
80+
# Example configuration.yaml entry
81+
device_tracker:
82+
- platform: huawei_lte
83+
```
84+
85+
See the [device tracker component page](/components/device_tracker/) for instructions how to configure the people to be tracked.
86+
87+
## {% linkable_title Notifications %}
88+
89+
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.
90+
91+
```yaml
92+
# Example configuration.yaml entry
93+
notify:
94+
- platform: huawei_lte
95+
recipient: "+15105550123"
96+
```
97+
98+
{% configuration %}
99+
recipient:
100+
description: The phone number of a default recipient or a list with multiple recipients.
101+
required: true
102+
type: string, list
103+
name:
104+
description: Setting the optional parameter `name` allows multiple notifiers to be created. The notifier will bind to the service `notify.NOTIFIER_NAME`.
105+
required: false
106+
default: notify
107+
type: string
108+
url:
109+
description: The router to use. Not needed if you only have one.
110+
required: false
111+
type: url
112+
{% endconfiguration %}
113+
114+
To use notifications, please see the [getting started with automation page](/getting-started/automation/).
115+
116+
## {% linkable_title Sensor %}
117+
118+
The `huawei_lte` sensor platform allows you to monitor Huawei LTE routers.
119+
120+
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.
121+
122+
To enable the sensor, add the following lines to your `configuration.yaml` file:
123+
124+
```yaml
125+
# Example configuration.yaml entry
126+
sensor:
127+
- platform: huawei_lte
128+
monitored_conditions:
129+
- device_information.SoftwareVersion
130+
- device_signal.rssi
131+
- traffic_statistics.CurrentDownloadRate
132+
- traffic_statistics.TotalConnectTime
133+
```
134+
135+
{% configuration %}
136+
monitored_conditions:
137+
description: Defines the data to monitor as sensors. Defaults to a few generally available data items expected to be available on most boxes.
138+
required: false
139+
default: Below is indicated which conditions are the default.
140+
type: list
141+
keys:
142+
device_information.SoftwareVersion:
143+
description: Software version.
144+
device_information.WanIPAddress:
145+
description: WAN interface IPv4 address.
146+
default: default
147+
device_information.WanIPv6Address:
148+
description: WAN interface IPv6 address.
149+
device_signal.rsrq:
150+
description: The signal RSRQ value.
151+
default: default
152+
device_signal.rsrp:
153+
description: The signal RSRP value.
154+
default: default
155+
device_signal.rssi:
156+
description: The signal RSSI value.
157+
default: default
158+
device_signal.sinr:
159+
description: The signal SINR value.
160+
default: default
161+
traffic_statistics.CurrentDownloadRate:
162+
description: Current download rate, bytes/sec.
163+
traffic_statistics.CurrentUploadRate:
164+
description: Current upload rate, bytes/sec.
165+
traffic_statistics.TotalUpload:
166+
description: Total bytes uploaded since last reset.
167+
traffic_statistics.TotalDownload:
168+
description: Total bytes downloaded since last reset.
169+
traffic_statistics.TotalConnectTime:
170+
description: Total time connected since last reset.
171+
{% endconfiguration %}

β€Žsource/_components/notify.huawei_lte.markdown

Lines changed: 0 additions & 46 deletions
This file was deleted.

β€Žsource/_components/sensor.huawei_lte.markdown

Lines changed: 0 additions & 75 deletions
This file was deleted.

0 commit comments

Comments
Β (0)