ipee-lemon 0.1.0__py3-none-any.whl

ipee/lemon/ble/device.py

@@ -0,0 +1,62 @@
+from typing import Dict
+
+from bleak import BleakClient
+
+from .service import BLECharacteristic, BLEService, CharMode
+
+
+class BleDevice:
+    """Base class for all BLE devices.
+
+    For specific devices ble services and characteristics
+    can be registered in their respective class through
+
+    ```python
+    ble_service = SpecificBleService()
+    self.register_service(ble_service)
+    ```
+
+    """
+
+    def __init__(self, address: str):
+        self.address = address
+        self.client = BleakClient(self.address)
+        self.services: Dict[str, BLEService] = {}
+
+    def register_service(self, service: BLEService):
+        self.services[service.uuid] = service
+
+    async def connect(self):
+        await self.client.connect()
+        # IMPORTANT: force service discovery
+        for service in self.client.services:
+            print(f"Service: {service.uuid}")
+            for char in service.characteristics:
+                print(f"  Characteristic: {char.uuid}")
+        print("Connected: ", self.address)
+
+        for service in self.services.values():
+            for char in service.characteristics.values():
+                if char.modes & {CharMode.NOTIFY, CharMode.INDICATE} and char.on_data:
+                    await self.client.start_notify(char.uuid, self._make_data_handler(char))
+
+    async def disconnect(self):
+        await self.client.disconnect()
+
+    @staticmethod
+    def _make_data_handler(char: BLECharacteristic):
+        def handler(_, data: bytearray):
+            if char.on_data:
+                char.on_data(bytes(data))
+
+        return handler
+
+        # ---------------------------
+        # Read / Write API
+        # ---------------------------
+
+    async def read(self, char_uuid: str) -> bytes:
+        return await self.client.read_gatt_char(char_uuid)
+
+    async def write(self, char_uuid: str, data: bytes, response: bool = False):
+        await self.client.write_gatt_char(char_uuid, data, response)

ipee/lemon/ble/lemon_ble.py

@@ -0,0 +1,20 @@
+from .device import BleDevice
+from .nus_service import NUSService
+from .ota_service import OtaService
+from .wifi_provision_service import WifiProvisioningService
+
+
+class LemonBleDevice(BleDevice):
+    def __init__(self, address: str):
+        super().__init__(address)
+
+        nus = NUSService(on_rx=self.on_nus_data)
+        self.register_service(nus)
+        ota = OtaService()
+        self.register_service(ota)
+        wifi = WifiProvisioningService()
+        self.register_service(wifi)
+
+    @staticmethod
+    def on_nus_data(data: bytearray):
+        print("NUS RX:", data.decode(errors="ignore"))

ipee/lemon/ble/nus_service.py

@@ -0,0 +1,30 @@
+from .device import BLECharacteristic, BLEService, CharMode
+
+
+class NUSService(BLEService):
+    """The NUS service is a BLEService that can be used for testing if the connection works
+
+    it has an rx and tx characteristic that prints data on the command line.
+    From the lemon perspective, you can send data to ble nodes by writing `ble send <some-text>`
+    """
+
+    RX_UUID = "6E400002-B5A3-F393-E0A9-E50E24DCCA9E"
+    TX_UUID = "6E400003-B5A3-F393-E0A9-E50E24DCCA9E"
+
+    def __init__(self, on_rx=None):
+        super().__init__(uuid="6E400001-B5A3-F393-E0A9-E50E24DCCA9E", name="Nordic UART Service")
+
+        self.add_characteristic(
+            BLECharacteristic(
+                uuid=self.TX_UUID,
+                modes={CharMode.NOTIFY},
+                description="Device → Host",
+                on_data=on_rx,
+            )
+        )
+
+        self.add_characteristic(
+            BLECharacteristic(
+                uuid=self.RX_UUID, modes={CharMode.WRITE}, description="Host → Device"
+            )
+        )

ipee/lemon/ble/ota_service.py

