s7commplus 0.1.0__tar.gz

s7commplus-0.1.0/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2013 Gijs Molenaar, Stephan Preeker
+
+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.

s7commplus-0.1.0/PKG-INFO

@@ -0,0 +1,90 @@
+Metadata-Version: 2.4
+Name: s7commplus
+Version: 0.1.0
+Summary: Pure Python S7CommPlus client and server emulator for Siemens S7-1200/1500 PLCs
+Author-email: Gijs Molenaar <gijsmolenaar@gmail.com>
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/gijzelaerr/s7commplus
+Project-URL: Repository, https://github.com/gijzelaerr/s7commplus
+Project-URL: Issues, https://github.com/gijzelaerr/s7commplus/issues
+Project-URL: Documentation, https://s7commplus.readthedocs.io/
+Keywords: s7commplus,s7,siemens,plc,industrial-automation
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Manufacturing
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: System :: Hardware
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+License-File: s7commplus/session_auth/LICENSE-HarpoS7
+Requires-Dist: cryptography>=41
+Provides-Extra: test
+Requires-Dist: pytest; extra == "test"
+Requires-Dist: pytest-asyncio; extra == "test"
+Requires-Dist: pytest-bdd<9,>=8.1; extra == "test"
+Requires-Dist: pytest-cov; extra == "test"
+Requires-Dist: hypothesis; extra == "test"
+Requires-Dist: mypy; extra == "test"
+Requires-Dist: ruff; extra == "test"
+Provides-Extra: docs
+Requires-Dist: sphinx>=7.2; extra == "docs"
+Requires-Dist: furo>=2024.8.6; extra == "docs"
+Dynamic: license-file
+
+# s7commplus
+
+Pure-Python S7CommPlus communication for Siemens S7-1200 and S7-1500 PLCs.
+It supports S7CommPlus V1, V2 (TLS), and V3; synchronous and asyncio clients;
+and a server emulator for testing. The synchronous client additionally supports
+legacy V1 SessionKey authentication; the asyncio client rejects that path
+during connection with an actionable error.
+
+```bash
+pip install s7commplus
+```
+
+```python
+from s7commplus import Client
+
+with Client() as client:
+    client.connect("192.168.1.10", 0, 1)
+    data = client.db_read(1, 0, 4)
+```
+
+S7CommPlus is used by newer S7-1200/1500 PLCs when classic PUT/GET access is
+disabled. This is an unofficial implementation and is not affiliated with,
+endorsed by, or supported by Siemens AG. Test against an isolated controller
+before using it in production or safety-relevant environments.
+
+Some older PLCs advertise only their SessionKey family instead of a complete
+public-key fingerprint. The synchronous `Client` tries the bounded set of
+bundled keys from that family on fresh sessions and caches the confirmed key
+for the PLC. Set `allow_legacy_key_fallback=False` on `connect()` when key
+probing must be disabled.
+
+## Development
+
+```bash
+python -m pip install -e '.[test]'
+pytest
+mypy s7commplus
+ruff check s7commplus tests
+ruff format --check s7commplus tests
+```
+
+Documentation is built by Read the Docs and validated in CI:
+
+```bash
+python -m pip install -e '.[docs]'
+sphinx-build -W --keep-going -b html docs docs/_build/html
+```
+
+The session-authentication implementation derives from HarpoS7; its MIT
+license is included at `s7commplus/session_auth/LICENSE-HarpoS7`.

s7commplus-0.1.0/README.md

@@ -0,0 +1,50 @@
+# s7commplus
+
+Pure-Python S7CommPlus communication for Siemens S7-1200 and S7-1500 PLCs.
+It supports S7CommPlus V1, V2 (TLS), and V3; synchronous and asyncio clients;
+and a server emulator for testing. The synchronous client additionally supports
+legacy V1 SessionKey authentication; the asyncio client rejects that path
+during connection with an actionable error.
+
+```bash
+pip install s7commplus
+```
+
+```python
+from s7commplus import Client
+
+with Client() as client:
+    client.connect("192.168.1.10", 0, 1)
+    data = client.db_read(1, 0, 4)
+```
+
+S7CommPlus is used by newer S7-1200/1500 PLCs when classic PUT/GET access is
+disabled. This is an unofficial implementation and is not affiliated with,
+endorsed by, or supported by Siemens AG. Test against an isolated controller
+before using it in production or safety-relevant environments.
+
+Some older PLCs advertise only their SessionKey family instead of a complete
+public-key fingerprint. The synchronous `Client` tries the bounded set of
+bundled keys from that family on fresh sessions and caches the confirmed key
+for the PLC. Set `allow_legacy_key_fallback=False` on `connect()` when key
+probing must be disabled.
+
+## Development
+
+```bash
+python -m pip install -e '.[test]'
+pytest
+mypy s7commplus
+ruff check s7commplus tests
+ruff format --check s7commplus tests
+```
+
+Documentation is built by Read the Docs and validated in CI:
+
+```bash
+python -m pip install -e '.[docs]'
+sphinx-build -W --keep-going -b html docs docs/_build/html
+```
+
+The session-authentication implementation derives from HarpoS7; its MIT
+license is included at `s7commplus/session_auth/LICENSE-HarpoS7`.

