<< Click to Display Table of Contents > 

Flash Control Interface Manual > Serial Numbers

Serial Numbers
Previous pageReturn to chapter overviewNext page

The following FCI commands are found in this chapter:

Command

Description

GSN

Get/Set reset time of global sequence number. Get/Set/Save global sequence number.

JI

Get job information

SI

Get/Set parameters of the serial number

SLR

Get/Set parameters of the save/load/reset mode

SN

Get/Set one of the serial numbers of the job

Table 44: Overview Commands Serial Numbers

GSN <VRZ> [<Gseq>] [<Par3>]

 

Get/Set reset time of global sequence number. Get/Set/Save global sequence number

ok  USC-2

ok  USC-3

 

Description

The GSN command with its obligatory parameter <VRZ> operates on global sequences. GSN V <Gseq> [<Par3>] is used to get or set the sequence number, GSN R <Gseq> [<Par3>] is used to get or set the reset time and GSN Z <Par3> is used to save global sequence numbers.

<VRZ>

Value: <string>

Function

empty

Not available. This parameter is obligatory.

V

Get/Set the sequence number of a global sequence

R

Get/Set the reset time of a global sequence number

Z

Reset all current global sequence numbers. Only <Par3> is available for <VRZ> = Z, <Gseq> is not.

<Gseq>

[optional]

Value: <int>

Function

empty for Z

Only available for <VRZ> = Z. Then, all current global sequence numbers are saved.

SaveState for Z

[0; 1]

only available for <VRZ> = Z:

0 = Reset all current global sequence numbers temporarily. If this state is not saved with SVG, the previous state can be restored using LDG.

1 = Reset and save all current global sequence numbers. The effect of "GSN Z" is the same as for "GSN Z 1".

Number for V,R

[1,64]

Obligatory for <VRZ> = V and = R. This parameter specifies the number of the global sequence number.

<Par3>

[optional]

Value: <int>

Function

empty for Z,V

For <VRZ> = Z: reset and save all current global sequence numbers.

For <VRZ> = V: get the sequence number of the global sequence specified by <Gseq>.

Number for V

Only available for <VRZ> = V: set the sequence number of the global sequence specified by <Gseq>.

Resettime for R

<int1> <int2> <int3>

 

 

Only available for <VRZ> = R: set the reset time of the global sequence specified by <Gseq>.

Specify the reset time (as unix timestamp) = <int1>, the reset period in seconds <int2> and the reset period in months <int3> all separated by spaces.

Example

Command

Return

Note

GSN V 20

0:

Get the sequence number of the global sequence 20.

GSN R 2 1402495200 30 0

0:

Set the reset time of the global sequence 2 to 1402495200 unix timestamp 30 seconds 0 months.

GSN Z 1

0:

Reset all global sequence numbers and save the reset state.

Notes

The ActualValue is calculated by:

ActualValue = StartValue + IncrementValue * RoundDown(( SequenceNumber Modulo ResetCount ) / BeatCount )

Reset period can only be seconds or months, set the other to zero. To disable reset for a sequence set all three values to 0.

Save

Changes are saved with SVG.

The global sequence numbers are also stored by the store button.

Saved changes are restored with LDG.

When not saved, changes are valid until the next reboot of the USC-Card.

Restriction

None

Errors

1: Too many parameters

2: Too few parameters

3: Unknown command

8: Parameter out of range

Table 45: GSN V, GSN R, GSN Z

JI <Number>

 

Get job information

ok  USC-2

ok  USC-3

 

Description

Get the job information. Currently, the command is only available with <Par1> = SN to get the amount of serial numbers in a selected job.

<Number>

 

Value: <string>

Function

empty

Not available. This parameter is obligatory.

SN

Get the amount of serial numbers in the job. A job needs to be selected before.

Example

Command

Return

Note

JN 1

0:

Select job with number 1.

JI

2:

Too few parameters. Parameter1 is necessary.

JI SN

0:

Get the information of the amount of serial numbers in the selected job.

Notes

Currently, the only possible value for parameter 1 is SN: Amount of serial numbers.

This command takes effect only if a job has been selected before (e.g. using JN).

Save

N/A

Restriction

None

Errors

1: Too many parameters

3: Unknown command

Table 46: JI

SI <Par> [<ValueToSet>]

 

Get/Set parameters of the serial number

ok  USC-2

ok  USC-3

 

Description

Get or set parameters of the serial number.

<Par>

 

Value: <string>

Function

empty

Not available. This parameter is obligatory.

B

Get or set the beat count.

F

Get or set the format of the serial number (see Format definition: Date/Time).

I

Get or set the increment value of the serial number.

M

Get the mode of the serial number (read only, parameter <ValueToSet> is not available for Par = M). <ValueToSet> is not available for this read only parameter.

