opensignalbox-interface 0.1.0__tar.gz

opensignalbox_interface-0.1.0/.gitignore

@@ -0,0 +1,182 @@
+# Created by https://www.toptal.com/developers/gitignore/api/python
+# Edit at https://www.toptal.com/developers/gitignore?templates=python
+
+### opensignalbox ###
+tests/**/settings.toml
+tests/workspace/boxes/*/resources/*
+tests/workspace/boxes/Lowdham
+opensignalbox/trainplanning/ltsv/icons
+
+### Python ###
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+#dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+### Python Patch ###
+# Poetry local configuration file - https://python-poetry.org/docs/configuration/#local-configuration
+poetry.toml
+
+# ruff
+.ruff_cache/
+
+# LSP config files
+pyrightconfig.json
+
+# End of https://www.toptal.com/developers/gitignore/api/python

opensignalbox_interface-0.1.0/CHANGELOG.md

@@ -0,0 +1,10 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+- WIP

opensignalbox_interface-0.1.0/LICENSE

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

opensignalbox_interface-0.1.0/PKG-INFO

@@ -0,0 +1,49 @@
+Metadata-Version: 2.4
+Name: opensignalbox-interface
+Version: 0.1.0
+Summary: The official hardware interface module for the opensignalbox simulation framework.
+Project-URL: Homepage, https://opensignalbox.org/
+Project-URL: Repository, https://github.com/opensignalbox/opensignalbox
+Author-email: The openSignalBox project <info@opensignalbox.org>
+Maintainer-email: Laurence Stant <laurence@stant.phd>
+License-File: LICENSE
+Classifier: License :: OSI Approved :: GNU Affero General Public License v3 or later (AGPLv3+)
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Requires-Python: >=3.8
+Requires-Dist: anyio>=4.3.0
+Requires-Dist: email-validator>=2.1.1
+Requires-Dist: fastapi>=0.115.0
+Requires-Dist: hypercorn>=0.16.0
+Requires-Dist: jinja2>=3.1.3
+Requires-Dist: opensignalbox-common>=0.1.0
+Requires-Dist: pydantic-settings>=2.1.0
+Requires-Dist: pyserial>=3.5
+Requires-Dist: pyyaml>=6.0.1
+Requires-Dist: requests>=2.31.0
+Requires-Dist: sqlmodel>=0.0.21
+Requires-Dist: trio>=0.23.2
+Requires-Dist: zmq>=0.0.0
+Description-Content-Type: text/markdown
+
+# OSB Interface
+
+Generic interface module for Open Signal Box system, providing abstraction for various physical and software interfaces.
+
+## Features
+- Generic interface and adapter architecture
+- Simple IO interface for boolean data (inputs and outputs)
+- Support for different adapter types (modbus, etc.)
+- Clean separation between interface type logic and adapter communication
+
+## Installation
+
+```bash
+pip install opensignalbox-interface
+```
+
+## Development
+
+```bash
+pip install -e .
+```

opensignalbox_interface-0.1.0/README.md

@@ -0,0 +1,21 @@
+# OSB Interface
+
+Generic interface module for Open Signal Box system, providing abstraction for various physical and software interfaces.
+
+## Features
+- Generic interface and adapter architecture
+- Simple IO interface for boolean data (inputs and outputs)
+- Support for different adapter types (modbus, etc.)
+- Clean separation between interface type logic and adapter communication
+
+## Installation
+
+```bash
+pip install opensignalbox-interface
+```
+
+## Development
+
+```bash
+pip install -e .
+```

opensignalbox_interface-0.1.0/pyproject.toml

@@ -0,0 +1,44 @@
+[project]
+name = "opensignalbox-interface"
+version = "0.1.0"
+description = "The official hardware interface module for the opensignalbox simulation framework."
+authors = [
+    { name = "The openSignalBox project", email = "info@opensignalbox.org" },
+]
+maintainers = [{ name = "Laurence Stant", email = "laurence@stant.phd" }]
+dependencies = [
+    "fastapi>=0.115.0",
+    "email-validator>=2.1.1",
+    "hypercorn>=0.16.0",
+    "trio>=0.23.2",
+    "pyyaml>=6.0.1",
+    "jinja2>=3.1.3",
+    "pydantic-settings>=2.1.0",
+    "zmq>=0.0.0",
+    "requests>=2.31.0",
+    "anyio>=4.3.0",
+    "opensignalbox-common>=0.1.0",
+    "sqlmodel>=0.0.21",
+    "pyserial>=3.5",
+]
+readme = "README.md"
+requires-python = ">= 3.8"
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "License :: OSI Approved :: GNU Affero General Public License v3 or later (AGPLv3+)",
+    "Operating System :: OS Independent",
+]
+
+[project.urls]
+"Homepage" = "https://opensignalbox.org/"
+"Repository" = "https://github.com/opensignalbox/opensignalbox"
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project.scripts]
+opensignalbox-interface = 'opensignalbox.interface.main:entry_point'
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/opensignalbox"]

opensignalbox_interface-0.1.0/src/opensignalbox/interface/__init__.py

@@ -0,0 +1,42 @@
+"""
+opensignalbox-interface - Generic interface module for Open Signal Box
+"""
+
+# Public exports
+from .adapters.base import BaseAdapter as BaseAdapter
+from .adapters.controller import AdapterController as AdapterController
+from .interfaces.base import InterfaceHandler as InterfaceHandler
+from .interfaces.controller import InterfaceController as InterfaceController
+
+# Module classes
+from .main import Module as Module
+from .models import (
+    AdapterBase,
+    AdapterCreate,
+    AdapterModel,
+    AdapterPublic,
+    AdapterTypeEnum,
+    AdapterUpdate,
+    Interface,
+    InterfaceBase,
+    InterfacePublic,
+    InterfaceTypeEnum,
+    InterfaceUpdate,
+)
+
+__all__ = [
+    "AdapterBase",
+    "AdapterController",
+    "AdapterCreate",
+    "AdapterModel",
+    "AdapterPublic",
+    "AdapterTypeEnum",
+    "AdapterUpdate",
+    "Interface",
+    "InterfaceBase",
+    "InterfaceController",
+    "InterfaceHandler",
+    "InterfacePublic",
+    "InterfaceTypeEnum",
+    "InterfaceUpdate",
+]

opensignalbox_interface-0.1.0/src/opensignalbox/interface/adapters/__init__.py

@@ -0,0 +1,3 @@
+"""
+Adapters for opensignalbox-interface.
+"""

opensignalbox_interface-0.1.0/src/opensignalbox/interface/adapters/base.py

@@ -0,0 +1,148 @@
+"""
+Base adapter class and types for opensignalbox-interface module.
+"""
+
+import logging
+from abc import ABC, abstractmethod
+from typing import Any, Optional
+
+logger = logging.getLogger(__name__)
+
+CONNECT_RETRIES = 3
+COMMAND_RETRIES = 3
+
+
+class BaseAdapter(ABC):
+    """Base abstract class for all adapters."""
+
+    # Adapter controller reference for API routes
+    adapter_controller = None
+
+    @classmethod
+    def set_controller(cls, controller):
+        """Set the adapter controller reference for API routes.
+
+        Args:
+            controller: The adapter controller instance
+        """
+        cls.adapter_controller = controller
+
+    @classmethod
+    def get_router(cls) -> Optional[Any]:
+        """Get API router for this adapter type.
+
+        Returns:
+            Optional FastAPI router to be included in the API
+            Returns None if no custom routes are needed
+
+        Example:
+            ```python
+            @classmethod
+            def get_router(cls):
+                from fastapi import APIRouter
+
+                router = APIRouter()
+
+                @router.get("/my-adapter/status")
+                async def get_status():
+                    # Access adapters via the controller reference
+                    adapters = cls.adapter_controller.get_all()
+                    return {"status": "ok", "adapter_count": len(adapters)}
+
+                return router
+            ```
+        """
+        return None
+
+    def __init__(
+        self, system_name: str, user_name: str, description: str = "", **kwargs: Any
+    ) -> None:
+        self.system_name = system_name
+        self.user_name = user_name
+        self.description = description
+        self.adapter_type: str = "BaseAdapter"
+        self.is_connected: bool = False
+        self.error: Optional[str] = None
+        self.enabled: bool = True
+
+    def connect(self) -> bool:
+        """Connect to the adapter with retry logic."""
+        if self.is_connected:
+            self.disconnect()
+        if not self.enabled:
+            return False
+        try:
+            self.attempt_connect()
+            self.error = None
+            self.is_connected = True
+            return True
+        except Exception as error:
+            logger.error(f"Connection to adapter '{self.user_name}' failed: {error}")
+            self.error = str(error)
+            self.disconnect()
+            self.enabled = False
+            return False
+
+    def clear_error_and_connect(self) -> None:
+        """Clear any errors and attempt to connect again."""
+        self.error = None
+        self.connect()
+
+    @abstractmethod
+    def attempt_connect(self) -> None:
+        """Concrete implementation of the connection logic."""
+        pass
+
+    def disconnect(self) -> None:
+        """Disconnect from the adapter."""
+        if self.is_connected:
+            self.attempt_disconnect()
+            self.is_connected = False
+
+    @abstractmethod
+    def attempt_disconnect(self) -> None:
+        """Concrete implementation of the disconnection logic."""
+        pass
+
+    def write(self, data: Any) -> None:
+        """Write data to the adapter with retry logic."""
+        write_try = 1
+        while write_try <= COMMAND_RETRIES:
+            try:
+                self.attempt_write(data)
+                return
+            except Exception as error:
+                logger.error(f"Write to adapter '{self.user_name}' failed: {error}")
+                self.error = str(error)
+                write_try += 1
+                if write_try <= COMMAND_RETRIES:
+                    logger.error(
+                        f"Retrying write {write_try} out of {COMMAND_RETRIES} attempts..."
+                    )
+
+    @abstractmethod
+    def attempt_write(self, data: Any) -> None:
+        """Concrete implementation of the write logic."""
+        pass
+
+    def read(self) -> Any:
+        """Read data from the adapter with retry logic."""
+        read_try = 1
+        while read_try <= COMMAND_RETRIES:
+            try:
+                result = self.attempt_read()
+                return result
+            except Exception as error:
+                logger.error(f"Read from adapter '{self.user_name}' failed: {error}")
+                self.error = str(error)
+                read_try += 1
+                if read_try <= COMMAND_RETRIES:
+                    logger.error(
+                        f"Retrying read {read_try} out of {COMMAND_RETRIES} attempts..."
+                    )
+        return None
+
+    @abstractmethod
+    def attempt_read(self) -> Any:
+        """Concrete implementation of the read logic."""
+        pass