tcio  V3.74.00
Function description
Functions
Controller Settings

Functions

DLL_RESULT TC42GetQ4ControllerCurrentFFWDGain (short *pGain)
 Get Feedforward-Gain of Q4 current controller.
DLL_RESULT TC42GetQ4ControllerCurrentIGain (short *pGain)
 Get I-Gain of Q4 current controller.
DLL_RESULT TC42GetQ4ControllerCurrentPGain (short *pGain)
 Get P-Gain of Q4 current controller.
DLL_RESULT TC42GetQ4ControllerPowerIGain (short *pGain)
 Get I-Gain of Q4 power controller.
DLL_RESULT TC42GetQ4ControllerPowerPGain (short *pGain)
 Get P-Gain of Q4 power controller.
DLL_RESULT TC42GetQ4ControllerVoltageFFWDGain (short *pGain)
 Get Feedforward-Gain of Q4 voltage controller.
DLL_RESULT TC42GetQ4ControllerVoltageIGain (short *pGain)
 Get I-Gain of Q4 voltage controller.
DLL_RESULT TC42GetQ4ControllerVoltagePGain (short *pGain)
 Get P-Gain of Q4 voltage controller.
DLL_RESULT TC42SetQ4ControllerCurrentFFWDGain (short Gain)
 Set Feedforward-Gain of Q4 current controller [-32766…32767].
DLL_RESULT TC42SetQ4ControllerCurrentIGain (short Gain)
 Set I-Gain of Q4 current controller [-32766…32767].
DLL_RESULT TC42SetQ4ControllerCurrentPGain (short Gain)
 Set P-Gain of Q4 current controller [-32766…32767].
DLL_RESULT TC42SetQ4ControllerPowerIGain (short Gain)
 Set I-Gain of Q4 power controller [-32766…32767].
DLL_RESULT TC42SetQ4ControllerPowerPGain (short Gain)
 Set P-Gain of Q4 power controller [-32766…32767].
DLL_RESULT TC42SetQ4ControllerVoltageFFWDGain (short Gain)
 Set Feedforward-Gain of Q4 voltage controller [-32766…32767].
DLL_RESULT TC42SetQ4ControllerVoltageIGain (short Gain)
 Set I-Gain of Q4 voltage controller [-32766…32767].
DLL_RESULT TC42SetQ4ControllerVoltagePGain (short Gain)
 Set P-Gain of Q4 voltage controller [-32766…32767].
DLL_RESULT TC4GetAdaptivControlSettings (unsigned int *vpadaptiv, unsigned int *viadaptiv, unsigned int *cpadaptiv, unsigned int *ciadaptiv)
 Reads actual adaptiv controller settings.
DLL_RESULT TC4GetAnalogBW (unsigned int *analogin, unsigned int *analogout)
 Reads the actual bandwidth limit for set values and actual values on analog interface.
DLL_RESULT TC4GetControlIn (unsigned int *output_on)
 With this function you can determine whether output voltage is enabled or disabled.
DLL_RESULT TC4GetCurrentControlSettings (unsigned int *p_pgain, unsigned int *p_igain, unsigned int *p_dgain, unsigned int *p_feed, unsigned int *p_t1)
 Reads the actual controller parameters of the current.
DLL_RESULT TC4GetLoadReject (unsigned int *reduction, unsigned int *cdifference)
 Reads load reject settings.
DLL_RESULT TC4GetOperatingModeQ1Only (unsigned short *pEnable)
 Query if operating mode is limited to Q1 only.
DLL_RESULT TC4GetOperatingModeQ4Only (unsigned short *pEnable)
 Query if operating mode is limited to Q4 only.
DLL_RESULT TC4GetPowerControlSettings (unsigned int *p_pgain, unsigned int *p_igain)
 Reads the actual controller parameters of the voltage.
DLL_RESULT TC4GetSlaveCharacteristics (int *slavevolterr, int *slavecurrerr, unsigned int *turnoffslaves)
 Reads actual settings for slave characteristics.
DLL_RESULT TC4GetVoltageControlSettings (unsigned int *p_pgain, unsigned int *p_igain, unsigned int *p_dgain, unsigned int *p_feed, unsigned int *p_t1)
 Reads the actual controller parameters of the voltage.
