googlewifi 0.1.0__py3-none-any.whl

googlewifi/__init__.py

@@ -0,0 +1,734 @@
+import asyncio
+import time
+import aiohttp
+import json
+import datetime
+import dateutil.parser
+import grpc
+import gpsoauth
+
+from ghome_foyer_api.api_pb2 import GetHomeGraphRequest
+from ghome_foyer_api.api_pb2_grpc import StructuresServiceStub
+
+GH_HEADERS = {"Content-Type": "application/json"}
+
+OAUTH_SERVICE = (
+  "oauth2:https://www.googleapis.com/auth/accesspoints "
+  "https://www.googleapis.com/auth/clouddevices"
+)
+GOOGLE_HOME_APP = "com.google.android.apps.chromecast.app"
+GOOGLE_HOME_CLIENT_SIG = "24bb24c05e47e0aefa68a58a766179d9b613a600"
+TOKEN_REFRESH_MARGIN = 300
+GPSOAUTH_TIMEOUT = 30
+
+
+class GoogleWifi:
+
+  def __init__(self, email:str, master_token:str, android_id:str, session:aiohttp.ClientSession = None):
+    """Initialize the Google Wifi API with a Google account credential set.
+
+    email: Google account email address.
+    master_token: aas_et/... or oauth2rt_1/... master token obtained via exchange_oauth_token().
+    android_id: android id used when the master token was minted.
+    """
+
+    if session:
+      self._session = session
+    else:
+      self._session = aiohttp.ClientSession()
+
+    self._email = email
+    self._master_token = master_token
+    self._android_id = android_id
+    self._api_token = None
+    self._api_token_expiry = 0
+    self._systems = None
+    self._access_points = {}
+
+  @staticmethod
+  async def exchange_oauth_token(email:str, oauth_token:str, android_id:str):
+    """Exchange an EmbeddedSetup oauth_token (oauth2_4/...) for a master token."""
+    def _exchange():
+      return gpsoauth.exchange_token(email, oauth_token, android_id)
+
+    try:
+      response = await asyncio.wait_for(asyncio.to_thread(_exchange), GPSOAUTH_TIMEOUT)
+    except asyncio.TimeoutError as error:
+      raise ConnectionError(f"Timed out contacting Google authentication: {error}") from error
+    except Exception as error:
+      raise GoogleWifiAuthError(f"Could not exchange oauth_token: {error}") from error
+
+    if not isinstance(response, dict):
+      raise GoogleWifiAuthError("Malformed response from Google authentication")
+
+    master_token = response.get("Token")
+    if not master_token:
+      error = response.get("Error") or response.get("error") or "unknown error"
+      raise GoogleWifiAuthError(f"Google did not return a master token: {error}")
+
+    return master_token
+
+  async def post_api(
+    self,
+    url:str,
+    headers:str=None,
+    payload:str=None,
+    params:str=None,
+    json_payload=None,
+    _retry:bool=True,
+    ):
+    """Post to the Google APIs."""
+    async with self._session.post(
+      url,
+      headers=headers,
+      data=payload,
+      params=params,
+      json=json_payload,
+      timeout=30,
+    ) as resp:
+      if resp.status == 401 and _retry:
+        await self._refresh_token_once(headers)
+        return await self.post_api(url, headers, payload, params, json_payload, False)
+      self._check_status(resp.status)
+      try:
+        response = await resp.text()
+      except aiohttp.ClientConnectorError as error:
+        raise ConnectionError(error)
+
+    if response:
+      try:
+        response = json.loads(response)
+      except json.JSONDecodeError as error:
+        raise ValueError(error)
+
+    return response
+
+  async def get_api(self, url:str, headers:str=None, payload:str=None, params:str=None, _retry:bool=True):
+    """Get call to Google APIs."""
+    try:
+      async with self._session.get(
+        url,
+        headers=headers,
+        data=payload,
+        params=params,
+        timeout=30,
+      ) as resp:
+        if resp.status == 401 and _retry:
+          await self._refresh_token_once(headers)
+          return await self.get_api(url, headers, payload, params, False)
+        self._check_status(resp.status)
+        try:
+          response = await resp.text()
+        except aiohttp.ClientError as error:
+          raise ConnectionError(error)
+    except asyncio.TimeoutError as error:
+      raise GoogleHomeIgnoreDevice(error)
+
+    if response:
+      try:
+        response = json.loads(response)
+      except json.JSONDecodeError as error:
+        raise ValueError(error)
+
+    return response
+
+  async def put_api(self, url:str, headers:str=None, payload:str=None, params:str=None, _retry:bool=True):
+    """Put call to Google APIs."""
+    async with self._session.put(
+      url,
+      headers=headers,
+      data=payload,
+      params=params,
+      timeout=30,
+    ) as resp:
+      if resp.status == 401 and _retry:
+        await self._refresh_token_once(headers)
+        return await self.put_api(url, headers, payload, params, False)
+      self._check_status(resp.status)
+      try:
+        response = await resp.text()
+      except aiohttp.ClientError as error:
+        raise ConnectionError(error)
+
+    if response:
+      try:
+        response = json.loads(response)
+      except json.JSONDecodeError as error:
+        raise ValueError(error)
+
+      return response
+
+  async def delete_api(self, url:str, headers:str=None, payload:str=None, params:str=None, _retry:bool=True):
+    """Delete call to Google APIs."""
+    async with self._session.delete(
+      url,
+      headers=headers,
+      data=payload,
+      params=params,
+      timeout=30,
+    ) as resp:
+      if resp.status == 401 and _retry:
+        await self._refresh_token_once(headers)
+        return await self.delete_api(url, headers, payload, params, False)
+      self._check_status(resp.status)
+      try:
+        response = await resp.text()
+      except aiohttp.ClientError as error:
+        raise ConnectionError(error)
+
+    if response:
+      try:
+        response = json.loads(response)
+      except json.JSONDecodeError as error:
+        raise ValueError(error)
+
+      return response
+
+  @staticmethod
+  def _check_status(status:int):
+    """Raise on error responses, re-mintable auth errors included."""
+    if status == 401 or status == 403:
+      raise GoogleWifiAuthError(f"Foyer authorization failed (HTTP {status})")
+    if status >= 400:
+      raise GoogleWifiException(f"Foyer API returned HTTP {status}")
+
+  async def get_api_token(self, force_refresh:bool=False):
+    """Mint or refresh the scoped API token via Google Play Services OAuth."""
+
+    if (
+      not force_refresh
+      and self._api_token
+      and self._api_token_expiry - TOKEN_REFRESH_MARGIN > time.time()
+    ):
+      return True
+
+    def _oauth():
+      return gpsoauth.perform_oauth(
+        self._email,
+        self._master_token,
+        self._android_id,
+        service=OAUTH_SERVICE,
+        app=GOOGLE_HOME_APP,
+        client_sig=GOOGLE_HOME_CLIENT_SIG,
+      )
+
+    try:
+      response = await asyncio.wait_for(asyncio.to_thread(_oauth), GPSOAUTH_TIMEOUT)
+    except asyncio.TimeoutError as error:
+      raise ConnectionError(f"Timed out contacting Google authentication: {error}") from error
+    except Exception as error:
+      raise ConnectionError(f"Google authentication token request failed: {error}") from error
+
+    if not isinstance(response, dict):
+      raise ConnectionError("Malformed response from Google authentication")
+
+    error = response.get("Error") or response.get("error")
+    if isinstance(error, str) and error.casefold() == "badauthentication":
+      raise GoogleWifiAuthError("Google rejected the stored master token")
+
+    token = response.get("Auth")
+    if not token:
+      raise GoogleWifiAuthError(
+        f"Google did not return an access token: {error or 'unknown error'}"
+      )
+
+    try:
+      lifetime = int(response.get("ExpiresInDurationSec", 3600))
+    except (TypeError, ValueError):
+      lifetime = 3600
+
+    self._api_token = token
+    self._api_token_expiry = time.time() + max(lifetime, 0)
+
+    return True
+
+  async def _refresh_token_once(self, headers):
+    """Force a token re-mint and update the Authorization header in place."""
+    await self.get_api_token(force_refresh=True)
+    if isinstance(headers, dict):
+      headers["Authorization"] = f"Bearer {self._api_token}"
+
+  async def connect(self):
+    """Authenticate to the Google Wifi services."""
+    await self.get_api_token()
+    return bool(self._api_token)
+
+  async def get_systems(self):
+    """Get the systems on this account."""
+    if await self.connect():
+      url = "https://googlehomefoyer-pa.googleapis.com/v2/groups?prettyPrint=false"
+      headers = {
+        "Authorization": f"Bearer {self._api_token}",
+        "Content-Type": "application/json; charset=utf-8"
+      }
+      payload = {}
+      
+      response = await self.get_api(url, headers, payload)
+
+      if response.get("groups"):
+        return await self.structure_systems(response)
+      else:
+        raise GoogleWifiException("Failed to retreive Google Wifi Data.")
+
+  async def get_devices(self, system_id):
+    """Retrieve the devices list for a given system."""
+    
+    if await self.connect():
+      url = f"https://googlehomefoyer-pa.googleapis.com/v2/groups/{system_id}/stations?prettyPrint=false"
+      headers = {
+        "Content-Type": "application/json; charset=utf-8",
+        "Authorization": f"Bearer {self._api_token}"
+      }
+      payload = {}
+
+      response =  await self.get_api(url, headers, payload)
+
+      return(response)
+
+  async def get_status(self, system_id):
+    """Retrieve the status payload for a system."""
+
+    if await self.connect():
+      url=f"https://googlehomefoyer-pa.googleapis.com/v2/groups/{system_id}/status?prettyPrint=false"
+      headers = {
+        "Content-Type": "application/json; charset=utf-8",
+        "Authorization": f"Bearer {self._api_token}"
+      }
+      payload = {}
+
+      response = await self.get_api(url, headers, payload)
+
+      return(response)
+
+  async def structure_systems(self, system_data):
+    """Structure the data with ids in dict."""
+    systems = {}
+    
+    for this_system in system_data["groups"]:
+      systems[this_system["id"]] = this_system
+
+      system_status = await self.get_status(this_system["id"])
+      system_metrics = await self.get_realtime_metrics(this_system["id"])
+
+      try:
+        systems[this_system["id"]]["status"] = system_status["wanConnectionStatus"]
+        systems[this_system["id"]]["groupTraffic"] = system_metrics.get("groupTraffic",None)
+      except KeyError as error:
+        raise GoogleWifiException(error)
+
+      blocking_policies = {}
+      family_hub_settings = this_system["groupSettings"].get("familyHubSettings") or {}
+      if family_hub_settings.get("stationPolicies"):
+        for blocking_policy in family_hub_settings["stationPolicies"]:
+          blocking_policies[blocking_policy["stationId"]] = blocking_policy
+
+      this_status = {}
+      for this_ap in system_status["apStatuses"]:
+        this_status[this_ap["apId"]] = this_ap
+
+      system_status["status"] = this_status
+
+      access_points = {}
+      
+      try:
+        for this_ap in this_system["accessPoints"]:
+          access_points[this_ap["id"]] = this_ap
+          access_points[this_ap["id"]]["status"] = system_status["status"][this_ap["id"]]["apState"]
+      except KeyError as error:
+        raise GoogleWifiException(error)
+
+      systems[this_system["id"]]["access_points"] = access_points
+
+      devices_list = await self.get_devices(this_system["id"])
+      
+      devices = {}
+      station_ids = []
+      
+      try:
+        for this_device in devices_list["stations"]:
+          devices[this_device["id"]] = this_device
+          station_ids.append(this_device["id"])
+          device_paused = False
+
+          if blocking_policies.get(this_device["id"]):
+            expire_date = dateutil.parser.parse(blocking_policies[this_device["id"]]["blockingPolicy"]["expiryTimestamp"])
+            
+            if expire_date > datetime.datetime.now(datetime.timezone.utc) or expire_date.timestamp() == 0:
+              device_paused = True
+
+          devices[this_device["id"]]["paused"] = device_paused
+      except KeyError as error:
+        raise GoogleWifiException(error)
+
+      sensitive_info = await self.get_sensitive_info(system_id=this_system["id"], station_ids=station_ids)                                        
+      for this_station in sensitive_info:
+        if this_station["stationId"] in devices:
+          devices[this_station["stationId"]]["macAddress"] = this_station.get("macAddress",{})
+
+      if system_metrics.get("stationMetrics"):
+        for this_station in system_metrics.get("stationMetrics"):
+          if this_station["station"]["id"] in devices:
+            devices[this_station["station"]["id"]]["traffic"] = this_station.get("traffic",{})
+
+      systems[this_system["id"]]["devices"] = devices
+
+    return systems
+
+  async def pause_device(self, system_id:str, device_id:str, pause_state:bool):
+    """Pause or unpause a specific device"""
+
+    if await self.connect():
+      url = f"https://googlehomefoyer-pa.googleapis.com/v2/groups/{system_id}/stationBlocking?prettyPrint=false"
+      headers = {
+        "Content-Type": "application/json; charset=utf-8",
+        "Authorization": f"Bearer {self._api_token}"
+      }
+
+      payload = {
+        "blocked": str(pause_state).lower(),
+        "stationId": device_id
+      }
+      payload = json.dumps(payload)
+      
+      response = await self.put_api(url, headers, payload)
+
+      return response.get("operation").get("operationState") == "CREATED"
+
+    else:
+      return False
+
+  async def prioritize_device(self, system_id:str, device_id:str, duration_hours:int=1):
+    """Set priority device for specified time (default 1 hour)."""
+    
+    if await self.connect():
+      duration_hours = 1 if duration_hours < 1 else duration_hours
+      duration_hours = 6 if duration_hours > 6 else duration_hours
+      
+      url = f"https://googlehomefoyer-pa.googleapis.com/v2/groups/{system_id}/prioritizedStation?prettyPrint=false"
+      headers = {
+        "Content-Type": "application/json; charset=utf-8",
+        "Authorization": f"Bearer {self._api_token}"
+      }
+
+      end_time = datetime.datetime.now() + datetime.timedelta(hours=duration_hours)
+
+      end_time = end_time.astimezone().replace(microsecond=0).isoformat()
+
+      payload = {
+        "stationId": device_id,
+        "prioritizationEndTime": end_time
+      }
+
+      payload = json.dumps(payload)
+
+      response = await self.put_api(url, headers=headers, payload=payload)
+
+      return response.get("operation").get("operationState") == "CREATED"
+
+    else:
+      return False
+
+  async def clear_prioritization(self, system_id:str):
+    """Clear any device prioritization."""
+    
+    if await self.connect():
+      url=f"https://googlehomefoyer-pa.googleapis.com/v2/groups/{system_id}/prioritizedStation?prettyPrint=false"
+
+      headers = {
+        "Content-Type": "application/json; charset=utf-8",
+        "Authorization": f"Bearer {self._api_token}"
+      }
+
+      payload = {}
+
+      response = await self.delete_api(url, headers=headers, payload=payload)
+
+      return response.get("operation").get("operationState") == "CREATED"
+
+    else:
+      return False
+
+  async def set_brightness(self, ap_id:str, brightness:int):
+    """Set Access Point Light Brightness."""
+
+    if await self.connect():
+      brightness = 0 if brightness < 0 else brightness
+      brightness = 100 if brightness > 100 else brightness
+      
+      url = f"https://googlehomefoyer-pa.googleapis.com/v2/accesspoints/{ap_id}/lighting?prettyPrint=false"
+
+      headers = {
+        "Content-Type": "application/json; charset=utf-8",
+        "Authorization": f"Bearer {self._api_token}"
+      }
+
+      payload = {
+        "automatic": False,
+        "intensity": brightness
+      }
+
+      payload = json.dumps(payload)
+
+      response = await self.put_api(url, headers=headers, payload=payload)
+
+      return response.get("operation").get("operationState") == "CREATED"
+
+    else:
+      return False
+
+  async def restart_ap(self, ap_id:str):
+    """Restart a specific Access Point."""
+
+    if await self.connect():
+      url=f"https://googlehomefoyer-pa.googleapis.com/v2/accesspoints/{ap_id}/reboot?prettyPrint=false"
+
+      headers = {
+        "Content-Type": "application/json; charset=utf-8",
+        "Authorization": f"Bearer {self._api_token}"
+      }
+
+      payload = {}
+      
+      response = await self.post_api(url, headers=headers, payload=payload)
+
+      return response.get("operation").get("operationState") == "CREATED"
+    
+    else:
+      return False
+  
+  async def restart_system(self, system_id:str):
+    """Restart the whole Google Wifi System."""
+
+    if await self.connect():
+      url = f"https://googlehomefoyer-pa.googleapis.com/v2/groups/{system_id}/reboot?prettyPrint=false"
+
+      headers = {
+        "Content-Type": "application/json; charset=utf-8",
+        "Authorization": f"Bearer {self._api_token}"
+      }
+
+      payload = {}
+
+      response = await self.post_api(url, headers=headers, payload=payload)
+
+      return response.get("operation").get("operationState") == "CREATED"
+
+    else:
+      return False
+
+  async def refresh_tokens(self):
+    """Refresh the Google Access tokens for local Google devices."""
+    if await self.connect():
+      creds = grpc.access_token_call_credentials(self._api_token)
+      ssl = grpc.ssl_channel_credentials()
+      composite = grpc.composite_channel_credentials(ssl, creds)
+      channel = grpc.secure_channel("googlehomefoyer-pa.googleapis.com:443", composite)
+      service = StructuresServiceStub(channel)
+      resp = service.GetHomeGraph(GetHomeGraphRequest())
+      data = resp.home.devices
+
+      tokens = {}
+
+      for device in data:
+          # this is the 'cloud device id'
+          if device.local_auth_token != "":
+            tokens[
+                device.device_info.project_info.string2
+            ] = device.local_auth_token
+
+      return tokens
+
+  async def update_info(self, host):
+    """Update data from Google Home."""
+
+    if await self.connect():
+      url = f"https://{host}:8443/setup/eureka_info"
+      params = {
+        "params":"version,audio,name,build_info,detail,device_info,net,wifi,setup,settings,opt_in,opencast,multizone,proxy,night_mode_params,user_eq,room_equalizer",
+        "options":"detail"
+      }
+
+      response = await self.get_api(url=url,params=params)
+
+      if response:
+        return response
+      else:
+        raise GoogleHomeUpdateFailed()
+
+  async def get_bluetooth_status(self, host, token):
+    """Retrieve the current bluetooth status."""
+    if await self.connect():
+      url = f"https://{host}:8443/setup/bluetooth/status"
+      headers = {"cast-local-authorization-token": token}
+
+      response = await self.get_api(url=url,headers=headers)
+
+      return response
+
+  async def get_bluetooth_devices(self, host, token):
+    """Retrieve the current bluetooth clients from a Google Home."""
+
+    if await self.connect():
+      url = f"https://{host}:8443/setup/bluetooth/scan"
+      data = {"enable": True, "clear_results": True, "timeout": 5}
+      headers = GH_HEADERS
+      headers["Host"] = host
+      headers["cast-local-authorization-token"] = token
+
+      await self.post_api(url=url,headers=headers,json_payload=data)
+      await asyncio.sleep(5)
+
+      url = f"https://{host}:8443/setup/bluetooth/scan_results"
+      
+      response = await self.get_api(url=url,headers=headers)
+
+      return response
+
+  async def create_wan_speedtest(self, system_id:str):
+    """Start a speed test operation on a system."""
+    if await self.connect():
+      url = f"https://googlehomefoyer-pa.googleapis.com/v2/groups/{system_id}/wanSpeedTest"
+      headers = {
+        "Content-Type": "application/json; charset=utf-8",
+        "Authorization": f"Bearer {self._api_token}"
+      }
+      payload = {}
+      params = (
+        ('prettyPrint', 'false'),
+      )
+
+      response = await self.post_api(url=url,headers=headers,payload=payload,params=params)
+      operation_id = response["operation"]["operationId"]
+
+      return operation_id
+
+  async def check_operation(self, operation_id: str):
+    """Check the status of a speed test operation."""
+    if await self.connect():
+      url = f"https://googlehomefoyer-pa.googleapis.com/v2/operations/{operation_id}"
+      headers = {
+        "Content-Type": "application/json; charset=utf-8",
+        "Authorization": f"Bearer {self._api_token}"
+      }
+      payload = {}
+      params = (
+        ('prettyPrint', 'false'),
+      )
+
+      return await self.get_api(url=url,headers=headers,payload=payload,params=params)
+
+  async def speed_test_results(self, system_id:str):
+    """Retrieve the speed test results."""
+    if await self.connect():
+      url = f"https://googlehomefoyer-pa.googleapis.com/v2/groups/{system_id}/speedTestResults"
+      headers = {
+        "Content-Type": "application/json; charset=utf-8",
+        "Authorization": f"Bearer {self._api_token}"
+      }
+      payload = {}
+      params = (
+        ('prettyPrint', 'false'),
+        ('maxResultCount', 1)
+      )
+
+      response = await self.get_api(url=url,headers=headers,payload=payload,params=params)
+
+      return response["speedTestResults"]
+
+  async def run_speed_test(self, system_id:str):
+    """Run a speed test and return the results."""
+    if await self.connect():
+      operation_id = await self.create_wan_speedtest(system_id=system_id)
+
+      status = await self.check_operation(operation_id)
+      status = status["operationState"]
+
+      while status != "DONE":
+        status = await self.check_operation(operation_id)
+        status = status["operationState"]
+        await asyncio.sleep(5)
+
+      results = await self.speed_test_results(system_id=system_id)
+      return results[0]
+      
+  async def start_retrieve_sensitive_info(self, system_id:str, station_ids:list):
+    """Start the request to return the device sensitive information."""
+    if await self.connect():
+      url = f"https://googlehomefoyer-pa.googleapis.com/v2/groups/{system_id}/stations/operations/sensitiveInfo"
+
+      headers = {
+        "Content-Type": "application/json; charset=utf-8",
+        "Authorization": f"Bearer {self._api_token}"
+      }
+      json_payload = {"stationIds":station_ids}
+      params = (
+        ('prettyPrint', 'false'),
+      )
+
+      response = await self.post_api(url=url,headers=headers,json_payload=json_payload,params=params)
+      operation_id = response.get("operation",[]).get("operationId")
+
+      return operation_id
+
+  async def sensitive_info_results(self, operation_id:str):
+    """Return the results of the sensitive info request."""
+    if await self.connect():
+      url = f"https://googlehomefoyer-pa.googleapis.com/v2/operations/{operation_id}/sensitiveInfo"
+      params = (
+        ('prettyPrint', 'false'),
+      )
+      headers = {
+        "Content-Type": "application/json; charset=utf-8",
+        "Authorization": f"Bearer {self._api_token}"
+      }
+      payload = {}
+
+      return await self.get_api(url=url, headers=headers, payload=payload, params=params)
+
+  async def get_sensitive_info(self, system_id:str, station_ids:list):
+    """Return a full set of sensitive info on the system."""
+    if await self.connect():
+      operation_id = await self.start_retrieve_sensitive_info(
+        system_id=system_id,station_ids=station_ids
+      )
+
+      status = await self.check_operation(operation_id)
+      status = status["operationState"]
+
+      while status != "DONE":
+        status = await self.check_operation(operation_id)
+        status = status["operationState"]
+        await asyncio.sleep(5)
+
+      results = await self.sensitive_info_results(operation_id=operation_id)
+      return results.get("stationSensitiveInfos",[])
+
+  async def get_realtime_metrics(self, system_id:str):
+    """Return real-time metrics from the system."""
+    if await self.connect():
+      url =  f"https://googlehomefoyer-pa.googleapis.com/v2/groups/{system_id}/realtimeMetrics"
+      params = (
+        ('prettyPrint', 'false'),
+      )
+      headers = {
+        "Content-Type": "application/json; charset=utf-8",
+        "Authorization": f"Bearer {self._api_token}"
+      }
+      payload = {}
+
+      return await self.get_api(url=url, headers=headers, payload=payload, params=params)
+    
+
+class GoogleWifiException(Exception):
+  """Platform not ready exception."""
+  pass
+
+class GoogleWifiAuthError(Exception):
+  """Stored Google credentials were rejected; re-authentication required."""
+  pass
+
+class GoogleHomeUpdateFailed(Exception):
+  """Google Home Update failed, token refresh required."""
+
+class GoogleHomeIgnoreDevice(Exception):
+  """Google Home can't get data, ignore it."""

