<< Click to Display Table of Contents > 

Flash Control Interface Manual > Statistics

Statistics
Previous pageReturn to chapter overviewNext page

The following FCI commands are found in this chapter:

Command

Description

GHS

Get head status.

GTC

Get trigger count.

GTI

Get timer information.

MAINVER

Get the current installed USC-3 firmware.

ST

Get flash statistics.

STAT

Get flash statistics in a defined range.

USCID

Get Customer ID, Dongle ID and MAC ID.

USCTYPE

Get Card Type.

Table 17: Overview Commands Statistics

GHS <HeadNumber> <Channel>

 

Get head status

ok  USC-2

ok  USC-3

 

Description

Get the state of the XY2-100 head status of the selected head as decimal number.

<HeadNumber>

 

 

Value: <int>

Function

0

Get the statistics of head 0.

1

Get the statistics of head 1.

<Channel>

Value: <int>

Function

0

Status <HeadNumber> X

1

Status <HeadNumber> Y

2

Status <HeadNumber> Z

Example

Command

Return

Note

GHS 0 0

0: 196608

Get head 0 state.

Notes

This command corresponds to the bits, which can be seen in the InfoView. Here you get a 20bit word, which depends on the connected scan head. This 20bit word needs to be interpreted by the user by the help of the manual of the scan head.

Save

N/A

Restriction

None

Errors

1: Too many parameters

2: Too few parameters

8: Parameter out of range

17: Wrong parameter type

Table 18: GHS

GTC

 

Get trigger count

ok  USC-2

ok  USC-3

 

Description

Get information on the trigger count. The trigger counter counts the external triggers signals in trigger mode (ET 1, M 1; FlashJobIOSelect mode). The trigger count is reset with M 1 or with loading of a new job in FlashJobIOSelect mode.

Example

Command

Return

Note

GTC

0: 5

5 external trigger signals have been detected since the last reset.

M 1

0:

Reset the trigger count.

GTC

0: 0

No external triggers signal has been detected since the last reset (M 1).

Notes

The trigger count is available during marking.

Maximum is 2^32 -1, will reset when maximum is reached.

Save

N/A

Restriction

None

Errors

2: Too few parameters

Table 19: GTC

GTI <InfoType>

 

Get timer information

ok  USC-2

ok  USC-3

 

Description

Get information on the duration of the last marking [ms], on the ratio between process time and marking time (interesting if working in trigger mode) and on the total time information array.

<InfoType>

 

Value: <int>

Function

empty

Not available. This parameter is obligatory.

0

Get the duration of the last marking in ms.

1

Get the ratio of the next-to-last process time and the last marking time.

Here, the process time is the time between the start of the next-to-last marking and the start of the last marking. The marking time is the duration between the start of a marking and the end of the marking.

More precisely, when working in trigger mode, GTI 1 gives the ratio between the marking time and the time between 2 trigger signals.

2

Get the total time info array. This can be helpful for debugging.

Example

Command

Return

Note

GTI 0

0: 21.14

Get mark time: 21.14 milliseconds.

GTI 1

0: #

Get ratio # of marking time and between trigger time.

GTI

2:

Too few parameters. GTI needs <Par1>.

Notes

-

Save

N/A

Restriction

None

Errors

1: Too many parameters

2: Too few parameters

3: Unknown command

Table 20: GTI

MAINVER

 

Get the current installed USC-3 firmware

notavailable  USC-2

ok  USC-3

 

Description

This command allows to get the firmware version on the USC-3-Card.

Example

Command

Return

Note

MAINVER

0: 61

Get USC-3 firmware version.

MAINVER 61

0: 1

To many parameters. Version can not be set.

Notes

-

Save

N/A

Restriction

Command is not available for USC-2.

Errors

1: Too many parameters

Table 21: MAINVER

ST [<JN>] [<InfoType>] [<SN>]

 

Get flash statistics

ok  USC-2

ok  USC-3

 

Description

Return the statistics of all jobs which are stored on the flash memory of the USC card.
Available information: the firmware version on the card, the size of each job stored on the flash, the number of serial numbers in each job, the UNF-Version, the name of each job.
Using Parameter2, additional information on the serial numbers within each job are available (ID, name, format, mode and text string).

