<< Click to Display Table of Contents > 

Client Control Interface Manual > Other > Hardware Status

Hardware Status
Previous pageReturn to chapter overviewNext page

•Hardware State

•Last Message Input

•All Message Inputs

•License

•USC System ID

•SCAPS Dongle ID

•USC Firmware Status

•USC Server Status

 

Hardware State
 

☐ Set

☒ Get

DLL Function

int State = ScGetLongValue(int Value_Type)

ASCII Function

int State = ScCciGetLongValue(int Value_Type)

Description

Get the hardware state of the current selected head.

Value_Type

Type: int

Location: ScComSAMLightClientCtrlValueTypes

scComSAMLightClientCtrlLongValueTypeHardwareState

41

State

Type: int

Unit: none

•0: Error.

•2: OK.

Notes

•A check is executed while booting. If it passed for all connected cards, the OK return is sent.

C# Example: Get hardware state

 

int State = cci.ScGetLongValue((int)ScComSAMLightClientCtrlValueTypes.scComSAMLightClientCtrlLongValueTypeHardwareState);

Table 368: Hardware State

Last Message Input

☐ Set

☒ Get

DLL Function

int CCI_Return = ScGetStringValue(int Value_Type, ref string Last_Message_Input)

ASCII Function

string Last_Message_Input = ScCciGetStringValue(int Value_Type)

Description

Get last message input that is still active.

Value_Type

Type: int

ID:

Location: ScComSAMLightClientCtrlValueTypes

scComSAMLightClientCtrlStringValueTypeGetLastErrorMessageInput

14

Error message input.

scComSAMLightClientCtrlStringValueTypeGetLastInfoMessageInput

15

Info message input.

Last_Message_Input

Type: string

Unit: none

The corresponding last message input.

CCI_Return

Type: int

CCI return number, see error list.

Notes

-

C# Example: Get last  message input:
 

string Last_Message_Input = "";

int CCI_Return = cci.ScGetStringValue( ( int )ScComSAMLightClientCtrlValueTypes.scComSAMLightClientCtrlStringValueTypeGetLastErrorMessageInput, ref Last_Message_Input );

Table 369: Last Message Input

All Message Inputs

☐ Set

☒ Get

DLL Function

int CCI_Return = ScGetStringValue(int Value_Type, ref string All_Message_Inputs)

ASCII Function

string All_Message_Inputs = ScCciGetStringValue(int Value_Type)

Description

Get all active message inputs.

Value_Type

Type: int

ID:

Location: ScComSAMLightClientCtrlValueTypes

scComSAMLightClientCtrlStringValueTypeGetAllErrorMessageInputs

46

Error message inputs.

scComSAMLightClientCtrlStringValueTypeGetAllInfoMessageInputs

47

Info message inputs.

All_Message_Inputs

Type: string

Unit: none

The corresponding message inputs.

CCI_Return

Type: int

CCI return number, see error list.

Notes

-

C# Example: Get all message inpust:
 

string All_Message_Inputs = "";

int CCI_Return = cci.ScGetStringValue( ( int )ScComSAMLightClientCtrlValueTypes.scComSAMLightClientCtrlStringValueTypeGetAllErrorMessageInputs, ref All_Message_Inputs );

Table 370: All Message Inputs

License
 

☐ Set

☒ Get

DLL Function

int CCI_Return = ScGetStringValue(int Value_Type, ref string License)

ASCII Function

string License = ScCciGetStringValue(int Value_Type)

Description

Get the active license from USB dongle and USC card.

Value_Type

Type: int

Location: ScComSAMLightClientCtrlValueTypes

scComSAMLightClientCtrlStringValueTypeLicenseAsString

40

License

Type: string

Unit: none

The active license from USB dongle and USC card. Example string:
"USB license: None, USC license: SAMLight + MOTF"

CCI_Return

Type: int

CCI return number, see error list.

Notes

-

C# Example: Get current license information:

 

string License = "";

int CCI_Return = cci.ScGetStringValue( ( int )ScComSAMLightClientCtrlValueTypes.scComSAMLightClientCtrlStringValueTypeLicenseAsString, ref License );

