pyebus.connection module

EBUS Connection Handling.

class pyebus.connection.Connection(host='127.0.0.1', port=8888, autoconnect=False, timeout=10)

Bases: object

EBUS Connection.

Keyword Arguments:

• host (str) – Hostname or IP

• port (int) – Port

• autoconnect (bool) – Automatically connect and re-connect

• timeout (int) – Connection Timeout

property host

Host.

property port

Port.

property autoconnect

Automatically connect and re-connect.

property timeout

Connection Timeout.

async async_connect()

Establish connection (required before first communication).

Raises:

ConnectionRefusedError – If connection cannot be established

async async_disconnect()

Disconnect if not already done.

is_connected()

Return True if connection is established.

This does not check if the connection is still usable.

Returns:

bool

async async_write(message)

Send TCP message to EBUSD.

Raises:

• ConnectionRefusedError – If connection cannot be established

• ConnectionError – If not connected (autoconnect==False)

async async_request(cmd, *args, **kwargs)

Assemble request starting with cmd and position args and keywords `kwargs’.

Raises:

• ConnectionRefusedError – If connection cannot be established

• ConnectionError – If not connected (autoconnect==False)

async async_read(infinite=False, check=True)

Receive lines until an empty one (infinite==False) or infinitly (infinite==True).

Yields:

str – line read

Raises:

• ConnectionRefusedError – If connection cannot be established

• ConnectionError – If not connected (autoconnect==False)

• CommandError – If command failed (check==True)

• Shutdown – On EBUSD shutdown.

async async_readresp(check=True)

Receive command response.

Read one line as command response and one empty line.

Returns:

response

Return type:

str

Raises:

• ConnectionRefusedError – If connection cannot be established

• ConnectionError – If not connected (autoconnect==False)

• CommandError – If command failed (check==True) or trailing data.

• Shutdown – On EBUSD shutdown.