tcio
Functions
Protection

Functions

DLL_RESULT TC42GetExtenedProtectSupported (unsigned short *pSupport)
 This function is used to check if the extended protect is supported. (output-undervoltage, output-power overload in Q1 and output-power overload in Q4)
DLL_RESULT TC42GetMaximasPower (short *pPabsQ1, short *pPabsQ4)
 This function is used to get the maximum allowed power of Q1 and Q4.
DLL_RESULT TC42GetOverLoadPowerQ1Param (double *pLimit, unsigned short *pDelay, double *pWarn, unsigned short *pWarnDelay)
 This function gets the actual protection limits for output-power overload in Q1.
DLL_RESULT TC42GetOverLoadPowerQ4Param (double *pLimit, unsigned short *pDelay, double *pWarn, unsigned short *pWarnDelay)
 This function gets the actual protection limits for output-power overload in Q4.
DLL_RESULT TC42GetQ4LimitOverCurrentAbs (double *pCurrent)
 Get Q4 over current absolute error limit for Q4 operating mode (Q4 over current limit settings are limited to this value)
DLL_RESULT TC42GetQ4LimitOverCurrentError (double *pCurrent)
 Get Q4 over current error limit for Q4 operating mode (will be negative)
DLL_RESULT TC42GetQ4LimitOverCurrentErrorDelay (double *pTime)
 Get Q4 over current error delay for Q4 operating mode.
DLL_RESULT TC42GetQ4LimitOverCurrentWarn (double *pCurrent)
 Get Q4 over current warning limit for Q4 operating mode (negative!)
DLL_RESULT TC42GetQ4LimitOverCurrentWarnDelay (double *pTime)
 Get Q4 over current warning delay for Q4 operating mode.
DLL_RESULT TC42GetUnderVoltageParam (double *pLimit, unsigned short *pDelay, double *pWarn, unsigned short *pWarnDelay, unsigned short *pEnableDelay)
 This function reads the actual protection limits for output-undervoltage.
DLL_RESULT TC42SetOverLoadPowerQ1Param (double limit, unsigned short delay, double warn, unsigned short warnDelay)
 This function sets the actual protection limits for output-power overload in Q1.
DLL_RESULT TC42SetOverLoadPowerQ4Param (double limit, unsigned short delay, double warn, unsigned short warnDelay)
 This function sets the actual protection limits for output-power overload in Q4.
DLL_RESULT TC42SetQ4LimitOverCurrentError (double Current)
 Set Q4 over current error limit for Q4 operating mode (negative!)
DLL_RESULT TC42SetQ4LimitOverCurrentErrorDelay (double Time)
 Set Q4 over current error delay for Q4 operating mode.
DLL_RESULT TC42SetQ4LimitOverCurrentWarn (double Current)
 Set Q4 over current warning limit for Q4 operating mode (negative!)
DLL_RESULT TC42SetQ4LimitOverCurrentWarnDelay (double Time)
 Set Q4 over current warning delay for Q4 operating mode.
DLL_RESULT TC42SetUnderVoltageParam (double limit, unsigned short delay, double warn, unsigned short warnDelay, unsigned short enableDelay)
 This function sets the actual protection limits for output-undervoltage.
DLL_RESULT TC4GetI2tAbsLimits (unsigned short *pI2tMaxInom, unsigned short *pI2tMaxLimit)
 This function is used to get the maximum allowed nominal current, error and warn limits of the i2t monitoring.
DLL_RESULT TC4GetI2tCurrentParam (double *pI2tCurrent, unsigned int *pLimit, unsigned int *pWarn)
 This function reads the actual settings for I^2t-monitoring on output current.
DLL_RESULT TC4GetMaximas (unsigned int *pVMax, unsigned int *pIMax)
 This function is used to get the maximum allowed voltage- and current-limits.
DLL_RESULT TC4GetOvercurrentParam (double *pLimit, unsigned int *pLimitDelay, double *pWarn, unsigned int *pWarnDelay)
 These function read the actual protection limits for output-overcurrent.
DLL_RESULT TC4GetOvervoltageParam (double *pLimit, unsigned int *pLimitDelay, double *pWarn, unsigned int *pWarnDelay)
 These function read the actual protection limits for output-overvoltage.
