From 12d889a3f3415194db8071920f36ea11f9b6c341 Mon Sep 17 00:00:00 2001 From: Klaas Schoute Date: Thu, 28 Feb 2019 05:27:02 +0100 Subject: [PATCH] =?UTF-8?q?=F0=9F=9A=9C=20Merges/Redirect=20Huawei=20LTE?= =?UTF-8?q?=20component=20pages=20(#8768)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * 🚜 Merges/Redirect Huawei LTE component pages * :pencil2: Tweak --- .../device_tracker.huawei_lte.markdown | 32 ---- source/_components/huawei_lte.markdown | 141 ++++++++++++++++-- source/_components/notify.huawei_lte.markdown | 46 ------ source/_components/sensor.huawei_lte.markdown | 75 ---------- 4 files changed, 126 insertions(+), 168 deletions(-) delete mode 100644 source/_components/device_tracker.huawei_lte.markdown delete mode 100644 source/_components/notify.huawei_lte.markdown delete mode 100644 source/_components/sensor.huawei_lte.markdown diff --git a/source/_components/device_tracker.huawei_lte.markdown b/source/_components/device_tracker.huawei_lte.markdown deleted file mode 100644 index 7beb8c788cc..00000000000 --- a/source/_components/device_tracker.huawei_lte.markdown +++ /dev/null @@ -1,32 +0,0 @@ ---- -layout: page -title: "Huawei LTE Router Device Tracker" -description: "Instructions on how to use Huawei LTE routers to track devices within Home Assistant." -date: 2018-09-08 20:00 -sidebar: true -comments: false -sharing: true -footer: true -logo: huawei.svg -ha_category: Presence Detection -ha_release: 0.79 ---- - - -This platform offers presence detection by looking at connected devices to a [Huawei LTE router](https://consumer.huawei.com/en/smart-home/). - -This requires you to have set up the [Huawei LTE component](/components/huawei_lte/). - -## {% linkable_title Configuration %} - -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. diff --git a/source/_components/huawei_lte.markdown b/source/_components/huawei_lte.markdown index ba637bb5d79..e40859b3446 100644 --- a/source/_components/huawei_lte.markdown +++ b/source/_components/huawei_lte.markdown @@ -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 %} @@ -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 %} @@ -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 %} \ No newline at end of file diff --git a/source/_components/notify.huawei_lte.markdown b/source/_components/notify.huawei_lte.markdown deleted file mode 100644 index 1baf01ca9a7..00000000000 --- a/source/_components/notify.huawei_lte.markdown +++ /dev/null @@ -1,46 +0,0 @@ ---- -layout: page -title: "Huawei LTE Notify" -description: "Instructions on how to add Huawei LTE notifications to Home Assistant." -date: 2018-12-23 17:00 -sidebar: true -comments: false -sharing: true -footer: true -logo: huawei.svg -ha_category: Notifications -ha_release: 0.88 ---- - -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. - -This requires you to have set up the -[Huawei LTE component](/components/huawei_lte/). - -```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/). diff --git a/source/_components/sensor.huawei_lte.markdown b/source/_components/sensor.huawei_lte.markdown deleted file mode 100644 index 673ac3186f8..00000000000 --- a/source/_components/sensor.huawei_lte.markdown +++ /dev/null @@ -1,75 +0,0 @@ ---- -layout: page -title: "Huawei LTE Router Sensor" -description: "Instructions on how to integrate Huawei LTE router sensors into Home Assistant." -date: 2018-09-08 20:00 -sidebar: true -comments: false -sharing: true -footer: true -logo: huawei.svg -ha_category: Network -ha_iot_class: "Local Polling" -ha_release: 0.79 ---- - -The `huawei_lte` sensor platform allows you to monitor Huawei LTE routers. - -## {% linkable_title Configuration %} - -This platform requires you to have set up the [Huawei LTE component](/components/huawei_lte/). - -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. - -## {% linkable_title Configuration %} - -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 %}