hurocon 0.3.0

Command line interface tool for interacting with Huawei LTE routers

Hurocon

Hurocon (huawei router control) - command line interface tool for interacting with Huawei LTE routers

• Features
• Supported Devices
• Availability
• Installation
• Quickstart
• Development
• Special

Features

• Device Control
  • Reboot
• SMS Control
  • Send

There are many features planned for future releases, you can view their full list here

Supported Devices

Full list of supported devices is available on this link.

Availability

This tool is OS-independent, which means it should work on any platform where python3 can run. Minimal python3 version required for this package is 3.7. This does not mean that it cannot work on python versions below the minimal, but its behavior is unpredictable and no support will be provided for any issues.

Installation

• You can install it from PyPi:

  pip install hurocon
  

• Or directly from Github repo:

  pip install git+https://github.com/maximilionus/hurocon.git
  

Currently can only be installed with pip on python >= 3.7. Binary bundle (pyinstaller-based) is planned but no ETA yet

Quickstart

Intro

After successful installation of this tool it can be accessed in shell using the following commands:

$ hurocon
# OR
$ python -m hurocon

You can also view a list of all main commands with:

$ hurocon --help

Each command and subcommand in this tool has a special --help flag to display detailed information about it

Authentication

Foremost, you need to specify the authentication details so that this tool can access the device in the future. You do it in two ways.

• In interactive mode:

  $ hurocon auth login
  

• Manually, by running:

  # Initialize local configuration file
  $ hurocon config init
  
  # Show path to local configuration file
  $ hurocon config path
  

  And then manually editing the json file with any text editor. It has a human-readable structure, so every part of it is exactly what you think it is.

Testing Connection

After auth details successfully specified you can test your connection with router by running

$ hurocon auth test

# Returns
# Success: Successful Authentication
# Failure: Auth failed, reason: "..."

Conclusion

That's it, you're ready to go. And remember - no matter how deep you go, --help flag is always here to help 👍

Development

Prepare The Environment

To prepare the development environment for this project, follow these steps:

1. Install poetry package manager with (pip, standalone (recommended))

2. Run the command below to prepare the virtual environment for this project

   $ poetry install
   

3. That's it, now you can modify the code the way you want and test it in two ways

   • Run this tool with

     $ poetry run hurocon
     

   • Or activate the project environment with

     $ poetry shell
     Spawning shell within ...
     
     $ hurocon
     

Build

Python Package

To build this tool to package (sdist and wheel) you should execute:

$ poetry build
Building hurocon ...

Prepared for distribution package will be located in ./dist/ directory

Special

Big thanks to Adam Schubert for his amazing huawei-lte-api package, that made this whole thing possible.