Merge pull request #13 from MarkGodwin/feature/raw_data

Feature/raw data

Author: MarkGodwin

.vscode/launch.json

@@ -5,13 +5,36 @@
     "version": "0.2.0",
     "configurations": [
         {
-            "name": "Python: Test Client",
+            "name": "CLI: List Devices",
             "type": "python",
             "request": "launch",
-            "program": "sample_client.py",
-            "console": "integratedTerminal",
+            "module": "tplink_omada_client.cli",
             "justMyCode": true,
-            "args": ["https://192.168.1.50", "admin", "admin"]
+            "args": ["devices"]
+        },
+        {
+            "name": "CLI: List Targets",
+            "type": "python",
+            "request": "launch",
+            "module": "tplink_omada_client.cli",
+            "justMyCode": true,
+            "args": ["targets"]
+        },
+        {
+            "name": "CLI: List Switches",
+            "type": "python",
+            "request": "launch",
+            "module": "tplink_omada_client.cli",
+            "justMyCode": true,
+            "args": ["switches"]
+        },
+        {
+            "name": "CLI: Get Switch",
+            "type": "python",
+            "request": "launch",
+            "module": "tplink_omada_client.cli",
+            "justMyCode": true,
+            "args": ["switch", "Main Switch", "--dump"]
         }
     ]
 }

README.md

@@ -29,7 +29,7 @@ This package provides a simple CLI for interacting with one or more Omada Contro
 CLI, you must first target a Controller.
 
 ```sh
-$ omada -t NAME target --url https://your.omada.controller.here --user admin --password password --site MySite
+$ omada -t NAME target --url https://your.omada.controller.here --user admin --password password --site MySite --set-default
 ```
 
 Where `NAME` is a name of your choosing to identify the targeted controller. `--site` defaults to the Omada
@@ -39,7 +39,7 @@ password.
 Once you have successfully targeted a controller you can test that things are working by running:
 
 ```sh
-$ omada -t NAME devices
+$ omada devices
 ```
 
 This will list all the devices being managed by your controller.
