tcio  V3.74.00
Function description
Functions
Status

Functions

DLL_RESULT TC42GetTemperaturePCB (double *pTemperature)
 Get internal controllerboard temperature.
DLL_RESULT TC4GetQ4ControllerActive (unsigned short *pActive)
 read if device is operating in Q4 mode (sinking)
Always reads zero if device is not a GSS device
DLL_RESULT TC4ReadErrorTree (struct T_ErrorTree *pErrortree)
 This function reads the error group- and detail-codes into a structure which is defined as follows:

DLL_RESULT TC4ReadErrorTree32 (struct T_ErrorTree32 *pErrorTree32)
 This function reads the error group- and detail-codes into a structure which is defined as follows:

DLL_RESULT TC4ReadWarningTree (struct T_ErrorTree *pWarntree)
 This function reads the warning group- and detail-codes into a structure which is defined as follows:

DLL_RESULT TC4ReadWarningTree32 (struct T_ErrorTree32 *pWarnTree32)
 This function reads the warning group- and detail-codes into a structure which is defined as follows:

DLL_RESULT TC4StateActSystem (unsigned int *p_state)
 returns the actual system- or module-state, depending on whether this function is called on a TopCon Master (returns system state) or Slave (returns module state of that Slave).

Detailed Description

Info about device state (ready, runnung, error, …), pending error and/or warning flags.


Function Documentation

DLL_RESULT TC42GetTemperaturePCB ( double *  pTemperature)

Get internal controllerboard temperature.

Parameters:
[out]pTemperature[Degree-Celsius]
Returns:
DLL_SUCCESS for success or DLL_FAIL or other value if an error occurs
DLL_RESULT TC4GetQ4ControllerActive ( unsigned short *  pActive)

read if device is operating in Q4 mode (sinking)
Always reads zero if device is not a GSS device

Parameters:
[out]pActive1: Enabled
0: Disabled
Note:
This is only possible if it is a GSS Device or a ReGen Device with the (Version >= 111000 and Version <= 111099) or (Version >= 121000 and Version <= 121099)
Returns:
DLL_SUCCESS for success or DLL_FAIL or other value if an error occurs
DLL_RESULT TC4ReadErrorTree ( struct T_ErrorTree *  pErrortree)

This function reads the error group- and detail-codes into a structure which is defined as follows:

 struct T_ErrorTree
 {
   WORD group;
   WORD error[16];
 };

All structure elements are 16bit wide and are aligned without memory gaps.

Parameters:
[out]pErrortreeT_ErrorTree-structure.
Note:
There are 16 possible error-groups. Each bit of the structure element group represents one error-group. To each error-group a 16-bit detail-code exists describing the error more precisely. The structure elements error[] contain these detail-codes. If bit 0 in group is set this means that error[0] contains a corresponding detail-code
If bit 1 in group is set this means that error[1] contains a corresponding detail-code

If bit 15 in group is set this means that error[15] contains a corresponding detail-code
The following table describes what error-index belongs to what error-group:
structure index Error group
error[0] Internal
error[1] Internal (PDSP)
error[2] Output current
error[3] Output voltage
error[4] Supply
error[5] Temperature
error[6] Communication
error[7] Internal (Modulator)
error[8] Internal (AD-overrange 1)
error[9] Internal (AD-overrange 2)
error[10] Internal (AD-underrange 1)
error[11] Internal (AD-underrange 2)
error[12] Login
error[13] Configuration
error[14] Configuration 2
error[15] Miscellaneous

See also:
The TopCon manual chapter Error handling, in which the detail-errors has described.
Returns:
DLL_SUCCESS for success or DLL_FAIL or other value if an error occurs
DLL_RESULT TC4ReadErrorTree32 ( struct T_ErrorTree32 *  pErrorTree32)

This function reads the error group- and detail-codes into a structure which is defined as follows:

 struct T_ErrorTree32
 {
   unsigned long group;
   unsigned long error[32];
 }

All structure elements are 32bit wide and are aligned without memory gaps.

Parameters:
[in]pErrorTree32T_ErrorTree-structure.
Note:
There are 32 possible error-groups. Each bit of the structure element group represents one error-group. To each error-group a 32-bit detail-code exists describing the error more precisely. The structure elements error[] contain these detail-codes.
If bit 0 in group is set this means that error[0] contains a corresponding detail-code
If bit 1 in group is set this means that error[1] contains a corresponding detail-code

If bit 31 in group is set this means that error[31] contains a corresponding detail-code
The following table describes what error-index belongs to what error-group:
structure index Error group
error[0] Internal
error[1] Internal (PDSP)
error[2] Output current
error[3] Output voltage
error[4] Supply
error[5] Temperature
error[6] Communication
error[7] Internal (Modulator)
error[8] AD overrange 1
error[9] AD overrange 2
error[10] AD underrange 1
error[11] AD underrange 2
error[12] Login
error[13] Configuration
error[14] Configuration 2
error[15] Miscellaneous
error[16] IBC System
error[17] IBC Supply
error[18] IBC Communication
error[19] IBC Power
error[20] IBC Inverter
error[21] IBC Miscellaneous
error[22] IBC Inverter 2
error[23] Not def.
error[24] Not def.
error[25] Not def.
error[26] Not def.
error[27] Login 2
error[28] Configuration 3
error[29] Communication 3
error[30] Internal 2
error[31] Communication 2

See also:
The TopCon manual chapter Error handling, in which the detail-errors has described.
Returns:
DLL_SUCCESS for success or DLL_FAIL or other value if an error occurs
DLL_RESULT TC4ReadWarningTree ( struct T_ErrorTree *  pWarntree)

This function reads the warning group- and detail-codes into a structure which is defined as follows:

 struct T_ErrorTree
 {
   WORD group;
   WORD error[16];
 };

All structure elements are 16bit wide and are aligned without memory gaps.

Parameters:
[in]pWarntreeT_ErrorTree-structure.
Note:
There are 16 possible error-groups. Each bit of the structure element group represents one error-group. To each warning-group a 16-bit detail-code exists describing the error more precisely. The structure elements error[] contain these detail-codes.
If bit 0 in group is set this means that error[0] contains a corresponding detail-code
If bit 1 in group is set this means that error[1] contains a corresponding detail-code

If bit 15 in group is set this means that error[15] contains a corresponding detail-code
The following table describes what error-index belongs to what warning-group:
structure index Error group
error[0] Internal
error[1] Internal (PDSP)
error[2] Output current
error[3] Output voltage
error[4] Supply
error[5] Temperature
error[6] Communication
error[7] Internal (Modulator)
error[8] AD overrange 1
error[9] AD overrange 2
error[10] AD underrange 1
error[11] AD underrange 2
error[12] Login
error[13] Configuration
error[14] Configuration 2
error[15] Miscellaneous

See also:
The TopCon manual chapter Error handling, in which the detail-errors has described.
Returns:
DLL_SUCCESS for success or DLL_FAIL or other value if an error occurs
DLL_RESULT TC4ReadWarningTree32 ( struct T_ErrorTree32 *  pWarnTree32)

This function reads the warning group- and detail-codes into a structure which is defined as follows:

 struct T_ErrorTree32
 {
   unsigned long group;
   unsigned long error[32];
 }

All structure elements are 32bit wide and are aligned without memory gaps.

Parameters:
[in]pWarnTree32T_ErrorTree32-structure.
Note:
There are 32 possible warn-groups. Each bit of the structure element group represents one error-group. To each warning-group a 32-bit detail-code exists describing the error more precisely. The structure elements error[] contain these detail-codes.
If bit 0 in group is set this means that error[0] contains a corresponding detail-code
If bit 1 in group is set this means that error[1] contains a corresponding detail-code

If bit 31 in group is set this means that error[31] contains a corresponding detail-code
The following table describes what error-index belongs to what warning-group:
structure index Error group
error[0] Internal
error[1] Internal (PDSP)
error[2] Output current
error[3] Output voltage
error[4] Supply
error[5] Temperature
error[6] Communication
error[7] Internal (Modulator)
error[8] AD overrange 1
error[9] AD overrange 2
error[10] AD underrange 1
error[11] AD underrange 2
error[12] Login
error[13] Configuration
error[14] Configuration 2
error[15] Miscellaneous
error[16] IBC System
error[17] IBC Supply
error[18] IBC Communication
error[19] IBC Power
error[20] IBC Inverter
error[21] IBC Miscellaneous
error[22] IBC Inverter 2
error[23] Not def.
error[24] Not def.
error[25] Not def.
error[26] Not def.
error[27] Login 2
error[28] Configuration 3
error[29] Communication 3
error[30] Internal 2
error[31] Communication 2

See also:
The TopCon manual chapter Error handling, in which the detail-errors has described.
Returns:
DLL_SUCCESS for success or DLL_FAIL or other value if an error occurs
DLL_RESULT TC4StateActSystem ( unsigned int *  p_state)

returns the actual system- or module-state, depending on whether this function is called on a TopCon Master (returns system state) or Slave (returns module state of that Slave).

Parameters:
[out]p_stateActual state
2: POWERUP
4: READY
8: RUN
10: WARNING
12: ERROR
14: STOP
Note:
values and corresponding states have changed since firmware 2.x
Returns:
DLL_SUCCESS for success or DLL_FAIL or other value if an error occurs