espark-core 0.5.5__tar.gz

espark_core-0.5.5/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Alan Tai
+
+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.

espark_core-0.5.5/MANIFEST.in

@@ -0,0 +1,4 @@
+include requirements.txt
+include requirements.dev.txt
+include ../README.md
+include LICENSE

espark_core-0.5.5/PKG-INFO

@@ -0,0 +1,139 @@
+Metadata-Version: 2.4
+Name: espark-core
+Version: 0.5.5
+Summary: The core module of the Espark ESP32-based IoT device management framework.
+License: MIT
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: aiomqtt>=2.5.0
+Requires-Dist: apscheduler>=3.11.2
+Requires-Dist: fastapi>=0.128.0
+Requires-Dist: packaging>=25.0
+Requires-Dist: slack-sdk==3.39.0
+Requires-Dist: sqlalchemy>=2.0.45
+Requires-Dist: sqlmodel>=0.0.31
+Requires-Dist: uvicorn[standard]>=0.40.0
+Provides-Extra: dev
+Requires-Dist: aiosqlite==0.22.1; extra == "dev"
+Requires-Dist: autopep8==2.3.2; extra == "dev"
+Requires-Dist: build==1.3.0; extra == "dev"
+Requires-Dist: fastapi-cli[standard-no-fastapi-cloud-cli]==0.0.20; extra == "dev"
+Requires-Dist: httpx==0.28.1; extra == "dev"
+Requires-Dist: pycodestyle==2.14.0; extra == "dev"
+Requires-Dist: pylint==4.0.4; extra == "dev"
+Requires-Dist: pytest==9.0.2; extra == "dev"
+Requires-Dist: pytest-asyncio==1.3.0; extra == "dev"
+Requires-Dist: pytest-cov==7.0.0; extra == "dev"
+Requires-Dist: twine==6.2.0; extra == "dev"
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: license
+Dynamic: license-file
+Dynamic: provides-extra
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
+
+# Espark
+
+Espark is a lightweight framework for building scalable and efficient ESP32-based IoT applications. It provides a modular architecture, easy-to-use APIs, and built-in support for common IoT protocols.
+
+## Project Goals
+
+- Simplify the development of ESP32 applications.
+- Provide a modular and extensible architecture.
+- Support common IoT protocols like MQTT.
+- Ensure efficient resource management for low-power devices.
+- Provide a clean and easy-to-use API.
+- Provide an user-friendly UI for configuration and monitoring.
+
+## Features
+
+- **Device Provisioning**: Easy setup and configuration of ESP32 devices.
+- **Telemetry Collection**: Built-in support for collecting and sending telemetry data.
+- **Scalable Architecture**: Designed to handle a large number of devices efficiently.
+- **Seamless Communication**: Support for MQTT protocol.
+
+## Hardware Requirements
+
+- ESP32 Development Board
+- USB Cable for programming and power
+- Optional: Sensors and triggers for specific applications
+
+## Project Structure
+
+```
+espark/
+├── espark-core/
+│   ├── esparkcore/      # FastAPI backend framework
+│   │   ├── data/              # Models, repositories
+│   │   ├── routers/           # API endpoints
+│   │   ├── schedules/         # Background tasks
+│   │   ├── services/          # Business logic, MQTT handling
+│   │   └── utils/             # Utility functions
+│   └── Makefile
+├── espark-node/
+│   ├── esparknode/      # MicroPython application framework
+│   │   ├── actions/           # Action handlers
+│   │   ├── data/              # Data storage
+│   │   ├── libraries/         # External libraries
+│   │   ├── networks/          # Network management
+│   │   ├── sensors/           # Sensor interfaces
+│   │   ├── triggers/          # Trigger interfaces
+│   │   ├── utils/             # Utility functions
+│   │   └── base_node.py       # Main application file
+│   └── Makefile
+└── espark-react/        # React frontend application
+    ├── src/
+    │   ├── data/              # Data models and data providers
+    │   ├── i18n/              # Internationalization files
+    │   ├── pages/             # Application pages
+    │   ├── routes/            # Application routing
+    │   ├── utils/             # Utility functions
+    │   ├── App.tsx            # Main application component
+    │   └── index.tsx          # Application entry point
+    └── package.json
+```
+
+## Development Workflows
+
+### Setting up the backend
+
+1. Add espark-core as a dependency in your FastAPI project.
+2. Configure database connections and MQTT settings as environment variables.
+3. Implement additional data models, repositories, routers, and business logic if needed.
+4. Add the `DeviceRouter`, `TelemetryRouter`, and other additional routers to your FastAPI app.
+
+### Setting up the ESP32 application
+
+1. Clone the espark-node repository to your local machine.
+2. Copy `espark-core/Makefile.template` to `Makefile` and customize it for your device.
+3. Run `make upgrade` to copy the espark-core library to your device project.
+4. Implement device-specific actions, sensors, and triggers as needed.
+5. Run `make flash` to upload the firmware to your ESP32 device.
+6. Run `make deploy` to upload the application to the device.
+
+### Setting up the frontend
+
+1. Add espark-react as a dependency in your React project.
+2. Render `<EsparkApp />` in your main application file.
+
+### Configurations
+
+- **espark-core**: Use environment variables, or `.env` file, for database and MQTT configurations.
+- **espark-node**: Use `esparknode.configs` for device-specific configurations.
+- **espark-react**: Customise `EsparkApp` props for application settings.
+
+## Examples and Patterns
+
+- **Router Example**: `device_router.py` in `espark-core/esparkcore/routers/` demonstrates how to create API endpoints for device management.
+- **Respository Example**: `device_repository.py` in `espark-core/esparkcore/data/repositories/` shows how to implement data access logic for devices.
+- **Action Example**: `esp32_relay.py` in `espark-node/esparknode/actions/` illustrates how to define actions for ESP32 devices.
+- **Sensor Example**: `sht20_sensor.py` in `espark-node/esparknode/sensors/` demonstrates how to read data from a SHT20 sensor.
+- **Trigger Example**: `gpio_trigger.py` in `espark-node/esparknode/triggers/` shows how to create GPIO-based triggers for device actions.
+- **List, Show, Edit Screens Example**: `DeviceList`, `DeviceShow`, and `DeviceEdit` components in `espark-react/src/pages/devices/` demonstrate how to create CRUD screens for device management.
+
+## Example Projects
+
+- **Espartan**: A smart thermostat and open-door alert automation system using ESP32-C3 devices, leveraging espark for device management and telemetry, available at [https://github.com/ayltai/Espartan](https://github.com/ayltai/Espartan).

espark_core-0.5.5/README.md

@@ -0,0 +1,102 @@
+# Espark
+
+Espark is a lightweight framework for building scalable and efficient ESP32-based IoT applications. It provides a modular architecture, easy-to-use APIs, and built-in support for common IoT protocols.
+
+## Project Goals
+
+- Simplify the development of ESP32 applications.
+- Provide a modular and extensible architecture.
+- Support common IoT protocols like MQTT.
+- Ensure efficient resource management for low-power devices.
+- Provide a clean and easy-to-use API.
+- Provide an user-friendly UI for configuration and monitoring.
+
+## Features
+
+- **Device Provisioning**: Easy setup and configuration of ESP32 devices.
+- **Telemetry Collection**: Built-in support for collecting and sending telemetry data.
+- **Scalable Architecture**: Designed to handle a large number of devices efficiently.
+- **Seamless Communication**: Support for MQTT protocol.
+
+## Hardware Requirements
+
+- ESP32 Development Board
+- USB Cable for programming and power
+- Optional: Sensors and triggers for specific applications
+
+## Project Structure
+
+```
+espark/
+├── espark-core/
+│   ├── esparkcore/      # FastAPI backend framework
+│   │   ├── data/              # Models, repositories
+│   │   ├── routers/           # API endpoints
+│   │   ├── schedules/         # Background tasks
+│   │   ├── services/          # Business logic, MQTT handling
+│   │   └── utils/             # Utility functions
+│   └── Makefile
+├── espark-node/
+│   ├── esparknode/      # MicroPython application framework
+│   │   ├── actions/           # Action handlers
+│   │   ├── data/              # Data storage
+│   │   ├── libraries/         # External libraries
+│   │   ├── networks/          # Network management
+│   │   ├── sensors/           # Sensor interfaces
+│   │   ├── triggers/          # Trigger interfaces
+│   │   ├── utils/             # Utility functions
+│   │   └── base_node.py       # Main application file
+│   └── Makefile
+└── espark-react/        # React frontend application
+    ├── src/
+    │   ├── data/              # Data models and data providers
+    │   ├── i18n/              # Internationalization files
+    │   ├── pages/             # Application pages
+    │   ├── routes/            # Application routing
+    │   ├── utils/             # Utility functions
+    │   ├── App.tsx            # Main application component
+    │   └── index.tsx          # Application entry point
+    └── package.json
+```
+
+## Development Workflows
+
+### Setting up the backend
+
+1. Add espark-core as a dependency in your FastAPI project.
+2. Configure database connections and MQTT settings as environment variables.
+3. Implement additional data models, repositories, routers, and business logic if needed.
+4. Add the `DeviceRouter`, `TelemetryRouter`, and other additional routers to your FastAPI app.
+
+### Setting up the ESP32 application
+
+1. Clone the espark-node repository to your local machine.
+2. Copy `espark-core/Makefile.template` to `Makefile` and customize it for your device.
+3. Run `make upgrade` to copy the espark-core library to your device project.
+4. Implement device-specific actions, sensors, and triggers as needed.
+5. Run `make flash` to upload the firmware to your ESP32 device.
+6. Run `make deploy` to upload the application to the device.
+
+### Setting up the frontend
+
+1. Add espark-react as a dependency in your React project.
+2. Render `<EsparkApp />` in your main application file.
+
+### Configurations
+
+- **espark-core**: Use environment variables, or `.env` file, for database and MQTT configurations.
+- **espark-node**: Use `esparknode.configs` for device-specific configurations.
+- **espark-react**: Customise `EsparkApp` props for application settings.
+
+## Examples and Patterns
+
+- **Router Example**: `device_router.py` in `espark-core/esparkcore/routers/` demonstrates how to create API endpoints for device management.
+- **Respository Example**: `device_repository.py` in `espark-core/esparkcore/data/repositories/` shows how to implement data access logic for devices.
+- **Action Example**: `esp32_relay.py` in `espark-node/esparknode/actions/` illustrates how to define actions for ESP32 devices.
+- **Sensor Example**: `sht20_sensor.py` in `espark-node/esparknode/sensors/` demonstrates how to read data from a SHT20 sensor.
+- **Trigger Example**: `gpio_trigger.py` in `espark-node/esparknode/triggers/` shows how to create GPIO-based triggers for device actions.
+- **List, Show, Edit Screens Example**: `DeviceList`, `DeviceShow`, and `DeviceEdit` components in `espark-react/src/pages/devices/` demonstrate how to create CRUD screens for device management.
+
+## Example Projects
+
+- **Espartan**: A smart thermostat and open-door alert automation system using ESP32-C3 devices, leveraging espark for device management and telemetry, available at [https://github.com/ayltai/Espartan](https://github.com/ayltai/Espartan).

espark_core-0.5.5/espark_core.egg-info/PKG-INFO

@@ -0,0 +1,139 @@
+Metadata-Version: 2.4
+Name: espark-core
+Version: 0.5.5
+Summary: The core module of the Espark ESP32-based IoT device management framework.
+License: MIT
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: aiomqtt>=2.5.0
+Requires-Dist: apscheduler>=3.11.2
+Requires-Dist: fastapi>=0.128.0
+Requires-Dist: packaging>=25.0
+Requires-Dist: slack-sdk==3.39.0
+Requires-Dist: sqlalchemy>=2.0.45
+Requires-Dist: sqlmodel>=0.0.31
+Requires-Dist: uvicorn[standard]>=0.40.0
+Provides-Extra: dev
+Requires-Dist: aiosqlite==0.22.1; extra == "dev"
+Requires-Dist: autopep8==2.3.2; extra == "dev"
+Requires-Dist: build==1.3.0; extra == "dev"
+Requires-Dist: fastapi-cli[standard-no-fastapi-cloud-cli]==0.0.20; extra == "dev"
+Requires-Dist: httpx==0.28.1; extra == "dev"
+Requires-Dist: pycodestyle==2.14.0; extra == "dev"
+Requires-Dist: pylint==4.0.4; extra == "dev"
+Requires-Dist: pytest==9.0.2; extra == "dev"
+Requires-Dist: pytest-asyncio==1.3.0; extra == "dev"
+Requires-Dist: pytest-cov==7.0.0; extra == "dev"
+Requires-Dist: twine==6.2.0; extra == "dev"
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: license
+Dynamic: license-file
+Dynamic: provides-extra
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
+
+# Espark
+
+Espark is a lightweight framework for building scalable and efficient ESP32-based IoT applications. It provides a modular architecture, easy-to-use APIs, and built-in support for common IoT protocols.
+
+## Project Goals
+
+- Simplify the development of ESP32 applications.
+- Provide a modular and extensible architecture.
+- Support common IoT protocols like MQTT.
+- Ensure efficient resource management for low-power devices.
+- Provide a clean and easy-to-use API.
+- Provide an user-friendly UI for configuration and monitoring.
+
+## Features
+
+- **Device Provisioning**: Easy setup and configuration of ESP32 devices.
+- **Telemetry Collection**: Built-in support for collecting and sending telemetry data.
+- **Scalable Architecture**: Designed to handle a large number of devices efficiently.
+- **Seamless Communication**: Support for MQTT protocol.
+
+## Hardware Requirements
+
+- ESP32 Development Board
+- USB Cable for programming and power
+- Optional: Sensors and triggers for specific applications
+
+## Project Structure
+
+```
+espark/
+├── espark-core/
+│   ├── esparkcore/      # FastAPI backend framework
+│   │   ├── data/              # Models, repositories
+│   │   ├── routers/           # API endpoints
+│   │   ├── schedules/         # Background tasks
+│   │   ├── services/          # Business logic, MQTT handling
+│   │   └── utils/             # Utility functions
+│   └── Makefile
+├── espark-node/
+│   ├── esparknode/      # MicroPython application framework
+│   │   ├── actions/           # Action handlers
+│   │   ├── data/              # Data storage
+│   │   ├── libraries/         # External libraries
+│   │   ├── networks/          # Network management
+│   │   ├── sensors/           # Sensor interfaces
+│   │   ├── triggers/          # Trigger interfaces
+│   │   ├── utils/             # Utility functions
+│   │   └── base_node.py       # Main application file
+│   └── Makefile
+└── espark-react/        # React frontend application
+    ├── src/
+    │   ├── data/              # Data models and data providers
+    │   ├── i18n/              # Internationalization files
+    │   ├── pages/             # Application pages
+    │   ├── routes/            # Application routing
+    │   ├── utils/             # Utility functions
+    │   ├── App.tsx            # Main application component
+    │   └── index.tsx          # Application entry point
+    └── package.json
+```
+
+## Development Workflows
+
+### Setting up the backend
+
+1. Add espark-core as a dependency in your FastAPI project.
+2. Configure database connections and MQTT settings as environment variables.
+3. Implement additional data models, repositories, routers, and business logic if needed.
+4. Add the `DeviceRouter`, `TelemetryRouter`, and other additional routers to your FastAPI app.
+
+### Setting up the ESP32 application
+
+1. Clone the espark-node repository to your local machine.
+2. Copy `espark-core/Makefile.template` to `Makefile` and customize it for your device.
+3. Run `make upgrade` to copy the espark-core library to your device project.
+4. Implement device-specific actions, sensors, and triggers as needed.
+5. Run `make flash` to upload the firmware to your ESP32 device.
+6. Run `make deploy` to upload the application to the device.
+
+### Setting up the frontend
+
+1. Add espark-react as a dependency in your React project.
+2. Render `<EsparkApp />` in your main application file.
+
+### Configurations
+
+- **espark-core**: Use environment variables, or `.env` file, for database and MQTT configurations.
+- **espark-node**: Use `esparknode.configs` for device-specific configurations.
+- **espark-react**: Customise `EsparkApp` props for application settings.
+
+## Examples and Patterns
+
+- **Router Example**: `device_router.py` in `espark-core/esparkcore/routers/` demonstrates how to create API endpoints for device management.
+- **Respository Example**: `device_repository.py` in `espark-core/esparkcore/data/repositories/` shows how to implement data access logic for devices.
+- **Action Example**: `esp32_relay.py` in `espark-node/esparknode/actions/` illustrates how to define actions for ESP32 devices.
+- **Sensor Example**: `sht20_sensor.py` in `espark-node/esparknode/sensors/` demonstrates how to read data from a SHT20 sensor.
+- **Trigger Example**: `gpio_trigger.py` in `espark-node/esparknode/triggers/` shows how to create GPIO-based triggers for device actions.
+- **List, Show, Edit Screens Example**: `DeviceList`, `DeviceShow`, and `DeviceEdit` components in `espark-react/src/pages/devices/` demonstrate how to create CRUD screens for device management.
+
+## Example Projects
+
+- **Espartan**: A smart thermostat and open-door alert automation system using ESP32-C3 devices, leveraging espark for device management and telemetry, available at [https://github.com/ayltai/Espartan](https://github.com/ayltai/Espartan).

espark_core-0.5.5/espark_core.egg-info/SOURCES.txt

@@ -0,0 +1,85 @@
+LICENSE
+MANIFEST.in
+README.md
+requirements.dev.txt
+requirements.txt
+setup.cfg
+setup.py
+../README.md
+./esparkcore/__init__.py
+./esparkcore/constants.py
+./esparkcore/data/__init__.py
+./esparkcore/data/database.py
+./esparkcore/data/models/__init__.py
+./esparkcore/data/models/device.py
+./esparkcore/data/models/notification.py
+./esparkcore/data/models/outbox.py
+./esparkcore/data/models/telemetry.py
+./esparkcore/data/models/trigger.py
+./esparkcore/data/models/version.py
+./esparkcore/data/repositories/__init__.py
+./esparkcore/data/repositories/base_repository.py
+./esparkcore/data/repositories/device_repository.py
+./esparkcore/data/repositories/notification_repository.py
+./esparkcore/data/repositories/outbox_repository.py
+./esparkcore/data/repositories/telemetry_repository.py
+./esparkcore/data/repositories/trigger_repository.py
+./esparkcore/data/repositories/version_repository.py
+./esparkcore/notifications/__init__.py
+./esparkcore/notifications/notifier.py
+./esparkcore/notifications/slack_notifier.py
+./esparkcore/routers/__init__.py
+./esparkcore/routers/base_router.py
+./esparkcore/routers/device_router.py
+./esparkcore/routers/notification_router.py
+./esparkcore/routers/telemetry_router.py
+./esparkcore/routers/trigger_router.py
+./esparkcore/routers/version_router.py
+./esparkcore/schedules/__init__.py
+./esparkcore/schedules/outbox.py
+./esparkcore/schedules/scheduler.py
+./esparkcore/services/__init__.py
+./esparkcore/services/mqtt.py
+./esparkcore/utils/__init__.py
+./esparkcore/utils/logging.py
+espark_core.egg-info/PKG-INFO
+espark_core.egg-info/SOURCES.txt
+espark_core.egg-info/dependency_links.txt
+espark_core.egg-info/requires.txt
+espark_core.egg-info/top_level.txt
+esparkcore/__init__.py
+esparkcore/constants.py
+esparkcore/data/__init__.py
+esparkcore/data/database.py
+esparkcore/data/models/__init__.py
+esparkcore/data/models/device.py
+esparkcore/data/models/notification.py
+esparkcore/data/models/outbox.py
+esparkcore/data/models/telemetry.py
+esparkcore/data/models/trigger.py
+esparkcore/data/models/version.py
+esparkcore/data/repositories/__init__.py
+esparkcore/data/repositories/base_repository.py
+esparkcore/data/repositories/device_repository.py
+esparkcore/data/repositories/notification_repository.py
+esparkcore/data/repositories/outbox_repository.py
+esparkcore/data/repositories/telemetry_repository.py
+esparkcore/data/repositories/trigger_repository.py
+esparkcore/data/repositories/version_repository.py
+esparkcore/notifications/__init__.py
+esparkcore/notifications/notifier.py
+esparkcore/notifications/slack_notifier.py
+esparkcore/routers/__init__.py
+esparkcore/routers/base_router.py
+esparkcore/routers/device_router.py
+esparkcore/routers/notification_router.py
+esparkcore/routers/telemetry_router.py
+esparkcore/routers/trigger_router.py
+esparkcore/routers/version_router.py
+esparkcore/schedules/__init__.py
+esparkcore/schedules/outbox.py
+esparkcore/schedules/scheduler.py
+esparkcore/services/__init__.py
+esparkcore/services/mqtt.py
+esparkcore/utils/__init__.py
+esparkcore/utils/logging.py

espark_core-0.5.5/espark_core.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

espark_core-0.5.5/espark_core.egg-info/requires.txt

@@ -0,0 +1,21 @@
+aiomqtt>=2.5.0
+apscheduler>=3.11.2
+fastapi>=0.128.0
+packaging>=25.0
+slack-sdk==3.39.0
+sqlalchemy>=2.0.45
+sqlmodel>=0.0.31
+uvicorn[standard]>=0.40.0
+
+[dev]
+aiosqlite==0.22.1
+autopep8==2.3.2
+build==1.3.0
+fastapi-cli[standard-no-fastapi-cloud-cli]==0.0.20
+httpx==0.28.1
+pycodestyle==2.14.0
+pylint==4.0.4
+pytest==9.0.2
+pytest-asyncio==1.3.0
+pytest-cov==7.0.0
+twine==6.2.0

espark_core-0.5.5/espark_core.egg-info/top_level.txt

@@ -0,0 +1 @@
+esparkcore

espark_core-0.5.5/esparkcore/constants.py

@@ -0,0 +1,11 @@
+ENV_DATABASE_URL : str = 'DATABASE_URL'
+ENV_MQTT_HOST    : str = 'MQTT_HOST'
+ENV_MQTT_PORT    : str = 'MQTT_PORT'
+ENV_UPLOAD_PATH  : str = 'UPLOAD_PATH'
+
+TOPIC_ACTION       : str = 'espark/action'
+TOPIC_DEVICE       : str = 'espark/device'
+TOPIC_REGISTRATION : str = 'espark/registration'
+TOPIC_TELEMETRY    : str = 'espark/telemetry'
+TOPIC_OTA          : str = 'espark/ota'
+TOPIC_CRASH        : str = 'espark/crash'

espark_core-0.5.5/esparkcore/data/__init__.py

@@ -0,0 +1 @@
+from .database import async_session, init_db

espark_core-0.5.5/esparkcore/data/database.py

@@ -0,0 +1,15 @@
+from os import getenv
+
+from sqlalchemy.ext.asyncio import async_sessionmaker, AsyncSession, create_async_engine
+from sqlmodel import SQLModel
+
+from ..constants import ENV_DATABASE_URL
+
+# pylint: disable=invalid-name
+engine        = create_async_engine(getenv(ENV_DATABASE_URL, 'sqlite+aiosqlite:///database.db'), echo=True)
+async_session = async_sessionmaker(engine, class_=AsyncSession, expire_on_commit=False)
+
+
+async def init_db():
+    async with engine.begin() as conn:
+        await conn.run_sync(SQLModel.metadata.create_all)

espark_core-0.5.5/esparkcore/data/models/__init__.py

@@ -0,0 +1,6 @@
+from .device import Device
+from .notification import Notification
+from .outbox import OutboxEvent
+from .telemetry import Telemetry
+from .trigger import Trigger
+from .version import AppVersion

espark_core-0.5.5/esparkcore/data/models/device.py

@@ -0,0 +1,15 @@
+from datetime import datetime
+from typing import Dict, Optional
+
+from sqlalchemy import Column
+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, foreign_key='appversion.id', ondelete='CASCADE', 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')

espark_core-0.5.5/esparkcore/data/models/notification.py

@@ -0,0 +1,11 @@
+from typing import Dict
+
+from sqlalchemy import Column
+from sqlmodel import SQLModel, Field, JSON
+
+
+class Notification(SQLModel, table=True):
+    id       : int            = Field(primary_key=True, description='Unique identifier for the notification')
+    name     : str            = Field(index=True, unique=True, description='Name of the notification')
+    provider : str            = Field(index=True, description='Notification provider (e.g., Slack, Twilio)')
+    config   : Dict[str, str] = Field(default_factory=dict, sa_column=Column(JSON), description='JSON string of provider-specific configuration parameters')

espark_core-0.5.5/esparkcore/data/models/outbox.py

@@ -0,0 +1,20 @@
+from datetime import datetime
+from typing import Dict, Optional
+from uuid import UUID, uuid4
+
+from sqlalchemy import Column
+from sqlmodel import SQLModel, Field, JSON, UniqueConstraint
+
+
+class OutboxEvent(SQLModel, table=True):
+    __table_args__ = (
+        UniqueConstraint('device_id', 'event_type', 'is_processed', name='uq_device_event'),
+    )
+
+    id           : UUID               = Field(default_factory=uuid4, primary_key=True, description='Unique identifier for the outbox event')
+    device_id    : str                = Field(foreign_key='device.id', ondelete='CASCADE', index=True, description='Identifier of the device associated with the event')
+    event_type   : str                = Field(index=True, description='Type of the event')
+    payload      : Dict[str, str]     = Field(default_factory=dict, sa_column=Column(JSON), description='JSON string of event-specific payload data')
+    created_at   : datetime           = Field(default_factory=datetime.now, index=True, description='Timestamp when the event was created')
+    processed_at : Optional[datetime] = Field(default=None, index=True, description='Timestamp when the event was processed')
+    is_processed : bool               = Field(default=False, index=True, description='Flag indicating whether the event has been processed')

espark_core-0.5.5/esparkcore/data/models/telemetry.py

@@ -0,0 +1,12 @@
+from datetime import datetime
+from typing import Optional
+
+from sqlmodel import SQLModel, Field
+
+
+class Telemetry(SQLModel, table=True):
+    id        : Optional[int] = Field(primary_key=True, default=None)
+    device_id : str           = Field(foreign_key='device.id', ondelete='CASCADE', description='Device that sent this data')
+    timestamp : datetime      = Field(index=True, description='Timestamp of the data')
+    data_type : str           = Field(index=True, description='Type of the data (e.g., motion, temperature)')
+    value     : int           = Field(description='Value of the data (e.g., temperature, human presence detected or not)')

espark_core-0.5.5/esparkcore/data/models/trigger.py

@@ -0,0 +1,13 @@
+from typing import Optional
+
+from sqlmodel import Field, SQLModel
+
+
+class Trigger(SQLModel, table=True):
+    id               : Optional[int] = Field(primary_key=True, description='Unique identifier for the trigger')
+    name             : str           = Field(index=True, unique=True, description='Name of the trigger')
+    device_id        : Optional[str] = Field(index=True, default=None, description='Identifier of the associated device')
+    data_type        : Optional[str] = Field(index=True, default=None, description='Type of telemetry data the trigger monitors (e.g., temperature, humidity)')
+    condition        : str           = Field(description='Condition to evaluate (e.g., ">", "<=")')
+    value            : int           = Field(description='Value to compare against for the trigger condition')
+    notification_ids : Optional[str] = Field(default=None, description='Comma-separated list of associated notification IDs to be sent when the trigger condition is met')

espark_core-0.5.5/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')

espark_core-0.5.5/esparkcore/data/repositories/__init__.py

@@ -0,0 +1,7 @@
+from .base_repository import AsyncRepository
+from .device_repository import DeviceRepository
+from .notification_repository import NotificationRepository
+from .outbox_repository import OutboxRepository
+from .telemetry_repository import TelemetryRepository
+from .trigger_repository import TriggerRepository
+from .version_repository import AppVersionRepository