Dane Sabo
3299181c70
M lazy-lock.json M lua/custom/configs/lspconfig.lua M lua/custom/init.lua A lua/custom/journal.lua A nvim_venv/bin/Activate.ps1 A nvim_venv/bin/activate A nvim_venv/bin/activate.csh A nvim_venv/bin/activate.fish
266 lines
8.8 KiB
Python
266 lines
8.8 KiB
Python
"""Base for all clients."""
|
|
from __future__ import annotations
|
|
|
|
import asyncio
|
|
from abc import abstractmethod
|
|
from collections.abc import Awaitable, Callable
|
|
|
|
from pymodbus.client.mixin import ModbusClientMixin
|
|
from pymodbus.exceptions import ConnectionException
|
|
from pymodbus.framer import FRAMER_NAME_TO_CLASS, FramerBase, FramerType
|
|
from pymodbus.logging import Log
|
|
from pymodbus.pdu import DecodePDU, ModbusPDU
|
|
from pymodbus.transaction import TransactionManager
|
|
from pymodbus.transport import CommParams
|
|
|
|
|
|
class ModbusBaseClient(ModbusClientMixin[Awaitable[ModbusPDU]]):
|
|
"""**ModbusBaseClient**.
|
|
|
|
:mod:`ModbusBaseClient` is normally not referenced outside :mod:`pymodbus`.
|
|
"""
|
|
|
|
def __init__(
|
|
self,
|
|
framer: FramerType,
|
|
retries: int,
|
|
comm_params: CommParams,
|
|
trace_packet: Callable[[bool, bytes], bytes] | None,
|
|
trace_pdu: Callable[[bool, ModbusPDU], ModbusPDU] | None,
|
|
trace_connect: Callable[[bool], None] | None,
|
|
) -> None:
|
|
"""Initialize a client instance.
|
|
|
|
:meta private:
|
|
"""
|
|
ModbusClientMixin.__init__(self) # type: ignore[arg-type]
|
|
self.comm_params = comm_params
|
|
self.ctx = TransactionManager(
|
|
comm_params,
|
|
(FRAMER_NAME_TO_CLASS[framer])(DecodePDU(False)),
|
|
retries,
|
|
False,
|
|
trace_packet,
|
|
trace_pdu,
|
|
trace_connect,
|
|
)
|
|
|
|
@property
|
|
def connected(self) -> bool:
|
|
"""Return state of connection."""
|
|
return self.ctx.is_active()
|
|
|
|
async def connect(self) -> bool:
|
|
"""Call transport connect."""
|
|
self.ctx.reset_delay()
|
|
Log.debug(
|
|
"Connecting to {}:{}.",
|
|
self.ctx.comm_params.host,
|
|
self.ctx.comm_params.port,
|
|
)
|
|
rc = await self.ctx.connect()
|
|
await asyncio.sleep(0.1)
|
|
return rc
|
|
|
|
def register(self, custom_response_class: type[ModbusPDU]) -> None:
|
|
"""Register a custom response class with the decoder (call **sync**).
|
|
|
|
:param custom_response_class: (optional) Modbus response class.
|
|
:raises MessageRegisterException: Check exception text.
|
|
|
|
Use register() to add non-standard responses (like e.g. a login prompt) and
|
|
have them interpreted automatically.
|
|
"""
|
|
self.ctx.framer.decoder.register(custom_response_class)
|
|
|
|
def close(self) -> None:
|
|
"""Close connection."""
|
|
self.ctx.close()
|
|
|
|
def execute(self, no_response_expected: bool, request: ModbusPDU):
|
|
"""Execute request and get response (call **sync/async**).
|
|
|
|
:meta private:
|
|
"""
|
|
if not self.ctx.transport:
|
|
raise ConnectionException(f"Not connected[{self!s}]")
|
|
return self.ctx.execute(no_response_expected, request)
|
|
|
|
def set_max_no_responses(self, max_count: int) -> None:
|
|
"""Override default max no request responses.
|
|
|
|
:param max_count: Max aborted requests before disconnecting.
|
|
|
|
The parameter retries defines how many times a request is retried
|
|
before being aborted. Once aborted a counter is incremented, and when
|
|
this counter is greater than max_count the connection is terminated.
|
|
|
|
.. tip::
|
|
When a request is successful the count is reset.
|
|
"""
|
|
self.ctx.max_until_disconnect = max_count
|
|
|
|
async def __aenter__(self):
|
|
"""Implement the client with enter block.
|
|
|
|
:returns: The current instance of the client
|
|
:raises ConnectionException:
|
|
"""
|
|
await self.connect()
|
|
return self
|
|
|
|
async def __aexit__(self, klass, value, traceback):
|
|
"""Implement the client with aexit block."""
|
|
self.close()
|
|
|
|
def __str__(self):
|
|
"""Build a string representation of the connection.
|
|
|
|
:returns: The string representation
|
|
"""
|
|
return (
|
|
f"{self.__class__.__name__} {self.ctx.comm_params.host}:{self.ctx.comm_params.port}"
|
|
)
|
|
|
|
|
|
class ModbusBaseSyncClient(ModbusClientMixin[ModbusPDU]):
|
|
"""**ModbusBaseClient**.
|
|
|
|
:mod:`ModbusBaseClient` is normally not referenced outside :mod:`pymodbus`.
|
|
"""
|
|
|
|
def __init__(
|
|
self,
|
|
framer: FramerType,
|
|
retries: int,
|
|
comm_params: CommParams,
|
|
trace_packet: Callable[[bool, bytes], bytes] | None,
|
|
trace_pdu: Callable[[bool, ModbusPDU], ModbusPDU] | None,
|
|
trace_connect: Callable[[bool], None] | None,
|
|
) -> None:
|
|
"""Initialize a client instance.
|
|
|
|
:meta private:
|
|
"""
|
|
ModbusClientMixin.__init__(self) # type: ignore[arg-type]
|
|
self.comm_params = comm_params
|
|
self.retries = retries
|
|
self.slaves: list[int] = []
|
|
|
|
# Common variables.
|
|
self.framer: FramerBase = (FRAMER_NAME_TO_CLASS[framer])(DecodePDU(False))
|
|
self.transaction = TransactionManager(
|
|
self.comm_params,
|
|
self.framer,
|
|
retries,
|
|
False,
|
|
trace_packet,
|
|
trace_pdu,
|
|
trace_connect,
|
|
sync_client=self,
|
|
)
|
|
self.reconnect_delay_current = self.comm_params.reconnect_delay or 0
|
|
self.use_udp = False
|
|
self.last_frame_end: float | None = 0
|
|
self.silent_interval: float = 0
|
|
|
|
# ----------------------------------------------------------------------- #
|
|
# Client external interface
|
|
# ----------------------------------------------------------------------- #
|
|
def register(self, custom_response_class: type[ModbusPDU]) -> None:
|
|
"""Register a custom response class with the decoder.
|
|
|
|
:param custom_response_class: (optional) Modbus response class.
|
|
:raises MessageRegisterException: Check exception text.
|
|
|
|
Use register() to add non-standard responses (like e.g. a login prompt) and
|
|
have them interpreted automatically.
|
|
"""
|
|
self.framer.decoder.register(custom_response_class)
|
|
|
|
def idle_time(self) -> float:
|
|
"""Time before initiating next transaction (call **sync**).
|
|
|
|
Applications can call message functions without checking idle_time(),
|
|
this is done automatically.
|
|
"""
|
|
if self.last_frame_end is None or self.silent_interval is None:
|
|
return 0
|
|
return self.last_frame_end + self.silent_interval
|
|
|
|
def execute(self, no_response_expected: bool, request: ModbusPDU) -> ModbusPDU:
|
|
"""Execute request and get response (call **sync/async**).
|
|
|
|
:param no_response_expected: The client will not expect a response to the request
|
|
:param request: The request to process
|
|
:returns: The result of the request execution
|
|
:raises ConnectionException: Check exception text.
|
|
|
|
:meta private:
|
|
"""
|
|
if not self.connect():
|
|
raise ConnectionException(f"Failed to connect[{self!s}]")
|
|
return self.transaction.sync_execute(no_response_expected, request)
|
|
|
|
def set_max_no_responses(self, max_count: int) -> None:
|
|
"""Override default max no request responses.
|
|
|
|
:param max_count: Max aborted requests before disconnecting.
|
|
|
|
The parameter retries defines how many times a request is retried
|
|
before being aborted. Once aborted a counter is incremented, and when
|
|
this counter is greater than max_count the connection is terminated.
|
|
|
|
.. tip::
|
|
When a request is successful the count is reset.
|
|
"""
|
|
self.transaction.max_until_disconnect = max_count
|
|
|
|
# ----------------------------------------------------------------------- #
|
|
# Internal methods
|
|
# ----------------------------------------------------------------------- #
|
|
@abstractmethod
|
|
def send(self, request: bytes, addr: tuple | None = None) -> int:
|
|
"""Send request.
|
|
|
|
:meta private:
|
|
"""
|
|
|
|
@abstractmethod
|
|
def recv(self, size: int | None) -> bytes:
|
|
"""Receive data.
|
|
|
|
:meta private:
|
|
"""
|
|
|
|
def connect(self) -> bool: # type: ignore[empty-body]
|
|
"""Connect to other end, overwritten."""
|
|
|
|
def close(self):
|
|
"""Close connection, overwritten."""
|
|
|
|
# ----------------------------------------------------------------------- #
|
|
# The magic methods
|
|
# ----------------------------------------------------------------------- #
|
|
def __enter__(self):
|
|
"""Implement the client with enter block.
|
|
|
|
:returns: The current instance of the client
|
|
:raises ConnectionException:
|
|
"""
|
|
self.connect()
|
|
return self
|
|
|
|
def __exit__(self, klass, value, traceback):
|
|
"""Implement the client with exit block."""
|
|
self.close()
|
|
|
|
def __str__(self):
|
|
"""Build a string representation of the connection.
|
|
|
|
:returns: The string representation
|
|
"""
|
|
return (
|
|
f"{self.__class__.__name__} {self.comm_params.host}:{self.comm_params.port}"
|
|
)
|