s7commplus-0.1.0/pyproject.toml

@@ -0,0 +1,80 @@
+[build-system]
+requires = ["setuptools>=77"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "s7commplus"
+version = "0.1.0"
+description = "Pure Python S7CommPlus client and server emulator for Siemens S7-1200/1500 PLCs"
+readme = "README.md"
+requires-python = ">=3.10"
+license = "MIT"
+license-files = ["LICENSE", "s7commplus/session_auth/LICENSE-HarpoS7"]
+authors = [{name = "Gijs Molenaar", email = "gijsmolenaar@gmail.com"}]
+keywords = ["s7commplus", "s7", "siemens", "plc", "industrial-automation"]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Intended Audience :: Developers",
+    "Intended Audience :: Manufacturing",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
+    "Topic :: System :: Hardware",
+]
+dependencies = ["cryptography>=41"]
+
+[project.optional-dependencies]
+test = ["pytest", "pytest-asyncio", "pytest-bdd>=8.1,<9", "pytest-cov", "hypothesis", "mypy", "ruff"]
+docs = ["sphinx>=7.2", "furo>=2024.8.6"]
+
+[project.urls]
+Homepage = "https://github.com/gijzelaerr/s7commplus"
+Repository = "https://github.com/gijzelaerr/s7commplus"
+Issues = "https://github.com/gijzelaerr/s7commplus/issues"
+Documentation = "https://s7commplus.readthedocs.io/"
+
+[tool.setuptools.package-data]
+s7commplus = [
+    "py.typed",
+    "session_auth/**/*.bin",
+    "session_auth/ARCHITECTURE.md",
+    "session_auth/LICENSE-HarpoS7",
+    "session_auth/artifacts.json",
+    "zlib_dicts/*.xml",
+]
+
+[tool.setuptools.packages.find]
+include = ["s7commplus*"]
+
+[[tool.uv.index]]
+name = "pypi"
+url = "https://pypi.org/simple"
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+pythonpath = ["."]
+asyncio_mode = "auto"
+markers = [
+    "conformance: protocol conformance tests",
+    "e2e: end-to-end tests requiring a real PLC connection",
+    "real_plc: versioned real-PLC acceptance scenario",
+    "smoke: read-only real-PLC acceptance scenario",
+    "write: real-PLC scenario that changes and restores scratch data",
+    "plc_write: existing real-PLC test that modifies scratch data",
+    "administrative: disruptive real-PLC scenario requiring separate opt-in",
+]
+
+[tool.mypy]
+strict = true
+ignore_missing_imports = true
+
+[tool.ruff]
+line-length = 130
+target-version = "py310"
+
+[tool.ruff.lint]
+select = ["E4", "E7", "E9", "F"]

s7commplus-0.1.0/s7commplus/__init__.py

@@ -0,0 +1,64 @@
+"""S7CommPlus protocol client for S7-1200/1500 PLCs.
+
+Pure Python implementation of the S7CommPlus protocol for direct
+communication with Siemens S7-1200 and S7-1500 PLCs. For legacy
+S7-300/400 PLCs, use ``snap7.Client`` instead.
+
+Usage::
+
+    from s7commplus import Client
+
+    client = Client()
+    client.connect("192.168.1.10")
+    data = client.db_read(1, 0, 4)
+"""
+
+from .async_client import S7CommPlusAsyncClient as AsyncClient
+from .alarm import Alarm, AlarmNotification, AlarmText, LanguageId
+from .blob_decompressor import decompress_blob, find_and_decompress
+from .catalog import ArrayDimension, SymbolCatalog, SymbolicTag, TagResult
+from .client import DBWriteItem, SymbolicReadItem
+from .client import S7CommPlusClient as Client
+from .connection import S7CommPlusConnection
+from .server import CPUState, DataBlock
+from .server import S7CommPlusServer as Server
+from .subscription import SubscriptionItem, SubscriptionNotification
+from .tag_browser import (
+    DataBlock as ExploreDataBlock,
+)
+from .tag_browser import (
+    Member,
+    Tag,
+    block_interface_from_explore,
+    datablocks_from_explore,
+    tags_from_explore,
+)
+
+__all__ = [
+    "Alarm",
+    "AlarmNotification",
+    "AlarmText",
+    "ArrayDimension",
+    "AsyncClient",
+    "CPUState",
+    "Client",
+    "DBWriteItem",
+    "DataBlock",
+    "ExploreDataBlock",
+    "LanguageId",
+    "Member",
+    "S7CommPlusConnection",
+    "Server",
+    "SubscriptionItem",
+    "SubscriptionNotification",
+    "SymbolCatalog",
+    "SymbolicReadItem",
+    "SymbolicTag",
+    "Tag",
+    "TagResult",
+    "block_interface_from_explore",
+    "datablocks_from_explore",
+    "decompress_blob",
+    "find_and_decompress",
+    "tags_from_explore",
+]