python-snap7 3.2.1__tar.gz → 3.3.0__tar.gz

{python_snap7-3.2.1 → python_snap7-3.3.0}/CHANGES.md

@@ -1,6 +1,57 @@
 CHANGES
 ========
 
+3.3.0
+-----
+
+### New features
+
+* Add the typed DB accessors (`db_read_int`, `db_write_real`, `db_read_string`, ...,
+  `db_read_array`/`db_write_array`) and the tag helpers (`read_tag`, `write_tag`,
+  `read_tags`) to `AsyncClient`, matching the synchronous `Client`, as well as
+  `is_alive`, `connect_routed`, and `read_diagnostic_buffer`. (#922)
+
+### Bug fixes
+
+* `get_string` and `get_wstring` now raise `ValueError` when the buffer is shorter than the declared current length,
+  instead of silently returning a truncated value (#945).
+* USERDATA responses whose last-data-unit byte is neither `0x00` nor `0x01` are rejected with `S7ProtocolError`
+  instead of being treated as "more data" (#946).
+* `get_wstring` compared the declared maximum in bytes with the 16382-character limit, so any WSTRING with a
+  capacity of 8192 characters or more was rejected, including ones written by `set_wstring` (#923).
+* The get-block-info request now places the trailing `A` after the block number, as native Snap7 does
+  (`'0' type '00001' 'A'`), instead of before it. The bundled server parses the new layout (#929).
+* `set_plc_datetime` encoded the weekday as Monday=1, but S7 DATE_AND_TIME counts Sunday=1 .. Saturday=7, so every
+  day was off by one position. The bundled server's clock reply uses the same convention now (#932).
+* `set_plc_datetime` now raises `ValueError` for years outside 1990-2089 instead of silently sending a different
+  year, since the two-digit S7 year cannot represent them (#933).
+* `parse_get_clock_response` now accepts the ten-byte S7 clock reply (reserved, century, then the time with milliseconds)
+  that native Snap7 and PLCs send, and still accepts the legacy eight-byte form. The bundled server emits the
+  ten-byte form (#934).
+* `parse_response` now fails on any nonzero S7 header error word, as native Snap7 does, instead of only when the error
+  class is nonzero. Read and upload responses with error class 0 and a nonzero error code were previously treated as
+  successes while the write path rejected them (#930).
+* `parse_list_blocks_response` now requires exactly the seven four-byte block-type entries (28 bytes) that native Snap7
+  expects, with distinct, known type codes. Empty or partial tables and duplicate entries are rejected instead of being
+  reported as zero block counts (#939).
+* `set_plc_datetime` and the session-password calls now accept the null acknowledgement (return code 0x0A, no data) that
+  real PLCs send for services that return no data, instead of failing with "Object does not exist". The bundled
+  server acknowledges these services the same way (#940).
+* Compress now uses the PI service `_GARB` and copy RAM to ROM uses file system `EP` with `_MODU`, matching real
+  engineering tools and native Snap7, instead of the invented `_MSZL`. The bundled server recognises the new
+  requests (#941).
+* Read-SZL requests now carry the `0xFF`/octet-string data header and continuation requests the 12-byte parameter
+  block (method `0x12`) that real engineering tools send; both previously used the header of a request without data
+  and an 8-byte parameter block (#942).
+* `get_order_code` no longer keeps the trailing space padding of the order code on S7-1200/1500 CPUs, for example
+  `6ES7 212-1BE40-0XB0 ` is now `6ES7 212-1BE40-0XB0` (#949).
+
+### Documentation
+
+* Add a "Tested and Verified Hardware" section to the PLC support matrix, listing the CPUs, firmware versions and
+  python-snap7 versions the real-PLC acceptance suite has passed on (S7-1200 CPU 1212C V4.7.3, S7-1500 CPU 1511F-1 PN
+  V2.9.7). (#947)
+
 3.2.1
 -----
 

{python_snap7-3.2.1/python_snap7.egg-info → python_snap7-3.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-snap7
-Version: 3.2.1
+Version: 3.3.0
 Summary: Pure Python S7 communication library for Siemens PLCs
 Author-email: Gijs Molenaar <gijsmolenaar@gmail.com>
 License-Expression: MIT
@@ -24,7 +24,7 @@ License-File: LICENSE
 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-bdd<10,>=8.1; extra == "test"
 Requires-Dist: pytest-cov; extra == "test"
 Requires-Dist: pytest-html; extra == "test"
 Requires-Dist: hypothesis; extra == "test"
@@ -75,6 +75,26 @@ using the classic S7 protocol. It supports S7-300 and S7-400 controllers, as
 well as S7-1200 and S7-1500 controllers with PUT/GET access enabled. It
 supports Python 3.10+ on Windows, Linux, and macOS without native dependencies.
 
+S7-1200 and S7-1500
+===================
+
+On S7-1200 and S7-1500 controllers, python-snap7 only works when PUT/GET access
+is enabled in TIA Portal, and it cannot access optimized data blocks. PUT/GET
+is unauthenticated and disabled by default, so leaving it disabled is the more
+secure configuration.
+
+If PUT/GET is disabled, or you need optimized data blocks or symbolic access,
+use `s7commplus <https://github.com/gijzelaerr/s7commplus>`_ instead::
+
+   pip install s7commplus
+
+s7commplus is a separate, younger project that implements S7CommPlus, the
+protocol these controllers speak natively. Check the
+`firmware versions validated so far <https://s7commplus.readthedocs.io/en/latest/connections.html>`_
+before relying on it, and see the
+`PLC support matrix <https://python-snap7.readthedocs.io/en/latest/plc-support.html>`_
+for what python-snap7 supports on each controller family.
+
 Installation
 ============
 
@@ -105,3 +125,5 @@ Read the full documentation at
 
 The safe volunteer hardware-test procedure is in
 `Real-PLC acceptance testing <doc/real-plc-testing.rst>`_.
+The CPUs and firmware versions it has passed on are listed under
+`Tested and Verified Hardware <doc/plc-support.rst>`_.

{python_snap7-3.2.1 → python_snap7-3.3.0}/README.rst

@@ -22,6 +22,26 @@ using the classic S7 protocol. It supports S7-300 and S7-400 controllers, as
 well as S7-1200 and S7-1500 controllers with PUT/GET access enabled. It
 supports Python 3.10+ on Windows, Linux, and macOS without native dependencies.
 
+S7-1200 and S7-1500
+===================
+
+On S7-1200 and S7-1500 controllers, python-snap7 only works when PUT/GET access
+is enabled in TIA Portal, and it cannot access optimized data blocks. PUT/GET
+is unauthenticated and disabled by default, so leaving it disabled is the more
+secure configuration.
+
+If PUT/GET is disabled, or you need optimized data blocks or symbolic access,
+use `s7commplus <https://github.com/gijzelaerr/s7commplus>`_ instead::
+
+   pip install s7commplus
+
+s7commplus is a separate, younger project that implements S7CommPlus, the
+protocol these controllers speak natively. Check the
+`firmware versions validated so far <https://s7commplus.readthedocs.io/en/latest/connections.html>`_
+before relying on it, and see the
+`PLC support matrix <https://python-snap7.readthedocs.io/en/latest/plc-support.html>`_
+for what python-snap7 supports on each controller family.
+
 Installation
 ============
 
@@ -52,3 +72,5 @@ Read the full documentation at
 
 The safe volunteer hardware-test procedure is in
 `Real-PLC acceptance testing <doc/real-plc-testing.rst>`_.
+The CPUs and firmware versions it has passed on are listed under
+`Tested and Verified Hardware <doc/plc-support.rst>`_.

{python_snap7-3.2.1 → python_snap7-3.3.0}/doc/plc-support.rst

@@ -52,6 +52,53 @@ Supported PLCs
      - Full
      - Use the :class:`~snap7.logo.Logo` class.
 
+.. _tested-hardware:
+
+Tested and Verified Hardware
+----------------------------
+
+The table lists real CPUs the :doc:`real-plc-testing` acceptance suite has been
+run against, with the firmware and python-snap7 version used. Every run reached
+the CPU over the classic S7 protocol with PUT/GET enabled and non-optimized
+fixture data blocks. A pass means the 13 acceptance scenarios succeeded: five
+read-only smoke scenarios (session, canonical fixture read, multi-read,
+reconnect, repeated operations) and eight scratch-write round trips (INT, REAL,
+BYTE, WORD, DWORD, DINT, CHAR, BOOL), each restored and read back.
+
+.. list-table::
+   :header-rows: 1
+   :widths: 20 12 12 14 12 30
+
+   * - CPU
+     - Firmware
+     - Result
+     - python-snap7
+     - Date
+     - Report
+   * - S7-1200 CPU 1212C (``6ES7 212-1BE40-0XB0``)
+     - V4.7.3
+     - 13/13 pass
+     - 3.2.1
+     - 2026-10-04
+     - `#919 <https://github.com/gijzelaerr/python-snap7/issues/919>`_
+       (rerun of `#907 <https://github.com/gijzelaerr/python-snap7/issues/907>`_)
+   * - S7-1500 CPU 1511F-1 PN (fail-safe) (``6ES7 511-1FK02-0AB0``)
+     - V2.9.7
+     - 13/13 pass
+     - 3.2.1
+     - 2026-10-13
+     - `#952 <https://github.com/gijzelaerr/python-snap7/issues/952>`_
+       (rerun of `#909 <https://github.com/gijzelaerr/python-snap7/issues/909>`_,
+       python-snap7 3.2.0, 2026-10-01)
+
+Notes:
+
+- On the S7-1200 CPU 1212C, ``upload()`` of a non-optimized DB is refused with
+  class 0x81, code 0x04 (see Feature Availability below). Block upload and
+  download were not run on the S7-1500 CPU 1511F-1 PN.
+- Administrative scenarios (``--allow-admin``) were not run.
+- To add your CPU, follow the result policy in :doc:`real-plc-testing`.
+
 Enabling PUT/GET Access
 -----------------------
 
@@ -59,6 +106,25 @@ For S7-1200 and S7-1500 PLCs, classic S7 protocol access requires the
 **PUT/GET** option to be enabled. See :doc:`tia-portal-config` for
 step-by-step instructions.
 
+.. note::
+
+   S7-1200 and S7-1500 CPUs natively speak **S7CommPlus**, the protocol TIA
+   Portal itself uses. python-snap7 does not implement it. What it uses on
+   these CPUs is the classic S7 protocol, which the CPU only serves as a
+   compatibility feature (PUT/GET). That compatibility path is deliberately
+   limited:
+
+   - it only reaches non-optimized data blocks and the I/O, marker, timer and
+     counter areas, so symbolic access to optimized DBs is not possible;
+   - program blocks (OB/FC/FB) and block upload/download are generally
+     refused, and the project source is never available;
+   - it has no authentication, which is why Siemens disables it by default.
+
+   If you need optimized DBs, symbolic access or any of the above, use an
+   S7CommPlus client such as the standalone
+   `s7commplus project <https://github.com/gijzelaerr/s7commplus>`_, OPC UA,
+   or TIA Portal Openness, rather than trying to make python-snap7 do it.
+
 .. warning::
 
    PUT/GET access provides unauthenticated read/write access to PLC memory.

{python_snap7-3.2.1 → python_snap7-3.3.0}/doc/real-plc-testing.rst

@@ -87,3 +87,6 @@ before expanding the host matrix; hosted CI already covers supported Python
 versions and operating systems without hardware. Test evidence stays in issues.
 Volunteer coordination may use Discussions, but is not a substitute for an
 attached structured result.
+
+Passing results are summarized, with CPU, firmware and python-snap7 version, in
+:ref:`tested-hardware`.

{python_snap7-3.2.1 → python_snap7-3.3.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "python-snap7"
-version = "3.2.1"
+version = "3.3.0"
 description = "Pure Python S7 communication library for Siemens PLCs"
 readme = "README.rst"
 authors = [
@@ -32,7 +32,7 @@ Homepage = "https://github.com/gijzelaerr/python-snap7"
 Documentation = "https://python-snap7.readthedocs.io/en/latest/"
 
 [project.optional-dependencies]
-test = ["pytest", "pytest-asyncio", "pytest-bdd>=8.1,<9", "pytest-cov", "pytest-html", "hypothesis", "mypy", "types-setuptools", "ruff", "tox", "tox-uv", "types-click", "uv"]
+test = ["pytest", "pytest-asyncio", "pytest-bdd>=8.1,<10", "pytest-cov", "pytest-html", "hypothesis", "mypy", "types-setuptools", "ruff", "tox", "tox-uv", "types-click", "uv"]
 cli = ["rich", "click" ]
 demo = ["psutil", "rich", "click"]
 doc = ["sphinx", "sphinx_rtd_theme"]

{python_snap7-3.2.1 → python_snap7-3.3.0/python_snap7.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-snap7
-Version: 3.2.1
+Version: 3.3.0
 Summary: Pure Python S7 communication library for Siemens PLCs
 Author-email: Gijs Molenaar <gijsmolenaar@gmail.com>
 License-Expression: MIT
@@ -24,7 +24,7 @@ License-File: LICENSE
 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-bdd<10,>=8.1; extra == "test"
 Requires-Dist: pytest-cov; extra == "test"
 Requires-Dist: pytest-html; extra == "test"
 Requires-Dist: hypothesis; extra == "test"
@@ -75,6 +75,26 @@ using the classic S7 protocol. It supports S7-300 and S7-400 controllers, as
 well as S7-1200 and S7-1500 controllers with PUT/GET access enabled. It
 supports Python 3.10+ on Windows, Linux, and macOS without native dependencies.
 
+S7-1200 and S7-1500
+===================
+
+On S7-1200 and S7-1500 controllers, python-snap7 only works when PUT/GET access
+is enabled in TIA Portal, and it cannot access optimized data blocks. PUT/GET
+is unauthenticated and disabled by default, so leaving it disabled is the more
+secure configuration.
+
+If PUT/GET is disabled, or you need optimized data blocks or symbolic access,
+use `s7commplus <https://github.com/gijzelaerr/s7commplus>`_ instead::
+
+   pip install s7commplus
+
+s7commplus is a separate, younger project that implements S7CommPlus, the
+protocol these controllers speak natively. Check the
+`firmware versions validated so far <https://s7commplus.readthedocs.io/en/latest/connections.html>`_
+before relying on it, and see the
+`PLC support matrix <https://python-snap7.readthedocs.io/en/latest/plc-support.html>`_
+for what python-snap7 supports on each controller family.
+
 Installation
 ============
 
@@ -105,3 +125,5 @@ Read the full documentation at
 
 The safe volunteer hardware-test procedure is in
 `Real-PLC acceptance testing <doc/real-plc-testing.rst>`_.
+The CPUs and firmware versions it has passed on are listed under
+`Tested and Verified Hardware <doc/plc-support.rst>`_.

{python_snap7-3.2.1 → python_snap7-3.3.0}/python_snap7.egg-info/SOURCES.txt

@@ -92,6 +92,7 @@ tests/__init__.py
 tests/conftest.py
 tests/test_api_surface.py
 tests/test_async_client.py
+tests/test_async_typed_access.py
 tests/test_behavioral_compatibility.py
 tests/test_cli.py
 tests/test_client.py

{python_snap7-3.2.1 → python_snap7-3.3.0}/python_snap7.egg-info/requires.txt

@@ -21,7 +21,7 @@ pyserial>=3.5
 [test]
 pytest
 pytest-asyncio
-pytest-bdd<9,>=8.1
+pytest-bdd<10,>=8.1
 pytest-cov
 pytest-html
 hypothesis