tcio
 All Functions Groups Pages
Functions
Device Info

Functions

DLL_RESULT TC42GetFirmwareVersionIBC (unsigned short *pVersion)
 Get firmware version of IBC board (e.g. 123 means V1.23)
Reads zero if device is not a GSS device. More...
 
DLL_RESULT TC42GetFirmwareVersionPLD (unsigned short *pVersionPLD)
 Read out the PLD version. More...
 
DLL_RESULT TC42GetIsGSSDevice (unsigned short *pEnabled)
 Get info if device is a GSS device or not. More...
 
DLL_RESULT TC42GetIsGSSDeviceReady (unsigned short *pReady)
 Get info if device is a GSS device and internal communication to IBC board (needed for Q4 operation) is ok. More...
 
DLL_RESULT TC42GetOperatingHoursAtVoltageOn (float *pOperatingHoursAtVoltageOn)
 Get operating hours the device was voltage-on. More...
 
DLL_RESULT TC4GetAdditionalPhysicalValues (int *pDCLinkPhysNom, int *pPrimaryCurrentPhysNom, int *pTemperaturePhysNom)
 get the standardised physical values from the TopCon module. This is not the same as the physical limit max values from module. More...
 
DLL_RESULT TC4GetDevicePhysicalMinValues (int *vphysmin, int *iphysmin, int *pphysmin)
 Gets the physical min values from module. More...
 
DLL_RESULT TC4GetDeviceVersion (unsigned int *pMain, unsigned int *pSub, unsigned int *pRevision)
 This function returns the firmware version of the MainDSP. All API-functions beginning with "TC4..." require *pmain to be 4 or 11 A main Version of 11 indicates a client specific software based upon V4.x. More...
 
DLL_RESULT TC4GetIsSupportedQ1Q4LimitMode (unsigned short *pIsSupported)
 Query if limiting operating mode to Q1only and Q4only is supported. More...
 
DLL_RESULT TC4GetIsSupportedQ4CurrentSinkActiveQuery (unsigned short *pIsSupported)
 Query if Q4 current sink is supported. More...
 
DLL_RESULT TC4GetIsSupportedQ4UserLimits (unsigned short *pIsSupported)
 Query if Q4 user limits are supported. More...
 
DLL_RESULT TC4GetIsSupportedVoltageOnHoursCounter (unsigned short *pIsSupported)
 Query if voltage on hours counter is supported. More...
 
DLL_RESULT TC4GetModuleID (unsigned int *pModuleId)
 Reads the ModuleID which is set by the ID-selector (AH and AL) on the front panel of each module.
The ModuleID is calculated as follows: ModuleID = (16*AH) + AL. More...
 
DLL_RESULT TC4GetModulePhysicalLimitMax (double *pVoltagePhysMax, double *pCurrentPhysMax, double *pPowerPhysMax, double *pResistancePhysMax)
 Gets the physical max values from module. More...
 
DLL_RESULT TC4GetModulePhysicalLimitMin (double *pVoltagePhysMin, double *pCurrentPhysMin, double *pPowerPhysMin, double *pResistancePhysMin)
 Gets the physical min values from module. More...
 
DLL_RESULT TC4GetModulePhysicalLimitNom (double *pVoltagePhysNom, double *pCurrentPhysNom, double *pPowerPhysNom, double *pResistancePhysNom)
 Gets the physical nominal values from module. These are the same values as from TC4GetModulePhysicalValues but from cache More...
 
DLL_RESULT TC4GetModulePhysicalValues (int *pVoltagePhysNom, int *pCurrentPhysNom, int *pPowerPhysNom, int *pResistancePhysNom)
 get the standardised physical values from the TopCon module. This is not the same as the physical limit max values from module. More...
 
DLL_RESULT TC4GetPeripherieVersion (unsigned int *pVersionPeripherieDSP, unsigned int *pVersionModulatorDSP, unsigned int *pVersionBootloader)
 This function returns software versions of two auxiliary DSP's and the bootloader version for the MainDSP. More...
 
DLL_RESULT TC4GetPhysicalValues (int *pVoltagePhysNom, int *pCurrentPhysNom, int *pPowerPhysNom, int *pResistancePhysNom, int *pDCLinkPhysNom, int *pPrimaryCurrentPhysNom, int *pTemperaturePhysNom)
 get the standardised physical values from the TopCon module. This is not the same as the physical limit max values from module. More...
 
DLL_RESULT TC4GetPhysicalValuesLimits (double *vlimit, double *ilimit, double *plimit, double *rlimit, double *vslimit, double *islimit, double *pslimit, double *rslimit)
 This function is used in multi-unit operation to translate between standardised system-values and physical system-values. Only use this function on a TopCon Master (a TopCon Slave will return false results) More...
 
DLL_RESULT TC4GetSystemPhysicalLimitMax (double *pVoltagePhysMax, double *pCurrentPhysMax, double *pPowerPhysMax, double *pResistancePhysMax)
 Gets the physical maximal values from system. More...
 
DLL_RESULT TC4GetSystemPhysicalLimitMin (double *pVoltagePhysMin, double *pCurrentPhysMin, double *pPowerPhysMin, double *pResistancePhysMin)
 Gets the physical minimal values from system. More...
 
DLL_RESULT TC4GetSystemPhysicalLimitNom (double *pVoltagePhysNom, double *pCurrentPhysNom, double *pPowerPhysNom, double *pResistancePhysNom)
 Gets the physical nominal values from system. These are the same values as from TC4GetSystemPhysicalValues but from cache More...
 
DLL_RESULT TC4GetSystemPhysicalMinValues (int *vphysmin, int *iphysmin, int *pphysmin)
 Gets the physical min values from system. More...
 
DLL_RESULT TC4GetSystemPhysicalValues (int *pVoltagePhysNom, int *pCurrentPhysNom, int *pPowerPhysNom, int *pResistancePhysNom)
 This function is used in multi-unit operation to translate between standardised system-values and physical system-values. Only use this function on a TopCon Master (a TopCon Slave will return false results) This is not the same as the physical limit max values from system. More...
 

Detailed Description

This group contains e.g. physical device limits, firmware versions, installed options and so on.

Function Documentation

DLL_RESULT TC42GetFirmwareVersionIBC ( unsigned short *  pVersion)

Get firmware version of IBC board (e.g. 123 means V1.23)
Reads zero if device is not a GSS device.

Parameters
[out]pVersionVersion of IBC
Returns
DLL_SUCCESS for success or DLL_FAIL or other value if an error occurs
DLL_RESULT TC42GetFirmwareVersionPLD ( unsigned short *  pVersionPLD)

Read out the PLD version.

Parameters
[out]pVersionPLDPLD version (e.g. 123 means V1.23)
Returns
DLL_SUCCESS for success or DLL_FAIL or other value if an error occurs
DLL_RESULT TC42GetIsGSSDevice ( unsigned short *  pEnabled)

Get info if device is a GSS device or not.

Parameters
[out]pEnabled1: Enabled
0: Disabled
Returns
DLL_SUCCESS for success or DLL_FAIL or other value if an error occurs
DLL_RESULT TC42GetIsGSSDeviceReady ( unsigned short *  pReady)

Get info if device is a GSS device and internal communication to IBC board (needed for Q4 operation) is ok.

Parameters
[out]pReady1: Enabled
0: Disabled
Returns
DLL_SUCCESS for success or DLL_FAIL or other value if an error occurs
DLL_RESULT TC42GetOperatingHoursAtVoltageOn ( float *  pOperatingHoursAtVoltageOn)

Get operating hours the device was voltage-on.

TC42__ GSS extension

Parameters
[out]pOperatingHoursAtVoltageOnvoltage-on operating hours [0...596523h]
Returns
DLL_SUCCESS for success or DLL_FAIL or other value if an error occurs
DLL_RESULT TC4GetAdditionalPhysicalValues ( int *  pDCLinkPhysNom,
int *  pPrimaryCurrentPhysNom,
int *  pTemperaturePhysNom 
)

