User Tools

Site Tools


commands:customb

Command:CUSTOMB (CCB)

Not implemented in Tiger except for programmable logic card, for that see Tiger Programmable Logic Card (TGPLC) documentation and ignore this page.

Shortcut CCB
Format CCB X=# Y=# Z=[1 to 10] F=# T=#
Units None
Remembered Using SS Z
Firmware Required PLANAR CORRECTION

Planar correction requires the PLANAR CORRECTION firmware module.

X: Returns the X coordinate of the current index with CCB X?. Sets the X coordinate with CCB X=#.
If CCB T=1, the points are x1, y1, z1… for CCB T=2 the points are x2, y2, z2, etc.

Y: Returns the Y coordinate of the current index with CCB Y?. Sets the Y coordinate with CCB Y=#.

F: Returns the Z coordinate of the current index with CCB F?. Sets the Z coordinate with CCB F=#.

T: Returns the current index with CCB T? Sets the current index that the the X, Y, and F axes operate on with CCB T=#. The value of T can be 1, 2, or 3.

Z: planar correction control

CCB Z=1 - Set the current position to point x1, y1, z1.
CCB Z=2 - Set the current position to point x2, y2, z2.
CCB Z=3 - Set the current position to point x3, y3, z3.

Set the current xyz position to the values x1, y1, z1 … x3, y3, z3 respectively.

CCB Z=4 - Calculate coefficients for planar correction function. Enable planar correction.
CCB Z=5 - Disable planar correction.

CCB Z=6 - Displays actual planar corrected current Z position as raw encoder counts.

Note: WHERE Z displays the target position of Z based on the most recently sent MOVE, MOVEREL, or HERE command.

CCB Z=7 - Re-initialize to zero all planar correction variables including x1, y1, z1 … x3, y3, z3 and planar correction function coefficients. Disable planar correction.

CCB Z=8 - Return the current planar correction state, Z if enabled, G if disabled. MS-2000 firmware v9.54 required

CCB Z=9 - Return the limit check status character. The limit status does not show up on the LCD.

The planar correction index will not move past the stage limits set by the SU and SL commands.

CharacterDescription
N Not at either limit
U At the upper limit
L At the lower limit

CCB Z=10 - Displays actual planar corrected current Z position in ASI units (1/10th of a micron). MS-2000 firmware v9.57 required

Examples

Enable planar correction, check z position, and check if planar correction is enabled.

CCB Z=4
:A
CCB Z=6 
:A Z=12345
CCB Z=8
:A Z

Send the planar correction points through serial commands and enable planar correction.

CCB T=1
:A
CCB X=0 Y=0 F=0
:A
CCB T=2
:A
CCB X=10000 Y=0 F=1000
:A
CCB T=3
:A
CCB X=10000 Y=10000 F=1000
:A
CCB Z=4
:A
Version History
Version
MS TG Description
9.57 - Set planar correction points through serial commands
9.57 - CCB Z=10 displays actual planar position in ASI units
9.54 - CCB Z=8 displays the planar correction state
Address: 29391 W Enid Rd. Eugene, OR 97402, USA | Phone: +1 (541) 461-8181
commands/customb.txt · Last modified: 2026/04/03 19:39 by brandon