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

python_snap7-3.2.1/CHANGES.md

@@ -0,0 +1,373 @@
+CHANGES
+========
+
+3.2.1
+-----
+
+Bug-fix and packaging release, with a few small additions.
+
+### Packaging
+
+* Include the full test suite (`tests/__init__.py`, `tests/conftest.py`, PLC setup
+  files), examples, docs, and `CHANGES.md` in the source distribution (#912, #913).
+* Remove leftover HarpoS7 test fixtures and transpiler from the S7CommPlus
+  split (#914).
+
+### New features
+
+* Add an `on_operation` callback to the synchronous and asynchronous clients,
+  invoked after each PLC operation with its name, duration, and whether it
+  raised, plus an example Prometheus metrics exporter (#843, #901).
+* Add a safe, Gherkin-based real-PLC acceptance program with restored scratch
+  writes and sanitized JSON/JUnit reports (#840, #892, #908).
+
+### Bug fixes
+
+* Match the classic Snap7 upload wire layout, collect every upload fragment, and
+  reject malformed, truncated, or mismatched S7/USERDATA responses (#903).
+* Use the PLC-driven request/response sequence for block download and match
+  classic S7 wire vectors for list-blocks-of-type, set clock, get block info,
+  and password requests (#904).
+* Fix the return type annotations of `snap7.util.get_byte` and `get_word`, which
+  return `int`, not `bytes`/`bytearray` (#910).
+
+3.2.0
+-----
+
+Feature and robustness release for the classic S7 protocol implementation.
+
+### Packaging
+
+* Move S7CommPlus support to the standalone
+  [`s7commplus`](https://github.com/gijzelaerr/s7commplus) package. The `s7`
+  import remains available as an alias for the classic `snap7` package.
+
+### New features
+
+* Add configurable request rate limiting to synchronous and asynchronous
+  clients, including fixed-interval and token-bucket modes (#823).
+* Add synchronous and asynchronous APIs for forcing I/O bits, cancelling
+  forces, and reading the PLC force table (#796, #800).
+* Add synchronous and asynchronous session password set/clear APIs for
+  password-protected PLCs (#792, #799).
+* Support LOGO reconnection, heartbeat, rate-limiting, and connection callback
+  options while preserving explicit TSAPs (#875).
+* Add an experimental serial PPI client for S7-200 PLCs, including V-memory,
+  system-memory, I/O, counter, and timer access (#824).
+
+### Bug fixes
+
+* Parse structured and flat SZL 0x0011 records correctly when reading order
+  codes and firmware versions from S7-1500 and classic PLCs (#783, #789).
+* Dispatch server callbacks and queue protocol events for client requests
+  instead of reporting only the server start event (#853, #856).
+* Validate classic S7 TPKT bounds and COTP Class 0 headers in synchronous and
+  asynchronous clients (#874).
+* Reject incomplete reads and mismatched or missing read/write
+  acknowledgements (#874).
+* Size read/write chunks in whole elements and preserve ctypes write
+  datatypes; correct BIT lengths and timer/counter index addressing (#874).
+* Validate `write_multi_vars()` inputs consistently and preserve each item's
+  declared datatype (#855, #874).
+* Echo the calling and called TSAP values in server connection confirmations,
+  and restart the receive deadline after each complete TPKT header (#893).
+* Return S7 item errors for reads from unregistered server areas or addresses
+  outside registered memory instead of returning fabricated data (#896).
+
+3.1.2
+-----
+
+Corrective bug fix and robustness release replacing the yanked 3.1.1 release.
+
+### Corrections
+
+* Withdraw the vulnerability and CWE characterizations published with 3.1.1.
+  Independent review found that those descriptions overstated or incorrectly
+  described the affected code paths.
+
+### Robustness fixes
+
+* Bound the server to 64 simultaneous clients by default, enforce the existing
+  `MaxClients` parameter, and allow `max_clients` configuration.
+* Validate block-download targets and declared sizes before allocating transfer
+  state, cap accumulated data at the declared size and registered area's
+  capacity, and clean up abandoned upload/download state on disconnect.
+* Correct block-download address parsing so the requested DB number is used
+  instead of silently falling back to DB1.
+* Bound COTP request reassembly to 1 MiB and apply one absolute deadline across
+  all fragments of a request.
+* Apply COTP TPDU-size validation consistently to sync and async clients.
+* Add regression tests for invalid PDU negotiation, TPDU-size validation,
+  connection limits, request reassembly, and block-download limits.
+
+3.1.1 (yanked)
+----------------
+
+This release was yanked because its security descriptions were inaccurate and
+some of its input-hardening changes were incomplete. Use 3.1.2 instead.
+
+### Robustness changes
+
+* Validate COTP TPDU-size encodings in the synchronous client.
+* Normalize implausibly small negotiated PDU lengths and ensure read/write
+  chunk sizes remain positive.
+* Stop finalizing downloads into unregistered server memory areas. This did not
+  bound the download accumulator and was completed in 3.1.2.
+
+### Bug fixes
+
+* Fix `connection_type` not applied in TSAP composition during
+  `connect()` (#766)
+* Fix auto-reconnect not triggered on multi-block read path (#787)
+* Support multi-byte string encodings (GBK, UTF-8) in `get_string`,
+  `set_string`, `get_fstring`, `set_fstring` (#788)
+* Thread encoding parameter through `read_tag` / `write_tag` /
+  `read_tags` (#786)
+* Server: reassemble COTP-fragmented requests; include TPDU size
+  parameter in Connection Confirm so clients don't fall back to the
+  128-byte ISO 8073 default (#804)
+* Server: fix `INT` and `DINT` word lengths returning wrong byte count
+  in read requests (#804)
+
+### Thanks
+
+* [@b1163646804](https://github.com/b1163646804) — multi-byte encoding
+  support and testing (#788)
+* [@domelg](https://github.com/domelg) — server COTP fragmentation and
+  INT/DINT byte count bug reports (#804)
+
+3.1.0
+-----
+
+Feature and bug fix release for the pure Python S7 communication library.
+
+### New features
+
+* **AsyncClient** for `asyncio` support (#593)
+* **Unified Tag API**: `client.read_tag("DB1.DBD0:REAL")` with PLC4X /
+  Siemens STEP7 syntax (#697)
+* **Dual-dialect tag parsing**: PLC4X and nodeS7 tag formats with
+  auto-detection (#701)
+* **Multi-variable read optimizer** with parallel dispatch (experimental, #641)
+* **S7 routing** for multi-subnet PLC access (experimental, #639)
+* **Heartbeat monitoring** and auto-reconnect with exponential backoff (#635)
+* **Structured logging** with PLC connection context (`snap7.log`, #688)
+* **PROFINET DCP** network discovery (#634)
+* **CLI tools** for PLC interaction (`pip install "python-snap7[cli]"`, #631)
+* **Demo server** exposing real host metrics (#704)
+* Typed DB access methods (`db_read_bool`, `db_read_int`, etc., #632)
+* Symbolic addressing — read/write by tag name (experimental, #638)
+* Diagnostic buffer reading (#690)
+* Array read/write helpers (`db_read_array`, `db_write_array`, #693)
+* Missing data type setters: `set_lint`, `set_ulint`, `set_ltime`, `set_ltod`, `set_ldt` (#693)
+* Property-based testing with Hypothesis (#636)
+
+### Bug fixes
+
+* Fix `AttributeError` from `__del__` during interpreter shutdown (#707)
+* Fix server SZL 0x001C response to match real PLC format (#694)
+* Fix `connection_type` in TSAP composition during connect (#766)
+* Accept `memoryview` in setter and getter type annotations (#647)
+* Zero-pad milliseconds in `get_time` (#716)
+* Fix PI service PDU format for PLC control commands (#743)
+* Fix `get_cpu_info` and `S7SZL.__str__` (#692)
+* Fix partner S7 Communication Setup and bsend/brecv PDU format (#669)
+* Fix `get_dtl` microsecond parsing (4-byte nanosecond field)
+* Fix `set_date` unsigned short for day count
+* Fix `set_tod` float precision loss
+* Validate BMP range in `set_wstring`
+* Fix async `get_cpu_info` SZL offsets (#702)
+* Fix demo primary-IP guess with VPN/tunnel interfaces (#708)
+* Fix mypy errors in server SZL list (#695)
+* Robustness: 210+ S7 error codes, auto PDU splitting, stale packet retry (#580)
+
+### Improvements
+
+* Set `TCP_NODELAY` and `SO_KEEPALIVE` on all sockets (#677)
+* Export `get_ulint`, `get_lint`, `get_date_time_object` from `snap7.util` (#652)
+* Documentation restructured: API Reference + Internals sections
+
+### Thanks
+
+* [@hs2bws-hash](https://github.com/hs2bws-hash) — extensive real PLC testing of Partner BSend/BRecv (#668)
+* [@QuakeString](https://github.com/QuakeString) — read optimizer inspiration via python-snap7-optimized fork
+
+3.0.0
+-----
+
+Major release: python-snap7 is now a pure Python S7 communication library.
+This version completely breaks with the previous approach of wrapping the C snap7
+shared library. The entire S7 protocol stack is now implemented in pure Python,
+greatly improving portability and making it easier to install and extend.
+
+* **Breaking**: The C snap7 library is no longer required or used
+* Complete rewrite of the S7 protocol stack in pure Python
+* Native Python implementation of TPKT (RFC 1006) and COTP (ISO 8073) layers
+* Native S7 protocol PDU encoding/decoding
+* Pure Python server implementation for testing and simulation
+* No platform-specific binary dependencies — works on any platform that runs Python
+* Improved error handling and connection management
+* Full type annotations with mypy strict mode
+* CLI interface for running an S7 server emulator (`pip install "python-snap7[cli]"`)
+
+If you experience issues with 3.0, please report them on the
+[issue tracker](https://github.com/gijzelaerr/python-snap7/issues) with a clear
+description and the version you are using. As a workaround, pin to the last
+pre-3.0 release:
+
+    $ pip install "python-snap7<3"
+
+### Thanks
+
+Special thanks to the following people for testing, reporting issues, and providing
+feedback during the 3.0 development:
+
+* [@lupaulus](https://github.com/lupaulus) — extensive testing and bug reports
+* [@spreeker](https://github.com/spreeker) — testing and feedback
+* [@nikteliy](https://github.com/nikteliy) — review and feedback on the rewrite
+* [@amorelettronico](https://github.com/amorelettronico) — testing
+* [@razour08](https://github.com/razour08) — testing
+* [@core-engineering](https://github.com/core-engineering) — bug reports (#553)
+* [@AndreasScharf](https://github.com/AndreasScharf) — bug reports (#572)
+* [@Robatronic](https://github.com/Robatronic) — bug reports (#574)
+* [@hirotasoshu](https://github.com/hirotasoshu) — feedback (#545)
+* [@PoitrasJ](https://github.com/PoitrasJ) — bug reports (#479)
+
+1.2
+---
+
+* fix wheel tag for linux x86_64 by @nikteliy in https://github.com/gijzelaerr/python-snap7/pull/297
+* Fixed typo area doesn't exist areas does by @Ofloo in https://github.com/gijzelaerr/python-snap7/pull/306
+* add get_time and set_time in util by @Yingliangzhe in https://github.com/gijzelaerr/python-snap7/pull/308
+* modification of TIME data type by @Yingliangzhe in https://github.com/gijzelaerr/python-snap7/pull/311
+* added DATE_AND_TIME Value as Datetime object by @zsisamci in https://github.com/gijzelaerr/python-snap7/pull/312
+* #273 by @nikteliy in https://github.com/gijzelaerr/python-snap7/pull/321
+* Add byte type parsing to DB_Row API + set parsing case insensitive by @LoicGRENON in https://github.com/gijzelaerr/python-snap7/pull/315
+* added missing types in  WordLen by @zsisamci in https://github.com/gijzelaerr/python-snap7/pull/326
+* Add support for read/write unsigned value from bytearray by @LoicGRENON in https://github.com/gijzelaerr/python-snap7/pull/316
+* fixing ip string paramters to c function by @zsisamci in https://github.com/gijzelaerr/python-snap7/pull/329
+* Add py.typed marker file by @mthuurne in https://github.com/gijzelaerr/python-snap7/pull/342
+* require correct package name, fixes issue #344 by @gijzelaerr in https://github.com/gijzelaerr/python-snap7/pull/345
+* Fix warnings by @nikteliy in https://github.com/gijzelaerr/python-snap7/pull/350
+* Update license identifier by @Shortfinga in https://github.com/gijzelaerr/python-snap7/pull/349
+* Update client db_write docs by @pwablito in https://github.com/gijzelaerr/python-snap7/pull/352
+* Fix db_offset calculation error by @lubbbert in https://github.com/gijzelaerr/python-snap7/pull/351
+* fix #355 by @swamper123 in https://github.com/gijzelaerr/python-snap7/pull/359
+* fix #272 by @swamper123 in https://github.com/gijzelaerr/python-snap7/pull/360
+* fix get_time for small values by @swamper123 in https://github.com/gijzelaerr/python-snap7/pull/358
+* add more getter methods for utils by @swamper123 in https://github.com/gijzelaerr/python-snap7/pull/357
+* Prepare for 1.2 by @gijzelaerr in https://github.com/gijzelaerr/python-snap7/pull/364
+
+### New Contributors
+
+* @Ofloo made their first contribution in https://github.com/gijzelaerr/python-snap7/pull/306
+* @zsisamci made their first contribution in https://github.com/gijzelaerr/python-snap7/pull/312
+* @LoicGRENON made their first contribution in https://github.com/gijzelaerr/python-snap7/pull/315
+* @mthuurne made their first contribution in https://github.com/gijzelaerr/python-snap7/pull/342
+* @Shortfinga made their first contribution in https://github.com/gijzelaerr/python-snap7/pull/349
+* @pwablito made their first contribution in https://github.com/gijzelaerr/python-snap7/pull/352
+* @lubbbert made their first contribution in https://github.com/gijzelaerr/python-snap7/pull/351
+
+**Full Changelog**: https://github.com/gijzelaerr/python-snap7/compare/1.1...1.2
+
+1.1
+---
+
+* Make a binary wheel for all platforms (#232)
+* Improve doc strings of all functions (#242)
+
+Special thanks for this release to
+ * Fabian Beitler
+ * Nikteliy
+ * Lautaro Nahuel Dapino
+
+1.0
+---
+
+ *  Drop python 2 support  (#214)
+ *  Feature request: ReadSZL()  (#196)
+ *  Keep argument format across the functions  (#193)
+ *  Drop Python2 Tests  (#167)
+ *  Support for S5TIME  (#163)
+ *  Add type annotations  (#157)
+ *  client.full_upload() return bytearray size 65536  (#127)
+ *  Some client tests segfault on Linux  (#26)
+ *  Not all functions are implemented yet  (#25)
+
+special thanks to [Fabian Beitler](https://github.com/swamper123) and
+[Nikteliy](https://github.com/nikteliy>) for their contributions to the 1.0 release!
+
+
+
+
+0.11
+----
+
+ * Update read_multi.py (#132)
+ * Added fixes to snap7/client.py read_area function to allow for Counter and Timer Reads  (#121)
+ * Post to a public docker repository? (#119)
+ * Implementation of Cli_SetDateTime, Cli_GetDateTime enhancement (#114)
+
+
+0.10
+----
+
+ * Fix OSX travis build #99
+ * util.get_int() broken #101
+ * Compatibility issue with Python3 #109
+ * Logo 8 improvements bug #105
+
+
+0.7
+---
+
+* util.get_int() broken (#65, #71)
+* fix Add files via upload bug (#59)
+
+Special thanks to Pelle van der Heide for solving issues
+
+
+0.6
+---
+
+* Add __del__ to client, server and partner (#69)
+* Add files via upload (#59)
+
+Special thanks to xybsoft for solving issues
+
+0.5
+---
+
+* adding some missing functions
+* fixing Python3 support (issue #43)
+* improving the documentation
+
+0.4
+---
+
+More functions added:
+
+* client.plc_stop
+* client.plc_cold_start
+* client.plc_hot_start
+* client.read_multi_vars
+
+0.2.1
+-----
+
+Small fix, README.rst was not included in sdist
+
+
+0.2
+---
+
+- Add support for Windows
+- Add functions added in Snap7 1.1.0
+- Add missing client functions
+- fix some partner functions
+- simplified API
+
+0.1
+---
+
+- Initial release.

python_snap7-3.2.1/MANIFEST.in

@@ -0,0 +1,9 @@
+include README.rst
+include CHANGES.md
+include LICENSE
+include tox.ini
+graft tests
+prune tests/fixtures
+graft example
+graft doc
+global-exclude *.py[cod] __pycache__

python_snap7-3.2.1/PKG-INFO

@@ -0,0 +1,107 @@
+Metadata-Version: 2.4
+Name: python-snap7
+Version: 3.2.1
+Summary: Pure Python S7 communication library for Siemens PLCs
+Author-email: Gijs Molenaar <gijsmolenaar@gmail.com>
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/gijzelaerr/python-snap7
+Project-URL: Documentation, https://python-snap7.readthedocs.io/en/latest/
+Keywords: snap7,s7,siemens,plc
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Environment :: Console
+Classifier: Topic :: System :: Hardware
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Manufacturing
+Classifier: Operating System :: POSIX
+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
+Requires-Python: >=3.10
+Description-Content-Type: text/x-rst
+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-cov; extra == "test"
+Requires-Dist: pytest-html; extra == "test"
+Requires-Dist: hypothesis; extra == "test"
+Requires-Dist: mypy; extra == "test"
+Requires-Dist: types-setuptools; extra == "test"
+Requires-Dist: ruff; extra == "test"
+Requires-Dist: tox; extra == "test"
+Requires-Dist: tox-uv; extra == "test"
+Requires-Dist: types-click; extra == "test"
+Requires-Dist: uv; extra == "test"
+Provides-Extra: cli
+Requires-Dist: rich; extra == "cli"
+Requires-Dist: click; extra == "cli"
+Provides-Extra: demo
+Requires-Dist: psutil; extra == "demo"
+Requires-Dist: rich; extra == "demo"
+Requires-Dist: click; extra == "demo"
+Provides-Extra: doc
+Requires-Dist: sphinx; extra == "doc"
+Requires-Dist: sphinx_rtd_theme; extra == "doc"
+Provides-Extra: discovery
+Requires-Dist: pnio-dcp; extra == "discovery"
+Provides-Extra: ppi
+Requires-Dist: pyserial>=3.5; extra == "ppi"
+Dynamic: license-file
+
+.. image:: https://img.shields.io/pypi/v/python-snap7.svg
+   :target: https://pypi.org/project/python-snap7/
+
+.. image:: https://img.shields.io/pypi/pyversions/python-snap7.svg
+   :target: https://pypi.org/project/python-snap7/
+
+.. image:: https://img.shields.io/github/license/gijzelaerr/python-snap7.svg
+   :target: https://github.com/gijzelaerr/python-snap7/blob/master/LICENSE
+
+.. image:: https://github.com/gijzelaerr/python-snap7/actions/workflows/test.yml/badge.svg
+   :target: https://github.com/gijzelaerr/python-snap7/actions/workflows/test.yml
+
+.. image:: https://readthedocs.org/projects/python-snap7/badge/
+   :target: https://python-snap7.readthedocs.io/en/latest/
+
+
+python-snap7
+============
+
+python-snap7 is a pure-Python library for communicating with Siemens S7 PLCs
+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.
+
+Installation
+============
+
+Install from PyPI::
+
+   pip install python-snap7
+
+Quick start
+===========
+
+::
+
+   from s7 import Client
+
+   client = Client()
+   client.connect("192.168.1.10", 0, 1)
+   data = client.db_read(1, 0, 4)
+   client.disconnect()
+
+The ``s7`` package is the recommended import. The ``snap7`` package name is
+also available for backwards compatibility.
+
+Documentation
+=============
+
+Read the full documentation at
+`python-snap7.readthedocs.io <https://python-snap7.readthedocs.io/en/latest/>`_.
+
+The safe volunteer hardware-test procedure is in
+`Real-PLC acceptance testing <doc/real-plc-testing.rst>`_.

python_snap7-3.2.1/README.rst

@@ -0,0 +1,54 @@
+.. image:: https://img.shields.io/pypi/v/python-snap7.svg
+   :target: https://pypi.org/project/python-snap7/
+
+.. image:: https://img.shields.io/pypi/pyversions/python-snap7.svg
+   :target: https://pypi.org/project/python-snap7/
+
+.. image:: https://img.shields.io/github/license/gijzelaerr/python-snap7.svg
+   :target: https://github.com/gijzelaerr/python-snap7/blob/master/LICENSE
+
+.. image:: https://github.com/gijzelaerr/python-snap7/actions/workflows/test.yml/badge.svg
+   :target: https://github.com/gijzelaerr/python-snap7/actions/workflows/test.yml
+
+.. image:: https://readthedocs.org/projects/python-snap7/badge/
+   :target: https://python-snap7.readthedocs.io/en/latest/
+
+
+python-snap7
+============
+
+python-snap7 is a pure-Python library for communicating with Siemens S7 PLCs
+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.
+
+Installation
+============
+
+Install from PyPI::
+
+   pip install python-snap7
+
+Quick start
+===========
+
+::
+
+   from s7 import Client
+
+   client = Client()
+   client.connect("192.168.1.10", 0, 1)
+   data = client.db_read(1, 0, 4)
+   client.disconnect()
+
+The ``s7`` package is the recommended import. The ``snap7`` package name is
+also available for backwards compatibility.
+
+Documentation
+=============
+
+Read the full documentation at
+`python-snap7.readthedocs.io <https://python-snap7.readthedocs.io/en/latest/>`_.
+
+The safe volunteer hardware-test procedure is in
+`Real-PLC acceptance testing <doc/real-plc-testing.rst>`_.

python_snap7-3.2.1/doc/API/client-base.rst

@@ -0,0 +1,9 @@
+Shared Client Internals
+=======================
+
+Pure-computation and compatibility methods shared by ``Client`` and
+``AsyncClient``. Applications normally access these methods through one of the
+concrete clients.
+
+.. automodule:: snap7.client_base
+   :members:

python_snap7-3.2.1/doc/API/client.rst

@@ -0,0 +1,45 @@
+Client
+======
+
+The ``s7`` package implements the classic S7 protocol for S7-300/400 PLCs and
+PUT/GET access on S7-1200/1500.
+
+Use ``Client`` for synchronous applications::
+
+   from s7 import Client
+
+   with Client() as client:
+       client.connect("192.168.1.10", 0, 1)
+       data = client.db_read(1, 0, 4)
+
+Use ``AsyncClient`` when the surrounding application uses ``asyncio``::
+
+   import asyncio
+   from s7 import AsyncClient
+
+   async def main():
+       async with AsyncClient() as client:
+           await client.connect("192.168.1.10", 0, 1)
+           data = await client.db_read(1, 0, 4)
+
+   asyncio.run(main())
+
+Both clients expose the same main PLC operations, including area and DB
+access, block transfer, CPU information and control, clock access, force
+operations, and session passwords. Methods that perform I/O are coroutines on
+``AsyncClient``. See :doc:`../advanced` for the less common operations.
+
+s7.Client
+---------
+
+.. automodule:: snap7.client
+   :members:
+   :inherited-members:
+
+s7.AsyncClient
+--------------
+
+.. automodule:: snap7.async_client
+   :members:
+   :inherited-members:
+   :exclude-members: AsyncISOTCPConnection

python_snap7-3.2.1/doc/API/connection.rst

@@ -0,0 +1,8 @@
+Connection
+==========
+
+The connection module implements the ISO on TCP transport layer (TPKT/COTP)
+used for S7 communication.
+
+.. automodule:: snap7.connection
+   :members:

python_snap7-3.2.1/doc/API/datatypes.rst

@@ -0,0 +1,7 @@
+Data Types
+==========
+
+The datatypes module provides S7 data type definitions and address encoding.
+
+.. automodule:: snap7.datatypes
+   :members:

python_snap7-3.2.1/doc/API/demo.rst

@@ -0,0 +1,9 @@
+Demo Server
+===========
+
+Implementation of the optional live host-metrics demo used by ``s7 demo``.
+Install ``python-snap7[demo]`` before running it. This module is intended for
+examples and integration testing, not production monitoring.
+
+.. automodule:: snap7.demo
+   :members:

python_snap7-3.2.1/doc/API/discovery.rst

@@ -0,0 +1,7 @@
+Discovery
+=========
+
+.. automodule:: snap7.discovery
+   :members:
+   :undoc-members:
+   :show-inheritance:

python_snap7-3.2.1/doc/API/error.rst

@@ -0,0 +1,5 @@
+Errors
+======
+
+.. automodule:: snap7.error
+   :members:

python_snap7-3.2.1/doc/API/log.rst

@@ -0,0 +1,33 @@
+Logging
+=======
+
+Structured logging with PLC connection context for multi-PLC environments.
+
+The :class:`~snap7.log.PLCLoggerAdapter` automatically injects PLC host,
+rack, and slot into every log message:
+
+.. code-block:: python
+
+   import logging
+   logging.basicConfig(level=logging.DEBUG)
+
+   from s7 import Client
+   client = Client()
+   client.connect("192.168.1.10", 0, 1)
+   # Logs: [192.168.1.10 R0/S1] Connected to 192.168.1.10:102 ...
+
+For JSON output (ELK, Datadog, Loki):
+
+.. code-block:: python
+
+   from s7.log import JSONFormatter
+
+   handler = logging.StreamHandler()
+   handler.setFormatter(JSONFormatter())
+   logging.getLogger("snap7").addHandler(handler)
+
+API reference
+-------------
+
+.. automodule:: snap7.log
+   :members:

python_snap7-3.2.1/doc/API/logo.rst

@@ -0,0 +1,5 @@
+Logo
+====
+
+.. autoclass:: snap7.logo.Logo
+   :members: