mbus-ffi 0.13.0

Native C FFI and browser WASM bindings for modbus-rs client APIs, with optional generated server bindings
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101

"""
modbus_rs — Python bindings for the modbus-rs library.

PyPI package: modbus-rs
Import name : modbus_rs

Client classes
--------------
TcpClient       — synchronous (blocking, GIL-releasing) Modbus TCP client
AsyncTcpClient  — asyncio Modbus TCP client
SerialClient    — synchronous Modbus serial client (RTU / ASCII)
AsyncSerialClient — asyncio Modbus serial client

Server classes
--------------
ModbusApp       — base class; subclass and override handler methods
AsyncTcpServer  — asyncio Modbus TCP server
TcpServer       — synchronous Modbus TCP server
AsyncSerialServer — asyncio Modbus serial server
SerialServer    — synchronous Modbus serial server

Exceptions
----------
ModbusError           — base exception
ModbusTimeout         — request timed out
ModbusConnectionError — connection failed or lost
ModbusProtocolError   — parse / framing error
ModbusDeviceException — remote device returned a Modbus exception code
ModbusConfigError     — bad constructor arguments
ModbusInvalidArgument — invalid argument passed to a Modbus call
"""

from importlib.metadata import version, PackageNotFoundError

from ._modbus_rs import (
    # clients
    TcpClient,
    AsyncTcpClient,
    SerialClient,
    AsyncSerialClient,
    # server
    ModbusApp,
    AsyncTcpServer,
    TcpServer,
    AsyncSerialServer,
    SerialServer,
    # exceptions
    ModbusError,
    ModbusTimeout,
    ModbusConnectionError,
    ModbusProtocolError,
    ModbusDeviceException,
    ModbusConfigError,
    ModbusInvalidArgument,
)

# Gateway classes are only available when the extension is built with the
# `python-gateway` feature.
try:
    from ._modbus_rs import (  # type: ignore[attr-defined]
        AsyncTcpGateway,
        GatewayEventHandler,
        TcpGateway,
    )
    _GATEWAY_AVAILABLE = True
except ImportError:
    _GATEWAY_AVAILABLE = False

try:
    __version__ = version("modbus-rs")
except PackageNotFoundError:
    __version__ = "0.0.0+unknown"

__all__ = [
    # clients
    "TcpClient",
    "AsyncTcpClient",
    "SerialClient",
    "AsyncSerialClient",
    # server
    "ModbusApp",
    "AsyncTcpServer",
    "TcpServer",
    "AsyncSerialServer",
    "SerialServer",
    # exceptions
    "ModbusError",
    "ModbusTimeout",
    "ModbusConnectionError",
    "ModbusProtocolError",
    "ModbusDeviceException",
    "ModbusConfigError",
    "ModbusInvalidArgument",
]

if _GATEWAY_AVAILABLE:
    __all__ += [
        "AsyncTcpGateway",
        "GatewayEventHandler",
        "TcpGateway",
    ]