googlewifi-0.1.0.dist-info/METADATA

@@ -0,0 +1,133 @@
+Metadata-Version: 2.4
+Name: googlewifi
+Version: 0.1.0
+Summary: Google WiFi API wrapper for integration to Google Wifi systems.
+Home-page: https://github.com/djtimca/googlewifi-api
+Download-URL: https://github.com/djtimca/googlewifi-api/archive/v_0.1.0.tar.gz
+Author: Tim Empringham
+Author-email: tim.empringham@live.ca
+License: apache-2.0
+Keywords: Google,Wifi
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Topic :: Software Development :: Build Tools
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.4
+Classifier: Programming Language :: Python :: 3.5
+Classifier: Programming Language :: Python :: 3.6
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENCE
+License-File: LICENSE.txt
+Requires-Dist: ghome-foyer-api<2.0.0,>=1.0.0
+Requires-Dist: gpsoauth==2.0.0
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: download-url
+Dynamic: home-page
+Dynamic: keywords
+Dynamic: license
+Dynamic: license-file
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
+
+# googlewifi-api
+PyPi Integration for Google WiFi Services for Home Assistant integration. Also provides bluetooth scanning from Google/Nest Home, Mini etc smart speakers to return information about bluetooth devices in the area.
+
+## Required - Google account credentials
+
+This API authenticates through Google Play Services OAuth (`gpsoauth`). You need your Google account email, a master token (`aas_et/...` or `oauth2rt_1/...`), and an `android_id`.
+
+To obtain a master token:
+
+1. Open `https://accounts.google.com/EmbeddedSetup` in a browser.
+2. Sign in with the Google account that owns/manages the Wifi network.
+3. Open browser developer tools and copy the **entire** value of the `oauth_token` cookie (it starts with `oauth2_4/`).
+4. Exchange it for a master token:
+
+```python
+import secrets, asyncio
+from googlewifi import GoogleWifi
+
+android_id = secrets.token_hex(8)
+master_token = asyncio.run(
+    GoogleWifi.exchange_oauth_token("you@gmail.com", "oauth2_4/...", android_id)
+)
+```
+
+The short-lived `oauth_token` is only used once. The resulting master token is reusable and sensitive — treat it like a password.
+
+If you already have a master token, skip the exchange and pass it directly.
+
+## Usage
+
+```python
+api = GoogleWifi(
+    email="you@gmail.com",
+    master_token="aas_et/...",
+    android_id="0123456789abcdef",
+)
+await api.connect()
+systems = await api.get_systems()
+```
+
+Session can be sent as an optional aiohttp session if you are managing your session within an application.
+
+`GoogleWifiAuthError` is raised when the stored master token is rejected by Google and a new `oauth_token` exchange is required.
+
+## Available Methods
+
+### get_systems()
+
+Returns a structured data set that includes the entire system data including system status, access point information and status, and devices from the network.
+
+### pause_device(system_id:str, device_id:str, pause_state:bool)
+
+Pause or unpause a specific device on the network. Must specify the system_id, device_id and pause_state (True to pause, False to unpause). Returns True/False on success of the call.
+
+### prioritize_device(system_id:str, device_id:str, duration_hours:int (default 1))
+
+Prioritize a device for a period of hours (to be specified by duration_hours) from 1 hour to 6 hours maximum. Must specify the system_id and device_id. If duration_hours is not passed it will default to 1 hour prioritization. Returns True/False on success of the call.
+
+### clear_prioritization(system_id:str)
+
+Clear any existing device prioritization from the system. Must specify the system_id to clear. Returns True/False on success of the call.
+
+### set_brightness(ap_id:str, brightness:int)
+
+Set the light brightness on the Access Point. Must specify the access point id (ap_id) and the desired brightness. Brightness range is 0-100. Returns True/False on the success of the call.
+
+### restart_ap(ap_id:str)
+
+Restart a specific Access Point. Must specify the access point (ap_id). Returns True/False on the success of the call.
+
+### restart_system(system_id:str)
+
+Restart the entire system. Must specify the system to restart (system_id). Returns True/False on the success of the call.
+
+### refresh_tokens()
+
+Will return a dict of local access tokens for Google Home/Mini etc devices in format {cloud_device_id:local_access_token}. These tokens are required to access a Google Home device for bluetooth updates and scanning.
+
+### update_info(host:str)
+
+Will return the detailed capabilities and information for a Google Home/Mini etc device. You have to provide the host IP (ie. 192.168.0.20) and it will return a detailed JSON payload which includes the capabilities of the device as well as the cloud device ID which can be used to extract the correct local access token from the refresh_tokens() dict.
+
+### get_bluetooth_status(host:str, token:str)
+
+Will return the current bluetooth status for the Google Home/Mini etc device.
+
+### get_bluetooth_devices(host:str, token:str)
+
+Will return a list of all bluetooth devices which are within range of that Google Home/Mini etc including the MAC address, device type, name, and RSSI (signal strength).
+
+### run_speed_test(system_id:str)
+
+Will run a WAN speed test on the system and return the results (upload/download speed).
+
+Note: This library was built specifically for integration to Home Assistant.

