Add set-client-name

Author: D-J-See

src/tplink_omada_client/cli/__init__.py

@@ -22,7 +22,9 @@
     command_targets,
     command_switch_ports,
     command_unblock_client,
-    command_set_device_led
+    command_set_device_led,
+    command_set_client_name
+
 )
 
 def main(argv: Union[Sequence[str], None] = None) -> int:
@@ -57,6 +59,7 @@ def main(argv: Union[Sequence[str], None] = None) -> int:
     command_targets.arg_parser(subparsers)
     command_unblock_client.arg_parser(subparsers)
     command_set_device_led.arg_parser(subparsers)
+    command_set_client_name.arg_parser(subparsers)
 
     try:
         args = parser.parse_args(args=argv)

src/tplink_omada_client/cli/command_set_client_name.py

@@ -0,0 +1,33 @@
+"""Implementation for 'set-client-name' command"""
+
+from argparse import _SubParsersAction
+import datetime
+from tplink_omada_client.clients import OmadaWiredClientDetails, OmadaWirelessClientDetails
+
+from .config import get_target_config, to_omada_connection
+from .util import get_device_by_mac_or_name, get_target_argument
+
+async def command_set_client_name(args) -> int:
+    """Executes 'set-client-name' command"""
+    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)
+        mac = await site_client.get_client(args['mac'])
+        name = args['name']
+        await site_client.set_client_name(mac, name)
+    return 0
+
+def arg_parser(subparsers: _SubParsersAction) -> None:
+    """Configures arguments parser for 'set-client-name' command"""
+    parser = subparsers.add_parser(
+        "set-client-name",
+        help="Sets the name of an omada client")
+    parser.add_argument(
+        "mac",
+        help="The MAC address of the client to set the name for",
+    )
+    parser.add_argument("name", help="The new name of the client")
+
+    parser.set_defaults(func=command_set_client_name)

src/tplink_omada_client/omadasiteclient.py

@@ -476,3 +476,18 @@ async def set_led_setting(self, mac_or_device: Union[str, OmadaDevice], setting:
         )
 
         return True
+
+    async def set_client_name(self, mac_or_client: Union[str, OmadaNetworkClient], name):
+        """Sets the name of a client"""
+        if isinstance(mac_or_client, OmadaConnectedClient):
+            mac = mac_or_client.mac
+        else:
+            mac = mac_or_client
+        payload = {"name": name }
+        await self._api.request(
+            "patch",
+            self._api.format_url(f"clients/{mac}", self._site_id),
+            payload=payload,
+        )
+
+        return True