<< Click to Display Table of Contents > 

Scanner Card Interface > SCI Functions > Control

Control
Previous pageReturn to chapter overviewNext page

Return value

Function / Property name

Parameter

long

ScContinuousMode

none

long

ScSCISetContinuousMode()

long Mode

long

ScSCIGetContinuousMode()

long *Mode

Table 9: ContinuousMode

If this property value is set to 1 the device is configured for continuous mode. This causes operations that are sent to the card e.g. using ScMoveAbs() to be executed immediately. This operation mode is more immediate than the non-continuous mode where the vectors are sent to the card and marked after execution is explicitly set to 1.


Return value

Function / Property name

Parameter

long

ScExecute

none

long

ScSCISetExecute()

long Value

long

ScSCIGetExecute()

long *Value

Table 10: Execute

If this property is set to 1 the execution of the current job starts, setting 0 stops marking operations. In non-continuous mode setting this property to 1 starts the marking of all vectors that have been sent to the card. In continuous mode this enables marking in general. Is set to 0 in non continuous mode after a job has completed.


Return value

Function / Property name

Parameter

void

ScFlush

none

long

ScSCIFlush()

void

Table 11: Flush

Flush is used in continuous mode to marks the end of a set of vectors. It blocks until all data that has been sent to the card is marked. If ScFlush() returns, marking of the current job has been finished and new data can be sent to the card.

note

In external trigger mode flush will not block and end of marking has to be polled with IsExposureEnd / Execute , depending on continuous/non continuous mode.


Return value

Function / Property name

Parameter

long

ScGetHardwareState()

long *State

long

ScSCIGetHardwareState()

long *State

Table 12: GetHardwareState

Checks the current state of the hardware. If this function returns scComHardwareStateError, marking is not possible due to a hardware error (hardware not connected, hardware could not be initialized correctly, ...)

Return value

Function / Property name

Parameter

long

ScIsExposureEnd

long *End

long

ScSCIIsExposureEnd()

long *Value

Table 13: IsExpusreEnd

This function returns 1 if the current active marking operation has finished.


Return value

Function / Property name

Parameter

long

ScGetDeviceMiscValue()

ScComStandardDeviceMiscValueConstants MiscID, double *value

long

ScSCIGetDeviceMiscValueD()

long MiscId, double *Value

Table 14: GetMiscValue

Retrieves various miscellaneous values for a device.

Return value

Function / Property name

Parameter

long

ScSetDeviceMiscValue()

ScComStandardDeviceMiscValueConstants MiscID, double value

long

ScSCISetDeviceMiscValueD()

long MiscId, double Value

Table 15: SetMiscValue

This function can be used to set various miscellaneous values for a device. Constants that enable or disable a feature take 1 or 0 as value parameter.

Constant

Description

scComStandardDeviceStyleIDMiscWobbleAmp

Size of the wobble amplitude (see DeviceEnableFlags).

scComStandardDeviceMiscEncoderKx

Set the encoder factor for marking on the fly applications in X direction

scComStandardDeviceMiscEncoderKy

Set the Y encoder factor for marking on the fly applications

scComStandardDeviceMiscMOFSimExtStartEncoder

Starts the simulation of encoder values

scComStandardDeviceMiscMOFCh0SimulateEncoder

Sets MOF simulation mode for channel 0

scComStandardDeviceMiscMOFCh0UseYChannel

Sets MOF channel 0 to use Y direction

scComStandardDeviceMiscShowServer

Shows the USC server window

scComStandardDeviceMiscSetJobSelectMode

Activates Job Select mode for external trigger

scComStandardDeviceMiscPowerRampUp

Sets the laser port ramp up value in bits/ms

scComStandardDeviceMiscPowerRampDown

Sets the laser port ramp down value in bits/ms

scComStandardDeviceStyleIDMiscPixelMapZone1

Sets the pixel map value for 0% in the current style (value between 0 and 1)

scComStandardDeviceStyleIDMiscPixelMapZone2

Sets the pixel map value for 20% in the current style (value between 0 and 1)

scComStandardDeviceStyleIDMiscPixelMapZone3

Sets the pixel map value for 40% in the current style (value between 0 and 1)

scComStandardDeviceStyleIDMiscPixelMapZone4

