tplinkrouterc6u 5.4.1__tar.gz → 5.5.0__tar.gz

{tplinkrouterc6u-5.4.1 → tplinkrouterc6u-5.5.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: tplinkrouterc6u
-Version: 5.4.1
+Version: 5.5.0
 Summary: TP-Link Router API
 Home-page: https://github.com/AlexandrErohin/TP-Link-Archer-C6U
 Author: Alex Erohin
@@ -53,6 +53,7 @@ from tplinkrouterc6u import (
     TplinkC1200Router,
     TplinkC5400XRouter,
     TPLinkMRClient,
+    TPLinkVRClient,
     TPLinkEXClient,
     TPLinkXDRClient,
     TPLinkDecoClient,
@@ -167,6 +168,7 @@ or you have TP-link C5400X or similar router you need to get web encrypted passw
 | wan_ipv4_uptime | Internet Uptime | int, None |
 | mem_usage | Memory usage in percentage between 0 and 1 | float, None |
 | cpu_usage | CPU usage in percentage between 0 and 1 | float, None |
+| conn_type | Connection type | str, None |
 | devices | List of all connectedd devices | list[[Device](#device)] |
 
 ### <a id="device">Device</a>
@@ -318,7 +320,9 @@ or you have TP-link C5400X or similar router you need to get web encrypted passw
 - Archer MR600 (v1, v2, v3)
 - Archer VR600 v3
 - Archer VR900v
+- Archer VR1200v v1
 - Archer VR2100v v1
+- Archer VX1800v v1.0
 - Deco M4 2.0
 - Deco M4R 2.0
 - Deco M5 v3

{tplinkrouterc6u-5.4.1 → tplinkrouterc6u-5.5.0}/README.md

@@ -22,6 +22,7 @@ from tplinkrouterc6u import (
     TplinkC1200Router,
     TplinkC5400XRouter,
     TPLinkMRClient,
+    TPLinkVRClient,
     TPLinkEXClient,
     TPLinkXDRClient,
     TPLinkDecoClient,
@@ -136,6 +137,7 @@ or you have TP-link C5400X or similar router you need to get web encrypted passw
 | wan_ipv4_uptime | Internet Uptime | int, None |
 | mem_usage | Memory usage in percentage between 0 and 1 | float, None |
 | cpu_usage | CPU usage in percentage between 0 and 1 | float, None |
+| conn_type | Connection type | str, None |
 | devices | List of all connectedd devices | list[[Device](#device)] |
 
 ### <a id="device">Device</a>
@@ -287,7 +289,9 @@ or you have TP-link C5400X or similar router you need to get web encrypted passw
 - Archer MR600 (v1, v2, v3)
 - Archer VR600 v3
 - Archer VR900v
+- Archer VR1200v v1
 - Archer VR2100v v1
+- Archer VX1800v v1.0
 - Deco M4 2.0
 - Deco M4R 2.0
 - Deco M5 v3

{tplinkrouterc6u-5.4.1 → tplinkrouterc6u-5.5.0}/setup.py

@@ -5,7 +5,7 @@ with open("README.md", "r") as fh:
 
 setuptools.setup(
     name="tplinkrouterc6u",
-    version="5.4.1",
+    version="5.5.0",
     author="Alex Erohin",
     author_email="alexanderErohin@yandex.ru",
     description="TP-Link Router API",

{tplinkrouterc6u-5.4.1 → tplinkrouterc6u-5.5.0}/test/test_client_c6u.py

@@ -64,6 +64,7 @@ class TestTPLinkClient(TestCase):
         ],
         "guest_5g_psk_key": "",
         "cpu_usage": 0.28,
+        "conn_type": "1",
         "guest_2g_encryption": "none",
         "wireless_5g_encryption": "psk",
         "guest_5g_ssid": "TP-Link_Guest_21CC_5G",
@@ -244,6 +245,7 @@ class TestTPLinkClient(TestCase):
         self.assertEqual(status.wifi_5g_enable, True)
         self.assertEqual(status.wan_ipv4_uptime, None)
         self.assertEqual(status.mem_usage, 0.43)
+        self.assertEqual(status.conn_type, '1')
         self.assertEqual(status.cpu_usage, 0.28)
         self.assertEqual(len(status.devices), 5)
         self.assertIsInstance(status.devices[0], Device)

{tplinkrouterc6u-5.4.1 → tplinkrouterc6u-5.5.0}/test/test_client_ex.py

@@ -277,6 +277,35 @@ class TestTPLinkEXClient(TestCase):
         self.assertEqual(result.lan_ipv4_dhcp_enable, True)
         self.assertEqual(result.remote, None)
 
+    def test_get_ipv4_status_empty(self) -> None:
+
+        DEV2_ADT_LAN = ('{"data":[],"operation":"gl","oid":"DEV2_ADT_LAN","success":true}')
+        DEV2_ADT_WAN = ('{"data":[],"operation":"gl","oid":"DEV2_ADT_WAN","success":true}')
+
+        class TPLinkEXClientTest(TPLinkEXClient):
+            self._token = True
+
+            def _request(self, url, method='POST', data_str=None, encrypt=False):
+                if 'DEV2_ADT_LAN' in data_str:
+                    return 200, DEV2_ADT_LAN
+                elif 'DEV2_ADT_WAN' in data_str:
+                    return 200, DEV2_ADT_WAN
+                raise ClientException()
+
+        client = TPLinkEXClientTest('', '')
+        result = client.get_ipv4_status()
+
+        self.assertIsInstance(result, IPv4Status)
+        self.assertEqual(result.wan_ipv4_ipaddr, None)
+        self.assertEqual(result.wan_ipv4_gateway, None)
+        self.assertEqual(result.wan_ipv4_netmask, None)
+        self.assertEqual(result.wan_ipv4_conntype, '')
+        self.assertEqual(result.lan_macaddr, '00-00-00-00-00-00')
+        self.assertEqual(result.lan_ipv4_ipaddr, '0.0.0.0')
+        self.assertEqual(result.lan_ipv4_netmask, '0.0.0.0')
+        self.assertEqual(result.lan_ipv4_dhcp_enable, False)
+        self.assertEqual(result.remote, None)
+
     def test_get_ipv4_status_one_wlan(self) -> None:
 
         DEV2_ADT_LAN = ('{"data":[{"MACAddress":"bf:75:44:4c:dc:9e","IPAddress":"192.168.5.1",'

{tplinkrouterc6u-5.4.1 → tplinkrouterc6u-5.5.0}/test/test_client_mr.py

@@ -310,6 +310,7 @@ X_TP_TotalPacketsReceived=467
         self.assertEqual(status.wan_ipv4_addr, '192.168.30.55')
         self.assertEqual(status.lan_ipv4_addr, '192.168.4.1')
         self.assertEqual(status.wan_ipv4_gateway, '192.168.30.1')
+        self.assertEqual(status.conn_type, 'ipoe_1_d')
         self.assertEqual(status.wired_total, 0)
         self.assertEqual(status.wifi_clients_total, 1)
         self.assertEqual(status.guest_clients_total, 0)
@@ -618,6 +619,7 @@ DNSServers=7.7.7.7,2.2.2.2
 
         self.assertIsInstance(result, IPv4Status)
         self.assertEqual(result.lan_macaddr, '00-00-00-00-00-00')
+        self.assertEqual(result.wan_ipv4_conntype, '')
         self.assertEqual(result.lan_ipv4_ipaddr, '0.0.0.0')
         self.assertEqual(result.lan_ipv4_netmask, '0.0.0.0')
         self.assertEqual(result.lan_ipv4_dhcp_enable, False)

{tplinkrouterc6u-5.4.1 → tplinkrouterc6u-5.5.0}/tplinkrouterc6u/__init__.py

@@ -3,6 +3,7 @@ from tplinkrouterc6u.client.deco import TPLinkDecoClient
 from tplinkrouterc6u.client_abstract import AbstractRouter
 from tplinkrouterc6u.client.mr import TPLinkMRClient
 from tplinkrouterc6u.client.ex import TPLinkEXClient
+from tplinkrouterc6u.client.vr import TPLinkVRClient
 from tplinkrouterc6u.client.c6v4 import TplinkC6V4Router
 from tplinkrouterc6u.client.c5400x import TplinkC5400XRouter
 from tplinkrouterc6u.client.c1200 import TplinkC1200Router

{tplinkrouterc6u-5.4.1 → tplinkrouterc6u-5.5.0}/tplinkrouterc6u/client/c6u.py

@@ -284,6 +284,7 @@ class TplinkBaseRouter(AbstractRouter, TplinkRequest):
         status.wan_ipv4_uptime = data.get('wan_ipv4_uptime')
         status.mem_usage = data.get('mem_usage')
         status.cpu_usage = data.get('cpu_usage')
+        status.conn_type = data.get('conn_type')
         status.wired_total = len(data.get('access_devices_wired', []))
         status.wifi_clients_total = len(data.get('access_devices_wireless_host', []))
         status.guest_clients_total = len(data.get('access_devices_wireless_guest', []))
@@ -366,7 +367,7 @@ class TplinkBaseRouter(AbstractRouter, TplinkRequest):
         ipv4_status._wan_macaddr = get_mac(data.get('wan_macaddr', '00:00:00:00:00:00'))
         ipv4_status._wan_ipv4_ipaddr = get_ip(data.get('wan_ipv4_ipaddr', '0.0.0.0'))
         ipv4_status._wan_ipv4_gateway = get_ip(data.get('wan_ipv4_gateway', '0.0.0.0'))
-        ipv4_status.wan_ipv4_conntype = data.get('wan_ipv4_conntype', '')
+        ipv4_status._wan_ipv4_conntype = data.get('wan_ipv4_conntype', '')
         ipv4_status._wan_ipv4_netmask = get_ip(data.get('wan_ipv4_netmask', '0.0.0.0'))
         ipv4_status._wan_ipv4_pridns = get_ip(data.get('wan_ipv4_pridns', '0.0.0.0'))
         ipv4_status._wan_ipv4_snddns = get_ip(data.get('wan_ipv4_snddns', '0.0.0.0'))

{tplinkrouterc6u-5.4.1 → tplinkrouterc6u-5.5.0}/tplinkrouterc6u/client/c6v4.py

@@ -1,6 +1,6 @@
 from requests import post
 from tplinkrouterc6u.common.package_enum import Connection
-from tplinkrouterc6u.common.dataclass import Firmware, Status
+from tplinkrouterc6u.common.dataclass import Firmware, Status, IPv4Status
 from tplinkrouterc6u.common.exception import ClientException
 from tplinkrouterc6u.client_abstract import AbstractRouter
 
@@ -31,6 +31,9 @@ class TplinkC6V4Router(AbstractRouter):
     def get_status(self) -> Status:
         raise ClientException('Not Implemented')
 
+    def get_ipv4_status(self) -> IPv4Status:
+        raise ClientException('Not Implemented')
+
     def reboot(self) -> None:
         raise ClientException('Not Implemented')
 

{tplinkrouterc6u-5.4.1 → tplinkrouterc6u-5.5.0}/tplinkrouterc6u/client/deco.py

@@ -132,7 +132,7 @@ class TPLinkDecoClient(TplinkEncryption, AbstractRouter):
         element = get_value(data, ['wan', 'ip_info', 'gateway'])
         ipv4_status._wan_ipv4_gateway = IPv4Address(element) if element else None
         element = get_value(data, ['wan', 'dial_type'])
-        ipv4_status.wan_ipv4_conntype = element if element else ''
+        ipv4_status._wan_ipv4_conntype = element if element else ''
         element = get_value(data, ['wan', 'ip_info', 'mask'])
         ipv4_status._wan_ipv4_netmask = IPv4Address(element) if element else None
         element = get_value(data, ['wan', 'ip_info', 'dns1'])

{tplinkrouterc6u-5.4.1 → tplinkrouterc6u-5.5.0}/tplinkrouterc6u/client/ex.py

@@ -5,6 +5,7 @@ from macaddress import EUI48
 from ipaddress import IPv4Address
 from logging import Logger
 from tplinkrouterc6u.common.package_enum import Connection, VPN
+from tplinkrouterc6u.common.helper import get_ip, get_mac, get_value
 from tplinkrouterc6u.common.dataclass import (
     Firmware,
     Status,
@@ -48,7 +49,6 @@ class TPLinkEXClient(TPLinkMRClientBase):
                  verify_ssl: bool = True, timeout: int = 30) -> None:
         super().__init__(host, password, username, logger, verify_ssl, timeout)
 
-        self.username = 'user'
         self._url_rsa_key = 'cgi/getGDPRParm'
 
     def logout(self) -> None:
@@ -203,26 +203,26 @@ class TPLinkEXClient(TPLinkMRClientBase):
         ]
         _, values = self.req_act(acts)
 
-        if values[0].__class__ == list:
+        if values[0].__class__ == list and len(values[0]) > 0:
             values[0] = values[0][0]
 
         ipv4_status = IPv4Status()
-        ipv4_status._lan_macaddr = EUI48(values[0]['MACAddress'])
-        ipv4_status._lan_ipv4_ipaddr = IPv4Address(values[0]['IPAddress'])
-        ipv4_status._lan_ipv4_netmask = IPv4Address(values[0]['IPSubnetMask'])
-        ipv4_status.lan_ipv4_dhcp_enable = bool(int(values[0]['DHCPv4Enable']))
+        ipv4_status._lan_macaddr = get_mac(get_value(values, [0, 'MACAddress'], '00:00:00:00:00:00'))
+        ipv4_status._lan_ipv4_ipaddr = get_ip(get_value(values, [0, 'IPAddress'], '0.0.0.0'))
+        ipv4_status._lan_ipv4_netmask = get_ip(get_value(values, [0, 'IPSubnetMask'], '0.0.0.0'))
+        ipv4_status.lan_ipv4_dhcp_enable = bool(int(get_value(values, [0, 'DHCPv4Enable'], '0')))
 
         for item in values[1]:
             if int(item['enable']) == 0 and values[1].__class__ == list:
                 continue
-            ipv4_status._wan_macaddr = EUI48(item['MACAddr'])
-            ipv4_status._wan_ipv4_ipaddr = IPv4Address(item['connIPv4Address'])
-            ipv4_status._wan_ipv4_gateway = IPv4Address(item['connIPv4Gateway'])
-            ipv4_status.wan_ipv4_conntype = item['name']
-            ipv4_status._wan_ipv4_netmask = IPv4Address(item['connIPv4SubnetMask'])
-            dns = item['connIPv4DnsServer'].split(',')
-            ipv4_status._wan_ipv4_pridns = IPv4Address(dns[0])
-            ipv4_status._wan_ipv4_snddns = IPv4Address(dns[1])
+            ipv4_status._wan_macaddr = get_mac(get_value(item, ['MACAddr'], '00:00:00:00:00:00'))
+            ipv4_status._wan_ipv4_ipaddr = get_ip(get_value(item, ['connIPv4Address'], '0.0.0.0'))
+            ipv4_status._wan_ipv4_gateway = get_ip(get_value(item, ['connIPv4Gateway'], '0.0.0.0'))
+            ipv4_status._wan_ipv4_conntype = get_value(item, ['name'], '')
+            ipv4_status._wan_ipv4_netmask = get_ip(get_value(item, ['connIPv4SubnetMask'], '0.0.0.0'))
+            dns = get_value(item, ['connIPv4DnsServer'], '').split(',')
+            ipv4_status._wan_ipv4_pridns = get_ip(dns[0] if len(dns) > 0 else '0.0.0.0')
+            ipv4_status._wan_ipv4_snddns = get_ip(dns[1] if len(dns) > 1 else '0.0.0.0')
 
         return ipv4_status
 

{tplinkrouterc6u-5.4.1 → tplinkrouterc6u-5.5.0}/tplinkrouterc6u/client/mr.py

@@ -7,7 +7,7 @@ from datetime import timedelta, datetime
 from macaddress import EUI48
 from ipaddress import IPv4Address
 from logging import Logger
-from tplinkrouterc6u.common.helper import get_ip, get_mac
+from tplinkrouterc6u.common.helper import get_ip, get_mac, get_value
 from tplinkrouterc6u.common.encryption import EncryptionWrapperMR
 from tplinkrouterc6u.common.package_enum import Connection, VPN
 from tplinkrouterc6u.common.dataclass import (
@@ -114,6 +114,213 @@ class TPLinkMRClientBase(AbstractRouter):
         ]
         self.req_act(acts)
 
+    def get_firmware(self) -> Firmware:
+        acts = [
+            self.ActItem(self.ActItem.GET, 'IGD_DEV_INFO', attrs=[
+                'hardwareVersion',
+                'modelName',
+                'softwareVersion'
+            ])
+        ]
+        _, values = self.req_act(acts)
+
+        firmware = Firmware(values.get('hardwareVersion', ''), values.get('modelName', ''),
+                            values.get('softwareVersion', ''))
+
+        return firmware
+
+    def get_status(self) -> Status:
+        status = Status()
+        acts = [
+            self.ActItem(self.ActItem.GS, 'LAN_IP_INTF', attrs=['X_TP_MACAddress', 'IPInterfaceIPAddress']),
+            self.ActItem(self.ActItem.GS, 'WAN_IP_CONN',
+                         attrs=['enable', 'MACAddress', 'externalIPAddress', 'defaultGateway', 'name']),
+            self.ActItem(self.ActItem.GL, 'LAN_WLAN', attrs=['enable', 'X_TP_Band']),
+            self.ActItem(self.ActItem.GL, 'LAN_WLAN_GUESTNET', attrs=['enable', 'name']),
+            self.ActItem(self.ActItem.GL, 'LAN_HOST_ENTRY', attrs=[
+                'IPAddress',
+                'MACAddress',
+                'hostName',
+                'X_TP_ConnType',
+                'active',
+            ]),
+            self.ActItem(self.ActItem.GS, 'LAN_WLAN_ASSOC_DEV', attrs=[
+                'associatedDeviceMACAddress',
+                'X_TP_TotalPacketsSent',
+                'X_TP_TotalPacketsReceived',
+            ]),
+        ]
+        _, values = self.req_act(acts)
+
+        if values['0'].__class__ == list:
+            values['0'] = values['0'][0]
+
+        status._lan_macaddr = EUI48(values['0']['X_TP_MACAddress'])
+        status._lan_ipv4_addr = IPv4Address(values['0']['IPInterfaceIPAddress'])
+
+        for item in self._to_list(values.get('1')):
+            if int(item['enable']) == 0 and values.get('1').__class__ == list:
+                continue
+            status._wan_macaddr = EUI48(item['MACAddress']) if item.get('MACAddress') else None
+            status._wan_ipv4_addr = IPv4Address(item['externalIPAddress'])
+            status._wan_ipv4_gateway = IPv4Address(item['defaultGateway'])
+            status.conn_type = item.get('name', '')
+
+        if values['2'].__class__ != list:
+            status.wifi_2g_enable = bool(int(values['2']['enable']))
+        else:
+            status.wifi_2g_enable = bool(int(values['2'][0]['enable']))
+            status.wifi_5g_enable = bool(int(values['2'][1]['enable']))
+
+        if values['3'].__class__ != list:
+            status.guest_2g_enable = bool(int(values['3']['enable']))
+        else:
+            status.guest_2g_enable = bool(int(values['3'][0]['enable']))
+            status.guest_5g_enable = bool(int(values['3'][1]['enable']))
+
+        devices = {}
+        for val in self._to_list(values.get('4')):
+            if int(val['active']) == 0:
+                continue
+            conn = self.CLIENT_TYPES.get(int(val['X_TP_ConnType']))
+            if conn is None:
+                continue
+            elif conn == Connection.WIRED:
+                status.wired_total += 1
+            elif conn.is_guest_wifi():
+                status.guest_clients_total += 1
+            elif conn.is_host_wifi():
+                status.wifi_clients_total += 1
+            devices[val['MACAddress']] = Device(conn,
+                                                EUI48(val['MACAddress']),
+                                                IPv4Address(val['IPAddress']),
+                                                val['hostName'])
+
+        for val in self._to_list(values.get('5')):
+            if val['associatedDeviceMACAddress'] not in devices:
+                status.wifi_clients_total += 1
+                devices[val['associatedDeviceMACAddress']] = Device(
+                    Connection.HOST_2G,
+                    EUI48(val['associatedDeviceMACAddress']),
+                    IPv4Address('0.0.0.0'),
+                    '')
+            devices[val['associatedDeviceMACAddress']].packets_sent = int(val['X_TP_TotalPacketsSent'])
+            devices[val['associatedDeviceMACAddress']].packets_received = int(val['X_TP_TotalPacketsReceived'])
+
+        status.devices = list(devices.values())
+        status.clients_total = status.wired_total + status.wifi_clients_total + status.guest_clients_total
+
+        return status
+
+    def get_ipv4_reservations(self) -> [IPv4Reservation]:
+        acts = [
+            self.ActItem(self.ActItem.GL, 'LAN_DHCP_STATIC_ADDR', attrs=['enable', 'chaddr', 'yiaddr']),
+        ]
+        _, values = self.req_act(acts)
+
+        ipv4_reservations = []
+        for item in self._to_list(values):
+            ipv4_reservations.append(
+                IPv4Reservation(
+                    EUI48(item['chaddr']),
+                    IPv4Address(item['yiaddr']),
+                    '',
+                    bool(int(item['enable']))
+                ))
+
+        return ipv4_reservations
+
+    def get_ipv4_dhcp_leases(self) -> [IPv4DHCPLease]:
+        acts = [
+            self.ActItem(self.ActItem.GL, 'LAN_HOST_ENTRY', attrs=['IPAddress', 'MACAddress', 'hostName',
+                                                                   'leaseTimeRemaining']),
+        ]
+        _, values = self.req_act(acts)
+
+        dhcp_leases = []
+        for item in self._to_list(values):
+            lease_time = item['leaseTimeRemaining']
+            dhcp_leases.append(
+                IPv4DHCPLease(
+                    EUI48(item['MACAddress']),
+                    IPv4Address(item['IPAddress']),
+                    item['hostName'],
+                    str(timedelta(seconds=int(lease_time))) if lease_time.isdigit() else 'Permanent',
+                ))
+
+        return dhcp_leases
+
+    def get_ipv4_status(self) -> IPv4Status:
+        acts = [
+            self.ActItem(self.ActItem.GS, 'LAN_IP_INTF',
+                         attrs=['X_TP_MACAddress', 'IPInterfaceIPAddress', 'IPInterfaceSubnetMask']),
+            self.ActItem(self.ActItem.GET, 'LAN_HOST_CFG', '1,0,0,0,0,0', attrs=['DHCPServerEnable']),
+            self.ActItem(self.ActItem.GS, 'WAN_IP_CONN',
+                         attrs=['enable', 'MACAddress', 'externalIPAddress', 'defaultGateway', 'name', 'subnetMask',
+                                'DNSServers']),
+        ]
+        _, values = self.req_act(acts)
+
+        ipv4_status = IPv4Status()
+        ipv4_status._lan_macaddr = get_mac(get_value(values, ['0', 'X_TP_MACAddress'], '00:00:00:00:00:00'))
+        ipv4_status._lan_ipv4_ipaddr = get_ip(get_value(values, ['0', 'IPInterfaceIPAddress'], '0.0.0.0'))
+        ipv4_status._lan_ipv4_netmask = get_ip(get_value(values, ['0', 'IPInterfaceSubnetMask'], '0.0.0.0'))
+        ipv4_status.lan_ipv4_dhcp_enable = bool(int(get_value(values, ['1', 'DHCPServerEnable'], '0')))
+
+        for item in self._to_list(values.get('2')):
+            if int(item.get('enable', '0')) == 0 and values.get('2').__class__ == list:
+                continue
+            ipv4_status._wan_macaddr = get_mac(item.get('MACAddress', '00:00:00:00:00:00'))
+            ipv4_status._wan_ipv4_ipaddr = get_ip(item.get('externalIPAddress', '0.0.0.0'))
+            ipv4_status._wan_ipv4_gateway = get_ip(item.get('defaultGateway', '0.0.0.0'))
+            ipv4_status._wan_ipv4_conntype = item.get('name', '')
+            ipv4_status._wan_ipv4_netmask = get_ip(item.get('subnetMask', '0.0.0.0'))
+            dns = item.get('DNSServers', '').split(',')
+            ipv4_status._wan_ipv4_pridns = get_ip(dns[0] if len(dns) > 0 else '0.0.0.0')
+            ipv4_status._wan_ipv4_snddns = get_ip(dns[1] if len(dns) > 1 else '0.0.0.0')
+
+        return ipv4_status
+
+    def set_wifi(self, wifi: Connection, enable: bool) -> None:
+        acts = [
+            self.ActItem(
+                self.ActItem.SET,
+                'LAN_WLAN' if wifi in [Connection.HOST_2G, Connection.HOST_5G] else 'LAN_WLAN_MSSIDENTRY',
+                self.WIFI_SET[wifi],
+                attrs=['enable={}'.format(int(enable))]),
+        ]
+        self.req_act(acts)
+
+    def get_vpn_status(self) -> VPNStatus:
+        status = VPNStatus()
+        acts = [
+            self.ActItem(self.ActItem.GET, 'OPENVPN', attrs=['enable']),
+            self.ActItem(self.ActItem.GET, 'PPTPVPN', attrs=['enable']),
+            self.ActItem(self.ActItem.GL, 'OVPN_CLIENT', attrs=['connAct']),
+            self.ActItem(self.ActItem.GL, 'PVPN_CLIENT', attrs=['connAct']),
+        ]
+        _, values = self.req_act(acts)
+
+        status.openvpn_enable = values['0']['enable'] == '1'
+        status.pptpvpn_enable = values['1']['enable'] == '1'
+
+        for item in values['2']:
+            if item['connAct'] == '1':
+                status.openvpn_clients_total += 1
+
+        for item in values['3']:
+            if item['connAct'] == '1':
+                status.pptpvpn_clients_total += 1
+
+        return status
+
+    def set_vpn(self, vpn: VPN, enable: bool) -> None:
+        acts = [
+            self.ActItem(self.ActItem.SET, vpn.value, attrs=['enable={}'.format(int(enable))])
+        ]
+
+        self.req_act(acts)
+
     def req_act(self, acts: list):
         '''
         Requests ACTs via the cgi_gdpr proxy
@@ -303,7 +510,7 @@ class TPLinkMRClientBase(AbstractRouter):
                 self._logger.debug(error)
             raise ClientException(error)
 
-    def _request(self, url, method='POST', data_str=None, encrypt=False):
+    def _request(self, url, method='POST', data_str=None, encrypt=False, is_login=False):
         '''
         Prepares and sends an HTTP request to the host
             - sets up the headers, handles token auth
@@ -325,7 +532,7 @@ class TPLinkMRClientBase(AbstractRouter):
 
         # encrypt request data if needed (for the /cgi_gdpr endpoint)
         if encrypt:
-            sign, data = self._prepare_data(data_str, False)
+            sign, data = self._prepare_data(data_str, is_login)
             data = 'sign={}\r\ndata={}\r\n'.format(sign, data)
         else:
             data = data_str
@@ -396,182 +603,6 @@ class TPLinkMRClient(TPLinkMRClientBase):
         if ret_code == self.HTTP_RET_OK:
             self._token = None
 
-    def get_firmware(self) -> Firmware:
-        acts = [
-            self.ActItem(self.ActItem.GET, 'IGD_DEV_INFO', attrs=[
-                'hardwareVersion',
-                'modelName',
-                'softwareVersion'
-            ])
-        ]
-        _, values = self.req_act(acts)
-
-        firmware = Firmware(values.get('hardwareVersion', ''), values.get('modelName', ''),
-                            values.get('softwareVersion', ''))
-
-        return firmware
-
-    def get_status(self) -> Status:
-        status = Status()
-        acts = [
-            self.ActItem(self.ActItem.GS, 'LAN_IP_INTF', attrs=['X_TP_MACAddress', 'IPInterfaceIPAddress']),
-            self.ActItem(self.ActItem.GS, 'WAN_IP_CONN',
-                         attrs=['enable', 'MACAddress', 'externalIPAddress', 'defaultGateway']),
-            self.ActItem(self.ActItem.GL, 'LAN_WLAN', attrs=['enable', 'X_TP_Band']),
-            self.ActItem(self.ActItem.GL, 'LAN_WLAN_GUESTNET', attrs=['enable', 'name']),
-            self.ActItem(self.ActItem.GL, 'LAN_HOST_ENTRY', attrs=[
-                'IPAddress',
-                'MACAddress',
-                'hostName',
-                'X_TP_ConnType',
-                'active',
-            ]),
-            self.ActItem(self.ActItem.GS, 'LAN_WLAN_ASSOC_DEV', attrs=[
-                'associatedDeviceMACAddress',
-                'X_TP_TotalPacketsSent',
-                'X_TP_TotalPacketsReceived',
-            ]),
-        ]
-        _, values = self.req_act(acts)
-
-        if values['0'].__class__ == list:
-            values['0'] = values['0'][0]
-
-        status._lan_macaddr = EUI48(values['0']['X_TP_MACAddress'])
-        status._lan_ipv4_addr = IPv4Address(values['0']['IPInterfaceIPAddress'])
-
-        for item in self._to_list(values.get('1')):
-            if int(item['enable']) == 0 and values.get('1').__class__ == list:
-                continue
-            status._wan_macaddr = EUI48(item['MACAddress']) if item.get('MACAddress') else None
-            status._wan_ipv4_addr = IPv4Address(item['externalIPAddress'])
-            status._wan_ipv4_gateway = IPv4Address(item['defaultGateway'])
-
-        if values['2'].__class__ != list:
-            status.wifi_2g_enable = bool(int(values['2']['enable']))
-        else:
-            status.wifi_2g_enable = bool(int(values['2'][0]['enable']))
-            status.wifi_5g_enable = bool(int(values['2'][1]['enable']))
-
-        if values['3'].__class__ != list:
-            status.guest_2g_enable = bool(int(values['3']['enable']))
-        else:
-            status.guest_2g_enable = bool(int(values['3'][0]['enable']))
-            status.guest_5g_enable = bool(int(values['3'][1]['enable']))
-
-        devices = {}
-        for val in self._to_list(values.get('4')):
-            if int(val['active']) == 0:
-                continue
-            conn = self.CLIENT_TYPES.get(int(val['X_TP_ConnType']))
-            if conn is None:
-                continue
-            elif conn == Connection.WIRED:
-                status.wired_total += 1
-            elif conn.is_guest_wifi():
-                status.guest_clients_total += 1
-            elif conn.is_host_wifi():
-                status.wifi_clients_total += 1
-            devices[val['MACAddress']] = Device(conn,
-                                                EUI48(val['MACAddress']),
-                                                IPv4Address(val['IPAddress']),
-                                                val['hostName'])
-
-        for val in self._to_list(values.get('5')):
-            if val['associatedDeviceMACAddress'] not in devices:
-                status.wifi_clients_total += 1
-                devices[val['associatedDeviceMACAddress']] = Device(
-                    Connection.HOST_2G,
-                    EUI48(val['associatedDeviceMACAddress']),
-                    IPv4Address('0.0.0.0'),
-                    '')
-            devices[val['associatedDeviceMACAddress']].packets_sent = int(val['X_TP_TotalPacketsSent'])
-            devices[val['associatedDeviceMACAddress']].packets_received = int(val['X_TP_TotalPacketsReceived'])
-
-        status.devices = list(devices.values())
-        status.clients_total = status.wired_total + status.wifi_clients_total + status.guest_clients_total
-
-        return status
-
-    def get_ipv4_reservations(self) -> [IPv4Reservation]:
-        acts = [
-            self.ActItem(self.ActItem.GL, 'LAN_DHCP_STATIC_ADDR', attrs=['enable', 'chaddr', 'yiaddr']),
-        ]
-        _, values = self.req_act(acts)
-
-        ipv4_reservations = []
-        for item in self._to_list(values):
-            ipv4_reservations.append(
-                IPv4Reservation(
-                    EUI48(item['chaddr']),
-                    IPv4Address(item['yiaddr']),
-                    '',
-                    bool(int(item['enable']))
-                ))
-
-        return ipv4_reservations
-
-    def get_ipv4_dhcp_leases(self) -> [IPv4DHCPLease]:
-        acts = [
-            self.ActItem(self.ActItem.GL, 'LAN_HOST_ENTRY', attrs=['IPAddress', 'MACAddress', 'hostName',
-                                                                   'leaseTimeRemaining']),
-        ]
-        _, values = self.req_act(acts)
-
-        dhcp_leases = []
-        for item in self._to_list(values):
-            lease_time = item['leaseTimeRemaining']
-            dhcp_leases.append(
-                IPv4DHCPLease(
-                    EUI48(item['MACAddress']),
-                    IPv4Address(item['IPAddress']),
-                    item['hostName'],
-                    str(timedelta(seconds=int(lease_time))) if lease_time.isdigit() else 'Permanent',
-                ))
-
-        return dhcp_leases
-
-    def get_ipv4_status(self) -> IPv4Status:
-        acts = [
-            self.ActItem(self.ActItem.GS, 'LAN_IP_INTF',
-                         attrs=['X_TP_MACAddress', 'IPInterfaceIPAddress', 'IPInterfaceSubnetMask']),
-            self.ActItem(self.ActItem.GET, 'LAN_HOST_CFG', '1,0,0,0,0,0', attrs=['DHCPServerEnable']),
-            self.ActItem(self.ActItem.GS, 'WAN_IP_CONN',
-                         attrs=['enable', 'MACAddress', 'externalIPAddress', 'defaultGateway', 'name', 'subnetMask',
-                                'DNSServers']),
-        ]
-        _, values = self.req_act(acts)
-
-        ipv4_status = IPv4Status()
-        ipv4_status._lan_macaddr = get_mac(values.get('0', {}).get('X_TP_MACAddress', '00:00:00:00:00:00'))
-        ipv4_status._lan_ipv4_ipaddr = get_ip(values.get('0', {}).get('IPInterfaceIPAddress', '0.0.0.0'))
-        ipv4_status._lan_ipv4_netmask = get_ip(values.get('0', {}).get('IPInterfaceSubnetMask', '0.0.0.0'))
-        ipv4_status.lan_ipv4_dhcp_enable = bool(int(values.get('1', {}).get('DHCPServerEnable', '0')))
-
-        for item in self._to_list(values.get('2')):
-            if int(item.get('enable', '0')) == 0 and values.get('2').__class__ == list:
-                continue
-            ipv4_status._wan_macaddr = get_mac(item.get('MACAddress', '00:00:00:00:00:00'))
-            ipv4_status._wan_ipv4_ipaddr = get_ip(item.get('externalIPAddress', '0.0.0.0'))
-            ipv4_status._wan_ipv4_gateway = get_ip(item.get('defaultGateway', '0.0.0.0'))
-            ipv4_status.wan_ipv4_conntype = item.get('name', '')
-            ipv4_status._wan_ipv4_netmask = get_ip(item.get('subnetMask', '0.0.0.0'))
-            dns = item.get('DNSServers', '').split(',')
-            ipv4_status._wan_ipv4_pridns = get_ip(dns[0] if len(dns) == 2 else '0.0.0.0')
-            ipv4_status._wan_ipv4_snddns = get_ip(dns[1] if len(dns) == 2 else '0.0.0.0')
-
-        return ipv4_status
-
-    def set_wifi(self, wifi: Connection, enable: bool) -> None:
-        acts = [
-            self.ActItem(
-                self.ActItem.SET,
-                'LAN_WLAN' if wifi in [Connection.HOST_2G, Connection.HOST_5G] else 'LAN_WLAN_MSSIDENTRY',
-                self.WIFI_SET[wifi],
-                attrs=['enable={}'.format(int(enable))]),
-        ]
-        self.req_act(acts)
-
     def send_sms(self, phone_number: str, message: str) -> None:
         acts = [
             self.ActItem(
@@ -681,33 +712,3 @@ class TPLinkMRClient(TPLinkMRClientBase):
         status.isp_name = values['3']['ispName']
 
         return status
-
-    def get_vpn_status(self) -> VPNStatus:
-        status = VPNStatus()
-        acts = [
-            self.ActItem(self.ActItem.GET, 'OPENVPN', attrs=['enable']),
-            self.ActItem(self.ActItem.GET, 'PPTPVPN', attrs=['enable']),
-            self.ActItem(self.ActItem.GL, 'OVPN_CLIENT', attrs=['connAct']),
-            self.ActItem(self.ActItem.GL, 'PVPN_CLIENT', attrs=['connAct']),
-        ]
-        _, values = self.req_act(acts)
-
-        status.openvpn_enable = values['0']['enable'] == '1'
-        status.pptpvpn_enable = values['1']['enable'] == '1'
-
-        for item in values['2']:
-            if item['connAct'] == '1':
-                status.openvpn_clients_total += 1
-
-        for item in values['3']:
-            if item['connAct'] == '1':
-                status.pptpvpn_clients_total += 1
-
-        return status
-
-    def set_vpn(self, vpn: VPN, enable: bool) -> None:
-        acts = [
-            self.ActItem(self.ActItem.SET, vpn.value, attrs=['enable={}'.format(int(enable))])
-        ]
-
-        self.req_act(acts)

tplinkrouterc6u-5.5.0/tplinkrouterc6u/client/vr.py

@@ -0,0 +1,129 @@
+import base64
+from http import HTTPStatus
+from tplinkrouterc6u.client.mr import TPLinkMRClientBase
+from tplinkrouterc6u.common.exception import ClientException
+from logging import Logger
+
+
+class TPLinkVRClient(TPLinkMRClientBase):
+    def __init__(self, host: str, password: str, username: str = 'admin', logger: Logger = None,
+                 verify_ssl: bool = True, timeout: int = 30):
+        super().__init__(host, password, username, logger, verify_ssl, timeout)
+        self._url_rsa_key = 'cgi/getGDPRParm'
+
+    def supports(self):
+        return self._verify_router() and super().supports()
+
+    def _verify_router(self) -> bool:
+        """
+        Verifies if the connected router is a supported TP-Link VR model.
+
+        This function checks if the router is a TP-Link VR model by sending a GET request
+        to the host and analyzing the response. It verifies the presence of specific
+        keywords and endpoints in the response to determine the model type.
+
+        Returns:
+            bool: True if the router is a supported TP-Link VR model and supports the RSA key endpoint,
+                otherwise False.
+
+        Raises:
+            Exception: If an error occurs during the request process, it logs the error
+                    and returns False.
+        """
+
+        is_VR = False
+        has_url_rsa_endpoint = False
+
+        try:
+            status_code, response = self._request(self.host, method='GET')
+        except Exception as e:
+            if self._logger is not None:
+                self._logger.error("Error while checking modem: {}".format(e))
+
+            return False
+
+        if status_code == HTTPStatus.OK:
+            is_VR = "Archer VR" in response
+            has_url_rsa_endpoint = self._url_rsa_key in response
+
+        if has_url_rsa_endpoint and is_VR:
+            return True
+        elif is_VR:
+            # check if lib.js is present. If response code is 200, it is okay. Check if self._url_rsa_key is present
+            try:
+                status_code, response = self._request("{}/js/lib.js".format(self.host), method='GET')
+            except Exception as e:
+                if self._logger is not None:
+                    self._logger.error("Error while checking if lib.js is present in modem: {}".format(e))
+
+                # if lib.js is not present, return False. Are API not compatible to this class?
+                return False
+
+            if status_code == HTTPStatus.OK:
+                has_url_rsa_endpoint = (self._url_rsa_key in response)
+
+            return is_VR and has_url_rsa_endpoint
+        else:
+            # modem is not VR
+            return False
+
+    def logout(self) -> None:
+        '''
+        Logs out from the host
+        '''
+        acts = [
+            self.ActItem(self.ActItem.CGI, '/cgi/logout')
+        ]
+
+        response, _ = self.req_act(acts)
+
+        if response == '[cgi]0\n[error]0\n':
+            self._token = None
+
+    def _req_login(self) -> None:
+        '''
+        Authenticates to the host
+            - sets the session token after successful login
+            - data/signature is passed as a GET parameter, NOT as a raw request data
+              (unlike for regular encrypted requests to the /cgi_gdpr endpoint)
+
+        Example session token (set as a cookie):
+            {'JSESSIONID': '4d786fede0164d7613411c7b6ec61e'}
+        '''
+        # self.password to base64 string
+        base64pwd = base64.b64encode(self.password.encode('utf-8')).decode('utf-8')
+#        sign, data = self._prepare_data(self.username + '\n' + str(base64pwd), True)
+
+        data_list = []
+        data_list.append("UserName={}".format(self.username))
+        data_list.append("Passwd={}".format(base64pwd))
+
+        actItem = self.ActItem(self.ActItem.CGI, '/cgi/login', attrs=data_list)
+        response, _ = self.req_act([actItem])
+
+        ret_code = self._parse_ret_val(response)
+        if ret_code == self.HTTP_RET_OK:
+            return
+
+        if ret_code == self.HTTP_ERR_USER_PWD_NOT_CORRECT:
+
+            error = 'TplinkRouter - VR - Login failed, wrong password.'
+            if self._logger:
+                self._logger.debug(error)
+            raise ClientException(error)
+
+        if ret_code == self.HTTP_ERR_USER_BAD_REQUEST:
+            error = 'TplinkRouter - VR - Login failed. Generic error code: {}'.format(ret_code)
+            if self._logger:
+                self._logger.debug(error)
+            raise ClientException(error)
+
+        # unknown error
+        error = 'TplinkRouter - VR - Login failed. Unknown error code: {}'.format(ret_code)
+        if self._logger:
+            self._logger.debug(error)
+        raise ClientException(error)
+
+    def _request(self, url, method='POST', data_str=None, encrypt=False, is_login=False):
+        is_login = encrypt and '/cgi/login' in data_str
+        return super()._request(url, method, data_str, encrypt, is_login)

{tplinkrouterc6u-5.4.1 → tplinkrouterc6u-5.5.0}/tplinkrouterc6u/client_abstract.py

@@ -1,7 +1,7 @@
 from requests.packages import urllib3
 from logging import Logger
 from tplinkrouterc6u.common.package_enum import Connection
-from tplinkrouterc6u.common.dataclass import Firmware, Status
+from tplinkrouterc6u.common.dataclass import Firmware, Status, IPv4Status
 from abc import ABC, abstractmethod
 
 
@@ -39,6 +39,10 @@ class AbstractRouter(ABC):
     def get_status(self) -> Status:
         pass
 
+    @abstractmethod
+    def get_ipv4_status(self) -> IPv4Status:
+        pass
+
     @abstractmethod
     def reboot(self) -> None:
         pass

{tplinkrouterc6u-5.4.1 → tplinkrouterc6u-5.5.0}/tplinkrouterc6u/common/dataclass.py

@@ -68,6 +68,7 @@ class Status:
         self.wan_ipv4_uptime: int | None = None
         self.mem_usage: float | None = None
         self.cpu_usage: float | None = None
+        self.conn_type: str | None = None
         self.devices: list[Device] = []
 
     @property
@@ -167,7 +168,7 @@ class IPv4Status:
         self._wan_macaddr: EUI48
         self._wan_ipv4_ipaddr: IPv4Address | None = None
         self._wan_ipv4_gateway: IPv4Address | None = None
-        self.wan_ipv4_conntype: str
+        self._wan_ipv4_conntype: str
         self._wan_ipv4_netmask: IPv4Address | None = None
         self._wan_ipv4_pridns: IPv4Address
         self._wan_ipv4_snddns: IPv4Address
@@ -189,6 +190,10 @@ class IPv4Status:
     def wan_ipv4_ipaddr(self):
         return str(self._wan_ipv4_ipaddr) if self._wan_ipv4_ipaddr else None
 
+    @property
+    def wan_ipv4_conntype(self):
+        return self._wan_ipv4_conntype if hasattr(self, '_wan_ipv4_conntype') else ''
+
     @property
     def wan_ipv4_ipaddress(self):
         return self._wan_ipv4_ipaddr

{tplinkrouterc6u-5.4.1 → tplinkrouterc6u-5.5.0}/tplinkrouterc6u/common/helper.py

@@ -16,12 +16,12 @@ def get_mac(mac: str) -> EUI48:
         return EUI48('00:00:00:00:00:00')
 
 
-def get_value(dictionary: dict, keys: list):
+def get_value(dictionary, keys: list, default=None):
     nested_dict = dictionary
 
     for key in keys:
         try:
             nested_dict = nested_dict[key]
         except Exception:
-            return None
+            return default
     return nested_dict

{tplinkrouterc6u-5.4.1 → tplinkrouterc6u-5.5.0}/tplinkrouterc6u/provider.py

@@ -1,7 +1,7 @@
 from logging import Logger
 
 from tplinkrouterc6u import TPLinkXDRClient
-from tplinkrouterc6u.common.exception import ClientException, AuthorizeError
+from tplinkrouterc6u.common.exception import ClientException
 from tplinkrouterc6u.client.c6u import TplinkRouter
 from tplinkrouterc6u.client.deco import TPLinkDecoClient
 from tplinkrouterc6u.client_abstract import AbstractRouter
@@ -10,30 +10,36 @@ from tplinkrouterc6u.client.ex import TPLinkEXClient
 from tplinkrouterc6u.client.c6v4 import TplinkC6V4Router
 from tplinkrouterc6u.client.c5400x import TplinkC5400XRouter
 from tplinkrouterc6u.client.c1200 import TplinkC1200Router
+from tplinkrouterc6u.client.vr import TPLinkVRClient
 
 
 class TplinkRouterProvider:
     @staticmethod
     def get_client(host: str, password: str, username: str = 'admin', logger: Logger = None,
                    verify_ssl: bool = True, timeout: int = 30) -> AbstractRouter:
-        for client in [TplinkC5400XRouter, TPLinkEXClient, TPLinkMRClient, TplinkC6V4Router, TPLinkDecoClient,
-                       TPLinkXDRClient, TplinkRouter]:
+        for client in [TplinkC5400XRouter, TPLinkVRClient, TPLinkEXClient, TPLinkMRClient, TplinkC6V4Router,
+                       TPLinkDecoClient, TPLinkXDRClient, TplinkRouter]:
             router = client(host, password, username, logger, verify_ssl, timeout)
             if router.supports():
                 return router
 
+        message = ('Login failed! Please check if your router local password is correct or '
+                   'try to use web encrypted password instead. Check the documentation!')
         router = TplinkC1200Router(host, password, username, logger, verify_ssl, timeout)
         try:
             router.authorize()
             return router
-        except AuthorizeError as e:
-            if logger:
-                logger.error(e.__str__())
-            raise ClientException(('Login failed! Please check if your router local password is correct or '
-                                   'try to use web encrypted password instead. Check the documentation!'
-                                   ))
-        except Exception as e:
-            if logger:
-                logger.error(e.__str__())
-            raise ClientException('Try to use web encrypted password instead. Check the documentation! '
-                                  + e.__str__())
+        except Exception:
+            pass
+
+        for client in [TPLinkVRClient, TPLinkXDRClient]:
+            router = client(host, password, username, None, verify_ssl, timeout)
+            try:
+                router.authorize()
+                message = ('Your router might be supported by {}. Please open the issue here '
+                           'https://github.com/AlexandrErohin/TP-Link-Archer-C6U').format(router.__class__)
+                break
+            except Exception:
+                pass
+
+        raise ClientException(message)

{tplinkrouterc6u-5.4.1 → tplinkrouterc6u-5.5.0}/tplinkrouterc6u.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: tplinkrouterc6u
-Version: 5.4.1
+Version: 5.5.0
 Summary: TP-Link Router API
 Home-page: https://github.com/AlexandrErohin/TP-Link-Archer-C6U
 Author: Alex Erohin
@@ -53,6 +53,7 @@ from tplinkrouterc6u import (
     TplinkC1200Router,
     TplinkC5400XRouter,
     TPLinkMRClient,
+    TPLinkVRClient,
     TPLinkEXClient,
     TPLinkXDRClient,
     TPLinkDecoClient,
@@ -167,6 +168,7 @@ or you have TP-link C5400X or similar router you need to get web encrypted passw
 | wan_ipv4_uptime | Internet Uptime | int, None |
 | mem_usage | Memory usage in percentage between 0 and 1 | float, None |
 | cpu_usage | CPU usage in percentage between 0 and 1 | float, None |
+| conn_type | Connection type | str, None |
 | devices | List of all connectedd devices | list[[Device](#device)] |
 
 ### <a id="device">Device</a>
@@ -318,7 +320,9 @@ or you have TP-link C5400X or similar router you need to get web encrypted passw
 - Archer MR600 (v1, v2, v3)
 - Archer VR600 v3
 - Archer VR900v
+- Archer VR1200v v1
 - Archer VR2100v v1
+- Archer VX1800v v1.0
 - Deco M4 2.0
 - Deco M4R 2.0
 - Deco M5 v3

{tplinkrouterc6u-5.4.1 → tplinkrouterc6u-5.5.0}/tplinkrouterc6u.egg-info/SOURCES.txt

@@ -24,6 +24,7 @@ tplinkrouterc6u/client/c6v4.py
 tplinkrouterc6u/client/deco.py
 tplinkrouterc6u/client/ex.py
 tplinkrouterc6u/client/mr.py
+tplinkrouterc6u/client/vr.py
 tplinkrouterc6u/client/xdr.py
 tplinkrouterc6u/common/__init__.py
 tplinkrouterc6u/common/dataclass.py