get the standardised physical values from the TopCon module. This is not the same as the physical limit max values from module.

Parameters
[out]pDCLinkPhysNomstandardised voltageDCLink [V]
[out]pPrimaryCurrentPhysNomstandardised primaryCurrent [A]
[out]pTemperaturePhysNomstandardised temperature [°C]
Note
see also TC4GetPhysicalValues
Returns
DLL_SUCCESS for success or DLL_FAIL or other value if an error occurs
DLL_RESULT TC4GetDevicePhysicalMinValues ( int *  vphysmin,
int *  iphysmin,
int *  pphysmin 
)

Gets the physical min values from module.

Parameters
[out]vphysminPhysicalMinVoltage [V]
[out]iphysminPhysicalMinCurrent [A]
[out]pphysminPhysicalMinPower [kW]
Returns
DLL_SUCCESS for success or DLL_FAIL or other value if an error occurs
Deprecated:
use TC4GetModulePhysicalLimitMin instead
DLL_RESULT TC4GetDeviceVersion ( unsigned int *  pMain,
unsigned int *  pSub,
unsigned int *  pRevision 
)

This function returns the firmware version of the MainDSP. All API-functions beginning with "TC4..." require *pmain to be 4 or 11 A main Version of 11 indicates a client specific software based upon V4.x.

Parameters
[out]pMainFirmware main version
[out]pSubFirmware sub version
[out]pRevisionFirmware revision
Note
This function is not appropiate to determine whether firmware V4.x or V2.x is installed as this function is only available on firmware V4.x (and V11.x).To find out what type of firmware (V4.x or V2.x) is installed please see chapter 5.
Returns
DLL_SUCCESS for success or DLL_FAIL or other value if an error occurs
DLL_RESULT TC4GetIsSupportedQ1Q4LimitMode ( unsigned short *  pIsSupported)

Query if limiting operating mode to Q1only and Q4only is supported.

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

Query if Q4 current sink is supported.

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

Query if Q4 user limits are supported.

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

Query if voltage on hours counter is supported.

Parameters
[out]pIsSupported0: false
1: true
Returns
DLL_SUCCESS for success or DLL_FAIL or other value if an error occurs
DLL_RESULT TC4GetModuleID ( unsigned int *  pModuleId)

Reads the ModuleID which is set by the ID-selector (AH and AL) on the front panel of each module.
The ModuleID is calculated as follows: ModuleID = (16*AH) + AL.

Parameters
*pModuleIdModule ID
Note
By definition a TopCon Master always has ModuleID 0 (zero). Don't confuse it with the ModuleSelector.
Returns
DLL_SUCCESS for success or DLL_FAIL or other value if an error occurs
DLL_RESULT TC4GetModulePhysicalLimitMax ( double *  pVoltagePhysMax,
double *  pCurrentPhysMax,
double *  pPowerPhysMax,
double *  pResistancePhysMax 
)

Gets the physical max values from module.

Parameters
[out]pVoltagePhysMax[V]
[out]pCurrentPhysMax[A]
[out]pPowerPhysMax[kW]
[out]pResistancePhysMax[mOhm]
Returns
DLL_SUCCESS for success or DLL_FAIL or other value if an error occurs
DLL_RESULT TC4GetModulePhysicalLimitMin ( double *  pVoltagePhysMin,
double *  pCurrentPhysMin,
double *  pPowerPhysMin,
double *  pResistancePhysMin 
)

Gets the physical min values from module.

Parameters
[out]pVoltagePhysMin[V]
[out]pCurrentPhysMin[A]
[out]pPowerPhysMin[kW]
[out]pResistancePhysMin[mOhm]
Returns
DLL_SUCCESS for success or DLL_FAIL or other value if an error occurs
DLL_RESULT TC4GetModulePhysicalLimitNom ( double *  pVoltagePhysNom,
double *  pCurrentPhysNom,
double *  pPowerPhysNom,
double *  pResistancePhysNom 
)

