Skip to main content

Api wrapper for Asuswrt https://www.asus.com/ASUSWRT/ using protocol HTTP

Project description

PyAsusWrt

PyAsusWrt is a small API wrapper written in python for communication with ASUSWRT-powered routers using the HTTP or HTTPS protocols.

It is based on Asynchronous HTTP Client AioHTTP.

It was mainly developed to be used with HomeAssistant AsusWRT integration as an alternative to the excellent library currently in use AIOAsusWrt. The purpose of this library is not to replace AIOAsusWrt (which uses the SSH and Telnet protocols) but to work alongside it to allow also the use the HTTP(s) protocols, so you can choose the best solution according to your model of router.

Of course, you can use this library for any other purpose, respecting the open source license to which this library is licensed.

Note

Pull Request to HA integration is under development and will be available when and if it will be approved by HA teams.

If you cannot wait for the completion of the PR, it is possible to replace the native HA integration with this custom integration that already contains support for this new library. This custom integration is based on the native one and is to be considered for test purpose only.

Installation

Installation of the latest release is available from PyPI:

pip install pyasuswrt

How open issue and run tests

There are many versions of asuswrt firmware, sometimes they just don't work in current implementation. If you have a problem with your specific router open an issue on this repository, but please add as much info as you can and at least:

  • Model and version of router
  • Version of Asuswrt

If possible before open issue run a test on your environment, using the code inside the module test.py (you must set right login credential inside the module before running it) and then provide the error log printed by the test.

To run the test:

python test.py

Be nice!

If you like the library, why don't you support me by buying me a coffee? It would certainly motivate me to further improve this work.

Buy me a coffee!

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pyasuswrt-0.1.21.tar.gz (15.5 kB view details)

Uploaded Source

Built Distribution

pyasuswrt-0.1.21-py3-none-any.whl (14.3 kB view details)

Uploaded Python 3

File details

Details for the file pyasuswrt-0.1.21.tar.gz.

File metadata

  • Download URL: pyasuswrt-0.1.21.tar.gz
  • Upload date:
  • Size: 15.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.10.11

File hashes

Hashes for pyasuswrt-0.1.21.tar.gz
Algorithm Hash digest
SHA256 ffee28f789512eea42ce182ba6a89fa2f5a31a423daf4fdcf6bad48a813a196f
MD5 7e2333074e75274cef57730d8e298169
BLAKE2b-256 ad0915df06dd173863b224a9b61861110db5caae26b4f9c78077d64b6cc593c7

See more details on using hashes here.

File details

Details for the file pyasuswrt-0.1.21-py3-none-any.whl.

File metadata

  • Download URL: pyasuswrt-0.1.21-py3-none-any.whl
  • Upload date:
  • Size: 14.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.10.11

File hashes

Hashes for pyasuswrt-0.1.21-py3-none-any.whl
Algorithm Hash digest
SHA256 1a1da5f878868c97150e01303c8a246e1fb1f5142589da54f111425d879f4058
MD5 62be291b76426b348679303cacb7743b
BLAKE2b-256 bbe8de26161a972a73644dd8a0271e4ea0de662739f976e7f34c5e69b78a7373

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page