WIP. Working setup with new API access. Needs work, expect bugs!

Author: Jon Kristian

.gitignore

@@ -1,14 +1,20 @@
-# Packages
-*.egg
+# artifacts
+__pycache__
+.pytest*
 *.egg-info
-eggs
-.eggs
+*/build/*
+*/dist/*
+*.log*
+*.db*
 
-# GITHUB Proposed Python stuff:
-*.py[cod]
 
-# emacs auto backups
-*~
-*#
-*.orig
-.idea
+# misc
+.coverage
+.vscode
+coverage.xml
+pyalko
+
+
+# Home Assistant configuration
+config/*
+!config/configuration.yaml

CONTRIBUTING.md

@@ -0,0 +1,61 @@
+# Contribution guidelines
+
+Contributing to this project should be as easy and transparent as possible, whether it's:
+
+- Reporting a bug
+- Discussing the current state of the code
+- Submitting a fix
+- Proposing new features
+
+## Github is used for everything
+
+Github is used to host code, to track issues and feature requests, as well as accept pull requests.
+
+Pull requests are the best way to propose changes to the codebase.
+
+1. Fork the repo and create your branch from `master`.
+2. If you've changed something, update the documentation.
+3. Make sure your code lints (using black).
+4. Test you contribution.
+5. Issue that pull request!
+
+## Any contributions you make will be under the MIT Software License
+
+In short, when you submit code changes, your submissions are understood to be under the same [MIT License](http://choosealicense.com/licenses/mit/) that covers the project. Feel free to contact the maintainers if that's a concern.
+
+## Report bugs using Github's [issues](../../issues)
+
+GitHub issues are used to track public bugs.
+Report a bug by [opening a new issue](../../issues/new/choose); it's that easy!
+
+## Write bug reports with detail, background, and sample code
+
+**Great Bug Reports** tend to have:
+
+- A quick summary and/or background
+- Steps to reproduce
+  - Be specific!
+  - Give sample code if you can.
+- What you expected would happen
+- What actually happens
+- Notes (possibly including why you think this might be happening, or stuff you tried that didn't work)
+
+People *love* thorough bug reports. I'm not even kidding.
+
+## Use a Consistent Coding Style
+
+Use [black](https://github.com/ambv/black) to make sure the code follows the style.
+
+## Test your code modification
+
+This custom component uses [integration_blueprint template](https://github.com/ludeeus/integration_blueprint) devcontainer.
+
+It comes with development environment in a container, easy to launch
+if you use Visual Studio Code. With this container you will have a stand alone
+Home Assistant instance running and already configured with the included
+[`configuration.yaml`](./configuration.yaml)
+file.
+
+## License
+
+By contributing, you agree that your contributions will be licensed under its MIT License.

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Jon Kristian Nilsen
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -1,6 +1,5 @@
 # AL-KO Robolinho component for Home Assistant
 This component allows you to integrate your AL-KO Robolinho mower in Home Assistant.
-For advanced users only, please see further explaination below.
 
 ## Supports
 - Battery level sensor
@@ -17,36 +16,15 @@ For advanced users only, please see further explaination below.
 
 # Installation
 
+## Requesting API access
+Before installing you should know that you will have to to request access to the API. [Fill out this form](https://alko-garden.com/api-access). If all went well you will receive your credentials.
+
 ## Manual or via HACS
 If you're using HACS you can add this repo as a custom repository and install, otherwise download or clone and copy the folder `custom_components/alko` into your `custom_components/`. Be sure to restart.
 
-## Installing a working app
-As stated in [issue #2](https://github.com/jonkristian/alko/issues/2), it is not possible to extract the credentials from recent AL-KO InTouch app (probably since version 4.0.0). In order to extract the credentials from the app, you need to download an older app version.
-
-- Download and install older InTouch app from the any APK mirrors website. If you have the "official" InTouch app from Google Play installed, remember to unsinstall it first. Tested and confirmed on v3.4.2 version downloaded from APKPure. Unfortunately, only .xapk file is available there, so you need to download APKPure app itself and then install InTouch v3.4.2 using the APKPure app.
-- Log in to the app and enter "My devices" tab (to make sure that the app downloaded devices information).
-- Proceed with further instructions below regarding token extraction using adb and intouch-credentials.sh script.
-
-## Finding secret and tokens (Android only | Requires adb)
-The AL-KO API is unfortunately not open for 3rd party applications. In order for this component to work you will have to have set up the AL-KO inTOUCH app and a [working adb connection to your phone](https://developer.android.com/studio/command-line/adb). To extract your secret and tokens I've created a very simple and crude script that will output these in the terminal.
-- Download [intouch-credentials.sh](https://raw.githubusercontent.com/jonkristian/alko/master/tools/intouch-credentials.sh) (located in tools folder).
-- Then `chmod +x intouch-credentials.sh` and `./intouch-credentials.sh` to run.
-- Now unlock your phone and click confirm the backup operation (do not encrypt).
-- This should print your `client_secret`, `access_token` and `refresh_token` the latter two is required during the integration setup step.
-- Add the following to your configuration.yaml.
-
-```yaml
-alko:
-  client_id: inTouchApp
-  client_secret: your_client_secret
-```
-After a restart you should now be able to add the integration via the integrations page, remember that tokens are short-lived 30 minutes.
-***
 ## Contribute
 If you own a smart product from AL-KO and would like to contribute, please don't hesitate getting in touch.
 
-### Regarding the AL-KO Api
-It's really sad that many manufacturers don't allow for 3rd party apps, since these APIs are already there and available through their own app most of the time, I personally don't see what the harm is. I've already sent an e-mail to AL-KO requesting that they open up to allow for more advanced home automation platforms like Home Assistant, but weeks have gone and I don't really expect getting a reply back. Maybe they will listen if more people get involved so if you want to try and do something about this, the e-mail I've found is gardentech@al-ko.com.
 ***
 ⭐️ this repository if you found it useful ❤️
 

configuration.yaml

@@ -0,0 +1,12 @@
+# https://www.home-assistant.io/integrations/default_config/
+default_config:
+
+# https://www.home-assistant.io/integrations/homeassistant/
+homeassistant:
+  debug: true
+
+# https://www.home-assistant.io/integrations/logger/
+logger:
+  default: info
+  logs:
+    custom_components.alko: debug

custom_components/alko/__init__.py

@@ -1,4 +1,5 @@
 """The AL-KO integration."""
+
 from __future__ import annotations
 
 from datetime import timedelta
@@ -11,91 +12,55 @@
 import async_timeout
 import voluptuous as vol
 
-from homeassistant.components.sensor import DOMAIN as SENSOR_DOMAIN
-from homeassistant.components.select import DOMAIN as SELECT_DOMAIN
-from homeassistant.components.switch import DOMAIN as SWITCH_DOMAIN
+from homeassistant.const import Platform
 from homeassistant.config_entries import ConfigEntry
-from homeassistant.const import CONF_CLIENT_ID, CONF_CLIENT_SECRET
 from homeassistant.core import HomeAssistant
 from homeassistant.exceptions import ConfigEntryAuthFailed
-from homeassistant.helpers import (
-    aiohttp_client,
-    config_entry_oauth2_flow,
-    config_validation as cv,
-)
+from homeassistant.helpers import aiohttp_client, config_entry_oauth2_flow
 from homeassistant.helpers.entity import DeviceInfo
 from homeassistant.helpers.update_coordinator import (
     CoordinatorEntity,
     DataUpdateCoordinator,
     UpdateFailed,
 )
 
-from .api import ConfigEntryAlkoClient, AlkoLocalOAuth2Implementation
-from .config_flow import OAuth2FlowHandler
-from .const import DOMAIN, OAUTH2_AUTHORIZE, OAUTH2_TOKEN
-
-CONFIG_SCHEMA = vol.Schema(
-    {
-        DOMAIN: vol.Schema(
-            {
-                vol.Required(CONF_CLIENT_ID): cv.string,
-                vol.Required(CONF_CLIENT_SECRET): cv.string,
-            }
-        )
-    },
-    extra=vol.ALLOW_EXTRA,
+from .api import (
+    ConfigEntryAlkoClient,
+    AlkoLocalOAuth2Implementation,
+    OAuth2SessionAlko
 )
 
-_LOGGER = logging.getLogger(__name__)
-
-PLATFORMS = (SENSOR_DOMAIN, SELECT_DOMAIN, SWITCH_DOMAIN)
-
-
-async def async_setup(hass: HomeAssistant, config: dict):
-    """Set up the AL-KO component."""
-    hass.data[DOMAIN] = {}
-
-    if DOMAIN not in config:
-        return True
+from .const import DOMAIN
 
-    hass.data[DOMAIN][CONF_CLIENT_ID] = config[DOMAIN][CONF_CLIENT_ID]
+_LOGGER = logging.getLogger(__name__)
 
-    OAuth2FlowHandler.async_register_implementation(
-        hass,
-        AlkoLocalOAuth2Implementation(
-            hass,
-            DOMAIN,
-            config[DOMAIN][CONF_CLIENT_ID],
-            config[DOMAIN][CONF_CLIENT_SECRET],
-            OAUTH2_AUTHORIZE,
-            OAUTH2_TOKEN,
-        ),
-    )
-
-    return True
+PLATFORMS = [Platform.SENSOR, Platform.SWITCH, Platform.SELECT]
 
 
 async def async_setup_entry(hass: HomeAssistant, entry: ConfigEntry) -> bool:
-    """Set up AL-KO from a config entry."""
+    """Set up ALKO from a config entry."""
     implementation = (
         await config_entry_oauth2_flow.async_get_config_entry_implementation(
             hass, entry
         )
     )
+    if not isinstance(implementation, AlkoLocalOAuth2Implementation):
+        raise TypeError(
+            "Unexpected auth implementation; can't find oauth client id")
 
     session = aiohttp_client.async_get_clientsession(hass)
-    oauth_session = config_entry_oauth2_flow.OAuth2Session(hass, entry, implementation)
+    oauth_session = OAuth2SessionAlko(hass, entry, implementation)
 
     client = ConfigEntryAlkoClient(session, oauth_session)
-
-    client_id = hass.data[DOMAIN][CONF_CLIENT_ID]
+    client_id = implementation.client_id
     alko = Alko(client, client_id)
 
     async def async_update_data() -> Alko:
         """Fetch data from Alko."""
         try:
             async with async_timeout.timeout(60):
                 await alko.get_devices()
+                _LOGGER.debug("Fetched devices: %s", repr(alko.devices))
             return alko
         except AlkoAuthenticationException as exception:
             raise ConfigEntryAuthFailed from exception
@@ -112,12 +77,11 @@ async def async_update_data() -> Alko:
         update_interval=timedelta(seconds=120),
     )
 
-    hass.data[DOMAIN][entry.entry_id] = coordinator
-
     # Fetch initial data so we have data when entities subscribe
     await coordinator.async_config_entry_first_refresh()
+    hass.data.setdefault(DOMAIN, {})[entry.entry_id] = coordinator
 
-    hass.config_entries.async_setup_platforms(entry, PLATFORMS)
+    await hass.config_entries.async_forward_entry_setups(entry, PLATFORMS)
 
     return True
 
@@ -131,12 +95,12 @@ async def async_unload_entry(hass: HomeAssistant, entry: ConfigEntry) -> bool:
     return unload_ok
 
 
-class AlkoEntity(CoordinatorEntity):
+class AlkoEntity(CoordinatorEntity[DataUpdateCoordinator[Alko]]):
     """Defines a base AL-KO entity."""
 
     def __init__(
         self,
-        coordinator: DataUpdateCoordinator,
+        coordinator: DataUpdateCoordinator[Alko],
         device: AlkoDevice,
         key: str,
         name: str,
@@ -178,6 +142,5 @@ def device_info(self) -> DeviceInfo:
             "manufacturer": "AL-KO",
             "model": self._device_model,
             "name": self._device_name,
-            "device_type": self._device_type,
             "sw_version": self._firmware_main,
         }

custom_components/alko/api.py

@@ -5,11 +5,24 @@
 from aiohttp import BasicAuth, ClientSession
 from pyalko import AlkoClient
 
+from homeassistant.components.application_credentials import AuthImplementation
 from homeassistant.helpers import config_entry_oauth2_flow
 from homeassistant.helpers.aiohttp_client import async_get_clientsession
 
 _LOGGER = logging.getLogger(__name__)
 
+class OAuth2SessionAlko(config_entry_oauth2_flow.OAuth2Session):
+    """OAuth2Session for Alko."""
+
+    async def force_refresh_token(self) -> None:
+        """Force a token refresh."""
+        new_token = await self.implementation.async_refresh_token(self.token)
+
+        self.hass.config_entries.async_update_entry(
+            self.config_entry, data={
+                **self.config_entry.data, "token": new_token}
+        )
+
 
 class ConfigEntryAlkoClient(AlkoClient):
     """Provide AL-KO authentication tied to an OAuth2 based config entry."""
@@ -32,7 +45,7 @@ async def async_get_access_token(self):
 
 
 class AlkoLocalOAuth2Implementation(
-    config_entry_oauth2_flow.LocalOAuth2Implementation
+    AuthImplementation,
 ):
     """AL-KO Local OAuth2 implementation."""
 

custom_components/alko/application_credentials.py

@@ -0,0 +1,27 @@
+"""Application credentials platform for the ALKO integration."""
+
+from homeassistant.components.application_credentials import (
+    AuthorizationServer,
+    ClientCredential,
+)
+from homeassistant.core import HomeAssistant
+from homeassistant.helpers import config_entry_oauth2_flow
+
+from .api import AlkoLocalOAuth2Implementation
+from .const import OAUTH2_AUTHORIZE, OAUTH2_TOKEN
+
+
+async def async_get_auth_implementation(
+    hass: HomeAssistant, auth_domain: str, credential: ClientCredential
+) -> config_entry_oauth2_flow.AbstractOAuth2Implementation:
+    """Return custom auth implementation."""
+    return AlkoLocalOAuth2Implementation(
+        hass,
+        auth_domain,
+        credential,
+        AuthorizationServer(
+            # authorize_url=OAUTH2_AUTHORIZE,
+            authorize_url="",  # Overridden in config flow.
+            token_url=OAUTH2_TOKEN,
+        ),
+    )