Gets the physical nominal values from module. These are the same values as from TC4GetModulePhysicalValues but from cache

Parameters
[out]pVoltagePhysNom[V]
[out]pCurrentPhysNom[A]
[out]pPowerPhysNom[kW]
[out]pResistancePhysNom[mOhm]
Returns
DLL_SUCCESS for success or DLL_FAIL or other value if an error occurs
DLL_RESULT TC4GetModulePhysicalValues ( int *  pVoltagePhysNom,
int *  pCurrentPhysNom,
int *  pPowerPhysNom,
int *  pResistancePhysNom 
)

get the standardised physical values from the TopCon module. This is not the same as the physical limit max values from module.

Parameters
[out]pVoltagePhysNomstandardised module voltage [V]
[out]pCurrentPhysNomstandardised module current [A]
[out]pPowerPhysNomstandardised module power [kW]
[out]pResistancePhysNomstandardised simulated module resistance [mOhm]
Note
see also TC4GetPhysicalValues
Returns
DLL_SUCCESS for success or DLL_FAIL or other value if an error occurs
Deprecated:
use function TC4GetModulePhysicalLimitNom
DLL_RESULT TC4GetPeripherieVersion ( unsigned int *  pVersionPeripherieDSP,
unsigned int *  pVersionModulatorDSP,
unsigned int *  pVersionBootloader 
)

This function returns software versions of two auxiliary DSP's and the bootloader version for the MainDSP.

High level commands up to CTR V4.00

Parameters
[out]pVersionPeripherieDSPSoftware version of peripherie-DSP (e.g. 10, read as 0.10)
[out]pVersionModulatorDSPSoftware version of modulator-DSP (e.g. 23, read as 0.23)
[out]pVersionBootloaderBootloader version for theMainDSP (e.g. 4, read as 0.04)
Returns
DLL_SUCCESS for success or DLL_FAIL or other value if an error occurs

High level commands up to CTR V4.00

DLL_RESULT TC4GetPhysicalValues ( int *  pVoltagePhysNom,
int *  pCurrentPhysNom,
int *  pPowerPhysNom,
int *  pResistancePhysNom,
int *  pDCLinkPhysNom,
int *  pPrimaryCurrentPhysNom,
int *  pTemperaturePhysNom 
)

get the standardised physical values from the TopCon module. This is not the same as the physical limit max values from module.

Parameters
[out]pVoltagePhysNomstandardised module voltage [V]
[out]pCurrentPhysNomstandardised module current [A]
[out]pPowerPhysNomstandardised module power [kW]
[out]pResistancePhysNomstandardised simulated module resistance [mOhm]
[out]pDCLinkPhysNomstandardised voltageDCLink [V]
[out]pPrimaryCurrentPhysNomstandardised primaryCurrent [A]
[out]pTemperaturePhysNomstandardised temperature [°C]
Note
The PhysicalSystemResistance is calculated and not messured.
If you change the configuration, also restart this function to get the correct values.
E.g.:
Suppose we have three TopCon modules, each with the following nominal data:
Unom = 60V, Inom = 333A, Pnom = 16kW

when connecting them in series we get a system with the following nominal data:
Unom = 3x60V=180V, Inom = 333A, Pnom = 3x16kW = 48kW

When we use the API-function TC4SetVoltageRef to set a desired voltage set value of, lets say 90V, we set the system-value. Each module will deliver its module-value of 30V.
Returns
DLL_SUCCESS for success or DLL_FAIL or other value if an error occurs
Deprecated:
use splited functions TC4GetModulePhysicalLimitNom and TC4GetAdditionalPhysicalValues instead
DLL_RESULT TC4GetPhysicalValuesLimits ( double *  vlimit,
double *  ilimit,
double *  plimit,
double *  rlimit,
double *  vslimit,
double *  islimit,
double *  pslimit,
double *  rslimit 
)

This function is used in multi-unit operation to translate between standardised system-values and physical system-values. Only use this function on a TopCon Master (a TopCon Slave will return false results)

