hvl_ccb.dev.supercube.typ_a

Inheritance diagram of hvl_ccb.dev.supercube.typ_a

Supercube Typ A module.

class SupercubeAOpcUaCommunication(config)[source]

Bases: hvl_ccb.dev.supercube.base.SupercubeOpcUaCommunication

static config_cls()[source]

Return the default configdataclass class.

Returns

a reference to the default configdataclass class

class SupercubeAOpcUaConfiguration(host: str, endpoint_name: str = 'Supercube Typ A', port: int = 4840, sub_handler: hvl_ccb.comm.opc.OpcUaSubHandler = <hvl_ccb.dev.supercube.base.SupercubeSubscriptionHandler object at 0x7fed1b3dd210>, update_period: int = 500, wait_timeout_retry_sec: Union[int, float] = 1, max_timeout_retry_nr: int = 5)[source]

Bases: hvl_ccb.dev.supercube.base.SupercubeOpcUaCommunicationConfig

endpoint_name: str = 'Supercube Typ A'

Endpoint of the OPC server, this is a path like ‘OPCUA/SimulationServer’

force_value(fieldname, value)

Forces a value to a dataclass field despite the class being frozen.

NOTE: you can define post_force_value method with same signature as this method to do extra processing after value has been forced on fieldname.

Parameters
  • fieldname – name of the field

  • value – value to assign

classmethod keys() Sequence[str]

Returns a list of all configdataclass fields key-names.

Returns

a list of strings containing all keys.

classmethod optional_defaults() Dict[str, object]

Returns a list of all configdataclass fields, that have a default value assigned and may be optionally specified on instantiation.

Returns

a list of strings containing all optional keys.

classmethod required_keys() Sequence[str]

Returns a list of all configdataclass fields, that have no default value assigned and need to be specified on instantiation.

Returns

a list of strings containing all required keys.

class SupercubeWithFU(com, dev_config=None)[source]

Bases: hvl_ccb.dev.supercube.base.SupercubeBase

Variant A of the Supercube with frequency converter.

static default_com_cls()[source]

Get the class for the default communication protocol used with this device.

Returns

the type of the standard communication protocol for this device

fso_reset() None[source]

TODO: test fso_reset with device

Reset the fast switch off circuitry to go back into normal state and allow to re-enable operate mode.

get_frequency() float[source]

TODO: test get_frequency with device

Read the electrical frequency of the current Supercube setup.

Returns

the frequency in Hz

get_fso_active() bool[source]

TODO: test get_fso_active with device

Get the state of the fast switch off functionality. Returns True if it is enabled, False otherwise.

Returns

state of the FSO functionality

get_max_voltage() float[source]

TODO: test get_max_voltage with device

Reads the maximum voltage of the setup and returns in V.

Returns

the maximum voltage of the setup in V.

get_power_setup() hvl_ccb.dev.supercube.constants.PowerSetup[source]

TODO: test get_power_setup with device

Return the power setup selected in the Supercube’s settings.

Returns

the power setup

get_primary_current() float[source]

TODO: get_primary_current with device

Read the current primary current at the output of the frequency converter ( before transformer).

Returns

primary current in A

get_primary_voltage() float[source]

TODO: test get_primary_voltage with device

Read the current primary voltage at the output of the frequency converter ( before transformer).

Returns

primary voltage in V

get_target_voltage() float[source]

TODO: test get_target_voltage with device

Gets the current setpoint of the output voltage value in V. This is not a measured value but is the corresponding function to set_target_voltage().

Returns

the setpoint voltage in V.

set_slope(slope: float) None[source]

TODO: test set_slope with device

Sets the dV/dt slope of the Supercube frequency converter to a new value in V/s.

Parameters

slope – voltage slope in V/s (0..15)

set_target_voltage(volt_v: float) None[source]

TODO: test set_target_voltage with device

Set the output voltage to a defined value in V.

Parameters

volt_v – the desired voltage in V