huaweisms is a python api client for Huawei Modems.
Project description
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
- B529s-23a
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
- sms_set_read: set the sms status to read
- 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
- switch_wlan_24ghz: allows to switch on or off the wlan 2.4Ghz module of the router
- switch_wlan_5ghz: allows to switch on or off the wlan 5Ghz module of the router
- 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
requests
library (and its dependencies) is required.
six
library (and its dependencies for Python 2 and 3 compatibility)
typing
library (support for type hints)
This is requirements.txt
content:
certifi==2018.11.29
chardet==3.0.4
idna>=2.6
requests>=2.0.0
urllib3>=1.22
typing>=3.7.4
six>=1.12.0
Installing
pip install huawei-modem-api-client
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
License
This project is licensed under the MIT License - see the LICENSE.md file for details
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for huawei-modem-api-client-1.1.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0f592b85bf3a8c94316c52880d72ebc2f377e4844d9d56937942437488cf4575 |
|
MD5 | d9e379f21c5a278a8706915ba25ea6f3 |
|
BLAKE2b-256 | ce1774c52c2e628c129d55d86dc35a34754588353602d4638f969df7f1cfbf25 |
Hashes for huawei_modem_api_client-1.1.0-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | fb547145aae314143b978c0e010e022089ed528e0e7a3d7d22081a5d2b484129 |
|
MD5 | 85fe50ec8c026f26fccde5c08f6b6b5b |
|
BLAKE2b-256 | 4719c51f3064753c01a290365791801a6b62a90e7ed89c2d68c784edca4c0e2b |