@@ -50,6 +50,9 @@ To see a list of all the available commands, run:
 $ omada -h
 ```
 
+You can set up multiple targets (controllers and sites), and specify the target with the `-t <NAME>` parameter.
+If you don't specify a target, the default will be used, if that has been set.
+
 The CLI is still young so if there is any functionality you need, please create an issue and let us know.
 
 ## Future

pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "tplink_omada_client"
-version = "1.2.1"
+version = "1.2.2"
 authors = [
   { name="Mark Godwin", email="author@example.com" },
 ]

src/tplink_omada_client/cli/__init__.py

@@ -12,6 +12,7 @@
     command_switches,
     command_target,
     command_targets,
+    command_default
 )
 
 def main(argv: Union[Sequence[str], None] = None) -> int:
@@ -22,6 +23,7 @@ def main(argv: Union[Sequence[str], None] = None) -> int:
     parser.add_argument(
         '-t', '--target',
         help="The target Omada controller",
+        default=""
     )
 
     subparsers = parser.add_subparsers(
@@ -34,6 +36,7 @@ def main(argv: Union[Sequence[str], None] = None) -> int:
     command_switches.arg_parser(subparsers)
     command_target.arg_parser(subparsers)
     command_targets.arg_parser(subparsers)
+    command_default.arg_parser(subparsers)
 
     try:
         args = parser.parse_args(args=argv)

src/tplink_omada_client/cli/command_default.py

@@ -0,0 +1,22 @@
+"""Implementation of 'default' command"""
+from argparse import _SubParsersAction, ArgumentError
+import getpass
+
+from .util import assert_target_argument
+from .config import ControllerConfig, set_default_target, to_omada_connection, get_target_config
+
+async def command_target(args) -> int:
+    """Executes 'default' command"""
+    target = assert_target_argument(args)
+    config = get_target_config(target)
+
+    set_default_target(target)
+    return 0
+
+def arg_parser(subparsers: _SubParsersAction) -> None:
+    """Configures argument parser for 'default' command"""
+    set_parser = subparsers.add_parser(
+        "default",
+        help="Sets the default target",
+    )
+    set_parser.set_defaults(func=command_target)

src/tplink_omada_client/cli/command_devices.py

@@ -1,19 +1,20 @@
 """Implementation for 'devices' command"""
 
 from argparse import _SubParsersAction
-
+import json
 from .config import get_target_config, to_omada_connection
-from .util import assert_target_argument
+from .util import dump_raw_data, get_target_argument
 
 async def command_devices(args) -> int:
     """Executes 'devices' command"""
-    controller = assert_target_argument(args)
+    controller = get_target_argument(args)
     config = get_target_config(controller)
 
     async with to_omada_connection(config) as client:
         site_client = await client.get_site_client(config.site)
         for device in await site_client.get_devices():
-            print(f"{device.mac} {device.ip_address:>15} {device.type:>6}  {device.name:20} {device.model_display_name}")
+            print(f"{device.mac} {device.ip_address:>15} {device.type:>7}  {device.name:20} {device.model_display_name}")
+            dump_raw_data(args, device)
     return 0
 
 def arg_parser(subparsers: _SubParsersAction) -> None:
@@ -22,4 +23,6 @@ def arg_parser(subparsers: _SubParsersAction) -> None:
         "devices",
         aliases=['d'],
         help="Lists devices managed by Omada Controller")
+    devices_parser.add_argument('-d', '--dump', help="Output raw device information",  action='store_true')
+
     devices_parser.set_defaults(func=command_devices)

src/tplink_omada_client/cli/command_switch.py

@@ -3,16 +3,17 @@
 from argparse import ArgumentParser
 
 from .config import get_target_config, to_omada_connection
-from .util import assert_target_argument
+from .util import dump_raw_data, get_mac, get_target_argument
 
 async def command_switch(args) -> int:
     """Executes 'switch' command"""
-    controller = assert_target_argument(args)
+    controller = get_target_argument(args)
     config = get_target_config(controller)
 
     async with to_omada_connection(config) as client:
         site_client = await client.get_site_client(config.site)
-        switch = await site_client.get_switch(args['mac'])
+        mac = await get_mac(site_client, args['mac'])
+        switch = await site_client.get_switch(mac)
         print(f"Name: {switch.name}")
         print(f"Address: {switch.mac} ({switch.ip_address})")
         print(f"Ports: {switch.number_of_ports}")
@@ -29,6 +30,8 @@ async def command_switch(args) -> int:
             for downlink in switch.downlink:
                 print(f"- {downlink.mac} {downlink.name}")
 
+        dump_raw_data(args, switch)
+
     return 0
 
 def arg_parser(subparsers) -> None:
@@ -41,5 +44,7 @@ def arg_parser(subparsers) -> None:
 
     switch_parser.add_argument(
         "mac",
-        help="The MAC address of the switch",
+        help="The MAC address or name of the switch",
     )
+    switch_parser.add_argument('-d', '--dump', help="Output raw device information",  action='store_true')
+

src/tplink_omada_client/cli/command_switches.py

@@ -3,11 +3,11 @@
 from argparse import _SubParsersAction
 
 from .config import get_target_config, to_omada_connection
-from .util import assert_target_argument
+from .util import dump_raw_data, get_target_argument
 
 async def command_switches(args) -> int:
     """Executes 'switches' command"""
-    controller = assert_target_argument(args)
+    controller = get_target_argument(args)
     config = get_target_config(controller)
 
     async with to_omada_connection(config) as client:
@@ -25,6 +25,8 @@ async def command_switches(args) -> int:
                     print("\u26a1", end="")
                 else:
                     print("  ", end="")
+
+            dump_raw_data(args, switch)
             print()
     return 0
 
@@ -35,3 +37,4 @@ def arg_parser(subparsers: _SubParsersAction) -> None:
         aliases=['s'],
         help="Lists switches managed by Omada Controller")
     switches_parser.set_defaults(func=command_switches)
+    switches_parser.add_argument('-d', '--dump', help="Output raw device information",  action='store_true')

src/tplink_omada_client/cli/command_target.py

@@ -1,13 +1,15 @@
 """Implementation of 'target' command"""
-from argparse import _SubParsersAction
+from argparse import _SubParsersAction, ArgumentError
 import getpass
+import json
 
-from .util import assert_target_argument
+from .util import get_target_argument
 from .config import ControllerConfig, set_target_config, to_omada_connection
 
 async def command_target(args) -> int:
     """Executes 'target' command"""
-    target = assert_target_argument(args)
+    target = get_target_argument(args)
+
     if args['password']:
         password = args['password']
     else:
@@ -18,15 +20,16 @@ async def command_target(args) -> int:
         password=password,
         site=args['site'],
     )
+    
     # Connect to controller to validate config
     async with to_omada_connection(config) as client:
         name = await client.get_controller_name()
         for site in await client.get_sites():
             if args['site'] == site.name:
                 print(f"Set target {target} to controller {name} and site {site.name}")
-                set_target_config(target, config)
+                set_target_config(target, config, args['set_default'])
 
-    return 1
+    return 0
 
 def arg_parser(subparsers: _SubParsersAction) -> None:
     """Configures argument parser for 'target' command"""
@@ -54,4 +57,9 @@ def arg_parser(subparsers: _SubParsersAction) -> None:
         help="The Omada site to user",
         default = "Default",
     )
+    set_parser.add_argument(
+        '-sd',
+        '--set-default',
+        help="Set this target as the default",
+        action='store_true')
 

src/tplink_omada_client/cli/command_targets.py

@@ -8,8 +8,8 @@
 async def command_targets(args) -> int: # pylint: disable=unused-argument
     """Executes 'targets' command"""
     controllers = get_targets()
-    for (controller, url) in controllers:
-        print(f"{controller:15} {url}")
+    for (controller, url, is_default) in controllers:
+        print(f"{('*' if is_default else' ')} {controller:15} {url}")
     return 0
 
 def arg_parser(subparsers: _SubParsersAction) -> None: