hvl_ccb.dev.cube.constants

digraph inheritance61c2413fe5 { bgcolor=transparent; rankdir=TB; size=""; "DoorStatus" [URL="../hvl_ccb.dev.cube.constants.html#hvl_ccb.dev.cube.constants.DoorStatus",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Possible status values for doors."]; "IntEnum" -> "DoorStatus" [arrowsize=0.5,style="setlinewidth(0.5)"]; "EarthingRodStatus" [URL="../hvl_ccb.dev.cube.constants.html#hvl_ccb.dev.cube.constants.EarthingRodStatus",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Possible status values for earthing rods."]; "IntEnum" -> "EarthingRodStatus" [arrowsize=0.5,style="setlinewidth(0.5)"]; "Enum" [fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",tooltip="An enumeration."]; "IntEnum" [fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",tooltip="Enum where members are also (and must be) ints"]; "ReprEnum" -> "IntEnum" [arrowsize=0.5,style="setlinewidth(0.5)"]; "MessageBoard" [URL="../hvl_ccb.dev.cube.constants.html#hvl_ccb.dev.cube.constants.MessageBoard",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="An enumeration."]; "Polarity" [URL="../hvl_ccb.dev.cube.constants.html#hvl_ccb.dev.cube.constants.Polarity",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="An enumeration."]; "IntEnum" -> "Polarity" [arrowsize=0.5,style="setlinewidth(0.5)"]; "PowerSetup" [URL="../hvl_ccb.dev.cube.constants.html#hvl_ccb.dev.cube.constants.PowerSetup",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Possible power setups corresponding to the value of variable :attr:`Power.setup`."]; "IntEnum" -> "PowerSetup" [arrowsize=0.5,style="setlinewidth(0.5)"]; "ReprEnum" [fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",tooltip="Only changes the repr(), leaving str() and format() to the mixed-in type."]; "Enum" -> "ReprEnum" [arrowsize=0.5,style="setlinewidth(0.5)"]; "SafetyStatus" [URL="../hvl_ccb.dev.cube.constants.html#hvl_ccb.dev.cube.constants.SafetyStatus",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Safety status values that are possible states returned from"]; "IntEnum" -> "SafetyStatus" [arrowsize=0.5,style="setlinewidth(0.5)"]; }

Constants, variable names for the BaseCube OPC-connected devices.

class DoorStatus(value=<no_arg>, names=None, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: IntEnum

Possible status values for doors.

CLOSED = 2

Door is closed, but not locked.

ERROR = 4

Door has an error or was opened in locked state (either with emergency stop or from the inside).

INACTIVE = 0

not enabled in BaseCube HMI setup, this door is not supervised.

LOCKED = 3

Door is closed and locked (safe state).

OPEN = 1

Door is open.

class EarthingRodStatus(value=<no_arg>, names=None, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: IntEnum

Possible status values for earthing rods.

EXPERIMENT_BLOCKED = 0

earthing rod is somewhere in the experiment and blocks the start of the experiment

EXPERIMENT_READY = 1

earthing rod is hanging next to the door, experiment is ready to operate

class MessageBoard(value=<no_arg>, names=None, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: _LineEnumBase

Variable NodeID strings for message board lines.

LINE_1 = '"DB_OPC_Connection"."Is_status_Line_1"'

LINE_10 = '"DB_OPC_Connection"."Is_status_Line_10"'

LINE_11 = '"DB_OPC_Connection"."Is_status_Line_11"'

LINE_12 = '"DB_OPC_Connection"."Is_status_Line_12"'

LINE_13 = '"DB_OPC_Connection"."Is_status_Line_13"'

LINE_14 = '"DB_OPC_Connection"."Is_status_Line_14"'

LINE_15 = '"DB_OPC_Connection"."Is_status_Line_15"'

LINE_2 = '"DB_OPC_Connection"."Is_status_Line_2"'

LINE_3 = '"DB_OPC_Connection"."Is_status_Line_3"'

LINE_4 = '"DB_OPC_Connection"."Is_status_Line_4"'

LINE_5 = '"DB_OPC_Connection"."Is_status_Line_5"'

LINE_6 = '"DB_OPC_Connection"."Is_status_Line_6"'

LINE_7 = '"DB_OPC_Connection"."Is_status_Line_7"'

LINE_8 = '"DB_OPC_Connection"."Is_status_Line_8"'

LINE_9 = '"DB_OPC_Connection"."Is_status_Line_9"'

class Polarity(value=<no_arg>, names=None, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: IntEnum

An enumeration.

NEGATIVE = 0

POSITIVE = 1

class PowerSetup(value=<no_arg>, names=None, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: IntEnum

Possible power setups corresponding to the value of variable Power.setup. The values for slope_min are experimentally defined, below these values the slope is more like a staircase

The name of the first argument needs to be ‘value’, otherwise the IntEnum is not working correctly.

AC_100KV = 3

AC_150KV = 4

AC_200KV = 5

AC_50KV = 2

DC_140KV = 7

DC_280KV = 8

EXTERNAL_SOURCE = 1

IMPULSE_140KV = 9

NO_SOURCE = 0

POWER_INVERTER_220V = 6

STOP_SAFETY_STATUSES: tuple[hvl_ccb.dev.cube.constants.SafetyStatus, ...] = (<SafetyStatus.GREEN_NOT_READY: 1>, <SafetyStatus.GREEN_READY: 2>)

BaseCube’s safety statuses required to close the connection to the device.

class SafetyStatus(value=<no_arg>, names=None, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: IntEnum

Safety status values that are possible states returned from hvl_ccb.dev.cube.base.BaseCube.status(). These values correspond to the states of the BaseCube’s safety circuit statemachine.

ERROR = 6

GREEN_NOT_READY = 1

GREEN_READY = 2

INITIALIZING = 0

QUICK_STOP = 5

RED_OPERATE = 4

RED_READY = 3