<< Click to Display Table of Contents > 

Client Control Interface Manual > Introduction

Introduction
Return to chapter overviewNext page

Welcome to our new client control documentation. In the past, this documentation was part of the SAMLight manual. As the Client Control Interface (CCI) was growing and growing we decided that a separate manual with a more user friendly structure and detailed descriptions of the commands including the definition and explanation of all relevant parameters as well as an easy example for each function was necessary.

If there are any questions or problems related to our documentation, feel free to contact us.

 

This manual will teach and show you how to remote control SAMLight from another software via a CCI application. The following chapters specify the main base functions used in combination with their constants as well as some programming examples and give tips to optimize the performance.

 

The basic structure of this manual follows the structure in the SAMLight manual. Each chapter of the SAMLight manual can be found in a similar way here if any relevant commands do exist. The amount of functions in SAMLight is huge - not all functions are also available in CCI. If there is a command missing in your opinion, feel free to contact us.

 

Client Control can be done via one of the following ways (further details in implementation):

Function calls
oOCX - ActiveX
oCOM
ASCII commands

 

Regarding the function calls, the OCX (ActiveX) control SCAPS.ScSamlightClientCtrl and the COM (CCI Ex) control SCAPS.ScSamlightClientCtrlEx are providing function commands to remote control SAMLight from another software. This allows fast development of automation with different Windows development environments. OCX and COM can be used with a 32-bit or a 64-bit custom software. In addition CCI can be used without the OCX or COM encapsulation. In this case, plain ASCII commands are sent via TCP from a different system which does not need to be a Windows PC.

 

In total, there are three different options:

1.Remote control SAMLight at the same Windows PC: CCI Function commands (OCX or COM) via Function Calls.
2.Remote control SAMLight from another Windows PCs: CCI Function commands (OCX or COM) via TCP.
3.Remote control SAMLight from any system supporting telnet-like network connections: CCI ASCII commands via TCP.

 

These three different ways to realize CCI are illustrated and described in further detail in the following (images always show the connection to a USC card, but CCI of course can also be used together with an RTC card.):

 

1.CCI Function Commands (OCX or COM) via Function Calls

 

CCI_Overview_FunctionCalls

 

 

SAMLight can be controlled by a CCI application running on the same PC:
SAMLight → Settings → System → Remote → Function Calls must be enabled.
The client application can use all Function commands, see DLL Commands.

 

2.CCI Function commands (OCX or COM) via TCP

 

CCI_Overview_TCP

 

SAMLight can be controlled by a CCI application running on a different PC. The SAM DLL (included in the SAMLight installer must be installed on the remote controlling PC, meaning that both system need to be a Windows PC.
Both Windows PCs are connected via TCP (Ethernet).
SAMLight → Settings → System → Remote → TCP must be enabled.
SAMLight → Settings → System → Remote → Bind To → IP Adress must be the IP of the PC on which SAMLight is running. Use 0.0.0.0 to allow remote control from any IP or 127.0.0.1 for local host.
The client application can use all Function commands, see DLL Commands.
If MultiInstance is used with two or more instances of SAMLight which should be controlled by one CCI application, different TCP connections (127.0.0.1, different Ports) have to be set in every instance of SAMLight together with two or more SAMLight Client Control ocx with different names in the CCI application. If just one TCP connection is closed by ScCloseEthernetConnection(), then TCP mode is also getting disabled and CCI switches to function call mode, which could lead to incorrect CCI function return values. So it is better to close all TCP connection and eventually reopen them all again.

 

3. CCI ASCII commands via TCP

 

CCI_Overview_TCP-ASCII

SAMLight can be controlled by a CCI application running on a different system which does not need to be a Windows PC.
The system and the Windows PC are connected via TCP (Ethernet)
SAMLight → Settings → System → Remote → TCP must be enabled.
SAMLight → Settings → System → Remote → ASCII Communication Mode must be enabled.
SAMLight → Settings → System → Remote → Bind To → IP Adress must be the IP of the PC on which SAMLight is running. Use 0.0.0.0 to allow remote control from any IP or 127.0.0.1 for local host.
The client application can use all ASCII commands, see ASCII Commands.