Parameters
[out]vlimitNominal output voltage [V] of that module
[out]ilimitMaximum output current [A] of that module
[out]plimitNominal output power [kW] of that module
[out]rlimitNominal simulated resistance [mOhm] of that module
[out]vslimitNominal output voltage [V] of the whole system
[out]islimitMaximum output current [A]of the whole system
[out]pslimitNominal output power [kW] of the whole system
[out]rslimitNominal simulated resistance [mOhm] of the whole system.
Note
Calling this function on a TopCon Slave will return 0 in system-limit values (parameters [5...8]) calling this function on a single TopCon Master returns equal values for module- and system-values (the master represents the system)
Returns
DLL_SUCCESS for success or DLL_FAIL or other value if an error occurs
Deprecated:
use
TC4GetModulePhysicalLimitMax
or
TC4GetSystemPhysicalLimitMax
instead
DLL_RESULT TC4GetSystemPhysicalLimitMax ( double *  pVoltagePhysMax,
double *  pCurrentPhysMax,
double *  pPowerPhysMax,
double *  pResistancePhysMax 
)

Gets the physical maximal values from system.

Parameters
[out]pVoltagePhysMax[V]
[out]pCurrentPhysMax[A]
[out]pPowerPhysMax[kW]
[out]pResistancePhysMax[mOhm]
Returns
DLL_SUCCESS for success or DLL_FAIL or other value if an error occurs
DLL_RESULT TC4GetSystemPhysicalLimitMin ( double *  pVoltagePhysMin,
double *  pCurrentPhysMin,
double *  pPowerPhysMin,
double *  pResistancePhysMin 
)

Gets the physical minimal values from system.

Parameters
[out]pVoltagePhysMin[V]
[out]pCurrentPhysMin[A]
[out]pPowerPhysMin[kW]
[out]pResistancePhysMin[mOhm]
Returns
DLL_SUCCESS for success or DLL_FAIL or other value if an error occurs
DLL_RESULT TC4GetSystemPhysicalLimitNom ( double *  pVoltagePhysNom,
double *  pCurrentPhysNom,
double *  pPowerPhysNom,
double *  pResistancePhysNom 
)

Gets the physical nominal values from system. These are the same values as from TC4GetSystemPhysicalValues but from cache

Parameters
[out]pVoltagePhysNomstandardised module voltage [V]
[out]pCurrentPhysNomstandardised module current [A]
[out]pPowerPhysNomstandardised module power [kW]
[out]pResistancePhysNomstandardised simulated module resistance [mOhm]
Returns
DLL_SUCCESS for success or DLL_FAIL or other value if an error occurs
DLL_RESULT TC4GetSystemPhysicalMinValues ( int *  vphysmin,
int *  iphysmin,
int *  pphysmin 
)

Gets the physical min values from system.

Parameters
[out]vphysminPhysicalMinVoltage [V]
[out]iphysminPhysicalMinCurrent [A]
[out]pphysminPhysicalMinPower [kW]
Returns
DLL_SUCCESS for success or DLL_FAIL or other value if an error occurs
Deprecated:
use TC4GetSystemPhysicalLimitMin instead
DLL_RESULT TC4GetSystemPhysicalValues ( int *  pVoltagePhysNom,
int *  pCurrentPhysNom,
int *  pPowerPhysNom,
int *  pResistancePhysNom 
)

This function is used in multi-unit operation to translate between standardised system-values and physical system-values. Only use this function on a TopCon Master (a TopCon Slave will return false results) This is not the same as the physical limit max values from system.

Parameters
[out]pVoltagePhysNomstandardised system voltage [V]
[out]pCurrentPhysNomstandardised system current[A]
[out]pPowerPhysNomstandardised system power [kW]
[out]pResistancePhysNomstandardised simulated system resistance [mOhm]
Note
Calling this function on a TopCon Master without any Slaves connected will return the same physical values as when calling TC4GetPhysicalValues (the master represents the whole system).
Returns
DLL_SUCCESS for success or DLL_FAIL or other value if an error occurs
Deprecated:
use function TC4GetSystemPhysicalLimitNom