Skip to content

vaem_config

Holds all the different VAEM configurations for the different backends.

These are the supported client interface configurations for the VAEM valve control module

Typical usage examples

vaem_config = VAEMTCPConfig(interface="tcp/ip", ip=ip, port=502)

vaem = VAEM(config=vaem_config)

VAEMConfig dataclass

Generic VAEM config dataclass for initialization.

Attributes:

Name Type Description
interface str

Interface to connect to VAEM. Ex: 'tcp/ip', 'serial'
unit_id int

Modbus Unit ID of the VAEM (default: 1)
Source code in src/vaem/vaem_config.py 
15
16
17
18
19
20
21
22
23
24
25
26
@dataclass(kw_only=True)
class VAEMConfig:
    """
    Generic VAEM config dataclass for initialization.

    Attributes:
        interface (str): Interface to connect to VAEM. Ex: 'tcp/ip', 'serial'
        unit_id (int): Modbus Unit ID of the VAEM (default: 1)
    """

    interface: str
    unit_id: int = 1

VAEMSerialConfig dataclass

Bases: VAEMConfig

Dataclass for VAEM Serial connection.

Attributes:

Name Type Description
com_port str

COM port to connect to VAEM
baudrate int

Baudrate for the serial connection (default: 9600). Ex: 9600, 19200, 38400, 57600, 115200
Typical usage example

vaem_serial_config = VAEMSerialConfig(interface = "serial", com_port = "COM3", baudrate = 9600)

vaem = VAEM(vaem_serial_config)

Source code in src/vaem/vaem_config.py 
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
@dataclass(kw_only=True)
class VAEMSerialConfig(VAEMConfig):
    """
    Dataclass for VAEM Serial connection.

    Attributes:
        com_port (str): COM port to connect to VAEM
        baudrate (int): Baudrate for the serial connection (default: 9600). Ex: 9600, 19200, 38400, 57600, 115200

    Typical usage example:
        vaem_serial_config = VAEMSerialConfig(interface = "serial", com_port = "COM3", baudrate = 9600)

        vaem = VAEM(vaem_serial_config)
    """

    com_port: str
    baudrate: int

VAEMTCPConfig dataclass

Bases: VAEMConfig

Datclass for VAEM TCP/IP connection.

Attributes:

Name Type Description
ip str

IP address of the VAEM
port int

Port number of the VAEM (default: 502)
Typical usage example

vaem_config = VAEMTCPConfig(interface="tcp/ip", ip=ip, port=502)

vaem = VAEM(config=vaem_config)

Source code in src/vaem/vaem_config.py 
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
@dataclass(kw_only=True)
class VAEMTCPConfig(VAEMConfig):
    """
    Datclass for VAEM TCP/IP connection.

    Attributes:
        ip (str): IP address of the VAEM
        port (int): Port number of the VAEM (default: 502)

    Typical usage example:
        vaem_config = VAEMTCPConfig(interface="tcp/ip", ip=ip, port=502)

        vaem = VAEM(config=vaem_config)
    """

    ip: str
    port: int = 502