profinet-py 0.6.0__tar.gz → 0.6.2__tar.gz

profinet_py-0.6.2/LICENSE-COMMERCIAL.md

@@ -0,0 +1,28 @@
+# Commercial License — profinet-py
+
+This software is dual-licensed:
+
+- **Open source** under the [GNU General Public License v3.0](LICENSE) for free and
+  open source use.
+- **Commercial/OEM license** for use in proprietary products, described below.
+
+## When you need a commercial license
+
+A commercial license is required if you want to:
+
+- Embed profinet-py in proprietary software or hardware products
+- Distribute profinet-py as part of a closed-source application
+- Use profinet-py in a product without complying with GPL-3.0 obligations
+  (source disclosure, copyleft, license notices)
+
+## What the commercial license provides
+
+- Permission to use, modify, and distribute profinet-py in proprietary products
+- No requirement to disclose your source code
+- No copyleft obligations
+- Priority support options available
+
+## Contact
+
+For commercial licensing inquiries, contact the maintainer via the details listed
+at <https://github.com/f0rw4rd>.

{profinet_py-0.6.0/profinet_py.egg-info → profinet_py-0.6.2}/PKG-INFO

@@ -1,14 +1,13 @@
 Metadata-Version: 2.4
 Name: profinet-py
-Version: 0.6.0
+Version: 0.6.2
 Summary: PROFINET IO-Controller library for Python
 Author: f0rw4rd
 Maintainer: f0rw4rd
 License-Expression: GPL-3.0-only
-Project-URL: Homepage, https://github.com/f0rw4rd/profinet
-Project-URL: Repository, https://github.com/f0rw4rd/profinet
-Project-URL: Original Project, https://github.com/alfredkrohmer/profinet
-Project-URL: Issues, https://github.com/f0rw4rd/profinet/issues
+Project-URL: Homepage, https://github.com/f0rw4rd/profinet-py
+Project-URL: Repository, https://github.com/f0rw4rd/profinet-py
+Project-URL: Issues, https://github.com/f0rw4rd/profinet-py/issues
 Keywords: profinet,industrial,ics,ot,plc,automation,siemens,dcp,rpc
 Classifier: Development Status :: 4 - Beta
 Classifier: Environment :: Console
@@ -23,17 +22,26 @@ Classifier: Typing :: Typed
 Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE
+License-File: LICENSE-COMMERCIAL.md
 Requires-Dist: construct>=2.10
 Provides-Extra: dev
-Requires-Dist: pytest>=7.0; extra == "dev"
+Requires-Dist: pytest>=9.0.0; extra == "dev"
 Requires-Dist: pytest-cov>=4.0; extra == "dev"
-Requires-Dist: black>=23.0; extra == "dev"
-Requires-Dist: mypy>=1.0; extra == "dev"
-Requires-Dist: ruff>=0.1.0; extra == "dev"
+Requires-Dist: ruff>=0.15.0; extra == "dev"
+Requires-Dist: vulture>=2.14; extra == "dev"
+Requires-Dist: bandit>=1.9.3; extra == "dev"
+Requires-Dist: pre-commit>=4.0.0; extra == "dev"
 Dynamic: license-file
 
 # profinet-py
 