@@ -0,0 +1,24 @@
+from .service import BLECharacteristic, BLEService, CharMode
+
+
+class OtaService(BLEService):
+    """The OTA service is used for setting the OTA URL and start updating
+
+    Make sure the device is connected through Wi-Fi before starting the update.
+    """
+
+    OTA_URL_UUID = "6E400008-B5A3-F393-E0A9-E50E24DCCA9E"
+
+    def __init__(self):
+        super().__init__(
+            uuid="6E400009-B5A3-F393-E0A9-E50E24DCCA9E",
+            name="OTA Service",
+        )
+
+        self.add_characteristic(
+            BLECharacteristic(
+                uuid=self.OTA_URL_UUID,
+                modes={CharMode.WRITE},
+                description="Set the OTA URL and start updating",
+            )
+        )

ipee/lemon/ble/service.py

@@ -0,0 +1,28 @@
+from dataclasses import dataclass, field
+from enum import Enum
+from typing import Callable, Dict, Optional, Set
+
+
+class CharMode(Enum):
+    READ = "read"
+    WRITE = "write"
+    NOTIFY = "notify"
+    INDICATE = "indicate"
+
+
+@dataclass
+class BLECharacteristic:
+    uuid: str
+    modes: Set[CharMode]
+    description: str = ""
+    on_data: Optional[Callable[[bytes], None]] = None
+
+
+@dataclass
+class BLEService:
+    uuid: str
+    name: str
+    characteristics: Dict[str, BLECharacteristic] = field(default_factory=dict)
+
+    def add_characteristic(self, characteristic: BLECharacteristic):
+        self.characteristics[characteristic.uuid] = characteristic

ipee/lemon/ble/wifi_provision_service.py

@@ -0,0 +1,25 @@
+from .service import BLECharacteristic, BLEService, CharMode
+
+
+class WifiProvisioningService(BLEService):
+    """The Wi-Fi Provisioning Service is used for setting the SSID and PW of the AP to connect to.
+
+    Once the SSID and Password are written, the device shall attempt connection.
+    """
+
+    SSID_UUID = "6E400005-B5A3-F393-E0A9-E50E24DCCA9E"
+    PASSWORD_UUID = "6E400006-B5A3-F393-E0A9-E50E24DCCA9E"  # NOSONAR - not a password field
+
+    def __init__(self):
+        super().__init__(
+            uuid="6E400004-B5A3-F393-E0A9-E50E24DCCA9E",
+            name="Wifi provisioning service",
+        )
+
+        self.add_characteristic(
+            BLECharacteristic(
+                uuid=self.SSID_UUID,
+                modes={CharMode.NOTIFY, CharMode.READ, CharMode.WRITE},
+                description="The SSID to connect to",
+            )
+        )

ipee/lemon/cli/base_service.py

@@ -0,0 +1,14 @@
+from serial import Serial
+
+
+class CliBaseService:
+    def __init__(self, tag: str, service_name: str):
+        self.tag = tag
+        self.service_name = service_name
+
+    def write(self, serial: Serial, command: str):
+        serial.write((self.tag + " " + command + "\n").encode())
+
+    @staticmethod
+    def read(self, serial: Serial):
+        return serial.readline()

ipee/lemon/cli/cli_ble_service.py

@@ -0,0 +1,18 @@
+from serial import Serial
+
+from .base_service import CliBaseService
+
+
+class CliBleService(CliBaseService):
+    def __init__(self):
+        super().__init__("ble", "ble service")
+
+    def enable(self, serial: Serial):
+        self.write(serial, "enable")
+
+    def disable(self, serial: Serial):
+        self.write(serial, "disable")
+
+    def send(self, serial: Serial, data: str):
+        command = "send " + data
+        self.write(serial, command)

ipee/lemon/cli/cli_wifi_service.py

