pydnp3-stepfunc 1.6.0.3__cp39-cp39-manylinux1_x86_64.whl

dnp3/types.py

@@ -0,0 +1,517 @@
+"""
+DNP3 data types, enums, and flags.
+
+Provides Pythonic wrappers around the C FFI enum and struct types.
+"""
+
+from enum import IntEnum
+from dataclasses import dataclass
+from typing import Optional
+import time as _time
+
+from ._ffi import ffi, lib
+
+
+# --- Enums ---
+
+class ParamError(IntEnum):
+    OK = 0
+    INVALID_TIMEOUT = 1
+    NULL_PARAMETER = 2
+    STRING_NOT_UTF8 = 3
+    NO_SUPPORT = 4
+    ASSOCIATION_DOES_NOT_EXIST = 5
+    ASSOCIATION_DUPLICATE_ADDRESS = 6
+    INVALID_SOCKET_ADDRESS = 7
+    INVALID_DNP3_ADDRESS = 8
+    INVALID_BUFFER_SIZE = 9
+    ADDRESS_FILTER_CONFLICT = 10
+    SERVER_ALREADY_STARTED = 11
+    SERVER_BIND_ERROR = 12
+    MASTER_ALREADY_SHUTDOWN = 13
+    RUNTIME_CREATION_FAILURE = 14
+    RUNTIME_DESTROYED = 15
+    RUNTIME_CANNOT_BLOCK_WITHIN_ASYNC = 16
+    LOGGING_ALREADY_CONFIGURED = 17
+    POINT_DOES_NOT_EXIST = 18
+    INVALID_PEER_CERTIFICATE = 19
+    INVALID_LOCAL_CERTIFICATE = 20
+    INVALID_PRIVATE_KEY = 21
+    INVALID_DNS_NAME = 22
+    OTHER_TLS_ERROR = 23
+    WRONG_CHANNEL_TYPE = 24
+    CONSUMED = 25
+
+
+class CommandStatus(IntEnum):
+    SUCCESS = 0
+    TIMEOUT = 1
+    NO_SELECT = 2
+    FORMAT_ERROR = 3
+    NOT_SUPPORTED = 4
+    ALREADY_ACTIVE = 5
+    HARDWARE_ERROR = 6
+    LOCAL = 7
+    TOO_MANY_OPS = 8
+    NOT_AUTHORIZED = 9
+    AUTOMATION_INHIBIT = 10
+    PROCESSING_LIMITED = 11
+    OUT_OF_RANGE = 12
+    DOWNSTREAM_LOCAL = 13
+    ALREADY_COMPLETE = 14
+    BLOCKED = 15
+    CANCELED = 16
+    BLOCKED_OTHER_MASTER = 17
+    DOWNSTREAM_FAIL = 18
+    NON_PARTICIPATING = 19
+    UNKNOWN = 20
+
+
+class TripCloseCode(IntEnum):
+    NUL = 0
+    CLOSE = 1
+    TRIP = 2
+    RESERVED = 3
+
+
+class OpType(IntEnum):
+    NUL = 0
+    PULSE_ON = 1
+    PULSE_OFF = 2
+    LATCH_ON = 3
+    LATCH_OFF = 4
+
+
+class DoubleBit(IntEnum):
+    INTERMEDIATE = 0
+    DETERMINED_OFF = 1
+    DETERMINED_ON = 2
+    INDETERMINATE = 3
+
+
+class TimeQuality(IntEnum):
+    SYNCHRONIZED = 0
+    UNSYNCHRONIZED = 1
+    INVALID = 2
+
+
+class CommandMode(IntEnum):
+    DIRECT_OPERATE = 0
+    SELECT_BEFORE_OPERATE = 1
+
+
+class TimeSyncMode(IntEnum):
+    LAN = 0
+    NON_LAN = 1
+
+
+class LinkErrorMode(IntEnum):
+    DISCARD = 0
+    CLOSE = 1
+
+
+class AppDecodeLevel(IntEnum):
+    NOTHING = 0
+    HEADER = 1
+    OBJECT_HEADERS = 2
+    OBJECT_VALUES = 3
+
+
+class TransportDecodeLevel(IntEnum):
+    NOTHING = 0
+    HEADER = 1
+    PAYLOAD = 2
+
+
+class LinkDecodeLevel(IntEnum):
+    NOTHING = 0
+    HEADER = 1
+    PAYLOAD = 2
+
+
+class PhysDecodeLevel(IntEnum):
+    NOTHING = 0
+    LENGTH = 1
+    DATA = 2
+
+
+class FunctionCode(IntEnum):
+    CONFIRM = 0
+    READ = 1
+    WRITE = 2
+    SELECT = 3
+    OPERATE = 4
+    DIRECT_OPERATE = 5
+    DIRECT_OPERATE_NO_ACK = 6
+    IMMEDIATE_FREEZE = 7
+    IMMEDIATE_FREEZE_NO_ACK = 8
+    FREEZE_AND_CLEAR = 9
+    FREEZE_AND_CLEAR_NO_ACK = 10
+    FREEZE_AT_TIME = 11
+    FREEZE_AT_TIME_NO_ACK = 12
+    COLD_RESTART = 13
+    WARM_RESTART = 14
+    INITIALIZE_DATA = 15
+    INITIALIZE_APPLICATION = 16
+    START_APPLICATION = 17
+    STOP_APPLICATION = 18
+    SAVE_CONFIGURATION = 19
+    ENABLE_UNSOLICITED = 20
+    DISABLE_UNSOLICITED = 21
+    ASSIGN_CLASS = 22
+    DELAY_MEASURE = 23
+    RECORD_CURRENT_TIME = 24
+    OPEN_FILE = 25
+    CLOSE_FILE = 26
+    DELETE_FILE = 27
+    GET_FILE_INFO = 28
+    AUTHENTICATE_FILE = 29
+    ABORT_FILE = 30
+    RESPONSE = 129
+    UNSOLICITED_RESPONSE = 130
+
+
+class ClientState(IntEnum):
+    DISABLED = 0
+    CONNECTING = 1
+    CONNECTED = 2
+    WAIT_AFTER_FAILED_CONNECT = 3
+    WAIT_AFTER_DISCONNECT = 4
+    SHUTDOWN = 5
+
+
+class ReadType(IntEnum):
+    STARTUP_INTEGRITY = 0
+    UNSOLICITED = 1
+    SINGLE_POLL = 2
+    PERIODIC_POLL = 3
+
+
+class TaskType(IntEnum):
+    USER_READ = 0
+    PERIODIC_POLL = 1
+    STARTUP_INTEGRITY = 2
+    AUTO_EVENT_SCAN = 3
+    COMMAND = 4
+    CLEAR_RESTART_BIT = 5
+    ENABLE_UNSOLICITED = 6
+    DISABLE_UNSOLICITED = 7
+    TIME_SYNC = 8
+    RESTART = 9
+    FILE_READ = 10
+    GET_FILE_INFO = 11
+    READ_DIRECTORY = 12
+    FILE_AUTH = 13
+    FILE_OPEN = 14
+    FILE_WRITE = 15
+    FILE_CLOSE = 16
+    GENERIC_EMPTY_RESPONSE = 17
+    WRITE_DEAD_BANDS = 18
+    LINK_STATUS = 19
+
+
+class AutoTimeSync(IntEnum):
+    NONE = 0
+    LAN = 1
+    NON_LAN = 2
+
+
+def _build_variation_enum():
+    """Build Variation enum dynamically from C library constants."""
+    members = {}
+    for attr_name in dir(lib):
+        if attr_name.startswith("DNP3_VARIATION_GROUP"):
+            name = attr_name.replace("DNP3_VARIATION_", "")
+            members[name] = getattr(lib, attr_name)
+    return IntEnum("Variation", members)
+
+
+Variation = _build_variation_enum()
+
+
+# Convenience group/variation mappings
+BINARY_INPUT = Variation["GROUP1_VAR0"]
+BINARY_OUTPUT = Variation["GROUP10_VAR0"]
+ANALOG_INPUT = Variation["GROUP30_VAR0"]
+ANALOG_OUTPUT = Variation["GROUP40_VAR0"]
+COUNTER = Variation["GROUP20_VAR0"]
+FROZEN_COUNTER = Variation["GROUP21_VAR0"]
+
+
+# --- Data classes ---
+
+@dataclass
+class Flags:
+    value: int
+
+    @property
+    def online(self) -> bool:
+        return bool(self.value & 0x01)
+
+    @property
+    def restart(self) -> bool:
+        return bool(self.value & 0x02)
+
+    @property
+    def comm_lost(self) -> bool:
+        return bool(self.value & 0x04)
+
+    @property
+    def remote_forced(self) -> bool:
+        return bool(self.value & 0x08)
+
+    @property
+    def local_forced(self) -> bool:
+        return bool(self.value & 0x10)
+
+    def to_ffi(self):
+        return {"value": self.value}
+
+
+@dataclass
+class Timestamp:
+    value: int  # milliseconds since UNIX epoch
+    quality: TimeQuality
+
+    @classmethod
+    def now(cls) -> "Timestamp":
+        return cls(int(_time.time() * 1000), TimeQuality.SYNCHRONIZED)
+
+    @classmethod
+    def invalid(cls) -> "Timestamp":
+        return cls(0, TimeQuality.INVALID)
+
+    def to_ffi(self):
+        return {"value": self.value, "quality": self.quality.value}
+
+
+@dataclass
+class BinaryInput:
+    index: int
+    value: bool
+    flags: Flags
+    time: Timestamp
+
+    @classmethod
+    def from_ffi(cls, c_obj) -> "BinaryInput":
+        return cls(
+            index=c_obj.index,
+            value=bool(c_obj.value),
+            flags=Flags(c_obj.flags.value),
+            time=Timestamp(c_obj.time.value, TimeQuality(c_obj.time.quality)),
+        )
+
+
+@dataclass
+class DoubleBitBinaryInput:
+    index: int
+    value: DoubleBit
+    flags: Flags
+    time: Timestamp
+
+    @classmethod
+    def from_ffi(cls, c_obj) -> "DoubleBitBinaryInput":
+        return cls(
+            index=c_obj.index,
+            value=DoubleBit(c_obj.value),
+            flags=Flags(c_obj.flags.value),
+            time=Timestamp(c_obj.time.value, TimeQuality(c_obj.time.quality)),
+        )
+
+
+@dataclass
+class BinaryOutputStatus:
+    index: int
+    value: bool
+    flags: Flags
+    time: Timestamp
+
+    @classmethod
+    def from_ffi(cls, c_obj) -> "BinaryOutputStatus":
+        return cls(
+            index=c_obj.index,
+            value=bool(c_obj.value),
+            flags=Flags(c_obj.flags.value),
+            time=Timestamp(c_obj.time.value, TimeQuality(c_obj.time.quality)),
+        )
+
+
+@dataclass
+class Counter:
+    index: int
+    value: int
+    flags: Flags
+    time: Timestamp
+
+    @classmethod
+    def from_ffi(cls, c_obj) -> "Counter":
+        return cls(
+            index=c_obj.index,
+            value=c_obj.value,
+            flags=Flags(c_obj.flags.value),
+            time=Timestamp(c_obj.time.value, TimeQuality(c_obj.time.quality)),
+        )
+
+
+@dataclass
+class FrozenCounter:
+    index: int
+    value: int
+    flags: Flags
+    time: Timestamp
+
+    @classmethod
+    def from_ffi(cls, c_obj) -> "FrozenCounter":
+        return cls(
+            index=c_obj.index,
+            value=c_obj.value,
+            flags=Flags(c_obj.flags.value),
+            time=Timestamp(c_obj.time.value, TimeQuality(c_obj.time.quality)),
+        )
+
+
+@dataclass
+class AnalogInput:
+    index: int
+    value: float
+    flags: Flags
+    time: Timestamp
+
+    @classmethod
+    def from_ffi(cls, c_obj) -> "AnalogInput":
+        return cls(
+            index=c_obj.index,
+            value=c_obj.value,
+            flags=Flags(c_obj.flags.value),
+            time=Timestamp(c_obj.time.value, TimeQuality(c_obj.time.quality)),
+        )
+
+
+@dataclass
+class AnalogOutputStatus:
+    index: int
+    value: float
+    flags: Flags
+    time: Timestamp
+
+    @classmethod
+    def from_ffi(cls, c_obj) -> "AnalogOutputStatus":
+        return cls(
+            index=c_obj.index,
+            value=c_obj.value,
+            flags=Flags(c_obj.flags.value),
+            time=Timestamp(c_obj.time.value, TimeQuality(c_obj.time.quality)),
+        )
+
+
+@dataclass
+class ControlCode:
+    tcc: TripCloseCode = TripCloseCode.NUL
+    clear: bool = False
+    op_type: OpType = OpType.LATCH_ON
+
+    def to_ffi(self):
+        return {
+            "tcc": self.tcc.value,
+            "clear": self.clear,
+            "queue": False,
+            "op_type": self.op_type.value,
+        }
+
+
+@dataclass
+class Group12Var1:
+    """Control Relay Output Block (CROB)."""
+    code: ControlCode
+    count: int = 1
+    on_time: int = 1000
+    off_time: int = 1000
+
+    def to_ffi(self):
+        return {
+            "code": self.code.to_ffi(),
+            "count": self.count,
+            "on_time": self.on_time,
+            "off_time": self.off_time,
+        }
+
+
+@dataclass
+class DecodeLevel:
+    application: AppDecodeLevel = AppDecodeLevel.NOTHING
+    transport: TransportDecodeLevel = TransportDecodeLevel.NOTHING
+    link: LinkDecodeLevel = LinkDecodeLevel.NOTHING
+    physical: PhysDecodeLevel = PhysDecodeLevel.NOTHING
+
+    def to_ffi(self):
+        return {
+            "application": self.application.value,
+            "transport": self.transport.value,
+            "link": self.link.value,
+            "physical": self.physical.value,
+        }
+
+
+@dataclass
+class ConnectStrategy:
+    min_connect_delay: int = 1000  # ms
+    max_connect_delay: int = 10000  # ms
+    reconnect_delay: int = 1000  # ms
+
+    def to_ffi(self):
+        return {
+            "min_connect_delay": self.min_connect_delay,
+            "max_connect_delay": self.max_connect_delay,
+            "reconnect_delay": self.reconnect_delay,
+        }
+
+
+@dataclass
+class IIN1:
+    broadcast: bool = False
+    class_1_events: bool = False
+    class_2_events: bool = False
+    class_3_events: bool = False
+    need_time: bool = False
+    local_control: bool = False
+    device_trouble: bool = False
+    device_restart: bool = False
+
+
+@dataclass
+class IIN2:
+    no_func_code_support: bool = False
+    object_unknown: bool = False
+    parameter_error: bool = False
+    event_buffer_overflow: bool = False
+    already_executing: bool = False
+    config_corrupt: bool = False
+
+
+@dataclass
+class IIN:
+    iin1: IIN1
+    iin2: IIN2
+
+    @classmethod
+    def from_ffi(cls, c_iin):
+        return cls(
+            iin1=IIN1(
+                broadcast=bool(c_iin.iin1.broadcast),
+                class_1_events=bool(c_iin.iin1.class_1_events),
+                class_2_events=bool(c_iin.iin1.class_2_events),
+                class_3_events=bool(c_iin.iin1.class_3_events),
+                need_time=bool(c_iin.iin1.need_time),
+                local_control=bool(c_iin.iin1.local_control),
+                device_trouble=bool(c_iin.iin1.device_trouble),
+                device_restart=bool(c_iin.iin1.device_restart),
+            ),
+            iin2=IIN2(
+                no_func_code_support=bool(c_iin.iin2.no_func_code_support),
+                object_unknown=bool(c_iin.iin2.object_unknown),
+                parameter_error=bool(c_iin.iin2.parameter_error),
+                event_buffer_overflow=bool(c_iin.iin2.event_buffer_overflow),
+                already_executing=bool(c_iin.iin2.already_executing),
+                config_corrupt=bool(c_iin.iin2.config_corrupt),
+            ),
+        )