DLL_RESULT TC4GetVoltageSlopeRamp (unsigned int *p_slope, unsigned int *p_ramp)
 Reads the actual slopes and ramps for voltage.
DLL_RESULT TC4SetAdaptivControlSettings (unsigned int vpadaptiv, unsigned int viadaptiv, unsigned int cpadaptiv, unsigned int ciadaptiv)
 Sets adaptive controller parameters. Adaptiv controller parameters can improve controller behaviour when load impedance changes.
DLL_RESULT TC4SetAnalogBW (unsigned int analogin, unsigned int analogout)
 Sets bandwidth limit for analog set values and analog actual values.
DLL_RESULT TC4SetControlIn (unsigned int voltage_on)
 Enables and disables output voltage.
DLL_RESULT TC4SetCurrentControlSettings (unsigned int pgain, unsigned int igain, unsigned int dgain, unsigned int feed, unsigned int t1)
 Sets controller parameters current.
DLL_RESULT TC4SetCurrentSlopeRamp (unsigned int slope, unsigned int ramp)
 Set slope and ramp values for current set values.
DLL_RESULT TC4SetLoadReject (unsigned int reduction, unsigned int cdifference)
 Sets load reject parameters. These parameters can improve controller behaviour on load rejection.
DLL_RESULT TC4SetOperatingModeQ1Only (unsigned short Enable)
 Set operating mode to Q1 only.
Be sure to not disable operating range to Q4 only at the same time.
Otherwise output is disabled (as nether Q1 nor Q4 operating mode is allowed)
DLL_RESULT TC4SetOperatingModeQ4Only (unsigned short Enable)
 Set operating mode to Q4 only.
Be sure to not disable operating range to Q1 only at the same time.
Otherwise output is disabled (as nether Q1 nor Q4 operating mode is allowed)
DLL_RESULT TC4SetPowerControlSettings (unsigned int pgain, unsigned int igain)
 Sets controller parameters power.
DLL_RESULT TC4SetSlaveCharacteristics (int slavevolterr, int slavecurrerr, unsigned int turnoffslaves)
 Set parameters for slave characteristics. These parameters determine whether TopCon Slaves try to reach set values fast or slow, depending on their actual control-error. Automatically turning off the slave controller when load current is very small or zero can improve output voltage stability.
DLL_RESULT TC4SetVoltageControlSettings (unsigned int pgain, unsigned int igain, unsigned int dgain, unsigned int feed, unsigned int t1)
 Sets controller parameters voltage.
DLL_RESULT TC4SetVoltageSlopeRamp (unsigned int slope, unsigned int ramp)
 Set slope and ramp values for voltage set values.

Detailed Description

Values to read/change controller PID parameters and other controller related settings.


Function Documentation

DLL_RESULT TC42GetQ4ControllerCurrentFFWDGain ( short *  pGain)

Get Feedforward-Gain of Q4 current controller.

