Skip to content

Commit

Permalink
Prepare for 0.2.6
Browse files Browse the repository at this point in the history
  • Loading branch information
Vaskivskyi committed Apr 11, 2022
1 parent 7d91cc1 commit 090265f
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 9 deletions.
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
## AsusRouter

**AsusRouter** is an API wrapper for communication with ASUSWRT-powered routers using the HTTP or HTTPS protocols.
**AsusRouter** is an API wrapper for communication with ASUSWRT-powered routers using HTTP or HTTPS protocols. This version is not final yet and has some issues. Please, consider them.


## Supported features

- **Monitoring data** when `enable_monitor` parameter of `AsusRrouter` is set to `True` (default)
- **Sending commands** to the device when `enable_control` is set to `True` (default is `False`)
- SSL server certificates on the device side (including certificate check on connection from Trusted Root Certificates or your own specified certificate file)s
- SSL server certificates on the device side (including certificate check on the connection from Trusted Root Certificates or your own specified certificate file)s


## Installation
Expand All @@ -21,7 +21,7 @@ pip install asusrouter

## Usage

Once installed, you can import `AsusRouter` class from the module. Example shows the default parameters except for `host`, `username` and `password`.
Once installed, you can import the `AsusRouter` class from the module. Example shows the default parameters except for `host`, `username` and `password`.

```python
from asusrouter.asusrouter import AsusRouter
Expand All @@ -47,7 +47,7 @@ router.async_initialize()

#### Monitors and additional methods

`AsusRouter` class has 3 monitors to load large part of useful data from the device. All of them require `enable_monitor` parameter of `AsusRrouter` to be set to `True`. The following methods can be used:
`AsusRouter` class has 3 monitors to load a large part of useful data from the device. All of them require the `enable_monitor` parameter of `AsusRrouter` to be set to `True`. The following methods can be used:

```python
router.async_monitor_main()
Expand All @@ -63,12 +63,12 @@ Moreover, some additional methods are also available (that could partially rely
router.async_find_interfaces()
```

The detailed description of monitors and monitoring methods is available here (*in work*).
A detailed description of monitors and monitoring methods is available here (*in work*).


#### Commands

`AsusRouter` class supports sending commands to the device using the `async_command` method. Sending commands requires `enable_command` parameter of `AsusRrouter` to be set to `True`.
`AsusRouter` class supports sending commands to the device using the `async_command` method. Sending commands requires the `enable_command` parameter of `AsusRrouter` to be set to `True`.

For example, to reboot the device:

Expand All @@ -77,12 +77,12 @@ For example, to reboot the device:
router.async_command(commands = {"rc_service": "reboot"}, action_mode = "apply")
```

Commands to the method should be sent as a `dict` of `command: value`. Please, refer to the Command List (*in work*) for the detailed explanation on the available commands.
Commands to the method should be sent as a `dict` of `command: value`. Please, refer to the Command List (*in work*) for a detailed explanation of the available commands.


## Supported devices and firmware

Currently, **AsusRouter** is tested on my only router model. If you wish to help me making it better, feel free to open a [Pull Request](https://github.com/Vaskivskyi/asusrouter/pulls) with your model name and firmware (if everything works well). Chances are much higher that some problems may occur on other devices, so [Issues](https://github.com/Vaskivskyi/asusrouter/issues) are waiting for a new one.
Currently, **AsusRouter** is tested on my only router model. If you wish to help me make it better, feel free to open a [Pull Request](https://github.com/Vaskivskyi/asusrouter/pulls) with your model name and firmware (if everything works well). Chances are much higher that some problems may occur on other devices, so [Issues](https://github.com/Vaskivskyi/asusrouter/issues) are waiting for a new one.


### Devices
Expand Down
2 changes: 1 addition & 1 deletion setup.cfg
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[metadata]
name = asusrouter
version = 0.2.5
version = 0.2.6
author = Yevhenii Vaskivskyi
author_email = [email protected]
license = Apache-2.0
Expand Down

0 comments on commit 090265f

Please sign in to comment.