+[![CI](https://github.com/f0rw4rd/profinet-py/actions/workflows/ci.yml/badge.svg)](https://github.com/f0rw4rd/profinet-py/actions/workflows/ci.yml)
+[![PyPI](https://img.shields.io/pypi/v/profinet-py)](https://pypi.org/project/profinet-py/)
+[![Python](https://img.shields.io/pypi/pyversions/profinet-py)](https://pypi.org/project/profinet-py/)
+[![License](https://img.shields.io/github/license/f0rw4rd/profinet-py)](LICENSE)
+[![Code style: ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
+[![CLA](https://img.shields.io/badge/CLA-required-blue)](CONTRIBUTING.md)
+
 A Python library for PROFINET IO communication, acting as an IO-Controller.
 
 ## Features
@@ -46,7 +54,7 @@ A Python library for PROFINET IO communication, acting as an IO-Controller.
 - **Diagnosis Parsing**: Channel, extended channel, and qualified channel diagnosis decoding
 - **Vendor Registry**: 2100+ PROFINET vendor IDs with name lookup
 - **Declarative Parsing**: Binary protocol parsing via [construct](https://construct.readthedocs.io/) library
-- **Cross-Platform**: Linux (AF_PACKET), Windows (Npcap), macOS (libpcap)
+- **Cross-Platform**: Linux (AF_PACKET), Windows (Npcap)
 - **High-level API**: `ProfinetDevice` class and `scan()` for quick device interaction
 
 ## Requirements
@@ -61,7 +69,6 @@ A Python library for PROFINET IO communication, acting as an IO-Controller.
 |----------|-------------------|----------------|
 | **Linux** | AF_PACKET (built-in) | None |
 | **Windows** | Npcap (wpcap.dll) | Install [Npcap](https://npcap.com/) with "WinPcap API-compatible Mode" enabled |
-| **macOS** | libpcap (built-in) | None |
 
 ## Installation
 
@@ -72,8 +79,8 @@ pip install profinet-py
 From source:
 
 ```bash
-git clone https://github.com/f0rw4rd/profinet.git
-cd profinet
+git clone https://github.com/f0rw4rd/profinet-py.git
+cd profinet-py
 pip install -e ".[dev]"
 ```
 
@@ -131,34 +138,6 @@ profinet -i eth0 cyclic device-name --gsdml device.xml
 profinet -i eth0 cyclic device-name --gsdml device.xml --cycle-ms 16
 ```
 
-## Credits
-
-This project is a modernized fork of the original PROFINET library by **Alfred Krohmer**:
-
-- **Original Repository**: https://github.com/alfredkrohmer/profinet
-- **Original Author**: Alfred Krohmer (2015)
-
-### Changes in this fork
-
-- Cross-platform support (Windows via Npcap ctypes, macOS via libpcap ctypes)
-- Dropped Python 3.8/3.9 (EOL), targets Python 3.10+
-- Migrated all binary parsing from `struct` to `construct` library for declarative, readable protocol definitions
-- Fixed 5 protocol bugs verified against Wireshark's PROFINET dissector and IEC 61158-6-10:
-  - DCP Option 0x04 is Reserved (not LLDP)
-  - Block Type 0x0012 is ExpectedIdentificationData (not QualifiedChannelDiagnosis)
-  - RT_CLASS_1 frame ID range starts at 0x8000 (not 0xC000)
-  - Device Suboption 0x09 does not exist in the spec
-  - DCP Identify uses separate Frame IDs for request (0xFEFE) and response (0xFEFF)
-- DCP SET operations now validate response block error codes instead of silently succeeding
-- Diagnosis parsing module with channel/extended/qualified channel support
-- Alarm notification parsing and background alarm listener
-- Cyclic I/O controller for RT_CLASS_1 periodic data exchange with explicit state machine (`IDLE → RUNNING → STOPPING → STOPPED`, `FAULT`), double-buffered output data, per-frame cycle counter tracking (gap/duplicate/out-of-order detection), watchdog with automatic fault transition, IOCS consumer status handling, graceful stop (RUN→STOP frames), and separate TX/RX sockets
-- High-level `ProfinetDevice` API with `start_cyclic()` for integrated cyclic IO, plus `scan()`/`scan_dict()` convenience functions
-- 2100+ vendor ID registry with lookup
-- CLI tool for discovery, I&M reading, and raw record access
-- 700+ unit tests, Docker-based integration tests against p-net device emulator
-- Type hints, ruff linting, mypy checking
-
 ## Support
 
 If you find this project useful, consider supporting development:
@@ -167,7 +146,11 @@ If you find this project useful, consider supporting development:
 
 ## License
 
-GPLv3. See [LICENSE](LICENSE) for details.
+Dual-licensed under [GPL-3.0](LICENSE) and a [commercial license](LICENSE-COMMERCIAL.md).
+
+Free for open source use under GPL-3.0. If you want to use profinet-py in proprietary
+products without GPL obligations, a commercial license is available —
+see [LICENSE-COMMERCIAL.md](LICENSE-COMMERCIAL.md) for details.
 
 ## References
 

{profinet_py-0.6.0 → profinet_py-0.6.2}/README.md

@@ -1,5 +1,12 @@
 # profinet-py
 
+[![CI](https://github.com/f0rw4rd/profinet-py/actions/workflows/ci.yml/badge.svg)](https://github.com/f0rw4rd/profinet-py/actions/workflows/ci.yml)
+[![PyPI](https://img.shields.io/pypi/v/profinet-py)](https://pypi.org/project/profinet-py/)
+[![Python](https://img.shields.io/pypi/pyversions/profinet-py)](https://pypi.org/project/profinet-py/)
+[![License](https://img.shields.io/github/license/f0rw4rd/profinet-py)](LICENSE)
+[![Code style: ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
+[![CLA](https://img.shields.io/badge/CLA-required-blue)](CONTRIBUTING.md)
+
 A Python library for PROFINET IO communication, acting as an IO-Controller.
 
 ## Features
@@ -12,7 +19,7 @@ A Python library for PROFINET IO communication, acting as an IO-Controller.
 - **Diagnosis Parsing**: Channel, extended channel, and qualified channel diagnosis decoding
 - **Vendor Registry**: 2100+ PROFINET vendor IDs with name lookup
 - **Declarative Parsing**: Binary protocol parsing via [construct](https://construct.readthedocs.io/) library
-- **Cross-Platform**: Linux (AF_PACKET), Windows (Npcap), macOS (libpcap)
+- **Cross-Platform**: Linux (AF_PACKET), Windows (Npcap)
 - **High-level API**: `ProfinetDevice` class and `scan()` for quick device interaction
 
 ## Requirements
@@ -27,7 +34,6 @@ A Python library for PROFINET IO communication, acting as an IO-Controller.
 |----------|-------------------|----------------|
 | **Linux** | AF_PACKET (built-in) | None |
 | **Windows** | Npcap (wpcap.dll) | Install [Npcap](https://npcap.com/) with "WinPcap API-compatible Mode" enabled |
-| **macOS** | libpcap (built-in) | None |
 
 ## Installation
 
@@ -38,8 +44,8 @@ pip install profinet-py
 From source:
 
 ```bash
-git clone https://github.com/f0rw4rd/profinet.git
-cd profinet
+git clone https://github.com/f0rw4rd/profinet-py.git
+cd profinet-py
 pip install -e ".[dev]"
 ```
 
@@ -97,34 +103,6 @@ profinet -i eth0 cyclic device-name --gsdml device.xml
 profinet -i eth0 cyclic device-name --gsdml device.xml --cycle-ms 16
 ```
 
-## Credits
-
-This project is a modernized fork of the original PROFINET library by **Alfred Krohmer**:
-
-- **Original Repository**: https://github.com/alfredkrohmer/profinet
-- **Original Author**: Alfred Krohmer (2015)
-
-### Changes in this fork
-
-- Cross-platform support (Windows via Npcap ctypes, macOS via libpcap ctypes)
-- Dropped Python 3.8/3.9 (EOL), targets Python 3.10+
-- Migrated all binary parsing from `struct` to `construct` library for declarative, readable protocol definitions
-- Fixed 5 protocol bugs verified against Wireshark's PROFINET dissector and IEC 61158-6-10:
-  - DCP Option 0x04 is Reserved (not LLDP)
-  - Block Type 0x0012 is ExpectedIdentificationData (not QualifiedChannelDiagnosis)
-  - RT_CLASS_1 frame ID range starts at 0x8000 (not 0xC000)
-  - Device Suboption 0x09 does not exist in the spec
-  - DCP Identify uses separate Frame IDs for request (0xFEFE) and response (0xFEFF)
-- DCP SET operations now validate response block error codes instead of silently succeeding
-- Diagnosis parsing module with channel/extended/qualified channel support
-- Alarm notification parsing and background alarm listener
-- Cyclic I/O controller for RT_CLASS_1 periodic data exchange with explicit state machine (`IDLE → RUNNING → STOPPING → STOPPED`, `FAULT`), double-buffered output data, per-frame cycle counter tracking (gap/duplicate/out-of-order detection), watchdog with automatic fault transition, IOCS consumer status handling, graceful stop (RUN→STOP frames), and separate TX/RX sockets
-- High-level `ProfinetDevice` API with `start_cyclic()` for integrated cyclic IO, plus `scan()`/`scan_dict()` convenience functions
-- 2100+ vendor ID registry with lookup
-- CLI tool for discovery, I&M reading, and raw record access
-- 700+ unit tests, Docker-based integration tests against p-net device emulator
-- Type hints, ruff linting, mypy checking
-
 ## Support
 
 If you find this project useful, consider supporting development:
@@ -133,7 +111,11 @@ If you find this project useful, consider supporting development:
 
 ## License
 
-GPLv3. See [LICENSE](LICENSE) for details.
+Dual-licensed under [GPL-3.0](LICENSE) and a [commercial license](LICENSE-COMMERCIAL.md).
+
+Free for open source use under GPL-3.0. If you want to use profinet-py in proprietary
+products without GPL obligations, a commercial license is available —
+see [LICENSE-COMMERCIAL.md](LICENSE-COMMERCIAL.md) for details.
 
 ## References
 

{profinet_py-0.6.0 → profinet_py-0.6.2}/profinet/__init__.py

@@ -9,12 +9,8 @@ A Python library for PROFINET IO communication, supporting:
 This library acts as an IO-Controller, allowing connection to and
 communication with PROFINET IO-Devices.
 
-Credits:
-    Original implementation by Alfred Krohmer (2015)
-    https://github.com/alfredkrohmer/profinet
-
-    Modernized for Python 3.8+ by f0rw4rd (2024)
-    https://github.com/f0rw4rd/profinet-py
+Author: f0rw4rd
+https://github.com/f0rw4rd/profinet-py
 """
 
 from . import blocks, indices

{profinet_py-0.6.0 → profinet_py-0.6.2}/profinet/alarm_listener.py

@@ -194,7 +194,7 @@ class AlarmListener:
         Returns:
             Configured socket for alarm reception.
             For Layer 2: platform-abstracted raw socket (AF_PACKET on Linux,
-            NpcapSocket on Windows, PcapSocket on macOS).
+            NpcapSocket on Windows).
             For UDP: standard socket.
 
         Raises:
@@ -210,7 +210,7 @@ class AlarmListener:
             # UDP socket (port 34964) — works on all platforms
             sock = socket.socket(socket.AF_INET, socket.SOCK_DGRAM)
             sock.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1)
-            sock.bind(("0.0.0.0", 34964))
+            sock.bind(("0.0.0.0", 34964))  # nosec B104 — must receive from any interface
 
         # Non-blocking timeout for clean shutdown
         sock.settimeout(1.0)

{profinet_py-0.6.0 → profinet_py-0.6.2}/profinet/cli.py

@@ -1,7 +1,6 @@
 """
 PROFINET command-line interface.
 
-Credits: Original implementation by Alfred Krohmer (2015)
 """
 
 from __future__ import annotations
@@ -141,6 +140,31 @@ def cmd_read(args: argparse.Namespace) -> int:
         sock.close()
 
 
+def cmd_write(args: argparse.Namespace) -> int:
+    """Execute write command."""
+    sock = ethernet_socket(args.interface, 3)
+    try:
+        src = get_mac(args.interface)
+
+        print(f"Connecting to {args.target}...")
+        info = rpc.get_station_info(sock, src, args.target)
+
+        with rpc.RPCCon(info) as conn:
+            conn.connect(src)
+
+            idx = int(args.index, 16) if args.index.startswith("0x") else int(args.index)
+            data = bytes.fromhex(args.data.replace(" ", ""))
+            conn.write(api=args.api, slot=args.slot, subslot=args.subslot, idx=idx, data=data)
+
+            print(
+                f"Wrote {len(data)} bytes to slot={args.slot} subslot={args.subslot} index=0x{idx:04X}"
+            )
+
+        return 0
+    finally:
+        sock.close()
+
+
 def cmd_read_inm0_filter(args: argparse.Namespace) -> int:
     """Execute read-inm0-filter command."""
     sock = ethernet_socket(args.interface, 3)
@@ -574,7 +598,7 @@ def create_parser() -> argparse.ArgumentParser:
     parser = argparse.ArgumentParser(
         prog="profinet",
         description="PROFINET IO-Controller CLI",
-        epilog="Credits: Original implementation by Alfred Krohmer (2015)",
+        epilog="https://github.com/f0rw4rd/profinet-py",
     )
 
     parser.add_argument(
@@ -631,6 +655,18 @@ def create_parser() -> argparse.ArgumentParser:
     sub.add_argument("--index", required=True, help="Record index (hex with 0x prefix)")
     sub.set_defaults(func=cmd_read)
 
+    # write
+    sub = subparsers.add_parser("write", help="Write data record")
+    sub.add_argument("target", metavar="NAME", help="Station name (e.g. my-device)")
+    sub.add_argument("--api", type=int, default=0, help="API (default: 0)")
+    sub.add_argument("--slot", type=int, required=True, help="Slot number")
+    sub.add_argument("--subslot", type=int, required=True, help="Subslot number")
+    sub.add_argument(
+        "--index", required=True, help="Record index (hex with 0x prefix, e.g. 0xAFF1)"
+    )
+    sub.add_argument("data", metavar="HEX", help="Data to write as hex string (e.g. deadbeef)")
+    sub.set_defaults(func=cmd_write)
+
     # read-inm0-filter
     sub = subparsers.add_parser("read-inm0-filter", help="Read device topology")
     sub.add_argument("target", metavar="NAME", help="Station name (e.g. my-device)")

{profinet_py-0.6.0 → profinet_py-0.6.2}/profinet/dcp.py

@@ -7,15 +7,12 @@ Provides device discovery and basic configuration operations:
 - get_param(): Read device parameter (name, IP)
 - set_param(): Write device parameter
 
-Credits:
-    Original implementation by Alfred Krohmer (2015)
-    https://github.com/alfredkrohmer/profinet
 """
 
 from __future__ import annotations
 
 import logging
-import random
+import secrets
 import time
 from collections.abc import Callable
 from dataclasses import dataclass
@@ -507,7 +504,7 @@ PARAMS: Dict[str, Tuple[int, int]] = {
 
 def _generate_xid() -> int:
     """Generate random transaction ID for DCP requests."""
-    return random.randint(0, 0xFFFFFFFF)
+    return secrets.randbelow(0x100000000)
 
 
 # =============================================================================
@@ -587,9 +584,9 @@ class DCPDeviceDescription:
                 self.netmask = s2ip(ip_block[6:10])
                 self.gateway = s2ip(ip_block[10:14])
         else:
-            self.ip = "0.0.0.0"
-            self.netmask = "0.0.0.0"
-            self.gateway = "0.0.0.0"
+            self.ip = "0.0.0.0"  # nosec B104 — PROFINET default (no IP assigned)
+            self.netmask = "0.0.0.0"  # nosec B104
+            self.gateway = "0.0.0.0"  # nosec B104
             logger.warning(f"Device {self.mac} has no IP configuration")
 
         # Handle device ID (optional)
@@ -1335,9 +1332,9 @@ def send_hello(
     sock: socket,
     src: bytes,
     station_name: str,
-    ip: str = "0.0.0.0",
-    netmask: str = "0.0.0.0",
-    gateway: str = "0.0.0.0",
+    ip: str = "0.0.0.0",  # nosec B104 — PROFINET default (no IP assigned)
+    netmask: str = "0.0.0.0",  # nosec B104
+    gateway: str = "0.0.0.0",  # nosec B104
     device_id: Tuple[int, int] = (0, 0),
     device_role: int = DEVICE_ROLE_IO_DEVICE,
 ) -> None:

{profinet_py-0.6.0 → profinet_py-0.6.2}/profinet/gsdml.py

@@ -7,7 +7,7 @@ module/submodule IDs and IO data sizes.
 
 from __future__ import annotations
 
-import xml.etree.ElementTree as ET
+import xml.etree.ElementTree as ET  # nosec B405 — GSDML files are local trusted vendor data
 from dataclasses import dataclass, field
 from pathlib import Path
 from typing import Dict, List, Optional, Union
@@ -503,7 +503,7 @@ def load_gsdml(path: Union[str, Path]) -> GSDMLDevice:
     Returns:
         GSDMLDevice with full module catalog.
     """
-    tree = ET.parse(str(path))
+    tree = ET.parse(str(path))  # nosec B314 — GSDML files are local trusted vendor data
     return _parse_gsdml_root(tree.getroot())
 
 

{profinet_py-0.6.0 → profinet_py-0.6.2}/profinet/protocol.py

@@ -6,9 +6,6 @@ Defines packet structures for:
 - DCE/RPC (Remote Procedure Call)
 - PNIO (PROFINET IO) data blocks
 
-Credits:
-    Original implementation by Alfred Krohmer (2015)
-    https://github.com/alfredkrohmer/profinet
 """
 
 from __future__ import annotations

{profinet_py-0.6.0 → profinet_py-0.6.2}/profinet/rpc.py

@@ -6,9 +6,6 @@ Provides IO-Controller functionality:
 - get_station_info(): Resolve device name to connection info
 - Read/Write operations via slot/subslot/index addressing
 
-Credits:
-    Original implementation by Alfred Krohmer (2015)
-    https://github.com/alfredkrohmer/profinet
 """
 
 from __future__ import annotations