From 4e44eacaffc75b7eb406de672dd97a82cec937a2 Mon Sep 17 00:00:00 2001 From: Jack Robison Date: Mon, 8 Oct 2018 17:57:45 -0400 Subject: [PATCH] add examples to readme --- README.md | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/README.md b/README.md index be7b3d4..3245b25 100644 --- a/README.md +++ b/README.md @@ -24,7 +24,28 @@ aioupnp [-h] [--debug_logging=] [--interface=] add_port_mapping | delete_port_mapping | get_external_ip | get_next_mapping | get_port_mapping_by_index | get_redirects | get_soap_commands | get_specific_port_mapping | m_search +### Examples +To get the external ip address from the UPnP gateway + + aioupnp get_external_ip + +To list the active port mappings on the gateway + + aioupnp get_redirects + +To debug the default gateway + + aioupnp --debug_logging=1 m_search + +To debug a gateway on a non default network interface + + aioupnp --interface=vmnet1 --debug_logging=1 m_search + +To debug a gateway on a non default network interface that isn't the router + + aioupnp --interface=vmnet1 --gateway_address=192.168.1.106 --debug_logging=1 m_search + ## License This project is MIT licensed. For the full license, see [LICENSE](LICENSE).