festo-vaem 0.1.0__tar.gz

festo_vaem-0.1.0/PKG-INFO

@@ -0,0 +1,51 @@
+Metadata-Version: 2.3
+Name: festo-vaem
+Version: 0.1.0
+Summary: Library to control Festo Lifetech VAEM 8 Channel Valve Control Device
+Keywords: Festo,Valve,Valves,Actuation,Valve Controller,Controller
+Author: Joshua Dang, Kyle Wardlow
+Author-email: Joshua Dang <joshua.dang@festo.com>, Kyle Wardlow <kyle.wardlow@festo.com>
+License: MIT
+Classifier: Programming Language :: Python :: 3
+Classifier: Development Status :: 4 - Beta
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Dist: pymodbus<=3.11.4
+Requires-Dist: rich>=14.0.0
+Requires-Dist: pyserial<=3.5 ; extra == 'serial'
+Requires-Python: >=3.10
+Project-URL: Homepage, https://github.com/Festo-se/festo-vaem
+Project-URL: Repository, https://github.com/Festo-se/festo-vaem.git
+Project-URL: Issues, https://github.com/Festo-se/festo-vaem/issues
+Provides-Extra: serial
+Description-Content-Type: text/markdown
+
+# VAEM
+
+`festo-vaem` is a python package which allows for driver like capabilites and usage over Festo's 8 Channel Valve controller (VAEM) device.
+
+Documentation can be found [here](https://festo-se.github.io/festo-vaem/). 
+
+Examples can be found [here](https://github.com/Festo-se/festo-vaem/tree/main/examples) and [here](https://festo-se.github.io/festo-vaem/examples/examples)
+
+## Installation
+
+### Release (PENDING)
+
+The lastest released version of this package can be found on the PyPi repo.
+Install using pip:
+
+```
+pip install festo-vaem
+```
+
+### From git repository
+
+The `festo-vaem` source code can also be installed directly from Github. Users can then choose to package it with pip locally if they wish
+```
+pip install git+https://github.com/Festo-se/festo-vaem.git
+```
+or using [`uv`](https://docs.astral.sh/uv/getting-started/installation/)
+```
+uv add "festo-vaem @ git+https://github.com/Festo-se/festo-vaem.git"
+```

festo_vaem-0.1.0/README.md

@@ -0,0 +1,29 @@
+# VAEM
+
+`festo-vaem` is a python package which allows for driver like capabilites and usage over Festo's 8 Channel Valve controller (VAEM) device.
+
+Documentation can be found [here](https://festo-se.github.io/festo-vaem/). 
+
+Examples can be found [here](https://github.com/Festo-se/festo-vaem/tree/main/examples) and [here](https://festo-se.github.io/festo-vaem/examples/examples)
+
+## Installation
+
+### Release (PENDING)
+
+The lastest released version of this package can be found on the PyPi repo.
+Install using pip:
+
+```
+pip install festo-vaem
+```
+
+### From git repository
+
+The `festo-vaem` source code can also be installed directly from Github. Users can then choose to package it with pip locally if they wish
+```
+pip install git+https://github.com/Festo-se/festo-vaem.git
+```
+or using [`uv`](https://docs.astral.sh/uv/getting-started/installation/)
+```
+uv add "festo-vaem @ git+https://github.com/Festo-se/festo-vaem.git"
+```

festo_vaem-0.1.0/pyproject.toml

@@ -0,0 +1,96 @@
+[project]
+name = "festo-vaem"
+description = "Library to control Festo Lifetech VAEM 8 Channel Valve Control Device"
+readme = {file = "README.md", content-type = "text/markdown"}
+authors = [
+    {name = "Joshua Dang", email = "joshua.dang@festo.com"},
+    {name = "Kyle Wardlow", email = "kyle.wardlow@festo.com"}
+]
+license = {text = "MIT"}
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "Development Status :: 4 - Beta",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+]
+keywords = ["Festo", "Valve", "Valves", "Actuation", "Valve Controller", "Controller"]
+version = "0.1.0"
+requires-python = ">=3.10"
+dependencies = [
+    "pymodbus<=3.11.4",
+    'rich>=14.0.0',
+]
+
+[project.urls]
+Homepage = "https://github.com/Festo-se/festo-vaem"
+Repository = "https://github.com/Festo-se/festo-vaem.git"
+Issues = "https://github.com/Festo-se/festo-vaem/issues"
+
+[project.optional-dependencies]
+serial = [
+    "pyserial<=3.5",
+]
+
+[build-system]
+requires = ["uv_build>=0.9.17,<0.10.0"]
+build-backend = "uv_build"
+
+[dependency-groups]
+dev = [
+    "pyserial<=3.5",
+    "pymodbus[simulator]<=3.11.4",
+    "pytest>=9.0.1",
+    "ruff"
+]
+docs = [
+    "mkdocs>=1.6.1",
+    "mkdocs-autoapi>=0.4.1",
+    "mkdocs-autorefs>=1.4.2",
+    "mkdocs-include-markdown-plugin>=7.1.5",
+    "mkdocs-material>=9.6.14",
+    "mkdocstrings[python]>=0.29.1",
+    "mkdocs-codeinclude-plugin>=0.2.1",
+]
+
+[tool.uv]
+cache-keys = [{ file = "pyproject.toml" }, { git = { commit = true } }]
+
+[tool.uv.build-backend]
+module-name = "vaem"
+
+[tool.ruff]
+line-length = 120
+indent-width = 4
+target-version = "py311"
+src = ["src", "examples"]
+exclude = [
+    ".git",
+    "__pycache__",
+    ".vscode",
+    ".venv",
+    ".pytest_cache",
+    "tests",
+]
+fix = true
+show-fixes = true
+
+[tool.ruff.lint]
+select = ["D", "E4", "E7", "E9", "F", "C901", "B", "S"]
+ignore = ["D203", "D212"]
+
+[tool.ruff.lint.pydocstyle]
+convention = "google"
+
+[tool.ruff.format]
+indent-style = "space"
+quote-style = "double"
+line-ending = "auto"
+docstring-code-format = true
+exclude = [
+    ".git",
+    "__pycache__",
+    ".vscode",
+    ".venv",
+    ".pytest_cache",
+    "tests",
+]

festo_vaem-0.1.0/src/vaem/__init__.py

@@ -0,0 +1,11 @@
+"""Abstracting internal file structure for VAEM package."""
+
+from vaem.vaem import VAEM
+from vaem.vaem_config import VAEMConfig, VAEMSerialConfig, VAEMTCPConfig
+
+__all__ = [
+    "VAEM",
+    "VAEMConfig",
+    "VAEMTCPConfig",
+    "VAEMSerialConfig",
+]

festo_vaem-0.1.0/src/vaem/utils/__init__.py

@@ -0,0 +1 @@
+"""Utils Submodule."""

festo_vaem-0.1.0/src/vaem/utils/logging.py

@@ -0,0 +1,65 @@
+"""Logger for VAEM device."""
+
+import logging
+
+from rich.logging import RichHandler
+
+
+class Logging:
+    """Class that contains common functions for logging."""
+
+    logger = logging.getLogger("vaem")
+
+    def __init__(self, logging_level=logging.INFO, filename=None) -> None:
+        """
+        Constructor for logging class.
+
+        Args:
+            logging_level (int): Logging level from logging module
+            filename (str): If provided, enables file logging to the given filename.
+
+        Returns:
+            None
+        """
+        logging.basicConfig(format="%(message)s", datefmt="[%X]", handlers=[RichHandler()])
+
+        Logging.logger.setLevel(logging_level)
+        Logging.logger.propagate = False
+
+        if filename:
+            self.enable_file_logging(logging_level, filename)
+        else:
+            self.enable_stream_logging(logging_level)
+
+    def enable_stream_logging(self, logging_level=logging.INFO) -> None:
+        """
+        Enables logging to stream using the provided log level with rich log formatting.
+
+        Args:
+            logging_level (int): Logging level from logging module
+
+        Returns:
+            None
+        """
+        handler = RichHandler()
+        handler.setLevel(logging_level)
+        formatter = logging.Formatter(fmt="%(message)s", datefmt="[%X]")
+        handler.setFormatter(formatter)
+        Logging.logger.addHandler(handler)
+
+    def enable_file_logging(self, logging_level=logging.INFO, filename=None) -> None:
+        """
+        Enables logging to a file using the provided filename and log level.
+
+        Args:
+            logging_level (int): Logging level from logging module
+            filename (str): Filename to log to.
+
+        Returns:
+            None
+        """
+        handler = logging.FileHandler(filename)
+        handler.setLevel(logging_level)
+        formatter = logging.Formatter(fmt="%(asctime)s - %(name)s - %(levelname)s - %(message)s", datefmt="[%X]")
+        handler.setFormatter(formatter)
+        Logging.logger.addHandler(handler)