Skip to content

vaem_helper

Helper functions for VAEM driver.

For further reference, see the VAEM documentation found at the Product Page or Operation Instructions.

VaemAccess

Bases: IntEnum

Enum class for the access type to the VAEM.

Attributes:

Name Type Description
READ 0

Read access
WRITE 1

Write access
Source code in src/vaem/vaem_helper.py 
22
23
24
25
26
27
28
29
30
31
32
class VaemAccess(IntEnum):
    """
    Enum class for the access type to the VAEM.

    Attributes:
        READ (0): Read access
        WRITE (1): Write access
    """

    READ = 0
    WRITE = 1

VaemControlWords

Bases: IntEnum

Enum class for the VAEM control words.

Attributes:

Name Type Description
STARTVALVES 1

Start Valves
STOPVALVES 4

Stop Valves
RESETERRORS 8

Reset Errors
STARTVALVESRESETERROR 9

Start valves and reset error bit after completion
Source code in src/vaem/vaem_helper.py 
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
class VaemControlWords(IntEnum):
    """
    Enum class for the VAEM control words.

    Attributes:
        STARTVALVES (0x01): Start Valves
        STOPVALVES (0x04): Stop Valves
        RESETERRORS (0x08): Reset Errors
        STARTVALVESRESETERROR (0x09): Start valves and reset error bit after completion
    """

    STARTVALVES = 0x01
    STOPVALVES = 0x04
    RESETERRORS = 0x08
    STARTVALVESRESETERROR = STARTVALVES + RESETERRORS

VaemDataType

Bases: IntEnum

Enum class for the data type being passed to and from the VAEM.

Attributes:

Name Type Description
UINT8 1

Unsigned 8-bit integer
UINT16 2

Unsigned 16-bit integer
UINT32 3

Unsigned 32-bit integer
UINT64 4

Unsigned 64-bit integer
Source code in src/vaem/vaem_helper.py 
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
class VaemDataType(IntEnum):
    """
    Enum class for the data type being passed to and from the VAEM.

    Attributes:
        UINT8 (1): Unsigned 8-bit integer
        UINT16 (2): Unsigned 16-bit integer
        UINT32 (3): Unsigned 32-bit integer
        UINT64 (4): Unsigned 64-bit integer
    """

    UINT8 = 1
    UINT16 = 2
    UINT32 = 3
    UINT64 = 4

VaemIndex

Bases: IntEnum

Mapping of indices for the VAEM parameters.

Attributes:

Name Type Description
CONTROLWORD 1

Control Word
STATUSWORD 2

Status Word
NOMINALVOLTAGE 4

Nominal Voltage
INRUSHCURRENT 5

Inrush Current
HOLDINGCURRENT 6

Holding Current
SWITCHINGTIME 7

Switching Time
PICKUPTIME 8

Pick Up Time
OPERATINGMODE 9

Operating Mode
SAVEPARAMETERS 17

Save Parameters
SELECTVALVE 19

Select Valve
TIMEDELAY 22

Time Delay
ERRORHANDLING 45

Activate or Deactivate Error Handling
CURRENTREDUCTIONTIME 46

Current Reduction Time
Source code in src/vaem/vaem_helper.py 
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
class VaemIndex(IntEnum):
    """
    Mapping of indices for the VAEM parameters.

    Attributes:
        CONTROLWORD (0x01): Control Word
        STATUSWORD (0x02): Status Word
        NOMINALVOLTAGE (0x04): Nominal Voltage
        INRUSHCURRENT (0x05): Inrush Current
        HOLDINGCURRENT (0x06): Holding Current
        SWITCHINGTIME (0x07): Switching Time
        PICKUPTIME (0x08): Pick Up Time
        OPERATINGMODE (0x09): Operating Mode
        SAVEPARAMETERS (0x11): Save Parameters
        SELECTVALVE (0x13): Select Valve
        TIMEDELAY (0x16): Time Delay
        ERRORHANDLING (0x2D): Activate or Deactivate Error Handling
        CURRENTREDUCTIONTIME (0x2E): Current Reduction Time
    """

    CONTROLWORD = 0x01
    STATUSWORD = 0x02
    NOMINALVOLTAGE = 0x04
    INRUSHCURRENT = 0x05
    HOLDINGCURRENT = 0x06
    SWITCHINGTIME = 0x07
    PICKUPTIME = 0x08
    OPERATINGMODE = 0x09
    SAVEPARAMETERS = 0x11
    SELECTVALVE = 0x13
    TIMEDELAY = 0x16
    ERRORHANDLING = 0x2D
    CURRENTREDUCTIONTIME = 0x2E

VaemOperatingMode

Bases: IntEnum

Enum class for the VAEM operating modes.

Attributes:

Name Type Description
OPMODE1 0

Operating Mode 1 -- Internal via control word via communication interface
OPMODE2 1

Operating Mode 2 -- External by 24 V trigger input, set switching time of the individual valves
OPMODE3 2

Operating Mode 3 -- External by 24 V trigger input, duration of the trigger input
Source code in src/vaem/vaem_helper.py 
104
105
106
107
108
109
110
111
112
113
114
115
116
class VaemOperatingMode(IntEnum):
    """
    Enum class for the VAEM operating modes.

    Attributes:
        OPMODE1 (0x00): Operating Mode 1 -- Internal via control word via communication interface
        OPMODE2 (0x01): Operating Mode 2 -- External by 24 V trigger input, set switching time of the individual valves
        OPMODE3 (0x02): Operating Mode 3 -- External by 24 V trigger input, duration of the trigger input
    """

    OPMODE1 = 0x00
    OPMODE2 = 0x01
    OPMODE3 = 0x02