![]() |
TopCon API
1.1.0
.Net API to control TopCon devices
|
This is the main TopCon object. More...
Classes | |
struct | DeviceControlMode |
Gets Data about the actual state of device control mode. More... | |
Public Types | |
enum | Status : uint { Status.Offline = 0, Status.PowerUp = 2, Status.Ready = 4, Status.Run = 8, Status.Warn = 10, Status.Error = 12, Status.Stop = 14 } |
This enumeration is a representation of the internal system state. OFFLINE: TopCon object is a pure virtual structure CONNECTED: TonCon object connected with a true TopCon device. More... | |
enum | RemoteControl : uint { RemoteControl.Analog = 0, RemoteControl.HmiHme = 1, RemoteControl.Rs232 = 2, RemoteControl.InternalReferences = 3 } |
Interface ti WrapperBase.RemoteControl More... | |
enum | QuadrantMode : ushort { QuadrantMode.None = 0, QuadrantMode.Q1 = 1, QuadrantMode.Q2 = 2, QuadrantMode.Q3 = 4, QuadrantMode.Q4 = 8 } |
Interface to DeviceInfo.QuadrantMode More... | |
Public Member Functions | |
TopCon () | |
This is the constructor with device id parameter More... | |
BatterySimulation | GetBatterySimulationObject () |
Get a BatterySimulation object (Central class for Battery simulation) You cannot create an object for this type over new command. To obtain that object call this function: Example: var batSimulation = myTopCon.GetBatterySimulationObject(); If the TC device is disconnected or the option BatSim is not installed into the TC device, you get a null object. After obtaining a BatterySimulation object you must configure it. The configuration of a simulation requires 2 steps: More... | |
int | GetNextAvailableComPort () |
Get next free com port or 0 if not found More... | |
DeviceControlMode | GetDeviceControlMode () |
Get a DeviceControlMode structure, with information about the actual state of control mode (Voltage, Current, Power, VoltageSense or PowerSense) More... | |
void | GetCommStatus (ref int state, ref int errorNumber) |
Get the communication state and error flag. Calling this method will also clear the internal communication library flags. The communication to the TopCon device can continue immediately. But still care about exceptions. More... | |
CurveContainer | GetCurveContainer (bool setFuncGeneratorData) |
Create a instanz of CurveContainer More... | |
ErrorWarning.ErrorList | GetErrorList () |
This function returns a reference to the ErrorList. More... | |
TCLIN | GetTclin (uint id) |
This method returns the TC.LIN object with the given id. This object is only needed for TC.LIN module values. TC.LIN system values are automatically switched if TC.LIN and TC.P or TC.MAC support these values. More... | |
bool | UpdateTopConConfigurationWithTopConData () |
After call TopCon constructor with a parameter TopConConfiguration, call the connect method. Afterwards once a UpdateTopConConfigurationWithTopConData() call. This function updates the content of the TopConConfiguration of this TopCon object with the values of the connected TopCon device. More... | |
void | ResetEnergyCounter () |
This function sets the energy counter of the TopCon PS to 0.0 (Reset). This method automatically switch to TC.LIN system values if supported and attached to TC.P or TC.MAC. More... | |
void | SetEnergyCounterToValue (double value) |
This function sets the energy counter of the TopCon PS to the value given as parameter. This method automatically switch to TC.LIN system values if supported and attached to TC.P or TC.MAC. More... | |
double | GetEnergyCounter () |
This function returns the energy counter of the connected TopCon system. This method automatically switch to TC.LIN system values if supported and attached to TC.P or TC.MAC. More... | |
void | ResetChargeCounter () |
This function sets the charge counter of the TopCon PS to 0.0 (Reset). More... | |
void | SetChargeCounterToValue (double value) |
This function sets the charge counter of the TopCon PS to the value given as parameter. More... | |
double | GetChargeCounter () |
This function returns the energy counter of the connected TopCon system. More... | |
void | SetRemoteControlInterface (RemoteControl remoteControl) |
This function allows to set the control of the TopCon to a particular interface. More... | |
RemoteControl | GetRemoteControlInterface () |
This function returns the particular interface who has the control of the TopCon. More... | |
int | GetSystemState () |
This function determines the state the TopCon runs in. More... | |
Status | GetSystemStateEnum () |
This function determines the state the TopCon runs in. More... | |
string | GetSystemStateAsString () |
This function checks the current system state of the TopCon device and returns it as string. More... | |
bool | IsConnected () |
This function indicates if the object is connected to the TopCon device. More... | |
bool | IsInRunState () |
This function returns true if the TopCon system is in "RUN" state. More... | |
bool | IsInReadyState () |
This function returns true if the TopCon system is in "READY" state. More... | |
bool | IsInErrorState () |
This function returns true if the TopCon system is in "ERROR" state. More... | |
bool | IsInWarningState () |
This function returns true if the TopCon system is in "ERROR" state. More... | |
TopConConfiguration | GetTopConConfig () |
This function returns the current TopConConfiguration. The configuration holds the key data of the present TopCon system. (Examples: NominalSystemCurrent or MaximumSystemCurrent) More... | |
FunctionEngine | GetFunctionEngine () |
This returns the FunctionEngine (with CurveList) that is kept inside of the TopCon DEVICE. Please use the corresponding commands to adjust the content of the underlying curvelist with the flash of the TopCon. If the TC device is disconnected or the option Function generator (TopCon TFE) is not installed into the TC device, you get a null object. More... | |
string | GetSerialNumberOfDevice () |
This function read and returns the serial number of the device. More... | |
void | SetCommTimeout (int readTimeout, int writeTimeout) |
This function allows to set the communication timeout parameters for read and write actions from and to the RS-232 interface. This parameter is used when a COM port is opened and defines how long the port waits for acknowledgement data from the other party. Standard value: read = 10, write = 10. Values used with the Regatron Ethernet option (Ethernet-to-RS232 converter): read = 100, write = 100. More... | |
void | SetVoltageBottomReference (Double uBottomRef) |
Set the reference bottom voltage value for a TC.P.LIN device with S3r mode More... | |
double | GetVoltageBottomReference () |
Get the reference bottom voltage value for a TC.P.LIN device with S3r mode More... | |
double | GetVoltageBottomActual () |
Get the actual bottom voltage value for a TC.P.LIN device with S3r mode. More... | |
bool | IsOptionSasEnabled () |
This method indicates if a valid SAS option is available in the connected TopCon. More... | |
bool | IsOptionBatControlEnabled () |
This method indicates if a valid ACCU option is available in the connected TopCon. More... | |
bool | IsOptionTfeEnabled () |
This method indicates if a valid TFE option is available in the connected TopCon. More... | |
int | GetCommunicationTimeoutWrite () |
This function returns the value of the WRITE commTimeout parameter. Standard value: 10. Value for Ethernet-to-RS-232 adapter: 30. More... | |
Int32 | GetCommunicationTimeoutRead () |
This function returns the value of the READ commTimeout parameter. Standard value: 10. Value for Ethernet-to-RS-232 adapter: 100. More... | |
string | GetDllVersionAsString () |
This function returns the information about the TCIO.DLL being used for the connection to the TopCon. More... | |
uint | GetNumberOfTcLinPresent () |
This method returns the number of TCLINs available in the system. More... | |
void | RestartMppTrackingEfficiencyMeasurement () |
Calling this method resets the efficiency measurement in the TopCon device (or in TC.LIN if available). It is recommended to do this once to start a new efficiency measurement period. This method automatically switch to TC.LIN system values if supported and attached to TC.P or TC.MAC. More... | |
double | GetSasEfficiency () |
This method returns the efficiency as being calculated by the SAS middleware. This method automatically switch to TC.LIN system values if supported and attached to TC.P or TC.MAC. More... | |
UInt32 | GetMaximumNumberOfTcLin () |
This method returns the maximum number of TC.LINs connected to the TopCon system. More... | |
Int32 | GetConnectedRs232ComPortNumber () |
This function returns the number of the COM interface that the TopCon is connected to. More... | |
bool | IsOptionAvlStorageEnabled () |
This method indicates if a valid AVLStorage option is available in the connected TopCon. More... | |
bool | IsOptionBatSimEnabled () |
This method indicates if a valid BatSim option is available in the connected TopCon. More... | |
bool | IsOptionCapSimEnabled () |
This method indicates if a valid CapSim option is available in the connected TopCon. More... | |
string | GetLastError () |
Get the last exception message. More... | |
void | Dispose () |
void | DoDispose (bool calledByFinalizer) |
void | Connect (int comPortNumber) |
This method connects the software object to the device (if available on the given port). The remote control of the TopCon power supply connected is pulled to the RS-232 interface. More... | |
void | Connect (int comPortNumber, bool setToRs232Remote) |
This method connects the software object to the device (if available on the given port). More... | |
void | Disconnect () |
This method disconnects the TopCon object from that used COM port and releases the online curveList. More... | |
void | ClearError () |
This function resets the actual error state. This is the same function as pressing the [ESC] key button on the HMI. More... | |
void | SetPowerOn () |
Switches ON the power output stage. More... | |
void | SetPowerOff () |
Switches OFF the power output stage. More... | |
void | SetPower (bool control) |
Switches ON or OFF the power output stage. More... | |
bool | IsPowerOn () |
This function determines if the TopCon device is in POWER ON mode. More... | |
void | SetSystemQuadrantOperatingMode (QuadrantMode quadrantMode) |
Set the quadrant operation mode limitation if Q1 Q4 LimitMode is supported. More... | |
double | GetReferenceVoltage () |
This function returns the value of the voltage reference, hence the limit where the controller switches to voltage control mode. (ref value). More... | |
double | GetReferenceCurrent () |
This function returns the value of the current reference, hence the limit where the controller switches to current control mode. (ref value). More... | |
double | GetReferencePower () |
This function returns the value of the power reference (here, the controller switches to current control mode, ref value). More... | |
double | GetReferenceResistance () |
This function returns the value of the resistance reference. More... | |
double | GetLimitVoltageQ4 () |
Get Q4 controller voltage limit (parameter will be positive). More... | |
double | GetLimitCurrentQ4 () |
This function returns the value of the current reference, hence the limit where the controller switches to current control mode. (ref value) (for Q4-Mode (TopCon 4.20 or higher/ReGen/ResAct)). More... | |
double | GetLimitPowerQ4 () |
This function returns the value of the power reference (here, the controller switches to current control mode, ref value) (for Q4-Mode (TopCon 4.20 or higher/ReGen/ResAct)). More... | |
double | GetActualVoltage () |
This function returns the value of the voltage at the output bars of the TopCon at that moment (actual value). This method automatically switch to TC.LIN system values if supported and attached to TC.P or TC.MAC. More... | |
double | GetActualCurrent () |
This function returns the value of the current at the output bars of the TopCon at that moment (actual value). This method automatically switch to TC.LIN system values if supported and attached to TC.P or TC.MAC. More... | |
double | GetActualPower () |
This function returns the value of the power at the output bars of the TopCon at that moment (actual value). This method automatically switch to TC.LIN system values if supported and attached to TC.P or TC.MAC. More... | |
double | GetActualResistance () |
This function returns the value of the internal resistance of the TopCon at that moment (actual value). More... | |
void | SetReferenceVoltage (double voltage) |
This function sets the voltage limit (Reference Value) of the TopCon power supply. More... | |
void | SetReferenceCurrent (double current) |
This function sets the current limit (Reference Current) of the TopCon power supply. More... | |
void | SetReferencePower (double power) |
This function sets the power limit (Reference Power) of the TopCon power supply. More... | |
void | SetReferenceResistance (double resistance) |
This function sets the internal resistance (Reference resistance) of the TopCon power supply. More... | |
void | SetLimitVoltageQ4 (double voltageQ4) |
Set Q4 controller voltage limit (parameter must be positive!) voltage PhysicalVoltage [V] This is only possible if it is a GSS Device or a ReGen Device with. Note: Call StoreParameters() if you want to store parameters on device. On Power Off/On parameters then stay the same. More... | |
void | SetLimitCurrentQ4 (double currentQ4) |
This function sets the current limit (Reference Current) of the TopCon power supply (for Q4-Mode (TopCon 4.20 or higher/ReGen/ResAct)). Note: Call StoreParameters() if you want to store parameters on device. On Power Off/On parameters then stay the same. More... | |
void | SetLimitPowerQ4 (double powerQ4) |
This function sets the power limit (Reference Power) of the TopCon power supply (for Q4-Mode (TopCon 4.20 or higher/ReGen/ResAct)). Note: Call StoreParameters() if you want to store parameters on device. On Power Off/On parameters then stay the same. More... | |
Int32 | WatchdogRs232On () |
Enable the RS-232 watchdog to the TopCon device. More... | |
Boolean | IsWatchdogRunning () |
check if watchdog RS-232 is running More... | |
void | WatchdogRs232Clear () |
If a Watchdog error occurs on the topcon device use this method to clear the run and error state of watchdog. After WatchdogRS232Clear() call ClearError() to get the TopCon device in ready state. More... | |
void | WatchdogRs232Off () |
Disable the RS-232 watchdog to the TopCon device. More... | |
void | CheckCommunication (int result, string methodeName) |
Use after calling wrapper methods. It handle throwing an TopConCofigurationException, if a data exchange error occurs. More... | |
bool | IsSupportedQ4UserLimits () |
Check support of Q4 User Limits before calling a method: More... | |
bool | IsSupportedExtenedProtect () |
Check support of Extened Protection before calling a method: More... | |
bool | IsSupportedQ4VoltageUserLimit () |
Check support of Q4 Voltage User Limit before calling a method: More... | |
bool | IsSupportedQ1Q4LimitMode () |
Check support Q1 and Q4 limit mode before calling a method: More... | |
bool | IsSupportedUBottom () |
Check support for UBottom More... | |
void | SetStandardMode () |
Sets Standard Mode for the control principle More... | |
void | SetHighDynamicMode () |
Sets High Dynamic Mode for the control principle More... | |
string | GetMode () |
Gets Mode for control principle More... | |
void | GetVoltageQ1ControlParameters (out uint pGain, out uint iGain, out uint dGain, out uint t1, out uint feedFwd) |
Gets control parameters for Voltage Q1 More... | |
void | SetVoltageQ1ControlParameters (uint pGain, uint iGain, uint dGain, uint t1, uint feedFwd) |
Sets control parameters for Voltage Q1 Note: Call StoreParameters() if you want to store parameters on device. On Power Off/On parameters then stay the same. More... | |
void | GetVoltageQ1Adaptive (out uint voltageQ1PAdaptive, out uint voltageQ1IAdaptive) |
Gets P- and I-Adaptive of Voltage Q1 More... | |
void | SetVoltageQ1Adaptive (uint voltageQ1PAdaptive, uint voltageQ1IAdaptive) |
Sets P- and I-Adaptive of Voltage Q1 Note 1: These values are also settable with GSS.WR devices and in High Dynamics-Mode, but then have no impact Note 2: Call StoreParameters() if you want to store parameters on device. On Power Off/On parameters then stay the same. More... | |
void | GetCurrentQ1ControlParameters (out uint pGain, out uint iGain, out uint dGain, out uint t1, out uint feedFwd) |
Gets control parameters for Current Q1 More... | |
void | SetCurrentQ1ControlParameters (uint pGain, uint iGain, uint dGain, uint t1, uint feedFwd) |
Sets control parameters for Current Q1 Note: Call StoreParameters() if you want to store parameters on device. On Power Off/On parameters then stay the same. More... | |
void | GetCurrentQ1Adaptive (out uint currentQ1PAdaptive, out uint currentQ1IAdaptive) |
Gets P- and I-Adaptive of Current Q1 More... | |
void | SetCurrentQ1Adaptive (uint currentQ1PAdaptive, uint currentQ1IAdaptive) |
Sets P- and I-Adaptive of Current Q1 Note 1: These values are also settable with GSS.WR devices and in High Dynamics-Mode, but then have no impact Note 2: Call StoreParameters() if you want to store parameters on device. On Power Off/On parameters then stay the same. More... | |
void | GetPowerQ1ControlParameters (out uint pGain, out uint iGain) |
Gets control parameters of Power Q1 More... | |
void | SetPowerQ1ControlParameters (uint pGain, uint iGain) |
Sets control parameters of Power Q1 Note: Call StoreParameters() if you want to store parameters on device. On Power Off/On parameters then stay the same. More... | |
void | GetVoltageQ4ControlParameters (out short pGain, out short iGain, out short feedFwd) |
Gets control parameters of Voltage Q4 More... | |
void | SetVoltageQ4ControlParameters (short pGain, short iGain, short feedFwd) |
Sets control parameters of Voltage Q4 Note: Call StoreParameters() if you want to store parameters on device. On Power Off/On parameters then stay the same. More... | |
void | GetCurrentQ4ControlParameters (out short pGain, out short iGain, out short feedFwd) |
Gets control parameters of Voltage Q4 More... | |
void | SetCurrentQ4ControlParameters (short pGain, short iGain, short feedFwd) |
Sets control parameters of Current Q4 Note: Call StoreParameters() if you want to store parameters on device. On Power Off/On parameters then stay the same. More... | |
void | GetPowerQ4ControlParameters (out short pGain, out short iGain) |
Gets control parameters of Power Q4 More... | |
void | SetPowerQ4ControlParameters (short pGain, short iGain) |
Sets control parameters of Power Q4 Note: Call StoreParameters() if you want to store parameters on device. On Power Off/On parameters then stay the same. More... | |
void | GetVoltageQ1TcLinControlParameters (out uint pGain, out uint iGain) |
Gets control parameters (more details in manual) of Voltage Q1 TC.Lin More... | |
void | SetVoltageQ1TcLinControlParameters (uint pGain, uint iGain) |
Sets control parameters (more details in manual) of Voltage Q1 TC.Lin Note: Call StoreParameters() if you want to store parameters on device. On Power Off/On parameters then stay the same. More... | |
void | GetCurrentQ1TcLinControlParameters (out uint pGain, out uint iGain) |
Gets control parameters (more details in manual) of Current Q1 TC.Lin More... | |
void | SetCurrentQ1TcLinControlParameters (uint pGain, uint iGain) |
Sets control parameters (more details in manual) of Current Q1 TC.Lin Note: Call StoreParameters() if you want to store parameters on device. On Power Off/On parameters then stay the same. More... | |
void | GetNumberOfModules (out uint numSerie, out uint numParallel) |
Gets number of modules More... | |
void | SetNumberOfModules (uint numSerie, uint numParallel) |
Sets number of modules Note 1: Call StoreParameters() if you want to store parameters on device. On Power Off/On parameters then stay the same. Note 2: Call ResetDevice() to activate changes More... | |
bool | GetMatrixConnectionType () |
Gets matrix connection type (more details in manual) More... | |
void | SetMatrixConnectionType (bool type) |
Sets matrix connection type Note 1: Call StoreParameters() if you want to store parameters on device. On Power Off/On parameters then stay the same. Note 2: Call ResetDevice() to activate changes More... | |
bool | GetRppEnabled () |
Gets RPP(=Reverse Polarity Protection) enabled More... | |
void | SetRppEnabled (bool rppEnabled) |
Sets RPP(=Reverse Polarity Protection) enabled Note 1: Call StoreParameters() if you want to store parameters on device. On Power Off/On parameters then stay the same. Note 2: Call ResetDevice() to activate changes More... | |
bool | GetOutputCapacitanceEnabled () |
Gets Output capacitance enabled More... | |
void | SetOutputCapacitanceEnabled (bool outputCapacitanceEnabled) |
Sets Output capacitance enabled Note 1: Call StoreParameters() if you want to store parameters on device. On Power Off/On parameters then stay the same. Note 2: Call ResetDevice() to activate changes More... | |
bool | GetTcLinEnabled () |
Gets Tc Lin enabled More... | |
void | SetTcLinEnabled (bool tcLinEnabled) |
Sets Tc Lin enabled Note 1: Call StoreParameters() if you want to store parameters on device. On Power Off/On parameters then stay the same. Note 2: Call ResetDevice() to activate changes More... | |
string | GetCurrentRange () |
Gets current range More... | |
void | SetCurrentRange (uint currentRange) |
Sets current range Note 1: Call StoreParameters() if you want to store parameters on device. On Power Off/On parameters then stay the same. Note 2: Call ResetDevice() to activate changes More... | |
bool | GetS3RModeEnabled () |
Gets S3RMode enabled More... | |
void | SetS3RModeEnabled (bool s3RModeEnabled) |
Sets S3RMode enabled Note 1: Call StoreParameters() if you want to store parameters on device. On Power Off/On parameters then stay the same. Note 2: Call ResetDevice() to activate changes More... | |
void | StoreParameters () |
Stores Parameters on device. Method ends when storing is finished. More... | |
void | ResetDevice () |
Resets device (output voltage has to be turned off). When the method is finished without exception, all devices should be reset. Note 1: All unsaved parameter values on the device get lost. With StoreParameters() they could be saved. Note 2: This method resets all devices, which could take long. Note 3: If method returns that not all devices could have been reset, try method ResetDevice(int timeOut) with longer timeOut. More... | |
void | ResetDevice (int timeOut) |
Resets device (output voltage has to be turned off). Timeout is used for the waiting time after reset started. When the method is finished without exception, all devices should be reset. Note 1: All unsaved parameter values on the device get lost. With StoreParameters() they could be saved. Note 2: This method resets all devices, which could take long. Note 3: If method returns that not all devices could have been reset, try method ResetDevice(int timeOut) with longer timeOut. More... | |
ushort | GetUInt16 (uint address) |
Gets unsigned short value of given address More... | |
void | SetUInt16 (uint address, ushort data) |
Sets unsigned short value to the given address More... | |
short | GetSInt16 (uint address) |
Gets signed short value of given address More... | |
void | SetSInt16 (uint address, short data) |
Sets signed short value to the given address More... | |
uint | GetUInt32 (uint address) |
Gets unsigned int value of given address More... | |
void | SetUInt32 (uint address, uint data) |
Sets unsigned int value to the given address More... | |
int | GetSInt32 (uint address) |
Gets signed int value of given address More... | |
void | SetSInt32 (uint address, int data) |
Sets signed int value to the given address More... | |
float | GetFloat (uint address) |
Gets float value of given address More... | |
void | SetFloat (uint address, float data) |
Sets float value to the given address More... | |
void | SetSoftwareModuleId (ushort ah, ushort al) |
Only use this method after consultation of our support team! Sets the ModuleID software-based when AL = AH = F on actual device is set. Note 1: This method needs a StoreParameters() before Resetting the device. Otherwise this settings get lost. Note 2: If configured a state in software which not exactly corresponds to the hardware arrangement, the system could take damage. More... | |
void | GetSoftwareModuleId (out ushort ah, out ushort al) |
Gets the ModuleID software-based when AL = AH = F on actual device is set. Note 1: This method needs a StoreParameters() before Resetting the device. Otherwise this settings get lost. Note 2: If configured a state in software which not exactly corresponds to the hardware arrangement, the system could take damage. More... | |
void | SetOverVoltageErrorLimit (double errorLimitVoltage) |
Sets over voltage error limit value. More... | |
void | GetOverVoltageErrorLimit (out double errorLimitVoltage) |
Gets over voltage error limit value. More... | |
void | SetOverVoltageErrorDelay (double errorDelayVoltage) |
Sets over voltage error delay value. More... | |
void | GetOverVoltageErrorDelay (out double errorDelayVoltage) |
Gets over voltage error delay value. More... | |
void | SetOverCurrentQ1ErrorLimit (double errorLimitCurrentQ1) |
Sets over current Q1 error limit value. More... | |
void | GetOverCurrentQ1ErrorLimit (out double errorLimitCurrentQ1) |
Gets over current Q1 error limit value. More... | |
void | SetOverCurrentQ1ErrorDelay (double errorDelayCurrentQ1) |
Sets over current Q1 error delay value. More... | |
void | GetOverCurrentQ1ErrorDelay (out double errorDelayCurrentQ1) |
Gets over current Q1 error delay value. More... | |
void | SetOverCurrentQ4ErrorLimit (double errorLimitCurrentQ4) |
Sets over current Q4 error limit value. More... | |
void | GetOverCurrentQ4ErrorLimit (out double errorLimitCurrentQ4) |
Gets over current Q4 error limit value. More... | |
void | SetOverCurrentQ4ErrorDelay (double errorDelayCurrentQ4) |
Sets over current Q4 error Delay More... | |
void | GetOverCurrentQ4ErrorDelay (out double errorDelayCurrentQ4) |
Gets over current Q4 error delay value. More... | |
void | SetUnderVoltageErrorLimit (double errorLimitUnderVoltage) |
Sets under voltage error limit value. More... | |
void | GetUnderVoltageErrorLimit (out double errorLimitUnderVoltage) |
Gets under voltage error limit value. More... | |
void | SetUnderVoltageErrorDelay (double errorDelayUnderVoltage) |
Sets under voltage error delay value. More... | |
void | GetUnderVoltageErrorDelay (out double errorDelayUnderVoltage) |
Gets under voltage error delay value. More... | |
void | SetMaxPowerQ1ErrorLimit (double errorLimitMaxPowerQ1) |
Sets max power Q1 error limit value. More... | |
void | GetMaxPowerQ1ErrorLimit (out double errorLimitMaxPowerQ1) |
Gets max power Q1 error limit value. More... | |
void | SetMaxPowerQ1ErrorDelay (double errorDelayMaxPowerQ1) |
Sets max power Q1 error delay value. More... | |
void | GetMaxPowerQ1ErrorDelay (out double errorDelayMaxPowerQ1) |
Gets max power Q1 error delay value. More... | |
void | SetMaxPowerQ4ErrorLimit (double errorLimitMaxPowerQ4) |
Sets max power Q4 error limit value. More... | |
void | GetMaxPowerQ4ErrorLimit (out double errorLimitMaxPowerQ4) |
Gets max power Q4 error limit value. More... | |
void | SetMaxPowerQ4ErrorDelay (double errorDelayMaxPowerQ4) |
Gets max power Q4 error delay value. More... | |
void | GetMaxPowerQ4ErrorDelay (out double errorDelayMaxPowerQ4) |
Gets max power Q4 error delay value. More... | |
Static Public Member Functions | |
static string | GetVersionOfApiWithRevision () |
Get the version of this TopCon programming API (incl. revision number). More... | |
static string | GetVersionOfApi () |
Get the version of this TopCon programming API (excluding the revision number). More... | |
Public Attributes | |
bool | Disposed => _disposed |
Static Public Attributes | |
const int | API_SUCCESS = Ch.Regatron.APPBase.ReturnCodes.SUCCESS |
This constants is similar to one is known in TCIO API as DLL_SUCCESS More... | |
const int | API_FAIL = Ch.Regatron.APPBase.ReturnCodes.FAIL |
This constants is similar to one is known in TCIO API as DLL_FAIL More... | |
Properties | |
QuadrantMode | SystemQuadrantMode [get] |
Determines what quadrant mode is enabled on the device. More... | |
QuadrantMode | SystemQuadrantOperatingMode [get] |
This is the main TopCon object.
This is the main TopCon object. TC.LIN system values are automatically switched if TC.LIN and TC.P or TC.MAC support these values.
|
strong |
|
strong |
|
strong |
CH.Regatron.HPPS.Device.TopCon.TopCon | ( | ) |
This is the constructor with device id parameter
This device is the identifier of this TopCon object throughout the whole API.
void CH.Regatron.HPPS.Device.TopCon.CheckCommunication | ( | int | result, |
string | methodeName | ||
) |
Use after calling wrapper methods. It handle throwing an TopConCofigurationException, if a data exchange error occurs.
result | result of the last data communication |
methodeName | use System.Reflection.MethodBase.GetCurrentMethod().Name |
void CH.Regatron.HPPS.Device.TopCon.ClearError | ( | ) |
This function resets the actual error state.
This is the same function as pressing the [ESC] key button on the HMI.
void CH.Regatron.HPPS.Device.TopCon.Connect | ( | int | comPortNumber | ) |
This method connects the software object to the device (if available on the given port).
The remote control of the TopCon power supply connected is pulled to the RS-232 interface.
comPortNumber | The number of the COM port to be used (1 = COM1, 2 = COM2, ...) |
ArgumentException | |
NotSupportedException | |
CH.Regatron.HPPS.Device.TopConCommunicationException |
void CH.Regatron.HPPS.Device.TopCon.Connect | ( | int | comPortNumber, |
bool | setToRs232Remote | ||
) |
This method connects the software object to the device (if available on the given port).
comPortNumber | The number of the COM port to be used (1 = COM1, 2 = COM2, ...) |
setToRs232Remote | set true if you want remote control to RS232 on connect, use false if device is controlled otherwise and for read only access |
ArgumentException | |
NotSupportedException | |
CH.Regatron.HPPS.Device.TopConCommunicationException |
void CH.Regatron.HPPS.Device.TopCon.Disconnect | ( | ) |
This method disconnects the TopCon object from that used COM port and releases the online curveList.
void CH.Regatron.HPPS.Device.TopCon.Dispose | ( | ) |
void CH.Regatron.HPPS.Device.TopCon.DoDispose | ( | bool | calledByFinalizer | ) |
calledByFinalizer |
double CH.Regatron.HPPS.Device.TopCon.GetActualCurrent | ( | ) |
This function returns the value of the current at the output bars of the TopCon at that moment (actual value).
This method automatically switch to TC.LIN system values if supported and attached to TC.P or TC.MAC.
double CH.Regatron.HPPS.Device.TopCon.GetActualPower | ( | ) |
This function returns the value of the power at the output bars of the TopCon at that moment (actual value).
This method automatically switch to TC.LIN system values if supported and attached to TC.P or TC.MAC.
double CH.Regatron.HPPS.Device.TopCon.GetActualResistance | ( | ) |
This function returns the value of the internal resistance of the TopCon at that moment (actual value).
double CH.Regatron.HPPS.Device.TopCon.GetActualVoltage | ( | ) |
This function returns the value of the voltage at the output bars of the TopCon at that moment (actual value).
This method automatically switch to TC.LIN system values if supported and attached to TC.P or TC.MAC.
BatterySimulation CH.Regatron.HPPS.Device.TopCon.GetBatterySimulationObject | ( | ) |
Get a BatterySimulation object (Central class for Battery simulation) You cannot create an object for this type over new command. To obtain that object call this function: Example: var batSimulation = myTopCon.GetBatterySimulationObject(); If the TC device is disconnected or the option BatSim is not installed into the TC device, you get a null object. After obtaining a BatterySimulation object you must configure it. The configuration of a simulation requires 2 steps:
1) Load a predefined battery configuration. With the help of ESSControl you have already defined a battery configuration. Let's say it has the name LeadAcid100Ah.batsimcnf and it is in the directory C:\Temp\ then call the function batSimulation.LoadBatteryConfiguration ( "C:\Temp\LeadAcid100Ah.batsimcnf"); If the path not exist or is not valid you get an exception.
2) Load a predefined battery simulation script. Also in ESSControl (suppose) you have defined a java script (or use the default script) called MyBatSimScript.batSim and it is in the directory C:\Temp\ then call the function batSimulation.LoadCustomScript ( "C:\Temp\MyBatSimScript.batSim"); If the path not exist or is not valid you get an exception.
After TC device is connected, the battery configuration and battery script are loaded, the BatterySimulation object is ready (but in "Stopped" state).
double CH.Regatron.HPPS.Device.TopCon.GetChargeCounter | ( | ) |
This function returns the energy counter of the connected TopCon system.
void CH.Regatron.HPPS.Device.TopCon.GetCommStatus | ( | ref int | state, |
ref int | errorNumber | ||
) |
Get the communication state and error flag. Calling this method will also clear the internal communication library flags.
The communication to the TopCon device can continue immediately. But still care about exceptions.
state | coomunication state flag |
errorNumber | detailed info |
Int32 CH.Regatron.HPPS.Device.TopCon.GetCommunicationTimeoutRead | ( | ) |
This function returns the value of the READ commTimeout parameter. Standard value: 10.
Value for Ethernet-to-RS-232 adapter: 100.
int CH.Regatron.HPPS.Device.TopCon.GetCommunicationTimeoutWrite | ( | ) |
This function returns the value of the WRITE commTimeout parameter. Standard value: 10.
Value for Ethernet-to-RS-232 adapter: 30.
Int32 CH.Regatron.HPPS.Device.TopCon.GetConnectedRs232ComPortNumber | ( | ) |
This function returns the number of the COM interface that the TopCon is connected to.
void CH.Regatron.HPPS.Device.TopCon.GetCurrentQ1Adaptive | ( | out uint | currentQ1PAdaptive, |
out uint | currentQ1IAdaptive | ||
) |
Gets P- and I-Adaptive of Current Q1
currentQ1PAdaptive | P-Adaptive (more details in manual) of Current Q1 |
currentQ1IAdaptive | I-Adaptive (more details in manual) of Current Q1 |
CH.Regatron.HPPS.Device.TopConCommunicationException | error while communication with device |
void CH.Regatron.HPPS.Device.TopCon.GetCurrentQ1ControlParameters | ( | out uint | pGain, |
out uint | iGain, | ||
out uint | dGain, | ||
out uint | t1, | ||
out uint | feedFwd | ||
) |
Gets control parameters for Current Q1
pGain | pGain (more details in manual) of Current Q1 |
iGain | iGain (more details in manual) of Current Q1 |
dGain | dGain (more details in manual) of Current Q1 |
t1 | t1 (more details in manual) of Current Q1 |
feedFwd | feedFwd (more details in manual) of Current Q1 |
CH.Regatron.HPPS.Device.TopConCommunicationException | error while communication with device |
void CH.Regatron.HPPS.Device.TopCon.GetCurrentQ1TcLinControlParameters | ( | out uint | pGain, |
out uint | iGain | ||
) |
Gets control parameters (more details in manual) of Current Q1 TC.Lin
pGain | pGain (more details in manual) of Current Q1 TC.Lin |
iGain | iGain (more details in manual) of Current Q1 TC.Lin |
CH.Regatron.HPPS.Device.TopConCommunicationException | error while communication with device |
CH.Regatron.HPPS.Device.TopConException | Tc Lin is not enabled |
NotSupportedException | Firmware version is to old |
void CH.Regatron.HPPS.Device.TopCon.GetCurrentQ4ControlParameters | ( | out short | pGain, |
out short | iGain, | ||
out short | feedFwd | ||
) |
Gets control parameters of Voltage Q4
pGain | pGain (more details in manual) of Voltage Q4 |
iGain | iGain (more details in manual) of Voltage Q4 |
feedFwd | feedFwd (more details in manual) of Voltage Q4 |
CH.Regatron.HPPS.Device.TopConCommunicationException | error while communication with device |
CH.Regatron.HPPS.Device.TopConException | no ibc board connected |
string CH.Regatron.HPPS.Device.TopCon.GetCurrentRange | ( | ) |
Gets current range
CH.Regatron.HPPS.Device.TopConCommunicationException | error while communication with device |
CurveContainer CH.Regatron.HPPS.Device.TopCon.GetCurveContainer | ( | bool | setFuncGeneratorData | ) |
Create a instanz of CurveContainer
DeviceControlMode CH.Regatron.HPPS.Device.TopCon.GetDeviceControlMode | ( | ) |
Get a DeviceControlMode structure, with information about the actual state of control mode (Voltage, Current, Power, VoltageSense or PowerSense)
string CH.Regatron.HPPS.Device.TopCon.GetDllVersionAsString | ( | ) |
This function returns the information about the TCIO.DLL being used for the connection to the TopCon.
System.NullReferenceException |
double CH.Regatron.HPPS.Device.TopCon.GetEnergyCounter | ( | ) |
This function returns the energy counter of the connected TopCon system.
This method automatically switch to TC.LIN system values if supported and attached to TC.P or TC.MAC.
ErrorWarning.ErrorList CH.Regatron.HPPS.Device.TopCon.GetErrorList | ( | ) |
This function returns a reference to the ErrorList.
System.ArgumentException |
float CH.Regatron.HPPS.Device.TopCon.GetFloat | ( | uint | address | ) |
Gets float value of given address
address | address of variable |
CH.Regatron.HPPS.Device.TopConCommunicationException | error while communication with device |
FunctionEngine CH.Regatron.HPPS.Device.TopCon.GetFunctionEngine | ( | ) |
This returns the FunctionEngine (with CurveList) that is kept inside of the TopCon DEVICE. Please use the corresponding commands to adjust the content of the underlying curvelist with the flash of the TopCon. If the TC device is disconnected or the option Function generator (TopCon TFE) is not installed into the TC device, you get a null object.
string CH.Regatron.HPPS.Device.TopCon.GetLastError | ( | ) |
double CH.Regatron.HPPS.Device.TopCon.GetLimitCurrentQ4 | ( | ) |
This function returns the value of the current reference, hence the limit where the controller switches to current control mode. (ref value) (for Q4-Mode (TopCon 4.20 or higher/ReGen/ResAct)).
CH.Regatron.HPPS.Device.TopConCommunicationException | |
System.NotSupportedException |
double CH.Regatron.HPPS.Device.TopCon.GetLimitPowerQ4 | ( | ) |
This function returns the value of the power reference (here, the controller switches to current control mode, ref value) (for Q4-Mode (TopCon 4.20 or higher/ReGen/ResAct)).
CH.Regatron.HPPS.Device.TopConCommunicationException | |
System.NotSupportedException |
double CH.Regatron.HPPS.Device.TopCon.GetLimitVoltageQ4 | ( | ) |
Get Q4 controller voltage limit (parameter will be positive).
CH.Regatron.HPPS.Device.TopConCommunicationException | |
System.NotSupportedException |
bool CH.Regatron.HPPS.Device.TopCon.GetMatrixConnectionType | ( | ) |
Gets matrix connection type (more details in manual)
CH.Regatron.HPPS.Device.TopConCommunicationException | error while communication with device |
UInt32 CH.Regatron.HPPS.Device.TopCon.GetMaximumNumberOfTcLin | ( | ) |
void CH.Regatron.HPPS.Device.TopCon.GetMaxPowerQ1ErrorDelay | ( | out double | errorDelayMaxPowerQ1 | ) |
Gets max power Q1 error delay value.
errorDelayMaxPowerQ1 | error delay in ms |
CH.Regatron.HPPS.Device.TopConCommunicationException | error while communication with device |
void CH.Regatron.HPPS.Device.TopCon.GetMaxPowerQ1ErrorLimit | ( | out double | errorLimitMaxPowerQ1 | ) |
Gets max power Q1 error limit value.
errorLimitMaxPowerQ1 | error limit in kW |
CH.Regatron.HPPS.Device.TopConCommunicationException | error while communication with device |
void CH.Regatron.HPPS.Device.TopCon.GetMaxPowerQ4ErrorDelay | ( | out double | errorDelayMaxPowerQ4 | ) |
Gets max power Q4 error delay value.
errorDelayMaxPowerQ4 | error delay in ms |
CH.Regatron.HPPS.Device.TopConCommunicationException | error while communication with device |
void CH.Regatron.HPPS.Device.TopCon.GetMaxPowerQ4ErrorLimit | ( | out double | errorLimitMaxPowerQ4 | ) |
Gets max power Q4 error limit value.
errorLimitMaxPowerQ4 | error limit in kW |
CH.Regatron.HPPS.Device.TopConCommunicationException | error while communication with device |
string CH.Regatron.HPPS.Device.TopCon.GetMode | ( | ) |
Gets Mode for control principle
CH.Regatron.HPPS.Device.TopConCommunicationException | error while communication with device |
NotSupportedException | setting mode is not supported |
int CH.Regatron.HPPS.Device.TopCon.GetNextAvailableComPort | ( | ) |
Get next free com port or 0 if not found
void CH.Regatron.HPPS.Device.TopCon.GetNumberOfModules | ( | out uint | numSerie, |
out uint | numParallel | ||
) |
Gets number of modules
numSerie | number of modules in line (more details in manual) |
numParallel | number of modules parallel (more details in manual) |
CH.Regatron.HPPS.Device.TopConCommunicationException | error while communication with device |
uint CH.Regatron.HPPS.Device.TopCon.GetNumberOfTcLinPresent | ( | ) |
This method returns the number of TCLINs available in the system.
bool CH.Regatron.HPPS.Device.TopCon.GetOutputCapacitanceEnabled | ( | ) |
Gets Output capacitance enabled
CH.Regatron.HPPS.Device.TopConCommunicationException | error while communication with device |
CH.Regatron.HPPS.Device.TopConException | Output Capacitance is not supported |
void CH.Regatron.HPPS.Device.TopCon.GetOverCurrentQ1ErrorDelay | ( | out double | errorDelayCurrentQ1 | ) |
Gets over current Q1 error delay value.
errorDelayCurrentQ1 | error delay in ms |
CH.Regatron.HPPS.Device.TopConCommunicationException | error while communication with device |
void CH.Regatron.HPPS.Device.TopCon.GetOverCurrentQ1ErrorLimit | ( | out double | errorLimitCurrentQ1 | ) |
Gets over current Q1 error limit value.
errorLimitCurrentQ1 | error limit in A |
CH.Regatron.HPPS.Device.TopConCommunicationException | error while communication with device |
void CH.Regatron.HPPS.Device.TopCon.GetOverCurrentQ4ErrorDelay | ( | out double | errorDelayCurrentQ4 | ) |
Gets over current Q4 error delay value.
errorDelayCurrentQ4 | error delay in ms |
CH.Regatron.HPPS.Device.TopConCommunicationException | error while communication with device |
void CH.Regatron.HPPS.Device.TopCon.GetOverCurrentQ4ErrorLimit | ( | out double | errorLimitCurrentQ4 | ) |
Gets over current Q4 error limit value.
errorLimitCurrentQ4 | error limit in A |
CH.Regatron.HPPS.Device.TopConCommunicationException | error while communication with device |
void CH.Regatron.HPPS.Device.TopCon.GetOverVoltageErrorDelay | ( | out double | errorDelayVoltage | ) |
Gets over voltage error delay value.
errorDelayVoltage | error delay in ms |
CH.Regatron.HPPS.Device.TopConCommunicationException | error while communication with device |
void CH.Regatron.HPPS.Device.TopCon.GetOverVoltageErrorLimit | ( | out double | errorLimitVoltage | ) |
Gets over voltage error limit value.
errorLimitVoltage | error limit in V |
CH.Regatron.HPPS.Device.TopConCommunicationException | error while communication with device |
void CH.Regatron.HPPS.Device.TopCon.GetPowerQ1ControlParameters | ( | out uint | pGain, |
out uint | iGain | ||
) |
Gets control parameters of Power Q1
pGain | pGain (more details in manual) of Power Q1 |
iGain | iGain (more details in manual) of Power Q1 |
CH.Regatron.HPPS.Device.TopConCommunicationException | error while communication with device |
void CH.Regatron.HPPS.Device.TopCon.GetPowerQ4ControlParameters | ( | out short | pGain, |
out short | iGain | ||
) |
Gets control parameters of Power Q4
pGain | pGain (more details in manual) of Power Q4 |
iGain | iGain (more details in manual) of Power Q4 |
CH.Regatron.HPPS.Device.TopConCommunicationException | error while communication with device |
CH.Regatron.HPPS.Device.TopConException | no ibc board connected |
double CH.Regatron.HPPS.Device.TopCon.GetReferenceCurrent | ( | ) |
This function returns the value of the current reference, hence the limit where the controller switches to current control mode. (ref value).
double CH.Regatron.HPPS.Device.TopCon.GetReferencePower | ( | ) |
This function returns the value of the power reference (here, the controller switches to current control mode, ref value).
double CH.Regatron.HPPS.Device.TopCon.GetReferenceResistance | ( | ) |
This function returns the value of the resistance reference.
double CH.Regatron.HPPS.Device.TopCon.GetReferenceVoltage | ( | ) |
This function returns the value of the voltage reference, hence the limit where the controller switches to voltage control mode. (ref value).
RemoteControl CH.Regatron.HPPS.Device.TopCon.GetRemoteControlInterface | ( | ) |
This function returns the particular interface who has the control of the TopCon.
bool CH.Regatron.HPPS.Device.TopCon.GetRppEnabled | ( | ) |
Gets RPP(=Reverse Polarity Protection) enabled
CH.Regatron.HPPS.Device.TopConCommunicationException | error while communication with device |
CH.Regatron.HPPS.Device.TopConException | RPP Mode is not supported |
bool CH.Regatron.HPPS.Device.TopCon.GetS3RModeEnabled | ( | ) |
Gets S3RMode enabled
CH.Regatron.HPPS.Device.TopConCommunicationException | error while communication with device |
CH.Regatron.HPPS.Device.TopConException | S3R Mode is not supported |
double CH.Regatron.HPPS.Device.TopCon.GetSasEfficiency | ( | ) |
This method returns the efficiency as being calculated by the SAS middleware.
This method automatically switch to TC.LIN system values if supported and attached to TC.P or TC.MAC.
string CH.Regatron.HPPS.Device.TopCon.GetSerialNumberOfDevice | ( | ) |
This function read and returns the serial number of the device.
CH.Regatron.HPPS.Device.TopConException |
short CH.Regatron.HPPS.Device.TopCon.GetSInt16 | ( | uint | address | ) |
Gets signed short value of given address
address | address of variable |
CH.Regatron.HPPS.Device.TopConCommunicationException | error while communication with device |
int CH.Regatron.HPPS.Device.TopCon.GetSInt32 | ( | uint | address | ) |
Gets signed int value of given address
address | address of variable |
CH.Regatron.HPPS.Device.TopConCommunicationException | error while communication with device |
void CH.Regatron.HPPS.Device.TopCon.GetSoftwareModuleId | ( | out ushort | ah, |
out ushort | al | ||
) |
Gets the ModuleID software-based when AL = AH = F on actual device is set.
Note 1: This method needs a StoreParameters() before Resetting the device. Otherwise this settings get lost.
Note 2: If configured a state in software which not exactly corresponds to the hardware arrangement, the system could take damage.
ah | Related to AH value on device |
al | Related to AL value on device |
NotSupportedException | Firmware version to old |
CH.Regatron.HPPS.Device.TopConCommunicationException | error while communication with device |
int CH.Regatron.HPPS.Device.TopCon.GetSystemState | ( | ) |
This function determines the state the TopCon runs in.
string CH.Regatron.HPPS.Device.TopCon.GetSystemStateAsString | ( | ) |
This function checks the current system state of the TopCon device and returns it as string.
Status CH.Regatron.HPPS.Device.TopCon.GetSystemStateEnum | ( | ) |
This function determines the state the TopCon runs in.
TCLIN CH.Regatron.HPPS.Device.TopCon.GetTclin | ( | uint | id | ) |
This method returns the TC.LIN object with the given id. This object is only needed for TC.LIN module values. TC.LIN system values are automatically switched if TC.LIN and TC.P or TC.MAC support these values.
id | Index number that represents the TC.LIN. |
System.ArgumentException |
bool CH.Regatron.HPPS.Device.TopCon.GetTcLinEnabled | ( | ) |
Gets Tc Lin enabled
CH.Regatron.HPPS.Device.TopConCommunicationException | error while communication with device |
TopConConfiguration CH.Regatron.HPPS.Device.TopCon.GetTopConConfig | ( | ) |
This function returns the current TopConConfiguration.
The configuration holds the key data of the present TopCon system. (Examples: NominalSystemCurrent or MaximumSystemCurrent)
ushort CH.Regatron.HPPS.Device.TopCon.GetUInt16 | ( | uint | address | ) |
Gets unsigned short value of given address
address | address of variable |
CH.Regatron.HPPS.Device.TopConCommunicationException | error while communication with device |
uint CH.Regatron.HPPS.Device.TopCon.GetUInt32 | ( | uint | address | ) |
Gets unsigned int value of given address
address | address of variable |
CH.Regatron.HPPS.Device.TopConCommunicationException | error while communication with device |
void CH.Regatron.HPPS.Device.TopCon.GetUnderVoltageErrorDelay | ( | out double | errorDelayUnderVoltage | ) |
Gets under voltage error delay value.
errorDelayUnderVoltage | error delay in ms |
CH.Regatron.HPPS.Device.TopConCommunicationException | error while communication with device |
void CH.Regatron.HPPS.Device.TopCon.GetUnderVoltageErrorLimit | ( | out double | errorLimitUnderVoltage | ) |
Gets under voltage error limit value.
errorLimitUnderVoltage | error limit in V |
CH.Regatron.HPPS.Device.TopConCommunicationException | error while communication with device |
|
static |
Get the version of this TopCon programming API (excluding the revision number).
|
static |
Get the version of this TopCon programming API (incl. revision number).
double CH.Regatron.HPPS.Device.TopCon.GetVoltageBottomActual | ( | ) |
Get the actual bottom voltage value for a TC.P.LIN device with S3r mode.
CH.Regatron.HPPS.Device.TopConCommunicationException | |
System.NotSupportedException |
double CH.Regatron.HPPS.Device.TopCon.GetVoltageBottomReference | ( | ) |
Get the reference bottom voltage value for a TC.P.LIN device with S3r mode
CH.Regatron.HPPS.Device.TopConCommunicationException | |
System.NotSupportedException |
void CH.Regatron.HPPS.Device.TopCon.GetVoltageQ1Adaptive | ( | out uint | voltageQ1PAdaptive, |
out uint | voltageQ1IAdaptive | ||
) |
Gets P- and I-Adaptive of Voltage Q1
voltageQ1PAdaptive | P-Adaptive (more details in manual) of Voltage Q1 |
voltageQ1IAdaptive | I-Adaptive (more details in manual) of Voltage Q1 |
CH.Regatron.HPPS.Device.TopConCommunicationException | error while communication with device |
void CH.Regatron.HPPS.Device.TopCon.GetVoltageQ1ControlParameters | ( | out uint | pGain, |
out uint | iGain, | ||
out uint | dGain, | ||
out uint | t1, | ||
out uint | feedFwd | ||
) |
Gets control parameters for Voltage Q1
pGain | pGain (more details in manual) of Voltage Q1 |
iGain | iGain (more details in manual) of Voltage Q1 |
dGain | dGain (more details in manual) of Voltage Q1 |
t1 | t1 (more details in manual) of Voltage Q1 |
feedFwd | feedFwd (more details in manual) of Voltage Q1 |
CH.Regatron.HPPS.Device.TopConCommunicationException | error while communication with device |
void CH.Regatron.HPPS.Device.TopCon.GetVoltageQ1TcLinControlParameters | ( | out uint | pGain, |
out uint | iGain | ||
) |
Gets control parameters (more details in manual) of Voltage Q1 TC.Lin
pGain | pGain (more details in manual) of Voltage Q1 TC.Lin |
iGain | iGain (more details in manual) of Voltage Q1 TC.Lin |
CH.Regatron.HPPS.Device.TopConCommunicationException | error while communication with device |
CH.Regatron.HPPS.Device.TopConException | Tc Lin is not enabled |
NotSupportedException | Firmware version is to old |
void CH.Regatron.HPPS.Device.TopCon.GetVoltageQ4ControlParameters | ( | out short | pGain, |
out short | iGain, | ||
out short | feedFwd | ||
) |
Gets control parameters of Voltage Q4
pGain | pGain (more details in manual) of Voltage Q4 |
iGain | iGain (more details in manual) of Voltage Q4 |
feedFwd | feedFwd (more details in manual) of Voltage Q4 |
CH.Regatron.HPPS.Device.TopConCommunicationException | error while communication with device |
CH.Regatron.HPPS.Device.TopConException | no ibc board connected |
bool CH.Regatron.HPPS.Device.TopCon.IsConnected | ( | ) |
This function indicates if the object is connected to the TopCon device.
bool CH.Regatron.HPPS.Device.TopCon.IsInErrorState | ( | ) |
This function returns true if the TopCon system is in "ERROR" state.
bool CH.Regatron.HPPS.Device.TopCon.IsInReadyState | ( | ) |
This function returns true if the TopCon system is in "READY" state.
bool CH.Regatron.HPPS.Device.TopCon.IsInRunState | ( | ) |
This function returns true if the TopCon system is in "RUN" state.
bool CH.Regatron.HPPS.Device.TopCon.IsInWarningState | ( | ) |
This function returns true if the TopCon system is in "ERROR" state.
bool CH.Regatron.HPPS.Device.TopCon.IsOptionAvlStorageEnabled | ( | ) |
This method indicates if a valid AVLStorage option is available in the connected TopCon.
CH.Regatron.HPPS.Device.TopConException |
bool CH.Regatron.HPPS.Device.TopCon.IsOptionBatControlEnabled | ( | ) |
This method indicates if a valid ACCU option is available in the connected TopCon.
CH.Regatron.HPPS.Device.TopConException |
bool CH.Regatron.HPPS.Device.TopCon.IsOptionBatSimEnabled | ( | ) |
This method indicates if a valid BatSim option is available in the connected TopCon.
CH.Regatron.HPPS.Device.TopConException |
bool CH.Regatron.HPPS.Device.TopCon.IsOptionCapSimEnabled | ( | ) |
This method indicates if a valid CapSim option is available in the connected TopCon.
CH.Regatron.HPPS.Device.TopConException |
bool CH.Regatron.HPPS.Device.TopCon.IsOptionSasEnabled | ( | ) |
This method indicates if a valid SAS option is available in the connected TopCon.
CH.Regatron.HPPS.Device.TopConException |
bool CH.Regatron.HPPS.Device.TopCon.IsOptionTfeEnabled | ( | ) |
This method indicates if a valid TFE option is available in the connected TopCon.
CH.Regatron.HPPS.Device.TopConException |
bool CH.Regatron.HPPS.Device.TopCon.IsPowerOn | ( | ) |
This function determines if the TopCon device is in POWER ON mode.
bool CH.Regatron.HPPS.Device.TopCon.IsSupportedExtenedProtect | ( | ) |
Check support of Extened Protection before calling a method:
bool CH.Regatron.HPPS.Device.TopCon.IsSupportedQ1Q4LimitMode | ( | ) |
Check support Q1 and Q4 limit mode before calling a method:
bool CH.Regatron.HPPS.Device.TopCon.IsSupportedQ4UserLimits | ( | ) |
Check support of Q4 User Limits before calling a method:
bool CH.Regatron.HPPS.Device.TopCon.IsSupportedQ4VoltageUserLimit | ( | ) |
Check support of Q4 Voltage User Limit before calling a method:
bool CH.Regatron.HPPS.Device.TopCon.IsSupportedUBottom | ( | ) |
Check support for UBottom
Boolean CH.Regatron.HPPS.Device.TopCon.IsWatchdogRunning | ( | ) |
check if watchdog RS-232 is running
void CH.Regatron.HPPS.Device.TopCon.ResetChargeCounter | ( | ) |
This function sets the charge counter of the TopCon PS to 0.0 (Reset).
void CH.Regatron.HPPS.Device.TopCon.ResetDevice | ( | ) |
Resets device (output voltage has to be turned off). When the method is finished without exception, all devices should be reset.
Note 1: All unsaved parameter values on the device get lost. With StoreParameters() they could be saved.
Note 2: This method resets all devices, which could take long.
Note 3: If method returns that not all devices could have been reset, try method ResetDevice(int timeOut) with longer timeOut.
CH.Regatron.HPPS.Device.TopConCommunicationException | error while communication with device |
TopConException | Voltage is turned on |
TopConException | Could not reset all devices |
NotSupportedException | Firmware version to old |
NotSupportedException | compatibility mode active |
void CH.Regatron.HPPS.Device.TopCon.ResetDevice | ( | int | timeOut | ) |
Resets device (output voltage has to be turned off). Timeout is used for the waiting time after reset started. When the method is finished without exception, all devices should be reset.
Note 1: All unsaved parameter values on the device get lost. With StoreParameters() they could be saved.
Note 2: This method resets all devices, which could take long. Note 3: If method returns that not all devices could have been reset, try method ResetDevice(int timeOut) with longer timeOut.
timeOut | timeOut in milliseconds after reset device (minimum value is 5000ms) to wait until it starts rebooting |
CH.Regatron.HPPS.Device.TopConCommunicationException | error while communication with device |
TopConException | Voltage is turned on |
TopConException | Could not reconnect to device |
NotSupportedException | Firmware version to old |
NotSupportedException | compatibility mode active |
void CH.Regatron.HPPS.Device.TopCon.ResetEnergyCounter | ( | ) |
This function sets the energy counter of the TopCon PS to 0.0 (Reset).
This method automatically switch to TC.LIN system values if supported and attached to TC.P or TC.MAC.
void CH.Regatron.HPPS.Device.TopCon.RestartMppTrackingEfficiencyMeasurement | ( | ) |
Calling this method resets the efficiency measurement in the TopCon device (or in TC.LIN if available). It is recommended to do this once to start a new efficiency measurement period.
This method automatically switch to TC.LIN system values if supported and attached to TC.P or TC.MAC.
TopConCommunicationException |
void CH.Regatron.HPPS.Device.TopCon.SetChargeCounterToValue | ( | double | value | ) |
This function sets the charge counter of the TopCon PS to the value given as parameter.
value | The value that the energy counter has to be set to. |
void CH.Regatron.HPPS.Device.TopCon.SetCommTimeout | ( | int | readTimeout, |
int | writeTimeout | ||
) |
This function allows to set the communication timeout parameters for read and write actions from and to the RS-232 interface. This parameter is used when a COM port is opened and defines how long the port waits for acknowledgement data from the other party.
Standard value: read = 10, write = 10.
Values used with the Regatron Ethernet option (Ethernet-to-RS232 converter): read = 100, write = 100.
readTimeout | Multiplier value for RS-232 read actions. |
writeTimeout | Multiplier value for RS-232 write actions. |
System.ArgumentException |
void CH.Regatron.HPPS.Device.TopCon.SetCurrentQ1Adaptive | ( | uint | currentQ1PAdaptive, |
uint | currentQ1IAdaptive | ||
) |
Sets P- and I-Adaptive of Current Q1
Note 1: These values are also settable with GSS.WR devices and in High Dynamics-Mode, but then have no impact
Note 2: Call StoreParameters() if you want to store parameters on device. On Power Off/On parameters then stay the same.
currentQ1PAdaptive | P-Adaptive (more details in manual) of Current Q1 |
currentQ1IAdaptive | I-Adaptive (more details in manual) of Current Q1 |
CH.Regatron.HPPS.Device.TopConCommunicationException | error while communication with device |
void CH.Regatron.HPPS.Device.TopCon.SetCurrentQ1ControlParameters | ( | uint | pGain, |
uint | iGain, | ||
uint | dGain, | ||
uint | t1, | ||
uint | feedFwd | ||
) |
Sets control parameters for Current Q1
Note: Call StoreParameters() if you want to store parameters on device. On Power Off/On parameters then stay the same.
pGain | pGain (more details in manual) of Current Q1 |
iGain | iGain (more details in manual) of Current Q1 |
dGain | dGain (more details in manual) of Current Q1 |
t1 | t1 (more details in manual) of Current Q1 |
feedFwd | feedFwd (more details in manual) of Current Q1 |
CH.Regatron.HPPS.Device.TopConCommunicationException | error while communication with device |
void CH.Regatron.HPPS.Device.TopCon.SetCurrentQ1TcLinControlParameters | ( | uint | pGain, |
uint | iGain | ||
) |
Sets control parameters (more details in manual) of Current Q1 TC.Lin
Note: Call StoreParameters() if you want to store parameters on device. On Power Off/On parameters then stay the same.
pGain | pGain (more details in manual) of Current Q1 TC.Lin |
iGain | iGain (more details in manual) of Current Q1 TC.Lin |
CH.Regatron.HPPS.Device.TopConCommunicationException | error while communication with device |
CH.Regatron.HPPS.Device.TopConException | Tc Lin is not enabled |
NotSupportedException | Firmware version is to old |
void CH.Regatron.HPPS.Device.TopCon.SetCurrentQ4ControlParameters | ( | short | pGain, |
short | iGain, | ||
short | feedFwd | ||
) |
Sets control parameters of Current Q4
Note: Call StoreParameters() if you want to store parameters on device. On Power Off/On parameters then stay the same.
pGain | pGain (more details in manual) of Current Q4 |
iGain | iGain (more details in manual) of Current Q4 |
feedFwd | feedFwd (more details in manual) of Current Q4 |
CH.Regatron.HPPS.Device.TopConCommunicationException | error while communication with device |
CH.Regatron.HPPS.Device.TopConException | no ibc board connected |
void CH.Regatron.HPPS.Device.TopCon.SetCurrentRange | ( | uint | currentRange | ) |
Sets current range
Note 1: Call StoreParameters() if you want to store parameters on device. On Power Off/On parameters then stay the same.
Note 2: Call ResetDevice() to activate changes
currentRange | 0 --> use local TC.LIN settings, 1 --> use max current range (all), 2 --> use alternative current range (all) |
CH.Regatron.HPPS.Device.TopConCommunicationException | error while communication with device |
void CH.Regatron.HPPS.Device.TopCon.SetEnergyCounterToValue | ( | double | value | ) |
This function sets the energy counter of the TopCon PS to the value given as parameter.
This method automatically switch to TC.LIN system values if supported and attached to TC.P or TC.MAC.
value | The value that the energy counter has to be set to. |
void CH.Regatron.HPPS.Device.TopCon.SetFloat | ( | uint | address, |
float | data | ||
) |
Sets float value to the given address
address | address of variable |
data | float value |
CH.Regatron.HPPS.Device.TopConCommunicationException | error while communication with device |
void CH.Regatron.HPPS.Device.TopCon.SetHighDynamicMode | ( | ) |
Sets High Dynamic Mode for the control principle
CH.Regatron.HPPS.Device.TopConCommunicationException | error while communication with device |
NotSupportedException | setting mode is not supported |
void CH.Regatron.HPPS.Device.TopCon.SetLimitCurrentQ4 | ( | double | currentQ4 | ) |
This function sets the current limit (Reference Current) of the TopCon power supply (for Q4-Mode (TopCon 4.20 or higher/ReGen/ResAct)). Note: Call StoreParameters() if you want to store parameters on device. On Power Off/On parameters then stay the same.
currentQ4 | The current limt sink value in amps [A]. |
CH.Regatron.HPPS.Device.TopConCommunicationException | |
System.NotSupportedException | |
System.ArgumentOutOfRangeException |
void CH.Regatron.HPPS.Device.TopCon.SetLimitPowerQ4 | ( | double | powerQ4 | ) |
This function sets the power limit (Reference Power) of the TopCon power supply (for Q4-Mode (TopCon 4.20 or higher/ReGen/ResAct)). Note: Call StoreParameters() if you want to store parameters on device. On Power Off/On parameters then stay the same.
powerQ4 | The power limit sink value in kilowatts [kW]. |
CH.Regatron.HPPS.Device.TopConCommunicationException | |
System.NotSupportedException | |
System.ArgumentOutOfRangeException |
void CH.Regatron.HPPS.Device.TopCon.SetLimitVoltageQ4 | ( | double | voltageQ4 | ) |
Set Q4 controller voltage limit (parameter must be positive!) voltage PhysicalVoltage [V] This is only possible if it is a GSS Device or a ReGen Device with. Note: Call StoreParameters() if you want to store parameters on device. On Power Off/On parameters then stay the same.
voltageQ4 | The Voltage limit sink value in voltage [V]. |
CH.Regatron.HPPS.Device.TopConCommunicationException | |
System.NotSupportedException | |
System.ArgumentOutOfRangeException |
void CH.Regatron.HPPS.Device.TopCon.SetMatrixConnectionType | ( | bool | type | ) |
Sets matrix connection type
Note 1: Call StoreParameters() if you want to store parameters on device. On Power Off/On parameters then stay the same.
Note 2: Call ResetDevice() to activate changes
type | true to activate, false to deactivate (more details in manual) |
void CH.Regatron.HPPS.Device.TopCon.SetMaxPowerQ1ErrorDelay | ( | double | errorDelayMaxPowerQ1 | ) |
Sets max power Q1 error delay value.
errorDelayMaxPowerQ1 | error delay in ms |
ArgumentException | value is not in the range |
CH.Regatron.HPPS.Device.TopConCommunicationException | error while communication with device |
void CH.Regatron.HPPS.Device.TopCon.SetMaxPowerQ1ErrorLimit | ( | double | errorLimitMaxPowerQ1 | ) |
Sets max power Q1 error limit value.
errorLimitMaxPowerQ1 | error limit in kW |
CH.Regatron.HPPS.Device.TopConCommunicationException | error while communication with device |
ArgumentException | values are not in range |
void CH.Regatron.HPPS.Device.TopCon.SetMaxPowerQ4ErrorDelay | ( | double | errorDelayMaxPowerQ4 | ) |
Gets max power Q4 error delay value.
errorDelayMaxPowerQ4 | error delay in ms |
ArgumentException | value is not in the range |
CH.Regatron.HPPS.Device.TopConCommunicationException | error while communication with device |
void CH.Regatron.HPPS.Device.TopCon.SetMaxPowerQ4ErrorLimit | ( | double | errorLimitMaxPowerQ4 | ) |
Sets max power Q4 error limit value.
errorLimitMaxPowerQ4 | error limit in kW |
CH.Regatron.HPPS.Device.TopConCommunicationException | error while communication with device |
void CH.Regatron.HPPS.Device.TopCon.SetNumberOfModules | ( | uint | numSerie, |
uint | numParallel | ||
) |
Sets number of modules
Note 1: Call StoreParameters() if you want to store parameters on device. On Power Off/On parameters then stay the same.
Note 2: Call ResetDevice() to activate changes
numSerie | number of modules in line (more details in manual) |
numParallel | number of modules parallel (more details in manual) |
CH.Regatron.HPPS.Device.TopConCommunicationException | error while communication with device |
void CH.Regatron.HPPS.Device.TopCon.SetOutputCapacitanceEnabled | ( | bool | outputCapacitanceEnabled | ) |
Sets Output capacitance enabled
Note 1: Call StoreParameters() if you want to store parameters on device. On Power Off/On parameters then stay the same.
Note 2: Call ResetDevice() to activate changes
outputCapacitanceEnabled | true to activate, false to deactivate (more details in manual) |
CH.Regatron.HPPS.Device.TopConCommunicationException | error while communication with device |
CH.Regatron.HPPS.Device.TopConException | Output Capacitance is not supported |
void CH.Regatron.HPPS.Device.TopCon.SetOverCurrentQ1ErrorDelay | ( | double | errorDelayCurrentQ1 | ) |
Sets over current Q1 error delay value.
errorDelayCurrentQ1 | error delay in ms |
CH.Regatron.HPPS.Device.TopConCommunicationException | error while communication with device |
void CH.Regatron.HPPS.Device.TopCon.SetOverCurrentQ1ErrorLimit | ( | double | errorLimitCurrentQ1 | ) |
Sets over current Q1 error limit value.
errorLimitCurrentQ1 | error limit in A |
CH.Regatron.HPPS.Device.TopConCommunicationException | error while communication with device |
ArgumentException | values are not in range |
void CH.Regatron.HPPS.Device.TopCon.SetOverCurrentQ4ErrorDelay | ( | double | errorDelayCurrentQ4 | ) |
Sets over current Q4 error Delay
errorDelayCurrentQ4 | error delay in ms |
ArgumentException | value is not in the range |
CH.Regatron.HPPS.Device.TopConCommunicationException | error while communication with device |
void CH.Regatron.HPPS.Device.TopCon.SetOverCurrentQ4ErrorLimit | ( | double | errorLimitCurrentQ4 | ) |
Sets over current Q4 error limit value.
errorLimitCurrentQ4 | error limit in A |
ArgumentException | value is not in the range |
CH.Regatron.HPPS.Device.TopConCommunicationException | error while communication with device |
void CH.Regatron.HPPS.Device.TopCon.SetOverVoltageErrorDelay | ( | double | errorDelayVoltage | ) |
Sets over voltage error delay value.
errorDelayVoltage | error delay in ms |
CH.Regatron.HPPS.Device.TopConCommunicationException | error while communication with device |
ArgumentException | values are not in device range |
void CH.Regatron.HPPS.Device.TopCon.SetOverVoltageErrorLimit | ( | double | errorLimitVoltage | ) |
Sets over voltage error limit value.
errorLimitVoltage | error limit in V |
ArgumentException | values are not in range |
CH.Regatron.HPPS.Device.TopConCommunicationException | error while communication with device |
void CH.Regatron.HPPS.Device.TopCon.SetPower | ( | bool | control | ) |
Switches ON or OFF the power output stage.
control | true for ON, false for OFF |
void CH.Regatron.HPPS.Device.TopCon.SetPowerOff | ( | ) |
Switches OFF the power output stage.
void CH.Regatron.HPPS.Device.TopCon.SetPowerOn | ( | ) |
Switches ON the power output stage.
void CH.Regatron.HPPS.Device.TopCon.SetPowerQ1ControlParameters | ( | uint | pGain, |
uint | iGain | ||
) |
Sets control parameters of Power Q1 Note: Call StoreParameters() if you want to store parameters on device. On Power Off/On parameters then stay the same.
pGain | pGain (more details in manual) of Power Q1 |
iGain | iGain (more details in manual) of Power Q1 |
CH.Regatron.HPPS.Device.TopConCommunicationException | error while communication with device |
void CH.Regatron.HPPS.Device.TopCon.SetPowerQ4ControlParameters | ( | short | pGain, |
short | iGain | ||
) |
Sets control parameters of Power Q4
Note: Call StoreParameters() if you want to store parameters on device. On Power Off/On parameters then stay the same.
pGain | pGain (more details in manual) of Power Q4 |
iGain | iGain (more details in manual) of Power Q4 |
CH.Regatron.HPPS.Device.TopConCommunicationException | error while communication with device |
CH.Regatron.HPPS.Device.TopConException | no ibc board connected |
void CH.Regatron.HPPS.Device.TopCon.SetReferenceCurrent | ( | double | current | ) |
This function sets the current limit (Reference Current) of the TopCon power supply.
current | The current value in amps [A]. |
CH.Regatron.HPPS.Device.TopConCommunicationException | |
System.ArgumentOutOfRangeException |
void CH.Regatron.HPPS.Device.TopCon.SetReferencePower | ( | double | power | ) |
This function sets the power limit (Reference Power) of the TopCon power supply.
power | The power value in kilowatts [kW]. |
CH.Regatron.HPPS.Device.TopConCommunicationException | |
System.ArgumentOutOfRangeException |
void CH.Regatron.HPPS.Device.TopCon.SetReferenceResistance | ( | double | resistance | ) |
This function sets the internal resistance (Reference resistance) of the TopCon power supply.
resistance | The resistance value in milliohm [m?]. |
CH.Regatron.HPPS.Device.TopConCommunicationException | |
System.ArgumentOutOfRangeException |
void CH.Regatron.HPPS.Device.TopCon.SetReferenceVoltage | ( | double | voltage | ) |
This function sets the voltage limit (Reference Value) of the TopCon power supply.
voltage | The voltage value in volt [V]. |
CH.Regatron.HPPS.Device.TopConCommunicationException | |
System.ArgumentOutOfRangeException |
void CH.Regatron.HPPS.Device.TopCon.SetRemoteControlInterface | ( | RemoteControl | remoteControl | ) |
This function allows to set the control of the TopCon to a particular interface.
remoteControl | The control interface to be used. |
seealso cref="Connect"
void CH.Regatron.HPPS.Device.TopCon.SetRppEnabled | ( | bool | rppEnabled | ) |
Sets RPP(=Reverse Polarity Protection) enabled
Note 1: Call StoreParameters() if you want to store parameters on device. On Power Off/On parameters then stay the same.
Note 2: Call ResetDevice() to activate changes
rppEnabled | true to activate, false to deactivate (more details in manual) |
CH.Regatron.HPPS.Device.TopConCommunicationException | error while communication with device |
void CH.Regatron.HPPS.Device.TopCon.SetS3RModeEnabled | ( | bool | s3RModeEnabled | ) |
Sets S3RMode enabled
Note 1: Call StoreParameters() if you want to store parameters on device. On Power Off/On parameters then stay the same.
Note 2: Call ResetDevice() to activate changes
s3RModeEnabled | true to activate, false to deactivate (more details in manual) |
CH.Regatron.HPPS.Device.TopConCommunicationException | error while communication with device |
CH.Regatron.HPPS.Device.TopConException | S3R Mode is not supported |
void CH.Regatron.HPPS.Device.TopCon.SetSInt16 | ( | uint | address, |
short | data | ||
) |
Sets signed short value to the given address
address | address of variable |
data | short value |
CH.Regatron.HPPS.Device.TopConCommunicationException | error while communication with device |
void CH.Regatron.HPPS.Device.TopCon.SetSInt32 | ( | uint | address, |
int | data | ||
) |
Sets signed int value to the given address
address | address of variable |
data | int value |
CH.Regatron.HPPS.Device.TopConCommunicationException | error while communication with device |
void CH.Regatron.HPPS.Device.TopCon.SetSoftwareModuleId | ( | ushort | ah, |
ushort | al | ||
) |
Only use this method after consultation of our support team!
Sets the ModuleID software-based when AL = AH = F on actual device is set.
Note 1: This method needs a StoreParameters() before Resetting the device. Otherwise this settings get lost.
Note 2: If configured a state in software which not exactly corresponds to the hardware arrangement, the system could take damage.
ah | Related to AH value on device (value between 0 and 15) |
al | Related to AL value on device (value between 0 and 15) |
NotSupportedException | Firmware version to old |
CH.Regatron.HPPS.Device.TopConCommunicationException | error while communication with device |
CH.Regatron.HPPS.Device.TopConException | value to high |
void CH.Regatron.HPPS.Device.TopCon.SetStandardMode | ( | ) |
Sets Standard Mode for the control principle
CH.Regatron.HPPS.Device.TopConCommunicationException | error while communication with device |
NotSupportedException | setting mode is not supported |
void CH.Regatron.HPPS.Device.TopCon.SetSystemQuadrantOperatingMode | ( | QuadrantMode | quadrantMode | ) |
Set the quadrant operation mode limitation if Q1 Q4 LimitMode is supported.
quadrantMode |
CH.Regatron.HPPS.Device.TopConCommunicationException | |
CH.Regatron.HPPS.Device.TopConCofigurationException | |
System.NotSupportedException |
void CH.Regatron.HPPS.Device.TopCon.SetTcLinEnabled | ( | bool | tcLinEnabled | ) |
Sets Tc Lin enabled Note 1: Call StoreParameters() if you want to store parameters on device. On Power Off/On parameters then stay the same. Note 2: Call ResetDevice() to activate changes
tcLinEnabled | true to activate, false to deactivate (more details in manual) |
CH.Regatron.HPPS.Device.TopConCommunicationException | error while communication with device |
void CH.Regatron.HPPS.Device.TopCon.SetUInt16 | ( | uint | address, |
ushort | data | ||
) |
Sets unsigned short value to the given address
address | address of variable |
data | ushort value |
CH.Regatron.HPPS.Device.TopConCommunicationException | error while communication with device |
void CH.Regatron.HPPS.Device.TopCon.SetUInt32 | ( | uint | address, |
uint | data | ||
) |
Sets unsigned int value to the given address
address | address of variable |
data | uint value |
CH.Regatron.HPPS.Device.TopConCommunicationException | error while communication with device |
void CH.Regatron.HPPS.Device.TopCon.SetUnderVoltageErrorDelay | ( | double | errorDelayUnderVoltage | ) |
Sets under voltage error delay value.
errorDelayUnderVoltage | error delay in ms |
ArgumentException | value is not in the range |
CH.Regatron.HPPS.Device.TopConCommunicationException | error while communication with device |
void CH.Regatron.HPPS.Device.TopCon.SetUnderVoltageErrorLimit | ( | double | errorLimitUnderVoltage | ) |
Sets under voltage error limit value.
errorLimitUnderVoltage | error limit in V |
ArgumentException | value is not in the range |
CH.Regatron.HPPS.Device.TopConCommunicationException | error while communication with device |
void CH.Regatron.HPPS.Device.TopCon.SetVoltageBottomReference | ( | Double | uBottomRef | ) |
Set the reference bottom voltage value for a TC.P.LIN device with S3r mode
uBottomRef | reference bottom voltage |
CH.Regatron.HPPS.Device.TopConCommunicationException | |
System.ArgumentOutOfRangeException | |
System.NotSupportedException |
void CH.Regatron.HPPS.Device.TopCon.SetVoltageQ1Adaptive | ( | uint | voltageQ1PAdaptive, |
uint | voltageQ1IAdaptive | ||
) |
Sets P- and I-Adaptive of Voltage Q1
Note 1: These values are also settable with GSS.WR devices and in High Dynamics-Mode, but then have no impact
Note 2: Call StoreParameters() if you want to store parameters on device. On Power Off/On parameters then stay the same.
voltageQ1PAdaptive | P-Adaptive (more details in manual) of Voltage Q1 |
voltageQ1IAdaptive | I-Adaptive (more details in manual) of Voltage Q1 |
CH.Regatron.HPPS.Device.TopConCommunicationException | error while communication with device |
void CH.Regatron.HPPS.Device.TopCon.SetVoltageQ1ControlParameters | ( | uint | pGain, |
uint | iGain, | ||
uint | dGain, | ||
uint | t1, | ||
uint | feedFwd | ||
) |
Sets control parameters for Voltage Q1
Note: Call StoreParameters() if you want to store parameters on device. On Power Off/On parameters then stay the same.
pGain | pGain (more details in manual) of Voltage Q1 |
iGain | iGain (more details in manual) of Voltage Q1 |
dGain | dGain (more details in manual) of Voltage Q1 |
t1 | t1 (more details in manual) of Voltage Q1 |
feedFwd | feedFwd (more details in manual) of Voltage Q1 |
CH.Regatron.HPPS.Device.TopConCommunicationException | error while communication with device |
void CH.Regatron.HPPS.Device.TopCon.SetVoltageQ1TcLinControlParameters | ( | uint | pGain, |
uint | iGain | ||
) |
Sets control parameters (more details in manual) of Voltage Q1 TC.Lin
Note: Call StoreParameters() if you want to store parameters on device. On Power Off/On parameters then stay the same.
pGain | pGain (more details in manual) of Voltage Q1 TC.Lin |
iGain | iGain (more details in manual) of Voltage Q1 TC.Lin |
CH.Regatron.HPPS.Device.TopConCommunicationException | error while communication with device |
CH.Regatron.HPPS.Device.TopConException | Tc Lin is not enabled |
NotSupportedException | Firmware version is to old |
void CH.Regatron.HPPS.Device.TopCon.SetVoltageQ4ControlParameters | ( | short | pGain, |
short | iGain, | ||
short | feedFwd | ||
) |
Sets control parameters of Voltage Q4
Note: Call StoreParameters() if you want to store parameters on device. On Power Off/On parameters then stay the same.
pGain | pGain (more details in manual) of Voltage Q4 |
iGain | iGain (more details in manual) of Voltage Q4 |
feedFwd | feedFwd (more details in manual) of Voltage Q4 |
CH.Regatron.HPPS.Device.TopConCommunicationException | error while communication with device |
CH.Regatron.HPPS.Device.TopConException | no ibc board connected |
void CH.Regatron.HPPS.Device.TopCon.StoreParameters | ( | ) |
Stores Parameters on device. Method ends when storing is finished.
CH.Regatron.HPPS.Device.TopConCommunicationException | error while communication with device |
bool CH.Regatron.HPPS.Device.TopCon.UpdateTopConConfigurationWithTopConData | ( | ) |
After call TopCon constructor with a parameter TopConConfiguration, call the connect method. Afterwards once a UpdateTopConConfigurationWithTopConData() call. This function updates the content of the TopConConfiguration of this TopCon object with the values of the connected TopCon device.
true if the TopCon is connected (and update was successful), false otherwise
void CH.Regatron.HPPS.Device.TopCon.WatchdogRs232Clear | ( | ) |
If a Watchdog error occurs on the topcon device use this method to clear the run and error state of watchdog. After WatchdogRS232Clear() call ClearError() to get the TopCon device in ready state.
void CH.Regatron.HPPS.Device.TopCon.WatchdogRs232Off | ( | ) |
Disable the RS-232 watchdog to the TopCon device.
Int32 CH.Regatron.HPPS.Device.TopCon.WatchdogRs232On | ( | ) |
Enable the RS-232 watchdog to the TopCon device.
|
static |
This constants is similar to one is known in TCIO API as DLL_FAIL
|
static |
This constants is similar to one is known in TCIO API as DLL_SUCCESS
bool CH.Regatron.HPPS.Device.TopCon.Disposed => _disposed |
|
get |
Determines what quadrant mode is enabled on the device.
|
get |
Read out the quadrant operating mode active by the device if Q1 Q4 LimitMode is supported.
CH.Regatron.HPPS.Device.TopConCommunicationException | |
CH.Regatron.HPPS.Device.TopConCofigurationException | |
System.NotSupportedException |