Template:X-Series/Commands/X-JOY3

From ZaberWiki
Jump to navigation Jump to search

Quick Command Reference

All X-Series devices ship with the ASCII Protocol enabled by default but the Binary Protocol is also supported.

ASCII Protocol

The following table offers a quick command and setting reference for the {{{Device}}}. Follow the links to view a detailed description of each instruction or refer to the ASCII Protocol Manual.

Quick Commands

Parameters in square brackets, e.g. [clr], indicate that the parameter is optional.
Parameters in italics, e.g. value, indicate that data, typically a number, needs to be provided.
Parameters separated by a pipe, e.g. abs|rel, indicate that one of the parameters in the set need to be provided.

Command Scope Parameter(s) Returns Firmware Versions Description
get Device setting value 6.06+ Retrieves the current value of the device or axis setting.
help Device commands
reply
warnflags
enums
command ...
enum
0 6.06+ Displays the help information for the system.
joystick Device Refer to the documentation Refer to the documentation 6.16+ Configures joystick axes.
key Device Refer to the documentation Refer to the documentation 6.16+ Configures joystick keys.
renumber Device value 0 6.06+ Renumbers all devices in the chain.
set Device setting value 0 6.06+ Sets the device or axis setting setting to the value.
system reset Device 0 6.06+ Resets the device, as it would appear after power up.
system restore Device 0 6.06+ Restores common device settings to their default values.
tools echo Device (message)
0 6.06+ Echoes the provided message (if any) back to the user.
tools setcomm Device rs232baud protocol 0 6.06+ Sets RS232 baud rate and communication protocol for RS232 and USB.
warnings Device [clear]
0 6.06+ Displays the active device and axis warnings, optionally clearing them if applicable.

Quick Device Settings

The settings listed below can be inspected and modified with the get and set commands described above.

Setting Scope Writable Firmware Versions Description
comm.address Device Yes 6.06+ The device address.
comm.alert Device Yes 6.06+ The device will send alert messages when this setting is 1.
comm.checksum Device Yes 6.06+ The device includes checksums in its messages if this setting is set to 1.
comm.protocol Device Yes 6.06+ The communications protocol used by the device on the current interface.
comm.rs232.baud Device Yes 6.06+ The baud rate used by RS232 Prev and Next interfaces.
comm.rs232.protocol Device Yes 6.09+ The protocol used by RS232 Prev and Next interfaces.
deviceid Device No 6.06+ The device ID for the unit.
joy.debug Device Yes 6.16+ Joystick debugging mode.
system.access Device Yes 6.06+ Sets the access level of the user.
system.axiscount Device No 6.06+ The number of axes in the device.
system.led.enable Device Yes 6.06+ Enables the front panel LEDs.
system.serial Device No 6.15+ The serial number of the device.
system.voltage Device No 6.06+ The voltage being applied to the device.
version Device No 6.06+ The firmware version of the device.
version.build Device No 6.17+ The build number of the device’s firmware.

Binary Protocol

The following table offers a quick command reference for the {{{Device}}}. For convenience, you may sort the table below by instruction name, command number, or reply number. Follow the links to view a detailed description of each instruction or refer to the Binary Protocol Manual.

Instruction Name Command# Command Data Command Type Reply Data
Reset 0 Ignored Command None
Renumber* 2 Ignored Command Device ID
Read Register 5 Register Address Command Data
Set Active Register 6 Register Address Setting Register Address
Write Register 7 Data Command Data
Set Active Axis* 25 Axis Setting Axis
Set Axis Device Number* 26 Device Number Setting Device Number
Set Axis Inversion* 27 Invert Status Setting Invert Status
Set Axis Velocity Profile* 28 Profile Number Setting Profile Number
Set Axis Velocity Scale* 29 Maximum Velocity Setting Maximum Velocity
Load Event Instruction* 30 Key Event Command Key Event
Return Event Instruction 31 Key Event Command n/a
Set Joystick Calibration Mode 33 Calibration Mode Setting Calibration Mode
Restore Settings* 36 Peripheral ID Command Peripheral ID
Set Device Mode* 40 Mode Setting Mode
Set Alias Number* 48 Alias Number Setting Alias Number
Return Device ID 50 Ignored Read-Only Setting Device ID
Return Firmware Version 51 Ignored Read-Only Setting Version
Return Power Supply Voltage 52 Ignored Read-Only Setting Voltage
Return Setting 53 Setting Number Command Setting Value
Echo Data 55 Data Command Data
Return Firmware Build 56 Ignored Read-Only Setting Build Number
Return Serial Number 63 Ignored Read-Only Setting Serial Number
Return Digital Input Count 67 Ignored Read-Only Setting Pin Count
Return Digital Output Count 70 Ignored Read-Only Setting Pin Count
Return Analog Input Count 75 Ignored Read-Only Setting Pin Count
Return Analog Output Count 77 Ignored Read-Only Setting Pin Count
Set Auto-Reply Disabled Mode* 101 Auto-Reply Mode Setting Auto-Reply Mode
Set Message ID Mode* 102 Message ID Mode Setting Message ID Mode
Set Baud Rate* 122 Baud Rate Setting Baud Rate
Set Protocol* 123 Protocol Setting Protocol
Convert To Ascii* 124 Baud Rate Command Baud Rate
Error 255 n/a Reply Error Code

* The settings for these commands are saved in non-volatile memory, i.e. the setting persists even if the device is powered down. To restore all settings to factory default, use command 36.