pymodbus.client.async package

Async Modbus Client implementation based on Twisted, tornado and asyncio

Example run:

from pymodbus.client.async import schedulers

# Import The clients

from pymodbus.client.async.tcp import AsyncModbusTCPClient as Client
from pymodbus.client.async.serial import AsyncModbusSerialClient as Client
from pymodbus.client.async.udp import AsyncModbusUDPClient as Client

# For tornado based async client use
event_loop, future = Client(schedulers.IO_LOOP, port=5020)

# For twisted based async client use
event_loop, future = Client(schedulers.REACTOR, port=5020)

# For asyncio based async client use
event_loop, client = Client(schedulers.ASYNC_IO, port=5020)

# Here event_loop is a thread which would control the backend and future is
# a Future/deffered object which would be used to
# add call backs to run asynchronously.

# The Actual client could be accessed with future.result() with Tornado
# and future.result when using twisted

# For asyncio the actual client is returned and event loop is asyncio loop

Submodules

pymodbus.client.async.serial module

class pymodbus.client.async.serial.AsyncModbusSerialClient

Bases: object

Actual Async Serial Client to be used.

To use do:

from pymodbus.client.async.serial import AsyncModbusSerialClient

pymodbus.client.async.tcp module

class pymodbus.client.async.tcp.AsyncModbusTCPClient

Bases: object

Actual Async Serial Client to be used.

To use do:

from pymodbus.client.async.tcp import AsyncModbusTCPClient

pymodbus.client.async.thread module

class pymodbus.client.async.thread.EventLoopThread(name, start, stop, *args, **kwargs)

Bases: object

Event loop controlling the backend event loops (io_loop for tornado, reactor for twisted and event_loop for Asyncio)

start()

Starts the backend event loop :return:

stop()

Stops the backend event loop :return:

pymodbus.client.async.udp module

class pymodbus.client.async.udp.AsyncModbusUDPClient

Bases: object

Actual Async UDP Client to be used.

To use do:

from pymodbus.client.async.tcp import AsyncModbusUDPClient