Sets the pixel map value for 60% in the current style (value between 0 and 1)

scComStandardDeviceStyleIDMiscPixelMapZone5

Sets the pixel map value for 80% in the current style (value between 0 and 1)

scComStandardDeviceStyleIDMiscPixelMapZone6

Sets the pixel map value for 100% in the current style (value between 0 and 1)

scComStandardDeviceMiscLaserType

Sets a special laser type

scComStandardDeviceMiscLaserTypeVersion

Sets the version of a special laser type

scComStandardDeviceStreamIDMiscSpecialLaserValue1

Sets special laser value 1 - meaning differs between laser types

scComStandardDeviceMiscOperationMode2

Sets special operation mode values

scComStandardDeviceMiscInputInhibitLaser

Designates an input port for "inhibit laser" signal. Possible values are -1 (disabled) or 0-3 for Ports 3-6.

scComStandardDeviceMiscEnableSendZCorr

Enables the usage of Z-Correction

scComStandardDeviceMiscOffset3DCorrtableLockup | scComStandardDeviceMiscIndexDistanceMirrorsMM

Sets the distance between the mirrors for z-correction calculation

This value is only applied to actual output after a ScInitControl call.

scComStandardDeviceMiscOffset3DCorrtableLockup | scComStandardDeviceMiscIndexRadiusSecondMirrorMM

Sets the distance from the second mirror to the focus for z-correction

This value is only applied to actual output after a ScInitControl call.

scComStandardDeviceMiscOffset3DCorrtableLockup | scComStandardDeviceMiscIndexLookupZNumControlPoints

Sets the number of control points for z-correction (between 3 and 32)

 

scComStandardDeviceMiscOffset3DCorrtableLockup | (number between scComStandardDeviceMiscIndexLookupZMMStart and 32)

Sets the mm value for a control point used in z-correction

This value is only applied to actual output after a ScInitControl call.

scComStandardDeviceMiscOffset3DCorrtableLockup | (number between scComStandardDeviceMiscIndexLookupZDacStart and 32)

Sets the dac value for a control point used in z-correction

This value is only applied to actual output after a ScInitControl call.

scComStandardDeviceMiscPolyDelayBreakAngle

Sets the maximum angle for poly delays - higher angles will get marking delay (see DeviceEnableFlags).

scComStandardDeviceMiscBitmapMode

Sets special bitmap modes. Currently available: scComStandardDeviceMiscBitmapModeInBitmap, only with GAP lasers

scComStandardDeviceMiscBufferThreshold

Sets the transfer threshhold. Once less than this value is available in the command buffer waiting in the output thread the buffer is flushed to the card.

scComStandardDeviceMiscCutStepSize

Sets the cut step value for subvector generation

scComStandardDeviceMiscDefocusList

Sets the Z-Focus offset for all following vectors

Table 16: MiscID parameters

The following constants are available with USC-2 only.

Constant

Description

scComStandardDeviceMiscMOFCh1SimulateEncoder

Sets MOF simulation mode for channel 1

scComStandardDeviceMiscMOFCh1UseYChannel

Sets MOF channel 1 to use Y direction

scComStandardDeviceMiscPrimaryHeadCorOffsetX

Sets correction offset x value for primary head

scComStandardDeviceMiscPrimaryHeadCorOffsetY

Sets correction offset y value for primary head

scComStandardDeviceMiscPrimaryHeadCorGainX

Sets correction gain x value for primary head

scComStandardDeviceMiscPrimaryHeadCorGainY

Sets correction gain y value for primary head

scComStandardDeviceMiscPrimaryHeadCorRotate

Sets correction rotation value for primary head in degree

scComStandardDeviceMiscPrimaryHeadCorEnable

Enables the correction on primary scan head

scComStandardDeviceMiscSetSecondaryHeadCorOffsetX

Sets correction offset x value for secondary head

scComStandardDeviceMiscSetSecondaryHeadCorOffsetY

Sets correction offset y value for secondary head

scComStandardDeviceMiscSecondaryHeadCorGainX

Sets correction gain x value for secondary head

scComStandardDeviceMiscSecondaryHeadCorGainY

Sets correction gain y value for secondary head

scComStandardDeviceMiscSecondaryHeadCorRotate

Sets correction rotation value for secondary head in degree