Possible values for the mode are:

1 = Text; 2 = Barcode; 8: = Date Time

N

Get the name of the serial number (read only, parameter <ValueToSet> is not available for Par = N).

P

Get the reset period for a combined serial number - date/time entity if the reset period is given in months. Otherwise, see <Par> = T. <ValueToSet> is not available for this read only parameter.

R

Get or set the reset count of the serial number.

S

Get or set the start value of the serial number.

T

Get the reset start time for a combined serial number - date/time entity. The reset start time is given if no marking has been done. After a marking, the reset time is updated and SI T will give the next valid reset time. <ValueToSet> is not available for this read only parameter.

V

Get the actual value of the serial number (read only, parameter <ValueToSet> is not available for Par = V).

<ValueToSet>

[optional]

Value

Function

empty

If a second parameter is entered, the value for <Par> is written instead of read.

<int>

Available for <Par> = B: set the beat count.

Available for <Par> = I: set the increment value.

Available for <Par> = R: set the reset count.

Available for <Par> = S: set the start value.

<string>

Available for <Par> = F: set the format (see Format definition: Date/Time).

<string> <string>

Available for <Par> = F if "combine with date/time" is activated for the the serial number in the advanced dialog in SAMLight. Set the start value of the serial number to 0.

Then, the first string sets the serial number, the second string sets the date/time. Both strings need to be put in quotation marks and seperated by a space.

Example

Command

Return

Note

JN 4

0:

Select job number 4.

SN 2

0:

Select serial number 2 in this job.

SI N

0:

Get name of this serial number.

SI N "MySN"

1:

Too many parameters; read only command.

SI R 100

0:

Set the reset count to 100 beats.

SI F

0: %05.0f

Get the format of this serial number.

SI I -10

0:

Set the increment step to -10.

SI F %d%H%M

0:

Set the format string, day of the month, hour and minute

SI F "6.0f" "%Y\%m\%d"

0:

Set the format of the serial number - date/time entity.

SI F

0: 11-2018\03\28

Get the format of the serial number - date/time entity.

Notes

The ActualValue is calculated by:

ActualValue = StartValue + IncrementValue * RoundDown(( SequenceNumber Modulo ResetCount ) / BeatCount )

For the format of a serial number, fixed values are possible.

If the serial number is combined with date/time, the format of both parts can be get or set via SI F. In this case, is it necessary to put both the desired strings in quotation marks ("") separated by a space.

Save

Changes will not be saved physically on the flash until JS is executed.

When the flag for saving on changes of a job is active (SLR 2, SVG), a new format set with SI F will be saved directly after the next marking.

Restriction

Set: not allowed during marking

Errors

1: Too many parameters

3: Unknown command

5: Not allowed during marking

17: Wrong parameter type

Table 47: SI

SLR [<Flag>]

 

Get/Set parameters of the save/load/reset mode

ok  USC-2

ok  USC-3

 

Description

Get and set the parameters of the save/load/reset mode.

<Flag>

[optional]

Value: <flag>

Function

empty

Get the mode.

0x1

The serial number will be reset when job is being loaded.

0x2

The current serial number count will be stored to the flash, if it has been changed.

0x10

Clear buffer upon serial number reset (FLAGS 1).

0x200

The serial number will be reset using Digi_In_7. This will reduce the available digital inputs which can be used for the selection of a job.

This mode is only available with FM 0x10000.

Example

Command

Return

Note

SLR 2

0:

Set flag 0x2: save on job change.

SVG

0:

Save this flag in the globals.

LDG

0:

Load globals.

Notes

The flags can be combined in any way.

For each "JN x" and "M 1"  command, the job is loaded and thus all serial numbers will be reset if SLR 0x1 is active.

1 will not reset serial numbers set as global sequences.

Save

Changes are saved with SVG.

Saved changes are restored with LDG.

When not saved, changes are valid until the next reboot of the USC-Card.

Restriction

Set: not allowed during marking

Errors

1: Too many parameters

5: Not allowed during marking

17: Wrong parameter type

Table 48: SLR

SN [<Number>]

 

Get/Set one of the serial numbers of the job

ok  USC-2

ok  USC-3

 

Description

Get/Set one of the serial numbers of the job.

<Number>

[optional]

Value: <int>

Function

empty

Get the number of the currently selected serial number.

Number

[1; 64]

Set the serial number with this number.

Example

Command

Return

Note

JN 1

0:

Select job with number 1.

SN 2

0:

Select serial number with number 2 in this job.

SN 300

8:

Parameter out of range

Notes

Any information read/write will now concern this serial number.

If there is no serial number in a job, the return value is -1.

Save

N/A

Restriction

None

Errors

6: Entity not found

8: Parameter out of range

Table 49: SN