Template:X-Series/Quick Tutorial

From ZaberWiki
Jump to navigation Jump to search

Quick Tutorial

We recommend using Zaber Console to communicate with the device(s). For other software options, see the Software page. Please refer to the ASCII Protocol Manual and/or Binary Protocol Manual for more detailed information on the available commands.

Initial Set-up

[[File:{{{Device}}}_Setup_w1000.jpg|500px|link=|{{{Device}}} Setup]]


  1. Daisy chain all integrated devices together using the RS-232 "Prev" and "Next" connectors (see Daisy-Chaining Devices for more details). Next, supply power to one or more devices. Many products share power through the daisy-chain cables. The power indicator on each should light up.
  2. Download and install Zaber Console. Start Zaber Console and select the communications port the first controller is connected to. For instructions on how to find the available communication ports on your system, please refer to: Appendix A - Available Communications Ports.
  3. From the Console, issue a renumber (T:2) command to all devices (Zaber Console may prompt you to do this also). The first device in the chain (closest to the computer) will become Device 1, the next will become Device 2, and so on.



Initialization

Every time the device is powered up or reset, the positioner should be returned to the home position. This is achieved by sending the home (T:1) command to the individual unit or all units. Until this is done, most positioners will only allow motion in one direction, towards the sensor.


Using the Device

Several commonly used ASCII commands, and their Binary equivalents, are shown below. For a full list of available commands, please refer to the Command Reference section below.

Command Description
/1 1 get pos↵ (T:60) Query the current position of Device #1 Axis #1.
/1 1 move abs 10000↵ (T:20:10000) Move Device #1, Axis #1 to position 10000 increments.
/2 1 move rel -12800↵ (T:21:-12800) Move Device #2, Axis #1 in the negative direction by 12800 increments.
/1 stop↵ (T:23) Decelerate and stop ALL axes on Device 1.
An axis number of 0 or no axis number implies all axes on the device, or the device itself.
/move vel 153600↵ (T:22:153600) Move ALL devices and ALL axes in the positive direction at the speed 153600.
A device address of 0 or no device address implies all devices in the chain.

Modifying Device Settings

Here are some examples if you would like to customize particular device settings. Refer to the ASCII Settings or Command Reference section for detailed descriptions of each setting.

Command Description
/1 set maxspeed 100000↵ (T:42:100000) Set the speed of all axes on the device.
/1 get maxspeed↵ (T:53:42) Query the axes' speed.
/1 system restore↵ (T:36) Restore all the settings of Device 1 to the default.

Built-In Help

Zaber X-Series devices feature a built-in help guide, providing a quick and easy reference for all Commands and Settings that the device has. To access the help, send: /1 help (for help with Device 1). The device number must be specified in the help command. This feature is only available in the ASCII protocol.

The device will respond with a detailed description on how to access specific information about commands and replies, as shown below:

@01 0 OK IDLE WR 0
#01 0 COMMAND USAGE:
#01 0  '/stop'     stop all devices
#01 0  '/1 stop'   stop device number 1
#01 0  '/1 2 stop'   stop device number 1 axis number 2
#01 0
#01 0 Type '/help commands' for a list of all top-level commands.
#01 0 Type '/help reply' for a quick reference on reply messages.
#01 0 Visit www.zaber.com/support for complete instruction manuals.

To access help for a specific command, for example the move command, send:

/1 help move↵
@01 0 OK IDLE -- 0
#01 0 move abs {x}             Move to absolute position
#01 0 move rel {x}             Move by relative position
#01 0 move vel {x}             Move at constant velocity
#01 0 move min                 Move to minimum position
#01 0 move max                 Move to maximum position