Add fbx autodetection

aiofreepybox/aiofreepybox.py

@@ -41,14 +41,14 @@
 
 
 class Freepybox:
-    def __init__(self, app_desc=app_desc, token_file=token_file, api_version='v3', timeout=10):
+    def __init__(self, app_desc=app_desc, token_file=token_file, api_version='auto', timeout=10):
         self.token_file = token_file
         self.api_version = api_version
         self.timeout = timeout
         self.app_desc = app_desc
         self._access = None
 
-    async def open(self, host, port):
+    async def open(self, host='auto', port='auto'):
         '''
         Open a session to the freebox, get a valid access module
         and instantiate freebox modules
@@ -63,6 +63,48 @@ async def open(self, host, port):
         conn = aiohttp.TCPConnector(ssl_context=ssl_ctx)
         self._session = aiohttp.ClientSession(connector=conn)
 
+        # Detect host, port and api_version
+        detect = [
+            host,
+            port,
+            self.api_version
+            ]
+        if 'auto' in detect:
+            default_host = '212.27.38.253'
+            default_host_list = [
+                'auto',
+                'mafreebox.freebox.fr',
+                '192.168.0.254',
+                default_host
+                ]
+            if host not in default_host_list:
+                default_host = host
+                logger.debug(f'Host set to {host}')
+                if port == 'auto':
+                    logger.warning('Port is set to auto, but host is not in default host list, checking port 80')
+                    sock = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
+                    result = sock.connect_ex((default_host,80))
+                    if result != 0:
+                        raise HttpRequestError('Port 80 is closed, cannot detect freebox')
+            r = await self._session.get(f'http://{default_host}/api_version', timeout=self.timeout)
+            resp = await r.json()
+            if host == 'auto':
+                host = resp['api_domain']
+                logger.debug(f'Host set to {host}')
+            if port == 'auto':
+                port = resp['https_port']
+                logger.debug(f'Port set to {port}')
+            server_version = resp['api_version'][:1]
+            short_api_version = self.api_version[1:]
+            if self.api_version == 'auto':
+                self.api_version = f'v{server_version}'
+                logger.debug(f'API version set to {self.api_version}')
+            elif server_version > short_api_version:
+                logger.warning(f'Freebox server support a newer api version: v{server_version}, check api_version ({self.api_version})')
+            elif server_version < short_api_version:
+                logger.warning(f'Freebox server does not support this version ({self.api_version}), downgrading to v{server_version}')
+                self.api_version = f'v{server_version}'
+
         self._access = await self._get_freebox_access(host, port, self.api_version, self.token_file, self.app_desc, self.timeout)
 
         # Instantiate freebox modules
@@ -148,7 +190,7 @@ async def _get_freebox_access(self, host, port, api_version, token_file, app_des
 
             # Store application token in file
             self._writefile_app_token(app_token, track_id, app_desc, token_file)
-            logger.info('Application token file was generated: {0}'.format(token_file))
+            logger.info(f'Application token file was generated: {token_file}')
 
         # Create freebox http access module
         fbx_access = Access(self._session, base_url, app_token, app_desc['app_id'], timeout)
@@ -165,7 +207,7 @@ async def _get_authorization_status(self, base_url, track_id, timeout):
             granted 	the app_token is valid and can be used to open a session
             denied 	    the user denied the authorization request
         '''
-        url = urljoin(base_url, 'login/authorize/{0}'.format(track_id))
+        url = urljoin(base_url, f'login/authorize/{track_id}')
         r = await self._session.get(url, timeout=timeout)
         resp = await r.json()
         return resp['result']['status']
@@ -183,7 +225,7 @@ async def _get_app_token(self, base_url, app_desc, timeout=10):
 
         # raise exception if resp.success != True
         if not resp.get('success'):
-            raise AuthorizationError('Authorization failed (APIResponse: {0})'
+            raise AuthorizationError('Authorization failed (APIResponse: {})'
                                      .format(json.dumps(resp)))
 
         app_token = resp['result']['app_token']
@@ -221,7 +263,7 @@ def _get_base_url(self, host, port, freebox_api_version):
         Returns base url for HTTPS requests
         :return:
         '''
-        return 'https://{0}:{1}/api/{2}/'.format(host, port, freebox_api_version)
+        return f'https://{host}:{port}/api/{freebox_api_version}/'
 
     def _is_app_desc_valid(self, app_desc):
         '''

example.py

@@ -15,12 +15,12 @@ async def demo():
     fbx = Freepybox()
 
     # To find out the HTTPS host and port of your freebox, go to
-    # http://mafreebox.freebox.fr/api_version
+    # http://mafreebox.freebox.fr/api_version or let auto detect do it for you
 
     # Connect to the freebox
     # Be ready to authorize the application on the Freebox if you use this
     # example for the first time
-    await fbx.open(host='abcdefgh.fbxos.fr', port=1234)
+    await fbx.open()
 
     # Dump freebox configuration using system API
     # Extract temperature and mac address