<JN>

[optional]

 

Value: <int>

Function

empty

Get the statistics of all jobs on the flash.

JobNumber

[1; 255]

Get the statistics of the job <JN>.

<InfoType>

[optional]

 

Value: <string>

Function

empty

Without parameter 2 and parameter 3, the flash statistics are returned - see explanation of parameter JN.

ID

Get the IDs and the names of all serial numbers of the job (does not allow parameter 3).

NA

Get the name of the specified serial number (needs parameter 3).

FO

Get the format string of the specified serial number (needs parameter 3).

MO

Get the mode of the specified serial number (needs parameter 3).

STR

Get the text string of the specified serial number (needs parameter 3).

DC

Get the timestamp (UTC) for the date created of the specified job number. (USC-3 only)

<SN>

[optional]

 

Value: <int>

Function

empty

Without <Par2> and <Par3>, flash statistics are returned - see explanation of parameter JN.

Parameter 3 is not allowed for <Par2> = ID.

SN
[1; 64]

ID of the specified serial number. Return statistics of the serial number specified by parameter 3; it is obligatory for <Par2> = NA, FO, MO and STR.

Example

Command

Return

Note

ST

0:

Get flash statistics.

ST 2 ID

0:

Get ID and name of all serial numbers in job number 2.

ST 3 NA 1

0:

Get name of serial number 1 in job number 3.

Notes

The command ST without parameters returns the statistics of all jobs stored on the flash.

Return values for the mode of a serial number, combinations can occur:

Value

Function

0x0001

Serial number mode: text

0x0002

Serial number mode: barcode

0x0008

Serial number mode: date time

0x0010

Serial number mode: custom format

0x0040

Serial number mode: text and date time

0x0800

Serial number mode: popup edit box barcode reader mode

0x1000

Serial number mode: use global serial number

Save

N/A

Restriction

Set: not allowed during marking

Errors

1: Too many parameters

4: Job not valid

5: Not allowed during marking

8: Parameter out of range

17: Wrong parameter type

Table 22: ST

STAT [<From> <To>]

 

Get flash statistics in a defined range

ok  USC-2

ok  USC-3

 

Description

Return the last JobID stored on the flash memory of the USC card.  
Using the optional parameter <From> <To>, return the job information about jobs in this range in the form ID:SIZE;SERIAL_NUMBERS;JOB_NAME

<From> <To>

[optional]

 

Value: <int>

Function

empty

Get the last valid job ID on the flash.

From

To

[1; 255]

Get the job information about jobs in this range in the form ID:SIZE;SERIAL_NUMBERS;JOB_NAME

Example

Command

Return

Note

STAT

0:

Get the last valid job ID.

STAT 1 5

0: 1:...

Get the job information of all job from job number 1 to job number 5.

Notes

-

Save

N/A

Restriction

Set: not allowed during marking

Errors

1: Too many parameters

4: Job not valid

5: Not allowed during marking

8: Parameter out of range

17: Wrong parameter type

Table 23: STAT

USCID

 

Get Customer ID, Dongle ID and MAC ID

ok  USC-2

ok  USC-3

 

Description

The command USCID is used to get the following IDs stored on the USC card:

Customer ID, Dongle ID and MAC ID. These IDs are returned separated by a space.

Example

Command

Return

Note

USCID

0: #

Get IDs #.

USCID 1

1:

Read only command. Too many parameters give the error message 1.

Notes

The return value is a string containing three numbers separated by a blank.

Save

N/A

Restriction

None

Errors

1: Too many parameters

Table 24: USCID

USCTYPE

 

Get Card Type

ok  USC-2

ok  USC-3

 

Description

The command USCTYPE is used to get the type of the USC card.

Example

Command

Return

Note

USCTYPE

0:2

The connected card is an USC-2.

USCTYPE

0:3

The connected card is an USC-3.

USCTYPE 1

1:

Read only command. Too many parameters give the error message 1.

Notes

-

Save

N/A

Restriction

None

Errors

1: Too many parameters

Table 25: USCTYPE