primitives 0.1.0__tar.gz

primitives-0.1.0/.gitignore

@@ -0,0 +1,84 @@
+# Python
+__pycache__/
+*.py[cod]
+*$py.class
+*.so
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# Virtual environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# uv
+.uv/
+
+# IDE
+.vscode/
+.idea/
+*.swp
+*.swo
+*~
+
+# OS
+.DS_Store
+Thumbs.db
+
+# Docker
+.dockerignore
+
+# Logs
+*.log
+
+# Environment variables
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+
+# Coverage reports
+htmlcov/
+.coverage
+.coverage.*
+coverage.xml
+*.cover
+.hypothesis/
+.pytest_cache/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# pyenv
+.python-version
+
+# pipenv
+Pipfile.lock
+
+# poetry
+poetry.lock
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json

primitives-0.1.0/PKG-INFO

@@ -0,0 +1,73 @@
+Metadata-Version: 2.4
+Name: primitives
+Version: 0.1.0
+Summary: Shared PLC-style primitives in Python
+Author-email: Neil Doell <neil@vococo.ca>
+License-Expression: MIT
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+
+timers-latches
+
+Lightweight, production-ready implementations of PLC-style primitives in Python:
+
+TON — On-delay timer
+
+SR — Set/Reset latch (reset dominant)
+
+These primitives are useful for industrial automation logic, simulations, or anywhere you want PLC-like control behavior in Python.
+
+Installation
+pip install timers-latches
+
+
+Or, for development:
+
+git clone https://github.com/yourorg/timers-latches.git
+cd timers-latches
+pip install -e .
+
+Usage
+from timers_latches import TON, SR
+
+# --- TON example ---
+ton = TON(preset_s=2.0)   # 2-second delay
+for step in range(5):
+    q = ton.update(enable=True, dt_s=0.5)
+    print(f"t={step*0.5:.1f}s, Q={q}")
+# Q will turn True after 2.0 seconds of accumulated enable time
+
+# --- SR example ---
+latch = SR(initial=False)
+print(latch.update(set_=True, reset=False))   # True
+print(latch.update(set_=False, reset=True))   # False (reset dominates)
+
+API
+TON(preset_s: float)
+
+preset_s: delay time in seconds (must be ≥ 0).
+
+.update(enable: bool, dt_s: float) -> bool: call once per scan; returns the done bit (Q).
+
+.Q: current output (done bit).
+
+SR(initial: bool = False)
+
+initial: starting state.
+
+.update(set_: bool, reset: bool) -> bool: updates and returns current state. Reset dominates set.
+
+.state: current latched state.
+
+Versioning
+
+Follows Semantic Versioning
+.
+
+API is stable from 1.0.0 onward.
+
+License
+
+MIT © Your Name / Your Organization
+
+⚡️ This package is intentionally minimal and focused: no dependencies, only core primitives. You can drop it into simulations, control logic, or larger automation frameworks.

primitives-0.1.0/README.md

@@ -0,0 +1,64 @@
+timers-latches
+
+Lightweight, production-ready implementations of PLC-style primitives in Python:
+
+TON — On-delay timer
+
+SR — Set/Reset latch (reset dominant)
+
+These primitives are useful for industrial automation logic, simulations, or anywhere you want PLC-like control behavior in Python.
+
+Installation
+pip install timers-latches
+
+
+Or, for development:
+
+git clone https://github.com/yourorg/timers-latches.git
+cd timers-latches
+pip install -e .
+
+Usage
+from timers_latches import TON, SR
+
+# --- TON example ---
+ton = TON(preset_s=2.0)   # 2-second delay
+for step in range(5):
+    q = ton.update(enable=True, dt_s=0.5)
+    print(f"t={step*0.5:.1f}s, Q={q}")
+# Q will turn True after 2.0 seconds of accumulated enable time
+
+# --- SR example ---
+latch = SR(initial=False)
+print(latch.update(set_=True, reset=False))   # True
+print(latch.update(set_=False, reset=True))   # False (reset dominates)
+
+API
+TON(preset_s: float)
+
+preset_s: delay time in seconds (must be ≥ 0).
+
+.update(enable: bool, dt_s: float) -> bool: call once per scan; returns the done bit (Q).
+
+.Q: current output (done bit).
+
+SR(initial: bool = False)
+
+initial: starting state.
+
+.update(set_: bool, reset: bool) -> bool: updates and returns current state. Reset dominates set.
+
+.state: current latched state.
+
+Versioning
+
+Follows Semantic Versioning
+.
+
+API is stable from 1.0.0 onward.
+
+License
+
+MIT © Your Name / Your Organization
+
+⚡️ This package is intentionally minimal and focused: no dependencies, only core primitives. You can drop it into simulations, control logic, or larger automation frameworks.

primitives-0.1.0/pyproject.toml

@@ -0,0 +1,24 @@
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "primitives"
+version = "0.1.0"
+description = "Shared PLC-style primitives in Python"
+authors = [{name="Neil Doell", email="neil@vococo.ca"}]
+readme = "README.md"
+license = "MIT"
+requires-python = ">=3.9"
+dependencies = []
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/primitives"]
+
+[tool.hatch.build.targets.wheel.force-include]
+"src/primitives/py.typed" = "primitives/py.typed"
+
+[tool.ruff.lint.per-file-ignores]
+"primitives/__init__.py" = ["F403", "F405"]
+

primitives-0.1.0/src/primitives/__init__.py

@@ -0,0 +1,4 @@
+from .ton import TON
+from .sr import SR
+
+__all__ = ["TON", "SR"]

primitives-0.1.0/src/primitives/sr.py

@@ -0,0 +1,12 @@
+from dataclasses import dataclass
+
+@dataclass(slots=True)
+class SR:
+    state: bool = False
+
+    def update(self, set_: bool, reset: bool) -> bool:
+        if reset:
+            self.state = False
+        elif set_:
+            self.state = True
+        return self.state

primitives-0.1.0/src/primitives/ton.py

@@ -0,0 +1,53 @@
+# primitives/ton.py
+from __future__ import annotations
+
+from dataclasses import dataclass
+from time import monotonic
+from typing import Optional
+
+
+@dataclass(slots=True)
+class TON:
+    """IEC-style TON (timer on-delay).
+
+    Usage:
+        t = TON(2.0)           # 2 seconds preset
+        t.update(True)         # call each scan with enable signal
+        if t.q: ...            # output goes True after preset elapses
+    """
+    preset: float                           # seconds
+    _start: Optional[float] = None          # monotonic start time
+    q: bool = False                         # done/output
+
+    def reset(self) -> None:
+        self._start = None
+        self.q = False
+
+    def update(self, enable: bool, now: Optional[float] = None) -> bool:
+        """Update the timer; return output (q).
+
+        Args:
+            enable: input signal; when False, timer resets.
+            now: optional monotonic time for testing; defaults to time.monotonic().
+        """
+        if not enable:
+            self.reset()
+            return self.q
+
+        t = monotonic() if now is None else now
+        if self._start is None:
+            self._start = t
+            self.q = False
+            return self.q
+
+        if (t - self._start) >= self.preset:
+            self.q = True
+        return self.q
+
+    @property
+    def elapsed(self) -> float:
+        """Seconds since enable; 0 if not running."""
+        if self._start is None:
+            return 0.0
+        t = monotonic()
+        return max(0.0, t - self._start)

primitives-0.1.0/uv.lock

@@ -0,0 +1,8 @@
+version = 1
+revision = 3
+requires-python = ">=3.10"
+
+[[package]]
+name = "primitives"
+version = "0.1.0"
+source = { editable = "." }