DLL_RESULT TC4SetI2tCurrentParam (double i2tCurrent, unsigned int limit, unsigned int warn)
 This function sets parameters for I^2t-monitoring on output-current. Maximum allowed physical value for i2tcurrent see API-function TC4GetI2tAbsLimits.
DLL_RESULT TC4SetOvercurrentParam (double limit, unsigned int limitDelay, double warn, unsigned int warnDelay)
 These functions set the protection limits for overcurrent on the output stage. Maximum allowed physical value for overcurrent-limit see API-function TC4GetMaximas.
DLL_RESULT TC4SetOvervoltageParam (double limit, unsigned int limitDelay, double warn, unsigned int warnDelay)
 These functions set the protection limits for overvoltage on the output stage. Maximum allowed physical value for overvoltage-limit see API-function TC4GetMaximas.

Detailed Description

To protect each TopCon module from overvoltage and overcurrent has limits setted for error and warning.

Attention:
Changing protection limits can cause serious damage to the modules.
Do not change protection limits without contacting Regatron before!

Function Documentation

DLL_RESULT TC42GetExtenedProtectSupported ( unsigned short *  pSupport)

This function is used to check if the extended protect is supported. (output-undervoltage, output-power overload in Q1 and output-power overload in Q4)

Parameters:
[out]pSupport0: false
1: true
Returns:
DLL_SUCCESS for success or DLL_FAIL or other value if an error occurs
DLL_RESULT TC42GetMaximasPower ( short *  pPabsQ1,
short *  pPabsQ4 
)

This function is used to get the maximum allowed power of Q1 and Q4.

Parameters:
[out]pPabsQ1Maximum allowed power of Q1
[out]pPabsQ4Maximum allowed power of Q4
Attention:
These values are not physical values - so translate to correct physical values
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 TC42GetOverLoadPowerQ1Param ( double *  pLimit,
unsigned short *  pDelay,
double *  pWarn,
unsigned short *  pWarnDelay 
)

This function gets the actual protection limits for output-power overload in Q1.

Parameters:
[out]pLimitActual power overload error level [kW]
[out]pDelayActual delay for the error level in [50us]
[out]pWarnActual power overload warning level [kW]
[out]pWarnDelayActual delay for the warning level in [50us]
Returns:
DLL_SUCCESS for success or DLL_FAIL or other value if an error occurs
DLL_RESULT TC42GetOverLoadPowerQ4Param ( double *  pLimit,
unsigned short *  pDelay,
double *  pWarn,
unsigned short *  pWarnDelay 
)

This function gets the actual protection limits for output-power overload in Q4.

Parameters:
[out]pLimitActual power overload error level [kW]
[out]pDelayActual delay for the error level in [50us]
[out]pWarnActual power overload warning level [kW]
[out]pWarnDelayActual delay for the warning level in [50us]
Returns:
DLL_SUCCESS for success or DLL_FAIL or other value if an error occurs
DLL_RESULT TC42GetQ4LimitOverCurrentAbs ( double *  pCurrent)

Get Q4 over current absolute error limit for Q4 operating mode (Q4 over current limit settings are limited to this value)

Parameters:
[out]pCurrent[A]
Returns:
DLL_SUCCESS for success or DLL_FAIL or other value if an error occurs
DLL_RESULT TC42GetQ4LimitOverCurrentError ( double *  pCurrent)

Get Q4 over current error limit for Q4 operating mode (will be negative)

Parameters:
[out]pCurrent[A]
Returns:
DLL_SUCCESS for success or DLL_FAIL or other value if an error occurs
DLL_RESULT TC42GetQ4LimitOverCurrentErrorDelay ( double *  pTime)

Get Q4 over current error delay for Q4 operating mode.

Parameters:
[out]pTime[ms]
Returns:
DLL_SUCCESS for success or DLL_FAIL or other value if an error occurs
DLL_RESULT TC42GetQ4LimitOverCurrentWarn ( double *  pCurrent)

Get Q4 over current warning limit for Q4 operating mode (negative!)

Parameters:
[out]pCurrent[A]
Returns:
DLL_SUCCESS for success or DLL_FAIL or other value if an error occurs
DLL_RESULT TC42GetQ4LimitOverCurrentWarnDelay ( double *  pTime)

