Huawei LTE

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.

Configuration

To add the Huawei LTE integration to your Home Assistant instance, use this My button:

Huawei LTE can be auto-discovered by Home Assistant. If an instance was found, it will be shown as Discovered. You can then set it up right away.

Manual configuration steps

If it wasn’t discovered automatically, don’t worry! You can set up a manual integration entry:

  • Browse to your Home Assistant instance.

  • Go to Settings > Devices & Services.

  • In the bottom right corner, select the Add Integration button.

  • From the list, select Huawei LTE.

  • Follow the instructions on screen to complete the setup.

URL

Base URL to the API of the router. Typically, something like http://192.168.X.1 where X is, for example, 1, 8, or 100. This is the beginning of the location shown in a browser when accessing the router’s web interface.

Verify SSL certificate

Whether to verify the SSL certificate of the router when accessing it. Applicable only if the router is accessed via HTTPS. For example, if the configured URL starts with https://.

Username

Username for accessing the router’s API. Typically, either admin, or left empty (recommended if that works).

Password

Password for accessing the router’s API.

Options

Options for Huawei LTE can be set via the user interface, by taking the following steps:

  • Browse to your Home Assistant instance.
  • Go to Settings > Devices & Services.
  • If multiple instances of Huawei LTE are configured, choose the instance you want to configure.
  • Select the integration, then select Configure.
Notification service name

Name of the notification service. Used to distinguish between notification services in case there are multiple Huawei LTE devices configured. The name here will be prefixed with notify.. For example, specifying huawei_lte will yield notify.huawei_lte as the complete service name.

Notification recipients

Comma separated list of default recipient SMS phone numbers for the notification service, used in case the notification sender does not specify any. Accepted formats may vary between device models and subscription types, but international E.164 format including the + prefix and country code, numbers only, is a good first bet.

Track wired network clients

Whether the device tracker entities track also clients attached to the router’s wired Ethernet network, in addition to wireless clients.

Unauthenticated mode

Whether to run in unauthenticated mode. See above for more information between authenticated and unauthenticated modes.

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.

Removing the integration

This integration follows standard integration removal. No extra steps are required.

To remove an integration instance from Home Assistant

  1. Go to Settings > Devices & services and select the integration card.
  2. From the list of devices, select the integration instance you want to remove.
  3. Next to the entry, select the three-dot menu. Then, select Delete.