update README.md
This commit is contained in:
parent
5a6be06cb5
commit
36372f747d
2 changed files with 29 additions and 16 deletions
43
README.md
43
README.md
|
@ -10,19 +10,27 @@
|
||||||
`aioupnp` is a python 3.6-8 library and command line tool to interact with UPnP gateways using asyncio. `aioupnp` requires the `netifaces` module.
|
`aioupnp` is a python 3.6-8 library and command line tool to interact with UPnP gateways using asyncio. `aioupnp` requires the `netifaces` module.
|
||||||
|
|
||||||
## Supported devices
|
## Supported devices
|
||||||
|
Actiontec
|
||||||
|
Airlive
|
||||||
|
ARRIS
|
||||||
|
ASUS
|
||||||
|
Belkin
|
||||||
|
Broadcom
|
||||||
|
Cisco
|
||||||
DD-WRT
|
DD-WRT
|
||||||
|
D-Link
|
||||||
|
Huawei
|
||||||
|
libupnp
|
||||||
|
Linksys
|
||||||
miniupnpd
|
miniupnpd
|
||||||
Actiontec GT784WN
|
Netgear
|
||||||
D-Link DIR-890L
|
TP-Link
|
||||||
Cisco CGA4131COM
|
ZyXEL
|
||||||
Linksys WRT1200AC
|
|
||||||
Netgear Nighthawk X4 AC2350
|
|
||||||
ASUS RT-N66U
|
|
||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
|
|
||||||
Verify the default python is python 3.6 or 3.7
|
Verify python is version 3.6-8
|
||||||
|
|
||||||
```
|
```
|
||||||
python --version
|
python --version
|
||||||
```
|
```
|
||||||
|
@ -53,9 +61,18 @@ in the order they are to be used. For example:
|
||||||
|
|
||||||
aioupnp --HOST=239.255.255.250:1900 --MAN=\"ssdp:discover\" --MX=1 --ST=upnp:rootdevice m_search
|
aioupnp --HOST=239.255.255.250:1900 --MAN=\"ssdp:discover\" --MX=1 --ST=upnp:rootdevice m_search
|
||||||
```
|
```
|
||||||
|
cli_commands = [
|
||||||
|
'm_search',
|
||||||
|
'get_external_ip',
|
||||||
|
'add_port_mapping',
|
||||||
|
'get_port_mapping_by_index',
|
||||||
|
'get_redirects',
|
||||||
|
'get_specific_port_mapping',
|
||||||
|
'delete_port_mapping',
|
||||||
|
'get_next_mapping'
|
||||||
|
]
|
||||||
### Commands
|
### Commands
|
||||||
add_port_mapping | delete_port_mapping | get_external_ip | get_next_mapping | get_port_mapping_by_index | get_redirects | debug_gateway | generate_test_data | get_specific_port_mapping | m_search
|
m_search | m_search | add_port_mapping | get_port_mapping_by_index | get_redirects | get_specific_port_mapping | delete_port_mapping | get_next_mapping
|
||||||
|
|
||||||
|
|
||||||
### Examples
|
### Examples
|
||||||
|
@ -68,10 +85,6 @@ aioupnp --HOST=239.255.255.250:1900 --MAN=\"ssdp:discover\" --MX=1 --ST=upnp:roo
|
||||||
|
|
||||||
aioupnp get_redirects
|
aioupnp get_redirects
|
||||||
|
|
||||||
#### To debug the default gateway (very verbose)
|
|
||||||
|
|
||||||
aioupnp --debug_logging debug_gateway
|
|
||||||
|
|
||||||
#### To debug the gateway discovery
|
#### To debug the gateway discovery
|
||||||
|
|
||||||
aioupnp --debug_logging m_search
|
aioupnp --debug_logging m_search
|
||||||
|
@ -90,4 +103,4 @@ This project is MIT licensed. For the full license, see [LICENSE](LICENSE).
|
||||||
|
|
||||||
## Contact
|
## Contact
|
||||||
|
|
||||||
The primary contact for this project is [@jackrobison](mailto:jack@lbry.io)
|
The primary contact for this project is [@jackrobison](mailto:jackrobison@lbry.com)
|
||||||
|
|
|
@ -2,4 +2,4 @@ __version__ = "0.0.15"
|
||||||
__author__ = "Jack Robison"
|
__author__ = "Jack Robison"
|
||||||
__maintainer__ = "Jack Robison"
|
__maintainer__ = "Jack Robison"
|
||||||
__license__ = "MIT"
|
__license__ = "MIT"
|
||||||
__email__ = "jackrobison@lbry.io"
|
__email__ = "jackrobison@lbry.com"
|
||||||
|
|
Loading…
Reference in a new issue