tcio
Functions
Remote System Configuration (RSC)

Functions

DLL_RESULT TC42RSCGetActualConfiguration (unsigned short descriptionStrSize, char *pStrActConfigDescription, unsigned short *pActConfigNumber, unsigned short *pActRedirectToSubSystem, unsigned short *pActMatrixConnectionType, unsigned short *pDefaultSwitchBoxID)
 Get the actual remote system configuration (RSC)
DLL_RESULT TC42RSCGetConfigurationAndSwitchboxState (unsigned short *pSystemConfigState, unsigned short *pSwitchBoxState)
 Get the state of the system configuration and the switchbox.
DLL_RESULT TC42RSCGetConfigurationDescription (unsigned short configurationNumber, unsigned short descriptionStrSize, char *pStrConfigDescription, unsigned short *pMatrixConnectionType)
 Get the description of a configuration.
DLL_RESULT TC42RSCGetConfigurationFileInfo (unsigned short *pSwitchBoxID, unsigned short *pRedirectToSubSystem, unsigned short *pNumberOfConfigurations)
 Get informations about the configurations in the configuration file.
DLL_RESULT TC42RSCInitialisation (char *pStrPathConfigFile, short *pRSCInitState)
 Initialising the remote system configuration (RSC)
DLL_RESULT TC42RSCSetConfiguration (unsigned short configurationNumber, unsigned short automaticRestart, short *pSetConfigState)
 Set a configuration.

Detailed Description

These functions are used to reconfigure a mulit unit system automatically (e.g. Reconfigure a serial to a parallel multi unit system).
For using the option remote system configuraton is a configuration file (.ini file) and a switchbox required. In the configuration file are the selectable system configurations saved. The switchbox changes the connections on the power side.

Attention:
These functions can only be used on a TC.MAC or a master from a master-slave system (not subsystem-master).

Function Documentation

DLL_RESULT TC42RSCGetActualConfiguration ( unsigned short  descriptionStrSize,
char *  pStrActConfigDescription,
unsigned short *  pActConfigNumber,
unsigned short *  pActRedirectToSubSystem,
unsigned short *  pActMatrixConnectionType,
unsigned short *  pDefaultSwitchBoxID 
)

Get the actual remote system configuration (RSC)

Parameters:
[in]descriptionStrSize,:Length (number of bytes) of the string for saving the actual configuration description
[out]pStrActConfigDescriptionreturns the string with the actual configuration description
[out]pActConfigNumberreturns the actual configuration number
[out]pActRedirectToSubSystemreturns if the actual configuration is valid for TC.MAC system, subsystems or master-slave system
0: Configuration valid for TC.MAC system
1: Configuration valid for subsystems or master-slave system
[out]pActMatrixConnectionTypereturns the actual system connection type 0: Parallel connection of serial lines 1: Series connection of parallel strings
[out]pDefaultSwitchBoxIDreturns the switchbox ID which is connected to the system
Note:
The parameter pActRedirectToSubSystem has only an effect on a TC.MAC.
The parameter pActMatrixConnectionType has only an effect in a matrix system (not only parallel or only serial connected devices).
Returns:
DLL_SUCCESS for success or DLL_FAIL or other value if an error occurs
DLL_RESULT TC42RSCGetConfigurationAndSwitchboxState ( unsigned short *  pSystemConfigState,
unsigned short *  pSwitchBoxState 
)

Get the state of the system configuration and the switchbox.

Parameters:
[out]pSystemConfigStatereturns the state of the system configuration
0: System configuration failed
1: System configuration successful
[out]pSwitchBoxStatereturns the switch box state 0: Switchbox state not ok
1: Switchbx state ok
Returns:
DLL_SUCCESS for success or DLL_FAIL or other value if an error occurs
DLL_RESULT TC42RSCGetConfigurationDescription ( unsigned short  configurationNumber,
unsigned short  descriptionStrSize,
char *  pStrConfigDescription,
unsigned short *  pMatrixConnectionType 
)

Get the description of a configuration.

Parameters:
[in]configurationNumber,:Configuration number to select the description
[in]descriptionStrSize,:Length (number of bytes) of the string for saving the configuration description
[out]pStrConfigDescriptionreturns the string with the configuration description, depending on the configuration number
[out]pMatrixConnectionTypereturns the system connection type 0: Parallel connection of serial lines 1: Series connection of parallel strings
Note:
The parameter pMatrixConnectionType has only an effect in a matrix system (not only parallel or only serial connected devices).
Returns:
DLL_SUCCESS for success or DLL_FAIL or other value if an error occurs
DLL_RESULT TC42RSCGetConfigurationFileInfo ( unsigned short *  pSwitchBoxID,
unsigned short *  pRedirectToSubSystem,
unsigned short *  pNumberOfConfigurations 
)

Get informations about the configurations in the configuration file.

Parameters:
[out]pSwitchBoxIDreturns the switchbox ID for which the configurations in the configuration file are valid
[out]pRedirectToSubSystemreturns if the configurations are valid for TC.MAC system, subsystems or master-slave system
0: Configurations valid for TC.MAC system
1: Configurations valid for subsystems or master-slave system
[out]pNumberOfConfigurationsreturns the number of configurations in the configuration file
Note:
The parameter pRedirectToSubSystem has only an effect on a TC.MAC.
Returns:
DLL_SUCCESS for success or DLL_FAIL or other value if an error occurs
DLL_RESULT TC42RSCInitialisation ( char *  pStrPathConfigFile,
short *  pRSCInitState 
)

Initialising the remote system configuration (RSC)

Parameters:
[in]pStrPathConfigFile,:Path where the conifguration file is saved
[out]pRSCInitStatereturns the initialisation state
-8: Switchbox ID's from device and from configuration file not identical
-7: Reading configuration file failed
-6: Invalid configuration file name
-5: Serial number from device and from configuration file not identical
-4: Set switchbox data failed
-3: Set device data failed
-2: Device is a slave or a subsystem-master
-1: RSC not enabled or supported
0: RSC initialisation successful
1: RSC initialisation is running
Attention:
Every time a connection to a device is established, this function must be called before a reconfiguration of the system can be performed.
Note:
The name of the configuration file must consist of the following parts:
  • Part 1: The naming: "RemoteSystemConfiguration"
  • Part 2: Serial number of the connected device (e.g. 1640CC787)
  • Part 3: File extension .ini
    Example for a configuration file name: RemoteSystemConfiguration1640CC787.ini
Returns:
DLL_SUCCESS for success or DLL_FAIL or other value if an error occurs
DLL_RESULT TC42RSCSetConfiguration ( unsigned short  configurationNumber,
unsigned short  automaticRestart,
short *  pSetConfigState 
)

Set a configuration.

Parameters:
[in]configurationNumber,:Number of configuration to set
[in]automaticRestart,:Automatic restart of the system 0: System must be restarted manually 1: System restarts automatically
[out]pSetConfigStatereturns the set configuration state
-4: Write command restart failed
-3: Save configuration failed
-2: Saving the configuration not possible until output is turned off
-1: Configuration number out of range
1: Set configuration running
2: Configuration successfully saved
3: System is restarting
Attention:
The saved configuration will only be active after the system is restarted.
The system must be reconnected after restarting.
Returns:
DLL_SUCCESS for success or DLL_FAIL or other value if an error occurs