Skip to content

pgva_config

Wrapper for the configurations of the PGVA communication backend.

This holds all the different PGVA-1 configurations for different backends

PGVAConfig dataclass

Generic class PGVA-1 dataclass for initalization.

Attributes:

Name Type Description
interface str

Interface type. Ex: 'tcp/ip', 'serial', 'codes
unit_id int

Modbus unit ID of the PGVA-1 device
Source code in src/pgva/pgva_config.py 
10
11
12
13
14
15
16
17
18
19
20
21
@dataclass(kw_only=True)
class PGVAConfig:
    """
    Generic class PGVA-1 dataclass for initalization.

    Attributes:
        interface (str): Interface type. Ex: 'tcp/ip', 'serial', 'codes
        unit_id (int): Modbus unit ID of the PGVA-1 device
    """

    interface: str
    unit_id: int = 1

PGVASerialConfig dataclass

Bases: PGVAConfig

Class PGVA-1 configuration for serial connection.

Attributes:

Name Type Description
com_port str

COM port of the serial connection. Ex: 'COM3' or '/dev/ttyUSB0'
baudrate int

Baudrate of the serial connection. Ex: 9600, 19200, 115200
Source code in src/pgva/pgva_config.py 
38
39
40
41
42
43
44
45
46
47
48
49
@dataclass(kw_only=True)
class PGVASerialConfig(PGVAConfig):
    """
    Class PGVA-1 configuration for serial connection.

    Attributes:
        com_port (str): COM port of the serial connection. Ex: 'COM3' or '/dev/ttyUSB0'
        baudrate (int): Baudrate of the serial connection. Ex: 9600, 19200, 115200
    """

    com_port: str
    baudrate: int

PGVATCPConfig dataclass

Bases: PGVAConfig

Class for PGVA-1 configuration class for ModbusTCP connection.

Attributes:

Name Type Description
ip str

IP address of PGVA in string form. Ex: '192.168.0.1'
port int

Default to 502, port of connunication for the PGVA-1
Source code in src/pgva/pgva_config.py 
24
25
26
27
28
29
30
31
32
33
34
35
@dataclass(kw_only=True)
class PGVATCPConfig(PGVAConfig):
    """
    Class for PGVA-1 configuration class for ModbusTCP connection.

    Attributes:
        ip (str): IP address of PGVA in string form. Ex: '192.168.0.1'
        port (int): Default to 502, port of connunication for the PGVA-1
    """

    ip: str
    port: int = 502