Merge pull request #23 from andyb2000/dev7

Dev7

Author: andyb2000

.github/workflows/autorelease.yaml

@@ -0,0 +1,19 @@
+on:
+  push:
+    paths:
+      - 'custom_components/husqvarna_automower_ble/manifest.json'
+    branches:
+      - main
+
+jobs:
+  set-secret-and-run-python:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+
+      - name: Automated Releases
+        uses: AnshKetchum/auto-changelog-release@alpha-1
+        with:
+          GIT_PERSONAL_ACCESS_TOKEN: ${{ secrets.REPOSITORY_TOKEN }}

.github/workflows/hassfest.yaml

@@ -0,0 +1,14 @@
+name: Validate with hassfest
+
+on:
+  push:
+  pull_request:
+  schedule:
+    - cron: "0 0 * * *"
+
+jobs:
+  validate:
+    runs-on: "ubuntu-latest"
+    steps:
+      - uses: "actions/checkout@v3"
+      - uses: home-assistant/actions/hassfest@master

README.md

@@ -30,6 +30,25 @@ It should add and you can close the Repository input box.
 You should now see the integration in HACS where you can download the latest version, or search for "Husqvarna Automower BLE".
 Restart home assistant to load the new integration
 
+# PIN codes with Flymo or similar
+
+These devices (Easilife Go and other brands that use Husqvarna internal boards) don't have an option to disable PIN.
+They accept the pin by pressing the sequence of buttons on the mower and on the app when setting up the pairing.
+The PIN sequence is translated to digits like this:
+
+On/OFF Power button = 1
+
+Go/Schedule button = 2
+
+Go button = 3
+
+Park button = 4
+
+See below image from operators manual. Which indicates the default pin would be 1234
+
+![image](https://github.com/user-attachments/assets/10c75863-a634-4686-bc4c-15bb128dcad9)
+
+
 # Usage
 
 BEFORE you add the new integration, you need to have your bluetooth proxy setup.
@@ -79,17 +98,22 @@ button:
 ```
 
 Once you have done this, deploy it to an ESP32 that is within range of your automower.
-You need the MAC address of your automower. Get this from your existing app.
 
-Now add your custom integration in Home Assistant.
+Bluetooth discovery may now discover your mower, if so you can go to SETTINGS > INTEGRATIONS
+and CONFIGURE. It will ask for the MAC and PIN.
+If autodiscovered the MAC will be filled in for you, otherwise you need to enter it manually.
+If the MAC is not discovered, you need to find this from your existing app.
+
+If you need to manually add it, do it by going into:
 SETTINGS > INTEGRATIONS
 Add Integration
 Search for "Husqvarna Automower BLE"
 
 BEFORE you enter the MAC address, power off your mower. Then power it back on and enter the physical
 PIN (if required). The mower goes into bluetooth pairing mode for up to 2 minutes which you need
 for this initial connection.
-Now enter the MAC address for your mower. Wait for it to add/search.
+During the configuration stage for the integration it will show a blank box with SUBMIT, click this when your mower
+is powered on and in bluetooth pairing mode.
 
 You may need to repeat this several times as the bluetooth pairing does not always work correctly.
 

custom_components/husqvarna_automower_ble/__init__.py

@@ -10,11 +10,12 @@
 
 from homeassistant.components import bluetooth
 from homeassistant.config_entries import ConfigEntry
-from homeassistant.const import CONF_ADDRESS, CONF_CLIENT_ID, Platform
+#from homeassistant.const import CONF_ADDRESS, CONF_CLIENT_ID, Platform
+from homeassistant.const import Platform
 from homeassistant.core import HomeAssistant
 from homeassistant.exceptions import ConfigEntryNotReady
 
-from .const import DOMAIN
+from .const import DOMAIN, CONF_ADDRESS, CONF_PIN, CONF_CLIENT_ID, STARTUP_MESSAGE
 from .coordinator import HusqvarnaCoordinator
 
 LOGGER = logging.getLogger(__name__)
@@ -27,13 +28,19 @@
 async def async_setup_entry(hass: HomeAssistant, entry: ConfigEntry) -> bool:
     """Set up Husqvarna Autoconnect Bluetooth from a config entry."""
     address = entry.data[CONF_ADDRESS]
+    pin = entry.data[CONF_PIN]
     channel_id = entry.data[CONF_CLIENT_ID]
 
-    mower = Mower(channel_id, address)
+    LOGGER.info(STARTUP_MESSAGE)
+
+    if pin != 0:
+        mower = Mower(channel_id, address, pin)
+    else:
+        mower = Mower(channel_id, address)
 
     await close_stale_connections_by_address(address)
 
-    LOGGER.debug("connecting to %s with channel ID %s", address, str(channel_id))
+    LOGGER.debug("connecting to %s with channel ID %s and pin %s", address, str(channel_id), str(pin))
     device = bluetooth.async_ble_device_from_address(
         hass, address, connectable=True
     ) or await get_device(address)

custom_components/husqvarna_automower_ble/config_flow.py

@@ -12,10 +12,11 @@
 from homeassistant.components import bluetooth
 from homeassistant.components.bluetooth import BluetoothServiceInfo
 from homeassistant.config_entries import ConfigFlow, ConfigFlowResult
-from homeassistant.const import CONF_ADDRESS, CONF_CLIENT_ID
+#from homeassistant.const import CONF_ADDRESS, CONF_CLIENT_ID
 from homeassistant.data_entry_flow import AbortFlow
+from bleak import BleakError
 
-from .const import DOMAIN
+from .const import DOMAIN,CONF_ADDRESS,CONF_PIN,CONF_CLIENT_ID
 
 _LOGGER = logging.getLogger(__name__)
 
@@ -40,6 +41,7 @@ class HusqvarnaAutomowerBleConfigFlow(ConfigFlow, domain=DOMAIN):
     def __init__(self) -> None:
         """Initialize the config flow."""
         self.address: str | None
+        _LOGGER.debug("init - config_flow")
 
     async def async_step_bluetooth(
         self, discovery_info: BluetoothServiceInfo
@@ -53,7 +55,7 @@ async def async_step_bluetooth(
         self.address = discovery_info.address
         await self.async_set_unique_id(self.address)
         self._abort_if_unique_id_configured()
-        return await self.async_step_confirm()
+        return await self.async_step_user()
 
     async def async_step_confirm(
         self, user_input: dict[str, Any] | None = None
@@ -70,7 +72,7 @@ async def async_step_confirm(
             (manufacture, device_type, model) = await Mower(
                 channel_id, self.address
             ).probe_gatts(device)
-        except TimeoutError as exception:
+        except (BleakError, TimeoutError) as exception:
             raise AbortFlow(
                 "cannot_connect", description_placeholders={"error": str(exception)}
             ) from exception
@@ -82,7 +84,7 @@ async def async_step_confirm(
         if user_input is not None:
             return self.async_create_entry(
                 title=title,
-                data={CONF_ADDRESS: self.address, CONF_CLIENT_ID: channel_id},
+                data={CONF_ADDRESS: self.address, CONF_CLIENT_ID: channel_id, CONF_PIN: self.pin},
             )
 
         self._set_confirm_only()
@@ -95,18 +97,26 @@ async def async_step_user(
         self, user_input: dict[str, Any] | None = None
     ) -> ConfigFlowResult:
         """Handle the initial step."""
+        _LOGGER.debug("async_step_user")
+        if not hasattr(self, 'address'):
+            self.address=""
+
+        errors = {}
         if user_input is not None:
             self.address = user_input[CONF_ADDRESS]
+            self.pin = user_input[CONF_PIN]
             await self.async_set_unique_id(self.address, raise_on_progress=False)
             self._abort_if_unique_id_configured()
             return await self.async_step_confirm()
 
         return self.async_show_form(
             step_id="user",
-            description_placeholders={"description": "Enter your device MAC address"},
             data_schema=vol.Schema(
                 {
-                    vol.Required(CONF_ADDRESS): str,
+                    vol.Required(CONF_ADDRESS, default=self.address): str,
+                    vol.Optional(CONF_PIN, default=0): int,
                 },
             ),
+            errors=errors
         )
+

custom_components/husqvarna_automower_ble/const.py

@@ -1,6 +1,16 @@
 """Constants for the Husqvarna Automower Bluetooth integration."""
 
+NAME = "Automower BLE component for HASS"
 DOMAIN = "husqvarna_automower_ble"
 MANUFACTURER = "Husqvarna"
 SERIAL = "serialNumber"
 MODEL = "model"
+CONF_ADDRESS = "address"
+CONF_PIN = "pin"
+CONF_CLIENT_ID = "client_id"
+STARTUP_MESSAGE = f"""
+-------------------------------------------------------------------
+{NAME}
+Custom component by @andyb2000
+-------------------------------------------------------------------
+"""

custom_components/husqvarna_automower_ble/coordinator.py

@@ -63,17 +63,21 @@ async def _async_find_device(self):
         _LOGGER.debug("Trying to reconnect")
         await close_stale_connections_by_address(self.address)
 
+        _LOGGER.debug("bluetooth connect...")
         device = bluetooth.async_ble_device_from_address(
             self.hass, self.address, connectable=True
         )
+        _LOGGER.debug("back from async_ble_device_from_address")
         if not device:
-            _LOGGER.error("Can't find device")
+            _LOGGER.debug("Can't find device")
             raise UpdateFailed("Can't find device")
 
         try:
             if not await self.mower.connect(device):
+                _LOGGER.debug("failed to connect in self.mower.connect")
                 raise UpdateFailed("Failed to connect")
         except (TimeoutError, BleakError) as ex:
+            _LOGGER.debug("except hit from ble connect")
             raise UpdateFailed("Failed to connect") from ex
 
     async def _async_update_data(self) -> dict[str, bytes]:

custom_components/husqvarna_automower_ble/manifest.json

@@ -3,16 +3,16 @@
   "name": "Husqvarna Automower BLE",
   "bluetooth": [
     {
-      "service_uuid": "98bd0001-0b0e-421a-84e5-ddbf75dc6de4",
-      "connectable": true
+      "connectable": true,
+      "service_uuid": "98bd0001-0b0e-421a-84e5-ddbf75dc6de4"
     }
   ],
   "codeowners": ["@alistair23", "@andyb2000"],
   "config_flow": true,
   "dependencies": ["bluetooth_adapters"],
   "documentation": "https://github.com/andyb2000/HACS-husqvarna_automower_ble/",
-  "issue_tracker": "https://github.com/andyb2000/HACS-husqvarna_automower_ble/issues",
   "iot_class": "local_polling",
-  "requirements": ["git+https://github.com/alistair23/AutoMower-BLE.git@main#automower_ble==0.2.0"],
-  "version": "0.0.9"
+  "issue_tracker": "https://github.com/andyb2000/HACS-husqvarna_automower_ble/issues",
+  "requirements": ["automower_ble @ git+https://github.com/alistair23/AutoMower-BLE.git@main"],
+  "version": "0.1.1"
 }

custom_components/husqvarna_automower_ble/strings.json

@@ -0,0 +1,34 @@
+{
+  "config": {
+    "step": {
+      "user": {
+        "title": "Automower BLE configuration",
+        "description": "Configure your mower before powering it on.",
+        "data": {
+          "address": "The Bluetooth MAC address of your mower",
+          "pin": "(optional) PIN code"
+        }
+      }
+    },
+    "error": {
+      "invalid_mac": "Invalid MAC address entered",
+      "already_configured": "Device is already configured",
+      "exception": "Error with BLE component",
+      "cannot_connect": "Cannot connect via BLE to your MAC address, check and try again"
+    },
+    "abort": {
+      "already_configured": "Device is already configured"
+    }
+  },
+  "options": {
+    "step": {
+      "init": {
+        "title": "Automower BLE configuration - step2",
+        "description": "Power mower on, enter PIN then continue",
+        "data": {
+          "port": "TCP port"
+        }
+      }
+    }
+  }
+}

custom_components/husqvarna_automower_ble/translations/en.json

@@ -0,0 +1,34 @@
+{
+  "config": {
+    "step": {
+      "user": {
+        "title": "Automower BLE configuration",
+        "description": "Configure your mower before powering it on.",
+        "data": {
+          "address": "The Bluetooth MAC address of your mower",
+          "pin": "(optional) PIN code"
+        }
+      }
+    },
+    "error": {
+      "invalid_mac": "Invalid MAC address entered",
+      "already_configured": "Device is already configured",
+      "exception": "Error with BLE component",
+      "cannot_connect": "Cannot connect via BLE to your MAC address, check and try again"
+    },
+    "abort": {
+      "already_configured": "Device is already configured"
+    }
+  },
+  "options": {
+    "step": {
+      "init": {
+        "title": "Automower BLE configuration - step2",
+        "description": "Power mower on, enter PIN then continue",
+        "data": {
+          "port": "TCP port"
+        }
+      }
+    }
+  }
+}