Clients

A client is used by a knx_plugin.gateway.definition.Gateway() to connect the KNX bus through a KNX gateway device.

Abstract

class knx_plugin.client.Client(on_con_lost, knx_state: knx_stack.state.State, tasks: Iterable[Callable])

connection_made(transport)

Called when a connection is made.

The argument is the transport representing the pipe connection. To receive data, wait for data_received() calls. When the connection is closed, connection_lost() is called.

connection_lost(exc)

Called when the connection is lost or closed.

The argument is an exception object or None (the latter meaning a regular EOF is received or the connection was aborted or closed).

error_received(exc)

encode(msg: Union[knx_stack.definition.layer.application.a_group_value_write.req.Msg, knx_stack.definition.layer.application.a_group_value_write.ind.Msg]) → knx_stack.msg.Msg

filter(msgs: Iterable[Union[knx_stack.definition.layer.application.a_group_value_read.req.Msg, knx_stack.definition.layer.application.a_group_value_write.req.Msg, knx_stack.definition.layer.application.a_group_value_read.con.Msg, knx_stack.definition.layer.application.a_group_value_write.con.Msg, knx_stack.definition.layer.application.a_group_value_read.ind.Msg, knx_stack.definition.layer.application.a_group_value_write.ind.Msg]]) → Tuple[Iterable[Union[knx_stack.definition.layer.application.a_group_value_write.req.Msg, knx_stack.definition.layer.application.a_group_value_read.req.Msg]], Iterable[Union[knx_stack.definition.layer.application.a_group_value_read.con.Msg, knx_stack.definition.layer.application.a_group_value_write.con.Msg]], Iterable[Union[knx_stack.definition.layer.application.a_group_value_read.ind.Msg, knx_stack.definition.layer.application.a_group_value_write.ind.Msg]], Iterable[Any]]

async write(msgs, *args)

USB HID

The connected knx gateway device is a USB HID device.

class knx_plugin.client.usbhid.Client(on_con_lost, knx_state: knx_stack.state.State, tasks: Iterable[Callable])

KNXNET IP

The connected knx gateway device is a KNXNET IP device.

class knx_plugin.client.knxnet_ip.Client(on_con_close, knx_state: knx_stack.state.State, tasks: Iterable[Callable], local_addr: str, local_port: int, remote_addr: str, remote_port: int)