@@ -0,0 +1,19 @@
+from serial import Serial
+
+from .base_service import CliBaseService
+
+
+class CliWifiService(CliBaseService):
+    def __init__(self):
+        super().__init__("wifi", "wifi-service")
+
+    def set_ssid(self, serial: Serial, ssid: str):
+        command = "set_ssid " + ssid
+        self.write(serial, command)
+
+    def set_password(self, serial: Serial, password: str):
+        command = "set_password " + password
+        self.write(serial, command)
+
+    def connect(self, serial: Serial):
+        self.write(serial, "connect")

ipee_lemon-0.1.0.dist-info/METADATA

@@ -0,0 +1,17 @@
+Metadata-Version: 2.4
+Name: ipee-lemon
+Version: 0.1.0
+Summary: 
+License-File: LICENSE
+Author: Jeroen Van den Broeck
+Author-email: jeroen.vandenbroeck@ipee.eu
+Requires-Python: >=3.12
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Requires-Dist: bleak (>=3.0.0,<4.0.0)
+Requires-Dist: pyserial (>=3.5,<4.0)
+Description-Content-Type: text/markdown
+
+

ipee_lemon-0.1.0.dist-info/RECORD

@@ -0,0 +1,16 @@
+ipee/lemon/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+ipee/lemon/ble/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+ipee/lemon/ble/device.py,sha256=NT0krhsUwZKmG6RgPATuTIjhKMdPQV7NJigAWfg1ThA,1949
+ipee/lemon/ble/lemon_ble.py,sha256=OY0kAgD0J_wk9OaylUNZzenJz7U_6WnPI92P5cILw7I,605
+ipee/lemon/ble/nus_service.py,sha256=m6PRoKHh49iB2CZBFvS2OD3Knrfyt8Rs85ZA_RIzBig,1030
+ipee/lemon/ble/ota_service.py,sha256=MaIbkAbT00Bhe6qTiOGH9CPtSbhYmTknCJCgjWr3LKg,700
+ipee/lemon/ble/service.py,sha256=M7eKVepA_8wpi_tKpmlau5W39FJW_RizwRvVdfrFjzc,655
+ipee/lemon/ble/wifi_provision_service.py,sha256=IsPzA85S5l4icJPpKLbi1HE0duATStUPD3tN7Zz26dc,860
+ipee/lemon/cli/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+ipee/lemon/cli/base_service.py,sha256=PpJr56pc6pX3b62nDQ2iIg2FT1ltdkiLoxf_R7axfPU,372
+ipee/lemon/cli/cli_ble_service.py,sha256=wLbleMRtkdOsxUzS6QzL2jOi0CEDN5SZZqiCrLjYh1A,449
+ipee/lemon/cli/cli_wifi_service.py,sha256=D49zT_Es62Rae5Zj9qk9F7PFV2YCvby5kZ3BKAAVFZs,525
+ipee_lemon-0.1.0.dist-info/METADATA,sha256=Hktsz6aEFs4rWOBOSJuINJiKyT9gAjg03xUWddJHeyI,500
+ipee_lemon-0.1.0.dist-info/WHEEL,sha256=zp0Cn7JsFoX2ATtOhtaFYIiE2rmFAD4OcMhtUki8W3U,88
+ipee_lemon-0.1.0.dist-info/licenses/LICENSE,sha256=qA9L0aqMG2k42p6wETagTQehNeFSQ4llTn0ogPyb60w,1051
+ipee_lemon-0.1.0.dist-info/RECORD,,

ipee_lemon-0.1.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: poetry-core 2.2.1
+Root-Is-Purelib: true
+Tag: py3-none-any

ipee_lemon-0.1.0.dist-info/licenses/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2026 IPEE. All rights reserved.
+
+This software and associated documentation files (the "Software") are the
+proprietary and confidential property of IPEE. Unauthorized copying, transfer,
+or reproduction of the Software, via any medium, is strictly prohibited.
+
+The Software is provided under a commercial license and may only be used in
+accordance with the terms and conditions agreed upon between IPEE and the
+licensee. No part of the Software may be modified, distributed, sublicensed,
+or otherwise made available to third parties without the prior written consent
+of IPEE.
+
+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.