googlewifi-0.1.0.dist-info/RECORD

@@ -0,0 +1,7 @@
+googlewifi/__init__.py,sha256=wGuzq45lLD9fbEDRljUEj3p30eCAXawYDL9PY6mkby0,24387
+googlewifi-0.1.0.dist-info/licenses/LICENCE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+googlewifi-0.1.0.dist-info/licenses/LICENSE.txt,sha256=pzLIIAQjBdx3-aXX85_dyrsgU38S5z6gkA73FRLWw3Y,583
+googlewifi-0.1.0.dist-info/METADATA,sha256=6RVVwMShU3w0V9GhcWJl4idethR0WXNJ8xpKr8cwIBA,5557
+googlewifi-0.1.0.dist-info/WHEEL,sha256=YVMoNqKzERt-wjUZwJ33xBGAwnFl-4cqbYkTtWa4itE,91
+googlewifi-0.1.0.dist-info/top_level.txt,sha256=SazTAc4CAT5AdCQs-VQdU0U1M0FRHeb1kzE50x7C8jQ,11
+googlewifi-0.1.0.dist-info/RECORD,,

googlewifi-0.1.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (84.0.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

googlewifi-0.1.0.dist-info/licenses/LICENCE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

googlewifi-0.1.0.dist-info/licenses/LICENSE.txt

@@ -0,0 +1,14 @@
+Copyright 2020 Tim Empringham
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+     http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+   

googlewifi-0.1.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+googlewifi