next up previous contents
Next: COO Up: Detailed Description of Commands Previous: CIL   Contents

CMEAS

CMEAS is used to measure a single cube. CMEAS can (optionally) illuminate the cube with the laser, trigger the A/D conversion, calculate the amplitude, phase and distance for this cube and returns these values to the client.
Mnemonic:

Cube MEASure.
Syntax:

CMEAS $<$f, n$>$
f: This is a flag that controls how CMEAS goes about measuring the cube. If the value of f is 1, the ZY will illuminate retro with the laser, then measure the cube. If it is 2, then the ZY will assume the laser is already on the cube, and measure.
n: The cube name or number
Return values:
Success:
CMEAS 1, f, id, name, amp, ph, dist
Failure:
CMEAS 0, [$<$f, id, name$>$,] err_msg
f: The CMEAS option used to measure the cube
id: The cube id number
name: The cube name
amp: The measured return signal amplitude
ph: The measured return signal phase
dist: The distance (in mm) from the center of the ZY's beam steering mirror to the cube.
err_msg: Should the command fail, this value will be an error message string, explaining the cause of failure. Failure modes include:
  • The wrong number of parameters were issued to CMEAS.
  • A non-numeric value was given for parameter f.
  • The value for parameter f is not 1 or 2.
  • The ZY was not initialized.
  • The cube name or number was not found in the ZY's cube collection.
  • The data in the ZY's DMA buffer does not belong to this cube.
Remarks:

This function is useful to conveniently measure just one cube. If a list of cubes need to be measured, then the SCN command would be a better choice. If option flag f is set to `1', CMEAS will first aim the laser at the cube to be measured and wait for the servo system to settle before taking data. Otherwise, this step is skipped. The ZY then takes data, calculates the results, and finally returns the results to the client. When using option `2', it is up to the client to ensure that the laser is pointed at some meaningful target. For option `1' to work, the servo amplifiers must be enabled, the servo system homed, and the front panel `Auto/Manual' switch must be in the `Auto' position. For both option `1' and `2', the ZY must have been initialized, and the specified cube must exist in the ZY's cube collection.
Example:
     send: CMEAS 1, ZBG     ; Aim laser to cube `ZBG' and measure
  receive: CMEAS 1, 1, 35, ZBG, 5.153, 2.4524965, 101003.545

     send: CMEAS 2, ZBG     ; Assume laser is already at `ZBG' and measure
  receive: CMEAS 1, 2, 35, ZBG, 5.153, 2.4524965, 101003.545
See also:

AMP, CIL, COO, DST, INI, PHI

next up previous contents
Next: COO Up: Detailed Description of Commands Previous: CIL   Contents
Ramon E. Creager 2002-03-11