![]() |
tcio
V3.74.00
Function description
|
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. | |
DLL_RESULT | TC42GetFirmwareVersionPLD (unsigned short *pVersionPLD) |
Read out the PLD version. | |
DLL_RESULT | TC42GetIsGSSDevice (unsigned short *pEnabled) |
Get info if device is a GSS device or not. | |
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. | |
DLL_RESULT | TC42GetOperatingHoursAtVoltageOn (float *pOperatingHoursAtVoltageOn) |
Get operating hours the device was voltage-on. | |
DLL_RESULT | TC4GetAdditionalPhysicalValues (int *vzphys, int *ipphys, int *tphys) |
get the standardised physical values from the TopCon module. This is not the same as the physical limit max values from module. | |
DLL_RESULT | TC4GetDevicePhysicalMinValues (int *vphysmin, int *iphysmin, int *pphysmin) |
Gets the physical min values from module. | |
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. | |
DLL_RESULT | TC4GetIsSupportedQ1Q4LimitMode (unsigned short *pIsSupported) |
Query if limiting operating mode to Q1only and Q4only is supported. | |
DLL_RESULT | TC4GetIsSupportedQ4CurrentSinkActiveQuery (unsigned short *pIsSupported) |
Query if Q4 current sink is supported. | |
DLL_RESULT | TC4GetIsSupportedQ4UserLimits (unsigned short *pIsSupported) |
Query if Q4 user limits are supported. | |
DLL_RESULT | TC4GetIsSupportedVoltageOnHoursCounter (unsigned short *pIsSupported) |
Query if voltage on hours counter is supported. | |
DLL_RESULT | TC4GetModuleID (unsigned int *p_moduleid) |
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. | |
DLL_RESULT | TC4GetModulePhysicalLimitMax (double *voltagePhysMax, double *currentPhysMax, double *powerPhysMax, double *resistancePhysMax) |
Gets the physical max values from module. | |
DLL_RESULT | TC4GetModulePhysicalLimitMin (double *voltagePhysMin, double *currentPhysMin, double *powerPhysMin, double *resistancePhysMin) |
Gets the physical min values from module. | |
DLL_RESULT | TC4GetModulePhysicalLimitNom (double *voltagePhysNom, double *currentPhysNom, double *powerPhysNom, double *resistancePhysNom) |
Gets the physical nominal values from module. These are the same values as from TC4GetModulePhysicalValues but from cache. | |
DLL_RESULT | TC4GetModulePhysicalValues (int *vphys, int *iphys, int *pphys, int *rphys) |
get the standardised physical values from the TopCon module. This is not the same as the physical limit max values from module. | |
DLL_RESULT | TC4GetPeripherieVersion (unsigned int *versionPDSP, unsigned int *versionMDSP, unsigned int *versionBootloader) |
This function returns software versions of two auxiliary DSP's and the bootloader version for the MainDSP. | |
DLL_RESULT | TC4GetPhysicalValues (int *vphys, int *iphys, int *pphys, int *rphys, int *vzphys, int *ipphys, int *tphys) |
get the standardised physical values from the TopCon module. This is not the same as the physical limit max values from module. | |
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) | |
DLL_RESULT | TC4GetSystemPhysicalLimitMax (double *voltagePhysMax, double *currentPhysMax, double *powerPhysMax, double *resistancePhysMax) |
Gets the physical maximal values from system. | |
DLL_RESULT | TC4GetSystemPhysicalLimitMin (double *voltagePhysMin, double *currentPhysMin, double *powerPhysMin, double *resistancePhysMin) |
Gets the physical minimal values from system. | |
DLL_RESULT | TC4GetSystemPhysicalLimitNom (double *voltagePhysNom, double *currentPhysNom, double *powerPhysNom, double *resistancePhysNom) |
Gets the physical nominal values from system. These are the same values as from TC4GetSystemPhysicalValues but from cache. | |
DLL_RESULT | TC4GetSystemPhysicalMinValues (int *vphysmin, int *iphysmin, int *pphysmin) |
Gets the physical min values from system. | |
DLL_RESULT | TC4GetSystemPhysicalValues (int *vphys, int *iphys, int *pphys, int *rphys) |
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. |
This group contains e.g. physical device limits, firmware versions, installed options and so on.
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.
[out] | pVersion | Version of IBC |
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.
[out] | pVersionPLD,: | PLD version (e.g. 123 means V1.23) |
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.
[out] | pEnabled | 1: Enabled 0: Disabled |
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.
[out] | pReady | 1: Enabled 0: Disabled |
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
[out] | pOperatingHoursAtVoltageOn | voltage-on operating hours [0..596523h] |
DLL_SUCCESS
for success or DLL_FAIL
or other value if an error occurs DLL_RESULT TC4GetAdditionalPhysicalValues | ( | int * | vzphys, |
int * | ipphys, | ||
int * | tphys | ||
) |
get the standardised physical values from the TopCon module. This is not the same as the physical limit max values from module.
[out] | vzphys | standardised voltageDCLink [V] |
[out] | ipphys | standardised primaryCurrent [A] |
[out] | tphys | standardised temperature [°C] |
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.
[out] | vphysmin | PhysicalMinVoltage [V] |
[out] | iphysmin | PhysicalMinCurrent [A] |
[out] | pphysmin | PhysicalMinPower [kW] |
DLL_SUCCESS
for success or DLL_FAIL
or other value if an error occurs 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.
[out] | pmain | Firmware main version |
[out] | psub | Firmware sub version |
[out] | prevision | Firmware revision |
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.
[out] | pIsSupported | 0: false 1: true |
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.
[out] | pIsSupported | 0: false 1: true |
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.
[out] | pIsSupported | 0: false 1: true |
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.
[out] | pIsSupported | 0: false 1: true |
DLL_SUCCESS
for success or DLL_FAIL
or other value if an error occurs DLL_RESULT TC4GetModuleID | ( | unsigned int * | p_moduleid | ) |
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.
*p_moduleid | ModuleID |
DLL_SUCCESS
for success or DLL_FAIL
or other value if an error occurs DLL_RESULT TC4GetModulePhysicalLimitMax | ( | double * | voltagePhysMax, |
double * | currentPhysMax, | ||
double * | powerPhysMax, | ||
double * | resistancePhysMax | ||
) |
Gets the physical max values from module.
[out] | voltagePhysMax | [V] |
[out] | currentPhysMax | [A] |
[out] | powerPhysMax | [kW] |
[out] | resistancePhysMax | [mOhm] |
DLL_SUCCESS
for success or DLL_FAIL
or other value if an error occurs DLL_RESULT TC4GetModulePhysicalLimitMin | ( | double * | voltagePhysMin, |
double * | currentPhysMin, | ||
double * | powerPhysMin, | ||
double * | resistancePhysMin | ||
) |
Gets the physical min values from module.
[out] | voltagePhysMin | [V] |
[out] | currentPhysMin | [A] |
[out] | powerPhysMin | [kW] |
[out] | resistancePhysMin | [mOhm] |
DLL_SUCCESS
for success or DLL_FAIL
or other value if an error occurs DLL_RESULT TC4GetModulePhysicalLimitNom | ( | double * | voltagePhysNom, |
double * | currentPhysNom, | ||
double * | powerPhysNom, | ||
double * | resistancePhysNom | ||
) |
Gets the physical nominal values from module. These are the same values as from TC4GetModulePhysicalValues but from cache.
[out] | voltagePhysNom | [V] |
[out] | currentPhysNom | [A] |
[out] | powerPhysNom | [kW] |
[out] | resistancePhysNom | [mOhm] |
DLL_SUCCESS
for success or DLL_FAIL
or other value if an error occurs DLL_RESULT TC4GetModulePhysicalValues | ( | int * | vphys, |
int * | iphys, | ||
int * | pphys, | ||
int * | rphys | ||
) |
get the standardised physical values from the TopCon module. This is not the same as the physical limit max values from module.
[out] | vphys | standardised module voltage [V] |
[out] | iphys | standardised module current [A] |
[out] | pphys | standardised module power [kW] |
[out] | rphys | standardised simulated module resistance [mOhm] |
DLL_SUCCESS
for success or DLL_FAIL
or other value if an error occurs DLL_RESULT TC4GetPeripherieVersion | ( | unsigned int * | versionPDSP, |
unsigned int * | versionMDSP, | ||
unsigned int * | versionBootloader | ||
) |
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
[out] | versionPDSP | Software version of peripherie-DSP (e.g. 10, read as 0.10) |
[out] | versionMDSP | Software version of modulator-DSP (e.g. 23, read as 0.23) |
[out] | versionBootloader | Bootloader version for theMainDSP (e.g. 4, read as 0.04) |
DLL_SUCCESS
for success or DLL_FAIL
or other value if an error occursHigh level commands up to CTR V4.00
DLL_RESULT TC4GetPhysicalValues | ( | int * | vphys, |
int * | iphys, | ||
int * | pphys, | ||
int * | rphys, | ||
int * | vzphys, | ||
int * | ipphys, | ||
int * | tphys | ||
) |
get the standardised physical values from the TopCon module. This is not the same as the physical limit max values from module.
[out] | vphys | standardised module voltage [V] |
[out] | iphys | standardised module current [A] |
[out] | pphys | standardised module power [kW] |
[out] | rphys | standardised simulated module resistance [mOhm] |
[out] | vzphys | standardised voltageDCLink [V] |
[out] | ipphys | standardised primaryCurrent [A] |
[out] | tphys | standardised temperature [°C] |
DLL_SUCCESS
for success or DLL_FAIL
or other value if an error occurs 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)
[out] | vlimit | Nominal output voltage [V] of that module |
[out] | ilimit | Maximum output current [A] of that module |
[out] | plimit | Nominal output power [kW] of that module |
[out] | rlimit | Nominal simulated resistance [mOhm] of that module |
[out] | vslimit | Nominal output voltage [V] of the whole system |
[out] | islimit | Maximum output current [A]of the whole system |
[out] | pslimit | Nominal output power [kW] of the whole system |
[out] | rslimit | Nominal simulated resistance [mOhm] of the whole system. |
DLL_SUCCESS
for success or DLL_FAIL
or other value if an error occurs DLL_RESULT TC4GetSystemPhysicalLimitMax | ( | double * | voltagePhysMax, |
double * | currentPhysMax, | ||
double * | powerPhysMax, | ||
double * | resistancePhysMax | ||
) |
Gets the physical maximal values from system.
[out] | voltagePhysMax | [V] |
[out] | currentPhysMax | [A] |
[out] | powerPhysMax | [kW] |
[out] | resistancePhysMax | [mOhm] |
DLL_SUCCESS
for success or DLL_FAIL
or other value if an error occurs DLL_RESULT TC4GetSystemPhysicalLimitMin | ( | double * | voltagePhysMin, |
double * | currentPhysMin, | ||
double * | powerPhysMin, | ||
double * | resistancePhysMin | ||
) |
Gets the physical minimal values from system.
[out] | voltagePhysMin | [V] |
[out] | currentPhysMin | [A] |
[out] | powerPhysMin | [kW] |
[out] | resistancePhysMin | [mOhm] |
DLL_SUCCESS
for success or DLL_FAIL
or other value if an error occurs DLL_RESULT TC4GetSystemPhysicalLimitNom | ( | double * | voltagePhysNom, |
double * | currentPhysNom, | ||
double * | powerPhysNom, | ||
double * | resistancePhysNom | ||
) |
Gets the physical nominal values from system. These are the same values as from TC4GetSystemPhysicalValues but from cache.
[out] | voltagePhysNom | [V] |
[out] | currentPhysNom | [A] |
[out] | powerPhysNom | [kW] |
[out] | resistancePhysNom | [mOhm] |
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.
[out] | vphysmin | PhysicalMinVoltage [V] |
[out] | iphysmin | PhysicalMinCurrent [A] |
[out] | pphysmin | PhysicalMinPower [kW] |
DLL_SUCCESS
for success or DLL_FAIL
or other value if an error occurs DLL_RESULT TC4GetSystemPhysicalValues | ( | int * | vphys, |
int * | iphys, | ||
int * | pphys, | ||
int * | rphys | ||
) |
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.
[out] | vphys | standardised system voltage [V] |
[out] | iphys | standardised system current[A] |
[out] | pphys | standardised system power [kW] |
[out] | rphys | standardised simulated system resistance [mOhm] |
DLL_SUCCESS
for success or DLL_FAIL
or other value if an error occurs