scComStandardDeviceMiscSecondaryHeadCorEnable

Enables the correction on secondary scan head

scComStandardDeviceMiscAddSecondaryHeadCorOffsetX

Sets an additional value for the x offset of the secondary head that will be added to the normal offset

scComStandardDeviceMiscAddSecondaryHeadCorOffsetY

Sets an additional value for the y offset of the secondary head that will be added to the normal offset

scComStandardDeviceMiscAdd2SecondaryHeadCorOffsetX

Sets a third value for the x offset of the secondary head that will be added to the normal offset

scComStandardDeviceMiscAdd2SecondaryHeadCorOffsetY

Sets a third value for the y offset of the secondary head that will be added to the normal offset

scComStandardDeviceMiscAdd2SecondaryHeadCorRotate

Sets an additional value for correction rotation value of the secondary head that will be added to the regular value

scComStandardDeviceMiscAdd2SecondaryHeadCorGainX

Sets an additional value for the correction gain x value of the secondary head that will be multiplied with the regular value

scComStandardDeviceMiscAdd2SecondaryHeadCorGainY

Sets an additional value for the correction gain y value of the secondary head that will be multiplied with the regular value

scComStandardDeviceMiscSendCorrTableValues

Sends the corr table values to the card - value specifies head

scComStandardDeviceMiscBufferTransferSize

Specifies the number of bytes that are transferred to the card in one chunk. Value can be between 5000 and 240000. Default is 19000.

scComStandardDeviceMiscExecServerCommand

Executes a command in the USC Server. See below for commands.

scComStandardDeviceMiscSetupParameterOffset

Specifies the offset for further scComStandardDeviceMiscSetupParameterValue calls. See below for valid values.

scComStandardDeviceMiscSetupParameterValue

Sets the value for the currently set parameter offset. See below for details.

Table 17: MiscID parameters USC-2 only

Possible sever commands

Description

0xXX08

Enables the USC Info mode, which allows the usage of GetUSCInfoLong. XX specifies the update interval in 10ms steps (between 1 and 100).

Table 18: Server commands

Possible parameter offsets

Description

56

Opto out port polarity. Bit positions correspond to port numbers, 1 inverts the port. Changes require a new InitControl call to take effect.

70

Opto in port polarity. Bit positions correspond to port numbers, 1 inverts the port. Changes require a new InitControl call to take effect.

71

Laser Gate/Laser A/Laser B polarity. 0x200000 = invert laser gate, 0x400000 = invert laser A, 0x800000 = invert laser B. Can be combined. Changes require a new InitControl call to take effect.

Table 19: Parameter offsets

warning

ScSCIGetDeviceMiscValueD / ScSCISetDeviceMiscValueD require at least version v_3_1_5_0148_20120724

scComStandardDeviceMiscBufferTransferSize and scComStandardDeviceMiscExecServerCommand require at least versionv_3_1_5_0198_20120919


Return value

Function / Property name

Parameter

long

ScStreamInfo()

sc_com_control_stream_info *Info

long

ScSCIStreamInfo()

long ident,long i_1,long i_2

long

ScSCIStreamInfoEx()

long ident, long i_0, long i_1, long i_2, double d_0

Table 20: StreamInfo

This function adds information to the stream that marks important points within a stream. The information is passed by using the parameter Info that expects a structure of type sc_com_control_stream_info (please see section Stream Information).

warning

ScSCIStreamInfoEx requires at least version v_4_0_5_0056_20211029

 


Return value

Function / Property name

Parameter

long

ScAxisState

none

long

ScSCISetAxisState()

long State

long

ScSCIGetAxisState()

long *State

Table 21: AxisState

The axis state determines how x and y coordinates are mapped to the actual x and y axes. It can be a combination of the following constants.

Constant

Description

scComAxisStateInvertX

Invert the orientation of the X axis output

scComAxisStateInvertY

Invert the orientation of the Y axis output

scComAxisStateFlipXY

Flip the X and Y axes for the output

Table 22:


Return value

Function / Property name

Parameter

long

ScMessageWindow

none

long

ScSCISetMessageWindow()

long hwnd

Table 23: MessageWindow

This function sets the message window. The SAM library will perform message pumping for this hwnd during long-standing operations such as flush.