home-assistant.io/source/_integrations/huawei_lte.markdown
Ville Skyttä cf3e51ac8f
Remove unmaintained and incomplete list of huawei_lte devices (#35346)
Point more prominently to upstream list instead.
2024-10-23 11:09:21 +02:00

3.8 KiB

title, description, ha_category, ha_release, ha_iot_class, ha_config_flow, ha_codeowners, ha_domain, ha_ssdp, ha_platforms, ha_integration_type
title description ha_category ha_release ha_iot_class ha_config_flow ha_codeowners ha_domain ha_ssdp ha_platforms ha_integration_type
Huawei LTE Instructions on how to integrate Huawei LTE router and modem devices with Home Assistant.
Binary sensor
Button
Network
Notifications
Presence detection
Select
Sensor
Switch
0.79 Local Polling true
@scop
@fphammerle
huawei_lte true
binary_sensor
button
device_tracker
notify
select
sensor
switch
integration

The Huawei LTE router and modem integration for Home Assistant allows you to observe and control Huawei LTE devices.

There is currently support for the following platforms within Home Assistant:

  • Presence detection - device tracker for connected devices
  • Notifications - via SMS
  • Sensors - device, network, signal, SMS count, traffic, and battery information
  • Switch - mobile data on/off, Wi-Fi guest network on/off
  • Binary sensor - mobile and Wi-Fi connection status, SMS storage full/not
  • Button - clear traffic statistics, restart
  • Select - preferred network mode

Setup

The integration can be enabled using the frontend, see below for details. Additionally, if the SSDP integration is 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 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 is active or vice versa. The exact list of features requiring authentication to work varies by device and firmware version. The integration will try to use all configured ones and fail gracefully if it detects one requiring authentication in unauthenticated mode.

Only a subset of the entities provided by the target device are enabled by default:

  • WAN IP address sensor
  • LTE signal sensors RSRQ, RSRP, RSSI, and SINR
  • mobile data and Wi-Fi guest network switches
  • mobile connection binary sensor
  • device tracker entries

The rest are added to the entity registry, but disabled by default.

Support for different categories of information and thus available entities varies by device model and firmware version.

{% include integrations/config_flow.md %}

Unauthenticated mode and default list of notification recipient phone numbers can be set using the integration's configuration options.

Actions

The following router action actions are available. When invoked by a user, administrator access is required.

Action huawei_lte.suspend_integration

Suspend integration. Suspending logs the integration out from the router, and stops accessing it. Useful e.g., if accessing the router web interface from another source such as a web browser is temporarily required. Invoke the huawei_lte.resume_integration action to resume.

Data attribute Optional Description
url yes, if only one router configured Router URL.

Action huawei_lte.resume_integration

Resume suspended integration.

Data attribute Optional Description
url yes, if only one router configured Router URL.

Tested devices

It is the intention and highly likely that this integration works with all devices reported working with the underlying huawei-lte-api library.

It will not work on ones noted as not working in that list.