T-Series/Compilation/Commands for motion products
Detailed Command Reference
This command reference applies only to firmware version 5.00 and up to the most recent version. The version of firmware installed on any Zaber T-Series device can be determined by issuing command #51. A three-digit number will be returned. Assume 2 decimal places (ex a reply of 293 indicates firmware version 2.93). For earlier versions of firmware, please consult the appropriate PDF user's manual:
Due to the addition of new features, newer versions of firmware may not be 100% backward compatible. You may wish to read the document Firmware History and Migration which outlines the changes that have taken place from one firmware version to the next and indicates what options are available if you wish to upgrade or downgrade the firmware on your devices.
Reset - Cmd 0
| Instruction Name | Reset |
|---|---|
| Applies to | All Zaber devices |
| Firmware Version | 5.00 and up |
| Command Number | 0 |
| Command Type | Command |
| Command Data | Ignored |
| Reply Data | None |
| Safe to retry? | Yes |
| Returns Current Position? | No |
| Persistence | n/a |
| Summary | Sets the device to its power-up condition. |
This has the same effect as unplugging and restarting the device.
Special Note
The position stored in the device prior to this command will be lost, so you must save it and reload it if it is important. All non-volatile settings (i.e. Device Number, Target Velocity, etc.) are saved and are not affected by reset or power-down.
Home - Cmd 1
| Instruction Name | Home |
|---|---|
| Applies to | All motorized devices |
| Firmware Version | 5.00 and up |
| Command Number | 1 |
| Command Type | Command |
| Command Data | Ignored |
| Reply Data | Final Position |
| Safe to retry? | Yes |
| Returns Current Position? | Yes |
| Persistence | n/a |
| Summary | Moves to the home position and resets the device's internal position. |
Upon receiving this instruction, the device will retract until its internal home sensor is triggered. It will then move forward several steps to avoid accidentally re-triggering the home sensor during use. Its internal position is then reset (to 0 for most devices). If a home offset has been specified with the Set Home Offset (cmd 47) instruction, the device will move forward for the specific offset, then reset the internal position.
- T-Series devices - Firmware 5.01 - 5.20
The device will attempt to home for an extended amount of time.
- T-Series devices - Firmware 5.21 and up
The home command aborts with an error if the device has traveled twice the Maximum Position setting without triggering the home sensor. This indicates that the device could possibly be stalling or slipping.
- A-Series devices - Firmware 6.xx
The device will attempt to home for an extended amount of time. If Closed-Loop Mode is enabled for an encoder-embedded device, the device will report any slip or stall incident.
Renumber - Cmd 2
| Instruction Name | Renumber |
|---|---|
| Applies to | All Zaber devices |
| Firmware Version | 5.00 and up |
| Command Number | 2 |
| Command Type | Command |
| Command Data | New Number |
| Reply Data | Device Id |
| Safe to retry? | Yes |
| Returns Current Position? | No |
| Persistence | Non-Volatile |
| Summary | Assigns new numbers to all the devices in the order in which they are connected. |
This command is usually sent to device number 0. When it is, the command data is ignored and all devices will renumber. The device closest to the computer becomes device number 1. The next device becomes number 2 and so on.
If sent to a device number other than 0, then that device will reassign itself the device number in the command data.
Note: Renumbering takes about 1/2 a second during which time the computer must not send any further data. The device number is stored in non-volatile memory so you can renumber once and not worry about issuing the renumber instruction again after each power-up.
Store Current Position - Cmd 16
| Instruction Name | Store Current Position |
|---|---|
| Applies to | All motorized devices |
| Firmware Version | 5.04 and up |
| Command Number | 16 |
| Command Type | Command |
| Command Data | Address |
| Reply Data | Address |
| Safe to retry? | Yes |
| Returns Current Position? | No |
| Persistence | Non-Volatile |
| Summary | Saves the current absolute position of the device. |
Valid Address values are 0 through 15 specifying one of 16 possible registers in which to store the position. This command can only be executed when the device has been homed. This command is used in conjunction with the Return Stored Position (Command #17) and Move To Stored Position (Command #18) instructions. The positions stored in the position registers are non-volatile and will persist after power-down or reset. All position registers are cleared by the Restore Settings (Command #36) instruction.
Return Stored Position - Cmd 17
| Instruction Name | Return Stored Position |
|---|---|
| Applies to | All motorized devices |
| Firmware Version | 5.04 and up |
| Command Number | 17 |
| Command Type | Command |
| Command Data | Address |
| Reply Data | Stored Position |
| Safe to retry? | Yes |
| Returns Current Position? | No |
| Persistence | n/a |
| Summary | Returns the position stored in one of the 16 position registers for the device. |
Valid command data values are 0 through 15, specifying one of 16 possible registers from which to retrieve the position. This command is used in conjunction with the Store Current Position (#16) and Move To Stored Position (#18) commands. Positions stored in the position registers are non-volatile and will persist after power-down or reset. All position registers are cleared by the Restore Settings (#36) command.
Move To Stored Position - Cmd 18
| Instruction Name | Move To Stored Position |
|---|---|
| Applies to | All motorized devices |
| Firmware Version | 5.04 and up |
| Command Number | 18 |
| Command Type | Command |
| Command Data | Address |
| Reply Data | Final Position |
| Safe to retry? | Yes |
| Returns Current Position? | Yes |
| Persistence | n/a |
| Summary | Moves the device to the stored position specified by the Command Data. |
Valid address values are 0 through 15, specifying one of 16 possible positions. This command is used in conjunction with the Store Current Position (#16) and Return Stored Position (#17) commands. This command does not send a response until the move has finished. All move commands are pre-emptive. If a new move command is issued before the previous move command is finished, the device will immediately move to the new position.
The target speed and acceleration during a move absolute instruction can be specified using Set Target Speed (Cmd 42) and Set Acceleration (Cmd 43) respectively.
This command may pre-empt, or be pre-empted by Move to Stored Position (Cmd 18), Move Absolute (Cmd 20), Move Relative (Cmd 21), Move at Constant Speed (Cmd 22) and Stop (Cmd 23).
Move Absolute - Cmd 20
| Instruction Name | Move Absolute |
|---|---|
| Applies to | All motorized devices |
| Firmware Version | 5.00 and up |
| Command Number | 20 |
| Command Type | Command |
| Command Data | Absolute Position |
| Reply Data | Final position |
| Safe to retry? | Yes |
| Returns Current Position? | Yes |
| Persistence | n/a |
| Summary | Moves the device to the position specified in the Command Data in microsteps. |
The device begins to move immediately, and sends a response when the move has finished.
The target speed and acceleration during a move absolute instruction can be specified using Set Target Speed (Cmd 42) and Set Acceleration (Cmd 43) respectively.
All move commands are pre-emptive. If a new move command is issued before the previous move command is finished, the device will immediately move to the new position. This command may pre-empt, or be pre-empted by Move to Stored Position (Cmd 18), Move Absolute (Cmd 20), Move Relative (Cmd 21), Move at Constant Speed (Cmd 22) and Stop (Cmd 23).
- T-Series Motorized Devices
The position must be between 0 and Maximum Position (specified by Set Maximum Position (cmd 44)), or an error code will be returned.
- A-Series Motorized Devices
The position must be between Minimum and Maximum Position (specified by Set Minimum Position (Cmd 106) and Set Maximum Position (cmd 44)), or an error code will be returned.
In addition to Set Acceleration (Cmd 43), A-Series devices also support Set Acceleration Only (Cmd 113) and Set Deceleration Only (Cmd 114).
Move Relative - Cmd 21
| Instruction Name | Move Relative |
|---|---|
| Applies to | All motorized devices |
| Firmware Version | 5.00 and up |
| Command Number | 21 |
| Command Type | Command |
| Command Data | Relative Position |
| Reply Data | Final Position |
| Safe to retry? | No |
| Returns Current Position? | Yes |
| Persistence | n/a |
| Summary | Moves the device by the positive or negative number of microsteps specified in the Command Data. |
The device moves to a position given by its current position plus the value specified in the command data. The relative move command data in microsteps can be positive or negative. The device begins to move immediately, and sends a response when the move has finished.
The target speed and acceleration during a move absolute instruction can be specified using Set Target Speed (Cmd 42) and Set Acceleration (Cmd 43) respectively.
All move commands are pre-emptive. If a new move command is issued before the previous move command is finished, the device will immediately move to the new position. If a Move Relative command is issued while the device is currently moving due to a previous command, the device will immediately set a new target position equal to the current position (at the instant the command was received) plus the specified relative position.
This command may pre-empt, or be pre-empted by Move to Stored Position (Cmd 18), Move Absolute (Cmd 20), Move Relative (Cmd 21), Move at Constant Speed (Cmd 22) and Stop (Cmd 23).
- T-Series Motorized Devices
The final position must be between 0 and Maximum Position (specified by Set Maximum Position (cmd 44)), or an error code will be returned.
- A-Series Motorized Devices
The final position must be between Minimum and Maximum Position (specified by Set Minimum Position (Cmd 106) and Set Maximum Position (cmd 44)), or an error code will be returned.
In addition to Set Acceleration (Cmd 43), A-Series devices also support Set Acceleration Only (Cmd 113) and Set Deceleration Only (Cmd 114).
Move At Constant Speed - Cmd 22
| Instruction Name | Move At Constant Speed |
|---|---|
| Applies to | All motorized devices |
| Firmware Version | 5.00 and up |
| Command Number | 22 |
| Command Type | Command |
| Command Data | Speed |
| Reply Data | Speed |
| Safe to retry? | Yes |
| Returns Current Position? | No |
| Persistence | n/a |
| Summary | Moves the device at a constant speed based on the value specified in the Command Data. |
This instruction specifies a direction and a speed to move, rather than a target position. When this instruction is issued the device will accelerate (at a rate determined by Set Acceleration (Cmd 43)) to the speed specified by the instruction data. The device will continue moving at this speed until a limit is reached or a pre-empting instruction is issued. Negative speeds cause retraction while positive speeds cause extension. Unlike the other movement commands, this command sends a response immediately without waiting for the move to finish.
The device may be set to return its position continuously during the move using Set Device Mode (Cmd 40) bit 4.
If the device reaches its end of travel, the device stops and the new position is returned via reply-only command Limit Active (Cmd 9).
This command may pre-empt, or be pre-empted by Move to Stored Position (Cmd 18), Move Absolute (Cmd 20), Move Relative (Cmd 21), Move at Constant Speed (Cmd 22) and Stop (Cmd 23).
For a spreadsheet that can be used to calculate speed setting values for any product see http://www.zaber.com/documents/ZaberSpeedSetting.xls. Alternatively you may use the formulas below.
The conversion between device speed and command data value depends on the device firmware version:
- T-Series devices - Firmware 5.xx
Actual Speed
- = Data * 9.375 * M mm/s or deg/s
- = Data * 9.375 microsteps/s
- = Data * 9.375 / R steps/s
- = Data * 9.375 / (R x S) * 60 revolutions/min Motor rpm
- = Data * 9.375 * L / (R x S) mm/s Linear devices only
where:
- Data is the value of the command data
- R (microsteps/step) is the microstep resolution (command 37)
- S (steps/revolution) is the number of steps per motor revolution
- M (mm or deg) is the microstep size
- L (mm or deg) is the distance of linear motion per motor revolution
Maximum data value is 512*R-1. Note that the maximum speed possible is independent of the resolution. In Firmware 5.21 and 5.22, a value of 0 is not allowed. In all other versions, target speed of 0 will cause Move Absolute/Relative and Move to Stored Position commands to return an error.
Refer to product specifications for the distance corresponding to a single microstep or revolution.
For example, if a motor has 48 steps per revolution (S = 48), used with default resolution (R = 64), and Data is 2922, then the motor will move at a speed of approximately 535 revolutions per minute.
- A-Series devices - Firmware 6.xx
Actual Speed
- = Data / 1.6384 * M mm/s or deg/s
- = Data / 1.6384 microsteps/s
- = Data / 1.6384 / R steps/s
- = Data / 1.6384 / (R x S) * 60 revolutions/min Motor rpm
- = Data / 1.6384 * L / (R x S) mm/s Linear devices only
where:
- Data is the value of the command data
- R (microsteps/step) is the microstep resolution (command 37)
- S (steps/revolution) is the number of steps per motor revolution
- M (mm or deg) is the microstep size
- L (mm or deg) is the distance of linear motion per motor revolution
Valid data values are from 1 to (16384*R). Note that the maximum speed possible is independent of the resolution.
Refer to product specifications for the distance corresponding to a single microstep or revolution.
For example, if a motor has 200 steps per revolution (S = 200), used with default resolution (R = 64), and Data is 153600, then the motor will move at a speed of 720 revolutions per minute.
Stop - Cmd 23
| Instruction Name | Stop |
|---|---|
| Applies to | All motorized devices |
| Firmware Version | 5.00 and up |
| Command Number | 23 |
| Command Type | Command |
| Command Data | Ignored |
| Reply Data | Final Position |
| Safe to retry? | Yes |
| Returns Current Position? | Yes |
| Persistence | n/a |
| Summary | Stops the device from moving by preempting any move instruction. |
This instruction can be used to pre-empt any move instruction. The device will decelerate to a stop. The reply data is the absolute position after stopping.
This command may pre-empt, or be pre-empted by Move to Stored Position (Cmd 18), Move Absolute (Cmd 20), Move Relative (Cmd 21), Move at Constant Speed (Cmd 22) and Stop (Cmd 23).
- T-Series devices - Firmware 5.xx
The device will decelerate at a rate specified by Set Acceleration (Cmd 43).
- A-Series devices - Firmware 6.xx
Rate of deceleration can be specified by either Set Acceleration (Cmd 43) (sets both Acceleration and Deceleration) or Set Deceleration Only (Cmd 114) (sets Deceleration only).
Depressing the manual control knob also gives the same effect as this command.
If another Stop is issued during deceleration (either by this command or depressing the manual control knob), the device will instantly stop.
Read Or Write Memory - Cmd 35
| Instruction Name | Read Or Write Memory |
|---|---|
| Applies to | T-Series motorized devices |
| Firmware Version | 5.xx |
| Command Number | 35 |
| Command Type | Command |
| Command Data | Data |
| Reply Data | Data |
| Safe to retry? | Yes |
| Returns Current Position? | No |
| Persistence | Non-Volatile |
| Summary | Reads or writes a byte of non-volatile memory. |
128 bytes of memory are available for user data. For example, the user may want to save some custom data such as a serial number, a name string, or data that uniquely identifies a particular device. Data written is not cleared by power down or reset. The most significant bit of byte 3 specifies whether the instruction is a read (0) or a write (1). The least significant 7 bits of byte 3 specify the address to read/write (0 to 127). Byte 4 specifies the value to be written. Bytes 5 and 6 are ignored.
These settings are stored in non-volatile memory and will persist after power-down or reset.
Restore Settings - Cmd 36
| Instruction Name | Restore Settings |
|---|---|
| Applies to | All Zaber devices |
| Firmware Version | 5.00 and up |
| Command Number | 36 |
| Command Type | Command |
| Command Data | Peripheral Id |
| Reply Data | Peripheral Id |
| Safe to retry? | Yes |
| Returns Current Position? | No |
| Persistence | Non-Volatile |
| Summary | Restores the device settings to the factory defaults. |
This command should be issued with a Peripheral Id of 0 to return the device to factory default settings. This instruction is very useful for troubleshooting. If the device does not appear to function properly, it may be because some of the settings have been changed. This instruction will restore the settings to default values. For a table of default settings, see Appendix A. All settings affected by this instruction are stored in non-volatile memory and will persist after power-down or reset.
This command behaves differently depending on device and Firmware version:
- T-Series or A-Series devices that are not standalone controllers
The device will only accept Restore Settings command with Data 0.
The T-MCA motor controller is designed to control many different motors and actuators. The Restore Settings instruction should usually be issued with a Peripheral Id corresponding to the specific motor or motorized device connected. This will set the T-MCA motor controller to the factory default settings for the motorized peripheral in question. For example, if a T-MCA device is connected to an NA11B30, the user can issue the Restore Settings instruction with a Peripheral Id of 31130. This will automatically set all non-volatile parameters (range, mode, running and hold currents, etc) to values that will work with the NA11B30.
For a list of Peripheral Ids and their corresponding settings, see http://www.zaber.com/support/?tab=Peripheral%20ids.
If the Restore Settings instruction is issued with data of 0 rather than one of the above Peripheral Ids, then the T-MCA device will be set to 15% maximum running current and no hold current. This is a relatively safe setting that prevents damage to any motor connected to the T-MCA, but as a result, you may not be able to run a motor with the T-MCA set to this condition. You can either issue the Restore Settings instruction with one of the Peripheral Ids listed above, or you can adjust each relevant setting independently. Note that the default settings for a given Peripheral Id are just a starting point to get your device working. The settings should still be adjusted individually for optimum performance in your application.
- A-Series controllers - Firmware 6.xx (A-MCA)
If command data of 0 is given, this command restores device to default settings for the assigned Peripheral Id. If a Peripheral ID is given, this command assigns the given Peripheral Id to the controller and loads the default settings for the assigned Peripheral Id. To load safe-mode settings, use Set Peripheral Id (Cmd 66) with command data 0 instead.
Set Microstep Resolution - Cmd 37
| Instruction Name | Set Microstep Resolution |
|---|---|
| Applies to | All motorized devices |
| Firmware Version | 5.00 and up |
| Command Number | 37 |
| Command Type | Setting |
| Command Data | Microsteps |
| Reply Data | Microsteps |
| Safe to retry? | Yes |
| Returns Current Position? | No |
| Persistence | Non-Volatile |
| Summary | Changes the number of microsteps per step. |
This command sets the microstep resolution of a device.
This setting is stored in non-volatile memory and will persist after power-down or reset. Use Restore Settings (Cmd 36) to restore all non-volatile settings to factory default.
The valid values and behaviour of this command depends on the device firmware version:
- T-Series devices - Firmware 5.xx
The default on most devices is 64. Available microstep resolutions are:
- 1, 2, 4, 8, 16, 32, 64, 128
All position data sent to or received from T-Series products is in units of microsteps. Note that when you change the microstep resolution, other position related settings are scaled automatically from current values to adjust for the new microstep size. The table below gives an example showing how other settings are affected when the microstep resolution is changed from 128 to 64:
| Setting | Before | After |
| Target Speed * | 2922 | 1461 |
| Maximum Travel Range * | 280000 | 140000 |
| Current Position | 10501 ** | 5250 ** |
| Maximum Relative Move * | 20000 | 10000 |
| Home Offset * | 1000 | 500 |
| Acceleration * | 100 | 50 |
* The settings for these commands are saved in non-volatile memory.
** Note that if a number is divided by two, it is rounded down to the nearest whole number. The only exception to this is if acceleration would become 0 (because 0 for acceleration indicates infinite acceleration). If acceleration would become 0, it will instead be set to 1 which is the lowest acceleration possible.
- A-Series devices - Firmware 6.xx
The default value on most devices is 64. Available microstep resolutions are:
- 1, 2, 4, 8, 16, 32, 64, 128, 256
- 3, 6, 12, 24, 48, 96, 192
- 5, 10, 20, 40, 80, 160
- 9, 18, 36, 72, 144
- 15, 30, 60, 120, 240
- 25, 50, 100, 200
- 27, 54, 108, 216
- 45, 90, 180
All position related settings are in units of microsteps. When you change the microstep resolution, microstep related settings are automatically restored to their default values and then adjusted to match the scale of the new resolution.
If you have previously changed any settings, you will need to reconfigure them after setting a new microstep resolution. The device should be homed after assigning a new microstep resolution.
The following example shows affected settings when resolution is changed from 64 to 32:
| Setting | Default | Before | After |
| Microstep Resolution * | 64 | 64 | 32 |
| Current Position | n/a | 10501 ** | 5250 ** |
| Target Speed * | 153600 | ignored | 76800 |
| Knob Velocity Scale * | 153600 | ignored | 76800 |
| Home Speed * | 50000 | ignored | 25000 |
| Maximum Position * | 280000 | ignored | 140000 |
| Minimum Position * | 0 | ignored | 0 |
| Home Offset * | 0 | ignored | 0 |
| Acceleration * | 205 ** | ignored | 102 ** |
| Deceleration * | 205 ** | ignored | 102 ** |
* The settings for these commands are saved in non-volatile memory.
** Note that if a number is divided by two, it is rounded down to the nearest whole number.
Set Running Current - Cmd 38
| Instruction Name | Set Running Current |
|---|---|
| Applies to | All motorized devices |
| Firmware Version | 5.00 and up |
| Command Number | 38 |
| Command Type | Setting |
| Command Data | Value |
| Reply Data | Value |
| Safe to retry? | Yes |
| Returns Current Position? | No |
| Persistence | Non-Volatile |
| Summary | Sets the desired current to be used when the device is moving. |
If your application does not require high torque, it is best to decrease the driving current to reduce power consumption, vibration, and motor heating. Trial and error should suggest an appropriate setting. If higher torque is required, it is generally safe to overdrive motors as long as they are not operated continuously. Motor temperature is typically the best indication of the degree to which overdriving can be employed. If the motor gets too hot to touch (>75°C), you should reduce the running current.
Zaber devices use two different techniques for controlling current: percentage and fractional. The easiest way to tell is to look at the device's power jack: a three-prong rectangular jack means that it uses the percentage technique, and a round jack means that it uses the fractional technique. Each section below lists the devices that use the technique and describes how the current is controlled. If you really want to be certain which technique is used, you can send the command with data value 1 or 127. If 1 returns an error, then the device is using the fractional technique. If 127 returns an error, then the device is using the percentage technique.
Percentage: This technique is used by T-LSQ, T-LST, T-MCA, and A-series motorized devices.
The current is related to the data by the formula:
- Current = CurrentCapacity * CommandData / 100
The Command Data can be a value from 0 (no current) to 100 (max). CurrentCapacity is the hardware's maximum capability of output current.
To prevent damage, some devices limit the maximum output current to a lower value. In that case the valid range is 0 - Limit. Current limits are listed under the device specifications.
Some devices limit the voltage rather than the current. In this case the same formula can be used by replacing Current and CurrentCapacity with Voltage and PowerSupplyVoltage.
For example, the T-MCA has a CurrentCapacity of 2.5A. To apply a current of 0.5A to a motor, reverse the formula:
CommandData
- = Current / CurrentCapacity * 100
- = 0.5A / 2.5A * 100
- = 20
Therefore CommandData = 20.
Fractional: This technique is used by all T-series motorized devices, with the exception of T-LSQ, T-LST, T-MCA.
The current is related to the data by the formula:
- Current = CurrentCapacity * 10 / CommandData
The range of accepted values is 0 (no current), 10 (max) - 127 (min). CurrentCapacity is the hardware's maximum capability of output current.
To prevent damage, some devices limit the maximum output current to a lower value. In that case the valid range is 0, Limit - 127. Current limits are listed under the device specifications.
Some devices limit the voltage rather than the current. In this case the same formula can be used by replacing Current and CurrentCapacity with Voltage and PowerSupplyVoltage.
For example, Suppose you connect a stepper motor rated for 420mA per phase to a T-CD2500. Reversing the equation above and using 420mA as Current gives:
CommandData
- = 10 * CurrentCapacity / Current
- = 10 * 2500mA / 420mA
- = 59.5 (round to 60)
Therefore CommandData = 60.
Set Hold Current - Cmd 39
| Instruction Name | Set Hold Current |
|---|---|
| Applies to | All motorized devices |
| Firmware Version | 5.00 and up |
| Command Number | 39 |
| Command Type | Setting |
| Command Data | Value |
| Reply Data | Value |
| Safe to retry? | Yes |
| Returns Current Position? | No |
| Persistence | Non-Volatile |
| Summary | Sets the desired current to be used when the device is holding its position. |
It is typical to run stepper motors at their rated current only during moves (for highest torque) and reduce the current when idle just to hold the position.
Typically the hold current can be set to around 25 - 50% of the running current. In some applications, the friction of the drive system alone is sufficient to hold the microstep position of the motor, and the hold current can be turned off completely. The hold current can be turned off by issuing the "Set Hold Current" instruction with data of 0.
When the device is moving, it applies running current to the motor. When the device stops moving, running current is applied for an additional 0.1 second before hold current is applied.
The formula for the hold current works the same way as for running current. Zaber devices use two different techniques for controlling current: percentage and fractional. The easiest way to tell is to look at the device's power jack: a three-prong rectangular jack means that it uses the percentage technique, and a round jack means that it uses the fractional technique. Each section below lists the devices that use the technique and describes how the current is controlled. If you really want to be certain which technique is used, you can send the command with data value 1 or 127. If 1 returns an error, then the device is using the fractional technique. If 127 returns an error, then the device is using the percentage technique.
Percentage: This technique is used by T-LSQ, T-LST, T-MCA, and A-series motorized devices.
The current is related to the data by the formula:
- Current = CurrentCapacity * CommandData / 100
The Command Data can be a value from 0 (no current) to 100 (max). CurrentCapacity is the hardware's maximum capability of output current.
To prevent damage, some devices limit the maximum output current to a lower value. In that case the valid range is 0 - Limit. Current limits are listed under the device specifications.
Some devices limit the voltage rather than the current. In this case the same formula can be used by replacing Current and CurrentCapacity with Voltage and PowerSupplyVoltage.
For example, the T-MCA has a CurrentCapacity of 2.5A. To apply a current of 0.5A to a motor, reverse the formula:
CommandData
- = Current / CurrentCapacity * 100
- = 0.5A / 2.5A * 100
- = 20
Therefore CommandData = 20.
Fractional: This technique is used by all T-series motorized devices, with the exception of T-LSQ, T-LST, T-MCA.
The current is related to the data by the formula:
- Current = CurrentCapacity * 10 / CommandData
The range of accepted values is 0 (no current), 10 (max) - 127 (min). CurrentCapacity is the hardware's maximum capability of output current.
To prevent damage, some devices limit the maximum output current to a lower value. In that case the valid range is 0, Limit - 127. Current limits are listed under the device specifications.
Some devices limit the voltage rather than the current. In this case the same formula can be used by replacing Current and CurrentCapacity with Voltage and PowerSupplyVoltage.
For example, Suppose you connect a stepper motor rated for 420mA per phase to a T-CD2500. Reversing the equation above and using 420mA as Current gives:
CommandData
- = 10 * CurrentCapacity / Current
- = 10 * 2500mA / 420mA
- = 59.5 (round to 60)
Therefore CommandData = 60.
Set Device Mode - Cmd 40
| Instruction Name | Set Device Mode |
|---|---|
| Applies to | All Zaber devices |
| Firmware Version | 5.04 and up |
| Command Number | 40 |
| Command Type | Setting |
| Command Data | Mode |
| Reply Data | Mode |
| Safe to retry? | Yes |
| Returns Current Position? | No |
| Persistence | Non-Volatile |
| Summary | Sets the Mode for the given device. |
This command allows setting several options, each controlled by a single bit within the command data. To determine what decimal value to use, the command data may be considered as a single 32-bit binary value. The least significant bit is bit_0, the next is bit_1, the next is bit_2, and so on up to the most significant bit_31. Each bit may have a value of either 1 or 0. Any unused or reserved bits should be left as 0.
The corresponding decimal representation of this 32-bit data is given by:
- Decimal value = (bit_0 * 1) + (bit_1 * 2) + … + (bit_n * 2^n) + … + (bit_31 * 2^31)
For example, suppose you want all mode bits to be 0 except for bit_3 (disable knob) and bit_6 (enable message Ids). The Set Device Mode instruction should be sent with data calculated as follows:
- Command Data
- = 2^3 + 2^6
- = 8 + 64
- = 72
Note that each instance of the Set Device Mode command overwrites ALL previous mode bits. Repeated commands do not have a cumulative effect. For example, suppose you send a Set Device Mode command with data of 8 to disable the knob. If you then send another Set Device Mode command with data of 64 to enable message IDs, you will re-enable the knob since bit_3 in the 2nd instruction is 0.
Most devices have a default mode setting of 0 (all bits are 0). Not all options are available in all Zaber devices. To see the list of available options for a product, refer to the Set Device Mode description in the specific product manual.
| Bit_n | 2^n | Description
|
| bit_0 | 1 | Disable Auto-reply A value of 1 disables ALL replies except those to “return” commands). The default value is 0 on all devices. |
| bit_1 | 2 | Enable Anti-backlash Routine A value of 1 enables anti-backlash. On negative moves (retracting), the device will overshoot the desired position by 640 microsteps (assuming 64 microsteps/step), reverse direction and approach the requested position from below. On positive moves (extending), the device behaves normally. Care must be taken not to crash the moving payload into a fixed object due to the 640 microsteps overshoot on negative moves. The default value is 0 on all devices. See note on anti-backlash and anti-sticktion below. * |
| bit_2 | 4 | Enable Anti-sticktion Routine A value of 1 enables the anti-sticktion routine. On moves less than 640 microsteps (assuming 64 microsteps/step), the device will first retract to a position 640 microsteps less than the requested position and approach the requested position from below. Care must be taken not to crash the moving payload into a fixed object due to the 640 microsteps negative move. The default value is 0 on all devices. See section on anti-backlash and anti-sticktion below this table. * |
| bit_3 | 8 | Disable Knob A value of 1 disables the knob preventing manual adjustment of the device. The default value is 0 on all devices. |
| bit_4 | 16 | Enable Move Tracking A value of 1 enables the Move Tracking response during move commands. The device will return its position periodically when a move command is executed. The Disable Auto-Reply option above takes precedence over this option. The default value is 0 on all devices. Before firmware version 5.14, only Move at Constant Speed commands could generate tracking responses, now all move commands can. |
| bit_5 | 32 | Disable Manual Move Tracking A value of 1 disables the Manual Move Tracking response during manual moves. The Disable Auto-Reply option above takes precedence over this option. The default value is 0 on all devices. |
| bit_6 | 64 | Enable Message Ids A value of 1 enables Message Ids. In this mode of communication, only bytes 3 through 5 are used for data. Byte 6 is used as an Id byte that the user can set to any value they wish. It will be returned unchanged in the reply. Message Ids allow the users application to monitor communication packets individually to implement error detection and recovery. The default value is 0 on all devices. Prior to firmware version 5.06, this feature was called "Virtual Channels Mode" and did not behave reliably. We do not recommend enabling this mode of communications unless you have firmware version 5.06 or later. |
| bit_7 | 128 | Home Status This bit is set to 0 automatically on power-up or reset. It is set automatically when the device is homed or when the position is set using command #45. It can be used to detect if a device has a valid position reference. It can also be set or cleared by the user. |
| bit_8 | 256 | Disable Auto-Home A value of 1 disables auto-home checking. Checking for trigger of home sensor is only done when home command is issued. This allows rotational devices to move multiple revolutions without re-triggering the home sensor. |
| bit_9 | 512 | Reverse Potentiometer A value of 1 reverses the direction of the travel when the potentiometer is used to control the device. This mode bit was introduced in firmware version 5.06. Prior to that it was not used. |
| bit_10 | 1,024 | Reserved |
| bit_11 | 2,048 | Enable Circular Phase Microstepping Square phase microstepping is employed by default. A value of 1 enables circular phase microstepping mode. The differences are: Circular Phase:
Square Phase:
|
| bit_12 | 4,096 | Set Home Switch Logic The T-MCA series can accept a variety of motors and home sensors. Some devices have active high home limit switches. On these devices, this bit must be changed from the default setting in order for the home sensor to function correctly. A value of 1 must be set for these devices for the device to home properly. Damage to the home sensor or actuator may result if this bit is set improperly. |
| bit_13 | 8,192 | Reserved |
| bit_14 | 16,384 | Disable Power LED A value of 1 turns off the power LED. It will still blink briefly, immediately after powerup. |
| bit_15 | 32,768 | Disable Serial LED A value of 1 turns off the serial LED. |
*Anti-backlash and Anti-sticktion routines are designed to compensate for backlash and sticktion. The solution to backlash is to always approach a position from the same direction. The solution to sticktion is to move the device far enough away from the final position to break free of sticktion before attempting the final move. The operation of the two features are dependent on each other, and the interaction of enabling one or both of the features is described in the diagram to the right.
For each setting scenario, the starting position is denoted by the solid vertical line and the final position is denoted by the dotted vertical line. There are four possible moves for each scenario: long move positive, long move negative, short move positive and short move negative. The arrows show the path that would be traversed for each scenario.
Set Home Speed - Cmd 41
| Instruction Name | Set Home Speed |
|---|---|
| Applies to | All motorized devices |
| Firmware Version | 5.20 and up |
| Command Number | 41 |
| Command Type | Setting |
| Command Data | Speed |
| Reply Data | Speed |
| Safe to retry? | Yes |
| Returns Current Position? | No |
| Persistence | Non-Volatile |
| Summary | Sets the speed at which the device moves when using the "Home" command. |
When a home instruction is issued, the device will accelerate at a rate determined by the acceleration setting up to the speed determined by this command. The home speed can be set independently of target speed (command 42) so that for stages that move very fast, issuing the home command would use a slower home speed and prevent the stage from crashing into the home position.
For a spreadsheet that can be used to calculate speed setting values for any product see http://www.zaber.com/documents/ZaberSpeedSetting.xls. Alternatively you may use the formulas below.
The conversion between device speed and command data value depends on the device firmware version:
- T-Series devices - Firmware 5.xx
Actual Speed
- = Data * 9.375 * M mm/s or deg/s
- = Data * 9.375 microsteps/s
- = Data * 9.375 / R steps/s
- = Data * 9.375 / (R x S) * 60 revolutions/min Motor rpm
- = Data * 9.375 * L / (R x S) mm/s Linear devices only
where:
- Data is the value of the command data
- R (microsteps/step) is the microstep resolution (command 37)
- S (steps/revolution) is the number of steps per motor revolution
- M (mm or deg) is the microstep size
- L (mm or deg) is the distance of linear motion per motor revolution
Maximum data value is 512*R-1. Note that the maximum speed possible is independent of the resolution. In Firmware 5.21 and 5.22, a value of 0 is not allowed. In all other versions, target speed of 0 will cause Move Absolute/Relative and Move to Stored Position commands to return an error.
Refer to product specifications for the distance corresponding to a single microstep or revolution.
For example, if a motor has 48 steps per revolution (S = 48), used with default resolution (R = 64), and Data is 2922, then the motor will move at a speed of approximately 535 revolutions per minute.
- A-Series devices - Firmware 6.xx
Actual Speed
- = Data / 1.6384 * M mm/s or deg/s
- = Data / 1.6384 microsteps/s
- = Data / 1.6384 / R steps/s
- = Data / 1.6384 / (R x S) * 60 revolutions/min Motor rpm
- = Data / 1.6384 * L / (R x S) mm/s Linear devices only
where:
- Data is the value of the command data
- R (microsteps/step) is the microstep resolution (command 37)
- S (steps/revolution) is the number of steps per motor revolution
- M (mm or deg) is the microstep size
- L (mm or deg) is the distance of linear motion per motor revolution
Valid data values are from 1 to (16384*R). Note that the maximum speed possible is independent of the resolution.
Refer to product specifications for the distance corresponding to a single microstep or revolution.
For example, if a motor has 200 steps per revolution (S = 200), used with default resolution (R = 64), and Data is 153600, then the motor will move at a speed of 720 revolutions per minute.
Set Target Speed - Cmd 42
| Instruction Name | Set Target Speed |
|---|---|
| Applies to | All motorized devices |
| Firmware Version | 5.00 and up |
| Command Number | 42 |
| Command Type | Setting |
| Command Data | Speed |
| Reply Data | Speed |
| Safe to retry? | Yes |
| Returns Current Position? | No |
| Persistence | Non-Volatile |
| Summary | Sets the speed at which the device moves when using the "Move Absolute" or "Move Relative" commands. |
When a move absolute or move relative instruction is issued, the device will accelerate at a rate determined by the acceleration setting up to the speed determined by this command.
The target velocity may be changed on-the-fly even when the device is in the middle of a move. The device will automatically adjust the velocity, but still target the final position specified in the original move.
For a spreadsheet that can be used to calculate speed setting values for any product see http://www.zaber.com/documents/ZaberSpeedSetting.xls. Alternatively you may use the formulas below.
The conversion between device speed and command data value depends on the device firmware version:
- T-Series devices - Firmware 5.xx
Actual Speed
- = Data * 9.375 * M mm/s or deg/s
- = Data * 9.375 microsteps/s
- = Data * 9.375 / R steps/s
- = Data * 9.375 / (R x S) * 60 revolutions/min Motor rpm
- = Data * 9.375 * L / (R x S) mm/s Linear devices only
where:
- Data is the value of the command data
- R (microsteps/step) is the microstep resolution (command 37)
- S (steps/revolution) is the number of steps per motor revolution
- M (mm or deg) is the microstep size
- L (mm or deg) is the distance of linear motion per motor revolution
Maximum data value is 512*R-1. Note that the maximum speed possible is independent of the resolution. In Firmware 5.21 and 5.22, a value of 0 is not allowed. In all other versions, target speed of 0 will cause Move Absolute/Relative and Move to Stored Position commands to return an error.
Refer to product specifications for the distance corresponding to a single microstep or revolution.
For example, if a motor has 48 steps per revolution (S = 48), used with default resolution (R = 64), and Data is 2922, then the motor will move at a speed of approximately 535 revolutions per minute.
- A-Series devices - Firmware 6.xx
Actual Speed
- = Data / 1.6384 * M mm/s or deg/s
- = Data / 1.6384 microsteps/s
- = Data / 1.6384 / R steps/s
- = Data / 1.6384 / (R x S) * 60 revolutions/min Motor rpm
- = Data / 1.6384 * L / (R x S) mm/s Linear devices only
where:
- Data is the value of the command data
- R (microsteps/step) is the microstep resolution (command 37)
- S (steps/revolution) is the number of steps per motor revolution
- M (mm or deg) is the microstep size
- L (mm or deg) is the distance of linear motion per motor revolution
Valid data values are from 1 to (16384*R). Note that the maximum speed possible is independent of the resolution.
Refer to product specifications for the distance corresponding to a single microstep or revolution.
For example, if a motor has 200 steps per revolution (S = 200), used with default resolution (R = 64), and Data is 153600, then the motor will move at a speed of 720 revolutions per minute.
Set Acceleration - Cmd 43
| Instruction Name | Set Acceleration |
|---|---|
| Applies to | All motorized devices |
| Firmware Version | 5.00 and up |
| Command Number | 43 |
| Command Type | Setting |
| Command Data | Acceleration |
| Reply Data | Acceleration |
| Safe to retry? | Yes |
| Returns Current Position? | No |
| Persistence | Non-Volatile |
| Summary | Sets the acceleration used by the movement commands. |
When a movement command is issued, the device will accelerate at a rate determined by this command "Set Acceleration" up to a maximum speed determined by the target velocity. The acceleration may be changed on-the-fly even when the device is in the middle of a move.
It is possible to set acceleration and deceleration separately in A-Series devices. In which case, use Set Acceleration Only (Cmd 113) and Set Deceleration Only (Cmd 114) instead.
The conversion between device acceleration and command data value depends on the device firmware version:
- T-Series devices - Firmware 5.xx
- Actual Acceleration
- = 11250 * Data * M mm/s^2 or deg/s^2
- = 11250 * Data microsteps/s^2
- = 11250 * Data / R steps/s^2
Where:
- Data is the value specified in the Command Data
- M (mm or deg) is the microstep size
- R is the microstep resolution set in command #37 (microsteps/step)
The maximum value allowable is (512*R-1). This is the same as the maximum allowable data for velocity, which means that the device will reach maximum velocity immediately. If acceleration is set to 0, it is as if acceleration is set to (512*R-1). Effectively acceleration is turned off and the device will start moving at the target speed immediately.
- A-Series devices - Firmware 6.xx
- Actual Acceleration
- = 10000 * Data * M / 1.6384 mm/s^2 or deg/s^2
- = 10000 * Data / 1.6384 microsteps/s^2
- = 10000 * Data / R / 1.6384 steps/s^2
Where:
- Data is the value specified in the Command Data
- M (mm or deg) is the microstep size
- R is the microstep resolution set in command #37 (microsteps/step)
The maximum value is 32767.
Set Maximum Position - Cmd 44
| Instruction Name | Set Maximum Position |
|---|---|
| Applies to | All motorized devices |
| Firmware Version | 5.00 and up |
| Command Number | 44 |
| Command Type | Setting |
| Command Data | Position |
| Reply Data | Position |
| Safe to retry? | Yes |
| Returns Current Position? | No |
| Persistence | Non-Volatile |
| Summary | Sets the maximum position the device is allowed to travel to. |
Use this command to limit the range of travel to a value other than the default. Exercise caution when using this command, since it is possible to set the range to a value greater than the physical limits of the device.
A device within range of travel is not allowed to move above its Maximum Position. The default Maximum Position is the full travel length of the device.
This setting is stored in non-volatile memory and will persist after power-down or reset.
NOTE: This command was previously named Set Maximum Range.
The valid range and behaviour of this command depends on the firmware version:
- T-Series devices - Firmware 5.01 - 5.20
Valid values can be any number from 0 to 16777215. Device movement behaviour when out of range is not well-defined.
- T-Series devices - Firmware 5.21 - 5.22
Valid values can be any number from 0 to 16777215, but the new Maximum Position cannot be less than the current position.
- T-Series devices - Firmware 5.23 and up
Valid values can be any number from 0 to 16777215. If the device Current Position is out of range and above Maximum Position, the device is not allowed to move in the positive direction.
- A-Series devices - Firmware 6.xx
If the device Current Position is out of range and above Maximum Position, the device is not allowed to move in the positive direction.
Valid values can be any number from -1000000000 to 1000000000.
Set Current Position - Cmd 45
| Instruction Name | Set Current Position |
|---|---|
| Applies to | All motorized devices |
| Firmware Version | 5.00 and up |
| Command Number | 45 |
| Command Type | Setting |
| Command Data | New Position |
| Reply Data | New Position |
| Safe to retry? | Yes |
| Returns Current Position? | Yes |
| Persistence | Volatile |
| Summary | Sets the device internal position counter. |
This command override the internal position counter with a new position value specified by the user.
The position data is volatile and will not persist after power-down or reset.
The behaviour of this command depends on the firmware version:
- T-Series devices - Firmware 5.xx
The phase of the stepper motor is controlled by the least significant byte of the position, thus the device may move by +/- 2 full steps unless the new position corresponds to the true current position of the device. This command is useful if you want to turn off the system without losing position. Simply save the position in the controlling computer and turn off the hold current (Command 39) before powering down. After powering up, set the position back to the saved value and turn on the hold current. In this way you can continue without having to home the device. You have to turn off the hold current because when the power first comes on the position will default to the maximum range, and that may be out of phase with the motor's current position. If the hold current is on, it will force the motor into phase with the default position before you've had a chance to restore the current position.
In Firmware 5.21 and 5.22, the new Current Position must be equal or less than Maximum Position. See Set Maximum Position (Cmd 44) for more details on range settings and behaviour.
- A-Series devices - Firmware 6.xx
Stepper motor phase remains unchanged when position is updated.
Do not use this command to preserve the position counter over power cycles. To restore the position counter without homing the device, Park the stage before power down and Unpark the stage when power is restored. See Set Park State (Cmd 65) for details.
Set Maximum Relative Move - Cmd 46
| Instruction Name | Set Maximum Relative Move |
|---|---|
| Applies to | T-Series motorized devices |
| Firmware Version | 5.xx |
| Command Number | 46 |
| Command Type | Setting |
| Command Data | Range |
| Reply Data | Range |
| Safe to retry? | Yes |
| Returns Current Position? | No |
| Persistence | Non-volatile |
| Summary | Sets a limit on the number of microsteps the device can make for a Relative Move command. |
Use this command to limit the maximum range of travel for a relative move command. For example, if maximum relative move is set to 1000, and the user requests a relative move (#21) of 800, then the device will move 800 microsteps. However, if the user requests a relative move of 1200, then the device will reply with an error code. Most applications can leave this unchanged from the default.
This setting is stored in non-volatile memory and will persist after power-down or reset.
Set Home Offset - Cmd 47
| Instruction Name | Set Home Offset |
|---|---|
| Applies to | All motorized devices |
| Firmware Version | 5.00 and up |
| Command Number | 47 |
| Command Type | Setting |
| Command Data | Offset |
| Reply Data | Offset |
| Safe to retry? | Yes |
| Returns Current Position? | No |
| Persistence | Non-Volatile |
| Summary | Sets the the new "Home" position which can then be used when the Home command is issued. |
When the home command is issued, the device will retract until the home sensor is triggered, then move forward until the home sensor is no longer triggered, then move forward by the Home Offset value (in microsteps) and resets the internal position (to 0 for most devices).
Note that the home offset command also changes the range settings of the device. For example, if the initial Home Offset is 0 and the Maximum Position is 500,000, and the user changes the Home Offset to 70,000, then the Maximum Position is automatically adjusted to be 430,000. However, changing the Maximum Position does not affect the home offset.
This setting is stored in non-volatile memory and will persist after power-down or reset.
- T-Series devices - Firmware 5.xx
When a new Home Offset is specified, Maximum Position is adjusted to provide the same maximum location. However, the device will not be able to travel below its new home position unless it is homing.
- A-Series devices - Firmware 6.xx
When a new Home Offset is specified, Minimum and Maximum Positions are adjusted to provide the same range. The device is able to move in the same travel range as before.
Set Alias Number - Cmd 48
| Instruction Name | Set Alias Number |
|---|---|
| Applies to | All Zaber devices |
| Firmware Version | 5.00 and up |
| Command Number | 48 |
| Command Type | Setting |
| Command Data | Alias Number |
| Reply Data | Alias Number |
| Safe to retry? | Yes |
| Returns Current Position? | No |
| Persistence | Non-Volatile |
| Summary | Sets an alternate device number for a device. |
This setting specifies an alternate device number for a device (in addition to its actual device number). By setting several devices to the same alias number, you can control a group of devices with a single instruction. When you send an instruction to an alias number, all devices with that alias number will execute the instruction and reply using their actual device numbers. To remove an alias, simply set the device's alias number to zero. Valid alias numbers are between 0 and 254. To avoid confusion, it is best to choose an alias greater than the number of devices connected.
This setting is stored in non-volatile memory and will persist after power-down or reset.
Set Lock State - Cmd 49
| Instruction Name | Set Lock State |
|---|---|
| Applies to | T-Series devices |
| Firmware Version | 5.xx since 5.07 |
| Command Number | 49 |
| Command Type | Setting |
| Command Data | Lock State |
| Reply Data | Lock State |
| Safe to retry? | Yes |
| Returns Current Position? | No |
| Persistence | Non-Volatile |
| Summary | Locks or unlocks all non-volatile settings. |
Sometimes it is desirable to lock all non-volatile settings to prevent them from being changed inadvertently. After changing all settings as desired, settings can be locked by setting the Lock State to 1. Subsequent attempts to change any non-volatile setting (e.g., Set Target Speed, command 42) will result in an error response with an error code of 3600 (settings locked). Note that the Set Lock State command does not apply to commands and settings that are specific to the joystick. Load Event Instruction and Set Axis Device Number for example, are unaffected by the Lock State.
How the Restore Settings instruction behaves when the settings are locked depends on the firmware version. In version 5.07 issuing a Restore Settings instruction while the settings are locked will result in an error response with an error code of 3600 (settings locked). This behavior was found to confuse many customers so in version 5.08 and up, the behavior was changed such that regardless of the current lock state, issuing a Restore Settings instruction will always return setting values to factory default values and leave settings in an unlocked state.
Settings can also be unlocked by setting the Lock State to 0.
Return Device Id - Cmd 50
| Instruction Name | Return Device Id |
|---|---|
| Applies to | All Zaber devices |
| Firmware Version | 5.00 and up |
| Command Number | 50 |
| Command Type | Read-Only Setting |
| Command Data | Ignored |
| Reply Data | Device Id |
| Safe to retry? | Yes |
| Returns Current Position? | No |
| Persistence | n/a |
| Summary | Returns the id number for the type of device connected. |
See the Zaber support web site for a table of device ids for all Zaber products.
Return Firmware Version - Cmd 51
| Instruction Name | Return Firmware Version |
|---|---|
| Applies to | All Zaber devices |
| Firmware Version | 5.00 and up |
| Command Number | 51 |
| Command Type | Read-Only Setting |
| Command Data | Ignored |
| Reply Data | Version |
| Safe to retry? | Yes |
| Returns Current Position? | No |
| Persistence | n/a |
| Summary | Returns the firmware version installed on the device. |
A decimal is assumed before the last two digits. For example, 502 indicates firmware version 5.02.
Return Power Supply Voltage - Cmd 52
| Instruction Name | Return Power Supply Voltage |
|---|---|
| Applies to | All Zaber devices |
| Firmware Version | 5.00 and up |
| Command Number | 52 |
| Command Type | Read-Only Setting |
| Command Data | Ignored |
| Reply Data | Voltage |
| Safe to retry? | Yes |
| Returns Current Position? | No |
| Persistence | n/a |
| Summary | Returns the voltage level of the device's power supply. |
A decimal is assumed before the last digit. For example, a value of 127 indicates 12.7 V. Note that the internal voltage measurement is not very accurate. Don't be alarmed if the indicated voltage is slightly different from your measurements.
Return Setting - Cmd 53
| Instruction Name | Return Setting |
|---|---|
| Applies to | All Zaber devices |
| Firmware Version | 5.00 and up |
| Command Number | 53 |
| Command Type | Command |
| Command Data | Setting Number |
| Reply Data | Setting Value |
| Safe to retry? | Yes |
| Returns Current Position? | No |
| Persistence | n/a |
| Summary | Returns the current value of the setting specified in the Command Data. |
Valid command data values are the command numbers of any "Set..." instruction. The device will reply using the command number of the specified setting (as if a command to change the setting had just been issued) but the setting will not be changed.
For example, command #48 is the "Set Alias" instruction. Therefore if you wish to return the current value of the alias number, simply send the Return Setting instruction with data of 48. The device will reply with command #48 and data equal to the setting value.
Since firmware version 5.21, this command also accepts the command numbers of any "Return..." instruction, such as command #50 "Return Device Id".
Return Status - Cmd 54
| Instruction Name | Return Status |
|---|---|
| Applies to | All motorized devices |
| Firmware Version | 5.00 and up |
| Command Number | 54 |
| Command Type | Read-Only Setting |
| Command Data | Ignored |
| Reply Data | Status |
| Safe to retry? | Yes |
| Returns Current Position? | No |
| Persistence | n/a |
| Summary | Returns the current status of the device. |
Possible status codes are as follows:
- 0 - idle, not currently executing any instructions
- 1 - executing a home instruction
- 10 - executing a manual move (i.e. the manual control knob is turned)
- 11 - executing a manual move in Displacement Mode (A-Series devices only)
- 20 - executing a move absolute instruction
- 21 - executing a move relative instruction
- 22 - executing a move at constant speed instruction
- 23 - executing a stop instruction (i.e. decelerating)
- 65 - device is parked (A-Series devices with FW 6.02 and up only. FW 6.01 returns 0 when parked)
Echo Data - Cmd 55
| Instruction Name | Echo Data |
|---|---|
| Applies to | All Zaber devices |
| Firmware Version | 5.04 and up |
| Command Number | 55 |
| Command Type | Command |
| Command Data | Data |
| Reply Data | Data |
| Safe to retry? | Yes |
| Returns Current Position? | No |
| Persistence | n/a |
| Summary | Echoes back the same Command Data that was sent. |
This command is useful for testing communication, similar to a network "ping".
Return Current Position - Cmd 60
| Instruction Name | Return Current Position |
|---|---|
| Applies to | All motorized devices |
| Firmware Version | 5.00 and up |
| Command Number | 60 |
| Command Type | Read-Only Setting |
| Command Data | Ignored |
| Reply Data | Position |
| Safe to retry? | Yes |
| Returns Current Position? | Yes |
| Persistence | n/a |
| Summary | Returns the current absolute position of the device in microsteps. |
This is equivalent to issuing a Return Setting (#53) command with a command data value of 45 (Set Current Position).
Reply-Only Reference
In general, a Zaber device will reply to an instruction using the same command number as the instruction itself. However, there are occasions (such as when the user turns a manual control knob) when the device may transmit data without first receiving a request from the controlling computer. This type of reply may be considered to be a triggered reply as opposed to a requested reply. In this case the device uses a “reply-only” command number to distinguish the reply from those requested by the controlling computer. The meanings of these replies and their corresponding data are given below.
Move Tracking - Cmd 8
| Instruction Name | Move Tracking |
|---|---|
| Applies to | All motorized devices |
| Firmware Version | 5.00 and up |
| Command Number | 8 |
| Command Type | Reply |
| Command Data | n/a |
| Reply Data | Position |
| Safe to retry? | Yes |
| Returns Current Position? | Yes |
| Persistence | n/a |
| Summary | Indicates to the user that the device has been set to a position tracking mode and given a move instruction. |
- T-Series motorized devices
Move Tracking has been enabled (see Set Device Mode (Cmd 40)) and device has been given a move instruction. In this mode, the device sends this reply every 0.25 seconds updating the current absolute position (in microsteps) during any move.
- A-Series motorized devices
Move Tracking has been enabled (see Set Move Tracking Mode (Cmd 115)) and device has been given a move instruction. In this mode, the device sends this reply at a regular interval updating the current absolute position (in microsteps) during any move. The default interval is 250ms and can be configured with Set Move Tracking Period (Cmd 117).
Limit Active - Cmd 9
| Instruction Name | Limit Active |
|---|---|
| Applies to | All motorized devices |
| Firmware Version | 5.00 and up |
| Command Number | 9 |
| Command Type | Reply |
| Command Data | n/a |
| Reply Data | Position |
| Safe to retry? | Yes |
| Returns Current Position? | Yes |
| Persistence | n/a |
| Summary | Indicates to the user that the device has reached one of the limits of travel. |
This response from a device indicates that it reached one of the limits of travel (either the minimum position or maximum position). For example, if a device is sent a “move at constant speed” instruction, and it reaches the maximum range of travel then the device will reply with this command number and the maximum position reached as data.
Manual Move Tracking - Cmd 10
| Instruction Name | Manual Move Tracking |
|---|---|
| Applies to | All motorized devices |
| Firmware Version | 5.00 and up |
| Command Number | 10 |
| Command Type | Reply |
| Command Data | n/a |
| Reply Data | Position |
| Safe to retry? | Yes |
| Returns Current Position? | Yes |
| Persistence | n/a |
| Summary | A reply that is sent when the manual control knob is turned. |
- T-Series motorized devices
Manual Move Tracking has been enabled (see Set Device Mode (Cmd 40)) and the device has been moved manually (the knob is turned). In this mode, the device sends this reply every 0.25 seconds updating the current absolute position (in microsteps) during any move.
- A-Series motorized devices
Manual Move Tracking has been enabled (see Set Manual Move Tracking Disabled Mode (Cmd 116)) and the device has been moved manually (the knob is turned). In this mode, the device sends this reply at a regular interval updating the current absolute position (in microsteps) during any move. The default interval is 250ms and can be configured with Set Move Tracking Period (Cmd 117).
Error - Cmd 255
| Instruction Name | Error |
|---|---|
| Applies to | All Zaber devices |
| Firmware Version | 5.00 and up |
| Command Number | 255 |
| Command Type | Reply |
| Command Data | n/a |
| Reply Data | Error Code |
| Safe to retry? | Yes |
| Returns Current Position? | No |
| Persistence | n/a |
| Summary | Indicates to the user that an error has occurred. |
This reply indicates that an error has occurred. The error code returned in the data indicates the type of error. The device may send an error code as a reply to an invalid instruction, or it may autonomously send an error code as a triggered reply (i.e. not in response to an instruction). The error code is typically the command number of the instruction that caused the error, but not always.
Error Codes
| Code | Name | Description |
|---|---|---|
| 1 | Cannot Home | Home - Device has traveled a long distance without triggering the home sensor. Device may be stalling or slipping. |
| 2 | Device Number Invalid | Renumbering data out of range. Data (Device number) must be between 1 and 254 inclusive. |
| 5 | Address Invalid | Read Register - Register address invalid. |
| 14 | Voltage Low | Power supply voltage too low. |
| 15 | Voltage High | Power supply voltage too high. |
| 18 | Stored Position Invalid | The position stored in the requested register is no longer valid. This is probably because the maximum range was reduced. |
| 20 | Absolute Position Invalid | Move Absolute - Target position out of range. |
| 21 | Relative Position Invalid | Move Relative - Target position out of range. |
| 22 | Velocity Invalid | Constant velocity move. Velocity out of range. |
| 25 | Axis Invalid | Set Active Axis - Data out of range. Must be 1, 2, or 3. |
| 26 | Axis Device Number Invalid | Set Axis Device Number - Data out of range. Must be between 0 and 254 inclusive. |
| 27 | Inversion Invalid | Set Axis Inversion - Data out of range. Must be 0, 1, or -1. |
| 28 | Velocity Profile Invalid | Set Axis Velocity Profile - Data out of range. Must be 0, 1, 2, or 3. |
| 29 | Velocity Scale Invalid | Set Axis Velocity Scale - Data out of range. Must be between 0 and 65535. |
| 30 | Load Event Invalid | Load Event-Triggered Instruction - Data out of range. See command #30 for valid range. |
| 31 | Return Event Invalid | Return Event-Triggered Instruction - Data out of range. See command #31 and #30 for valid range. |
| 33 | Calibration Mode Invalid | Must be 0, 1, or 2. |
| 36 | Peripheral Id Invalid | Restore Settings - Peripheral id is invalid. Please use one of the peripheral ids listed in the user manual, or 0 for default. |
| 37 | Resolution Invalid | Invalid microstep resolution. See command 37 for allowable values. |
| 38 | Run Current Invalid | Run current out of range. |
| 39 | Hold Current Invalid | Hold current out of range. |
| 40 | Mode Invalid | Set Device Mode - one or more of the mode bits is invalid. |
| 41 | Home Speed Invalid | Home speed out of range. The range of home speed is determined by the resolution. |
| 42 | Speed Invalid | Target speed out of range. The range of target speed is determined by the resolution. |
| 43 | Acceleration Invalid | Target acceleration out of range. |
| 44 | Maximum Position Invalid | Maximum position out of range. |
| 45 | Current Position Invalid | Current position out of range. |
| 46 | Maximum Relative Move Invalid | Max relative move out of range. Must be between 0 and 16,777,215. |
| 47 | Offset Invalid | Home offset out of range. Home offset must be between 0 and maximum position. |
| 48 | Alias Invalid | Alias out of range. Alias must be between 0 and 254 inclusive. |
| 49 | Lock State Invalid | Lock state must be 1 (locked) or 0 (unlocked). |
| 50 | Device Id Unknown | The device id is not included in the firmware's list. |
| 53 | Setting Invalid | Return Setting - data entered is not a valid setting command number. Valid data are the command numbers of any "Set..." or "Return..." instructions. |
| 64 | Command Invalid | Command number not valid in this firmware version. |
| 65 | Park State Invalid | Set Park State - State must be 0 or 1, or device cannot park because it is in motion. |
| 67 | Temperature High | High temperature is detected inside device. Device may be overheating. |
| 101 | Auto Reply Disabled Mode Invalid | Mode must be 0 or 1. |
| 102 | Message Id Mode Invalid | Mode must be 0 or 1. |
| 103 | Home Status Invalid | Status must be 0 or 1. |
| 104 | Home Sensor Type Invalid | Type must be 0 or 1. |
| 105 | Auto-Home Disabled Mode Invalid | Mode must be 0 or 1. |
| 106 | Minimum Position Invalid | Minimum position out of range. |
| 107 | Knob Disabled Mode Invalid | Mode must be 0 or 1. |
| 108 | Knob Direction Invalid | Direction must be 0 or 1. |
| 109 | Knob Movement Mode Invalid | Mode must be 0 or 1. |
| 111 | Knob Velocity Scale Invalid | Maximum knob speed out of range. The range of valid speed is determined by the resolution. |
| 112 | Knob Velocity Profile Invalid | Profile must be 1 (Linear), 2 (Quadratic), or 3 (Cubic). |
| 113 | Acceleration Only Invalid | Acceleration out of range. |
| 114 | Deceleration Only Invalid | Deceleration out of range. |
| 115 | Move Tracking Mode Invalid | Mode must be 0 or 1. |
| 116 | Manual Move Tracking Disabled Mode Invalid | Mode must be 0 or 1. |
| 117 | Move Tracking Period Invalid | Valid range is 10 - 65535. |
| 118 | Closed-Loop Mode Invalid | Valid modes are 0-6. |
| 119 | Slip Tracking Period Invalid | Valid range is 0(Off), 10 - 65535. |
| 120 | Stall Timeout Invalid | Valid range is 0 - 65535. |
| 121 | Device Direction Invalid | Direction must be 0 or 1. |
| 255 | Busy | Another command is executing and cannot be pre-empted. Either stop the previous command or wait until it finishes before trying again. |
| 701 | Register Address Invalid | Write Register - Register address invalid. |
| 702 | Register Value Invalid | Write Register - Value out of range. |
| 1600 | Save Position Invalid | Save Current Position register out of range (must be 0-15). |
| 1601 | Save Position Not Homed | Save Current Position is not allowed unless the device has been homed. |
| 1700 | Return Position Invalid | Return Stored Position register out of range (must be 0-15). |
| 1800 | Move Position Invalid | Move to Stored Position register out of range (must be 0-15). |
| 1801 | Move Position Not Homed | Move to Stored Position is not allowed unless the device has been homed. |
| 2146 | Relative Position Limited | Move Relative (command 20) exceeded maximum relative move range. Either move a shorter distance, or change the maximum relative move (command 46). |
| 3600 | Settings Locked | Must clear Lock State (command 49) first. See the Set Lock State command for details. |
| 4001 | Bit 1 Invalid | Set Device Mode - bit 1 is reserved in this device and must be 0. |
| 4002 | Bit 2 Invalid | Set Device Mode - bit 2 is reserved in this device and must be 0. |
| 4008 | Disable Auto Home Invalid | Set Device Mode - this is a linear actuator; Disable Auto Home is used for rotary actuators only. |
| 4010 | Bit 10 Invalid | Set Device Mode - bit 10 is reserved in this device and must be 0. |
| 4011 | Bit 11 Invalid | Set Device Mode - bit 11 is reserved in this device and must be 0. |
| 4012 | Home Switch Invalid | Set Device Mode - this device has integrated home sensor with preset polarity; mode bit 12 cannot be changed by the user. |
| 4013 | Bit 13 Invalid | Set Device Mode - bit 13 is reserved in this device and must be 0. |
| 4014 | Bit 14 Invalid | Set Device Mode - bit 14 is reserved in this device and must be 0. |
| 4015 | Bit 15 Invalid | Set Device Mode - bit 15 is reserved in this device and must be 0. |
| 6501 | Device Parked | Device is currently parked. Use Set Park State or Home to unpark device before requesting a move. |
