tplinkrouterc6u 5.4.2__py3-none-any.whl → 5.5.0__py3-none-any.whl

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)

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)

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/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', []))

tplinkrouterc6u/client/ex.py

@@ -49,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:

tplinkrouterc6u/client/mr.py

@@ -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(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 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/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/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

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.2.dist-info → tplinkrouterc6u-5.5.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: tplinkrouterc6u
-Version: 5.4.2
+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,6 +320,7 @@ 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

{tplinkrouterc6u-5.4.2.dist-info → tplinkrouterc6u-5.5.0.dist-info}/RECORD

@@ -1,30 +1,31 @@
 test/__init__.py,sha256=McQmUjeN3AwmwdS6QNfwGXXE77OKoPK852I2BM9XsrU,210
 test/test_client_c1200.py,sha256=4RdwMEwTGWLOxOVTuPikifXDcUJFQ13DuyWGm2Aevrk,8811
-test/test_client_c6u.py,sha256=rJKJWwUBcmMehvdyyRtWm420X6KIXdrJu75VH6JPvng,32066
+test/test_client_c6u.py,sha256=3nvhybxYxiCVjjLXB3nBYrAkXS8zoLtJibgvsqsTQ3U,32140
 test/test_client_deco.py,sha256=YPLKRD8GoyDYHfRgdXvCk8iVNw8zdMJW-AHVnNbpdTM,31719
 test/test_client_ex.py,sha256=0dVvOJqxpR2xNca99vadfdpxmzW-4sk9X_4tAK8x9-c,21710
-test/test_client_mr.py,sha256=pKlQwGZNZRek9oFQPm2HkeeU3cI9EPySxtdZ8H2mqWY,33462
+test/test_client_mr.py,sha256=NxTgXv_wN50K8KsJhykoU-TX0ddDGlX_7jp50FXOLjg,33517
 test/test_client_xdr.py,sha256=mgn-xL5mD5sHD8DjTz9vpY7jeh4Ob6Um6Y8v5Qgx2jA,23374
-tplinkrouterc6u/__init__.py,sha256=bLlCkiL9ycyRVG7VqPOJWPcoPmUfMkdTcUKFYKNP8QI,900
+tplinkrouterc6u/__init__.py,sha256=8f-K4p6y_bIa4NReODulceWsjCCojAFSSj5vrjaogdw,953
 tplinkrouterc6u/client_abstract.py,sha256=3UYzmll774S_Gb5E0FTVO_rI3-XFM7PSklg1-V-2jls,1419
-tplinkrouterc6u/provider.py,sha256=SsyGu_2SZ-a46ADl9aw_0wx0lgbsJhS6wnwUzb_1qGg,1900
+tplinkrouterc6u/provider.py,sha256=lgmGAZI5E1jgpo0IRY4TIKTbAb4S_wX3HhRcx0RoSmY,2083
 tplinkrouterc6u/client/__init__.py,sha256=KBy3fmtA9wgyFrb0Urh2x4CkKtWVnESdp-vxmuOvq0k,27
 tplinkrouterc6u/client/c1200.py,sha256=_nY_pJ-wPWODAaes9kHPdVcM6YM54f1E54CfdoFHqbE,4771
 tplinkrouterc6u/client/c5400x.py,sha256=9E0omBSbWY_ljrs5MTCMu5brmrLtzsDB5O62Db8lP8Q,4329
-tplinkrouterc6u/client/c6u.py,sha256=fRNqT8vifpqQoLLNUwEYX1A6jEzat5XGbhCVGmL7ihk,17588
+tplinkrouterc6u/client/c6u.py,sha256=TbS8qbwfPzIVDEMNNlKMhWuGeo-RUvaCkG_bF7Y4L0Q,17637
 tplinkrouterc6u/client/c6v4.py,sha256=bvquZ0FHgU_LJfZxQkfyKQz0C52mFytC4mzFSOqp99Y,1596
 tplinkrouterc6u/client/deco.py,sha256=7uVd9wt3aJGShft7L520AzFpQ85xbgRWM-8uyrpxE8Y,8229
-tplinkrouterc6u/client/ex.py,sha256=RVB04rWTFEqYlKr_4TSqzVC3niNWZOcrkxfI2ub9PY0,13070
-tplinkrouterc6u/client/mr.py,sha256=clqCU8q5WM5xKSgJrcgKmDvrvE_INEf5gwja0iHhkPc,25877
+tplinkrouterc6u/client/ex.py,sha256=Ih0aCvjhUGN6MDIeRgT0nSBQYNWzH9c70i71AN_G_Ns,13039
+tplinkrouterc6u/client/mr.py,sha256=DJ5phVte-yEMddE5QAUu2MnRBmfuBZwz2-4ZWYWXlI0,25956
+tplinkrouterc6u/client/vr.py,sha256=7Tbu0IrWtr4HHtyrnLFXEJi1QctzhilciL7agtwQ0R8,5025
 tplinkrouterc6u/client/xdr.py,sha256=9YuVfrmsrDeqnhJXp1Fc4OfcJEz9SkjdmpOoTIDi6Js,10327
 tplinkrouterc6u/common/__init__.py,sha256=pCTvVZ9CAwgb7MxRnLx0y1rI0sTKSwT24FfxWfQXeTM,33
-tplinkrouterc6u/common/dataclass.py,sha256=iozL4PzEiFX3Ry4yJA9VU83sr-yPv8AmU1cquusj-Ks,7765
+tplinkrouterc6u/common/dataclass.py,sha256=QQTGb9w4Yt3GNkISgrQhvWPMEEJOsgFFZ2MI1MIAPjw,7807
 tplinkrouterc6u/common/encryption.py,sha256=4HelTxzN6esMfDZRBt3m8bwB9Nj_biKijnCnrGWPWKg,6228
 tplinkrouterc6u/common/exception.py,sha256=_0G8ZvW5__CsGifHrsZeULdl8c6EUD071sDCQsQgrHY,140
 tplinkrouterc6u/common/helper.py,sha256=23b04fk9HuVinrZXMCS5R1rmF8uZ7eM-Cdnp7Br9NR0,572
 tplinkrouterc6u/common/package_enum.py,sha256=4ykL_2Pw0nDEIH_qR9UJlFF6stTgSfhPz32r8KT-sh8,1624
-tplinkrouterc6u-5.4.2.dist-info/LICENSE,sha256=YF6QR6Vjxcg5b_sYIyqkME7FZYau5TfEUGTG-0JeRK0,35129
-tplinkrouterc6u-5.4.2.dist-info/METADATA,sha256=FWZupEQ4AcBd0PaHlJHj_hE6UE_zGXr8lqX9lx2SRpc,15211
-tplinkrouterc6u-5.4.2.dist-info/WHEEL,sha256=jB7zZ3N9hIM9adW7qlTAyycLYW9npaWKLRzaoVcLKcM,91
-tplinkrouterc6u-5.4.2.dist-info/top_level.txt,sha256=1iSCCIueqgEkrTxtQ-jiHe99jAB10zqrVdBcwvNfe_M,21
-tplinkrouterc6u-5.4.2.dist-info/RECORD,,
+tplinkrouterc6u-5.5.0.dist-info/LICENSE,sha256=YF6QR6Vjxcg5b_sYIyqkME7FZYau5TfEUGTG-0JeRK0,35129
+tplinkrouterc6u-5.5.0.dist-info/METADATA,sha256=tBsmDyFWC6vjlTys6G38pTZ658kQMgGhiGgTNplPyRw,15295
+tplinkrouterc6u-5.5.0.dist-info/WHEEL,sha256=jB7zZ3N9hIM9adW7qlTAyycLYW9npaWKLRzaoVcLKcM,91
+tplinkrouterc6u-5.5.0.dist-info/top_level.txt,sha256=1iSCCIueqgEkrTxtQ-jiHe99jAB10zqrVdBcwvNfe_M,21
+tplinkrouterc6u-5.5.0.dist-info/RECORD,,