Skip to main content

Python HTTP API client for Huawei Modems

This is a python library to interact with a Huawei modem over HTTP API.

The library has been tested on these devices:

  • E5180
  • E8372
  • B315
  • e3372h

Please let me know if you tested it successfully with other modems as well.

Currently Supported

  • webserver
    • get_session_token_info: gets a session token to use
  • user
    • login: creates a new session on the HTTP API
  • sms
    • get_sms: get information from boxes: inbox, outbox
    • send_sms: sends an SMS through device's modem
    • delete_sms: deletes an sms from one of their boxes
    • sms_count: get the sms count on each box
  • ussd
    • status: get status of ussd. This will tell you if there are ussd messages available to read
    • send: sends a ussd message
    • get: retrieves a ussd message
  • wlan:
    • get_connected_hosts: gets a list of connected devices
    • block_host: blocks the device from network
    • unblock_host: unblock device on network
    • get_blocked_hosts: gets a list of blocked devices
    • is_host_blocked: checks if device is blocked
  • dialup:
    • connect_mobile: enables mobile (ie LTE / 4G / 3G / etc) network
    • disconnect_mobile: disables mobile network
    • get_mobile_status: checks the mobile connection status
  • device:
    • reboot: reboots the modem

Prerequisites

Only requests library (and its dependencies) is required.

This is requirements.txt content:

certifi==2018.11.29
chardet==3.0.4
idna>=2.6
requests>=2.0.0
urllib3>=1.22

Installing

pip install huawei-modem-api-client-through-proxy

Example

import huaweisms.api.user
import huaweisms.api.wlan
import huaweisms.api.sms

ctx = huaweisms.api.user.quick_login("myusername", "mypassword")
print(ctx)
# output: <ApiCtx modem_host=192.168.8.1>

# sending sms
huaweisms.api.sms.send_sms(
    ctx,
    'phone-number',
    'this is the sms message'
)

# connected devices
device_list = huaweisms.api.wlan.get_connected_hosts(ctx)

Note: The default modem host is assumed to be 192.168.8.1. If that is not the case for you, you can specify your modem ip as follows:

import huaweisms.api.user
ctx = huaweisms.api.user.quick_login("myusername", "mypassword", modem_host='10.11.12.13')
print(ctx)

#output: <ApiCtx modem_host=10.11.12.13>

Built With

  • requests - Python HTTP Requests for Humans™

Contributing

Send me a PM if you want to contribute.

Authors

  • Pablo Santa Cruz - Owner - pablo
  • Mka Madlavana - Collaborator - dopstar

License

This project is licensed under the MIT License - see the LICENSE.md file for details

Metadata

Release files for huawei-modem-py-api-client-through-proxy 0.0.8

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-modem-py-api-client-through-proxy 0.0.8
File Size Uploaded Provenance Actions
huawei-modem-py-api-client-through-proxy-0.0.8.tar.gz 8.3 kB Without provenance Details for huawei-modem-py-api-client-through-proxy-0.0.8.tar.gz

Release files / huawei-modem-py-api-client-through-proxy-0.0.8.tar.gz

Download URL huawei-modem-py-api-client-through-proxy-0.0.8.tar.gz
Size 8.3 kB
Tags Source
SHA-256 checksum
How to use checksums
086b446edb3422dc35153893d98b22df45d28057aa7653e5150788508dd30229
BLAKE2b-256 checksum
How to use checksums
4eb2e47e9911fd9584389fdde841eb604041d961cf25c4f2f534365b4bf19088
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.41.1 CPython/3.7.5

Security for huawei-modem-py-api-client-through-proxy 0.0.8

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

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