Parameters:
[out]pGain[#]
Returns:
DLL_SUCCESS for success or DLL_FAIL or other value if an error occurs
DLL_RESULT TC42GetQ4ControllerCurrentIGain ( short *  pGain)

Get I-Gain of Q4 current controller.

Parameters:
[out]pGain[#]
Returns:
DLL_SUCCESS for success or DLL_FAIL or other value if an error occurs
DLL_RESULT TC42GetQ4ControllerCurrentPGain ( short *  pGain)

Get P-Gain of Q4 current controller.

Parameters:
[out]pGain[#]
Returns:
DLL_SUCCESS for success or DLL_FAIL or other value if an error occurs
DLL_RESULT TC42GetQ4ControllerPowerIGain ( short *  pGain)

Get I-Gain of Q4 power controller.

Parameters:
[out]*pGain[#]
Returns:
DLL_SUCCESS for success or DLL_FAIL or other value if an error occurs
DLL_RESULT TC42GetQ4ControllerPowerPGain ( short *  pGain)

Get P-Gain of Q4 power controller.

Parameters:
[out]pGain[#]
Returns:
DLL_SUCCESS for success or DLL_FAIL or other value if an error occurs
DLL_RESULT TC42GetQ4ControllerVoltageFFWDGain ( short *  pGain)

Get Feedforward-Gain of Q4 voltage controller.

Parameters:
[out]pGain[#]
Returns:
DLL_SUCCESS for success or DLL_FAIL or other value if an error occurs
DLL_RESULT TC42GetQ4ControllerVoltageIGain ( short *  pGain)

Get I-Gain of Q4 voltage controller.

Parameters:
[out]pGain[#]
Returns:
DLL_SUCCESS for success or DLL_FAIL or other value if an error occurs
DLL_RESULT TC42GetQ4ControllerVoltagePGain ( short *  pGain)

Get P-Gain of Q4 voltage controller.

Parameters:
[out]pGain[#]
Returns:
DLL_SUCCESS for success or DLL_FAIL or other value if an error occurs
DLL_RESULT TC42SetQ4ControllerCurrentFFWDGain ( short  Gain)

Set Feedforward-Gain of Q4 current controller [-32766…32767].

Parameters:
[in]Gain[#]
Returns:
DLL_SUCCESS for success or DLL_FAIL or other value if an error occurs
DLL_RESULT TC42SetQ4ControllerCurrentIGain ( short  Gain)

Set I-Gain of Q4 current controller [-32766…32767].

Parameters:
[in]Gain[#]
Returns:
DLL_SUCCESS for success or DLL_FAIL or other value if an error occurs
DLL_RESULT TC42SetQ4ControllerCurrentPGain ( short  Gain)

Set P-Gain of Q4 current controller [-32766…32767].

Parameters:
[in]Gain[#]
Returns:
DLL_SUCCESS for success or DLL_FAIL or other value if an error occurs
DLL_RESULT TC42SetQ4ControllerPowerIGain ( short  Gain)

Set I-Gain of Q4 power controller [-32766…32767].

Parameters:
[in]Gain[#]
Returns:
DLL_SUCCESS for success or DLL_FAIL or other value if an error occurs
DLL_RESULT TC42SetQ4ControllerPowerPGain ( short  Gain)

Set P-Gain of Q4 power controller [-32766…32767].

Parameters:
[in]Gain[#]
Returns:
DLL_SUCCESS for success or DLL_FAIL or other value if an error occurs
DLL_RESULT TC42SetQ4ControllerVoltageFFWDGain ( short  Gain)

Set Feedforward-Gain of Q4 voltage controller [-32766…32767].

Parameters:
[in]Gain[#]
Returns:
DLL_SUCCESS for success or DLL_FAIL or other value if an error occurs
DLL_RESULT TC42SetQ4ControllerVoltageIGain ( short  Gain)

Set I-Gain of Q4 voltage controller [-32766…32767].

Parameters:
[in]Gain[#]
Returns:
DLL_SUCCESS for success or DLL_FAIL or other value if an error occurs
DLL_RESULT TC42SetQ4ControllerVoltagePGain ( short  Gain)

Set P-Gain of Q4 voltage controller [-32766…32767].

TC4__ regen / TC42__ GSS extension

Parameters:
[in]Gain[#]
Returns:
DLL_SUCCESS for success or DLL_FAIL or other value if an error occurs
DLL_RESULT TC4GetAdaptivControlSettings ( unsigned int *  vpadaptiv,
unsigned int *  viadaptiv,
unsigned int *  cpadaptiv,
unsigned int *  ciadaptiv 
)

Reads actual adaptiv controller settings.

Parameters:
[out]vpadaptivAdaptive gain for voltage controller P-gain
[out]viadaptivAdaptive gain for voltage controller I-gain
[out]cpadaptivAdaptive gain for current controller P-gain
[out]ciadaptivAdaptive gain for current controller I-gain
Returns:
DLL_SUCCESS for success or DLL_FAIL or other value if an error occurs
DLL_RESULT TC4GetAnalogBW ( unsigned int *  analogin,
unsigned int *  analogout 
)

Reads the actual bandwidth limit for set values and actual values on analog interface.

Parameters:
[out]analoginActual bandwidth limit for analog set values
[out]analogoutActual bandwidth limit for analog actual values
Note:
filter frequency steps: 0 = filter is turned off 1 =1600Hz, 2 = 800Hz, 3=400Hz, …, 15 = 0.1Hz
Returns:
DLL_SUCCESS for success or DLL_FAIL or other value if an error occurs
DLL_RESULT TC4GetControlIn ( unsigned int *  output_on)

With this function you can determine whether output voltage is enabled or disabled.

Parameters:
[out]output_onActual output voltage state
Note:
this function also gives correct values when the output voltage was enabled or disabled via analog interface or HMI/HME.
Returns:
DLL_SUCCESS for success or DLL_FAIL or other value if an error occurs
DLL_RESULT TC4GetCurrentControlSettings ( unsigned int *  p_pgain,
unsigned int *  p_igain,
unsigned int *  p_dgain,
unsigned int *  p_feed,
unsigned int *  p_t1 
)

Reads the actual controller parameters of the current.

Parameters:
[out]p_pgainActual P-gain
[out]p_igainActual I-gain
[out]p_dgainActual D-gain
[out]p_feedActual feed-forward-gain
[out]p_t1Actual time delay for D-gain
Returns:
DLL_SUCCESS for success or DLL_FAIL or other value if an error occurs
DLL_RESULT TC4GetLoadReject ( unsigned int *  reduction,
unsigned int *  cdifference 
)

Reads load reject settings.

Parameters:
[out]reductionController output reduction (0…4096), 0=0%, 4096=100%
[out]cdifferenceCurrent difference within 50us for load reject detection (0…4000)
Attention:
cdifference is not a physical value - so translate to correct physical value
Note:
Load reject detection is supported from firmware V4.11.20 or later and is only effective in Q1 operating mode.
See also:
chapter Translate between standardised values and physical values
Returns:
DLL_SUCCESS for success or DLL_FAIL or other value if an error occurs
DLL_RESULT TC4GetOperatingModeQ1Only ( unsigned short *  pEnable)

Query if operating mode is limited to Q1 only.

Parameters:
[out]pEnable0: false
1: true
Returns:
DLL_SUCCESS for success or DLL_FAIL or other value if an error occurs
DLL_RESULT TC4GetOperatingModeQ4Only ( unsigned short *  pEnable)

Query if operating mode is limited to Q4 only.

Parameters:
[out]pEnable0: false
1: true
Returns:
DLL_SUCCESS for success or DLL_FAIL or other value if an error occurs
DLL_RESULT TC4GetPowerControlSettings ( unsigned int *  p_pgain,
unsigned int *  p_igain 
)

Reads the actual controller parameters of the voltage.

Parameters:
[out]p_pgainActual P-gain
[out]p_igainActual I-gain
Note:
This is only a PI-controller.
Returns:
DLL_SUCCESS for success or DLL_FAIL or other value if an error occurs
DLL_RESULT TC4GetSlaveCharacteristics ( int *  slavevolterr,
int *  slavecurrerr,
unsigned int *  turnoffslaves 
)

Reads actual settings for slave characteristics.

Parameters:
[in]slavevolterrActual allowed slave voltage error (-4000…+4000 = -100…+100% of nominal voltage)
[in]slavecurrerrActual allowed slave current error (-4000…+4000 = -100…+100% of maximum current)
[in]turnoffslavesActual setting whether slaves are automatically turned off on small or zero load current.
Note:
Slave characteristics are supported from firmware V4.11.30 or later.
Returns:
DLL_SUCCESS for success or DLL_FAIL or other value if an error occurs
DLL_RESULT TC4GetVoltageControlSettings ( unsigned int *  p_pgain,
unsigned int *  p_igain,
unsigned int *  p_dgain,
unsigned int *  p_feed,
unsigned int *  p_t1 
)

Reads the actual controller parameters of the voltage.

Parameters:
[out]p_pgainActual P-gain
[out]p_igainActual I-gain
[out]p_dgainActual D-gain
[out]p_feedActual feed-forward-gain
[out]p_t1Actual time delay for D-gain
Returns:
DLL_SUCCESS for success or DLL_FAIL or other value if an error occurs
DLL_RESULT TC4GetVoltageSlopeRamp ( unsigned int *  p_slope,
unsigned int *  p_ramp 
)

Reads the actual slopes and ramps for voltage.

Parameters:
[out]p_slopeActual startup ramp value (this ramp will be applied to set values when enabling output voltage)
[out]p_rampActual ramp value (this ramp will be applied to set values when they are changed)
Note:
slope and ramp:
1: slowest set value ramp: 0-100% (full scale) in 1.6 seconds
32000: fastest set value ramp: 0-100% (full scale) in 50us
Returns:
DLL_SUCCESS for success or DLL_FAIL or other value if an error occurs
DLL_RESULT TC4SetAdaptivControlSettings ( unsigned int  vpadaptiv,
unsigned int  viadaptiv,
unsigned int  cpadaptiv,
unsigned int  ciadaptiv 
)

Sets adaptive controller parameters. Adaptiv controller parameters can improve controller behaviour when load impedance changes.

Parameters:
[in]vpadaptivAdaptive gain for voltage controller P-gain
[in]viadaptivAdaptive gain for voltage controller I-gain
[in]cpadaptivAdaptive gain for current controller P-gain
[in]ciadaptivAdaptive gain for current controller I-gain
Note:
Setting adaptive controller parameters on a TopCon Master will automatically transfers them to all connected Slaves.
Setting adaptive controller parameters on a TopCon Slave will have no effect.
Adaptive controller parameters are supported from firmware V4.11.23 or later On firmware V4.11.16 this function is also implemented but in an experimental way and will not work the same as in V4.11.23 or later.
Returns:
DLL_SUCCESS for success or DLL_FAIL or other value if an error occurs
DLL_RESULT TC4SetAnalogBW ( unsigned int  analogin,
unsigned int  analogout 
)

Sets bandwidth limit for analog set values and analog actual values.

Parameters:
[in]analoginbandwidth limit for analog set values (0..15)
[in]analogoutbandwidth limit for analog actual values (0..15)
Precondition:
For firmware V4.11.28 or later remote control input must be set to analog or RS232
For firmware V4.11.27 and earlier remote control input must be set to RS232
Note:
filter frequency steps: 0 = filter is turned off 1 =1600Hz, 2 = 800Hz, 3=400Hz, …, 15 = 0.1Hz
Returns:
DLL_SUCCESS for success or DLL_FAIL or other value if an error occurs
DLL_RESULT TC4SetControlIn ( unsigned int  voltage_on)

Enables and disables output voltage.

Parameters:
[in]voltage_on0: power unit off
1: power unit on
Precondition:
RemoteControlInput must be set to RS232
Note:
calling this function on a TopCon Slave will have no effect
Returns:
DLL_SUCCESS for success or DLL_FAIL or other value if an error occurs
DLL_RESULT TC4SetCurrentControlSettings ( unsigned int  pgain,
unsigned int  igain,
unsigned int  dgain,
unsigned int  feed,
unsigned int  t1 
)

Sets controller parameters current.

Parameters:
[in]pgainP-gain (0..32767)
[in]igainI-gain (0..32767)
[in]dgainD-gain (0..32767)
[in]feedFeed-forward-gain (0..32767)
[in]t1Time delay for D.gain (0..16384)
Note:
Setting controller parameters on a TopCon Master will automatically transfers them to all connected Slaves.
Setting controller parameters on a TopCon Slave will have no effect.
Returns:
DLL_SUCCESS for success or DLL_FAIL or other value if an error occurs
DLL_RESULT TC4SetCurrentSlopeRamp ( unsigned int  slope,
unsigned int  ramp 
)

Set slope and ramp values for current set values.

Parameters:
[in]sloperamp value for ramp at voltage on (1..32000)
[in]rampramp value for ramp on changing set values (1..32000)
Note:
slope and ramp:
1: slowest set value ramp: 0-100% (full scale) in 1.6 seconds
32000: fastest set value ramp: 0-100% (full scale) in 50us
Setting slope and ramp parameters on a TopCon Master will automatically transfers them to all connected Slaves.
Setting slope and ramp parameters on a TopCon Slave will have no effect.
Returns:
DLL_SUCCESS for success or DLL_FAIL or other value if an error occurs
DLL_RESULT TC4SetLoadReject ( unsigned int  reduction,
unsigned int  cdifference 
)

Sets load reject parameters. These parameters can improve controller behaviour on load rejection.

Parameters:
[in]reductionReduces controller output to X% of actual value when detecting load rejection (0..4096), with 0=0%, 4096=100%.
[in]cdifferenceMinimal current difference between two cycles (50us) to detect load rejection. (0..4000)
Attention:
cdifference is not a physical value - so translate to correct physical value
Note:
Setting load reject parameters on a TopCon Master will automatically transfers them to all connected Slaves.
Setting load reject parameters on a TopCon Slave will have no effect.
Load reject detection is supported from firmware V4.11.20 or later and is only effective in Q1 operating mode.
See also:
chapter Translate between standardised values and physical values
Returns:
DLL_SUCCESS for success or DLL_FAIL or other value if an error occurs
DLL_RESULT TC4SetOperatingModeQ1Only ( unsigned short  Enable)

Set operating mode to Q1 only.
Be sure to not disable operating range to Q4 only at the same time.
Otherwise output is disabled (as nether Q1 nor Q4 operating mode is allowed)

Parameters:
[in]Enable0: false
1: true
Returns:
DLL_SUCCESS for success or DLL_FAIL or other value if an error occurs
DLL_RESULT TC4SetOperatingModeQ4Only ( unsigned short  Enable)

Set operating mode to Q4 only.
Be sure to not disable operating range to Q1 only at the same time.
Otherwise output is disabled (as nether Q1 nor Q4 operating mode is allowed)

Parameters:
[in]Enable0: false
1: true
Returns:
DLL_SUCCESS for success or DLL_FAIL or other value if an error occurs
DLL_RESULT TC4SetPowerControlSettings ( unsigned int  pgain,
unsigned int  igain 
)

Sets controller parameters power.

Parameters:
[in]pgainP-gain (0..32767)
[in]igainI-gain (0..32767)
Note:
Setting controller parameters on a TopCon Master will automatically transfers them to all connected Slaves.
Setting controller parameters on a TopCon Slave will have no effect.
Returns:
DLL_SUCCESS for success or DLL_FAIL or other value if an error occurs
DLL_RESULT TC4SetSlaveCharacteristics ( int  slavevolterr,
int  slavecurrerr,
unsigned int  turnoffslaves 
)

Set parameters for slave characteristics. These parameters determine whether TopCon Slaves try to reach set values fast or slow, depending on their actual control-error. Automatically turning off the slave controller when load current is very small or zero can improve output voltage stability.

Parameters:
[in]slavevolterrAllowed slave voltage error (-4000…+4000 = -100…+100% of nominal voltage) If the actual voltage error is smaller than this limit the slave reaches the set values slowly.
[in]slavecurrerrAllowed slave current error (-4000…+4000 = -100…+100% of maximum current) If the actual current error is smaller that this limit the slave reaches the set values slowly.
[in]turnoffslavesTurn off slaves on small or zero load current (0:no, 1:yes)
Note:
Setting slave characteristics on a TopCon Master will automatically transfers them to all connected Slaves.
Setting slave characteristics on a TopCon Slave will have no effect.
On a single-master-system slave characteristics will have no effect.
Slave characteristics are supported from firmware V4.11.30 or later.
Returns:
DLL_SUCCESS for success or DLL_FAIL or other value if an error occurs
DLL_RESULT TC4SetVoltageControlSettings ( unsigned int  pgain,
unsigned int  igain,
unsigned int  dgain,
unsigned int  feed,
unsigned int  t1 
)

Sets controller parameters voltage.

Parameters:
[in]pgainP-gain (0..32767)
[in]igainI-gain (0..32767)
[in]dgainD-gain (0..32767)
[in]feedFeed-forward-gain (0..32767)
[in]t1Time delay for D.gain (0..16384)
Note:
Setting controller parameters on a TopCon Master will automatically transfers them to all connected Slaves.
Setting controller parameters on a TopCon Slave will have no effect.
Returns:
DLL_SUCCESS for success or DLL_FAIL or other value if an error occurs
DLL_RESULT TC4SetVoltageSlopeRamp ( unsigned int  slope,
unsigned int  ramp 
)

Set slope and ramp values for voltage set values.

Parameters:
[in]sloperamp value for ramp at voltage on (1..32000)
[in]rampramp value for ramp on changing set values (1..32000)
Note:
slope and ramp:
1: slowest set value ramp: 0-100% (full scale) in 1.6 seconds
32000: fastest set value ramp: 0-100% (full scale) in 50us
Setting slope and ramp parameters on a TopCon Master will automatically transfers them to all connected Slaves.
Setting slope and ramp parameters on a TopCon Slave will have no effect.
Returns:
DLL_SUCCESS for success or DLL_FAIL or other value if an error occurs