Get Q4 over current warning delay for Q4 operating mode.

Parameters:
[out]pTime[ms]
Returns:
DLL_SUCCESS for success or DLL_FAIL or other value if an error occurs
DLL_RESULT TC42GetUnderVoltageParam ( double *  pLimit,
unsigned short *  pDelay,
double *  pWarn,
unsigned short *  pWarnDelay,
unsigned short *  pEnableDelay 
)

This function reads the actual protection limits for output-undervoltage.

Parameters:
[out]pLimitActual undervoltage error level [V]
[out]pDelayActual delay for the error level in [50us]
[out]pWarnActual undervoltage warning level [V]
[out]pWarnDelayActual delay for the warning level in [50us]
[out]pEnableDelayTime for activation of undervoltage monitoring, after voltage on [ms]
Returns:
DLL_SUCCESS for success or DLL_FAIL or other value if an error occurs
DLL_RESULT TC42SetOverLoadPowerQ1Param ( double  limit,
unsigned short  delay,
double  warn,
unsigned short  warnDelay 
)

This function sets the actual protection limits for output-power overload in Q1.

Parameters:
[in]limitActual power overload error level [kW]
[in]delayActual delay for the error level in [50us]
[in]warnActual power overload warning level [kW]
[in]warnDelayActual delay for the warning level in [50us]
Returns:
DLL_SUCCESS for success or DLL_FAIL or other value if an error occurs
DLL_RESULT TC42SetOverLoadPowerQ4Param ( double  limit,
unsigned short  delay,
double  warn,
unsigned short  warnDelay 
)

This function sets the actual protection limits for output-power overload in Q4.

Parameters:
[in]limitActual power overload error level [kW]
[in]delayActual delay for the error level in [50us]
[in]warnActual power overload warning level [kW]
[in]warnDelayActual delay for the warning level in [50us]
Returns:
DLL_SUCCESS for success or DLL_FAIL or other value if an error occurs
DLL_RESULT TC42SetQ4LimitOverCurrentError ( double  Current)

Set Q4 over current error limit for Q4 operating mode (negative!)

Parameters:
[in]Current[A]
Returns:
DLL_SUCCESS for success or DLL_FAIL or other value if an error occurs
DLL_RESULT TC42SetQ4LimitOverCurrentErrorDelay ( double  Time)

Set Q4 over current error delay for Q4 operating mode.

Parameters:
[in]Time[ms]
Returns:
DLL_SUCCESS for success or DLL_FAIL or other value if an error occurs
DLL_RESULT TC42SetQ4LimitOverCurrentWarn ( double  Current)

Set Q4 over current warning limit for Q4 operating mode (negative!)

Parameters:
[in]Current[A]
Returns:
DLL_SUCCESS for success or DLL_FAIL or other value if an error occurs
DLL_RESULT TC42SetQ4LimitOverCurrentWarnDelay ( double  Time)

Set Q4 over current warning delay for Q4 operating mode.

Parameters:
[in]Time[ms]
Returns:
DLL_SUCCESS for success or DLL_FAIL or other value if an error occurs
DLL_RESULT TC42SetUnderVoltageParam ( double  limit,
unsigned short  delay,
double  warn,
unsigned short  warnDelay,
unsigned short  enableDelay 
)

This function sets the actual protection limits for output-undervoltage.

Parameters:
[in]limitActual undervoltage error level [V]
[in]delayActual delay for the error level in [50us]
[in]warnActual undervoltage warning level [V]
[in]warnDelayActual delay for the warning level in [50us]
[in]enableDelayTime for activation of undervoltage monitoring, after voltage on [ms]
Returns:
DLL_SUCCESS for success or DLL_FAIL or other value if an error occurs
DLL_RESULT TC4GetI2tAbsLimits ( unsigned short *  pI2tMaxInom,
unsigned short *  pI2tMaxLimit 
)

This function is used to get the maximum allowed nominal current, error and warn limits of the i2t monitoring.