Table 371: License

SCAPS Dongle ID

☐ Set

☒ Get

DLL Function

int Dongle_ID = ScGetLongValue(int Value_Type)

ASCII Function

int Dongle_ID = ScCciGetLongValue(int Value_Type)

Description

Get User ID or System ID.

Value_Type

Type: int

ID:

Location: ScComSAMLightClientCtrlValueTypes

scComSAMLightClientCtrlLongValueTypeDongleUserID

39

User ID

scComSAMLightClientCtrlLongValueTypeDongleSystemID

40

System ID

DongleID

Type: int

Unit: none

Get the User ID or System ID.

Notes

•If a combination of USB-Dongle and Card is used, the USB-Dongle is shown.

•If multiple cards are connected, the ID of the one positioned first in the server will be received.

•If MultiInstance is used, the IDs of the currently active card will be received.

C# Example: Get current System ID:
 
int Dongle_ID = cci.ScGetLongValue( ( int )ScComSAMLightClientCtrlValueTypes.scComSAMLightClientCtrlLongValueTypeDongleSystemID );

Table 372: SCAPS Dongle ID

USC Firmware Status

☐  Set

☒ Get

DLL Function

int Firmware_Status = ScGetLongValue(int Value_Type)

ASCII Function

int Firmware_Status = ScCciGetLongValue(int Value_Type)

Description

Get the status of the USC firmware.

Value_Type

Type: int

ID:

Location: ScComSAMLightClientCtrlValueTypes

scComSAMLightClientCtrlLongValueTypeFirmwareStatus

123

Firmware_Status

Type: int

Unit: none

•< 0: Firmware on the USC card is newer than the software version.

•= 0: Firmware on the USC card is up to date.

•> 0: A newer firmware is available.

Notes

•This command is not available for USC-1.

C# Example: Get current USC firmware status:
 
int Firmware_Status = cci.ScGetLongValue( ( int )ScComSAMLightClientCtrlValueTypes.scComSAMLightClientCtrlLongValueTypeFirmwareStatus );

Table 373: USC Firmware Status

USC Server Status

☐  Set

☒ Get

DLL Function

int Server_Status = ScGetLongValue(int Value_Type)

ASCII Function

int Server_Status = ScCciGetLongValue(int Value_Type)

Description

Get the status of the usc server.

Value_Type

Type: int

ID:

Location: ScComSAMLightClientCtrlValueTypes

scComSAMLightClientCtrlLongValueTypeServerStatus

67

Server_Status

Type: int

Flag:

Location: None

Device Connected

0x1

Device OK

0x2

Device Missing

0x8

Device USC-1

0x10000

Device USC-2

0x20000

Device USC-3

0x80000

Device USC-4

0x100000

CCI_Return

Type: int

CCI return number, see error list.

Notes

•The flags can be combined by using logical operators. Please refer to the chapter How to work with Flags for more information.

•There are further undocumented flags for internal use only.

•This command should not be used while marking, as this could interfere with the transmission of data to the card.

C# Example: Get current USC server status:
 
int Server_Status = cci.ScGetLongValue( ( int )ScComSAMLightClientCtrlValueTypes.scComSAMLightClientCtrlLongValueTypeServerStatus );

Table 374: USC Server Status

USC System ID

☐ Set

☒ Get

DLL Function

int Dongle_ID = ScGetLongValue(int Value_Type)

ASCII Function

int Dongle_ID = ScCciGetLongValue(int Value_Type)

Description

Get the System ID of the current card.

Value_Type

Type: int

ID:

Location: ScComSAMLightClientCtrlValueTypes

scComSAMLightClientCtrlLongValueTypeSystemNumberOfHead

171

SystemID

Type: int

Unit: none

Get the SystemID of the current card.

Notes

•If multiple Heads are in use, the command Head ID can be used to select the head of which the SystemID is received.

C# Example: Get current System ID:
 
int SystemID = cci.ScGetLongValue( ( int ) ScComSAMLightClientCtrlValueTypes.scComSAMLightClientCtrlLongValueTypeDongleSystemNumberOfHead );

Table 375: USC System ID