Robomow-BLE 1.0.0__tar.gz

robomow_ble-1.0.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026  Arjan Mels
+
+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.

robomow_ble-1.0.0/PKG-INFO

@@ -0,0 +1,193 @@
+Metadata-Version: 2.4
+Name: Robomow-BLE
+Version: 1.0.0
+Summary: Robomow BLE protocol library
+Author: Robomow-HA contributors
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/arjanmels/robomow_ble
+Project-URL: Changelog, https://github.com/arjanmels/robomow_ble/blob/main/CHANGELOG.md
+Project-URL: Documentation, https://arjanmels.github.io/robomow_ble/
+Project-URL: Issues, https://github.com/arjanmels/robomow_ble/issues
+Keywords: ble,bluetooth,robomow,lawn-mower,protocol
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Natural Language :: English
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Software Development :: Libraries
+Classifier: Topic :: System :: Hardware :: Hardware Drivers
+Classifier: Typing :: Typed
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: attrs>=23.2.0
+Requires-Dist: bleak>=0.22.0
+Requires-Dist: bleak-retry-connector>=3.10.0
+Provides-Extra: test
+Requires-Dist: pytest>=8.0; extra == "test"
+Provides-Extra: docs
+Requires-Dist: pdoc>=15.0; extra == "docs"
+Dynamic: license-file
+
+# Robomow-BLE
+
+Robomow-BLE is a standalone Python library for talking to Robomow mowers over
+Bluetooth Low Energy (BLE).
+
+It provides a reusable BLE protocol layer for Robomow mowers and can be used
+directly in Python applications.
+
+Currently it only supports RT models. 
+Support for other models may be added in the future if there is demand and access to devices for testing.
+
+## API Overview
+
+Please refer to the [API documentation](https://arjanmels.github.io/robomow_ble/) for details.
+
+## How to use
+
+### Install
+
+Install from PyPI:
+
+```bash
+python -m pip install Robomow-BLE
+```
+
+### Create a device client
+
+Create a `RobomowDevice` with:
+
+- `mainboard_serial`: mower mainboard serial used during authentication.
+- `update_callback` (optional): called for each update as `RobomowUpdate(key, value)`.
+
+
+```python
+from robomow_ble import RobomowDevice
+
+mower = RobomowDevice(
+    mainboard_serial="12345678901234",
+)
+```
+
+### How to find `mainboard_serial`:
+
+1. Log in to myrobomow.robomow.com.
+2. Open your browser's Developer Tools (F12).
+3. Go to the Network tab.
+4. Reload the page.
+5. Look for a request ending in `/api/customer/products`.
+6. Click the request and open the Response tab.
+7. In the JSON response, find the field named `MainboardSerial`. This value is the actual mainboard serial number.
+
+
+### Connect and authenticate
+
+Discover a BLE device with Bleak, then connect:
+
+```python
+from bleak import BleakScanner
+
+ble_device = await BleakScanner.find_device_by_address(address, timeout=15.0)
+if ble_device is None:
+    raise RuntimeError("Mower not found")
+
+await mower.async_connect(ble_device)
+```
+
+### Receive updates
+
+Pass a callback to receive state changes:
+
+```python
+from robomow_ble import RobomowUpdate, EntityKey
+
+
+def on_update(update: RobomowUpdate) -> None:
+    if update.key == EntityKey.BATTERY_LEVEL:
+        print(f"Battery: {update.value}%")
+    else:
+        print(f"{update.key}: {update.value}")
+```
+
+### Send commands
+
+Common control methods:
+
+- `await mower.async_start_mowing(duration_minutes=30)`
+- `await mower.async_start_mowing_edge()`
+- `await mower.async_stop_mowing()`
+- `await mower.async_return_to_home()`
+
+Common settings methods:
+
+- `await mower.async_enable_schedule()` / `await mower.async_disable_schedule()`
+- `await mower.async_set_schedule(schedule)`
+- `await mower.async_enable_anti_theft()` / `await mower.async_disable_anti_theft()`
+- `await mower.async_enable_child_lock()` / `await mower.async_disable_child_lock()`
+- `await mower.async_set_wire_signal_type(wire_signal_type)`
+
+### Read state
+
+Example state properties:
+
+- Identity/version: `family`, `model`, `mainboard_version`, `software_version`
+- Live values: `operating_state`, `message`, `battery_level`, `rssi`
+- Status: `schedule_enabled`, `next_departure`, `expected_duration`
+
+### Disconnect cleanly
+
+Always disconnect in a `finally` block:
+
+```python
+try:
+    ...
+finally:
+    await mower.async_disconnect()
+```
+
+## Minimal example
+
+```python
+import asyncio
+
+from bleak import BleakScanner
+from robomow_ble import RobomowDevice, RobomowUpdate, EntityKey
+
+
+def on_update(update: RobomowUpdate) -> None:
+    if update.key == EntityKey.BATTERY_LEVEL:
+        print(f"Battery: {update.value}%")
+    else:
+        print(f"{update.key}: {update.value}")
+
+
+async def main() -> None:
+    # Replace these with your mower details
+    address = "AA:BB:CC:DD:EE:FF"
+    mainboard_serial = "12345678901234"
+
+    ble_device = await BleakScanner.find_device_by_address(address, timeout=15.0)
+    if ble_device is None:
+        raise RuntimeError("Mower not found")
+
+    mower = RobomowDevice(
+        mainboard_serial=mainboard_serial,
+        update_callback=on_update,
+    )
+
+    await mower.async_connect(ble_device)
+    try:
+        await mower.async_start_mowing(duration_minutes=30)
+        await asyncio.sleep(5)
+        print("State:", mower.operating_state)
+    finally:
+        await mower.async_disconnect()
+
+
+if __name__ == "__main__":
+    asyncio.run(main())
+```
+
+

robomow_ble-1.0.0/README.md

@@ -0,0 +1,161 @@
+# Robomow-BLE
+
+Robomow-BLE is a standalone Python library for talking to Robomow mowers over
+Bluetooth Low Energy (BLE).
+
+It provides a reusable BLE protocol layer for Robomow mowers and can be used
+directly in Python applications.
+
+Currently it only supports RT models. 
+Support for other models may be added in the future if there is demand and access to devices for testing.
+
+## API Overview
+
+Please refer to the [API documentation](https://arjanmels.github.io/robomow_ble/) for details.
+
+## How to use
+
+### Install
+
+Install from PyPI:
+
+```bash
+python -m pip install Robomow-BLE
+```
+
+### Create a device client
+
+Create a `RobomowDevice` with:
+
+- `mainboard_serial`: mower mainboard serial used during authentication.
+- `update_callback` (optional): called for each update as `RobomowUpdate(key, value)`.
+
+
+```python
+from robomow_ble import RobomowDevice
+
+mower = RobomowDevice(
+    mainboard_serial="12345678901234",
+)
+```
+
+### How to find `mainboard_serial`:
+
+1. Log in to myrobomow.robomow.com.
+2. Open your browser's Developer Tools (F12).
+3. Go to the Network tab.
+4. Reload the page.
+5. Look for a request ending in `/api/customer/products`.
+6. Click the request and open the Response tab.
+7. In the JSON response, find the field named `MainboardSerial`. This value is the actual mainboard serial number.
+
+
+### Connect and authenticate
+
+Discover a BLE device with Bleak, then connect:
+
+```python
+from bleak import BleakScanner
+
+ble_device = await BleakScanner.find_device_by_address(address, timeout=15.0)
+if ble_device is None:
+    raise RuntimeError("Mower not found")
+
+await mower.async_connect(ble_device)
+```
+
+### Receive updates
+
+Pass a callback to receive state changes:
+
+```python
+from robomow_ble import RobomowUpdate, EntityKey
+
+
+def on_update(update: RobomowUpdate) -> None:
+    if update.key == EntityKey.BATTERY_LEVEL:
+        print(f"Battery: {update.value}%")
+    else:
+        print(f"{update.key}: {update.value}")
+```
+
+### Send commands
+
+Common control methods:
+
+- `await mower.async_start_mowing(duration_minutes=30)`
+- `await mower.async_start_mowing_edge()`
+- `await mower.async_stop_mowing()`
+- `await mower.async_return_to_home()`
+
+Common settings methods:
+
+- `await mower.async_enable_schedule()` / `await mower.async_disable_schedule()`
+- `await mower.async_set_schedule(schedule)`
+- `await mower.async_enable_anti_theft()` / `await mower.async_disable_anti_theft()`
+- `await mower.async_enable_child_lock()` / `await mower.async_disable_child_lock()`
+- `await mower.async_set_wire_signal_type(wire_signal_type)`
+
+### Read state
+
+Example state properties:
+
+- Identity/version: `family`, `model`, `mainboard_version`, `software_version`
+- Live values: `operating_state`, `message`, `battery_level`, `rssi`
+- Status: `schedule_enabled`, `next_departure`, `expected_duration`
+
+### Disconnect cleanly
+
+Always disconnect in a `finally` block:
+
+```python
+try:
+    ...
+finally:
+    await mower.async_disconnect()
+```
+
+## Minimal example
+
+```python
+import asyncio
+
+from bleak import BleakScanner
+from robomow_ble import RobomowDevice, RobomowUpdate, EntityKey
+
+
+def on_update(update: RobomowUpdate) -> None:
+    if update.key == EntityKey.BATTERY_LEVEL:
+        print(f"Battery: {update.value}%")
+    else:
+        print(f"{update.key}: {update.value}")
+
+
+async def main() -> None:
+    # Replace these with your mower details
+    address = "AA:BB:CC:DD:EE:FF"
+    mainboard_serial = "12345678901234"
+
+    ble_device = await BleakScanner.find_device_by_address(address, timeout=15.0)
+    if ble_device is None:
+        raise RuntimeError("Mower not found")
+
+    mower = RobomowDevice(
+        mainboard_serial=mainboard_serial,
+        update_callback=on_update,
+    )
+
+    await mower.async_connect(ble_device)
+    try:
+        await mower.async_start_mowing(duration_minutes=30)
+        await asyncio.sleep(5)
+        print("State:", mower.operating_state)
+    finally:
+        await mower.async_disconnect()
+
+
+if __name__ == "__main__":
+    asyncio.run(main())
+```
+
+

robomow_ble-1.0.0/pyproject.toml

@@ -0,0 +1,55 @@
+[build-system]
+requires = ["setuptools>=69", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "Robomow-BLE"
+version = "1.0.0"
+description = "Robomow BLE protocol library"
+readme = "README.md"
+requires-python = ">=3.12"
+license = "MIT"
+license-files = ["LICENSE"]
+authors = [
+  { name = "Robomow-HA contributors" }
+]
+keywords = ["ble", "bluetooth", "robomow", "lawn-mower", "protocol"]
+classifiers = [
+  "Development Status :: 3 - Alpha",
+  "Intended Audience :: Developers",
+  "Natural Language :: English",
+  "Operating System :: OS Independent",
+  "Programming Language :: Python :: 3",
+  "Programming Language :: Python :: 3.12",
+  "Topic :: Software Development :: Libraries",
+  "Topic :: System :: Hardware :: Hardware Drivers",
+  "Typing :: Typed",
+]
+dependencies = [
+  "attrs>=23.2.0",
+  "bleak>=0.22.0",
+  "bleak-retry-connector>=3.10.0"
+]
+
+[project.optional-dependencies]
+test = [
+  "pytest>=8.0"
+]
+docs = [
+  "pdoc>=15.0"
+]
+
+[project.urls]
+Homepage = "https://github.com/arjanmels/robomow_ble"
+Changelog = "https://github.com/arjanmels/robomow_ble/blob/main/CHANGELOG.md"
+Documentation = "https://arjanmels.github.io/robomow_ble/"
+Issues = "https://github.com/arjanmels/robomow_ble/issues"
+
+[tool.setuptools]
+package-dir = { "" = "src" }
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[tool.setuptools.package-data]
+robomow_ble = ["py.typed"]

robomow_ble-1.0.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

robomow_ble-1.0.0/src/Robomow_BLE.egg-info/PKG-INFO

@@ -0,0 +1,193 @@
+Metadata-Version: 2.4
+Name: Robomow-BLE
+Version: 1.0.0
+Summary: Robomow BLE protocol library
+Author: Robomow-HA contributors
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/arjanmels/robomow_ble
+Project-URL: Changelog, https://github.com/arjanmels/robomow_ble/blob/main/CHANGELOG.md
+Project-URL: Documentation, https://arjanmels.github.io/robomow_ble/
+Project-URL: Issues, https://github.com/arjanmels/robomow_ble/issues
+Keywords: ble,bluetooth,robomow,lawn-mower,protocol
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Natural Language :: English
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Software Development :: Libraries
+Classifier: Topic :: System :: Hardware :: Hardware Drivers
+Classifier: Typing :: Typed
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: attrs>=23.2.0
+Requires-Dist: bleak>=0.22.0
+Requires-Dist: bleak-retry-connector>=3.10.0
+Provides-Extra: test
+Requires-Dist: pytest>=8.0; extra == "test"
+Provides-Extra: docs
+Requires-Dist: pdoc>=15.0; extra == "docs"
+Dynamic: license-file
+
+# Robomow-BLE
+
+Robomow-BLE is a standalone Python library for talking to Robomow mowers over
+Bluetooth Low Energy (BLE).
+
+It provides a reusable BLE protocol layer for Robomow mowers and can be used
+directly in Python applications.
+
+Currently it only supports RT models. 
+Support for other models may be added in the future if there is demand and access to devices for testing.
+
+## API Overview
+
+Please refer to the [API documentation](https://arjanmels.github.io/robomow_ble/) for details.
+
+## How to use
+
+### Install
+
+Install from PyPI:
+
+```bash
+python -m pip install Robomow-BLE
+```
+
+### Create a device client
+
+Create a `RobomowDevice` with:
+
+- `mainboard_serial`: mower mainboard serial used during authentication.
+- `update_callback` (optional): called for each update as `RobomowUpdate(key, value)`.
+
+
+```python
+from robomow_ble import RobomowDevice
+
+mower = RobomowDevice(
+    mainboard_serial="12345678901234",
+)
+```
+
+### How to find `mainboard_serial`:
+
+1. Log in to myrobomow.robomow.com.
+2. Open your browser's Developer Tools (F12).
+3. Go to the Network tab.
+4. Reload the page.
+5. Look for a request ending in `/api/customer/products`.
+6. Click the request and open the Response tab.
+7. In the JSON response, find the field named `MainboardSerial`. This value is the actual mainboard serial number.
+
+
+### Connect and authenticate
+
+Discover a BLE device with Bleak, then connect:
+
+```python
+from bleak import BleakScanner
+
+ble_device = await BleakScanner.find_device_by_address(address, timeout=15.0)
+if ble_device is None:
+    raise RuntimeError("Mower not found")
+
+await mower.async_connect(ble_device)
+```
+
+### Receive updates
+
+Pass a callback to receive state changes:
+
+```python
+from robomow_ble import RobomowUpdate, EntityKey
+
+
+def on_update(update: RobomowUpdate) -> None:
+    if update.key == EntityKey.BATTERY_LEVEL:
+        print(f"Battery: {update.value}%")
+    else:
+        print(f"{update.key}: {update.value}")
+```
+
+### Send commands
+
+Common control methods:
+
+- `await mower.async_start_mowing(duration_minutes=30)`
+- `await mower.async_start_mowing_edge()`
+- `await mower.async_stop_mowing()`
+- `await mower.async_return_to_home()`
+
+Common settings methods:
+
+- `await mower.async_enable_schedule()` / `await mower.async_disable_schedule()`
+- `await mower.async_set_schedule(schedule)`
+- `await mower.async_enable_anti_theft()` / `await mower.async_disable_anti_theft()`
+- `await mower.async_enable_child_lock()` / `await mower.async_disable_child_lock()`
+- `await mower.async_set_wire_signal_type(wire_signal_type)`
+
+### Read state
+
+Example state properties:
+
+- Identity/version: `family`, `model`, `mainboard_version`, `software_version`
+- Live values: `operating_state`, `message`, `battery_level`, `rssi`
+- Status: `schedule_enabled`, `next_departure`, `expected_duration`
+
+### Disconnect cleanly
+
+Always disconnect in a `finally` block:
+
+```python
+try:
+    ...
+finally:
+    await mower.async_disconnect()
+```
+
+## Minimal example
+
+```python
+import asyncio
+
+from bleak import BleakScanner
+from robomow_ble import RobomowDevice, RobomowUpdate, EntityKey
+
+
+def on_update(update: RobomowUpdate) -> None:
+    if update.key == EntityKey.BATTERY_LEVEL:
+        print(f"Battery: {update.value}%")
+    else:
+        print(f"{update.key}: {update.value}")
+
+
+async def main() -> None:
+    # Replace these with your mower details
+    address = "AA:BB:CC:DD:EE:FF"
+    mainboard_serial = "12345678901234"
+
+    ble_device = await BleakScanner.find_device_by_address(address, timeout=15.0)
+    if ble_device is None:
+        raise RuntimeError("Mower not found")
+
+    mower = RobomowDevice(
+        mainboard_serial=mainboard_serial,
+        update_callback=on_update,
+    )
+
+    await mower.async_connect(ble_device)
+    try:
+        await mower.async_start_mowing(duration_minutes=30)
+        await asyncio.sleep(5)
+        print("State:", mower.operating_state)
+    finally:
+        await mower.async_disconnect()
+
+
+if __name__ == "__main__":
+    asyncio.run(main())
+```
+
+

robomow_ble-1.0.0/src/Robomow_BLE.egg-info/SOURCES.txt

@@ -0,0 +1,18 @@
+LICENSE
+README.md
+pyproject.toml
+src/Robomow_BLE.egg-info/PKG-INFO
+src/Robomow_BLE.egg-info/SOURCES.txt
+src/Robomow_BLE.egg-info/dependency_links.txt
+src/Robomow_BLE.egg-info/requires.txt
+src/Robomow_BLE.egg-info/top_level.txt
+src/robomow_ble/__init__.py
+src/robomow_ble/const.py
+src/robomow_ble/const_rt.py
+src/robomow_ble/exceptions.py
+src/robomow_ble/family_handler_base.py
+src/robomow_ble/family_handler_rt.py
+src/robomow_ble/helpers.py
+src/robomow_ble/mower.py
+src/robomow_ble/py.typed
+tests/test_smoke.py

robomow_ble-1.0.0/src/Robomow_BLE.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

robomow_ble-1.0.0/src/Robomow_BLE.egg-info/requires.txt

@@ -0,0 +1,9 @@
+attrs>=23.2.0
+bleak>=0.22.0
+bleak-retry-connector>=3.10.0
+
+[docs]
+pdoc>=15.0
+
+[test]
+pytest>=8.0

robomow_ble-1.0.0/src/Robomow_BLE.egg-info/top_level.txt

@@ -0,0 +1 @@
+robomow_ble

robomow_ble-1.0.0/src/robomow_ble/__init__.py

@@ -0,0 +1,43 @@
+"""Robomow-BLE provides a reusable Bluetooth Low Energy protocol layer for
+communicating with Robomow mowers.
+
+The package exposes a small top-level API intended for direct use:
+
+- ``RobomowDevice``: main client used to connect, read state, and send commands.
+- ``RobomowUpdate``: callback payload for state changes.
+- ``RobomowAuthenticationError`` and ``RobomowProtocolError``: protocol errors.
+- Enums: ``MowerFamily``, ``MowerModel``, ``MowerOperatingState``,
+  ``EntityKey``, ``WireSignalType``, ``Zone``.
+- Datatypes: ``MowerSchedule``, ``MowerSchedule.Day``, ``MowerOperation``,
+  ``Message``.
+"""
+
+from .const import (
+    EntityKey,
+    Message,
+    MowerFamily,
+    MowerModel,
+    MowerOperation,
+    MowerOperatingState,
+    MowerSchedule,
+    WireSignalType,
+    Zone,
+)
+from .exceptions import RobomowAuthenticationError, RobomowProtocolError
+from .mower import RobomowDevice, RobomowUpdate
+
+__all__ = [
+    "RobomowDevice",
+    "RobomowUpdate",
+    "RobomowProtocolError",
+    "RobomowAuthenticationError",
+    "Message",
+    "MowerOperation",
+    "MowerFamily",
+    "MowerModel",
+    "MowerSchedule",
+    "MowerOperatingState",
+    "EntityKey",
+    "WireSignalType",
+    "Zone",
+]