espark-core 0.3.1__py3-none-any.whl → 0.4.0__py3-none-any.whl

{espark_core-0.3.1.dist-info → espark_core-0.4.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: espark-core
-Version: 0.3.1
+Version: 0.4.0
 Summary: The core module of the Espark ESP32-based IoT device management framework.
 License: MIT
 Requires-Python: >=3.8
@@ -9,6 +9,7 @@ License-File: LICENSE
 Requires-Dist: aiomqtt
 Requires-Dist: apscheduler
 Requires-Dist: fastapi
+Requires-Dist: packaging
 Requires-Dist: sqlalchemy
 Requires-Dist: sqlmodel
 Requires-Dist: uvicorn[standard]

{espark_core-0.3.1.dist-info → espark_core-0.4.0.dist-info}/RECORD

@@ -1,29 +1,32 @@
-espark_core-0.3.1.dist-info/licenses/LICENSE,sha256=wkIXJHYIspOGVvn_ajKyLucpIyw9_pO3QExFcNTCY78,1065
+espark_core-0.4.0.dist-info/licenses/LICENSE,sha256=wkIXJHYIspOGVvn_ajKyLucpIyw9_pO3QExFcNTCY78,1065
 esparkcore/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-esparkcore/constants.py,sha256=jgbhkana_NU_AdcGI0B0OjEOSBAuYNmTroC-vdlD69I,338
+esparkcore/constants.py,sha256=uI0bVa78CZa-ftlyTRMqWSBK275iDB1l8g1TmtJ1FGg,378
 esparkcore/data/__init__.py,sha256=abMOPq6jC5qOQCl9j7iPDv8iyjzDF-oVd_gW0la5kL4,45
 esparkcore/data/database.py,sha256=OaJSBDW6Qge-rsKkSIksJXOg3xF_y6LuBew--6uFbG4,532
-esparkcore/data/models/__init__.py,sha256=y4tnMxZGRsqYTWw-ctWzPMHj1B9xfPYc3Ettoz2vYAI,92
-esparkcore/data/models/device.py,sha256=xXewJHBx4_R_m-N81m0_mcgNmbxzcK0KyCvIGazU3Ck,823
+esparkcore/data/models/__init__.py,sha256=9YBRwn7R_aovQjT-ZR64fBm7TPs0dsjoq3LzsUTaRtA,124
+esparkcore/data/models/device.py,sha256=HQr941uabovQpyGZ1fOnsBNSU_LVmB7JQIZuDkk1uis,1086
 esparkcore/data/models/outbox.py,sha256=r5bgjIbj9H-OsGhE-CWKGRf4Tp88qMvmxPYHNGOApY4,1309
 esparkcore/data/models/telemetry.py,sha256=OfzGqGj2Y1sdK519sSOEXhfuErHoeEdpy5qmJMIc27A,652
-esparkcore/data/repositories/__init__.py,sha256=uuzaSYEtrifTHYMXr7xGPwXLhvuvccGYfur6w9UG72E,195
+esparkcore/data/models/version.py,sha256=h2O_Owx-exx5tiQiiauCSELkUHDx-QZjiIGqFPybT4M,269
+esparkcore/data/repositories/__init__.py,sha256=R4cFUr137IxhyQVwFaXRHikPkTBE_4nUAAFRchxcohA,248
 esparkcore/data/repositories/base_repository.py,sha256=L5APTp8SczndbWqgJyEqKe-4NQoL_YYOapUN6i572cM,2097
 esparkcore/data/repositories/device_repository.py,sha256=P9KK-Ta9MgMdrnct5hbGEoipPOPrrDQ4wINQnZZ6iZY,1131
 esparkcore/data/repositories/outbox_repository.py,sha256=PdPyKq2Km4_7732O6HhA4BlV_zBjYF91GkMltNKUovg,1015
 esparkcore/data/repositories/telemetry_repository.py,sha256=5UBBmY-ugcgP0Xji7cu58_nGt8MWKeHz9DHNVJxk0BY,1116
-esparkcore/routers/__init__.py,sha256=kVr51MhvJYVKYZXS9maqf4XXj-4qLyM9UFk5x9BEAnQ,86
+esparkcore/data/repositories/version_repository.py,sha256=QZZX2BpFx1i0oeFJ6j0nZvlZH7cViKU8VERBE8AU3ZY,395
+esparkcore/routers/__init__.py,sha256=K8-S0hugkQT5DB8i8O5YqeRsu9fGfLep6UQzCIpdgGg,131
 esparkcore/routers/base_router.py,sha256=t-x8tYZVzBk9bD__9yaGYhm66glq_oM_lAHn0eplM2M,3902
 esparkcore/routers/device_router.py,sha256=mIBAyTyxl9AF8Os_Sms6Bb0vEvWfljyElbTWEGLo0iU,1172
-esparkcore/routers/telemetry_router.py,sha256=3ZpgY1fjGkXLmoaxm2paNJNVc5VMf1iZqsDh0xa0TyI,2014
+esparkcore/routers/telemetry_router.py,sha256=sLO5-oN73IjdGC_ASNif5xmVZHjka_iLv0BKZ_deZP0,1981
+esparkcore/routers/version_router.py,sha256=zoOteeK4Cs-OIk_k2v7vPwpR-OfLBwYhOUhNZjPYfHs,387
 esparkcore/schedules/__init__.py,sha256=v5Wy3Cbt2AnudGMGXv_Cyaa10s6NAmP66rDjcMSvf0o,74
 esparkcore/schedules/outbox.py,sha256=GGANvjkI7w1BdmmVRgKog498ASD_xRN0g8bG6yC_SN4,811
 esparkcore/schedules/scheduler.py,sha256=aYQXImLZ4tW-hRavn3ObuV3lYjmOZD813YkeG1NsYfY,170
 esparkcore/services/__init__.py,sha256=RIZOHBfkWn3HsApdA5rH9EZbbXGq0NfiGoOWDO_JX1k,30
-esparkcore/services/mqtt.py,sha256=292ZJ9YZbAYGghNFtRoXWbMenOiOo57bIo-D9Pwyr8o,4831
+esparkcore/services/mqtt.py,sha256=9MOlFIKtR42CuOfX-kEd-DT2od7mXtbD-0B8dNHqplg,6279
 esparkcore/utils/__init__.py,sha256=rzuCJUAaQl-yPhM1vcWB_1zVXqtA71ChYP2aM_3UfKk,42
 esparkcore/utils/logging.py,sha256=sRO8uOcPkFH-DwepqLOTS2qGaopXpMdVOjzZL6RpGs4,257
-espark_core-0.3.1.dist-info/METADATA,sha256=E151oXCvJ7hIdbkU9vQWjZsu7CLvPlzeHafnbCXDzLU,6136
-espark_core-0.3.1.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-espark_core-0.3.1.dist-info/top_level.txt,sha256=hXVyhIPB4aGskFm5queWALxDPhcDkrN7_8vcjwA1iE4,11
-espark_core-0.3.1.dist-info/RECORD,,
+espark_core-0.4.0.dist-info/METADATA,sha256=Z2PvZcnFDZncpr1gk2A-Yabnx-4kI5zCuS3UgjhubGg,6161
+espark_core-0.4.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+espark_core-0.4.0.dist-info/top_level.txt,sha256=hXVyhIPB4aGskFm5queWALxDPhcDkrN7_8vcjwA1iE4,11
+espark_core-0.4.0.dist-info/RECORD,,

esparkcore/constants.py

@@ -2,8 +2,9 @@ ENV_DATABASE_URL : str = 'DATABASE_URL'
 ENV_MQTT_HOST    : str = 'MQTT_HOST'
 ENV_MQTT_PORT    : str = 'MQTT_PORT'
 
+TOPIC_ACTION       : str = 'espark/action'
 TOPIC_DEVICE       : str = 'espark/device'
 TOPIC_REGISTRATION : str = 'espark/registration'
 TOPIC_TELEMETRY    : str = 'espark/telemetry'
-TOPIC_ACTION       : str = 'espark/action'
+TOPIC_OTP          : str = 'espark/otp'
 TOPIC_CRASH        : str = 'espark/crash'

esparkcore/data/models/__init__.py

@@ -1,3 +1,4 @@
 from .device import Device
 from .outbox import OutboxEvent
 from .telemetry import Telemetry
+from .version import AppVersion

esparkcore/data/models/device.py

@@ -8,6 +8,8 @@ from sqlmodel import SQLModel, Field, JSON
 class Device(SQLModel, table=True):
     id           : str                         = Field(primary_key=True, description='Unique identifier for the device')
     display_name : Optional[str]               = Field(default=None, description='Human-readable name of the device')
+    app_name     : Optional[str]               = Field(default=None, description='Name of the application running on the device')
+    app_version  : Optional[str]               = Field(default=None, description='Version of the application running on the device')
     capabilities : Optional[str]               = Field(default=None, description='Comma separated capabilities of the device')
     parameters   : Dict[str, str | int | bool] = Field(default_factory=dict, sa_column=Column(JSON), description='JSON string of capability-specific parameters')
     last_seen    : datetime                    = Field(index=True, description='Last time the device was seen online')

esparkcore/data/models/version.py

@@ -0,0 +1,6 @@
+from sqlmodel import SQLModel, Field
+
+
+class AppVersion(SQLModel, table=True):
+    id      : str = Field(primary_key=True, description='The app name, which is a unique identifier for the app version')
+    version : str = Field(description='Version of the application')

esparkcore/data/repositories/__init__.py

@@ -2,3 +2,4 @@ from .base_repository import AsyncRepository
 from .device_repository import DeviceRepository
 from .outbox_repository import OutboxRepository
 from .telemetry_repository import TelemetryRepository
+from .version_repository import AppVersionRepository

esparkcore/data/repositories/version_repository.py

@@ -0,0 +1,11 @@
+from ..models import AppVersion
+from .base_repository import AsyncRepository
+
+
+class AppVersionRepository(AsyncRepository[AppVersion]):
+    def __init__(self):
+        super().__init__(AppVersion)
+
+    async def get_by_app_name(self, session, app_name: str) -> AppVersion | None:
+        # pylint: disable=unexpected-keyword-arg
+        return await self.get(session, AppVersion.id == app_name)

esparkcore/routers/__init__.py

@@ -1,2 +1,3 @@
 from .device_router import DeviceRouter
 from .telemetry_router import TelemetryRouter
+from .version_router import AppVersionRouter

esparkcore/routers/telemetry_router.py

@@ -1,5 +1,5 @@
 from datetime import datetime, timedelta, timezone
-from typing import cast, Sequence
+from typing import Sequence
 
 from fastapi import Depends, Query, Response
 from sqlalchemy.ext.asyncio import AsyncSession
@@ -28,7 +28,7 @@ class TelemetryRouter(BaseRouter):
                 capabilities = device.capabilities.split(',') if device.capabilities else []
                 for data_type in capabilities:
                     if not data_type.startswith('action_'):
-                        telemetry = await cast(TelemetryRepository, self.repo).get_latest_for_device(session, device.id, data_type)
+                        telemetry = await self.repo.get_latest_for_device(session, device.id, data_type)
                         if telemetry:
                             if telemetry.timestamp.tzinfo is None:
                                 telemetry.timestamp = telemetry.timestamp.replace(tzinfo=timezone.utc)

esparkcore/routers/version_router.py

@@ -0,0 +1,10 @@
+from ..data.models import AppVersion
+from ..data.repositories import AppVersionRepository
+from .base_router import BaseRouter
+
+
+class AppVersionRouter(BaseRouter):
+    def __init__(self, repo: AppVersionRepository = None) -> None:
+        self.repo : AppVersionRepository = repo or AppVersionRepository()
+
+        super().__init__(AppVersion, self.repo, '/api/v1/versions', ['version'])

esparkcore/services/mqtt.py

@@ -1,27 +1,29 @@
 from asyncio import create_task, gather, Queue, sleep
 from datetime import datetime, timezone
-from json import JSONDecodeError, loads
+from json import dumps, JSONDecodeError, loads
 from os import getenv
 from uuid import getnode
 
 from aiomqtt import Client, MqttError
+from packaging.version import Version
 
-from ..constants import ENV_MQTT_HOST, ENV_MQTT_PORT, TOPIC_CRASH, TOPIC_REGISTRATION, TOPIC_TELEMETRY
+from ..constants import ENV_MQTT_HOST, ENV_MQTT_PORT, TOPIC_CRASH, TOPIC_OTP, TOPIC_REGISTRATION, TOPIC_TELEMETRY
 from ..data import async_session
-from ..data.models import Device, Telemetry
-from ..data.repositories import DeviceRepository, TelemetryRepository
+from ..data.models import AppVersion, Device, Telemetry
+from ..data.repositories import AppVersionRepository, DeviceRepository, TelemetryRepository
 from ..utils import log_debug, log_error
 
 MQTT_RETRY_DELAY: int = 5
 
 
 class MQTTManager:
-    def __init__(self, device_repo: DeviceRepository = None, telemetry_repo: TelemetryRepository = None):
-        self.mqtt_host      : str                 = getenv(ENV_MQTT_HOST, 'localhost')
-        self.mqtt_port      : int                 = int(getenv(ENV_MQTT_PORT, '1883'))
-        self.device_repo    : DeviceRepository    = device_repo
-        self.telemetry_repo : TelemetryRepository = telemetry_repo
-        self.queue          : Queue               = Queue()
+    def __init__(self, version_repo: AppVersionRepository = None, device_repo: DeviceRepository = None, telemetry_repo: TelemetryRepository = None):
+        self.mqtt_host      : str                  = getenv(ENV_MQTT_HOST, 'localhost')
+        self.mqtt_port      : int                  = int(getenv(ENV_MQTT_PORT, '1883'))
+        self.version_repo   : AppVersionRepository = version_repo if version_repo else AppVersionRepository()
+        self.device_repo    : DeviceRepository     = device_repo if device_repo else DeviceRepository()
+        self.telemetry_repo : TelemetryRepository  = telemetry_repo if telemetry_repo else TelemetryRepository()
+        self.queue          : Queue                = Queue()
 
     async def _handle_registration(self, device_id: str, payload: dict) -> None:
         try:
@@ -30,6 +32,8 @@ class MQTTManager:
             async with async_session() as session:
                 device = await self.device_repo.get(session, Device.id == device_id)
                 if device:
+                    device.app_name     = payload['app_name']
+                    device.app_version  = payload['app_version']
                     device.capabilities = payload['capabilities']
                     device.last_seen    = datetime.now(timezone.utc)
 
@@ -39,10 +43,26 @@ class MQTTManager:
 
                     device.id           = device_id
                     device.display_name = None
+                    device.app_name     = payload['app_name']
+                    device.app_version  = payload['app_version']
                     device.capabilities = payload['capabilities']
                     device.last_seen    = datetime.now(timezone.utc)
 
                     await self.device_repo.add(session, device)
+
+                latest_version  = await self.version_repo.get(session, AppVersion.id == payload['app_name'])
+                current_version = Version(payload['app_version'])
+
+                if Version(latest_version.version) > current_version:
+                    log_debug(f'Device {device_id} is running an outdated version ({current_version} < {latest_version.version})')
+
+                    async with Client(self.mqtt_host, self.mqtt_port, identifier=f'espark-core-{hex(getnode())}') as client:
+                        await client.publish(f'{TOPIC_OTP}/{device_id}', dumps({
+                            'device_id'    : device_id,
+                            'app_name'     : payload['app_name'],
+                            'app_version'  : latest_version.version,
+                            'download_url' : None,
+                        }), qos=1)
         # pylint: disable=broad-exception-caught
         except Exception as e:
             log_error(e)