Skip to main content

huawei-lte-api

API For huawei LAN/WAN LTE Modems, you can use this to simply send SMS, get information about your internet usage, signal, and tons of other stuff

Tox tests

Please consider sponsoring if you're using this package commercially, my time is not free :) You can sponsor me by clicking on "Sponsor" button in top button row. Thank You.

Tested on:

3G/LTE Routers:

  • Huawei B310s-22
  • Huawei B311-221
  • Huawei B315s-22
  • Huawei B525s-23a
  • Huawei B525s-65a
  • Huawei B715s-23c
  • Huawei B528s
  • Huawei B535-232
  • Huawei B628-265
  • Huawei B612-233
  • Huawei B818-263
  • Huawei E5180s-22
  • Huawei E5186s-22a
  • Huawei E5576-320
  • Huawei E5577Cs-321
  • Huawei E8231
  • Huawei E5573s-320
  • SoyeaLink B535-333

3G/LTE USB sticks:

(Device must support NETWork mode aka. "HiLink" version, it wont work with serial mode)

  • Huawei E3131
  • Huawei E8372h-608
  • Huawei E3372
  • Huawei E3531
  • Huawei E5530As-2

5G Routers:

  • Huawei 5G CPE Pro 2 (H122-373)
  • Huawei 5G CPE Pro (H112-372)
  • Huawei 5G CPE6 (H165-383)

(probably will work for other Huawei LTE devices too)

Will NOT work on:

LTE Routers:

  • Huawei B2368-22 (Incompatible firmware, testing device needed!)
  • Huawei B593s-22 (Incompatible firmware, testing device needed!)

Installation

PIP (pip3 on some distros)

pip install huawei-lte-api

Repository

You can also use these repositories maintained by me

Debian and derivatives

Add repository by running these commands

wget -O- https://repository.salamek.cz/deb/salamek.gpg | sudo tee /usr/share/keyrings/salamek-archive-keyring.gpg
echo "deb     [signed-by=/usr/share/keyrings/salamek-archive-keyring.gpg] https://repository.salamek.cz/deb/pub all main" | sudo tee /etc/apt/sources.list.d/salamek.cz.list

And then you can install a package python3-huawei-lte-api

apt update && apt install python3-huawei-lte-api

Archlinux

Add repository by adding this at end of file /etc/pacman.conf

[salamek]
Server = https://repository.salamek.cz/arch/pub/any
SigLevel = Optional

and then install by running

pacman -Sy python-huawei-lte-api

Gentoo

emerge dev-python/huawei-lte-api

Usage

from huawei_lte_api.Client import Client
from huawei_lte_api.Connection import Connection

# with Connection('http://192.168.8.1/') as connection: For limited access, I have valid credentials no need for limited access
with Connection("http://admin:MY_SUPER_TRUPER_PASSWORD@192.168.8.1/") as connection:
    client = Client(connection)  # This just simplifies access to separate API groups, you can use device = Device(connection) if you want

    print(client.device.signal())  # Can be accessed without authorization
    print(client.device.information())  # Needs valid authorization, will throw exception if invalid credentials are passed in URL


# For more API calls just look on code in the huawei_lte_api/api folder, there is no separate DOC yet

Result dict

{
    "DeviceName": "B310s-22",
    "SerialNumber": "MY_SERIAL_NUMBER",
    "Imei": "MY_IMEI",
    "Imsi": "MY_IMSI",
    "Iccid": "MY_ICCID",
    "Msisdn": None,
    "HardwareVersion": "WL1B310FM03",
    "SoftwareVersion": "21.311.06.03.55",
    "WebUIVersion": "17.100.09.00.03",
    "MacAddress1": "EHM:MY:MAC",
    "MacAddress2": None,
    "ProductFamily": "LTE",
    "Classify": "cpe",
    "supportmode": None,
    "workmode": "LTE",
}

Code examples

Some code examples are in /examples folder

Monitoring

SMS

Ports to other languages

Donations

  • 250 CZK (9.79 EUR) for B535-232 fund, thx @larsvinc !
  • 371,69 CZK (14.32 EUR) by Oleg Jusaew
  • 292 CZK (11.50 EUR) by Toth-Mate Akos
  • 441 CZK (18.12 EUR) by Olexandr Shamin

Metadata

Release files for huawei-lte-api 2.0.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for huawei-lte-api 2.0.1
File Size Uploaded
huawei_lte_api-2.0.1.tar.gz 46.8 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for huawei-lte-api 2.0.1
File Interpreter ABI Platform
huawei_lte_api-2.0.1-py3-none-any.whl Python 3 none any Details

Total release size: 112.5 kB

Release files / huawei_lte_api-2.0.1.tar.gz

Download URL huawei_lte_api-2.0.1.tar.gz
Size 46.8 kB
Tags Source
SHA-256 checksum
How to use checksums
a30329eb50579bde65fd35f5246f5b416d2f530e1ac3136428adea533e0a307e
BLAKE2b-256 checksum
How to use checksums
2ca855aac0383b66fbccd4f30933ffaae322692635eadcaf1bc432a998765c50
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.13.5

Release files / huawei_lte_api-2.0.1-py3-none-any.whl

Download URL huawei_lte_api-2.0.1-py3-none-any.whl
Size 65.7 kB
Tags Python 3
SHA-256 checksum
How to use checksums
23a6af2e8553e11ae3bd0d8df895fc9fddcb16bba15be3b2b1443576f4e32522
BLAKE2b-256 checksum
How to use checksums
092c03e2e4958e49efdc52a7de2b7cf5e299c5846c0d7b2eb682d533a8f3f519
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.13.5

Release history Release notifications | RSS feed

This release

2.0.1 This release

2 release files

1.11.0

1 release file

1.10.0

1 release file

1.9.3

1 release file

1.8.1

1 release file

1.7.3

1 release file

1.6.11

1 release file

1.6.10

1 release file

1.6.9

1 release file

1.6.8

1 release file

1.6.7

1 release file

1.6.4

1 release file

1.6.3

1 release file

1.6.1

1 release file

1.6.0

1 release file

1.5.4

1 release file

1.5.2

1 release file

1.5.1

1 release file

1.5.0

1 release file

1.4.18

1 release file

1.4.17

1 release file

1.4.16

1 release file

1.4.15

1 release file

1.4.14

1 release file

1.4.12

1 release file

1.4.11

1 release file

1.4.10

1 release file

1.4.9

1 release file

1.4.7

1 release file

1.4.6

1 release file

1.4.5

1 release file

1.4.4

1 release file

1.4.3

1 release file

1.4.1

1 release file

1.4.0

1 release file

1.3.0

1 release file

1.2.0

1 release file

1.1.5

1 release file

1.1.4

1 release file

1.1.3

1 release file

1.1.2

1 release file

1.1.1

1 release file

1.0.16

1 release file

1.0.15

1 release file

1.0.13

1 release file

1.0.12

1 release file

1.0.11

1 release file

1.0.10

1 release file

1.0.9

1 release file

1.0.8

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page