pydnp3-stepfunc 1.6.0.3__cp310-cp310-manylinux1_x86_64.whl

pydnp3_stepfunc-1.6.0.3.dist-info/METADATA

@@ -0,0 +1,238 @@
+Metadata-Version: 2.4
+Name: pydnp3-stepfunc
+Version: 1.6.0.3
+Summary: Python bindings for the stepfunc/dnp3 Rust library via cffi
+Author: f0rw4rd
+License: MIT
+Project-URL: Homepage, https://github.com/f0rw4rd/dnp3-python
+Project-URL: Repository, https://github.com/f0rw4rd/dnp3-python
+Project-URL: Issues, https://github.com/f0rw4rd/dnp3-python/issues
+Keywords: dnp3,scada,ics,industrial-control-systems,modbus,protocol,master,outstation,rtu,power-systems
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: System :: Networking
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+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 :: Implementation :: CPython
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: cffi>=1.15.0
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0; extra == "dev"
+Requires-Dist: pytest-timeout>=2.0; extra == "dev"
+Dynamic: license-file
+
+# dnp3-python
+
+Python bindings for the [stepfunc/dnp3](https://github.com/stepfunc/dnp3) Rust library via cffi.
+
+[![Tests](https://github.com/f0rw4rd/dnp3-python/actions/workflows/tests.yml/badge.svg)](https://github.com/f0rw4rd/dnp3-python/actions/workflows/tests.yml)
+
+This library provides a Pythonic API for DNP3 (Distributed Network Protocol 3) master
+and outstation operations, built on the production-quality stepfunc/dnp3 implementation.
+It supports TCP, TLS, serial, and UDP transports with full Secure Authentication support.
+
+## Features
+
+- **Master station** - Integrity polls, class-based reads, specific group/variation reads
+- **Control operations** - Select-Before-Operate (SBO), Direct Operate, analog outputs
+- **Device attributes** - Read Group 0 device attribute strings
+- **Outstation server** - Create test outstations with configurable databases
+- **Time synchronization** - LAN and non-LAN time sync modes
+- **Restart commands** - Cold and warm restart with delay reporting
+- **Multiple transports** - TCP, TLS, serial, UDP channel creation
+- **Logging** - Configurable log levels, text/JSON output, custom callbacks
+- **Thread-safe** - All handlers use locking for concurrent access
+
+## Installation
+
+### Prerequisites
+
+You need the compiled stepfunc/dnp3 C FFI library (`libdnp3_ffi.so` and `dnp3.h`).
+
+```bash
+# Clone and build the Rust library
+git clone https://github.com/stepfunc/dnp3.git stepfunc-dnp3
+cd stepfunc-dnp3
+cargo build --release -p dnp3-ffi
+
+# Generate C bindings
+cargo build --release -p dnp3-bindings
+```
+
+### Install dnp3-python
+
+```bash
+# Install from local checkout
+pip install -e .
+
+# Or with dev dependencies
+pip install -e ".[dev]"
+```
+
+The library locates `dnp3.h` and `libdnp3_ffi.so` automatically from a sibling
+`stepfunc-dnp3/` directory. You can also set environment variables:
+
+```bash
+export DNP3_HEADER_PATH=/path/to/dnp3.h
+export DNP3_LIB_PATH=/path/to/libdnp3_ffi.so
+```
+
+## Quick Start
+
+### Master - Read Data from Outstation
+
+```python
+from dnp3 import Runtime, MasterChannelConfig, ReadHandler
+from dnp3.channel import create_tcp_channel
+from dnp3.logging import configure_logging, LogLevel
+
+configure_logging(LogLevel.INFO)
+
+with Runtime() as runtime:
+    handler = ReadHandler()
+    channel = create_tcp_channel(
+        runtime,
+        endpoints=["127.0.0.1:20000"],
+        config=MasterChannelConfig(address=1),
+    )
+    assoc = channel.add_association(address=1024, read_handler=handler)
+    channel.enable()
+
+    # Integrity poll (all classes)
+    channel.read(assoc)
+
+    for bi in handler.binary_inputs:
+        print(f"BI {bi.index}: {bi.value} (flags={bi.flags.value:#04x})")
+    for ai in handler.analog_inputs:
+        print(f"AI {ai.index}: {ai.value}")
+
+    channel.destroy()
+```
+
+### Master - Control Operations
+
+```python
+from dnp3 import OpType, CommandMode
+
+# Select-Before-Operate
+channel.select_before_operate(assoc, index=3, op_type=OpType.LATCH_ON)
+
+# Direct Operate
+channel.direct_operate(assoc, index=5, op_type=OpType.LATCH_OFF)
+
+# Analog output
+channel.operate(
+    assoc,
+    mode=CommandMode.DIRECT_OPERATE,
+    analog_double_commands=[(0, 42.5)],
+)
+```
+
+### Outstation Server
+
+```python
+from dnp3 import Runtime
+from dnp3.outstation import OutstationServer, OutstationConfig
+
+with Runtime() as runtime:
+    server = OutstationServer(runtime, address="0.0.0.0:20000")
+    config = OutstationConfig(outstation_address=10, master_address=1)
+    outstation = server.add_outstation(config=config)
+    server.bind()
+
+    # Server is now accepting master connections...
+    input("Press Enter to stop")
+    server.destroy()
+```
+
+### Examples
+
+See the [examples/](examples/) directory for complete working scripts:
+
+- [**master_poll.py**](examples/master_poll.py) - Connect and read data points
+- [**master_control.py**](examples/master_control.py) - SBO and direct operate
+- [**master_attributes.py**](examples/master_attributes.py) - Read device attributes (Group 0)
+- [**outstation_server.py**](examples/outstation_server.py) - Test outstation with sample data
+
+## API Summary
+
+### Core Classes
+
+| Class | Description |
+|-------|-------------|
+| `Runtime` | Manages the Tokio async runtime (context manager) |
+| `MasterChannel` | Master station channel with read/control methods |
+| `MasterChannelConfig` | Channel configuration (address, decode level, buffer sizes) |
+| `AssociationConfig` | Association settings (unsolicited, integrity, timeouts) |
+| `ReadHandler` | Collects data from read operations |
+| `OutstationServer` | TCP outstation server for testing |
+
+### Channel Factories
+
+| Function | Description |
+|----------|-------------|
+| `create_tcp_channel()` | TCP master channel |
+| `create_tls_channel()` | TLS-encrypted master channel |
+| `create_serial_channel()` | Serial port master channel |
+| `create_udp_channel()` | UDP master channel |
+
+### Data Types
+
+| Type | Description |
+|------|-------------|
+| `BinaryInput` | Binary input point (index, value, flags, timestamp) |
+| `AnalogInput` | Analog input point |
+| `Counter` | Counter point |
+| `BinaryOutputStatus` | Binary output status |
+| `AnalogOutputStatus` | Analog output status |
+| `Group12Var1` | Control Relay Output Block (CROB) |
+| `Variation` | DNP3 group/variation enum |
+
+### MasterChannel Methods
+
+| Method | Description |
+|--------|-------------|
+| `read()` | One-shot read (by class or variation) |
+| `read_attributes()` | Read device attributes (Group 0) |
+| `add_poll()` | Add periodic poll |
+| `select_before_operate()` | SBO binary output control |
+| `direct_operate()` | Direct operate binary output |
+| `operate()` | Generic control (CROB + analog) |
+| `synchronize_time()` | Time sync (LAN/non-LAN) |
+| `cold_restart()` / `warm_restart()` | Restart commands |
+| `check_link_status()` | Link status check |
+
+## Building from Source
+
+```bash
+# 1. Build the Rust library (in a sibling directory)
+git clone https://github.com/stepfunc/dnp3.git ../stepfunc-dnp3
+cd ../stepfunc-dnp3
+cargo build --release -p dnp3-ffi
+
+# 2. Install this package
+cd ../dnp3-python
+pip install -e ".[dev]"
+
+# 3. Run tests
+pytest tests/
+```
+
+## License
+
+This Python wrapper is MIT licensed. See [LICENSE](LICENSE).
+
+The underlying stepfunc/dnp3 library uses a non-commercial license
+(evaluation, research, and training use only). See the
+[stepfunc/dnp3 LICENSE](https://github.com/stepfunc/dnp3/blob/main/LICENSE.txt)
+for details.

pydnp3_stepfunc-1.6.0.3.dist-info/RECORD

@@ -0,0 +1,17 @@
+dnp3/__init__.py,sha256=7RhCkjj7AAhTa-sXS-KqfXxwNinOAzK2a9u-Hoc32LI,2903
+dnp3/_build_ffi.py,sha256=XKhduO48wQHzAWWxiDGMsYTKGX6fQbODecSbE772oSM,5237
+dnp3/_ffi.py,sha256=8I6Ng1HUgYRmKPrDsY7kAB5D81kJpGv3UZ5Vl29T6Hw,1755
+dnp3/channel.py,sha256=wwyg_ZC4uXD3YJ1HXWpI1kW4ZlbLS2-LOc5lcJ7wIq4,7227
+dnp3/handler.py,sha256=ruGao_Toc-EWqcq1XwbUoz6U24T0BwsVwmheGUraaXQ,17225
+dnp3/logging.py,sha256=a8Jset4GQH3Ks60qNuW7KenhdolT_33udYMLwF4bhX0,2432
+dnp3/master.py,sha256=ggz6sCsXaE1ggVGCrxYAfu5wUTeS8Yzu7lGer-hJGYQ,17773
+dnp3/outstation.py,sha256=pT9OPfm3Zewq05exKnHB0Q2YgckIEfe6He7D8KX4WB0,14977
+dnp3/runtime.py,sha256=ik_f8KKJXsl_we_V5_dhbRoO7p7CFqvwOI5HQ-ZxwSk,1611
+dnp3/types.py,sha256=nJJKplJ62Ij5Njvo6dU-IoP_k-fz5_Oo9odikxjAnAE,11721
+dnp3/vendor/dnp3.h,sha256=UfORDVjFHp9hRXw-nOrc3b2hFYCyaaCIwMs4EueEUnQ,371525
+dnp3/vendor/libdnp3_ffi.so,sha256=JS-a5U3VWn0EDHbT5dUSqpfk7hE_aB8uP7n5-oppcNw,7101512
+pydnp3_stepfunc-1.6.0.3.dist-info/licenses/LICENSE,sha256=rDANftwBo2YLfaPsY4ZKCcHHdQFfpgL1B8GfqE4XIws,1064
+pydnp3_stepfunc-1.6.0.3.dist-info/METADATA,sha256=Tr2ReNKP7oNpRcyhib_4RkgpeX4MvQZ9XQMKZVluZhc,7820
+pydnp3_stepfunc-1.6.0.3.dist-info/WHEEL,sha256=dIWhZP8noP6mB-YKST8g3F1ArFuppNVE7wIphKMromA,104
+pydnp3_stepfunc-1.6.0.3.dist-info/top_level.txt,sha256=Wfb2qiOz-crxcPBaLWFPAzTAt1-9gW6EAitSqdYhIao,5
+pydnp3_stepfunc-1.6.0.3.dist-info/RECORD,,

pydnp3_stepfunc-1.6.0.3.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (80.10.2)
+Root-Is-Purelib: true
+Tag: cp310-cp310-linux_x86_64
+

pydnp3_stepfunc-1.6.0.3.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 f0rw4rd
+
+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.

pydnp3_stepfunc-1.6.0.3.dist-info/top_level.txt

@@ -0,0 +1 @@
+dnp3