Parameters:
[out]pI2tMaxInomMaximum allowed nominal current
[out]pI2tMaxLimitMaximum allowed error and warn limit
Attention:
These values are not physical values - so translate to correct physical values
Note:
Setting protection limits on a single master unit: treat pI2tMaxInom and pI2tMaxLimit as module-values.
Setting protection limits in multi-unit operation treat pI2tMaxInom and pI2tMaxLimit as system-values.
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 TC4GetI2tCurrentParam ( double *  pI2tCurrent,
unsigned int *  pLimit,
unsigned int *  pWarn 
)

This function reads the actual settings for I^2t-monitoring on output current.

Parameters:
[out]pI2tCurrentActual nominal current [A]
[out]pLimitActual I^2t error-limit
[out]pWarnActual I^2t warning-limit
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 TC4GetMaximas ( unsigned int *  pVMax,
unsigned int *  pIMax 
)

This function is used to get the maximum allowed voltage- and current-limits.

Parameters:
[out]pVMaxMaximum allowed voltage limit
[out]pIMaxMaximum allowed current limit
Attention:
These values are not physical values - so translate to correct physical values
Note:
Setting protection limits on a single master unit: treat pVMax and pIMax as module-values.
Setting protection limits in multi-unit operation treat pVMax and pIMax as system-values
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 TC4GetOvercurrentParam ( double *  pLimit,
unsigned int *  pLimitDelay,
double *  pWarn,
unsigned int *  pWarnDelay 
)

These function read the actual protection limits for output-overcurrent.

Parameters:
[out]pLimitActual overcurrent error level
[out]pLimitDelayActual delay for the error level in [50us]
[out]pWarnActual overcurrent warning level
[out]pWarnDelayActual delay for the warning level in [50us]
Returns:
DLL_SUCCESS for success or DLL_FAIL or other value if an error occurs
DLL_RESULT TC4GetOvervoltageParam ( double *  pLimit,
unsigned int *  pLimitDelay,
double *  pWarn,
unsigned int *  pWarnDelay 
)

These function read the actual protection limits for output-overvoltage.

Parameters:
[out]pLimitActual overvoltage error level
[out]pLimitDelayActual delay for the error level in [50us]
[out]pWarnActual overvoltage warning level
[out]pWarnDelayActual delay for the warning level in [50us]
Returns:
DLL_SUCCESS for success or DLL_FAIL or other value if an error occurs
DLL_RESULT TC4SetI2tCurrentParam ( double  i2tCurrent,
unsigned int  limit,
unsigned int  warn 
)

This function sets parameters for I^2t-monitoring on output-current. Maximum allowed physical value for i2tcurrent see API-function TC4GetI2tAbsLimits.

Parameters:
[in]i2tCurrentNominal current [A]
[in]limitError-limit for I^2t
[in]warnWarning limit for I^2t
Precondition:
Remote control input must be set to RS232 (this API)
Note:
Setting I2t-parameters on a TopCon Master will automatically transfers them to all connected Slaves.
Setting I2t-parameters on a TopCon Slave will have no effect.
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 TC4SetOvercurrentParam ( double  limit,
unsigned int  limitDelay,
double  warn,
unsigned int  warnDelay 
)

These functions set the protection limits for overcurrent on the output stage. Maximum allowed physical value for overcurrent-limit see API-function TC4GetMaximas.

Parameters:
[in]limitovercurrent error level
[in]limitDelaydelay for error level in [50us]
[in]warnovercurrent warning level
[in]warnDelaydelay for warning level in [50us]
Precondition:
Remote control input must be set to RS232 (this API) Setting overcurrent 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 TC4SetOvervoltageParam ( double  limit,
unsigned int  limitDelay,
double  warn,
unsigned int  warnDelay 
)

These functions set the protection limits for overvoltage on the output stage. Maximum allowed physical value for overvoltage-limit see API-function TC4GetMaximas.

Parameters:
[in]limitovervoltage error level
[in]limitDelaydelay for error level in [50us]
[in]warnovervoltage warning level
[in]warnDelaydelay for warning level in [50us]
Precondition:
Remote control input must be set to RS232 (this API)
Note:
Setting overvoltage parameters on a TopCon Master will automatically transfers them to all connected Slaves.
Setting overvoltage parameters on a TopCon Slave will have no effect.
Returns:
DLL_SUCCESS for success or DLL_FAIL or other value if an error occurs