To sort the table, click on a triangle.
| Name |
Type |
Level |
Version |
Set/Get |
Args |
Range |
Meaning |
Description |
Support |
|---|---|---|---|---|---|---|---|---|---|
| 2D.ALGORITHM | Symbology | PUBLIC | 3.0.0 | SET|GET | algorithm |
[0-1] |
0: IDMax ©
1: IDQuick |
IDQuick or IDMax© | X, XM, SX and QE fixed-mount readers. All Q models except for DM503Q. |
| 3DVECTOR.CALIBRATED | Action | PRIVATE | 5.5.0 | GET | calibration_status |
[0-2] |
0:Neither factory, nor field calibration present 1:Only factory calibration loaded 2:Factory and field calibration loaded |
Query current calibration status. | ALL |
| 3DVECTOR.ENABLED | Action | PRIVATE | 5.5.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enables/disables the 3DVectoring functionality on the reader. | ALL |
| 3DVECTOR.FCALIB-CVL.LOAD | Action | PRIVATE | 5.5.0 | size_bytes |
Load factory calibration data blob in CVL style. | ALL | |||
| 3DVECTOR.FCALIB-CVL.SEND | Action | PRIVATE | 5.5.0 | Send factory calibration data blob in CVL style. | ALL | ||||
| 3DVECTOR.FCALIB-CVT.LOAD | Action | PRIVATE | 5.5.0 | size_bytes |
Load factory calibration data blob in CVT style. | ALL | |||
| 3DVECTOR.FCALIB-CVT.SEND | Action | PRIVATE | 5.5.0 | Send factory calibration data blob in CVT style. | ALL | ||||
| 3DVECTOR.LENGTH | Action | PRIVATE | 5.5.0 | SET|GET | This sets/gets the length of the output 3D line segment. | ALL | |||
| 3DVECTOR.SCALIB.LOAD | Action | PRIVATE | 5.5.0 | size_bytes |
Load system calibration data blob. | ALL | |||
| 3DVECTOR.SCALIB.SEND | Action | PRIVATE | 5.5.0 | Send system calibration data blob. | ALL | ||||
| ABORT | Action | PRIVATE | 3.0.0 | Abort command in process. Intended to abort image transfer. | ALL | ||||
| ACCEL-SENSOR.OPERATION-MODE | Communication | PUBLIC | 5.4.0 | SET|GET | int |
[0-1] |
0: Acceleration Sensor is not used for waking the reader up from hibernation. 1: Acceleration Sensor is used for waking the reader up from hibernation. |
Configures the application of the acceleration sensor. This command is only valid for Bluetooth-connected readers. |
DM8050, DM8600. |
| ACCEL-SENSOR.SENSITIVITY | Communication | PUBLIC | 5.4.0 | SET|GET | int |
[0-2] |
0: Low 1: Medium 2: High |
Gets/sets the sensitivity of the acceleration sensor of/to the predefined value. | DM8050, DM8600. |
| ANDROID.AOA-SWITCH-TIMEOUT | Communication | PUBLIC | 5.7.1 | SET|GET | timeout [ms] |
0-3600000 | Timeout in milliseconds. | After boot the MX device won’t switch to AOA mode for this amount of time. | MX-1000, MX-1502 |
| ANDROID.ROLE | Communication | PUBLIC | 5.7.1 | SET|GET | role |
0-2 |
0: Auto 1: Device 2: AOA |
Sets the USB role of the MX device when in Android mode. | MX-1000, MX-1502 |
| ANDROID.USB-ROLE-CHANGE | Action | PRIVATE | 5.7.1 | SET|GET | enabled timeout |
[ON|OFF] |
ON: (default) role change enabled, reader operates as usual OFF: role change disabled, reader stays in device mode Timeout in seconds after which the role change is automatically enabled again. |
Disables the USB role change. If role change is disabled, the reader stays in device mode, meaning the phone is not charged. If the role change is disabled, a timeout must be provided in seconds after which the role change is automatically enabled again. | ALL |
| AZTEC.TRAINED-MODEL | Decoder | PUBLIC | 5.7.0 | SET|GET | grid size module size polarity |
[15-151] [1-1000] [0-2] |
Grid size Module size * 10 0: dark-on-light 1: light-on-dark 2: either |
Set training parameters for Aztec symbology. | Fixed-mount readers |
| BACKUP.EXPORT | Action | PUBLIC | 5.7.0 | Exports a human readable version of the current reader backup. | ALL | ||||
| BATTERY.CHARGE | System | PUBLIC | 4.4.0 | GET | int |
[0-100] | Displays, in percentage, current battery level. | MX-1000 and DM8000 series readers. | |
| BATTERY.INFO | System | PUBLIC | 5.5.1 | GET | battery |
[0-1] |
0: internal battery 1: grip battery |
Gets verbose battery status. | MX-1000 |
| BEEP | Action | PUBLIC | 3.0.0 | repetition level |
[0-3] [0-2] |
Command audio beep. | ALL | ||
| BEEP.DATAVALID-FAIL | IO | PUBLIC | 3.0.0 | SET|GET | repetition level |
[0-3] [0-2] |
number of beeps 0: Lo pitch 1: Med pitch 2: Hi pitch |
Data Validation Failure Beep Settings. | ALL except for DM50, DM60 and DM70. |
| BEEP.DATAVALID-FAIL-OL | IO | PUBLIC | 3.0.0 | SET|GET | repetition level |
[0-3] [0-2] |
number of beeps 0: Lo pitch 1: Med pitch 2: Hi pitch |
Data Validation Failure Beep Settings when offline. | Wireless readers. |
| BEEP.GLOBAL-ENABLE | Action | PUBLIC | 5.7.0 | SET|GET | state |
[ON|OFF] |
ON: enable OFF: disable |
This command will disable all beeps on the DataMan product. | DM8050, DM8600 |
| BEEP.GOOD | IO | PUBLIC | 3.0.0 | SET|GET | repetition level |
[0-3] [0-2] |
number of beeps 0: Lo pitch 1: Med pitch 2: Hi pitch |
Good Read Beep Settings. | ALL except for DM50, DM60 and DM70. |
| BEEP.GOOD-OL | IO | PUBLIC | 3.0.0 | SET|GET | repetition level |
[0-3] [0-2] |
number of beeps 0: Lo pitch 1: Med pitch 2: Hi pitch |
Good Read Beep Settings when offline. | Wireless readers. |
| BEEP.NO-READ | IO | PUBLIC | 3.0.0 | SET|GET | repetition level |
[0-3] [0-2] |
number of beeps 0: Lo pitch 1: Med pitch 2: Hi pitch |
No-Read Beep Settings. | ALL except for DM50, DM60 and DM70. |
| BEEP.NO-READ-OL | IO | PUBLIC | 3.0.0 | SET|GET | repetition level |
[0-3] [0-2] |
number of beeps 0: Lo pitch 1: Med pitch 2: Hi pitch |
No-Read Beep Settings when offline. | Wireless readers. |
| BEEPER.ENABLED | IO | PUBLIC | 5.7.1 | SET|GET | state |
[ON|OFF] | Enable/disable beeper in general. | All | |
| BLUETOOTH.KBM-PIN | Communication | PRIVATE | 5.4.3 | SET|GET | string |
0-16 characters of decimal number | PIN number (e.g. "1234") | Gets or sets the PIN number of the remote target. | DM8050, DM8600. |
| BLUETOOTH.KBM-TARGET-ADDR | Communication | PRIVATE | 5.4.3 | SET|GET | string |
8 characters of hexadecimal number | MAC address (e.g. "0006660492A6") | Gets or sets the MAC address of the remote target. | DM8050, DM8600. |
| BLUETOOTH.MAC-ADDRESS | Communication | PUBLIC | 5.4.0 | GET | Returns the own Bluetooth address of the device. | DM8050, DM8600. | |||
| BLUETOOTH.MAX-RF-POWER | Communication | PUBLIC | 5.4.3 | SET|GET | int |
-23-7 | Maximum output power in dBm | DM8050, DM8600, and Bluetooth base stations. | |
| BLUETOOTH.OPERATION-MODE | Communication | PRIVATE | 5.4.3 | SET|GET | number |
[0-2] |
0: normal mode 1: PC connect mode 2: keyboard emulator mode |
Gets or sets the Bluetooth operation mode. | DM8050, DM8600. |
| BUTTON.3SEC-ACTION | IO | PUBLIC | 3.0.0 | SET|GET | mode state |
[0-6] [ON|OFF] |
0: Train 1: Optimize Brighness 2: Set Match String 3: Optimize Focus 4: Read Configuration Code 5: Tune 6: Toggle Test Mode enable/disable |
Three Second Button Action. | Fixed mount readers. Test Mode is only supported on the DM503, DM300 series readers and DM474. |
| BUTTON.ACTION | IO | PUBLIC | 5.5.1 | SET|GET | button action |
[0-2] [0-1] |
Index of button (0:Left;1:Right;2:Grip) 0: disabled 1: trigger |
Sets and gets the assigned feature for hardware buttons. | MX-1000 |
| BUTTON.ENABLE | IO | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enables or disables the trigger button. | Fixed mount readers. |
| BUTTON.SAVE-MATCH-STRING | Communication | PUBLIC | 4.5.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enables or disables saving the trained match string directly to flash when Set Match String is enabled for the 3 sec button press action. If disabled, the match string is only stored in RAM and if the configuration is not saved manually it will be gone after reboot. | DM474, DM503, and DM300 series readers. |
| BUTTON.VIRTUAL | Action | PRIVATE | 5.4.0 | int state |
[ON|OFF] |
Denotes the button id. enable/disable Denotes the new state of the button. |
Allows to virtually push the TUNE button for more than 3 seconds on a DM8600 to activate "magic mode". | DM8600 | |
| C11.CHKCHAR | Symbology | PUBLIC | 5.7.1 | SET|GET | state |
[ON|OFF] |
ON: enable OFF: disable (default) |
Code 11 Check Character | Mobile |
| C11.CHKCHAR-OPTION | Symbology | PUBLIC | 5.7.1 | SET|GET | int |
[0-1] |
0: disable 1: enable (default) |
Mobile | |
| C11.CODESIZE | Symbology | PUBLIC | 5.7.1 | SET|GET | any, min, max |
[ON|OFF] [1-max] [min-80] |
any length code minimum code length maximum code length |
Code 11 Code Size | ALL |
| C128.CODESIZE | Symbology | PUBLIC | 3.0.0 | SET|GET | any min max |
[ON|OFF] [1-max] [min-80] |
any length code minimum code length maximum code length |
Code 128 Allowed Size. | ALL |
| C25.CHKCHAR | Symbology | PUBLIC | 5.5.2 | SET|GET | state |
[ON|OFF] |
ON: enable OFF: disable |
Code 25 Check Character | ALL |
| C25.CODESIZE | Symbology | PUBLIC | 5.5.2 | SET|GET | any, min, max |
[ON|OFF] [1-max] [min-80] |
any length code minimum code length maximum code length |
Code 25 Code Size. For the Manatee Works SDK, all of the Code 25 variants use the same minimum length; thus it will accept either C25.CODESIZE or I205.CODESIZE. | ALL |
| C25.QZ-SIZE | Symbology | PUBLIC | 5.5.2 | SET|GET | size |
[0..100] | any length code | Sets or gets the single side strictness as a percentage. | ALL |
| C25.XMTCHK | Symbology | PUBLIC | 5.5.2 | SET|GET | state |
[ON|OFF] |
ON: enable OFF: disable |
Sets or gets whether to transmit the check digit. | ALL |
| C39.ASCII | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Code 39 Full ASCII. | ALL |
| C39.CHKCHAR | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Code 39 Check Character. | ALL |
| C39.CODESIZE | Symbology | PUBLIC | 3.0.0 | SET|GET | any min max |
[ON|OFF] [1-max] [min-80] |
any length code minimum code length maximum code length |
Code 39 Code Size. | ALL |
| C39.XMTCHK | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Code 39 Transmit Check Character. | ALL |
| C93.CODESIZE | Symbology | PUBLIC | 3.0.0 | SET|GET | any min max |
[ON|OFF] [1-max] [min-80] |
any length code minimum code length maximum code length |
Code 93 Code Size. | ALL |
| CAMERA.AUTO-REGULATION | Camera | PUBLIC | 5.6.0 | SET|GET | auto |
[ON|OFF] |
ON: Automatic OFF: Manual |
Camera Parameters where exposure is in microseconds. | DM50, DM60, DM70, DM150, DM260, DM300 series readers, DM360 series readers, DM474, DM503, DM8600 |
| CAMERA.BURST-LENGTH | Camera | PUBLIC | 3.0.0 | SET|GET | count |
[2-*] | number-images | Burst Length. Number of Acquired Images in Burst Trigger-Mode. Actual maximum can be increased by reducing the camera field of view or reserving fewer images for Process Monitor/Record and Playback. |
Fixed mount readers. |
| CAMERA.BURST-TRANSFER-ALL | Camera | PRIVATE | 3.3.0 | SET|GET | state |
[ON|OFF] | enable/disable | Force transfer of all burst images. Used by the DMCC .NET. |
|
| CAMERA.ENABLE | Camera | PRIVATE | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enables camera which can be disabled when loading images from the PC. | ALL |
| CAMERA.EXPOSURE | Camera | PUBLIC | 3.0.0 | SET|GET | auto target exposure gain |
[ON|OFF] [0-255] [0-22] [4-60] |
ON: Automatic OFF: Manual target pixel value 0: 1/10000 1: 1/7500 2: 1/5000 3: 1/4000 4: 1/3000 5: 1/2500 6: 1/2000 7: 1/1500 8: 1/1250 9: 1/1000 10: 1/750 11: 1/500 12: 1/300 13: 1/250 14: 1/200 15: 1/150 16: 1/125 17: 1/100 18: 1/75 19: 1/50 20: 1/40 21: 1/30000 22: 1/15000 camera gain |
Camera Parameters. The arguments 'exposure' and 'gain' have no effect if 'auto' is ON and the 'target' has no effect if 'auto' is OFF. | DM700. |
| CAMERA.EXPOSURE | Camera | PRIVATE | 3.0.0 | SET|GET | auto target exposure gain |
[ON|OFF] [0-255] [0-20] [1-19] |
ON: Automatic OFF: Manual target pixel value 0: 1/20000 1: 1/10000 2: 1/7500 3: 1/5000 4: 1/3000 5: 1/2500 6: 1/2000 7: 1/1500 8: 1/1250 9: 1/1000 10: 1/750 11: 1/500 12: 1/300 13: 1/250 14: 1/200 15: 1/150 16: 1/125 17: 1/100 18: 1/75 19: 1/50 20: 1/40 camera gain |
Camera Parameters. The arguments 'exposure' and 'gain' have no effect if 'auto' is ON and the 'target' has no effect if 'auto' is OFF. | DM7500 |
| CAMERA.EXPOSURE | Camera | PUBLIC | 5.6.0 | SET|GET | exposure |
[18-25000] | exposure | Camera Parameters where exposure is in microseconds. | DM50, DM60, DM70, DM150, and DM260 |
| CAMERA.EXPOSURE | Camera | PUBLIC | 5.6.0 | SET|GET | exposure |
[5-1000] [12-1000] [5-100000] |
DM300 and DM302 internal illumination DM303 internal illumination with external or no illumination |
Camera Parameters where exposure is in microseconds. | DM300 series readers, DM360 series readers, DM474, DM8600. |
| CAMERA.EXPOSURE | Camera | PUBLIC | 5.6.0 | SET|GET | exposure |
[12-100000] | exposure independent of illumination | Camera Parameters where exposure is in microseconds. | DM503 |
| CAMERA.EXPOSURE-LIMIT-US | Camera | PUBLIC | 5.5.0 | GET | exposure |
maximum value allowed for SET CAMERA.EXPOSURE-US | Get the maximum allowed exposure limited by current settings in us. | Fixed Mount readers. | |
| CAMERA.EXPOSURE-US | Camera | PUBLIC | 5.5.0 | SET|GET | auto target exposure gain |
[ON|OFF] [0-255] [18-25000] [0-60] |
ON: Automatic OFF: Manual target pixel value exposure camera gain |
Camera Parameters where exposure is in microseconds. The argument 'exposure' and 'gain' has no effect if 'auto' is ON and 'target' has no effect at all. | DM50, DM60, DM70, DM150, DM260 |
| CAMERA.EXPOSURE-US | Camera | PUBLIC | 5.5.0 | SET|GET | auto target exposure gain |
[ON|OFF] [0-255] [5-1000] [12-1000] [5-100000] [0-106] |
ON: Automatic OFF: Manual target pixel value DM300 and DM302 internal illumination DM303 internal illumination with external or no illumination camera gain |
Camera Parameters where exposure is in microseconds. The argument 'exposure' and 'gain' has no effect if 'auto' is ON and 'target' has no effect at all. | DM300 series readers, DM360 series readers, DM474, DM8600. |
| CAMERA.EXPOSURE-US | Camera | PUBLIC | 5.5.0 | SET|GET | auto target exposure gain |
[ON|OFF] [0-255] [12-100000] [0-41] |
ON: Automatic OFF: Manual target pixel value exposure independent of illumination camera gain |
Camera Parameters where exposure is in microseconds. The argument 'exposure' and 'gain' has no effect if 'auto' is ON and 'target' has no effect at all. | DM503 |
| CAMERA.EXPOSURE-US | Camera | PUBLIC | 5.5.0 | SET|GET | auto target exposure gain |
[ON|OFF] [0-255] [50-25000] [0-60] |
ON: Automatic OFF: Manual target pixel value camera gain |
Camera Parameters where exposure is in microseconds. The argument 'exposure' and 'gain' has no effect if 'auto' is ON and 'target' has no effect at all. | MX-1000 and DM8000 series readers. |
| CAMERA.FOV | Camera | PREVIEW | 3.2.0 | SET|GET | left (multiple of 8) right (multiple of 8) top (multiple of 4) bottom (multiple of 4) |
[0...] [left+64...] [0...] [top+64...] |
pixels from left pixels from right pixels from top pixels from bottom |
The camera field of view is the area of the camera used for image acquisition. | ALL |
| CAMERA.FOV-ENABLED | Camera | PUBLIC | 3.2.0 | SET|GET | state |
[ON|OFF] | enable/disable | Indicates whether the full FoV or a custom FoV will be used for image acquisition. You can change this value only for the following trigger types: single, burst, and continuous. |
ALL |
| CAMERA.FULL-BLACK-LEVEL-CORRECTION | Camera | PUBLIC | 5.5.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enables Full black level correction. | DM300 series readers, DM474. |
| CAMERA.GAIN | Camera | PUBLIC | 5.5.0 | SET|GET | gain |
[1.00-31.76] | The gain has no effect if the camera runs with automatic exposure | DM300 series readers, DM474. | |
| CAMERA.GAIN | Camera | PUBLIC | 5.5.0 | SET|GET | gain |
[1.00-13.88] | The gain has no effect if the camera runs with automatic exposure | DM503 | |
| CAMERA.GAIN | Camera | PUBLIC | 5.5.0 | SET|GET | gain |
[1.00-15.00] | The gain has no effect if the camera runs with automatic exposure | DM50, DM60, DM70 | |
| CAMERA.GAIN-LIMIT | Camera | PUBLIC | 5.7.0 | SET|GET | gain |
[1.00-max_gain] | 1.00-max_gain: The maximum gain to use | Controls the maximum gain the tuning and auto-regulation process uses to find the best reader settings. Useful to limit noise in Images. | Fixed mount readers. |
| CAMERA.HDR-ESTIMATED-SCENE-KEY | Camera | PRIVATE | 6.1.0 | SET|GET | estimated scene key |
[0-4095] | Estimated scene key parameter for HDR | DM370 series, DM470 series readers. | |
| CAMERA.HDR-MODE | Camera | PUBLIC | 6.1.0 | SET|GET | mode |
[0-2] |
0: Off 1: Global 2: Local |
HDR mode | DM470 series readers. |
| CAMERA.HDR-MODE | Camera | PUBLIC | 6.1.6 | SET|GET | mode |
[0-1] |
0: Off 1: Global |
HDR mode | DM370 series readers. |
| CAMERA.INTERVAL-US | Camera | PUBLIC | 4.0.0 | SET|GET | us |
[*-1000000] |
Microseconds. Step size is 250. * By default the minimum range is 6000 but this can change depending on decode timeout and field of view. |
Acquisition Interval, the time between successive camera acquisitions in microseconds. Supported with Burst, Self, and Continuous trigger types. | DM50, DM60, DM70, DM474, DM503, and DM300 series readers. |
| CAMERA.MAX-EXPOSURE | Camera | PRIVATE | 3.0.0 | SET|GET | exposure |
[0-20] |
0: 1/20000 1: 1/10000 2: 1/7500 3: 1/5000 4: 1/3000 5: 1/2500 6: 1/2000 7: 1/1500 8: 1/1250 9: 1/1000 10: 1/750 11: 1/500 12: 1/300 13: 1/250 14: 1/200 15: 1/150 16: 1/125 17: 1/100 18: 1/75 19: 1/50 20: 1/40 |
Maximum exposure limit for autoregulation. | MX-1000 and DM8000 series readers. |
| CAMERA.MAX-EXPOSURE-US | Camera | PUBLIC | 4.0.0 | SET|GET | exposure |
[1-50] [1-410] [1-100000] |
with HPIA without HPIA with external or no illumination |
Maximum exposure limit in microseconds for autoregulation. HPIA = High Powered Illumination Accessory. |
DM70, DM150, DM260, DM474, DM503, and DM300 series readers. |
| CAMERA.MAX-EXPOSURE-US | Camera | PUBLIC | 5.1.0 | SET|GET | exposure |
[18-25000] | Maximum exposure limit in microseconds for autoregulation. | DM50, DM60, DM70. | |
| CAMERA.MIRROR-HORIZONTAL | Camera | PUBLIC | 5.2.0 | SET|GET | state |
[ON|OFF] | enable/disable | Mirror acquired image over the vertical axis. | DM474, DM503 and DM300 series readers. |
| CAMERA.MIRROR-VERTICAL | Camera | PUBLIC | 5.2.0 | SET|GET | state |
[ON|OFF] | enable/disable | Mirror acquired image over the horizontal axis. | DM70, DM260, DM474, DM503 and DM300 series readers. |
| CAMERA.ROI | Camera | 3.0.0 | SET|GET | left right top bottom |
|||||
| CAMERA.TARGET-BRIGHTNESS | Camera | PUBLIC | 5.6.0 | SET|GET | target |
[0-255] | target pixel value | Camera Parameters where exposure is in microseconds. | All, except MX series readers. |
| CAMERA.XPAND-ROI | Camera | PUBLIC | 5.5.0 | SET|GET | ROI index left right top bottom |
[1-2] [0 - sensor width] [0 - sensor width] [0 - sensor height] [0 - sensor height] |
ROI index pixels from left pixels from right pixels from top pixels from bottom |
Specifies custom FOVE regions. Requires the 1DDataStitching feature key. |
DM70, DM150, DM260, DM300 series readers, DM474, DM503. |
| CAMERA.XPAND-ROI-TYPE | Camera | PUBLIC | 5.5.0 | SET|GET | int |
[0-3] |
0: None 1: Xpand-15 2: Xpand-25 3: Custom |
Indicates the used FOVE type. Requires the 1DDataStitching feature key. |
DM70, DM150, DM260, DM300 series readers, DM474, DM503. |
| CODABAR.CHKCHAR | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Codabar Check Character. | ALL |
| CODABAR.CODESIZE | Symbology | PUBLIC | 3.0.0 | SET|GET | any min max |
[ON|OFF] [1-max] [min-80] |
any length code minimum code length maximum code length |
Codabar Code Size. | ALL |
| CODABAR.QZ-SIZE | Symbology | PRIVATE | 3.0.0 | SET|GET | state |
[0|100] | Quiet zone single strictness size. | ALL | |
| CODABAR.XMT-START-STOP-CHAR | Decoder | PRIVATE | 6.0.0 | SET|GET | state |
[ON|OFF] |
ON: Enable OFF: Disable |
Enable or disable transmitting start and stop character as part of the decoded string. | Ethernet readers |
| CODABAR.XMTCHK | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Codabar Transmit Check Character. | ALL |
| COM.ALTERNATE-MODE-DISABLE | Decoder | PRIVATE | 5.7.0 | SET|GET | enable |
[ON|OFF] |
ON: alternate mode cable detection enabled OFF: alternate mode cable detection disabled |
Disables alternate mode cable detection. | DM70 |
| COM.AUTO-DETECT | Communication | PRIVATE | 3.0.0 | SET|GET | state |
[ON|OFF] [ON|OFF] | enable/disable | Enables support for simultaneous connection to USB And RS-232. | |
| COM.BAUD-RATE | Communication | PUBLIC | 3.0.0 | SET|GET | rate |
[1-5] |
1: 115200 2: 57600 3: 38400 4: 19200 5: 9600 |
ALL except for MX-1000. | |
| COM.BAUD-RATE - test data | Communication - sample | 3.0.0 | SET|GET | rate |
[1...5] |
1:115200 2:57600 3:38400 4:19200 5:9600 |
RS232 Communication Speed. Does not affect USB communication speed. |
ALL | |
| COM.BUFFER-AUTO-FLUSH | Communication | PUBLIC | 4.2.1 | SET|GET | state |
[ON|OFF] | enable/disable | Determines if the whole content of the offline buffer is automatically flushed to the first Telnet client. If not, flushing must be activated by the client. | Wireless readers. |
| COM.BUFFER-DATA | IO | PRIVATE | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | ||
| COM.BUFFER-DATA | Communication | PUBLIC | 4.2.1 | SET|GET | state |
[ON|OFF] | enable/disable | Offline buffering. | Wireless readers. |
| COM.BUFFER-MODE | Communication | PUBLIC | 4.2.2 | SET|GET | int |
[0-1] |
0: Multiple 1: Single |
Sets or gets the offline buffering mode. | Wireless DM8000 readers. |
| COM.BUFFER-RESET | Action | PUBLIC | 4.2.1 | Clears the content of the offline buffer. | DM8050, DM8600 and MX-1000. | ||||
| COM.BUFFER-START-SEND | Action | PUBLIC | 4.2.1 | Valid if auto-flush is off. Activates buffer data output over Telnet channels (and flushes buffered codes). Data output is stopped every time when all Telnet channels are disconnected. | DM8050, DM8600 and MX-1000. | ||||
| COM.COMMUNICATIONS-MODULE | Communication | PUBLIC | 4.2.0 | GET | type |
[0-3] |
0: Serial 1: Ethernet 2: Wireless 3: Bluetooth |
Returns the type of communication module being used. | MX-1000 and DM8000 series readers. |
| COM.DATA-BITS | Communication | PUBLIC | 3.0.0 | SET|GET | bits |
[7,8] | ALL except for MX-1000. | ||
| COM.DATA-BITS | IO | PRIVATE | 3.0.0 | SET|GET | bits |
[7|8] | RS232 data bits | ||
| COM.DMCC-CHECKSUM | Communication | PRIVATE | 3.4.0 | SET|GET | type |
[0-3] |
0: none 1: XOR 2: CRC16 (Header/Response) 3: CRC16 (Header/Response/Data) |
Checksum used in DMCC response. | |
| COM.DMCC-EVENT | Communication | PRIVATE | 4.2.0 | SET|GET | event_mask |
[0-255] bitfield |
0: none 1: reader online/offline |
Sets which events are sent over DMCC. Used by DataMan SDK. | Wireless readers, base station. |
| COM.DMCC-HEADER | Communication | PRIVATE | 3.4.0 | SET|GET | type |
[0-1] |
0: default 1: include result ID |
Sets or gets the header option used in Extended mode. | |
| COM.DMCC-RESPONSE | Communication | PUBLIC | 3.0.0 | SET|GET | mode |
[0|1] |
0: Silent (default) 1: Extended |
DMCC response format. | ALL |
| COM.DMCC-RESPONSE | Communication | PRIVATE | 3.0.0 | SET|GET | mode |
[0-2] |
0: Silent (default) 1: Extended 2: Extended mode with ||[xxx::length] CR NL data Responses |
DMCC response format. | ALL |
| COM.INTERFACE | Communication | PRIVATE | 5.4.3 | GET | Supported interfaces: RS232, USB, Ethernet, WiFi, Bluetooth. | ||||
| COM.MULTI-PORT | Communication | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable daisy chaining of readers so they share one COM port. | Fixed mount readers. |
| COM.PARITY | Communication | PUBLIC | 3.0.0 | SET|GET | parity |
[0-4] |
0: None 1: Even 2: Odd 3: Space 4: Mark |
All except for MX-1000 and MX-1502. | |
| COM.PROTOCOL | Communication | PUBLIC | 5.7.0 | SET|GET | type |
0..1 |
0: Off 1: RTS/CTS |
Sets hardware handshake type of serial port. | Devices with RTS/CTS lines |
| COM.RS232-ENABLE-PAUSE | Communication | PUBLIC | 5.5.0 | SET|GET | mode |
ON/OFF | Enable/disable pause in output data stream. | DM300 series readers, DM60, DM50, DM70, DM474 | |
| COM.RS232-FILTER | Communication | PRIVATE | 5.0.0_cr7 | SET|GET | state |
[ON|OFF] | enable/disable | Enable or disable the RS-232 filter. | DM300 series readers, DM474. |
| COM.RS232-FILTER-CHAR | Communication | PRIVATE | 5.0.0_cr7 | SET|GET | char |
[0x00-0xFF] | Hex char | Sets or gets the hex value of the character to start filtering after (e.g. 0x03 for ETX). | DM300 series readers, DM474. |
| COM.RS232-INTERCHAR-DELAY | Communication | PUBLIC | 5.5.0 | SET|GET | us |
[0-5000] | milliseconds | Sets or gets the internal delay between sending characters to the serial port. | DM300 series readers, DM60, DM50, DM70, DM360 series readers, DM474, DM503 |
| COM.RS232-ROUTE | Communication | PUBLIC | 4.2.1 | SET|GET | value |
[0-1] |
0: base station 1: associated reader |
Controls to which device RS-232 communication is routed. | DM8000 series wireless readers. |
| COM.SCRIPT | Communication | PRIVATE | 5.3.0 | SET|GET | num-bytes |
Load script from communication channel. | DM474, DM503 and DM300 series readers. | ||
| COM.SCRIPT | Communication | PUBLIC | 5.5.0 | SET|GET | num-bytes |
GET: Retrieves the current communication script. SET: Uploads a communication script. | Fixed-mount readers. | ||
| COM.SCRIPT-ENABLED | Communication | PRIVATE | 5.3.0 | SET|GET | bool |
DM474, DM503 and DM300 series readers. | |||
| COM.SCRIPT-ENABLED | Communication | PUBLIC | 5.5.0 | SET|GET | bool |
Enables/disables communication scripting or retrieves current state. | Fixed-mount readers. | ||
| COM.SCRIPT-ERROR | Communication | PUBLIC | 5.5.0 | GET | message |
script error message | Get the error message for the Custom Communication protocol script | Fixed-mount readers. | |
| COM.STOP-BITS | Communication | PUBLIC | 3.0.0 | SET|GET | bits |
[1-2] | ALL except for MX-1000. | ||
| COM.USB-COMPATIBILITY-MODE | Communication | PUBLIC | 3.0.0 | SET|GET | legacy |
[ON|OFF] |
ON: use pre-3.5.0 driver OFF: default |
Controls USB driver. Reboot is required. |
DM50, DM70 and DM8000 series readers. |
| COM.USB-HID-ONLY | Communication | PUBLIC | 5.4.0 | SET|GET | state |
[ON|OFF] | enable/disable | When enabled, the base station will appear as a single USB Keyboard device on its USB port, instead of a composite device. | DM8000 base station G2 |
| COM.USB-MODE | Communication | PUBLIC | 4.2.1 | SET|GET | type |
[0-1] |
0: USB COM 1: USB HID |
Controls USB based communication channels. | DM50, DM60, DM70, MX-1000, MX-1502 and DM8000 series readers. |
| COM.USB-RE-ENUMERATE-ON-START | Communication | PUBLIC | 5.5 | SET|GET | state |
[ON|OFF]
[ON|OFF] |
enable/disable
ON: USB 1.1 mode OFF: USB 2.0 mode |
Feature to re-enumerate the COM port after firmware is started. | DM8000 series readers. |
| COM.USB-REQUIRE-DTR | Communication | PUBLIC | 5.5.0 | SET|GET | state |
[ON|OFF] [ON|OFF] | enable/disable Enable/Disable | Turns the requirement to assert DTR signal during USB communication On or Off. | DM8050 |
| COM.USB-SPEED | Communication | PUBLIC | 4.2.1 | SET|GET | int |
[ON|OFF] |
ON: USB 1.1 mode OFF: USB 2.0 mode |
Forces the USB into full speed mode. | Every reader connected through USB except MX-1000. |
| COM.USB-TEST-SN | Communication | PRIVATE | 4.2.0 | SET|GET | string |
test serial number | Used by manufacturing to make different devices enumerate on the same CDC COM port. | Base station, DM50, DM60 and DM70. | |
| COM.USB-USE-TEST-SN | Communication | PRIVATE | 4.2.0 | SET|GET | state |
[ON|OFF] [ON|OFF] | enable/disable | Used by manufacturing to make different devices enumerate on the same CDC COM port. | Base station, DM50, DM60 and DM70. |
| COM.WAKEUP | Communication | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Wakeup Message. | ALL |
| COM.XLATEPRNT | Communication | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Translate unprintable characters that are embedded in a symbol. The translated result is output over the connection (for example, COM, USB, Ethernet, USB-KEYBOARD). Note that Data Formatting leading and terminating text are not translated. The characters translated are ASCII values between 0x00 and 0x1F. For example, 0x00 = <NUL>, 0x04 = <EOT>, 0x0a = <LF>, 0x0d = <CR>. | ALL |
| CONFIG-BACKUP.ENABLE | Action | PUBLIC | 5.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enables automatic device configuration backup. | Ethernet readers. DM8000 series wireless readers also support FTP if the base station is connected through Ethernet. |
| CONFIG-BACKUP.IP-ADDRESS | Action | PUBLIC | 5.0.0 | SET|GET | string |
IP address of the Cognex Explorer FTP service. Uses dotted decimal form, such as "192.168.23.42". |
Ethernet readers. DM8000 series wireless readers also support FTP if the base station is connected through Ethernet. | ||
| CONFIG-BACKUP.PASSWORD | Action | PUBLIC | 5.0.0 | SET|GET | string |
Password used to log in to Cognex Explorer FTP service. | Ethernet readers. DM8000 series wireless readers also support FTP if the base station is connected through Ethernet. | ||
| CONFIG-BACKUP.PORT | Action | PUBLIC | 5.0.0 | SET|GET | port |
[0-65535] | Port number of the Cognex Explorer FTP service. | Ethernet readers. DM8000 series wireless readers also support FTP if the base station is connected through Ethernet. | |
| CONFIG-BACKUP.SERVER-TYPE | Communication | PUBLIC | 5.5.0 | SET|GET | type |
[0-1] |
0: Generic 1: Mitsubishi GOT |
Configuration backup server type. | DM474, DM503 and DM300 series readers. |
| CONFIG-BACKUP.USER-NAME | Action | PUBLIC | 5.0.0 | SET|GET | string |
User name used to log in to the Cognex Explorer FTP service. | Ethernet readers. DM8000 series wireless readers also support FTP if the base station is connected through Ethernet. | ||
| CONFIG.DEFAULT | Action | PUBLIC | 3.0.0 | Resets the device’s configuration settings to factory defaults. Device identification and communications settings are not changed. | ALL | ||||
| CONFIG.DUMP-UIDS | Action | PRIVATE | 3.0.0 | Returns all value tree parameters. | ALL | ||||
| CONFIG.EXPORT | Action | PUBLIC | 5.7.0 | Exports a human readable version of the current reader configuration. | ALL | ||||
| CONFIG.LOAD | Action | PUBLIC | 4.4.0 | num-bytes |
Load Configuration from communication channel. Make sure you use a robust communications channel (for example, Ethernet) because this command does not have error checking or retry support and might cause the device to hang. | ALL | |||
| CONFIG.RESTORE | Action | PUBLIC | 3.0.0 | Restores Configuration from Non-Volatile Memory. | ALL | ||||
| CONFIG.SAVE | Action | PUBLIC | 3.0.0 | Saves Configuration to Non-Volatile Memory. | ALL | ||||
| CONFIG.SAVE-DEFAULTS | Action | PRIVATE | 5.4.0 | Saves current settings as defaults. This command does not reboot the device. | ALL | ||||
| CONFIG.SEND | Action | PUBLIC | 3.0.0 | Send device configuration to communication channel. | ALL | ||||
| CONTROL.RPC | Action | PRIVATE | 4.2.0 | SET|GET | string |
RP code to execute. | Executes RP codes passed as string. Used internally to route RP commands to the base station. | ALL | |
| CPFLASH.WRITE | Camera | PRIVATE | 5.0.0 | id |
[0-4] |
0: Unknown 1: Prototype 2: Alpha build with SRAM 3: Alpha build with SDRAM 4: Beta build |
Flash camera port ID. | DM 503. | |
| CQ | Code Quality | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable Code Quality. Code Quality Measurements require reader calibration and the Verification Feature Key. |
DM8600V |
| CQ.CALIB-DATE | Code Quality | PUBLIC | 3.0.0 | GET | Device Code Quality Calibration Date. | DM8600V | |||
| CQ.ILLUMINATION | Code Quality | PUBLIC | 3.0.0 | SET|GET | illumination-option state |
[0-4] [ON|OFF] |
0: Direct on axis 1: 30-deg All Quadrants 2: 30-deg E-W Quadrants 3: 30-deg N-S Quadrants 4: Custom enable/disable |
Code Quality Illumination Option. | DM8600V |
| CQ.METRICS | Code Quality | PUBLIC | 3.0.0 | SET|GET | metric |
[0-3] |
0: AIM-DPM/ISO/IEC TR 29158 1: ISO/IEC 15415 2: AS9132 Laser-etch 3: AS9132 Dot-peen |
Code Quality Enabled Metrics. | DM8600V |
| CQ.MINPASS | Code Quality | PUBLIC | 3.0.0 | SET|GET | metric min-pass |
[0-1] [0-4] |
0: AIM-DPM/ISO/IEC TR 29158 1: ISO/IEC 15415 0: F 1: D 2: C 3: B 4: A |
Code Quality Minimum Passing Grade. Determines the threshold for "validation failure action" including beep and configured line output. |
DM8600V |
| CQ.PROCESSM | Code Quality | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Code Quality Process Control Metrics. | DM8600V |
| CQ.RESET-CALIBRATION | Code Quality | PUBLIC | 3.3.0 | Invalidates code quality calibration data. Reboot is required. |
DM8600V | ||||
| CQ.UNITS | Code Quality | PUBLIC | 3.0.0 | SET|GET | option |
[0-3] |
0: mils 1: mm 2: inches 3: pixels |
Code Quality Units. | DM8600V |
| CUSTOM-CMD.COMMAND-FOOTER | Communication | PUBLIC | 3.2.0 | SET|GET | string |
End of the string to be echoed. See the Overview topic for formatting requirements for the string argument. |
Fixed mount readers. | ||
| CUSTOM-CMD.COMMAND-HEADER | Communication | PUBLIC | 3.2.0 | SET|GET | string |
Start of the string to be echoed. | Fixed mount readers. | ||
| CUSTOM-CMD.ECHO | Communication | PUBLIC | 3.2.0 | SET|GET | state |
[ON|OFF] | enable/disable | Indicates if characters received between a COMMAND-HEADER and COMMAND-FOOTER are echoed. | Fixed mount readers. |
| CUSTOM-CMD.TRIGGER | Communication | PUBLIC | 3.2.0 | SET|GET | state |
[ON|OFF] | enable/disable | Indicates if reader will respond to the TRIGGER-ON or TRIGGER-OFF string. | Fixed mount readers. |
| CUSTOM-CMD.TRIGGER-OFF | Communication | PUBLIC | 3.2.0 | SET|GET | string |
String that will stop a trigger. See the Overview topic for formatting requirements for the string argument. |
Fixed mount readers. | ||
| CUSTOM-CMD.TRIGGER-ON | Communication | PUBLIC | 3.2.0 | SET|GET | string |
String that will start a trigger. See the Overview topic for formatting requirements for the string argument. |
Fixed mount readers. | ||
| DATA.IMAGE-TYPE | Communication | PRIVATE | 3.4.0 | SET|GET | type |
[0-2] |
0: all 1: no read 2: read |
Sets or gets type of image automatically returned. Used in conjuction with DATA.RESULT-TYPE. | |
| DATA.RESULT-ALWAYSSEND | System | PRIVATE | 3.1.0 | SET|GET | state |
[ON|OFF] | enable/disable | Sets gets whether to always send result. | ALL |
| DATA.RESULT-ENCODING | Communication | PUBLIC | 3.1.0 | SET|GET | encoding |
[0|1] |
0: ASCII (default) 1: Base64 |
Result string encoding. | ALL |
| DATA.RESULT-TYPE | System | PRIVATE | 3.1.0 | SET|GET | bit-field |
[0-128] |
0x00 = None 0x01 = Result 0x02 = XML formated result 0x04 = XML formated statistics 0x08 = Image Data 0x10 = Image Graphics 0x20 = Traning Result 0x40 = Code Quality Graphics |
Controls automatic result transmitted from reader. Default is 1. | ALL |
| DATA.RESULT-TYPE | System | PUBLIC | 5.5.0 | SET|GET | bit-field |
[0,1,512] |
0 = None 1 = Result 512 = MS test response |
Controls automatic, result transmitted from reader. Default bits are 1 and 512 (which is 513). | ALL |
| DATA.RESULT-TYPE | System | PRIVATE | 5.0.0_cr10 | SET|GET | bit-field |
[0-511] |
0x00 = None 0x01 = Result 0x100 = Input event message |
Controls automatic result transmitted from reader. Default is 1. | ALL |
| DATABAR.EXPANDED | Symbology | PUBLIC | 3.4.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable Databar expanded. | ALL |
| DATABAR.GROUP | Symbology | PUBLIC | 3.4.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable Databar group. | ALL |
| DATABAR.LIMITED | Symbology | PUBLIC | 3.4.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable Databar limited. | ALL |
| DATAMATRIX.ALGORITHM-VERSION | Symbology | PUBLIC | 3.5.3 | SET|GET | version |
[0-2] |
0: speed preferred 1: yield preferred 2: extended |
IDQuick Usage Type. | Fixed mount readers except for DM300L, DM503L, and DM503QL. 2 (extended) is supported by DM50, DM60, DM70, DM150, DM260. |
| DATAMATRIX.DAMAGE | Decoder | PUBLIC | 5.5.0 | SET|GET | damage level |
[2,4] |
2: moderate 4: extreme |
Set Extreme to enable PowerGrid. | DM300 series readers, DM360, DM474 readers |
| DATAMATRIX.EXTREME-PRINT-GROWTH | Symbology | PUBLIC | 3.4.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable extreme print growth for DataMatrix symbols. | ALL except for DM50, DM60, DM70, DM300, DM503, DM8050 and DM8600. |
| DATAMATRIX.IDMAX-SCALE-UNCERTAINTY-PERCENTAGE | Decoder | PRIVATE | 6.0.1 | SET | percentage |
Specifies Scale Uncertainty Percentage. It is a parameter that allows or limits the tuned DataMatrix decoder to examine code that has different PPM than the originally tuned code. The percentage should be PPM1-PPM2)/PPM1 * 100. Active when IDMax is enabled. | ALL | ||
| DATAMATRIX.PRINT-DEFORMATION | Symbology | PUBLIC | 5.2.0 | SET|GET | state |
[0|1] |
0: Minimal 1: Moderate |
Sets the IDMax Properties. | DM300, DM474, DM503. |
| DATAMATRIX.QUALITY-METRICS | Decoder | PUBLIC | 4.5.0 | SET|GET | type |
[0-3] |
0: none 1: AIM DPM 2: ISO 15415 3: SEMI T10 |
Code quality metrics for DataMatrix. | ALL |
| DATAMATRIX.SCALE-UNCERTAINTY-PERCENTAGE | Decoder | PRIVATE | 6.0.1 | SET | percentage |
Specifies Scale Uncertainty Percentage. It is a parameter that allows or limits the tuned DataMatrix decoder to examine code that has a PPM different than the originally tuned code. The percentage should be (PPM1-PPM2)/PPM1 * 100. Used when IDQuick decoder is enabled. | ALL | ||
| DATAMATRIX.SECURITY-KEY | Symbology | PRIVATE | 3.2.0 | SET | type name |
1 |
1: Custom1 |
Sets the secure Data Matrix key which is 32 byte string. This string needs to be entered in hexadecimal format. | |
| DATAMATRIX.SECURITY-TYPE | Symbology | PRIVATE | 3.2.0 | SET|GET | type state |
[0-1] [ON|OFF] |
0: None 1: Custom1 enable/disable |
Data Matrix security type used. Only valid with a valid security key is set. | ALL |
| DATAMATRIX.SYMBOL-DIFFICULTY | Symbology | PUBLIC | 5.1.0 | SET|GET | int |
[0-2] |
0: Easy 1: Medium 2: Hard |
Level of DataMatrix code symbol difficulty. | DM8600. |
| DATAMATRIX.TRAINED-FLEX-GRID | Symbology | PUBLIC | 5.2.0 | SET|GET | state |
[ON|OFF] | enable/disable | Switches the Trained Code Property "Flexible Grid Size". | DM300, DM474, DM503. |
| DATAMATRIX.TRAINED-IGNORE-POLARITY | Symbology | PUBLIC | 5.2.0 | SET|GET | state |
[ON|OFF] | enable/disable | Switches the Trained Code Property "Ignore Polarity". | DM300, DM474, DM503. |
| DATAMATRIX.TRAINED-MODEL | Decoder | PUBLIC | 5.5.0 | SET|GET | rows columns module-size polarity mirrored |
[8-144] [8-144] [1-1000] [0-2] [ON|OFF] |
Number of rows Number of columns Module size * 10 0: dark-on-light 1: light-on-dark 2: either ON: mirrored OFF: not mirrored |
Train Data Matrix from the given parameters without needing to capture an image. | Fixed-mount readers |
| DATAMATRIX.TYPE | Decoder | PRIVATE | 6.1.6 | SET|GET |
|
[1-3] |
1 = DataMatrix only 2 = DMRE 3 = Both |
Set support level for DataMatrix and/or DataMatrix Rectangular Extensions. | ALL |
| DATAMATRIX.USAGE | Symbology | PUBLIC | 3.0.0 | SET|GET | Usage Type |
[0-1] |
0: Default 1: High speed ink jet mode |
IDMax Usage Type. | ALL except for DM50, DM60, DM70, DM300, DM503. |
| DEBUG.LOG | System | PRIVATE | 5.4.0 | GET | Gets the debug log in development builds, returns nothing for released firmware. | ALL | |||
| DECODER.1D-DATA-STITCH | Decoder | PUBLIC | 5.5.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enables/disables 1D data-stitching. Requires the 1DDataStitching feature key. |
DM70, DM150, DM260, DM300 series readers, DM474, DM503. |
| DECODER.1D-DECODE-STRICTNESS | Decoder | PRIVATE | 6.1.6 | SET|GET |
|
[0-2] |
0 = Conservative 1 = Moderate 2 = Tolerant |
Selects which 1D decoding strictness mode to use. The default is 1 ("Moderate"). With setting 0 ("Conservative"), misreads are reduced, with 2 ("Tolerant"), no-reads are reduced. With setting 1 ("Moderate") this is balanced. | ALL |
| DECODER.1D-EXTENDED-RESOLUTION | Decoder | PUBLIC | 5.5.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enables/disables the 1D extended resolution decoding method. Requires the 1DExtendedRes feature key. |
DM70, DM150, DM260, DM300 series readers, DM474, DM503. |
| DECODER.1D-LEARN-CODESIZE | Decoder | PRIVATE | 3.2.0_cr5 | SET|GET | state |
[ON|OFF] | enable/disable | Learn the code size of 1D Symbols. | ALL |
| DECODER.1D-LEARN-ORIENT | Decoder | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Learn Orientation of 1D Symbols. | Fixed mount readers. |
| DECODER.1D-MINIMUM-DECODES | Symbology | PUBLIC | 5.2.0 | SET|GET | int |
[0-5] | Minimum number of decoded scans to report a confident decoding (to prevent misread). | ALL | |
| DECODER.1D-PICKETFENCE-BARCODE-ONLY | System | PRIVATE | 5.4.0 | GET | |||||
| DECODER.1D-QUALITY-METRICS | Decoder | PUBLIC | 5.2.0 | SET|GET | mode |
[0-1] |
0: none 1: 1D readability |
Enables/disables 1D Process Control Metrics. | ALL |
| DECODER.1D-SHORT-HEIGHT-CODES | Decoder | PRIVATE | 6.0.0 | SET|GET | state |
[ON|OFF] |
ON: Enable OFF: Disable |
Enable or disable Short Height Codes. | Ethernet readers |
| DECODER.1D-SHORT-QUIET-ZONE | Decoder | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | When ON, the reader is tolerant with non-standard (i.e. short) quiet zones. | ALL |
| DECODER.1D-SYMBOL-ORIENTATION | Decoder | PUBLIC | 4.1 | SET|GET | orientation |
[0-3] |
0: Omnidirectional 1: Ladder and Picket Fence (default) 2: Ladder 3: Picket Fence |
Sets or gets the orientation at which codes can be found. Omnidirectional requires the Omnidirectional feature key. | DM50, DM60, DM70, DM474, DM503, MX-1000, MX-1502 and DM300 series readers. DM503L readers support only 2: Ladder and 3: Picket Fence. |
| DECODER.1D-TARGET | Decoder | PRIVATE | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Target Decoding. | MX-1000 and DM8000 series readers. |
| DECODER.1D-USAGE | Decoder | PRIVATE | 3.0.0 | SET|GET | usage-type |
[0-1] |
0: Standard 0: Extended |
1D Symbology Usage Type. | |
| DECODER.1D-USAGE | Decoder | PUBLIC | 3.0.0 | SET|GET | usage |
[0-1] |
0: Standard 1: Extended |
1D Symbology Usage Type. | Fixed mount readers. |
| DECODER.ALLOW-ALL-MST-RESULTS | Decoder | PUBLIC | 5.7.3 | SET|GET | state |
[ON|OFF] |
ON: enable OFF: disable |
Enables or disables re-read delay processing for slave results. | DM300 series readers, DM474, DM503, DM70, DM150, DM260 |
| DECODER.CENTERING-WINDOW | Decoder | PUBLIC | 6.0.0 | SET|GET | center x perc, center y perc, size x perc, size y perc |
[0-100] | Percentage | Location and size of centering window as a percentage of the sensor size. | DM50, DM60, DM70, DM150 DM260, DM300, DM360, DM474, MX-1000 series |
| DECODER.DISPLAY-TARGET | Decoder | PUBLIC | 6.0.0 | SET|GET | state |
[ON|OFF] | Enable/Disable | Displays centering window graphics. | DM50, DM60, DM70, DM150 DM260, DM300, DM360, DM474, MX-1000 series |
| DECODER.EFFORT | Decoder | PUBLIC | 5.7.1 | SET|GET | int |
[0-5] | Sets the effort level used by the decoding algorithms. Default is 2. | All | |
| DECODER.MAC-SCAN-TIMEOUT | Decoder | PUBLIC | 5.7.1 | SET|GET | int |
[0-60] | DM50, DM60, DM70, DM150 DM260, DM300, DM360, DM474, MX-1000, MX1502 | ||
| DECODER.NO-READ-FEEDBACK | Decoder | PRIVATE | 5.5.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enables/disables found but not decoded symbol info. | ALL |
| DECODER.PREPROCESS | Decoder | PRIVATE | 3.4.0 | SET|GET | slot filter param1 param2 param3 |
[0] [0-2] [0-255] [0-255] [0-255] |
slot to configure 0: none 1: Equalize 2: Stretch Filter parameter 1. Filter parameter 2. Filter parameter 2. |
Sets or gets the filter to apply to an image before decoding. | |
| DECODER.REREAD-MODE | Decoder | PUBLIC | 4.4.0 | SET|GET | mode |
[0-1] |
0: last read 1: first read |
Code re-reading delay relative to either the first read or the last. | DM50, DM60, DM70, DM474, DM503, DM300 series readers, DM8050 and DM8600. |
| DECODER.REREAD-NEVER2X | Decoder | PUBLIC | 5.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Never read the same code twice. All trigger modes, e.g. Multicode Reading. |
ALL |
| DECODER.REREAD-NOT-LAST-N | Decoder | PUBLIC | 5.5 SR3 | SET|GET | int |
[0-100] |
0: no restriction 1-100 Define N |
Do not read code if this code was read within the last N reads. | All |
| DECODER.REREAD-TIME | Decoder | PUBLIC | 4.4.0 | SET|GET | ms |
[0-10000] | Milliseconds | Code re-reading delay in milliseconds. | ALL |
| DECODER.ROI | Decoder | PUBLIC | 3.0.0 | SET|GET | left (multiple of 8) right (multiple of 8) top (multiple of 4) bottom (multiple of 4) |
[0...] [left+64...] [0...] [top+64...] |
left of the ROI rectangle right of the ROI rectangle top of the ROI rectangle bottom of the ROI rectangle |
Decoder Region of Interest. Image Region examined by decoder for enabled symbols. Pixel coordinates are relative to the upper left corner of the displayed image. Left < Right and Top < Bottom. Values must not be outside the specified CAMERA.FOV settings. |
ALL |
| DECODER.TARGET-DECODING | Decoder | PUBLIC | 5.7.1 | SET|GET | state |
[ON|OFF] | enable/disable | Enable target decoding, where the reader attempts to symbols that lie only under the aiming dots. | MX-1000, MX-1502 series readers. |
| DECODER.TIMEOUT | Decoder | PUBLIC | 3.0.0 | SET|GET | ms |
[0-10000] | milliseconds | Decoder Timeout. Maximum allowed decode time. |
Fixed mount readers. |
| DECODER.USE-CENTERING | Decoder | PUBLIC | 6.0.0 | SET|GET | state |
[ON|OFF] | Enable/Disable | Only reads codes within the centering window. | DM50, DM60, DM70, DM150, DM260, DM300, DM360, DM474, MX-1000 series |
| DEVICE-LOG.CLEAR | Action | PUBLIC | 5.2.0 | This command clears the device log. | DM50, DM60, DM70, DM474, DM503, DM300 series readers, DM8050, DM8600, MX-1000 and MX-1502. | ||||
| DEVICE.APPLOADER-VER | System | PRIVATE | 5.4.0 | GET | Returns the Apploader version. | ||||
| DEVICE.BACKUP | Action | PUBLIC | 3.3.0 | Send encrypted backup file (.cdc) to the PC. | ALL | ||||
| DEVICE.BOOT-VER | System | PRIVATE | 3.0.0 | ||||||
| DEVICE.CGNM-DEV-TYPE | System | PRIVATE | 5.5.1 | GET | Returns the CogNamer device type. | ALL | |||
| DEVICE.DEFAULT | Action | PUBLIC | 3.0.0 | Resets all device settings to factory defaults. This command reboots the device. | ALL | ||||
| DEVICE.DEFAULT-MFG | Action | PRIVATE | 5.4.0 | Resets all device settings to Cognex defaults. This command reboots the device. | DM8050, DM8600. | ||||
| DEVICE.DESCRIPTION | System | PUBLIC | 5.7.0 | SET|GET | state |
[0-127] | description | Store device description for inventory management. | ALL |
| DEVICE.FAILSAFE-VER | System | PRIVATE | 5.4.0 | GET | Returns the Failsafe version. | ||||
| DEVICE.FEATURE-KEYS | System | PUBLIC | 3.0.0 | GET | Device Feature Keys. | ALL | |||
| DEVICE.FIRMWARE-VER | System | PUBLIC | 3.0.0 | GET | Device Firmware Version. | ALL | |||
| DEVICE.FLASH | PRIVATE | 3.0.0 | begin numbytes |
||||||
| DEVICE.ID | Camera | PRIVATE | 5.4.0 | GET | string |
Returns the device id. | ALL | ||
| DEVICE.LENS-TYPE | Camera | PRIVATE | 5.0.0 | GET | type |
This command gives you the lens type when a liquid lens is installed. | ALL | ||
| DEVICE.LOG | Action | PUBLIC | 4.4.0 | GET | Get the device log of error and exception conditions such as missed triggers and trigger overruns. | DM50, DM60, DM70, DM474, DM503, DM300 series readers, DM8050 and DM8600. | |||
| DEVICE.MAC-ADDRESS | Communication | PUBLIC | 3.3.0 | GET | Reader's MAC address. | Ethernet readers. | |||
| DEVICE.NAME | System | PUBLIC | 3.0.0 | SET|GET | string |
Device Name. MX + the last six digits of DEVICE.SERIAL-NUMBER | ALL | ||
| DEVICE.RESTORE | Action | PUBLIC | 3.3.0 | file size |
Transmits backup file (.cdc) to the reader. File size is in bytes. File data follows footer. | ALL | |||
| DEVICE.SAVE | System | PRIVATE | 3.0.0 | ||||||
| DEVICE.SCRIPT-HEAP-SIZE-LIMIT | Communication | PRIVATE | 5.5.0 | SET|GET | size |
204800-2147483647 | Maximum size in bytes | Maximum heap size the script engine may allocate. | Fixed mount readers |
| DEVICE.SCRIPT-HEAP-USAGE-CURRENT | Communication | PRIVATE | 5.5.0 | GET | size |
Currently used heap size | The size of heap the script currently allocates. | Fixed mount readers | |
| DEVICE.SCRIPT-HEAP-USAGE-MAX | Communication | PRIVATE | 5.5.0 | GET | size |
Maximum used heap size | The maximum size of heap the script allocated allocated. | Fixed mount readers | |
| DEVICE.SERIAL-NUMBER | System | PUBLIC | 3.0.0 | GET | Device Serial Number. | ALL | |||
| DEVICE.SHIPPEDAS-VER | System | PRIVATE | 3.0.0 | GET | |||||
| DEVICE.SSID | Communication | PUBLIC | 4.2.0 | SET|GET | string |
Network name. | Wireless readers. | ||
| DEVICE.START-VER | System | PRIVATE | 3.0.0 | ||||||
| DEVICE.STATS | Action | PRIVATE | 5.2.0 | GET | Get decode statistics. | All. | |||
| DEVICE.SUBCLASS | System | PRIVATE | 5.4.0 | GET | string |
Activates the relevant device subclasses. | |||
| DEVICE.SYSLOG-IP | Communication | PRIVATE | 5.0.0 | SET|GET | string |
Specifies the remote syslog server IP address. | |||
| DEVICE.TIMEZONE | Action | PUBLIC | 5.7.0 | SET|GET | timezone |
Location or POSIX timezone | Get or set the timezone for local time. | All | |
| DEVICE.TYPE | System | PUBLIC | 3.0.0 | GET | Device Type. | ALL | |||
| DMCC.RESET | Action | PUBLIC | 4.4.0 | When sent, the DMCC resets the following DMCC back to default: COM.DMCC-RESPONSE, COM.DMCC-CHECKSUM, COM.DMCC-HEADER, DATA.RESULT-TYPE, DATA.RESULT-ENCODING, DATA.RESULT-ALWAYSSEND, DATA.IMAGE-TYPE. | ALL | ||||
| DMCC.SAVE | Action | PUBLIC | 4.4.0 | Saves DMCC connection settings. It also saves the status for a new connection session for the following DMCC: COM.DMCC-RESPONSE, COM.DMCC-CHECKSUM, COM.DMCC-HEADER, DATA.RESULT-TYPE, DATA.RESULT-ENCODING, DATA.RESULT-ALWAYSSEND, DATA.IMAGE-TYPE. | ALL | ||||
| DMPOP | System | PRIVATE | 3.0.0 | GET | vtree path |
Gets value tree parameter. | |||
| DMPOP.INFO | System | PRIVATE | 3.1.0 | GET | vtree path |
Gets Device Info value tree parameter. | |||
| DMPUSH | System | PRIVATE | 3.0.0 | SET | vtree path |
Sets value tree parameter. | |||
| DMPUSH.INFO | System | PRIVATE | 3.1.0 | SET | vtree path |
Sets Device Info value tree parameter. DMCC Key is required. | |||
| DMSTATS | System | PRIVATE | 3.1.0 | vtree path |
Returns argument range for value tree parameter. e.g. ||>DMSTATS /ROI/Left |
||||
| DOTCODE.MAXIMUM-COLUMNS | Decoder | PUBLIC | 5.4.0 | SET|GET | int |
[11-128] | The default is 128. | DM300 series readers, DM474, DM8050X and DM8600. | |
| DOTCODE.MAXIMUM-ROWS | Decoder | PUBLIC | 5.4.0 | SET|GET | int |
[5-128] | The default is 32. | DM300 series readers, DM474, DM8050X and DM8600. | |
| DOTCODE.MINIMUM-COLUMNS | Decoder | PUBLIC | 5.4.0 | SET|GET | int |
[11-128] | The default is 16. | DM300 series readers, DM474, DM8050X and DM8600. | |
| DOTCODE.MINIMUM-ROWS | Decoder | PUBLIC | 5.4.0 | SET|GET | int |
[5-128] |
The default is 6. |
DM300 series readers, DM474, DM8050X and DM8600. | |
| DOTCODE.POLARITY | Decoder | PUBLIC | 5.4.0 | SET|GET | int |
[0-2] |
0: Dark on Light 1: Light on Dark 2: Either |
DM300 series readers, DM474, DM8050X and DM8600. | |
| DOTCODE.QUALITY-METRICS | Decoder | PRIVATE | 5.5.0 | SET|GET | mode |
[0-1] |
0: none 1: enable AIM metrics |
Enable Subset of Quality Metrics from DotCode AIM Specification. | DM474, DM503, DM300 series readers, DM8050X and DM8600. |
| DVALID.DOD-EXEID | Data Validation | PUBLIC | 3.0.0 | SET|GET | string |
expected-EID | DoD Expected Enterprise ID (EID). | ALL | |
| DVALID.DOD-EXPN | Data Validation | PUBLIC | 3.0.0 | SET|GET | string |
expected-PN | DoD Expected Part Number. See the Overview topic for formatting requirements for the string argument. |
ALL | |
| DVALID.DODCNSTRT | Data Validation | PUBLIC | 3.0.0 | SET|GET | construct |
[0-3] |
0: Any 1: Construct #1 2: Construct #2 3: Equivalent |
Data Validation DoD Construct. | ALL |
| DVALID.FAIL-ACTION | Data Validation | PUBLIC | 3.0.0 | SET|GET | action |
[0-3] |
0: Transmit "Validation Failure" 1: Transmit "Validation Failure" + decoded string 2: Transmit annotated decode string 3: Transmit nothing |
Data Validation Failure Action. | ALL |
| DVALID.FAIL-XMT-CRLF | Data Validation | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Data Validation Transimit CRLF on Failure. | ALL |
| DVALID.GS1-FORMAT | Data Validation | PUBLIC | 3.4.0 | SET|GET | string |
GS1 format string | Set GS1 format string. | ALL | |
| DVALID.ISO-CONSTRUCT | Data Validation | PUBLIC | 3.0.0 | SET|GET | construct |
[0-1] |
0: ISO 15434 1: ISO 15434 & ISO 15418 |
ISO Construct. | ALL |
| DVALID.MATCH-STRING | Data Validation | PUBLIC | 3.0.0 | SET|GET | string |
match-string | Data Validation Match-String. See the Overview topic for formatting requirements for the string argument. |
ALL | |
| DVALID.MATCH-STRING-EMPTY-RESULT | Data Validation | PRIVATE | 4.4.0 | SET|GET | action |
[0-1] |
0: empty match string fails 1: empty match string passes |
Gets or sets if a match string validation attempt with an empty match string should fail (0=default) or pass (1). | ALL |
| DVALID.MATCH-STRING-PARAMS | Data Validation | PUBLIC | 3.0.0 | SET|GET | increment start length step no-read validation-fail |
[ON|OFF]
[0-*] [1-*] [-2|-1|0|1|2] [ON|OFF] [ON|OFF] |
enable/disable
start position of numerical match number of digits increment enable/disable update on no-read enable/disable update on validation failure |
Data Validation Match-String Parameters. | ALL |
| DVALID.PATTERN | Data Validation | PUBLIC | 3.0.0 | SET|GET | string |
pattern-string | Data Validation Pattern. Regexp Data Validation. See the Overview topic for formatting requirements for the string argument. |
ALL | |
| DVALID.PROG-TARG | Data Validation | PUBLIC | 4.4.0 | SET|GET | category |
[1-5] |
1: DataMatrix 2: QR Code/MaxiCode/AztecCode 3: Linear/ Postal/ Stacked 4: VeriCode® 5: DotCode |
Data Validation Programming Target. Data Validation Symbology Set to be modified by subsequent commands. Once issued, this command changes the subsequent behavior of the reader. |
ALL |
| DVALID.TYPE | Data Validation | PUBLIC | 3.0.0 | SET|GET | type |
[0-5] |
0: None 1: DoD UID 2: ISO 3: Pattern 4: Match String 5: GS1 |
ALL | |
| EAN-UCC.CC-C | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable or disable Composite Code C. | ALL |
| EAN-UCC.XMTMODE | Symbology | PUBLIC | 3.0.0 | SET|GET | mode |
[0-1] |
0: Standard (linear & 2D) 1: Linear only |
EAN-UCC Transmit mode. | ALL |
| ENCODER.COUNT | IO | PUBLIC | 4.1.0 | SET|GET | value |
[0-2 billion] | value to set | Gets the encoder count or sets it to the specified value. | Fixed-mount readers |
| ENCODER.DISTANCE-TO-OUTPUT | IO | PUBLIC | 4.1.0 | SET|GET | int |
0-1000000 mm |
Default: 0 Min: 0 Max: 1000000 Step: 1 |
Sets the output distance from the trigger on the sensor. | DM300 series readers, DM474. |
| ENCODER.DOUBLE-RATE | IO | PUBLIC | 5.7.0 | SET|GET | boolean |
[ON|OFF] | Edge detection | If set to ON, Encoder will count both edges on the Encoder Input line. If set to OFF, Encoder will count only the selected edge. | DM503 |
| ENCODER.DOUBLE-RATE | IO | PUBLIC | 6.1.6 | SET|GET | boolean |
[ON|OFF] | Edge detection | If set to ON, Encoder will count both edges on the Encoder Input line. If set to OFF, Encoder will count only the selected edge. | DM360, DM370, and DM470 series readers. |
| ENCODER.FLUSH | IO | PUBLIC | 4.1.0 | Flushes all encoder actions. | DM474, DM503 and DM300 series readers. | ||||
| ENCODER.MODE | IO | PUBLIC | 5.5.0 | SET|GET | value |
[0-4] |
0: Encoder A signal counts up, Encoder B signal counts down. 1: Encoder A signal counts up, Encoder B signal counts down. 2: Encoder A and Encoder B form quadrature (SIN/COS) signal, 1 count per cycle. 3: Encoder A and Encoder B form quadrature (SIN/COS) signal, 2 counts per cycle. 4: Encoder A and Encoder B form quadrature (SIN/COS) signal, 4 counts per cycle. |
Encoder mode. Sets the mode the encoder signals are interpreted if the Encoder Direction pin is defined. | Fixed-mount readers |
| ENCODER.RESET | IO | PUBLIC | 5.5.0 | Resets the encoder count to 0 and clears all encoder related events. | Fixed-mount readers | ||||
| ENCODER.RESOLUTION | IO | PUBLIC | 4.1.0 | SET|GET | int |
0-1000000 um |
Default: 5000 Min: 0 Max: 1000000 Step: 1 |
Sets the distance per pulse of the encoder. | DM474, DM503, and DM300 series readers. |
| ERROR-LED.ENABLE | Action | PRIVATE | 4.5.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enables/disables error log LED. | DM50, DM60, DM70, DM503, DM474 and DM300 series readers. |
| ERROR-LED.ENABLE | Action | PRIVATE | 4.4.0_cr1_sr1 | SET|GET | state |
[ON|OFF] | enable/disable | Enables/disables error log LED. | DM300 series readers. |
| ERROR-LED.ON-TIME-MS | System | PUBLIC | 5.7.0 | SET|GET | duration |
Sets the duration for the Error LED in ms. Use 0 for unlimited duration. | All devices with an error LED. | ||
| ETHERNET-IP.ENABLED | Communication | PUBLIC | 3.3.0_cr1 | SET|GET | state |
[ON|OFF] | enable/disable | Enabled or disabled EtherNet/IP communications. | Ethernet readers. The DM8000 series wireless readers also support this protocol if the base station is connected through Ethernet. In the case of a Bluetooth connection, the command has to be sent to the base station, not to the reader. |
| EVENT.RULES | IO | PRIVATE | 3.4.0 | SET|GET | rules |
||||
| FILE.LOAD | Action | PRIVATE | 4.5.0 | This command can be used to upload a file into DataMan flash filesystem. It should be specified as 'FILE.LOAD "Length" "Filename"'. This DMCC is password-protected. |
ALL | ||||
| FILE.SAVE | Action | PRIVATE | 5.7.0 | filename |
This command can be used to load file from flash, e.g. FILE.SEND "/files/vs.cfg". | ALL | |||
| FILE.UNLINK | System | PRIVATE | 3.3.0 | file |
Remove file from file system. | ||||
| FILTER.IMAGE-TO-USE-SYMBOL | Decoder | PUBLIC | 4.3.0 | SET|GET | symbology input |
[1-5] [0-1] |
1: DataMatrix 2: QR Code/MaxiCode/AztecCode 3: Linear/ Postal/ Stacked 4: VeriCode® 5: DotCode 0: original image 1: filtered image |
Sets or gets which type of symbology should be filtered or not. AztecCode is only supported on the DM503 and DM300 series readers. |
DM50, DM60, DM70, DM150, DM260, DM300 series readers, DM474. |
| FILTER.NOREAD-IMAGE | Decoder | PUBLIC | 4.3.0 | SET|GET | symbology |
[0-5] |
0: Any 1: DataMatrix 2: QR Code/MaxiCode/AztecCode 3: Linear/ Postal/ Stacked 4: VeriCode® 5: DotCode |
Sets or gets if the symbology selected should be filtered if the image is no-read. AztecCode is only supported on the DM503 and DM300 series readers. |
DM50, DM60, DM70, DM150, DM260, DM300 series readers, DM474. |
| FILTER.STACK | Decoder | PUBLIC | 4.3.0 | SET|GET | step method value1 value2 value3 |
[1-4] [0-11] [0-255] |
Filter step 0: no filtering 1: equalize 2: stretch 3: low pass 4: dilate 5: erode 6: open 7: close 8: auto stretch 9: optical density 10: invert 11: median method parameter |
The first value sets the order of the filter steps. Filter step 1 is the first step, filter step 2 is the second, and so on. The second value sets the filter to be used. The third value means the additional properties that you can set for the given filter. You cannot configure the whole stack with one statement, but each on its own.The following example: SET FILTER.STACK 2 2 0 100 0 sets the second step in the filter, for stretch from 0 to 100, leaving the third value unused (0).The following example: GET FILTER.STACK 3 (for the third filter) returns 5 4 3 meaning that filter number 5, that is, erode is on, with parameters 4, 3. | DM50, DM60, DM70, DM150, DM260, DM300 series readers, DM474. |
| FIRMWARE.LOAD | System | PRIVATE | 3.1.0 | file size date from location |
|
|
Loads firmware file to reader. File data follows DMCC footer. Forces a reboot. | ||
| FIRMWARE.LOAD-NOREBOOT | System | PRIVATE | 3.1.0 | file size date from location |
|
|
Loads firmware file to reader. File data follows DMCC footer. | ||
| FKEY.LOAD | System | PRIVATE | 3.1.0 | key size |
Loads encrypted feature key string to reader. Key data follows DMCC footer. Forces a reboot. | ||||
| FKEY.LOAD-NOREBOOT | System | PRIVATE | 3.1.0 | key size |
Loads encrypted feature key string to reader. Key data follows DMCC footer. | ||||
| FKEY.SAVE | System | PRIVATE | 3.1.0 | Saves feature key to flash memory. | |||||
| FLASH.AT70-INIT | Action | PRIVATE | 5.7.1 | magic |
647391673 | Magic number | This command clears AT70 Config block in flash memory. | AT70 based devices | |
| FLASH.ERASE | System | PRIVATE | 3.1.0 | sec number sec offset size |
|
|
Used to reset feature key data section. Obsolete in 3.3 by FILE.UNLINK. | ||
| FLASH.GET | System | PRIVATE | 3.1.0 | sec number sec offset size |
|
|
Output the specified section of Flash. | ||
| FOCUS.CALIBRATE | Action | PRIVATE | 6.0.1 | Compute C-mount flange distance for early units and store in manufacturing data. | DM47x, DM37x | ||||
| FOCUS.COMPENSATE-AFTER-IDLE | Camera | PRIVATE | 5.2.0 | SET|GET | time |
[1-10000] | idle time | Compensates temperature changes after camera is idle for this time. | Liquid lens. |
| FOCUS.DISTANCE | Camera | PUBLIC | 4.0.0 | SET|GET | int |
Distance in mm from the front of the camera to the part. This command returns the value only if Focus Steps is set to 0, otherwise you need to use FOCUS.SWEEP-RANGE instead. |
DM300 series readers, DM474. | ||
| FOCUS.EXTENDED-RANGE | Camera | PUBLIC | 5.7.0 | GET | value |
[ON|OFF] | Extended Focus Range | Indicates that the reader operates in the extended focus range of ON. In this mode GET FOCUS.DISTANCE will return with an error. | Fixed-mount readers with Liquid Lens |
| FOCUS.EXTENDED-RANGE-START | Camera | PRIVATE | 5.7.0 | SET|GET | distance |
[50..4000] | define start of extended range | Defines the start of the extended focus range. Above this distance only optical power can be used to control the Liquid Lens. | Fixed-mount readers with Liquid Lens |
| FOCUS.FAST-DELAY | Camera | PRIVATE | 4.0.0 | SET|GET | value |
??? | |||
| FOCUS.FEEDBACK | Camera | PUBLIC | 4.3.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enables focus feedback. | DM474, DM503 and DM300 series readers. |
| FOCUS.FOCUS-TIME | Camera | PRIVATE | 4.0.0 | SET|GET | value |
[0-3] | |||
| FOCUS.HALL-SENSOR | Camera | PRIVATE | 5.2.0 | GET | value |
??? | |||
| FOCUS.POWER | Camera | PUBLIC | 5.7.0 | SET|GET | optical power |
[-6.0 .. 20.00] | Optical Power in Diopters | Conrols the optical power of the liquid lens. The actual range is dependent on the hardware and on manufacturing tolerances. | Fixed-mount readers with Liquid Lens |
| FOCUS.POWER-RANGE | Camera | PRIVATE | 5.7.1 | GET | Optical Power |
[liquid lens specific] | Optical Power in Diopters | Return minimum (first value) and maximun (second value) optical power values. | Readers with Liquid Lens |
| FOCUS.PRECISION | Camera | PUBLIC | 5.7.0 | SET|GET | settle mode |
[0..1] |
0: normal focus control 1: precise focus control |
Controls the liquid lens focus control between normal focus control and slow but more precise mode. | Fixed mount readers with a liquid lens. |
| FOCUS.PROGRESS | Camera | PUBLIC | 5.7.0 | SET|GET | enable |
[ON|OFF] |
ON: focus progress on OFF: focus progress off |
Enable transfer of intermittent focus images during adjust focus. | Fixed mount readers with a liquid lens. |
| FOCUS.RELAX-TIME | Camera | PRIVATE | 4.0.0 | SET|GET | value |
??? | |||
| FOCUS.STRATEGY | Camera | PRIVATE | 4.0.0 | SET|GET | value |
??? | |||
| FOCUS.SWEEP-POWER | Camera | PUBLIC | 5.7.3 | SET|GET | Optical Power for near distance Optical Power for far distance |
liquid lens specific liquid lens specific |
Optical Power in Diopters Optical Power in Diopters |
Returns near (first value) and far (second value) optical power values. | Readers with Liquid Lens. |
| FOCUS.SWEEP-RANGE | Camera | PUBLIC | 3.6.0 | SET|GET | DM8000 DM300 |
[0-500] [0-500] [40-500] [40-500] |
low sweep range high sweep range low sweep range high sweep range |
Defines the sweep range to be used for focusing. Low must be less than high. The low value is ignored if FOCUS.SWEEP-STEPS is set to 0. | DM70, DM260, DM300 series, DM474 and DM8000 series readers. |
| FOCUS.SWEEP-STEPS | Camera | PUBLIC | 3.6.0 | SET|GET | value |
[0-8] | number of steps to divide the sweep range | Sets the number of steps the sweep range should be divided by. If steps is set to 0 only the high sweep range value is used. | DM70, DM260, DM474, DM8000 series and DM300 series readers. |
| FOCUS.TEMPERATURE-COMPENSATIONS | Camera | PRIVATE | 5.7.0 | SET|GET | state |
ON/OFF | Enable or disable the temperature compensation for the liquid lense HSLC. | Fixed mount readers with a Liquid Lens. | |
| FORMAT.ADVANCED | Data Formatting | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable Data Formatting Advanced Mode. Advanced Mode Formatting Enables: Regexp Pattern Substitution. |
ALL |
| FORMAT.CRLF-END | Data Formatting | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Data Formatting CRLF Terminator. Requires Data Formatting Standard Mode Enabled. |
ALL |
| FORMAT.DELIMITER | Data Formatting | PUBLIC | 3.0.0 | SET|GET | delimiter-option |
[0-5] |
0: none 1: space 2: comma 3: tab 4: label 5: xml |
Data Formatting Delimiter. Sets the delimeter between Data Formatting Tokens. Requires Data Formatting Standard Mode Enabled. |
ALL |
| FORMAT.DISCARD-UNMATCHED | Data Formatting | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Data Formatting Discard Unmatched Data. | ALL |
| FORMAT.MODE | Data Formatting | PUBLIC | 4.5.0 | SET|GET | mode |
[0-1] |
0: basic formatting 1: script-based formatting |
Specifies data formatting mode. By default, basic formatting is the set formatting mode. |
DM50, DM60, DM70, DM474, DM503, MX-1000, MX-1502 and DM300 series readers. |
| FORMAT.MULTICODE-DELIMITER | Data Formatting | PUBLIC | 3.2.0 | SET|GET | type |
[0-6] |
0: none 1: space 2: comma 3: tab 4: label 5: xml 6: CRLF |
Data Formatting Delimiter. Sets the delimiter between codes in a multicode result. |
Fixed mount readers. |
| FORMAT.PROG-TARG | Data Formatting | PUBLIC | 3.2.0 | SET|GET | category |
[0-5] |
0: Universal 1: DataMatrix 2: QR Code/MaxiCode/AztecCode 3: Linear/ Postal/ Stacked 4: VeriCode® 5: DotCode |
Data Formatting Programming Target. Data Formatting Symbology Set to be modified by subsequent commands. Once issued, it changes the subsequent behavior of the reader. AztecCode is only supported on the DM503 and DM300 series readers. |
ALL |
| FORMAT.REGEXP | Data Formatting | PUBLIC | 3.0.0 | SET|GET | string |
regular expression string | Data Formatting Regular Expression. Requires Data Formatting Advanced Mode Enabled. See the Overview topic for formatting requirements for the string argument. |
ALL | |
| FORMAT.SCRIPT | Data Formatting | PUBLIC | 5.2.0 | SET|GET | num-bytes |
Set: loads the script from the host to the reader. Get: sends the script from the reader to the host. | DM474, DM503, MX-1000, MX-1502 and DM300 series readers. | ||
| FORMAT.STANDARD | Data Formatting | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable Data Formatting Standard Mode. Standard Mode Formatting Enables: Leading Text, Data, Data Delimeter, Terminating Text, Terminating CRLF. |
ALL |
| FORMAT.TEXT-BEGIN | Data Formatting | PUBLIC | 3.0.0 | SET|GET | string |
leading output text | Data Formatting Leading Text. Requires Data Formatting Standard Mode Enabled. See the Overview topic for formatting requirements for the string argument. |
ALL | |
| FORMAT.TEXT-END | Data Formatting | PUBLIC | 3.0.0 | SET|GET | string |
trailing text | Data Formatting Trailing Text. Requires Data Formatting Standard Mode Enabled. See the Overview topic for formatting requirements for the string argument. |
ALL | |
| FORMAT.TOKEN | Data Formatting | PUBLIC | 3.0.0 | SET|GET | string |
token string | Data Formatting Standard Data. Regardless of the parameters given to GET FORMAT.TOKEN, it will return the current data formatting token string contained in the Standard Formatting window pointed to by the current value of GET FORMAT.PROG-TARG. See Data Formatting Token Table for available elements. See the Overview topic for formatting requirements for the string argument. |
ALL | |
| FTP-IMAGE.CUSTOM-FILE-NAME | Communication | PUBLIC | 3.3.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable/disable FTP server generated file name. | Ethernet readers. DM8000 series wireless readers also support FTP if the base station is connected through Ethernet. |
| FTP-IMAGE.FILE-NAME | Communication | PUBLIC | 3.3.0 | SET|GET | string |
File name of FTP image. | Ethernet readers. DM8000 series wireless readers also support FTP if the base station is connected through Ethernet. | ||
| FTP-IMAGE.FILE-NAME-USE-SCRIPT | Communication | PUBLIC | 5.2.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enables FTP file name generation script. | DM474, DM503 and DM300 series readers. |
| FTP-IMAGE.IDLE-LIMIT | Communication | PUBLIC | 5.5.0 | SET|GET | state |
[ON|OFF] | enable/disable | Limit duration of idle connections. | DM474, DM503 and DM300 series readers. |
| FTP-IMAGE.IDLE-TIME | Communication | PUBLIC | 5.5.0 | SET|GET | seconds |
Maximum duration of telling the FTP server that the reader is alive. | DM474, DM503 and DM300 series readers. | ||
| FTP-IMAGE.IP-ADDRESS | Communication | PUBLIC | 3.3.0 | SET|GET | string |
IP address of target FTP server. Uses dotted decimal form, such as "192.168.23.42". |
Ethernet readers. DM8000 series wireless readers also support FTP if the base station is connected through Ethernet. | ||
| FTP-IMAGE.MAX-APPEND | Communication | PUBLIC | 3.3.0 | SET|GET | value |
[0-65535] | Max increment value to append to image name. | Ethernet readers. DM8000 series wireless readers also support FTP if the base station is connected through Ethernet. | |
| FTP-IMAGE.MAX-APPEND-START-VALUE | Communication | PUBLIC | 4.0.0 | SET|GET | value |
[0-65535] | Initial increment value to append to image name. | DM503 | |
| FTP-IMAGE.PASSWORD | Communication | PUBLIC | 3.3.0 | SET | string |
Password used to login to target FTP server. | Ethernet readers. DM8000 series wireless readers also support FTP if the base station is connected through Ethernet. | ||
| FTP-IMAGE.PORT | Communication | PUBLIC | 4.0.0 | SET|GET | port |
[0-65535] | FTP server port number. | Ethernet readers. DM8000 series wireless readers also support FTP if the base station is connected through Ethernet. | |
| FTP-IMAGE.PRIORITY | Communication | PRIVATE | 5.2.0 | SET|GET | value |
[0-2] |
0: High - above decoder 1: Medium - same as running decoder 2: Low - below running decoder |
FTP thread priority. | Ethernet readers. DM8000 series wireless readers also support FTP if the base station is connected through Ethernet. |
| FTP-IMAGE.SERVER-PATH | Communication | PUBLIC | 3.3.0 | SET|GET | string |
Path for FTP image. | Ethernet readers. DM8000 series wireless readers also support FTP if the base station is connected through Ethernet. | ||
| FTP-IMAGE.SERVER-PATH-SCRIPT | Communication | PUBLIC | 5.2.0 | SET|GET | num-bytes |
Set: loads the script from the host to the reader. Get: sends the script from the reader to the host. | DM474, DM503 and DM300 series readers. | ||
| FTP-IMAGE.SERVER-PATH-SCRIPT-ERROR | Communication | PUBLIC | 5.5.0 | GET | message |
script error message | Gets the script error message for FTP Storage name generation . | Fixed-mount readers. | |
| FTP-IMAGE.SERVER-TYPE | Communication | PUBLIC | 5.6.3 | SET|GET | type |
[0-2] |
0: Generic 1: Mitsubishi GOT 2: SFTP |
FTP image server type. 2 means that the server is an S(SH)FTP server. | DM474, DM503 and DM300 series readers. |
| FTP-IMAGE.USER-NAME | Communication | PUBLIC | 3.3.0 | SET|GET | string |
Username used to login to target FTP server. | Ethernet readers. DM8000 series wireless readers also support FTP if the base station is connected through Ethernet. | ||
| FTP-PCM-REPORT.CUSTOM-FILE-NAME | Communication | PUBLIC | 5.7.0 | SET|GET | state |
ON/OFF |
enable disable |
Enable/disable customize file name generation (if disabled the FTP server has to generate a unique name). | Ethernet readers |
| FTP-PCM-REPORT.ENABLE | Communication | PUBLIC | 5.7.0 | SET|GET | enable |
ON/OFF | Enable or disable a PCM Report FTP connection. | Ethernet readers | |
| FTP-PCM-REPORT.FILE-NAME | Communication | PUBLIC | 5.7.0 | SET|GET | string |
File name of PCM Report. | Ethernet readers | ||
| FTP-PCM-REPORT.FILE-NAME-USE-SCRIPT | Communication | PUBLIC | 5.7.0 | SET|GET | state |
ON/OFF |
enable disable |
Enables PCM report file name generation by script. | Ethernet readers |
| FTP-PCM-REPORT.IDLE-LIMIT | Communication | PUBLIC | 5.7.0 | SET|GET | state |
ON/OFF |
enable disable |
Limit duration of idle connections after a data transfer. | Ethernet readers |
| FTP-PCM-REPORT.IDLE-TIME | Communication | PUBLIC | 5.7.0 | SET|GET | seconds |
[0-3600] | Maximum duration of idle connections after a data transfer. | Ethernet readers | |
| FTP-PCM-REPORT.IP-ADDRESS | Communication | PUBLIC | 5.7.0 | SET|GET | server |
IP address or DNS name | Set the PCM Report FTP server. | Ethernet readers | |
| FTP-PCM-REPORT.MAX-APPEND | Communication | PUBLIC | 5.7.0 | SET|GET | value |
[0-65535] | Max increment value to append to PCM report file name. | Ethernet readers | |
| FTP-PCM-REPORT.MAX-APPEND-START-VALUE | Communication | PUBLIC | 5.7.0 | SET|GET | value |
[0-65535] | Initial increment value to append to PCM report file name. | Ethernet readers | |
| FTP-PCM-REPORT.PASSWORD | Communication | PUBLIC | 5.7.0 | SET|GET | string |
PASSWORD used to login to target PCM Report FTP server. | Ethernet readers | ||
| FTP-PCM-REPORT.PORT | Communication | PUBLIC | 5.7.0 | SET|GET | port |
[0-65535] | PCM Report FTP server port number. | Ethernet readers | |
| FTP-PCM-REPORT.SCRIPT-ERROR | Communication | PUBLIC | 5.7.0 | GET | message |
script error message | Gets the script error message for FTP PCM report file name generation. | Ethernet readers | |
| FTP-PCM-REPORT.SERVER-PATH | Communication | PUBLIC | 5.7.0 | SET|GET | string |
Path for PCM Reports which has to be named by the FTP Server. | Ethernet readers | ||
| FTP-PCM-REPORT.SERVER-TYPE | Communication | PUBLIC | 5.7.0 | SET|GET | type |
[0-2] |
0: Generic 1: Mitsubishi GOT 2: SFTP(encrypted) |
FTP server type. | Ethernet readers |
| FTP-PCM-REPORT.USER-NAME | Communication | PUBLIC | 5.7.0 | SET|GET | string |
Username used to login to target PCM Report FTP server. | Ethernet readers | ||
| FTP-PROXY.CONNECT | Communication | PRIVATE | 4.2.0 | index |
[0-15] | FTP object index as returned by FTP-PROXY.CREATE | Used by wireless readers to proxy FTP transfer through base station. | Base station. | |
| FTP-PROXY.CREATE | Communication | PRIVATE | 4.2.0 | user pass server port type |
dotted decimal from IPv4 address [1-65535] [0-1] |
Password. Target FTP server address. Target FTP port number. Target FTP server type (Generic/Mitsubishi). |
Used by wireless readers to proxy FTP transfer through base station. | Base station. | |
| FTP-PROXY.DESTROY | Communication | PRIVATE | 4.2.0 | index |
[0-15] | FTP object index as returned by FTP-PROXY.CREATE | Used by wireless readers to proxy FTP transfer through base station. | Base station. | |
| FTP-PROXY.DISCONNECT | Communication | PRIVATE | 4.2.0 | index |
[0-15] | FTP object index as returned by FTP-PROXY.CREATE | Used by wireless readers to proxy FTP transfer through base station. | Base station. | |
| FTP-PROXY.EXECUTE | Communication | PRIVATE | 4.2.0 | index type path length data |
[0-15] [0-15] [0-15] [0-3] [0-3] |
FTP object index as returned by FTP-PROXY.CREATE FTP transfer type (STOR/STOU/APPE/RETR) File path for FTP transfer Data length Data |
Used by wireless readers to proxy FTP transfer through base station. | Base station. | |
| FTP-PROXY.NOOP | Communication | PRIVATE | 5.0.0 | session |
Sends NOOP using FTP proxy. | Wireless readers. | |||
| FTP-RESULT.APPEND | Communication | PUBLIC | 3.3.0 | SET|GET | type |
[ON|OFF] |
ON: Append result to existing file. OFF: Overwrite file content with result. |
Append to or overwrite file when result is sent via FTP to the file specified by FTP-RESULT.FILE-NAME. The file will be created if it does not exist. | Ethernet readers. DM8000 series wireless readers also support FTP if the base station is connected through Ethernet. |
| FTP-RESULT.ENABLE | Communication | PUBLIC | 3.3.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable/disable FTP transfer of reader results. | Ethernet readers. DM8000 series wireless readers also support FTP if the base station is connected through Ethernet. |
| FTP-RESULT.FILE-NAME | Communication | PUBLIC | 3.3.0 | SET|GET | string |
File name of FTP result. | Ethernet readers. DM8000 series wireless readers also support FTP if the base station is connected through Ethernet. | ||
| FTP-RESULT.IDLE-LIMIT | Communication | PUBLIC | 5.5.0 | SET|GET | state |
[ON|OFF] | enable/disable | Limit duration of idle connections after a data transfer. | DM474, DM503 and DM300 series readers. |
| FTP-RESULT.IDLE-TIME | Communication | PUBLIC | 5.5.0 | SET|GET | seconds |
[0-3600] | Maximum duration of idle connections after a data transfer. | DM474, DM503 and DM300 series readers. | |
| FTP-RESULT.IP-ADDRESS | Communication | PUBLIC | 3.3.0 | SET|GET | string |
IP address of target FTP server. Uses dotted decimal form, such as "192.168.23.42". |
Ethernet readers and MX-1000. DM8000 series wireless readers also support FTP if the base station is connected through Ethernet. | ||
| FTP-RESULT.PASSWORD | Communication | PUBLIC | 3.3.0 | SET | string |
Password used to login to target FTP server. | Ethernet readers. DM8000 series wireless readers also support FTP if the base station is connected through Ethernet. | ||
| FTP-RESULT.PORT | Communication | PUBLIC | 4.0.0 | SET|GET | port |
[0-65535] | FTP server port number. | Ethernet readers. DM8000 series wireless readers also support FTP if the base station is connected through Ethernet. | |
| FTP-RESULT.SERVER-TYPE | Communication | PUBLIC | 5.6.3 | SET|GET | type |
[0-2] |
0: Generic 1: Mitsubishi GOT 2: SFTP |
FTP server type.2 means that the server is an S(SH)FTP server. | DM474, DM503 and DM300 series readers. |
| FTP-RESULT.USER-NAME | Communication | PUBLIC | 3.3.0 | SET|GET | string |
Username used to login to target FTP server. | Ethernet readers. DM8000 series wireless readers also support FTP if the base station is connected through Ethernet. | ||
| FTP.LOG | Action | PRIVATE | 4.4.0 | GET | Get the FTP log of FTP control connection commands and replies in case of FTP problems. | ALL | |||
| HEAP.STATS | System | PRIVATE | 3.1.0 | Returns heap memory statistics. | |||||
| HEIGHT-SENSOR.CURRENT-MEASUREMENT | Camera | PUBLIC | 6.1.6 | GET | [0-4000] | Distance from the C-Mount Flange in mm | Returns the read out of the ToF range distance in mm. | DM370 series, DM470 series readers. | |
| HPIT.FRONT-COVER | Communication | PUBLIC | 6.1.6 | GET |
|
[0-4] |
0 = No cover 1 = Cross polarized NEWC Linear Polarized S 2 = Clear cover 3 = Undefined 4 = Diffused |
Detected front cover type. | DM370 series, DM470 series readers. |
| HPIT.INDICATOR-MODE | Action | PUBLIC | 6.1.6 | SET|GET | IND_ID IND_MODE |
[0-1] [0-1] |
0 = Left indicator 1 = Right indicator 0 = OFF 1 = ON |
Allows to control the LED indicators located in Torch according to the selected mode. This command is intended only for usability testing. | DM370 series, DM470 series readers. |
| HPIT.INDICATOR-ON-TIME-US | Action | PRIVATE | 6.1.6 | SET|GET | IND_ID TIME_US |
[0-1] [100-10000] |
0 = Left indicator 1 = Right indicator |
Allows to control the Indicator0 (Green LED) on time to be executed in the following illumination pulse after an event has been detected. | DM370 series, DM470 series readers. |
| HPT.CHANNEL-ENABLED | Action | PRIVATE | 5.7.0 | SET|GET | channel_name, state |
[ON|OFF] string, [ON|OFF] | enable/disable Channel name. Switch state. | Enables or disables a given HPT log channel. | ALL |
| HPT.LOG | Action | PRIVATE | 5.7.0 | GET | Retrieves the HPT log as a binary file content. | ALL | |||
| I2O5.CHKCHAR | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | I2of5 Check Character. | ALL |
| I2O5.CODESIZE | Symbology | PUBLIC | 3.0.0 | SET|GET | any min max |
[ON|OFF] [4-max] [min-80] |
any length code minimum code length maximum code length |
I2of5 Code Size. For the Manatee Works SDK, all of the Code 25 variants use the same minimum length; thus it will accept either C25.CODESIZE or I205.CODESIZE. | ALL |
| I2O5.QZ-SIZE | Symbology | PRIVATE | 3.0.0 | SET|GET | state |
[0|100] | Quiet zone single strictness size. | ALL | |
| I2O5.XMTCHK | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | I2of5 Transmit Check Character. | ALL |
| IDFLASH.READ | System | PRIVATE | 5.4.0 | SET | Read ID/slide in EEPROM content. | All | |||
| IDFLASH.WRITE | System | PRIVATE | 5.4.0 | SET | string |
Write ID/slide in EEPROM content. | All | ||
| IMAGE.FETCH | Camera | PRIVATE | 5.7.1 | size format quality |
[0-3] [0-2] [10, 15, 20... 85, 90] |
0: Full 1: 1/4 2: 1/16 3: 1/64 0: Bitmap 1: JPEG 2: PNG JPEG quality |
Acquires an image and transfers it. | ||
| IMAGE.FORMAT | Camera | PUBLIC | 5.6.3 | SET|GET | format |
[0-2] |
0: Bitmap 1: JPEG 2: PNG |
Image File Format. | ALL |
| IMAGE.LOAD | Camera | PRIVATE | 3.0.0 | num-bytes |
Loads image from PC to Reader. | ||||
| IMAGE.LOAD-FTP-MULT-PARAM | Camera | PRIVATE | 4.0.0 | ??? | |||||
| IMAGE.LOAD-FTP-MULT-PARAM | IO | PRIVATE | 5.5.0 | SET | server_ip picture last_image more burst_count buffer-overflow seq_nbr ” ” ”user” ”passwd” port |
[ON|OFF] [3] [0-1] |
Server IP Picture name enable/disable Number of images to take 0: Off 1: On Sequence number in the burst User name Password Port used |
Allows uploading of multiple pictures as a burst. | ALL |
| IMAGE.LOAD-FTP-PARAM | Camera | PRIVATE | 4.0.0 | ??? | |||||
| IMAGE.QUALITY | Camera | PUBLIC | 4.4.0 | SET|GET | quality |
[10, 15, 20... 85, 90] | JPEG Quality | Quality of the jpeg image. | ALL |
| IMAGE.SEND | Action | PUBLIC | 5.5.0 | Retrieve the last camera image acquired. Returns number of bytes of image data followed by \r\n followed by image data. Whatever is set for ||>IMAGE.SIZE, ||>IMAGE.FORMAT, and ||>IMAGE.QUALITY before requesting the image will be used for the corresponding size, format, and quality. | ALL | ||||
| IMAGE.SEND-BUFFER | Camera | PRIVATE | 5.6.3 | index size format quality |
[0-3] [0-2] [10, 15, 20... 85, 90] |
0: Full 1: 1/4 2: 1/16 3: 1/64 0: Bitmap 1: JPEG 2: PNG JPEG Quality |
Send specified image buffer date. | ||
| IMAGE.SEND-SLOT | Camera | 3.0.0 | |||||||
| IMAGE.SEND-TYPE | Camera | 3.0.0 | |||||||
| IMAGE.SIZE | Camera | PUBLIC | 4.4.0 | SET|GET | size |
[0-3] |
0: Full 1: 1/4 2: 1/16 3: 1/64 |
Image Size. | ALL |
| IMAGEBUFFER.ALLOW-OVERWRITE | RecordPlayback | PUBLIC | 4.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Allow buffered images that have not been transfered to be overwritten if all available buffers are used and new images arrive. | DM50, DM60, DM70, DM474, DM503, DM300 series readers, DM8050 and DM8600. |
| IMAGEBUFFER.AUTO-PREFER-CENTER | RecordPlayback | PUBLIC | 5.7.3 | SET|GET | Controls whether to use the decoders best symbol or the symbol closer to the ROI center. | DM50, DM60, DM70, DM474, DM503, DM300 series readers, DM8050 and DM8600. | |||
| IMAGEBUFFER.DELETE | RecordPlayback | PUBLIC | 4.0.0 | Release stored images. | DM50, DM60, DM70, DM474, DM503, DM300 series readers, DM8050 and DM8600. | ||||
| IMAGEBUFFER.DELETE-AFTER-TRANSFER | RecordPlayback | PUBLIC | 4.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Release stored images automatically after image has been transfered. | DM50, DM60, DM70, DM474, DM503, DM300 series readers, DM8050 and DM8600. |
| IMAGEBUFFER.FORMAT | RecordPlayback | PUBLIC | 5.6.3 | SET|GET | format |
[0-2] |
0: Bitmap 1: JPEG 2: PNG |
DM50, DM60, DM70, DM474, DM503, MX-1000, DM8000 series and DM300 series readers. | |
| IMAGEBUFFER.GOOD-IMAGE-MODE | RecordPlayback | PUBLIC | 5.2.0 | SET|GET | mode |
[0-1] |
0: Unlimited 1: Rate limited |
Good Read Image stores all buffered good read images unless you set a limit rate. | DM503, DM300 series readers, DM8050 and DM8600. |
| IMAGEBUFFER.GOOD-IMAGE-RATE-BURST | RecordPlayback | PUBLIC | 5.2.0 | SET|GET | interval |
[1-1000] | Burst determines the peak rate of the number of good read images buffered. | DM474, DM503, DM300 series readers, DM8050 and DM8600. | |
| IMAGEBUFFER.GOOD-IMAGE-RATE-COUNT | RecordPlayback | PUBLIC | 5.2.0 | SET|GET | interval |
Number of good read images to be buffered at a time unit (for example, minutes or hours) specified with IMAGEBUFFER.GOOD-IMAGE-RATE-COUNT. | DM474, DM503, DM300 series readers, DM8050 and DM8600. | ||
| IMAGEBUFFER.GOOD-IMAGE-RATE-TIME | RecordPlayback | PUBLIC | 5.2.0 | SET|GET | type |
[0-3] |
0: seconds 1: minutes 2: hours 3: days |
Time unit of good read images to be buffered at a rate number specified with IMAGEBUFFER.GOOD-IMAGE-RATE-TIME. | DM474, DM503, DM300 series readers, DM8050 and DM8600. |
| IMAGEBUFFER.IMAGE-TYPE | RecordPlayback | PUBLIC | 5.5.0 | SET|GET | int |
[0-2] |
0: All 1: Same as result 2: Auto |
Sets "What images to Buffer for a Result". When "Auto" is selected, the reader does intelligent image buffering. Requires the IntImageBuffer feature key to select the "Auto" option. |
DM70, DM150, DM260, DM300 series readers, DM474, DM503. |
| IMAGEBUFFER.MAX-IMAGES-PER-RESULT | RecordPlayback | PUBLIC | 5.0.0 | SET|GET | size |
[0-*] | Sets or gets how many images (n) per result are stored. | DM50, DM60, DM70, DM474, DM503, DM300 series readers, DM8050 and DM8600. | |
| IMAGEBUFFER.MAX-NUM | RecordPlayback | PUBLIC | 4.0.0 | SET|GET | size |
[0-*] | Maximum number of images that can be buffered. * Range varies depending depending on Camera ROI and memory allocated for burst length. |
DM50, DM60, DM70, DM474, DM503, DM300 series readers, DM8050 and DM8600. | |
| IMAGEBUFFER.NO-READ-IMAGE-LAST-NUMBER | RecordPlayback | PRIVATE | 5.5.0 | SET|GET | limit |
[n][Max Int] | In Burst trigger mode, n is the number of images in a burst. In other trigger modes, there is no limit. | Stores images up to the limit. | Fixed-mount readers, only in Single, Burst, Self and Continuous modes. |
| IMAGEBUFFER.NO-READ-IMAGE-MODE | RecordPlayback | PRIVATE | 5.0.0 | SET|GET | size |
[0-3] |
0: No-Read Image Period 1: No-Read Image Number 2: No-Read Image Rate 3: No-Read Image Range |
No-Read Image stores only one image per trigger and you can select which one. No-Read Image Period stores every nth bad read image. This is evaluated across trigger modes. For example, if you have burst trigger selected with a length of 5 and set period to 3, the 1st and 4th image of the first, but the 2nd and 5th of the second burst will be stored. No-Read Image Range stores all bad read images from the no-read image number to the last no-read image number. | Fixed-mount readers, only in Single, Burst, Self and Continuous modes. |
| IMAGEBUFFER.NO-READ-IMAGE-NUMBER | RecordPlayback | PUBLIC | 5.0.0 | SET|GET | limit |
[n] [Max Int] |
In Burst trigger mode, n is the number of images in a burst In other trigger modes, there is no limit |
Store exactly one image. | DM50, DM60, DM70, DM474, DM503, DM300 series readers, only in Single, Burst, Self and Continuous modes. |
| IMAGEBUFFER.NO-READ-IMAGE-PERIOD | RecordPlayback | PUBLIC | 4.0.0 | SET|GET | interval |
[1-200] | Sets or gets the interval to save the image of a bad read. If, for example, you use an interval of 6, the first bad image is saved and the next 5 are not. The default is 1 which saves each bad read image. | DM50, DM60, DM70, DM474, DM503, DM300 series readers, only in Single, Burst, Self and Continuous modes. | |
| IMAGEBUFFER.NO-READ-IMAGE-RATE-BURST | RecordPlayback | PUBLIC | 5.2.0 | SET|GET | interval |
[1-1000] | Burst determines the peak rate of the number of bad read images buffered. | DM474, DM503, DM300 series readers, only in Single, Burst, Self and Continuous modes. | |
| IMAGEBUFFER.NO-READ-IMAGE-RATE-COUNT | RecordPlayback | PUBLIC | 5.2.0 | SET|GET | interval |
Number of bad read images to be buffered at a time unit (for example, minutes or hours) specified with IMAGEBUFFER.NO-READ-IMAGE-RATE-COUNT. | DM503, DM300 series readers, only in Single, Burst, Self and Continuous modes. | ||
| IMAGEBUFFER.NO-READ-IMAGE-RATE-TIME | RecordPlayback | PUBLIC | 5.2.0 | SET|GET | type |
[0-3] |
0: seconds 1: minutes 2: hours 3: days |
Time unit of bad read images to be buffered at a rate number specified with IMAGEBUFFER.NO-READ-IMAGE-RATE-TIME. | DM474, DM503, DM300 series readers, only in Single, Burst, Self and Continuous modes. |
| IMAGEBUFFER.NO-READ-INDEX | RecordPlayback | PRIVATE | 4.4.0_cr2 | SET|GET | index |
0 is the default behavior to send all as selected; 1 – max burst is send only the index selected. | DM474, DM300 series readers, DM8050 and DM8600. | ||
| IMAGEBUFFER.NUM | RecordPlayback | PUBLIC | 4.0.0 | GET | size |
Returns the number of currently buffered images. | DM50, DM60, DM70, DM474, DM503, DM300 series readers, DM8050 and DM8600. | ||
| IMAGEBUFFER.OVERLAY | RecordPlayback | PUBLIC | 5.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enables Overlay Graphics (SVG) for buffered images. | DM50, DM60, DM70, DM474, DM503, DM300 series readers, DM8050 and DM8600. |
| IMAGEBUFFER.QUALITY | RecordPlayback | PUBLIC | 4.0.0 | SET|GET | quality |
[10, 15, 20... 85, 90] | JPEG Quality | DM50, DM60, DM70, DM474, DM503, MX-1000, DM8000 series and DM300 series readers. | |
| IMAGEBUFFER.RECORD | RecordPlayback | 4.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable or disable image buffereing. obsolete in 4.0.0. |
Fixed mount readers, DM8050 and DM8600. | |
| IMAGEBUFFER.RECORD-TYPE | RecordPlayback | PUBLIC | 4.0.0 | SET|GET | type |
[0-5] |
0: None 1: No-Read 2: Read 3: All 4: Validation Failure 5: No-Read + Validation failure |
Sets or gets the type of image to buffer. In case of No-Read, the image is buffered if the reader fails to read. |
DM50, DM60, DM70, DM474, DM503, MX-1000, DM8000 series and DM300 series readers. |
| IMAGEBUFFER.SEND-FTP | RecordPlayback | PUBLIC | 4.0.0 | Transmit buffered images to designated FTP server. | DM60, DM474, DM503, DM8000 series and DM300 series readers. | ||||
| IMAGEBUFFER.SEND-FTP-PARAM | RecordPlayback | PRIVATE | 4.0.0 | Transmit buffered images to designated FTP server. | Fixed mount Ethernet readers, DM8050 and DM8600. | ||||
| IMAGEBUFFER.SIZE | RecordPlayback | PUBLIC | 4.0.0 | SET|GET | size |
[0-3] |
0: Full 1: 1/4 2: 1/16 3: 1/64 |
DM50, DM60, DM70, DM474, DM503, MX-1000, DM8000 series and DM300 series readers. | |
| IMAGEBUFFER.TRANSFER-MODE | RecordPlayback | PUBLIC | 4.0.0 | SET|GET | interval |
[0-1] |
0: On Request 1: FTP - runtime |
Sets or gets whether buffered images should automatically sent FTP or if they should be send only after requested. | DM60, DM70, DM474, DM503, MX-1000, DM8000 series, and DM300 series readers and DM260. |
| INPUT-STRING.ENABLE | Data Formatting | PUBLIC | 5.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enables or disables the use of the Input String feature (available for serial, telnet, NetworkClient). When enabled, a header and the footer can be set by the INPUT-STRING.HEADER and INPUT-STRING.FOOTER commands, respectively. A string of characters can be given between the header and the footer, which will be sent with the formatted output (for example, [hello world], if the header is set to ’[’ and the footer to ’]’). Since the input string is saved temporarily, it appears only in the next result output. Use Setup Tool (the <Input String> option) or <ISTR> with DMCC (see SET FORMAT.TOKEN) to allow Input string in the result output. | ALL |
| INPUT-STRING.ENABLE | Data Formatting | PRIVATE | 4.4.0_cr10 | SET|GET | state |
[ON|OFF] | enable/disable | Enables or disables the use of the Input String feature (available for serial, telnet, NetworkClient). When enabled, a header and the footer can be set by the INPUT-STRING.HEADER and INPUT-STRING.FOOTER commands, respectively. A string of characters can be given between the header and the footer, which will be sent with the formatted output (for example, [hello world], if the header is set to ’[’ and the footer to ’]’). Since the input string is saved temporarily, it appears only in the next result output. Use Setup Tool (the <Input String> option) or <ISTR> with DMCC (see SET FORMAT.TOKEN) to allow Input string in the result output. | ALL |
| INPUT-STRING.FOOTER | Data Formatting | PUBLIC | 5.0.0 | SET|GET | string |
token string | Sets the footer for the Input String character string. | ALL | |
| INPUT-STRING.HEADER | Data Formatting | PUBLIC | 5.0.0 | SET|GET | string |
token string | Sets the header for the Input String character string. | ALL | |
| INPUT-STRING.MODE | Data Formatting | PUBLIC | 5.5.0 | SET|GET | int |
[0-4] |
0: Store 1: Send 2: Send with header and footer 3: Send with formatting 4: Send with header and footer formatting |
Controls whether the input string data is sent out as a result or stored in an internal variable. | Fixed-mount readers. |
| INPUT-STRING.VALUE | Data Formatting | PUBLIC | 5.5.0 | SET|GET | string |
token string | Sets the content of the Input String character string. | Fixed-mount readers | |
| INPUT.ACTION | IO | PUBLIC | 4.0.0 | SET|GET | line action state |
[0-3] [0-11] [ON|OFF] |
Input line number 0: Train Code 1: Optimize Brightness 2: Set Match String 3: Optimize Focus 4: Read Configuration Code 5: Trigger Off 6: Encoder 7: Allow Buffered No-Read Images 8: Clear Outputs 9: Tune (DM300 only) 10: Encoder direction 11: Trigger on ON: execute action when line is triggered OFF: no action |
Sets or gets the state for the specified line action. The input actions "Train Code," "Optimize Brightness," "Set Match String," and "Read Configuration Code" are carried out only after the next trigger. |
Fixed-mount readers. |
| INPUT.ACTION1 | IO | PUBLIC | 3.0.0 | SET|GET | mode state |
[0-3] [ON|OFF] |
0: Train Code 1: Optimize Brighness 2: Set Match String 3: Optimize focus (Only for readers with a liquid lens.) enable/disable |
Input Line 1 Action. | Fixed mount readers. |
| INPUT.EVENT-MESSAGE | IO | PRIVATE | 5.0.0_cr10 | SET|GET | state |
[ON|OFF] | enable/disable | Instructs the system to generate a message for every input line state change. | DM300 series readers, DM474. |
| INPUT.STATE | Action | PUBLIC | 5.5.0 | GET | line |
[0-3] | input line number | Gets the current state of the input line specified. Returns 1 for high, 0 for low. | Fixed-mount readers |
| INPUT.VIRTUAL | Action | PRIVATE | 3.0.0 | line state |
[0-7] [ON|OFF] |
enable/disable |
Software Virtual Input. Trigger is equivalent to line 0. Note that the input actions "Train Code," "Optimize Brightness," "Set Match String," and "Read Configuration Code" are carried out only after the next trigger. |
Fixed mount devices. | |
| INPUT1.SAVE-MATCH-STRING | Communication | PUBLIC | 4.5.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enables or disables saving the match string to flash when Set Match String is enabled as Input line 1 action. | DM50, DM60, DM70, DM474, DM503, and DM300 series readers. |
| INTELLIGRATED.ENABLED | Communication | PRIVATE | 5.0.0_cr14 | SET|GET | state |
[ON|OFF] | enable/disable | Enable or disable the Intelligrated protocol. | DM503 series readers. |
| INTELLIGRATED.HEARTBEAT | IO | PRIVATE | 5.0.0_cr14 | SET|GET | sec |
[0-50] | seconds | Sets or gets the time between heartbeat transmissions. A value of 0 disables the heartbeat. | DM503 series readers. |
| INTER-MESSAGE.DELAY | Communication | PREVIEW | 3.2.0 | SET|GET | value |
[0-10000] | milliseconds | Transmission delay between buffered read strings. | Wireless readers. |
| IO-LINE.DIRECTION | IO | PUBLIC | 5.5.0 | SET|GET | line direction |
[2,3] [0,1] |
line=2: sets direction of I/O Line 2 line=3: sets direction of I/O Line 3 direction=0: defines line as output direction=1: defines line as input |
Sets the direction of the programmable I/O lines of DM360 and DM474 series readers. | DM360 series, DM474 readers |
| KEY.EMULATE-PS2 | IO | PRIVATE | 5.4.0 | SET|GET | state |
[ON|OFF]
[OFF, Wedge, EmulationG |
enable/disable
OFF: no emulation Wedge: reader and PS/2 keyboard are connected using a wedge cable Emulation: reader is connected to wedge and no PS/2 keyboard is present |
Wireless readers. | |
| KEY.INTERCHAR-DELAY | Communication | PUBLIC | 5.5.0 | SET|GET | us |
[0-1000] | milliseconds | Sets or gets the delay time between characters when in HID keyboard mode. | DM300 series readers, DM60, DM50, DM70, DM474. |
| KEY.LANGUAGE | IO | PUBLIC | 3.0.0 | SET|GET | language |
[0-7] |
0: Alt Key Combo 1: DE 2: US 3: JP 4: FR 5: ES 6: NO 7: FI |
ALL except for DM60, DM474, DM503, and DM300 series readers. | |
| KEY.PAUSE-TIME | Action | PUBLIC | 5.4.0 | SET|GET | Pause time |
[0-1000] | 0 to 1000 millisecond pause | Sets the time to pause for a specified pause key sequence. | DM8050, DM8600 series |
| KEY.ZERO-PAD | IO | PUBLIC | 3.0.0 | SET|GET | language |
[ON|OFF] | enable/disable | ALL except for DM60, DM474, DM503, and DM300 series readers. | |
| LIGHT.AIMER | Camera | PUBLIC | 3.0.0 | SET|GET | aimer-mode |
[0-1] |
0: Off 1: On |
Aimer Enable. Default is ON. |
ALL except for DM503 and DM8050. |
| LIGHT.AIMER | Camera | PUBLIC | 5.4.0 | SET|GET | aimer-mode |
[0,1,3] |
0: Off 1: On 3: Activated by Acceleration Sensor |
Aimer Enable. Default is ON. |
DM8050 |
| LIGHT.AIMER | Camera | PRIVATE | 3.0.0 | SET|GET | aimer-mode |
[0-3] |
0: Off 1: LED 2: Laser 3: Both |
Aimer Enable. | DM700 |
| LIGHT.AIMER | Camera | PRIVATE | 3.0.0 | SET|GET | aimer-mode |
[0-3] |
0: Off 1: On when idle 2: Blink (default) 3: On (default) |
Aimer Enable. | DM7500 |
| LIGHT.AIMER | Camera | PUBLIC | 6.1.6 | SET|GET | aimer-mode |
[0-1] |
0: Off 1: On |
Enables or disables the aimer. | DM370 series, DM470 readers. |
| LIGHT.AIMER-TIMEOUT | Camera | PUBLIC | 4.2.1 | SET|GET | int |
[0-600] | seconds | Aimer Timeout in seconds. | MX-1000 and DM8000 series readers. |
| LIGHT.DARKFIELD-INTENSITY | Camera | PUBLIC | 5.4.3 | SET|GET | value |
[0-15] | Intensity | Darkfield Illumination Intensity. | DM8600 |
| LIGHT.DIFFUSE-INTENSITY | Camera | PUBLIC | 5.4.3 | SET|GET | level |
[0-15] | Intensity | Diffuse Brightfield Illumination Intensity. | DM8600 |
| LIGHT.DIRECT | Camera | PUBLIC | 4.4.0 | SET|GET | north east south west NORTH EAST SOUTH WEST |
[ON|OFF]
[ON|OFF] [ON|OFF] [ON|OFF] [ON|OFF] [ON|OFF] [ON|OFF] [ON|OFF] |
enable/disable
enable/disable enable/disable enable/disable enable/disable enable/disable enable/disable enable/disable |
Sets the quadrants on the DM300. Small letters refer to the inner, capital letters to the outer circle, possible values are ON and OFF for each segment. Example for a SET command: SET LIGHT.DIRECT ON OFF ON ON OFF OFF OFF OFF if you want to have the inner north, south, and west lights on. | DM300 series readers, DM474. |
| LIGHT.DIRECT | Camera | PUBLIC | 5.5.0 | SET|GET | north-east north-west south-east south-west |
[ON|OFF]
[ON|OFF] [ON|OFF] [ON|OFF] |
enable/disable
enable/disable enable/disable enable/disable |
Sets the quadrants on the DM70, DM150 and DM260. Possible values are ON and OFF for each segment. Example for a SET command: SET LIGHT.DIRECT ON OFF OFF ON if you want to have the top-left and bottom-right LED on. | DM70, DM150 and DM260 readers. |
| LIGHT.DIRECT | Camera | PUBLIC | 5.7.7 | SET|GET | state |
[ON|OFF] | enable/disable | Turns on/off light banks for the 8072V. Verification should only take place with lighting combinations that can be described as 30 single, 30T (opposite sides), 30Q (all 30 panels), 45Q (all 45 panels), or 90. Other lighting combinations are allowed by the firmware, but will not result in valid verification result. | DM8072 Verifier |
| LIGHT.DIRECT | Camera | PUBLIC | 6.1.6 | SET|GET | North Corners South East-West |
[ON|OFF]
[ON|OFF] [ON|OFF] [ON|OFF] |
enable/disable
enable/disable enable/disable enable/disable |
Enables or disables the HPIT quadrants. | DM370 series, DM470 series readers. |
| LIGHT.DIRECT-INTENSITY | Camera | PUBLIC | 5.1.0 | SET|GET | level |
[0-15] | Intensity | Direct Illumination Intensity. | DM50, DM60, DM474, DM503 and DM300 series readers. |
| LIGHT.DIRECT-INTENSITY | Camera | PUBLIC | 5.4.3 | SET|GET | level |
[1-15] | Intensity | Direct Illumination Intensity. | DM8050 |
| LIGHT.EXTERNAL-ENABLE | Camera | PUBLIC | 4.1.0 | SET|GET | enable |
[ON|OFF] | enable/disable | Enable external illumination supported by I/O. | Fixed mount readers. |
| LIGHT.EXTERNAL-INTENSITY | Camera | PUBLIC | 5.2.0 | SET|GET | level |
[0-15] | Intensity | Sets the intensity of the external illumination. | Fixed mount readers. |
| LIGHT.EXTERNAL-POLARITY | Camera | PUBLIC | 3.0.0 | SET|GET | polarity |
[0-1] |
0: Active Low 1: Active High |
External illlumination output polarity. | Fixed mount readers except for DM70, DM150, DM260. |
| LIGHT.EXTERNAL-PRECHARGE-TIME | Camera | PREVIEW | 3.0.0 | SET|GET | time |
[1-980] | microseconds | External light precharge time. | Fixed mount readers. |
| LIGHT.HIGH-FREQUENCY | Camera | PUBLIC | 5.2.0 | SET|GET | enable |
[ON|OFF] | enable/disable | Enables High Frequency Lights to avoid flickering illumination. | DM50, DM60, DM70, DM474, DM503, and DM300 series readers. |
| LIGHT.HIGH-FREQUENCY-ALWAYS | Camera | PUBLIC | 5.2.0 | SET|GET | enable seconds |
[ON|OFF] 0-86400 |
enable/disable auto off duration |
Enables High Frequency Light in Continuous trigger mode even if no trigger is active. After duration seconds the High Frequency Light is turned off. If the duration is 0 the light is never turned off. | DM50, DM60, DM70, DM474, DM503, and DM300 series readers. |
| LIGHT.HIGH-FREQUENCY-FORCE | Camera | PRIVATE | 5.2.0 | SET|GET | enable |
[ON|OFF] | enable/disable | Enable High Frequency Lights even if overheat protection would normally prohibit it. | DM300 series readers |
| LIGHT.INTERNAL-ENABLE | Camera | PUBLIC | 4.1.0 | SET|GET | enable |
[ON|OFF] | enable/disable | Enable the built-in internal illumination. Default value is OFF. | DM50, DM60, DM70, DM8050, MX-1000, MX-1502, Mobile. |
| LIGHT.LOW-ANGLE | Camera | PUBLIC | 5.7.0 | SET|GET | state |
[ON|OFF] [ON|OFF] | enable/disable low-angle illumination | Controls the DM262 UHD low-angle illumination. | DM262 |
| LIGHT.ON-AXIS | Camera | PUBLIC | 5.7.0 | SET|GET | state |
[ON|OFF] [ON|OFF] | enable/disable on-axis illumination | Controls the DM262 UHD on-axis illumination. | DM262 |
| LIGHT.ON-AXIS-INTENSITY | Camera | PRIVATE | 5.7.0 | SET|GET | intensity |
[0..3] | on-axis illumination intensity | Controls the intensity of the DM262 UHD on-axis illumination. | DM262 |
| LIGHT.POLARIZED | Camera | PUBLIC | 5.6.0 | SET|GET | polarized LED count |
[0|2|4] | Number of polarized filtered LEDs in the illumination | Use this command after applying a different HPIL front cover to publish the illumination filter status to the device. | DM70, DM150, DM260 |
| LIGHT.SELF-REPAIR | Camera | PRIVATE | 5.5.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enables/disables internal illumination self repair mode. | DM300 series readers |
| LIGHTCURTAIN.BEAM-SPACING | IO | PUBLIC | 4.1.0 | SET|GET | spacing |
[1-300000] | micrometers | Distance (in um) between beams of the Light Curtain. This determines the resolution of the light curtain. | DM503 |
| LIGHTRING.DURATION | IO | PUBLIC | 5.7.0 | SET|GET | duration |
[0..10000] |
0: Default behavior 10..10000: duration of lightring event in ms, step 10 ms |
Controls the duration of the lightring illumination event. | DM36x, DM474 and DM503 |
| LIMIT.CONS-NOREAD | System | PRIVATE | 5.4.0 | SET|GET | string |
empty string: feature disabled "CBRD>n": signal after n consecutive bad reads |
Sets/gets the threshold for consecutive bad read event signaling. | ALL | |
| LIVEIMG.MODE | Camera | PUBLIC | 5.2.0 | SET|GET | mode |
[0,2] |
0: Disable 2: Enable |
Controls live image display. | ALL |
| LIVEIMG.SEND | Camera | PUBLIC | 5.6.3 | size format quality |
[0-3] [0-2] [10, 15, 20... 85, 90] |
0: Full 1: 1/4 2: 1/16 3: 1/64 0: Bitmap 1: JPEG 2: PNG JPEG Quality |
Request image transfer to PC when LIVEIMG.MODE is set to 3. | ||
| LL.REGTODISTANCE | System | PRIVATE | 5.4.0 | register |
Get distance in mm for specified register steps at current temperature. | Readers with liquid lens. | |||
| LLFLASH.READ | System | PRIVATE | 5.4.0 | GET | Gets liquid lens flash content. | Readers with liquid lens. | |||
| LLFLASH.WRITE | System | PRIVATE | 5.4.0 | SET | Sets liquid lens flash content. | Readers with liquid lens. | |||
| LVHSTS.ENABLED | Communication | PRIVATE | 4.4.1_cr6_sr2 | SET|GET | state |
[ON|OFF] | enable/disable | Enable or disable the USPS Lehigh Valley HSTS protocol. | DM300 series readers, DM474. |
| MARKEM.ENABLED | Communication | PRIVATE | 5.0.0_cr11 | SET|GET | state |
[ON|OFF] | enable/disable | Enable or disable the Markem protocol. | DM300 series readers, DM474. |
| MASTER-SLAVE.GROUP-NAME | Communication | PUBLIC | 4.0.0 | SET|GET | name |
Gets or sets the name of the master slave group. | DM60, DM474, DM503, and DM300 series readers. | ||
| MASTER-SLAVE.MODE | Communication | PUBLIC | 4.0.0 | SET|GET | mode |
[0-2] |
0: OFF 1: ON 2: Master |
Switches the master-slave functioning of the reader on or off. | DM60, DM474, DM503, and DM300 series readers. |
| MASTER-SLAVE.RX-HEIGHT-SENSOR | Camera | PUBLIC | 4.1.0 | SET|GET | enable |
[ON|OFF]* | enable/disable | Enables or disables this system receiving height information from another system in the network group. | DM60, DM474 and DM300 series readers. |
| MASTER-SLAVE.TEST | Communication | PUBLIC | 5.5.0 | mode message |
[0-2] |
0: Slave to Master 1: Master to Slave 2: Master to Slave to Master |
Transmits the test message from reader to reader as designated by mode. The terminating reader will output the message preceded by the initiating device delimited by a space | Fixed-mount readers. | |
| MASTER-SLAVE.TEST-EFP-OUTPUT | Communication | PUBLIC | 5.7.3 | SET|GET | state |
[ON|OFF] |
ON: enable OFF: disable |
Enables or disables mst-test messages on the Industrial Protocol interfaces. | DM300 series readers, DM474. |
| MASTER-SLAVE.TIMEOUT | Communication | PUBLIC | 4.0.0 | SET|GET | milliseconds |
[0-10000] | Gets or sets the time to wait for results from slave cameras. | DM60, DM474, DM503, and DM300 series readers. | |
| MASTER-SLAVE.TIMEOUT-DISTANCE | Communication | PUBLIC | 5.7.3 | SET|GET | int |
[0-1000000] | Distance | The distance for a master slave timeout. | DM60, DM70, DM260, DM474, DM503, and DM300 series readers. |
| MASTER-SLAVE.TIMEOUT-MODE | Communication | PUBLIC | 5.7.3 | SET|GET | mode |
[0-1] |
0: Time 1: Distance |
Controls if the mater slave response timeout will be time or distance based. | DM60, DM260, DM474, DM503, and DM300 series readers. |
| MAXICODE.TRAINED-MODEL | Decoder | PUBLIC | 5.7.0 | SET|GET | module size |
[1-1000] | Module size * 10 | Set training parameters for MaxiCode symbology. | Fixed-mount readers |
| MC-PROTOCOL.ENABLED | Communication | PRIVATE | SET|GET | state |
[ON|OFF] | enable/disable | Enable or disable MC-Protocol communication. | Ethernet readers. The DM8000 series wireless readers also support this protocol if the base station is connected through Ethernet. In the case of a Bluetooth connection, the command has to be sent to the base station, not to the reader. | |
| MODBUSTCP.ENABLED | Communication | PUBLIC | SET|GET | state |
[ON|OFF] | enable/disable | Enable or disable Modbus/TCP communication. | Ethernet readers. The DM8000 series wireless readers also support this protocol if the base station is connected through Ethernet. In the case of a Bluetooth connection, the command has to be sent to the base station, not to the reader. | |
| MODBUSTCP.HOLDING-ONLY | Communication | PUBLIC | SET|GET | state |
[ON|OFF] | enable/disable | Ethernet readers. DM8000 series wireless readers also support this protocol if the base station is connected through Ethernet. | ||
| MONITOR-MODE.AUTOEXPOSURE | Camera | PUBLIC | 5.7.1 | SET|GET | state |
[ON|OFF] | enable/disable | Enable/disable autoregulation while in monitor mode. | ALL |
| MONITOR-MODE.DECODE-ENABLE | Camera | PUBLIC | 5.7.1 | SET|GET | mode |
[ON|OFF] | enable/disable | ALL | |
| MONITOR-MODE.ENABLE | Camera | PUBLIC | 6.0.1 | SET|GET | state |
[ON|OFF] | enable/disable | Enable/disable monitor mode. | ALL |
| MOTION-DETECTION.ACTIVE | Action | PUBLIC | 5.7.0 | GET | state |
[ON|OFF] |
ON: Active or Lights Off OFF: Inactive or Lights On |
Allows checking the current state of motion detection for presentation or self-internal trigger mode. | DM50, DN60, DM70, DM150, DM260, DM300, DM360, DM474. |
| MOTION-DETECTION.ENABLE | Action | PUBLIC | 5.7.0 | SET|GET | state |
[ON|OFF] |
ON: enable OFF: disable |
Enables or disables motion detection for Presentation trigger mode. | DM50, DN60, DM70, DM150, DM260, DM300, DM474, DM503. |
| MOTION-DETECTION.INIT-STATE | Action | PRIVATE | 5.7.0 | SET|GET | state |
[ON|OFF] | enable/disable ON: motion detection is default state\n; OFF: switch to motion detection state after timeout | Specify the motion detection default state. | DM50, DM60, DM70, DM150, DM260, DM300, DM474, DM503. |
| MOTION-DETECTION.SENSITIVITY | Action | PUBLIC | 5.7.0 | SET|GET |
|
[0|2] |
0: Low 1: Medium 2: High |
Sets or gets the motion detection sensitivity level when in presentation mode. | DM50, DM60, DM70, DM150, DM260, DM300, DM474, DM503. |
| MOTION-DETECTION.TIMEOUT | Action | PRIVATE | 5.7.0 | SET|GET | [0 - 3600] | sec | Time after the reader switches into the motion detection mode. | DM50, DM60, DM70, DM150, DM260, DM300, DM474, DM503. | |
| MQA.POSTAL-HEIGHT_MICRON | Code Quality | PRIVATE | 4.4.1_cr7 and 5.0.0_cr6 | SET|GET | height |
Height in microns per pixel for MERLIN metrics. | DM300 series readers, DM474. | ||
| MQA.POSTAL-MODE | Code Quality | PRIVATE | 4.0.0 | SET|GET | mode |
[0-2] |
0: Off 1: Partial Metrics 2: All Metrics |
Gets or sets the postal verification mode. | ALL |
| MSI.CHKCHAR | Symbology | PUBLIC | 5.0.0_cr5 | SET|GET | state |
[ON|OFF] | enable/disable | Sets or gets whether check character is used. Default value is OFF. | DM300 series, DM474, DM503, MX-1000, MX-1502, Mobile. |
| MSI.CHKCHAR-OPTION | Symbology | PUBLIC | 5.0.0_cr5 | SET|GET | mode |
[0-5] |
0: Mod10 1: Mod11 2: Mod1010 3: Mod1110 4: 5: |
Sets or gets the method for calculating checksum. | DM474, DM503 and DM300 series, MX-1000, MX-1502, Mobile. |
| MSI.CODESIZE | Symbology | PUBLIC | 5.0.0_cr5 | SET|GET | mode min max |
[ON|OFF] [1-max] [min-80] |
any length code minimum code length maximum code length |
Sets or gets the expected code size. | DM474, DM503, DM300 series readers, MX-1000, MX-1502. |
| MSI.QZ-SIZE | Symbology | PUBLIC | 5.0.0_cr5 | SET|GET | size |
[0-100] | Sets or gets the single side strictness as a percentage | DM474, DM503 and DM300 series readers. | |
| MSI.XMTCHK | Symbology | PUBLIC | 5.0.0_cr5 | SET|GET | state |
[ON|OFF] | enable/disable | Sets or gets whether to transmit the check digit. | DM474, DM503 and DM300 series readers. |
| MULTICODE.HORIZONTAL-REVERSE | Symbology | PUBLIC | 3.4.0 | SET|GET | state |
[ON|OFF] |
ON: sort right to left OFF: sort left to right |
Horizontal positional sorting order priority. | Fixed mount readers. |
| MULTICODE.IDENTICAL-SYMBOLS | Symbology | PUBLIC | 3.4.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enables/disables output of identical symbols when multicode is enabled. | Fixed mount readers. |
| MULTICODE.IMAGE-REVERSE | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] |
ON: sort last image first OFF: sort first image first |
Image sorting order preference. | Fixed mount readers. |
| MULTICODE.MAX-NUM-CODES | Symbology | PUBLIC | 3.2.0 | SET|GET | symbology number |
[1-5] [1-255] |
1: DataMatrix 2: QR Code/MaxiCode/AztecCode 3: Linear/ Postal/ Stacked 4: VeriCode® 5: DotCode |
The expected maximum number of codes to find for each symbology grouping 1 - 4; no expected value for any single symbology can exceed parameter 0, the total number of codes to find. | Fixed mount readers. |
| MULTICODE.NUM-CODES | Symbology | PUBLIC | 3.2.0 | SET|GET | number |
[1-255] | Number of codes readers must find for a successful read result. | Fixed mount readers. | |
| MULTICODE.PARTIAL-RESULTS | Symbology | PUBLIC | 3.2.0 | SET|GET | state |
[ON|OFF] | enable/disable | Controls how the reader interprets the number of codes to find. ON = reader will return a successful read if 1 or more codes are found. OFF = reader will return a successful read only if number of codes found equals MULTICODE.NUM-CODES value. | Fixed mount readers. |
| MULTICODE.SORT-PRIORITY | Symbology | PUBLIC | 3.4.0 | SET|GET | symbology image vertical position horizontal position |
[0-3] [0-3] [0-3] [0-3] |
Range for all four arguments indicates sort priority. Must be different for each criteria. |
Sorting order for multicode results: 0 is highest priority, 3 is lowest priority. | Fixed mount readers. |
| MULTICODE.SYMBOLOGY-REVERSE | Symbology | PUBLIC | 3.4.0 | SET|GET | state |
[ON|OFF] |
ON: DotCode, VeriCode ®, Linear/Postal/Stacked, QR Code/MaxiCode/AztecCode, Data Matrix OFF: Data Matrix, QR Code/MaxiCode/AztecCode, Linear/Postal/Stacked, VeriCode ®, DotCode |
Symbology sorting order preference. | Fixed mount readers. |
| MULTICODE.VERTICAL-REVERSE | Symbology | PUBLIC | 3.4.0 | SET|GET | state |
[ON|OFF] |
ON: sort bottom to top OFF: sort top to bottom |
Vertical position sorting order preference. | Fixed mount readers. |
| NET-LOCAL.DHCP | Communication | PUBLIC | 3.3.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable/Disable DHCP on reader. | Ethernet readers. |
| NET-LOCAL.DNS-SERVER | Communication | PUBLIC | 3.3.0 | SET|GET | server |
Gets or sets the DNS Server address. | Ethernet readers. | ||
| NET-LOCAL.GATEWAY | Communication | PUBLIC | 3.3.0 | SET|GET | string |
Reader's default gateway IP address. Uses dotted decimal form, such as "192.168.23.1". |
Ethernet readers. | ||
| NET-LOCAL.IP-ADDRESS | Communication | PUBLIC | 3.3.0 | SET|GET | string |
Reader's IP address. Uses dotted decimal form, such as "192.168.23.42". |
Ethernet readers. | ||
| NET-LOCAL.MAX-LINK-SPEED | Communication | PRIVATE | 5.2.0 | SET|GET | speed |
[0-4] |
0: 1000 MBits/sec Full Duplex 1: 100 MBits/sec Full Duplex 2: 100 MBits/sec Half Duplex 3: 10 MBits/sec Full Duplex 4: 10 MBits/sec Half Duplex |
Limits the advertised autonegotiation maximum link speed. | DM503 only |
| NET-LOCAL.PCAP | System | PRIVATE | 5.7.0 | SET|GET | interface |
interface | Retrieves packet capturing buffer. | ALL | |
| NET-LOCAL.PORT | Communication | PUBLIC | 3.4.0 | SET|GET | port |
[1-65535] | Setup Tool server TCP port on reader. | Ethernet readers. | |
| NET-LOCAL.READER-IP-ADDRESS | Communication | PUBLIC | 4.2.0 | SET|GET | string |
dotted decimal form IPv4 address | Base station's IP address. Uses dotted decimal form, such as "192.168.23.42". |
Base stations. | |
| NET-LOCAL.READER-SUBNET-MASK | Communication | PUBLIC | 5.2.0 | SET|GET | string |
dotted decimal form IPv4 address | Base station's subnet mask. Uses dotted decimal form, such as "192.168.23.255". |
Base stationss. | |
| NET-LOCAL.SEC-ENABLE | Communication | PRIVATE | 5.2.0 | SET|GET | state |
[ON|OFF] |
enable/disable
ON: use authentication OFF: no authentication |
Use authentication over telnet for communciation between reader and base. | Ethernet readers. |
| NET-LOCAL.SEC-PASSWORD | Communication | PRIVATE | 5.2.0 | SET|GET | string |
password for authentication | Use authentication over telnet for communciation between reader and base. | Ethernet readers. | |
| NET-LOCAL.SEC-USERNAME | Communication | PRIVATE | 5.2.0 | SET|GET | string |
username for authentication | Use authentication over telnet for communciation between reader and base. | Ethernet readers. | |
| NET-LOCAL.SUBNET-MASK | Communication | PUBLIC | 3.3.0 | SET|GET | string |
Reader's subnet mask. Uses dotted decimal form, such as "192.168.23.255". |
Ethernet readers. | ||
| NET-LOCAL.TCP-KEEPALIVE | Communication | PRIVATE | 3.3.1 | SET|GET | state |
[ON|OFF] | enable/disable | Enable/Disable TCP keepalive message. | Ethernet readers. |
| NET-LOCAL.TCP-KEEPALIVE-COUNT | Communication | PRIVATE | 3.3.1 | SET|GET | value |
[0-32565] | TCP keep alive retry count. | Ethernet readers. | |
| NET-LOCAL.TCP-KEEPALIVE-IDLE | Communication | PRIVATE | 3.3.1 | SET|GET | value |
[0-32565] | TCP keep alive time. Ethernet readers. |
||
| NET-LOCAL.TCP-KEEPALIVE-INTERVAL | Communication | PRIVATE | 3.3.1 | SET|GET | value |
[0-32565] | TCP keep alive interval. Ethernet readers. |
||
| NETWORK-CLIENT.CLIENT-PORT | Communication | PUBLIC | 5.2.0 | SET|GET | int |
[0-65535] | The port on the reader to use as the outbound port (default is 0). | Ethernet readers except for the DM8000 wireless. | |
| NETWORK-CLIENT.CLOSE-CONNECTION | Communication | PUBLIC | 5.2.0 | SET|GET | int |
[0-1] |
0: Never 1: After reader data transfer |
Whether or not to keep the connection open after data transfer (default is 0). | Ethernet readers except for the DM8000 wireless. |
| NETWORK-CLIENT.CONNECTION-TIMEOUT | Communication | PUBLIC | 5.2.0 | SET|GET | int |
[1000-60000] | How long to wait before considering the connection dead (default is 3000). | Ethernet readers except for the DM8000 wireless. | |
| NETWORK-CLIENT.ENABLED | Communication | PUBLIC | 5.1.0 | SET|GET | state |
[ON|OFF] | enable/disable | Switch the Network Client feature on or off. | Ethernet readers except for the DM8000 wireless. |
| NETWORK-CLIENT.HOST-ADDRESS | Communication | PUBLIC | 5.2.0 | SET|GET | string |
Max length = 255 | The address of the server to connect to. | Ethernet readers except for the DM8000 wireless. | |
| NETWORK-CLIENT.HOST-PORT | Communication | PUBLIC | 5.2.0 | SET|GET | int |
[0–65535] | The remote port on the server to connect to (default is 1000). | Ethernet readers except for the DM8000 wireless. | |
| NETWORK-CLIENT.IDLE-TIMEOUT | Communication | PUBLIC | 5.2.0 | SET|GET | int |
[1–3600] | How long to keep the connection open after transfer (default is 1). | Ethernet readers except for the DM8000 wireless. | |
| NETWORK-CLIENT.OPEN-CONNECTION | Communication | PUBLIC | 5.2.0 | SET|GET | us |
[0-1] |
0: on Power-up 1: on Data Activity |
When to open the connection to the remote host (default is 0). | Ethernet readers except for the DM8000 wireless. |
| NETWORK-CLIENT.PROTOCOL | Communication | PUBLIC | 5.2.0 | SET|GET | int |
[0-1] |
0: TCP 1: UDP |
Which protocol to use for the connection (default is 0). | Ethernet readers except for the DM8000 wireless. |
| NETWORK-CLIENT.RECONNECT-DELAY | Communication | PUBLIC | 5.2.0 | SET|GET | int |
[100-60000] | How long to wait before reconnecting if the connection is lost (default is 1000). | Ethernet readers except for the DM8000 wireless. | |
| NTP.ENABLE | Communication | PUBLIC | 5.7.0 | SET|GET | state |
[ON|OFF] | enable/disable Enable/Disable | Enables or disables NTP. | All |
| NTP.SERVER1 | Communication | PUBLIC | 5.7.0 | SET|GET | server |
IP address or DNS name | Set the NTP server 1. | All | |
| NTP.SERVER2 | Communication | PUBLIC | 5.7.0 | SET|GET | server |
IP address or DNS name | Set the NTP server 2. | All | |
| OUTPUT-QUEUE.FLUSH | IO | PUBLIC | 4.1.0 | int |
[0-1] |
0: throw output away 1: send all output now |
To flush or send all output. | DM474, DM503, and DM300 series readers. | |
| OUTPUT.ACTION | IO | PREVIEW | 3.0.0 | SET|GET | line action |
[0-7] [0-1] |
line number 0: Open 1: Close |
Output Action. Open or Close output line on event. Only supported on line 1. |
Fixed mount readers. |
| OUTPUT.CQ-FAIL | IO | PRIVATE | 3.0.0 | Output Code Quality failed actions. Verifiers only. |
|||||
| OUTPUT.DATAVALID-FAIL | Action | PREVIEW | 3.0.0 | Virtual Data Validation Failure. Device beeps, flashes indicator lights, and sets output lines as if the specified Data Validation failure event occurred. |
ALL | ||||
| OUTPUT.DATAVALID-FAIL | IO | PRIVATE | 3.0.0 | Output Data Validation failed actions. | |||||
| OUTPUT.DELAY-DISTANCE | Decoder | PUBLIC | 4.4.0 | SET|GET | millimeters |
[0-100000] | Distance to output when using the Encoder. | DM474, DM503, and DM300 series readers. | |
| OUTPUT.DELAY-REFERENCE | Decoder | PUBLIC | 4.4.0 | SET|GET | mode |
[0-1] |
0: Trigger Start 1: Trigger End |
Sets or gets whether output is delayed relative to trigger start or trigger end. | DM50, DM60, DM70, DM474, DM503, and DM300 series readers. |
| OUTPUT.DELAY-TIME | Decoder | PUBLIC | 4.4.0 | SET|GET | milliseconds |
[0-10000] | Output delay in milliseconds. | DM50, DM60, DM70, DM503, DM300 series readers, DM474. | |
| OUTPUT.DELAY-TYPE | Decoder | PUBLIC | 4.4.0 | SET|GET | mode |
[0-1] |
0: None 1: Time |
Sets or gets whether output is delayed, and if so, whether according to time. | DM50, DM60, DM70, DM300 series readers, DM474. |
| OUTPUT.DELAY-TYPE | Decoder | PUBLIC | 4.4.0 | SET|GET | mode |
[0-2] |
0: None 1: Time 2: Distance |
Sets or gets whether output is delayed, and if so, whether according to time or distance. | DM503 |
| OUTPUT.EVENTS | IO | PREVIEW | 3.0.0 | SET|GET | line read no-read validation-failure trigger-overrun buffer-overflow user event 1 user event 2 |
[0-7] [0-1] [0-1] [0-1] [0-1] [0-1] [0-1] [0-1] |
i/o line number 0: Off 1: On 0: Off 1: On 0: Off 1: On 0: Off 1: On 0: Off 1: On 0: Off 1: On 0: Off 1: On |
Output Events. Configure output line to signal based on event. |
Fixed mount readers. |
| OUTPUT.GOOD | Action | PREVIEW | 3.0.0 | Virtual Good-Read. Device beeps, flashes indicator lights, and sets output lines as if the specified read event occurred. |
ALL | ||||
| OUTPUT.GOOD | IO | PRIVATE | 3.0.0 | Output good read actions. | |||||
| OUTPUT.NOREAD | Action | PREVIEW | 3.0.0 | Virtual No-Read. Device beeps, flashes indicator lights, and sets output lines as if the specified no-read event occurred. |
ALL | ||||
| OUTPUT.NOREAD | IO | PRIVATE | 3.0.0 | Output no read actions. | |||||
| OUTPUT.PULSE-WIDTH | IO | PUBLIC | 3.0.0 | SET|GET | line ms |
[0-7] [0-30000] |
i/o line number milliseconds |
Output Pulse-width. | Fixed mount readers. |
| OUTPUT.RESERVED | IO | PUBLIC | 3.0.0 | SET|GET | line reserved |
[0-7] [ON|OFF] |
i/o line number enable/disable |
Output Reserved for External Illumination. Line will be controlled by acquisition system when enabled. | Fixed mount readers, except DM50, DM60 and DM70. |
| OUTPUT.TRIG-OVERRUN | IO | PRIVATE | 3.0.0 | Output trigger overrun actions. | |||||
| OUTPUT.USER-CONFIGURE | Communication | PUBLIC | 5.3.0 | SET|GET | event number beep tone beep number LED color vibration |
[1,2] [0-2] [0-3] [0-7] [ON|OFF] |
1: USER_EVENT_1 2: USER_EVENT_2 [0]: Low [1]: Medium [2]: High Number of beeps [0]: Off [1]: Blue [2]: Green [3]: Cyan [4]: Red [5]: Magenta [6]: Yellow [7]: White enable/disable ON: The reader vibrates on the given user event. OFF: The reader does not vibrate on the given user event. |
Sets the beeper tone and the number of beeps for USER_EVENT_1 or USER_EVENT_2. | DM8050 (except for the vibration parameter), ON|OFF is supported on DM8600 and MX-1000. |
| OUTPUT.USER1 | Action | PUBLIC | 5.3.0 | Device emits USER_EVENT_1 event. | DM8050, MX-1000, MX-1502, DM474, DM503 and DM300 series readers. | ||||
| OUTPUT.USER2 | Action | PUBLIC | 5.3.0 | Device emits USER_EVENT_2 event. | DM8050, MX-1000, MX-1502, DM474, DM503 and DM300 series readers. | ||||
| PCM-RESULT-STRING.EXTEND | Decoder | PUBLIC | 5.7.0 | SET|GET | enable |
[ON|OFF] | Enable or disable extending the result string with metric information. | Ethernet readers. | |
| PCM-RESULT-STRING.METRIC-FORMAT | Decoder | PUBLIC | 5.7.0 | SET|GET | type |
[0-2] |
0: Grade 1: Value 2: Grade + Value |
Set the format of a single metric entry. | Ethernet readers. |
| PCM-RESULT-STRING.METRIC-PREFIX | Decoder | PUBLIC | 5.7.0 | SET|GET | type |
[0-2] |
0: None 1: Acronym 2: Name |
Defines the prefix for a single metric entry. | Ethernet readers. |
| PCM-RESULT-STRING.METRIC-SEPARATOR | Decoder | PUBLIC | 5.7.0 | SET|GET | string |
Defines the metric separator. | Ethernet readers. | ||
| PCM-RESULT-STRING.OVERALL-GRADE | Decoder | PUBLIC | 5.7.0 | SET|GET | type |
[ON|OFF] | enable | Enables or disables showing the overall grade in at the beginning of the result string. | Ethernet readers. |
| PCM-RESULT-STRING.SEPARATOR | Decoder | PUBLIC | 5.7.0 | SET|GET | string |
Defines the main separator between result data and metric section. | Ethernet readers. | ||
| PCM.CUSTOM-DESCRIPTION | Decoder | PUBLIC | 5.7.0 | SET|GET | string |
Ethernet readers. | |||
| PCM.METRIC-PARM-OVERALL | Decoder | PUBLIC | 5.7.0 | SET|GET | type type state |
[0-5] [0-27] [ON|OFF] |
0: AIM-DPM 1: ISO-IEC 15415 2: ANSI-ISO-IEC 15416 3: SemiT10 4: 1D readability 5: DotCode Readybility 0: Symbol Contrast 1: Axial Non Uniformity 2: Print Growth 3: UEC 4: Modulation 5: Fixed Pattern Damage 6: Grid Non Uniformity 7: Extreme Reflectance 8: Reflect Min 9: Edge Contrast Min 10: Single Scan Int 11: Multi Scan Int 12: Signal To Noise Ratio 13: Horizontal Mark Growth 14: Vertical Mark Growth 15: Data Matrix Cell Width 16: Data Matrix Cell Height 17: Horizontal Mark Misplacement 18: Vertical Mark Misplacement 19: Cell Defects 20: Finder Pattern Defects 21: Overall Grade 22: Edge Determination 23: Defects 24: Reference Decode 25: Decodability 26: Contrast Uniformity 27: Reflectance Margin ON: use for overall calculation OFF: do not use for overall calculation |
Use the the metric grading result for calculating the overall result if enabled (e.g. AIM-DPM → Symbol Contrast → Use for Overall Calculation = ON) Not all metrics are available for each standard: AIM-DPM (0, 1, 2, 3, 4, 5, 6, 8), ISO-IEC 15415 (0, 1, 3, 4, 5, 6, 7), ANSI-ISO-IEC 15416 (1, 4, 8, 9, 22, 23, 24, 25), 1D readability (0, 2, 8, 9, 10, 11), DotCode (0, 1, 2, 3, 6, 8) | Ethernet readers. |
| PCM.METRIC-PARM-REPORT | Decoder | PUBLIC | 5.7.0 | SET|GET | type type state |
[0-5] [0-27] [ON|OFF] |
0: AIM-DPM 1: ISO-IEC 15415 2: ANSI-ISO-IEC 15416 3: SemiT10 4: 1D readability 5: DotCode Readybility 0: Symbol Contrast 1: Axial Non Uniformity 2: Print Growth 3: UEC 4: Modulation 5: Fixed Pattern Damage 6: Grid Non Uniformity 7: Extreme Reflectance 8: Reflect Min 9: Edge Contrast Min 10: Single Scan Int 11: Multi Scan Int 12: Signal To Noise Ratio 13: Horizontal Mark Growth 14: Vertical Mark Growth 15: Data Matrix Cell Width 16: Data Matrix Cell Height 17: Horizontal Mark Misplacement 18: Vertical Mark Misplacement 19: Cell Defects 20: Finder Pattern Defects 21: Overall Grade 22: Edge Determination 23: Defects 24: Reference Decode 25: Decodability 26: Contrast Uniformity 27: Reflectance Margin ON: include in report OFF: do not include in report |
Include the metric grading result for selected quality standard and metric in the report if enabled. Only available if not use for overall calculation (e.g. ISO-IEC 15415 → Modulation → Show in Report = ON) Not all metrics are available for each standard: AIM-DPM (0, 1, 2, 3, 4, 5, 6, 8), ISO-IEC 15415 (0, 1, 2, 3, 4, 5, 6, 7), ANSI-ISO-IEC 15416 (0, 4, 8, 9, 22, 23, 24, 25), SemiT10 (1, 4, 12, 13, 14, 15, 16, 17, 18, 19, 20), 1D readability (0, 2, 8, 9, 10, 11), DotCode (0, 1, 2, 3, 6, 8). | Ethernet readers. |
| PCM.METRIC-PARM-THRESHOLD | Decoder | PUBLIC | 5.7.0 | SET|GET | type type grade value |
[0-5] [0-25] [1-4] [0-1000] |
0: AIM-DPM 1: ISO-IEC 15415 2: ANSI-ISO-IEC 15416 3: SemiT10 4: 1D readability 5: DotCode Readybility 0: Symbol Contrast 1: Axial Non Uniformity 2: Print Growth 3: UEC 4: Modulation 5: Fixed Pattern Damage 6: Grid Non Uniformity 7: Extreme Reflectance 8: Reflect Min 9: Edge Contrast Min 10: Single Scan Int 11: Multi Scan Int 12: Signal To Noise Ratio 13: Horizontal Mark Growth 14: Vertical Mark Growth 15: Data Matrix Cell Width 16: Data Matrix Cell Height 17: Horizontal Mark Misplacement 18: Vertical Mark Misplacement 19: Cell Defects 20: Finder Pattern Defects 21: Overall Grade 22: Edge Determination 23: Defects 24: Reference Decode 25: Decodability 1: D 2: C 3: B 4: A Threshold raw value |
Set the raw value threshold for the selected quality standard, metric and grade (e.g. AIM-DPM → UEC → Threshold B = 50). Not all metrics are available for each standard: AIM-DPM (0, 1, 3, 4, 6, 8), ISO-IEC 15415 (0, 1, 3, 4, 6), ANSI-ISO-IEC 15416 (1, 4, 8, 9, 23, 25), 1D readability (0, 2, 8, 9, 11), DotCode (0, 1, 2, 3, 6, 8) | Ethernet readers. |
| PCM.MIN-PASS | Decoder | PUBLIC | 5.7.0 | SET|GET | type grade |
[0-5] [0-4] |
0: AIM-DPM 1: ISO-IEC 15415 2: ANSI-ISO-IEC 15416 3: SemiT10 4: 1D readability 5: DotCode Readybility 0: F 1: D 2: C 3: B 4: A |
Set the overall minimum passing grade. Results under this grade will mean the reading failed. | Ethernet readers. |
| PCM.USE-CUSTOM-THRESHOLDS | Decoder | PUBLIC | 5.7.0 | SET|GET | type state |
[0-5] [ON|OFF] |
0: AIM-DPM 1: ISO-IEC 15415 2: ANSI-ISO-IEC 15416 3: SemiT10 4: 1D readability 5: DotCode Readybility ON: do regrading OFF: keep current result |
Enable or disable regrading of metric results by using the custom thresholds. | Ethernet readers. |
| PHARMA.CODE-ORIENTATION | Symbology | PUBLIC | 3.4.0 | SET|GET | direction |
[0-2] |
0: Any (default) 1: Horizontal 2: Vertical |
Preferred orientation for decoding Pharmacode symbols. | ALL |
| PHARMA.CODESIZE | Symbology | PUBLIC | 3.4.0 | SET|GET | any min max |
[ON|OFF] [1-6] [1-6] |
any length code minimum code length maximum code length |
Expected Pharmacode size. | ALL |
| PHARMA.HORIZONTAL-DIRECTION | Symbology | PUBLIC | 3.4.0 | SET|GET | direction |
[0-1] |
0: left-to-right (default) 1: right-to-left |
Horizontal direction preference for decoding Pharmacode symbols. | ALL |
| PHARMA.MAX-LENGTH | Symbology | PRIVATE | 4.4.0 | SET|GET | length |
[1-6] | Gets or sets the maximum length for a Pharmacode. Obsoleted in 5.1. |
ALL | |
| PHARMA.MIN-LENGTH | Symbology | PRIVATE | 4.4.0 | SET|GET | length |
[1-6] | Gets or sets the minimum length for a Pharmacode. Obsoleted in 5.1. |
ALL | |
| PHARMA.SUPPLEMENTARY | Symbology | PRIVATE | 3.4.0 | SET|GET | state |
[ON|OFF] | enable/disable | Get or set whether supplementary component is expected. | ALL |
| PHARMA.SUPPLEMENTARY-GAP-THRESH | Symbology | PRIVATE | 3.4.0 | SET|GET | gap |
[100-300] | Get or set the Pharmacode supplementary gap threshold in pixels. | ALL | |
| PHARMA.VERTICAL-DIRECTION | Symbology | PUBLIC | 3.4.0 | SET|GET | direction |
[0-1] |
0: top-to-bottom (default) 1: bottom-to-top |
Vertical direction preference for decoding Pharmacode symbols. | ALL |
| PHS.ADD-PACKAGE | System | PRIVATE | 5.4.0 | ||||||
| PLANET.XMTCHK | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | PLANET Transmit Check Character. | ALL |
| POSTNET.XMTCHK | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | POSTNET Transmit Check Character. | ALL |
| POWER.HIBERNATE-DISABLE | System | PUBLIC | 4.2.1 | SET|GET | state |
[ON|OFF] | enable/disable | Turning the Hibernation feature on or off. ON means that the device never hibernates. OFF means that Hibernation is not disabled (it is enabled), thus the device will go into hibernation mode. | DM8000 wireless readers. |
| POWER.HIBERNATE-TIMEOUT | System | PUBLIC | 4.2.1 | SET|GET | int |
[1-600] | seconds | Hibernation timeout. | DM8000 wireless readers. |
| POWER.POWEROFF-DISABLE | System | PUBLIC | 4.2.1 | SET|GET | state |
[ON|OFF] | enable/disable | Turning the Power Off feature on or off. ON means that the device never turns off. OFF means that Power Off is not disabled (it is enabled), thus the device will turn off. | DM8050, DM8600, MX-1000 and MX-1502. |
| POWER.POWEROFF-TIMEOUT | System | PUBLIC | 4.2.1 | SET|GET | int |
[1-600] | seconds | Power Off timeout. | DM8050, DM8600, MX-1000 and MX-1502. |
| POWER.SLEEP | System | PRIVATE | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Power Save Mode Enable. | DM7500 |
| POWER.SLEEPTIME | System | PRIVATE | 3.0.0 | SET|GET | secs |
[0, 60, 120... 600] | seconds | Time before entering power-save mode. | DM7500 |
| PPP.IP-CLIENT | System | PRIVATE | 5.4.0 | SET|GET | Reader/client device IP address for internal communication between client and base station. | Wireless readers. | |||
| PPP.IP-SERVER | System | PRIVATE | 5.4.0 | SET|GET | Base/server device IP address for internal communication between client and base station. | Wireless readers. | |||
| PPP.NETMASK | System | PRIVATE | 5.4.0 | SET|GET | int |
Netmask for internal communication between reader and base. | Wireless readers. | ||
| PRESENT.NEVER2X | System | PRIVATE | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Never Read the Same Code Twice. OBSOLETED in 4.5. Presentation mode only. |
ALL |
| PRESENT.REREAD | System | PRIVATE | 3.0.0 | SET|GET | ms |
[0-10000] | milliseconds | OBSOLETED in 4.5. Presentation Mode Re-read Delay. | ALL |
| PRESENT.RESCAN | System | PRIVATE | 3.0.0 | SET|GET | ms |
[0-10000] | milliseconds | OBSOLETED in 4.5. Presentation Mode Rescan Delay. | ALL |
| PROFIBUS.GATEWAY-COM | Communication | PRIVATE | 5.5.0 | SET|GET | mode |
[0-2] |
0: Profibus 1: RS485 2: RS422 |
Get the COM configuration (Profibus / RS422 / RS485). | Fixed-mount readers |
| PROFIBUS.GATEWAY-FLOW | Communication | PRIVATE | 5.5.0 | SET|GET | mode |
[0-2] |
0: None 1: RTS/CTS 2: XON/XOFF |
The reader will return a value indicating the type of serial flow control to be used. | Fixed-mount readers |
| PROFIBUS.GATEWAY-HOST | Communication | PRIVATE | 5.5.0 | GET | type |
[0] | The reader will return a value indicating the host interface protocol. | Fixed-mount readers | |
| PROFIBUS.GATEWAY-MODE | Communication | PRIVATE | 5.5.0 | GET | mode |
[1] | Get the profibus mode configuration. | Fixed-mount readers | |
| PROFIBUS.GATEWAY-NODE | Communication | PRIVATE | 5.5.0 | SET|GET | node number |
[1-99] | The reader will return the Profinet node number for the gateway. | Fixed-mount readers | |
| PROFIBUS.GATEWAY-RUN | Communication | PRIVATE | 5.5.0 | SET|GET | state |
[ON|OFF] | Runtime start message or heartbeat. | Fixed-mount readers | |
| PROFIBUS.GATEWAY-STATUS | Communication | PRIVATE | 5.5.0 | SET|GET | status |
[0-4] |
0: ok, no error 1: Invalid op mode 2: Invalid node number 3: Invalid flow control 4: Invalid host interference |
Set Gateway error message. | Fixed-mount readers |
| PROFIBUS.GATEWAY-VERSION | Communication | PRIVATE | 5.5.0 | SET|GET | mode |
Set the GW firmware version, used for baud rate detection. | Fixed-mount readers | ||
| PROFINET.ENABLED | Communication | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enabled or disabled PROFINET communications. | Ethernet readers. The DM8000 series wireless readers also support this protocol if the base station is connected through Ethernet. In the case of a Bluetooth connection, the command has to be sent to the base station, not to the reader. |
| PROXIMITY.CURRENT | Communication | PRIVATE | 5.4.0 | SET|GET | int |
[10-200] step 10 | IR LED current of the proximity sensor in mA | A higher value will increase the sensitivity of the sensor. | DM8600 |
| PROXIMITY.THRESHOLD | Communication | PRIVATE | 5.4.0 | SET|GET | int |
[0-100] | Threshold value which defines if the optical button has been pressed or released. A lower value will increase the sensitivity of the sensor. | DM8600 | |
| PTP-SYNC.DELAY | Communication | PUBLIC | 5.5.0 | SET|GET | time |
[0-1000000] | Time between trigger start and the synchronized acquisition timestamp. | DM360 series readers, DM474 | |
| PTP-SYNC.ENABLE | Communication | PUBLIC | 5.5.0 | SET|GET | mode |
[ON|OFF] | Enables MST synchronized by PTP. | DM360 series readers, DM474 | |
| PTP-SYNC.LOCAL-OFFSET | Communication | PUBLIC | 5.5.0 | SET|GET | time |
[0-1000000] | Local offset added to the synchronized acquisition timestamp. | DM360 series readers, DM474 | |
| PTP.ENABLE | Communication | PUBLIC | 5.5.0 | SET|GET | mode |
[ON|OFF] |
enable/disable
OFF: Disable the PTP timestamp synchronization ON: Enable the PTP timestamp synchronization |
Enable the PTP timestamp synchronization. | DM360 series readers, DM474 |
| PTP.PRIORITY1 | Communication | PUBLIC | 5.5.0 | SET|GET | level |
[0-255] | This is the first 8-bit priority value (lower number denotes a higher priority). Normally, this is set at 128 for master capable devices. | DM360 series readers, DM474 | |
| PTP.PRIORITY2 | Communication | PUBLIC | 5.5.0 | SET|GET | level |
[0-255] | This is the second 8-bit priority value (lower number denotes a higher priority). This parameter allows to configure backup clocks. | DM360 series readers, DM474 | |
| PTP.SLAVE-ONLY | Communication | PUBLIC | 5.5.0 | SET|GET | mode |
[ON|OFF] |
enable/disable
OFF: Disables PTP slave only configuration of the reader ON: Configures the reader as PTP slave only |
This parameter configures the reader as PTP slave only, even if no other master is active. | DM360 series readers, DM474 |
| QR.MAXIMUM-GRID-SIZE | Symbology | PUBLIC | 5.2.0 | SET|GET | size |
[49-177] | Step size: 4. | Maximum grid size which can be read by the QR decoder. | ALL |
| QR.MICRO | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Micro QR Code. | ALL except for DM300L, DM503L, and DM503QL. |
| QR.MODEL1 | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | QR model-1. | ALL except for DM300L, DM503L, and DM503QL. |
| QR.MODEL2 | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | QR model-2. | ALL except for DM300L, DM503L, and DM503QL. |
| QR.QUALITY-METRICS | Decoder | PUBLIC | 4.5.0 | SET|GET | type |
[0-2] |
0: none 1: ISO/IEC 15415 2: AIM-DPM / ISO/IEC TR 29158 |
Code quality metrics for QR codes. | ALL |
| QR.SYMBOL-DIFFICULTY | Symbology | PUBLIC | 5.1.0 | SET|GET | int |
[0-2] |
0: Easy 1: Medium 2: Hard |
Level of QR code symbol difficulty. | DM8600. |
| QR.TRAINED-MODEL | Decoder | PUBLIC | 5.7.0 | SET|GET | grid size module size model polarity mirrored |
[11-177] [1-1000] [0-3] [0-2] [ON|OFF] [ON|OFF] |
Grid size Module size * 10 0: Unknown model 1: Model-1 2: Model-2 3: Micro-QR 0: dark-on-light 1: light-on-dark 2: either enable/disable ON: mirrored OFF: not mirrored |
Set training parameters for QR-Code symbology. Option 3 for argument "model": Micro-QR is not applicable for 6.0.1. |
Fixed-mount readers |
| READER.ASSIGNED | Communication | PUBLIC | 5.2.0 | SET|GET | state |
[ON|OFF] | enable/disable | Unassignins the reader and the base station that is associated with it. | Base |
| REBOOT | Action | PUBLIC | 3.0.0 | Reboot the Device. Rebooting the Device restores the Configuration stored in Non-Volatile Memory. Commands will not be processed for several seconds while the device reboots. If communication settings are changed, connection with device may be lost. Note that when connected via USB-COM, the application must release the COM port. |
ALL | ||||
| REBOOT.DELAYED | Action | PUBLIC | 5.6.0 | Reboot the Device after delay in seconds. Rebooting the Device restores the Configuration stored in Non-Volatile Memory. Commands will not be processed for several seconds while the device reboots.If communication settings are changed, connection with device may be lost. Note that when connected via USB-COM, the application must release the COM port. | All | ||||
| RESULT | Action | PUBLIC | 3.0.0 | GET | target |
[0-1] |
0: Result string 1: XML formatted |
Optional Send Last Result. By default the result string is in ASCII format, but this can be changed to Base64 with the DATA.RESULT-ENCODING command. | ALL |
| RESULT.NO-READ-STRING | IO | PUBLIC | 3.0.0 | SET|GET | string |
no-read-string | No-Read Output String. | ALL | |
| RSS.EXPANDED | Symbology | PUBLIC | 4.4.0 | SET|GET | state |
[ON|OFF] | enable/disable | RSS Expanded. | ALL |
| SCRIPT.GARBAGE-COLLECT | Communication | PRIVATE | 5.5.0 | force |
[ON|OFF] | enable/disable Enforce the garbage collection | Check or enforce the Garbage Collection process. | Fixed mount readers | |
| SCRIPT.LOAD | Data Formatting | PUBLIC | 4.5.0 | num-bytes |
Loads the formatting script from the host to the reader. | DM50, DM60, DM70, DM474, DM503, MX-1000, MX-1502 and DM300 series readers. | |||
| SCRIPT.SEND | Data Formatting | PUBLIC | 4.5.0 | Sends the formatting script from the reader to the host. | DM50, DM60, DM70, DM474, DM503, MX-1000, MX-1502 and DM300 series readers. | ||||
| SDCARD.BACKUP-FILE | Communication | PUBLIC | 5.5.0 | SET|GET | state |
[ON|OFF] | enable/disable | SD card is used for creating and restoring a configuration file backup. | DM360 series readers, DM474 |
| SDCARD.PRESENT | Communication | PUBLIC | 5.5.0 | GET | Returns True if the SD card was detected, False otherwise. | DM360 series readers, DM474 | |||
| SDCARD.TESTFILE | Communication | PRIVATE | 5.5.0 | SET|GET | string |
SET: writes argument to a predefined file on the card. GET: reads back the same file and returns its content. | DM360 series readers, DM474 | ||
| SDK.VERSION | System | PRIVATE | 3.0.0 | SET|GET | Gets or sets the SDK version. Used by early versions of the DataMan SDK. | ||||
| SETUP.ENABLE | Camera | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Setup Enable. One Setup must always be enabled. Enable the desired Setup, before disabiling another Setup. For DM300 series readers, this command works for the active setup. |
DM50, DM60, DM70, DM150, DM260, DM474, DM503, DM8600, MX-1000 and DM300 series readers. |
| SETUP.NAME | Camera | PUBLIC | 3.0.0 | SET|GET | name |
Setup Name. User defined name. |
DM50, DM60, DM70, DM150, DM260, DM474, DM503, DM8600, MX-1000, and DM300 series readers. | ||
| SETUP.PROG-TARGET | Camera | PUBLIC | 3.0.0 | SET|GET | category |
[0-3] |
0: General Purpose 1: Curved Surface 2: Under Marked 3: Mirrored Surface |
Setup Programming Target. Setup to be modified by subsequent commands. |
DM70, DM150, DM260, DM8600 and MX-1000 |
| SETUP.PROG-TARGET | Camera | PUBLIC | 5.0.0 | SET|GET | category |
[0-15] | A number signifying an already existing setup. | Setup Programming Target. Setup to be modified by subsequent commands. |
DM50, DM60, DM70, DM150, DM260, DM474, DM503 and DM300 series readers. |
| SETUP.START-WITH-LAST-READ | Camera | PUBLIC | 5.2.0 | SET|GET | mode |
[ON|OFF] |
enable/disable
OFF: Start with fixed setup ON: Start with setup of last good read |
Sets read setup. | DM8600, DM70, DM150, DM260, DM474, DM503, MX-1000, MX-1502 and DM300 series readers. |
| SETUP.START-WITH-SETUP | Camera | PUBLIC | 5.2.0 | SET|GET | setup |
[0-15] | setup number to start with | Starts read setup. | DM8600, DM70, DM150, DM260, DM474, DM503, MX-1000, MX-1502 and DM300 series readers. |
| SETUP.USE | Camera | PUBLIC | 5.2.0 | int state |
[1-15] [ON|OFF] |
Setup to change enable/disable Disables/Enables setup to be used. |
Adds or removes a setup from the list of usable Read Setups. | DM8600, DM70, DM150, DM260, DM474, DM503 and DM300 series readers. | |
| SLMP-PROTOCOL.ENABLED | Communication | PUBLIC | SET|GET | state |
[ON|OFF] | enable/disable | Enables or disables SLMP-Protocol communication. | Ethernet readers. DM8000 series wireless readers also support this protocol if the base station is connected through Ethernet. In the case of a Bluetooth connection, the command has to be sent to the base station, not to the reader. | |
| SSH.UNLOCK | Action | PRIVATE | 6.0.1 | GET | The PC (host) sends this command to the reader to initiate the unlocking mechanism. As a response, the reader sends back a 32 byte random challenge to the PC. | DM474 | |||
| SSH.UNLOCK | Action | PRIVATE | 6.0.1 | SET | signature of the challenge |
The argument is the signature of the random challenge generated by the reader and signed with a public key on the PC side. The reader then verifies that the challenge was signed with the proper key and sent back in one minute. In this case, the SSH service is started on the reader, otherwise, an invalid parameter error is returned. | DM474 | ||
| STATISTICS.RESET | Action | PUBLIC | 3.3.1 | Reset all statistics. | ALL | ||||
| SYMBOL.4STATE-AUS | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable 4-State Australia Post Symbology. | ALL except for DM150QL, DM260QL, DM300L, DM503L, and DM503QL. |
| SYMBOL.4STATE-IMB | Symbology | PUBLIC | 3.4.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable 4-State Intelligent Mail Barcode. | ALL except for DM150QL, DM260QL, DM300L, DM503L, and DM503QL. |
| SYMBOL.4STATE-JAP | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable 4-State Japan Post Symbology. | ALL except for DM150QL, DM260QL, DM300L, DM503L, and DM503QL. |
| SYMBOL.4STATE-RMC | Symbology | PRIVATE | 5.6.0 | SET|GET | state |
[ON|OFF] | enable/disable Enable/Disable | Enables or disables Royal Mail Code Symbology. | DM50, DM60, DM70, DM150, DM260, DM30x, DM474, DM503, MX-1000, MX-1502. Mobile. |
| SYMBOL.4STATE-UPU | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable 4-State UPU Symbology. | ALL except for DM150QL, DM260QL, DM300L, DM503L, and DM503QL. |
| SYMBOL.AZTECCODE | Symbology | PUBLIC | 5.0.0_cr2 | SET|GET | state |
[ON|OFF] | enable/disable | Enable Aztec code symbology. | DM70, DM150, DM260, DM503, DM300 series readers, DM474, DM8050, DM8600, MX-1000, MX-1502, Mobile. |
| SYMBOL.C11 | Symbology | PUBLIC | 5.7.1 | SET|GET | state |
[ON|OFF] | enable/disable | Enable Code 11 Symbology. | ALL |
| SYMBOL.C128 | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable Code 128 Symbology. | ALL |
| SYMBOL.C25 | Symbology | PUBLIC | 5.5.2 | SET|GET | state |
[ON|OFF] | enable/disable | Enable Code 25 Symbology. Manatee Works supports 7 subcodes: Standard, Interleaved, ITF-14, IATA, Matrix, COOP, and Inverted. | ALL |
| SYMBOL.C39 | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable Code 39 Symbology. | ALL |
| SYMBOL.C39-CONVERT-TO-C32 | Code Quality | PUBLIC | 5.5.0 | SET|GET | state |
[ON|OFF] | enable/disable | Parameter enables or disables Code39 to Code 32 conversion. | DM70, DM150, DM260 |
| SYMBOL.C39-CONVERT-TO-C32 | Symbology | PUBLIC | 5.5.0 | SET | state |
[ON|OFF] | enable/disable | Enables/disables the conversion of Code39 to Code32. | ALL |
| SYMBOL.C93 | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable Code 93 Symbology. | ALL |
| SYMBOL.CODABAR | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable Codabar Symbology. | ALL |
| SYMBOL.COOP | Symbology | PUBLIC | 5.7.1 | SET|GET | state |
[ON|OFF] | enable/disable | ALL | |
| SYMBOL.DATABAR | Symbology | PUBLIC | 3.4.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable Databar. It will enable EXPANDED and LIMITED in Manatee Works SDK (just like MX). | ALL |
| SYMBOL.DATAMATRIX | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable DataMatrix Symbology. | ALL except for DM150QL, DM260QL, DM300L, DM503L, and DM503QL. |
| SYMBOL.DOTCODE | Symbology | PUBLIC | 5.0.0_cr3 | SET|GET | state |
[ON|OFF] | enable/disable | Enable DotCode symbology. | DM70, DM150, DM260, DM300 series readers, DM474, DM8050X, DM8600, MX-1000, MX-1502, Mobile. |
| SYMBOL.EAN-UCC | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable EAN-UCC Symbology. | ALL |
| SYMBOL.I2O5 | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable Interleaved 2 of 5 Symbology. | ALL |
| SYMBOL.IATA | Symbology | PUBLIC | 5.7.1 | SET|GET | state |
[ON|OFF] | enable/disable | ALL | |
| SYMBOL.INVERTED | Symbology | PUBLIC | 5.7.1 | SET|GET | state |
[ON|OFF] | enable/disable | ALL | |
| SYMBOL.ITF14 | Symbology | PUBLIC | 5.7.1 | SET|GET | state |
[ON|OFF] | enable/disable | ALL | |
| SYMBOL.MATRIX | Symbology | PUBLIC | 4.7.1 | SET|GET | state |
[ON|OFF] | enable/disable | Enable Matrix symbology. | All. |
| SYMBOL.MAXICODE | Symbology | PUBLIC | 4.5.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable MaxiCode symbology. | DM50, DM60, DM70, DM150, DM260, DM300 series readers, DM474, DM503, DM8050, DM8600, MX-1000 and MX-1502, Mobile. |
| SYMBOL.MICROPDF417 | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable Micro-PDF 417 Symbology. | ALL |
| SYMBOL.MSI | Symbology | PUBLIC | 5.0.0_cr5 | SET|GET | state |
[ON|OFF] | enable/disable | Sets or gets whether MSI Code is enabled or disabled | DM70, DM150, DM260, DM503, DM300 series readers, DM474, MX-1000, MX-1502, Mobile. |
| SYMBOL.PDF417 | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable PDF 417 Symbology. | ALL |
| SYMBOL.PHARMACODE | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable Pharmacode symbology. | ALL |
| SYMBOL.PLANET | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable PLANET Symbology. | ALL except for DM150QL, DM260QL, DM300L, DM302L, DM503L, and DM503QL. |
| SYMBOL.POSTNET | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable POSTNET Symbology. | ALL except for DM150QL, DM260QL, DM300L, DM503L, and DM503QL. |
| SYMBOL.QR | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable QR-Code Symbology. Enables QR and Micro QR in Manatee Works SDK. | ALL except for DM150QL, DM260QL, DM300L, DM503L and DM503QL. |
| SYMBOL.RPC | Symbology | PRIVATE | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Reader Programming Code. | DM70, DM150, DM260 |
| SYMBOL.UPC-EAN | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable UPC/EAN Symbology. It will enable UPC-A, UPC-E, EAN-8, and EAN-13 in Manatee Works SDK (just like MX). | ALL |
| SYMBOL.VERICODE | Symbology | PUBLIC | 3.2.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable VeriCode ® symbology. | DM70, DM150 and DM260 readers with VeriCode ® license. |
| SYNC-ACQUISITION.CABLE-END | Communication | PUBLIC | 5.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Sets or gets whether your device is a bus terminator at the end of the synchronization interface bus. | DM503 |
| SYNC-ACQUISITION.DELAY | Communication | PUBLIC | 5.0.0 | SET|GET | us |
[0-25000] | microseconds | Synchronized acquisition delay: the time the reader waits after sending or receiving the synchronized interface signal before the regular acquisition sequence starts. | DM503 |
| SYNC-ACQUISITION.ENABLED | Communication | PUBLIC | 5.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enables or disables synchronized triggering. | DM503 |
| SYNC-ACQUISITION.MASTER | Communication | PUBLIC | 5.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Sets or gets whether the device is the master among the synchronized readers. | DM503 |
| SYNC-ACQUISITION.START-DELAY | Communication | PRIVATE | 5.0.0 | SET|GET | us |
[0-25000] | microseconds | This command is to adjust the delay between the master/slave trigger sent via Ethernet and the sync signal sent for RS-845 to compensate for the longer runtime of the message via Ethernet. Developer only command. |
DM503 |
| TELNET.CUSTOM-PORTS | Communication | PUBLIC | 5.5.0 | SET|GET | port |
[0-65535] | Comma separated list of TCP ports | Additional Telnet TCP ports for custom communication. | Ethernet readers |
| TELNET.PORT | Communication | PUBLIC | 3.3.0 | SET|GET | value |
[0-65535] | Telnet server TCP port on reader. | Ethernet readers. | |
| TEMPERATURE.CPU | System | PRIVATE | 6.1.0 | GET | CPU Temperature in °C. | DM370 series, DM470 series readers. | |||
| TEMPERATURE.LL | System | PRIVATE | 6.1.0 | GET | Get Liquid lens Temperature in °C. Only available if a Liquid lens is present. |
DM370 series, DM470 series readers. | |||
| TEMPERATURE.SENSOR | System | PRIVATE | 6.1.0 | GET | Get Imager Temperature in °C. Only available if compatible image sensor is present. Readout can interfere with image acquisition. |
DM370 series, DM470 series readers. | |||
| TEST-MODE.ACCEPT-TRIGGERS | Communication | PUBLIC | 5.2.0 | value |
[0-2000000000] | number of accepted triggers from all inputs | Allows a limited number of triggers from external inputs even if triggering from those should be rejected using TEST-MODE.INPUTS-ENABLE. | DM70, DM150, DM260, DM474, DM503 and DM300 series readers. | |
| TEST-MODE.AUTOMATIC | Communication | PUBLIC | 5.2.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enables automatic triggering. | DM70, DM150, DM260, DM474, DM503 and DM300 series readers. |
| TEST-MODE.AUTOMATIC-OFF-US | Communication | PUBLIC | 5.2.0 | SET|GET | microseconds |
[0-2000000000] | Inactive trigger phase for automatic triggering. | DM70, DM150, DM260, DM474, DM503 and DM300 series readers. | |
| TEST-MODE.AUTOMATIC-ON-US | Communication | PUBLIC | 5.2.0 | SET|GET | microseconds |
[0-2000000000] | Active trigger phase for automatic triggering. | DM70, DM150, DM260, DM474, DM503 and DM300 series readers. | |
| TEST-MODE.ENABLE | Communication | PUBLIC | 5.2.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enables test mode. | DM70, DM150, DM260, DM474, DM503 and DM300 series readers. |
| TEST-MODE.INPUTS-ENABLE | Communication | PUBLIC | 5.2.0 | SET|GET | state |
[ON|OFF] | enable/disable | Disables external trigger sources during test mode. | DM70, DM150, DM260, DM474, DM503 and DM300 series readers. |
| TEST-MODE.OUTPUTS-ENABLE | Communication | PUBLIC | 5.2.0 | SET|GET | state |
[ON|OFF] | enable/disable | Disables result reporting to external destinations during test mode. | DM70, DM150, DM260, DM474, DM503 and DM300 series readers. |
| TLS.BENCHMARK | Action | PRIVATE | 5.7.0 | Starts a benchmark of the SSL/TLS library.This DMCC is password protected. The result can be checked in the HPT log output. | ALL | ||||
| TLS.SELFTEST | Action | PRIVATE | 5.7.0 | Starts a benchmark of the SSL/TLS library. This DMCC is password protected. The result can be checked in the HPT log output. | ALL | ||||
| TRACE.DUMPFILE | System | PRIVATE | 5.4.0 | filename |
Saves a trace log file, which is archived in flash, into a file. | ||||
| TRAIN.AUTO-DISABLE | Symbology | PREVIEW | 3.2.0 | SET|GET | state |
[ON|OFF] | enable/disable | Indicates whether untrained symbology groups will be disabled after the next attempt to train. | Fixed mount readers. |
| TRAIN.AVAILABLE | Symbology | PRIVATE | 3.2.0 | GET | symbology |
Indicates whether incremental training is available for the selected symbology group. | Fixed mount readers. | ||
| TRAIN.BRIGHT | Action | PUBLIC | 3.0.0 | type |
[ON|OFF] |
ON: Start Train Brightness Algorithm OFF: Abort Train Brightness Algorithm |
Generate a fixed value for the exposure setting based on the particular scene, similar to the Optimize Brightness button in the Setup Tool. | Fixed mount devices. | |
| TRAIN.CODE | Action | PUBLIC | 3.0.0 | state |
[ON|OFF] | enable/disable | Train symbology using next sucessful decode. | Fixed mount devices. | |
| TRAIN.CODE-FROM-IMAGE | Action | PRIVATE | 4.5.0 | num-bytes |
Code is trained from uploaded image. | Fixed mount devices. | |||
| TRAIN.FOCUS | Action | PUBLIC | 3.3.0 | state |
[ON|OFF] | enable/disable | Optimize lens focus. | DM503, DM474 and DM300 series readers. | |
| TRAIN.INCREMENTAL | Symbology | PUBLIC | 3.2.0 | SET|GET | state |
[ON|OFF] | enable/disable | Indicates whether incremental training is used during the next attempt to train. | Fixed mount readers. |
| TRAIN.MATCH-STRING | Action | PUBLIC | 3.1.0 | Triggers the reader and sets the match string to the value of the decoded string. Match String validation must be enabled for this command to work. | Fixed mount devices, DM8050 and DM8600. | ||||
| TRAINED-CODE.INFO | Symbology | PUBLIC | 4.4.0 | GET | Gets information about the currently trained code type ('Untrained' if no code is trained). | Fixed mount devices. | |||
| TRIGGER | Action | PUBLIC | 3.0.0 | state |
[ON|OFF] |
enable/disable
ON: Scanning process is initiated, displaying the preview if necessary, decoding frames, etc. OFF: Scanning process is terminated, even if a barcode has not been decoded. |
Software Trigger. | ALL | |
| TRIGGER | Action | PUBLIC | 3.6.0 | GET | state |
[0|1] |
0: Off 1: On |
Get current state of the trigger. | ALL |
| TRIGGER.DEBOUNCE-DELAY | IO | PUBLIC | 4.0.0 | SET|GET | delay |
[0-6] |
0: short 1: 2: default 3: 4: 5: 6: long |
Sets or gets how long the trigger signal must be detected in order to be recognized as valid. | Fixed-mount readers. |
| TRIGGER.DELAY | Camera | PRIVATE | 3.0.0 | SET|GET | milliseconds |
[0-10000] | Trigger Delay. Delay camera acquisition by specified number of milliseconds. |
ALL | |
| TRIGGER.DELAY-DISTANCE | Camera | PUBLIC | 4.4.0 | SET|GET | millimeter |
[0-2147483646] | Delay camera acquisition by distance specified in millimeters. | DM503, DM474 and DM300 series readers. | |
| TRIGGER.DELAY-TIME | Camera | PUBLIC | 4.4.0 | SET|GET | milliseconds |
[0-10000] | Trigger delay in milliseconds. Delay camera acquisition by specified number of milliseconds. |
DM50, DM60, DM70, DM474, DM503, and DM300 series readers. | |
| TRIGGER.DELAY-TYPE | Camera | PUBLIC | 4.4.0 | SET|GET | mode |
[0-1] |
0: none 1: time |
Sets or gets whether trigger delay is according to time. | DM50, DM60 and DM70 |
| TRIGGER.DELAY-TYPE | Camera | PUBLIC | 4.4.0 | SET|GET | mode |
[0-2] |
0: none 1: time 2: distance |
Sets or gets whether trigger delay is according to time or distance. | DM503, DM474 and DM300 series readers. |
| TRIGGER.END-DELAY-DISTANCE | Camera | PUBLIC | 4.4.0 | SET|GET | millimeters |
[0-2147483646] | Sets or gets trigger end delay distance. | DM474, DM503 and DM300 series readers. | |
| TRIGGER.END-DELAY-TIME | Camera | PUBLIC | 4.4.0 | SET|GET | milliseconds |
[0-10000] | Sets or gets trigger end delay time. | DM50, DM60, DM70, DM474, DM503, and DM300 series readers. | |
| TRIGGER.END-HOLDOFF-DISTANCE | IO | PUBLIC | 5.5.0 | SET|GET | distance |
[0-10000 mm] | distance for hold-off at trigger end | When greater than 0, the distance with which to cancel a pending trigger off and allow the trigger to continue. | DM474, DM503 and DM300 series readers. |
| TRIGGER.END-HOLDOFF-TIME | IO | PUBLIC | 5.5.0 | SET|GET | rime |
[0-10000 ms] | time for hold-off at trigger end | When greater than 0, the time with which to cancel a pending trigger off and allow the trigger to continue. | Fixed-mount readers |
| TRIGGER.HOLDOFF-DISTANCE | IO | PUBLIC | 5.5.0 | SET|GET | distance |
[0-10000 mm] | distance for hold-off at trigger start | When greater than 0, the distance with which to cancel a pending trigger on and act like there was no trigger at all. | DM474, DM503 and DM300 series readers. |
| TRIGGER.HOLDOFF-TIME | IO | PUBLIC | 5.5.0 | SET|GET | time |
[0-10000 ms] | time for hold-off at trigger start | When greater than 0, the time with which to cancel a pending trigger on and act like there was no trigger at all. | Fixed-mount readers |
| TRIGGER.HOLDOFF-TYPE | IO | PUBLIC | 5.5.0 | SET|GET | type |
[0-2] |
0 = None 1 = Time 2 = Distance |
Which type of trigger hold-off to use, none, time or distance. | Fixed-mount readers |
| TRIGGER.IGNORE-DISTANCE | IO | PRIVATE | 5.5.0 | SET|GET | milliseconds |
[0-2147483646] | Sets or gets the minimum trigger distance for a trigger to be considered good. All trigger durations less than the specified duration will be aborted. | Fixed-mount readers | |
| TRIGGER.IGNORE-TIME | IO | PRIVATE | 5.5.0 | SET|GET | milliseconds |
[0-10000] | Sets or gets the minimum trigger duration for a trigger to be considered good. All trigger durations less than the specified duration will be aborted. | Fixed-mount readers | |
| TRIGGER.IGNORE-TYPE | IO | PRIVATE | 5.5.0 | SET|GET | mode |
[0-2] |
0: none 1: time 2: distance |
Sets or gets what type of triggers to ignore. | Fixed-mount readers |
| TRIGGER.POLARITY | IO | PUBLIC | 4.0.0 | SET|GET | line polarity |
[0-3] [ON|OFF] |
Input line ON: Rising edge OFF: Falling edge |
Sets or gets the polarity at which an input will be triggered. | Fixed mount readers. |
| TRIGGER.TYPE | Camera | PUBLIC | 3.0.0 | SET|GET | type |
[0-5] |
0: Single (external) 1: Presentation (internal) 2: Manual (button) 3: Burst (external) 4: Self (internal) 5: Continuous (external) |
Trigger Type. The camera API should return the current trigger type value. | DM700 and DM8000 series readers support only Presentation and Manual trigger types. MX-1000, MX-1502 and Mobile support only Manual and Continuous trigger types. |
| TRUCHECK.AG | Decoder | PUBLIC | 5.7.7 | GET | Returns the AG (average grade) score from the last verification attempt. | DM8072 Verifier | |||
| TRUCHECK.AG-GRADE | Decoder | PUBLIC | 5.7.7 | GET | Returns the AG (average grade) grade from the last verification attempt. | DM8072 Verifier | |||
| TRUCHECK.ANU | Decoder | PUBLIC | 5.7.7 | GET | Returns the ANU (axial non-uniformity) score from the last verification attempt. | DM8072 Verifier | |||
| TRUCHECK.ANU-GRADE | Decoder | PUBLIC | 5.7.7 | GET | Returns the ANU (axial non-uniformity) grade from the last verification attempt. | DM8072 Verifier | |||
| TRUCHECK.DECODE-GRADE | Decoder | PUBLIC | 5.7.7 | GET | Returns the DECODE grade from the last verification attempt. | DM8072 Verifier | |||
| TRUCHECK.FPD | Decoder | PUBLIC | 5.7.7 | GET | Returns the FPD (fixed pattern damage) score from the last verification attempt. | DM8072 Verifier | |||
| TRUCHECK.FPD-GRADE | Decoder | PUBLIC | 5.7.7 | GET | Returns the FPD (fixed pattern damage) grade from the last verification attempt. | DM8072 Verifier | |||
| TRUCHECK.GNU | Decoder | PUBLIC | 5.7.7 | GET | Returns the GNU (grid non-uniformity) score from the last verification attempt. | DM8072 Verifier | |||
| TRUCHECK.GNU-GRADE | Decoder | PUBLIC | 5.7.7 | GET | Returns the GNU (grid non-uniformity) grade from the last verification attempt. | DM8072 Verifier | |||
| TRUCHECK.MOD-GRADE | Decoder | PUBLIC | 5.7.7 | GET | Returns the MOD (modulation) grade from the last verification attempt. | DM8072 Verifier | |||
| TRUCHECK.RM-GRADE | Decoder | PUBLIC | 5.7.7 | GET | Returns the RM grade from the last verification attempt. | DM8072 Verifier | |||
| TRUCHECK.SC | Decoder | PUBLIC | 5.7.7 | GET | Returns the SC (symbol contrast) score from the last verification attempt. | DM8072 Verifier | |||
| TRUCHECK.SC-GRADE | Decoder | PUBLIC | 5.7.7 | GET | Returns the SC (symbol contrast) grade from the last verification attempt. | DM8072 Verifier | |||
| TRUCHECK.UEC | Decoder | PUBLIC | 5.7.7 | GET | Returns the UEC (unused error correction) score from the last verification attempt. | DM8072 Verifier | |||
| TRUCHECK.UEC-GRADE | Decoder | PUBLIC | 5.7.7 | GET | Returns the UEC (unused error correction) grade from the last verification attempt. | DM8072 Verifier | |||
| TUNE-BUTTON.3SEC-ACTION | System | PUBLIC | 5.0.0 | SET|GET | action state |
[0-6] [ON|OFF] |
action code (see BUTTON.3SEC-ACTION), enabled enable/disable |
Defines actions when the user pushes the tune button for more than 3 seconds. | DM474, DM503 and DM300 readers. |
| TUNE-BUTTON.3SEC-ACTION | System | PUBLIC | 5.4.0 | SET|GET | action state |
[2,7] [ON|OFF] |
2: Set Match String 7: Extended Read Attempts enable/disable |
Defines actions when the user pushes the tune button for more than 3 seconds. | DM8600 readers. |
| TUNE-BUTTON.ENABLE | IO | PUBLIC | 5.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enables or disables the tune button. | DM474, DM503, and DM300 series readers. |
| TUNE-BUTTON.SAVE-MATCH-STRING | System | PUBLIC | 5.2.0 | SET|GET | state |
[ON|OFF] | enable/disable tune button enabled | Enables the 'save match string' action when the user pushes the tune button for more than 3 seconds. | DM474, DM503, DM8600 and DM300 readers. |
| TUNE.ADJUST-FOCUS | Camera | PUBLIC | 4.3.0 | SET|GET | state |
[ON|OFF] | Enables or disables using adjusting focus while tuning. | DM70, DM150, DM260, DM474 and DM300 series readers with liquid lens. | |
| TUNE.CANCEL | Action | PUBLIC | 4.3.0 |
|
0: Tuning is cancelled. 104: Tuning is not running or there is an error. 101: Tuning is not available. |
Cancel tuning. | DM300 series readers, DM474, DM70, DM260, and DM150. | ||
| TUNE.EXCLUDE-AMBIENT-RESULTS | Camera | PUBLIC | 5.7.0 | SET|GET | disable ambient |
[ON|OFF] |
ON: Disables the automatic selection of ambient light results OFF: Allows ambient light results for atomatic seletion |
Control the automatic selection of tuning results where the prevailing illumination type is ambient light. | Fixed mount readers. |
| TUNE.START | Action | PUBLIC | 4.3.0 |
|
0: Tuning started. 104: Tuning is already running or there is an error. 101: Tuning is not available. |
Start tuning. | DM300 series readers, DM474, DM70, DM260, and DM150. | ||
| TUNE.STATUS | Action | PUBLIC | 5.5.0 | GET | Returns ON if tuning is running, OFF otherwise. | Fixed mount devices. | |||
| TUNE.TRAIN-CODE | Camera | PUBLIC | 4.3.0 | SET|GET | state |
[ON|OFF] | Enables or disables code training while tuning. | DM300 series readers, DM474, DM70, DM260, and DM150. | |
| TUNE.TUNE-LIGHT-BANKS | Camera | PUBLIC | 4.3.0 | SET|GET | state |
[ON|OFF] | Enables or disables using light banks while tuning. Only available when internal illumination is used. |
DM300 series readers, DM474, DM260, DM70 and DM150. | |
| TUNE.TUNE-LIGHT-COMBINATIONS | Camera | PUBLIC | 5.5.0 | SET|GET | mode |
[ON|OFF] | If it is ON, light combinations will always be tuned. | DM300 series readers, DM474, DM260, DM70 and DM150. | |
| UNTRAIN.MODEL | Action | PUBLIC | 3.2.0 | enum index |
[0-5] 0 |
0: All Symbologies 1: DataMatrix 2: QR Code/MaxiCode/AztecCode 3: Linear/ Postal/ Stacked 4: VeriCode® 5: DotCode |
Deletes the specified model. AztecCode is only supported on the DM503 and DM300 series readers. |
Fixed mount readers. | |
| UPC-EAN.DELZERO | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | UPC/EAN Delete Leading Zero. | ALL |
| UPC-EAN.EAN13 | Symbology | PUBLIC | 5.7.1 | SET|GET | state |
[ON|OFF] | enable/disable | UPC/EAN Allow EAN13. | ALL |
| UPC-EAN.EAN8 | Symbology | PUBLIC | 5.7.1 | SET|GET | state |
[ON|OFF] | enable/disable | UPC/EAN Allow EAN8. | ALL |
| UPC-EAN.EAN8SUPL | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | UPC/EAN Allow EAN8 Supplementals. | ALL |
| UPC-EAN.EXPANDED | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | UPC/EAN Expanded. | ALL |
| UPC-EAN.SUPPLEMENT | Symbology | PUBLIC | 3.0.0 | SET|GET | option |
[0-4] |
0: Ignore 1: Required 2: Required 2 digit 3: Required 5 digit 4: Not required |
UPC/EAN Supplementals. The Manatee Works SDK only supports turning UPC/EAN supplement code support on/off, while the DMCC command allows them to be off, required, require a 2 digit, require a 5 digit, or optionally permit them. The Manatee Works SDK will treat options 1-4 the same; to simply enable them. | ALL |
| UPC-EAN.UPC-A | Symbology | PUBLIC | 5.7.1 | SET|GET | state |
[ON|OFF] | enable/disable | UPC/EAN UPC-A enabled. | ALL |
| UPC-EAN.UPC-E | Symbology | PUBLIC | 5.7.1 | SET|GET | state |
[ON|OFF] | enable/disable | UPC/EAN UPC-E enabled. | ALL |
| UPC-EAN.UPCE1 | Symbology | PUBLIC | 5.7.1 | SET|GET | state |
[ON|OFF] | enable/disable | UPC/EAN UPCE1 enabled. | ALL |
| UPC-EAN.UPCE1 | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | UPC/EAN UPCE1 Enabled. | ALL |
| UPTIME | Action | PUBLIC | 5.7.0 | Shows the time since device started. | All | ||||
| VIBRATION.GOOD | System | PUBLIC | 3.1.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enables vibration. | Handheld readers, except for DM8050. |
| VSOC.ACCELERATION | Decoder | PRIVATE | 4.0.0 | SET|GET | enable |
[ON|OFF] | enable/disable | Enabled or disable VSOC acceleration. | |
| VSOC.LEGACY-AUTO-REG | Camera | PRIVATE | 4.0.0 | SET|GET | enable |
[ON|OFF] | enable/disable | Enabled or disable VSOC auto-regulation algorithm. | |
| WIFI.AUTH-MODE | Communication | PUBLIC | 4.2.4 | SET|GET | int |
[0-3] |
0 – no auth 1 – WPA-PSK 2 – WPA2-PSK 3 – EAP/TLS 4 – PEAP-MSCHAPV2 |
Sets the authentication method. | DM8000 |
| WIFI.CA-CERT | Communication | PUBLIC | 4.2.4 | SET|GET | string |
NA | Used In WPA-Enterprise. This is the certificate of the certification authority we trust. | PEM formatted certificate, terminated by a space. | DM8000;Base |
| WIFI.CHANNEL | Communication | PUBLIC | 4.2.4 | SET|GET | int |
[1-11] | Sets the wifi channel number. | ||
| WIFI.CLIENT-CERT | Communication | PUBLIC | 4.2.4 | SET|GET | string |
NA | Used in WPA-Enterprise (EAP-TLS). This is the certificate of the reader signed by the trusted CA (set with the previous command). | PEM formatted certificate, terminated by a space. | DM8000;Base |
| WIFI.CLIENT-IDENTITY | Communication | PUBLIC | 4.2.4 | SET|GET | string |
NA | The identity the client certificate is issued to. | DM8000;Base | |
| WIFI.CLIENT-PRIVATE-KEY | Communication | PUBLIC | 4.2.4 | SET|GET | string |
NA | Used in WPA-Enterprise (EAP-TLS). The private key of the reader. | PEM formatted private key, terminated by a space. | DM8000;Base |
| WIFI.ENABLED | Communication | PUBLIC | 4.2.4 | SET|GET | state |
[ON|OFF] | enable/disable | Enables or disables wifi in ad-hoc mode. | |
| WIFI.ENC-METHOD | Communication | PUBLIC | 4.2.4 | SET|GET | int |
[0-5] |
0 – off 1 – WEP40 2 – WEP104 3 – TKIP 4 – AES 5 – TKIP/AES |
Sets the authentication method. | DM8000;Base |
| WIFI.NETWORK-TYPE | Communication | PUBLIC | 4.2.4 | SET|GET | int |
[0-1] |
0 – Infrastructure mode 1 – AD-HOC mode |
Sets whether wifi works in infrastructure or ad-hoc mode. | DM8000 |
| WIFI.PASSPHRASE | Communication | PUBLIC | 4.2.4 | SET|GET | string |
NA | In WEP encrpytion and in WPA(2)-PSK it is the passphrase set by the AP. | DM8000;Base | |
| WIFI.SSID | Communication | PUBLIC | 4.2.4 | SET|GET | string |
NA | Assigns an SSID name to the network. |
| Name |
Type |
Level |
Version |
Set/Get |
Args |
Range |
Meaning |
Description |
Support |
|---|---|---|---|---|---|---|---|---|---|
| WIFI.SSID | Communication | PUBLIC | 4.2.4 | SET|GET | string |
NA | Assigns an SSID name to the network. | ||
| WIFI.PASSPHRASE | Communication | PUBLIC | 4.2.4 | SET|GET | string |
NA | In WEP encrpytion and in WPA(2)-PSK it is the passphrase set by the AP. | DM8000;Base | |
| WIFI.NETWORK-TYPE | Communication | PUBLIC | 4.2.4 | SET|GET | int |
[0-1] |
0 – Infrastructure mode 1 – AD-HOC mode |
Sets whether wifi works in infrastructure or ad-hoc mode. | DM8000 |
| WIFI.ENC-METHOD | Communication | PUBLIC | 4.2.4 | SET|GET | int |
[0-5] |
0 – off 1 – WEP40 2 – WEP104 3 – TKIP 4 – AES 5 – TKIP/AES |
Sets the authentication method. | DM8000;Base |
| WIFI.ENABLED | Communication | PUBLIC | 4.2.4 | SET|GET | state |
[ON|OFF] | enable/disable | Enables or disables wifi in ad-hoc mode. | |
| WIFI.CLIENT-PRIVATE-KEY | Communication | PUBLIC | 4.2.4 | SET|GET | string |
NA | Used in WPA-Enterprise (EAP-TLS). The private key of the reader. | PEM formatted private key, terminated by a space. | DM8000;Base |
| WIFI.CLIENT-IDENTITY | Communication | PUBLIC | 4.2.4 | SET|GET | string |
NA | The identity the client certificate is issued to. | DM8000;Base | |
| WIFI.CLIENT-CERT | Communication | PUBLIC | 4.2.4 | SET|GET | string |
NA | Used in WPA-Enterprise (EAP-TLS). This is the certificate of the reader signed by the trusted CA (set with the previous command). | PEM formatted certificate, terminated by a space. | DM8000;Base |
| WIFI.CHANNEL | Communication | PUBLIC | 4.2.4 | SET|GET | int |
[1-11] | Sets the wifi channel number. | ||
| WIFI.CA-CERT | Communication | PUBLIC | 4.2.4 | SET|GET | string |
NA | Used In WPA-Enterprise. This is the certificate of the certification authority we trust. | PEM formatted certificate, terminated by a space. | DM8000;Base |
| WIFI.AUTH-MODE | Communication | PUBLIC | 4.2.4 | SET|GET | int |
[0-3] |
0 – no auth 1 – WPA-PSK 2 – WPA2-PSK 3 – EAP/TLS 4 – PEAP-MSCHAPV2 |
Sets the authentication method. | DM8000 |
| VSOC.LEGACY-AUTO-REG | Camera | PRIVATE | 4.0.0 | SET|GET | enable |
[ON|OFF] | enable/disable | Enabled or disable VSOC auto-regulation algorithm. | |
| VSOC.ACCELERATION | Decoder | PRIVATE | 4.0.0 | SET|GET | enable |
[ON|OFF] | enable/disable | Enabled or disable VSOC acceleration. | |
| VIBRATION.GOOD | System | PUBLIC | 3.1.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enables vibration. | Handheld readers, except for DM8050. |
| UPTIME | Action | PUBLIC | 5.7.0 | Shows the time since device started. | All | ||||
| UPC-EAN.UPCE1 | Symbology | PUBLIC | 5.7.1 | SET|GET | state |
[ON|OFF] | enable/disable | UPC/EAN UPCE1 enabled. | ALL |
| UPC-EAN.UPCE1 | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | UPC/EAN UPCE1 Enabled. | ALL |
| UPC-EAN.UPC-E | Symbology | PUBLIC | 5.7.1 | SET|GET | state |
[ON|OFF] | enable/disable | UPC/EAN UPC-E enabled. | ALL |
| UPC-EAN.UPC-A | Symbology | PUBLIC | 5.7.1 | SET|GET | state |
[ON|OFF] | enable/disable | UPC/EAN UPC-A enabled. | ALL |
| UPC-EAN.SUPPLEMENT | Symbology | PUBLIC | 3.0.0 | SET|GET | option |
[0-4] |
0: Ignore 1: Required 2: Required 2 digit 3: Required 5 digit 4: Not required |
UPC/EAN Supplementals. The Manatee Works SDK only supports turning UPC/EAN supplement code support on/off, while the DMCC command allows them to be off, required, require a 2 digit, require a 5 digit, or optionally permit them. The Manatee Works SDK will treat options 1-4 the same; to simply enable them. | ALL |
| UPC-EAN.EXPANDED | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | UPC/EAN Expanded. | ALL |
| UPC-EAN.EAN8SUPL | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | UPC/EAN Allow EAN8 Supplementals. | ALL |
| UPC-EAN.EAN8 | Symbology | PUBLIC | 5.7.1 | SET|GET | state |
[ON|OFF] | enable/disable | UPC/EAN Allow EAN8. | ALL |
| UPC-EAN.EAN13 | Symbology | PUBLIC | 5.7.1 | SET|GET | state |
[ON|OFF] | enable/disable | UPC/EAN Allow EAN13. | ALL |
| UPC-EAN.DELZERO | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | UPC/EAN Delete Leading Zero. | ALL |
| UNTRAIN.MODEL | Action | PUBLIC | 3.2.0 | enum index |
[0-5] 0 |
0: All Symbologies 1: DataMatrix 2: QR Code/MaxiCode/AztecCode 3: Linear/ Postal/ Stacked 4: VeriCode® 5: DotCode |
Deletes the specified model. AztecCode is only supported on the DM503 and DM300 series readers. |
Fixed mount readers. | |
| TUNE.TUNE-LIGHT-COMBINATIONS | Camera | PUBLIC | 5.5.0 | SET|GET | mode |
[ON|OFF] | If it is ON, light combinations will always be tuned. | DM300 series readers, DM474, DM260, DM70 and DM150. | |
| TUNE.TUNE-LIGHT-BANKS | Camera | PUBLIC | 4.3.0 | SET|GET | state |
[ON|OFF] | Enables or disables using light banks while tuning. Only available when internal illumination is used. |
DM300 series readers, DM474, DM260, DM70 and DM150. | |
| TUNE.TRAIN-CODE | Camera | PUBLIC | 4.3.0 | SET|GET | state |
[ON|OFF] | Enables or disables code training while tuning. | DM300 series readers, DM474, DM70, DM260, and DM150. | |
| TUNE.STATUS | Action | PUBLIC | 5.5.0 | GET | Returns ON if tuning is running, OFF otherwise. | Fixed mount devices. | |||
| TUNE.START | Action | PUBLIC | 4.3.0 |
|
0: Tuning started. 104: Tuning is already running or there is an error. 101: Tuning is not available. |
Start tuning. | DM300 series readers, DM474, DM70, DM260, and DM150. | ||
| TUNE.EXCLUDE-AMBIENT-RESULTS | Camera | PUBLIC | 5.7.0 | SET|GET | disable ambient |
[ON|OFF] |
ON: Disables the automatic selection of ambient light results OFF: Allows ambient light results for atomatic seletion |
Control the automatic selection of tuning results where the prevailing illumination type is ambient light. | Fixed mount readers. |
| TUNE.CANCEL | Action | PUBLIC | 4.3.0 |
|
0: Tuning is cancelled. 104: Tuning is not running or there is an error. 101: Tuning is not available. |
Cancel tuning. | DM300 series readers, DM474, DM70, DM260, and DM150. | ||
| TUNE.ADJUST-FOCUS | Camera | PUBLIC | 4.3.0 | SET|GET | state |
[ON|OFF] | Enables or disables using adjusting focus while tuning. | DM70, DM150, DM260, DM474 and DM300 series readers with liquid lens. | |
| TUNE-BUTTON.SAVE-MATCH-STRING | System | PUBLIC | 5.2.0 | SET|GET | state |
[ON|OFF] | enable/disable tune button enabled | Enables the 'save match string' action when the user pushes the tune button for more than 3 seconds. | DM474, DM503, DM8600 and DM300 readers. |
| TUNE-BUTTON.ENABLE | IO | PUBLIC | 5.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enables or disables the tune button. | DM474, DM503, and DM300 series readers. |
| TUNE-BUTTON.3SEC-ACTION | System | PUBLIC | 5.0.0 | SET|GET | action state |
[0-6] [ON|OFF] |
action code (see BUTTON.3SEC-ACTION), enabled enable/disable |
Defines actions when the user pushes the tune button for more than 3 seconds. | DM474, DM503 and DM300 readers. |
| TUNE-BUTTON.3SEC-ACTION | System | PUBLIC | 5.4.0 | SET|GET | action state |
[2,7] [ON|OFF] |
2: Set Match String 7: Extended Read Attempts enable/disable |
Defines actions when the user pushes the tune button for more than 3 seconds. | DM8600 readers. |
| TRUCHECK.UEC-GRADE | Decoder | PUBLIC | 5.7.7 | GET | Returns the UEC (unused error correction) grade from the last verification attempt. | DM8072 Verifier | |||
| TRUCHECK.UEC | Decoder | PUBLIC | 5.7.7 | GET | Returns the UEC (unused error correction) score from the last verification attempt. | DM8072 Verifier | |||
| TRUCHECK.SC-GRADE | Decoder | PUBLIC | 5.7.7 | GET | Returns the SC (symbol contrast) grade from the last verification attempt. | DM8072 Verifier | |||
| TRUCHECK.SC | Decoder | PUBLIC | 5.7.7 | GET | Returns the SC (symbol contrast) score from the last verification attempt. | DM8072 Verifier | |||
| TRUCHECK.RM-GRADE | Decoder | PUBLIC | 5.7.7 | GET | Returns the RM grade from the last verification attempt. | DM8072 Verifier | |||
| TRUCHECK.MOD-GRADE | Decoder | PUBLIC | 5.7.7 | GET | Returns the MOD (modulation) grade from the last verification attempt. | DM8072 Verifier | |||
| TRUCHECK.GNU-GRADE | Decoder | PUBLIC | 5.7.7 | GET | Returns the GNU (grid non-uniformity) grade from the last verification attempt. | DM8072 Verifier | |||
| TRUCHECK.GNU | Decoder | PUBLIC | 5.7.7 | GET | Returns the GNU (grid non-uniformity) score from the last verification attempt. | DM8072 Verifier | |||
| TRUCHECK.FPD-GRADE | Decoder | PUBLIC | 5.7.7 | GET | Returns the FPD (fixed pattern damage) grade from the last verification attempt. | DM8072 Verifier | |||
| TRUCHECK.FPD | Decoder | PUBLIC | 5.7.7 | GET | Returns the FPD (fixed pattern damage) score from the last verification attempt. | DM8072 Verifier | |||
| TRUCHECK.DECODE-GRADE | Decoder | PUBLIC | 5.7.7 | GET | Returns the DECODE grade from the last verification attempt. | DM8072 Verifier | |||
| TRUCHECK.ANU-GRADE | Decoder | PUBLIC | 5.7.7 | GET | Returns the ANU (axial non-uniformity) grade from the last verification attempt. | DM8072 Verifier | |||
| TRUCHECK.ANU | Decoder | PUBLIC | 5.7.7 | GET | Returns the ANU (axial non-uniformity) score from the last verification attempt. | DM8072 Verifier | |||
| TRUCHECK.AG-GRADE | Decoder | PUBLIC | 5.7.7 | GET | Returns the AG (average grade) grade from the last verification attempt. | DM8072 Verifier | |||
| TRUCHECK.AG | Decoder | PUBLIC | 5.7.7 | GET | Returns the AG (average grade) score from the last verification attempt. | DM8072 Verifier | |||
| TRIGGER.TYPE | Camera | PUBLIC | 3.0.0 | SET|GET | type |
[0-5] |
0: Single (external) 1: Presentation (internal) 2: Manual (button) 3: Burst (external) 4: Self (internal) 5: Continuous (external) |
Trigger Type. The camera API should return the current trigger type value. | DM700 and DM8000 series readers support only Presentation and Manual trigger types. MX-1000, MX-1502 and Mobile support only Manual and Continuous trigger types. |
| TRIGGER.POLARITY | IO | PUBLIC | 4.0.0 | SET|GET | line polarity |
[0-3] [ON|OFF] |
Input line ON: Rising edge OFF: Falling edge |
Sets or gets the polarity at which an input will be triggered. | Fixed mount readers. |
| TRIGGER.IGNORE-TYPE | IO | PRIVATE | 5.5.0 | SET|GET | mode |
[0-2] |
0: none 1: time 2: distance |
Sets or gets what type of triggers to ignore. | Fixed-mount readers |
| TRIGGER.IGNORE-TIME | IO | PRIVATE | 5.5.0 | SET|GET | milliseconds |
[0-10000] | Sets or gets the minimum trigger duration for a trigger to be considered good. All trigger durations less than the specified duration will be aborted. | Fixed-mount readers | |
| TRIGGER.IGNORE-DISTANCE | IO | PRIVATE | 5.5.0 | SET|GET | milliseconds |
[0-2147483646] | Sets or gets the minimum trigger distance for a trigger to be considered good. All trigger durations less than the specified duration will be aborted. | Fixed-mount readers | |
| TRIGGER.HOLDOFF-TYPE | IO | PUBLIC | 5.5.0 | SET|GET | type |
[0-2] |
0 = None 1 = Time 2 = Distance |
Which type of trigger hold-off to use, none, time or distance. | Fixed-mount readers |
| TRIGGER.HOLDOFF-TIME | IO | PUBLIC | 5.5.0 | SET|GET | time |
[0-10000 ms] | time for hold-off at trigger start | When greater than 0, the time with which to cancel a pending trigger on and act like there was no trigger at all. | Fixed-mount readers |
| TRIGGER.HOLDOFF-DISTANCE | IO | PUBLIC | 5.5.0 | SET|GET | distance |
[0-10000 mm] | distance for hold-off at trigger start | When greater than 0, the distance with which to cancel a pending trigger on and act like there was no trigger at all. | DM474, DM503 and DM300 series readers. |
| TRIGGER.END-HOLDOFF-TIME | IO | PUBLIC | 5.5.0 | SET|GET | rime |
[0-10000 ms] | time for hold-off at trigger end | When greater than 0, the time with which to cancel a pending trigger off and allow the trigger to continue. | Fixed-mount readers |
| TRIGGER.END-HOLDOFF-DISTANCE | IO | PUBLIC | 5.5.0 | SET|GET | distance |
[0-10000 mm] | distance for hold-off at trigger end | When greater than 0, the distance with which to cancel a pending trigger off and allow the trigger to continue. | DM474, DM503 and DM300 series readers. |
| TRIGGER.END-DELAY-TIME | Camera | PUBLIC | 4.4.0 | SET|GET | milliseconds |
[0-10000] | Sets or gets trigger end delay time. | DM50, DM60, DM70, DM474, DM503, and DM300 series readers. | |
| TRIGGER.END-DELAY-DISTANCE | Camera | PUBLIC | 4.4.0 | SET|GET | millimeters |
[0-2147483646] | Sets or gets trigger end delay distance. | DM474, DM503 and DM300 series readers. | |
| TRIGGER.DELAY-TYPE | Camera | PUBLIC | 4.4.0 | SET|GET | mode |
[0-1] |
0: none 1: time |
Sets or gets whether trigger delay is according to time. | DM50, DM60 and DM70 |
| TRIGGER.DELAY-TYPE | Camera | PUBLIC | 4.4.0 | SET|GET | mode |
[0-2] |
0: none 1: time 2: distance |
Sets or gets whether trigger delay is according to time or distance. | DM503, DM474 and DM300 series readers. |
| TRIGGER.DELAY-TIME | Camera | PUBLIC | 4.4.0 | SET|GET | milliseconds |
[0-10000] | Trigger delay in milliseconds. Delay camera acquisition by specified number of milliseconds. |
DM50, DM60, DM70, DM474, DM503, and DM300 series readers. | |
| TRIGGER.DELAY-DISTANCE | Camera | PUBLIC | 4.4.0 | SET|GET | millimeter |
[0-2147483646] | Delay camera acquisition by distance specified in millimeters. | DM503, DM474 and DM300 series readers. | |
| TRIGGER.DELAY | Camera | PRIVATE | 3.0.0 | SET|GET | milliseconds |
[0-10000] | Trigger Delay. Delay camera acquisition by specified number of milliseconds. |
ALL | |
| TRIGGER.DEBOUNCE-DELAY | IO | PUBLIC | 4.0.0 | SET|GET | delay |
[0-6] |
0: short 1: 2: default 3: 4: 5: 6: long |
Sets or gets how long the trigger signal must be detected in order to be recognized as valid. | Fixed-mount readers. |
| TRIGGER | Action | PUBLIC | 3.0.0 | state |
[ON|OFF] |
enable/disable
ON: Scanning process is initiated, displaying the preview if necessary, decoding frames, etc. OFF: Scanning process is terminated, even if a barcode has not been decoded. |
Software Trigger. | ALL | |
| TRIGGER | Action | PUBLIC | 3.6.0 | GET | state |
[0|1] |
0: Off 1: On |
Get current state of the trigger. | ALL |
| TRAINED-CODE.INFO | Symbology | PUBLIC | 4.4.0 | GET | Gets information about the currently trained code type ('Untrained' if no code is trained). | Fixed mount devices. | |||
| TRAIN.MATCH-STRING | Action | PUBLIC | 3.1.0 | Triggers the reader and sets the match string to the value of the decoded string. Match String validation must be enabled for this command to work. | Fixed mount devices, DM8050 and DM8600. | ||||
| TRAIN.INCREMENTAL | Symbology | PUBLIC | 3.2.0 | SET|GET | state |
[ON|OFF] | enable/disable | Indicates whether incremental training is used during the next attempt to train. | Fixed mount readers. |
| TRAIN.FOCUS | Action | PUBLIC | 3.3.0 | state |
[ON|OFF] | enable/disable | Optimize lens focus. | DM503, DM474 and DM300 series readers. | |
| TRAIN.CODE-FROM-IMAGE | Action | PRIVATE | 4.5.0 | num-bytes |
Code is trained from uploaded image. | Fixed mount devices. | |||
| TRAIN.CODE | Action | PUBLIC | 3.0.0 | state |
[ON|OFF] | enable/disable | Train symbology using next sucessful decode. | Fixed mount devices. | |
| TRAIN.BRIGHT | Action | PUBLIC | 3.0.0 | type |
[ON|OFF] |
ON: Start Train Brightness Algorithm OFF: Abort Train Brightness Algorithm |
Generate a fixed value for the exposure setting based on the particular scene, similar to the Optimize Brightness button in the Setup Tool. | Fixed mount devices. | |
| TRAIN.AVAILABLE | Symbology | PRIVATE | 3.2.0 | GET | symbology |
Indicates whether incremental training is available for the selected symbology group. | Fixed mount readers. | ||
| TRAIN.AUTO-DISABLE | Symbology | PREVIEW | 3.2.0 | SET|GET | state |
[ON|OFF] | enable/disable | Indicates whether untrained symbology groups will be disabled after the next attempt to train. | Fixed mount readers. |
| TRACE.DUMPFILE | System | PRIVATE | 5.4.0 | filename |
Saves a trace log file, which is archived in flash, into a file. | ||||
| TLS.SELFTEST | Action | PRIVATE | 5.7.0 | Starts a benchmark of the SSL/TLS library. This DMCC is password protected. The result can be checked in the HPT log output. | ALL | ||||
| TLS.BENCHMARK | Action | PRIVATE | 5.7.0 | Starts a benchmark of the SSL/TLS library.This DMCC is password protected. The result can be checked in the HPT log output. | ALL | ||||
| TEST-MODE.OUTPUTS-ENABLE | Communication | PUBLIC | 5.2.0 | SET|GET | state |
[ON|OFF] | enable/disable | Disables result reporting to external destinations during test mode. | DM70, DM150, DM260, DM474, DM503 and DM300 series readers. |
| TEST-MODE.INPUTS-ENABLE | Communication | PUBLIC | 5.2.0 | SET|GET | state |
[ON|OFF] | enable/disable | Disables external trigger sources during test mode. | DM70, DM150, DM260, DM474, DM503 and DM300 series readers. |
| TEST-MODE.ENABLE | Communication | PUBLIC | 5.2.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enables test mode. | DM70, DM150, DM260, DM474, DM503 and DM300 series readers. |
| TEST-MODE.AUTOMATIC-ON-US | Communication | PUBLIC | 5.2.0 | SET|GET | microseconds |
[0-2000000000] | Active trigger phase for automatic triggering. | DM70, DM150, DM260, DM474, DM503 and DM300 series readers. | |
| TEST-MODE.AUTOMATIC-OFF-US | Communication | PUBLIC | 5.2.0 | SET|GET | microseconds |
[0-2000000000] | Inactive trigger phase for automatic triggering. | DM70, DM150, DM260, DM474, DM503 and DM300 series readers. | |
| TEST-MODE.AUTOMATIC | Communication | PUBLIC | 5.2.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enables automatic triggering. | DM70, DM150, DM260, DM474, DM503 and DM300 series readers. |
| TEST-MODE.ACCEPT-TRIGGERS | Communication | PUBLIC | 5.2.0 | value |
[0-2000000000] | number of accepted triggers from all inputs | Allows a limited number of triggers from external inputs even if triggering from those should be rejected using TEST-MODE.INPUTS-ENABLE. | DM70, DM150, DM260, DM474, DM503 and DM300 series readers. | |
| TEMPERATURE.SENSOR | System | PRIVATE | 6.1.0 | GET | Get Imager Temperature in °C. Only available if compatible image sensor is present. Readout can interfere with image acquisition. |
DM370 series, DM470 series readers. | |||
| TEMPERATURE.LL | System | PRIVATE | 6.1.0 | GET | Get Liquid lens Temperature in °C. Only available if a Liquid lens is present. |
DM370 series, DM470 series readers. | |||
| TEMPERATURE.CPU | System | PRIVATE | 6.1.0 | GET | CPU Temperature in °C. | DM370 series, DM470 series readers. | |||
| TELNET.PORT | Communication | PUBLIC | 3.3.0 | SET|GET | value |
[0-65535] | Telnet server TCP port on reader. | Ethernet readers. | |
| TELNET.CUSTOM-PORTS | Communication | PUBLIC | 5.5.0 | SET|GET | port |
[0-65535] | Comma separated list of TCP ports | Additional Telnet TCP ports for custom communication. | Ethernet readers |
| SYNC-ACQUISITION.START-DELAY | Communication | PRIVATE | 5.0.0 | SET|GET | us |
[0-25000] | microseconds | This command is to adjust the delay between the master/slave trigger sent via Ethernet and the sync signal sent for RS-845 to compensate for the longer runtime of the message via Ethernet. Developer only command. |
DM503 |
| SYNC-ACQUISITION.MASTER | Communication | PUBLIC | 5.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Sets or gets whether the device is the master among the synchronized readers. | DM503 |
| SYNC-ACQUISITION.ENABLED | Communication | PUBLIC | 5.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enables or disables synchronized triggering. | DM503 |
| SYNC-ACQUISITION.DELAY | Communication | PUBLIC | 5.0.0 | SET|GET | us |
[0-25000] | microseconds | Synchronized acquisition delay: the time the reader waits after sending or receiving the synchronized interface signal before the regular acquisition sequence starts. | DM503 |
| SYNC-ACQUISITION.CABLE-END | Communication | PUBLIC | 5.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Sets or gets whether your device is a bus terminator at the end of the synchronization interface bus. | DM503 |
| SYMBOL.VERICODE | Symbology | PUBLIC | 3.2.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable VeriCode ® symbology. | DM70, DM150 and DM260 readers with VeriCode ® license. |
| SYMBOL.UPC-EAN | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable UPC/EAN Symbology. It will enable UPC-A, UPC-E, EAN-8, and EAN-13 in Manatee Works SDK (just like MX). | ALL |
| SYMBOL.RPC | Symbology | PRIVATE | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Reader Programming Code. | DM70, DM150, DM260 |
| SYMBOL.QR | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable QR-Code Symbology. Enables QR and Micro QR in Manatee Works SDK. | ALL except for DM150QL, DM260QL, DM300L, DM503L and DM503QL. |
| SYMBOL.POSTNET | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable POSTNET Symbology. | ALL except for DM150QL, DM260QL, DM300L, DM503L, and DM503QL. |
| SYMBOL.PLANET | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable PLANET Symbology. | ALL except for DM150QL, DM260QL, DM300L, DM302L, DM503L, and DM503QL. |
| SYMBOL.PHARMACODE | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable Pharmacode symbology. | ALL |
| SYMBOL.PDF417 | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable PDF 417 Symbology. | ALL |
| SYMBOL.MSI | Symbology | PUBLIC | 5.0.0_cr5 | SET|GET | state |
[ON|OFF] | enable/disable | Sets or gets whether MSI Code is enabled or disabled | DM70, DM150, DM260, DM503, DM300 series readers, DM474, MX-1000, MX-1502, Mobile. |
| SYMBOL.MICROPDF417 | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable Micro-PDF 417 Symbology. | ALL |
| SYMBOL.MAXICODE | Symbology | PUBLIC | 4.5.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable MaxiCode symbology. | DM50, DM60, DM70, DM150, DM260, DM300 series readers, DM474, DM503, DM8050, DM8600, MX-1000 and MX-1502, Mobile. |
| SYMBOL.MATRIX | Symbology | PUBLIC | 4.7.1 | SET|GET | state |
[ON|OFF] | enable/disable | Enable Matrix symbology. | All. |
| SYMBOL.ITF14 | Symbology | PUBLIC | 5.7.1 | SET|GET | state |
[ON|OFF] | enable/disable | ALL | |
| SYMBOL.INVERTED | Symbology | PUBLIC | 5.7.1 | SET|GET | state |
[ON|OFF] | enable/disable | ALL | |
| SYMBOL.IATA | Symbology | PUBLIC | 5.7.1 | SET|GET | state |
[ON|OFF] | enable/disable | ALL | |
| SYMBOL.I2O5 | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable Interleaved 2 of 5 Symbology. | ALL |
| SYMBOL.EAN-UCC | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable EAN-UCC Symbology. | ALL |
| SYMBOL.DOTCODE | Symbology | PUBLIC | 5.0.0_cr3 | SET|GET | state |
[ON|OFF] | enable/disable | Enable DotCode symbology. | DM70, DM150, DM260, DM300 series readers, DM474, DM8050X, DM8600, MX-1000, MX-1502, Mobile. |
| SYMBOL.DATAMATRIX | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable DataMatrix Symbology. | ALL except for DM150QL, DM260QL, DM300L, DM503L, and DM503QL. |
| SYMBOL.DATABAR | Symbology | PUBLIC | 3.4.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable Databar. It will enable EXPANDED and LIMITED in Manatee Works SDK (just like MX). | ALL |
| SYMBOL.COOP | Symbology | PUBLIC | 5.7.1 | SET|GET | state |
[ON|OFF] | enable/disable | ALL | |
| SYMBOL.CODABAR | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable Codabar Symbology. | ALL |
| SYMBOL.C93 | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable Code 93 Symbology. | ALL |
| SYMBOL.C39-CONVERT-TO-C32 | Code Quality | PUBLIC | 5.5.0 | SET|GET | state |
[ON|OFF] | enable/disable | Parameter enables or disables Code39 to Code 32 conversion. | DM70, DM150, DM260 |
| SYMBOL.C39-CONVERT-TO-C32 | Symbology | PUBLIC | 5.5.0 | SET | state |
[ON|OFF] | enable/disable | Enables/disables the conversion of Code39 to Code32. | ALL |
| SYMBOL.C39 | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable Code 39 Symbology. | ALL |
| SYMBOL.C25 | Symbology | PUBLIC | 5.5.2 | SET|GET | state |
[ON|OFF] | enable/disable | Enable Code 25 Symbology. Manatee Works supports 7 subcodes: Standard, Interleaved, ITF-14, IATA, Matrix, COOP, and Inverted. | ALL |
| SYMBOL.C128 | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable Code 128 Symbology. | ALL |
| SYMBOL.C11 | Symbology | PUBLIC | 5.7.1 | SET|GET | state |
[ON|OFF] | enable/disable | Enable Code 11 Symbology. | ALL |
| SYMBOL.AZTECCODE | Symbology | PUBLIC | 5.0.0_cr2 | SET|GET | state |
[ON|OFF] | enable/disable | Enable Aztec code symbology. | DM70, DM150, DM260, DM503, DM300 series readers, DM474, DM8050, DM8600, MX-1000, MX-1502, Mobile. |
| SYMBOL.4STATE-UPU | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable 4-State UPU Symbology. | ALL except for DM150QL, DM260QL, DM300L, DM503L, and DM503QL. |
| SYMBOL.4STATE-RMC | Symbology | PRIVATE | 5.6.0 | SET|GET | state |
[ON|OFF] | enable/disable Enable/Disable | Enables or disables Royal Mail Code Symbology. | DM50, DM60, DM70, DM150, DM260, DM30x, DM474, DM503, MX-1000, MX-1502. Mobile. |
| SYMBOL.4STATE-JAP | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable 4-State Japan Post Symbology. | ALL except for DM150QL, DM260QL, DM300L, DM503L, and DM503QL. |
| SYMBOL.4STATE-IMB | Symbology | PUBLIC | 3.4.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable 4-State Intelligent Mail Barcode. | ALL except for DM150QL, DM260QL, DM300L, DM503L, and DM503QL. |
| SYMBOL.4STATE-AUS | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable 4-State Australia Post Symbology. | ALL except for DM150QL, DM260QL, DM300L, DM503L, and DM503QL. |
| STATISTICS.RESET | Action | PUBLIC | 3.3.1 | Reset all statistics. | ALL | ||||
| SSH.UNLOCK | Action | PRIVATE | 6.0.1 | GET | The PC (host) sends this command to the reader to initiate the unlocking mechanism. As a response, the reader sends back a 32 byte random challenge to the PC. | DM474 | |||
| SSH.UNLOCK | Action | PRIVATE | 6.0.1 | SET | signature of the challenge |
The argument is the signature of the random challenge generated by the reader and signed with a public key on the PC side. The reader then verifies that the challenge was signed with the proper key and sent back in one minute. In this case, the SSH service is started on the reader, otherwise, an invalid parameter error is returned. | DM474 | ||
| SLMP-PROTOCOL.ENABLED | Communication | PUBLIC | SET|GET | state |
[ON|OFF] | enable/disable | Enables or disables SLMP-Protocol communication. | Ethernet readers. DM8000 series wireless readers also support this protocol if the base station is connected through Ethernet. In the case of a Bluetooth connection, the command has to be sent to the base station, not to the reader. | |
| SETUP.USE | Camera | PUBLIC | 5.2.0 | int state |
[1-15] [ON|OFF] |
Setup to change enable/disable Disables/Enables setup to be used. |
Adds or removes a setup from the list of usable Read Setups. | DM8600, DM70, DM150, DM260, DM474, DM503 and DM300 series readers. | |
| SETUP.START-WITH-SETUP | Camera | PUBLIC | 5.2.0 | SET|GET | setup |
[0-15] | setup number to start with | Starts read setup. | DM8600, DM70, DM150, DM260, DM474, DM503, MX-1000, MX-1502 and DM300 series readers. |
| SETUP.START-WITH-LAST-READ | Camera | PUBLIC | 5.2.0 | SET|GET | mode |
[ON|OFF] |
enable/disable
OFF: Start with fixed setup ON: Start with setup of last good read |
Sets read setup. | DM8600, DM70, DM150, DM260, DM474, DM503, MX-1000, MX-1502 and DM300 series readers. |
| SETUP.PROG-TARGET | Camera | PUBLIC | 3.0.0 | SET|GET | category |
[0-3] |
0: General Purpose 1: Curved Surface 2: Under Marked 3: Mirrored Surface |
Setup Programming Target. Setup to be modified by subsequent commands. |
DM70, DM150, DM260, DM8600 and MX-1000 |
| SETUP.PROG-TARGET | Camera | PUBLIC | 5.0.0 | SET|GET | category |
[0-15] | A number signifying an already existing setup. | Setup Programming Target. Setup to be modified by subsequent commands. |
DM50, DM60, DM70, DM150, DM260, DM474, DM503 and DM300 series readers. |
| SETUP.NAME | Camera | PUBLIC | 3.0.0 | SET|GET | name |
Setup Name. User defined name. |
DM50, DM60, DM70, DM150, DM260, DM474, DM503, DM8600, MX-1000, and DM300 series readers. | ||
| SETUP.ENABLE | Camera | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Setup Enable. One Setup must always be enabled. Enable the desired Setup, before disabiling another Setup. For DM300 series readers, this command works for the active setup. |
DM50, DM60, DM70, DM150, DM260, DM474, DM503, DM8600, MX-1000 and DM300 series readers. |
| SDK.VERSION | System | PRIVATE | 3.0.0 | SET|GET | Gets or sets the SDK version. Used by early versions of the DataMan SDK. | ||||
| SDCARD.TESTFILE | Communication | PRIVATE | 5.5.0 | SET|GET | string |
SET: writes argument to a predefined file on the card. GET: reads back the same file and returns its content. | DM360 series readers, DM474 | ||
| SDCARD.PRESENT | Communication | PUBLIC | 5.5.0 | GET | Returns True if the SD card was detected, False otherwise. | DM360 series readers, DM474 | |||
| SDCARD.BACKUP-FILE | Communication | PUBLIC | 5.5.0 | SET|GET | state |
[ON|OFF] | enable/disable | SD card is used for creating and restoring a configuration file backup. | DM360 series readers, DM474 |
| SCRIPT.SEND | Data Formatting | PUBLIC | 4.5.0 | Sends the formatting script from the reader to the host. | DM50, DM60, DM70, DM474, DM503, MX-1000, MX-1502 and DM300 series readers. | ||||
| SCRIPT.LOAD | Data Formatting | PUBLIC | 4.5.0 | num-bytes |
Loads the formatting script from the host to the reader. | DM50, DM60, DM70, DM474, DM503, MX-1000, MX-1502 and DM300 series readers. | |||
| SCRIPT.GARBAGE-COLLECT | Communication | PRIVATE | 5.5.0 | force |
[ON|OFF] | enable/disable Enforce the garbage collection | Check or enforce the Garbage Collection process. | Fixed mount readers | |
| RSS.EXPANDED | Symbology | PUBLIC | 4.4.0 | SET|GET | state |
[ON|OFF] | enable/disable | RSS Expanded. | ALL |
| RESULT.NO-READ-STRING | IO | PUBLIC | 3.0.0 | SET|GET | string |
no-read-string | No-Read Output String. | ALL | |
| RESULT | Action | PUBLIC | 3.0.0 | GET | target |
[0-1] |
0: Result string 1: XML formatted |
Optional Send Last Result. By default the result string is in ASCII format, but this can be changed to Base64 with the DATA.RESULT-ENCODING command. | ALL |
| REBOOT.DELAYED | Action | PUBLIC | 5.6.0 | Reboot the Device after delay in seconds. Rebooting the Device restores the Configuration stored in Non-Volatile Memory. Commands will not be processed for several seconds while the device reboots.If communication settings are changed, connection with device may be lost. Note that when connected via USB-COM, the application must release the COM port. | All | ||||
| REBOOT | Action | PUBLIC | 3.0.0 | Reboot the Device. Rebooting the Device restores the Configuration stored in Non-Volatile Memory. Commands will not be processed for several seconds while the device reboots. If communication settings are changed, connection with device may be lost. Note that when connected via USB-COM, the application must release the COM port. |
ALL | ||||
| READER.ASSIGNED | Communication | PUBLIC | 5.2.0 | SET|GET | state |
[ON|OFF] | enable/disable | Unassignins the reader and the base station that is associated with it. | Base |
| QR.TRAINED-MODEL | Decoder | PUBLIC | 5.7.0 | SET|GET | grid size module size model polarity mirrored |
[11-177] [1-1000] [0-3] [0-2] [ON|OFF] [ON|OFF] |
Grid size Module size * 10 0: Unknown model 1: Model-1 2: Model-2 3: Micro-QR 0: dark-on-light 1: light-on-dark 2: either enable/disable ON: mirrored OFF: not mirrored |
Set training parameters for QR-Code symbology. Option 3 for argument "model": Micro-QR is not applicable for 6.0.1. |
Fixed-mount readers |
| QR.SYMBOL-DIFFICULTY | Symbology | PUBLIC | 5.1.0 | SET|GET | int |
[0-2] |
0: Easy 1: Medium 2: Hard |
Level of QR code symbol difficulty. | DM8600. |
| QR.QUALITY-METRICS | Decoder | PUBLIC | 4.5.0 | SET|GET | type |
[0-2] |
0: none 1: ISO/IEC 15415 2: AIM-DPM / ISO/IEC TR 29158 |
Code quality metrics for QR codes. | ALL |
| QR.MODEL2 | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | QR model-2. | ALL except for DM300L, DM503L, and DM503QL. |
| QR.MODEL1 | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | QR model-1. | ALL except for DM300L, DM503L, and DM503QL. |
| QR.MICRO | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Micro QR Code. | ALL except for DM300L, DM503L, and DM503QL. |
| QR.MAXIMUM-GRID-SIZE | Symbology | PUBLIC | 5.2.0 | SET|GET | size |
[49-177] | Step size: 4. | Maximum grid size which can be read by the QR decoder. | ALL |
| PTP.SLAVE-ONLY | Communication | PUBLIC | 5.5.0 | SET|GET | mode |
[ON|OFF] |
enable/disable
OFF: Disables PTP slave only configuration of the reader ON: Configures the reader as PTP slave only |
This parameter configures the reader as PTP slave only, even if no other master is active. | DM360 series readers, DM474 |
| PTP.PRIORITY2 | Communication | PUBLIC | 5.5.0 | SET|GET | level |
[0-255] | This is the second 8-bit priority value (lower number denotes a higher priority). This parameter allows to configure backup clocks. | DM360 series readers, DM474 | |
| PTP.PRIORITY1 | Communication | PUBLIC | 5.5.0 | SET|GET | level |
[0-255] | This is the first 8-bit priority value (lower number denotes a higher priority). Normally, this is set at 128 for master capable devices. | DM360 series readers, DM474 | |
| PTP.ENABLE | Communication | PUBLIC | 5.5.0 | SET|GET | mode |
[ON|OFF] |
enable/disable
OFF: Disable the PTP timestamp synchronization ON: Enable the PTP timestamp synchronization |
Enable the PTP timestamp synchronization. | DM360 series readers, DM474 |
| PTP-SYNC.LOCAL-OFFSET | Communication | PUBLIC | 5.5.0 | SET|GET | time |
[0-1000000] | Local offset added to the synchronized acquisition timestamp. | DM360 series readers, DM474 | |
| PTP-SYNC.ENABLE | Communication | PUBLIC | 5.5.0 | SET|GET | mode |
[ON|OFF] | Enables MST synchronized by PTP. | DM360 series readers, DM474 | |
| PTP-SYNC.DELAY | Communication | PUBLIC | 5.5.0 | SET|GET | time |
[0-1000000] | Time between trigger start and the synchronized acquisition timestamp. | DM360 series readers, DM474 | |
| PROXIMITY.THRESHOLD | Communication | PRIVATE | 5.4.0 | SET|GET | int |
[0-100] | Threshold value which defines if the optical button has been pressed or released. A lower value will increase the sensitivity of the sensor. | DM8600 | |
| PROXIMITY.CURRENT | Communication | PRIVATE | 5.4.0 | SET|GET | int |
[10-200] step 10 | IR LED current of the proximity sensor in mA | A higher value will increase the sensitivity of the sensor. | DM8600 |
| PROFINET.ENABLED | Communication | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enabled or disabled PROFINET communications. | Ethernet readers. The DM8000 series wireless readers also support this protocol if the base station is connected through Ethernet. In the case of a Bluetooth connection, the command has to be sent to the base station, not to the reader. |
| PROFIBUS.GATEWAY-VERSION | Communication | PRIVATE | 5.5.0 | SET|GET | mode |
Set the GW firmware version, used for baud rate detection. | Fixed-mount readers | ||
| PROFIBUS.GATEWAY-STATUS | Communication | PRIVATE | 5.5.0 | SET|GET | status |
[0-4] |
0: ok, no error 1: Invalid op mode 2: Invalid node number 3: Invalid flow control 4: Invalid host interference |
Set Gateway error message. | Fixed-mount readers |
| PROFIBUS.GATEWAY-RUN | Communication | PRIVATE | 5.5.0 | SET|GET | state |
[ON|OFF] | Runtime start message or heartbeat. | Fixed-mount readers | |
| PROFIBUS.GATEWAY-NODE | Communication | PRIVATE | 5.5.0 | SET|GET | node number |
[1-99] | The reader will return the Profinet node number for the gateway. | Fixed-mount readers | |
| PROFIBUS.GATEWAY-MODE | Communication | PRIVATE | 5.5.0 | GET | mode |
[1] | Get the profibus mode configuration. | Fixed-mount readers | |
| PROFIBUS.GATEWAY-HOST | Communication | PRIVATE | 5.5.0 | GET | type |
[0] | The reader will return a value indicating the host interface protocol. | Fixed-mount readers | |
| PROFIBUS.GATEWAY-FLOW | Communication | PRIVATE | 5.5.0 | SET|GET | mode |
[0-2] |
0: None 1: RTS/CTS 2: XON/XOFF |
The reader will return a value indicating the type of serial flow control to be used. | Fixed-mount readers |
| PROFIBUS.GATEWAY-COM | Communication | PRIVATE | 5.5.0 | SET|GET | mode |
[0-2] |
0: Profibus 1: RS485 2: RS422 |
Get the COM configuration (Profibus / RS422 / RS485). | Fixed-mount readers |
| PRESENT.RESCAN | System | PRIVATE | 3.0.0 | SET|GET | ms |
[0-10000] | milliseconds | OBSOLETED in 4.5. Presentation Mode Rescan Delay. | ALL |
| PRESENT.REREAD | System | PRIVATE | 3.0.0 | SET|GET | ms |
[0-10000] | milliseconds | OBSOLETED in 4.5. Presentation Mode Re-read Delay. | ALL |
| PRESENT.NEVER2X | System | PRIVATE | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Never Read the Same Code Twice. OBSOLETED in 4.5. Presentation mode only. |
ALL |
| PPP.NETMASK | System | PRIVATE | 5.4.0 | SET|GET | int |
Netmask for internal communication between reader and base. | Wireless readers. | ||
| PPP.IP-SERVER | System | PRIVATE | 5.4.0 | SET|GET | Base/server device IP address for internal communication between client and base station. | Wireless readers. | |||
| PPP.IP-CLIENT | System | PRIVATE | 5.4.0 | SET|GET | Reader/client device IP address for internal communication between client and base station. | Wireless readers. | |||
| POWER.SLEEPTIME | System | PRIVATE | 3.0.0 | SET|GET | secs |
[0, 60, 120... 600] | seconds | Time before entering power-save mode. | DM7500 |
| POWER.SLEEP | System | PRIVATE | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Power Save Mode Enable. | DM7500 |
| POWER.POWEROFF-TIMEOUT | System | PUBLIC | 4.2.1 | SET|GET | int |
[1-600] | seconds | Power Off timeout. | DM8050, DM8600, MX-1000 and MX-1502. |
| POWER.POWEROFF-DISABLE | System | PUBLIC | 4.2.1 | SET|GET | state |
[ON|OFF] | enable/disable | Turning the Power Off feature on or off. ON means that the device never turns off. OFF means that Power Off is not disabled (it is enabled), thus the device will turn off. | DM8050, DM8600, MX-1000 and MX-1502. |
| POWER.HIBERNATE-TIMEOUT | System | PUBLIC | 4.2.1 | SET|GET | int |
[1-600] | seconds | Hibernation timeout. | DM8000 wireless readers. |
| POWER.HIBERNATE-DISABLE | System | PUBLIC | 4.2.1 | SET|GET | state |
[ON|OFF] | enable/disable | Turning the Hibernation feature on or off. ON means that the device never hibernates. OFF means that Hibernation is not disabled (it is enabled), thus the device will go into hibernation mode. | DM8000 wireless readers. |
| POSTNET.XMTCHK | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | POSTNET Transmit Check Character. | ALL |
| PLANET.XMTCHK | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | PLANET Transmit Check Character. | ALL |
| PHS.ADD-PACKAGE | System | PRIVATE | 5.4.0 | ||||||
| PHARMA.VERTICAL-DIRECTION | Symbology | PUBLIC | 3.4.0 | SET|GET | direction |
[0-1] |
0: top-to-bottom (default) 1: bottom-to-top |
Vertical direction preference for decoding Pharmacode symbols. | ALL |
| PHARMA.SUPPLEMENTARY-GAP-THRESH | Symbology | PRIVATE | 3.4.0 | SET|GET | gap |
[100-300] | Get or set the Pharmacode supplementary gap threshold in pixels. | ALL | |
| PHARMA.SUPPLEMENTARY | Symbology | PRIVATE | 3.4.0 | SET|GET | state |
[ON|OFF] | enable/disable | Get or set whether supplementary component is expected. | ALL |
| PHARMA.MIN-LENGTH | Symbology | PRIVATE | 4.4.0 | SET|GET | length |
[1-6] | Gets or sets the minimum length for a Pharmacode. Obsoleted in 5.1. |
ALL | |
| PHARMA.MAX-LENGTH | Symbology | PRIVATE | 4.4.0 | SET|GET | length |
[1-6] | Gets or sets the maximum length for a Pharmacode. Obsoleted in 5.1. |
ALL | |
| PHARMA.HORIZONTAL-DIRECTION | Symbology | PUBLIC | 3.4.0 | SET|GET | direction |
[0-1] |
0: left-to-right (default) 1: right-to-left |
Horizontal direction preference for decoding Pharmacode symbols. | ALL |
| PHARMA.CODESIZE | Symbology | PUBLIC | 3.4.0 | SET|GET | any min max |
[ON|OFF] [1-6] [1-6] |
any length code minimum code length maximum code length |
Expected Pharmacode size. | ALL |
| PHARMA.CODE-ORIENTATION | Symbology | PUBLIC | 3.4.0 | SET|GET | direction |
[0-2] |
0: Any (default) 1: Horizontal 2: Vertical |
Preferred orientation for decoding Pharmacode symbols. | ALL |
| PCM.USE-CUSTOM-THRESHOLDS | Decoder | PUBLIC | 5.7.0 | SET|GET | type state |
[0-5] [ON|OFF] |
0: AIM-DPM 1: ISO-IEC 15415 2: ANSI-ISO-IEC 15416 3: SemiT10 4: 1D readability 5: DotCode Readybility ON: do regrading OFF: keep current result |
Enable or disable regrading of metric results by using the custom thresholds. | Ethernet readers. |
| PCM.MIN-PASS | Decoder | PUBLIC | 5.7.0 | SET|GET | type grade |
[0-5] [0-4] |
0: AIM-DPM 1: ISO-IEC 15415 2: ANSI-ISO-IEC 15416 3: SemiT10 4: 1D readability 5: DotCode Readybility 0: F 1: D 2: C 3: B 4: A |
Set the overall minimum passing grade. Results under this grade will mean the reading failed. | Ethernet readers. |
| PCM.METRIC-PARM-THRESHOLD | Decoder | PUBLIC | 5.7.0 | SET|GET | type type grade value |
[0-5] [0-25] [1-4] [0-1000] |
0: AIM-DPM 1: ISO-IEC 15415 2: ANSI-ISO-IEC 15416 3: SemiT10 4: 1D readability 5: DotCode Readybility 0: Symbol Contrast 1: Axial Non Uniformity 2: Print Growth 3: UEC 4: Modulation 5: Fixed Pattern Damage 6: Grid Non Uniformity 7: Extreme Reflectance 8: Reflect Min 9: Edge Contrast Min 10: Single Scan Int 11: Multi Scan Int 12: Signal To Noise Ratio 13: Horizontal Mark Growth 14: Vertical Mark Growth 15: Data Matrix Cell Width 16: Data Matrix Cell Height 17: Horizontal Mark Misplacement 18: Vertical Mark Misplacement 19: Cell Defects 20: Finder Pattern Defects 21: Overall Grade 22: Edge Determination 23: Defects 24: Reference Decode 25: Decodability 1: D 2: C 3: B 4: A Threshold raw value |
Set the raw value threshold for the selected quality standard, metric and grade (e.g. AIM-DPM → UEC → Threshold B = 50). Not all metrics are available for each standard: AIM-DPM (0, 1, 3, 4, 6, 8), ISO-IEC 15415 (0, 1, 3, 4, 6), ANSI-ISO-IEC 15416 (1, 4, 8, 9, 23, 25), 1D readability (0, 2, 8, 9, 11), DotCode (0, 1, 2, 3, 6, 8) | Ethernet readers. |
| PCM.METRIC-PARM-REPORT | Decoder | PUBLIC | 5.7.0 | SET|GET | type type state |
[0-5] [0-27] [ON|OFF] |
0: AIM-DPM 1: ISO-IEC 15415 2: ANSI-ISO-IEC 15416 3: SemiT10 4: 1D readability 5: DotCode Readybility 0: Symbol Contrast 1: Axial Non Uniformity 2: Print Growth 3: UEC 4: Modulation 5: Fixed Pattern Damage 6: Grid Non Uniformity 7: Extreme Reflectance 8: Reflect Min 9: Edge Contrast Min 10: Single Scan Int 11: Multi Scan Int 12: Signal To Noise Ratio 13: Horizontal Mark Growth 14: Vertical Mark Growth 15: Data Matrix Cell Width 16: Data Matrix Cell Height 17: Horizontal Mark Misplacement 18: Vertical Mark Misplacement 19: Cell Defects 20: Finder Pattern Defects 21: Overall Grade 22: Edge Determination 23: Defects 24: Reference Decode 25: Decodability 26: Contrast Uniformity 27: Reflectance Margin ON: include in report OFF: do not include in report |
Include the metric grading result for selected quality standard and metric in the report if enabled. Only available if not use for overall calculation (e.g. ISO-IEC 15415 → Modulation → Show in Report = ON) Not all metrics are available for each standard: AIM-DPM (0, 1, 2, 3, 4, 5, 6, 8), ISO-IEC 15415 (0, 1, 2, 3, 4, 5, 6, 7), ANSI-ISO-IEC 15416 (0, 4, 8, 9, 22, 23, 24, 25), SemiT10 (1, 4, 12, 13, 14, 15, 16, 17, 18, 19, 20), 1D readability (0, 2, 8, 9, 10, 11), DotCode (0, 1, 2, 3, 6, 8). | Ethernet readers. |
| PCM.METRIC-PARM-OVERALL | Decoder | PUBLIC | 5.7.0 | SET|GET | type type state |
[0-5] [0-27] [ON|OFF] |
0: AIM-DPM 1: ISO-IEC 15415 2: ANSI-ISO-IEC 15416 3: SemiT10 4: 1D readability 5: DotCode Readybility 0: Symbol Contrast 1: Axial Non Uniformity 2: Print Growth 3: UEC 4: Modulation 5: Fixed Pattern Damage 6: Grid Non Uniformity 7: Extreme Reflectance 8: Reflect Min 9: Edge Contrast Min 10: Single Scan Int 11: Multi Scan Int 12: Signal To Noise Ratio 13: Horizontal Mark Growth 14: Vertical Mark Growth 15: Data Matrix Cell Width 16: Data Matrix Cell Height 17: Horizontal Mark Misplacement 18: Vertical Mark Misplacement 19: Cell Defects 20: Finder Pattern Defects 21: Overall Grade 22: Edge Determination 23: Defects 24: Reference Decode 25: Decodability 26: Contrast Uniformity 27: Reflectance Margin ON: use for overall calculation OFF: do not use for overall calculation |
Use the the metric grading result for calculating the overall result if enabled (e.g. AIM-DPM → Symbol Contrast → Use for Overall Calculation = ON) Not all metrics are available for each standard: AIM-DPM (0, 1, 2, 3, 4, 5, 6, 8), ISO-IEC 15415 (0, 1, 3, 4, 5, 6, 7), ANSI-ISO-IEC 15416 (1, 4, 8, 9, 22, 23, 24, 25), 1D readability (0, 2, 8, 9, 10, 11), DotCode (0, 1, 2, 3, 6, 8) | Ethernet readers. |
| PCM.CUSTOM-DESCRIPTION | Decoder | PUBLIC | 5.7.0 | SET|GET | string |
Ethernet readers. | |||
| PCM-RESULT-STRING.SEPARATOR | Decoder | PUBLIC | 5.7.0 | SET|GET | string |
Defines the main separator between result data and metric section. | Ethernet readers. | ||
| PCM-RESULT-STRING.OVERALL-GRADE | Decoder | PUBLIC | 5.7.0 | SET|GET | type |
[ON|OFF] | enable | Enables or disables showing the overall grade in at the beginning of the result string. | Ethernet readers. |
| PCM-RESULT-STRING.METRIC-SEPARATOR | Decoder | PUBLIC | 5.7.0 | SET|GET | string |
Defines the metric separator. | Ethernet readers. | ||
| PCM-RESULT-STRING.METRIC-PREFIX | Decoder | PUBLIC | 5.7.0 | SET|GET | type |
[0-2] |
0: None 1: Acronym 2: Name |
Defines the prefix for a single metric entry. | Ethernet readers. |
| PCM-RESULT-STRING.METRIC-FORMAT | Decoder | PUBLIC | 5.7.0 | SET|GET | type |
[0-2] |
0: Grade 1: Value 2: Grade + Value |
Set the format of a single metric entry. | Ethernet readers. |
| PCM-RESULT-STRING.EXTEND | Decoder | PUBLIC | 5.7.0 | SET|GET | enable |
[ON|OFF] | Enable or disable extending the result string with metric information. | Ethernet readers. | |
| OUTPUT.USER2 | Action | PUBLIC | 5.3.0 | Device emits USER_EVENT_2 event. | DM8050, MX-1000, MX-1502, DM474, DM503 and DM300 series readers. | ||||
| OUTPUT.USER1 | Action | PUBLIC | 5.3.0 | Device emits USER_EVENT_1 event. | DM8050, MX-1000, MX-1502, DM474, DM503 and DM300 series readers. | ||||
| OUTPUT.USER-CONFIGURE | Communication | PUBLIC | 5.3.0 | SET|GET | event number beep tone beep number LED color vibration |
[1,2] [0-2] [0-3] [0-7] [ON|OFF] |
1: USER_EVENT_1 2: USER_EVENT_2 [0]: Low [1]: Medium [2]: High Number of beeps [0]: Off [1]: Blue [2]: Green [3]: Cyan [4]: Red [5]: Magenta [6]: Yellow [7]: White enable/disable ON: The reader vibrates on the given user event. OFF: The reader does not vibrate on the given user event. |
Sets the beeper tone and the number of beeps for USER_EVENT_1 or USER_EVENT_2. | DM8050 (except for the vibration parameter), ON|OFF is supported on DM8600 and MX-1000. |
| OUTPUT.TRIG-OVERRUN | IO | PRIVATE | 3.0.0 | Output trigger overrun actions. | |||||
| OUTPUT.RESERVED | IO | PUBLIC | 3.0.0 | SET|GET | line reserved |
[0-7] [ON|OFF] |
i/o line number enable/disable |
Output Reserved for External Illumination. Line will be controlled by acquisition system when enabled. | Fixed mount readers, except DM50, DM60 and DM70. |
| OUTPUT.PULSE-WIDTH | IO | PUBLIC | 3.0.0 | SET|GET | line ms |
[0-7] [0-30000] |
i/o line number milliseconds |
Output Pulse-width. | Fixed mount readers. |
| OUTPUT.NOREAD | Action | PREVIEW | 3.0.0 | Virtual No-Read. Device beeps, flashes indicator lights, and sets output lines as if the specified no-read event occurred. |
ALL | ||||
| OUTPUT.NOREAD | IO | PRIVATE | 3.0.0 | Output no read actions. | |||||
| OUTPUT.GOOD | Action | PREVIEW | 3.0.0 | Virtual Good-Read. Device beeps, flashes indicator lights, and sets output lines as if the specified read event occurred. |
ALL | ||||
| OUTPUT.GOOD | IO | PRIVATE | 3.0.0 | Output good read actions. | |||||
| OUTPUT.EVENTS | IO | PREVIEW | 3.0.0 | SET|GET | line read no-read validation-failure trigger-overrun buffer-overflow user event 1 user event 2 |
[0-7] [0-1] [0-1] [0-1] [0-1] [0-1] [0-1] [0-1] |
i/o line number 0: Off 1: On 0: Off 1: On 0: Off 1: On 0: Off 1: On 0: Off 1: On 0: Off 1: On 0: Off 1: On |
Output Events. Configure output line to signal based on event. |
Fixed mount readers. |
| OUTPUT.DELAY-TYPE | Decoder | PUBLIC | 4.4.0 | SET|GET | mode |
[0-1] |
0: None 1: Time |
Sets or gets whether output is delayed, and if so, whether according to time. | DM50, DM60, DM70, DM300 series readers, DM474. |
| OUTPUT.DELAY-TYPE | Decoder | PUBLIC | 4.4.0 | SET|GET | mode |
[0-2] |
0: None 1: Time 2: Distance |
Sets or gets whether output is delayed, and if so, whether according to time or distance. | DM503 |
| OUTPUT.DELAY-TIME | Decoder | PUBLIC | 4.4.0 | SET|GET | milliseconds |
[0-10000] | Output delay in milliseconds. | DM50, DM60, DM70, DM503, DM300 series readers, DM474. | |
| OUTPUT.DELAY-REFERENCE | Decoder | PUBLIC | 4.4.0 | SET|GET | mode |
[0-1] |
0: Trigger Start 1: Trigger End |
Sets or gets whether output is delayed relative to trigger start or trigger end. | DM50, DM60, DM70, DM474, DM503, and DM300 series readers. |
| OUTPUT.DELAY-DISTANCE | Decoder | PUBLIC | 4.4.0 | SET|GET | millimeters |
[0-100000] | Distance to output when using the Encoder. | DM474, DM503, and DM300 series readers. | |
| OUTPUT.DATAVALID-FAIL | Action | PREVIEW | 3.0.0 | Virtual Data Validation Failure. Device beeps, flashes indicator lights, and sets output lines as if the specified Data Validation failure event occurred. |
ALL | ||||
| OUTPUT.DATAVALID-FAIL | IO | PRIVATE | 3.0.0 | Output Data Validation failed actions. | |||||
| OUTPUT.CQ-FAIL | IO | PRIVATE | 3.0.0 | Output Code Quality failed actions. Verifiers only. |
|||||
| OUTPUT.ACTION | IO | PREVIEW | 3.0.0 | SET|GET | line action |
[0-7] [0-1] |
line number 0: Open 1: Close |
Output Action. Open or Close output line on event. Only supported on line 1. |
Fixed mount readers. |
| OUTPUT-QUEUE.FLUSH | IO | PUBLIC | 4.1.0 | int |
[0-1] |
0: throw output away 1: send all output now |
To flush or send all output. | DM474, DM503, and DM300 series readers. | |
| NTP.SERVER2 | Communication | PUBLIC | 5.7.0 | SET|GET | server |
IP address or DNS name | Set the NTP server 2. | All | |
| NTP.SERVER1 | Communication | PUBLIC | 5.7.0 | SET|GET | server |
IP address or DNS name | Set the NTP server 1. | All | |
| NTP.ENABLE | Communication | PUBLIC | 5.7.0 | SET|GET | state |
[ON|OFF] | enable/disable Enable/Disable | Enables or disables NTP. | All |
| NETWORK-CLIENT.RECONNECT-DELAY | Communication | PUBLIC | 5.2.0 | SET|GET | int |
[100-60000] | How long to wait before reconnecting if the connection is lost (default is 1000). | Ethernet readers except for the DM8000 wireless. | |
| NETWORK-CLIENT.PROTOCOL | Communication | PUBLIC | 5.2.0 | SET|GET | int |
[0-1] |
0: TCP 1: UDP |
Which protocol to use for the connection (default is 0). | Ethernet readers except for the DM8000 wireless. |
| NETWORK-CLIENT.OPEN-CONNECTION | Communication | PUBLIC | 5.2.0 | SET|GET | us |
[0-1] |
0: on Power-up 1: on Data Activity |
When to open the connection to the remote host (default is 0). | Ethernet readers except for the DM8000 wireless. |
| NETWORK-CLIENT.IDLE-TIMEOUT | Communication | PUBLIC | 5.2.0 | SET|GET | int |
[1–3600] | How long to keep the connection open after transfer (default is 1). | Ethernet readers except for the DM8000 wireless. | |
| NETWORK-CLIENT.HOST-PORT | Communication | PUBLIC | 5.2.0 | SET|GET | int |
[0–65535] | The remote port on the server to connect to (default is 1000). | Ethernet readers except for the DM8000 wireless. | |
| NETWORK-CLIENT.HOST-ADDRESS | Communication | PUBLIC | 5.2.0 | SET|GET | string |
Max length = 255 | The address of the server to connect to. | Ethernet readers except for the DM8000 wireless. | |
| NETWORK-CLIENT.ENABLED | Communication | PUBLIC | 5.1.0 | SET|GET | state |
[ON|OFF] | enable/disable | Switch the Network Client feature on or off. | Ethernet readers except for the DM8000 wireless. |
| NETWORK-CLIENT.CONNECTION-TIMEOUT | Communication | PUBLIC | 5.2.0 | SET|GET | int |
[1000-60000] | How long to wait before considering the connection dead (default is 3000). | Ethernet readers except for the DM8000 wireless. | |
| NETWORK-CLIENT.CLOSE-CONNECTION | Communication | PUBLIC | 5.2.0 | SET|GET | int |
[0-1] |
0: Never 1: After reader data transfer |
Whether or not to keep the connection open after data transfer (default is 0). | Ethernet readers except for the DM8000 wireless. |
| NETWORK-CLIENT.CLIENT-PORT | Communication | PUBLIC | 5.2.0 | SET|GET | int |
[0-65535] | The port on the reader to use as the outbound port (default is 0). | Ethernet readers except for the DM8000 wireless. | |
| NET-LOCAL.TCP-KEEPALIVE-INTERVAL | Communication | PRIVATE | 3.3.1 | SET|GET | value |
[0-32565] | TCP keep alive interval. Ethernet readers. |
||
| NET-LOCAL.TCP-KEEPALIVE-IDLE | Communication | PRIVATE | 3.3.1 | SET|GET | value |
[0-32565] | TCP keep alive time. Ethernet readers. |
||
| NET-LOCAL.TCP-KEEPALIVE-COUNT | Communication | PRIVATE | 3.3.1 | SET|GET | value |
[0-32565] | TCP keep alive retry count. | Ethernet readers. | |
| NET-LOCAL.TCP-KEEPALIVE | Communication | PRIVATE | 3.3.1 | SET|GET | state |
[ON|OFF] | enable/disable | Enable/Disable TCP keepalive message. | Ethernet readers. |
| NET-LOCAL.SUBNET-MASK | Communication | PUBLIC | 3.3.0 | SET|GET | string |
Reader's subnet mask. Uses dotted decimal form, such as "192.168.23.255". |
Ethernet readers. | ||
| NET-LOCAL.SEC-USERNAME | Communication | PRIVATE | 5.2.0 | SET|GET | string |
username for authentication | Use authentication over telnet for communciation between reader and base. | Ethernet readers. | |
| NET-LOCAL.SEC-PASSWORD | Communication | PRIVATE | 5.2.0 | SET|GET | string |
password for authentication | Use authentication over telnet for communciation between reader and base. | Ethernet readers. | |
| NET-LOCAL.SEC-ENABLE | Communication | PRIVATE | 5.2.0 | SET|GET | state |
[ON|OFF] |
enable/disable
ON: use authentication OFF: no authentication |
Use authentication over telnet for communciation between reader and base. | Ethernet readers. |
| NET-LOCAL.READER-SUBNET-MASK | Communication | PUBLIC | 5.2.0 | SET|GET | string |
dotted decimal form IPv4 address | Base station's subnet mask. Uses dotted decimal form, such as "192.168.23.255". |
Base stationss. | |
| NET-LOCAL.READER-IP-ADDRESS | Communication | PUBLIC | 4.2.0 | SET|GET | string |
dotted decimal form IPv4 address | Base station's IP address. Uses dotted decimal form, such as "192.168.23.42". |
Base stations. | |
| NET-LOCAL.PORT | Communication | PUBLIC | 3.4.0 | SET|GET | port |
[1-65535] | Setup Tool server TCP port on reader. | Ethernet readers. | |
| NET-LOCAL.PCAP | System | PRIVATE | 5.7.0 | SET|GET | interface |
interface | Retrieves packet capturing buffer. | ALL | |
| NET-LOCAL.MAX-LINK-SPEED | Communication | PRIVATE | 5.2.0 | SET|GET | speed |
[0-4] |
0: 1000 MBits/sec Full Duplex 1: 100 MBits/sec Full Duplex 2: 100 MBits/sec Half Duplex 3: 10 MBits/sec Full Duplex 4: 10 MBits/sec Half Duplex |
Limits the advertised autonegotiation maximum link speed. | DM503 only |
| NET-LOCAL.IP-ADDRESS | Communication | PUBLIC | 3.3.0 | SET|GET | string |
Reader's IP address. Uses dotted decimal form, such as "192.168.23.42". |
Ethernet readers. | ||
| NET-LOCAL.GATEWAY | Communication | PUBLIC | 3.3.0 | SET|GET | string |
Reader's default gateway IP address. Uses dotted decimal form, such as "192.168.23.1". |
Ethernet readers. | ||
| NET-LOCAL.DNS-SERVER | Communication | PUBLIC | 3.3.0 | SET|GET | server |
Gets or sets the DNS Server address. | Ethernet readers. | ||
| NET-LOCAL.DHCP | Communication | PUBLIC | 3.3.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable/Disable DHCP on reader. | Ethernet readers. |
| MULTICODE.VERTICAL-REVERSE | Symbology | PUBLIC | 3.4.0 | SET|GET | state |
[ON|OFF] |
ON: sort bottom to top OFF: sort top to bottom |
Vertical position sorting order preference. | Fixed mount readers. |
| MULTICODE.SYMBOLOGY-REVERSE | Symbology | PUBLIC | 3.4.0 | SET|GET | state |
[ON|OFF] |
ON: DotCode, VeriCode ®, Linear/Postal/Stacked, QR Code/MaxiCode/AztecCode, Data Matrix OFF: Data Matrix, QR Code/MaxiCode/AztecCode, Linear/Postal/Stacked, VeriCode ®, DotCode |
Symbology sorting order preference. | Fixed mount readers. |
| MULTICODE.SORT-PRIORITY | Symbology | PUBLIC | 3.4.0 | SET|GET | symbology image vertical position horizontal position |
[0-3] [0-3] [0-3] [0-3] |
Range for all four arguments indicates sort priority. Must be different for each criteria. |
Sorting order for multicode results: 0 is highest priority, 3 is lowest priority. | Fixed mount readers. |
| MULTICODE.PARTIAL-RESULTS | Symbology | PUBLIC | 3.2.0 | SET|GET | state |
[ON|OFF] | enable/disable | Controls how the reader interprets the number of codes to find. ON = reader will return a successful read if 1 or more codes are found. OFF = reader will return a successful read only if number of codes found equals MULTICODE.NUM-CODES value. | Fixed mount readers. |
| MULTICODE.NUM-CODES | Symbology | PUBLIC | 3.2.0 | SET|GET | number |
[1-255] | Number of codes readers must find for a successful read result. | Fixed mount readers. | |
| MULTICODE.MAX-NUM-CODES | Symbology | PUBLIC | 3.2.0 | SET|GET | symbology number |
[1-5] [1-255] |
1: DataMatrix 2: QR Code/MaxiCode/AztecCode 3: Linear/ Postal/ Stacked 4: VeriCode® 5: DotCode |
The expected maximum number of codes to find for each symbology grouping 1 - 4; no expected value for any single symbology can exceed parameter 0, the total number of codes to find. | Fixed mount readers. |
| MULTICODE.IMAGE-REVERSE | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] |
ON: sort last image first OFF: sort first image first |
Image sorting order preference. | Fixed mount readers. |
| MULTICODE.IDENTICAL-SYMBOLS | Symbology | PUBLIC | 3.4.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enables/disables output of identical symbols when multicode is enabled. | Fixed mount readers. |
| MULTICODE.HORIZONTAL-REVERSE | Symbology | PUBLIC | 3.4.0 | SET|GET | state |
[ON|OFF] |
ON: sort right to left OFF: sort left to right |
Horizontal positional sorting order priority. | Fixed mount readers. |
| MSI.XMTCHK | Symbology | PUBLIC | 5.0.0_cr5 | SET|GET | state |
[ON|OFF] | enable/disable | Sets or gets whether to transmit the check digit. | DM474, DM503 and DM300 series readers. |
| MSI.QZ-SIZE | Symbology | PUBLIC | 5.0.0_cr5 | SET|GET | size |
[0-100] | Sets or gets the single side strictness as a percentage | DM474, DM503 and DM300 series readers. | |
| MSI.CODESIZE | Symbology | PUBLIC | 5.0.0_cr5 | SET|GET | mode min max |
[ON|OFF] [1-max] [min-80] |
any length code minimum code length maximum code length |
Sets or gets the expected code size. | DM474, DM503, DM300 series readers, MX-1000, MX-1502. |
| MSI.CHKCHAR-OPTION | Symbology | PUBLIC | 5.0.0_cr5 | SET|GET | mode |
[0-5] |
0: Mod10 1: Mod11 2: Mod1010 3: Mod1110 4: 5: |
Sets or gets the method for calculating checksum. | DM474, DM503 and DM300 series, MX-1000, MX-1502, Mobile. |
| MSI.CHKCHAR | Symbology | PUBLIC | 5.0.0_cr5 | SET|GET | state |
[ON|OFF] | enable/disable | Sets or gets whether check character is used. Default value is OFF. | DM300 series, DM474, DM503, MX-1000, MX-1502, Mobile. |
| MQA.POSTAL-MODE | Code Quality | PRIVATE | 4.0.0 | SET|GET | mode |
[0-2] |
0: Off 1: Partial Metrics 2: All Metrics |
Gets or sets the postal verification mode. | ALL |
| MQA.POSTAL-HEIGHT_MICRON | Code Quality | PRIVATE | 4.4.1_cr7 and 5.0.0_cr6 | SET|GET | height |
Height in microns per pixel for MERLIN metrics. | DM300 series readers, DM474. | ||
| MOTION-DETECTION.TIMEOUT | Action | PRIVATE | 5.7.0 | SET|GET | [0 - 3600] | sec | Time after the reader switches into the motion detection mode. | DM50, DM60, DM70, DM150, DM260, DM300, DM474, DM503. | |
| MOTION-DETECTION.SENSITIVITY | Action | PUBLIC | 5.7.0 | SET|GET |
|
[0|2] |
0: Low 1: Medium 2: High |
Sets or gets the motion detection sensitivity level when in presentation mode. | DM50, DM60, DM70, DM150, DM260, DM300, DM474, DM503. |
| MOTION-DETECTION.INIT-STATE | Action | PRIVATE | 5.7.0 | SET|GET | state |
[ON|OFF] | enable/disable ON: motion detection is default state\n; OFF: switch to motion detection state after timeout | Specify the motion detection default state. | DM50, DM60, DM70, DM150, DM260, DM300, DM474, DM503. |
| MOTION-DETECTION.ENABLE | Action | PUBLIC | 5.7.0 | SET|GET | state |
[ON|OFF] |
ON: enable OFF: disable |
Enables or disables motion detection for Presentation trigger mode. | DM50, DN60, DM70, DM150, DM260, DM300, DM474, DM503. |
| MOTION-DETECTION.ACTIVE | Action | PUBLIC | 5.7.0 | GET | state |
[ON|OFF] |
ON: Active or Lights Off OFF: Inactive or Lights On |
Allows checking the current state of motion detection for presentation or self-internal trigger mode. | DM50, DN60, DM70, DM150, DM260, DM300, DM360, DM474. |
| MONITOR-MODE.ENABLE | Camera | PUBLIC | 6.0.1 | SET|GET | state |
[ON|OFF] | enable/disable | Enable/disable monitor mode. | ALL |
| MONITOR-MODE.DECODE-ENABLE | Camera | PUBLIC | 5.7.1 | SET|GET | mode |
[ON|OFF] | enable/disable | ALL | |
| MONITOR-MODE.AUTOEXPOSURE | Camera | PUBLIC | 5.7.1 | SET|GET | state |
[ON|OFF] | enable/disable | Enable/disable autoregulation while in monitor mode. | ALL |
| MODBUSTCP.HOLDING-ONLY | Communication | PUBLIC | SET|GET | state |
[ON|OFF] | enable/disable | Ethernet readers. DM8000 series wireless readers also support this protocol if the base station is connected through Ethernet. | ||
| MODBUSTCP.ENABLED | Communication | PUBLIC | SET|GET | state |
[ON|OFF] | enable/disable | Enable or disable Modbus/TCP communication. | Ethernet readers. The DM8000 series wireless readers also support this protocol if the base station is connected through Ethernet. In the case of a Bluetooth connection, the command has to be sent to the base station, not to the reader. | |
| MC-PROTOCOL.ENABLED | Communication | PRIVATE | SET|GET | state |
[ON|OFF] | enable/disable | Enable or disable MC-Protocol communication. | Ethernet readers. The DM8000 series wireless readers also support this protocol if the base station is connected through Ethernet. In the case of a Bluetooth connection, the command has to be sent to the base station, not to the reader. | |
| MAXICODE.TRAINED-MODEL | Decoder | PUBLIC | 5.7.0 | SET|GET | module size |
[1-1000] | Module size * 10 | Set training parameters for MaxiCode symbology. | Fixed-mount readers |
| MASTER-SLAVE.TIMEOUT-MODE | Communication | PUBLIC | 5.7.3 | SET|GET | mode |
[0-1] |
0: Time 1: Distance |
Controls if the mater slave response timeout will be time or distance based. | DM60, DM260, DM474, DM503, and DM300 series readers. |
| MASTER-SLAVE.TIMEOUT-DISTANCE | Communication | PUBLIC | 5.7.3 | SET|GET | int |
[0-1000000] | Distance | The distance for a master slave timeout. | DM60, DM70, DM260, DM474, DM503, and DM300 series readers. |
| MASTER-SLAVE.TIMEOUT | Communication | PUBLIC | 4.0.0 | SET|GET | milliseconds |
[0-10000] | Gets or sets the time to wait for results from slave cameras. | DM60, DM474, DM503, and DM300 series readers. | |
| MASTER-SLAVE.TEST-EFP-OUTPUT | Communication | PUBLIC | 5.7.3 | SET|GET | state |
[ON|OFF] |
ON: enable OFF: disable |
Enables or disables mst-test messages on the Industrial Protocol interfaces. | DM300 series readers, DM474. |
| MASTER-SLAVE.TEST | Communication | PUBLIC | 5.5.0 | mode message |
[0-2] |
0: Slave to Master 1: Master to Slave 2: Master to Slave to Master |
Transmits the test message from reader to reader as designated by mode. The terminating reader will output the message preceded by the initiating device delimited by a space | Fixed-mount readers. | |
| MASTER-SLAVE.RX-HEIGHT-SENSOR | Camera | PUBLIC | 4.1.0 | SET|GET | enable |
[ON|OFF]* | enable/disable | Enables or disables this system receiving height information from another system in the network group. | DM60, DM474 and DM300 series readers. |
| MASTER-SLAVE.MODE | Communication | PUBLIC | 4.0.0 | SET|GET | mode |
[0-2] |
0: OFF 1: ON 2: Master |
Switches the master-slave functioning of the reader on or off. | DM60, DM474, DM503, and DM300 series readers. |
| MASTER-SLAVE.GROUP-NAME | Communication | PUBLIC | 4.0.0 | SET|GET | name |
Gets or sets the name of the master slave group. | DM60, DM474, DM503, and DM300 series readers. | ||
| MARKEM.ENABLED | Communication | PRIVATE | 5.0.0_cr11 | SET|GET | state |
[ON|OFF] | enable/disable | Enable or disable the Markem protocol. | DM300 series readers, DM474. |
| LVHSTS.ENABLED | Communication | PRIVATE | 4.4.1_cr6_sr2 | SET|GET | state |
[ON|OFF] | enable/disable | Enable or disable the USPS Lehigh Valley HSTS protocol. | DM300 series readers, DM474. |
| LLFLASH.WRITE | System | PRIVATE | 5.4.0 | SET | Sets liquid lens flash content. | Readers with liquid lens. | |||
| LLFLASH.READ | System | PRIVATE | 5.4.0 | GET | Gets liquid lens flash content. | Readers with liquid lens. | |||
| LL.REGTODISTANCE | System | PRIVATE | 5.4.0 | register |
Get distance in mm for specified register steps at current temperature. | Readers with liquid lens. | |||
| LIVEIMG.SEND | Camera | PUBLIC | 5.6.3 | size format quality |
[0-3] [0-2] [10, 15, 20... 85, 90] |
0: Full 1: 1/4 2: 1/16 3: 1/64 0: Bitmap 1: JPEG 2: PNG JPEG Quality |
Request image transfer to PC when LIVEIMG.MODE is set to 3. | ||
| LIVEIMG.MODE | Camera | PUBLIC | 5.2.0 | SET|GET | mode |
[0,2] |
0: Disable 2: Enable |
Controls live image display. | ALL |
| LIMIT.CONS-NOREAD | System | PRIVATE | 5.4.0 | SET|GET | string |
empty string: feature disabled "CBRD>n": signal after n consecutive bad reads |
Sets/gets the threshold for consecutive bad read event signaling. | ALL | |
| LIGHTRING.DURATION | IO | PUBLIC | 5.7.0 | SET|GET | duration |
[0..10000] |
0: Default behavior 10..10000: duration of lightring event in ms, step 10 ms |
Controls the duration of the lightring illumination event. | DM36x, DM474 and DM503 |
| LIGHTCURTAIN.BEAM-SPACING | IO | PUBLIC | 4.1.0 | SET|GET | spacing |
[1-300000] | micrometers | Distance (in um) between beams of the Light Curtain. This determines the resolution of the light curtain. | DM503 |
| LIGHT.SELF-REPAIR | Camera | PRIVATE | 5.5.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enables/disables internal illumination self repair mode. | DM300 series readers |
| LIGHT.POLARIZED | Camera | PUBLIC | 5.6.0 | SET|GET | polarized LED count |
[0|2|4] | Number of polarized filtered LEDs in the illumination | Use this command after applying a different HPIL front cover to publish the illumination filter status to the device. | DM70, DM150, DM260 |
| LIGHT.ON-AXIS-INTENSITY | Camera | PRIVATE | 5.7.0 | SET|GET | intensity |
[0..3] | on-axis illumination intensity | Controls the intensity of the DM262 UHD on-axis illumination. | DM262 |
| LIGHT.ON-AXIS | Camera | PUBLIC | 5.7.0 | SET|GET | state |
[ON|OFF] [ON|OFF] | enable/disable on-axis illumination | Controls the DM262 UHD on-axis illumination. | DM262 |
| LIGHT.LOW-ANGLE | Camera | PUBLIC | 5.7.0 | SET|GET | state |
[ON|OFF] [ON|OFF] | enable/disable low-angle illumination | Controls the DM262 UHD low-angle illumination. | DM262 |
| LIGHT.INTERNAL-ENABLE | Camera | PUBLIC | 4.1.0 | SET|GET | enable |
[ON|OFF] | enable/disable | Enable the built-in internal illumination. Default value is OFF. | DM50, DM60, DM70, DM8050, MX-1000, MX-1502, Mobile. |
| LIGHT.HIGH-FREQUENCY-FORCE | Camera | PRIVATE | 5.2.0 | SET|GET | enable |
[ON|OFF] | enable/disable | Enable High Frequency Lights even if overheat protection would normally prohibit it. | DM300 series readers |
| LIGHT.HIGH-FREQUENCY-ALWAYS | Camera | PUBLIC | 5.2.0 | SET|GET | enable seconds |
[ON|OFF] 0-86400 |
enable/disable auto off duration |
Enables High Frequency Light in Continuous trigger mode even if no trigger is active. After duration seconds the High Frequency Light is turned off. If the duration is 0 the light is never turned off. | DM50, DM60, DM70, DM474, DM503, and DM300 series readers. |
| LIGHT.HIGH-FREQUENCY | Camera | PUBLIC | 5.2.0 | SET|GET | enable |
[ON|OFF] | enable/disable | Enables High Frequency Lights to avoid flickering illumination. | DM50, DM60, DM70, DM474, DM503, and DM300 series readers. |
| LIGHT.EXTERNAL-PRECHARGE-TIME | Camera | PREVIEW | 3.0.0 | SET|GET | time |
[1-980] | microseconds | External light precharge time. | Fixed mount readers. |
| LIGHT.EXTERNAL-POLARITY | Camera | PUBLIC | 3.0.0 | SET|GET | polarity |
[0-1] |
0: Active Low 1: Active High |
External illlumination output polarity. | Fixed mount readers except for DM70, DM150, DM260. |
| LIGHT.EXTERNAL-INTENSITY | Camera | PUBLIC | 5.2.0 | SET|GET | level |
[0-15] | Intensity | Sets the intensity of the external illumination. | Fixed mount readers. |
| LIGHT.EXTERNAL-ENABLE | Camera | PUBLIC | 4.1.0 | SET|GET | enable |
[ON|OFF] | enable/disable | Enable external illumination supported by I/O. | Fixed mount readers. |
| LIGHT.DIRECT-INTENSITY | Camera | PUBLIC | 5.1.0 | SET|GET | level |
[0-15] | Intensity | Direct Illumination Intensity. | DM50, DM60, DM474, DM503 and DM300 series readers. |
| LIGHT.DIRECT-INTENSITY | Camera | PUBLIC | 5.4.3 | SET|GET | level |
[1-15] | Intensity | Direct Illumination Intensity. | DM8050 |
| LIGHT.DIRECT | Camera | PUBLIC | 4.4.0 | SET|GET | north east south west NORTH EAST SOUTH WEST |
[ON|OFF]
[ON|OFF] [ON|OFF] [ON|OFF] [ON|OFF] [ON|OFF] [ON|OFF] [ON|OFF] |
enable/disable
enable/disable enable/disable enable/disable enable/disable enable/disable enable/disable enable/disable |
Sets the quadrants on the DM300. Small letters refer to the inner, capital letters to the outer circle, possible values are ON and OFF for each segment. Example for a SET command: SET LIGHT.DIRECT ON OFF ON ON OFF OFF OFF OFF if you want to have the inner north, south, and west lights on. | DM300 series readers, DM474. |
| LIGHT.DIRECT | Camera | PUBLIC | 5.5.0 | SET|GET | north-east north-west south-east south-west |
[ON|OFF]
[ON|OFF] [ON|OFF] [ON|OFF] |
enable/disable
enable/disable enable/disable enable/disable |
Sets the quadrants on the DM70, DM150 and DM260. Possible values are ON and OFF for each segment. Example for a SET command: SET LIGHT.DIRECT ON OFF OFF ON if you want to have the top-left and bottom-right LED on. | DM70, DM150 and DM260 readers. |
| LIGHT.DIRECT | Camera | PUBLIC | 5.7.7 | SET|GET | state |
[ON|OFF] | enable/disable | Turns on/off light banks for the 8072V. Verification should only take place with lighting combinations that can be described as 30 single, 30T (opposite sides), 30Q (all 30 panels), 45Q (all 45 panels), or 90. Other lighting combinations are allowed by the firmware, but will not result in valid verification result. | DM8072 Verifier |
| LIGHT.DIRECT | Camera | PUBLIC | 6.1.6 | SET|GET | North Corners South East-West |
[ON|OFF]
[ON|OFF] [ON|OFF] [ON|OFF] |
enable/disable
enable/disable enable/disable enable/disable |
Enables or disables the HPIT quadrants. | DM370 series, DM470 series readers. |
| LIGHT.DIFFUSE-INTENSITY | Camera | PUBLIC | 5.4.3 | SET|GET | level |
[0-15] | Intensity | Diffuse Brightfield Illumination Intensity. | DM8600 |
| LIGHT.DARKFIELD-INTENSITY | Camera | PUBLIC | 5.4.3 | SET|GET | value |
[0-15] | Intensity | Darkfield Illumination Intensity. | DM8600 |
| LIGHT.AIMER-TIMEOUT | Camera | PUBLIC | 4.2.1 | SET|GET | int |
[0-600] | seconds | Aimer Timeout in seconds. | MX-1000 and DM8000 series readers. |
| LIGHT.AIMER | Camera | PUBLIC | 3.0.0 | SET|GET | aimer-mode |
[0-1] |
0: Off 1: On |
Aimer Enable. Default is ON. |
ALL except for DM503 and DM8050. |
| LIGHT.AIMER | Camera | PUBLIC | 5.4.0 | SET|GET | aimer-mode |
[0,1,3] |
0: Off 1: On 3: Activated by Acceleration Sensor |
Aimer Enable. Default is ON. |
DM8050 |
| LIGHT.AIMER | Camera | PRIVATE | 3.0.0 | SET|GET | aimer-mode |
[0-3] |
0: Off 1: LED 2: Laser 3: Both |
Aimer Enable. | DM700 |
| LIGHT.AIMER | Camera | PRIVATE | 3.0.0 | SET|GET | aimer-mode |
[0-3] |
0: Off 1: On when idle 2: Blink (default) 3: On (default) |
Aimer Enable. | DM7500 |
| LIGHT.AIMER | Camera | PUBLIC | 6.1.6 | SET|GET | aimer-mode |
[0-1] |
0: Off 1: On |
Enables or disables the aimer. | DM370 series, DM470 readers. |
| KEY.ZERO-PAD | IO | PUBLIC | 3.0.0 | SET|GET | language |
[ON|OFF] | enable/disable | ALL except for DM60, DM474, DM503, and DM300 series readers. | |
| KEY.PAUSE-TIME | Action | PUBLIC | 5.4.0 | SET|GET | Pause time |
[0-1000] | 0 to 1000 millisecond pause | Sets the time to pause for a specified pause key sequence. | DM8050, DM8600 series |
| KEY.LANGUAGE | IO | PUBLIC | 3.0.0 | SET|GET | language |
[0-7] |
0: Alt Key Combo 1: DE 2: US 3: JP 4: FR 5: ES 6: NO 7: FI |
ALL except for DM60, DM474, DM503, and DM300 series readers. | |
| KEY.INTERCHAR-DELAY | Communication | PUBLIC | 5.5.0 | SET|GET | us |
[0-1000] | milliseconds | Sets or gets the delay time between characters when in HID keyboard mode. | DM300 series readers, DM60, DM50, DM70, DM474. |
| KEY.EMULATE-PS2 | IO | PRIVATE | 5.4.0 | SET|GET | state |
[ON|OFF]
[OFF, Wedge, EmulationG |
enable/disable
OFF: no emulation Wedge: reader and PS/2 keyboard are connected using a wedge cable Emulation: reader is connected to wedge and no PS/2 keyboard is present |
Wireless readers. | |
| IO-LINE.DIRECTION | IO | PUBLIC | 5.5.0 | SET|GET | line direction |
[2,3] [0,1] |
line=2: sets direction of I/O Line 2 line=3: sets direction of I/O Line 3 direction=0: defines line as output direction=1: defines line as input |
Sets the direction of the programmable I/O lines of DM360 and DM474 series readers. | DM360 series, DM474 readers |
| INTER-MESSAGE.DELAY | Communication | PREVIEW | 3.2.0 | SET|GET | value |
[0-10000] | milliseconds | Transmission delay between buffered read strings. | Wireless readers. |
| INTELLIGRATED.HEARTBEAT | IO | PRIVATE | 5.0.0_cr14 | SET|GET | sec |
[0-50] | seconds | Sets or gets the time between heartbeat transmissions. A value of 0 disables the heartbeat. | DM503 series readers. |
| INTELLIGRATED.ENABLED | Communication | PRIVATE | 5.0.0_cr14 | SET|GET | state |
[ON|OFF] | enable/disable | Enable or disable the Intelligrated protocol. | DM503 series readers. |
| INPUT1.SAVE-MATCH-STRING | Communication | PUBLIC | 4.5.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enables or disables saving the match string to flash when Set Match String is enabled as Input line 1 action. | DM50, DM60, DM70, DM474, DM503, and DM300 series readers. |
| INPUT.VIRTUAL | Action | PRIVATE | 3.0.0 | line state |
[0-7] [ON|OFF] |
enable/disable |
Software Virtual Input. Trigger is equivalent to line 0. Note that the input actions "Train Code," "Optimize Brightness," "Set Match String," and "Read Configuration Code" are carried out only after the next trigger. |
Fixed mount devices. | |
| INPUT.STATE | Action | PUBLIC | 5.5.0 | GET | line |
[0-3] | input line number | Gets the current state of the input line specified. Returns 1 for high, 0 for low. | Fixed-mount readers |
| INPUT.EVENT-MESSAGE | IO | PRIVATE | 5.0.0_cr10 | SET|GET | state |
[ON|OFF] | enable/disable | Instructs the system to generate a message for every input line state change. | DM300 series readers, DM474. |
| INPUT.ACTION1 | IO | PUBLIC | 3.0.0 | SET|GET | mode state |
[0-3] [ON|OFF] |
0: Train Code 1: Optimize Brighness 2: Set Match String 3: Optimize focus (Only for readers with a liquid lens.) enable/disable |
Input Line 1 Action. | Fixed mount readers. |
| INPUT.ACTION | IO | PUBLIC | 4.0.0 | SET|GET | line action state |
[0-3] [0-11] [ON|OFF] |
Input line number 0: Train Code 1: Optimize Brightness 2: Set Match String 3: Optimize Focus 4: Read Configuration Code 5: Trigger Off 6: Encoder 7: Allow Buffered No-Read Images 8: Clear Outputs 9: Tune (DM300 only) 10: Encoder direction 11: Trigger on ON: execute action when line is triggered OFF: no action |
Sets or gets the state for the specified line action. The input actions "Train Code," "Optimize Brightness," "Set Match String," and "Read Configuration Code" are carried out only after the next trigger. |
Fixed-mount readers. |
| INPUT-STRING.VALUE | Data Formatting | PUBLIC | 5.5.0 | SET|GET | string |
token string | Sets the content of the Input String character string. | Fixed-mount readers | |
| INPUT-STRING.MODE | Data Formatting | PUBLIC | 5.5.0 | SET|GET | int |
[0-4] |
0: Store 1: Send 2: Send with header and footer 3: Send with formatting 4: Send with header and footer formatting |
Controls whether the input string data is sent out as a result or stored in an internal variable. | Fixed-mount readers. |
| INPUT-STRING.HEADER | Data Formatting | PUBLIC | 5.0.0 | SET|GET | string |
token string | Sets the header for the Input String character string. | ALL | |
| INPUT-STRING.FOOTER | Data Formatting | PUBLIC | 5.0.0 | SET|GET | string |
token string | Sets the footer for the Input String character string. | ALL | |
| INPUT-STRING.ENABLE | Data Formatting | PUBLIC | 5.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enables or disables the use of the Input String feature (available for serial, telnet, NetworkClient). When enabled, a header and the footer can be set by the INPUT-STRING.HEADER and INPUT-STRING.FOOTER commands, respectively. A string of characters can be given between the header and the footer, which will be sent with the formatted output (for example, [hello world], if the header is set to ’[’ and the footer to ’]’). Since the input string is saved temporarily, it appears only in the next result output. Use Setup Tool (the <Input String> option) or <ISTR> with DMCC (see SET FORMAT.TOKEN) to allow Input string in the result output. | ALL |
| INPUT-STRING.ENABLE | Data Formatting | PRIVATE | 4.4.0_cr10 | SET|GET | state |
[ON|OFF] | enable/disable | Enables or disables the use of the Input String feature (available for serial, telnet, NetworkClient). When enabled, a header and the footer can be set by the INPUT-STRING.HEADER and INPUT-STRING.FOOTER commands, respectively. A string of characters can be given between the header and the footer, which will be sent with the formatted output (for example, [hello world], if the header is set to ’[’ and the footer to ’]’). Since the input string is saved temporarily, it appears only in the next result output. Use Setup Tool (the <Input String> option) or <ISTR> with DMCC (see SET FORMAT.TOKEN) to allow Input string in the result output. | ALL |
| IMAGEBUFFER.TRANSFER-MODE | RecordPlayback | PUBLIC | 4.0.0 | SET|GET | interval |
[0-1] |
0: On Request 1: FTP - runtime |
Sets or gets whether buffered images should automatically sent FTP or if they should be send only after requested. | DM60, DM70, DM474, DM503, MX-1000, DM8000 series, and DM300 series readers and DM260. |
| IMAGEBUFFER.SIZE | RecordPlayback | PUBLIC | 4.0.0 | SET|GET | size |
[0-3] |
0: Full 1: 1/4 2: 1/16 3: 1/64 |
DM50, DM60, DM70, DM474, DM503, MX-1000, DM8000 series and DM300 series readers. | |
| IMAGEBUFFER.SEND-FTP-PARAM | RecordPlayback | PRIVATE | 4.0.0 | Transmit buffered images to designated FTP server. | Fixed mount Ethernet readers, DM8050 and DM8600. | ||||
| IMAGEBUFFER.SEND-FTP | RecordPlayback | PUBLIC | 4.0.0 | Transmit buffered images to designated FTP server. | DM60, DM474, DM503, DM8000 series and DM300 series readers. | ||||
| IMAGEBUFFER.RECORD-TYPE | RecordPlayback | PUBLIC | 4.0.0 | SET|GET | type |
[0-5] |
0: None 1: No-Read 2: Read 3: All 4: Validation Failure 5: No-Read + Validation failure |
Sets or gets the type of image to buffer. In case of No-Read, the image is buffered if the reader fails to read. |
DM50, DM60, DM70, DM474, DM503, MX-1000, DM8000 series and DM300 series readers. |
| IMAGEBUFFER.RECORD | RecordPlayback | 4.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable or disable image buffereing. obsolete in 4.0.0. |
Fixed mount readers, DM8050 and DM8600. | |
| IMAGEBUFFER.QUALITY | RecordPlayback | PUBLIC | 4.0.0 | SET|GET | quality |
[10, 15, 20... 85, 90] | JPEG Quality | DM50, DM60, DM70, DM474, DM503, MX-1000, DM8000 series and DM300 series readers. | |
| IMAGEBUFFER.OVERLAY | RecordPlayback | PUBLIC | 5.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enables Overlay Graphics (SVG) for buffered images. | DM50, DM60, DM70, DM474, DM503, DM300 series readers, DM8050 and DM8600. |
| IMAGEBUFFER.NUM | RecordPlayback | PUBLIC | 4.0.0 | GET | size |
Returns the number of currently buffered images. | DM50, DM60, DM70, DM474, DM503, DM300 series readers, DM8050 and DM8600. | ||
| IMAGEBUFFER.NO-READ-INDEX | RecordPlayback | PRIVATE | 4.4.0_cr2 | SET|GET | index |
0 is the default behavior to send all as selected; 1 – max burst is send only the index selected. | DM474, DM300 series readers, DM8050 and DM8600. | ||
| IMAGEBUFFER.NO-READ-IMAGE-RATE-TIME | RecordPlayback | PUBLIC | 5.2.0 | SET|GET | type |
[0-3] |
0: seconds 1: minutes 2: hours 3: days |
Time unit of bad read images to be buffered at a rate number specified with IMAGEBUFFER.NO-READ-IMAGE-RATE-TIME. | DM474, DM503, DM300 series readers, only in Single, Burst, Self and Continuous modes. |
| IMAGEBUFFER.NO-READ-IMAGE-RATE-COUNT | RecordPlayback | PUBLIC | 5.2.0 | SET|GET | interval |
Number of bad read images to be buffered at a time unit (for example, minutes or hours) specified with IMAGEBUFFER.NO-READ-IMAGE-RATE-COUNT. | DM503, DM300 series readers, only in Single, Burst, Self and Continuous modes. | ||
| IMAGEBUFFER.NO-READ-IMAGE-RATE-BURST | RecordPlayback | PUBLIC | 5.2.0 | SET|GET | interval |
[1-1000] | Burst determines the peak rate of the number of bad read images buffered. | DM474, DM503, DM300 series readers, only in Single, Burst, Self and Continuous modes. | |
| IMAGEBUFFER.NO-READ-IMAGE-PERIOD | RecordPlayback | PUBLIC | 4.0.0 | SET|GET | interval |
[1-200] | Sets or gets the interval to save the image of a bad read. If, for example, you use an interval of 6, the first bad image is saved and the next 5 are not. The default is 1 which saves each bad read image. | DM50, DM60, DM70, DM474, DM503, DM300 series readers, only in Single, Burst, Self and Continuous modes. | |
| IMAGEBUFFER.NO-READ-IMAGE-NUMBER | RecordPlayback | PUBLIC | 5.0.0 | SET|GET | limit |
[n] [Max Int] |
In Burst trigger mode, n is the number of images in a burst In other trigger modes, there is no limit |
Store exactly one image. | DM50, DM60, DM70, DM474, DM503, DM300 series readers, only in Single, Burst, Self and Continuous modes. |
| IMAGEBUFFER.NO-READ-IMAGE-MODE | RecordPlayback | PRIVATE | 5.0.0 | SET|GET | size |
[0-3] |
0: No-Read Image Period 1: No-Read Image Number 2: No-Read Image Rate 3: No-Read Image Range |
No-Read Image stores only one image per trigger and you can select which one. No-Read Image Period stores every nth bad read image. This is evaluated across trigger modes. For example, if you have burst trigger selected with a length of 5 and set period to 3, the 1st and 4th image of the first, but the 2nd and 5th of the second burst will be stored. No-Read Image Range stores all bad read images from the no-read image number to the last no-read image number. | Fixed-mount readers, only in Single, Burst, Self and Continuous modes. |
| IMAGEBUFFER.NO-READ-IMAGE-LAST-NUMBER | RecordPlayback | PRIVATE | 5.5.0 | SET|GET | limit |
[n][Max Int] | In Burst trigger mode, n is the number of images in a burst. In other trigger modes, there is no limit. | Stores images up to the limit. | Fixed-mount readers, only in Single, Burst, Self and Continuous modes. |
| IMAGEBUFFER.MAX-NUM | RecordPlayback | PUBLIC | 4.0.0 | SET|GET | size |
[0-*] | Maximum number of images that can be buffered. * Range varies depending depending on Camera ROI and memory allocated for burst length. |
DM50, DM60, DM70, DM474, DM503, DM300 series readers, DM8050 and DM8600. | |
| IMAGEBUFFER.MAX-IMAGES-PER-RESULT | RecordPlayback | PUBLIC | 5.0.0 | SET|GET | size |
[0-*] | Sets or gets how many images (n) per result are stored. | DM50, DM60, DM70, DM474, DM503, DM300 series readers, DM8050 and DM8600. | |
| IMAGEBUFFER.IMAGE-TYPE | RecordPlayback | PUBLIC | 5.5.0 | SET|GET | int |
[0-2] |
0: All 1: Same as result 2: Auto |
Sets "What images to Buffer for a Result". When "Auto" is selected, the reader does intelligent image buffering. Requires the IntImageBuffer feature key to select the "Auto" option. |
DM70, DM150, DM260, DM300 series readers, DM474, DM503. |
| IMAGEBUFFER.GOOD-IMAGE-RATE-TIME | RecordPlayback | PUBLIC | 5.2.0 | SET|GET | type |
[0-3] |
0: seconds 1: minutes 2: hours 3: days |
Time unit of good read images to be buffered at a rate number specified with IMAGEBUFFER.GOOD-IMAGE-RATE-TIME. | DM474, DM503, DM300 series readers, DM8050 and DM8600. |
| IMAGEBUFFER.GOOD-IMAGE-RATE-COUNT | RecordPlayback | PUBLIC | 5.2.0 | SET|GET | interval |
Number of good read images to be buffered at a time unit (for example, minutes or hours) specified with IMAGEBUFFER.GOOD-IMAGE-RATE-COUNT. | DM474, DM503, DM300 series readers, DM8050 and DM8600. | ||
| IMAGEBUFFER.GOOD-IMAGE-RATE-BURST | RecordPlayback | PUBLIC | 5.2.0 | SET|GET | interval |
[1-1000] | Burst determines the peak rate of the number of good read images buffered. | DM474, DM503, DM300 series readers, DM8050 and DM8600. | |
| IMAGEBUFFER.GOOD-IMAGE-MODE | RecordPlayback | PUBLIC | 5.2.0 | SET|GET | mode |
[0-1] |
0: Unlimited 1: Rate limited |
Good Read Image stores all buffered good read images unless you set a limit rate. | DM503, DM300 series readers, DM8050 and DM8600. |
| IMAGEBUFFER.FORMAT | RecordPlayback | PUBLIC | 5.6.3 | SET|GET | format |
[0-2] |
0: Bitmap 1: JPEG 2: PNG |
DM50, DM60, DM70, DM474, DM503, MX-1000, DM8000 series and DM300 series readers. | |
| IMAGEBUFFER.DELETE-AFTER-TRANSFER | RecordPlayback | PUBLIC | 4.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Release stored images automatically after image has been transfered. | DM50, DM60, DM70, DM474, DM503, DM300 series readers, DM8050 and DM8600. |
| IMAGEBUFFER.DELETE | RecordPlayback | PUBLIC | 4.0.0 | Release stored images. | DM50, DM60, DM70, DM474, DM503, DM300 series readers, DM8050 and DM8600. | ||||
| IMAGEBUFFER.AUTO-PREFER-CENTER | RecordPlayback | PUBLIC | 5.7.3 | SET|GET | Controls whether to use the decoders best symbol or the symbol closer to the ROI center. | DM50, DM60, DM70, DM474, DM503, DM300 series readers, DM8050 and DM8600. | |||
| IMAGEBUFFER.ALLOW-OVERWRITE | RecordPlayback | PUBLIC | 4.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Allow buffered images that have not been transfered to be overwritten if all available buffers are used and new images arrive. | DM50, DM60, DM70, DM474, DM503, DM300 series readers, DM8050 and DM8600. |
| IMAGE.SIZE | Camera | PUBLIC | 4.4.0 | SET|GET | size |
[0-3] |
0: Full 1: 1/4 2: 1/16 3: 1/64 |
Image Size. | ALL |
| IMAGE.SEND-TYPE | Camera | 3.0.0 | |||||||
| IMAGE.SEND-SLOT | Camera | 3.0.0 | |||||||
| IMAGE.SEND-BUFFER | Camera | PRIVATE | 5.6.3 | index size format quality |
[0-3] [0-2] [10, 15, 20... 85, 90] |
0: Full 1: 1/4 2: 1/16 3: 1/64 0: Bitmap 1: JPEG 2: PNG JPEG Quality |
Send specified image buffer date. | ||
| IMAGE.SEND | Action | PUBLIC | 5.5.0 | Retrieve the last camera image acquired. Returns number of bytes of image data followed by \r\n followed by image data. Whatever is set for ||>IMAGE.SIZE, ||>IMAGE.FORMAT, and ||>IMAGE.QUALITY before requesting the image will be used for the corresponding size, format, and quality. | ALL | ||||
| IMAGE.QUALITY | Camera | PUBLIC | 4.4.0 | SET|GET | quality |
[10, 15, 20... 85, 90] | JPEG Quality | Quality of the jpeg image. | ALL |
| IMAGE.LOAD-FTP-PARAM | Camera | PRIVATE | 4.0.0 | ??? | |||||
| IMAGE.LOAD-FTP-MULT-PARAM | Camera | PRIVATE | 4.0.0 | ??? | |||||
| IMAGE.LOAD-FTP-MULT-PARAM | IO | PRIVATE | 5.5.0 | SET | server_ip picture last_image more burst_count buffer-overflow seq_nbr ” ” ”user” ”passwd” port |
[ON|OFF] [3] [0-1] |
Server IP Picture name enable/disable Number of images to take 0: Off 1: On Sequence number in the burst User name Password Port used |
Allows uploading of multiple pictures as a burst. | ALL |
| IMAGE.LOAD | Camera | PRIVATE | 3.0.0 | num-bytes |
Loads image from PC to Reader. | ||||
| IMAGE.FORMAT | Camera | PUBLIC | 5.6.3 | SET|GET | format |
[0-2] |
0: Bitmap 1: JPEG 2: PNG |
Image File Format. | ALL |
| IMAGE.FETCH | Camera | PRIVATE | 5.7.1 | size format quality |
[0-3] [0-2] [10, 15, 20... 85, 90] |
0: Full 1: 1/4 2: 1/16 3: 1/64 0: Bitmap 1: JPEG 2: PNG JPEG quality |
Acquires an image and transfers it. | ||
| IDFLASH.WRITE | System | PRIVATE | 5.4.0 | SET | string |
Write ID/slide in EEPROM content. | All | ||
| IDFLASH.READ | System | PRIVATE | 5.4.0 | SET | Read ID/slide in EEPROM content. | All | |||
| I2O5.XMTCHK | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | I2of5 Transmit Check Character. | ALL |
| I2O5.QZ-SIZE | Symbology | PRIVATE | 3.0.0 | SET|GET | state |
[0|100] | Quiet zone single strictness size. | ALL | |
| I2O5.CODESIZE | Symbology | PUBLIC | 3.0.0 | SET|GET | any min max |
[ON|OFF] [4-max] [min-80] |
any length code minimum code length maximum code length |
I2of5 Code Size. For the Manatee Works SDK, all of the Code 25 variants use the same minimum length; thus it will accept either C25.CODESIZE or I205.CODESIZE. | ALL |
| I2O5.CHKCHAR | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | I2of5 Check Character. | ALL |
| HPT.LOG | Action | PRIVATE | 5.7.0 | GET | Retrieves the HPT log as a binary file content. | ALL | |||
| HPT.CHANNEL-ENABLED | Action | PRIVATE | 5.7.0 | SET|GET | channel_name, state |
[ON|OFF] string, [ON|OFF] | enable/disable Channel name. Switch state. | Enables or disables a given HPT log channel. | ALL |
| HPIT.INDICATOR-ON-TIME-US | Action | PRIVATE | 6.1.6 | SET|GET | IND_ID TIME_US |
[0-1] [100-10000] |
0 = Left indicator 1 = Right indicator |
Allows to control the Indicator0 (Green LED) on time to be executed in the following illumination pulse after an event has been detected. | DM370 series, DM470 series readers. |
| HPIT.INDICATOR-MODE | Action | PUBLIC | 6.1.6 | SET|GET | IND_ID IND_MODE |
[0-1] [0-1] |
0 = Left indicator 1 = Right indicator 0 = OFF 1 = ON |
Allows to control the LED indicators located in Torch according to the selected mode. This command is intended only for usability testing. | DM370 series, DM470 series readers. |
| HPIT.FRONT-COVER | Communication | PUBLIC | 6.1.6 | GET |
|
[0-4] |
0 = No cover 1 = Cross polarized NEWC Linear Polarized S 2 = Clear cover 3 = Undefined 4 = Diffused |
Detected front cover type. | DM370 series, DM470 series readers. |
| HEIGHT-SENSOR.CURRENT-MEASUREMENT | Camera | PUBLIC | 6.1.6 | GET | [0-4000] | Distance from the C-Mount Flange in mm | Returns the read out of the ToF range distance in mm. | DM370 series, DM470 series readers. | |
| HEAP.STATS | System | PRIVATE | 3.1.0 | Returns heap memory statistics. | |||||
| FTP.LOG | Action | PRIVATE | 4.4.0 | GET | Get the FTP log of FTP control connection commands and replies in case of FTP problems. | ALL | |||
| FTP-RESULT.USER-NAME | Communication | PUBLIC | 3.3.0 | SET|GET | string |
Username used to login to target FTP server. | Ethernet readers. DM8000 series wireless readers also support FTP if the base station is connected through Ethernet. | ||
| FTP-RESULT.SERVER-TYPE | Communication | PUBLIC | 5.6.3 | SET|GET | type |
[0-2] |
0: Generic 1: Mitsubishi GOT 2: SFTP |
FTP server type.2 means that the server is an S(SH)FTP server. | DM474, DM503 and DM300 series readers. |
| FTP-RESULT.PORT | Communication | PUBLIC | 4.0.0 | SET|GET | port |
[0-65535] | FTP server port number. | Ethernet readers. DM8000 series wireless readers also support FTP if the base station is connected through Ethernet. | |
| FTP-RESULT.PASSWORD | Communication | PUBLIC | 3.3.0 | SET | string |
Password used to login to target FTP server. | Ethernet readers. DM8000 series wireless readers also support FTP if the base station is connected through Ethernet. | ||
| FTP-RESULT.IP-ADDRESS | Communication | PUBLIC | 3.3.0 | SET|GET | string |
IP address of target FTP server. Uses dotted decimal form, such as "192.168.23.42". |
Ethernet readers and MX-1000. DM8000 series wireless readers also support FTP if the base station is connected through Ethernet. | ||
| FTP-RESULT.IDLE-TIME | Communication | PUBLIC | 5.5.0 | SET|GET | seconds |
[0-3600] | Maximum duration of idle connections after a data transfer. | DM474, DM503 and DM300 series readers. | |
| FTP-RESULT.IDLE-LIMIT | Communication | PUBLIC | 5.5.0 | SET|GET | state |
[ON|OFF] | enable/disable | Limit duration of idle connections after a data transfer. | DM474, DM503 and DM300 series readers. |
| FTP-RESULT.FILE-NAME | Communication | PUBLIC | 3.3.0 | SET|GET | string |
File name of FTP result. | Ethernet readers. DM8000 series wireless readers also support FTP if the base station is connected through Ethernet. | ||
| FTP-RESULT.ENABLE | Communication | PUBLIC | 3.3.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable/disable FTP transfer of reader results. | Ethernet readers. DM8000 series wireless readers also support FTP if the base station is connected through Ethernet. |
| FTP-RESULT.APPEND | Communication | PUBLIC | 3.3.0 | SET|GET | type |
[ON|OFF] |
ON: Append result to existing file. OFF: Overwrite file content with result. |
Append to or overwrite file when result is sent via FTP to the file specified by FTP-RESULT.FILE-NAME. The file will be created if it does not exist. | Ethernet readers. DM8000 series wireless readers also support FTP if the base station is connected through Ethernet. |
| FTP-PROXY.NOOP | Communication | PRIVATE | 5.0.0 | session |
Sends NOOP using FTP proxy. | Wireless readers. | |||
| FTP-PROXY.EXECUTE | Communication | PRIVATE | 4.2.0 | index type path length data |
[0-15] [0-15] [0-15] [0-3] [0-3] |
FTP object index as returned by FTP-PROXY.CREATE FTP transfer type (STOR/STOU/APPE/RETR) File path for FTP transfer Data length Data |
Used by wireless readers to proxy FTP transfer through base station. | Base station. | |
| FTP-PROXY.DISCONNECT | Communication | PRIVATE | 4.2.0 | index |
[0-15] | FTP object index as returned by FTP-PROXY.CREATE | Used by wireless readers to proxy FTP transfer through base station. | Base station. | |
| FTP-PROXY.DESTROY | Communication | PRIVATE | 4.2.0 | index |
[0-15] | FTP object index as returned by FTP-PROXY.CREATE | Used by wireless readers to proxy FTP transfer through base station. | Base station. | |
| FTP-PROXY.CREATE | Communication | PRIVATE | 4.2.0 | user pass server port type |
dotted decimal from IPv4 address [1-65535] [0-1] |
Password. Target FTP server address. Target FTP port number. Target FTP server type (Generic/Mitsubishi). |
Used by wireless readers to proxy FTP transfer through base station. | Base station. | |
| FTP-PROXY.CONNECT | Communication | PRIVATE | 4.2.0 | index |
[0-15] | FTP object index as returned by FTP-PROXY.CREATE | Used by wireless readers to proxy FTP transfer through base station. | Base station. | |
| FTP-PCM-REPORT.USER-NAME | Communication | PUBLIC | 5.7.0 | SET|GET | string |
Username used to login to target PCM Report FTP server. | Ethernet readers | ||
| FTP-PCM-REPORT.SERVER-TYPE | Communication | PUBLIC | 5.7.0 | SET|GET | type |
[0-2] |
0: Generic 1: Mitsubishi GOT 2: SFTP(encrypted) |
FTP server type. | Ethernet readers |
| FTP-PCM-REPORT.SERVER-PATH | Communication | PUBLIC | 5.7.0 | SET|GET | string |
Path for PCM Reports which has to be named by the FTP Server. | Ethernet readers | ||
| FTP-PCM-REPORT.SCRIPT-ERROR | Communication | PUBLIC | 5.7.0 | GET | message |
script error message | Gets the script error message for FTP PCM report file name generation. | Ethernet readers | |
| FTP-PCM-REPORT.PORT | Communication | PUBLIC | 5.7.0 | SET|GET | port |
[0-65535] | PCM Report FTP server port number. | Ethernet readers | |
| FTP-PCM-REPORT.PASSWORD | Communication | PUBLIC | 5.7.0 | SET|GET | string |
PASSWORD used to login to target PCM Report FTP server. | Ethernet readers | ||
| FTP-PCM-REPORT.MAX-APPEND-START-VALUE | Communication | PUBLIC | 5.7.0 | SET|GET | value |
[0-65535] | Initial increment value to append to PCM report file name. | Ethernet readers | |
| FTP-PCM-REPORT.MAX-APPEND | Communication | PUBLIC | 5.7.0 | SET|GET | value |
[0-65535] | Max increment value to append to PCM report file name. | Ethernet readers | |
| FTP-PCM-REPORT.IP-ADDRESS | Communication | PUBLIC | 5.7.0 | SET|GET | server |
IP address or DNS name | Set the PCM Report FTP server. | Ethernet readers | |
| FTP-PCM-REPORT.IDLE-TIME | Communication | PUBLIC | 5.7.0 | SET|GET | seconds |
[0-3600] | Maximum duration of idle connections after a data transfer. | Ethernet readers | |
| FTP-PCM-REPORT.IDLE-LIMIT | Communication | PUBLIC | 5.7.0 | SET|GET | state |
ON/OFF |
enable disable |
Limit duration of idle connections after a data transfer. | Ethernet readers |
| FTP-PCM-REPORT.FILE-NAME-USE-SCRIPT | Communication | PUBLIC | 5.7.0 | SET|GET | state |
ON/OFF |
enable disable |
Enables PCM report file name generation by script. | Ethernet readers |
| FTP-PCM-REPORT.FILE-NAME | Communication | PUBLIC | 5.7.0 | SET|GET | string |
File name of PCM Report. | Ethernet readers | ||
| FTP-PCM-REPORT.ENABLE | Communication | PUBLIC | 5.7.0 | SET|GET | enable |
ON/OFF | Enable or disable a PCM Report FTP connection. | Ethernet readers | |
| FTP-PCM-REPORT.CUSTOM-FILE-NAME | Communication | PUBLIC | 5.7.0 | SET|GET | state |
ON/OFF |
enable disable |
Enable/disable customize file name generation (if disabled the FTP server has to generate a unique name). | Ethernet readers |
| FTP-IMAGE.USER-NAME | Communication | PUBLIC | 3.3.0 | SET|GET | string |
Username used to login to target FTP server. | Ethernet readers. DM8000 series wireless readers also support FTP if the base station is connected through Ethernet. | ||
| FTP-IMAGE.SERVER-TYPE | Communication | PUBLIC | 5.6.3 | SET|GET | type |
[0-2] |
0: Generic 1: Mitsubishi GOT 2: SFTP |
FTP image server type. 2 means that the server is an S(SH)FTP server. | DM474, DM503 and DM300 series readers. |
| FTP-IMAGE.SERVER-PATH-SCRIPT-ERROR | Communication | PUBLIC | 5.5.0 | GET | message |
script error message | Gets the script error message for FTP Storage name generation . | Fixed-mount readers. | |
| FTP-IMAGE.SERVER-PATH-SCRIPT | Communication | PUBLIC | 5.2.0 | SET|GET | num-bytes |
Set: loads the script from the host to the reader. Get: sends the script from the reader to the host. | DM474, DM503 and DM300 series readers. | ||
| FTP-IMAGE.SERVER-PATH | Communication | PUBLIC | 3.3.0 | SET|GET | string |
Path for FTP image. | Ethernet readers. DM8000 series wireless readers also support FTP if the base station is connected through Ethernet. | ||
| FTP-IMAGE.PRIORITY | Communication | PRIVATE | 5.2.0 | SET|GET | value |
[0-2] |
0: High - above decoder 1: Medium - same as running decoder 2: Low - below running decoder |
FTP thread priority. | Ethernet readers. DM8000 series wireless readers also support FTP if the base station is connected through Ethernet. |
| FTP-IMAGE.PORT | Communication | PUBLIC | 4.0.0 | SET|GET | port |
[0-65535] | FTP server port number. | Ethernet readers. DM8000 series wireless readers also support FTP if the base station is connected through Ethernet. | |
| FTP-IMAGE.PASSWORD | Communication | PUBLIC | 3.3.0 | SET | string |
Password used to login to target FTP server. | Ethernet readers. DM8000 series wireless readers also support FTP if the base station is connected through Ethernet. | ||
| FTP-IMAGE.MAX-APPEND-START-VALUE | Communication | PUBLIC | 4.0.0 | SET|GET | value |
[0-65535] | Initial increment value to append to image name. | DM503 | |
| FTP-IMAGE.MAX-APPEND | Communication | PUBLIC | 3.3.0 | SET|GET | value |
[0-65535] | Max increment value to append to image name. | Ethernet readers. DM8000 series wireless readers also support FTP if the base station is connected through Ethernet. | |
| FTP-IMAGE.IP-ADDRESS | Communication | PUBLIC | 3.3.0 | SET|GET | string |
IP address of target FTP server. Uses dotted decimal form, such as "192.168.23.42". |
Ethernet readers. DM8000 series wireless readers also support FTP if the base station is connected through Ethernet. | ||
| FTP-IMAGE.IDLE-TIME | Communication | PUBLIC | 5.5.0 | SET|GET | seconds |
Maximum duration of telling the FTP server that the reader is alive. | DM474, DM503 and DM300 series readers. | ||
| FTP-IMAGE.IDLE-LIMIT | Communication | PUBLIC | 5.5.0 | SET|GET | state |
[ON|OFF] | enable/disable | Limit duration of idle connections. | DM474, DM503 and DM300 series readers. |
| FTP-IMAGE.FILE-NAME-USE-SCRIPT | Communication | PUBLIC | 5.2.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enables FTP file name generation script. | DM474, DM503 and DM300 series readers. |
| FTP-IMAGE.FILE-NAME | Communication | PUBLIC | 3.3.0 | SET|GET | string |
File name of FTP image. | Ethernet readers. DM8000 series wireless readers also support FTP if the base station is connected through Ethernet. | ||
| FTP-IMAGE.CUSTOM-FILE-NAME | Communication | PUBLIC | 3.3.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable/disable FTP server generated file name. | Ethernet readers. DM8000 series wireless readers also support FTP if the base station is connected through Ethernet. |
| FORMAT.TOKEN | Data Formatting | PUBLIC | 3.0.0 | SET|GET | string |
token string | Data Formatting Standard Data. Regardless of the parameters given to GET FORMAT.TOKEN, it will return the current data formatting token string contained in the Standard Formatting window pointed to by the current value of GET FORMAT.PROG-TARG. See Data Formatting Token Table for available elements. See the Overview topic for formatting requirements for the string argument. |
ALL | |
| FORMAT.TEXT-END | Data Formatting | PUBLIC | 3.0.0 | SET|GET | string |
trailing text | Data Formatting Trailing Text. Requires Data Formatting Standard Mode Enabled. See the Overview topic for formatting requirements for the string argument. |
ALL | |
| FORMAT.TEXT-BEGIN | Data Formatting | PUBLIC | 3.0.0 | SET|GET | string |
leading output text | Data Formatting Leading Text. Requires Data Formatting Standard Mode Enabled. See the Overview topic for formatting requirements for the string argument. |
ALL | |
| FORMAT.STANDARD | Data Formatting | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable Data Formatting Standard Mode. Standard Mode Formatting Enables: Leading Text, Data, Data Delimeter, Terminating Text, Terminating CRLF. |
ALL |
| FORMAT.SCRIPT | Data Formatting | PUBLIC | 5.2.0 | SET|GET | num-bytes |
Set: loads the script from the host to the reader. Get: sends the script from the reader to the host. | DM474, DM503, MX-1000, MX-1502 and DM300 series readers. | ||
| FORMAT.REGEXP | Data Formatting | PUBLIC | 3.0.0 | SET|GET | string |
regular expression string | Data Formatting Regular Expression. Requires Data Formatting Advanced Mode Enabled. See the Overview topic for formatting requirements for the string argument. |
ALL | |
| FORMAT.PROG-TARG | Data Formatting | PUBLIC | 3.2.0 | SET|GET | category |
[0-5] |
0: Universal 1: DataMatrix 2: QR Code/MaxiCode/AztecCode 3: Linear/ Postal/ Stacked 4: VeriCode® 5: DotCode |
Data Formatting Programming Target. Data Formatting Symbology Set to be modified by subsequent commands. Once issued, it changes the subsequent behavior of the reader. AztecCode is only supported on the DM503 and DM300 series readers. |
ALL |
| FORMAT.MULTICODE-DELIMITER | Data Formatting | PUBLIC | 3.2.0 | SET|GET | type |
[0-6] |
0: none 1: space 2: comma 3: tab 4: label 5: xml 6: CRLF |
Data Formatting Delimiter. Sets the delimiter between codes in a multicode result. |
Fixed mount readers. |
| FORMAT.MODE | Data Formatting | PUBLIC | 4.5.0 | SET|GET | mode |
[0-1] |
0: basic formatting 1: script-based formatting |
Specifies data formatting mode. By default, basic formatting is the set formatting mode. |
DM50, DM60, DM70, DM474, DM503, MX-1000, MX-1502 and DM300 series readers. |
| FORMAT.DISCARD-UNMATCHED | Data Formatting | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Data Formatting Discard Unmatched Data. | ALL |
| FORMAT.DELIMITER | Data Formatting | PUBLIC | 3.0.0 | SET|GET | delimiter-option |
[0-5] |
0: none 1: space 2: comma 3: tab 4: label 5: xml |
Data Formatting Delimiter. Sets the delimeter between Data Formatting Tokens. Requires Data Formatting Standard Mode Enabled. |
ALL |
| FORMAT.CRLF-END | Data Formatting | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Data Formatting CRLF Terminator. Requires Data Formatting Standard Mode Enabled. |
ALL |
| FORMAT.ADVANCED | Data Formatting | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable Data Formatting Advanced Mode. Advanced Mode Formatting Enables: Regexp Pattern Substitution. |
ALL |
| FOCUS.TEMPERATURE-COMPENSATIONS | Camera | PRIVATE | 5.7.0 | SET|GET | state |
ON/OFF | Enable or disable the temperature compensation for the liquid lense HSLC. | Fixed mount readers with a Liquid Lens. | |
| FOCUS.SWEEP-STEPS | Camera | PUBLIC | 3.6.0 | SET|GET | value |
[0-8] | number of steps to divide the sweep range | Sets the number of steps the sweep range should be divided by. If steps is set to 0 only the high sweep range value is used. | DM70, DM260, DM474, DM8000 series and DM300 series readers. |
| FOCUS.SWEEP-RANGE | Camera | PUBLIC | 3.6.0 | SET|GET | DM8000 DM300 |
[0-500] [0-500] [40-500] [40-500] |
low sweep range high sweep range low sweep range high sweep range |
Defines the sweep range to be used for focusing. Low must be less than high. The low value is ignored if FOCUS.SWEEP-STEPS is set to 0. | DM70, DM260, DM300 series, DM474 and DM8000 series readers. |
| FOCUS.SWEEP-POWER | Camera | PUBLIC | 5.7.3 | SET|GET | Optical Power for near distance Optical Power for far distance |
liquid lens specific liquid lens specific |
Optical Power in Diopters Optical Power in Diopters |
Returns near (first value) and far (second value) optical power values. | Readers with Liquid Lens. |
| FOCUS.STRATEGY | Camera | PRIVATE | 4.0.0 | SET|GET | value |
??? | |||
| FOCUS.RELAX-TIME | Camera | PRIVATE | 4.0.0 | SET|GET | value |
??? | |||
| FOCUS.PROGRESS | Camera | PUBLIC | 5.7.0 | SET|GET | enable |
[ON|OFF] |
ON: focus progress on OFF: focus progress off |
Enable transfer of intermittent focus images during adjust focus. | Fixed mount readers with a liquid lens. |
| FOCUS.PRECISION | Camera | PUBLIC | 5.7.0 | SET|GET | settle mode |
[0..1] |
0: normal focus control 1: precise focus control |
Controls the liquid lens focus control between normal focus control and slow but more precise mode. | Fixed mount readers with a liquid lens. |
| FOCUS.POWER-RANGE | Camera | PRIVATE | 5.7.1 | GET | Optical Power |
[liquid lens specific] | Optical Power in Diopters | Return minimum (first value) and maximun (second value) optical power values. | Readers with Liquid Lens |
| FOCUS.POWER | Camera | PUBLIC | 5.7.0 | SET|GET | optical power |
[-6.0 .. 20.00] | Optical Power in Diopters | Conrols the optical power of the liquid lens. The actual range is dependent on the hardware and on manufacturing tolerances. | Fixed-mount readers with Liquid Lens |
| FOCUS.HALL-SENSOR | Camera | PRIVATE | 5.2.0 | GET | value |
??? | |||
| FOCUS.FOCUS-TIME | Camera | PRIVATE | 4.0.0 | SET|GET | value |
[0-3] | |||
| FOCUS.FEEDBACK | Camera | PUBLIC | 4.3.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enables focus feedback. | DM474, DM503 and DM300 series readers. |
| FOCUS.FAST-DELAY | Camera | PRIVATE | 4.0.0 | SET|GET | value |
??? | |||
| FOCUS.EXTENDED-RANGE-START | Camera | PRIVATE | 5.7.0 | SET|GET | distance |
[50..4000] | define start of extended range | Defines the start of the extended focus range. Above this distance only optical power can be used to control the Liquid Lens. | Fixed-mount readers with Liquid Lens |
| FOCUS.EXTENDED-RANGE | Camera | PUBLIC | 5.7.0 | GET | value |
[ON|OFF] | Extended Focus Range | Indicates that the reader operates in the extended focus range of ON. In this mode GET FOCUS.DISTANCE will return with an error. | Fixed-mount readers with Liquid Lens |
| FOCUS.DISTANCE | Camera | PUBLIC | 4.0.0 | SET|GET | int |
Distance in mm from the front of the camera to the part. This command returns the value only if Focus Steps is set to 0, otherwise you need to use FOCUS.SWEEP-RANGE instead. |
DM300 series readers, DM474. | ||
| FOCUS.COMPENSATE-AFTER-IDLE | Camera | PRIVATE | 5.2.0 | SET|GET | time |
[1-10000] | idle time | Compensates temperature changes after camera is idle for this time. | Liquid lens. |
| FOCUS.CALIBRATE | Action | PRIVATE | 6.0.1 | Compute C-mount flange distance for early units and store in manufacturing data. | DM47x, DM37x | ||||
| FLASH.GET | System | PRIVATE | 3.1.0 | sec number sec offset size |
|
|
Output the specified section of Flash. | ||
| FLASH.ERASE | System | PRIVATE | 3.1.0 | sec number sec offset size |
|
|
Used to reset feature key data section. Obsolete in 3.3 by FILE.UNLINK. | ||
| FLASH.AT70-INIT | Action | PRIVATE | 5.7.1 | magic |
647391673 | Magic number | This command clears AT70 Config block in flash memory. | AT70 based devices | |
| FKEY.SAVE | System | PRIVATE | 3.1.0 | Saves feature key to flash memory. | |||||
| FKEY.LOAD-NOREBOOT | System | PRIVATE | 3.1.0 | key size |
Loads encrypted feature key string to reader. Key data follows DMCC footer. | ||||
| FKEY.LOAD | System | PRIVATE | 3.1.0 | key size |
Loads encrypted feature key string to reader. Key data follows DMCC footer. Forces a reboot. | ||||
| FIRMWARE.LOAD-NOREBOOT | System | PRIVATE | 3.1.0 | file size date from location |
|
|
Loads firmware file to reader. File data follows DMCC footer. | ||
| FIRMWARE.LOAD | System | PRIVATE | 3.1.0 | file size date from location |
|
|
Loads firmware file to reader. File data follows DMCC footer. Forces a reboot. | ||
| FILTER.STACK | Decoder | PUBLIC | 4.3.0 | SET|GET | step method value1 value2 value3 |
[1-4] [0-11] [0-255] |
Filter step 0: no filtering 1: equalize 2: stretch 3: low pass 4: dilate 5: erode 6: open 7: close 8: auto stretch 9: optical density 10: invert 11: median method parameter |
The first value sets the order of the filter steps. Filter step 1 is the first step, filter step 2 is the second, and so on. The second value sets the filter to be used. The third value means the additional properties that you can set for the given filter. You cannot configure the whole stack with one statement, but each on its own.The following example: SET FILTER.STACK 2 2 0 100 0 sets the second step in the filter, for stretch from 0 to 100, leaving the third value unused (0).The following example: GET FILTER.STACK 3 (for the third filter) returns 5 4 3 meaning that filter number 5, that is, erode is on, with parameters 4, 3. | DM50, DM60, DM70, DM150, DM260, DM300 series readers, DM474. |
| FILTER.NOREAD-IMAGE | Decoder | PUBLIC | 4.3.0 | SET|GET | symbology |
[0-5] |
0: Any 1: DataMatrix 2: QR Code/MaxiCode/AztecCode 3: Linear/ Postal/ Stacked 4: VeriCode® 5: DotCode |
Sets or gets if the symbology selected should be filtered if the image is no-read. AztecCode is only supported on the DM503 and DM300 series readers. |
DM50, DM60, DM70, DM150, DM260, DM300 series readers, DM474. |
| FILTER.IMAGE-TO-USE-SYMBOL | Decoder | PUBLIC | 4.3.0 | SET|GET | symbology input |
[1-5] [0-1] |
1: DataMatrix 2: QR Code/MaxiCode/AztecCode 3: Linear/ Postal/ Stacked 4: VeriCode® 5: DotCode 0: original image 1: filtered image |
Sets or gets which type of symbology should be filtered or not. AztecCode is only supported on the DM503 and DM300 series readers. |
DM50, DM60, DM70, DM150, DM260, DM300 series readers, DM474. |
| FILE.UNLINK | System | PRIVATE | 3.3.0 | file |
Remove file from file system. | ||||
| FILE.SAVE | Action | PRIVATE | 5.7.0 | filename |
This command can be used to load file from flash, e.g. FILE.SEND "/files/vs.cfg". | ALL | |||
| FILE.LOAD | Action | PRIVATE | 4.5.0 | This command can be used to upload a file into DataMan flash filesystem. It should be specified as 'FILE.LOAD "Length" "Filename"'. This DMCC is password-protected. |
ALL | ||||
| EVENT.RULES | IO | PRIVATE | 3.4.0 | SET|GET | rules |
||||
| ETHERNET-IP.ENABLED | Communication | PUBLIC | 3.3.0_cr1 | SET|GET | state |
[ON|OFF] | enable/disable | Enabled or disabled EtherNet/IP communications. | Ethernet readers. The DM8000 series wireless readers also support this protocol if the base station is connected through Ethernet. In the case of a Bluetooth connection, the command has to be sent to the base station, not to the reader. |
| ERROR-LED.ON-TIME-MS | System | PUBLIC | 5.7.0 | SET|GET | duration |
Sets the duration for the Error LED in ms. Use 0 for unlimited duration. | All devices with an error LED. | ||
| ERROR-LED.ENABLE | Action | PRIVATE | 4.5.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enables/disables error log LED. | DM50, DM60, DM70, DM503, DM474 and DM300 series readers. |
| ERROR-LED.ENABLE | Action | PRIVATE | 4.4.0_cr1_sr1 | SET|GET | state |
[ON|OFF] | enable/disable | Enables/disables error log LED. | DM300 series readers. |
| ENCODER.RESOLUTION | IO | PUBLIC | 4.1.0 | SET|GET | int |
0-1000000 um |
Default: 5000 Min: 0 Max: 1000000 Step: 1 |
Sets the distance per pulse of the encoder. | DM474, DM503, and DM300 series readers. |
| ENCODER.RESET | IO | PUBLIC | 5.5.0 | Resets the encoder count to 0 and clears all encoder related events. | Fixed-mount readers | ||||
| ENCODER.MODE | IO | PUBLIC | 5.5.0 | SET|GET | value |
[0-4] |
0: Encoder A signal counts up, Encoder B signal counts down. 1: Encoder A signal counts up, Encoder B signal counts down. 2: Encoder A and Encoder B form quadrature (SIN/COS) signal, 1 count per cycle. 3: Encoder A and Encoder B form quadrature (SIN/COS) signal, 2 counts per cycle. 4: Encoder A and Encoder B form quadrature (SIN/COS) signal, 4 counts per cycle. |
Encoder mode. Sets the mode the encoder signals are interpreted if the Encoder Direction pin is defined. | Fixed-mount readers |
| ENCODER.FLUSH | IO | PUBLIC | 4.1.0 | Flushes all encoder actions. | DM474, DM503 and DM300 series readers. | ||||
| ENCODER.DOUBLE-RATE | IO | PUBLIC | 5.7.0 | SET|GET | boolean |
[ON|OFF] | Edge detection | If set to ON, Encoder will count both edges on the Encoder Input line. If set to OFF, Encoder will count only the selected edge. | DM503 |
| ENCODER.DOUBLE-RATE | IO | PUBLIC | 6.1.6 | SET|GET | boolean |
[ON|OFF] | Edge detection | If set to ON, Encoder will count both edges on the Encoder Input line. If set to OFF, Encoder will count only the selected edge. | DM360, DM370, and DM470 series readers. |
| ENCODER.DISTANCE-TO-OUTPUT | IO | PUBLIC | 4.1.0 | SET|GET | int |
0-1000000 mm |
Default: 0 Min: 0 Max: 1000000 Step: 1 |
Sets the output distance from the trigger on the sensor. | DM300 series readers, DM474. |
| ENCODER.COUNT | IO | PUBLIC | 4.1.0 | SET|GET | value |
[0-2 billion] | value to set | Gets the encoder count or sets it to the specified value. | Fixed-mount readers |
| EAN-UCC.XMTMODE | Symbology | PUBLIC | 3.0.0 | SET|GET | mode |
[0-1] |
0: Standard (linear & 2D) 1: Linear only |
EAN-UCC Transmit mode. | ALL |
| EAN-UCC.CC-C | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable or disable Composite Code C. | ALL |
| DVALID.TYPE | Data Validation | PUBLIC | 3.0.0 | SET|GET | type |
[0-5] |
0: None 1: DoD UID 2: ISO 3: Pattern 4: Match String 5: GS1 |
ALL | |
| DVALID.PROG-TARG | Data Validation | PUBLIC | 4.4.0 | SET|GET | category |
[1-5] |
1: DataMatrix 2: QR Code/MaxiCode/AztecCode 3: Linear/ Postal/ Stacked 4: VeriCode® 5: DotCode |
Data Validation Programming Target. Data Validation Symbology Set to be modified by subsequent commands. Once issued, this command changes the subsequent behavior of the reader. |
ALL |
| DVALID.PATTERN | Data Validation | PUBLIC | 3.0.0 | SET|GET | string |
pattern-string | Data Validation Pattern. Regexp Data Validation. See the Overview topic for formatting requirements for the string argument. |
ALL | |
| DVALID.MATCH-STRING-PARAMS | Data Validation | PUBLIC | 3.0.0 | SET|GET | increment start length step no-read validation-fail |
[ON|OFF]
[0-*] [1-*] [-2|-1|0|1|2] [ON|OFF] [ON|OFF] |
enable/disable
start position of numerical match number of digits increment enable/disable update on no-read enable/disable update on validation failure |
Data Validation Match-String Parameters. | ALL |
| DVALID.MATCH-STRING-EMPTY-RESULT | Data Validation | PRIVATE | 4.4.0 | SET|GET | action |
[0-1] |
0: empty match string fails 1: empty match string passes |
Gets or sets if a match string validation attempt with an empty match string should fail (0=default) or pass (1). | ALL |
| DVALID.MATCH-STRING | Data Validation | PUBLIC | 3.0.0 | SET|GET | string |
match-string | Data Validation Match-String. See the Overview topic for formatting requirements for the string argument. |
ALL | |
| DVALID.ISO-CONSTRUCT | Data Validation | PUBLIC | 3.0.0 | SET|GET | construct |
[0-1] |
0: ISO 15434 1: ISO 15434 & ISO 15418 |
ISO Construct. | ALL |
| DVALID.GS1-FORMAT | Data Validation | PUBLIC | 3.4.0 | SET|GET | string |
GS1 format string | Set GS1 format string. | ALL | |
| DVALID.FAIL-XMT-CRLF | Data Validation | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Data Validation Transimit CRLF on Failure. | ALL |
| DVALID.FAIL-ACTION | Data Validation | PUBLIC | 3.0.0 | SET|GET | action |
[0-3] |
0: Transmit "Validation Failure" 1: Transmit "Validation Failure" + decoded string 2: Transmit annotated decode string 3: Transmit nothing |
Data Validation Failure Action. | ALL |
| DVALID.DODCNSTRT | Data Validation | PUBLIC | 3.0.0 | SET|GET | construct |
[0-3] |
0: Any 1: Construct #1 2: Construct #2 3: Equivalent |
Data Validation DoD Construct. | ALL |
| DVALID.DOD-EXPN | Data Validation | PUBLIC | 3.0.0 | SET|GET | string |
expected-PN | DoD Expected Part Number. See the Overview topic for formatting requirements for the string argument. |
ALL | |
| DVALID.DOD-EXEID | Data Validation | PUBLIC | 3.0.0 | SET|GET | string |
expected-EID | DoD Expected Enterprise ID (EID). | ALL | |
| DOTCODE.QUALITY-METRICS | Decoder | PRIVATE | 5.5.0 | SET|GET | mode |
[0-1] |
0: none 1: enable AIM metrics |
Enable Subset of Quality Metrics from DotCode AIM Specification. | DM474, DM503, DM300 series readers, DM8050X and DM8600. |
| DOTCODE.POLARITY | Decoder | PUBLIC | 5.4.0 | SET|GET | int |
[0-2] |
0: Dark on Light 1: Light on Dark 2: Either |
DM300 series readers, DM474, DM8050X and DM8600. | |
| DOTCODE.MINIMUM-ROWS | Decoder | PUBLIC | 5.4.0 | SET|GET | int |
[5-128] |
The default is 6. |
DM300 series readers, DM474, DM8050X and DM8600. | |
| DOTCODE.MINIMUM-COLUMNS | Decoder | PUBLIC | 5.4.0 | SET|GET | int |
[11-128] | The default is 16. | DM300 series readers, DM474, DM8050X and DM8600. | |
| DOTCODE.MAXIMUM-ROWS | Decoder | PUBLIC | 5.4.0 | SET|GET | int |
[5-128] | The default is 32. | DM300 series readers, DM474, DM8050X and DM8600. | |
| DOTCODE.MAXIMUM-COLUMNS | Decoder | PUBLIC | 5.4.0 | SET|GET | int |
[11-128] | The default is 128. | DM300 series readers, DM474, DM8050X and DM8600. | |
| DMSTATS | System | PRIVATE | 3.1.0 | vtree path |
Returns argument range for value tree parameter. e.g. ||>DMSTATS /ROI/Left |
||||
| DMPUSH.INFO | System | PRIVATE | 3.1.0 | SET | vtree path |
Sets Device Info value tree parameter. DMCC Key is required. | |||
| DMPUSH | System | PRIVATE | 3.0.0 | SET | vtree path |
Sets value tree parameter. | |||
| DMPOP.INFO | System | PRIVATE | 3.1.0 | GET | vtree path |
Gets Device Info value tree parameter. | |||
| DMPOP | System | PRIVATE | 3.0.0 | GET | vtree path |
Gets value tree parameter. | |||
| DMCC.SAVE | Action | PUBLIC | 4.4.0 | Saves DMCC connection settings. It also saves the status for a new connection session for the following DMCC: COM.DMCC-RESPONSE, COM.DMCC-CHECKSUM, COM.DMCC-HEADER, DATA.RESULT-TYPE, DATA.RESULT-ENCODING, DATA.RESULT-ALWAYSSEND, DATA.IMAGE-TYPE. | ALL | ||||
| DMCC.RESET | Action | PUBLIC | 4.4.0 | When sent, the DMCC resets the following DMCC back to default: COM.DMCC-RESPONSE, COM.DMCC-CHECKSUM, COM.DMCC-HEADER, DATA.RESULT-TYPE, DATA.RESULT-ENCODING, DATA.RESULT-ALWAYSSEND, DATA.IMAGE-TYPE. | ALL | ||||
| DEVICE.TYPE | System | PUBLIC | 3.0.0 | GET | Device Type. | ALL | |||
| DEVICE.TIMEZONE | Action | PUBLIC | 5.7.0 | SET|GET | timezone |
Location or POSIX timezone | Get or set the timezone for local time. | All | |
| DEVICE.SYSLOG-IP | Communication | PRIVATE | 5.0.0 | SET|GET | string |
Specifies the remote syslog server IP address. | |||
| DEVICE.SUBCLASS | System | PRIVATE | 5.4.0 | GET | string |
Activates the relevant device subclasses. | |||
| DEVICE.STATS | Action | PRIVATE | 5.2.0 | GET | Get decode statistics. | All. | |||
| DEVICE.START-VER | System | PRIVATE | 3.0.0 | ||||||
| DEVICE.SSID | Communication | PUBLIC | 4.2.0 | SET|GET | string |
Network name. | Wireless readers. | ||
| DEVICE.SHIPPEDAS-VER | System | PRIVATE | 3.0.0 | GET | |||||
| DEVICE.SERIAL-NUMBER | System | PUBLIC | 3.0.0 | GET | Device Serial Number. | ALL | |||
| DEVICE.SCRIPT-HEAP-USAGE-MAX | Communication | PRIVATE | 5.5.0 | GET | size |
Maximum used heap size | The maximum size of heap the script allocated allocated. | Fixed mount readers | |
| DEVICE.SCRIPT-HEAP-USAGE-CURRENT | Communication | PRIVATE | 5.5.0 | GET | size |
Currently used heap size | The size of heap the script currently allocates. | Fixed mount readers | |
| DEVICE.SCRIPT-HEAP-SIZE-LIMIT | Communication | PRIVATE | 5.5.0 | SET|GET | size |
204800-2147483647 | Maximum size in bytes | Maximum heap size the script engine may allocate. | Fixed mount readers |
| DEVICE.SAVE | System | PRIVATE | 3.0.0 | ||||||
| DEVICE.RESTORE | Action | PUBLIC | 3.3.0 | file size |
Transmits backup file (.cdc) to the reader. File size is in bytes. File data follows footer. | ALL | |||
| DEVICE.NAME | System | PUBLIC | 3.0.0 | SET|GET | string |
Device Name. MX + the last six digits of DEVICE.SERIAL-NUMBER | ALL | ||
| DEVICE.MAC-ADDRESS | Communication | PUBLIC | 3.3.0 | GET | Reader's MAC address. | Ethernet readers. | |||
| DEVICE.LOG | Action | PUBLIC | 4.4.0 | GET | Get the device log of error and exception conditions such as missed triggers and trigger overruns. | DM50, DM60, DM70, DM474, DM503, DM300 series readers, DM8050 and DM8600. | |||
| DEVICE.LENS-TYPE | Camera | PRIVATE | 5.0.0 | GET | type |
This command gives you the lens type when a liquid lens is installed. | ALL | ||
| DEVICE.ID | Camera | PRIVATE | 5.4.0 | GET | string |
Returns the device id. | ALL | ||
| DEVICE.FLASH | PRIVATE | 3.0.0 | begin numbytes |
||||||
| DEVICE.FIRMWARE-VER | System | PUBLIC | 3.0.0 | GET | Device Firmware Version. | ALL | |||
| DEVICE.FEATURE-KEYS | System | PUBLIC | 3.0.0 | GET | Device Feature Keys. | ALL | |||
| DEVICE.FAILSAFE-VER | System | PRIVATE | 5.4.0 | GET | Returns the Failsafe version. | ||||
| DEVICE.DESCRIPTION | System | PUBLIC | 5.7.0 | SET|GET | state |
[0-127] | description | Store device description for inventory management. | ALL |
| DEVICE.DEFAULT-MFG | Action | PRIVATE | 5.4.0 | Resets all device settings to Cognex defaults. This command reboots the device. | DM8050, DM8600. | ||||
| DEVICE.DEFAULT | Action | PUBLIC | 3.0.0 | Resets all device settings to factory defaults. This command reboots the device. | ALL | ||||
| DEVICE.CGNM-DEV-TYPE | System | PRIVATE | 5.5.1 | GET | Returns the CogNamer device type. | ALL | |||
| DEVICE.BOOT-VER | System | PRIVATE | 3.0.0 | ||||||
| DEVICE.BACKUP | Action | PUBLIC | 3.3.0 | Send encrypted backup file (.cdc) to the PC. | ALL | ||||
| DEVICE.APPLOADER-VER | System | PRIVATE | 5.4.0 | GET | Returns the Apploader version. | ||||
| DEVICE-LOG.CLEAR | Action | PUBLIC | 5.2.0 | This command clears the device log. | DM50, DM60, DM70, DM474, DM503, DM300 series readers, DM8050, DM8600, MX-1000 and MX-1502. | ||||
| DECODER.USE-CENTERING | Decoder | PUBLIC | 6.0.0 | SET|GET | state |
[ON|OFF] | Enable/Disable | Only reads codes within the centering window. | DM50, DM60, DM70, DM150, DM260, DM300, DM360, DM474, MX-1000 series |
| DECODER.TIMEOUT | Decoder | PUBLIC | 3.0.0 | SET|GET | ms |
[0-10000] | milliseconds | Decoder Timeout. Maximum allowed decode time. |
Fixed mount readers. |
| DECODER.TARGET-DECODING | Decoder | PUBLIC | 5.7.1 | SET|GET | state |
[ON|OFF] | enable/disable | Enable target decoding, where the reader attempts to symbols that lie only under the aiming dots. | MX-1000, MX-1502 series readers. |
| DECODER.ROI | Decoder | PUBLIC | 3.0.0 | SET|GET | left (multiple of 8) right (multiple of 8) top (multiple of 4) bottom (multiple of 4) |
[0...] [left+64...] [0...] [top+64...] |
left of the ROI rectangle right of the ROI rectangle top of the ROI rectangle bottom of the ROI rectangle |
Decoder Region of Interest. Image Region examined by decoder for enabled symbols. Pixel coordinates are relative to the upper left corner of the displayed image. Left < Right and Top < Bottom. Values must not be outside the specified CAMERA.FOV settings. |
ALL |
| DECODER.REREAD-TIME | Decoder | PUBLIC | 4.4.0 | SET|GET | ms |
[0-10000] | Milliseconds | Code re-reading delay in milliseconds. | ALL |
| DECODER.REREAD-NOT-LAST-N | Decoder | PUBLIC | 5.5 SR3 | SET|GET | int |
[0-100] |
0: no restriction 1-100 Define N |
Do not read code if this code was read within the last N reads. | All |
| DECODER.REREAD-NEVER2X | Decoder | PUBLIC | 5.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Never read the same code twice. All trigger modes, e.g. Multicode Reading. |
ALL |
| DECODER.REREAD-MODE | Decoder | PUBLIC | 4.4.0 | SET|GET | mode |
[0-1] |
0: last read 1: first read |
Code re-reading delay relative to either the first read or the last. | DM50, DM60, DM70, DM474, DM503, DM300 series readers, DM8050 and DM8600. |
| DECODER.PREPROCESS | Decoder | PRIVATE | 3.4.0 | SET|GET | slot filter param1 param2 param3 |
[0] [0-2] [0-255] [0-255] [0-255] |
slot to configure 0: none 1: Equalize 2: Stretch Filter parameter 1. Filter parameter 2. Filter parameter 2. |
Sets or gets the filter to apply to an image before decoding. | |
| DECODER.NO-READ-FEEDBACK | Decoder | PRIVATE | 5.5.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enables/disables found but not decoded symbol info. | ALL |
| DECODER.MAC-SCAN-TIMEOUT | Decoder | PUBLIC | 5.7.1 | SET|GET | int |
[0-60] | DM50, DM60, DM70, DM150 DM260, DM300, DM360, DM474, MX-1000, MX1502 | ||
| DECODER.EFFORT | Decoder | PUBLIC | 5.7.1 | SET|GET | int |
[0-5] | Sets the effort level used by the decoding algorithms. Default is 2. | All | |
| DECODER.DISPLAY-TARGET | Decoder | PUBLIC | 6.0.0 | SET|GET | state |
[ON|OFF] | Enable/Disable | Displays centering window graphics. | DM50, DM60, DM70, DM150 DM260, DM300, DM360, DM474, MX-1000 series |
| DECODER.CENTERING-WINDOW | Decoder | PUBLIC | 6.0.0 | SET|GET | center x perc, center y perc, size x perc, size y perc |
[0-100] | Percentage | Location and size of centering window as a percentage of the sensor size. | DM50, DM60, DM70, DM150 DM260, DM300, DM360, DM474, MX-1000 series |
| DECODER.ALLOW-ALL-MST-RESULTS | Decoder | PUBLIC | 5.7.3 | SET|GET | state |
[ON|OFF] |
ON: enable OFF: disable |
Enables or disables re-read delay processing for slave results. | DM300 series readers, DM474, DM503, DM70, DM150, DM260 |
| DECODER.1D-USAGE | Decoder | PRIVATE | 3.0.0 | SET|GET | usage-type |
[0-1] |
0: Standard 0: Extended |
1D Symbology Usage Type. | |
| DECODER.1D-USAGE | Decoder | PUBLIC | 3.0.0 | SET|GET | usage |
[0-1] |
0: Standard 1: Extended |
1D Symbology Usage Type. | Fixed mount readers. |
| DECODER.1D-TARGET | Decoder | PRIVATE | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Target Decoding. | MX-1000 and DM8000 series readers. |
| DECODER.1D-SYMBOL-ORIENTATION | Decoder | PUBLIC | 4.1 | SET|GET | orientation |
[0-3] |
0: Omnidirectional 1: Ladder and Picket Fence (default) 2: Ladder 3: Picket Fence |
Sets or gets the orientation at which codes can be found. Omnidirectional requires the Omnidirectional feature key. | DM50, DM60, DM70, DM474, DM503, MX-1000, MX-1502 and DM300 series readers. DM503L readers support only 2: Ladder and 3: Picket Fence. |
| DECODER.1D-SHORT-QUIET-ZONE | Decoder | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | When ON, the reader is tolerant with non-standard (i.e. short) quiet zones. | ALL |
| DECODER.1D-SHORT-HEIGHT-CODES | Decoder | PRIVATE | 6.0.0 | SET|GET | state |
[ON|OFF] |
ON: Enable OFF: Disable |
Enable or disable Short Height Codes. | Ethernet readers |
| DECODER.1D-QUALITY-METRICS | Decoder | PUBLIC | 5.2.0 | SET|GET | mode |
[0-1] |
0: none 1: 1D readability |
Enables/disables 1D Process Control Metrics. | ALL |
| DECODER.1D-PICKETFENCE-BARCODE-ONLY | System | PRIVATE | 5.4.0 | GET | |||||
| DECODER.1D-MINIMUM-DECODES | Symbology | PUBLIC | 5.2.0 | SET|GET | int |
[0-5] | Minimum number of decoded scans to report a confident decoding (to prevent misread). | ALL | |
| DECODER.1D-LEARN-ORIENT | Decoder | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Learn Orientation of 1D Symbols. | Fixed mount readers. |
| DECODER.1D-LEARN-CODESIZE | Decoder | PRIVATE | 3.2.0_cr5 | SET|GET | state |
[ON|OFF] | enable/disable | Learn the code size of 1D Symbols. | ALL |
| DECODER.1D-EXTENDED-RESOLUTION | Decoder | PUBLIC | 5.5.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enables/disables the 1D extended resolution decoding method. Requires the 1DExtendedRes feature key. |
DM70, DM150, DM260, DM300 series readers, DM474, DM503. |
| DECODER.1D-DECODE-STRICTNESS | Decoder | PRIVATE | 6.1.6 | SET|GET |
|
[0-2] |
0 = Conservative 1 = Moderate 2 = Tolerant |
Selects which 1D decoding strictness mode to use. The default is 1 ("Moderate"). With setting 0 ("Conservative"), misreads are reduced, with 2 ("Tolerant"), no-reads are reduced. With setting 1 ("Moderate") this is balanced. | ALL |
| DECODER.1D-DATA-STITCH | Decoder | PUBLIC | 5.5.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enables/disables 1D data-stitching. Requires the 1DDataStitching feature key. |
DM70, DM150, DM260, DM300 series readers, DM474, DM503. |
| DEBUG.LOG | System | PRIVATE | 5.4.0 | GET | Gets the debug log in development builds, returns nothing for released firmware. | ALL | |||
| DATAMATRIX.USAGE | Symbology | PUBLIC | 3.0.0 | SET|GET | Usage Type |
[0-1] |
0: Default 1: High speed ink jet mode |
IDMax Usage Type. | ALL except for DM50, DM60, DM70, DM300, DM503. |
| DATAMATRIX.TYPE | Decoder | PRIVATE | 6.1.6 | SET|GET |
|
[1-3] |
1 = DataMatrix only 2 = DMRE 3 = Both |
Set support level for DataMatrix and/or DataMatrix Rectangular Extensions. | ALL |
| DATAMATRIX.TRAINED-MODEL | Decoder | PUBLIC | 5.5.0 | SET|GET | rows columns module-size polarity mirrored |
[8-144] [8-144] [1-1000] [0-2] [ON|OFF] |
Number of rows Number of columns Module size * 10 0: dark-on-light 1: light-on-dark 2: either ON: mirrored OFF: not mirrored |
Train Data Matrix from the given parameters without needing to capture an image. | Fixed-mount readers |
| DATAMATRIX.TRAINED-IGNORE-POLARITY | Symbology | PUBLIC | 5.2.0 | SET|GET | state |
[ON|OFF] | enable/disable | Switches the Trained Code Property "Ignore Polarity". | DM300, DM474, DM503. |
| DATAMATRIX.TRAINED-FLEX-GRID | Symbology | PUBLIC | 5.2.0 | SET|GET | state |
[ON|OFF] | enable/disable | Switches the Trained Code Property "Flexible Grid Size". | DM300, DM474, DM503. |
| DATAMATRIX.SYMBOL-DIFFICULTY | Symbology | PUBLIC | 5.1.0 | SET|GET | int |
[0-2] |
0: Easy 1: Medium 2: Hard |
Level of DataMatrix code symbol difficulty. | DM8600. |
| DATAMATRIX.SECURITY-TYPE | Symbology | PRIVATE | 3.2.0 | SET|GET | type state |
[0-1] [ON|OFF] |
0: None 1: Custom1 enable/disable |
Data Matrix security type used. Only valid with a valid security key is set. | ALL |
| DATAMATRIX.SECURITY-KEY | Symbology | PRIVATE | 3.2.0 | SET | type name |
1 |
1: Custom1 |
Sets the secure Data Matrix key which is 32 byte string. This string needs to be entered in hexadecimal format. | |
| DATAMATRIX.SCALE-UNCERTAINTY-PERCENTAGE | Decoder | PRIVATE | 6.0.1 | SET | percentage |
Specifies Scale Uncertainty Percentage. It is a parameter that allows or limits the tuned DataMatrix decoder to examine code that has a PPM different than the originally tuned code. The percentage should be (PPM1-PPM2)/PPM1 * 100. Used when IDQuick decoder is enabled. | ALL | ||
| DATAMATRIX.QUALITY-METRICS | Decoder | PUBLIC | 4.5.0 | SET|GET | type |
[0-3] |
0: none 1: AIM DPM 2: ISO 15415 3: SEMI T10 |
Code quality metrics for DataMatrix. | ALL |
| DATAMATRIX.PRINT-DEFORMATION | Symbology | PUBLIC | 5.2.0 | SET|GET | state |
[0|1] |
0: Minimal 1: Moderate |
Sets the IDMax Properties. | DM300, DM474, DM503. |
| DATAMATRIX.IDMAX-SCALE-UNCERTAINTY-PERCENTAGE | Decoder | PRIVATE | 6.0.1 | SET | percentage |
Specifies Scale Uncertainty Percentage. It is a parameter that allows or limits the tuned DataMatrix decoder to examine code that has different PPM than the originally tuned code. The percentage should be PPM1-PPM2)/PPM1 * 100. Active when IDMax is enabled. | ALL | ||
| DATAMATRIX.EXTREME-PRINT-GROWTH | Symbology | PUBLIC | 3.4.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable extreme print growth for DataMatrix symbols. | ALL except for DM50, DM60, DM70, DM300, DM503, DM8050 and DM8600. |
| DATAMATRIX.DAMAGE | Decoder | PUBLIC | 5.5.0 | SET|GET | damage level |
[2,4] |
2: moderate 4: extreme |
Set Extreme to enable PowerGrid. | DM300 series readers, DM360, DM474 readers |
| DATAMATRIX.ALGORITHM-VERSION | Symbology | PUBLIC | 3.5.3 | SET|GET | version |
[0-2] |
0: speed preferred 1: yield preferred 2: extended |
IDQuick Usage Type. | Fixed mount readers except for DM300L, DM503L, and DM503QL. 2 (extended) is supported by DM50, DM60, DM70, DM150, DM260. |
| DATABAR.LIMITED | Symbology | PUBLIC | 3.4.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable Databar limited. | ALL |
| DATABAR.GROUP | Symbology | PUBLIC | 3.4.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable Databar group. | ALL |
| DATABAR.EXPANDED | Symbology | PUBLIC | 3.4.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable Databar expanded. | ALL |
| DATA.RESULT-TYPE | System | PRIVATE | 3.1.0 | SET|GET | bit-field |
[0-128] |
0x00 = None 0x01 = Result 0x02 = XML formated result 0x04 = XML formated statistics 0x08 = Image Data 0x10 = Image Graphics 0x20 = Traning Result 0x40 = Code Quality Graphics |
Controls automatic result transmitted from reader. Default is 1. | ALL |
| DATA.RESULT-TYPE | System | PUBLIC | 5.5.0 | SET|GET | bit-field |
[0,1,512] |
0 = None 1 = Result 512 = MS test response |
Controls automatic, result transmitted from reader. Default bits are 1 and 512 (which is 513). | ALL |
| DATA.RESULT-TYPE | System | PRIVATE | 5.0.0_cr10 | SET|GET | bit-field |
[0-511] |
0x00 = None 0x01 = Result 0x100 = Input event message |
Controls automatic result transmitted from reader. Default is 1. | ALL |
| DATA.RESULT-ENCODING | Communication | PUBLIC | 3.1.0 | SET|GET | encoding |
[0|1] |
0: ASCII (default) 1: Base64 |
Result string encoding. | ALL |
| DATA.RESULT-ALWAYSSEND | System | PRIVATE | 3.1.0 | SET|GET | state |
[ON|OFF] | enable/disable | Sets gets whether to always send result. | ALL |
| DATA.IMAGE-TYPE | Communication | PRIVATE | 3.4.0 | SET|GET | type |
[0-2] |
0: all 1: no read 2: read |
Sets or gets type of image automatically returned. Used in conjuction with DATA.RESULT-TYPE. | |
| CUSTOM-CMD.TRIGGER-ON | Communication | PUBLIC | 3.2.0 | SET|GET | string |
String that will start a trigger. See the Overview topic for formatting requirements for the string argument. |
Fixed mount readers. | ||
| CUSTOM-CMD.TRIGGER-OFF | Communication | PUBLIC | 3.2.0 | SET|GET | string |
String that will stop a trigger. See the Overview topic for formatting requirements for the string argument. |
Fixed mount readers. | ||
| CUSTOM-CMD.TRIGGER | Communication | PUBLIC | 3.2.0 | SET|GET | state |
[ON|OFF] | enable/disable | Indicates if reader will respond to the TRIGGER-ON or TRIGGER-OFF string. | Fixed mount readers. |
| CUSTOM-CMD.ECHO | Communication | PUBLIC | 3.2.0 | SET|GET | state |
[ON|OFF] | enable/disable | Indicates if characters received between a COMMAND-HEADER and COMMAND-FOOTER are echoed. | Fixed mount readers. |
| CUSTOM-CMD.COMMAND-HEADER | Communication | PUBLIC | 3.2.0 | SET|GET | string |
Start of the string to be echoed. | Fixed mount readers. | ||
| CUSTOM-CMD.COMMAND-FOOTER | Communication | PUBLIC | 3.2.0 | SET|GET | string |
End of the string to be echoed. See the Overview topic for formatting requirements for the string argument. |
Fixed mount readers. | ||
| CQ.UNITS | Code Quality | PUBLIC | 3.0.0 | SET|GET | option |
[0-3] |
0: mils 1: mm 2: inches 3: pixels |
Code Quality Units. | DM8600V |
| CQ.RESET-CALIBRATION | Code Quality | PUBLIC | 3.3.0 | Invalidates code quality calibration data. Reboot is required. |
DM8600V | ||||
| CQ.PROCESSM | Code Quality | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Code Quality Process Control Metrics. | DM8600V |
| CQ.MINPASS | Code Quality | PUBLIC | 3.0.0 | SET|GET | metric min-pass |
[0-1] [0-4] |
0: AIM-DPM/ISO/IEC TR 29158 1: ISO/IEC 15415 0: F 1: D 2: C 3: B 4: A |
Code Quality Minimum Passing Grade. Determines the threshold for "validation failure action" including beep and configured line output. |
DM8600V |
| CQ.METRICS | Code Quality | PUBLIC | 3.0.0 | SET|GET | metric |
[0-3] |
0: AIM-DPM/ISO/IEC TR 29158 1: ISO/IEC 15415 2: AS9132 Laser-etch 3: AS9132 Dot-peen |
Code Quality Enabled Metrics. | DM8600V |
| CQ.ILLUMINATION | Code Quality | PUBLIC | 3.0.0 | SET|GET | illumination-option state |
[0-4] [ON|OFF] |
0: Direct on axis 1: 30-deg All Quadrants 2: 30-deg E-W Quadrants 3: 30-deg N-S Quadrants 4: Custom enable/disable |
Code Quality Illumination Option. | DM8600V |
| CQ.CALIB-DATE | Code Quality | PUBLIC | 3.0.0 | GET | Device Code Quality Calibration Date. | DM8600V | |||
| CQ | Code Quality | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable Code Quality. Code Quality Measurements require reader calibration and the Verification Feature Key. |
DM8600V |
| CPFLASH.WRITE | Camera | PRIVATE | 5.0.0 | id |
[0-4] |
0: Unknown 1: Prototype 2: Alpha build with SRAM 3: Alpha build with SDRAM 4: Beta build |
Flash camera port ID. | DM 503. | |
| CONTROL.RPC | Action | PRIVATE | 4.2.0 | SET|GET | string |
RP code to execute. | Executes RP codes passed as string. Used internally to route RP commands to the base station. | ALL | |
| CONFIG.SEND | Action | PUBLIC | 3.0.0 | Send device configuration to communication channel. | ALL | ||||
| CONFIG.SAVE-DEFAULTS | Action | PRIVATE | 5.4.0 | Saves current settings as defaults. This command does not reboot the device. | ALL | ||||
| CONFIG.SAVE | Action | PUBLIC | 3.0.0 | Saves Configuration to Non-Volatile Memory. | ALL | ||||
| CONFIG.RESTORE | Action | PUBLIC | 3.0.0 | Restores Configuration from Non-Volatile Memory. | ALL | ||||
| CONFIG.LOAD | Action | PUBLIC | 4.4.0 | num-bytes |
Load Configuration from communication channel. Make sure you use a robust communications channel (for example, Ethernet) because this command does not have error checking or retry support and might cause the device to hang. | ALL | |||
| CONFIG.EXPORT | Action | PUBLIC | 5.7.0 | Exports a human readable version of the current reader configuration. | ALL | ||||
| CONFIG.DUMP-UIDS | Action | PRIVATE | 3.0.0 | Returns all value tree parameters. | ALL | ||||
| CONFIG.DEFAULT | Action | PUBLIC | 3.0.0 | Resets the device’s configuration settings to factory defaults. Device identification and communications settings are not changed. | ALL | ||||
| CONFIG-BACKUP.USER-NAME | Action | PUBLIC | 5.0.0 | SET|GET | string |
User name used to log in to the Cognex Explorer FTP service. | Ethernet readers. DM8000 series wireless readers also support FTP if the base station is connected through Ethernet. | ||
| CONFIG-BACKUP.SERVER-TYPE | Communication | PUBLIC | 5.5.0 | SET|GET | type |
[0-1] |
0: Generic 1: Mitsubishi GOT |
Configuration backup server type. | DM474, DM503 and DM300 series readers. |
| CONFIG-BACKUP.PORT | Action | PUBLIC | 5.0.0 | SET|GET | port |
[0-65535] | Port number of the Cognex Explorer FTP service. | Ethernet readers. DM8000 series wireless readers also support FTP if the base station is connected through Ethernet. | |
| CONFIG-BACKUP.PASSWORD | Action | PUBLIC | 5.0.0 | SET|GET | string |
Password used to log in to Cognex Explorer FTP service. | Ethernet readers. DM8000 series wireless readers also support FTP if the base station is connected through Ethernet. | ||
| CONFIG-BACKUP.IP-ADDRESS | Action | PUBLIC | 5.0.0 | SET|GET | string |
IP address of the Cognex Explorer FTP service. Uses dotted decimal form, such as "192.168.23.42". |
Ethernet readers. DM8000 series wireless readers also support FTP if the base station is connected through Ethernet. | ||
| CONFIG-BACKUP.ENABLE | Action | PUBLIC | 5.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enables automatic device configuration backup. | Ethernet readers. DM8000 series wireless readers also support FTP if the base station is connected through Ethernet. |
| COM.XLATEPRNT | Communication | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Translate unprintable characters that are embedded in a symbol. The translated result is output over the connection (for example, COM, USB, Ethernet, USB-KEYBOARD). Note that Data Formatting leading and terminating text are not translated. The characters translated are ASCII values between 0x00 and 0x1F. For example, 0x00 = <NUL>, 0x04 = <EOT>, 0x0a = <LF>, 0x0d = <CR>. | ALL |
| COM.WAKEUP | Communication | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Wakeup Message. | ALL |
| COM.USB-USE-TEST-SN | Communication | PRIVATE | 4.2.0 | SET|GET | state |
[ON|OFF] [ON|OFF] | enable/disable | Used by manufacturing to make different devices enumerate on the same CDC COM port. | Base station, DM50, DM60 and DM70. |
| COM.USB-TEST-SN | Communication | PRIVATE | 4.2.0 | SET|GET | string |
test serial number | Used by manufacturing to make different devices enumerate on the same CDC COM port. | Base station, DM50, DM60 and DM70. | |
| COM.USB-SPEED | Communication | PUBLIC | 4.2.1 | SET|GET | int |
[ON|OFF] |
ON: USB 1.1 mode OFF: USB 2.0 mode |
Forces the USB into full speed mode. | Every reader connected through USB except MX-1000. |
| COM.USB-REQUIRE-DTR | Communication | PUBLIC | 5.5.0 | SET|GET | state |
[ON|OFF] [ON|OFF] | enable/disable Enable/Disable | Turns the requirement to assert DTR signal during USB communication On or Off. | DM8050 |
| COM.USB-RE-ENUMERATE-ON-START | Communication | PUBLIC | 5.5 | SET|GET | state |
[ON|OFF]
[ON|OFF] |
enable/disable
ON: USB 1.1 mode OFF: USB 2.0 mode |
Feature to re-enumerate the COM port after firmware is started. | DM8000 series readers. |
| COM.USB-MODE | Communication | PUBLIC | 4.2.1 | SET|GET | type |
[0-1] |
0: USB COM 1: USB HID |
Controls USB based communication channels. | DM50, DM60, DM70, MX-1000, MX-1502 and DM8000 series readers. |
| COM.USB-HID-ONLY | Communication | PUBLIC | 5.4.0 | SET|GET | state |
[ON|OFF] | enable/disable | When enabled, the base station will appear as a single USB Keyboard device on its USB port, instead of a composite device. | DM8000 base station G2 |
| COM.USB-COMPATIBILITY-MODE | Communication | PUBLIC | 3.0.0 | SET|GET | legacy |
[ON|OFF] |
ON: use pre-3.5.0 driver OFF: default |
Controls USB driver. Reboot is required. |
DM50, DM70 and DM8000 series readers. |
| COM.STOP-BITS | Communication | PUBLIC | 3.0.0 | SET|GET | bits |
[1-2] | ALL except for MX-1000. | ||
| COM.SCRIPT-ERROR | Communication | PUBLIC | 5.5.0 | GET | message |
script error message | Get the error message for the Custom Communication protocol script | Fixed-mount readers. | |
| COM.SCRIPT-ENABLED | Communication | PRIVATE | 5.3.0 | SET|GET | bool |
DM474, DM503 and DM300 series readers. | |||
| COM.SCRIPT-ENABLED | Communication | PUBLIC | 5.5.0 | SET|GET | bool |
Enables/disables communication scripting or retrieves current state. | Fixed-mount readers. | ||
| COM.SCRIPT | Communication | PRIVATE | 5.3.0 | SET|GET | num-bytes |
Load script from communication channel. | DM474, DM503 and DM300 series readers. | ||
| COM.SCRIPT | Communication | PUBLIC | 5.5.0 | SET|GET | num-bytes |
GET: Retrieves the current communication script. SET: Uploads a communication script. | Fixed-mount readers. | ||
| COM.RS232-ROUTE | Communication | PUBLIC | 4.2.1 | SET|GET | value |
[0-1] |
0: base station 1: associated reader |
Controls to which device RS-232 communication is routed. | DM8000 series wireless readers. |
| COM.RS232-INTERCHAR-DELAY | Communication | PUBLIC | 5.5.0 | SET|GET | us |
[0-5000] | milliseconds | Sets or gets the internal delay between sending characters to the serial port. | DM300 series readers, DM60, DM50, DM70, DM360 series readers, DM474, DM503 |
| COM.RS232-FILTER-CHAR | Communication | PRIVATE | 5.0.0_cr7 | SET|GET | char |
[0x00-0xFF] | Hex char | Sets or gets the hex value of the character to start filtering after (e.g. 0x03 for ETX). | DM300 series readers, DM474. |
| COM.RS232-FILTER | Communication | PRIVATE | 5.0.0_cr7 | SET|GET | state |
[ON|OFF] | enable/disable | Enable or disable the RS-232 filter. | DM300 series readers, DM474. |
| COM.RS232-ENABLE-PAUSE | Communication | PUBLIC | 5.5.0 | SET|GET | mode |
ON/OFF | Enable/disable pause in output data stream. | DM300 series readers, DM60, DM50, DM70, DM474 | |
| COM.PROTOCOL | Communication | PUBLIC | 5.7.0 | SET|GET | type |
0..1 |
0: Off 1: RTS/CTS |
Sets hardware handshake type of serial port. | Devices with RTS/CTS lines |
| COM.PARITY | Communication | PUBLIC | 3.0.0 | SET|GET | parity |
[0-4] |
0: None 1: Even 2: Odd 3: Space 4: Mark |
All except for MX-1000 and MX-1502. | |
| COM.MULTI-PORT | Communication | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable daisy chaining of readers so they share one COM port. | Fixed mount readers. |
| COM.INTERFACE | Communication | PRIVATE | 5.4.3 | GET | Supported interfaces: RS232, USB, Ethernet, WiFi, Bluetooth. | ||||
| COM.DMCC-RESPONSE | Communication | PUBLIC | 3.0.0 | SET|GET | mode |
[0|1] |
0: Silent (default) 1: Extended |
DMCC response format. | ALL |
| COM.DMCC-RESPONSE | Communication | PRIVATE | 3.0.0 | SET|GET | mode |
[0-2] |
0: Silent (default) 1: Extended 2: Extended mode with ||[xxx::length] CR NL data Responses |
DMCC response format. | ALL |
| COM.DMCC-HEADER | Communication | PRIVATE | 3.4.0 | SET|GET | type |
[0-1] |
0: default 1: include result ID |
Sets or gets the header option used in Extended mode. | |
| COM.DMCC-EVENT | Communication | PRIVATE | 4.2.0 | SET|GET | event_mask |
[0-255] bitfield |
0: none 1: reader online/offline |
Sets which events are sent over DMCC. Used by DataMan SDK. | Wireless readers, base station. |
| COM.DMCC-CHECKSUM | Communication | PRIVATE | 3.4.0 | SET|GET | type |
[0-3] |
0: none 1: XOR 2: CRC16 (Header/Response) 3: CRC16 (Header/Response/Data) |
Checksum used in DMCC response. | |
| COM.DATA-BITS | Communication | PUBLIC | 3.0.0 | SET|GET | bits |
[7,8] | ALL except for MX-1000. | ||
| COM.DATA-BITS | IO | PRIVATE | 3.0.0 | SET|GET | bits |
[7|8] | RS232 data bits | ||
| COM.COMMUNICATIONS-MODULE | Communication | PUBLIC | 4.2.0 | GET | type |
[0-3] |
0: Serial 1: Ethernet 2: Wireless 3: Bluetooth |
Returns the type of communication module being used. | MX-1000 and DM8000 series readers. |
| COM.BUFFER-START-SEND | Action | PUBLIC | 4.2.1 | Valid if auto-flush is off. Activates buffer data output over Telnet channels (and flushes buffered codes). Data output is stopped every time when all Telnet channels are disconnected. | DM8050, DM8600 and MX-1000. | ||||
| COM.BUFFER-RESET | Action | PUBLIC | 4.2.1 | Clears the content of the offline buffer. | DM8050, DM8600 and MX-1000. | ||||
| COM.BUFFER-MODE | Communication | PUBLIC | 4.2.2 | SET|GET | int |
[0-1] |
0: Multiple 1: Single |
Sets or gets the offline buffering mode. | Wireless DM8000 readers. |
| COM.BUFFER-DATA | IO | PRIVATE | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | ||
| COM.BUFFER-DATA | Communication | PUBLIC | 4.2.1 | SET|GET | state |
[ON|OFF] | enable/disable | Offline buffering. | Wireless readers. |
| COM.BUFFER-AUTO-FLUSH | Communication | PUBLIC | 4.2.1 | SET|GET | state |
[ON|OFF] | enable/disable | Determines if the whole content of the offline buffer is automatically flushed to the first Telnet client. If not, flushing must be activated by the client. | Wireless readers. |
| COM.BAUD-RATE - test data | Communication - sample | 3.0.0 | SET|GET | rate |
[1...5] |
1:115200 2:57600 3:38400 4:19200 5:9600 |
RS232 Communication Speed. Does not affect USB communication speed. |
ALL | |
| COM.BAUD-RATE | Communication | PUBLIC | 3.0.0 | SET|GET | rate |
[1-5] |
1: 115200 2: 57600 3: 38400 4: 19200 5: 9600 |
ALL except for MX-1000. | |
| COM.AUTO-DETECT | Communication | PRIVATE | 3.0.0 | SET|GET | state |
[ON|OFF] [ON|OFF] | enable/disable | Enables support for simultaneous connection to USB And RS-232. | |
| COM.ALTERNATE-MODE-DISABLE | Decoder | PRIVATE | 5.7.0 | SET|GET | enable |
[ON|OFF] |
ON: alternate mode cable detection enabled OFF: alternate mode cable detection disabled |
Disables alternate mode cable detection. | DM70 |
| CODABAR.XMTCHK | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Codabar Transmit Check Character. | ALL |
| CODABAR.XMT-START-STOP-CHAR | Decoder | PRIVATE | 6.0.0 | SET|GET | state |
[ON|OFF] |
ON: Enable OFF: Disable |
Enable or disable transmitting start and stop character as part of the decoded string. | Ethernet readers |
| CODABAR.QZ-SIZE | Symbology | PRIVATE | 3.0.0 | SET|GET | state |
[0|100] | Quiet zone single strictness size. | ALL | |
| CODABAR.CODESIZE | Symbology | PUBLIC | 3.0.0 | SET|GET | any min max |
[ON|OFF] [1-max] [min-80] |
any length code minimum code length maximum code length |
Codabar Code Size. | ALL |
| CODABAR.CHKCHAR | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Codabar Check Character. | ALL |
| CAMERA.XPAND-ROI-TYPE | Camera | PUBLIC | 5.5.0 | SET|GET | int |
[0-3] |
0: None 1: Xpand-15 2: Xpand-25 3: Custom |
Indicates the used FOVE type. Requires the 1DDataStitching feature key. |
DM70, DM150, DM260, DM300 series readers, DM474, DM503. |
| CAMERA.XPAND-ROI | Camera | PUBLIC | 5.5.0 | SET|GET | ROI index left right top bottom |
[1-2] [0 - sensor width] [0 - sensor width] [0 - sensor height] [0 - sensor height] |
ROI index pixels from left pixels from right pixels from top pixels from bottom |
Specifies custom FOVE regions. Requires the 1DDataStitching feature key. |
DM70, DM150, DM260, DM300 series readers, DM474, DM503. |
| CAMERA.TARGET-BRIGHTNESS | Camera | PUBLIC | 5.6.0 | SET|GET | target |
[0-255] | target pixel value | Camera Parameters where exposure is in microseconds. | All, except MX series readers. |
| CAMERA.ROI | Camera | 3.0.0 | SET|GET | left right top bottom |
|||||
| CAMERA.MIRROR-VERTICAL | Camera | PUBLIC | 5.2.0 | SET|GET | state |
[ON|OFF] | enable/disable | Mirror acquired image over the horizontal axis. | DM70, DM260, DM474, DM503 and DM300 series readers. |
| CAMERA.MIRROR-HORIZONTAL | Camera | PUBLIC | 5.2.0 | SET|GET | state |
[ON|OFF] | enable/disable | Mirror acquired image over the vertical axis. | DM474, DM503 and DM300 series readers. |
| CAMERA.MAX-EXPOSURE-US | Camera | PUBLIC | 4.0.0 | SET|GET | exposure |
[1-50] [1-410] [1-100000] |
with HPIA without HPIA with external or no illumination |
Maximum exposure limit in microseconds for autoregulation. HPIA = High Powered Illumination Accessory. |
DM70, DM150, DM260, DM474, DM503, and DM300 series readers. |
| CAMERA.MAX-EXPOSURE-US | Camera | PUBLIC | 5.1.0 | SET|GET | exposure |
[18-25000] | Maximum exposure limit in microseconds for autoregulation. | DM50, DM60, DM70. | |
| CAMERA.MAX-EXPOSURE | Camera | PRIVATE | 3.0.0 | SET|GET | exposure |
[0-20] |
0: 1/20000 1: 1/10000 2: 1/7500 3: 1/5000 4: 1/3000 5: 1/2500 6: 1/2000 7: 1/1500 8: 1/1250 9: 1/1000 10: 1/750 11: 1/500 12: 1/300 13: 1/250 14: 1/200 15: 1/150 16: 1/125 17: 1/100 18: 1/75 19: 1/50 20: 1/40 |
Maximum exposure limit for autoregulation. | MX-1000 and DM8000 series readers. |
| CAMERA.INTERVAL-US | Camera | PUBLIC | 4.0.0 | SET|GET | us |
[*-1000000] |
Microseconds. Step size is 250. * By default the minimum range is 6000 but this can change depending on decode timeout and field of view. |
Acquisition Interval, the time between successive camera acquisitions in microseconds. Supported with Burst, Self, and Continuous trigger types. | DM50, DM60, DM70, DM474, DM503, and DM300 series readers. |
| CAMERA.HDR-MODE | Camera | PUBLIC | 6.1.0 | SET|GET | mode |
[0-2] |
0: Off 1: Global 2: Local |
HDR mode | DM470 series readers. |
| CAMERA.HDR-MODE | Camera | PUBLIC | 6.1.6 | SET|GET | mode |
[0-1] |
0: Off 1: Global |
HDR mode | DM370 series readers. |
| CAMERA.HDR-ESTIMATED-SCENE-KEY | Camera | PRIVATE | 6.1.0 | SET|GET | estimated scene key |
[0-4095] | Estimated scene key parameter for HDR | DM370 series, DM470 series readers. | |
| CAMERA.GAIN-LIMIT | Camera | PUBLIC | 5.7.0 | SET|GET | gain |
[1.00-max_gain] | 1.00-max_gain: The maximum gain to use | Controls the maximum gain the tuning and auto-regulation process uses to find the best reader settings. Useful to limit noise in Images. | Fixed mount readers. |
| CAMERA.GAIN | Camera | PUBLIC | 5.5.0 | SET|GET | gain |
[1.00-31.76] | The gain has no effect if the camera runs with automatic exposure | DM300 series readers, DM474. | |
| CAMERA.GAIN | Camera | PUBLIC | 5.5.0 | SET|GET | gain |
[1.00-13.88] | The gain has no effect if the camera runs with automatic exposure | DM503 | |
| CAMERA.GAIN | Camera | PUBLIC | 5.5.0 | SET|GET | gain |
[1.00-15.00] | The gain has no effect if the camera runs with automatic exposure | DM50, DM60, DM70 | |
| CAMERA.FULL-BLACK-LEVEL-CORRECTION | Camera | PUBLIC | 5.5.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enables Full black level correction. | DM300 series readers, DM474. |
| CAMERA.FOV-ENABLED | Camera | PUBLIC | 3.2.0 | SET|GET | state |
[ON|OFF] | enable/disable | Indicates whether the full FoV or a custom FoV will be used for image acquisition. You can change this value only for the following trigger types: single, burst, and continuous. |
ALL |
| CAMERA.FOV | Camera | PREVIEW | 3.2.0 | SET|GET | left (multiple of 8) right (multiple of 8) top (multiple of 4) bottom (multiple of 4) |
[0...] [left+64...] [0...] [top+64...] |
pixels from left pixels from right pixels from top pixels from bottom |
The camera field of view is the area of the camera used for image acquisition. | ALL |
| CAMERA.EXPOSURE-US | Camera | PUBLIC | 5.5.0 | SET|GET | auto target exposure gain |
[ON|OFF] [0-255] [18-25000] [0-60] |
ON: Automatic OFF: Manual target pixel value exposure camera gain |
Camera Parameters where exposure is in microseconds. The argument 'exposure' and 'gain' has no effect if 'auto' is ON and 'target' has no effect at all. | DM50, DM60, DM70, DM150, DM260 |
| CAMERA.EXPOSURE-US | Camera | PUBLIC | 5.5.0 | SET|GET | auto target exposure gain |
[ON|OFF] [0-255] [5-1000] [12-1000] [5-100000] [0-106] |
ON: Automatic OFF: Manual target pixel value DM300 and DM302 internal illumination DM303 internal illumination with external or no illumination camera gain |
Camera Parameters where exposure is in microseconds. The argument 'exposure' and 'gain' has no effect if 'auto' is ON and 'target' has no effect at all. | DM300 series readers, DM360 series readers, DM474, DM8600. |
| CAMERA.EXPOSURE-US | Camera | PUBLIC | 5.5.0 | SET|GET | auto target exposure gain |
[ON|OFF] [0-255] [12-100000] [0-41] |
ON: Automatic OFF: Manual target pixel value exposure independent of illumination camera gain |
Camera Parameters where exposure is in microseconds. The argument 'exposure' and 'gain' has no effect if 'auto' is ON and 'target' has no effect at all. | DM503 |
| CAMERA.EXPOSURE-US | Camera | PUBLIC | 5.5.0 | SET|GET | auto target exposure gain |
[ON|OFF] [0-255] [50-25000] [0-60] |
ON: Automatic OFF: Manual target pixel value camera gain |
Camera Parameters where exposure is in microseconds. The argument 'exposure' and 'gain' has no effect if 'auto' is ON and 'target' has no effect at all. | MX-1000 and DM8000 series readers. |
| CAMERA.EXPOSURE-LIMIT-US | Camera | PUBLIC | 5.5.0 | GET | exposure |
maximum value allowed for SET CAMERA.EXPOSURE-US | Get the maximum allowed exposure limited by current settings in us. | Fixed Mount readers. | |
| CAMERA.EXPOSURE | Camera | PUBLIC | 3.0.0 | SET|GET | auto target exposure gain |
[ON|OFF] [0-255] [0-22] [4-60] |
ON: Automatic OFF: Manual target pixel value 0: 1/10000 1: 1/7500 2: 1/5000 3: 1/4000 4: 1/3000 5: 1/2500 6: 1/2000 7: 1/1500 8: 1/1250 9: 1/1000 10: 1/750 11: 1/500 12: 1/300 13: 1/250 14: 1/200 15: 1/150 16: 1/125 17: 1/100 18: 1/75 19: 1/50 20: 1/40 21: 1/30000 22: 1/15000 camera gain |
Camera Parameters. The arguments 'exposure' and 'gain' have no effect if 'auto' is ON and the 'target' has no effect if 'auto' is OFF. | DM700. |
| CAMERA.EXPOSURE | Camera | PRIVATE | 3.0.0 | SET|GET | auto target exposure gain |
[ON|OFF] [0-255] [0-20] [1-19] |
ON: Automatic OFF: Manual target pixel value 0: 1/20000 1: 1/10000 2: 1/7500 3: 1/5000 4: 1/3000 5: 1/2500 6: 1/2000 7: 1/1500 8: 1/1250 9: 1/1000 10: 1/750 11: 1/500 12: 1/300 13: 1/250 14: 1/200 15: 1/150 16: 1/125 17: 1/100 18: 1/75 19: 1/50 20: 1/40 camera gain |
Camera Parameters. The arguments 'exposure' and 'gain' have no effect if 'auto' is ON and the 'target' has no effect if 'auto' is OFF. | DM7500 |
| CAMERA.EXPOSURE | Camera | PUBLIC | 5.6.0 | SET|GET | exposure |
[18-25000] | exposure | Camera Parameters where exposure is in microseconds. | DM50, DM60, DM70, DM150, and DM260 |
| CAMERA.EXPOSURE | Camera | PUBLIC | 5.6.0 | SET|GET | exposure |
[5-1000] [12-1000] [5-100000] |
DM300 and DM302 internal illumination DM303 internal illumination with external or no illumination |
Camera Parameters where exposure is in microseconds. | DM300 series readers, DM360 series readers, DM474, DM8600. |
| CAMERA.EXPOSURE | Camera | PUBLIC | 5.6.0 | SET|GET | exposure |
[12-100000] | exposure independent of illumination | Camera Parameters where exposure is in microseconds. | DM503 |
| CAMERA.ENABLE | Camera | PRIVATE | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enables camera which can be disabled when loading images from the PC. | ALL |
| CAMERA.BURST-TRANSFER-ALL | Camera | PRIVATE | 3.3.0 | SET|GET | state |
[ON|OFF] | enable/disable | Force transfer of all burst images. Used by the DMCC .NET. |
|
| CAMERA.BURST-LENGTH | Camera | PUBLIC | 3.0.0 | SET|GET | count |
[2-*] | number-images | Burst Length. Number of Acquired Images in Burst Trigger-Mode. Actual maximum can be increased by reducing the camera field of view or reserving fewer images for Process Monitor/Record and Playback. |
Fixed mount readers. |
| CAMERA.AUTO-REGULATION | Camera | PUBLIC | 5.6.0 | SET|GET | auto |
[ON|OFF] |
ON: Automatic OFF: Manual |
Camera Parameters where exposure is in microseconds. | DM50, DM60, DM70, DM150, DM260, DM300 series readers, DM360 series readers, DM474, DM503, DM8600 |
| C93.CODESIZE | Symbology | PUBLIC | 3.0.0 | SET|GET | any min max |
[ON|OFF] [1-max] [min-80] |
any length code minimum code length maximum code length |
Code 93 Code Size. | ALL |
| C39.XMTCHK | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Code 39 Transmit Check Character. | ALL |
| C39.CODESIZE | Symbology | PUBLIC | 3.0.0 | SET|GET | any min max |
[ON|OFF] [1-max] [min-80] |
any length code minimum code length maximum code length |
Code 39 Code Size. | ALL |
| C39.CHKCHAR | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Code 39 Check Character. | ALL |
| C39.ASCII | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Code 39 Full ASCII. | ALL |
| C25.XMTCHK | Symbology | PUBLIC | 5.5.2 | SET|GET | state |
[ON|OFF] |
ON: enable OFF: disable |
Sets or gets whether to transmit the check digit. | ALL |
| C25.QZ-SIZE | Symbology | PUBLIC | 5.5.2 | SET|GET | size |
[0..100] | any length code | Sets or gets the single side strictness as a percentage. | ALL |
| C25.CODESIZE | Symbology | PUBLIC | 5.5.2 | SET|GET | any, min, max |
[ON|OFF] [1-max] [min-80] |
any length code minimum code length maximum code length |
Code 25 Code Size. For the Manatee Works SDK, all of the Code 25 variants use the same minimum length; thus it will accept either C25.CODESIZE or I205.CODESIZE. | ALL |
| C25.CHKCHAR | Symbology | PUBLIC | 5.5.2 | SET|GET | state |
[ON|OFF] |
ON: enable OFF: disable |
Code 25 Check Character | ALL |
| C128.CODESIZE | Symbology | PUBLIC | 3.0.0 | SET|GET | any min max |
[ON|OFF] [1-max] [min-80] |
any length code minimum code length maximum code length |
Code 128 Allowed Size. | ALL |
| C11.CODESIZE | Symbology | PUBLIC | 5.7.1 | SET|GET | any, min, max |
[ON|OFF] [1-max] [min-80] |
any length code minimum code length maximum code length |
Code 11 Code Size | ALL |
| C11.CHKCHAR-OPTION | Symbology | PUBLIC | 5.7.1 | SET|GET | int |
[0-1] |
0: disable 1: enable (default) |
Mobile | |
| C11.CHKCHAR | Symbology | PUBLIC | 5.7.1 | SET|GET | state |
[ON|OFF] |
ON: enable OFF: disable (default) |
Code 11 Check Character | Mobile |
| BUTTON.VIRTUAL | Action | PRIVATE | 5.4.0 | int state |
[ON|OFF] |
Denotes the button id. enable/disable Denotes the new state of the button. |
Allows to virtually push the TUNE button for more than 3 seconds on a DM8600 to activate "magic mode". | DM8600 | |
| BUTTON.SAVE-MATCH-STRING | Communication | PUBLIC | 4.5.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enables or disables saving the trained match string directly to flash when Set Match String is enabled for the 3 sec button press action. If disabled, the match string is only stored in RAM and if the configuration is not saved manually it will be gone after reboot. | DM474, DM503, and DM300 series readers. |
| BUTTON.ENABLE | IO | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enables or disables the trigger button. | Fixed mount readers. |
| BUTTON.ACTION | IO | PUBLIC | 5.5.1 | SET|GET | button action |
[0-2] [0-1] |
Index of button (0:Left;1:Right;2:Grip) 0: disabled 1: trigger |
Sets and gets the assigned feature for hardware buttons. | MX-1000 |
| BUTTON.3SEC-ACTION | IO | PUBLIC | 3.0.0 | SET|GET | mode state |
[0-6] [ON|OFF] |
0: Train 1: Optimize Brighness 2: Set Match String 3: Optimize Focus 4: Read Configuration Code 5: Tune 6: Toggle Test Mode enable/disable |
Three Second Button Action. | Fixed mount readers. Test Mode is only supported on the DM503, DM300 series readers and DM474. |
| BLUETOOTH.OPERATION-MODE | Communication | PRIVATE | 5.4.3 | SET|GET | number |
[0-2] |
0: normal mode 1: PC connect mode 2: keyboard emulator mode |
Gets or sets the Bluetooth operation mode. | DM8050, DM8600. |
| BLUETOOTH.MAX-RF-POWER | Communication | PUBLIC | 5.4.3 | SET|GET | int |
-23-7 | Maximum output power in dBm | DM8050, DM8600, and Bluetooth base stations. | |
| BLUETOOTH.MAC-ADDRESS | Communication | PUBLIC | 5.4.0 | GET | Returns the own Bluetooth address of the device. | DM8050, DM8600. | |||
| BLUETOOTH.KBM-TARGET-ADDR | Communication | PRIVATE | 5.4.3 | SET|GET | string |
8 characters of hexadecimal number | MAC address (e.g. "0006660492A6") | Gets or sets the MAC address of the remote target. | DM8050, DM8600. |
| BLUETOOTH.KBM-PIN | Communication | PRIVATE | 5.4.3 | SET|GET | string |
0-16 characters of decimal number | PIN number (e.g. "1234") | Gets or sets the PIN number of the remote target. | DM8050, DM8600. |
| BEEPER.ENABLED | IO | PUBLIC | 5.7.1 | SET|GET | state |
[ON|OFF] | Enable/disable beeper in general. | All | |
| BEEP.NO-READ-OL | IO | PUBLIC | 3.0.0 | SET|GET | repetition level |
[0-3] [0-2] |
number of beeps 0: Lo pitch 1: Med pitch 2: Hi pitch |
No-Read Beep Settings when offline. | Wireless readers. |
| BEEP.NO-READ | IO | PUBLIC | 3.0.0 | SET|GET | repetition level |
[0-3] [0-2] |
number of beeps 0: Lo pitch 1: Med pitch 2: Hi pitch |
No-Read Beep Settings. | ALL except for DM50, DM60 and DM70. |
| BEEP.GOOD-OL | IO | PUBLIC | 3.0.0 | SET|GET | repetition level |
[0-3] [0-2] |
number of beeps 0: Lo pitch 1: Med pitch 2: Hi pitch |
Good Read Beep Settings when offline. | Wireless readers. |
| BEEP.GOOD | IO | PUBLIC | 3.0.0 | SET|GET | repetition level |
[0-3] [0-2] |
number of beeps 0: Lo pitch 1: Med pitch 2: Hi pitch |
Good Read Beep Settings. | ALL except for DM50, DM60 and DM70. |
| BEEP.GLOBAL-ENABLE | Action | PUBLIC | 5.7.0 | SET|GET | state |
[ON|OFF] |
ON: enable OFF: disable |
This command will disable all beeps on the DataMan product. | DM8050, DM8600 |
| BEEP.DATAVALID-FAIL-OL | IO | PUBLIC | 3.0.0 | SET|GET | repetition level |
[0-3] [0-2] |
number of beeps 0: Lo pitch 1: Med pitch 2: Hi pitch |
Data Validation Failure Beep Settings when offline. | Wireless readers. |
| BEEP.DATAVALID-FAIL | IO | PUBLIC | 3.0.0 | SET|GET | repetition level |
[0-3] [0-2] |
number of beeps 0: Lo pitch 1: Med pitch 2: Hi pitch |
Data Validation Failure Beep Settings. | ALL except for DM50, DM60 and DM70. |
| BEEP | Action | PUBLIC | 3.0.0 | repetition level |
[0-3] [0-2] |
Command audio beep. | ALL | ||
| BATTERY.INFO | System | PUBLIC | 5.5.1 | GET | battery |
[0-1] |
0: internal battery 1: grip battery |
Gets verbose battery status. | MX-1000 |
| BATTERY.CHARGE | System | PUBLIC | 4.4.0 | GET | int |
[0-100] | Displays, in percentage, current battery level. | MX-1000 and DM8000 series readers. | |
| BACKUP.EXPORT | Action | PUBLIC | 5.7.0 | Exports a human readable version of the current reader backup. | ALL | ||||
| AZTEC.TRAINED-MODEL | Decoder | PUBLIC | 5.7.0 | SET|GET | grid size module size polarity |
[15-151] [1-1000] [0-2] |
Grid size Module size * 10 0: dark-on-light 1: light-on-dark 2: either |
Set training parameters for Aztec symbology. | Fixed-mount readers |
| ANDROID.USB-ROLE-CHANGE | Action | PRIVATE | 5.7.1 | SET|GET | enabled timeout |
[ON|OFF] |
ON: (default) role change enabled, reader operates as usual OFF: role change disabled, reader stays in device mode Timeout in seconds after which the role change is automatically enabled again. |
Disables the USB role change. If role change is disabled, the reader stays in device mode, meaning the phone is not charged. If the role change is disabled, a timeout must be provided in seconds after which the role change is automatically enabled again. | ALL |
| ANDROID.ROLE | Communication | PUBLIC | 5.7.1 | SET|GET | role |
0-2 |
0: Auto 1: Device 2: AOA |
Sets the USB role of the MX device when in Android mode. | MX-1000, MX-1502 |
| ANDROID.AOA-SWITCH-TIMEOUT | Communication | PUBLIC | 5.7.1 | SET|GET | timeout [ms] |
0-3600000 | Timeout in milliseconds. | After boot the MX device won’t switch to AOA mode for this amount of time. | MX-1000, MX-1502 |
| ACCEL-SENSOR.SENSITIVITY | Communication | PUBLIC | 5.4.0 | SET|GET | int |
[0-2] |
0: Low 1: Medium 2: High |
Gets/sets the sensitivity of the acceleration sensor of/to the predefined value. | DM8050, DM8600. |
| ACCEL-SENSOR.OPERATION-MODE | Communication | PUBLIC | 5.4.0 | SET|GET | int |
[0-1] |
0: Acceleration Sensor is not used for waking the reader up from hibernation. 1: Acceleration Sensor is used for waking the reader up from hibernation. |
Configures the application of the acceleration sensor. This command is only valid for Bluetooth-connected readers. |
DM8050, DM8600. |
| ABORT | Action | PRIVATE | 3.0.0 | Abort command in process. Intended to abort image transfer. | ALL | ||||
| 3DVECTOR.SCALIB.SEND | Action | PRIVATE | 5.5.0 | Send system calibration data blob. | ALL | ||||
| 3DVECTOR.SCALIB.LOAD | Action | PRIVATE | 5.5.0 | size_bytes |
Load system calibration data blob. | ALL | |||
| 3DVECTOR.LENGTH | Action | PRIVATE | 5.5.0 | SET|GET | This sets/gets the length of the output 3D line segment. | ALL | |||
| 3DVECTOR.FCALIB-CVT.SEND | Action | PRIVATE | 5.5.0 | Send factory calibration data blob in CVT style. | ALL | ||||
| 3DVECTOR.FCALIB-CVT.LOAD | Action | PRIVATE | 5.5.0 | size_bytes |
Load factory calibration data blob in CVT style. | ALL | |||
| 3DVECTOR.FCALIB-CVL.SEND | Action | PRIVATE | 5.5.0 | Send factory calibration data blob in CVL style. | ALL | ||||
| 3DVECTOR.FCALIB-CVL.LOAD | Action | PRIVATE | 5.5.0 | size_bytes |
Load factory calibration data blob in CVL style. | ALL | |||
| 3DVECTOR.ENABLED | Action | PRIVATE | 5.5.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enables/disables the 3DVectoring functionality on the reader. | ALL |
| 3DVECTOR.CALIBRATED | Action | PRIVATE | 5.5.0 | GET | calibration_status |
[0-2] |
0:Neither factory, nor field calibration present 1:Only factory calibration loaded 2:Factory and field calibration loaded |
Query current calibration status. | ALL |
| 2D.ALGORITHM | Symbology | PUBLIC | 3.0.0 | SET|GET | algorithm |
[0-1] |
0: IDMax ©
1: IDQuick |
IDQuick or IDMax© | X, XM, SX and QE fixed-mount readers. All Q models except for DM503Q. |
| Name |
Type |
Level |
Version |
Set/Get |
Args |
Range |
Meaning |
Description |
Support |
|---|---|---|---|---|---|---|---|---|---|
| DEVICE.FLASH | PRIVATE | 3.0.0 | begin numbytes |
||||||
| 3DVECTOR.CALIBRATED | Action | PRIVATE | 5.5.0 | GET | calibration_status |
[0-2] |
0:Neither factory, nor field calibration present 1:Only factory calibration loaded 2:Factory and field calibration loaded |
Query current calibration status. | ALL |
| 3DVECTOR.ENABLED | Action | PRIVATE | 5.5.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enables/disables the 3DVectoring functionality on the reader. | ALL |
| 3DVECTOR.FCALIB-CVL.LOAD | Action | PRIVATE | 5.5.0 | size_bytes |
Load factory calibration data blob in CVL style. | ALL | |||
| 3DVECTOR.FCALIB-CVL.SEND | Action | PRIVATE | 5.5.0 | Send factory calibration data blob in CVL style. | ALL | ||||
| 3DVECTOR.FCALIB-CVT.LOAD | Action | PRIVATE | 5.5.0 | size_bytes |
Load factory calibration data blob in CVT style. | ALL | |||
| 3DVECTOR.FCALIB-CVT.SEND | Action | PRIVATE | 5.5.0 | Send factory calibration data blob in CVT style. | ALL | ||||
| 3DVECTOR.LENGTH | Action | PRIVATE | 5.5.0 | SET|GET | This sets/gets the length of the output 3D line segment. | ALL | |||
| 3DVECTOR.SCALIB.LOAD | Action | PRIVATE | 5.5.0 | size_bytes |
Load system calibration data blob. | ALL | |||
| 3DVECTOR.SCALIB.SEND | Action | PRIVATE | 5.5.0 | Send system calibration data blob. | ALL | ||||
| ABORT | Action | PRIVATE | 3.0.0 | Abort command in process. Intended to abort image transfer. | ALL | ||||
| ANDROID.USB-ROLE-CHANGE | Action | PRIVATE | 5.7.1 | SET|GET | enabled timeout |
[ON|OFF] |
ON: (default) role change enabled, reader operates as usual OFF: role change disabled, reader stays in device mode Timeout in seconds after which the role change is automatically enabled again. |
Disables the USB role change. If role change is disabled, the reader stays in device mode, meaning the phone is not charged. If the role change is disabled, a timeout must be provided in seconds after which the role change is automatically enabled again. | ALL |
| BACKUP.EXPORT | Action | PUBLIC | 5.7.0 | Exports a human readable version of the current reader backup. | ALL | ||||
| BEEP | Action | PUBLIC | 3.0.0 | repetition level |
[0-3] [0-2] |
Command audio beep. | ALL | ||
| BEEP.GLOBAL-ENABLE | Action | PUBLIC | 5.7.0 | SET|GET | state |
[ON|OFF] |
ON: enable OFF: disable |
This command will disable all beeps on the DataMan product. | DM8050, DM8600 |
| BUTTON.VIRTUAL | Action | PRIVATE | 5.4.0 | int state |
[ON|OFF] |
Denotes the button id. enable/disable Denotes the new state of the button. |
Allows to virtually push the TUNE button for more than 3 seconds on a DM8600 to activate "magic mode". | DM8600 | |
| COM.BUFFER-RESET | Action | PUBLIC | 4.2.1 | Clears the content of the offline buffer. | DM8050, DM8600 and MX-1000. | ||||
| COM.BUFFER-START-SEND | Action | PUBLIC | 4.2.1 | Valid if auto-flush is off. Activates buffer data output over Telnet channels (and flushes buffered codes). Data output is stopped every time when all Telnet channels are disconnected. | DM8050, DM8600 and MX-1000. | ||||
| CONFIG-BACKUP.ENABLE | Action | PUBLIC | 5.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enables automatic device configuration backup. | Ethernet readers. DM8000 series wireless readers also support FTP if the base station is connected through Ethernet. |
| CONFIG-BACKUP.IP-ADDRESS | Action | PUBLIC | 5.0.0 | SET|GET | string |
IP address of the Cognex Explorer FTP service. Uses dotted decimal form, such as "192.168.23.42". |
Ethernet readers. DM8000 series wireless readers also support FTP if the base station is connected through Ethernet. | ||
| CONFIG-BACKUP.PASSWORD | Action | PUBLIC | 5.0.0 | SET|GET | string |
Password used to log in to Cognex Explorer FTP service. | Ethernet readers. DM8000 series wireless readers also support FTP if the base station is connected through Ethernet. | ||
| CONFIG-BACKUP.PORT | Action | PUBLIC | 5.0.0 | SET|GET | port |
[0-65535] | Port number of the Cognex Explorer FTP service. | Ethernet readers. DM8000 series wireless readers also support FTP if the base station is connected through Ethernet. | |
| CONFIG-BACKUP.USER-NAME | Action | PUBLIC | 5.0.0 | SET|GET | string |
User name used to log in to the Cognex Explorer FTP service. | Ethernet readers. DM8000 series wireless readers also support FTP if the base station is connected through Ethernet. | ||
| CONFIG.DEFAULT | Action | PUBLIC | 3.0.0 | Resets the device’s configuration settings to factory defaults. Device identification and communications settings are not changed. | ALL | ||||
| CONFIG.DUMP-UIDS | Action | PRIVATE | 3.0.0 | Returns all value tree parameters. | ALL | ||||
| CONFIG.EXPORT | Action | PUBLIC | 5.7.0 | Exports a human readable version of the current reader configuration. | ALL | ||||
| CONFIG.LOAD | Action | PUBLIC | 4.4.0 | num-bytes |
Load Configuration from communication channel. Make sure you use a robust communications channel (for example, Ethernet) because this command does not have error checking or retry support and might cause the device to hang. | ALL | |||
| CONFIG.RESTORE | Action | PUBLIC | 3.0.0 | Restores Configuration from Non-Volatile Memory. | ALL | ||||
| CONFIG.SAVE | Action | PUBLIC | 3.0.0 | Saves Configuration to Non-Volatile Memory. | ALL | ||||
| CONFIG.SAVE-DEFAULTS | Action | PRIVATE | 5.4.0 | Saves current settings as defaults. This command does not reboot the device. | ALL | ||||
| CONFIG.SEND | Action | PUBLIC | 3.0.0 | Send device configuration to communication channel. | ALL | ||||
| CONTROL.RPC | Action | PRIVATE | 4.2.0 | SET|GET | string |
RP code to execute. | Executes RP codes passed as string. Used internally to route RP commands to the base station. | ALL | |
| DEVICE-LOG.CLEAR | Action | PUBLIC | 5.2.0 | This command clears the device log. | DM50, DM60, DM70, DM474, DM503, DM300 series readers, DM8050, DM8600, MX-1000 and MX-1502. | ||||
| DEVICE.BACKUP | Action | PUBLIC | 3.3.0 | Send encrypted backup file (.cdc) to the PC. | ALL | ||||
| DEVICE.DEFAULT | Action | PUBLIC | 3.0.0 | Resets all device settings to factory defaults. This command reboots the device. | ALL | ||||
| DEVICE.DEFAULT-MFG | Action | PRIVATE | 5.4.0 | Resets all device settings to Cognex defaults. This command reboots the device. | DM8050, DM8600. | ||||
| DEVICE.LOG | Action | PUBLIC | 4.4.0 | GET | Get the device log of error and exception conditions such as missed triggers and trigger overruns. | DM50, DM60, DM70, DM474, DM503, DM300 series readers, DM8050 and DM8600. | |||
| DEVICE.RESTORE | Action | PUBLIC | 3.3.0 | file size |
Transmits backup file (.cdc) to the reader. File size is in bytes. File data follows footer. | ALL | |||
| DEVICE.STATS | Action | PRIVATE | 5.2.0 | GET | Get decode statistics. | All. | |||
| DEVICE.TIMEZONE | Action | PUBLIC | 5.7.0 | SET|GET | timezone |
Location or POSIX timezone | Get or set the timezone for local time. | All | |
| DMCC.RESET | Action | PUBLIC | 4.4.0 | When sent, the DMCC resets the following DMCC back to default: COM.DMCC-RESPONSE, COM.DMCC-CHECKSUM, COM.DMCC-HEADER, DATA.RESULT-TYPE, DATA.RESULT-ENCODING, DATA.RESULT-ALWAYSSEND, DATA.IMAGE-TYPE. | ALL | ||||
| DMCC.SAVE | Action | PUBLIC | 4.4.0 | Saves DMCC connection settings. It also saves the status for a new connection session for the following DMCC: COM.DMCC-RESPONSE, COM.DMCC-CHECKSUM, COM.DMCC-HEADER, DATA.RESULT-TYPE, DATA.RESULT-ENCODING, DATA.RESULT-ALWAYSSEND, DATA.IMAGE-TYPE. | ALL | ||||
| ERROR-LED.ENABLE | Action | PRIVATE | 4.5.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enables/disables error log LED. | DM50, DM60, DM70, DM503, DM474 and DM300 series readers. |
| ERROR-LED.ENABLE | Action | PRIVATE | 4.4.0_cr1_sr1 | SET|GET | state |
[ON|OFF] | enable/disable | Enables/disables error log LED. | DM300 series readers. |
| FILE.LOAD | Action | PRIVATE | 4.5.0 | This command can be used to upload a file into DataMan flash filesystem. It should be specified as 'FILE.LOAD "Length" "Filename"'. This DMCC is password-protected. |
ALL | ||||
| FILE.SAVE | Action | PRIVATE | 5.7.0 | filename |
This command can be used to load file from flash, e.g. FILE.SEND "/files/vs.cfg". | ALL | |||
| FLASH.AT70-INIT | Action | PRIVATE | 5.7.1 | magic |
647391673 | Magic number | This command clears AT70 Config block in flash memory. | AT70 based devices | |
| FOCUS.CALIBRATE | Action | PRIVATE | 6.0.1 | Compute C-mount flange distance for early units and store in manufacturing data. | DM47x, DM37x | ||||
| FTP.LOG | Action | PRIVATE | 4.4.0 | GET | Get the FTP log of FTP control connection commands and replies in case of FTP problems. | ALL | |||
| HPIT.INDICATOR-MODE | Action | PUBLIC | 6.1.6 | SET|GET | IND_ID IND_MODE |
[0-1] [0-1] |
0 = Left indicator 1 = Right indicator 0 = OFF 1 = ON |
Allows to control the LED indicators located in Torch according to the selected mode. This command is intended only for usability testing. | DM370 series, DM470 series readers. |
| HPIT.INDICATOR-ON-TIME-US | Action | PRIVATE | 6.1.6 | SET|GET | IND_ID TIME_US |
[0-1] [100-10000] |
0 = Left indicator 1 = Right indicator |
Allows to control the Indicator0 (Green LED) on time to be executed in the following illumination pulse after an event has been detected. | DM370 series, DM470 series readers. |
| HPT.CHANNEL-ENABLED | Action | PRIVATE | 5.7.0 | SET|GET | channel_name, state |
[ON|OFF] string, [ON|OFF] | enable/disable Channel name. Switch state. | Enables or disables a given HPT log channel. | ALL |
| HPT.LOG | Action | PRIVATE | 5.7.0 | GET | Retrieves the HPT log as a binary file content. | ALL | |||
| IMAGE.SEND | Action | PUBLIC | 5.5.0 | Retrieve the last camera image acquired. Returns number of bytes of image data followed by \r\n followed by image data. Whatever is set for ||>IMAGE.SIZE, ||>IMAGE.FORMAT, and ||>IMAGE.QUALITY before requesting the image will be used for the corresponding size, format, and quality. | ALL | ||||
| INPUT.STATE | Action | PUBLIC | 5.5.0 | GET | line |
[0-3] | input line number | Gets the current state of the input line specified. Returns 1 for high, 0 for low. | Fixed-mount readers |
| INPUT.VIRTUAL | Action | PRIVATE | 3.0.0 | line state |
[0-7] [ON|OFF] |
enable/disable |
Software Virtual Input. Trigger is equivalent to line 0. Note that the input actions "Train Code," "Optimize Brightness," "Set Match String," and "Read Configuration Code" are carried out only after the next trigger. |
Fixed mount devices. | |
| KEY.PAUSE-TIME | Action | PUBLIC | 5.4.0 | SET|GET | Pause time |
[0-1000] | 0 to 1000 millisecond pause | Sets the time to pause for a specified pause key sequence. | DM8050, DM8600 series |
| MOTION-DETECTION.ACTIVE | Action | PUBLIC | 5.7.0 | GET | state |
[ON|OFF] |
ON: Active or Lights Off OFF: Inactive or Lights On |
Allows checking the current state of motion detection for presentation or self-internal trigger mode. | DM50, DN60, DM70, DM150, DM260, DM300, DM360, DM474. |
| MOTION-DETECTION.ENABLE | Action | PUBLIC | 5.7.0 | SET|GET | state |
[ON|OFF] |
ON: enable OFF: disable |
Enables or disables motion detection for Presentation trigger mode. | DM50, DN60, DM70, DM150, DM260, DM300, DM474, DM503. |
| MOTION-DETECTION.INIT-STATE | Action | PRIVATE | 5.7.0 | SET|GET | state |
[ON|OFF] | enable/disable ON: motion detection is default state\n; OFF: switch to motion detection state after timeout | Specify the motion detection default state. | DM50, DM60, DM70, DM150, DM260, DM300, DM474, DM503. |
| MOTION-DETECTION.SENSITIVITY | Action | PUBLIC | 5.7.0 | SET|GET |
|
[0|2] |
0: Low 1: Medium 2: High |
Sets or gets the motion detection sensitivity level when in presentation mode. | DM50, DM60, DM70, DM150, DM260, DM300, DM474, DM503. |
| MOTION-DETECTION.TIMEOUT | Action | PRIVATE | 5.7.0 | SET|GET | [0 - 3600] | sec | Time after the reader switches into the motion detection mode. | DM50, DM60, DM70, DM150, DM260, DM300, DM474, DM503. | |
| OUTPUT.DATAVALID-FAIL | Action | PREVIEW | 3.0.0 | Virtual Data Validation Failure. Device beeps, flashes indicator lights, and sets output lines as if the specified Data Validation failure event occurred. |
ALL | ||||
| OUTPUT.GOOD | Action | PREVIEW | 3.0.0 | Virtual Good-Read. Device beeps, flashes indicator lights, and sets output lines as if the specified read event occurred. |
ALL | ||||
| OUTPUT.NOREAD | Action | PREVIEW | 3.0.0 | Virtual No-Read. Device beeps, flashes indicator lights, and sets output lines as if the specified no-read event occurred. |
ALL | ||||
| OUTPUT.USER1 | Action | PUBLIC | 5.3.0 | Device emits USER_EVENT_1 event. | DM8050, MX-1000, MX-1502, DM474, DM503 and DM300 series readers. | ||||
| OUTPUT.USER2 | Action | PUBLIC | 5.3.0 | Device emits USER_EVENT_2 event. | DM8050, MX-1000, MX-1502, DM474, DM503 and DM300 series readers. | ||||
| REBOOT | Action | PUBLIC | 3.0.0 | Reboot the Device. Rebooting the Device restores the Configuration stored in Non-Volatile Memory. Commands will not be processed for several seconds while the device reboots. If communication settings are changed, connection with device may be lost. Note that when connected via USB-COM, the application must release the COM port. |
ALL | ||||
| REBOOT.DELAYED | Action | PUBLIC | 5.6.0 | Reboot the Device after delay in seconds. Rebooting the Device restores the Configuration stored in Non-Volatile Memory. Commands will not be processed for several seconds while the device reboots.If communication settings are changed, connection with device may be lost. Note that when connected via USB-COM, the application must release the COM port. | All | ||||
| RESULT | Action | PUBLIC | 3.0.0 | GET | target |
[0-1] |
0: Result string 1: XML formatted |
Optional Send Last Result. By default the result string is in ASCII format, but this can be changed to Base64 with the DATA.RESULT-ENCODING command. | ALL |
| SSH.UNLOCK | Action | PRIVATE | 6.0.1 | GET | The PC (host) sends this command to the reader to initiate the unlocking mechanism. As a response, the reader sends back a 32 byte random challenge to the PC. | DM474 | |||
| SSH.UNLOCK | Action | PRIVATE | 6.0.1 | SET | signature of the challenge |
The argument is the signature of the random challenge generated by the reader and signed with a public key on the PC side. The reader then verifies that the challenge was signed with the proper key and sent back in one minute. In this case, the SSH service is started on the reader, otherwise, an invalid parameter error is returned. | DM474 | ||
| STATISTICS.RESET | Action | PUBLIC | 3.3.1 | Reset all statistics. | ALL | ||||
| TLS.BENCHMARK | Action | PRIVATE | 5.7.0 | Starts a benchmark of the SSL/TLS library.This DMCC is password protected. The result can be checked in the HPT log output. | ALL | ||||
| TLS.SELFTEST | Action | PRIVATE | 5.7.0 | Starts a benchmark of the SSL/TLS library. This DMCC is password protected. The result can be checked in the HPT log output. | ALL | ||||
| TRAIN.BRIGHT | Action | PUBLIC | 3.0.0 | type |
[ON|OFF] |
ON: Start Train Brightness Algorithm OFF: Abort Train Brightness Algorithm |
Generate a fixed value for the exposure setting based on the particular scene, similar to the Optimize Brightness button in the Setup Tool. | Fixed mount devices. | |
| TRAIN.CODE | Action | PUBLIC | 3.0.0 | state |
[ON|OFF] | enable/disable | Train symbology using next sucessful decode. | Fixed mount devices. | |
| TRAIN.CODE-FROM-IMAGE | Action | PRIVATE | 4.5.0 | num-bytes |
Code is trained from uploaded image. | Fixed mount devices. | |||
| TRAIN.FOCUS | Action | PUBLIC | 3.3.0 | state |
[ON|OFF] | enable/disable | Optimize lens focus. | DM503, DM474 and DM300 series readers. | |
| TRAIN.MATCH-STRING | Action | PUBLIC | 3.1.0 | Triggers the reader and sets the match string to the value of the decoded string. Match String validation must be enabled for this command to work. | Fixed mount devices, DM8050 and DM8600. | ||||
| TRIGGER | Action | PUBLIC | 3.0.0 | state |
[ON|OFF] |
enable/disable
ON: Scanning process is initiated, displaying the preview if necessary, decoding frames, etc. OFF: Scanning process is terminated, even if a barcode has not been decoded. |
Software Trigger. | ALL | |
| TRIGGER | Action | PUBLIC | 3.6.0 | GET | state |
[0|1] |
0: Off 1: On |
Get current state of the trigger. | ALL |
| TUNE.CANCEL | Action | PUBLIC | 4.3.0 |
|
0: Tuning is cancelled. 104: Tuning is not running or there is an error. 101: Tuning is not available. |
Cancel tuning. | DM300 series readers, DM474, DM70, DM260, and DM150. | ||
| TUNE.START | Action | PUBLIC | 4.3.0 |
|
0: Tuning started. 104: Tuning is already running or there is an error. 101: Tuning is not available. |
Start tuning. | DM300 series readers, DM474, DM70, DM260, and DM150. | ||
| TUNE.STATUS | Action | PUBLIC | 5.5.0 | GET | Returns ON if tuning is running, OFF otherwise. | Fixed mount devices. | |||
| UNTRAIN.MODEL | Action | PUBLIC | 3.2.0 | enum index |
[0-5] 0 |
0: All Symbologies 1: DataMatrix 2: QR Code/MaxiCode/AztecCode 3: Linear/ Postal/ Stacked 4: VeriCode® 5: DotCode |
Deletes the specified model. AztecCode is only supported on the DM503 and DM300 series readers. |
Fixed mount readers. | |
| UPTIME | Action | PUBLIC | 5.7.0 | Shows the time since device started. | All | ||||
| CAMERA.AUTO-REGULATION | Camera | PUBLIC | 5.6.0 | SET|GET | auto |
[ON|OFF] |
ON: Automatic OFF: Manual |
Camera Parameters where exposure is in microseconds. | DM50, DM60, DM70, DM150, DM260, DM300 series readers, DM360 series readers, DM474, DM503, DM8600 |
| CAMERA.BURST-LENGTH | Camera | PUBLIC | 3.0.0 | SET|GET | count |
[2-*] | number-images | Burst Length. Number of Acquired Images in Burst Trigger-Mode. Actual maximum can be increased by reducing the camera field of view or reserving fewer images for Process Monitor/Record and Playback. |
Fixed mount readers. |
| CAMERA.BURST-TRANSFER-ALL | Camera | PRIVATE | 3.3.0 | SET|GET | state |
[ON|OFF] | enable/disable | Force transfer of all burst images. Used by the DMCC .NET. |
|
| CAMERA.ENABLE | Camera | PRIVATE | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enables camera which can be disabled when loading images from the PC. | ALL |
| CAMERA.EXPOSURE | Camera | PUBLIC | 3.0.0 | SET|GET | auto target exposure gain |
[ON|OFF] [0-255] [0-22] [4-60] |
ON: Automatic OFF: Manual target pixel value 0: 1/10000 1: 1/7500 2: 1/5000 3: 1/4000 4: 1/3000 5: 1/2500 6: 1/2000 7: 1/1500 8: 1/1250 9: 1/1000 10: 1/750 11: 1/500 12: 1/300 13: 1/250 14: 1/200 15: 1/150 16: 1/125 17: 1/100 18: 1/75 19: 1/50 20: 1/40 21: 1/30000 22: 1/15000 camera gain |
Camera Parameters. The arguments 'exposure' and 'gain' have no effect if 'auto' is ON and the 'target' has no effect if 'auto' is OFF. | DM700. |
| CAMERA.EXPOSURE | Camera | PRIVATE | 3.0.0 | SET|GET | auto target exposure gain |
[ON|OFF] [0-255] [0-20] [1-19] |
ON: Automatic OFF: Manual target pixel value 0: 1/20000 1: 1/10000 2: 1/7500 3: 1/5000 4: 1/3000 5: 1/2500 6: 1/2000 7: 1/1500 8: 1/1250 9: 1/1000 10: 1/750 11: 1/500 12: 1/300 13: 1/250 14: 1/200 15: 1/150 16: 1/125 17: 1/100 18: 1/75 19: 1/50 20: 1/40 camera gain |
Camera Parameters. The arguments 'exposure' and 'gain' have no effect if 'auto' is ON and the 'target' has no effect if 'auto' is OFF. | DM7500 |
| CAMERA.EXPOSURE | Camera | PUBLIC | 5.6.0 | SET|GET | exposure |
[18-25000] | exposure | Camera Parameters where exposure is in microseconds. | DM50, DM60, DM70, DM150, and DM260 |
| CAMERA.EXPOSURE | Camera | PUBLIC | 5.6.0 | SET|GET | exposure |
[5-1000] [12-1000] [5-100000] |
DM300 and DM302 internal illumination DM303 internal illumination with external or no illumination |
Camera Parameters where exposure is in microseconds. | DM300 series readers, DM360 series readers, DM474, DM8600. |
| CAMERA.EXPOSURE | Camera | PUBLIC | 5.6.0 | SET|GET | exposure |
[12-100000] | exposure independent of illumination | Camera Parameters where exposure is in microseconds. | DM503 |
| CAMERA.EXPOSURE-LIMIT-US | Camera | PUBLIC | 5.5.0 | GET | exposure |
maximum value allowed for SET CAMERA.EXPOSURE-US | Get the maximum allowed exposure limited by current settings in us. | Fixed Mount readers. | |
| CAMERA.EXPOSURE-US | Camera | PUBLIC | 5.5.0 | SET|GET | auto target exposure gain |
[ON|OFF] [0-255] [18-25000] [0-60] |
ON: Automatic OFF: Manual target pixel value exposure camera gain |
Camera Parameters where exposure is in microseconds. The argument 'exposure' and 'gain' has no effect if 'auto' is ON and 'target' has no effect at all. | DM50, DM60, DM70, DM150, DM260 |
| CAMERA.EXPOSURE-US | Camera | PUBLIC | 5.5.0 | SET|GET | auto target exposure gain |
[ON|OFF] [0-255] [5-1000] [12-1000] [5-100000] [0-106] |
ON: Automatic OFF: Manual target pixel value DM300 and DM302 internal illumination DM303 internal illumination with external or no illumination camera gain |
Camera Parameters where exposure is in microseconds. The argument 'exposure' and 'gain' has no effect if 'auto' is ON and 'target' has no effect at all. | DM300 series readers, DM360 series readers, DM474, DM8600. |
| CAMERA.EXPOSURE-US | Camera | PUBLIC | 5.5.0 | SET|GET | auto target exposure gain |
[ON|OFF] [0-255] [12-100000] [0-41] |
ON: Automatic OFF: Manual target pixel value exposure independent of illumination camera gain |
Camera Parameters where exposure is in microseconds. The argument 'exposure' and 'gain' has no effect if 'auto' is ON and 'target' has no effect at all. | DM503 |
| CAMERA.EXPOSURE-US | Camera | PUBLIC | 5.5.0 | SET|GET | auto target exposure gain |
[ON|OFF] [0-255] [50-25000] [0-60] |
ON: Automatic OFF: Manual target pixel value camera gain |
Camera Parameters where exposure is in microseconds. The argument 'exposure' and 'gain' has no effect if 'auto' is ON and 'target' has no effect at all. | MX-1000 and DM8000 series readers. |
| CAMERA.FOV | Camera | PREVIEW | 3.2.0 | SET|GET | left (multiple of 8) right (multiple of 8) top (multiple of 4) bottom (multiple of 4) |
[0...] [left+64...] [0...] [top+64...] |
pixels from left pixels from right pixels from top pixels from bottom |
The camera field of view is the area of the camera used for image acquisition. | ALL |
| CAMERA.FOV-ENABLED | Camera | PUBLIC | 3.2.0 | SET|GET | state |
[ON|OFF] | enable/disable | Indicates whether the full FoV or a custom FoV will be used for image acquisition. You can change this value only for the following trigger types: single, burst, and continuous. |
ALL |
| CAMERA.FULL-BLACK-LEVEL-CORRECTION | Camera | PUBLIC | 5.5.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enables Full black level correction. | DM300 series readers, DM474. |
| CAMERA.GAIN | Camera | PUBLIC | 5.5.0 | SET|GET | gain |
[1.00-31.76] | The gain has no effect if the camera runs with automatic exposure | DM300 series readers, DM474. | |
| CAMERA.GAIN | Camera | PUBLIC | 5.5.0 | SET|GET | gain |
[1.00-13.88] | The gain has no effect if the camera runs with automatic exposure | DM503 | |
| CAMERA.GAIN | Camera | PUBLIC | 5.5.0 | SET|GET | gain |
[1.00-15.00] | The gain has no effect if the camera runs with automatic exposure | DM50, DM60, DM70 | |
| CAMERA.GAIN-LIMIT | Camera | PUBLIC | 5.7.0 | SET|GET | gain |
[1.00-max_gain] | 1.00-max_gain: The maximum gain to use | Controls the maximum gain the tuning and auto-regulation process uses to find the best reader settings. Useful to limit noise in Images. | Fixed mount readers. |
| CAMERA.HDR-ESTIMATED-SCENE-KEY | Camera | PRIVATE | 6.1.0 | SET|GET | estimated scene key |
[0-4095] | Estimated scene key parameter for HDR | DM370 series, DM470 series readers. | |
| CAMERA.HDR-MODE | Camera | PUBLIC | 6.1.0 | SET|GET | mode |
[0-2] |
0: Off 1: Global 2: Local |
HDR mode | DM470 series readers. |
| CAMERA.HDR-MODE | Camera | PUBLIC | 6.1.6 | SET|GET | mode |
[0-1] |
0: Off 1: Global |
HDR mode | DM370 series readers. |
| CAMERA.INTERVAL-US | Camera | PUBLIC | 4.0.0 | SET|GET | us |
[*-1000000] |
Microseconds. Step size is 250. * By default the minimum range is 6000 but this can change depending on decode timeout and field of view. |
Acquisition Interval, the time between successive camera acquisitions in microseconds. Supported with Burst, Self, and Continuous trigger types. | DM50, DM60, DM70, DM474, DM503, and DM300 series readers. |
| CAMERA.MAX-EXPOSURE | Camera | PRIVATE | 3.0.0 | SET|GET | exposure |
[0-20] |
0: 1/20000 1: 1/10000 2: 1/7500 3: 1/5000 4: 1/3000 5: 1/2500 6: 1/2000 7: 1/1500 8: 1/1250 9: 1/1000 10: 1/750 11: 1/500 12: 1/300 13: 1/250 14: 1/200 15: 1/150 16: 1/125 17: 1/100 18: 1/75 19: 1/50 20: 1/40 |
Maximum exposure limit for autoregulation. | MX-1000 and DM8000 series readers. |
| CAMERA.MAX-EXPOSURE-US | Camera | PUBLIC | 4.0.0 | SET|GET | exposure |
[1-50] [1-410] [1-100000] |
with HPIA without HPIA with external or no illumination |
Maximum exposure limit in microseconds for autoregulation. HPIA = High Powered Illumination Accessory. |
DM70, DM150, DM260, DM474, DM503, and DM300 series readers. |
| CAMERA.MAX-EXPOSURE-US | Camera | PUBLIC | 5.1.0 | SET|GET | exposure |
[18-25000] | Maximum exposure limit in microseconds for autoregulation. | DM50, DM60, DM70. | |
| CAMERA.MIRROR-HORIZONTAL | Camera | PUBLIC | 5.2.0 | SET|GET | state |
[ON|OFF] | enable/disable | Mirror acquired image over the vertical axis. | DM474, DM503 and DM300 series readers. |
| CAMERA.MIRROR-VERTICAL | Camera | PUBLIC | 5.2.0 | SET|GET | state |
[ON|OFF] | enable/disable | Mirror acquired image over the horizontal axis. | DM70, DM260, DM474, DM503 and DM300 series readers. |
| CAMERA.ROI | Camera | 3.0.0 | SET|GET | left right top bottom |
|||||
| CAMERA.TARGET-BRIGHTNESS | Camera | PUBLIC | 5.6.0 | SET|GET | target |
[0-255] | target pixel value | Camera Parameters where exposure is in microseconds. | All, except MX series readers. |
| CAMERA.XPAND-ROI | Camera | PUBLIC | 5.5.0 | SET|GET | ROI index left right top bottom |
[1-2] [0 - sensor width] [0 - sensor width] [0 - sensor height] [0 - sensor height] |
ROI index pixels from left pixels from right pixels from top pixels from bottom |
Specifies custom FOVE regions. Requires the 1DDataStitching feature key. |
DM70, DM150, DM260, DM300 series readers, DM474, DM503. |
| CAMERA.XPAND-ROI-TYPE | Camera | PUBLIC | 5.5.0 | SET|GET | int |
[0-3] |
0: None 1: Xpand-15 2: Xpand-25 3: Custom |
Indicates the used FOVE type. Requires the 1DDataStitching feature key. |
DM70, DM150, DM260, DM300 series readers, DM474, DM503. |
| CPFLASH.WRITE | Camera | PRIVATE | 5.0.0 | id |
[0-4] |
0: Unknown 1: Prototype 2: Alpha build with SRAM 3: Alpha build with SDRAM 4: Beta build |
Flash camera port ID. | DM 503. | |
| DEVICE.ID | Camera | PRIVATE | 5.4.0 | GET | string |
Returns the device id. | ALL | ||
| DEVICE.LENS-TYPE | Camera | PRIVATE | 5.0.0 | GET | type |
This command gives you the lens type when a liquid lens is installed. | ALL | ||
| FOCUS.COMPENSATE-AFTER-IDLE | Camera | PRIVATE | 5.2.0 | SET|GET | time |
[1-10000] | idle time | Compensates temperature changes after camera is idle for this time. | Liquid lens. |
| FOCUS.DISTANCE | Camera | PUBLIC | 4.0.0 | SET|GET | int |
Distance in mm from the front of the camera to the part. This command returns the value only if Focus Steps is set to 0, otherwise you need to use FOCUS.SWEEP-RANGE instead. |
DM300 series readers, DM474. | ||
| FOCUS.EXTENDED-RANGE | Camera | PUBLIC | 5.7.0 | GET | value |
[ON|OFF] | Extended Focus Range | Indicates that the reader operates in the extended focus range of ON. In this mode GET FOCUS.DISTANCE will return with an error. | Fixed-mount readers with Liquid Lens |
| FOCUS.EXTENDED-RANGE-START | Camera | PRIVATE | 5.7.0 | SET|GET | distance |
[50..4000] | define start of extended range | Defines the start of the extended focus range. Above this distance only optical power can be used to control the Liquid Lens. | Fixed-mount readers with Liquid Lens |
| FOCUS.FAST-DELAY | Camera | PRIVATE | 4.0.0 | SET|GET | value |
??? | |||
| FOCUS.FEEDBACK | Camera | PUBLIC | 4.3.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enables focus feedback. | DM474, DM503 and DM300 series readers. |
| FOCUS.FOCUS-TIME | Camera | PRIVATE | 4.0.0 | SET|GET | value |
[0-3] | |||
| FOCUS.HALL-SENSOR | Camera | PRIVATE | 5.2.0 | GET | value |
??? | |||
| FOCUS.POWER | Camera | PUBLIC | 5.7.0 | SET|GET | optical power |
[-6.0 .. 20.00] | Optical Power in Diopters | Conrols the optical power of the liquid lens. The actual range is dependent on the hardware and on manufacturing tolerances. | Fixed-mount readers with Liquid Lens |
| FOCUS.POWER-RANGE | Camera | PRIVATE | 5.7.1 | GET | Optical Power |
[liquid lens specific] | Optical Power in Diopters | Return minimum (first value) and maximun (second value) optical power values. | Readers with Liquid Lens |
| FOCUS.PRECISION | Camera | PUBLIC | 5.7.0 | SET|GET | settle mode |
[0..1] |
0: normal focus control 1: precise focus control |
Controls the liquid lens focus control between normal focus control and slow but more precise mode. | Fixed mount readers with a liquid lens. |
| FOCUS.PROGRESS | Camera | PUBLIC | 5.7.0 | SET|GET | enable |
[ON|OFF] |
ON: focus progress on OFF: focus progress off |
Enable transfer of intermittent focus images during adjust focus. | Fixed mount readers with a liquid lens. |
| FOCUS.RELAX-TIME | Camera | PRIVATE | 4.0.0 | SET|GET | value |
??? | |||
| FOCUS.STRATEGY | Camera | PRIVATE | 4.0.0 | SET|GET | value |
??? | |||
| FOCUS.SWEEP-POWER | Camera | PUBLIC | 5.7.3 | SET|GET | Optical Power for near distance Optical Power for far distance |
liquid lens specific liquid lens specific |
Optical Power in Diopters Optical Power in Diopters |
Returns near (first value) and far (second value) optical power values. | Readers with Liquid Lens. |
| FOCUS.SWEEP-RANGE | Camera | PUBLIC | 3.6.0 | SET|GET | DM8000 DM300 |
[0-500] [0-500] [40-500] [40-500] |
low sweep range high sweep range low sweep range high sweep range |
Defines the sweep range to be used for focusing. Low must be less than high. The low value is ignored if FOCUS.SWEEP-STEPS is set to 0. | DM70, DM260, DM300 series, DM474 and DM8000 series readers. |
| FOCUS.SWEEP-STEPS | Camera | PUBLIC | 3.6.0 | SET|GET | value |
[0-8] | number of steps to divide the sweep range | Sets the number of steps the sweep range should be divided by. If steps is set to 0 only the high sweep range value is used. | DM70, DM260, DM474, DM8000 series and DM300 series readers. |
| FOCUS.TEMPERATURE-COMPENSATIONS | Camera | PRIVATE | 5.7.0 | SET|GET | state |
ON/OFF | Enable or disable the temperature compensation for the liquid lense HSLC. | Fixed mount readers with a Liquid Lens. | |
| HEIGHT-SENSOR.CURRENT-MEASUREMENT | Camera | PUBLIC | 6.1.6 | GET | [0-4000] | Distance from the C-Mount Flange in mm | Returns the read out of the ToF range distance in mm. | DM370 series, DM470 series readers. | |
| IMAGE.FETCH | Camera | PRIVATE | 5.7.1 | size format quality |
[0-3] [0-2] [10, 15, 20... 85, 90] |
0: Full 1: 1/4 2: 1/16 3: 1/64 0: Bitmap 1: JPEG 2: PNG JPEG quality |
Acquires an image and transfers it. | ||
| IMAGE.FORMAT | Camera | PUBLIC | 5.6.3 | SET|GET | format |
[0-2] |
0: Bitmap 1: JPEG 2: PNG |
Image File Format. | ALL |
| IMAGE.LOAD | Camera | PRIVATE | 3.0.0 | num-bytes |
Loads image from PC to Reader. | ||||
| IMAGE.LOAD-FTP-MULT-PARAM | Camera | PRIVATE | 4.0.0 | ??? | |||||
| IMAGE.LOAD-FTP-PARAM | Camera | PRIVATE | 4.0.0 | ??? | |||||
| IMAGE.QUALITY | Camera | PUBLIC | 4.4.0 | SET|GET | quality |
[10, 15, 20... 85, 90] | JPEG Quality | Quality of the jpeg image. | ALL |
| IMAGE.SEND-BUFFER | Camera | PRIVATE | 5.6.3 | index size format quality |
[0-3] [0-2] [10, 15, 20... 85, 90] |
0: Full 1: 1/4 2: 1/16 3: 1/64 0: Bitmap 1: JPEG 2: PNG JPEG Quality |
Send specified image buffer date. | ||
| IMAGE.SEND-SLOT | Camera | 3.0.0 | |||||||
| IMAGE.SEND-TYPE | Camera | 3.0.0 | |||||||
| IMAGE.SIZE | Camera | PUBLIC | 4.4.0 | SET|GET | size |
[0-3] |
0: Full 1: 1/4 2: 1/16 3: 1/64 |
Image Size. | ALL |
| LIGHT.AIMER | Camera | PUBLIC | 3.0.0 | SET|GET | aimer-mode |
[0-1] |
0: Off 1: On |
Aimer Enable. Default is ON. |
ALL except for DM503 and DM8050. |
| LIGHT.AIMER | Camera | PUBLIC | 5.4.0 | SET|GET | aimer-mode |
[0,1,3] |
0: Off 1: On 3: Activated by Acceleration Sensor |
Aimer Enable. Default is ON. |
DM8050 |
| LIGHT.AIMER | Camera | PRIVATE | 3.0.0 | SET|GET | aimer-mode |
[0-3] |
0: Off 1: LED 2: Laser 3: Both |
Aimer Enable. | DM700 |
| LIGHT.AIMER | Camera | PRIVATE | 3.0.0 | SET|GET | aimer-mode |
[0-3] |
0: Off 1: On when idle 2: Blink (default) 3: On (default) |
Aimer Enable. | DM7500 |
| LIGHT.AIMER | Camera | PUBLIC | 6.1.6 | SET|GET | aimer-mode |
[0-1] |
0: Off 1: On |
Enables or disables the aimer. | DM370 series, DM470 readers. |
| LIGHT.AIMER-TIMEOUT | Camera | PUBLIC | 4.2.1 | SET|GET | int |
[0-600] | seconds | Aimer Timeout in seconds. | MX-1000 and DM8000 series readers. |
| LIGHT.DARKFIELD-INTENSITY | Camera | PUBLIC | 5.4.3 | SET|GET | value |
[0-15] | Intensity | Darkfield Illumination Intensity. | DM8600 |
| LIGHT.DIFFUSE-INTENSITY | Camera | PUBLIC | 5.4.3 | SET|GET | level |
[0-15] | Intensity | Diffuse Brightfield Illumination Intensity. | DM8600 |
| LIGHT.DIRECT | Camera | PUBLIC | 4.4.0 | SET|GET | north east south west NORTH EAST SOUTH WEST |
[ON|OFF]
[ON|OFF] [ON|OFF] [ON|OFF] [ON|OFF] [ON|OFF] [ON|OFF] [ON|OFF] |
enable/disable
enable/disable enable/disable enable/disable enable/disable enable/disable enable/disable enable/disable |
Sets the quadrants on the DM300. Small letters refer to the inner, capital letters to the outer circle, possible values are ON and OFF for each segment. Example for a SET command: SET LIGHT.DIRECT ON OFF ON ON OFF OFF OFF OFF if you want to have the inner north, south, and west lights on. | DM300 series readers, DM474. |
| LIGHT.DIRECT | Camera | PUBLIC | 5.5.0 | SET|GET | north-east north-west south-east south-west |
[ON|OFF]
[ON|OFF] [ON|OFF] [ON|OFF] |
enable/disable
enable/disable enable/disable enable/disable |
Sets the quadrants on the DM70, DM150 and DM260. Possible values are ON and OFF for each segment. Example for a SET command: SET LIGHT.DIRECT ON OFF OFF ON if you want to have the top-left and bottom-right LED on. | DM70, DM150 and DM260 readers. |
| LIGHT.DIRECT | Camera | PUBLIC | 5.7.7 | SET|GET | state |
[ON|OFF] | enable/disable | Turns on/off light banks for the 8072V. Verification should only take place with lighting combinations that can be described as 30 single, 30T (opposite sides), 30Q (all 30 panels), 45Q (all 45 panels), or 90. Other lighting combinations are allowed by the firmware, but will not result in valid verification result. | DM8072 Verifier |
| LIGHT.DIRECT | Camera | PUBLIC | 6.1.6 | SET|GET | North Corners South East-West |
[ON|OFF]
[ON|OFF] [ON|OFF] [ON|OFF] |
enable/disable
enable/disable enable/disable enable/disable |
Enables or disables the HPIT quadrants. | DM370 series, DM470 series readers. |
| LIGHT.DIRECT-INTENSITY | Camera | PUBLIC | 5.1.0 | SET|GET | level |
[0-15] | Intensity | Direct Illumination Intensity. | DM50, DM60, DM474, DM503 and DM300 series readers. |
| LIGHT.DIRECT-INTENSITY | Camera | PUBLIC | 5.4.3 | SET|GET | level |
[1-15] | Intensity | Direct Illumination Intensity. | DM8050 |
| LIGHT.EXTERNAL-ENABLE | Camera | PUBLIC | 4.1.0 | SET|GET | enable |
[ON|OFF] | enable/disable | Enable external illumination supported by I/O. | Fixed mount readers. |
| LIGHT.EXTERNAL-INTENSITY | Camera | PUBLIC | 5.2.0 | SET|GET | level |
[0-15] | Intensity | Sets the intensity of the external illumination. | Fixed mount readers. |
| LIGHT.EXTERNAL-POLARITY | Camera | PUBLIC | 3.0.0 | SET|GET | polarity |
[0-1] |
0: Active Low 1: Active High |
External illlumination output polarity. | Fixed mount readers except for DM70, DM150, DM260. |
| LIGHT.EXTERNAL-PRECHARGE-TIME | Camera | PREVIEW | 3.0.0 | SET|GET | time |
[1-980] | microseconds | External light precharge time. | Fixed mount readers. |
| LIGHT.HIGH-FREQUENCY | Camera | PUBLIC | 5.2.0 | SET|GET | enable |
[ON|OFF] | enable/disable | Enables High Frequency Lights to avoid flickering illumination. | DM50, DM60, DM70, DM474, DM503, and DM300 series readers. |
| LIGHT.HIGH-FREQUENCY-ALWAYS | Camera | PUBLIC | 5.2.0 | SET|GET | enable seconds |
[ON|OFF] 0-86400 |
enable/disable auto off duration |
Enables High Frequency Light in Continuous trigger mode even if no trigger is active. After duration seconds the High Frequency Light is turned off. If the duration is 0 the light is never turned off. | DM50, DM60, DM70, DM474, DM503, and DM300 series readers. |
| LIGHT.HIGH-FREQUENCY-FORCE | Camera | PRIVATE | 5.2.0 | SET|GET | enable |
[ON|OFF] | enable/disable | Enable High Frequency Lights even if overheat protection would normally prohibit it. | DM300 series readers |
| LIGHT.INTERNAL-ENABLE | Camera | PUBLIC | 4.1.0 | SET|GET | enable |
[ON|OFF] | enable/disable | Enable the built-in internal illumination. Default value is OFF. | DM50, DM60, DM70, DM8050, MX-1000, MX-1502, Mobile. |
| LIGHT.LOW-ANGLE | Camera | PUBLIC | 5.7.0 | SET|GET | state |
[ON|OFF] [ON|OFF] | enable/disable low-angle illumination | Controls the DM262 UHD low-angle illumination. | DM262 |
| LIGHT.ON-AXIS | Camera | PUBLIC | 5.7.0 | SET|GET | state |
[ON|OFF] [ON|OFF] | enable/disable on-axis illumination | Controls the DM262 UHD on-axis illumination. | DM262 |
| LIGHT.ON-AXIS-INTENSITY | Camera | PRIVATE | 5.7.0 | SET|GET | intensity |
[0..3] | on-axis illumination intensity | Controls the intensity of the DM262 UHD on-axis illumination. | DM262 |
| LIGHT.POLARIZED | Camera | PUBLIC | 5.6.0 | SET|GET | polarized LED count |
[0|2|4] | Number of polarized filtered LEDs in the illumination | Use this command after applying a different HPIL front cover to publish the illumination filter status to the device. | DM70, DM150, DM260 |
| LIGHT.SELF-REPAIR | Camera | PRIVATE | 5.5.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enables/disables internal illumination self repair mode. | DM300 series readers |
| LIVEIMG.MODE | Camera | PUBLIC | 5.2.0 | SET|GET | mode |
[0,2] |
0: Disable 2: Enable |
Controls live image display. | ALL |
| LIVEIMG.SEND | Camera | PUBLIC | 5.6.3 | size format quality |
[0-3] [0-2] [10, 15, 20... 85, 90] |
0: Full 1: 1/4 2: 1/16 3: 1/64 0: Bitmap 1: JPEG 2: PNG JPEG Quality |
Request image transfer to PC when LIVEIMG.MODE is set to 3. | ||
| MASTER-SLAVE.RX-HEIGHT-SENSOR | Camera | PUBLIC | 4.1.0 | SET|GET | enable |
[ON|OFF]* | enable/disable | Enables or disables this system receiving height information from another system in the network group. | DM60, DM474 and DM300 series readers. |
| MONITOR-MODE.AUTOEXPOSURE | Camera | PUBLIC | 5.7.1 | SET|GET | state |
[ON|OFF] | enable/disable | Enable/disable autoregulation while in monitor mode. | ALL |
| MONITOR-MODE.DECODE-ENABLE | Camera | PUBLIC | 5.7.1 | SET|GET | mode |
[ON|OFF] | enable/disable | ALL | |
| MONITOR-MODE.ENABLE | Camera | PUBLIC | 6.0.1 | SET|GET | state |
[ON|OFF] | enable/disable | Enable/disable monitor mode. | ALL |
| SETUP.ENABLE | Camera | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Setup Enable. One Setup must always be enabled. Enable the desired Setup, before disabiling another Setup. For DM300 series readers, this command works for the active setup. |
DM50, DM60, DM70, DM150, DM260, DM474, DM503, DM8600, MX-1000 and DM300 series readers. |
| SETUP.NAME | Camera | PUBLIC | 3.0.0 | SET|GET | name |
Setup Name. User defined name. |
DM50, DM60, DM70, DM150, DM260, DM474, DM503, DM8600, MX-1000, and DM300 series readers. | ||
| SETUP.PROG-TARGET | Camera | PUBLIC | 3.0.0 | SET|GET | category |
[0-3] |
0: General Purpose 1: Curved Surface 2: Under Marked 3: Mirrored Surface |
Setup Programming Target. Setup to be modified by subsequent commands. |
DM70, DM150, DM260, DM8600 and MX-1000 |
| SETUP.PROG-TARGET | Camera | PUBLIC | 5.0.0 | SET|GET | category |
[0-15] | A number signifying an already existing setup. | Setup Programming Target. Setup to be modified by subsequent commands. |
DM50, DM60, DM70, DM150, DM260, DM474, DM503 and DM300 series readers. |
| SETUP.START-WITH-LAST-READ | Camera | PUBLIC | 5.2.0 | SET|GET | mode |
[ON|OFF] |
enable/disable
OFF: Start with fixed setup ON: Start with setup of last good read |
Sets read setup. | DM8600, DM70, DM150, DM260, DM474, DM503, MX-1000, MX-1502 and DM300 series readers. |
| SETUP.START-WITH-SETUP | Camera | PUBLIC | 5.2.0 | SET|GET | setup |
[0-15] | setup number to start with | Starts read setup. | DM8600, DM70, DM150, DM260, DM474, DM503, MX-1000, MX-1502 and DM300 series readers. |
| SETUP.USE | Camera | PUBLIC | 5.2.0 | int state |
[1-15] [ON|OFF] |
Setup to change enable/disable Disables/Enables setup to be used. |
Adds or removes a setup from the list of usable Read Setups. | DM8600, DM70, DM150, DM260, DM474, DM503 and DM300 series readers. | |
| TRIGGER.DELAY | Camera | PRIVATE | 3.0.0 | SET|GET | milliseconds |
[0-10000] | Trigger Delay. Delay camera acquisition by specified number of milliseconds. |
ALL | |
| TRIGGER.DELAY-DISTANCE | Camera | PUBLIC | 4.4.0 | SET|GET | millimeter |
[0-2147483646] | Delay camera acquisition by distance specified in millimeters. | DM503, DM474 and DM300 series readers. | |
| TRIGGER.DELAY-TIME | Camera | PUBLIC | 4.4.0 | SET|GET | milliseconds |
[0-10000] | Trigger delay in milliseconds. Delay camera acquisition by specified number of milliseconds. |
DM50, DM60, DM70, DM474, DM503, and DM300 series readers. | |
| TRIGGER.DELAY-TYPE | Camera | PUBLIC | 4.4.0 | SET|GET | mode |
[0-1] |
0: none 1: time |
Sets or gets whether trigger delay is according to time. | DM50, DM60 and DM70 |
| TRIGGER.DELAY-TYPE | Camera | PUBLIC | 4.4.0 | SET|GET | mode |
[0-2] |
0: none 1: time 2: distance |
Sets or gets whether trigger delay is according to time or distance. | DM503, DM474 and DM300 series readers. |
| TRIGGER.END-DELAY-DISTANCE | Camera | PUBLIC | 4.4.0 | SET|GET | millimeters |
[0-2147483646] | Sets or gets trigger end delay distance. | DM474, DM503 and DM300 series readers. | |
| TRIGGER.END-DELAY-TIME | Camera | PUBLIC | 4.4.0 | SET|GET | milliseconds |
[0-10000] | Sets or gets trigger end delay time. | DM50, DM60, DM70, DM474, DM503, and DM300 series readers. | |
| TRIGGER.TYPE | Camera | PUBLIC | 3.0.0 | SET|GET | type |
[0-5] |
0: Single (external) 1: Presentation (internal) 2: Manual (button) 3: Burst (external) 4: Self (internal) 5: Continuous (external) |
Trigger Type. The camera API should return the current trigger type value. | DM700 and DM8000 series readers support only Presentation and Manual trigger types. MX-1000, MX-1502 and Mobile support only Manual and Continuous trigger types. |
| TUNE.ADJUST-FOCUS | Camera | PUBLIC | 4.3.0 | SET|GET | state |
[ON|OFF] | Enables or disables using adjusting focus while tuning. | DM70, DM150, DM260, DM474 and DM300 series readers with liquid lens. | |
| TUNE.EXCLUDE-AMBIENT-RESULTS | Camera | PUBLIC | 5.7.0 | SET|GET | disable ambient |
[ON|OFF] |
ON: Disables the automatic selection of ambient light results OFF: Allows ambient light results for atomatic seletion |
Control the automatic selection of tuning results where the prevailing illumination type is ambient light. | Fixed mount readers. |
| TUNE.TRAIN-CODE | Camera | PUBLIC | 4.3.0 | SET|GET | state |
[ON|OFF] | Enables or disables code training while tuning. | DM300 series readers, DM474, DM70, DM260, and DM150. | |
| TUNE.TUNE-LIGHT-BANKS | Camera | PUBLIC | 4.3.0 | SET|GET | state |
[ON|OFF] | Enables or disables using light banks while tuning. Only available when internal illumination is used. |
DM300 series readers, DM474, DM260, DM70 and DM150. | |
| TUNE.TUNE-LIGHT-COMBINATIONS | Camera | PUBLIC | 5.5.0 | SET|GET | mode |
[ON|OFF] | If it is ON, light combinations will always be tuned. | DM300 series readers, DM474, DM260, DM70 and DM150. | |
| VSOC.LEGACY-AUTO-REG | Camera | PRIVATE | 4.0.0 | SET|GET | enable |
[ON|OFF] | enable/disable | Enabled or disable VSOC auto-regulation algorithm. | |
| CQ | Code Quality | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable Code Quality. Code Quality Measurements require reader calibration and the Verification Feature Key. |
DM8600V |
| CQ.CALIB-DATE | Code Quality | PUBLIC | 3.0.0 | GET | Device Code Quality Calibration Date. | DM8600V | |||
| CQ.ILLUMINATION | Code Quality | PUBLIC | 3.0.0 | SET|GET | illumination-option state |
[0-4] [ON|OFF] |
0: Direct on axis 1: 30-deg All Quadrants 2: 30-deg E-W Quadrants 3: 30-deg N-S Quadrants 4: Custom enable/disable |
Code Quality Illumination Option. | DM8600V |
| CQ.METRICS | Code Quality | PUBLIC | 3.0.0 | SET|GET | metric |
[0-3] |
0: AIM-DPM/ISO/IEC TR 29158 1: ISO/IEC 15415 2: AS9132 Laser-etch 3: AS9132 Dot-peen |
Code Quality Enabled Metrics. | DM8600V |
| CQ.MINPASS | Code Quality | PUBLIC | 3.0.0 | SET|GET | metric min-pass |
[0-1] [0-4] |
0: AIM-DPM/ISO/IEC TR 29158 1: ISO/IEC 15415 0: F 1: D 2: C 3: B 4: A |
Code Quality Minimum Passing Grade. Determines the threshold for "validation failure action" including beep and configured line output. |
DM8600V |
| CQ.PROCESSM | Code Quality | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Code Quality Process Control Metrics. | DM8600V |
| CQ.RESET-CALIBRATION | Code Quality | PUBLIC | 3.3.0 | Invalidates code quality calibration data. Reboot is required. |
DM8600V | ||||
| CQ.UNITS | Code Quality | PUBLIC | 3.0.0 | SET|GET | option |
[0-3] |
0: mils 1: mm 2: inches 3: pixels |
Code Quality Units. | DM8600V |
| MQA.POSTAL-HEIGHT_MICRON | Code Quality | PRIVATE | 4.4.1_cr7 and 5.0.0_cr6 | SET|GET | height |
Height in microns per pixel for MERLIN metrics. | DM300 series readers, DM474. | ||
| MQA.POSTAL-MODE | Code Quality | PRIVATE | 4.0.0 | SET|GET | mode |
[0-2] |
0: Off 1: Partial Metrics 2: All Metrics |
Gets or sets the postal verification mode. | ALL |
| SYMBOL.C39-CONVERT-TO-C32 | Code Quality | PUBLIC | 5.5.0 | SET|GET | state |
[ON|OFF] | enable/disable | Parameter enables or disables Code39 to Code 32 conversion. | DM70, DM150, DM260 |
| ACCEL-SENSOR.OPERATION-MODE | Communication | PUBLIC | 5.4.0 | SET|GET | int |
[0-1] |
0: Acceleration Sensor is not used for waking the reader up from hibernation. 1: Acceleration Sensor is used for waking the reader up from hibernation. |
Configures the application of the acceleration sensor. This command is only valid for Bluetooth-connected readers. |
DM8050, DM8600. |
| ACCEL-SENSOR.SENSITIVITY | Communication | PUBLIC | 5.4.0 | SET|GET | int |
[0-2] |
0: Low 1: Medium 2: High |
Gets/sets the sensitivity of the acceleration sensor of/to the predefined value. | DM8050, DM8600. |
| ANDROID.AOA-SWITCH-TIMEOUT | Communication | PUBLIC | 5.7.1 | SET|GET | timeout [ms] |
0-3600000 | Timeout in milliseconds. | After boot the MX device won’t switch to AOA mode for this amount of time. | MX-1000, MX-1502 |
| ANDROID.ROLE | Communication | PUBLIC | 5.7.1 | SET|GET | role |
0-2 |
0: Auto 1: Device 2: AOA |
Sets the USB role of the MX device when in Android mode. | MX-1000, MX-1502 |
| BLUETOOTH.KBM-PIN | Communication | PRIVATE | 5.4.3 | SET|GET | string |
0-16 characters of decimal number | PIN number (e.g. "1234") | Gets or sets the PIN number of the remote target. | DM8050, DM8600. |
| BLUETOOTH.KBM-TARGET-ADDR | Communication | PRIVATE | 5.4.3 | SET|GET | string |
8 characters of hexadecimal number | MAC address (e.g. "0006660492A6") | Gets or sets the MAC address of the remote target. | DM8050, DM8600. |
| BLUETOOTH.MAC-ADDRESS | Communication | PUBLIC | 5.4.0 | GET | Returns the own Bluetooth address of the device. | DM8050, DM8600. | |||
| BLUETOOTH.MAX-RF-POWER | Communication | PUBLIC | 5.4.3 | SET|GET | int |
-23-7 | Maximum output power in dBm | DM8050, DM8600, and Bluetooth base stations. | |
| BLUETOOTH.OPERATION-MODE | Communication | PRIVATE | 5.4.3 | SET|GET | number |
[0-2] |
0: normal mode 1: PC connect mode 2: keyboard emulator mode |
Gets or sets the Bluetooth operation mode. | DM8050, DM8600. |
| BUTTON.SAVE-MATCH-STRING | Communication | PUBLIC | 4.5.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enables or disables saving the trained match string directly to flash when Set Match String is enabled for the 3 sec button press action. If disabled, the match string is only stored in RAM and if the configuration is not saved manually it will be gone after reboot. | DM474, DM503, and DM300 series readers. |
| COM.AUTO-DETECT | Communication | PRIVATE | 3.0.0 | SET|GET | state |
[ON|OFF] [ON|OFF] | enable/disable | Enables support for simultaneous connection to USB And RS-232. | |
| COM.BAUD-RATE | Communication | PUBLIC | 3.0.0 | SET|GET | rate |
[1-5] |
1: 115200 2: 57600 3: 38400 4: 19200 5: 9600 |
ALL except for MX-1000. | |
| COM.BUFFER-AUTO-FLUSH | Communication | PUBLIC | 4.2.1 | SET|GET | state |
[ON|OFF] | enable/disable | Determines if the whole content of the offline buffer is automatically flushed to the first Telnet client. If not, flushing must be activated by the client. | Wireless readers. |
| COM.BUFFER-DATA | Communication | PUBLIC | 4.2.1 | SET|GET | state |
[ON|OFF] | enable/disable | Offline buffering. | Wireless readers. |
| COM.BUFFER-MODE | Communication | PUBLIC | 4.2.2 | SET|GET | int |
[0-1] |
0: Multiple 1: Single |
Sets or gets the offline buffering mode. | Wireless DM8000 readers. |
| COM.COMMUNICATIONS-MODULE | Communication | PUBLIC | 4.2.0 | GET | type |
[0-3] |
0: Serial 1: Ethernet 2: Wireless 3: Bluetooth |
Returns the type of communication module being used. | MX-1000 and DM8000 series readers. |
| COM.DATA-BITS | Communication | PUBLIC | 3.0.0 | SET|GET | bits |
[7,8] | ALL except for MX-1000. | ||
| COM.DMCC-CHECKSUM | Communication | PRIVATE | 3.4.0 | SET|GET | type |
[0-3] |
0: none 1: XOR 2: CRC16 (Header/Response) 3: CRC16 (Header/Response/Data) |
Checksum used in DMCC response. | |
| COM.DMCC-EVENT | Communication | PRIVATE | 4.2.0 | SET|GET | event_mask |
[0-255] bitfield |
0: none 1: reader online/offline |
Sets which events are sent over DMCC. Used by DataMan SDK. | Wireless readers, base station. |
| COM.DMCC-HEADER | Communication | PRIVATE | 3.4.0 | SET|GET | type |
[0-1] |
0: default 1: include result ID |
Sets or gets the header option used in Extended mode. | |
| COM.DMCC-RESPONSE | Communication | PUBLIC | 3.0.0 | SET|GET | mode |
[0|1] |
0: Silent (default) 1: Extended |
DMCC response format. | ALL |
| COM.DMCC-RESPONSE | Communication | PRIVATE | 3.0.0 | SET|GET | mode |
[0-2] |
0: Silent (default) 1: Extended 2: Extended mode with ||[xxx::length] CR NL data Responses |
DMCC response format. | ALL |
| COM.INTERFACE | Communication | PRIVATE | 5.4.3 | GET | Supported interfaces: RS232, USB, Ethernet, WiFi, Bluetooth. | ||||
| COM.MULTI-PORT | Communication | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable daisy chaining of readers so they share one COM port. | Fixed mount readers. |
| COM.PARITY | Communication | PUBLIC | 3.0.0 | SET|GET | parity |
[0-4] |
0: None 1: Even 2: Odd 3: Space 4: Mark |
All except for MX-1000 and MX-1502. | |
| COM.PROTOCOL | Communication | PUBLIC | 5.7.0 | SET|GET | type |
0..1 |
0: Off 1: RTS/CTS |
Sets hardware handshake type of serial port. | Devices with RTS/CTS lines |
| COM.RS232-ENABLE-PAUSE | Communication | PUBLIC | 5.5.0 | SET|GET | mode |
ON/OFF | Enable/disable pause in output data stream. | DM300 series readers, DM60, DM50, DM70, DM474 | |
| COM.RS232-FILTER | Communication | PRIVATE | 5.0.0_cr7 | SET|GET | state |
[ON|OFF] | enable/disable | Enable or disable the RS-232 filter. | DM300 series readers, DM474. |
| COM.RS232-FILTER-CHAR | Communication | PRIVATE | 5.0.0_cr7 | SET|GET | char |
[0x00-0xFF] | Hex char | Sets or gets the hex value of the character to start filtering after (e.g. 0x03 for ETX). | DM300 series readers, DM474. |
| COM.RS232-INTERCHAR-DELAY | Communication | PUBLIC | 5.5.0 | SET|GET | us |
[0-5000] | milliseconds | Sets or gets the internal delay between sending characters to the serial port. | DM300 series readers, DM60, DM50, DM70, DM360 series readers, DM474, DM503 |
| COM.RS232-ROUTE | Communication | PUBLIC | 4.2.1 | SET|GET | value |
[0-1] |
0: base station 1: associated reader |
Controls to which device RS-232 communication is routed. | DM8000 series wireless readers. |
| COM.SCRIPT | Communication | PRIVATE | 5.3.0 | SET|GET | num-bytes |
Load script from communication channel. | DM474, DM503 and DM300 series readers. | ||
| COM.SCRIPT | Communication | PUBLIC | 5.5.0 | SET|GET | num-bytes |
GET: Retrieves the current communication script. SET: Uploads a communication script. | Fixed-mount readers. | ||
| COM.SCRIPT-ENABLED | Communication | PRIVATE | 5.3.0 | SET|GET | bool |
DM474, DM503 and DM300 series readers. | |||
| COM.SCRIPT-ENABLED | Communication | PUBLIC | 5.5.0 | SET|GET | bool |
Enables/disables communication scripting or retrieves current state. | Fixed-mount readers. | ||
| COM.SCRIPT-ERROR | Communication | PUBLIC | 5.5.0 | GET | message |
script error message | Get the error message for the Custom Communication protocol script | Fixed-mount readers. | |
| COM.STOP-BITS | Communication | PUBLIC | 3.0.0 | SET|GET | bits |
[1-2] | ALL except for MX-1000. | ||
| COM.USB-COMPATIBILITY-MODE | Communication | PUBLIC | 3.0.0 | SET|GET | legacy |
[ON|OFF] |
ON: use pre-3.5.0 driver OFF: default |
Controls USB driver. Reboot is required. |
DM50, DM70 and DM8000 series readers. |
| COM.USB-HID-ONLY | Communication | PUBLIC | 5.4.0 | SET|GET | state |
[ON|OFF] | enable/disable | When enabled, the base station will appear as a single USB Keyboard device on its USB port, instead of a composite device. | DM8000 base station G2 |
| COM.USB-MODE | Communication | PUBLIC | 4.2.1 | SET|GET | type |
[0-1] |
0: USB COM 1: USB HID |
Controls USB based communication channels. | DM50, DM60, DM70, MX-1000, MX-1502 and DM8000 series readers. |
| COM.USB-RE-ENUMERATE-ON-START | Communication | PUBLIC | 5.5 | SET|GET | state |
[ON|OFF]
[ON|OFF] |
enable/disable
ON: USB 1.1 mode OFF: USB 2.0 mode |
Feature to re-enumerate the COM port after firmware is started. | DM8000 series readers. |
| COM.USB-REQUIRE-DTR | Communication | PUBLIC | 5.5.0 | SET|GET | state |
[ON|OFF] [ON|OFF] | enable/disable Enable/Disable | Turns the requirement to assert DTR signal during USB communication On or Off. | DM8050 |
| COM.USB-SPEED | Communication | PUBLIC | 4.2.1 | SET|GET | int |
[ON|OFF] |
ON: USB 1.1 mode OFF: USB 2.0 mode |
Forces the USB into full speed mode. | Every reader connected through USB except MX-1000. |
| COM.USB-TEST-SN | Communication | PRIVATE | 4.2.0 | SET|GET | string |
test serial number | Used by manufacturing to make different devices enumerate on the same CDC COM port. | Base station, DM50, DM60 and DM70. | |
| COM.USB-USE-TEST-SN | Communication | PRIVATE | 4.2.0 | SET|GET | state |
[ON|OFF] [ON|OFF] | enable/disable | Used by manufacturing to make different devices enumerate on the same CDC COM port. | Base station, DM50, DM60 and DM70. |
| COM.WAKEUP | Communication | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Wakeup Message. | ALL |
| COM.XLATEPRNT | Communication | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Translate unprintable characters that are embedded in a symbol. The translated result is output over the connection (for example, COM, USB, Ethernet, USB-KEYBOARD). Note that Data Formatting leading and terminating text are not translated. The characters translated are ASCII values between 0x00 and 0x1F. For example, 0x00 = <NUL>, 0x04 = <EOT>, 0x0a = <LF>, 0x0d = <CR>. | ALL |
| CONFIG-BACKUP.SERVER-TYPE | Communication | PUBLIC | 5.5.0 | SET|GET | type |
[0-1] |
0: Generic 1: Mitsubishi GOT |
Configuration backup server type. | DM474, DM503 and DM300 series readers. |
| CUSTOM-CMD.COMMAND-FOOTER | Communication | PUBLIC | 3.2.0 | SET|GET | string |
End of the string to be echoed. See the Overview topic for formatting requirements for the string argument. |
Fixed mount readers. | ||
| CUSTOM-CMD.COMMAND-HEADER | Communication | PUBLIC | 3.2.0 | SET|GET | string |
Start of the string to be echoed. | Fixed mount readers. | ||
| CUSTOM-CMD.ECHO | Communication | PUBLIC | 3.2.0 | SET|GET | state |
[ON|OFF] | enable/disable | Indicates if characters received between a COMMAND-HEADER and COMMAND-FOOTER are echoed. | Fixed mount readers. |
| CUSTOM-CMD.TRIGGER | Communication | PUBLIC | 3.2.0 | SET|GET | state |
[ON|OFF] | enable/disable | Indicates if reader will respond to the TRIGGER-ON or TRIGGER-OFF string. | Fixed mount readers. |
| CUSTOM-CMD.TRIGGER-OFF | Communication | PUBLIC | 3.2.0 | SET|GET | string |
String that will stop a trigger. See the Overview topic for formatting requirements for the string argument. |
Fixed mount readers. | ||
| CUSTOM-CMD.TRIGGER-ON | Communication | PUBLIC | 3.2.0 | SET|GET | string |
String that will start a trigger. See the Overview topic for formatting requirements for the string argument. |
Fixed mount readers. | ||
| DATA.IMAGE-TYPE | Communication | PRIVATE | 3.4.0 | SET|GET | type |
[0-2] |
0: all 1: no read 2: read |
Sets or gets type of image automatically returned. Used in conjuction with DATA.RESULT-TYPE. | |
| DATA.RESULT-ENCODING | Communication | PUBLIC | 3.1.0 | SET|GET | encoding |
[0|1] |
0: ASCII (default) 1: Base64 |
Result string encoding. | ALL |
| DEVICE.MAC-ADDRESS | Communication | PUBLIC | 3.3.0 | GET | Reader's MAC address. | Ethernet readers. | |||
| DEVICE.SCRIPT-HEAP-SIZE-LIMIT | Communication | PRIVATE | 5.5.0 | SET|GET | size |
204800-2147483647 | Maximum size in bytes | Maximum heap size the script engine may allocate. | Fixed mount readers |
| DEVICE.SCRIPT-HEAP-USAGE-CURRENT | Communication | PRIVATE | 5.5.0 | GET | size |
Currently used heap size | The size of heap the script currently allocates. | Fixed mount readers | |
| DEVICE.SCRIPT-HEAP-USAGE-MAX | Communication | PRIVATE | 5.5.0 | GET | size |
Maximum used heap size | The maximum size of heap the script allocated allocated. | Fixed mount readers | |
| DEVICE.SSID | Communication | PUBLIC | 4.2.0 | SET|GET | string |
Network name. | Wireless readers. | ||
| DEVICE.SYSLOG-IP | Communication | PRIVATE | 5.0.0 | SET|GET | string |
Specifies the remote syslog server IP address. | |||
| ETHERNET-IP.ENABLED | Communication | PUBLIC | 3.3.0_cr1 | SET|GET | state |
[ON|OFF] | enable/disable | Enabled or disabled EtherNet/IP communications. | Ethernet readers. The DM8000 series wireless readers also support this protocol if the base station is connected through Ethernet. In the case of a Bluetooth connection, the command has to be sent to the base station, not to the reader. |
| FTP-IMAGE.CUSTOM-FILE-NAME | Communication | PUBLIC | 3.3.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable/disable FTP server generated file name. | Ethernet readers. DM8000 series wireless readers also support FTP if the base station is connected through Ethernet. |
| FTP-IMAGE.FILE-NAME | Communication | PUBLIC | 3.3.0 | SET|GET | string |
File name of FTP image. | Ethernet readers. DM8000 series wireless readers also support FTP if the base station is connected through Ethernet. | ||
| FTP-IMAGE.FILE-NAME-USE-SCRIPT | Communication | PUBLIC | 5.2.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enables FTP file name generation script. | DM474, DM503 and DM300 series readers. |
| FTP-IMAGE.IDLE-LIMIT | Communication | PUBLIC | 5.5.0 | SET|GET | state |
[ON|OFF] | enable/disable | Limit duration of idle connections. | DM474, DM503 and DM300 series readers. |
| FTP-IMAGE.IDLE-TIME | Communication | PUBLIC | 5.5.0 | SET|GET | seconds |
Maximum duration of telling the FTP server that the reader is alive. | DM474, DM503 and DM300 series readers. | ||
| FTP-IMAGE.IP-ADDRESS | Communication | PUBLIC | 3.3.0 | SET|GET | string |
IP address of target FTP server. Uses dotted decimal form, such as "192.168.23.42". |
Ethernet readers. DM8000 series wireless readers also support FTP if the base station is connected through Ethernet. | ||
| FTP-IMAGE.MAX-APPEND | Communication | PUBLIC | 3.3.0 | SET|GET | value |
[0-65535] | Max increment value to append to image name. | Ethernet readers. DM8000 series wireless readers also support FTP if the base station is connected through Ethernet. | |
| FTP-IMAGE.MAX-APPEND-START-VALUE | Communication | PUBLIC | 4.0.0 | SET|GET | value |
[0-65535] | Initial increment value to append to image name. | DM503 | |
| FTP-IMAGE.PASSWORD | Communication | PUBLIC | 3.3.0 | SET | string |
Password used to login to target FTP server. | Ethernet readers. DM8000 series wireless readers also support FTP if the base station is connected through Ethernet. | ||
| FTP-IMAGE.PORT | Communication | PUBLIC | 4.0.0 | SET|GET | port |
[0-65535] | FTP server port number. | Ethernet readers. DM8000 series wireless readers also support FTP if the base station is connected through Ethernet. | |
| FTP-IMAGE.PRIORITY | Communication | PRIVATE | 5.2.0 | SET|GET | value |
[0-2] |
0: High - above decoder 1: Medium - same as running decoder 2: Low - below running decoder |
FTP thread priority. | Ethernet readers. DM8000 series wireless readers also support FTP if the base station is connected through Ethernet. |
| FTP-IMAGE.SERVER-PATH | Communication | PUBLIC | 3.3.0 | SET|GET | string |
Path for FTP image. | Ethernet readers. DM8000 series wireless readers also support FTP if the base station is connected through Ethernet. | ||
| FTP-IMAGE.SERVER-PATH-SCRIPT | Communication | PUBLIC | 5.2.0 | SET|GET | num-bytes |
Set: loads the script from the host to the reader. Get: sends the script from the reader to the host. | DM474, DM503 and DM300 series readers. | ||
| FTP-IMAGE.SERVER-PATH-SCRIPT-ERROR | Communication | PUBLIC | 5.5.0 | GET | message |
script error message | Gets the script error message for FTP Storage name generation . | Fixed-mount readers. | |
| FTP-IMAGE.SERVER-TYPE | Communication | PUBLIC | 5.6.3 | SET|GET | type |
[0-2] |
0: Generic 1: Mitsubishi GOT 2: SFTP |
FTP image server type. 2 means that the server is an S(SH)FTP server. | DM474, DM503 and DM300 series readers. |
| FTP-IMAGE.USER-NAME | Communication | PUBLIC | 3.3.0 | SET|GET | string |
Username used to login to target FTP server. | Ethernet readers. DM8000 series wireless readers also support FTP if the base station is connected through Ethernet. | ||
| FTP-PCM-REPORT.CUSTOM-FILE-NAME | Communication | PUBLIC | 5.7.0 | SET|GET | state |
ON/OFF |
enable disable |
Enable/disable customize file name generation (if disabled the FTP server has to generate a unique name). | Ethernet readers |
| FTP-PCM-REPORT.ENABLE | Communication | PUBLIC | 5.7.0 | SET|GET | enable |
ON/OFF | Enable or disable a PCM Report FTP connection. | Ethernet readers | |
| FTP-PCM-REPORT.FILE-NAME | Communication | PUBLIC | 5.7.0 | SET|GET | string |
File name of PCM Report. | Ethernet readers | ||
| FTP-PCM-REPORT.FILE-NAME-USE-SCRIPT | Communication | PUBLIC | 5.7.0 | SET|GET | state |
ON/OFF |
enable disable |
Enables PCM report file name generation by script. | Ethernet readers |
| FTP-PCM-REPORT.IDLE-LIMIT | Communication | PUBLIC | 5.7.0 | SET|GET | state |
ON/OFF |
enable disable |
Limit duration of idle connections after a data transfer. | Ethernet readers |
| FTP-PCM-REPORT.IDLE-TIME | Communication | PUBLIC | 5.7.0 | SET|GET | seconds |
[0-3600] | Maximum duration of idle connections after a data transfer. | Ethernet readers | |
| FTP-PCM-REPORT.IP-ADDRESS | Communication | PUBLIC | 5.7.0 | SET|GET | server |
IP address or DNS name | Set the PCM Report FTP server. | Ethernet readers | |
| FTP-PCM-REPORT.MAX-APPEND | Communication | PUBLIC | 5.7.0 | SET|GET | value |
[0-65535] | Max increment value to append to PCM report file name. | Ethernet readers | |
| FTP-PCM-REPORT.MAX-APPEND-START-VALUE | Communication | PUBLIC | 5.7.0 | SET|GET | value |
[0-65535] | Initial increment value to append to PCM report file name. | Ethernet readers | |
| FTP-PCM-REPORT.PASSWORD | Communication | PUBLIC | 5.7.0 | SET|GET | string |
PASSWORD used to login to target PCM Report FTP server. | Ethernet readers | ||
| FTP-PCM-REPORT.PORT | Communication | PUBLIC | 5.7.0 | SET|GET | port |
[0-65535] | PCM Report FTP server port number. | Ethernet readers | |
| FTP-PCM-REPORT.SCRIPT-ERROR | Communication | PUBLIC | 5.7.0 | GET | message |
script error message | Gets the script error message for FTP PCM report file name generation. | Ethernet readers | |
| FTP-PCM-REPORT.SERVER-PATH | Communication | PUBLIC | 5.7.0 | SET|GET | string |
Path for PCM Reports which has to be named by the FTP Server. | Ethernet readers | ||
| FTP-PCM-REPORT.SERVER-TYPE | Communication | PUBLIC | 5.7.0 | SET|GET | type |
[0-2] |
0: Generic 1: Mitsubishi GOT 2: SFTP(encrypted) |
FTP server type. | Ethernet readers |
| FTP-PCM-REPORT.USER-NAME | Communication | PUBLIC | 5.7.0 | SET|GET | string |
Username used to login to target PCM Report FTP server. | Ethernet readers | ||
| FTP-PROXY.CONNECT | Communication | PRIVATE | 4.2.0 | index |
[0-15] | FTP object index as returned by FTP-PROXY.CREATE | Used by wireless readers to proxy FTP transfer through base station. | Base station. | |
| FTP-PROXY.CREATE | Communication | PRIVATE | 4.2.0 | user pass server port type |
dotted decimal from IPv4 address [1-65535] [0-1] |
Password. Target FTP server address. Target FTP port number. Target FTP server type (Generic/Mitsubishi). |
Used by wireless readers to proxy FTP transfer through base station. | Base station. | |
| FTP-PROXY.DESTROY | Communication | PRIVATE | 4.2.0 | index |
[0-15] | FTP object index as returned by FTP-PROXY.CREATE | Used by wireless readers to proxy FTP transfer through base station. | Base station. | |
| FTP-PROXY.DISCONNECT | Communication | PRIVATE | 4.2.0 | index |
[0-15] | FTP object index as returned by FTP-PROXY.CREATE | Used by wireless readers to proxy FTP transfer through base station. | Base station. | |
| FTP-PROXY.EXECUTE | Communication | PRIVATE | 4.2.0 | index type path length data |
[0-15] [0-15] [0-15] [0-3] [0-3] |
FTP object index as returned by FTP-PROXY.CREATE FTP transfer type (STOR/STOU/APPE/RETR) File path for FTP transfer Data length Data |
Used by wireless readers to proxy FTP transfer through base station. | Base station. | |
| FTP-PROXY.NOOP | Communication | PRIVATE | 5.0.0 | session |
Sends NOOP using FTP proxy. | Wireless readers. | |||
| FTP-RESULT.APPEND | Communication | PUBLIC | 3.3.0 | SET|GET | type |
[ON|OFF] |
ON: Append result to existing file. OFF: Overwrite file content with result. |
Append to or overwrite file when result is sent via FTP to the file specified by FTP-RESULT.FILE-NAME. The file will be created if it does not exist. | Ethernet readers. DM8000 series wireless readers also support FTP if the base station is connected through Ethernet. |
| FTP-RESULT.ENABLE | Communication | PUBLIC | 3.3.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable/disable FTP transfer of reader results. | Ethernet readers. DM8000 series wireless readers also support FTP if the base station is connected through Ethernet. |
| FTP-RESULT.FILE-NAME | Communication | PUBLIC | 3.3.0 | SET|GET | string |
File name of FTP result. | Ethernet readers. DM8000 series wireless readers also support FTP if the base station is connected through Ethernet. | ||
| FTP-RESULT.IDLE-LIMIT | Communication | PUBLIC | 5.5.0 | SET|GET | state |
[ON|OFF] | enable/disable | Limit duration of idle connections after a data transfer. | DM474, DM503 and DM300 series readers. |
| FTP-RESULT.IDLE-TIME | Communication | PUBLIC | 5.5.0 | SET|GET | seconds |
[0-3600] | Maximum duration of idle connections after a data transfer. | DM474, DM503 and DM300 series readers. | |
| FTP-RESULT.IP-ADDRESS | Communication | PUBLIC | 3.3.0 | SET|GET | string |
IP address of target FTP server. Uses dotted decimal form, such as "192.168.23.42". |
Ethernet readers and MX-1000. DM8000 series wireless readers also support FTP if the base station is connected through Ethernet. | ||
| FTP-RESULT.PASSWORD | Communication | PUBLIC | 3.3.0 | SET | string |
Password used to login to target FTP server. | Ethernet readers. DM8000 series wireless readers also support FTP if the base station is connected through Ethernet. | ||
| FTP-RESULT.PORT | Communication | PUBLIC | 4.0.0 | SET|GET | port |
[0-65535] | FTP server port number. | Ethernet readers. DM8000 series wireless readers also support FTP if the base station is connected through Ethernet. | |
| FTP-RESULT.SERVER-TYPE | Communication | PUBLIC | 5.6.3 | SET|GET | type |
[0-2] |
0: Generic 1: Mitsubishi GOT 2: SFTP |
FTP server type.2 means that the server is an S(SH)FTP server. | DM474, DM503 and DM300 series readers. |
| FTP-RESULT.USER-NAME | Communication | PUBLIC | 3.3.0 | SET|GET | string |
Username used to login to target FTP server. | Ethernet readers. DM8000 series wireless readers also support FTP if the base station is connected through Ethernet. | ||
| HPIT.FRONT-COVER | Communication | PUBLIC | 6.1.6 | GET |
|
[0-4] |
0 = No cover 1 = Cross polarized NEWC Linear Polarized S 2 = Clear cover 3 = Undefined 4 = Diffused |
Detected front cover type. | DM370 series, DM470 series readers. |
| INPUT1.SAVE-MATCH-STRING | Communication | PUBLIC | 4.5.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enables or disables saving the match string to flash when Set Match String is enabled as Input line 1 action. | DM50, DM60, DM70, DM474, DM503, and DM300 series readers. |
| INTELLIGRATED.ENABLED | Communication | PRIVATE | 5.0.0_cr14 | SET|GET | state |
[ON|OFF] | enable/disable | Enable or disable the Intelligrated protocol. | DM503 series readers. |
| INTER-MESSAGE.DELAY | Communication | PREVIEW | 3.2.0 | SET|GET | value |
[0-10000] | milliseconds | Transmission delay between buffered read strings. | Wireless readers. |
| KEY.INTERCHAR-DELAY | Communication | PUBLIC | 5.5.0 | SET|GET | us |
[0-1000] | milliseconds | Sets or gets the delay time between characters when in HID keyboard mode. | DM300 series readers, DM60, DM50, DM70, DM474. |
| LVHSTS.ENABLED | Communication | PRIVATE | 4.4.1_cr6_sr2 | SET|GET | state |
[ON|OFF] | enable/disable | Enable or disable the USPS Lehigh Valley HSTS protocol. | DM300 series readers, DM474. |
| MARKEM.ENABLED | Communication | PRIVATE | 5.0.0_cr11 | SET|GET | state |
[ON|OFF] | enable/disable | Enable or disable the Markem protocol. | DM300 series readers, DM474. |
| MASTER-SLAVE.GROUP-NAME | Communication | PUBLIC | 4.0.0 | SET|GET | name |
Gets or sets the name of the master slave group. | DM60, DM474, DM503, and DM300 series readers. | ||
| MASTER-SLAVE.MODE | Communication | PUBLIC | 4.0.0 | SET|GET | mode |
[0-2] |
0: OFF 1: ON 2: Master |
Switches the master-slave functioning of the reader on or off. | DM60, DM474, DM503, and DM300 series readers. |
| MASTER-SLAVE.TEST | Communication | PUBLIC | 5.5.0 | mode message |
[0-2] |
0: Slave to Master 1: Master to Slave 2: Master to Slave to Master |
Transmits the test message from reader to reader as designated by mode. The terminating reader will output the message preceded by the initiating device delimited by a space | Fixed-mount readers. | |
| MASTER-SLAVE.TEST-EFP-OUTPUT | Communication | PUBLIC | 5.7.3 | SET|GET | state |
[ON|OFF] |
ON: enable OFF: disable |
Enables or disables mst-test messages on the Industrial Protocol interfaces. | DM300 series readers, DM474. |
| MASTER-SLAVE.TIMEOUT | Communication | PUBLIC | 4.0.0 | SET|GET | milliseconds |
[0-10000] | Gets or sets the time to wait for results from slave cameras. | DM60, DM474, DM503, and DM300 series readers. | |
| MASTER-SLAVE.TIMEOUT-DISTANCE | Communication | PUBLIC | 5.7.3 | SET|GET | int |
[0-1000000] | Distance | The distance for a master slave timeout. | DM60, DM70, DM260, DM474, DM503, and DM300 series readers. |
| MASTER-SLAVE.TIMEOUT-MODE | Communication | PUBLIC | 5.7.3 | SET|GET | mode |
[0-1] |
0: Time 1: Distance |
Controls if the mater slave response timeout will be time or distance based. | DM60, DM260, DM474, DM503, and DM300 series readers. |
| MC-PROTOCOL.ENABLED | Communication | PRIVATE | SET|GET | state |
[ON|OFF] | enable/disable | Enable or disable MC-Protocol communication. | Ethernet readers. The DM8000 series wireless readers also support this protocol if the base station is connected through Ethernet. In the case of a Bluetooth connection, the command has to be sent to the base station, not to the reader. | |
| MODBUSTCP.ENABLED | Communication | PUBLIC | SET|GET | state |
[ON|OFF] | enable/disable | Enable or disable Modbus/TCP communication. | Ethernet readers. The DM8000 series wireless readers also support this protocol if the base station is connected through Ethernet. In the case of a Bluetooth connection, the command has to be sent to the base station, not to the reader. | |
| MODBUSTCP.HOLDING-ONLY | Communication | PUBLIC | SET|GET | state |
[ON|OFF] | enable/disable | Ethernet readers. DM8000 series wireless readers also support this protocol if the base station is connected through Ethernet. | ||
| NET-LOCAL.DHCP | Communication | PUBLIC | 3.3.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable/Disable DHCP on reader. | Ethernet readers. |
| NET-LOCAL.DNS-SERVER | Communication | PUBLIC | 3.3.0 | SET|GET | server |
Gets or sets the DNS Server address. | Ethernet readers. | ||
| NET-LOCAL.GATEWAY | Communication | PUBLIC | 3.3.0 | SET|GET | string |
Reader's default gateway IP address. Uses dotted decimal form, such as "192.168.23.1". |
Ethernet readers. | ||
| NET-LOCAL.IP-ADDRESS | Communication | PUBLIC | 3.3.0 | SET|GET | string |
Reader's IP address. Uses dotted decimal form, such as "192.168.23.42". |
Ethernet readers. | ||
| NET-LOCAL.MAX-LINK-SPEED | Communication | PRIVATE | 5.2.0 | SET|GET | speed |
[0-4] |
0: 1000 MBits/sec Full Duplex 1: 100 MBits/sec Full Duplex 2: 100 MBits/sec Half Duplex 3: 10 MBits/sec Full Duplex 4: 10 MBits/sec Half Duplex |
Limits the advertised autonegotiation maximum link speed. | DM503 only |
| NET-LOCAL.PORT | Communication | PUBLIC | 3.4.0 | SET|GET | port |
[1-65535] | Setup Tool server TCP port on reader. | Ethernet readers. | |
| NET-LOCAL.READER-IP-ADDRESS | Communication | PUBLIC | 4.2.0 | SET|GET | string |
dotted decimal form IPv4 address | Base station's IP address. Uses dotted decimal form, such as "192.168.23.42". |
Base stations. | |
| NET-LOCAL.READER-SUBNET-MASK | Communication | PUBLIC | 5.2.0 | SET|GET | string |
dotted decimal form IPv4 address | Base station's subnet mask. Uses dotted decimal form, such as "192.168.23.255". |
Base stationss. | |
| NET-LOCAL.SEC-ENABLE | Communication | PRIVATE | 5.2.0 | SET|GET | state |
[ON|OFF] |
enable/disable
ON: use authentication OFF: no authentication |
Use authentication over telnet for communciation between reader and base. | Ethernet readers. |
| NET-LOCAL.SEC-PASSWORD | Communication | PRIVATE | 5.2.0 | SET|GET | string |
password for authentication | Use authentication over telnet for communciation between reader and base. | Ethernet readers. | |
| NET-LOCAL.SEC-USERNAME | Communication | PRIVATE | 5.2.0 | SET|GET | string |
username for authentication | Use authentication over telnet for communciation between reader and base. | Ethernet readers. | |
| NET-LOCAL.SUBNET-MASK | Communication | PUBLIC | 3.3.0 | SET|GET | string |
Reader's subnet mask. Uses dotted decimal form, such as "192.168.23.255". |
Ethernet readers. | ||
| NET-LOCAL.TCP-KEEPALIVE | Communication | PRIVATE | 3.3.1 | SET|GET | state |
[ON|OFF] | enable/disable | Enable/Disable TCP keepalive message. | Ethernet readers. |
| NET-LOCAL.TCP-KEEPALIVE-COUNT | Communication | PRIVATE | 3.3.1 | SET|GET | value |
[0-32565] | TCP keep alive retry count. | Ethernet readers. | |
| NET-LOCAL.TCP-KEEPALIVE-IDLE | Communication | PRIVATE | 3.3.1 | SET|GET | value |
[0-32565] | TCP keep alive time. Ethernet readers. |
||
| NET-LOCAL.TCP-KEEPALIVE-INTERVAL | Communication | PRIVATE | 3.3.1 | SET|GET | value |
[0-32565] | TCP keep alive interval. Ethernet readers. |
||
| NETWORK-CLIENT.CLIENT-PORT | Communication | PUBLIC | 5.2.0 | SET|GET | int |
[0-65535] | The port on the reader to use as the outbound port (default is 0). | Ethernet readers except for the DM8000 wireless. | |
| NETWORK-CLIENT.CLOSE-CONNECTION | Communication | PUBLIC | 5.2.0 | SET|GET | int |
[0-1] |
0: Never 1: After reader data transfer |
Whether or not to keep the connection open after data transfer (default is 0). | Ethernet readers except for the DM8000 wireless. |
| NETWORK-CLIENT.CONNECTION-TIMEOUT | Communication | PUBLIC | 5.2.0 | SET|GET | int |
[1000-60000] | How long to wait before considering the connection dead (default is 3000). | Ethernet readers except for the DM8000 wireless. | |
| NETWORK-CLIENT.ENABLED | Communication | PUBLIC | 5.1.0 | SET|GET | state |
[ON|OFF] | enable/disable | Switch the Network Client feature on or off. | Ethernet readers except for the DM8000 wireless. |
| NETWORK-CLIENT.HOST-ADDRESS | Communication | PUBLIC | 5.2.0 | SET|GET | string |
Max length = 255 | The address of the server to connect to. | Ethernet readers except for the DM8000 wireless. | |
| NETWORK-CLIENT.HOST-PORT | Communication | PUBLIC | 5.2.0 | SET|GET | int |
[0–65535] | The remote port on the server to connect to (default is 1000). | Ethernet readers except for the DM8000 wireless. | |
| NETWORK-CLIENT.IDLE-TIMEOUT | Communication | PUBLIC | 5.2.0 | SET|GET | int |
[1–3600] | How long to keep the connection open after transfer (default is 1). | Ethernet readers except for the DM8000 wireless. | |
| NETWORK-CLIENT.OPEN-CONNECTION | Communication | PUBLIC | 5.2.0 | SET|GET | us |
[0-1] |
0: on Power-up 1: on Data Activity |
When to open the connection to the remote host (default is 0). | Ethernet readers except for the DM8000 wireless. |
| NETWORK-CLIENT.PROTOCOL | Communication | PUBLIC | 5.2.0 | SET|GET | int |
[0-1] |
0: TCP 1: UDP |
Which protocol to use for the connection (default is 0). | Ethernet readers except for the DM8000 wireless. |
| NETWORK-CLIENT.RECONNECT-DELAY | Communication | PUBLIC | 5.2.0 | SET|GET | int |
[100-60000] | How long to wait before reconnecting if the connection is lost (default is 1000). | Ethernet readers except for the DM8000 wireless. | |
| NTP.ENABLE | Communication | PUBLIC | 5.7.0 | SET|GET | state |
[ON|OFF] | enable/disable Enable/Disable | Enables or disables NTP. | All |
| NTP.SERVER1 | Communication | PUBLIC | 5.7.0 | SET|GET | server |
IP address or DNS name | Set the NTP server 1. | All | |
| NTP.SERVER2 | Communication | PUBLIC | 5.7.0 | SET|GET | server |
IP address or DNS name | Set the NTP server 2. | All | |
| OUTPUT.USER-CONFIGURE | Communication | PUBLIC | 5.3.0 | SET|GET | event number beep tone beep number LED color vibration |
[1,2] [0-2] [0-3] [0-7] [ON|OFF] |
1: USER_EVENT_1 2: USER_EVENT_2 [0]: Low [1]: Medium [2]: High Number of beeps [0]: Off [1]: Blue [2]: Green [3]: Cyan [4]: Red [5]: Magenta [6]: Yellow [7]: White enable/disable ON: The reader vibrates on the given user event. OFF: The reader does not vibrate on the given user event. |
Sets the beeper tone and the number of beeps for USER_EVENT_1 or USER_EVENT_2. | DM8050 (except for the vibration parameter), ON|OFF is supported on DM8600 and MX-1000. |
| PROFIBUS.GATEWAY-COM | Communication | PRIVATE | 5.5.0 | SET|GET | mode |
[0-2] |
0: Profibus 1: RS485 2: RS422 |
Get the COM configuration (Profibus / RS422 / RS485). | Fixed-mount readers |
| PROFIBUS.GATEWAY-FLOW | Communication | PRIVATE | 5.5.0 | SET|GET | mode |
[0-2] |
0: None 1: RTS/CTS 2: XON/XOFF |
The reader will return a value indicating the type of serial flow control to be used. | Fixed-mount readers |
| PROFIBUS.GATEWAY-HOST | Communication | PRIVATE | 5.5.0 | GET | type |
[0] | The reader will return a value indicating the host interface protocol. | Fixed-mount readers | |
| PROFIBUS.GATEWAY-MODE | Communication | PRIVATE | 5.5.0 | GET | mode |
[1] | Get the profibus mode configuration. | Fixed-mount readers | |
| PROFIBUS.GATEWAY-NODE | Communication | PRIVATE | 5.5.0 | SET|GET | node number |
[1-99] | The reader will return the Profinet node number for the gateway. | Fixed-mount readers | |
| PROFIBUS.GATEWAY-RUN | Communication | PRIVATE | 5.5.0 | SET|GET | state |
[ON|OFF] | Runtime start message or heartbeat. | Fixed-mount readers | |
| PROFIBUS.GATEWAY-STATUS | Communication | PRIVATE | 5.5.0 | SET|GET | status |
[0-4] |
0: ok, no error 1: Invalid op mode 2: Invalid node number 3: Invalid flow control 4: Invalid host interference |
Set Gateway error message. | Fixed-mount readers |
| PROFIBUS.GATEWAY-VERSION | Communication | PRIVATE | 5.5.0 | SET|GET | mode |
Set the GW firmware version, used for baud rate detection. | Fixed-mount readers | ||
| PROFINET.ENABLED | Communication | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enabled or disabled PROFINET communications. | Ethernet readers. The DM8000 series wireless readers also support this protocol if the base station is connected through Ethernet. In the case of a Bluetooth connection, the command has to be sent to the base station, not to the reader. |
| PROXIMITY.CURRENT | Communication | PRIVATE | 5.4.0 | SET|GET | int |
[10-200] step 10 | IR LED current of the proximity sensor in mA | A higher value will increase the sensitivity of the sensor. | DM8600 |
| PROXIMITY.THRESHOLD | Communication | PRIVATE | 5.4.0 | SET|GET | int |
[0-100] | Threshold value which defines if the optical button has been pressed or released. A lower value will increase the sensitivity of the sensor. | DM8600 | |
| PTP-SYNC.DELAY | Communication | PUBLIC | 5.5.0 | SET|GET | time |
[0-1000000] | Time between trigger start and the synchronized acquisition timestamp. | DM360 series readers, DM474 | |
| PTP-SYNC.ENABLE | Communication | PUBLIC | 5.5.0 | SET|GET | mode |
[ON|OFF] | Enables MST synchronized by PTP. | DM360 series readers, DM474 | |
| PTP-SYNC.LOCAL-OFFSET | Communication | PUBLIC | 5.5.0 | SET|GET | time |
[0-1000000] | Local offset added to the synchronized acquisition timestamp. | DM360 series readers, DM474 | |
| PTP.ENABLE | Communication | PUBLIC | 5.5.0 | SET|GET | mode |
[ON|OFF] |
enable/disable
OFF: Disable the PTP timestamp synchronization ON: Enable the PTP timestamp synchronization |
Enable the PTP timestamp synchronization. | DM360 series readers, DM474 |
| PTP.PRIORITY1 | Communication | PUBLIC | 5.5.0 | SET|GET | level |
[0-255] | This is the first 8-bit priority value (lower number denotes a higher priority). Normally, this is set at 128 for master capable devices. | DM360 series readers, DM474 | |
| PTP.PRIORITY2 | Communication | PUBLIC | 5.5.0 | SET|GET | level |
[0-255] | This is the second 8-bit priority value (lower number denotes a higher priority). This parameter allows to configure backup clocks. | DM360 series readers, DM474 | |
| PTP.SLAVE-ONLY | Communication | PUBLIC | 5.5.0 | SET|GET | mode |
[ON|OFF] |
enable/disable
OFF: Disables PTP slave only configuration of the reader ON: Configures the reader as PTP slave only |
This parameter configures the reader as PTP slave only, even if no other master is active. | DM360 series readers, DM474 |
| READER.ASSIGNED | Communication | PUBLIC | 5.2.0 | SET|GET | state |
[ON|OFF] | enable/disable | Unassignins the reader and the base station that is associated with it. | Base |
| SCRIPT.GARBAGE-COLLECT | Communication | PRIVATE | 5.5.0 | force |
[ON|OFF] | enable/disable Enforce the garbage collection | Check or enforce the Garbage Collection process. | Fixed mount readers | |
| SDCARD.BACKUP-FILE | Communication | PUBLIC | 5.5.0 | SET|GET | state |
[ON|OFF] | enable/disable | SD card is used for creating and restoring a configuration file backup. | DM360 series readers, DM474 |
| SDCARD.PRESENT | Communication | PUBLIC | 5.5.0 | GET | Returns True if the SD card was detected, False otherwise. | DM360 series readers, DM474 | |||
| SDCARD.TESTFILE | Communication | PRIVATE | 5.5.0 | SET|GET | string |
SET: writes argument to a predefined file on the card. GET: reads back the same file and returns its content. | DM360 series readers, DM474 | ||
| SLMP-PROTOCOL.ENABLED | Communication | PUBLIC | SET|GET | state |
[ON|OFF] | enable/disable | Enables or disables SLMP-Protocol communication. | Ethernet readers. DM8000 series wireless readers also support this protocol if the base station is connected through Ethernet. In the case of a Bluetooth connection, the command has to be sent to the base station, not to the reader. | |
| SYNC-ACQUISITION.CABLE-END | Communication | PUBLIC | 5.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Sets or gets whether your device is a bus terminator at the end of the synchronization interface bus. | DM503 |
| SYNC-ACQUISITION.DELAY | Communication | PUBLIC | 5.0.0 | SET|GET | us |
[0-25000] | microseconds | Synchronized acquisition delay: the time the reader waits after sending or receiving the synchronized interface signal before the regular acquisition sequence starts. | DM503 |
| SYNC-ACQUISITION.ENABLED | Communication | PUBLIC | 5.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enables or disables synchronized triggering. | DM503 |
| SYNC-ACQUISITION.MASTER | Communication | PUBLIC | 5.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Sets or gets whether the device is the master among the synchronized readers. | DM503 |
| SYNC-ACQUISITION.START-DELAY | Communication | PRIVATE | 5.0.0 | SET|GET | us |
[0-25000] | microseconds | This command is to adjust the delay between the master/slave trigger sent via Ethernet and the sync signal sent for RS-845 to compensate for the longer runtime of the message via Ethernet. Developer only command. |
DM503 |
| TELNET.CUSTOM-PORTS | Communication | PUBLIC | 5.5.0 | SET|GET | port |
[0-65535] | Comma separated list of TCP ports | Additional Telnet TCP ports for custom communication. | Ethernet readers |
| TELNET.PORT | Communication | PUBLIC | 3.3.0 | SET|GET | value |
[0-65535] | Telnet server TCP port on reader. | Ethernet readers. | |
| TEST-MODE.ACCEPT-TRIGGERS | Communication | PUBLIC | 5.2.0 | value |
[0-2000000000] | number of accepted triggers from all inputs | Allows a limited number of triggers from external inputs even if triggering from those should be rejected using TEST-MODE.INPUTS-ENABLE. | DM70, DM150, DM260, DM474, DM503 and DM300 series readers. | |
| TEST-MODE.AUTOMATIC | Communication | PUBLIC | 5.2.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enables automatic triggering. | DM70, DM150, DM260, DM474, DM503 and DM300 series readers. |
| TEST-MODE.AUTOMATIC-OFF-US | Communication | PUBLIC | 5.2.0 | SET|GET | microseconds |
[0-2000000000] | Inactive trigger phase for automatic triggering. | DM70, DM150, DM260, DM474, DM503 and DM300 series readers. | |
| TEST-MODE.AUTOMATIC-ON-US | Communication | PUBLIC | 5.2.0 | SET|GET | microseconds |
[0-2000000000] | Active trigger phase for automatic triggering. | DM70, DM150, DM260, DM474, DM503 and DM300 series readers. | |
| TEST-MODE.ENABLE | Communication | PUBLIC | 5.2.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enables test mode. | DM70, DM150, DM260, DM474, DM503 and DM300 series readers. |
| TEST-MODE.INPUTS-ENABLE | Communication | PUBLIC | 5.2.0 | SET|GET | state |
[ON|OFF] | enable/disable | Disables external trigger sources during test mode. | DM70, DM150, DM260, DM474, DM503 and DM300 series readers. |
| TEST-MODE.OUTPUTS-ENABLE | Communication | PUBLIC | 5.2.0 | SET|GET | state |
[ON|OFF] | enable/disable | Disables result reporting to external destinations during test mode. | DM70, DM150, DM260, DM474, DM503 and DM300 series readers. |
| WIFI.AUTH-MODE | Communication | PUBLIC | 4.2.4 | SET|GET | int |
[0-3] |
0 – no auth 1 – WPA-PSK 2 – WPA2-PSK 3 – EAP/TLS 4 – PEAP-MSCHAPV2 |
Sets the authentication method. | DM8000 |
| WIFI.CA-CERT | Communication | PUBLIC | 4.2.4 | SET|GET | string |
NA | Used In WPA-Enterprise. This is the certificate of the certification authority we trust. | PEM formatted certificate, terminated by a space. | DM8000;Base |
| WIFI.CHANNEL | Communication | PUBLIC | 4.2.4 | SET|GET | int |
[1-11] | Sets the wifi channel number. | ||
| WIFI.CLIENT-CERT | Communication | PUBLIC | 4.2.4 | SET|GET | string |
NA | Used in WPA-Enterprise (EAP-TLS). This is the certificate of the reader signed by the trusted CA (set with the previous command). | PEM formatted certificate, terminated by a space. | DM8000;Base |
| WIFI.CLIENT-IDENTITY | Communication | PUBLIC | 4.2.4 | SET|GET | string |
NA | The identity the client certificate is issued to. | DM8000;Base | |
| WIFI.CLIENT-PRIVATE-KEY | Communication | PUBLIC | 4.2.4 | SET|GET | string |
NA | Used in WPA-Enterprise (EAP-TLS). The private key of the reader. | PEM formatted private key, terminated by a space. | DM8000;Base |
| WIFI.ENABLED | Communication | PUBLIC | 4.2.4 | SET|GET | state |
[ON|OFF] | enable/disable | Enables or disables wifi in ad-hoc mode. | |
| WIFI.ENC-METHOD | Communication | PUBLIC | 4.2.4 | SET|GET | int |
[0-5] |
0 – off 1 – WEP40 2 – WEP104 3 – TKIP 4 – AES 5 – TKIP/AES |
Sets the authentication method. | DM8000;Base |
| WIFI.NETWORK-TYPE | Communication | PUBLIC | 4.2.4 | SET|GET | int |
[0-1] |
0 – Infrastructure mode 1 – AD-HOC mode |
Sets whether wifi works in infrastructure or ad-hoc mode. | DM8000 |
| WIFI.PASSPHRASE | Communication | PUBLIC | 4.2.4 | SET|GET | string |
NA | In WEP encrpytion and in WPA(2)-PSK it is the passphrase set by the AP. | DM8000;Base | |
| WIFI.SSID | Communication | PUBLIC | 4.2.4 | SET|GET | string |
NA | Assigns an SSID name to the network. | ||
| COM.BAUD-RATE - test data | Communication - sample | 3.0.0 | SET|GET | rate |
[1...5] |
1:115200 2:57600 3:38400 4:19200 5:9600 |
RS232 Communication Speed. Does not affect USB communication speed. |
ALL | |
| FORMAT.ADVANCED | Data Formatting | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable Data Formatting Advanced Mode. Advanced Mode Formatting Enables: Regexp Pattern Substitution. |
ALL |
| FORMAT.CRLF-END | Data Formatting | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Data Formatting CRLF Terminator. Requires Data Formatting Standard Mode Enabled. |
ALL |
| FORMAT.DELIMITER | Data Formatting | PUBLIC | 3.0.0 | SET|GET | delimiter-option |
[0-5] |
0: none 1: space 2: comma 3: tab 4: label 5: xml |
Data Formatting Delimiter. Sets the delimeter between Data Formatting Tokens. Requires Data Formatting Standard Mode Enabled. |
ALL |
| FORMAT.DISCARD-UNMATCHED | Data Formatting | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Data Formatting Discard Unmatched Data. | ALL |
| FORMAT.MODE | Data Formatting | PUBLIC | 4.5.0 | SET|GET | mode |
[0-1] |
0: basic formatting 1: script-based formatting |
Specifies data formatting mode. By default, basic formatting is the set formatting mode. |
DM50, DM60, DM70, DM474, DM503, MX-1000, MX-1502 and DM300 series readers. |
| FORMAT.MULTICODE-DELIMITER | Data Formatting | PUBLIC | 3.2.0 | SET|GET | type |
[0-6] |
0: none 1: space 2: comma 3: tab 4: label 5: xml 6: CRLF |
Data Formatting Delimiter. Sets the delimiter between codes in a multicode result. |
Fixed mount readers. |
| FORMAT.PROG-TARG | Data Formatting | PUBLIC | 3.2.0 | SET|GET | category |
[0-5] |
0: Universal 1: DataMatrix 2: QR Code/MaxiCode/AztecCode 3: Linear/ Postal/ Stacked 4: VeriCode® 5: DotCode |
Data Formatting Programming Target. Data Formatting Symbology Set to be modified by subsequent commands. Once issued, it changes the subsequent behavior of the reader. AztecCode is only supported on the DM503 and DM300 series readers. |
ALL |
| FORMAT.REGEXP | Data Formatting | PUBLIC | 3.0.0 | SET|GET | string |
regular expression string | Data Formatting Regular Expression. Requires Data Formatting Advanced Mode Enabled. See the Overview topic for formatting requirements for the string argument. |
ALL | |
| FORMAT.SCRIPT | Data Formatting | PUBLIC | 5.2.0 | SET|GET | num-bytes |
Set: loads the script from the host to the reader. Get: sends the script from the reader to the host. | DM474, DM503, MX-1000, MX-1502 and DM300 series readers. | ||
| FORMAT.STANDARD | Data Formatting | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable Data Formatting Standard Mode. Standard Mode Formatting Enables: Leading Text, Data, Data Delimeter, Terminating Text, Terminating CRLF. |
ALL |
| FORMAT.TEXT-BEGIN | Data Formatting | PUBLIC | 3.0.0 | SET|GET | string |
leading output text | Data Formatting Leading Text. Requires Data Formatting Standard Mode Enabled. See the Overview topic for formatting requirements for the string argument. |
ALL | |
| FORMAT.TEXT-END | Data Formatting | PUBLIC | 3.0.0 | SET|GET | string |
trailing text | Data Formatting Trailing Text. Requires Data Formatting Standard Mode Enabled. See the Overview topic for formatting requirements for the string argument. |
ALL | |
| FORMAT.TOKEN | Data Formatting | PUBLIC | 3.0.0 | SET|GET | string |
token string | Data Formatting Standard Data. Regardless of the parameters given to GET FORMAT.TOKEN, it will return the current data formatting token string contained in the Standard Formatting window pointed to by the current value of GET FORMAT.PROG-TARG. See Data Formatting Token Table for available elements. See the Overview topic for formatting requirements for the string argument. |
ALL | |
| INPUT-STRING.ENABLE | Data Formatting | PUBLIC | 5.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enables or disables the use of the Input String feature (available for serial, telnet, NetworkClient). When enabled, a header and the footer can be set by the INPUT-STRING.HEADER and INPUT-STRING.FOOTER commands, respectively. A string of characters can be given between the header and the footer, which will be sent with the formatted output (for example, [hello world], if the header is set to ’[’ and the footer to ’]’). Since the input string is saved temporarily, it appears only in the next result output. Use Setup Tool (the <Input String> option) or <ISTR> with DMCC (see SET FORMAT.TOKEN) to allow Input string in the result output. | ALL |
| INPUT-STRING.ENABLE | Data Formatting | PRIVATE | 4.4.0_cr10 | SET|GET | state |
[ON|OFF] | enable/disable | Enables or disables the use of the Input String feature (available for serial, telnet, NetworkClient). When enabled, a header and the footer can be set by the INPUT-STRING.HEADER and INPUT-STRING.FOOTER commands, respectively. A string of characters can be given between the header and the footer, which will be sent with the formatted output (for example, [hello world], if the header is set to ’[’ and the footer to ’]’). Since the input string is saved temporarily, it appears only in the next result output. Use Setup Tool (the <Input String> option) or <ISTR> with DMCC (see SET FORMAT.TOKEN) to allow Input string in the result output. | ALL |
| INPUT-STRING.FOOTER | Data Formatting | PUBLIC | 5.0.0 | SET|GET | string |
token string | Sets the footer for the Input String character string. | ALL | |
| INPUT-STRING.HEADER | Data Formatting | PUBLIC | 5.0.0 | SET|GET | string |
token string | Sets the header for the Input String character string. | ALL | |
| INPUT-STRING.MODE | Data Formatting | PUBLIC | 5.5.0 | SET|GET | int |
[0-4] |
0: Store 1: Send 2: Send with header and footer 3: Send with formatting 4: Send with header and footer formatting |
Controls whether the input string data is sent out as a result or stored in an internal variable. | Fixed-mount readers. |
| INPUT-STRING.VALUE | Data Formatting | PUBLIC | 5.5.0 | SET|GET | string |
token string | Sets the content of the Input String character string. | Fixed-mount readers | |
| SCRIPT.LOAD | Data Formatting | PUBLIC | 4.5.0 | num-bytes |
Loads the formatting script from the host to the reader. | DM50, DM60, DM70, DM474, DM503, MX-1000, MX-1502 and DM300 series readers. | |||
| SCRIPT.SEND | Data Formatting | PUBLIC | 4.5.0 | Sends the formatting script from the reader to the host. | DM50, DM60, DM70, DM474, DM503, MX-1000, MX-1502 and DM300 series readers. | ||||
| DVALID.DOD-EXEID | Data Validation | PUBLIC | 3.0.0 | SET|GET | string |
expected-EID | DoD Expected Enterprise ID (EID). | ALL | |
| DVALID.DOD-EXPN | Data Validation | PUBLIC | 3.0.0 | SET|GET | string |
expected-PN | DoD Expected Part Number. See the Overview topic for formatting requirements for the string argument. |
ALL | |
| DVALID.DODCNSTRT | Data Validation | PUBLIC | 3.0.0 | SET|GET | construct |
[0-3] |
0: Any 1: Construct #1 2: Construct #2 3: Equivalent |
Data Validation DoD Construct. | ALL |
| DVALID.FAIL-ACTION | Data Validation | PUBLIC | 3.0.0 | SET|GET | action |
[0-3] |
0: Transmit "Validation Failure" 1: Transmit "Validation Failure" + decoded string 2: Transmit annotated decode string 3: Transmit nothing |
Data Validation Failure Action. | ALL |
| DVALID.FAIL-XMT-CRLF | Data Validation | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Data Validation Transimit CRLF on Failure. | ALL |
| DVALID.GS1-FORMAT | Data Validation | PUBLIC | 3.4.0 | SET|GET | string |
GS1 format string | Set GS1 format string. | ALL | |
| DVALID.ISO-CONSTRUCT | Data Validation | PUBLIC | 3.0.0 | SET|GET | construct |
[0-1] |
0: ISO 15434 1: ISO 15434 & ISO 15418 |
ISO Construct. | ALL |
| DVALID.MATCH-STRING | Data Validation | PUBLIC | 3.0.0 | SET|GET | string |
match-string | Data Validation Match-String. See the Overview topic for formatting requirements for the string argument. |
ALL | |
| DVALID.MATCH-STRING-EMPTY-RESULT | Data Validation | PRIVATE | 4.4.0 | SET|GET | action |
[0-1] |
0: empty match string fails 1: empty match string passes |
Gets or sets if a match string validation attempt with an empty match string should fail (0=default) or pass (1). | ALL |
| DVALID.MATCH-STRING-PARAMS | Data Validation | PUBLIC | 3.0.0 | SET|GET | increment start length step no-read validation-fail |
[ON|OFF]
[0-*] [1-*] [-2|-1|0|1|2] [ON|OFF] [ON|OFF] |
enable/disable
start position of numerical match number of digits increment enable/disable update on no-read enable/disable update on validation failure |
Data Validation Match-String Parameters. | ALL |
| DVALID.PATTERN | Data Validation | PUBLIC | 3.0.0 | SET|GET | string |
pattern-string | Data Validation Pattern. Regexp Data Validation. See the Overview topic for formatting requirements for the string argument. |
ALL | |
| DVALID.PROG-TARG | Data Validation | PUBLIC | 4.4.0 | SET|GET | category |
[1-5] |
1: DataMatrix 2: QR Code/MaxiCode/AztecCode 3: Linear/ Postal/ Stacked 4: VeriCode® 5: DotCode |
Data Validation Programming Target. Data Validation Symbology Set to be modified by subsequent commands. Once issued, this command changes the subsequent behavior of the reader. |
ALL |
| DVALID.TYPE | Data Validation | PUBLIC | 3.0.0 | SET|GET | type |
[0-5] |
0: None 1: DoD UID 2: ISO 3: Pattern 4: Match String 5: GS1 |
ALL | |
| AZTEC.TRAINED-MODEL | Decoder | PUBLIC | 5.7.0 | SET|GET | grid size module size polarity |
[15-151] [1-1000] [0-2] |
Grid size Module size * 10 0: dark-on-light 1: light-on-dark 2: either |
Set training parameters for Aztec symbology. | Fixed-mount readers |
| CODABAR.XMT-START-STOP-CHAR | Decoder | PRIVATE | 6.0.0 | SET|GET | state |
[ON|OFF] |
ON: Enable OFF: Disable |
Enable or disable transmitting start and stop character as part of the decoded string. | Ethernet readers |
| COM.ALTERNATE-MODE-DISABLE | Decoder | PRIVATE | 5.7.0 | SET|GET | enable |
[ON|OFF] |
ON: alternate mode cable detection enabled OFF: alternate mode cable detection disabled |
Disables alternate mode cable detection. | DM70 |
| DATAMATRIX.DAMAGE | Decoder | PUBLIC | 5.5.0 | SET|GET | damage level |
[2,4] |
2: moderate 4: extreme |
Set Extreme to enable PowerGrid. | DM300 series readers, DM360, DM474 readers |
| DATAMATRIX.IDMAX-SCALE-UNCERTAINTY-PERCENTAGE | Decoder | PRIVATE | 6.0.1 | SET | percentage |
Specifies Scale Uncertainty Percentage. It is a parameter that allows or limits the tuned DataMatrix decoder to examine code that has different PPM than the originally tuned code. The percentage should be PPM1-PPM2)/PPM1 * 100. Active when IDMax is enabled. | ALL | ||
| DATAMATRIX.QUALITY-METRICS | Decoder | PUBLIC | 4.5.0 | SET|GET | type |
[0-3] |
0: none 1: AIM DPM 2: ISO 15415 3: SEMI T10 |
Code quality metrics for DataMatrix. | ALL |
| DATAMATRIX.SCALE-UNCERTAINTY-PERCENTAGE | Decoder | PRIVATE | 6.0.1 | SET | percentage |
Specifies Scale Uncertainty Percentage. It is a parameter that allows or limits the tuned DataMatrix decoder to examine code that has a PPM different than the originally tuned code. The percentage should be (PPM1-PPM2)/PPM1 * 100. Used when IDQuick decoder is enabled. | ALL | ||
| DATAMATRIX.TRAINED-MODEL | Decoder | PUBLIC | 5.5.0 | SET|GET | rows columns module-size polarity mirrored |
[8-144] [8-144] [1-1000] [0-2] [ON|OFF] |
Number of rows Number of columns Module size * 10 0: dark-on-light 1: light-on-dark 2: either ON: mirrored OFF: not mirrored |
Train Data Matrix from the given parameters without needing to capture an image. | Fixed-mount readers |
| DATAMATRIX.TYPE | Decoder | PRIVATE | 6.1.6 | SET|GET |
|
[1-3] |
1 = DataMatrix only 2 = DMRE 3 = Both |
Set support level for DataMatrix and/or DataMatrix Rectangular Extensions. | ALL |
| DECODER.1D-DATA-STITCH | Decoder | PUBLIC | 5.5.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enables/disables 1D data-stitching. Requires the 1DDataStitching feature key. |
DM70, DM150, DM260, DM300 series readers, DM474, DM503. |
| DECODER.1D-DECODE-STRICTNESS | Decoder | PRIVATE | 6.1.6 | SET|GET |
|
[0-2] |
0 = Conservative 1 = Moderate 2 = Tolerant |
Selects which 1D decoding strictness mode to use. The default is 1 ("Moderate"). With setting 0 ("Conservative"), misreads are reduced, with 2 ("Tolerant"), no-reads are reduced. With setting 1 ("Moderate") this is balanced. | ALL |
| DECODER.1D-EXTENDED-RESOLUTION | Decoder | PUBLIC | 5.5.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enables/disables the 1D extended resolution decoding method. Requires the 1DExtendedRes feature key. |
DM70, DM150, DM260, DM300 series readers, DM474, DM503. |
| DECODER.1D-LEARN-CODESIZE | Decoder | PRIVATE | 3.2.0_cr5 | SET|GET | state |
[ON|OFF] | enable/disable | Learn the code size of 1D Symbols. | ALL |
| DECODER.1D-LEARN-ORIENT | Decoder | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Learn Orientation of 1D Symbols. | Fixed mount readers. |
| DECODER.1D-QUALITY-METRICS | Decoder | PUBLIC | 5.2.0 | SET|GET | mode |
[0-1] |
0: none 1: 1D readability |
Enables/disables 1D Process Control Metrics. | ALL |
| DECODER.1D-SHORT-HEIGHT-CODES | Decoder | PRIVATE | 6.0.0 | SET|GET | state |
[ON|OFF] |
ON: Enable OFF: Disable |
Enable or disable Short Height Codes. | Ethernet readers |
| DECODER.1D-SHORT-QUIET-ZONE | Decoder | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | When ON, the reader is tolerant with non-standard (i.e. short) quiet zones. | ALL |
| DECODER.1D-SYMBOL-ORIENTATION | Decoder | PUBLIC | 4.1 | SET|GET | orientation |
[0-3] |
0: Omnidirectional 1: Ladder and Picket Fence (default) 2: Ladder 3: Picket Fence |
Sets or gets the orientation at which codes can be found. Omnidirectional requires the Omnidirectional feature key. | DM50, DM60, DM70, DM474, DM503, MX-1000, MX-1502 and DM300 series readers. DM503L readers support only 2: Ladder and 3: Picket Fence. |
| DECODER.1D-TARGET | Decoder | PRIVATE | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Target Decoding. | MX-1000 and DM8000 series readers. |
| DECODER.1D-USAGE | Decoder | PRIVATE | 3.0.0 | SET|GET | usage-type |
[0-1] |
0: Standard 0: Extended |
1D Symbology Usage Type. | |
| DECODER.1D-USAGE | Decoder | PUBLIC | 3.0.0 | SET|GET | usage |
[0-1] |
0: Standard 1: Extended |
1D Symbology Usage Type. | Fixed mount readers. |
| DECODER.ALLOW-ALL-MST-RESULTS | Decoder | PUBLIC | 5.7.3 | SET|GET | state |
[ON|OFF] |
ON: enable OFF: disable |
Enables or disables re-read delay processing for slave results. | DM300 series readers, DM474, DM503, DM70, DM150, DM260 |
| DECODER.CENTERING-WINDOW | Decoder | PUBLIC | 6.0.0 | SET|GET | center x perc, center y perc, size x perc, size y perc |
[0-100] | Percentage | Location and size of centering window as a percentage of the sensor size. | DM50, DM60, DM70, DM150 DM260, DM300, DM360, DM474, MX-1000 series |
| DECODER.DISPLAY-TARGET | Decoder | PUBLIC | 6.0.0 | SET|GET | state |
[ON|OFF] | Enable/Disable | Displays centering window graphics. | DM50, DM60, DM70, DM150 DM260, DM300, DM360, DM474, MX-1000 series |
| DECODER.EFFORT | Decoder | PUBLIC | 5.7.1 | SET|GET | int |
[0-5] | Sets the effort level used by the decoding algorithms. Default is 2. | All | |
| DECODER.MAC-SCAN-TIMEOUT | Decoder | PUBLIC | 5.7.1 | SET|GET | int |
[0-60] | DM50, DM60, DM70, DM150 DM260, DM300, DM360, DM474, MX-1000, MX1502 | ||
| DECODER.NO-READ-FEEDBACK | Decoder | PRIVATE | 5.5.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enables/disables found but not decoded symbol info. | ALL |
| DECODER.PREPROCESS | Decoder | PRIVATE | 3.4.0 | SET|GET | slot filter param1 param2 param3 |
[0] [0-2] [0-255] [0-255] [0-255] |
slot to configure 0: none 1: Equalize 2: Stretch Filter parameter 1. Filter parameter 2. Filter parameter 2. |
Sets or gets the filter to apply to an image before decoding. | |
| DECODER.REREAD-MODE | Decoder | PUBLIC | 4.4.0 | SET|GET | mode |
[0-1] |
0: last read 1: first read |
Code re-reading delay relative to either the first read or the last. | DM50, DM60, DM70, DM474, DM503, DM300 series readers, DM8050 and DM8600. |
| DECODER.REREAD-NEVER2X | Decoder | PUBLIC | 5.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Never read the same code twice. All trigger modes, e.g. Multicode Reading. |
ALL |
| DECODER.REREAD-NOT-LAST-N | Decoder | PUBLIC | 5.5 SR3 | SET|GET | int |
[0-100] |
0: no restriction 1-100 Define N |
Do not read code if this code was read within the last N reads. | All |
| DECODER.REREAD-TIME | Decoder | PUBLIC | 4.4.0 | SET|GET | ms |
[0-10000] | Milliseconds | Code re-reading delay in milliseconds. | ALL |
| DECODER.ROI | Decoder | PUBLIC | 3.0.0 | SET|GET | left (multiple of 8) right (multiple of 8) top (multiple of 4) bottom (multiple of 4) |
[0...] [left+64...] [0...] [top+64...] |
left of the ROI rectangle right of the ROI rectangle top of the ROI rectangle bottom of the ROI rectangle |
Decoder Region of Interest. Image Region examined by decoder for enabled symbols. Pixel coordinates are relative to the upper left corner of the displayed image. Left < Right and Top < Bottom. Values must not be outside the specified CAMERA.FOV settings. |
ALL |
| DECODER.TARGET-DECODING | Decoder | PUBLIC | 5.7.1 | SET|GET | state |
[ON|OFF] | enable/disable | Enable target decoding, where the reader attempts to symbols that lie only under the aiming dots. | MX-1000, MX-1502 series readers. |
| DECODER.TIMEOUT | Decoder | PUBLIC | 3.0.0 | SET|GET | ms |
[0-10000] | milliseconds | Decoder Timeout. Maximum allowed decode time. |
Fixed mount readers. |
| DECODER.USE-CENTERING | Decoder | PUBLIC | 6.0.0 | SET|GET | state |
[ON|OFF] | Enable/Disable | Only reads codes within the centering window. | DM50, DM60, DM70, DM150, DM260, DM300, DM360, DM474, MX-1000 series |
| DOTCODE.MAXIMUM-COLUMNS | Decoder | PUBLIC | 5.4.0 | SET|GET | int |
[11-128] | The default is 128. | DM300 series readers, DM474, DM8050X and DM8600. | |
| DOTCODE.MAXIMUM-ROWS | Decoder | PUBLIC | 5.4.0 | SET|GET | int |
[5-128] | The default is 32. | DM300 series readers, DM474, DM8050X and DM8600. | |
| DOTCODE.MINIMUM-COLUMNS | Decoder | PUBLIC | 5.4.0 | SET|GET | int |
[11-128] | The default is 16. | DM300 series readers, DM474, DM8050X and DM8600. | |
| DOTCODE.MINIMUM-ROWS | Decoder | PUBLIC | 5.4.0 | SET|GET | int |
[5-128] |
The default is 6. |
DM300 series readers, DM474, DM8050X and DM8600. | |
| DOTCODE.POLARITY | Decoder | PUBLIC | 5.4.0 | SET|GET | int |
[0-2] |
0: Dark on Light 1: Light on Dark 2: Either |
DM300 series readers, DM474, DM8050X and DM8600. | |
| DOTCODE.QUALITY-METRICS | Decoder | PRIVATE | 5.5.0 | SET|GET | mode |
[0-1] |
0: none 1: enable AIM metrics |
Enable Subset of Quality Metrics from DotCode AIM Specification. | DM474, DM503, DM300 series readers, DM8050X and DM8600. |
| FILTER.IMAGE-TO-USE-SYMBOL | Decoder | PUBLIC | 4.3.0 | SET|GET | symbology input |
[1-5] [0-1] |
1: DataMatrix 2: QR Code/MaxiCode/AztecCode 3: Linear/ Postal/ Stacked 4: VeriCode® 5: DotCode 0: original image 1: filtered image |
Sets or gets which type of symbology should be filtered or not. AztecCode is only supported on the DM503 and DM300 series readers. |
DM50, DM60, DM70, DM150, DM260, DM300 series readers, DM474. |
| FILTER.NOREAD-IMAGE | Decoder | PUBLIC | 4.3.0 | SET|GET | symbology |
[0-5] |
0: Any 1: DataMatrix 2: QR Code/MaxiCode/AztecCode 3: Linear/ Postal/ Stacked 4: VeriCode® 5: DotCode |
Sets or gets if the symbology selected should be filtered if the image is no-read. AztecCode is only supported on the DM503 and DM300 series readers. |
DM50, DM60, DM70, DM150, DM260, DM300 series readers, DM474. |
| FILTER.STACK | Decoder | PUBLIC | 4.3.0 | SET|GET | step method value1 value2 value3 |
[1-4] [0-11] [0-255] |
Filter step 0: no filtering 1: equalize 2: stretch 3: low pass 4: dilate 5: erode 6: open 7: close 8: auto stretch 9: optical density 10: invert 11: median method parameter |
The first value sets the order of the filter steps. Filter step 1 is the first step, filter step 2 is the second, and so on. The second value sets the filter to be used. The third value means the additional properties that you can set for the given filter. You cannot configure the whole stack with one statement, but each on its own.The following example: SET FILTER.STACK 2 2 0 100 0 sets the second step in the filter, for stretch from 0 to 100, leaving the third value unused (0).The following example: GET FILTER.STACK 3 (for the third filter) returns 5 4 3 meaning that filter number 5, that is, erode is on, with parameters 4, 3. | DM50, DM60, DM70, DM150, DM260, DM300 series readers, DM474. |
| MAXICODE.TRAINED-MODEL | Decoder | PUBLIC | 5.7.0 | SET|GET | module size |
[1-1000] | Module size * 10 | Set training parameters for MaxiCode symbology. | Fixed-mount readers |
| OUTPUT.DELAY-DISTANCE | Decoder | PUBLIC | 4.4.0 | SET|GET | millimeters |
[0-100000] | Distance to output when using the Encoder. | DM474, DM503, and DM300 series readers. | |
| OUTPUT.DELAY-REFERENCE | Decoder | PUBLIC | 4.4.0 | SET|GET | mode |
[0-1] |
0: Trigger Start 1: Trigger End |
Sets or gets whether output is delayed relative to trigger start or trigger end. | DM50, DM60, DM70, DM474, DM503, and DM300 series readers. |
| OUTPUT.DELAY-TIME | Decoder | PUBLIC | 4.4.0 | SET|GET | milliseconds |
[0-10000] | Output delay in milliseconds. | DM50, DM60, DM70, DM503, DM300 series readers, DM474. | |
| OUTPUT.DELAY-TYPE | Decoder | PUBLIC | 4.4.0 | SET|GET | mode |
[0-1] |
0: None 1: Time |
Sets or gets whether output is delayed, and if so, whether according to time. | DM50, DM60, DM70, DM300 series readers, DM474. |
| OUTPUT.DELAY-TYPE | Decoder | PUBLIC | 4.4.0 | SET|GET | mode |
[0-2] |
0: None 1: Time 2: Distance |
Sets or gets whether output is delayed, and if so, whether according to time or distance. | DM503 |
| PCM-RESULT-STRING.EXTEND | Decoder | PUBLIC | 5.7.0 | SET|GET | enable |
[ON|OFF] | Enable or disable extending the result string with metric information. | Ethernet readers. | |
| PCM-RESULT-STRING.METRIC-FORMAT | Decoder | PUBLIC | 5.7.0 | SET|GET | type |
[0-2] |
0: Grade 1: Value 2: Grade + Value |
Set the format of a single metric entry. | Ethernet readers. |
| PCM-RESULT-STRING.METRIC-PREFIX | Decoder | PUBLIC | 5.7.0 | SET|GET | type |
[0-2] |
0: None 1: Acronym 2: Name |
Defines the prefix for a single metric entry. | Ethernet readers. |
| PCM-RESULT-STRING.METRIC-SEPARATOR | Decoder | PUBLIC | 5.7.0 | SET|GET | string |
Defines the metric separator. | Ethernet readers. | ||
| PCM-RESULT-STRING.OVERALL-GRADE | Decoder | PUBLIC | 5.7.0 | SET|GET | type |
[ON|OFF] | enable | Enables or disables showing the overall grade in at the beginning of the result string. | Ethernet readers. |
| PCM-RESULT-STRING.SEPARATOR | Decoder | PUBLIC | 5.7.0 | SET|GET | string |
Defines the main separator between result data and metric section. | Ethernet readers. | ||
| PCM.CUSTOM-DESCRIPTION | Decoder | PUBLIC | 5.7.0 | SET|GET | string |
Ethernet readers. | |||
| PCM.METRIC-PARM-OVERALL | Decoder | PUBLIC | 5.7.0 | SET|GET | type type state |
[0-5] [0-27] [ON|OFF] |
0: AIM-DPM 1: ISO-IEC 15415 2: ANSI-ISO-IEC 15416 3: SemiT10 4: 1D readability 5: DotCode Readybility 0: Symbol Contrast 1: Axial Non Uniformity 2: Print Growth 3: UEC 4: Modulation 5: Fixed Pattern Damage 6: Grid Non Uniformity 7: Extreme Reflectance 8: Reflect Min 9: Edge Contrast Min 10: Single Scan Int 11: Multi Scan Int 12: Signal To Noise Ratio 13: Horizontal Mark Growth 14: Vertical Mark Growth 15: Data Matrix Cell Width 16: Data Matrix Cell Height 17: Horizontal Mark Misplacement 18: Vertical Mark Misplacement 19: Cell Defects 20: Finder Pattern Defects 21: Overall Grade 22: Edge Determination 23: Defects 24: Reference Decode 25: Decodability 26: Contrast Uniformity 27: Reflectance Margin ON: use for overall calculation OFF: do not use for overall calculation |
Use the the metric grading result for calculating the overall result if enabled (e.g. AIM-DPM → Symbol Contrast → Use for Overall Calculation = ON) Not all metrics are available for each standard: AIM-DPM (0, 1, 2, 3, 4, 5, 6, 8), ISO-IEC 15415 (0, 1, 3, 4, 5, 6, 7), ANSI-ISO-IEC 15416 (1, 4, 8, 9, 22, 23, 24, 25), 1D readability (0, 2, 8, 9, 10, 11), DotCode (0, 1, 2, 3, 6, 8) | Ethernet readers. |
| PCM.METRIC-PARM-REPORT | Decoder | PUBLIC | 5.7.0 | SET|GET | type type state |
[0-5] [0-27] [ON|OFF] |
0: AIM-DPM 1: ISO-IEC 15415 2: ANSI-ISO-IEC 15416 3: SemiT10 4: 1D readability 5: DotCode Readybility 0: Symbol Contrast 1: Axial Non Uniformity 2: Print Growth 3: UEC 4: Modulation 5: Fixed Pattern Damage 6: Grid Non Uniformity 7: Extreme Reflectance 8: Reflect Min 9: Edge Contrast Min 10: Single Scan Int 11: Multi Scan Int 12: Signal To Noise Ratio 13: Horizontal Mark Growth 14: Vertical Mark Growth 15: Data Matrix Cell Width 16: Data Matrix Cell Height 17: Horizontal Mark Misplacement 18: Vertical Mark Misplacement 19: Cell Defects 20: Finder Pattern Defects 21: Overall Grade 22: Edge Determination 23: Defects 24: Reference Decode 25: Decodability 26: Contrast Uniformity 27: Reflectance Margin ON: include in report OFF: do not include in report |
Include the metric grading result for selected quality standard and metric in the report if enabled. Only available if not use for overall calculation (e.g. ISO-IEC 15415 → Modulation → Show in Report = ON) Not all metrics are available for each standard: AIM-DPM (0, 1, 2, 3, 4, 5, 6, 8), ISO-IEC 15415 (0, 1, 2, 3, 4, 5, 6, 7), ANSI-ISO-IEC 15416 (0, 4, 8, 9, 22, 23, 24, 25), SemiT10 (1, 4, 12, 13, 14, 15, 16, 17, 18, 19, 20), 1D readability (0, 2, 8, 9, 10, 11), DotCode (0, 1, 2, 3, 6, 8). | Ethernet readers. |
| PCM.METRIC-PARM-THRESHOLD | Decoder | PUBLIC | 5.7.0 | SET|GET | type type grade value |
[0-5] [0-25] [1-4] [0-1000] |
0: AIM-DPM 1: ISO-IEC 15415 2: ANSI-ISO-IEC 15416 3: SemiT10 4: 1D readability 5: DotCode Readybility 0: Symbol Contrast 1: Axial Non Uniformity 2: Print Growth 3: UEC 4: Modulation 5: Fixed Pattern Damage 6: Grid Non Uniformity 7: Extreme Reflectance 8: Reflect Min 9: Edge Contrast Min 10: Single Scan Int 11: Multi Scan Int 12: Signal To Noise Ratio 13: Horizontal Mark Growth 14: Vertical Mark Growth 15: Data Matrix Cell Width 16: Data Matrix Cell Height 17: Horizontal Mark Misplacement 18: Vertical Mark Misplacement 19: Cell Defects 20: Finder Pattern Defects 21: Overall Grade 22: Edge Determination 23: Defects 24: Reference Decode 25: Decodability 1: D 2: C 3: B 4: A Threshold raw value |
Set the raw value threshold for the selected quality standard, metric and grade (e.g. AIM-DPM → UEC → Threshold B = 50). Not all metrics are available for each standard: AIM-DPM (0, 1, 3, 4, 6, 8), ISO-IEC 15415 (0, 1, 3, 4, 6), ANSI-ISO-IEC 15416 (1, 4, 8, 9, 23, 25), 1D readability (0, 2, 8, 9, 11), DotCode (0, 1, 2, 3, 6, 8) | Ethernet readers. |
| PCM.MIN-PASS | Decoder | PUBLIC | 5.7.0 | SET|GET | type grade |
[0-5] [0-4] |
0: AIM-DPM 1: ISO-IEC 15415 2: ANSI-ISO-IEC 15416 3: SemiT10 4: 1D readability 5: DotCode Readybility 0: F 1: D 2: C 3: B 4: A |
Set the overall minimum passing grade. Results under this grade will mean the reading failed. | Ethernet readers. |
| PCM.USE-CUSTOM-THRESHOLDS | Decoder | PUBLIC | 5.7.0 | SET|GET | type state |
[0-5] [ON|OFF] |
0: AIM-DPM 1: ISO-IEC 15415 2: ANSI-ISO-IEC 15416 3: SemiT10 4: 1D readability 5: DotCode Readybility ON: do regrading OFF: keep current result |
Enable or disable regrading of metric results by using the custom thresholds. | Ethernet readers. |
| QR.QUALITY-METRICS | Decoder | PUBLIC | 4.5.0 | SET|GET | type |
[0-2] |
0: none 1: ISO/IEC 15415 2: AIM-DPM / ISO/IEC TR 29158 |
Code quality metrics for QR codes. | ALL |
| QR.TRAINED-MODEL | Decoder | PUBLIC | 5.7.0 | SET|GET | grid size module size model polarity mirrored |
[11-177] [1-1000] [0-3] [0-2] [ON|OFF] [ON|OFF] |
Grid size Module size * 10 0: Unknown model 1: Model-1 2: Model-2 3: Micro-QR 0: dark-on-light 1: light-on-dark 2: either enable/disable ON: mirrored OFF: not mirrored |
Set training parameters for QR-Code symbology. Option 3 for argument "model": Micro-QR is not applicable for 6.0.1. |
Fixed-mount readers |
| TRUCHECK.AG | Decoder | PUBLIC | 5.7.7 | GET | Returns the AG (average grade) score from the last verification attempt. | DM8072 Verifier | |||
| TRUCHECK.AG-GRADE | Decoder | PUBLIC | 5.7.7 | GET | Returns the AG (average grade) grade from the last verification attempt. | DM8072 Verifier | |||
| TRUCHECK.ANU | Decoder | PUBLIC | 5.7.7 | GET | Returns the ANU (axial non-uniformity) score from the last verification attempt. | DM8072 Verifier | |||
| TRUCHECK.ANU-GRADE | Decoder | PUBLIC | 5.7.7 | GET | Returns the ANU (axial non-uniformity) grade from the last verification attempt. | DM8072 Verifier | |||
| TRUCHECK.DECODE-GRADE | Decoder | PUBLIC | 5.7.7 | GET | Returns the DECODE grade from the last verification attempt. | DM8072 Verifier | |||
| TRUCHECK.FPD | Decoder | PUBLIC | 5.7.7 | GET | Returns the FPD (fixed pattern damage) score from the last verification attempt. | DM8072 Verifier | |||
| TRUCHECK.FPD-GRADE | Decoder | PUBLIC | 5.7.7 | GET | Returns the FPD (fixed pattern damage) grade from the last verification attempt. | DM8072 Verifier | |||
| TRUCHECK.GNU | Decoder | PUBLIC | 5.7.7 | GET | Returns the GNU (grid non-uniformity) score from the last verification attempt. | DM8072 Verifier | |||
| TRUCHECK.GNU-GRADE | Decoder | PUBLIC | 5.7.7 | GET | Returns the GNU (grid non-uniformity) grade from the last verification attempt. | DM8072 Verifier | |||
| TRUCHECK.MOD-GRADE | Decoder | PUBLIC | 5.7.7 | GET | Returns the MOD (modulation) grade from the last verification attempt. | DM8072 Verifier | |||
| TRUCHECK.RM-GRADE | Decoder | PUBLIC | 5.7.7 | GET | Returns the RM grade from the last verification attempt. | DM8072 Verifier | |||
| TRUCHECK.SC | Decoder | PUBLIC | 5.7.7 | GET | Returns the SC (symbol contrast) score from the last verification attempt. | DM8072 Verifier | |||
| TRUCHECK.SC-GRADE | Decoder | PUBLIC | 5.7.7 | GET | Returns the SC (symbol contrast) grade from the last verification attempt. | DM8072 Verifier | |||
| TRUCHECK.UEC | Decoder | PUBLIC | 5.7.7 | GET | Returns the UEC (unused error correction) score from the last verification attempt. | DM8072 Verifier | |||
| TRUCHECK.UEC-GRADE | Decoder | PUBLIC | 5.7.7 | GET | Returns the UEC (unused error correction) grade from the last verification attempt. | DM8072 Verifier | |||
| VSOC.ACCELERATION | Decoder | PRIVATE | 4.0.0 | SET|GET | enable |
[ON|OFF] | enable/disable | Enabled or disable VSOC acceleration. | |
| BEEP.DATAVALID-FAIL | IO | PUBLIC | 3.0.0 | SET|GET | repetition level |
[0-3] [0-2] |
number of beeps 0: Lo pitch 1: Med pitch 2: Hi pitch |
Data Validation Failure Beep Settings. | ALL except for DM50, DM60 and DM70. |
| BEEP.DATAVALID-FAIL-OL | IO | PUBLIC | 3.0.0 | SET|GET | repetition level |
[0-3] [0-2] |
number of beeps 0: Lo pitch 1: Med pitch 2: Hi pitch |
Data Validation Failure Beep Settings when offline. | Wireless readers. |
| BEEP.GOOD | IO | PUBLIC | 3.0.0 | SET|GET | repetition level |
[0-3] [0-2] |
number of beeps 0: Lo pitch 1: Med pitch 2: Hi pitch |
Good Read Beep Settings. | ALL except for DM50, DM60 and DM70. |
| BEEP.GOOD-OL | IO | PUBLIC | 3.0.0 | SET|GET | repetition level |
[0-3] [0-2] |
number of beeps 0: Lo pitch 1: Med pitch 2: Hi pitch |
Good Read Beep Settings when offline. | Wireless readers. |
| BEEP.NO-READ | IO | PUBLIC | 3.0.0 | SET|GET | repetition level |
[0-3] [0-2] |
number of beeps 0: Lo pitch 1: Med pitch 2: Hi pitch |
No-Read Beep Settings. | ALL except for DM50, DM60 and DM70. |
| BEEP.NO-READ-OL | IO | PUBLIC | 3.0.0 | SET|GET | repetition level |
[0-3] [0-2] |
number of beeps 0: Lo pitch 1: Med pitch 2: Hi pitch |
No-Read Beep Settings when offline. | Wireless readers. |
| BEEPER.ENABLED | IO | PUBLIC | 5.7.1 | SET|GET | state |
[ON|OFF] | Enable/disable beeper in general. | All | |
| BUTTON.3SEC-ACTION | IO | PUBLIC | 3.0.0 | SET|GET | mode state |
[0-6] [ON|OFF] |
0: Train 1: Optimize Brighness 2: Set Match String 3: Optimize Focus 4: Read Configuration Code 5: Tune 6: Toggle Test Mode enable/disable |
Three Second Button Action. | Fixed mount readers. Test Mode is only supported on the DM503, DM300 series readers and DM474. |
| BUTTON.ACTION | IO | PUBLIC | 5.5.1 | SET|GET | button action |
[0-2] [0-1] |
Index of button (0:Left;1:Right;2:Grip) 0: disabled 1: trigger |
Sets and gets the assigned feature for hardware buttons. | MX-1000 |
| BUTTON.ENABLE | IO | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enables or disables the trigger button. | Fixed mount readers. |
| COM.BUFFER-DATA | IO | PRIVATE | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | ||
| COM.DATA-BITS | IO | PRIVATE | 3.0.0 | SET|GET | bits |
[7|8] | RS232 data bits | ||
| ENCODER.COUNT | IO | PUBLIC | 4.1.0 | SET|GET | value |
[0-2 billion] | value to set | Gets the encoder count or sets it to the specified value. | Fixed-mount readers |
| ENCODER.DISTANCE-TO-OUTPUT | IO | PUBLIC | 4.1.0 | SET|GET | int |
0-1000000 mm |
Default: 0 Min: 0 Max: 1000000 Step: 1 |
Sets the output distance from the trigger on the sensor. | DM300 series readers, DM474. |
| ENCODER.DOUBLE-RATE | IO | PUBLIC | 5.7.0 | SET|GET | boolean |
[ON|OFF] | Edge detection | If set to ON, Encoder will count both edges on the Encoder Input line. If set to OFF, Encoder will count only the selected edge. | DM503 |
| ENCODER.DOUBLE-RATE | IO | PUBLIC | 6.1.6 | SET|GET | boolean |
[ON|OFF] | Edge detection | If set to ON, Encoder will count both edges on the Encoder Input line. If set to OFF, Encoder will count only the selected edge. | DM360, DM370, and DM470 series readers. |
| ENCODER.FLUSH | IO | PUBLIC | 4.1.0 | Flushes all encoder actions. | DM474, DM503 and DM300 series readers. | ||||
| ENCODER.MODE | IO | PUBLIC | 5.5.0 | SET|GET | value |
[0-4] |
0: Encoder A signal counts up, Encoder B signal counts down. 1: Encoder A signal counts up, Encoder B signal counts down. 2: Encoder A and Encoder B form quadrature (SIN/COS) signal, 1 count per cycle. 3: Encoder A and Encoder B form quadrature (SIN/COS) signal, 2 counts per cycle. 4: Encoder A and Encoder B form quadrature (SIN/COS) signal, 4 counts per cycle. |
Encoder mode. Sets the mode the encoder signals are interpreted if the Encoder Direction pin is defined. | Fixed-mount readers |
| ENCODER.RESET | IO | PUBLIC | 5.5.0 | Resets the encoder count to 0 and clears all encoder related events. | Fixed-mount readers | ||||
| ENCODER.RESOLUTION | IO | PUBLIC | 4.1.0 | SET|GET | int |
0-1000000 um |
Default: 5000 Min: 0 Max: 1000000 Step: 1 |
Sets the distance per pulse of the encoder. | DM474, DM503, and DM300 series readers. |
| EVENT.RULES | IO | PRIVATE | 3.4.0 | SET|GET | rules |
||||
| IMAGE.LOAD-FTP-MULT-PARAM | IO | PRIVATE | 5.5.0 | SET | server_ip picture last_image more burst_count buffer-overflow seq_nbr ” ” ”user” ”passwd” port |
[ON|OFF] [3] [0-1] |
Server IP Picture name enable/disable Number of images to take 0: Off 1: On Sequence number in the burst User name Password Port used |
Allows uploading of multiple pictures as a burst. | ALL |
| INPUT.ACTION | IO | PUBLIC | 4.0.0 | SET|GET | line action state |
[0-3] [0-11] [ON|OFF] |
Input line number 0: Train Code 1: Optimize Brightness 2: Set Match String 3: Optimize Focus 4: Read Configuration Code 5: Trigger Off 6: Encoder 7: Allow Buffered No-Read Images 8: Clear Outputs 9: Tune (DM300 only) 10: Encoder direction 11: Trigger on ON: execute action when line is triggered OFF: no action |
Sets or gets the state for the specified line action. The input actions "Train Code," "Optimize Brightness," "Set Match String," and "Read Configuration Code" are carried out only after the next trigger. |
Fixed-mount readers. |
| INPUT.ACTION1 | IO | PUBLIC | 3.0.0 | SET|GET | mode state |
[0-3] [ON|OFF] |
0: Train Code 1: Optimize Brighness 2: Set Match String 3: Optimize focus (Only for readers with a liquid lens.) enable/disable |
Input Line 1 Action. | Fixed mount readers. |
| INPUT.EVENT-MESSAGE | IO | PRIVATE | 5.0.0_cr10 | SET|GET | state |
[ON|OFF] | enable/disable | Instructs the system to generate a message for every input line state change. | DM300 series readers, DM474. |
| INTELLIGRATED.HEARTBEAT | IO | PRIVATE | 5.0.0_cr14 | SET|GET | sec |
[0-50] | seconds | Sets or gets the time between heartbeat transmissions. A value of 0 disables the heartbeat. | DM503 series readers. |
| IO-LINE.DIRECTION | IO | PUBLIC | 5.5.0 | SET|GET | line direction |
[2,3] [0,1] |
line=2: sets direction of I/O Line 2 line=3: sets direction of I/O Line 3 direction=0: defines line as output direction=1: defines line as input |
Sets the direction of the programmable I/O lines of DM360 and DM474 series readers. | DM360 series, DM474 readers |
| KEY.EMULATE-PS2 | IO | PRIVATE | 5.4.0 | SET|GET | state |
[ON|OFF]
[OFF, Wedge, EmulationG |
enable/disable
OFF: no emulation Wedge: reader and PS/2 keyboard are connected using a wedge cable Emulation: reader is connected to wedge and no PS/2 keyboard is present |
Wireless readers. | |
| KEY.LANGUAGE | IO | PUBLIC | 3.0.0 | SET|GET | language |
[0-7] |
0: Alt Key Combo 1: DE 2: US 3: JP 4: FR 5: ES 6: NO 7: FI |
ALL except for DM60, DM474, DM503, and DM300 series readers. | |
| KEY.ZERO-PAD | IO | PUBLIC | 3.0.0 | SET|GET | language |
[ON|OFF] | enable/disable | ALL except for DM60, DM474, DM503, and DM300 series readers. | |
| LIGHTCURTAIN.BEAM-SPACING | IO | PUBLIC | 4.1.0 | SET|GET | spacing |
[1-300000] | micrometers | Distance (in um) between beams of the Light Curtain. This determines the resolution of the light curtain. | DM503 |
| LIGHTRING.DURATION | IO | PUBLIC | 5.7.0 | SET|GET | duration |
[0..10000] |
0: Default behavior 10..10000: duration of lightring event in ms, step 10 ms |
Controls the duration of the lightring illumination event. | DM36x, DM474 and DM503 |
| OUTPUT-QUEUE.FLUSH | IO | PUBLIC | 4.1.0 | int |
[0-1] |
0: throw output away 1: send all output now |
To flush or send all output. | DM474, DM503, and DM300 series readers. | |
| OUTPUT.ACTION | IO | PREVIEW | 3.0.0 | SET|GET | line action |
[0-7] [0-1] |
line number 0: Open 1: Close |
Output Action. Open or Close output line on event. Only supported on line 1. |
Fixed mount readers. |
| OUTPUT.CQ-FAIL | IO | PRIVATE | 3.0.0 | Output Code Quality failed actions. Verifiers only. |
|||||
| OUTPUT.DATAVALID-FAIL | IO | PRIVATE | 3.0.0 | Output Data Validation failed actions. | |||||
| OUTPUT.EVENTS | IO | PREVIEW | 3.0.0 | SET|GET | line read no-read validation-failure trigger-overrun buffer-overflow user event 1 user event 2 |
[0-7] [0-1] [0-1] [0-1] [0-1] [0-1] [0-1] [0-1] |
i/o line number 0: Off 1: On 0: Off 1: On 0: Off 1: On 0: Off 1: On 0: Off 1: On 0: Off 1: On 0: Off 1: On |
Output Events. Configure output line to signal based on event. |
Fixed mount readers. |
| OUTPUT.GOOD | IO | PRIVATE | 3.0.0 | Output good read actions. | |||||
| OUTPUT.NOREAD | IO | PRIVATE | 3.0.0 | Output no read actions. | |||||
| OUTPUT.PULSE-WIDTH | IO | PUBLIC | 3.0.0 | SET|GET | line ms |
[0-7] [0-30000] |
i/o line number milliseconds |
Output Pulse-width. | Fixed mount readers. |
| OUTPUT.RESERVED | IO | PUBLIC | 3.0.0 | SET|GET | line reserved |
[0-7] [ON|OFF] |
i/o line number enable/disable |
Output Reserved for External Illumination. Line will be controlled by acquisition system when enabled. | Fixed mount readers, except DM50, DM60 and DM70. |
| OUTPUT.TRIG-OVERRUN | IO | PRIVATE | 3.0.0 | Output trigger overrun actions. | |||||
| RESULT.NO-READ-STRING | IO | PUBLIC | 3.0.0 | SET|GET | string |
no-read-string | No-Read Output String. | ALL | |
| TRIGGER.DEBOUNCE-DELAY | IO | PUBLIC | 4.0.0 | SET|GET | delay |
[0-6] |
0: short 1: 2: default 3: 4: 5: 6: long |
Sets or gets how long the trigger signal must be detected in order to be recognized as valid. | Fixed-mount readers. |
| TRIGGER.END-HOLDOFF-DISTANCE | IO | PUBLIC | 5.5.0 | SET|GET | distance |
[0-10000 mm] | distance for hold-off at trigger end | When greater than 0, the distance with which to cancel a pending trigger off and allow the trigger to continue. | DM474, DM503 and DM300 series readers. |
| TRIGGER.END-HOLDOFF-TIME | IO | PUBLIC | 5.5.0 | SET|GET | rime |
[0-10000 ms] | time for hold-off at trigger end | When greater than 0, the time with which to cancel a pending trigger off and allow the trigger to continue. | Fixed-mount readers |
| TRIGGER.HOLDOFF-DISTANCE | IO | PUBLIC | 5.5.0 | SET|GET | distance |
[0-10000 mm] | distance for hold-off at trigger start | When greater than 0, the distance with which to cancel a pending trigger on and act like there was no trigger at all. | DM474, DM503 and DM300 series readers. |
| TRIGGER.HOLDOFF-TIME | IO | PUBLIC | 5.5.0 | SET|GET | time |
[0-10000 ms] | time for hold-off at trigger start | When greater than 0, the time with which to cancel a pending trigger on and act like there was no trigger at all. | Fixed-mount readers |
| TRIGGER.HOLDOFF-TYPE | IO | PUBLIC | 5.5.0 | SET|GET | type |
[0-2] |
0 = None 1 = Time 2 = Distance |
Which type of trigger hold-off to use, none, time or distance. | Fixed-mount readers |
| TRIGGER.IGNORE-DISTANCE | IO | PRIVATE | 5.5.0 | SET|GET | milliseconds |
[0-2147483646] | Sets or gets the minimum trigger distance for a trigger to be considered good. All trigger durations less than the specified duration will be aborted. | Fixed-mount readers | |
| TRIGGER.IGNORE-TIME | IO | PRIVATE | 5.5.0 | SET|GET | milliseconds |
[0-10000] | Sets or gets the minimum trigger duration for a trigger to be considered good. All trigger durations less than the specified duration will be aborted. | Fixed-mount readers | |
| TRIGGER.IGNORE-TYPE | IO | PRIVATE | 5.5.0 | SET|GET | mode |
[0-2] |
0: none 1: time 2: distance |
Sets or gets what type of triggers to ignore. | Fixed-mount readers |
| TRIGGER.POLARITY | IO | PUBLIC | 4.0.0 | SET|GET | line polarity |
[0-3] [ON|OFF] |
Input line ON: Rising edge OFF: Falling edge |
Sets or gets the polarity at which an input will be triggered. | Fixed mount readers. |
| TUNE-BUTTON.ENABLE | IO | PUBLIC | 5.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enables or disables the tune button. | DM474, DM503, and DM300 series readers. |
| IMAGEBUFFER.ALLOW-OVERWRITE | RecordPlayback | PUBLIC | 4.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Allow buffered images that have not been transfered to be overwritten if all available buffers are used and new images arrive. | DM50, DM60, DM70, DM474, DM503, DM300 series readers, DM8050 and DM8600. |
| IMAGEBUFFER.AUTO-PREFER-CENTER | RecordPlayback | PUBLIC | 5.7.3 | SET|GET | Controls whether to use the decoders best symbol or the symbol closer to the ROI center. | DM50, DM60, DM70, DM474, DM503, DM300 series readers, DM8050 and DM8600. | |||
| IMAGEBUFFER.DELETE | RecordPlayback | PUBLIC | 4.0.0 | Release stored images. | DM50, DM60, DM70, DM474, DM503, DM300 series readers, DM8050 and DM8600. | ||||
| IMAGEBUFFER.DELETE-AFTER-TRANSFER | RecordPlayback | PUBLIC | 4.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Release stored images automatically after image has been transfered. | DM50, DM60, DM70, DM474, DM503, DM300 series readers, DM8050 and DM8600. |
| IMAGEBUFFER.FORMAT | RecordPlayback | PUBLIC | 5.6.3 | SET|GET | format |
[0-2] |
0: Bitmap 1: JPEG 2: PNG |
DM50, DM60, DM70, DM474, DM503, MX-1000, DM8000 series and DM300 series readers. | |
| IMAGEBUFFER.GOOD-IMAGE-MODE | RecordPlayback | PUBLIC | 5.2.0 | SET|GET | mode |
[0-1] |
0: Unlimited 1: Rate limited |
Good Read Image stores all buffered good read images unless you set a limit rate. | DM503, DM300 series readers, DM8050 and DM8600. |
| IMAGEBUFFER.GOOD-IMAGE-RATE-BURST | RecordPlayback | PUBLIC | 5.2.0 | SET|GET | interval |
[1-1000] | Burst determines the peak rate of the number of good read images buffered. | DM474, DM503, DM300 series readers, DM8050 and DM8600. | |
| IMAGEBUFFER.GOOD-IMAGE-RATE-COUNT | RecordPlayback | PUBLIC | 5.2.0 | SET|GET | interval |
Number of good read images to be buffered at a time unit (for example, minutes or hours) specified with IMAGEBUFFER.GOOD-IMAGE-RATE-COUNT. | DM474, DM503, DM300 series readers, DM8050 and DM8600. | ||
| IMAGEBUFFER.GOOD-IMAGE-RATE-TIME | RecordPlayback | PUBLIC | 5.2.0 | SET|GET | type |
[0-3] |
0: seconds 1: minutes 2: hours 3: days |
Time unit of good read images to be buffered at a rate number specified with IMAGEBUFFER.GOOD-IMAGE-RATE-TIME. | DM474, DM503, DM300 series readers, DM8050 and DM8600. |
| IMAGEBUFFER.IMAGE-TYPE | RecordPlayback | PUBLIC | 5.5.0 | SET|GET | int |
[0-2] |
0: All 1: Same as result 2: Auto |
Sets "What images to Buffer for a Result". When "Auto" is selected, the reader does intelligent image buffering. Requires the IntImageBuffer feature key to select the "Auto" option. |
DM70, DM150, DM260, DM300 series readers, DM474, DM503. |
| IMAGEBUFFER.MAX-IMAGES-PER-RESULT | RecordPlayback | PUBLIC | 5.0.0 | SET|GET | size |
[0-*] | Sets or gets how many images (n) per result are stored. | DM50, DM60, DM70, DM474, DM503, DM300 series readers, DM8050 and DM8600. | |
| IMAGEBUFFER.MAX-NUM | RecordPlayback | PUBLIC | 4.0.0 | SET|GET | size |
[0-*] | Maximum number of images that can be buffered. * Range varies depending depending on Camera ROI and memory allocated for burst length. |
DM50, DM60, DM70, DM474, DM503, DM300 series readers, DM8050 and DM8600. | |
| IMAGEBUFFER.NO-READ-IMAGE-LAST-NUMBER | RecordPlayback | PRIVATE | 5.5.0 | SET|GET | limit |
[n][Max Int] | In Burst trigger mode, n is the number of images in a burst. In other trigger modes, there is no limit. | Stores images up to the limit. | Fixed-mount readers, only in Single, Burst, Self and Continuous modes. |
| IMAGEBUFFER.NO-READ-IMAGE-MODE | RecordPlayback | PRIVATE | 5.0.0 | SET|GET | size |
[0-3] |
0: No-Read Image Period 1: No-Read Image Number 2: No-Read Image Rate 3: No-Read Image Range |
No-Read Image stores only one image per trigger and you can select which one. No-Read Image Period stores every nth bad read image. This is evaluated across trigger modes. For example, if you have burst trigger selected with a length of 5 and set period to 3, the 1st and 4th image of the first, but the 2nd and 5th of the second burst will be stored. No-Read Image Range stores all bad read images from the no-read image number to the last no-read image number. | Fixed-mount readers, only in Single, Burst, Self and Continuous modes. |
| IMAGEBUFFER.NO-READ-IMAGE-NUMBER | RecordPlayback | PUBLIC | 5.0.0 | SET|GET | limit |
[n] [Max Int] |
In Burst trigger mode, n is the number of images in a burst In other trigger modes, there is no limit |
Store exactly one image. | DM50, DM60, DM70, DM474, DM503, DM300 series readers, only in Single, Burst, Self and Continuous modes. |
| IMAGEBUFFER.NO-READ-IMAGE-PERIOD | RecordPlayback | PUBLIC | 4.0.0 | SET|GET | interval |
[1-200] | Sets or gets the interval to save the image of a bad read. If, for example, you use an interval of 6, the first bad image is saved and the next 5 are not. The default is 1 which saves each bad read image. | DM50, DM60, DM70, DM474, DM503, DM300 series readers, only in Single, Burst, Self and Continuous modes. | |
| IMAGEBUFFER.NO-READ-IMAGE-RATE-BURST | RecordPlayback | PUBLIC | 5.2.0 | SET|GET | interval |
[1-1000] | Burst determines the peak rate of the number of bad read images buffered. | DM474, DM503, DM300 series readers, only in Single, Burst, Self and Continuous modes. | |
| IMAGEBUFFER.NO-READ-IMAGE-RATE-COUNT | RecordPlayback | PUBLIC | 5.2.0 | SET|GET | interval |
Number of bad read images to be buffered at a time unit (for example, minutes or hours) specified with IMAGEBUFFER.NO-READ-IMAGE-RATE-COUNT. | DM503, DM300 series readers, only in Single, Burst, Self and Continuous modes. | ||
| IMAGEBUFFER.NO-READ-IMAGE-RATE-TIME | RecordPlayback | PUBLIC | 5.2.0 | SET|GET | type |
[0-3] |
0: seconds 1: minutes 2: hours 3: days |
Time unit of bad read images to be buffered at a rate number specified with IMAGEBUFFER.NO-READ-IMAGE-RATE-TIME. | DM474, DM503, DM300 series readers, only in Single, Burst, Self and Continuous modes. |
| IMAGEBUFFER.NO-READ-INDEX | RecordPlayback | PRIVATE | 4.4.0_cr2 | SET|GET | index |
0 is the default behavior to send all as selected; 1 – max burst is send only the index selected. | DM474, DM300 series readers, DM8050 and DM8600. | ||
| IMAGEBUFFER.NUM | RecordPlayback | PUBLIC | 4.0.0 | GET | size |
Returns the number of currently buffered images. | DM50, DM60, DM70, DM474, DM503, DM300 series readers, DM8050 and DM8600. | ||
| IMAGEBUFFER.OVERLAY | RecordPlayback | PUBLIC | 5.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enables Overlay Graphics (SVG) for buffered images. | DM50, DM60, DM70, DM474, DM503, DM300 series readers, DM8050 and DM8600. |
| IMAGEBUFFER.QUALITY | RecordPlayback | PUBLIC | 4.0.0 | SET|GET | quality |
[10, 15, 20... 85, 90] | JPEG Quality | DM50, DM60, DM70, DM474, DM503, MX-1000, DM8000 series and DM300 series readers. | |
| IMAGEBUFFER.RECORD | RecordPlayback | 4.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable or disable image buffereing. obsolete in 4.0.0. |
Fixed mount readers, DM8050 and DM8600. | |
| IMAGEBUFFER.RECORD-TYPE | RecordPlayback | PUBLIC | 4.0.0 | SET|GET | type |
[0-5] |
0: None 1: No-Read 2: Read 3: All 4: Validation Failure 5: No-Read + Validation failure |
Sets or gets the type of image to buffer. In case of No-Read, the image is buffered if the reader fails to read. |
DM50, DM60, DM70, DM474, DM503, MX-1000, DM8000 series and DM300 series readers. |
| IMAGEBUFFER.SEND-FTP | RecordPlayback | PUBLIC | 4.0.0 | Transmit buffered images to designated FTP server. | DM60, DM474, DM503, DM8000 series and DM300 series readers. | ||||
| IMAGEBUFFER.SEND-FTP-PARAM | RecordPlayback | PRIVATE | 4.0.0 | Transmit buffered images to designated FTP server. | Fixed mount Ethernet readers, DM8050 and DM8600. | ||||
| IMAGEBUFFER.SIZE | RecordPlayback | PUBLIC | 4.0.0 | SET|GET | size |
[0-3] |
0: Full 1: 1/4 2: 1/16 3: 1/64 |
DM50, DM60, DM70, DM474, DM503, MX-1000, DM8000 series and DM300 series readers. | |
| IMAGEBUFFER.TRANSFER-MODE | RecordPlayback | PUBLIC | 4.0.0 | SET|GET | interval |
[0-1] |
0: On Request 1: FTP - runtime |
Sets or gets whether buffered images should automatically sent FTP or if they should be send only after requested. | DM60, DM70, DM474, DM503, MX-1000, DM8000 series, and DM300 series readers and DM260. |
| 2D.ALGORITHM | Symbology | PUBLIC | 3.0.0 | SET|GET | algorithm |
[0-1] |
0: IDMax ©
1: IDQuick |
IDQuick or IDMax© | X, XM, SX and QE fixed-mount readers. All Q models except for DM503Q. |
| C11.CHKCHAR | Symbology | PUBLIC | 5.7.1 | SET|GET | state |
[ON|OFF] |
ON: enable OFF: disable (default) |
Code 11 Check Character | Mobile |
| C11.CHKCHAR-OPTION | Symbology | PUBLIC | 5.7.1 | SET|GET | int |
[0-1] |
0: disable 1: enable (default) |
Mobile | |
| C11.CODESIZE | Symbology | PUBLIC | 5.7.1 | SET|GET | any, min, max |
[ON|OFF] [1-max] [min-80] |
any length code minimum code length maximum code length |
Code 11 Code Size | ALL |
| C128.CODESIZE | Symbology | PUBLIC | 3.0.0 | SET|GET | any min max |
[ON|OFF] [1-max] [min-80] |
any length code minimum code length maximum code length |
Code 128 Allowed Size. | ALL |
| C25.CHKCHAR | Symbology | PUBLIC | 5.5.2 | SET|GET | state |
[ON|OFF] |
ON: enable OFF: disable |
Code 25 Check Character | ALL |
| C25.CODESIZE | Symbology | PUBLIC | 5.5.2 | SET|GET | any, min, max |
[ON|OFF] [1-max] [min-80] |
any length code minimum code length maximum code length |
Code 25 Code Size. For the Manatee Works SDK, all of the Code 25 variants use the same minimum length; thus it will accept either C25.CODESIZE or I205.CODESIZE. | ALL |
| C25.QZ-SIZE | Symbology | PUBLIC | 5.5.2 | SET|GET | size |
[0..100] | any length code | Sets or gets the single side strictness as a percentage. | ALL |
| C25.XMTCHK | Symbology | PUBLIC | 5.5.2 | SET|GET | state |
[ON|OFF] |
ON: enable OFF: disable |
Sets or gets whether to transmit the check digit. | ALL |
| C39.ASCII | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Code 39 Full ASCII. | ALL |
| C39.CHKCHAR | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Code 39 Check Character. | ALL |
| C39.CODESIZE | Symbology | PUBLIC | 3.0.0 | SET|GET | any min max |
[ON|OFF] [1-max] [min-80] |
any length code minimum code length maximum code length |
Code 39 Code Size. | ALL |
| C39.XMTCHK | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Code 39 Transmit Check Character. | ALL |
| C93.CODESIZE | Symbology | PUBLIC | 3.0.0 | SET|GET | any min max |
[ON|OFF] [1-max] [min-80] |
any length code minimum code length maximum code length |
Code 93 Code Size. | ALL |
| CODABAR.CHKCHAR | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Codabar Check Character. | ALL |
| CODABAR.CODESIZE | Symbology | PUBLIC | 3.0.0 | SET|GET | any min max |
[ON|OFF] [1-max] [min-80] |
any length code minimum code length maximum code length |
Codabar Code Size. | ALL |
| CODABAR.QZ-SIZE | Symbology | PRIVATE | 3.0.0 | SET|GET | state |
[0|100] | Quiet zone single strictness size. | ALL | |
| CODABAR.XMTCHK | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Codabar Transmit Check Character. | ALL |
| DATABAR.EXPANDED | Symbology | PUBLIC | 3.4.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable Databar expanded. | ALL |
| DATABAR.GROUP | Symbology | PUBLIC | 3.4.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable Databar group. | ALL |
| DATABAR.LIMITED | Symbology | PUBLIC | 3.4.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable Databar limited. | ALL |
| DATAMATRIX.ALGORITHM-VERSION | Symbology | PUBLIC | 3.5.3 | SET|GET | version |
[0-2] |
0: speed preferred 1: yield preferred 2: extended |
IDQuick Usage Type. | Fixed mount readers except for DM300L, DM503L, and DM503QL. 2 (extended) is supported by DM50, DM60, DM70, DM150, DM260. |
| DATAMATRIX.EXTREME-PRINT-GROWTH | Symbology | PUBLIC | 3.4.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable extreme print growth for DataMatrix symbols. | ALL except for DM50, DM60, DM70, DM300, DM503, DM8050 and DM8600. |
| DATAMATRIX.PRINT-DEFORMATION | Symbology | PUBLIC | 5.2.0 | SET|GET | state |
[0|1] |
0: Minimal 1: Moderate |
Sets the IDMax Properties. | DM300, DM474, DM503. |
| DATAMATRIX.SECURITY-KEY | Symbology | PRIVATE | 3.2.0 | SET | type name |
1 |
1: Custom1 |
Sets the secure Data Matrix key which is 32 byte string. This string needs to be entered in hexadecimal format. | |
| DATAMATRIX.SECURITY-TYPE | Symbology | PRIVATE | 3.2.0 | SET|GET | type state |
[0-1] [ON|OFF] |
0: None 1: Custom1 enable/disable |
Data Matrix security type used. Only valid with a valid security key is set. | ALL |
| DATAMATRIX.SYMBOL-DIFFICULTY | Symbology | PUBLIC | 5.1.0 | SET|GET | int |
[0-2] |
0: Easy 1: Medium 2: Hard |
Level of DataMatrix code symbol difficulty. | DM8600. |
| DATAMATRIX.TRAINED-FLEX-GRID | Symbology | PUBLIC | 5.2.0 | SET|GET | state |
[ON|OFF] | enable/disable | Switches the Trained Code Property "Flexible Grid Size". | DM300, DM474, DM503. |
| DATAMATRIX.TRAINED-IGNORE-POLARITY | Symbology | PUBLIC | 5.2.0 | SET|GET | state |
[ON|OFF] | enable/disable | Switches the Trained Code Property "Ignore Polarity". | DM300, DM474, DM503. |
| DATAMATRIX.USAGE | Symbology | PUBLIC | 3.0.0 | SET|GET | Usage Type |
[0-1] |
0: Default 1: High speed ink jet mode |
IDMax Usage Type. | ALL except for DM50, DM60, DM70, DM300, DM503. |
| DECODER.1D-MINIMUM-DECODES | Symbology | PUBLIC | 5.2.0 | SET|GET | int |
[0-5] | Minimum number of decoded scans to report a confident decoding (to prevent misread). | ALL | |
| EAN-UCC.CC-C | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable or disable Composite Code C. | ALL |
| EAN-UCC.XMTMODE | Symbology | PUBLIC | 3.0.0 | SET|GET | mode |
[0-1] |
0: Standard (linear & 2D) 1: Linear only |
EAN-UCC Transmit mode. | ALL |
| I2O5.CHKCHAR | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | I2of5 Check Character. | ALL |
| I2O5.CODESIZE | Symbology | PUBLIC | 3.0.0 | SET|GET | any min max |
[ON|OFF] [4-max] [min-80] |
any length code minimum code length maximum code length |
I2of5 Code Size. For the Manatee Works SDK, all of the Code 25 variants use the same minimum length; thus it will accept either C25.CODESIZE or I205.CODESIZE. | ALL |
| I2O5.QZ-SIZE | Symbology | PRIVATE | 3.0.0 | SET|GET | state |
[0|100] | Quiet zone single strictness size. | ALL | |
| I2O5.XMTCHK | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | I2of5 Transmit Check Character. | ALL |
| MSI.CHKCHAR | Symbology | PUBLIC | 5.0.0_cr5 | SET|GET | state |
[ON|OFF] | enable/disable | Sets or gets whether check character is used. Default value is OFF. | DM300 series, DM474, DM503, MX-1000, MX-1502, Mobile. |
| MSI.CHKCHAR-OPTION | Symbology | PUBLIC | 5.0.0_cr5 | SET|GET | mode |
[0-5] |
0: Mod10 1: Mod11 2: Mod1010 3: Mod1110 4: 5: |
Sets or gets the method for calculating checksum. | DM474, DM503 and DM300 series, MX-1000, MX-1502, Mobile. |
| MSI.CODESIZE | Symbology | PUBLIC | 5.0.0_cr5 | SET|GET | mode min max |
[ON|OFF] [1-max] [min-80] |
any length code minimum code length maximum code length |
Sets or gets the expected code size. | DM474, DM503, DM300 series readers, MX-1000, MX-1502. |
| MSI.QZ-SIZE | Symbology | PUBLIC | 5.0.0_cr5 | SET|GET | size |
[0-100] | Sets or gets the single side strictness as a percentage | DM474, DM503 and DM300 series readers. | |
| MSI.XMTCHK | Symbology | PUBLIC | 5.0.0_cr5 | SET|GET | state |
[ON|OFF] | enable/disable | Sets or gets whether to transmit the check digit. | DM474, DM503 and DM300 series readers. |
| MULTICODE.HORIZONTAL-REVERSE | Symbology | PUBLIC | 3.4.0 | SET|GET | state |
[ON|OFF] |
ON: sort right to left OFF: sort left to right |
Horizontal positional sorting order priority. | Fixed mount readers. |
| MULTICODE.IDENTICAL-SYMBOLS | Symbology | PUBLIC | 3.4.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enables/disables output of identical symbols when multicode is enabled. | Fixed mount readers. |
| MULTICODE.IMAGE-REVERSE | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] |
ON: sort last image first OFF: sort first image first |
Image sorting order preference. | Fixed mount readers. |
| MULTICODE.MAX-NUM-CODES | Symbology | PUBLIC | 3.2.0 | SET|GET | symbology number |
[1-5] [1-255] |
1: DataMatrix 2: QR Code/MaxiCode/AztecCode 3: Linear/ Postal/ Stacked 4: VeriCode® 5: DotCode |
The expected maximum number of codes to find for each symbology grouping 1 - 4; no expected value for any single symbology can exceed parameter 0, the total number of codes to find. | Fixed mount readers. |
| MULTICODE.NUM-CODES | Symbology | PUBLIC | 3.2.0 | SET|GET | number |
[1-255] | Number of codes readers must find for a successful read result. | Fixed mount readers. | |
| MULTICODE.PARTIAL-RESULTS | Symbology | PUBLIC | 3.2.0 | SET|GET | state |
[ON|OFF] | enable/disable | Controls how the reader interprets the number of codes to find. ON = reader will return a successful read if 1 or more codes are found. OFF = reader will return a successful read only if number of codes found equals MULTICODE.NUM-CODES value. | Fixed mount readers. |
| MULTICODE.SORT-PRIORITY | Symbology | PUBLIC | 3.4.0 | SET|GET | symbology image vertical position horizontal position |
[0-3] [0-3] [0-3] [0-3] |
Range for all four arguments indicates sort priority. Must be different for each criteria. |
Sorting order for multicode results: 0 is highest priority, 3 is lowest priority. | Fixed mount readers. |
| MULTICODE.SYMBOLOGY-REVERSE | Symbology | PUBLIC | 3.4.0 | SET|GET | state |
[ON|OFF] |
ON: DotCode, VeriCode ®, Linear/Postal/Stacked, QR Code/MaxiCode/AztecCode, Data Matrix OFF: Data Matrix, QR Code/MaxiCode/AztecCode, Linear/Postal/Stacked, VeriCode ®, DotCode |
Symbology sorting order preference. | Fixed mount readers. |
| MULTICODE.VERTICAL-REVERSE | Symbology | PUBLIC | 3.4.0 | SET|GET | state |
[ON|OFF] |
ON: sort bottom to top OFF: sort top to bottom |
Vertical position sorting order preference. | Fixed mount readers. |
| PHARMA.CODE-ORIENTATION | Symbology | PUBLIC | 3.4.0 | SET|GET | direction |
[0-2] |
0: Any (default) 1: Horizontal 2: Vertical |
Preferred orientation for decoding Pharmacode symbols. | ALL |
| PHARMA.CODESIZE | Symbology | PUBLIC | 3.4.0 | SET|GET | any min max |
[ON|OFF] [1-6] [1-6] |
any length code minimum code length maximum code length |
Expected Pharmacode size. | ALL |
| PHARMA.HORIZONTAL-DIRECTION | Symbology | PUBLIC | 3.4.0 | SET|GET | direction |
[0-1] |
0: left-to-right (default) 1: right-to-left |
Horizontal direction preference for decoding Pharmacode symbols. | ALL |
| PHARMA.MAX-LENGTH | Symbology | PRIVATE | 4.4.0 | SET|GET | length |
[1-6] | Gets or sets the maximum length for a Pharmacode. Obsoleted in 5.1. |
ALL | |
| PHARMA.MIN-LENGTH | Symbology | PRIVATE | 4.4.0 | SET|GET | length |
[1-6] | Gets or sets the minimum length for a Pharmacode. Obsoleted in 5.1. |
ALL | |
| PHARMA.SUPPLEMENTARY | Symbology | PRIVATE | 3.4.0 | SET|GET | state |
[ON|OFF] | enable/disable | Get or set whether supplementary component is expected. | ALL |
| PHARMA.SUPPLEMENTARY-GAP-THRESH | Symbology | PRIVATE | 3.4.0 | SET|GET | gap |
[100-300] | Get or set the Pharmacode supplementary gap threshold in pixels. | ALL | |
| PHARMA.VERTICAL-DIRECTION | Symbology | PUBLIC | 3.4.0 | SET|GET | direction |
[0-1] |
0: top-to-bottom (default) 1: bottom-to-top |
Vertical direction preference for decoding Pharmacode symbols. | ALL |
| PLANET.XMTCHK | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | PLANET Transmit Check Character. | ALL |
| POSTNET.XMTCHK | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | POSTNET Transmit Check Character. | ALL |
| QR.MAXIMUM-GRID-SIZE | Symbology | PUBLIC | 5.2.0 | SET|GET | size |
[49-177] | Step size: 4. | Maximum grid size which can be read by the QR decoder. | ALL |
| QR.MICRO | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Micro QR Code. | ALL except for DM300L, DM503L, and DM503QL. |
| QR.MODEL1 | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | QR model-1. | ALL except for DM300L, DM503L, and DM503QL. |
| QR.MODEL2 | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | QR model-2. | ALL except for DM300L, DM503L, and DM503QL. |
| QR.SYMBOL-DIFFICULTY | Symbology | PUBLIC | 5.1.0 | SET|GET | int |
[0-2] |
0: Easy 1: Medium 2: Hard |
Level of QR code symbol difficulty. | DM8600. |
| RSS.EXPANDED | Symbology | PUBLIC | 4.4.0 | SET|GET | state |
[ON|OFF] | enable/disable | RSS Expanded. | ALL |
| SYMBOL.4STATE-AUS | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable 4-State Australia Post Symbology. | ALL except for DM150QL, DM260QL, DM300L, DM503L, and DM503QL. |
| SYMBOL.4STATE-IMB | Symbology | PUBLIC | 3.4.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable 4-State Intelligent Mail Barcode. | ALL except for DM150QL, DM260QL, DM300L, DM503L, and DM503QL. |
| SYMBOL.4STATE-JAP | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable 4-State Japan Post Symbology. | ALL except for DM150QL, DM260QL, DM300L, DM503L, and DM503QL. |
| SYMBOL.4STATE-RMC | Symbology | PRIVATE | 5.6.0 | SET|GET | state |
[ON|OFF] | enable/disable Enable/Disable | Enables or disables Royal Mail Code Symbology. | DM50, DM60, DM70, DM150, DM260, DM30x, DM474, DM503, MX-1000, MX-1502. Mobile. |
| SYMBOL.4STATE-UPU | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable 4-State UPU Symbology. | ALL except for DM150QL, DM260QL, DM300L, DM503L, and DM503QL. |
| SYMBOL.AZTECCODE | Symbology | PUBLIC | 5.0.0_cr2 | SET|GET | state |
[ON|OFF] | enable/disable | Enable Aztec code symbology. | DM70, DM150, DM260, DM503, DM300 series readers, DM474, DM8050, DM8600, MX-1000, MX-1502, Mobile. |
| SYMBOL.C11 | Symbology | PUBLIC | 5.7.1 | SET|GET | state |
[ON|OFF] | enable/disable | Enable Code 11 Symbology. | ALL |
| SYMBOL.C128 | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable Code 128 Symbology. | ALL |
| SYMBOL.C25 | Symbology | PUBLIC | 5.5.2 | SET|GET | state |
[ON|OFF] | enable/disable | Enable Code 25 Symbology. Manatee Works supports 7 subcodes: Standard, Interleaved, ITF-14, IATA, Matrix, COOP, and Inverted. | ALL |
| SYMBOL.C39 | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable Code 39 Symbology. | ALL |
| SYMBOL.C39-CONVERT-TO-C32 | Symbology | PUBLIC | 5.5.0 | SET | state |
[ON|OFF] | enable/disable | Enables/disables the conversion of Code39 to Code32. | ALL |
| SYMBOL.C93 | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable Code 93 Symbology. | ALL |
| SYMBOL.CODABAR | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable Codabar Symbology. | ALL |
| SYMBOL.COOP | Symbology | PUBLIC | 5.7.1 | SET|GET | state |
[ON|OFF] | enable/disable | ALL | |
| SYMBOL.DATABAR | Symbology | PUBLIC | 3.4.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable Databar. It will enable EXPANDED and LIMITED in Manatee Works SDK (just like MX). | ALL |
| SYMBOL.DATAMATRIX | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable DataMatrix Symbology. | ALL except for DM150QL, DM260QL, DM300L, DM503L, and DM503QL. |
| SYMBOL.DOTCODE | Symbology | PUBLIC | 5.0.0_cr3 | SET|GET | state |
[ON|OFF] | enable/disable | Enable DotCode symbology. | DM70, DM150, DM260, DM300 series readers, DM474, DM8050X, DM8600, MX-1000, MX-1502, Mobile. |
| SYMBOL.EAN-UCC | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable EAN-UCC Symbology. | ALL |
| SYMBOL.I2O5 | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable Interleaved 2 of 5 Symbology. | ALL |
| SYMBOL.IATA | Symbology | PUBLIC | 5.7.1 | SET|GET | state |
[ON|OFF] | enable/disable | ALL | |
| SYMBOL.INVERTED | Symbology | PUBLIC | 5.7.1 | SET|GET | state |
[ON|OFF] | enable/disable | ALL | |
| SYMBOL.ITF14 | Symbology | PUBLIC | 5.7.1 | SET|GET | state |
[ON|OFF] | enable/disable | ALL | |
| SYMBOL.MATRIX | Symbology | PUBLIC | 4.7.1 | SET|GET | state |
[ON|OFF] | enable/disable | Enable Matrix symbology. | All. |
| SYMBOL.MAXICODE | Symbology | PUBLIC | 4.5.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable MaxiCode symbology. | DM50, DM60, DM70, DM150, DM260, DM300 series readers, DM474, DM503, DM8050, DM8600, MX-1000 and MX-1502, Mobile. |
| SYMBOL.MICROPDF417 | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable Micro-PDF 417 Symbology. | ALL |
| SYMBOL.MSI | Symbology | PUBLIC | 5.0.0_cr5 | SET|GET | state |
[ON|OFF] | enable/disable | Sets or gets whether MSI Code is enabled or disabled | DM70, DM150, DM260, DM503, DM300 series readers, DM474, MX-1000, MX-1502, Mobile. |
| SYMBOL.PDF417 | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable PDF 417 Symbology. | ALL |
| SYMBOL.PHARMACODE | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable Pharmacode symbology. | ALL |
| SYMBOL.PLANET | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable PLANET Symbology. | ALL except for DM150QL, DM260QL, DM300L, DM302L, DM503L, and DM503QL. |
| SYMBOL.POSTNET | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable POSTNET Symbology. | ALL except for DM150QL, DM260QL, DM300L, DM503L, and DM503QL. |
| SYMBOL.QR | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable QR-Code Symbology. Enables QR and Micro QR in Manatee Works SDK. | ALL except for DM150QL, DM260QL, DM300L, DM503L and DM503QL. |
| SYMBOL.RPC | Symbology | PRIVATE | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Reader Programming Code. | DM70, DM150, DM260 |
| SYMBOL.UPC-EAN | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable UPC/EAN Symbology. It will enable UPC-A, UPC-E, EAN-8, and EAN-13 in Manatee Works SDK (just like MX). | ALL |
| SYMBOL.VERICODE | Symbology | PUBLIC | 3.2.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable VeriCode ® symbology. | DM70, DM150 and DM260 readers with VeriCode ® license. |
| TRAIN.AUTO-DISABLE | Symbology | PREVIEW | 3.2.0 | SET|GET | state |
[ON|OFF] | enable/disable | Indicates whether untrained symbology groups will be disabled after the next attempt to train. | Fixed mount readers. |
| TRAIN.AVAILABLE | Symbology | PRIVATE | 3.2.0 | GET | symbology |
Indicates whether incremental training is available for the selected symbology group. | Fixed mount readers. | ||
| TRAIN.INCREMENTAL | Symbology | PUBLIC | 3.2.0 | SET|GET | state |
[ON|OFF] | enable/disable | Indicates whether incremental training is used during the next attempt to train. | Fixed mount readers. |
| TRAINED-CODE.INFO | Symbology | PUBLIC | 4.4.0 | GET | Gets information about the currently trained code type ('Untrained' if no code is trained). | Fixed mount devices. | |||
| UPC-EAN.DELZERO | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | UPC/EAN Delete Leading Zero. | ALL |
| UPC-EAN.EAN13 | Symbology | PUBLIC | 5.7.1 | SET|GET | state |
[ON|OFF] | enable/disable | UPC/EAN Allow EAN13. | ALL |
| UPC-EAN.EAN8 | Symbology | PUBLIC | 5.7.1 | SET|GET | state |
[ON|OFF] | enable/disable | UPC/EAN Allow EAN8. | ALL |
| UPC-EAN.EAN8SUPL | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | UPC/EAN Allow EAN8 Supplementals. | ALL |
| UPC-EAN.EXPANDED | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | UPC/EAN Expanded. | ALL |
| UPC-EAN.SUPPLEMENT | Symbology | PUBLIC | 3.0.0 | SET|GET | option |
[0-4] |
0: Ignore 1: Required 2: Required 2 digit 3: Required 5 digit 4: Not required |
UPC/EAN Supplementals. The Manatee Works SDK only supports turning UPC/EAN supplement code support on/off, while the DMCC command allows them to be off, required, require a 2 digit, require a 5 digit, or optionally permit them. The Manatee Works SDK will treat options 1-4 the same; to simply enable them. | ALL |
| UPC-EAN.UPC-A | Symbology | PUBLIC | 5.7.1 | SET|GET | state |
[ON|OFF] | enable/disable | UPC/EAN UPC-A enabled. | ALL |
| UPC-EAN.UPC-E | Symbology | PUBLIC | 5.7.1 | SET|GET | state |
[ON|OFF] | enable/disable | UPC/EAN UPC-E enabled. | ALL |
| UPC-EAN.UPCE1 | Symbology | PUBLIC | 5.7.1 | SET|GET | state |
[ON|OFF] | enable/disable | UPC/EAN UPCE1 enabled. | ALL |
| UPC-EAN.UPCE1 | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | UPC/EAN UPCE1 Enabled. | ALL |
| BATTERY.CHARGE | System | PUBLIC | 4.4.0 | GET | int |
[0-100] | Displays, in percentage, current battery level. | MX-1000 and DM8000 series readers. | |
| BATTERY.INFO | System | PUBLIC | 5.5.1 | GET | battery |
[0-1] |
0: internal battery 1: grip battery |
Gets verbose battery status. | MX-1000 |
| DATA.RESULT-ALWAYSSEND | System | PRIVATE | 3.1.0 | SET|GET | state |
[ON|OFF] | enable/disable | Sets gets whether to always send result. | ALL |
| DATA.RESULT-TYPE | System | PRIVATE | 3.1.0 | SET|GET | bit-field |
[0-128] |
0x00 = None 0x01 = Result 0x02 = XML formated result 0x04 = XML formated statistics 0x08 = Image Data 0x10 = Image Graphics 0x20 = Traning Result 0x40 = Code Quality Graphics |
Controls automatic result transmitted from reader. Default is 1. | ALL |
| DATA.RESULT-TYPE | System | PUBLIC | 5.5.0 | SET|GET | bit-field |
[0,1,512] |
0 = None 1 = Result 512 = MS test response |
Controls automatic, result transmitted from reader. Default bits are 1 and 512 (which is 513). | ALL |
| DATA.RESULT-TYPE | System | PRIVATE | 5.0.0_cr10 | SET|GET | bit-field |
[0-511] |
0x00 = None 0x01 = Result 0x100 = Input event message |
Controls automatic result transmitted from reader. Default is 1. | ALL |
| DEBUG.LOG | System | PRIVATE | 5.4.0 | GET | Gets the debug log in development builds, returns nothing for released firmware. | ALL | |||
| DECODER.1D-PICKETFENCE-BARCODE-ONLY | System | PRIVATE | 5.4.0 | GET | |||||
| DEVICE.APPLOADER-VER | System | PRIVATE | 5.4.0 | GET | Returns the Apploader version. | ||||
| DEVICE.BOOT-VER | System | PRIVATE | 3.0.0 | ||||||
| DEVICE.CGNM-DEV-TYPE | System | PRIVATE | 5.5.1 | GET | Returns the CogNamer device type. | ALL | |||
| DEVICE.DESCRIPTION | System | PUBLIC | 5.7.0 | SET|GET | state |
[0-127] | description | Store device description for inventory management. | ALL |
| DEVICE.FAILSAFE-VER | System | PRIVATE | 5.4.0 | GET | Returns the Failsafe version. | ||||
| DEVICE.FEATURE-KEYS | System | PUBLIC | 3.0.0 | GET | Device Feature Keys. | ALL | |||
| DEVICE.FIRMWARE-VER | System | PUBLIC | 3.0.0 | GET | Device Firmware Version. | ALL | |||
| DEVICE.NAME | System | PUBLIC | 3.0.0 | SET|GET | string |
Device Name. MX + the last six digits of DEVICE.SERIAL-NUMBER | ALL | ||
| DEVICE.SAVE | System | PRIVATE | 3.0.0 | ||||||
| DEVICE.SERIAL-NUMBER | System | PUBLIC | 3.0.0 | GET | Device Serial Number. | ALL | |||
| DEVICE.SHIPPEDAS-VER | System | PRIVATE | 3.0.0 | GET | |||||
| DEVICE.START-VER | System | PRIVATE | 3.0.0 | ||||||
| DEVICE.SUBCLASS | System | PRIVATE | 5.4.0 | GET | string |
Activates the relevant device subclasses. | |||
| DEVICE.TYPE | System | PUBLIC | 3.0.0 | GET | Device Type. | ALL | |||
| DMPOP | System | PRIVATE | 3.0.0 | GET | vtree path |
Gets value tree parameter. | |||
| DMPOP.INFO | System | PRIVATE | 3.1.0 | GET | vtree path |
Gets Device Info value tree parameter. | |||
| DMPUSH | System | PRIVATE | 3.0.0 | SET | vtree path |
Sets value tree parameter. | |||
| DMPUSH.INFO | System | PRIVATE | 3.1.0 | SET | vtree path |
Sets Device Info value tree parameter. DMCC Key is required. | |||
| DMSTATS | System | PRIVATE | 3.1.0 | vtree path |
Returns argument range for value tree parameter. e.g. ||>DMSTATS /ROI/Left |
||||
| ERROR-LED.ON-TIME-MS | System | PUBLIC | 5.7.0 | SET|GET | duration |
Sets the duration for the Error LED in ms. Use 0 for unlimited duration. | All devices with an error LED. | ||
| FILE.UNLINK | System | PRIVATE | 3.3.0 | file |
Remove file from file system. | ||||
| FIRMWARE.LOAD | System | PRIVATE | 3.1.0 | file size date from location |
|
|
Loads firmware file to reader. File data follows DMCC footer. Forces a reboot. | ||
| FIRMWARE.LOAD-NOREBOOT | System | PRIVATE | 3.1.0 | file size date from location |
|
|
Loads firmware file to reader. File data follows DMCC footer. | ||
| FKEY.LOAD | System | PRIVATE | 3.1.0 | key size |
Loads encrypted feature key string to reader. Key data follows DMCC footer. Forces a reboot. | ||||
| FKEY.LOAD-NOREBOOT | System | PRIVATE | 3.1.0 | key size |
Loads encrypted feature key string to reader. Key data follows DMCC footer. | ||||
| FKEY.SAVE | System | PRIVATE | 3.1.0 | Saves feature key to flash memory. | |||||
| FLASH.ERASE | System | PRIVATE | 3.1.0 | sec number sec offset size |
|
|
Used to reset feature key data section. Obsolete in 3.3 by FILE.UNLINK. | ||
| FLASH.GET | System | PRIVATE | 3.1.0 | sec number sec offset size |
|
|
Output the specified section of Flash. | ||
| HEAP.STATS | System | PRIVATE | 3.1.0 | Returns heap memory statistics. | |||||
| IDFLASH.READ | System | PRIVATE | 5.4.0 | SET | Read ID/slide in EEPROM content. | All | |||
| IDFLASH.WRITE | System | PRIVATE | 5.4.0 | SET | string |
Write ID/slide in EEPROM content. | All | ||
| LIMIT.CONS-NOREAD | System | PRIVATE | 5.4.0 | SET|GET | string |
empty string: feature disabled "CBRD>n": signal after n consecutive bad reads |
Sets/gets the threshold for consecutive bad read event signaling. | ALL | |
| LL.REGTODISTANCE | System | PRIVATE | 5.4.0 | register |
Get distance in mm for specified register steps at current temperature. | Readers with liquid lens. | |||
| LLFLASH.READ | System | PRIVATE | 5.4.0 | GET | Gets liquid lens flash content. | Readers with liquid lens. | |||
| LLFLASH.WRITE | System | PRIVATE | 5.4.0 | SET | Sets liquid lens flash content. | Readers with liquid lens. | |||
| NET-LOCAL.PCAP | System | PRIVATE | 5.7.0 | SET|GET | interface |
interface | Retrieves packet capturing buffer. | ALL | |
| PHS.ADD-PACKAGE | System | PRIVATE | 5.4.0 | ||||||
| POWER.HIBERNATE-DISABLE | System | PUBLIC | 4.2.1 | SET|GET | state |
[ON|OFF] | enable/disable | Turning the Hibernation feature on or off. ON means that the device never hibernates. OFF means that Hibernation is not disabled (it is enabled), thus the device will go into hibernation mode. | DM8000 wireless readers. |
| POWER.HIBERNATE-TIMEOUT | System | PUBLIC | 4.2.1 | SET|GET | int |
[1-600] | seconds | Hibernation timeout. | DM8000 wireless readers. |
| POWER.POWEROFF-DISABLE | System | PUBLIC | 4.2.1 | SET|GET | state |
[ON|OFF] | enable/disable | Turning the Power Off feature on or off. ON means that the device never turns off. OFF means that Power Off is not disabled (it is enabled), thus the device will turn off. | DM8050, DM8600, MX-1000 and MX-1502. |
| POWER.POWEROFF-TIMEOUT | System | PUBLIC | 4.2.1 | SET|GET | int |
[1-600] | seconds | Power Off timeout. | DM8050, DM8600, MX-1000 and MX-1502. |
| POWER.SLEEP | System | PRIVATE | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Power Save Mode Enable. | DM7500 |
| POWER.SLEEPTIME | System | PRIVATE | 3.0.0 | SET|GET | secs |
[0, 60, 120... 600] | seconds | Time before entering power-save mode. | DM7500 |
| PPP.IP-CLIENT | System | PRIVATE | 5.4.0 | SET|GET | Reader/client device IP address for internal communication between client and base station. | Wireless readers. | |||
| PPP.IP-SERVER | System | PRIVATE | 5.4.0 | SET|GET | Base/server device IP address for internal communication between client and base station. | Wireless readers. | |||
| PPP.NETMASK | System | PRIVATE | 5.4.0 | SET|GET | int |
Netmask for internal communication between reader and base. | Wireless readers. | ||
| PRESENT.NEVER2X | System | PRIVATE | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Never Read the Same Code Twice. OBSOLETED in 4.5. Presentation mode only. |
ALL |
| PRESENT.REREAD | System | PRIVATE | 3.0.0 | SET|GET | ms |
[0-10000] | milliseconds | OBSOLETED in 4.5. Presentation Mode Re-read Delay. | ALL |
| PRESENT.RESCAN | System | PRIVATE | 3.0.0 | SET|GET | ms |
[0-10000] | milliseconds | OBSOLETED in 4.5. Presentation Mode Rescan Delay. | ALL |
| SDK.VERSION | System | PRIVATE | 3.0.0 | SET|GET | Gets or sets the SDK version. Used by early versions of the DataMan SDK. | ||||
| TEMPERATURE.CPU | System | PRIVATE | 6.1.0 | GET | CPU Temperature in °C. | DM370 series, DM470 series readers. | |||
| TEMPERATURE.LL | System | PRIVATE | 6.1.0 | GET | Get Liquid lens Temperature in °C. Only available if a Liquid lens is present. |
DM370 series, DM470 series readers. | |||
| TEMPERATURE.SENSOR | System | PRIVATE | 6.1.0 | GET | Get Imager Temperature in °C. Only available if compatible image sensor is present. Readout can interfere with image acquisition. |
DM370 series, DM470 series readers. | |||
| TRACE.DUMPFILE | System | PRIVATE | 5.4.0 | filename |
Saves a trace log file, which is archived in flash, into a file. | ||||
| TUNE-BUTTON.3SEC-ACTION | System | PUBLIC | 5.0.0 | SET|GET | action state |
[0-6] [ON|OFF] |
action code (see BUTTON.3SEC-ACTION), enabled enable/disable |
Defines actions when the user pushes the tune button for more than 3 seconds. | DM474, DM503 and DM300 readers. |
| TUNE-BUTTON.3SEC-ACTION | System | PUBLIC | 5.4.0 | SET|GET | action state |
[2,7] [ON|OFF] |
2: Set Match String 7: Extended Read Attempts enable/disable |
Defines actions when the user pushes the tune button for more than 3 seconds. | DM8600 readers. |
| TUNE-BUTTON.SAVE-MATCH-STRING | System | PUBLIC | 5.2.0 | SET|GET | state |
[ON|OFF] | enable/disable tune button enabled | Enables the 'save match string' action when the user pushes the tune button for more than 3 seconds. | DM474, DM503, DM8600 and DM300 readers. |
| VIBRATION.GOOD | System | PUBLIC | 3.1.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enables vibration. | Handheld readers, except for DM8050. |
| Name |
Type |
Level |
Version |
Set/Get |
Args |
Range |
Meaning |
Description |
Support |
|---|---|---|---|---|---|---|---|---|---|
| BATTERY.CHARGE | System | PUBLIC | 4.4.0 | GET | int |
[0-100] | Displays, in percentage, current battery level. | MX-1000 and DM8000 series readers. | |
| BATTERY.INFO | System | PUBLIC | 5.5.1 | GET | battery |
[0-1] |
0: internal battery 1: grip battery |
Gets verbose battery status. | MX-1000 |
| DATA.RESULT-ALWAYSSEND | System | PRIVATE | 3.1.0 | SET|GET | state |
[ON|OFF] | enable/disable | Sets gets whether to always send result. | ALL |
| DATA.RESULT-TYPE | System | PRIVATE | 3.1.0 | SET|GET | bit-field |
[0-128] |
0x00 = None 0x01 = Result 0x02 = XML formated result 0x04 = XML formated statistics 0x08 = Image Data 0x10 = Image Graphics 0x20 = Traning Result 0x40 = Code Quality Graphics |
Controls automatic result transmitted from reader. Default is 1. | ALL |
| DATA.RESULT-TYPE | System | PUBLIC | 5.5.0 | SET|GET | bit-field |
[0,1,512] |
0 = None 1 = Result 512 = MS test response |
Controls automatic, result transmitted from reader. Default bits are 1 and 512 (which is 513). | ALL |
| DATA.RESULT-TYPE | System | PRIVATE | 5.0.0_cr10 | SET|GET | bit-field |
[0-511] |
0x00 = None 0x01 = Result 0x100 = Input event message |
Controls automatic result transmitted from reader. Default is 1. | ALL |
| DEBUG.LOG | System | PRIVATE | 5.4.0 | GET | Gets the debug log in development builds, returns nothing for released firmware. | ALL | |||
| DECODER.1D-PICKETFENCE-BARCODE-ONLY | System | PRIVATE | 5.4.0 | GET | |||||
| DEVICE.APPLOADER-VER | System | PRIVATE | 5.4.0 | GET | Returns the Apploader version. | ||||
| DEVICE.BOOT-VER | System | PRIVATE | 3.0.0 | ||||||
| DEVICE.CGNM-DEV-TYPE | System | PRIVATE | 5.5.1 | GET | Returns the CogNamer device type. | ALL | |||
| DEVICE.DESCRIPTION | System | PUBLIC | 5.7.0 | SET|GET | state |
[0-127] | description | Store device description for inventory management. | ALL |
| DEVICE.FAILSAFE-VER | System | PRIVATE | 5.4.0 | GET | Returns the Failsafe version. | ||||
| DEVICE.FEATURE-KEYS | System | PUBLIC | 3.0.0 | GET | Device Feature Keys. | ALL | |||
| DEVICE.FIRMWARE-VER | System | PUBLIC | 3.0.0 | GET | Device Firmware Version. | ALL | |||
| DEVICE.NAME | System | PUBLIC | 3.0.0 | SET|GET | string |
Device Name. MX + the last six digits of DEVICE.SERIAL-NUMBER | ALL | ||
| DEVICE.SAVE | System | PRIVATE | 3.0.0 | ||||||
| DEVICE.SERIAL-NUMBER | System | PUBLIC | 3.0.0 | GET | Device Serial Number. | ALL | |||
| DEVICE.SHIPPEDAS-VER | System | PRIVATE | 3.0.0 | GET | |||||
| DEVICE.START-VER | System | PRIVATE | 3.0.0 | ||||||
| DEVICE.SUBCLASS | System | PRIVATE | 5.4.0 | GET | string |
Activates the relevant device subclasses. | |||
| DEVICE.TYPE | System | PUBLIC | 3.0.0 | GET | Device Type. | ALL | |||
| DMPOP | System | PRIVATE | 3.0.0 | GET | vtree path |
Gets value tree parameter. | |||
| DMPOP.INFO | System | PRIVATE | 3.1.0 | GET | vtree path |
Gets Device Info value tree parameter. | |||
| DMPUSH | System | PRIVATE | 3.0.0 | SET | vtree path |
Sets value tree parameter. | |||
| DMPUSH.INFO | System | PRIVATE | 3.1.0 | SET | vtree path |
Sets Device Info value tree parameter. DMCC Key is required. | |||
| DMSTATS | System | PRIVATE | 3.1.0 | vtree path |
Returns argument range for value tree parameter. e.g. ||>DMSTATS /ROI/Left |
||||
| ERROR-LED.ON-TIME-MS | System | PUBLIC | 5.7.0 | SET|GET | duration |
Sets the duration for the Error LED in ms. Use 0 for unlimited duration. | All devices with an error LED. | ||
| FILE.UNLINK | System | PRIVATE | 3.3.0 | file |
Remove file from file system. | ||||
| FIRMWARE.LOAD | System | PRIVATE | 3.1.0 | file size date from location |
|
|
Loads firmware file to reader. File data follows DMCC footer. Forces a reboot. | ||
| FIRMWARE.LOAD-NOREBOOT | System | PRIVATE | 3.1.0 | file size date from location |
|
|
Loads firmware file to reader. File data follows DMCC footer. | ||
| FKEY.LOAD | System | PRIVATE | 3.1.0 | key size |
Loads encrypted feature key string to reader. Key data follows DMCC footer. Forces a reboot. | ||||
| FKEY.LOAD-NOREBOOT | System | PRIVATE | 3.1.0 | key size |
Loads encrypted feature key string to reader. Key data follows DMCC footer. | ||||
| FKEY.SAVE | System | PRIVATE | 3.1.0 | Saves feature key to flash memory. | |||||
| FLASH.ERASE | System | PRIVATE | 3.1.0 | sec number sec offset size |
|
|
Used to reset feature key data section. Obsolete in 3.3 by FILE.UNLINK. | ||
| FLASH.GET | System | PRIVATE | 3.1.0 | sec number sec offset size |
|
|
Output the specified section of Flash. | ||
| HEAP.STATS | System | PRIVATE | 3.1.0 | Returns heap memory statistics. | |||||
| IDFLASH.READ | System | PRIVATE | 5.4.0 | SET | Read ID/slide in EEPROM content. | All | |||
| IDFLASH.WRITE | System | PRIVATE | 5.4.0 | SET | string |
Write ID/slide in EEPROM content. | All | ||
| LIMIT.CONS-NOREAD | System | PRIVATE | 5.4.0 | SET|GET | string |
empty string: feature disabled "CBRD>n": signal after n consecutive bad reads |
Sets/gets the threshold for consecutive bad read event signaling. | ALL | |
| LL.REGTODISTANCE | System | PRIVATE | 5.4.0 | register |
Get distance in mm for specified register steps at current temperature. | Readers with liquid lens. | |||
| LLFLASH.READ | System | PRIVATE | 5.4.0 | GET | Gets liquid lens flash content. | Readers with liquid lens. | |||
| LLFLASH.WRITE | System | PRIVATE | 5.4.0 | SET | Sets liquid lens flash content. | Readers with liquid lens. | |||
| NET-LOCAL.PCAP | System | PRIVATE | 5.7.0 | SET|GET | interface |
interface | Retrieves packet capturing buffer. | ALL | |
| PHS.ADD-PACKAGE | System | PRIVATE | 5.4.0 | ||||||
| POWER.HIBERNATE-DISABLE | System | PUBLIC | 4.2.1 | SET|GET | state |
[ON|OFF] | enable/disable | Turning the Hibernation feature on or off. ON means that the device never hibernates. OFF means that Hibernation is not disabled (it is enabled), thus the device will go into hibernation mode. | DM8000 wireless readers. |
| POWER.HIBERNATE-TIMEOUT | System | PUBLIC | 4.2.1 | SET|GET | int |
[1-600] | seconds | Hibernation timeout. | DM8000 wireless readers. |
| POWER.POWEROFF-DISABLE | System | PUBLIC | 4.2.1 | SET|GET | state |
[ON|OFF] | enable/disable | Turning the Power Off feature on or off. ON means that the device never turns off. OFF means that Power Off is not disabled (it is enabled), thus the device will turn off. | DM8050, DM8600, MX-1000 and MX-1502. |
| POWER.POWEROFF-TIMEOUT | System | PUBLIC | 4.2.1 | SET|GET | int |
[1-600] | seconds | Power Off timeout. | DM8050, DM8600, MX-1000 and MX-1502. |
| POWER.SLEEP | System | PRIVATE | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Power Save Mode Enable. | DM7500 |
| POWER.SLEEPTIME | System | PRIVATE | 3.0.0 | SET|GET | secs |
[0, 60, 120... 600] | seconds | Time before entering power-save mode. | DM7500 |
| PPP.IP-CLIENT | System | PRIVATE | 5.4.0 | SET|GET | Reader/client device IP address for internal communication between client and base station. | Wireless readers. | |||
| PPP.IP-SERVER | System | PRIVATE | 5.4.0 | SET|GET | Base/server device IP address for internal communication between client and base station. | Wireless readers. | |||
| PPP.NETMASK | System | PRIVATE | 5.4.0 | SET|GET | int |
Netmask for internal communication between reader and base. | Wireless readers. | ||
| PRESENT.NEVER2X | System | PRIVATE | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Never Read the Same Code Twice. OBSOLETED in 4.5. Presentation mode only. |
ALL |
| PRESENT.REREAD | System | PRIVATE | 3.0.0 | SET|GET | ms |
[0-10000] | milliseconds | OBSOLETED in 4.5. Presentation Mode Re-read Delay. | ALL |
| PRESENT.RESCAN | System | PRIVATE | 3.0.0 | SET|GET | ms |
[0-10000] | milliseconds | OBSOLETED in 4.5. Presentation Mode Rescan Delay. | ALL |
| SDK.VERSION | System | PRIVATE | 3.0.0 | SET|GET | Gets or sets the SDK version. Used by early versions of the DataMan SDK. | ||||
| TEMPERATURE.CPU | System | PRIVATE | 6.1.0 | GET | CPU Temperature in °C. | DM370 series, DM470 series readers. | |||
| TEMPERATURE.LL | System | PRIVATE | 6.1.0 | GET | Get Liquid lens Temperature in °C. Only available if a Liquid lens is present. |
DM370 series, DM470 series readers. | |||
| TEMPERATURE.SENSOR | System | PRIVATE | 6.1.0 | GET | Get Imager Temperature in °C. Only available if compatible image sensor is present. Readout can interfere with image acquisition. |
DM370 series, DM470 series readers. | |||
| TRACE.DUMPFILE | System | PRIVATE | 5.4.0 | filename |
Saves a trace log file, which is archived in flash, into a file. | ||||
| TUNE-BUTTON.3SEC-ACTION | System | PUBLIC | 5.0.0 | SET|GET | action state |
[0-6] [ON|OFF] |
action code (see BUTTON.3SEC-ACTION), enabled enable/disable |
Defines actions when the user pushes the tune button for more than 3 seconds. | DM474, DM503 and DM300 readers. |
| TUNE-BUTTON.3SEC-ACTION | System | PUBLIC | 5.4.0 | SET|GET | action state |
[2,7] [ON|OFF] |
2: Set Match String 7: Extended Read Attempts enable/disable |
Defines actions when the user pushes the tune button for more than 3 seconds. | DM8600 readers. |
| TUNE-BUTTON.SAVE-MATCH-STRING | System | PUBLIC | 5.2.0 | SET|GET | state |
[ON|OFF] | enable/disable tune button enabled | Enables the 'save match string' action when the user pushes the tune button for more than 3 seconds. | DM474, DM503, DM8600 and DM300 readers. |
| VIBRATION.GOOD | System | PUBLIC | 3.1.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enables vibration. | Handheld readers, except for DM8050. |
| 2D.ALGORITHM | Symbology | PUBLIC | 3.0.0 | SET|GET | algorithm |
[0-1] |
0: IDMax ©
1: IDQuick |
IDQuick or IDMax© | X, XM, SX and QE fixed-mount readers. All Q models except for DM503Q. |
| C11.CHKCHAR | Symbology | PUBLIC | 5.7.1 | SET|GET | state |
[ON|OFF] |
ON: enable OFF: disable (default) |
Code 11 Check Character | Mobile |
| C11.CHKCHAR-OPTION | Symbology | PUBLIC | 5.7.1 | SET|GET | int |
[0-1] |
0: disable 1: enable (default) |
Mobile | |
| C11.CODESIZE | Symbology | PUBLIC | 5.7.1 | SET|GET | any, min, max |
[ON|OFF] [1-max] [min-80] |
any length code minimum code length maximum code length |
Code 11 Code Size | ALL |
| C128.CODESIZE | Symbology | PUBLIC | 3.0.0 | SET|GET | any min max |
[ON|OFF] [1-max] [min-80] |
any length code minimum code length maximum code length |
Code 128 Allowed Size. | ALL |
| C25.CHKCHAR | Symbology | PUBLIC | 5.5.2 | SET|GET | state |
[ON|OFF] |
ON: enable OFF: disable |
Code 25 Check Character | ALL |
| C25.CODESIZE | Symbology | PUBLIC | 5.5.2 | SET|GET | any, min, max |
[ON|OFF] [1-max] [min-80] |
any length code minimum code length maximum code length |
Code 25 Code Size. For the Manatee Works SDK, all of the Code 25 variants use the same minimum length; thus it will accept either C25.CODESIZE or I205.CODESIZE. | ALL |
| C25.QZ-SIZE | Symbology | PUBLIC | 5.5.2 | SET|GET | size |
[0..100] | any length code | Sets or gets the single side strictness as a percentage. | ALL |
| C25.XMTCHK | Symbology | PUBLIC | 5.5.2 | SET|GET | state |
[ON|OFF] |
ON: enable OFF: disable |
Sets or gets whether to transmit the check digit. | ALL |
| C39.ASCII | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Code 39 Full ASCII. | ALL |
| C39.CHKCHAR | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Code 39 Check Character. | ALL |
| C39.CODESIZE | Symbology | PUBLIC | 3.0.0 | SET|GET | any min max |
[ON|OFF] [1-max] [min-80] |
any length code minimum code length maximum code length |
Code 39 Code Size. | ALL |
| C39.XMTCHK | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Code 39 Transmit Check Character. | ALL |
| C93.CODESIZE | Symbology | PUBLIC | 3.0.0 | SET|GET | any min max |
[ON|OFF] [1-max] [min-80] |
any length code minimum code length maximum code length |
Code 93 Code Size. | ALL |
| CODABAR.CHKCHAR | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Codabar Check Character. | ALL |
| CODABAR.CODESIZE | Symbology | PUBLIC | 3.0.0 | SET|GET | any min max |
[ON|OFF] [1-max] [min-80] |
any length code minimum code length maximum code length |
Codabar Code Size. | ALL |
| CODABAR.QZ-SIZE | Symbology | PRIVATE | 3.0.0 | SET|GET | state |
[0|100] | Quiet zone single strictness size. | ALL | |
| CODABAR.XMTCHK | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Codabar Transmit Check Character. | ALL |
| DATABAR.EXPANDED | Symbology | PUBLIC | 3.4.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable Databar expanded. | ALL |
| DATABAR.GROUP | Symbology | PUBLIC | 3.4.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable Databar group. | ALL |
| DATABAR.LIMITED | Symbology | PUBLIC | 3.4.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable Databar limited. | ALL |
| DATAMATRIX.ALGORITHM-VERSION | Symbology | PUBLIC | 3.5.3 | SET|GET | version |
[0-2] |
0: speed preferred 1: yield preferred 2: extended |
IDQuick Usage Type. | Fixed mount readers except for DM300L, DM503L, and DM503QL. 2 (extended) is supported by DM50, DM60, DM70, DM150, DM260. |
| DATAMATRIX.EXTREME-PRINT-GROWTH | Symbology | PUBLIC | 3.4.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable extreme print growth for DataMatrix symbols. | ALL except for DM50, DM60, DM70, DM300, DM503, DM8050 and DM8600. |
| DATAMATRIX.PRINT-DEFORMATION | Symbology | PUBLIC | 5.2.0 | SET|GET | state |
[0|1] |
0: Minimal 1: Moderate |
Sets the IDMax Properties. | DM300, DM474, DM503. |
| DATAMATRIX.SECURITY-KEY | Symbology | PRIVATE | 3.2.0 | SET | type name |
1 |
1: Custom1 |
Sets the secure Data Matrix key which is 32 byte string. This string needs to be entered in hexadecimal format. | |
| DATAMATRIX.SECURITY-TYPE | Symbology | PRIVATE | 3.2.0 | SET|GET | type state |
[0-1] [ON|OFF] |
0: None 1: Custom1 enable/disable |
Data Matrix security type used. Only valid with a valid security key is set. | ALL |
| DATAMATRIX.SYMBOL-DIFFICULTY | Symbology | PUBLIC | 5.1.0 | SET|GET | int |
[0-2] |
0: Easy 1: Medium 2: Hard |
Level of DataMatrix code symbol difficulty. | DM8600. |
| DATAMATRIX.TRAINED-FLEX-GRID | Symbology | PUBLIC | 5.2.0 | SET|GET | state |
[ON|OFF] | enable/disable | Switches the Trained Code Property "Flexible Grid Size". | DM300, DM474, DM503. |
| DATAMATRIX.TRAINED-IGNORE-POLARITY | Symbology | PUBLIC | 5.2.0 | SET|GET | state |
[ON|OFF] | enable/disable | Switches the Trained Code Property "Ignore Polarity". | DM300, DM474, DM503. |
| DATAMATRIX.USAGE | Symbology | PUBLIC | 3.0.0 | SET|GET | Usage Type |
[0-1] |
0: Default 1: High speed ink jet mode |
IDMax Usage Type. | ALL except for DM50, DM60, DM70, DM300, DM503. |
| DECODER.1D-MINIMUM-DECODES | Symbology | PUBLIC | 5.2.0 | SET|GET | int |
[0-5] | Minimum number of decoded scans to report a confident decoding (to prevent misread). | ALL | |
| EAN-UCC.CC-C | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable or disable Composite Code C. | ALL |
| EAN-UCC.XMTMODE | Symbology | PUBLIC | 3.0.0 | SET|GET | mode |
[0-1] |
0: Standard (linear & 2D) 1: Linear only |
EAN-UCC Transmit mode. | ALL |
| I2O5.CHKCHAR | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | I2of5 Check Character. | ALL |
| I2O5.CODESIZE | Symbology | PUBLIC | 3.0.0 | SET|GET | any min max |
[ON|OFF] [4-max] [min-80] |
any length code minimum code length maximum code length |
I2of5 Code Size. For the Manatee Works SDK, all of the Code 25 variants use the same minimum length; thus it will accept either C25.CODESIZE or I205.CODESIZE. | ALL |
| I2O5.QZ-SIZE | Symbology | PRIVATE | 3.0.0 | SET|GET | state |
[0|100] | Quiet zone single strictness size. | ALL | |
| I2O5.XMTCHK | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | I2of5 Transmit Check Character. | ALL |
| MSI.CHKCHAR | Symbology | PUBLIC | 5.0.0_cr5 | SET|GET | state |
[ON|OFF] | enable/disable | Sets or gets whether check character is used. Default value is OFF. | DM300 series, DM474, DM503, MX-1000, MX-1502, Mobile. |
| MSI.CHKCHAR-OPTION | Symbology | PUBLIC | 5.0.0_cr5 | SET|GET | mode |
[0-5] |
0: Mod10 1: Mod11 2: Mod1010 3: Mod1110 4: 5: |
Sets or gets the method for calculating checksum. | DM474, DM503 and DM300 series, MX-1000, MX-1502, Mobile. |
| MSI.CODESIZE | Symbology | PUBLIC | 5.0.0_cr5 | SET|GET | mode min max |
[ON|OFF] [1-max] [min-80] |
any length code minimum code length maximum code length |
Sets or gets the expected code size. | DM474, DM503, DM300 series readers, MX-1000, MX-1502. |
| MSI.QZ-SIZE | Symbology | PUBLIC | 5.0.0_cr5 | SET|GET | size |
[0-100] | Sets or gets the single side strictness as a percentage | DM474, DM503 and DM300 series readers. | |
| MSI.XMTCHK | Symbology | PUBLIC | 5.0.0_cr5 | SET|GET | state |
[ON|OFF] | enable/disable | Sets or gets whether to transmit the check digit. | DM474, DM503 and DM300 series readers. |
| MULTICODE.HORIZONTAL-REVERSE | Symbology | PUBLIC | 3.4.0 | SET|GET | state |
[ON|OFF] |
ON: sort right to left OFF: sort left to right |
Horizontal positional sorting order priority. | Fixed mount readers. |
| MULTICODE.IDENTICAL-SYMBOLS | Symbology | PUBLIC | 3.4.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enables/disables output of identical symbols when multicode is enabled. | Fixed mount readers. |
| MULTICODE.IMAGE-REVERSE | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] |
ON: sort last image first OFF: sort first image first |
Image sorting order preference. | Fixed mount readers. |
| MULTICODE.MAX-NUM-CODES | Symbology | PUBLIC | 3.2.0 | SET|GET | symbology number |
[1-5] [1-255] |
1: DataMatrix 2: QR Code/MaxiCode/AztecCode 3: Linear/ Postal/ Stacked 4: VeriCode® 5: DotCode |
The expected maximum number of codes to find for each symbology grouping 1 - 4; no expected value for any single symbology can exceed parameter 0, the total number of codes to find. | Fixed mount readers. |
| MULTICODE.NUM-CODES | Symbology | PUBLIC | 3.2.0 | SET|GET | number |
[1-255] | Number of codes readers must find for a successful read result. | Fixed mount readers. | |
| MULTICODE.PARTIAL-RESULTS | Symbology | PUBLIC | 3.2.0 | SET|GET | state |
[ON|OFF] | enable/disable | Controls how the reader interprets the number of codes to find. ON = reader will return a successful read if 1 or more codes are found. OFF = reader will return a successful read only if number of codes found equals MULTICODE.NUM-CODES value. | Fixed mount readers. |
| MULTICODE.SORT-PRIORITY | Symbology | PUBLIC | 3.4.0 | SET|GET | symbology image vertical position horizontal position |
[0-3] [0-3] [0-3] [0-3] |
Range for all four arguments indicates sort priority. Must be different for each criteria. |
Sorting order for multicode results: 0 is highest priority, 3 is lowest priority. | Fixed mount readers. |
| MULTICODE.SYMBOLOGY-REVERSE | Symbology | PUBLIC | 3.4.0 | SET|GET | state |
[ON|OFF] |
ON: DotCode, VeriCode ®, Linear/Postal/Stacked, QR Code/MaxiCode/AztecCode, Data Matrix OFF: Data Matrix, QR Code/MaxiCode/AztecCode, Linear/Postal/Stacked, VeriCode ®, DotCode |
Symbology sorting order preference. | Fixed mount readers. |
| MULTICODE.VERTICAL-REVERSE | Symbology | PUBLIC | 3.4.0 | SET|GET | state |
[ON|OFF] |
ON: sort bottom to top OFF: sort top to bottom |
Vertical position sorting order preference. | Fixed mount readers. |
| PHARMA.CODE-ORIENTATION | Symbology | PUBLIC | 3.4.0 | SET|GET | direction |
[0-2] |
0: Any (default) 1: Horizontal 2: Vertical |
Preferred orientation for decoding Pharmacode symbols. | ALL |
| PHARMA.CODESIZE | Symbology | PUBLIC | 3.4.0 | SET|GET | any min max |
[ON|OFF] [1-6] [1-6] |
any length code minimum code length maximum code length |
Expected Pharmacode size. | ALL |
| PHARMA.HORIZONTAL-DIRECTION | Symbology | PUBLIC | 3.4.0 | SET|GET | direction |
[0-1] |
0: left-to-right (default) 1: right-to-left |
Horizontal direction preference for decoding Pharmacode symbols. | ALL |
| PHARMA.MAX-LENGTH | Symbology | PRIVATE | 4.4.0 | SET|GET | length |
[1-6] | Gets or sets the maximum length for a Pharmacode. Obsoleted in 5.1. |
ALL | |
| PHARMA.MIN-LENGTH | Symbology | PRIVATE | 4.4.0 | SET|GET | length |
[1-6] | Gets or sets the minimum length for a Pharmacode. Obsoleted in 5.1. |
ALL | |
| PHARMA.SUPPLEMENTARY | Symbology | PRIVATE | 3.4.0 | SET|GET | state |
[ON|OFF] | enable/disable | Get or set whether supplementary component is expected. | ALL |
| PHARMA.SUPPLEMENTARY-GAP-THRESH | Symbology | PRIVATE | 3.4.0 | SET|GET | gap |
[100-300] | Get or set the Pharmacode supplementary gap threshold in pixels. | ALL | |
| PHARMA.VERTICAL-DIRECTION | Symbology | PUBLIC | 3.4.0 | SET|GET | direction |
[0-1] |
0: top-to-bottom (default) 1: bottom-to-top |
Vertical direction preference for decoding Pharmacode symbols. | ALL |
| PLANET.XMTCHK | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | PLANET Transmit Check Character. | ALL |
| POSTNET.XMTCHK | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | POSTNET Transmit Check Character. | ALL |
| QR.MAXIMUM-GRID-SIZE | Symbology | PUBLIC | 5.2.0 | SET|GET | size |
[49-177] | Step size: 4. | Maximum grid size which can be read by the QR decoder. | ALL |
| QR.MICRO | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Micro QR Code. | ALL except for DM300L, DM503L, and DM503QL. |
| QR.MODEL1 | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | QR model-1. | ALL except for DM300L, DM503L, and DM503QL. |
| QR.MODEL2 | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | QR model-2. | ALL except for DM300L, DM503L, and DM503QL. |
| QR.SYMBOL-DIFFICULTY | Symbology | PUBLIC | 5.1.0 | SET|GET | int |
[0-2] |
0: Easy 1: Medium 2: Hard |
Level of QR code symbol difficulty. | DM8600. |
| RSS.EXPANDED | Symbology | PUBLIC | 4.4.0 | SET|GET | state |
[ON|OFF] | enable/disable | RSS Expanded. | ALL |
| SYMBOL.4STATE-AUS | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable 4-State Australia Post Symbology. | ALL except for DM150QL, DM260QL, DM300L, DM503L, and DM503QL. |
| SYMBOL.4STATE-IMB | Symbology | PUBLIC | 3.4.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable 4-State Intelligent Mail Barcode. | ALL except for DM150QL, DM260QL, DM300L, DM503L, and DM503QL. |
| SYMBOL.4STATE-JAP | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable 4-State Japan Post Symbology. | ALL except for DM150QL, DM260QL, DM300L, DM503L, and DM503QL. |
| SYMBOL.4STATE-RMC | Symbology | PRIVATE | 5.6.0 | SET|GET | state |
[ON|OFF] | enable/disable Enable/Disable | Enables or disables Royal Mail Code Symbology. | DM50, DM60, DM70, DM150, DM260, DM30x, DM474, DM503, MX-1000, MX-1502. Mobile. |
| SYMBOL.4STATE-UPU | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable 4-State UPU Symbology. | ALL except for DM150QL, DM260QL, DM300L, DM503L, and DM503QL. |
| SYMBOL.AZTECCODE | Symbology | PUBLIC | 5.0.0_cr2 | SET|GET | state |
[ON|OFF] | enable/disable | Enable Aztec code symbology. | DM70, DM150, DM260, DM503, DM300 series readers, DM474, DM8050, DM8600, MX-1000, MX-1502, Mobile. |
| SYMBOL.C11 | Symbology | PUBLIC | 5.7.1 | SET|GET | state |
[ON|OFF] | enable/disable | Enable Code 11 Symbology. | ALL |
| SYMBOL.C128 | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable Code 128 Symbology. | ALL |
| SYMBOL.C25 | Symbology | PUBLIC | 5.5.2 | SET|GET | state |
[ON|OFF] | enable/disable | Enable Code 25 Symbology. Manatee Works supports 7 subcodes: Standard, Interleaved, ITF-14, IATA, Matrix, COOP, and Inverted. | ALL |
| SYMBOL.C39 | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable Code 39 Symbology. | ALL |
| SYMBOL.C39-CONVERT-TO-C32 | Symbology | PUBLIC | 5.5.0 | SET | state |
[ON|OFF] | enable/disable | Enables/disables the conversion of Code39 to Code32. | ALL |
| SYMBOL.C93 | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable Code 93 Symbology. | ALL |
| SYMBOL.CODABAR | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable Codabar Symbology. | ALL |
| SYMBOL.COOP | Symbology | PUBLIC | 5.7.1 | SET|GET | state |
[ON|OFF] | enable/disable | ALL | |
| SYMBOL.DATABAR | Symbology | PUBLIC | 3.4.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable Databar. It will enable EXPANDED and LIMITED in Manatee Works SDK (just like MX). | ALL |
| SYMBOL.DATAMATRIX | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable DataMatrix Symbology. | ALL except for DM150QL, DM260QL, DM300L, DM503L, and DM503QL. |
| SYMBOL.DOTCODE | Symbology | PUBLIC | 5.0.0_cr3 | SET|GET | state |
[ON|OFF] | enable/disable | Enable DotCode symbology. | DM70, DM150, DM260, DM300 series readers, DM474, DM8050X, DM8600, MX-1000, MX-1502, Mobile. |
| SYMBOL.EAN-UCC | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable EAN-UCC Symbology. | ALL |
| SYMBOL.I2O5 | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable Interleaved 2 of 5 Symbology. | ALL |
| SYMBOL.IATA | Symbology | PUBLIC | 5.7.1 | SET|GET | state |
[ON|OFF] | enable/disable | ALL | |
| SYMBOL.INVERTED | Symbology | PUBLIC | 5.7.1 | SET|GET | state |
[ON|OFF] | enable/disable | ALL | |
| SYMBOL.ITF14 | Symbology | PUBLIC | 5.7.1 | SET|GET | state |
[ON|OFF] | enable/disable | ALL | |
| SYMBOL.MATRIX | Symbology | PUBLIC | 4.7.1 | SET|GET | state |
[ON|OFF] | enable/disable | Enable Matrix symbology. | All. |
| SYMBOL.MAXICODE | Symbology | PUBLIC | 4.5.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable MaxiCode symbology. | DM50, DM60, DM70, DM150, DM260, DM300 series readers, DM474, DM503, DM8050, DM8600, MX-1000 and MX-1502, Mobile. |
| SYMBOL.MICROPDF417 | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable Micro-PDF 417 Symbology. | ALL |
| SYMBOL.MSI | Symbology | PUBLIC | 5.0.0_cr5 | SET|GET | state |
[ON|OFF] | enable/disable | Sets or gets whether MSI Code is enabled or disabled | DM70, DM150, DM260, DM503, DM300 series readers, DM474, MX-1000, MX-1502, Mobile. |
| SYMBOL.PDF417 | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable PDF 417 Symbology. | ALL |
| SYMBOL.PHARMACODE | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable Pharmacode symbology. | ALL |
| SYMBOL.PLANET | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable PLANET Symbology. | ALL except for DM150QL, DM260QL, DM300L, DM302L, DM503L, and DM503QL. |
| SYMBOL.POSTNET | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable POSTNET Symbology. | ALL except for DM150QL, DM260QL, DM300L, DM503L, and DM503QL. |
| SYMBOL.QR | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable QR-Code Symbology. Enables QR and Micro QR in Manatee Works SDK. | ALL except for DM150QL, DM260QL, DM300L, DM503L and DM503QL. |
| SYMBOL.RPC | Symbology | PRIVATE | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Reader Programming Code. | DM70, DM150, DM260 |
| SYMBOL.UPC-EAN | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable UPC/EAN Symbology. It will enable UPC-A, UPC-E, EAN-8, and EAN-13 in Manatee Works SDK (just like MX). | ALL |
| SYMBOL.VERICODE | Symbology | PUBLIC | 3.2.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable VeriCode ® symbology. | DM70, DM150 and DM260 readers with VeriCode ® license. |
| TRAIN.AUTO-DISABLE | Symbology | PREVIEW | 3.2.0 | SET|GET | state |
[ON|OFF] | enable/disable | Indicates whether untrained symbology groups will be disabled after the next attempt to train. | Fixed mount readers. |
| TRAIN.AVAILABLE | Symbology | PRIVATE | 3.2.0 | GET | symbology |
Indicates whether incremental training is available for the selected symbology group. | Fixed mount readers. | ||
| TRAIN.INCREMENTAL | Symbology | PUBLIC | 3.2.0 | SET|GET | state |
[ON|OFF] | enable/disable | Indicates whether incremental training is used during the next attempt to train. | Fixed mount readers. |
| TRAINED-CODE.INFO | Symbology | PUBLIC | 4.4.0 | GET | Gets information about the currently trained code type ('Untrained' if no code is trained). | Fixed mount devices. | |||
| UPC-EAN.DELZERO | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | UPC/EAN Delete Leading Zero. | ALL |
| UPC-EAN.EAN13 | Symbology | PUBLIC | 5.7.1 | SET|GET | state |
[ON|OFF] | enable/disable | UPC/EAN Allow EAN13. | ALL |
| UPC-EAN.EAN8 | Symbology | PUBLIC | 5.7.1 | SET|GET | state |
[ON|OFF] | enable/disable | UPC/EAN Allow EAN8. | ALL |
| UPC-EAN.EAN8SUPL | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | UPC/EAN Allow EAN8 Supplementals. | ALL |
| UPC-EAN.EXPANDED | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | UPC/EAN Expanded. | ALL |
| UPC-EAN.SUPPLEMENT | Symbology | PUBLIC | 3.0.0 | SET|GET | option |
[0-4] |
0: Ignore 1: Required 2: Required 2 digit 3: Required 5 digit 4: Not required |
UPC/EAN Supplementals. The Manatee Works SDK only supports turning UPC/EAN supplement code support on/off, while the DMCC command allows them to be off, required, require a 2 digit, require a 5 digit, or optionally permit them. The Manatee Works SDK will treat options 1-4 the same; to simply enable them. | ALL |
| UPC-EAN.UPC-A | Symbology | PUBLIC | 5.7.1 | SET|GET | state |
[ON|OFF] | enable/disable | UPC/EAN UPC-A enabled. | ALL |
| UPC-EAN.UPC-E | Symbology | PUBLIC | 5.7.1 | SET|GET | state |
[ON|OFF] | enable/disable | UPC/EAN UPC-E enabled. | ALL |
| UPC-EAN.UPCE1 | Symbology | PUBLIC | 5.7.1 | SET|GET | state |
[ON|OFF] | enable/disable | UPC/EAN UPCE1 enabled. | ALL |
| UPC-EAN.UPCE1 | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | UPC/EAN UPCE1 Enabled. | ALL |
| IMAGEBUFFER.ALLOW-OVERWRITE | RecordPlayback | PUBLIC | 4.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Allow buffered images that have not been transfered to be overwritten if all available buffers are used and new images arrive. | DM50, DM60, DM70, DM474, DM503, DM300 series readers, DM8050 and DM8600. |
| IMAGEBUFFER.AUTO-PREFER-CENTER | RecordPlayback | PUBLIC | 5.7.3 | SET|GET | Controls whether to use the decoders best symbol or the symbol closer to the ROI center. | DM50, DM60, DM70, DM474, DM503, DM300 series readers, DM8050 and DM8600. | |||
| IMAGEBUFFER.DELETE | RecordPlayback | PUBLIC | 4.0.0 | Release stored images. | DM50, DM60, DM70, DM474, DM503, DM300 series readers, DM8050 and DM8600. | ||||
| IMAGEBUFFER.DELETE-AFTER-TRANSFER | RecordPlayback | PUBLIC | 4.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Release stored images automatically after image has been transfered. | DM50, DM60, DM70, DM474, DM503, DM300 series readers, DM8050 and DM8600. |
| IMAGEBUFFER.FORMAT | RecordPlayback | PUBLIC | 5.6.3 | SET|GET | format |
[0-2] |
0: Bitmap 1: JPEG 2: PNG |
DM50, DM60, DM70, DM474, DM503, MX-1000, DM8000 series and DM300 series readers. | |
| IMAGEBUFFER.GOOD-IMAGE-MODE | RecordPlayback | PUBLIC | 5.2.0 | SET|GET | mode |
[0-1] |
0: Unlimited 1: Rate limited |
Good Read Image stores all buffered good read images unless you set a limit rate. | DM503, DM300 series readers, DM8050 and DM8600. |
| IMAGEBUFFER.GOOD-IMAGE-RATE-BURST | RecordPlayback | PUBLIC | 5.2.0 | SET|GET | interval |
[1-1000] | Burst determines the peak rate of the number of good read images buffered. | DM474, DM503, DM300 series readers, DM8050 and DM8600. | |
| IMAGEBUFFER.GOOD-IMAGE-RATE-COUNT | RecordPlayback | PUBLIC | 5.2.0 | SET|GET | interval |
Number of good read images to be buffered at a time unit (for example, minutes or hours) specified with IMAGEBUFFER.GOOD-IMAGE-RATE-COUNT. | DM474, DM503, DM300 series readers, DM8050 and DM8600. | ||
| IMAGEBUFFER.GOOD-IMAGE-RATE-TIME | RecordPlayback | PUBLIC | 5.2.0 | SET|GET | type |
[0-3] |
0: seconds 1: minutes 2: hours 3: days |
Time unit of good read images to be buffered at a rate number specified with IMAGEBUFFER.GOOD-IMAGE-RATE-TIME. | DM474, DM503, DM300 series readers, DM8050 and DM8600. |
| IMAGEBUFFER.IMAGE-TYPE | RecordPlayback | PUBLIC | 5.5.0 | SET|GET | int |
[0-2] |
0: All 1: Same as result 2: Auto |
Sets "What images to Buffer for a Result". When "Auto" is selected, the reader does intelligent image buffering. Requires the IntImageBuffer feature key to select the "Auto" option. |
DM70, DM150, DM260, DM300 series readers, DM474, DM503. |
| IMAGEBUFFER.MAX-IMAGES-PER-RESULT | RecordPlayback | PUBLIC | 5.0.0 | SET|GET | size |
[0-*] | Sets or gets how many images (n) per result are stored. | DM50, DM60, DM70, DM474, DM503, DM300 series readers, DM8050 and DM8600. | |
| IMAGEBUFFER.MAX-NUM | RecordPlayback | PUBLIC | 4.0.0 | SET|GET | size |
[0-*] | Maximum number of images that can be buffered. * Range varies depending depending on Camera ROI and memory allocated for burst length. |
DM50, DM60, DM70, DM474, DM503, DM300 series readers, DM8050 and DM8600. | |
| IMAGEBUFFER.NO-READ-IMAGE-LAST-NUMBER | RecordPlayback | PRIVATE | 5.5.0 | SET|GET | limit |
[n][Max Int] | In Burst trigger mode, n is the number of images in a burst. In other trigger modes, there is no limit. | Stores images up to the limit. | Fixed-mount readers, only in Single, Burst, Self and Continuous modes. |
| IMAGEBUFFER.NO-READ-IMAGE-MODE | RecordPlayback | PRIVATE | 5.0.0 | SET|GET | size |
[0-3] |
0: No-Read Image Period 1: No-Read Image Number 2: No-Read Image Rate 3: No-Read Image Range |
No-Read Image stores only one image per trigger and you can select which one. No-Read Image Period stores every nth bad read image. This is evaluated across trigger modes. For example, if you have burst trigger selected with a length of 5 and set period to 3, the 1st and 4th image of the first, but the 2nd and 5th of the second burst will be stored. No-Read Image Range stores all bad read images from the no-read image number to the last no-read image number. | Fixed-mount readers, only in Single, Burst, Self and Continuous modes. |
| IMAGEBUFFER.NO-READ-IMAGE-NUMBER | RecordPlayback | PUBLIC | 5.0.0 | SET|GET | limit |
[n] [Max Int] |
In Burst trigger mode, n is the number of images in a burst In other trigger modes, there is no limit |
Store exactly one image. | DM50, DM60, DM70, DM474, DM503, DM300 series readers, only in Single, Burst, Self and Continuous modes. |
| IMAGEBUFFER.NO-READ-IMAGE-PERIOD | RecordPlayback | PUBLIC | 4.0.0 | SET|GET | interval |
[1-200] | Sets or gets the interval to save the image of a bad read. If, for example, you use an interval of 6, the first bad image is saved and the next 5 are not. The default is 1 which saves each bad read image. | DM50, DM60, DM70, DM474, DM503, DM300 series readers, only in Single, Burst, Self and Continuous modes. | |
| IMAGEBUFFER.NO-READ-IMAGE-RATE-BURST | RecordPlayback | PUBLIC | 5.2.0 | SET|GET | interval |
[1-1000] | Burst determines the peak rate of the number of bad read images buffered. | DM474, DM503, DM300 series readers, only in Single, Burst, Self and Continuous modes. | |
| IMAGEBUFFER.NO-READ-IMAGE-RATE-COUNT | RecordPlayback | PUBLIC | 5.2.0 | SET|GET | interval |
Number of bad read images to be buffered at a time unit (for example, minutes or hours) specified with IMAGEBUFFER.NO-READ-IMAGE-RATE-COUNT. | DM503, DM300 series readers, only in Single, Burst, Self and Continuous modes. | ||
| IMAGEBUFFER.NO-READ-IMAGE-RATE-TIME | RecordPlayback | PUBLIC | 5.2.0 | SET|GET | type |
[0-3] |
0: seconds 1: minutes 2: hours 3: days |
Time unit of bad read images to be buffered at a rate number specified with IMAGEBUFFER.NO-READ-IMAGE-RATE-TIME. | DM474, DM503, DM300 series readers, only in Single, Burst, Self and Continuous modes. |
| IMAGEBUFFER.NO-READ-INDEX | RecordPlayback | PRIVATE | 4.4.0_cr2 | SET|GET | index |
0 is the default behavior to send all as selected; 1 – max burst is send only the index selected. | DM474, DM300 series readers, DM8050 and DM8600. | ||
| IMAGEBUFFER.NUM | RecordPlayback | PUBLIC | 4.0.0 | GET | size |
Returns the number of currently buffered images. | DM50, DM60, DM70, DM474, DM503, DM300 series readers, DM8050 and DM8600. | ||
| IMAGEBUFFER.OVERLAY | RecordPlayback | PUBLIC | 5.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enables Overlay Graphics (SVG) for buffered images. | DM50, DM60, DM70, DM474, DM503, DM300 series readers, DM8050 and DM8600. |
| IMAGEBUFFER.QUALITY | RecordPlayback | PUBLIC | 4.0.0 | SET|GET | quality |
[10, 15, 20... 85, 90] | JPEG Quality | DM50, DM60, DM70, DM474, DM503, MX-1000, DM8000 series and DM300 series readers. | |
| IMAGEBUFFER.RECORD | RecordPlayback | 4.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable or disable image buffereing. obsolete in 4.0.0. |
Fixed mount readers, DM8050 and DM8600. | |
| IMAGEBUFFER.RECORD-TYPE | RecordPlayback | PUBLIC | 4.0.0 | SET|GET | type |
[0-5] |
0: None 1: No-Read 2: Read 3: All 4: Validation Failure 5: No-Read + Validation failure |
Sets or gets the type of image to buffer. In case of No-Read, the image is buffered if the reader fails to read. |
DM50, DM60, DM70, DM474, DM503, MX-1000, DM8000 series and DM300 series readers. |
| IMAGEBUFFER.SEND-FTP | RecordPlayback | PUBLIC | 4.0.0 | Transmit buffered images to designated FTP server. | DM60, DM474, DM503, DM8000 series and DM300 series readers. | ||||
| IMAGEBUFFER.SEND-FTP-PARAM | RecordPlayback | PRIVATE | 4.0.0 | Transmit buffered images to designated FTP server. | Fixed mount Ethernet readers, DM8050 and DM8600. | ||||
| IMAGEBUFFER.SIZE | RecordPlayback | PUBLIC | 4.0.0 | SET|GET | size |
[0-3] |
0: Full 1: 1/4 2: 1/16 3: 1/64 |
DM50, DM60, DM70, DM474, DM503, MX-1000, DM8000 series and DM300 series readers. | |
| IMAGEBUFFER.TRANSFER-MODE | RecordPlayback | PUBLIC | 4.0.0 | SET|GET | interval |
[0-1] |
0: On Request 1: FTP - runtime |
Sets or gets whether buffered images should automatically sent FTP or if they should be send only after requested. | DM60, DM70, DM474, DM503, MX-1000, DM8000 series, and DM300 series readers and DM260. |
| BEEP.DATAVALID-FAIL | IO | PUBLIC | 3.0.0 | SET|GET | repetition level |
[0-3] [0-2] |
number of beeps 0: Lo pitch 1: Med pitch 2: Hi pitch |
Data Validation Failure Beep Settings. | ALL except for DM50, DM60 and DM70. |
| BEEP.DATAVALID-FAIL-OL | IO | PUBLIC | 3.0.0 | SET|GET | repetition level |
[0-3] [0-2] |
number of beeps 0: Lo pitch 1: Med pitch 2: Hi pitch |
Data Validation Failure Beep Settings when offline. | Wireless readers. |
| BEEP.GOOD | IO | PUBLIC | 3.0.0 | SET|GET | repetition level |
[0-3] [0-2] |
number of beeps 0: Lo pitch 1: Med pitch 2: Hi pitch |
Good Read Beep Settings. | ALL except for DM50, DM60 and DM70. |
| BEEP.GOOD-OL | IO | PUBLIC | 3.0.0 | SET|GET | repetition level |
[0-3] [0-2] |
number of beeps 0: Lo pitch 1: Med pitch 2: Hi pitch |
Good Read Beep Settings when offline. | Wireless readers. |
| BEEP.NO-READ | IO | PUBLIC | 3.0.0 | SET|GET | repetition level |
[0-3] [0-2] |
number of beeps 0: Lo pitch 1: Med pitch 2: Hi pitch |
No-Read Beep Settings. | ALL except for DM50, DM60 and DM70. |
| BEEP.NO-READ-OL | IO | PUBLIC | 3.0.0 | SET|GET | repetition level |
[0-3] [0-2] |
number of beeps 0: Lo pitch 1: Med pitch 2: Hi pitch |
No-Read Beep Settings when offline. | Wireless readers. |
| BEEPER.ENABLED | IO | PUBLIC | 5.7.1 | SET|GET | state |
[ON|OFF] | Enable/disable beeper in general. | All | |
| BUTTON.3SEC-ACTION | IO | PUBLIC | 3.0.0 | SET|GET | mode state |
[0-6] [ON|OFF] |
0: Train 1: Optimize Brighness 2: Set Match String 3: Optimize Focus 4: Read Configuration Code 5: Tune 6: Toggle Test Mode enable/disable |
Three Second Button Action. | Fixed mount readers. Test Mode is only supported on the DM503, DM300 series readers and DM474. |
| BUTTON.ACTION | IO | PUBLIC | 5.5.1 | SET|GET | button action |
[0-2] [0-1] |
Index of button (0:Left;1:Right;2:Grip) 0: disabled 1: trigger |
Sets and gets the assigned feature for hardware buttons. | MX-1000 |
| BUTTON.ENABLE | IO | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enables or disables the trigger button. | Fixed mount readers. |
| COM.BUFFER-DATA | IO | PRIVATE | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | ||
| COM.DATA-BITS | IO | PRIVATE | 3.0.0 | SET|GET | bits |
[7|8] | RS232 data bits | ||
| ENCODER.COUNT | IO | PUBLIC | 4.1.0 | SET|GET | value |
[0-2 billion] | value to set | Gets the encoder count or sets it to the specified value. | Fixed-mount readers |
| ENCODER.DISTANCE-TO-OUTPUT | IO | PUBLIC | 4.1.0 | SET|GET | int |
0-1000000 mm |
Default: 0 Min: 0 Max: 1000000 Step: 1 |
Sets the output distance from the trigger on the sensor. | DM300 series readers, DM474. |
| ENCODER.DOUBLE-RATE | IO | PUBLIC | 5.7.0 | SET|GET | boolean |
[ON|OFF] | Edge detection | If set to ON, Encoder will count both edges on the Encoder Input line. If set to OFF, Encoder will count only the selected edge. | DM503 |
| ENCODER.DOUBLE-RATE | IO | PUBLIC | 6.1.6 | SET|GET | boolean |
[ON|OFF] | Edge detection | If set to ON, Encoder will count both edges on the Encoder Input line. If set to OFF, Encoder will count only the selected edge. | DM360, DM370, and DM470 series readers. |
| ENCODER.FLUSH | IO | PUBLIC | 4.1.0 | Flushes all encoder actions. | DM474, DM503 and DM300 series readers. | ||||
| ENCODER.MODE | IO | PUBLIC | 5.5.0 | SET|GET | value |
[0-4] |
0: Encoder A signal counts up, Encoder B signal counts down. 1: Encoder A signal counts up, Encoder B signal counts down. 2: Encoder A and Encoder B form quadrature (SIN/COS) signal, 1 count per cycle. 3: Encoder A and Encoder B form quadrature (SIN/COS) signal, 2 counts per cycle. 4: Encoder A and Encoder B form quadrature (SIN/COS) signal, 4 counts per cycle. |
Encoder mode. Sets the mode the encoder signals are interpreted if the Encoder Direction pin is defined. | Fixed-mount readers |
| ENCODER.RESET | IO | PUBLIC | 5.5.0 | Resets the encoder count to 0 and clears all encoder related events. | Fixed-mount readers | ||||
| ENCODER.RESOLUTION | IO | PUBLIC | 4.1.0 | SET|GET | int |
0-1000000 um |
Default: 5000 Min: 0 Max: 1000000 Step: 1 |
Sets the distance per pulse of the encoder. | DM474, DM503, and DM300 series readers. |
| EVENT.RULES | IO | PRIVATE | 3.4.0 | SET|GET | rules |
||||
| IMAGE.LOAD-FTP-MULT-PARAM | IO | PRIVATE | 5.5.0 | SET | server_ip picture last_image more burst_count buffer-overflow seq_nbr ” ” ”user” ”passwd” port |
[ON|OFF] [3] [0-1] |
Server IP Picture name enable/disable Number of images to take 0: Off 1: On Sequence number in the burst User name Password Port used |
Allows uploading of multiple pictures as a burst. | ALL |
| INPUT.ACTION | IO | PUBLIC | 4.0.0 | SET|GET | line action state |
[0-3] [0-11] [ON|OFF] |
Input line number 0: Train Code 1: Optimize Brightness 2: Set Match String 3: Optimize Focus 4: Read Configuration Code 5: Trigger Off 6: Encoder 7: Allow Buffered No-Read Images 8: Clear Outputs 9: Tune (DM300 only) 10: Encoder direction 11: Trigger on ON: execute action when line is triggered OFF: no action |
Sets or gets the state for the specified line action. The input actions "Train Code," "Optimize Brightness," "Set Match String," and "Read Configuration Code" are carried out only after the next trigger. |
Fixed-mount readers. |
| INPUT.ACTION1 | IO | PUBLIC | 3.0.0 | SET|GET | mode state |
[0-3] [ON|OFF] |
0: Train Code 1: Optimize Brighness 2: Set Match String 3: Optimize focus (Only for readers with a liquid lens.) enable/disable |
Input Line 1 Action. | Fixed mount readers. |
| INPUT.EVENT-MESSAGE | IO | PRIVATE | 5.0.0_cr10 | SET|GET | state |
[ON|OFF] | enable/disable | Instructs the system to generate a message for every input line state change. | DM300 series readers, DM474. |
| INTELLIGRATED.HEARTBEAT | IO | PRIVATE | 5.0.0_cr14 | SET|GET | sec |
[0-50] | seconds | Sets or gets the time between heartbeat transmissions. A value of 0 disables the heartbeat. | DM503 series readers. |
| IO-LINE.DIRECTION | IO | PUBLIC | 5.5.0 | SET|GET | line direction |
[2,3] [0,1] |
line=2: sets direction of I/O Line 2 line=3: sets direction of I/O Line 3 direction=0: defines line as output direction=1: defines line as input |
Sets the direction of the programmable I/O lines of DM360 and DM474 series readers. | DM360 series, DM474 readers |
| KEY.EMULATE-PS2 | IO | PRIVATE | 5.4.0 | SET|GET | state |
[ON|OFF]
[OFF, Wedge, EmulationG |
enable/disable
OFF: no emulation Wedge: reader and PS/2 keyboard are connected using a wedge cable Emulation: reader is connected to wedge and no PS/2 keyboard is present |
Wireless readers. | |
| KEY.LANGUAGE | IO | PUBLIC | 3.0.0 | SET|GET | language |
[0-7] |
0: Alt Key Combo 1: DE 2: US 3: JP 4: FR 5: ES 6: NO 7: FI |
ALL except for DM60, DM474, DM503, and DM300 series readers. | |
| KEY.ZERO-PAD | IO | PUBLIC | 3.0.0 | SET|GET | language |
[ON|OFF] | enable/disable | ALL except for DM60, DM474, DM503, and DM300 series readers. | |
| LIGHTCURTAIN.BEAM-SPACING | IO | PUBLIC | 4.1.0 | SET|GET | spacing |
[1-300000] | micrometers | Distance (in um) between beams of the Light Curtain. This determines the resolution of the light curtain. | DM503 |
| LIGHTRING.DURATION | IO | PUBLIC | 5.7.0 | SET|GET | duration |
[0..10000] |
0: Default behavior 10..10000: duration of lightring event in ms, step 10 ms |
Controls the duration of the lightring illumination event. | DM36x, DM474 and DM503 |
| OUTPUT-QUEUE.FLUSH | IO | PUBLIC | 4.1.0 | int |
[0-1] |
0: throw output away 1: send all output now |
To flush or send all output. | DM474, DM503, and DM300 series readers. | |
| OUTPUT.ACTION | IO | PREVIEW | 3.0.0 | SET|GET | line action |
[0-7] [0-1] |
line number 0: Open 1: Close |
Output Action. Open or Close output line on event. Only supported on line 1. |
Fixed mount readers. |
| OUTPUT.CQ-FAIL | IO | PRIVATE | 3.0.0 | Output Code Quality failed actions. Verifiers only. |
|||||
| OUTPUT.DATAVALID-FAIL | IO | PRIVATE | 3.0.0 | Output Data Validation failed actions. | |||||
| OUTPUT.EVENTS | IO | PREVIEW | 3.0.0 | SET|GET | line read no-read validation-failure trigger-overrun buffer-overflow user event 1 user event 2 |
[0-7] [0-1] [0-1] [0-1] [0-1] [0-1] [0-1] [0-1] |
i/o line number 0: Off 1: On 0: Off 1: On 0: Off 1: On 0: Off 1: On 0: Off 1: On 0: Off 1: On 0: Off 1: On |
Output Events. Configure output line to signal based on event. |
Fixed mount readers. |
| OUTPUT.GOOD | IO | PRIVATE | 3.0.0 | Output good read actions. | |||||
| OUTPUT.NOREAD | IO | PRIVATE | 3.0.0 | Output no read actions. | |||||
| OUTPUT.PULSE-WIDTH | IO | PUBLIC | 3.0.0 | SET|GET | line ms |
[0-7] [0-30000] |
i/o line number milliseconds |
Output Pulse-width. | Fixed mount readers. |
| OUTPUT.RESERVED | IO | PUBLIC | 3.0.0 | SET|GET | line reserved |
[0-7] [ON|OFF] |
i/o line number enable/disable |
Output Reserved for External Illumination. Line will be controlled by acquisition system when enabled. | Fixed mount readers, except DM50, DM60 and DM70. |
| OUTPUT.TRIG-OVERRUN | IO | PRIVATE | 3.0.0 | Output trigger overrun actions. | |||||
| RESULT.NO-READ-STRING | IO | PUBLIC | 3.0.0 | SET|GET | string |
no-read-string | No-Read Output String. | ALL | |
| TRIGGER.DEBOUNCE-DELAY | IO | PUBLIC | 4.0.0 | SET|GET | delay |
[0-6] |
0: short 1: 2: default 3: 4: 5: 6: long |
Sets or gets how long the trigger signal must be detected in order to be recognized as valid. | Fixed-mount readers. |
| TRIGGER.END-HOLDOFF-DISTANCE | IO | PUBLIC | 5.5.0 | SET|GET | distance |
[0-10000 mm] | distance for hold-off at trigger end | When greater than 0, the distance with which to cancel a pending trigger off and allow the trigger to continue. | DM474, DM503 and DM300 series readers. |
| TRIGGER.END-HOLDOFF-TIME | IO | PUBLIC | 5.5.0 | SET|GET | rime |
[0-10000 ms] | time for hold-off at trigger end | When greater than 0, the time with which to cancel a pending trigger off and allow the trigger to continue. | Fixed-mount readers |
| TRIGGER.HOLDOFF-DISTANCE | IO | PUBLIC | 5.5.0 | SET|GET | distance |
[0-10000 mm] | distance for hold-off at trigger start | When greater than 0, the distance with which to cancel a pending trigger on and act like there was no trigger at all. | DM474, DM503 and DM300 series readers. |
| TRIGGER.HOLDOFF-TIME | IO | PUBLIC | 5.5.0 | SET|GET | time |
[0-10000 ms] | time for hold-off at trigger start | When greater than 0, the time with which to cancel a pending trigger on and act like there was no trigger at all. | Fixed-mount readers |
| TRIGGER.HOLDOFF-TYPE | IO | PUBLIC | 5.5.0 | SET|GET | type |
[0-2] |
0 = None 1 = Time 2 = Distance |
Which type of trigger hold-off to use, none, time or distance. | Fixed-mount readers |
| TRIGGER.IGNORE-DISTANCE | IO | PRIVATE | 5.5.0 | SET|GET | milliseconds |
[0-2147483646] | Sets or gets the minimum trigger distance for a trigger to be considered good. All trigger durations less than the specified duration will be aborted. | Fixed-mount readers | |
| TRIGGER.IGNORE-TIME | IO | PRIVATE | 5.5.0 | SET|GET | milliseconds |
[0-10000] | Sets or gets the minimum trigger duration for a trigger to be considered good. All trigger durations less than the specified duration will be aborted. | Fixed-mount readers | |
| TRIGGER.IGNORE-TYPE | IO | PRIVATE | 5.5.0 | SET|GET | mode |
[0-2] |
0: none 1: time 2: distance |
Sets or gets what type of triggers to ignore. | Fixed-mount readers |
| TRIGGER.POLARITY | IO | PUBLIC | 4.0.0 | SET|GET | line polarity |
[0-3] [ON|OFF] |
Input line ON: Rising edge OFF: Falling edge |
Sets or gets the polarity at which an input will be triggered. | Fixed mount readers. |
| TUNE-BUTTON.ENABLE | IO | PUBLIC | 5.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enables or disables the tune button. | DM474, DM503, and DM300 series readers. |
| AZTEC.TRAINED-MODEL | Decoder | PUBLIC | 5.7.0 | SET|GET | grid size module size polarity |
[15-151] [1-1000] [0-2] |
Grid size Module size * 10 0: dark-on-light 1: light-on-dark 2: either |
Set training parameters for Aztec symbology. | Fixed-mount readers |
| CODABAR.XMT-START-STOP-CHAR | Decoder | PRIVATE | 6.0.0 | SET|GET | state |
[ON|OFF] |
ON: Enable OFF: Disable |
Enable or disable transmitting start and stop character as part of the decoded string. | Ethernet readers |
| COM.ALTERNATE-MODE-DISABLE | Decoder | PRIVATE | 5.7.0 | SET|GET | enable |
[ON|OFF] |
ON: alternate mode cable detection enabled OFF: alternate mode cable detection disabled |
Disables alternate mode cable detection. | DM70 |
| DATAMATRIX.DAMAGE | Decoder | PUBLIC | 5.5.0 | SET|GET | damage level |
[2,4] |
2: moderate 4: extreme |
Set Extreme to enable PowerGrid. | DM300 series readers, DM360, DM474 readers |
| DATAMATRIX.IDMAX-SCALE-UNCERTAINTY-PERCENTAGE | Decoder | PRIVATE | 6.0.1 | SET | percentage |
Specifies Scale Uncertainty Percentage. It is a parameter that allows or limits the tuned DataMatrix decoder to examine code that has different PPM than the originally tuned code. The percentage should be PPM1-PPM2)/PPM1 * 100. Active when IDMax is enabled. | ALL | ||
| DATAMATRIX.QUALITY-METRICS | Decoder | PUBLIC | 4.5.0 | SET|GET | type |
[0-3] |
0: none 1: AIM DPM 2: ISO 15415 3: SEMI T10 |
Code quality metrics for DataMatrix. | ALL |
| DATAMATRIX.SCALE-UNCERTAINTY-PERCENTAGE | Decoder | PRIVATE | 6.0.1 | SET | percentage |
Specifies Scale Uncertainty Percentage. It is a parameter that allows or limits the tuned DataMatrix decoder to examine code that has a PPM different than the originally tuned code. The percentage should be (PPM1-PPM2)/PPM1 * 100. Used when IDQuick decoder is enabled. | ALL | ||
| DATAMATRIX.TRAINED-MODEL | Decoder | PUBLIC | 5.5.0 | SET|GET | rows columns module-size polarity mirrored |
[8-144] [8-144] [1-1000] [0-2] [ON|OFF] |
Number of rows Number of columns Module size * 10 0: dark-on-light 1: light-on-dark 2: either ON: mirrored OFF: not mirrored |
Train Data Matrix from the given parameters without needing to capture an image. | Fixed-mount readers |
| DATAMATRIX.TYPE | Decoder | PRIVATE | 6.1.6 | SET|GET |
|
[1-3] |
1 = DataMatrix only 2 = DMRE 3 = Both |
Set support level for DataMatrix and/or DataMatrix Rectangular Extensions. | ALL |
| DECODER.1D-DATA-STITCH | Decoder | PUBLIC | 5.5.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enables/disables 1D data-stitching. Requires the 1DDataStitching feature key. |
DM70, DM150, DM260, DM300 series readers, DM474, DM503. |
| DECODER.1D-DECODE-STRICTNESS | Decoder | PRIVATE | 6.1.6 | SET|GET |
|
[0-2] |
0 = Conservative 1 = Moderate 2 = Tolerant |
Selects which 1D decoding strictness mode to use. The default is 1 ("Moderate"). With setting 0 ("Conservative"), misreads are reduced, with 2 ("Tolerant"), no-reads are reduced. With setting 1 ("Moderate") this is balanced. | ALL |
| DECODER.1D-EXTENDED-RESOLUTION | Decoder | PUBLIC | 5.5.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enables/disables the 1D extended resolution decoding method. Requires the 1DExtendedRes feature key. |
DM70, DM150, DM260, DM300 series readers, DM474, DM503. |
| DECODER.1D-LEARN-CODESIZE | Decoder | PRIVATE | 3.2.0_cr5 | SET|GET | state |
[ON|OFF] | enable/disable | Learn the code size of 1D Symbols. | ALL |
| DECODER.1D-LEARN-ORIENT | Decoder | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Learn Orientation of 1D Symbols. | Fixed mount readers. |
| DECODER.1D-QUALITY-METRICS | Decoder | PUBLIC | 5.2.0 | SET|GET | mode |
[0-1] |
0: none 1: 1D readability |
Enables/disables 1D Process Control Metrics. | ALL |
| DECODER.1D-SHORT-HEIGHT-CODES | Decoder | PRIVATE | 6.0.0 | SET|GET | state |
[ON|OFF] |
ON: Enable OFF: Disable |
Enable or disable Short Height Codes. | Ethernet readers |
| DECODER.1D-SHORT-QUIET-ZONE | Decoder | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | When ON, the reader is tolerant with non-standard (i.e. short) quiet zones. | ALL |
| DECODER.1D-SYMBOL-ORIENTATION | Decoder | PUBLIC | 4.1 | SET|GET | orientation |
[0-3] |
0: Omnidirectional 1: Ladder and Picket Fence (default) 2: Ladder 3: Picket Fence |
Sets or gets the orientation at which codes can be found. Omnidirectional requires the Omnidirectional feature key. | DM50, DM60, DM70, DM474, DM503, MX-1000, MX-1502 and DM300 series readers. DM503L readers support only 2: Ladder and 3: Picket Fence. |
| DECODER.1D-TARGET | Decoder | PRIVATE | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Target Decoding. | MX-1000 and DM8000 series readers. |
| DECODER.1D-USAGE | Decoder | PRIVATE | 3.0.0 | SET|GET | usage-type |
[0-1] |
0: Standard 0: Extended |
1D Symbology Usage Type. | |
| DECODER.1D-USAGE | Decoder | PUBLIC | 3.0.0 | SET|GET | usage |
[0-1] |
0: Standard 1: Extended |
1D Symbology Usage Type. | Fixed mount readers. |
| DECODER.ALLOW-ALL-MST-RESULTS | Decoder | PUBLIC | 5.7.3 | SET|GET | state |
[ON|OFF] |
ON: enable OFF: disable |
Enables or disables re-read delay processing for slave results. | DM300 series readers, DM474, DM503, DM70, DM150, DM260 |
| DECODER.CENTERING-WINDOW | Decoder | PUBLIC | 6.0.0 | SET|GET | center x perc, center y perc, size x perc, size y perc |
[0-100] | Percentage | Location and size of centering window as a percentage of the sensor size. | DM50, DM60, DM70, DM150 DM260, DM300, DM360, DM474, MX-1000 series |
| DECODER.DISPLAY-TARGET | Decoder | PUBLIC | 6.0.0 | SET|GET | state |
[ON|OFF] | Enable/Disable | Displays centering window graphics. | DM50, DM60, DM70, DM150 DM260, DM300, DM360, DM474, MX-1000 series |
| DECODER.EFFORT | Decoder | PUBLIC | 5.7.1 | SET|GET | int |
[0-5] | Sets the effort level used by the decoding algorithms. Default is 2. | All | |
| DECODER.MAC-SCAN-TIMEOUT | Decoder | PUBLIC | 5.7.1 | SET|GET | int |
[0-60] | DM50, DM60, DM70, DM150 DM260, DM300, DM360, DM474, MX-1000, MX1502 | ||
| DECODER.NO-READ-FEEDBACK | Decoder | PRIVATE | 5.5.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enables/disables found but not decoded symbol info. | ALL |
| DECODER.PREPROCESS | Decoder | PRIVATE | 3.4.0 | SET|GET | slot filter param1 param2 param3 |
[0] [0-2] [0-255] [0-255] [0-255] |
slot to configure 0: none 1: Equalize 2: Stretch Filter parameter 1. Filter parameter 2. Filter parameter 2. |
Sets or gets the filter to apply to an image before decoding. | |
| DECODER.REREAD-MODE | Decoder | PUBLIC | 4.4.0 | SET|GET | mode |
[0-1] |
0: last read 1: first read |
Code re-reading delay relative to either the first read or the last. | DM50, DM60, DM70, DM474, DM503, DM300 series readers, DM8050 and DM8600. |
| DECODER.REREAD-NEVER2X | Decoder | PUBLIC | 5.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Never read the same code twice. All trigger modes, e.g. Multicode Reading. |
ALL |
| DECODER.REREAD-NOT-LAST-N | Decoder | PUBLIC | 5.5 SR3 | SET|GET | int |
[0-100] |
0: no restriction 1-100 Define N |
Do not read code if this code was read within the last N reads. | All |
| DECODER.REREAD-TIME | Decoder | PUBLIC | 4.4.0 | SET|GET | ms |
[0-10000] | Milliseconds | Code re-reading delay in milliseconds. | ALL |
| DECODER.ROI | Decoder | PUBLIC | 3.0.0 | SET|GET | left (multiple of 8) right (multiple of 8) top (multiple of 4) bottom (multiple of 4) |
[0...] [left+64...] [0...] [top+64...] |
left of the ROI rectangle right of the ROI rectangle top of the ROI rectangle bottom of the ROI rectangle |
Decoder Region of Interest. Image Region examined by decoder for enabled symbols. Pixel coordinates are relative to the upper left corner of the displayed image. Left < Right and Top < Bottom. Values must not be outside the specified CAMERA.FOV settings. |
ALL |
| DECODER.TARGET-DECODING | Decoder | PUBLIC | 5.7.1 | SET|GET | state |
[ON|OFF] | enable/disable | Enable target decoding, where the reader attempts to symbols that lie only under the aiming dots. | MX-1000, MX-1502 series readers. |
| DECODER.TIMEOUT | Decoder | PUBLIC | 3.0.0 | SET|GET | ms |
[0-10000] | milliseconds | Decoder Timeout. Maximum allowed decode time. |
Fixed mount readers. |
| DECODER.USE-CENTERING | Decoder | PUBLIC | 6.0.0 | SET|GET | state |
[ON|OFF] | Enable/Disable | Only reads codes within the centering window. | DM50, DM60, DM70, DM150, DM260, DM300, DM360, DM474, MX-1000 series |
| DOTCODE.MAXIMUM-COLUMNS | Decoder | PUBLIC | 5.4.0 | SET|GET | int |
[11-128] | The default is 128. | DM300 series readers, DM474, DM8050X and DM8600. | |
| DOTCODE.MAXIMUM-ROWS | Decoder | PUBLIC | 5.4.0 | SET|GET | int |
[5-128] | The default is 32. | DM300 series readers, DM474, DM8050X and DM8600. | |
| DOTCODE.MINIMUM-COLUMNS | Decoder | PUBLIC | 5.4.0 | SET|GET | int |
[11-128] | The default is 16. | DM300 series readers, DM474, DM8050X and DM8600. | |
| DOTCODE.MINIMUM-ROWS | Decoder | PUBLIC | 5.4.0 | SET|GET | int |
[5-128] |
The default is 6. |
DM300 series readers, DM474, DM8050X and DM8600. | |
| DOTCODE.POLARITY | Decoder | PUBLIC | 5.4.0 | SET|GET | int |
[0-2] |
0: Dark on Light 1: Light on Dark 2: Either |
DM300 series readers, DM474, DM8050X and DM8600. | |
| DOTCODE.QUALITY-METRICS | Decoder | PRIVATE | 5.5.0 | SET|GET | mode |
[0-1] |
0: none 1: enable AIM metrics |
Enable Subset of Quality Metrics from DotCode AIM Specification. | DM474, DM503, DM300 series readers, DM8050X and DM8600. |
| FILTER.IMAGE-TO-USE-SYMBOL | Decoder | PUBLIC | 4.3.0 | SET|GET | symbology input |
[1-5] [0-1] |
1: DataMatrix 2: QR Code/MaxiCode/AztecCode 3: Linear/ Postal/ Stacked 4: VeriCode® 5: DotCode 0: original image 1: filtered image |
Sets or gets which type of symbology should be filtered or not. AztecCode is only supported on the DM503 and DM300 series readers. |
DM50, DM60, DM70, DM150, DM260, DM300 series readers, DM474. |
| FILTER.NOREAD-IMAGE | Decoder | PUBLIC | 4.3.0 | SET|GET | symbology |
[0-5] |
0: Any 1: DataMatrix 2: QR Code/MaxiCode/AztecCode 3: Linear/ Postal/ Stacked 4: VeriCode® 5: DotCode |
Sets or gets if the symbology selected should be filtered if the image is no-read. AztecCode is only supported on the DM503 and DM300 series readers. |
DM50, DM60, DM70, DM150, DM260, DM300 series readers, DM474. |
| FILTER.STACK | Decoder | PUBLIC | 4.3.0 | SET|GET | step method value1 value2 value3 |
[1-4] [0-11] [0-255] |
Filter step 0: no filtering 1: equalize 2: stretch 3: low pass 4: dilate 5: erode 6: open 7: close 8: auto stretch 9: optical density 10: invert 11: median method parameter |
The first value sets the order of the filter steps. Filter step 1 is the first step, filter step 2 is the second, and so on. The second value sets the filter to be used. The third value means the additional properties that you can set for the given filter. You cannot configure the whole stack with one statement, but each on its own.The following example: SET FILTER.STACK 2 2 0 100 0 sets the second step in the filter, for stretch from 0 to 100, leaving the third value unused (0).The following example: GET FILTER.STACK 3 (for the third filter) returns 5 4 3 meaning that filter number 5, that is, erode is on, with parameters 4, 3. | DM50, DM60, DM70, DM150, DM260, DM300 series readers, DM474. |
| MAXICODE.TRAINED-MODEL | Decoder | PUBLIC | 5.7.0 | SET|GET | module size |
[1-1000] | Module size * 10 | Set training parameters for MaxiCode symbology. | Fixed-mount readers |
| OUTPUT.DELAY-DISTANCE | Decoder | PUBLIC | 4.4.0 | SET|GET | millimeters |
[0-100000] | Distance to output when using the Encoder. | DM474, DM503, and DM300 series readers. | |
| OUTPUT.DELAY-REFERENCE | Decoder | PUBLIC | 4.4.0 | SET|GET | mode |
[0-1] |
0: Trigger Start 1: Trigger End |
Sets or gets whether output is delayed relative to trigger start or trigger end. | DM50, DM60, DM70, DM474, DM503, and DM300 series readers. |
| OUTPUT.DELAY-TIME | Decoder | PUBLIC | 4.4.0 | SET|GET | milliseconds |
[0-10000] | Output delay in milliseconds. | DM50, DM60, DM70, DM503, DM300 series readers, DM474. | |
| OUTPUT.DELAY-TYPE | Decoder | PUBLIC | 4.4.0 | SET|GET | mode |
[0-1] |
0: None 1: Time |
Sets or gets whether output is delayed, and if so, whether according to time. | DM50, DM60, DM70, DM300 series readers, DM474. |
| OUTPUT.DELAY-TYPE | Decoder | PUBLIC | 4.4.0 | SET|GET | mode |
[0-2] |
0: None 1: Time 2: Distance |
Sets or gets whether output is delayed, and if so, whether according to time or distance. | DM503 |
| PCM-RESULT-STRING.EXTEND | Decoder | PUBLIC | 5.7.0 | SET|GET | enable |
[ON|OFF] | Enable or disable extending the result string with metric information. | Ethernet readers. | |
| PCM-RESULT-STRING.METRIC-FORMAT | Decoder | PUBLIC | 5.7.0 | SET|GET | type |
[0-2] |
0: Grade 1: Value 2: Grade + Value |
Set the format of a single metric entry. | Ethernet readers. |
| PCM-RESULT-STRING.METRIC-PREFIX | Decoder | PUBLIC | 5.7.0 | SET|GET | type |
[0-2] |
0: None 1: Acronym 2: Name |
Defines the prefix for a single metric entry. | Ethernet readers. |
| PCM-RESULT-STRING.METRIC-SEPARATOR | Decoder | PUBLIC | 5.7.0 | SET|GET | string |
Defines the metric separator. | Ethernet readers. | ||
| PCM-RESULT-STRING.OVERALL-GRADE | Decoder | PUBLIC | 5.7.0 | SET|GET | type |
[ON|OFF] | enable | Enables or disables showing the overall grade in at the beginning of the result string. | Ethernet readers. |
| PCM-RESULT-STRING.SEPARATOR | Decoder | PUBLIC | 5.7.0 | SET|GET | string |
Defines the main separator between result data and metric section. | Ethernet readers. | ||
| PCM.CUSTOM-DESCRIPTION | Decoder | PUBLIC | 5.7.0 | SET|GET | string |
Ethernet readers. | |||
| PCM.METRIC-PARM-OVERALL | Decoder | PUBLIC | 5.7.0 | SET|GET | type type state |
[0-5] [0-27] [ON|OFF] |
0: AIM-DPM 1: ISO-IEC 15415 2: ANSI-ISO-IEC 15416 3: SemiT10 4: 1D readability 5: DotCode Readybility 0: Symbol Contrast 1: Axial Non Uniformity 2: Print Growth 3: UEC 4: Modulation 5: Fixed Pattern Damage 6: Grid Non Uniformity 7: Extreme Reflectance 8: Reflect Min 9: Edge Contrast Min 10: Single Scan Int 11: Multi Scan Int 12: Signal To Noise Ratio 13: Horizontal Mark Growth 14: Vertical Mark Growth 15: Data Matrix Cell Width 16: Data Matrix Cell Height 17: Horizontal Mark Misplacement 18: Vertical Mark Misplacement 19: Cell Defects 20: Finder Pattern Defects 21: Overall Grade 22: Edge Determination 23: Defects 24: Reference Decode 25: Decodability 26: Contrast Uniformity 27: Reflectance Margin ON: use for overall calculation OFF: do not use for overall calculation |
Use the the metric grading result for calculating the overall result if enabled (e.g. AIM-DPM → Symbol Contrast → Use for Overall Calculation = ON) Not all metrics are available for each standard: AIM-DPM (0, 1, 2, 3, 4, 5, 6, 8), ISO-IEC 15415 (0, 1, 3, 4, 5, 6, 7), ANSI-ISO-IEC 15416 (1, 4, 8, 9, 22, 23, 24, 25), 1D readability (0, 2, 8, 9, 10, 11), DotCode (0, 1, 2, 3, 6, 8) | Ethernet readers. |
| PCM.METRIC-PARM-REPORT | Decoder | PUBLIC | 5.7.0 | SET|GET | type type state |
[0-5] [0-27] [ON|OFF] |
0: AIM-DPM 1: ISO-IEC 15415 2: ANSI-ISO-IEC 15416 3: SemiT10 4: 1D readability 5: DotCode Readybility 0: Symbol Contrast 1: Axial Non Uniformity 2: Print Growth 3: UEC 4: Modulation 5: Fixed Pattern Damage 6: Grid Non Uniformity 7: Extreme Reflectance 8: Reflect Min 9: Edge Contrast Min 10: Single Scan Int 11: Multi Scan Int 12: Signal To Noise Ratio 13: Horizontal Mark Growth 14: Vertical Mark Growth 15: Data Matrix Cell Width 16: Data Matrix Cell Height 17: Horizontal Mark Misplacement 18: Vertical Mark Misplacement 19: Cell Defects 20: Finder Pattern Defects 21: Overall Grade 22: Edge Determination 23: Defects 24: Reference Decode 25: Decodability 26: Contrast Uniformity 27: Reflectance Margin ON: include in report OFF: do not include in report |
Include the metric grading result for selected quality standard and metric in the report if enabled. Only available if not use for overall calculation (e.g. ISO-IEC 15415 → Modulation → Show in Report = ON) Not all metrics are available for each standard: AIM-DPM (0, 1, 2, 3, 4, 5, 6, 8), ISO-IEC 15415 (0, 1, 2, 3, 4, 5, 6, 7), ANSI-ISO-IEC 15416 (0, 4, 8, 9, 22, 23, 24, 25), SemiT10 (1, 4, 12, 13, 14, 15, 16, 17, 18, 19, 20), 1D readability (0, 2, 8, 9, 10, 11), DotCode (0, 1, 2, 3, 6, 8). | Ethernet readers. |
| PCM.METRIC-PARM-THRESHOLD | Decoder | PUBLIC | 5.7.0 | SET|GET | type type grade value |
[0-5] [0-25] [1-4] [0-1000] |
0: AIM-DPM 1: ISO-IEC 15415 2: ANSI-ISO-IEC 15416 3: SemiT10 4: 1D readability 5: DotCode Readybility 0: Symbol Contrast 1: Axial Non Uniformity 2: Print Growth 3: UEC 4: Modulation 5: Fixed Pattern Damage 6: Grid Non Uniformity 7: Extreme Reflectance 8: Reflect Min 9: Edge Contrast Min 10: Single Scan Int 11: Multi Scan Int 12: Signal To Noise Ratio 13: Horizontal Mark Growth 14: Vertical Mark Growth 15: Data Matrix Cell Width 16: Data Matrix Cell Height 17: Horizontal Mark Misplacement 18: Vertical Mark Misplacement 19: Cell Defects 20: Finder Pattern Defects 21: Overall Grade 22: Edge Determination 23: Defects 24: Reference Decode 25: Decodability 1: D 2: C 3: B 4: A Threshold raw value |
Set the raw value threshold for the selected quality standard, metric and grade (e.g. AIM-DPM → UEC → Threshold B = 50). Not all metrics are available for each standard: AIM-DPM (0, 1, 3, 4, 6, 8), ISO-IEC 15415 (0, 1, 3, 4, 6), ANSI-ISO-IEC 15416 (1, 4, 8, 9, 23, 25), 1D readability (0, 2, 8, 9, 11), DotCode (0, 1, 2, 3, 6, 8) | Ethernet readers. |
| PCM.MIN-PASS | Decoder | PUBLIC | 5.7.0 | SET|GET | type grade |
[0-5] [0-4] |
0: AIM-DPM 1: ISO-IEC 15415 2: ANSI-ISO-IEC 15416 3: SemiT10 4: 1D readability 5: DotCode Readybility 0: F 1: D 2: C 3: B 4: A |
Set the overall minimum passing grade. Results under this grade will mean the reading failed. | Ethernet readers. |
| PCM.USE-CUSTOM-THRESHOLDS | Decoder | PUBLIC | 5.7.0 | SET|GET | type state |
[0-5] [ON|OFF] |
0: AIM-DPM 1: ISO-IEC 15415 2: ANSI-ISO-IEC 15416 3: SemiT10 4: 1D readability 5: DotCode Readybility ON: do regrading OFF: keep current result |
Enable or disable regrading of metric results by using the custom thresholds. | Ethernet readers. |
| QR.QUALITY-METRICS | Decoder | PUBLIC | 4.5.0 | SET|GET | type |
[0-2] |
0: none 1: ISO/IEC 15415 2: AIM-DPM / ISO/IEC TR 29158 |
Code quality metrics for QR codes. | ALL |
| QR.TRAINED-MODEL | Decoder | PUBLIC | 5.7.0 | SET|GET | grid size module size model polarity mirrored |
[11-177] [1-1000] [0-3] [0-2] [ON|OFF] [ON|OFF] |
Grid size Module size * 10 0: Unknown model 1: Model-1 2: Model-2 3: Micro-QR 0: dark-on-light 1: light-on-dark 2: either enable/disable ON: mirrored OFF: not mirrored |
Set training parameters for QR-Code symbology. Option 3 for argument "model": Micro-QR is not applicable for 6.0.1. |
Fixed-mount readers |
| TRUCHECK.AG | Decoder | PUBLIC | 5.7.7 | GET | Returns the AG (average grade) score from the last verification attempt. | DM8072 Verifier | |||
| TRUCHECK.AG-GRADE | Decoder | PUBLIC | 5.7.7 | GET | Returns the AG (average grade) grade from the last verification attempt. | DM8072 Verifier | |||
| TRUCHECK.ANU | Decoder | PUBLIC | 5.7.7 | GET | Returns the ANU (axial non-uniformity) score from the last verification attempt. | DM8072 Verifier | |||
| TRUCHECK.ANU-GRADE | Decoder | PUBLIC | 5.7.7 | GET | Returns the ANU (axial non-uniformity) grade from the last verification attempt. | DM8072 Verifier | |||
| TRUCHECK.DECODE-GRADE | Decoder | PUBLIC | 5.7.7 | GET | Returns the DECODE grade from the last verification attempt. | DM8072 Verifier | |||
| TRUCHECK.FPD | Decoder | PUBLIC | 5.7.7 | GET | Returns the FPD (fixed pattern damage) score from the last verification attempt. | DM8072 Verifier | |||
| TRUCHECK.FPD-GRADE | Decoder | PUBLIC | 5.7.7 | GET | Returns the FPD (fixed pattern damage) grade from the last verification attempt. | DM8072 Verifier | |||
| TRUCHECK.GNU | Decoder | PUBLIC | 5.7.7 | GET | Returns the GNU (grid non-uniformity) score from the last verification attempt. | DM8072 Verifier | |||
| TRUCHECK.GNU-GRADE | Decoder | PUBLIC | 5.7.7 | GET | Returns the GNU (grid non-uniformity) grade from the last verification attempt. | DM8072 Verifier | |||
| TRUCHECK.MOD-GRADE | Decoder | PUBLIC | 5.7.7 | GET | Returns the MOD (modulation) grade from the last verification attempt. | DM8072 Verifier | |||
| TRUCHECK.RM-GRADE | Decoder | PUBLIC | 5.7.7 | GET | Returns the RM grade from the last verification attempt. | DM8072 Verifier | |||
| TRUCHECK.SC | Decoder | PUBLIC | 5.7.7 | GET | Returns the SC (symbol contrast) score from the last verification attempt. | DM8072 Verifier | |||
| TRUCHECK.SC-GRADE | Decoder | PUBLIC | 5.7.7 | GET | Returns the SC (symbol contrast) grade from the last verification attempt. | DM8072 Verifier | |||
| TRUCHECK.UEC | Decoder | PUBLIC | 5.7.7 | GET | Returns the UEC (unused error correction) score from the last verification attempt. | DM8072 Verifier | |||
| TRUCHECK.UEC-GRADE | Decoder | PUBLIC | 5.7.7 | GET | Returns the UEC (unused error correction) grade from the last verification attempt. | DM8072 Verifier | |||
| VSOC.ACCELERATION | Decoder | PRIVATE | 4.0.0 | SET|GET | enable |
[ON|OFF] | enable/disable | Enabled or disable VSOC acceleration. | |
| DVALID.DOD-EXEID | Data Validation | PUBLIC | 3.0.0 | SET|GET | string |
expected-EID | DoD Expected Enterprise ID (EID). | ALL | |
| DVALID.DOD-EXPN | Data Validation | PUBLIC | 3.0.0 | SET|GET | string |
expected-PN | DoD Expected Part Number. See the Overview topic for formatting requirements for the string argument. |
ALL | |
| DVALID.DODCNSTRT | Data Validation | PUBLIC | 3.0.0 | SET|GET | construct |
[0-3] |
0: Any 1: Construct #1 2: Construct #2 3: Equivalent |
Data Validation DoD Construct. | ALL |
| DVALID.FAIL-ACTION | Data Validation | PUBLIC | 3.0.0 | SET|GET | action |
[0-3] |
0: Transmit "Validation Failure" 1: Transmit "Validation Failure" + decoded string 2: Transmit annotated decode string 3: Transmit nothing |
Data Validation Failure Action. | ALL |
| DVALID.FAIL-XMT-CRLF | Data Validation | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Data Validation Transimit CRLF on Failure. | ALL |
| DVALID.GS1-FORMAT | Data Validation | PUBLIC | 3.4.0 | SET|GET | string |
GS1 format string | Set GS1 format string. | ALL | |
| DVALID.ISO-CONSTRUCT | Data Validation | PUBLIC | 3.0.0 | SET|GET | construct |
[0-1] |
0: ISO 15434 1: ISO 15434 & ISO 15418 |
ISO Construct. | ALL |
| DVALID.MATCH-STRING | Data Validation | PUBLIC | 3.0.0 | SET|GET | string |
match-string | Data Validation Match-String. See the Overview topic for formatting requirements for the string argument. |
ALL | |
| DVALID.MATCH-STRING-EMPTY-RESULT | Data Validation | PRIVATE | 4.4.0 | SET|GET | action |
[0-1] |
0: empty match string fails 1: empty match string passes |
Gets or sets if a match string validation attempt with an empty match string should fail (0=default) or pass (1). | ALL |
| DVALID.MATCH-STRING-PARAMS | Data Validation | PUBLIC | 3.0.0 | SET|GET | increment start length step no-read validation-fail |
[ON|OFF]
[0-*] [1-*] [-2|-1|0|1|2] [ON|OFF] [ON|OFF] |
enable/disable
start position of numerical match number of digits increment enable/disable update on no-read enable/disable update on validation failure |
Data Validation Match-String Parameters. | ALL |
| DVALID.PATTERN | Data Validation | PUBLIC | 3.0.0 | SET|GET | string |
pattern-string | Data Validation Pattern. Regexp Data Validation. See the Overview topic for formatting requirements for the string argument. |
ALL | |
| DVALID.PROG-TARG | Data Validation | PUBLIC | 4.4.0 | SET|GET | category |
[1-5] |
1: DataMatrix 2: QR Code/MaxiCode/AztecCode 3: Linear/ Postal/ Stacked 4: VeriCode® 5: DotCode |
Data Validation Programming Target. Data Validation Symbology Set to be modified by subsequent commands. Once issued, this command changes the subsequent behavior of the reader. |
ALL |
| DVALID.TYPE | Data Validation | PUBLIC | 3.0.0 | SET|GET | type |
[0-5] |
0: None 1: DoD UID 2: ISO 3: Pattern 4: Match String 5: GS1 |
ALL | |
| FORMAT.ADVANCED | Data Formatting | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable Data Formatting Advanced Mode. Advanced Mode Formatting Enables: Regexp Pattern Substitution. |
ALL |
| FORMAT.CRLF-END | Data Formatting | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Data Formatting CRLF Terminator. Requires Data Formatting Standard Mode Enabled. |
ALL |
| FORMAT.DELIMITER | Data Formatting | PUBLIC | 3.0.0 | SET|GET | delimiter-option |
[0-5] |
0: none 1: space 2: comma 3: tab 4: label 5: xml |
Data Formatting Delimiter. Sets the delimeter between Data Formatting Tokens. Requires Data Formatting Standard Mode Enabled. |
ALL |
| FORMAT.DISCARD-UNMATCHED | Data Formatting | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Data Formatting Discard Unmatched Data. | ALL |
| FORMAT.MODE | Data Formatting | PUBLIC | 4.5.0 | SET|GET | mode |
[0-1] |
0: basic formatting 1: script-based formatting |
Specifies data formatting mode. By default, basic formatting is the set formatting mode. |
DM50, DM60, DM70, DM474, DM503, MX-1000, MX-1502 and DM300 series readers. |
| FORMAT.MULTICODE-DELIMITER | Data Formatting | PUBLIC | 3.2.0 | SET|GET | type |
[0-6] |
0: none 1: space 2: comma 3: tab 4: label 5: xml 6: CRLF |
Data Formatting Delimiter. Sets the delimiter between codes in a multicode result. |
Fixed mount readers. |
| FORMAT.PROG-TARG | Data Formatting | PUBLIC | 3.2.0 | SET|GET | category |
[0-5] |
0: Universal 1: DataMatrix 2: QR Code/MaxiCode/AztecCode 3: Linear/ Postal/ Stacked 4: VeriCode® 5: DotCode |
Data Formatting Programming Target. Data Formatting Symbology Set to be modified by subsequent commands. Once issued, it changes the subsequent behavior of the reader. AztecCode is only supported on the DM503 and DM300 series readers. |
ALL |
| FORMAT.REGEXP | Data Formatting | PUBLIC | 3.0.0 | SET|GET | string |
regular expression string | Data Formatting Regular Expression. Requires Data Formatting Advanced Mode Enabled. See the Overview topic for formatting requirements for the string argument. |
ALL | |
| FORMAT.SCRIPT | Data Formatting | PUBLIC | 5.2.0 | SET|GET | num-bytes |
Set: loads the script from the host to the reader. Get: sends the script from the reader to the host. | DM474, DM503, MX-1000, MX-1502 and DM300 series readers. | ||
| FORMAT.STANDARD | Data Formatting | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable Data Formatting Standard Mode. Standard Mode Formatting Enables: Leading Text, Data, Data Delimeter, Terminating Text, Terminating CRLF. |
ALL |
| FORMAT.TEXT-BEGIN | Data Formatting | PUBLIC | 3.0.0 | SET|GET | string |
leading output text | Data Formatting Leading Text. Requires Data Formatting Standard Mode Enabled. See the Overview topic for formatting requirements for the string argument. |
ALL | |
| FORMAT.TEXT-END | Data Formatting | PUBLIC | 3.0.0 | SET|GET | string |
trailing text | Data Formatting Trailing Text. Requires Data Formatting Standard Mode Enabled. See the Overview topic for formatting requirements for the string argument. |
ALL | |
| FORMAT.TOKEN | Data Formatting | PUBLIC | 3.0.0 | SET|GET | string |
token string | Data Formatting Standard Data. Regardless of the parameters given to GET FORMAT.TOKEN, it will return the current data formatting token string contained in the Standard Formatting window pointed to by the current value of GET FORMAT.PROG-TARG. See Data Formatting Token Table for available elements. See the Overview topic for formatting requirements for the string argument. |
ALL | |
| INPUT-STRING.ENABLE | Data Formatting | PUBLIC | 5.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enables or disables the use of the Input String feature (available for serial, telnet, NetworkClient). When enabled, a header and the footer can be set by the INPUT-STRING.HEADER and INPUT-STRING.FOOTER commands, respectively. A string of characters can be given between the header and the footer, which will be sent with the formatted output (for example, [hello world], if the header is set to ’[’ and the footer to ’]’). Since the input string is saved temporarily, it appears only in the next result output. Use Setup Tool (the <Input String> option) or <ISTR> with DMCC (see SET FORMAT.TOKEN) to allow Input string in the result output. | ALL |
| INPUT-STRING.ENABLE | Data Formatting | PRIVATE | 4.4.0_cr10 | SET|GET | state |
[ON|OFF] | enable/disable | Enables or disables the use of the Input String feature (available for serial, telnet, NetworkClient). When enabled, a header and the footer can be set by the INPUT-STRING.HEADER and INPUT-STRING.FOOTER commands, respectively. A string of characters can be given between the header and the footer, which will be sent with the formatted output (for example, [hello world], if the header is set to ’[’ and the footer to ’]’). Since the input string is saved temporarily, it appears only in the next result output. Use Setup Tool (the <Input String> option) or <ISTR> with DMCC (see SET FORMAT.TOKEN) to allow Input string in the result output. | ALL |
| INPUT-STRING.FOOTER | Data Formatting | PUBLIC | 5.0.0 | SET|GET | string |
token string | Sets the footer for the Input String character string. | ALL | |
| INPUT-STRING.HEADER | Data Formatting | PUBLIC | 5.0.0 | SET|GET | string |
token string | Sets the header for the Input String character string. | ALL | |
| INPUT-STRING.MODE | Data Formatting | PUBLIC | 5.5.0 | SET|GET | int |
[0-4] |
0: Store 1: Send 2: Send with header and footer 3: Send with formatting 4: Send with header and footer formatting |
Controls whether the input string data is sent out as a result or stored in an internal variable. | Fixed-mount readers. |
| INPUT-STRING.VALUE | Data Formatting | PUBLIC | 5.5.0 | SET|GET | string |
token string | Sets the content of the Input String character string. | Fixed-mount readers | |
| SCRIPT.LOAD | Data Formatting | PUBLIC | 4.5.0 | num-bytes |
Loads the formatting script from the host to the reader. | DM50, DM60, DM70, DM474, DM503, MX-1000, MX-1502 and DM300 series readers. | |||
| SCRIPT.SEND | Data Formatting | PUBLIC | 4.5.0 | Sends the formatting script from the reader to the host. | DM50, DM60, DM70, DM474, DM503, MX-1000, MX-1502 and DM300 series readers. | ||||
| COM.BAUD-RATE - test data | Communication - sample | 3.0.0 | SET|GET | rate |
[1...5] |
1:115200 2:57600 3:38400 4:19200 5:9600 |
RS232 Communication Speed. Does not affect USB communication speed. |
ALL | |
| ACCEL-SENSOR.OPERATION-MODE | Communication | PUBLIC | 5.4.0 | SET|GET | int |
[0-1] |
0: Acceleration Sensor is not used for waking the reader up from hibernation. 1: Acceleration Sensor is used for waking the reader up from hibernation. |
Configures the application of the acceleration sensor. This command is only valid for Bluetooth-connected readers. |
DM8050, DM8600. |
| ACCEL-SENSOR.SENSITIVITY | Communication | PUBLIC | 5.4.0 | SET|GET | int |
[0-2] |
0: Low 1: Medium 2: High |
Gets/sets the sensitivity of the acceleration sensor of/to the predefined value. | DM8050, DM8600. |
| ANDROID.AOA-SWITCH-TIMEOUT | Communication | PUBLIC | 5.7.1 | SET|GET | timeout [ms] |
0-3600000 | Timeout in milliseconds. | After boot the MX device won’t switch to AOA mode for this amount of time. | MX-1000, MX-1502 |
| ANDROID.ROLE | Communication | PUBLIC | 5.7.1 | SET|GET | role |
0-2 |
0: Auto 1: Device 2: AOA |
Sets the USB role of the MX device when in Android mode. | MX-1000, MX-1502 |
| BLUETOOTH.KBM-PIN | Communication | PRIVATE | 5.4.3 | SET|GET | string |
0-16 characters of decimal number | PIN number (e.g. "1234") | Gets or sets the PIN number of the remote target. | DM8050, DM8600. |
| BLUETOOTH.KBM-TARGET-ADDR | Communication | PRIVATE | 5.4.3 | SET|GET | string |
8 characters of hexadecimal number | MAC address (e.g. "0006660492A6") | Gets or sets the MAC address of the remote target. | DM8050, DM8600. |
| BLUETOOTH.MAC-ADDRESS | Communication | PUBLIC | 5.4.0 | GET | Returns the own Bluetooth address of the device. | DM8050, DM8600. | |||
| BLUETOOTH.MAX-RF-POWER | Communication | PUBLIC | 5.4.3 | SET|GET | int |
-23-7 | Maximum output power in dBm | DM8050, DM8600, and Bluetooth base stations. | |
| BLUETOOTH.OPERATION-MODE | Communication | PRIVATE | 5.4.3 | SET|GET | number |
[0-2] |
0: normal mode 1: PC connect mode 2: keyboard emulator mode |
Gets or sets the Bluetooth operation mode. | DM8050, DM8600. |
| BUTTON.SAVE-MATCH-STRING | Communication | PUBLIC | 4.5.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enables or disables saving the trained match string directly to flash when Set Match String is enabled for the 3 sec button press action. If disabled, the match string is only stored in RAM and if the configuration is not saved manually it will be gone after reboot. | DM474, DM503, and DM300 series readers. |
| COM.AUTO-DETECT | Communication | PRIVATE | 3.0.0 | SET|GET | state |
[ON|OFF] [ON|OFF] | enable/disable | Enables support for simultaneous connection to USB And RS-232. | |
| COM.BAUD-RATE | Communication | PUBLIC | 3.0.0 | SET|GET | rate |
[1-5] |
1: 115200 2: 57600 3: 38400 4: 19200 5: 9600 |
ALL except for MX-1000. | |
| COM.BUFFER-AUTO-FLUSH | Communication | PUBLIC | 4.2.1 | SET|GET | state |
[ON|OFF] | enable/disable | Determines if the whole content of the offline buffer is automatically flushed to the first Telnet client. If not, flushing must be activated by the client. | Wireless readers. |
| COM.BUFFER-DATA | Communication | PUBLIC | 4.2.1 | SET|GET | state |
[ON|OFF] | enable/disable | Offline buffering. | Wireless readers. |
| COM.BUFFER-MODE | Communication | PUBLIC | 4.2.2 | SET|GET | int |
[0-1] |
0: Multiple 1: Single |
Sets or gets the offline buffering mode. | Wireless DM8000 readers. |
| COM.COMMUNICATIONS-MODULE | Communication | PUBLIC | 4.2.0 | GET | type |
[0-3] |
0: Serial 1: Ethernet 2: Wireless 3: Bluetooth |
Returns the type of communication module being used. | MX-1000 and DM8000 series readers. |
| COM.DATA-BITS | Communication | PUBLIC | 3.0.0 | SET|GET | bits |
[7,8] | ALL except for MX-1000. | ||
| COM.DMCC-CHECKSUM | Communication | PRIVATE | 3.4.0 | SET|GET | type |
[0-3] |
0: none 1: XOR 2: CRC16 (Header/Response) 3: CRC16 (Header/Response/Data) |
Checksum used in DMCC response. | |
| COM.DMCC-EVENT | Communication | PRIVATE | 4.2.0 | SET|GET | event_mask |
[0-255] bitfield |
0: none 1: reader online/offline |
Sets which events are sent over DMCC. Used by DataMan SDK. | Wireless readers, base station. |
| COM.DMCC-HEADER | Communication | PRIVATE | 3.4.0 | SET|GET | type |
[0-1] |
0: default 1: include result ID |
Sets or gets the header option used in Extended mode. | |
| COM.DMCC-RESPONSE | Communication | PUBLIC | 3.0.0 | SET|GET | mode |
[0|1] |
0: Silent (default) 1: Extended |
DMCC response format. | ALL |
| COM.DMCC-RESPONSE | Communication | PRIVATE | 3.0.0 | SET|GET | mode |
[0-2] |
0: Silent (default) 1: Extended 2: Extended mode with ||[xxx::length] CR NL data Responses |
DMCC response format. | ALL |
| COM.INTERFACE | Communication | PRIVATE | 5.4.3 | GET | Supported interfaces: RS232, USB, Ethernet, WiFi, Bluetooth. | ||||
| COM.MULTI-PORT | Communication | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable daisy chaining of readers so they share one COM port. | Fixed mount readers. |
| COM.PARITY | Communication | PUBLIC | 3.0.0 | SET|GET | parity |
[0-4] |
0: None 1: Even 2: Odd 3: Space 4: Mark |
All except for MX-1000 and MX-1502. | |
| COM.PROTOCOL | Communication | PUBLIC | 5.7.0 | SET|GET | type |
0..1 |
0: Off 1: RTS/CTS |
Sets hardware handshake type of serial port. | Devices with RTS/CTS lines |
| COM.RS232-ENABLE-PAUSE | Communication | PUBLIC | 5.5.0 | SET|GET | mode |
ON/OFF | Enable/disable pause in output data stream. | DM300 series readers, DM60, DM50, DM70, DM474 | |
| COM.RS232-FILTER | Communication | PRIVATE | 5.0.0_cr7 | SET|GET | state |
[ON|OFF] | enable/disable | Enable or disable the RS-232 filter. | DM300 series readers, DM474. |
| COM.RS232-FILTER-CHAR | Communication | PRIVATE | 5.0.0_cr7 | SET|GET | char |
[0x00-0xFF] | Hex char | Sets or gets the hex value of the character to start filtering after (e.g. 0x03 for ETX). | DM300 series readers, DM474. |
| COM.RS232-INTERCHAR-DELAY | Communication | PUBLIC | 5.5.0 | SET|GET | us |
[0-5000] | milliseconds | Sets or gets the internal delay between sending characters to the serial port. | DM300 series readers, DM60, DM50, DM70, DM360 series readers, DM474, DM503 |
| COM.RS232-ROUTE | Communication | PUBLIC | 4.2.1 | SET|GET | value |
[0-1] |
0: base station 1: associated reader |
Controls to which device RS-232 communication is routed. | DM8000 series wireless readers. |
| COM.SCRIPT | Communication | PRIVATE | 5.3.0 | SET|GET | num-bytes |
Load script from communication channel. | DM474, DM503 and DM300 series readers. | ||
| COM.SCRIPT | Communication | PUBLIC | 5.5.0 | SET|GET | num-bytes |
GET: Retrieves the current communication script. SET: Uploads a communication script. | Fixed-mount readers. | ||
| COM.SCRIPT-ENABLED | Communication | PRIVATE | 5.3.0 | SET|GET | bool |
DM474, DM503 and DM300 series readers. | |||
| COM.SCRIPT-ENABLED | Communication | PUBLIC | 5.5.0 | SET|GET | bool |
Enables/disables communication scripting or retrieves current state. | Fixed-mount readers. | ||
| COM.SCRIPT-ERROR | Communication | PUBLIC | 5.5.0 | GET | message |
script error message | Get the error message for the Custom Communication protocol script | Fixed-mount readers. | |
| COM.STOP-BITS | Communication | PUBLIC | 3.0.0 | SET|GET | bits |
[1-2] | ALL except for MX-1000. | ||
| COM.USB-COMPATIBILITY-MODE | Communication | PUBLIC | 3.0.0 | SET|GET | legacy |
[ON|OFF] |
ON: use pre-3.5.0 driver OFF: default |
Controls USB driver. Reboot is required. |
DM50, DM70 and DM8000 series readers. |
| COM.USB-HID-ONLY | Communication | PUBLIC | 5.4.0 | SET|GET | state |
[ON|OFF] | enable/disable | When enabled, the base station will appear as a single USB Keyboard device on its USB port, instead of a composite device. | DM8000 base station G2 |
| COM.USB-MODE | Communication | PUBLIC | 4.2.1 | SET|GET | type |
[0-1] |
0: USB COM 1: USB HID |
Controls USB based communication channels. | DM50, DM60, DM70, MX-1000, MX-1502 and DM8000 series readers. |
| COM.USB-RE-ENUMERATE-ON-START | Communication | PUBLIC | 5.5 | SET|GET | state |
[ON|OFF]
[ON|OFF] |
enable/disable
ON: USB 1.1 mode OFF: USB 2.0 mode |
Feature to re-enumerate the COM port after firmware is started. | DM8000 series readers. |
| COM.USB-REQUIRE-DTR | Communication | PUBLIC | 5.5.0 | SET|GET | state |
[ON|OFF] [ON|OFF] | enable/disable Enable/Disable | Turns the requirement to assert DTR signal during USB communication On or Off. | DM8050 |
| COM.USB-SPEED | Communication | PUBLIC | 4.2.1 | SET|GET | int |
[ON|OFF] |
ON: USB 1.1 mode OFF: USB 2.0 mode |
Forces the USB into full speed mode. | Every reader connected through USB except MX-1000. |
| COM.USB-TEST-SN | Communication | PRIVATE | 4.2.0 | SET|GET | string |
test serial number | Used by manufacturing to make different devices enumerate on the same CDC COM port. | Base station, DM50, DM60 and DM70. | |
| COM.USB-USE-TEST-SN | Communication | PRIVATE | 4.2.0 | SET|GET | state |
[ON|OFF] [ON|OFF] | enable/disable | Used by manufacturing to make different devices enumerate on the same CDC COM port. | Base station, DM50, DM60 and DM70. |
| COM.WAKEUP | Communication | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Wakeup Message. | ALL |
| COM.XLATEPRNT | Communication | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Translate unprintable characters that are embedded in a symbol. The translated result is output over the connection (for example, COM, USB, Ethernet, USB-KEYBOARD). Note that Data Formatting leading and terminating text are not translated. The characters translated are ASCII values between 0x00 and 0x1F. For example, 0x00 = <NUL>, 0x04 = <EOT>, 0x0a = <LF>, 0x0d = <CR>. | ALL |
| CONFIG-BACKUP.SERVER-TYPE | Communication | PUBLIC | 5.5.0 | SET|GET | type |
[0-1] |
0: Generic 1: Mitsubishi GOT |
Configuration backup server type. | DM474, DM503 and DM300 series readers. |
| CUSTOM-CMD.COMMAND-FOOTER | Communication | PUBLIC | 3.2.0 | SET|GET | string |
End of the string to be echoed. See the Overview topic for formatting requirements for the string argument. |
Fixed mount readers. | ||
| CUSTOM-CMD.COMMAND-HEADER | Communication | PUBLIC | 3.2.0 | SET|GET | string |
Start of the string to be echoed. | Fixed mount readers. | ||
| CUSTOM-CMD.ECHO | Communication | PUBLIC | 3.2.0 | SET|GET | state |
[ON|OFF] | enable/disable | Indicates if characters received between a COMMAND-HEADER and COMMAND-FOOTER are echoed. | Fixed mount readers. |
| CUSTOM-CMD.TRIGGER | Communication | PUBLIC | 3.2.0 | SET|GET | state |
[ON|OFF] | enable/disable | Indicates if reader will respond to the TRIGGER-ON or TRIGGER-OFF string. | Fixed mount readers. |
| CUSTOM-CMD.TRIGGER-OFF | Communication | PUBLIC | 3.2.0 | SET|GET | string |
String that will stop a trigger. See the Overview topic for formatting requirements for the string argument. |
Fixed mount readers. | ||
| CUSTOM-CMD.TRIGGER-ON | Communication | PUBLIC | 3.2.0 | SET|GET | string |
String that will start a trigger. See the Overview topic for formatting requirements for the string argument. |
Fixed mount readers. | ||
| DATA.IMAGE-TYPE | Communication | PRIVATE | 3.4.0 | SET|GET | type |
[0-2] |
0: all 1: no read 2: read |
Sets or gets type of image automatically returned. Used in conjuction with DATA.RESULT-TYPE. | |
| DATA.RESULT-ENCODING | Communication | PUBLIC | 3.1.0 | SET|GET | encoding |
[0|1] |
0: ASCII (default) 1: Base64 |
Result string encoding. | ALL |
| DEVICE.MAC-ADDRESS | Communication | PUBLIC | 3.3.0 | GET | Reader's MAC address. | Ethernet readers. | |||
| DEVICE.SCRIPT-HEAP-SIZE-LIMIT | Communication | PRIVATE | 5.5.0 | SET|GET | size |
204800-2147483647 | Maximum size in bytes | Maximum heap size the script engine may allocate. | Fixed mount readers |
| DEVICE.SCRIPT-HEAP-USAGE-CURRENT | Communication | PRIVATE | 5.5.0 | GET | size |
Currently used heap size | The size of heap the script currently allocates. | Fixed mount readers | |
| DEVICE.SCRIPT-HEAP-USAGE-MAX | Communication | PRIVATE | 5.5.0 | GET | size |
Maximum used heap size | The maximum size of heap the script allocated allocated. | Fixed mount readers | |
| DEVICE.SSID | Communication | PUBLIC | 4.2.0 | SET|GET | string |
Network name. | Wireless readers. | ||
| DEVICE.SYSLOG-IP | Communication | PRIVATE | 5.0.0 | SET|GET | string |
Specifies the remote syslog server IP address. | |||
| ETHERNET-IP.ENABLED | Communication | PUBLIC | 3.3.0_cr1 | SET|GET | state |
[ON|OFF] | enable/disable | Enabled or disabled EtherNet/IP communications. | Ethernet readers. The DM8000 series wireless readers also support this protocol if the base station is connected through Ethernet. In the case of a Bluetooth connection, the command has to be sent to the base station, not to the reader. |
| FTP-IMAGE.CUSTOM-FILE-NAME | Communication | PUBLIC | 3.3.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable/disable FTP server generated file name. | Ethernet readers. DM8000 series wireless readers also support FTP if the base station is connected through Ethernet. |
| FTP-IMAGE.FILE-NAME | Communication | PUBLIC | 3.3.0 | SET|GET | string |
File name of FTP image. | Ethernet readers. DM8000 series wireless readers also support FTP if the base station is connected through Ethernet. | ||
| FTP-IMAGE.FILE-NAME-USE-SCRIPT | Communication | PUBLIC | 5.2.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enables FTP file name generation script. | DM474, DM503 and DM300 series readers. |
| FTP-IMAGE.IDLE-LIMIT | Communication | PUBLIC | 5.5.0 | SET|GET | state |
[ON|OFF] | enable/disable | Limit duration of idle connections. | DM474, DM503 and DM300 series readers. |
| FTP-IMAGE.IDLE-TIME | Communication | PUBLIC | 5.5.0 | SET|GET | seconds |
Maximum duration of telling the FTP server that the reader is alive. | DM474, DM503 and DM300 series readers. | ||
| FTP-IMAGE.IP-ADDRESS | Communication | PUBLIC | 3.3.0 | SET|GET | string |
IP address of target FTP server. Uses dotted decimal form, such as "192.168.23.42". |
Ethernet readers. DM8000 series wireless readers also support FTP if the base station is connected through Ethernet. | ||
| FTP-IMAGE.MAX-APPEND | Communication | PUBLIC | 3.3.0 | SET|GET | value |
[0-65535] | Max increment value to append to image name. | Ethernet readers. DM8000 series wireless readers also support FTP if the base station is connected through Ethernet. | |
| FTP-IMAGE.MAX-APPEND-START-VALUE | Communication | PUBLIC | 4.0.0 | SET|GET | value |
[0-65535] | Initial increment value to append to image name. | DM503 | |
| FTP-IMAGE.PASSWORD | Communication | PUBLIC | 3.3.0 | SET | string |
Password used to login to target FTP server. | Ethernet readers. DM8000 series wireless readers also support FTP if the base station is connected through Ethernet. | ||
| FTP-IMAGE.PORT | Communication | PUBLIC | 4.0.0 | SET|GET | port |
[0-65535] | FTP server port number. | Ethernet readers. DM8000 series wireless readers also support FTP if the base station is connected through Ethernet. | |
| FTP-IMAGE.PRIORITY | Communication | PRIVATE | 5.2.0 | SET|GET | value |
[0-2] |
0: High - above decoder 1: Medium - same as running decoder 2: Low - below running decoder |
FTP thread priority. | Ethernet readers. DM8000 series wireless readers also support FTP if the base station is connected through Ethernet. |
| FTP-IMAGE.SERVER-PATH | Communication | PUBLIC | 3.3.0 | SET|GET | string |
Path for FTP image. | Ethernet readers. DM8000 series wireless readers also support FTP if the base station is connected through Ethernet. | ||
| FTP-IMAGE.SERVER-PATH-SCRIPT | Communication | PUBLIC | 5.2.0 | SET|GET | num-bytes |
Set: loads the script from the host to the reader. Get: sends the script from the reader to the host. | DM474, DM503 and DM300 series readers. | ||
| FTP-IMAGE.SERVER-PATH-SCRIPT-ERROR | Communication | PUBLIC | 5.5.0 | GET | message |
script error message | Gets the script error message for FTP Storage name generation . | Fixed-mount readers. | |
| FTP-IMAGE.SERVER-TYPE | Communication | PUBLIC | 5.6.3 | SET|GET | type |
[0-2] |
0: Generic 1: Mitsubishi GOT 2: SFTP |
FTP image server type. 2 means that the server is an S(SH)FTP server. | DM474, DM503 and DM300 series readers. |
| FTP-IMAGE.USER-NAME | Communication | PUBLIC | 3.3.0 | SET|GET | string |
Username used to login to target FTP server. | Ethernet readers. DM8000 series wireless readers also support FTP if the base station is connected through Ethernet. | ||
| FTP-PCM-REPORT.CUSTOM-FILE-NAME | Communication | PUBLIC | 5.7.0 | SET|GET | state |
ON/OFF |
enable disable |
Enable/disable customize file name generation (if disabled the FTP server has to generate a unique name). | Ethernet readers |
| FTP-PCM-REPORT.ENABLE | Communication | PUBLIC | 5.7.0 | SET|GET | enable |
ON/OFF | Enable or disable a PCM Report FTP connection. | Ethernet readers | |
| FTP-PCM-REPORT.FILE-NAME | Communication | PUBLIC | 5.7.0 | SET|GET | string |
File name of PCM Report. | Ethernet readers | ||
| FTP-PCM-REPORT.FILE-NAME-USE-SCRIPT | Communication | PUBLIC | 5.7.0 | SET|GET | state |
ON/OFF |
enable disable |
Enables PCM report file name generation by script. | Ethernet readers |
| FTP-PCM-REPORT.IDLE-LIMIT | Communication | PUBLIC | 5.7.0 | SET|GET | state |
ON/OFF |
enable disable |
Limit duration of idle connections after a data transfer. | Ethernet readers |
| FTP-PCM-REPORT.IDLE-TIME | Communication | PUBLIC | 5.7.0 | SET|GET | seconds |
[0-3600] | Maximum duration of idle connections after a data transfer. | Ethernet readers | |
| FTP-PCM-REPORT.IP-ADDRESS | Communication | PUBLIC | 5.7.0 | SET|GET | server |
IP address or DNS name | Set the PCM Report FTP server. | Ethernet readers | |
| FTP-PCM-REPORT.MAX-APPEND | Communication | PUBLIC | 5.7.0 | SET|GET | value |
[0-65535] | Max increment value to append to PCM report file name. | Ethernet readers | |
| FTP-PCM-REPORT.MAX-APPEND-START-VALUE | Communication | PUBLIC | 5.7.0 | SET|GET | value |
[0-65535] | Initial increment value to append to PCM report file name. | Ethernet readers | |
| FTP-PCM-REPORT.PASSWORD | Communication | PUBLIC | 5.7.0 | SET|GET | string |
PASSWORD used to login to target PCM Report FTP server. | Ethernet readers | ||
| FTP-PCM-REPORT.PORT | Communication | PUBLIC | 5.7.0 | SET|GET | port |
[0-65535] | PCM Report FTP server port number. | Ethernet readers | |
| FTP-PCM-REPORT.SCRIPT-ERROR | Communication | PUBLIC | 5.7.0 | GET | message |
script error message | Gets the script error message for FTP PCM report file name generation. | Ethernet readers | |
| FTP-PCM-REPORT.SERVER-PATH | Communication | PUBLIC | 5.7.0 | SET|GET | string |
Path for PCM Reports which has to be named by the FTP Server. | Ethernet readers | ||
| FTP-PCM-REPORT.SERVER-TYPE | Communication | PUBLIC | 5.7.0 | SET|GET | type |
[0-2] |
0: Generic 1: Mitsubishi GOT 2: SFTP(encrypted) |
FTP server type. | Ethernet readers |
| FTP-PCM-REPORT.USER-NAME | Communication | PUBLIC | 5.7.0 | SET|GET | string |
Username used to login to target PCM Report FTP server. | Ethernet readers | ||
| FTP-PROXY.CONNECT | Communication | PRIVATE | 4.2.0 | index |
[0-15] | FTP object index as returned by FTP-PROXY.CREATE | Used by wireless readers to proxy FTP transfer through base station. | Base station. | |
| FTP-PROXY.CREATE | Communication | PRIVATE | 4.2.0 | user pass server port type |
dotted decimal from IPv4 address [1-65535] [0-1] |
Password. Target FTP server address. Target FTP port number. Target FTP server type (Generic/Mitsubishi). |
Used by wireless readers to proxy FTP transfer through base station. | Base station. | |
| FTP-PROXY.DESTROY | Communication | PRIVATE | 4.2.0 | index |
[0-15] | FTP object index as returned by FTP-PROXY.CREATE | Used by wireless readers to proxy FTP transfer through base station. | Base station. | |
| FTP-PROXY.DISCONNECT | Communication | PRIVATE | 4.2.0 | index |
[0-15] | FTP object index as returned by FTP-PROXY.CREATE | Used by wireless readers to proxy FTP transfer through base station. | Base station. | |
| FTP-PROXY.EXECUTE | Communication | PRIVATE | 4.2.0 | index type path length data |
[0-15] [0-15] [0-15] [0-3] [0-3] |
FTP object index as returned by FTP-PROXY.CREATE FTP transfer type (STOR/STOU/APPE/RETR) File path for FTP transfer Data length Data |
Used by wireless readers to proxy FTP transfer through base station. | Base station. | |
| FTP-PROXY.NOOP | Communication | PRIVATE | 5.0.0 | session |
Sends NOOP using FTP proxy. | Wireless readers. | |||
| FTP-RESULT.APPEND | Communication | PUBLIC | 3.3.0 | SET|GET | type |
[ON|OFF] |
ON: Append result to existing file. OFF: Overwrite file content with result. |
Append to or overwrite file when result is sent via FTP to the file specified by FTP-RESULT.FILE-NAME. The file will be created if it does not exist. | Ethernet readers. DM8000 series wireless readers also support FTP if the base station is connected through Ethernet. |
| FTP-RESULT.ENABLE | Communication | PUBLIC | 3.3.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable/disable FTP transfer of reader results. | Ethernet readers. DM8000 series wireless readers also support FTP if the base station is connected through Ethernet. |
| FTP-RESULT.FILE-NAME | Communication | PUBLIC | 3.3.0 | SET|GET | string |
File name of FTP result. | Ethernet readers. DM8000 series wireless readers also support FTP if the base station is connected through Ethernet. | ||
| FTP-RESULT.IDLE-LIMIT | Communication | PUBLIC | 5.5.0 | SET|GET | state |
[ON|OFF] | enable/disable | Limit duration of idle connections after a data transfer. | DM474, DM503 and DM300 series readers. |
| FTP-RESULT.IDLE-TIME | Communication | PUBLIC | 5.5.0 | SET|GET | seconds |
[0-3600] | Maximum duration of idle connections after a data transfer. | DM474, DM503 and DM300 series readers. | |
| FTP-RESULT.IP-ADDRESS | Communication | PUBLIC | 3.3.0 | SET|GET | string |
IP address of target FTP server. Uses dotted decimal form, such as "192.168.23.42". |
Ethernet readers and MX-1000. DM8000 series wireless readers also support FTP if the base station is connected through Ethernet. | ||
| FTP-RESULT.PASSWORD | Communication | PUBLIC | 3.3.0 | SET | string |
Password used to login to target FTP server. | Ethernet readers. DM8000 series wireless readers also support FTP if the base station is connected through Ethernet. | ||
| FTP-RESULT.PORT | Communication | PUBLIC | 4.0.0 | SET|GET | port |
[0-65535] | FTP server port number. | Ethernet readers. DM8000 series wireless readers also support FTP if the base station is connected through Ethernet. | |
| FTP-RESULT.SERVER-TYPE | Communication | PUBLIC | 5.6.3 | SET|GET | type |
[0-2] |
0: Generic 1: Mitsubishi GOT 2: SFTP |
FTP server type.2 means that the server is an S(SH)FTP server. | DM474, DM503 and DM300 series readers. |
| FTP-RESULT.USER-NAME | Communication | PUBLIC | 3.3.0 | SET|GET | string |
Username used to login to target FTP server. | Ethernet readers. DM8000 series wireless readers also support FTP if the base station is connected through Ethernet. | ||
| HPIT.FRONT-COVER | Communication | PUBLIC | 6.1.6 | GET |
|
[0-4] |
0 = No cover 1 = Cross polarized NEWC Linear Polarized S 2 = Clear cover 3 = Undefined 4 = Diffused |
Detected front cover type. | DM370 series, DM470 series readers. |
| INPUT1.SAVE-MATCH-STRING | Communication | PUBLIC | 4.5.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enables or disables saving the match string to flash when Set Match String is enabled as Input line 1 action. | DM50, DM60, DM70, DM474, DM503, and DM300 series readers. |
| INTELLIGRATED.ENABLED | Communication | PRIVATE | 5.0.0_cr14 | SET|GET | state |
[ON|OFF] | enable/disable | Enable or disable the Intelligrated protocol. | DM503 series readers. |
| INTER-MESSAGE.DELAY | Communication | PREVIEW | 3.2.0 | SET|GET | value |
[0-10000] | milliseconds | Transmission delay between buffered read strings. | Wireless readers. |
| KEY.INTERCHAR-DELAY | Communication | PUBLIC | 5.5.0 | SET|GET | us |
[0-1000] | milliseconds | Sets or gets the delay time between characters when in HID keyboard mode. | DM300 series readers, DM60, DM50, DM70, DM474. |
| LVHSTS.ENABLED | Communication | PRIVATE | 4.4.1_cr6_sr2 | SET|GET | state |
[ON|OFF] | enable/disable | Enable or disable the USPS Lehigh Valley HSTS protocol. | DM300 series readers, DM474. |
| MARKEM.ENABLED | Communication | PRIVATE | 5.0.0_cr11 | SET|GET | state |
[ON|OFF] | enable/disable | Enable or disable the Markem protocol. | DM300 series readers, DM474. |
| MASTER-SLAVE.GROUP-NAME | Communication | PUBLIC | 4.0.0 | SET|GET | name |
Gets or sets the name of the master slave group. | DM60, DM474, DM503, and DM300 series readers. | ||
| MASTER-SLAVE.MODE | Communication | PUBLIC | 4.0.0 | SET|GET | mode |
[0-2] |
0: OFF 1: ON 2: Master |
Switches the master-slave functioning of the reader on or off. | DM60, DM474, DM503, and DM300 series readers. |
| MASTER-SLAVE.TEST | Communication | PUBLIC | 5.5.0 | mode message |
[0-2] |
0: Slave to Master 1: Master to Slave 2: Master to Slave to Master |
Transmits the test message from reader to reader as designated by mode. The terminating reader will output the message preceded by the initiating device delimited by a space | Fixed-mount readers. | |
| MASTER-SLAVE.TEST-EFP-OUTPUT | Communication | PUBLIC | 5.7.3 | SET|GET | state |
[ON|OFF] |
ON: enable OFF: disable |
Enables or disables mst-test messages on the Industrial Protocol interfaces. | DM300 series readers, DM474. |
| MASTER-SLAVE.TIMEOUT | Communication | PUBLIC | 4.0.0 | SET|GET | milliseconds |
[0-10000] | Gets or sets the time to wait for results from slave cameras. | DM60, DM474, DM503, and DM300 series readers. | |
| MASTER-SLAVE.TIMEOUT-DISTANCE | Communication | PUBLIC | 5.7.3 | SET|GET | int |
[0-1000000] | Distance | The distance for a master slave timeout. | DM60, DM70, DM260, DM474, DM503, and DM300 series readers. |
| MASTER-SLAVE.TIMEOUT-MODE | Communication | PUBLIC | 5.7.3 | SET|GET | mode |
[0-1] |
0: Time 1: Distance |
Controls if the mater slave response timeout will be time or distance based. | DM60, DM260, DM474, DM503, and DM300 series readers. |
| MC-PROTOCOL.ENABLED | Communication | PRIVATE | SET|GET | state |
[ON|OFF] | enable/disable | Enable or disable MC-Protocol communication. | Ethernet readers. The DM8000 series wireless readers also support this protocol if the base station is connected through Ethernet. In the case of a Bluetooth connection, the command has to be sent to the base station, not to the reader. | |
| MODBUSTCP.ENABLED | Communication | PUBLIC | SET|GET | state |
[ON|OFF] | enable/disable | Enable or disable Modbus/TCP communication. | Ethernet readers. The DM8000 series wireless readers also support this protocol if the base station is connected through Ethernet. In the case of a Bluetooth connection, the command has to be sent to the base station, not to the reader. | |
| MODBUSTCP.HOLDING-ONLY | Communication | PUBLIC | SET|GET | state |
[ON|OFF] | enable/disable | Ethernet readers. DM8000 series wireless readers also support this protocol if the base station is connected through Ethernet. | ||
| NET-LOCAL.DHCP | Communication | PUBLIC | 3.3.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable/Disable DHCP on reader. | Ethernet readers. |
| NET-LOCAL.DNS-SERVER | Communication | PUBLIC | 3.3.0 | SET|GET | server |
Gets or sets the DNS Server address. | Ethernet readers. | ||
| NET-LOCAL.GATEWAY | Communication | PUBLIC | 3.3.0 | SET|GET | string |
Reader's default gateway IP address. Uses dotted decimal form, such as "192.168.23.1". |
Ethernet readers. | ||
| NET-LOCAL.IP-ADDRESS | Communication | PUBLIC | 3.3.0 | SET|GET | string |
Reader's IP address. Uses dotted decimal form, such as "192.168.23.42". |
Ethernet readers. | ||
| NET-LOCAL.MAX-LINK-SPEED | Communication | PRIVATE | 5.2.0 | SET|GET | speed |
[0-4] |
0: 1000 MBits/sec Full Duplex 1: 100 MBits/sec Full Duplex 2: 100 MBits/sec Half Duplex 3: 10 MBits/sec Full Duplex 4: 10 MBits/sec Half Duplex |
Limits the advertised autonegotiation maximum link speed. | DM503 only |
| NET-LOCAL.PORT | Communication | PUBLIC | 3.4.0 | SET|GET | port |
[1-65535] | Setup Tool server TCP port on reader. | Ethernet readers. | |
| NET-LOCAL.READER-IP-ADDRESS | Communication | PUBLIC | 4.2.0 | SET|GET | string |
dotted decimal form IPv4 address | Base station's IP address. Uses dotted decimal form, such as "192.168.23.42". |
Base stations. | |
| NET-LOCAL.READER-SUBNET-MASK | Communication | PUBLIC | 5.2.0 | SET|GET | string |
dotted decimal form IPv4 address | Base station's subnet mask. Uses dotted decimal form, such as "192.168.23.255". |
Base stationss. | |
| NET-LOCAL.SEC-ENABLE | Communication | PRIVATE | 5.2.0 | SET|GET | state |
[ON|OFF] |
enable/disable
ON: use authentication OFF: no authentication |
Use authentication over telnet for communciation between reader and base. | Ethernet readers. |
| NET-LOCAL.SEC-PASSWORD | Communication | PRIVATE | 5.2.0 | SET|GET | string |
password for authentication | Use authentication over telnet for communciation between reader and base. | Ethernet readers. | |
| NET-LOCAL.SEC-USERNAME | Communication | PRIVATE | 5.2.0 | SET|GET | string |
username for authentication | Use authentication over telnet for communciation between reader and base. | Ethernet readers. | |
| NET-LOCAL.SUBNET-MASK | Communication | PUBLIC | 3.3.0 | SET|GET | string |
Reader's subnet mask. Uses dotted decimal form, such as "192.168.23.255". |
Ethernet readers. | ||
| NET-LOCAL.TCP-KEEPALIVE | Communication | PRIVATE | 3.3.1 | SET|GET | state |
[ON|OFF] | enable/disable | Enable/Disable TCP keepalive message. | Ethernet readers. |
| NET-LOCAL.TCP-KEEPALIVE-COUNT | Communication | PRIVATE | 3.3.1 | SET|GET | value |
[0-32565] | TCP keep alive retry count. | Ethernet readers. | |
| NET-LOCAL.TCP-KEEPALIVE-IDLE | Communication | PRIVATE | 3.3.1 | SET|GET | value |
[0-32565] | TCP keep alive time. Ethernet readers. |
||
| NET-LOCAL.TCP-KEEPALIVE-INTERVAL | Communication | PRIVATE | 3.3.1 | SET|GET | value |
[0-32565] | TCP keep alive interval. Ethernet readers. |
||
| NETWORK-CLIENT.CLIENT-PORT | Communication | PUBLIC | 5.2.0 | SET|GET | int |
[0-65535] | The port on the reader to use as the outbound port (default is 0). | Ethernet readers except for the DM8000 wireless. | |
| NETWORK-CLIENT.CLOSE-CONNECTION | Communication | PUBLIC | 5.2.0 | SET|GET | int |
[0-1] |
0: Never 1: After reader data transfer |
Whether or not to keep the connection open after data transfer (default is 0). | Ethernet readers except for the DM8000 wireless. |
| NETWORK-CLIENT.CONNECTION-TIMEOUT | Communication | PUBLIC | 5.2.0 | SET|GET | int |
[1000-60000] | How long to wait before considering the connection dead (default is 3000). | Ethernet readers except for the DM8000 wireless. | |
| NETWORK-CLIENT.ENABLED | Communication | PUBLIC | 5.1.0 | SET|GET | state |
[ON|OFF] | enable/disable | Switch the Network Client feature on or off. | Ethernet readers except for the DM8000 wireless. |
| NETWORK-CLIENT.HOST-ADDRESS | Communication | PUBLIC | 5.2.0 | SET|GET | string |
Max length = 255 | The address of the server to connect to. | Ethernet readers except for the DM8000 wireless. | |
| NETWORK-CLIENT.HOST-PORT | Communication | PUBLIC | 5.2.0 | SET|GET | int |
[0–65535] | The remote port on the server to connect to (default is 1000). | Ethernet readers except for the DM8000 wireless. | |
| NETWORK-CLIENT.IDLE-TIMEOUT | Communication | PUBLIC | 5.2.0 | SET|GET | int |
[1–3600] | How long to keep the connection open after transfer (default is 1). | Ethernet readers except for the DM8000 wireless. | |
| NETWORK-CLIENT.OPEN-CONNECTION | Communication | PUBLIC | 5.2.0 | SET|GET | us |
[0-1] |
0: on Power-up 1: on Data Activity |
When to open the connection to the remote host (default is 0). | Ethernet readers except for the DM8000 wireless. |
| NETWORK-CLIENT.PROTOCOL | Communication | PUBLIC | 5.2.0 | SET|GET | int |
[0-1] |
0: TCP 1: UDP |
Which protocol to use for the connection (default is 0). | Ethernet readers except for the DM8000 wireless. |
| NETWORK-CLIENT.RECONNECT-DELAY | Communication | PUBLIC | 5.2.0 | SET|GET | int |
[100-60000] | How long to wait before reconnecting if the connection is lost (default is 1000). | Ethernet readers except for the DM8000 wireless. | |
| NTP.ENABLE | Communication | PUBLIC | 5.7.0 | SET|GET | state |
[ON|OFF] | enable/disable Enable/Disable | Enables or disables NTP. | All |
| NTP.SERVER1 | Communication | PUBLIC | 5.7.0 | SET|GET | server |
IP address or DNS name | Set the NTP server 1. | All | |
| NTP.SERVER2 | Communication | PUBLIC | 5.7.0 | SET|GET | server |
IP address or DNS name | Set the NTP server 2. | All | |
| OUTPUT.USER-CONFIGURE | Communication | PUBLIC | 5.3.0 | SET|GET | event number beep tone beep number LED color vibration |
[1,2] [0-2] [0-3] [0-7] [ON|OFF] |
1: USER_EVENT_1 2: USER_EVENT_2 [0]: Low [1]: Medium [2]: High Number of beeps [0]: Off [1]: Blue [2]: Green [3]: Cyan [4]: Red [5]: Magenta [6]: Yellow [7]: White enable/disable ON: The reader vibrates on the given user event. OFF: The reader does not vibrate on the given user event. |
Sets the beeper tone and the number of beeps for USER_EVENT_1 or USER_EVENT_2. | DM8050 (except for the vibration parameter), ON|OFF is supported on DM8600 and MX-1000. |
| PROFIBUS.GATEWAY-COM | Communication | PRIVATE | 5.5.0 | SET|GET | mode |
[0-2] |
0: Profibus 1: RS485 2: RS422 |
Get the COM configuration (Profibus / RS422 / RS485). | Fixed-mount readers |
| PROFIBUS.GATEWAY-FLOW | Communication | PRIVATE | 5.5.0 | SET|GET | mode |
[0-2] |
0: None 1: RTS/CTS 2: XON/XOFF |
The reader will return a value indicating the type of serial flow control to be used. | Fixed-mount readers |
| PROFIBUS.GATEWAY-HOST | Communication | PRIVATE | 5.5.0 | GET | type |
[0] | The reader will return a value indicating the host interface protocol. | Fixed-mount readers | |
| PROFIBUS.GATEWAY-MODE | Communication | PRIVATE | 5.5.0 | GET | mode |
[1] | Get the profibus mode configuration. | Fixed-mount readers | |
| PROFIBUS.GATEWAY-NODE | Communication | PRIVATE | 5.5.0 | SET|GET | node number |
[1-99] | The reader will return the Profinet node number for the gateway. | Fixed-mount readers | |
| PROFIBUS.GATEWAY-RUN | Communication | PRIVATE | 5.5.0 | SET|GET | state |
[ON|OFF] | Runtime start message or heartbeat. | Fixed-mount readers | |
| PROFIBUS.GATEWAY-STATUS | Communication | PRIVATE | 5.5.0 | SET|GET | status |
[0-4] |
0: ok, no error 1: Invalid op mode 2: Invalid node number 3: Invalid flow control 4: Invalid host interference |
Set Gateway error message. | Fixed-mount readers |
| PROFIBUS.GATEWAY-VERSION | Communication | PRIVATE | 5.5.0 | SET|GET | mode |
Set the GW firmware version, used for baud rate detection. | Fixed-mount readers | ||
| PROFINET.ENABLED | Communication | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enabled or disabled PROFINET communications. | Ethernet readers. The DM8000 series wireless readers also support this protocol if the base station is connected through Ethernet. In the case of a Bluetooth connection, the command has to be sent to the base station, not to the reader. |
| PROXIMITY.CURRENT | Communication | PRIVATE | 5.4.0 | SET|GET | int |
[10-200] step 10 | IR LED current of the proximity sensor in mA | A higher value will increase the sensitivity of the sensor. | DM8600 |
| PROXIMITY.THRESHOLD | Communication | PRIVATE | 5.4.0 | SET|GET | int |
[0-100] | Threshold value which defines if the optical button has been pressed or released. A lower value will increase the sensitivity of the sensor. | DM8600 | |
| PTP-SYNC.DELAY | Communication | PUBLIC | 5.5.0 | SET|GET | time |
[0-1000000] | Time between trigger start and the synchronized acquisition timestamp. | DM360 series readers, DM474 | |
| PTP-SYNC.ENABLE | Communication | PUBLIC | 5.5.0 | SET|GET | mode |
[ON|OFF] | Enables MST synchronized by PTP. | DM360 series readers, DM474 | |
| PTP-SYNC.LOCAL-OFFSET | Communication | PUBLIC | 5.5.0 | SET|GET | time |
[0-1000000] | Local offset added to the synchronized acquisition timestamp. | DM360 series readers, DM474 | |
| PTP.ENABLE | Communication | PUBLIC | 5.5.0 | SET|GET | mode |
[ON|OFF] |
enable/disable
OFF: Disable the PTP timestamp synchronization ON: Enable the PTP timestamp synchronization |
Enable the PTP timestamp synchronization. | DM360 series readers, DM474 |
| PTP.PRIORITY1 | Communication | PUBLIC | 5.5.0 | SET|GET | level |
[0-255] | This is the first 8-bit priority value (lower number denotes a higher priority). Normally, this is set at 128 for master capable devices. | DM360 series readers, DM474 | |
| PTP.PRIORITY2 | Communication | PUBLIC | 5.5.0 | SET|GET | level |
[0-255] | This is the second 8-bit priority value (lower number denotes a higher priority). This parameter allows to configure backup clocks. | DM360 series readers, DM474 | |
| PTP.SLAVE-ONLY | Communication | PUBLIC | 5.5.0 | SET|GET | mode |
[ON|OFF] |
enable/disable
OFF: Disables PTP slave only configuration of the reader ON: Configures the reader as PTP slave only |
This parameter configures the reader as PTP slave only, even if no other master is active. | DM360 series readers, DM474 |
| READER.ASSIGNED | Communication | PUBLIC | 5.2.0 | SET|GET | state |
[ON|OFF] | enable/disable | Unassignins the reader and the base station that is associated with it. | Base |
| SCRIPT.GARBAGE-COLLECT | Communication | PRIVATE | 5.5.0 | force |
[ON|OFF] | enable/disable Enforce the garbage collection | Check or enforce the Garbage Collection process. | Fixed mount readers | |
| SDCARD.BACKUP-FILE | Communication | PUBLIC | 5.5.0 | SET|GET | state |
[ON|OFF] | enable/disable | SD card is used for creating and restoring a configuration file backup. | DM360 series readers, DM474 |
| SDCARD.PRESENT | Communication | PUBLIC | 5.5.0 | GET | Returns True if the SD card was detected, False otherwise. | DM360 series readers, DM474 | |||
| SDCARD.TESTFILE | Communication | PRIVATE | 5.5.0 | SET|GET | string |
SET: writes argument to a predefined file on the card. GET: reads back the same file and returns its content. | DM360 series readers, DM474 | ||
| SLMP-PROTOCOL.ENABLED | Communication | PUBLIC | SET|GET | state |
[ON|OFF] | enable/disable | Enables or disables SLMP-Protocol communication. | Ethernet readers. DM8000 series wireless readers also support this protocol if the base station is connected through Ethernet. In the case of a Bluetooth connection, the command has to be sent to the base station, not to the reader. | |
| SYNC-ACQUISITION.CABLE-END | Communication | PUBLIC | 5.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Sets or gets whether your device is a bus terminator at the end of the synchronization interface bus. | DM503 |
| SYNC-ACQUISITION.DELAY | Communication | PUBLIC | 5.0.0 | SET|GET | us |
[0-25000] | microseconds | Synchronized acquisition delay: the time the reader waits after sending or receiving the synchronized interface signal before the regular acquisition sequence starts. | DM503 |
| SYNC-ACQUISITION.ENABLED | Communication | PUBLIC | 5.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enables or disables synchronized triggering. | DM503 |
| SYNC-ACQUISITION.MASTER | Communication | PUBLIC | 5.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Sets or gets whether the device is the master among the synchronized readers. | DM503 |
| SYNC-ACQUISITION.START-DELAY | Communication | PRIVATE | 5.0.0 | SET|GET | us |
[0-25000] | microseconds | This command is to adjust the delay between the master/slave trigger sent via Ethernet and the sync signal sent for RS-845 to compensate for the longer runtime of the message via Ethernet. Developer only command. |
DM503 |
| TELNET.CUSTOM-PORTS | Communication | PUBLIC | 5.5.0 | SET|GET | port |
[0-65535] | Comma separated list of TCP ports | Additional Telnet TCP ports for custom communication. | Ethernet readers |
| TELNET.PORT | Communication | PUBLIC | 3.3.0 | SET|GET | value |
[0-65535] | Telnet server TCP port on reader. | Ethernet readers. | |
| TEST-MODE.ACCEPT-TRIGGERS | Communication | PUBLIC | 5.2.0 | value |
[0-2000000000] | number of accepted triggers from all inputs | Allows a limited number of triggers from external inputs even if triggering from those should be rejected using TEST-MODE.INPUTS-ENABLE. | DM70, DM150, DM260, DM474, DM503 and DM300 series readers. | |
| TEST-MODE.AUTOMATIC | Communication | PUBLIC | 5.2.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enables automatic triggering. | DM70, DM150, DM260, DM474, DM503 and DM300 series readers. |
| TEST-MODE.AUTOMATIC-OFF-US | Communication | PUBLIC | 5.2.0 | SET|GET | microseconds |
[0-2000000000] | Inactive trigger phase for automatic triggering. | DM70, DM150, DM260, DM474, DM503 and DM300 series readers. | |
| TEST-MODE.AUTOMATIC-ON-US | Communication | PUBLIC | 5.2.0 | SET|GET | microseconds |
[0-2000000000] | Active trigger phase for automatic triggering. | DM70, DM150, DM260, DM474, DM503 and DM300 series readers. | |
| TEST-MODE.ENABLE | Communication | PUBLIC | 5.2.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enables test mode. | DM70, DM150, DM260, DM474, DM503 and DM300 series readers. |
| TEST-MODE.INPUTS-ENABLE | Communication | PUBLIC | 5.2.0 | SET|GET | state |
[ON|OFF] | enable/disable | Disables external trigger sources during test mode. | DM70, DM150, DM260, DM474, DM503 and DM300 series readers. |
| TEST-MODE.OUTPUTS-ENABLE | Communication | PUBLIC | 5.2.0 | SET|GET | state |
[ON|OFF] | enable/disable | Disables result reporting to external destinations during test mode. | DM70, DM150, DM260, DM474, DM503 and DM300 series readers. |
| WIFI.AUTH-MODE | Communication | PUBLIC | 4.2.4 | SET|GET | int |
[0-3] |
0 – no auth 1 – WPA-PSK 2 – WPA2-PSK 3 – EAP/TLS 4 – PEAP-MSCHAPV2 |
Sets the authentication method. | DM8000 |
| WIFI.CA-CERT | Communication | PUBLIC | 4.2.4 | SET|GET | string |
NA | Used In WPA-Enterprise. This is the certificate of the certification authority we trust. | PEM formatted certificate, terminated by a space. | DM8000;Base |
| WIFI.CHANNEL | Communication | PUBLIC | 4.2.4 | SET|GET | int |
[1-11] | Sets the wifi channel number. | ||
| WIFI.CLIENT-CERT | Communication | PUBLIC | 4.2.4 | SET|GET | string |
NA | Used in WPA-Enterprise (EAP-TLS). This is the certificate of the reader signed by the trusted CA (set with the previous command). | PEM formatted certificate, terminated by a space. | DM8000;Base |
| WIFI.CLIENT-IDENTITY | Communication | PUBLIC | 4.2.4 | SET|GET | string |
NA | The identity the client certificate is issued to. | DM8000;Base | |
| WIFI.CLIENT-PRIVATE-KEY | Communication | PUBLIC | 4.2.4 | SET|GET | string |
NA | Used in WPA-Enterprise (EAP-TLS). The private key of the reader. | PEM formatted private key, terminated by a space. | DM8000;Base |
| WIFI.ENABLED | Communication | PUBLIC | 4.2.4 | SET|GET | state |
[ON|OFF] | enable/disable | Enables or disables wifi in ad-hoc mode. | |
| WIFI.ENC-METHOD | Communication | PUBLIC | 4.2.4 | SET|GET | int |
[0-5] |
0 – off 1 – WEP40 2 – WEP104 3 – TKIP 4 – AES 5 – TKIP/AES |
Sets the authentication method. | DM8000;Base |
| WIFI.NETWORK-TYPE | Communication | PUBLIC | 4.2.4 | SET|GET | int |
[0-1] |
0 – Infrastructure mode 1 – AD-HOC mode |
Sets whether wifi works in infrastructure or ad-hoc mode. | DM8000 |
| WIFI.PASSPHRASE | Communication | PUBLIC | 4.2.4 | SET|GET | string |
NA | In WEP encrpytion and in WPA(2)-PSK it is the passphrase set by the AP. | DM8000;Base | |
| WIFI.SSID | Communication | PUBLIC | 4.2.4 | SET|GET | string |
NA | Assigns an SSID name to the network. | ||
| CQ | Code Quality | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable Code Quality. Code Quality Measurements require reader calibration and the Verification Feature Key. |
DM8600V |
| CQ.CALIB-DATE | Code Quality | PUBLIC | 3.0.0 | GET | Device Code Quality Calibration Date. | DM8600V | |||
| CQ.ILLUMINATION | Code Quality | PUBLIC | 3.0.0 | SET|GET | illumination-option state |
[0-4] [ON|OFF] |
0: Direct on axis 1: 30-deg All Quadrants 2: 30-deg E-W Quadrants 3: 30-deg N-S Quadrants 4: Custom enable/disable |
Code Quality Illumination Option. | DM8600V |
| CQ.METRICS | Code Quality | PUBLIC | 3.0.0 | SET|GET | metric |
[0-3] |
0: AIM-DPM/ISO/IEC TR 29158 1: ISO/IEC 15415 2: AS9132 Laser-etch 3: AS9132 Dot-peen |
Code Quality Enabled Metrics. | DM8600V |
| CQ.MINPASS | Code Quality | PUBLIC | 3.0.0 | SET|GET | metric min-pass |
[0-1] [0-4] |
0: AIM-DPM/ISO/IEC TR 29158 1: ISO/IEC 15415 0: F 1: D 2: C 3: B 4: A |
Code Quality Minimum Passing Grade. Determines the threshold for "validation failure action" including beep and configured line output. |
DM8600V |
| CQ.PROCESSM | Code Quality | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Code Quality Process Control Metrics. | DM8600V |
| CQ.RESET-CALIBRATION | Code Quality | PUBLIC | 3.3.0 | Invalidates code quality calibration data. Reboot is required. |
DM8600V | ||||
| CQ.UNITS | Code Quality | PUBLIC | 3.0.0 | SET|GET | option |
[0-3] |
0: mils 1: mm 2: inches 3: pixels |
Code Quality Units. | DM8600V |
| MQA.POSTAL-HEIGHT_MICRON | Code Quality | PRIVATE | 4.4.1_cr7 and 5.0.0_cr6 | SET|GET | height |
Height in microns per pixel for MERLIN metrics. | DM300 series readers, DM474. | ||
| MQA.POSTAL-MODE | Code Quality | PRIVATE | 4.0.0 | SET|GET | mode |
[0-2] |
0: Off 1: Partial Metrics 2: All Metrics |
Gets or sets the postal verification mode. | ALL |
| SYMBOL.C39-CONVERT-TO-C32 | Code Quality | PUBLIC | 5.5.0 | SET|GET | state |
[ON|OFF] | enable/disable | Parameter enables or disables Code39 to Code 32 conversion. | DM70, DM150, DM260 |
| CAMERA.AUTO-REGULATION | Camera | PUBLIC | 5.6.0 | SET|GET | auto |
[ON|OFF] |
ON: Automatic OFF: Manual |
Camera Parameters where exposure is in microseconds. | DM50, DM60, DM70, DM150, DM260, DM300 series readers, DM360 series readers, DM474, DM503, DM8600 |
| CAMERA.BURST-LENGTH | Camera | PUBLIC | 3.0.0 | SET|GET | count |
[2-*] | number-images | Burst Length. Number of Acquired Images in Burst Trigger-Mode. Actual maximum can be increased by reducing the camera field of view or reserving fewer images for Process Monitor/Record and Playback. |
Fixed mount readers. |
| CAMERA.BURST-TRANSFER-ALL | Camera | PRIVATE | 3.3.0 | SET|GET | state |
[ON|OFF] | enable/disable | Force transfer of all burst images. Used by the DMCC .NET. |
|
| CAMERA.ENABLE | Camera | PRIVATE | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enables camera which can be disabled when loading images from the PC. | ALL |
| CAMERA.EXPOSURE | Camera | PUBLIC | 3.0.0 | SET|GET | auto target exposure gain |
[ON|OFF] [0-255] [0-22] [4-60] |
ON: Automatic OFF: Manual target pixel value 0: 1/10000 1: 1/7500 2: 1/5000 3: 1/4000 4: 1/3000 5: 1/2500 6: 1/2000 7: 1/1500 8: 1/1250 9: 1/1000 10: 1/750 11: 1/500 12: 1/300 13: 1/250 14: 1/200 15: 1/150 16: 1/125 17: 1/100 18: 1/75 19: 1/50 20: 1/40 21: 1/30000 22: 1/15000 camera gain |
Camera Parameters. The arguments 'exposure' and 'gain' have no effect if 'auto' is ON and the 'target' has no effect if 'auto' is OFF. | DM700. |
| CAMERA.EXPOSURE | Camera | PRIVATE | 3.0.0 | SET|GET | auto target exposure gain |
[ON|OFF] [0-255] [0-20] [1-19] |
ON: Automatic OFF: Manual target pixel value 0: 1/20000 1: 1/10000 2: 1/7500 3: 1/5000 4: 1/3000 5: 1/2500 6: 1/2000 7: 1/1500 8: 1/1250 9: 1/1000 10: 1/750 11: 1/500 12: 1/300 13: 1/250 14: 1/200 15: 1/150 16: 1/125 17: 1/100 18: 1/75 19: 1/50 20: 1/40 camera gain |
Camera Parameters. The arguments 'exposure' and 'gain' have no effect if 'auto' is ON and the 'target' has no effect if 'auto' is OFF. | DM7500 |
| CAMERA.EXPOSURE | Camera | PUBLIC | 5.6.0 | SET|GET | exposure |
[18-25000] | exposure | Camera Parameters where exposure is in microseconds. | DM50, DM60, DM70, DM150, and DM260 |
| CAMERA.EXPOSURE | Camera | PUBLIC | 5.6.0 | SET|GET | exposure |
[5-1000] [12-1000] [5-100000] |
DM300 and DM302 internal illumination DM303 internal illumination with external or no illumination |
Camera Parameters where exposure is in microseconds. | DM300 series readers, DM360 series readers, DM474, DM8600. |
| CAMERA.EXPOSURE | Camera | PUBLIC | 5.6.0 | SET|GET | exposure |
[12-100000] | exposure independent of illumination | Camera Parameters where exposure is in microseconds. | DM503 |
| CAMERA.EXPOSURE-LIMIT-US | Camera | PUBLIC | 5.5.0 | GET | exposure |
maximum value allowed for SET CAMERA.EXPOSURE-US | Get the maximum allowed exposure limited by current settings in us. | Fixed Mount readers. | |
| CAMERA.EXPOSURE-US | Camera | PUBLIC | 5.5.0 | SET|GET | auto target exposure gain |
[ON|OFF] [0-255] [18-25000] [0-60] |
ON: Automatic OFF: Manual target pixel value exposure camera gain |
Camera Parameters where exposure is in microseconds. The argument 'exposure' and 'gain' has no effect if 'auto' is ON and 'target' has no effect at all. | DM50, DM60, DM70, DM150, DM260 |
| CAMERA.EXPOSURE-US | Camera | PUBLIC | 5.5.0 | SET|GET | auto target exposure gain |
[ON|OFF] [0-255] [5-1000] [12-1000] [5-100000] [0-106] |
ON: Automatic OFF: Manual target pixel value DM300 and DM302 internal illumination DM303 internal illumination with external or no illumination camera gain |
Camera Parameters where exposure is in microseconds. The argument 'exposure' and 'gain' has no effect if 'auto' is ON and 'target' has no effect at all. | DM300 series readers, DM360 series readers, DM474, DM8600. |
| CAMERA.EXPOSURE-US | Camera | PUBLIC | 5.5.0 | SET|GET | auto target exposure gain |
[ON|OFF] [0-255] [12-100000] [0-41] |
ON: Automatic OFF: Manual target pixel value exposure independent of illumination camera gain |
Camera Parameters where exposure is in microseconds. The argument 'exposure' and 'gain' has no effect if 'auto' is ON and 'target' has no effect at all. | DM503 |
| CAMERA.EXPOSURE-US | Camera | PUBLIC | 5.5.0 | SET|GET | auto target exposure gain |
[ON|OFF] [0-255] [50-25000] [0-60] |
ON: Automatic OFF: Manual target pixel value camera gain |
Camera Parameters where exposure is in microseconds. The argument 'exposure' and 'gain' has no effect if 'auto' is ON and 'target' has no effect at all. | MX-1000 and DM8000 series readers. |
| CAMERA.FOV | Camera | PREVIEW | 3.2.0 | SET|GET | left (multiple of 8) right (multiple of 8) top (multiple of 4) bottom (multiple of 4) |
[0...] [left+64...] [0...] [top+64...] |
pixels from left pixels from right pixels from top pixels from bottom |
The camera field of view is the area of the camera used for image acquisition. | ALL |
| CAMERA.FOV-ENABLED | Camera | PUBLIC | 3.2.0 | SET|GET | state |
[ON|OFF] | enable/disable | Indicates whether the full FoV or a custom FoV will be used for image acquisition. You can change this value only for the following trigger types: single, burst, and continuous. |
ALL |
| CAMERA.FULL-BLACK-LEVEL-CORRECTION | Camera | PUBLIC | 5.5.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enables Full black level correction. | DM300 series readers, DM474. |
| CAMERA.GAIN | Camera | PUBLIC | 5.5.0 | SET|GET | gain |
[1.00-31.76] | The gain has no effect if the camera runs with automatic exposure | DM300 series readers, DM474. | |
| CAMERA.GAIN | Camera | PUBLIC | 5.5.0 | SET|GET | gain |
[1.00-13.88] | The gain has no effect if the camera runs with automatic exposure | DM503 | |
| CAMERA.GAIN | Camera | PUBLIC | 5.5.0 | SET|GET | gain |
[1.00-15.00] | The gain has no effect if the camera runs with automatic exposure | DM50, DM60, DM70 | |
| CAMERA.GAIN-LIMIT | Camera | PUBLIC | 5.7.0 | SET|GET | gain |
[1.00-max_gain] | 1.00-max_gain: The maximum gain to use | Controls the maximum gain the tuning and auto-regulation process uses to find the best reader settings. Useful to limit noise in Images. | Fixed mount readers. |
| CAMERA.HDR-ESTIMATED-SCENE-KEY | Camera | PRIVATE | 6.1.0 | SET|GET | estimated scene key |
[0-4095] | Estimated scene key parameter for HDR | DM370 series, DM470 series readers. | |
| CAMERA.HDR-MODE | Camera | PUBLIC | 6.1.0 | SET|GET | mode |
[0-2] |
0: Off 1: Global 2: Local |
HDR mode | DM470 series readers. |
| CAMERA.HDR-MODE | Camera | PUBLIC | 6.1.6 | SET|GET | mode |
[0-1] |
0: Off 1: Global |
HDR mode | DM370 series readers. |
| CAMERA.INTERVAL-US | Camera | PUBLIC | 4.0.0 | SET|GET | us |
[*-1000000] |
Microseconds. Step size is 250. * By default the minimum range is 6000 but this can change depending on decode timeout and field of view. |
Acquisition Interval, the time between successive camera acquisitions in microseconds. Supported with Burst, Self, and Continuous trigger types. | DM50, DM60, DM70, DM474, DM503, and DM300 series readers. |
| CAMERA.MAX-EXPOSURE | Camera | PRIVATE | 3.0.0 | SET|GET | exposure |
[0-20] |
0: 1/20000 1: 1/10000 2: 1/7500 3: 1/5000 4: 1/3000 5: 1/2500 6: 1/2000 7: 1/1500 8: 1/1250 9: 1/1000 10: 1/750 11: 1/500 12: 1/300 13: 1/250 14: 1/200 15: 1/150 16: 1/125 17: 1/100 18: 1/75 19: 1/50 20: 1/40 |
Maximum exposure limit for autoregulation. | MX-1000 and DM8000 series readers. |
| CAMERA.MAX-EXPOSURE-US | Camera | PUBLIC | 4.0.0 | SET|GET | exposure |
[1-50] [1-410] [1-100000] |
with HPIA without HPIA with external or no illumination |
Maximum exposure limit in microseconds for autoregulation. HPIA = High Powered Illumination Accessory. |
DM70, DM150, DM260, DM474, DM503, and DM300 series readers. |
| CAMERA.MAX-EXPOSURE-US | Camera | PUBLIC | 5.1.0 | SET|GET | exposure |
[18-25000] | Maximum exposure limit in microseconds for autoregulation. | DM50, DM60, DM70. | |
| CAMERA.MIRROR-HORIZONTAL | Camera | PUBLIC | 5.2.0 | SET|GET | state |
[ON|OFF] | enable/disable | Mirror acquired image over the vertical axis. | DM474, DM503 and DM300 series readers. |
| CAMERA.MIRROR-VERTICAL | Camera | PUBLIC | 5.2.0 | SET|GET | state |
[ON|OFF] | enable/disable | Mirror acquired image over the horizontal axis. | DM70, DM260, DM474, DM503 and DM300 series readers. |
| CAMERA.ROI | Camera | 3.0.0 | SET|GET | left right top bottom |
|||||
| CAMERA.TARGET-BRIGHTNESS | Camera | PUBLIC | 5.6.0 | SET|GET | target |
[0-255] | target pixel value | Camera Parameters where exposure is in microseconds. | All, except MX series readers. |
| CAMERA.XPAND-ROI | Camera | PUBLIC | 5.5.0 | SET|GET | ROI index left right top bottom |
[1-2] [0 - sensor width] [0 - sensor width] [0 - sensor height] [0 - sensor height] |
ROI index pixels from left pixels from right pixels from top pixels from bottom |
Specifies custom FOVE regions. Requires the 1DDataStitching feature key. |
DM70, DM150, DM260, DM300 series readers, DM474, DM503. |
| CAMERA.XPAND-ROI-TYPE | Camera | PUBLIC | 5.5.0 | SET|GET | int |
[0-3] |
0: None 1: Xpand-15 2: Xpand-25 3: Custom |
Indicates the used FOVE type. Requires the 1DDataStitching feature key. |
DM70, DM150, DM260, DM300 series readers, DM474, DM503. |
| CPFLASH.WRITE | Camera | PRIVATE | 5.0.0 | id |
[0-4] |
0: Unknown 1: Prototype 2: Alpha build with SRAM 3: Alpha build with SDRAM 4: Beta build |
Flash camera port ID. | DM 503. | |
| DEVICE.ID | Camera | PRIVATE | 5.4.0 | GET | string |
Returns the device id. | ALL | ||
| DEVICE.LENS-TYPE | Camera | PRIVATE | 5.0.0 | GET | type |
This command gives you the lens type when a liquid lens is installed. | ALL | ||
| FOCUS.COMPENSATE-AFTER-IDLE | Camera | PRIVATE | 5.2.0 | SET|GET | time |
[1-10000] | idle time | Compensates temperature changes after camera is idle for this time. | Liquid lens. |
| FOCUS.DISTANCE | Camera | PUBLIC | 4.0.0 | SET|GET | int |
Distance in mm from the front of the camera to the part. This command returns the value only if Focus Steps is set to 0, otherwise you need to use FOCUS.SWEEP-RANGE instead. |
DM300 series readers, DM474. | ||
| FOCUS.EXTENDED-RANGE | Camera | PUBLIC | 5.7.0 | GET | value |
[ON|OFF] | Extended Focus Range | Indicates that the reader operates in the extended focus range of ON. In this mode GET FOCUS.DISTANCE will return with an error. | Fixed-mount readers with Liquid Lens |
| FOCUS.EXTENDED-RANGE-START | Camera | PRIVATE | 5.7.0 | SET|GET | distance |
[50..4000] | define start of extended range | Defines the start of the extended focus range. Above this distance only optical power can be used to control the Liquid Lens. | Fixed-mount readers with Liquid Lens |
| FOCUS.FAST-DELAY | Camera | PRIVATE | 4.0.0 | SET|GET | value |
??? | |||
| FOCUS.FEEDBACK | Camera | PUBLIC | 4.3.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enables focus feedback. | DM474, DM503 and DM300 series readers. |
| FOCUS.FOCUS-TIME | Camera | PRIVATE | 4.0.0 | SET|GET | value |
[0-3] | |||
| FOCUS.HALL-SENSOR | Camera | PRIVATE | 5.2.0 | GET | value |
??? | |||
| FOCUS.POWER | Camera | PUBLIC | 5.7.0 | SET|GET | optical power |
[-6.0 .. 20.00] | Optical Power in Diopters | Conrols the optical power of the liquid lens. The actual range is dependent on the hardware and on manufacturing tolerances. | Fixed-mount readers with Liquid Lens |
| FOCUS.POWER-RANGE | Camera | PRIVATE | 5.7.1 | GET | Optical Power |
[liquid lens specific] | Optical Power in Diopters | Return minimum (first value) and maximun (second value) optical power values. | Readers with Liquid Lens |
| FOCUS.PRECISION | Camera | PUBLIC | 5.7.0 | SET|GET | settle mode |
[0..1] |
0: normal focus control 1: precise focus control |
Controls the liquid lens focus control between normal focus control and slow but more precise mode. | Fixed mount readers with a liquid lens. |
| FOCUS.PROGRESS | Camera | PUBLIC | 5.7.0 | SET|GET | enable |
[ON|OFF] |
ON: focus progress on OFF: focus progress off |
Enable transfer of intermittent focus images during adjust focus. | Fixed mount readers with a liquid lens. |
| FOCUS.RELAX-TIME | Camera | PRIVATE | 4.0.0 | SET|GET | value |
??? | |||
| FOCUS.STRATEGY | Camera | PRIVATE | 4.0.0 | SET|GET | value |
??? | |||
| FOCUS.SWEEP-POWER | Camera | PUBLIC | 5.7.3 | SET|GET | Optical Power for near distance Optical Power for far distance |
liquid lens specific liquid lens specific |
Optical Power in Diopters Optical Power in Diopters |
Returns near (first value) and far (second value) optical power values. | Readers with Liquid Lens. |
| FOCUS.SWEEP-RANGE | Camera | PUBLIC | 3.6.0 | SET|GET | DM8000 DM300 |
[0-500] [0-500] [40-500] [40-500] |
low sweep range high sweep range low sweep range high sweep range |
Defines the sweep range to be used for focusing. Low must be less than high. The low value is ignored if FOCUS.SWEEP-STEPS is set to 0. | DM70, DM260, DM300 series, DM474 and DM8000 series readers. |
| FOCUS.SWEEP-STEPS | Camera | PUBLIC | 3.6.0 | SET|GET | value |
[0-8] | number of steps to divide the sweep range | Sets the number of steps the sweep range should be divided by. If steps is set to 0 only the high sweep range value is used. | DM70, DM260, DM474, DM8000 series and DM300 series readers. |
| FOCUS.TEMPERATURE-COMPENSATIONS | Camera | PRIVATE | 5.7.0 | SET|GET | state |
ON/OFF | Enable or disable the temperature compensation for the liquid lense HSLC. | Fixed mount readers with a Liquid Lens. | |
| HEIGHT-SENSOR.CURRENT-MEASUREMENT | Camera | PUBLIC | 6.1.6 | GET | [0-4000] | Distance from the C-Mount Flange in mm | Returns the read out of the ToF range distance in mm. | DM370 series, DM470 series readers. | |
| IMAGE.FETCH | Camera | PRIVATE | 5.7.1 | size format quality |
[0-3] [0-2] [10, 15, 20... 85, 90] |
0: Full 1: 1/4 2: 1/16 3: 1/64 0: Bitmap 1: JPEG 2: PNG JPEG quality |
Acquires an image and transfers it. | ||
| IMAGE.FORMAT | Camera | PUBLIC | 5.6.3 | SET|GET | format |
[0-2] |
0: Bitmap 1: JPEG 2: PNG |
Image File Format. | ALL |
| IMAGE.LOAD | Camera | PRIVATE | 3.0.0 | num-bytes |
Loads image from PC to Reader. | ||||
| IMAGE.LOAD-FTP-MULT-PARAM | Camera | PRIVATE | 4.0.0 | ??? | |||||
| IMAGE.LOAD-FTP-PARAM | Camera | PRIVATE | 4.0.0 | ??? | |||||
| IMAGE.QUALITY | Camera | PUBLIC | 4.4.0 | SET|GET | quality |
[10, 15, 20... 85, 90] | JPEG Quality | Quality of the jpeg image. | ALL |
| IMAGE.SEND-BUFFER | Camera | PRIVATE | 5.6.3 | index size format quality |
[0-3] [0-2] [10, 15, 20... 85, 90] |
0: Full 1: 1/4 2: 1/16 3: 1/64 0: Bitmap 1: JPEG 2: PNG JPEG Quality |
Send specified image buffer date. | ||
| IMAGE.SEND-SLOT | Camera | 3.0.0 | |||||||
| IMAGE.SEND-TYPE | Camera | 3.0.0 | |||||||
| IMAGE.SIZE | Camera | PUBLIC | 4.4.0 | SET|GET | size |
[0-3] |
0: Full 1: 1/4 2: 1/16 3: 1/64 |
Image Size. | ALL |
| LIGHT.AIMER | Camera | PUBLIC | 3.0.0 | SET|GET | aimer-mode |
[0-1] |
0: Off 1: On |
Aimer Enable. Default is ON. |
ALL except for DM503 and DM8050. |
| LIGHT.AIMER | Camera | PUBLIC | 5.4.0 | SET|GET | aimer-mode |
[0,1,3] |
0: Off 1: On 3: Activated by Acceleration Sensor |
Aimer Enable. Default is ON. |
DM8050 |
| LIGHT.AIMER | Camera | PRIVATE | 3.0.0 | SET|GET | aimer-mode |
[0-3] |
0: Off 1: LED 2: Laser 3: Both |
Aimer Enable. | DM700 |
| LIGHT.AIMER | Camera | PRIVATE | 3.0.0 | SET|GET | aimer-mode |
[0-3] |
0: Off 1: On when idle 2: Blink (default) 3: On (default) |
Aimer Enable. | DM7500 |
| LIGHT.AIMER | Camera | PUBLIC | 6.1.6 | SET|GET | aimer-mode |
[0-1] |
0: Off 1: On |
Enables or disables the aimer. | DM370 series, DM470 readers. |
| LIGHT.AIMER-TIMEOUT | Camera | PUBLIC | 4.2.1 | SET|GET | int |
[0-600] | seconds | Aimer Timeout in seconds. | MX-1000 and DM8000 series readers. |
| LIGHT.DARKFIELD-INTENSITY | Camera | PUBLIC | 5.4.3 | SET|GET | value |
[0-15] | Intensity | Darkfield Illumination Intensity. | DM8600 |
| LIGHT.DIFFUSE-INTENSITY | Camera | PUBLIC | 5.4.3 | SET|GET | level |
[0-15] | Intensity | Diffuse Brightfield Illumination Intensity. | DM8600 |
| LIGHT.DIRECT | Camera | PUBLIC | 4.4.0 | SET|GET | north east south west NORTH EAST SOUTH WEST |
[ON|OFF]
[ON|OFF] [ON|OFF] [ON|OFF] [ON|OFF] [ON|OFF] [ON|OFF] [ON|OFF] |
enable/disable
enable/disable enable/disable enable/disable enable/disable enable/disable enable/disable enable/disable |
Sets the quadrants on the DM300. Small letters refer to the inner, capital letters to the outer circle, possible values are ON and OFF for each segment. Example for a SET command: SET LIGHT.DIRECT ON OFF ON ON OFF OFF OFF OFF if you want to have the inner north, south, and west lights on. | DM300 series readers, DM474. |
| LIGHT.DIRECT | Camera | PUBLIC | 5.5.0 | SET|GET | north-east north-west south-east south-west |
[ON|OFF]
[ON|OFF] [ON|OFF] [ON|OFF] |
enable/disable
enable/disable enable/disable enable/disable |
Sets the quadrants on the DM70, DM150 and DM260. Possible values are ON and OFF for each segment. Example for a SET command: SET LIGHT.DIRECT ON OFF OFF ON if you want to have the top-left and bottom-right LED on. | DM70, DM150 and DM260 readers. |
| LIGHT.DIRECT | Camera | PUBLIC | 5.7.7 | SET|GET | state |
[ON|OFF] | enable/disable | Turns on/off light banks for the 8072V. Verification should only take place with lighting combinations that can be described as 30 single, 30T (opposite sides), 30Q (all 30 panels), 45Q (all 45 panels), or 90. Other lighting combinations are allowed by the firmware, but will not result in valid verification result. | DM8072 Verifier |
| LIGHT.DIRECT | Camera | PUBLIC | 6.1.6 | SET|GET | North Corners South East-West |
[ON|OFF]
[ON|OFF] [ON|OFF] [ON|OFF] |
enable/disable
enable/disable enable/disable enable/disable |
Enables or disables the HPIT quadrants. | DM370 series, DM470 series readers. |
| LIGHT.DIRECT-INTENSITY | Camera | PUBLIC | 5.1.0 | SET|GET | level |
[0-15] | Intensity | Direct Illumination Intensity. | DM50, DM60, DM474, DM503 and DM300 series readers. |
| LIGHT.DIRECT-INTENSITY | Camera | PUBLIC | 5.4.3 | SET|GET | level |
[1-15] | Intensity | Direct Illumination Intensity. | DM8050 |
| LIGHT.EXTERNAL-ENABLE | Camera | PUBLIC | 4.1.0 | SET|GET | enable |
[ON|OFF] | enable/disable | Enable external illumination supported by I/O. | Fixed mount readers. |
| LIGHT.EXTERNAL-INTENSITY | Camera | PUBLIC | 5.2.0 | SET|GET | level |
[0-15] | Intensity | Sets the intensity of the external illumination. | Fixed mount readers. |
| LIGHT.EXTERNAL-POLARITY | Camera | PUBLIC | 3.0.0 | SET|GET | polarity |
[0-1] |
0: Active Low 1: Active High |
External illlumination output polarity. | Fixed mount readers except for DM70, DM150, DM260. |
| LIGHT.EXTERNAL-PRECHARGE-TIME | Camera | PREVIEW | 3.0.0 | SET|GET | time |
[1-980] | microseconds | External light precharge time. | Fixed mount readers. |
| LIGHT.HIGH-FREQUENCY | Camera | PUBLIC | 5.2.0 | SET|GET | enable |
[ON|OFF] | enable/disable | Enables High Frequency Lights to avoid flickering illumination. | DM50, DM60, DM70, DM474, DM503, and DM300 series readers. |
| LIGHT.HIGH-FREQUENCY-ALWAYS | Camera | PUBLIC | 5.2.0 | SET|GET | enable seconds |
[ON|OFF] 0-86400 |
enable/disable auto off duration |
Enables High Frequency Light in Continuous trigger mode even if no trigger is active. After duration seconds the High Frequency Light is turned off. If the duration is 0 the light is never turned off. | DM50, DM60, DM70, DM474, DM503, and DM300 series readers. |
| LIGHT.HIGH-FREQUENCY-FORCE | Camera | PRIVATE | 5.2.0 | SET|GET | enable |
[ON|OFF] | enable/disable | Enable High Frequency Lights even if overheat protection would normally prohibit it. | DM300 series readers |
| LIGHT.INTERNAL-ENABLE | Camera | PUBLIC | 4.1.0 | SET|GET | enable |
[ON|OFF] | enable/disable | Enable the built-in internal illumination. Default value is OFF. | DM50, DM60, DM70, DM8050, MX-1000, MX-1502, Mobile. |
| LIGHT.LOW-ANGLE | Camera | PUBLIC | 5.7.0 | SET|GET | state |
[ON|OFF] [ON|OFF] | enable/disable low-angle illumination | Controls the DM262 UHD low-angle illumination. | DM262 |
| LIGHT.ON-AXIS | Camera | PUBLIC | 5.7.0 | SET|GET | state |
[ON|OFF] [ON|OFF] | enable/disable on-axis illumination | Controls the DM262 UHD on-axis illumination. | DM262 |
| LIGHT.ON-AXIS-INTENSITY | Camera | PRIVATE | 5.7.0 | SET|GET | intensity |
[0..3] | on-axis illumination intensity | Controls the intensity of the DM262 UHD on-axis illumination. | DM262 |
| LIGHT.POLARIZED | Camera | PUBLIC | 5.6.0 | SET|GET | polarized LED count |
[0|2|4] | Number of polarized filtered LEDs in the illumination | Use this command after applying a different HPIL front cover to publish the illumination filter status to the device. | DM70, DM150, DM260 |
| LIGHT.SELF-REPAIR | Camera | PRIVATE | 5.5.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enables/disables internal illumination self repair mode. | DM300 series readers |
| LIVEIMG.MODE | Camera | PUBLIC | 5.2.0 | SET|GET | mode |
[0,2] |
0: Disable 2: Enable |
Controls live image display. | ALL |
| LIVEIMG.SEND | Camera | PUBLIC | 5.6.3 | size format quality |
[0-3] [0-2] [10, 15, 20... 85, 90] |
0: Full 1: 1/4 2: 1/16 3: 1/64 0: Bitmap 1: JPEG 2: PNG JPEG Quality |
Request image transfer to PC when LIVEIMG.MODE is set to 3. | ||
| MASTER-SLAVE.RX-HEIGHT-SENSOR | Camera | PUBLIC | 4.1.0 | SET|GET | enable |
[ON|OFF]* | enable/disable | Enables or disables this system receiving height information from another system in the network group. | DM60, DM474 and DM300 series readers. |
| MONITOR-MODE.AUTOEXPOSURE | Camera | PUBLIC | 5.7.1 | SET|GET | state |
[ON|OFF] | enable/disable | Enable/disable autoregulation while in monitor mode. | ALL |
| MONITOR-MODE.DECODE-ENABLE | Camera | PUBLIC | 5.7.1 | SET|GET | mode |
[ON|OFF] | enable/disable | ALL | |
| MONITOR-MODE.ENABLE | Camera | PUBLIC | 6.0.1 | SET|GET | state |
[ON|OFF] | enable/disable | Enable/disable monitor mode. | ALL |
| SETUP.ENABLE | Camera | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Setup Enable. One Setup must always be enabled. Enable the desired Setup, before disabiling another Setup. For DM300 series readers, this command works for the active setup. |
DM50, DM60, DM70, DM150, DM260, DM474, DM503, DM8600, MX-1000 and DM300 series readers. |
| SETUP.NAME | Camera | PUBLIC | 3.0.0 | SET|GET | name |
Setup Name. User defined name. |
DM50, DM60, DM70, DM150, DM260, DM474, DM503, DM8600, MX-1000, and DM300 series readers. | ||
| SETUP.PROG-TARGET | Camera | PUBLIC | 3.0.0 | SET|GET | category |
[0-3] |
0: General Purpose 1: Curved Surface 2: Under Marked 3: Mirrored Surface |
Setup Programming Target. Setup to be modified by subsequent commands. |
DM70, DM150, DM260, DM8600 and MX-1000 |
| SETUP.PROG-TARGET | Camera | PUBLIC | 5.0.0 | SET|GET | category |
[0-15] | A number signifying an already existing setup. | Setup Programming Target. Setup to be modified by subsequent commands. |
DM50, DM60, DM70, DM150, DM260, DM474, DM503 and DM300 series readers. |
| SETUP.START-WITH-LAST-READ | Camera | PUBLIC | 5.2.0 | SET|GET | mode |
[ON|OFF] |
enable/disable
OFF: Start with fixed setup ON: Start with setup of last good read |
Sets read setup. | DM8600, DM70, DM150, DM260, DM474, DM503, MX-1000, MX-1502 and DM300 series readers. |
| SETUP.START-WITH-SETUP | Camera | PUBLIC | 5.2.0 | SET|GET | setup |
[0-15] | setup number to start with | Starts read setup. | DM8600, DM70, DM150, DM260, DM474, DM503, MX-1000, MX-1502 and DM300 series readers. |
| SETUP.USE | Camera | PUBLIC | 5.2.0 | int state |
[1-15] [ON|OFF] |
Setup to change enable/disable Disables/Enables setup to be used. |
Adds or removes a setup from the list of usable Read Setups. | DM8600, DM70, DM150, DM260, DM474, DM503 and DM300 series readers. | |
| TRIGGER.DELAY | Camera | PRIVATE | 3.0.0 | SET|GET | milliseconds |
[0-10000] | Trigger Delay. Delay camera acquisition by specified number of milliseconds. |
ALL | |
| TRIGGER.DELAY-DISTANCE | Camera | PUBLIC | 4.4.0 | SET|GET | millimeter |
[0-2147483646] | Delay camera acquisition by distance specified in millimeters. | DM503, DM474 and DM300 series readers. | |
| TRIGGER.DELAY-TIME | Camera | PUBLIC | 4.4.0 | SET|GET | milliseconds |
[0-10000] | Trigger delay in milliseconds. Delay camera acquisition by specified number of milliseconds. |
DM50, DM60, DM70, DM474, DM503, and DM300 series readers. | |
| TRIGGER.DELAY-TYPE | Camera | PUBLIC | 4.4.0 | SET|GET | mode |
[0-1] |
0: none 1: time |
Sets or gets whether trigger delay is according to time. | DM50, DM60 and DM70 |
| TRIGGER.DELAY-TYPE | Camera | PUBLIC | 4.4.0 | SET|GET | mode |
[0-2] |
0: none 1: time 2: distance |
Sets or gets whether trigger delay is according to time or distance. | DM503, DM474 and DM300 series readers. |
| TRIGGER.END-DELAY-DISTANCE | Camera | PUBLIC | 4.4.0 | SET|GET | millimeters |
[0-2147483646] | Sets or gets trigger end delay distance. | DM474, DM503 and DM300 series readers. | |
| TRIGGER.END-DELAY-TIME | Camera | PUBLIC | 4.4.0 | SET|GET | milliseconds |
[0-10000] | Sets or gets trigger end delay time. | DM50, DM60, DM70, DM474, DM503, and DM300 series readers. | |
| TRIGGER.TYPE | Camera | PUBLIC | 3.0.0 | SET|GET | type |
[0-5] |
0: Single (external) 1: Presentation (internal) 2: Manual (button) 3: Burst (external) 4: Self (internal) 5: Continuous (external) |
Trigger Type. The camera API should return the current trigger type value. | DM700 and DM8000 series readers support only Presentation and Manual trigger types. MX-1000, MX-1502 and Mobile support only Manual and Continuous trigger types. |
| TUNE.ADJUST-FOCUS | Camera | PUBLIC | 4.3.0 | SET|GET | state |
[ON|OFF] | Enables or disables using adjusting focus while tuning. | DM70, DM150, DM260, DM474 and DM300 series readers with liquid lens. | |
| TUNE.EXCLUDE-AMBIENT-RESULTS | Camera | PUBLIC | 5.7.0 | SET|GET | disable ambient |
[ON|OFF] |
ON: Disables the automatic selection of ambient light results OFF: Allows ambient light results for atomatic seletion |
Control the automatic selection of tuning results where the prevailing illumination type is ambient light. | Fixed mount readers. |
| TUNE.TRAIN-CODE | Camera | PUBLIC | 4.3.0 | SET|GET | state |
[ON|OFF] | Enables or disables code training while tuning. | DM300 series readers, DM474, DM70, DM260, and DM150. | |
| TUNE.TUNE-LIGHT-BANKS | Camera | PUBLIC | 4.3.0 | SET|GET | state |
[ON|OFF] | Enables or disables using light banks while tuning. Only available when internal illumination is used. |
DM300 series readers, DM474, DM260, DM70 and DM150. | |
| TUNE.TUNE-LIGHT-COMBINATIONS | Camera | PUBLIC | 5.5.0 | SET|GET | mode |
[ON|OFF] | If it is ON, light combinations will always be tuned. | DM300 series readers, DM474, DM260, DM70 and DM150. | |
| VSOC.LEGACY-AUTO-REG | Camera | PRIVATE | 4.0.0 | SET|GET | enable |
[ON|OFF] | enable/disable | Enabled or disable VSOC auto-regulation algorithm. | |
| 3DVECTOR.CALIBRATED | Action | PRIVATE | 5.5.0 | GET | calibration_status |
[0-2] |
0:Neither factory, nor field calibration present 1:Only factory calibration loaded 2:Factory and field calibration loaded |
Query current calibration status. | ALL |
| 3DVECTOR.ENABLED | Action | PRIVATE | 5.5.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enables/disables the 3DVectoring functionality on the reader. | ALL |
| 3DVECTOR.FCALIB-CVL.LOAD | Action | PRIVATE | 5.5.0 | size_bytes |
Load factory calibration data blob in CVL style. | ALL | |||
| 3DVECTOR.FCALIB-CVL.SEND | Action | PRIVATE | 5.5.0 | Send factory calibration data blob in CVL style. | ALL | ||||
| 3DVECTOR.FCALIB-CVT.LOAD | Action | PRIVATE | 5.5.0 | size_bytes |
Load factory calibration data blob in CVT style. | ALL | |||
| 3DVECTOR.FCALIB-CVT.SEND | Action | PRIVATE | 5.5.0 | Send factory calibration data blob in CVT style. | ALL | ||||
| 3DVECTOR.LENGTH | Action | PRIVATE | 5.5.0 | SET|GET | This sets/gets the length of the output 3D line segment. | ALL | |||
| 3DVECTOR.SCALIB.LOAD | Action | PRIVATE | 5.5.0 | size_bytes |
Load system calibration data blob. | ALL | |||
| 3DVECTOR.SCALIB.SEND | Action | PRIVATE | 5.5.0 | Send system calibration data blob. | ALL | ||||
| ABORT | Action | PRIVATE | 3.0.0 | Abort command in process. Intended to abort image transfer. | ALL | ||||
| ANDROID.USB-ROLE-CHANGE | Action | PRIVATE | 5.7.1 | SET|GET | enabled timeout |
[ON|OFF] |
ON: (default) role change enabled, reader operates as usual OFF: role change disabled, reader stays in device mode Timeout in seconds after which the role change is automatically enabled again. |
Disables the USB role change. If role change is disabled, the reader stays in device mode, meaning the phone is not charged. If the role change is disabled, a timeout must be provided in seconds after which the role change is automatically enabled again. | ALL |
| BACKUP.EXPORT | Action | PUBLIC | 5.7.0 | Exports a human readable version of the current reader backup. | ALL | ||||
| BEEP | Action | PUBLIC | 3.0.0 | repetition level |
[0-3] [0-2] |
Command audio beep. | ALL | ||
| BEEP.GLOBAL-ENABLE | Action | PUBLIC | 5.7.0 | SET|GET | state |
[ON|OFF] |
ON: enable OFF: disable |
This command will disable all beeps on the DataMan product. | DM8050, DM8600 |
| BUTTON.VIRTUAL | Action | PRIVATE | 5.4.0 | int state |
[ON|OFF] |
Denotes the button id. enable/disable Denotes the new state of the button. |
Allows to virtually push the TUNE button for more than 3 seconds on a DM8600 to activate "magic mode". | DM8600 | |
| COM.BUFFER-RESET | Action | PUBLIC | 4.2.1 | Clears the content of the offline buffer. | DM8050, DM8600 and MX-1000. | ||||
| COM.BUFFER-START-SEND | Action | PUBLIC | 4.2.1 | Valid if auto-flush is off. Activates buffer data output over Telnet channels (and flushes buffered codes). Data output is stopped every time when all Telnet channels are disconnected. | DM8050, DM8600 and MX-1000. | ||||
| CONFIG-BACKUP.ENABLE | Action | PUBLIC | 5.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enables automatic device configuration backup. | Ethernet readers. DM8000 series wireless readers also support FTP if the base station is connected through Ethernet. |
| CONFIG-BACKUP.IP-ADDRESS | Action | PUBLIC | 5.0.0 | SET|GET | string |
IP address of the Cognex Explorer FTP service. Uses dotted decimal form, such as "192.168.23.42". |
Ethernet readers. DM8000 series wireless readers also support FTP if the base station is connected through Ethernet. | ||
| CONFIG-BACKUP.PASSWORD | Action | PUBLIC | 5.0.0 | SET|GET | string |
Password used to log in to Cognex Explorer FTP service. | Ethernet readers. DM8000 series wireless readers also support FTP if the base station is connected through Ethernet. | ||
| CONFIG-BACKUP.PORT | Action | PUBLIC | 5.0.0 | SET|GET | port |
[0-65535] | Port number of the Cognex Explorer FTP service. | Ethernet readers. DM8000 series wireless readers also support FTP if the base station is connected through Ethernet. | |
| CONFIG-BACKUP.USER-NAME | Action | PUBLIC | 5.0.0 | SET|GET | string |
User name used to log in to the Cognex Explorer FTP service. | Ethernet readers. DM8000 series wireless readers also support FTP if the base station is connected through Ethernet. | ||
| CONFIG.DEFAULT | Action | PUBLIC | 3.0.0 | Resets the device’s configuration settings to factory defaults. Device identification and communications settings are not changed. | ALL | ||||
| CONFIG.DUMP-UIDS | Action | PRIVATE | 3.0.0 | Returns all value tree parameters. | ALL | ||||
| CONFIG.EXPORT | Action | PUBLIC | 5.7.0 | Exports a human readable version of the current reader configuration. | ALL | ||||
| CONFIG.LOAD | Action | PUBLIC | 4.4.0 | num-bytes |
Load Configuration from communication channel. Make sure you use a robust communications channel (for example, Ethernet) because this command does not have error checking or retry support and might cause the device to hang. | ALL | |||
| CONFIG.RESTORE | Action | PUBLIC | 3.0.0 | Restores Configuration from Non-Volatile Memory. | ALL | ||||
| CONFIG.SAVE | Action | PUBLIC | 3.0.0 | Saves Configuration to Non-Volatile Memory. | ALL | ||||
| CONFIG.SAVE-DEFAULTS | Action | PRIVATE | 5.4.0 | Saves current settings as defaults. This command does not reboot the device. | ALL | ||||
| CONFIG.SEND | Action | PUBLIC | 3.0.0 | Send device configuration to communication channel. | ALL | ||||
| CONTROL.RPC | Action | PRIVATE | 4.2.0 | SET|GET | string |
RP code to execute. | Executes RP codes passed as string. Used internally to route RP commands to the base station. | ALL | |
| DEVICE-LOG.CLEAR | Action | PUBLIC | 5.2.0 | This command clears the device log. | DM50, DM60, DM70, DM474, DM503, DM300 series readers, DM8050, DM8600, MX-1000 and MX-1502. | ||||
| DEVICE.BACKUP | Action | PUBLIC | 3.3.0 | Send encrypted backup file (.cdc) to the PC. | ALL | ||||
| DEVICE.DEFAULT | Action | PUBLIC | 3.0.0 | Resets all device settings to factory defaults. This command reboots the device. | ALL | ||||
| DEVICE.DEFAULT-MFG | Action | PRIVATE | 5.4.0 | Resets all device settings to Cognex defaults. This command reboots the device. | DM8050, DM8600. | ||||
| DEVICE.LOG | Action | PUBLIC | 4.4.0 | GET | Get the device log of error and exception conditions such as missed triggers and trigger overruns. | DM50, DM60, DM70, DM474, DM503, DM300 series readers, DM8050 and DM8600. | |||
| DEVICE.RESTORE | Action | PUBLIC | 3.3.0 | file size |
Transmits backup file (.cdc) to the reader. File size is in bytes. File data follows footer. | ALL | |||
| DEVICE.STATS | Action | PRIVATE | 5.2.0 | GET | Get decode statistics. | All. | |||
| DEVICE.TIMEZONE | Action | PUBLIC | 5.7.0 | SET|GET | timezone |
Location or POSIX timezone | Get or set the timezone for local time. | All | |
| DMCC.RESET | Action | PUBLIC | 4.4.0 | When sent, the DMCC resets the following DMCC back to default: COM.DMCC-RESPONSE, COM.DMCC-CHECKSUM, COM.DMCC-HEADER, DATA.RESULT-TYPE, DATA.RESULT-ENCODING, DATA.RESULT-ALWAYSSEND, DATA.IMAGE-TYPE. | ALL | ||||
| DMCC.SAVE | Action | PUBLIC | 4.4.0 | Saves DMCC connection settings. It also saves the status for a new connection session for the following DMCC: COM.DMCC-RESPONSE, COM.DMCC-CHECKSUM, COM.DMCC-HEADER, DATA.RESULT-TYPE, DATA.RESULT-ENCODING, DATA.RESULT-ALWAYSSEND, DATA.IMAGE-TYPE. | ALL | ||||
| ERROR-LED.ENABLE | Action | PRIVATE | 4.5.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enables/disables error log LED. | DM50, DM60, DM70, DM503, DM474 and DM300 series readers. |
| ERROR-LED.ENABLE | Action | PRIVATE | 4.4.0_cr1_sr1 | SET|GET | state |
[ON|OFF] | enable/disable | Enables/disables error log LED. | DM300 series readers. |
| FILE.LOAD | Action | PRIVATE | 4.5.0 | This command can be used to upload a file into DataMan flash filesystem. It should be specified as 'FILE.LOAD "Length" "Filename"'. This DMCC is password-protected. |
ALL | ||||
| FILE.SAVE | Action | PRIVATE | 5.7.0 | filename |
This command can be used to load file from flash, e.g. FILE.SEND "/files/vs.cfg". | ALL | |||
| FLASH.AT70-INIT | Action | PRIVATE | 5.7.1 | magic |
647391673 | Magic number | This command clears AT70 Config block in flash memory. | AT70 based devices | |
| FOCUS.CALIBRATE | Action | PRIVATE | 6.0.1 | Compute C-mount flange distance for early units and store in manufacturing data. | DM47x, DM37x | ||||
| FTP.LOG | Action | PRIVATE | 4.4.0 | GET | Get the FTP log of FTP control connection commands and replies in case of FTP problems. | ALL | |||
| HPIT.INDICATOR-MODE | Action | PUBLIC | 6.1.6 | SET|GET | IND_ID IND_MODE |
[0-1] [0-1] |
0 = Left indicator 1 = Right indicator 0 = OFF 1 = ON |
Allows to control the LED indicators located in Torch according to the selected mode. This command is intended only for usability testing. | DM370 series, DM470 series readers. |
| HPIT.INDICATOR-ON-TIME-US | Action | PRIVATE | 6.1.6 | SET|GET | IND_ID TIME_US |
[0-1] [100-10000] |
0 = Left indicator 1 = Right indicator |
Allows to control the Indicator0 (Green LED) on time to be executed in the following illumination pulse after an event has been detected. | DM370 series, DM470 series readers. |
| HPT.CHANNEL-ENABLED | Action | PRIVATE | 5.7.0 | SET|GET | channel_name, state |
[ON|OFF] string, [ON|OFF] | enable/disable Channel name. Switch state. | Enables or disables a given HPT log channel. | ALL |
| HPT.LOG | Action | PRIVATE | 5.7.0 | GET | Retrieves the HPT log as a binary file content. | ALL | |||
| IMAGE.SEND | Action | PUBLIC | 5.5.0 | Retrieve the last camera image acquired. Returns number of bytes of image data followed by \r\n followed by image data. Whatever is set for ||>IMAGE.SIZE, ||>IMAGE.FORMAT, and ||>IMAGE.QUALITY before requesting the image will be used for the corresponding size, format, and quality. | ALL | ||||
| INPUT.STATE | Action | PUBLIC | 5.5.0 | GET | line |
[0-3] | input line number | Gets the current state of the input line specified. Returns 1 for high, 0 for low. | Fixed-mount readers |
| INPUT.VIRTUAL | Action | PRIVATE | 3.0.0 | line state |
[0-7] [ON|OFF] |
enable/disable |
Software Virtual Input. Trigger is equivalent to line 0. Note that the input actions "Train Code," "Optimize Brightness," "Set Match String," and "Read Configuration Code" are carried out only after the next trigger. |
Fixed mount devices. | |
| KEY.PAUSE-TIME | Action | PUBLIC | 5.4.0 | SET|GET | Pause time |
[0-1000] | 0 to 1000 millisecond pause | Sets the time to pause for a specified pause key sequence. | DM8050, DM8600 series |
| MOTION-DETECTION.ACTIVE | Action | PUBLIC | 5.7.0 | GET | state |
[ON|OFF] |
ON: Active or Lights Off OFF: Inactive or Lights On |
Allows checking the current state of motion detection for presentation or self-internal trigger mode. | DM50, DN60, DM70, DM150, DM260, DM300, DM360, DM474. |
| MOTION-DETECTION.ENABLE | Action | PUBLIC | 5.7.0 | SET|GET | state |
[ON|OFF] |
ON: enable OFF: disable |
Enables or disables motion detection for Presentation trigger mode. | DM50, DN60, DM70, DM150, DM260, DM300, DM474, DM503. |
| MOTION-DETECTION.INIT-STATE | Action | PRIVATE | 5.7.0 | SET|GET | state |
[ON|OFF] | enable/disable ON: motion detection is default state\n; OFF: switch to motion detection state after timeout | Specify the motion detection default state. | DM50, DM60, DM70, DM150, DM260, DM300, DM474, DM503. |
| MOTION-DETECTION.SENSITIVITY | Action | PUBLIC | 5.7.0 | SET|GET |
|
[0|2] |
0: Low 1: Medium 2: High |
Sets or gets the motion detection sensitivity level when in presentation mode. | DM50, DM60, DM70, DM150, DM260, DM300, DM474, DM503. |
| MOTION-DETECTION.TIMEOUT | Action | PRIVATE | 5.7.0 | SET|GET | [0 - 3600] | sec | Time after the reader switches into the motion detection mode. | DM50, DM60, DM70, DM150, DM260, DM300, DM474, DM503. | |
| OUTPUT.DATAVALID-FAIL | Action | PREVIEW | 3.0.0 | Virtual Data Validation Failure. Device beeps, flashes indicator lights, and sets output lines as if the specified Data Validation failure event occurred. |
ALL | ||||
| OUTPUT.GOOD | Action | PREVIEW | 3.0.0 | Virtual Good-Read. Device beeps, flashes indicator lights, and sets output lines as if the specified read event occurred. |
ALL | ||||
| OUTPUT.NOREAD | Action | PREVIEW | 3.0.0 | Virtual No-Read. Device beeps, flashes indicator lights, and sets output lines as if the specified no-read event occurred. |
ALL | ||||
| OUTPUT.USER1 | Action | PUBLIC | 5.3.0 | Device emits USER_EVENT_1 event. | DM8050, MX-1000, MX-1502, DM474, DM503 and DM300 series readers. | ||||
| OUTPUT.USER2 | Action | PUBLIC | 5.3.0 | Device emits USER_EVENT_2 event. | DM8050, MX-1000, MX-1502, DM474, DM503 and DM300 series readers. | ||||
| REBOOT | Action | PUBLIC | 3.0.0 | Reboot the Device. Rebooting the Device restores the Configuration stored in Non-Volatile Memory. Commands will not be processed for several seconds while the device reboots. If communication settings are changed, connection with device may be lost. Note that when connected via USB-COM, the application must release the COM port. |
ALL | ||||
| REBOOT.DELAYED | Action | PUBLIC | 5.6.0 | Reboot the Device after delay in seconds. Rebooting the Device restores the Configuration stored in Non-Volatile Memory. Commands will not be processed for several seconds while the device reboots.If communication settings are changed, connection with device may be lost. Note that when connected via USB-COM, the application must release the COM port. | All | ||||
| RESULT | Action | PUBLIC | 3.0.0 | GET | target |
[0-1] |
0: Result string 1: XML formatted |
Optional Send Last Result. By default the result string is in ASCII format, but this can be changed to Base64 with the DATA.RESULT-ENCODING command. | ALL |
| SSH.UNLOCK | Action | PRIVATE | 6.0.1 | GET | The PC (host) sends this command to the reader to initiate the unlocking mechanism. As a response, the reader sends back a 32 byte random challenge to the PC. | DM474 | |||
| SSH.UNLOCK | Action | PRIVATE | 6.0.1 | SET | signature of the challenge |
The argument is the signature of the random challenge generated by the reader and signed with a public key on the PC side. The reader then verifies that the challenge was signed with the proper key and sent back in one minute. In this case, the SSH service is started on the reader, otherwise, an invalid parameter error is returned. | DM474 | ||
| STATISTICS.RESET | Action | PUBLIC | 3.3.1 | Reset all statistics. | ALL | ||||
| TLS.BENCHMARK | Action | PRIVATE | 5.7.0 | Starts a benchmark of the SSL/TLS library.This DMCC is password protected. The result can be checked in the HPT log output. | ALL | ||||
| TLS.SELFTEST | Action | PRIVATE | 5.7.0 | Starts a benchmark of the SSL/TLS library. This DMCC is password protected. The result can be checked in the HPT log output. | ALL | ||||
| TRAIN.BRIGHT | Action | PUBLIC | 3.0.0 | type |
[ON|OFF] |
ON: Start Train Brightness Algorithm OFF: Abort Train Brightness Algorithm |
Generate a fixed value for the exposure setting based on the particular scene, similar to the Optimize Brightness button in the Setup Tool. | Fixed mount devices. | |
| TRAIN.CODE | Action | PUBLIC | 3.0.0 | state |
[ON|OFF] | enable/disable | Train symbology using next sucessful decode. | Fixed mount devices. | |
| TRAIN.CODE-FROM-IMAGE | Action | PRIVATE | 4.5.0 | num-bytes |
Code is trained from uploaded image. | Fixed mount devices. | |||
| TRAIN.FOCUS | Action | PUBLIC | 3.3.0 | state |
[ON|OFF] | enable/disable | Optimize lens focus. | DM503, DM474 and DM300 series readers. | |
| TRAIN.MATCH-STRING | Action | PUBLIC | 3.1.0 | Triggers the reader and sets the match string to the value of the decoded string. Match String validation must be enabled for this command to work. | Fixed mount devices, DM8050 and DM8600. | ||||
| TRIGGER | Action | PUBLIC | 3.0.0 | state |
[ON|OFF] |
enable/disable
ON: Scanning process is initiated, displaying the preview if necessary, decoding frames, etc. OFF: Scanning process is terminated, even if a barcode has not been decoded. |
Software Trigger. | ALL | |
| TRIGGER | Action | PUBLIC | 3.6.0 | GET | state |
[0|1] |
0: Off 1: On |
Get current state of the trigger. | ALL |
| TUNE.CANCEL | Action | PUBLIC | 4.3.0 |
|
0: Tuning is cancelled. 104: Tuning is not running or there is an error. 101: Tuning is not available. |
Cancel tuning. | DM300 series readers, DM474, DM70, DM260, and DM150. | ||
| TUNE.START | Action | PUBLIC | 4.3.0 |
|
0: Tuning started. 104: Tuning is already running or there is an error. 101: Tuning is not available. |
Start tuning. | DM300 series readers, DM474, DM70, DM260, and DM150. | ||
| TUNE.STATUS | Action | PUBLIC | 5.5.0 | GET | Returns ON if tuning is running, OFF otherwise. | Fixed mount devices. | |||
| UNTRAIN.MODEL | Action | PUBLIC | 3.2.0 | enum index |
[0-5] 0 |
0: All Symbologies 1: DataMatrix 2: QR Code/MaxiCode/AztecCode 3: Linear/ Postal/ Stacked 4: VeriCode® 5: DotCode |
Deletes the specified model. AztecCode is only supported on the DM503 and DM300 series readers. |
Fixed mount readers. | |
| UPTIME | Action | PUBLIC | 5.7.0 | Shows the time since device started. | All | ||||
| DEVICE.FLASH | PRIVATE | 3.0.0 | begin numbytes |
| Name |
Type |
Level |
Version |
Set/Get |
Args |
Range |
Meaning |
Description |
Support |
|---|---|---|---|---|---|---|---|---|---|
| COM.BAUD-RATE - test data | Communication - sample | 3.0.0 | SET|GET | rate |
[1...5] |
1:115200 2:57600 3:38400 4:19200 5:9600 |
RS232 Communication Speed. Does not affect USB communication speed. |
ALL | |
| 2D.ALGORITHM | Symbology | PUBLIC | 3.0.0 | SET|GET | algorithm |
[0-1] |
0: IDMax ©
1: IDQuick |
IDQuick or IDMax© | X, XM, SX and QE fixed-mount readers. All Q models except for DM503Q. |
| ACCEL-SENSOR.OPERATION-MODE | Communication | PUBLIC | 5.4.0 | SET|GET | int |
[0-1] |
0: Acceleration Sensor is not used for waking the reader up from hibernation. 1: Acceleration Sensor is used for waking the reader up from hibernation. |
Configures the application of the acceleration sensor. This command is only valid for Bluetooth-connected readers. |
DM8050, DM8600. |
| ACCEL-SENSOR.SENSITIVITY | Communication | PUBLIC | 5.4.0 | SET|GET | int |
[0-2] |
0: Low 1: Medium 2: High |
Gets/sets the sensitivity of the acceleration sensor of/to the predefined value. | DM8050, DM8600. |
| ANDROID.AOA-SWITCH-TIMEOUT | Communication | PUBLIC | 5.7.1 | SET|GET | timeout [ms] |
0-3600000 | Timeout in milliseconds. | After boot the MX device won’t switch to AOA mode for this amount of time. | MX-1000, MX-1502 |
| ANDROID.ROLE | Communication | PUBLIC | 5.7.1 | SET|GET | role |
0-2 |
0: Auto 1: Device 2: AOA |
Sets the USB role of the MX device when in Android mode. | MX-1000, MX-1502 |
| AZTEC.TRAINED-MODEL | Decoder | PUBLIC | 5.7.0 | SET|GET | grid size module size polarity |
[15-151] [1-1000] [0-2] |
Grid size Module size * 10 0: dark-on-light 1: light-on-dark 2: either |
Set training parameters for Aztec symbology. | Fixed-mount readers |
| BACKUP.EXPORT | Action | PUBLIC | 5.7.0 | Exports a human readable version of the current reader backup. | ALL | ||||
| BATTERY.CHARGE | System | PUBLIC | 4.4.0 | GET | int |
[0-100] | Displays, in percentage, current battery level. | MX-1000 and DM8000 series readers. | |
| BATTERY.INFO | System | PUBLIC | 5.5.1 | GET | battery |
[0-1] |
0: internal battery 1: grip battery |
Gets verbose battery status. | MX-1000 |
| BEEP | Action | PUBLIC | 3.0.0 | repetition level |
[0-3] [0-2] |
Command audio beep. | ALL | ||
| BEEP.DATAVALID-FAIL | IO | PUBLIC | 3.0.0 | SET|GET | repetition level |
[0-3] [0-2] |
number of beeps 0: Lo pitch 1: Med pitch 2: Hi pitch |
Data Validation Failure Beep Settings. | ALL except for DM50, DM60 and DM70. |
| BEEP.DATAVALID-FAIL-OL | IO | PUBLIC | 3.0.0 | SET|GET | repetition level |
[0-3] [0-2] |
number of beeps 0: Lo pitch 1: Med pitch 2: Hi pitch |
Data Validation Failure Beep Settings when offline. | Wireless readers. |
| BEEP.GLOBAL-ENABLE | Action | PUBLIC | 5.7.0 | SET|GET | state |
[ON|OFF] |
ON: enable OFF: disable |
This command will disable all beeps on the DataMan product. | DM8050, DM8600 |
| BEEP.GOOD | IO | PUBLIC | 3.0.0 | SET|GET | repetition level |
[0-3] [0-2] |
number of beeps 0: Lo pitch 1: Med pitch 2: Hi pitch |
Good Read Beep Settings. | ALL except for DM50, DM60 and DM70. |
| BEEP.GOOD-OL | IO | PUBLIC | 3.0.0 | SET|GET | repetition level |
[0-3] [0-2] |
number of beeps 0: Lo pitch 1: Med pitch 2: Hi pitch |
Good Read Beep Settings when offline. | Wireless readers. |
| BEEP.NO-READ | IO | PUBLIC | 3.0.0 | SET|GET | repetition level |
[0-3] [0-2] |
number of beeps 0: Lo pitch 1: Med pitch 2: Hi pitch |
No-Read Beep Settings. | ALL except for DM50, DM60 and DM70. |
| BEEP.NO-READ-OL | IO | PUBLIC | 3.0.0 | SET|GET | repetition level |
[0-3] [0-2] |
number of beeps 0: Lo pitch 1: Med pitch 2: Hi pitch |
No-Read Beep Settings when offline. | Wireless readers. |
| BEEPER.ENABLED | IO | PUBLIC | 5.7.1 | SET|GET | state |
[ON|OFF] | Enable/disable beeper in general. | All | |
| BLUETOOTH.MAC-ADDRESS | Communication | PUBLIC | 5.4.0 | GET | Returns the own Bluetooth address of the device. | DM8050, DM8600. | |||
| BLUETOOTH.MAX-RF-POWER | Communication | PUBLIC | 5.4.3 | SET|GET | int |
-23-7 | Maximum output power in dBm | DM8050, DM8600, and Bluetooth base stations. | |
| BUTTON.3SEC-ACTION | IO | PUBLIC | 3.0.0 | SET|GET | mode state |
[0-6] [ON|OFF] |
0: Train 1: Optimize Brighness 2: Set Match String 3: Optimize Focus 4: Read Configuration Code 5: Tune 6: Toggle Test Mode enable/disable |
Three Second Button Action. | Fixed mount readers. Test Mode is only supported on the DM503, DM300 series readers and DM474. |
| BUTTON.ACTION | IO | PUBLIC | 5.5.1 | SET|GET | button action |
[0-2] [0-1] |
Index of button (0:Left;1:Right;2:Grip) 0: disabled 1: trigger |
Sets and gets the assigned feature for hardware buttons. | MX-1000 |
| BUTTON.ENABLE | IO | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enables or disables the trigger button. | Fixed mount readers. |
| BUTTON.SAVE-MATCH-STRING | Communication | PUBLIC | 4.5.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enables or disables saving the trained match string directly to flash when Set Match String is enabled for the 3 sec button press action. If disabled, the match string is only stored in RAM and if the configuration is not saved manually it will be gone after reboot. | DM474, DM503, and DM300 series readers. |
| C11.CHKCHAR | Symbology | PUBLIC | 5.7.1 | SET|GET | state |
[ON|OFF] |
ON: enable OFF: disable (default) |
Code 11 Check Character | Mobile |
| C11.CHKCHAR-OPTION | Symbology | PUBLIC | 5.7.1 | SET|GET | int |
[0-1] |
0: disable 1: enable (default) |
Mobile | |
| C11.CODESIZE | Symbology | PUBLIC | 5.7.1 | SET|GET | any, min, max |
[ON|OFF] [1-max] [min-80] |
any length code minimum code length maximum code length |
Code 11 Code Size | ALL |
| C128.CODESIZE | Symbology | PUBLIC | 3.0.0 | SET|GET | any min max |
[ON|OFF] [1-max] [min-80] |
any length code minimum code length maximum code length |
Code 128 Allowed Size. | ALL |
| C25.CHKCHAR | Symbology | PUBLIC | 5.5.2 | SET|GET | state |
[ON|OFF] |
ON: enable OFF: disable |
Code 25 Check Character | ALL |
| C25.CODESIZE | Symbology | PUBLIC | 5.5.2 | SET|GET | any, min, max |
[ON|OFF] [1-max] [min-80] |
any length code minimum code length maximum code length |
Code 25 Code Size. For the Manatee Works SDK, all of the Code 25 variants use the same minimum length; thus it will accept either C25.CODESIZE or I205.CODESIZE. | ALL |
| C25.QZ-SIZE | Symbology | PUBLIC | 5.5.2 | SET|GET | size |
[0..100] | any length code | Sets or gets the single side strictness as a percentage. | ALL |
| C25.XMTCHK | Symbology | PUBLIC | 5.5.2 | SET|GET | state |
[ON|OFF] |
ON: enable OFF: disable |
Sets or gets whether to transmit the check digit. | ALL |
| C39.ASCII | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Code 39 Full ASCII. | ALL |
| C39.CHKCHAR | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Code 39 Check Character. | ALL |
| C39.CODESIZE | Symbology | PUBLIC | 3.0.0 | SET|GET | any min max |
[ON|OFF] [1-max] [min-80] |
any length code minimum code length maximum code length |
Code 39 Code Size. | ALL |
| C39.XMTCHK | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Code 39 Transmit Check Character. | ALL |
| C93.CODESIZE | Symbology | PUBLIC | 3.0.0 | SET|GET | any min max |
[ON|OFF] [1-max] [min-80] |
any length code minimum code length maximum code length |
Code 93 Code Size. | ALL |
| CAMERA.AUTO-REGULATION | Camera | PUBLIC | 5.6.0 | SET|GET | auto |
[ON|OFF] |
ON: Automatic OFF: Manual |
Camera Parameters where exposure is in microseconds. | DM50, DM60, DM70, DM150, DM260, DM300 series readers, DM360 series readers, DM474, DM503, DM8600 |
| CAMERA.BURST-LENGTH | Camera | PUBLIC | 3.0.0 | SET|GET | count |
[2-*] | number-images | Burst Length. Number of Acquired Images in Burst Trigger-Mode. Actual maximum can be increased by reducing the camera field of view or reserving fewer images for Process Monitor/Record and Playback. |
Fixed mount readers. |
| CAMERA.EXPOSURE | Camera | PUBLIC | 3.0.0 | SET|GET | auto target exposure gain |
[ON|OFF] [0-255] [0-22] [4-60] |
ON: Automatic OFF: Manual target pixel value 0: 1/10000 1: 1/7500 2: 1/5000 3: 1/4000 4: 1/3000 5: 1/2500 6: 1/2000 7: 1/1500 8: 1/1250 9: 1/1000 10: 1/750 11: 1/500 12: 1/300 13: 1/250 14: 1/200 15: 1/150 16: 1/125 17: 1/100 18: 1/75 19: 1/50 20: 1/40 21: 1/30000 22: 1/15000 camera gain |
Camera Parameters. The arguments 'exposure' and 'gain' have no effect if 'auto' is ON and the 'target' has no effect if 'auto' is OFF. | DM700. |
| CAMERA.EXPOSURE | Camera | PUBLIC | 5.6.0 | SET|GET | exposure |
[18-25000] | exposure | Camera Parameters where exposure is in microseconds. | DM50, DM60, DM70, DM150, and DM260 |
| CAMERA.EXPOSURE | Camera | PUBLIC | 5.6.0 | SET|GET | exposure |
[5-1000] [12-1000] [5-100000] |
DM300 and DM302 internal illumination DM303 internal illumination with external or no illumination |
Camera Parameters where exposure is in microseconds. | DM300 series readers, DM360 series readers, DM474, DM8600. |
| CAMERA.EXPOSURE | Camera | PUBLIC | 5.6.0 | SET|GET | exposure |
[12-100000] | exposure independent of illumination | Camera Parameters where exposure is in microseconds. | DM503 |
| CAMERA.EXPOSURE-LIMIT-US | Camera | PUBLIC | 5.5.0 | GET | exposure |
maximum value allowed for SET CAMERA.EXPOSURE-US | Get the maximum allowed exposure limited by current settings in us. | Fixed Mount readers. | |
| CAMERA.EXPOSURE-US | Camera | PUBLIC | 5.5.0 | SET|GET | auto target exposure gain |
[ON|OFF] [0-255] [18-25000] [0-60] |
ON: Automatic OFF: Manual target pixel value exposure camera gain |
Camera Parameters where exposure is in microseconds. The argument 'exposure' and 'gain' has no effect if 'auto' is ON and 'target' has no effect at all. | DM50, DM60, DM70, DM150, DM260 |
| CAMERA.EXPOSURE-US | Camera | PUBLIC | 5.5.0 | SET|GET | auto target exposure gain |
[ON|OFF] [0-255] [5-1000] [12-1000] [5-100000] [0-106] |
ON: Automatic OFF: Manual target pixel value DM300 and DM302 internal illumination DM303 internal illumination with external or no illumination camera gain |
Camera Parameters where exposure is in microseconds. The argument 'exposure' and 'gain' has no effect if 'auto' is ON and 'target' has no effect at all. | DM300 series readers, DM360 series readers, DM474, DM8600. |
| CAMERA.EXPOSURE-US | Camera | PUBLIC | 5.5.0 | SET|GET | auto target exposure gain |
[ON|OFF] [0-255] [12-100000] [0-41] |
ON: Automatic OFF: Manual target pixel value exposure independent of illumination camera gain |
Camera Parameters where exposure is in microseconds. The argument 'exposure' and 'gain' has no effect if 'auto' is ON and 'target' has no effect at all. | DM503 |
| CAMERA.EXPOSURE-US | Camera | PUBLIC | 5.5.0 | SET|GET | auto target exposure gain |
[ON|OFF] [0-255] [50-25000] [0-60] |
ON: Automatic OFF: Manual target pixel value camera gain |
Camera Parameters where exposure is in microseconds. The argument 'exposure' and 'gain' has no effect if 'auto' is ON and 'target' has no effect at all. | MX-1000 and DM8000 series readers. |
| CAMERA.FOV-ENABLED | Camera | PUBLIC | 3.2.0 | SET|GET | state |
[ON|OFF] | enable/disable | Indicates whether the full FoV or a custom FoV will be used for image acquisition. You can change this value only for the following trigger types: single, burst, and continuous. |
ALL |
| CAMERA.FULL-BLACK-LEVEL-CORRECTION | Camera | PUBLIC | 5.5.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enables Full black level correction. | DM300 series readers, DM474. |
| CAMERA.GAIN | Camera | PUBLIC | 5.5.0 | SET|GET | gain |
[1.00-31.76] | The gain has no effect if the camera runs with automatic exposure | DM300 series readers, DM474. | |
| CAMERA.GAIN | Camera | PUBLIC | 5.5.0 | SET|GET | gain |
[1.00-13.88] | The gain has no effect if the camera runs with automatic exposure | DM503 | |
| CAMERA.GAIN | Camera | PUBLIC | 5.5.0 | SET|GET | gain |
[1.00-15.00] | The gain has no effect if the camera runs with automatic exposure | DM50, DM60, DM70 | |
| CAMERA.GAIN-LIMIT | Camera | PUBLIC | 5.7.0 | SET|GET | gain |
[1.00-max_gain] | 1.00-max_gain: The maximum gain to use | Controls the maximum gain the tuning and auto-regulation process uses to find the best reader settings. Useful to limit noise in Images. | Fixed mount readers. |
| CAMERA.HDR-MODE | Camera | PUBLIC | 6.1.0 | SET|GET | mode |
[0-2] |
0: Off 1: Global 2: Local |
HDR mode | DM470 series readers. |
| CAMERA.HDR-MODE | Camera | PUBLIC | 6.1.6 | SET|GET | mode |
[0-1] |
0: Off 1: Global |
HDR mode | DM370 series readers. |
| CAMERA.INTERVAL-US | Camera | PUBLIC | 4.0.0 | SET|GET | us |
[*-1000000] |
Microseconds. Step size is 250. * By default the minimum range is 6000 but this can change depending on decode timeout and field of view. |
Acquisition Interval, the time between successive camera acquisitions in microseconds. Supported with Burst, Self, and Continuous trigger types. | DM50, DM60, DM70, DM474, DM503, and DM300 series readers. |
| CAMERA.MAX-EXPOSURE-US | Camera | PUBLIC | 4.0.0 | SET|GET | exposure |
[1-50] [1-410] [1-100000] |
with HPIA without HPIA with external or no illumination |
Maximum exposure limit in microseconds for autoregulation. HPIA = High Powered Illumination Accessory. |
DM70, DM150, DM260, DM474, DM503, and DM300 series readers. |
| CAMERA.MAX-EXPOSURE-US | Camera | PUBLIC | 5.1.0 | SET|GET | exposure |
[18-25000] | Maximum exposure limit in microseconds for autoregulation. | DM50, DM60, DM70. | |
| CAMERA.MIRROR-HORIZONTAL | Camera | PUBLIC | 5.2.0 | SET|GET | state |
[ON|OFF] | enable/disable | Mirror acquired image over the vertical axis. | DM474, DM503 and DM300 series readers. |
| CAMERA.MIRROR-VERTICAL | Camera | PUBLIC | 5.2.0 | SET|GET | state |
[ON|OFF] | enable/disable | Mirror acquired image over the horizontal axis. | DM70, DM260, DM474, DM503 and DM300 series readers. |
| CAMERA.TARGET-BRIGHTNESS | Camera | PUBLIC | 5.6.0 | SET|GET | target |
[0-255] | target pixel value | Camera Parameters where exposure is in microseconds. | All, except MX series readers. |
| CAMERA.XPAND-ROI | Camera | PUBLIC | 5.5.0 | SET|GET | ROI index left right top bottom |
[1-2] [0 - sensor width] [0 - sensor width] [0 - sensor height] [0 - sensor height] |
ROI index pixels from left pixels from right pixels from top pixels from bottom |
Specifies custom FOVE regions. Requires the 1DDataStitching feature key. |
DM70, DM150, DM260, DM300 series readers, DM474, DM503. |
| CAMERA.XPAND-ROI-TYPE | Camera | PUBLIC | 5.5.0 | SET|GET | int |
[0-3] |
0: None 1: Xpand-15 2: Xpand-25 3: Custom |
Indicates the used FOVE type. Requires the 1DDataStitching feature key. |
DM70, DM150, DM260, DM300 series readers, DM474, DM503. |
| CODABAR.CHKCHAR | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Codabar Check Character. | ALL |
| CODABAR.CODESIZE | Symbology | PUBLIC | 3.0.0 | SET|GET | any min max |
[ON|OFF] [1-max] [min-80] |
any length code minimum code length maximum code length |
Codabar Code Size. | ALL |
| CODABAR.XMTCHK | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Codabar Transmit Check Character. | ALL |
| COM.BAUD-RATE | Communication | PUBLIC | 3.0.0 | SET|GET | rate |
[1-5] |
1: 115200 2: 57600 3: 38400 4: 19200 5: 9600 |
ALL except for MX-1000. | |
| COM.BUFFER-AUTO-FLUSH | Communication | PUBLIC | 4.2.1 | SET|GET | state |
[ON|OFF] | enable/disable | Determines if the whole content of the offline buffer is automatically flushed to the first Telnet client. If not, flushing must be activated by the client. | Wireless readers. |
| COM.BUFFER-DATA | Communication | PUBLIC | 4.2.1 | SET|GET | state |
[ON|OFF] | enable/disable | Offline buffering. | Wireless readers. |
| COM.BUFFER-MODE | Communication | PUBLIC | 4.2.2 | SET|GET | int |
[0-1] |
0: Multiple 1: Single |
Sets or gets the offline buffering mode. | Wireless DM8000 readers. |
| COM.BUFFER-RESET | Action | PUBLIC | 4.2.1 | Clears the content of the offline buffer. | DM8050, DM8600 and MX-1000. | ||||
| COM.BUFFER-START-SEND | Action | PUBLIC | 4.2.1 | Valid if auto-flush is off. Activates buffer data output over Telnet channels (and flushes buffered codes). Data output is stopped every time when all Telnet channels are disconnected. | DM8050, DM8600 and MX-1000. | ||||
| COM.COMMUNICATIONS-MODULE | Communication | PUBLIC | 4.2.0 | GET | type |
[0-3] |
0: Serial 1: Ethernet 2: Wireless 3: Bluetooth |
Returns the type of communication module being used. | MX-1000 and DM8000 series readers. |
| COM.DATA-BITS | Communication | PUBLIC | 3.0.0 | SET|GET | bits |
[7,8] | ALL except for MX-1000. | ||
| COM.DMCC-RESPONSE | Communication | PUBLIC | 3.0.0 | SET|GET | mode |
[0|1] |
0: Silent (default) 1: Extended |
DMCC response format. | ALL |
| COM.MULTI-PORT | Communication | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable daisy chaining of readers so they share one COM port. | Fixed mount readers. |
| COM.PARITY | Communication | PUBLIC | 3.0.0 | SET|GET | parity |
[0-4] |
0: None 1: Even 2: Odd 3: Space 4: Mark |
All except for MX-1000 and MX-1502. | |
| COM.PROTOCOL | Communication | PUBLIC | 5.7.0 | SET|GET | type |
0..1 |
0: Off 1: RTS/CTS |
Sets hardware handshake type of serial port. | Devices with RTS/CTS lines |
| COM.RS232-ENABLE-PAUSE | Communication | PUBLIC | 5.5.0 | SET|GET | mode |
ON/OFF | Enable/disable pause in output data stream. | DM300 series readers, DM60, DM50, DM70, DM474 | |
| COM.RS232-INTERCHAR-DELAY | Communication | PUBLIC | 5.5.0 | SET|GET | us |
[0-5000] | milliseconds | Sets or gets the internal delay between sending characters to the serial port. | DM300 series readers, DM60, DM50, DM70, DM360 series readers, DM474, DM503 |
| COM.RS232-ROUTE | Communication | PUBLIC | 4.2.1 | SET|GET | value |
[0-1] |
0: base station 1: associated reader |
Controls to which device RS-232 communication is routed. | DM8000 series wireless readers. |
| COM.SCRIPT | Communication | PUBLIC | 5.5.0 | SET|GET | num-bytes |
GET: Retrieves the current communication script. SET: Uploads a communication script. | Fixed-mount readers. | ||
| COM.SCRIPT-ENABLED | Communication | PUBLIC | 5.5.0 | SET|GET | bool |
Enables/disables communication scripting or retrieves current state. | Fixed-mount readers. | ||
| COM.SCRIPT-ERROR | Communication | PUBLIC | 5.5.0 | GET | message |
script error message | Get the error message for the Custom Communication protocol script | Fixed-mount readers. | |
| COM.STOP-BITS | Communication | PUBLIC | 3.0.0 | SET|GET | bits |
[1-2] | ALL except for MX-1000. | ||
| COM.USB-COMPATIBILITY-MODE | Communication | PUBLIC | 3.0.0 | SET|GET | legacy |
[ON|OFF] |
ON: use pre-3.5.0 driver OFF: default |
Controls USB driver. Reboot is required. |
DM50, DM70 and DM8000 series readers. |
| COM.USB-HID-ONLY | Communication | PUBLIC | 5.4.0 | SET|GET | state |
[ON|OFF] | enable/disable | When enabled, the base station will appear as a single USB Keyboard device on its USB port, instead of a composite device. | DM8000 base station G2 |
| COM.USB-MODE | Communication | PUBLIC | 4.2.1 | SET|GET | type |
[0-1] |
0: USB COM 1: USB HID |
Controls USB based communication channels. | DM50, DM60, DM70, MX-1000, MX-1502 and DM8000 series readers. |
| COM.USB-RE-ENUMERATE-ON-START | Communication | PUBLIC | 5.5 | SET|GET | state |
[ON|OFF]
[ON|OFF] |
enable/disable
ON: USB 1.1 mode OFF: USB 2.0 mode |
Feature to re-enumerate the COM port after firmware is started. | DM8000 series readers. |
| COM.USB-REQUIRE-DTR | Communication | PUBLIC | 5.5.0 | SET|GET | state |
[ON|OFF] [ON|OFF] | enable/disable Enable/Disable | Turns the requirement to assert DTR signal during USB communication On or Off. | DM8050 |
| COM.USB-SPEED | Communication | PUBLIC | 4.2.1 | SET|GET | int |
[ON|OFF] |
ON: USB 1.1 mode OFF: USB 2.0 mode |
Forces the USB into full speed mode. | Every reader connected through USB except MX-1000. |
| COM.WAKEUP | Communication | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Wakeup Message. | ALL |
| COM.XLATEPRNT | Communication | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Translate unprintable characters that are embedded in a symbol. The translated result is output over the connection (for example, COM, USB, Ethernet, USB-KEYBOARD). Note that Data Formatting leading and terminating text are not translated. The characters translated are ASCII values between 0x00 and 0x1F. For example, 0x00 = <NUL>, 0x04 = <EOT>, 0x0a = <LF>, 0x0d = <CR>. | ALL |
| CONFIG-BACKUP.ENABLE | Action | PUBLIC | 5.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enables automatic device configuration backup. | Ethernet readers. DM8000 series wireless readers also support FTP if the base station is connected through Ethernet. |
| CONFIG-BACKUP.IP-ADDRESS | Action | PUBLIC | 5.0.0 | SET|GET | string |
IP address of the Cognex Explorer FTP service. Uses dotted decimal form, such as "192.168.23.42". |
Ethernet readers. DM8000 series wireless readers also support FTP if the base station is connected through Ethernet. | ||
| CONFIG-BACKUP.PASSWORD | Action | PUBLIC | 5.0.0 | SET|GET | string |
Password used to log in to Cognex Explorer FTP service. | Ethernet readers. DM8000 series wireless readers also support FTP if the base station is connected through Ethernet. | ||
| CONFIG-BACKUP.PORT | Action | PUBLIC | 5.0.0 | SET|GET | port |
[0-65535] | Port number of the Cognex Explorer FTP service. | Ethernet readers. DM8000 series wireless readers also support FTP if the base station is connected through Ethernet. | |
| CONFIG-BACKUP.SERVER-TYPE | Communication | PUBLIC | 5.5.0 | SET|GET | type |
[0-1] |
0: Generic 1: Mitsubishi GOT |
Configuration backup server type. | DM474, DM503 and DM300 series readers. |
| CONFIG-BACKUP.USER-NAME | Action | PUBLIC | 5.0.0 | SET|GET | string |
User name used to log in to the Cognex Explorer FTP service. | Ethernet readers. DM8000 series wireless readers also support FTP if the base station is connected through Ethernet. | ||
| CONFIG.DEFAULT | Action | PUBLIC | 3.0.0 | Resets the device’s configuration settings to factory defaults. Device identification and communications settings are not changed. | ALL | ||||
| CONFIG.EXPORT | Action | PUBLIC | 5.7.0 | Exports a human readable version of the current reader configuration. | ALL | ||||
| CONFIG.LOAD | Action | PUBLIC | 4.4.0 | num-bytes |
Load Configuration from communication channel. Make sure you use a robust communications channel (for example, Ethernet) because this command does not have error checking or retry support and might cause the device to hang. | ALL | |||
| CONFIG.RESTORE | Action | PUBLIC | 3.0.0 | Restores Configuration from Non-Volatile Memory. | ALL | ||||
| CONFIG.SAVE | Action | PUBLIC | 3.0.0 | Saves Configuration to Non-Volatile Memory. | ALL | ||||
| CONFIG.SEND | Action | PUBLIC | 3.0.0 | Send device configuration to communication channel. | ALL | ||||
| CQ | Code Quality | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable Code Quality. Code Quality Measurements require reader calibration and the Verification Feature Key. |
DM8600V |
| CQ.CALIB-DATE | Code Quality | PUBLIC | 3.0.0 | GET | Device Code Quality Calibration Date. | DM8600V | |||
| CQ.ILLUMINATION | Code Quality | PUBLIC | 3.0.0 | SET|GET | illumination-option state |
[0-4] [ON|OFF] |
0: Direct on axis 1: 30-deg All Quadrants 2: 30-deg E-W Quadrants 3: 30-deg N-S Quadrants 4: Custom enable/disable |
Code Quality Illumination Option. | DM8600V |
| CQ.METRICS | Code Quality | PUBLIC | 3.0.0 | SET|GET | metric |
[0-3] |
0: AIM-DPM/ISO/IEC TR 29158 1: ISO/IEC 15415 2: AS9132 Laser-etch 3: AS9132 Dot-peen |
Code Quality Enabled Metrics. | DM8600V |
| CQ.MINPASS | Code Quality | PUBLIC | 3.0.0 | SET|GET | metric min-pass |
[0-1] [0-4] |
0: AIM-DPM/ISO/IEC TR 29158 1: ISO/IEC 15415 0: F 1: D 2: C 3: B 4: A |
Code Quality Minimum Passing Grade. Determines the threshold for "validation failure action" including beep and configured line output. |
DM8600V |
| CQ.PROCESSM | Code Quality | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Code Quality Process Control Metrics. | DM8600V |
| CQ.RESET-CALIBRATION | Code Quality | PUBLIC | 3.3.0 | Invalidates code quality calibration data. Reboot is required. |
DM8600V | ||||
| CQ.UNITS | Code Quality | PUBLIC | 3.0.0 | SET|GET | option |
[0-3] |
0: mils 1: mm 2: inches 3: pixels |
Code Quality Units. | DM8600V |
| CUSTOM-CMD.COMMAND-FOOTER | Communication | PUBLIC | 3.2.0 | SET|GET | string |
End of the string to be echoed. See the Overview topic for formatting requirements for the string argument. |
Fixed mount readers. | ||
| CUSTOM-CMD.COMMAND-HEADER | Communication | PUBLIC | 3.2.0 | SET|GET | string |
Start of the string to be echoed. | Fixed mount readers. | ||
| CUSTOM-CMD.ECHO | Communication | PUBLIC | 3.2.0 | SET|GET | state |
[ON|OFF] | enable/disable | Indicates if characters received between a COMMAND-HEADER and COMMAND-FOOTER are echoed. | Fixed mount readers. |
| CUSTOM-CMD.TRIGGER | Communication | PUBLIC | 3.2.0 | SET|GET | state |
[ON|OFF] | enable/disable | Indicates if reader will respond to the TRIGGER-ON or TRIGGER-OFF string. | Fixed mount readers. |
| CUSTOM-CMD.TRIGGER-OFF | Communication | PUBLIC | 3.2.0 | SET|GET | string |
String that will stop a trigger. See the Overview topic for formatting requirements for the string argument. |
Fixed mount readers. | ||
| CUSTOM-CMD.TRIGGER-ON | Communication | PUBLIC | 3.2.0 | SET|GET | string |
String that will start a trigger. See the Overview topic for formatting requirements for the string argument. |
Fixed mount readers. | ||
| DATA.RESULT-ENCODING | Communication | PUBLIC | 3.1.0 | SET|GET | encoding |
[0|1] |
0: ASCII (default) 1: Base64 |
Result string encoding. | ALL |
| DATA.RESULT-TYPE | System | PUBLIC | 5.5.0 | SET|GET | bit-field |
[0,1,512] |
0 = None 1 = Result 512 = MS test response |
Controls automatic, result transmitted from reader. Default bits are 1 and 512 (which is 513). | ALL |
| DATABAR.EXPANDED | Symbology | PUBLIC | 3.4.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable Databar expanded. | ALL |
| DATABAR.GROUP | Symbology | PUBLIC | 3.4.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable Databar group. | ALL |
| DATABAR.LIMITED | Symbology | PUBLIC | 3.4.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable Databar limited. | ALL |
| DATAMATRIX.ALGORITHM-VERSION | Symbology | PUBLIC | 3.5.3 | SET|GET | version |
[0-2] |
0: speed preferred 1: yield preferred 2: extended |
IDQuick Usage Type. | Fixed mount readers except for DM300L, DM503L, and DM503QL. 2 (extended) is supported by DM50, DM60, DM70, DM150, DM260. |
| DATAMATRIX.DAMAGE | Decoder | PUBLIC | 5.5.0 | SET|GET | damage level |
[2,4] |
2: moderate 4: extreme |
Set Extreme to enable PowerGrid. | DM300 series readers, DM360, DM474 readers |
| DATAMATRIX.EXTREME-PRINT-GROWTH | Symbology | PUBLIC | 3.4.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable extreme print growth for DataMatrix symbols. | ALL except for DM50, DM60, DM70, DM300, DM503, DM8050 and DM8600. |
| DATAMATRIX.PRINT-DEFORMATION | Symbology | PUBLIC | 5.2.0 | SET|GET | state |
[0|1] |
0: Minimal 1: Moderate |
Sets the IDMax Properties. | DM300, DM474, DM503. |
| DATAMATRIX.QUALITY-METRICS | Decoder | PUBLIC | 4.5.0 | SET|GET | type |
[0-3] |
0: none 1: AIM DPM 2: ISO 15415 3: SEMI T10 |
Code quality metrics for DataMatrix. | ALL |
| DATAMATRIX.SYMBOL-DIFFICULTY | Symbology | PUBLIC | 5.1.0 | SET|GET | int |
[0-2] |
0: Easy 1: Medium 2: Hard |
Level of DataMatrix code symbol difficulty. | DM8600. |
| DATAMATRIX.TRAINED-FLEX-GRID | Symbology | PUBLIC | 5.2.0 | SET|GET | state |
[ON|OFF] | enable/disable | Switches the Trained Code Property "Flexible Grid Size". | DM300, DM474, DM503. |
| DATAMATRIX.TRAINED-IGNORE-POLARITY | Symbology | PUBLIC | 5.2.0 | SET|GET | state |
[ON|OFF] | enable/disable | Switches the Trained Code Property "Ignore Polarity". | DM300, DM474, DM503. |
| DATAMATRIX.TRAINED-MODEL | Decoder | PUBLIC | 5.5.0 | SET|GET | rows columns module-size polarity mirrored |
[8-144] [8-144] [1-1000] [0-2] [ON|OFF] |
Number of rows Number of columns Module size * 10 0: dark-on-light 1: light-on-dark 2: either ON: mirrored OFF: not mirrored |
Train Data Matrix from the given parameters without needing to capture an image. | Fixed-mount readers |
| DATAMATRIX.USAGE | Symbology | PUBLIC | 3.0.0 | SET|GET | Usage Type |
[0-1] |
0: Default 1: High speed ink jet mode |
IDMax Usage Type. | ALL except for DM50, DM60, DM70, DM300, DM503. |
| DECODER.1D-DATA-STITCH | Decoder | PUBLIC | 5.5.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enables/disables 1D data-stitching. Requires the 1DDataStitching feature key. |
DM70, DM150, DM260, DM300 series readers, DM474, DM503. |
| DECODER.1D-EXTENDED-RESOLUTION | Decoder | PUBLIC | 5.5.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enables/disables the 1D extended resolution decoding method. Requires the 1DExtendedRes feature key. |
DM70, DM150, DM260, DM300 series readers, DM474, DM503. |
| DECODER.1D-LEARN-ORIENT | Decoder | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Learn Orientation of 1D Symbols. | Fixed mount readers. |
| DECODER.1D-MINIMUM-DECODES | Symbology | PUBLIC | 5.2.0 | SET|GET | int |
[0-5] | Minimum number of decoded scans to report a confident decoding (to prevent misread). | ALL | |
| DECODER.1D-QUALITY-METRICS | Decoder | PUBLIC | 5.2.0 | SET|GET | mode |
[0-1] |
0: none 1: 1D readability |
Enables/disables 1D Process Control Metrics. | ALL |
| DECODER.1D-SHORT-QUIET-ZONE | Decoder | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | When ON, the reader is tolerant with non-standard (i.e. short) quiet zones. | ALL |
| DECODER.1D-SYMBOL-ORIENTATION | Decoder | PUBLIC | 4.1 | SET|GET | orientation |
[0-3] |
0: Omnidirectional 1: Ladder and Picket Fence (default) 2: Ladder 3: Picket Fence |
Sets or gets the orientation at which codes can be found. Omnidirectional requires the Omnidirectional feature key. | DM50, DM60, DM70, DM474, DM503, MX-1000, MX-1502 and DM300 series readers. DM503L readers support only 2: Ladder and 3: Picket Fence. |
| DECODER.1D-USAGE | Decoder | PUBLIC | 3.0.0 | SET|GET | usage |
[0-1] |
0: Standard 1: Extended |
1D Symbology Usage Type. | Fixed mount readers. |
| DECODER.ALLOW-ALL-MST-RESULTS | Decoder | PUBLIC | 5.7.3 | SET|GET | state |
[ON|OFF] |
ON: enable OFF: disable |
Enables or disables re-read delay processing for slave results. | DM300 series readers, DM474, DM503, DM70, DM150, DM260 |
| DECODER.CENTERING-WINDOW | Decoder | PUBLIC | 6.0.0 | SET|GET | center x perc, center y perc, size x perc, size y perc |
[0-100] | Percentage | Location and size of centering window as a percentage of the sensor size. | DM50, DM60, DM70, DM150 DM260, DM300, DM360, DM474, MX-1000 series |
| DECODER.DISPLAY-TARGET | Decoder | PUBLIC | 6.0.0 | SET|GET | state |
[ON|OFF] | Enable/Disable | Displays centering window graphics. | DM50, DM60, DM70, DM150 DM260, DM300, DM360, DM474, MX-1000 series |
| DECODER.EFFORT | Decoder | PUBLIC | 5.7.1 | SET|GET | int |
[0-5] | Sets the effort level used by the decoding algorithms. Default is 2. | All | |
| DECODER.MAC-SCAN-TIMEOUT | Decoder | PUBLIC | 5.7.1 | SET|GET | int |
[0-60] | DM50, DM60, DM70, DM150 DM260, DM300, DM360, DM474, MX-1000, MX1502 | ||
| DECODER.REREAD-MODE | Decoder | PUBLIC | 4.4.0 | SET|GET | mode |
[0-1] |
0: last read 1: first read |
Code re-reading delay relative to either the first read or the last. | DM50, DM60, DM70, DM474, DM503, DM300 series readers, DM8050 and DM8600. |
| DECODER.REREAD-NEVER2X | Decoder | PUBLIC | 5.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Never read the same code twice. All trigger modes, e.g. Multicode Reading. |
ALL |
| DECODER.REREAD-NOT-LAST-N | Decoder | PUBLIC | 5.5 SR3 | SET|GET | int |
[0-100] |
0: no restriction 1-100 Define N |
Do not read code if this code was read within the last N reads. | All |
| DECODER.REREAD-TIME | Decoder | PUBLIC | 4.4.0 | SET|GET | ms |
[0-10000] | Milliseconds | Code re-reading delay in milliseconds. | ALL |
| DECODER.ROI | Decoder | PUBLIC | 3.0.0 | SET|GET | left (multiple of 8) right (multiple of 8) top (multiple of 4) bottom (multiple of 4) |
[0...] [left+64...] [0...] [top+64...] |
left of the ROI rectangle right of the ROI rectangle top of the ROI rectangle bottom of the ROI rectangle |
Decoder Region of Interest. Image Region examined by decoder for enabled symbols. Pixel coordinates are relative to the upper left corner of the displayed image. Left < Right and Top < Bottom. Values must not be outside the specified CAMERA.FOV settings. |
ALL |
| DECODER.TARGET-DECODING | Decoder | PUBLIC | 5.7.1 | SET|GET | state |
[ON|OFF] | enable/disable | Enable target decoding, where the reader attempts to symbols that lie only under the aiming dots. | MX-1000, MX-1502 series readers. |
| DECODER.TIMEOUT | Decoder | PUBLIC | 3.0.0 | SET|GET | ms |
[0-10000] | milliseconds | Decoder Timeout. Maximum allowed decode time. |
Fixed mount readers. |
| DECODER.USE-CENTERING | Decoder | PUBLIC | 6.0.0 | SET|GET | state |
[ON|OFF] | Enable/Disable | Only reads codes within the centering window. | DM50, DM60, DM70, DM150, DM260, DM300, DM360, DM474, MX-1000 series |
| DEVICE-LOG.CLEAR | Action | PUBLIC | 5.2.0 | This command clears the device log. | DM50, DM60, DM70, DM474, DM503, DM300 series readers, DM8050, DM8600, MX-1000 and MX-1502. | ||||
| DEVICE.BACKUP | Action | PUBLIC | 3.3.0 | Send encrypted backup file (.cdc) to the PC. | ALL | ||||
| DEVICE.DEFAULT | Action | PUBLIC | 3.0.0 | Resets all device settings to factory defaults. This command reboots the device. | ALL | ||||
| DEVICE.DESCRIPTION | System | PUBLIC | 5.7.0 | SET|GET | state |
[0-127] | description | Store device description for inventory management. | ALL |
| DEVICE.FEATURE-KEYS | System | PUBLIC | 3.0.0 | GET | Device Feature Keys. | ALL | |||
| DEVICE.FIRMWARE-VER | System | PUBLIC | 3.0.0 | GET | Device Firmware Version. | ALL | |||
| DEVICE.LOG | Action | PUBLIC | 4.4.0 | GET | Get the device log of error and exception conditions such as missed triggers and trigger overruns. | DM50, DM60, DM70, DM474, DM503, DM300 series readers, DM8050 and DM8600. | |||
| DEVICE.MAC-ADDRESS | Communication | PUBLIC | 3.3.0 | GET | Reader's MAC address. | Ethernet readers. | |||
| DEVICE.NAME | System | PUBLIC | 3.0.0 | SET|GET | string |
Device Name. MX + the last six digits of DEVICE.SERIAL-NUMBER | ALL | ||
| DEVICE.RESTORE | Action | PUBLIC | 3.3.0 | file size |
Transmits backup file (.cdc) to the reader. File size is in bytes. File data follows footer. | ALL | |||
| DEVICE.SERIAL-NUMBER | System | PUBLIC | 3.0.0 | GET | Device Serial Number. | ALL | |||
| DEVICE.SSID | Communication | PUBLIC | 4.2.0 | SET|GET | string |
Network name. | Wireless readers. | ||
| DEVICE.TIMEZONE | Action | PUBLIC | 5.7.0 | SET|GET | timezone |
Location or POSIX timezone | Get or set the timezone for local time. | All | |
| DEVICE.TYPE | System | PUBLIC | 3.0.0 | GET | Device Type. | ALL | |||
| DMCC.RESET | Action | PUBLIC | 4.4.0 | When sent, the DMCC resets the following DMCC back to default: COM.DMCC-RESPONSE, COM.DMCC-CHECKSUM, COM.DMCC-HEADER, DATA.RESULT-TYPE, DATA.RESULT-ENCODING, DATA.RESULT-ALWAYSSEND, DATA.IMAGE-TYPE. | ALL | ||||
| DMCC.SAVE | Action | PUBLIC | 4.4.0 | Saves DMCC connection settings. It also saves the status for a new connection session for the following DMCC: COM.DMCC-RESPONSE, COM.DMCC-CHECKSUM, COM.DMCC-HEADER, DATA.RESULT-TYPE, DATA.RESULT-ENCODING, DATA.RESULT-ALWAYSSEND, DATA.IMAGE-TYPE. | ALL | ||||
| DOTCODE.MAXIMUM-COLUMNS | Decoder | PUBLIC | 5.4.0 | SET|GET | int |
[11-128] | The default is 128. | DM300 series readers, DM474, DM8050X and DM8600. | |
| DOTCODE.MAXIMUM-ROWS | Decoder | PUBLIC | 5.4.0 | SET|GET | int |
[5-128] | The default is 32. | DM300 series readers, DM474, DM8050X and DM8600. | |
| DOTCODE.MINIMUM-COLUMNS | Decoder | PUBLIC | 5.4.0 | SET|GET | int |
[11-128] | The default is 16. | DM300 series readers, DM474, DM8050X and DM8600. | |
| DOTCODE.MINIMUM-ROWS | Decoder | PUBLIC | 5.4.0 | SET|GET | int |
[5-128] |
The default is 6. |
DM300 series readers, DM474, DM8050X and DM8600. | |
| DOTCODE.POLARITY | Decoder | PUBLIC | 5.4.0 | SET|GET | int |
[0-2] |
0: Dark on Light 1: Light on Dark 2: Either |
DM300 series readers, DM474, DM8050X and DM8600. | |
| DVALID.DOD-EXEID | Data Validation | PUBLIC | 3.0.0 | SET|GET | string |
expected-EID | DoD Expected Enterprise ID (EID). | ALL | |
| DVALID.DOD-EXPN | Data Validation | PUBLIC | 3.0.0 | SET|GET | string |
expected-PN | DoD Expected Part Number. See the Overview topic for formatting requirements for the string argument. |
ALL | |
| DVALID.DODCNSTRT | Data Validation | PUBLIC | 3.0.0 | SET|GET | construct |
[0-3] |
0: Any 1: Construct #1 2: Construct #2 3: Equivalent |
Data Validation DoD Construct. | ALL |
| DVALID.FAIL-ACTION | Data Validation | PUBLIC | 3.0.0 | SET|GET | action |
[0-3] |
0: Transmit "Validation Failure" 1: Transmit "Validation Failure" + decoded string 2: Transmit annotated decode string 3: Transmit nothing |
Data Validation Failure Action. | ALL |
| DVALID.FAIL-XMT-CRLF | Data Validation | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Data Validation Transimit CRLF on Failure. | ALL |
| DVALID.GS1-FORMAT | Data Validation | PUBLIC | 3.4.0 | SET|GET | string |
GS1 format string | Set GS1 format string. | ALL | |
| DVALID.ISO-CONSTRUCT | Data Validation | PUBLIC | 3.0.0 | SET|GET | construct |
[0-1] |
0: ISO 15434 1: ISO 15434 & ISO 15418 |
ISO Construct. | ALL |
| DVALID.MATCH-STRING | Data Validation | PUBLIC | 3.0.0 | SET|GET | string |
match-string | Data Validation Match-String. See the Overview topic for formatting requirements for the string argument. |
ALL | |
| DVALID.MATCH-STRING-PARAMS | Data Validation | PUBLIC | 3.0.0 | SET|GET | increment start length step no-read validation-fail |
[ON|OFF]
[0-*] [1-*] [-2|-1|0|1|2] [ON|OFF] [ON|OFF] |
enable/disable
start position of numerical match number of digits increment enable/disable update on no-read enable/disable update on validation failure |
Data Validation Match-String Parameters. | ALL |
| DVALID.PATTERN | Data Validation | PUBLIC | 3.0.0 | SET|GET | string |
pattern-string | Data Validation Pattern. Regexp Data Validation. See the Overview topic for formatting requirements for the string argument. |
ALL | |
| DVALID.PROG-TARG | Data Validation | PUBLIC | 4.4.0 | SET|GET | category |
[1-5] |
1: DataMatrix 2: QR Code/MaxiCode/AztecCode 3: Linear/ Postal/ Stacked 4: VeriCode® 5: DotCode |
Data Validation Programming Target. Data Validation Symbology Set to be modified by subsequent commands. Once issued, this command changes the subsequent behavior of the reader. |
ALL |
| DVALID.TYPE | Data Validation | PUBLIC | 3.0.0 | SET|GET | type |
[0-5] |
0: None 1: DoD UID 2: ISO 3: Pattern 4: Match String 5: GS1 |
ALL | |
| EAN-UCC.CC-C | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable or disable Composite Code C. | ALL |
| EAN-UCC.XMTMODE | Symbology | PUBLIC | 3.0.0 | SET|GET | mode |
[0-1] |
0: Standard (linear & 2D) 1: Linear only |
EAN-UCC Transmit mode. | ALL |
| ENCODER.COUNT | IO | PUBLIC | 4.1.0 | SET|GET | value |
[0-2 billion] | value to set | Gets the encoder count or sets it to the specified value. | Fixed-mount readers |
| ENCODER.DISTANCE-TO-OUTPUT | IO | PUBLIC | 4.1.0 | SET|GET | int |
0-1000000 mm |
Default: 0 Min: 0 Max: 1000000 Step: 1 |
Sets the output distance from the trigger on the sensor. | DM300 series readers, DM474. |
| ENCODER.DOUBLE-RATE | IO | PUBLIC | 5.7.0 | SET|GET | boolean |
[ON|OFF] | Edge detection | If set to ON, Encoder will count both edges on the Encoder Input line. If set to OFF, Encoder will count only the selected edge. | DM503 |
| ENCODER.DOUBLE-RATE | IO | PUBLIC | 6.1.6 | SET|GET | boolean |
[ON|OFF] | Edge detection | If set to ON, Encoder will count both edges on the Encoder Input line. If set to OFF, Encoder will count only the selected edge. | DM360, DM370, and DM470 series readers. |
| ENCODER.FLUSH | IO | PUBLIC | 4.1.0 | Flushes all encoder actions. | DM474, DM503 and DM300 series readers. | ||||
| ENCODER.MODE | IO | PUBLIC | 5.5.0 | SET|GET | value |
[0-4] |
0: Encoder A signal counts up, Encoder B signal counts down. 1: Encoder A signal counts up, Encoder B signal counts down. 2: Encoder A and Encoder B form quadrature (SIN/COS) signal, 1 count per cycle. 3: Encoder A and Encoder B form quadrature (SIN/COS) signal, 2 counts per cycle. 4: Encoder A and Encoder B form quadrature (SIN/COS) signal, 4 counts per cycle. |
Encoder mode. Sets the mode the encoder signals are interpreted if the Encoder Direction pin is defined. | Fixed-mount readers |
| ENCODER.RESET | IO | PUBLIC | 5.5.0 | Resets the encoder count to 0 and clears all encoder related events. | Fixed-mount readers | ||||
| ENCODER.RESOLUTION | IO | PUBLIC | 4.1.0 | SET|GET | int |
0-1000000 um |
Default: 5000 Min: 0 Max: 1000000 Step: 1 |
Sets the distance per pulse of the encoder. | DM474, DM503, and DM300 series readers. |
| ERROR-LED.ON-TIME-MS | System | PUBLIC | 5.7.0 | SET|GET | duration |
Sets the duration for the Error LED in ms. Use 0 for unlimited duration. | All devices with an error LED. | ||
| ETHERNET-IP.ENABLED | Communication | PUBLIC | 3.3.0_cr1 | SET|GET | state |
[ON|OFF] | enable/disable | Enabled or disabled EtherNet/IP communications. | Ethernet readers. The DM8000 series wireless readers also support this protocol if the base station is connected through Ethernet. In the case of a Bluetooth connection, the command has to be sent to the base station, not to the reader. |
| FILTER.IMAGE-TO-USE-SYMBOL | Decoder | PUBLIC | 4.3.0 | SET|GET | symbology input |
[1-5] [0-1] |
1: DataMatrix 2: QR Code/MaxiCode/AztecCode 3: Linear/ Postal/ Stacked 4: VeriCode® 5: DotCode 0: original image 1: filtered image |
Sets or gets which type of symbology should be filtered or not. AztecCode is only supported on the DM503 and DM300 series readers. |
DM50, DM60, DM70, DM150, DM260, DM300 series readers, DM474. |
| FILTER.NOREAD-IMAGE | Decoder | PUBLIC | 4.3.0 | SET|GET | symbology |
[0-5] |
0: Any 1: DataMatrix 2: QR Code/MaxiCode/AztecCode 3: Linear/ Postal/ Stacked 4: VeriCode® 5: DotCode |
Sets or gets if the symbology selected should be filtered if the image is no-read. AztecCode is only supported on the DM503 and DM300 series readers. |
DM50, DM60, DM70, DM150, DM260, DM300 series readers, DM474. |
| FILTER.STACK | Decoder | PUBLIC | 4.3.0 | SET|GET | step method value1 value2 value3 |
[1-4] [0-11] [0-255] |
Filter step 0: no filtering 1: equalize 2: stretch 3: low pass 4: dilate 5: erode 6: open 7: close 8: auto stretch 9: optical density 10: invert 11: median method parameter |
The first value sets the order of the filter steps. Filter step 1 is the first step, filter step 2 is the second, and so on. The second value sets the filter to be used. The third value means the additional properties that you can set for the given filter. You cannot configure the whole stack with one statement, but each on its own.The following example: SET FILTER.STACK 2 2 0 100 0 sets the second step in the filter, for stretch from 0 to 100, leaving the third value unused (0).The following example: GET FILTER.STACK 3 (for the third filter) returns 5 4 3 meaning that filter number 5, that is, erode is on, with parameters 4, 3. | DM50, DM60, DM70, DM150, DM260, DM300 series readers, DM474. |
| FOCUS.DISTANCE | Camera | PUBLIC | 4.0.0 | SET|GET | int |
Distance in mm from the front of the camera to the part. This command returns the value only if Focus Steps is set to 0, otherwise you need to use FOCUS.SWEEP-RANGE instead. |
DM300 series readers, DM474. | ||
| FOCUS.EXTENDED-RANGE | Camera | PUBLIC | 5.7.0 | GET | value |
[ON|OFF] | Extended Focus Range | Indicates that the reader operates in the extended focus range of ON. In this mode GET FOCUS.DISTANCE will return with an error. | Fixed-mount readers with Liquid Lens |
| FOCUS.FEEDBACK | Camera | PUBLIC | 4.3.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enables focus feedback. | DM474, DM503 and DM300 series readers. |
| FOCUS.POWER | Camera | PUBLIC | 5.7.0 | SET|GET | optical power |
[-6.0 .. 20.00] | Optical Power in Diopters | Conrols the optical power of the liquid lens. The actual range is dependent on the hardware and on manufacturing tolerances. | Fixed-mount readers with Liquid Lens |
| FOCUS.PRECISION | Camera | PUBLIC | 5.7.0 | SET|GET | settle mode |
[0..1] |
0: normal focus control 1: precise focus control |
Controls the liquid lens focus control between normal focus control and slow but more precise mode. | Fixed mount readers with a liquid lens. |
| FOCUS.PROGRESS | Camera | PUBLIC | 5.7.0 | SET|GET | enable |
[ON|OFF] |
ON: focus progress on OFF: focus progress off |
Enable transfer of intermittent focus images during adjust focus. | Fixed mount readers with a liquid lens. |
| FOCUS.SWEEP-POWER | Camera | PUBLIC | 5.7.3 | SET|GET | Optical Power for near distance Optical Power for far distance |
liquid lens specific liquid lens specific |
Optical Power in Diopters Optical Power in Diopters |
Returns near (first value) and far (second value) optical power values. | Readers with Liquid Lens. |
| FOCUS.SWEEP-RANGE | Camera | PUBLIC | 3.6.0 | SET|GET | DM8000 DM300 |
[0-500] [0-500] [40-500] [40-500] |
low sweep range high sweep range low sweep range high sweep range |
Defines the sweep range to be used for focusing. Low must be less than high. The low value is ignored if FOCUS.SWEEP-STEPS is set to 0. | DM70, DM260, DM300 series, DM474 and DM8000 series readers. |
| FOCUS.SWEEP-STEPS | Camera | PUBLIC | 3.6.0 | SET|GET | value |
[0-8] | number of steps to divide the sweep range | Sets the number of steps the sweep range should be divided by. If steps is set to 0 only the high sweep range value is used. | DM70, DM260, DM474, DM8000 series and DM300 series readers. |
| FORMAT.ADVANCED | Data Formatting | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable Data Formatting Advanced Mode. Advanced Mode Formatting Enables: Regexp Pattern Substitution. |
ALL |
| FORMAT.CRLF-END | Data Formatting | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Data Formatting CRLF Terminator. Requires Data Formatting Standard Mode Enabled. |
ALL |
| FORMAT.DELIMITER | Data Formatting | PUBLIC | 3.0.0 | SET|GET | delimiter-option |
[0-5] |
0: none 1: space 2: comma 3: tab 4: label 5: xml |
Data Formatting Delimiter. Sets the delimeter between Data Formatting Tokens. Requires Data Formatting Standard Mode Enabled. |
ALL |
| FORMAT.DISCARD-UNMATCHED | Data Formatting | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Data Formatting Discard Unmatched Data. | ALL |
| FORMAT.MODE | Data Formatting | PUBLIC | 4.5.0 | SET|GET | mode |
[0-1] |
0: basic formatting 1: script-based formatting |
Specifies data formatting mode. By default, basic formatting is the set formatting mode. |
DM50, DM60, DM70, DM474, DM503, MX-1000, MX-1502 and DM300 series readers. |
| FORMAT.MULTICODE-DELIMITER | Data Formatting | PUBLIC | 3.2.0 | SET|GET | type |
[0-6] |
0: none 1: space 2: comma 3: tab 4: label 5: xml 6: CRLF |
Data Formatting Delimiter. Sets the delimiter between codes in a multicode result. |
Fixed mount readers. |
| FORMAT.PROG-TARG | Data Formatting | PUBLIC | 3.2.0 | SET|GET | category |
[0-5] |
0: Universal 1: DataMatrix 2: QR Code/MaxiCode/AztecCode 3: Linear/ Postal/ Stacked 4: VeriCode® 5: DotCode |
Data Formatting Programming Target. Data Formatting Symbology Set to be modified by subsequent commands. Once issued, it changes the subsequent behavior of the reader. AztecCode is only supported on the DM503 and DM300 series readers. |
ALL |
| FORMAT.REGEXP | Data Formatting | PUBLIC | 3.0.0 | SET|GET | string |
regular expression string | Data Formatting Regular Expression. Requires Data Formatting Advanced Mode Enabled. See the Overview topic for formatting requirements for the string argument. |
ALL | |
| FORMAT.SCRIPT | Data Formatting | PUBLIC | 5.2.0 | SET|GET | num-bytes |
Set: loads the script from the host to the reader. Get: sends the script from the reader to the host. | DM474, DM503, MX-1000, MX-1502 and DM300 series readers. | ||
| FORMAT.STANDARD | Data Formatting | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable Data Formatting Standard Mode. Standard Mode Formatting Enables: Leading Text, Data, Data Delimeter, Terminating Text, Terminating CRLF. |
ALL |
| FORMAT.TEXT-BEGIN | Data Formatting | PUBLIC | 3.0.0 | SET|GET | string |
leading output text | Data Formatting Leading Text. Requires Data Formatting Standard Mode Enabled. See the Overview topic for formatting requirements for the string argument. |
ALL | |
| FORMAT.TEXT-END | Data Formatting | PUBLIC | 3.0.0 | SET|GET | string |
trailing text | Data Formatting Trailing Text. Requires Data Formatting Standard Mode Enabled. See the Overview topic for formatting requirements for the string argument. |
ALL | |
| FORMAT.TOKEN | Data Formatting | PUBLIC | 3.0.0 | SET|GET | string |
token string | Data Formatting Standard Data. Regardless of the parameters given to GET FORMAT.TOKEN, it will return the current data formatting token string contained in the Standard Formatting window pointed to by the current value of GET FORMAT.PROG-TARG. See Data Formatting Token Table for available elements. See the Overview topic for formatting requirements for the string argument. |
ALL | |
| FTP-IMAGE.CUSTOM-FILE-NAME | Communication | PUBLIC | 3.3.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable/disable FTP server generated file name. | Ethernet readers. DM8000 series wireless readers also support FTP if the base station is connected through Ethernet. |
| FTP-IMAGE.FILE-NAME | Communication | PUBLIC | 3.3.0 | SET|GET | string |
File name of FTP image. | Ethernet readers. DM8000 series wireless readers also support FTP if the base station is connected through Ethernet. | ||
| FTP-IMAGE.FILE-NAME-USE-SCRIPT | Communication | PUBLIC | 5.2.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enables FTP file name generation script. | DM474, DM503 and DM300 series readers. |
| FTP-IMAGE.IDLE-LIMIT | Communication | PUBLIC | 5.5.0 | SET|GET | state |
[ON|OFF] | enable/disable | Limit duration of idle connections. | DM474, DM503 and DM300 series readers. |
| FTP-IMAGE.IDLE-TIME | Communication | PUBLIC | 5.5.0 | SET|GET | seconds |
Maximum duration of telling the FTP server that the reader is alive. | DM474, DM503 and DM300 series readers. | ||
| FTP-IMAGE.IP-ADDRESS | Communication | PUBLIC | 3.3.0 | SET|GET | string |
IP address of target FTP server. Uses dotted decimal form, such as "192.168.23.42". |
Ethernet readers. DM8000 series wireless readers also support FTP if the base station is connected through Ethernet. | ||
| FTP-IMAGE.MAX-APPEND | Communication | PUBLIC | 3.3.0 | SET|GET | value |
[0-65535] | Max increment value to append to image name. | Ethernet readers. DM8000 series wireless readers also support FTP if the base station is connected through Ethernet. | |
| FTP-IMAGE.MAX-APPEND-START-VALUE | Communication | PUBLIC | 4.0.0 | SET|GET | value |
[0-65535] | Initial increment value to append to image name. | DM503 | |
| FTP-IMAGE.PASSWORD | Communication | PUBLIC | 3.3.0 | SET | string |
Password used to login to target FTP server. | Ethernet readers. DM8000 series wireless readers also support FTP if the base station is connected through Ethernet. | ||
| FTP-IMAGE.PORT | Communication | PUBLIC | 4.0.0 | SET|GET | port |
[0-65535] | FTP server port number. | Ethernet readers. DM8000 series wireless readers also support FTP if the base station is connected through Ethernet. | |
| FTP-IMAGE.SERVER-PATH | Communication | PUBLIC | 3.3.0 | SET|GET | string |
Path for FTP image. | Ethernet readers. DM8000 series wireless readers also support FTP if the base station is connected through Ethernet. | ||
| FTP-IMAGE.SERVER-PATH-SCRIPT | Communication | PUBLIC | 5.2.0 | SET|GET | num-bytes |
Set: loads the script from the host to the reader. Get: sends the script from the reader to the host. | DM474, DM503 and DM300 series readers. | ||
| FTP-IMAGE.SERVER-PATH-SCRIPT-ERROR | Communication | PUBLIC | 5.5.0 | GET | message |
script error message | Gets the script error message for FTP Storage name generation . | Fixed-mount readers. | |
| FTP-IMAGE.SERVER-TYPE | Communication | PUBLIC | 5.6.3 | SET|GET | type |
[0-2] |
0: Generic 1: Mitsubishi GOT 2: SFTP |
FTP image server type. 2 means that the server is an S(SH)FTP server. | DM474, DM503 and DM300 series readers. |
| FTP-IMAGE.USER-NAME | Communication | PUBLIC | 3.3.0 | SET|GET | string |
Username used to login to target FTP server. | Ethernet readers. DM8000 series wireless readers also support FTP if the base station is connected through Ethernet. | ||
| FTP-PCM-REPORT.CUSTOM-FILE-NAME | Communication | PUBLIC | 5.7.0 | SET|GET | state |
ON/OFF |
enable disable |
Enable/disable customize file name generation (if disabled the FTP server has to generate a unique name). | Ethernet readers |
| FTP-PCM-REPORT.ENABLE | Communication | PUBLIC | 5.7.0 | SET|GET | enable |
ON/OFF | Enable or disable a PCM Report FTP connection. | Ethernet readers | |
| FTP-PCM-REPORT.FILE-NAME | Communication | PUBLIC | 5.7.0 | SET|GET | string |
File name of PCM Report. | Ethernet readers | ||
| FTP-PCM-REPORT.FILE-NAME-USE-SCRIPT | Communication | PUBLIC | 5.7.0 | SET|GET | state |
ON/OFF |
enable disable |
Enables PCM report file name generation by script. | Ethernet readers |
| FTP-PCM-REPORT.IDLE-LIMIT | Communication | PUBLIC | 5.7.0 | SET|GET | state |
ON/OFF |
enable disable |
Limit duration of idle connections after a data transfer. | Ethernet readers |
| FTP-PCM-REPORT.IDLE-TIME | Communication | PUBLIC | 5.7.0 | SET|GET | seconds |
[0-3600] | Maximum duration of idle connections after a data transfer. | Ethernet readers | |
| FTP-PCM-REPORT.IP-ADDRESS | Communication | PUBLIC | 5.7.0 | SET|GET | server |
IP address or DNS name | Set the PCM Report FTP server. | Ethernet readers | |
| FTP-PCM-REPORT.MAX-APPEND | Communication | PUBLIC | 5.7.0 | SET|GET | value |
[0-65535] | Max increment value to append to PCM report file name. | Ethernet readers | |
| FTP-PCM-REPORT.MAX-APPEND-START-VALUE | Communication | PUBLIC | 5.7.0 | SET|GET | value |
[0-65535] | Initial increment value to append to PCM report file name. | Ethernet readers | |
| FTP-PCM-REPORT.PASSWORD | Communication | PUBLIC | 5.7.0 | SET|GET | string |
PASSWORD used to login to target PCM Report FTP server. | Ethernet readers | ||
| FTP-PCM-REPORT.PORT | Communication | PUBLIC | 5.7.0 | SET|GET | port |
[0-65535] | PCM Report FTP server port number. | Ethernet readers | |
| FTP-PCM-REPORT.SCRIPT-ERROR | Communication | PUBLIC | 5.7.0 | GET | message |
script error message | Gets the script error message for FTP PCM report file name generation. | Ethernet readers | |
| FTP-PCM-REPORT.SERVER-PATH | Communication | PUBLIC | 5.7.0 | SET|GET | string |
Path for PCM Reports which has to be named by the FTP Server. | Ethernet readers | ||
| FTP-PCM-REPORT.SERVER-TYPE | Communication | PUBLIC | 5.7.0 | SET|GET | type |
[0-2] |
0: Generic 1: Mitsubishi GOT 2: SFTP(encrypted) |
FTP server type. | Ethernet readers |
| FTP-PCM-REPORT.USER-NAME | Communication | PUBLIC | 5.7.0 | SET|GET | string |
Username used to login to target PCM Report FTP server. | Ethernet readers | ||
| FTP-RESULT.APPEND | Communication | PUBLIC | 3.3.0 | SET|GET | type |
[ON|OFF] |
ON: Append result to existing file. OFF: Overwrite file content with result. |
Append to or overwrite file when result is sent via FTP to the file specified by FTP-RESULT.FILE-NAME. The file will be created if it does not exist. | Ethernet readers. DM8000 series wireless readers also support FTP if the base station is connected through Ethernet. |
| FTP-RESULT.ENABLE | Communication | PUBLIC | 3.3.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable/disable FTP transfer of reader results. | Ethernet readers. DM8000 series wireless readers also support FTP if the base station is connected through Ethernet. |
| FTP-RESULT.FILE-NAME | Communication | PUBLIC | 3.3.0 | SET|GET | string |
File name of FTP result. | Ethernet readers. DM8000 series wireless readers also support FTP if the base station is connected through Ethernet. | ||
| FTP-RESULT.IDLE-LIMIT | Communication | PUBLIC | 5.5.0 | SET|GET | state |
[ON|OFF] | enable/disable | Limit duration of idle connections after a data transfer. | DM474, DM503 and DM300 series readers. |
| FTP-RESULT.IDLE-TIME | Communication | PUBLIC | 5.5.0 | SET|GET | seconds |
[0-3600] | Maximum duration of idle connections after a data transfer. | DM474, DM503 and DM300 series readers. | |
| FTP-RESULT.IP-ADDRESS | Communication | PUBLIC | 3.3.0 | SET|GET | string |
IP address of target FTP server. Uses dotted decimal form, such as "192.168.23.42". |
Ethernet readers and MX-1000. DM8000 series wireless readers also support FTP if the base station is connected through Ethernet. | ||
| FTP-RESULT.PASSWORD | Communication | PUBLIC | 3.3.0 | SET | string |
Password used to login to target FTP server. | Ethernet readers. DM8000 series wireless readers also support FTP if the base station is connected through Ethernet. | ||
| FTP-RESULT.PORT | Communication | PUBLIC | 4.0.0 | SET|GET | port |
[0-65535] | FTP server port number. | Ethernet readers. DM8000 series wireless readers also support FTP if the base station is connected through Ethernet. | |
| FTP-RESULT.SERVER-TYPE | Communication | PUBLIC | 5.6.3 | SET|GET | type |
[0-2] |
0: Generic 1: Mitsubishi GOT 2: SFTP |
FTP server type.2 means that the server is an S(SH)FTP server. | DM474, DM503 and DM300 series readers. |
| FTP-RESULT.USER-NAME | Communication | PUBLIC | 3.3.0 | SET|GET | string |
Username used to login to target FTP server. | Ethernet readers. DM8000 series wireless readers also support FTP if the base station is connected through Ethernet. | ||
| HEIGHT-SENSOR.CURRENT-MEASUREMENT | Camera | PUBLIC | 6.1.6 | GET | [0-4000] | Distance from the C-Mount Flange in mm | Returns the read out of the ToF range distance in mm. | DM370 series, DM470 series readers. | |
| HPIT.FRONT-COVER | Communication | PUBLIC | 6.1.6 | GET |
|
[0-4] |
0 = No cover 1 = Cross polarized NEWC Linear Polarized S 2 = Clear cover 3 = Undefined 4 = Diffused |
Detected front cover type. | DM370 series, DM470 series readers. |
| HPIT.INDICATOR-MODE | Action | PUBLIC | 6.1.6 | SET|GET | IND_ID IND_MODE |
[0-1] [0-1] |
0 = Left indicator 1 = Right indicator 0 = OFF 1 = ON |
Allows to control the LED indicators located in Torch according to the selected mode. This command is intended only for usability testing. | DM370 series, DM470 series readers. |
| I2O5.CHKCHAR | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | I2of5 Check Character. | ALL |
| I2O5.CODESIZE | Symbology | PUBLIC | 3.0.0 | SET|GET | any min max |
[ON|OFF] [4-max] [min-80] |
any length code minimum code length maximum code length |
I2of5 Code Size. For the Manatee Works SDK, all of the Code 25 variants use the same minimum length; thus it will accept either C25.CODESIZE or I205.CODESIZE. | ALL |
| I2O5.XMTCHK | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | I2of5 Transmit Check Character. | ALL |
| IMAGE.FORMAT | Camera | PUBLIC | 5.6.3 | SET|GET | format |
[0-2] |
0: Bitmap 1: JPEG 2: PNG |
Image File Format. | ALL |
| IMAGE.QUALITY | Camera | PUBLIC | 4.4.0 | SET|GET | quality |
[10, 15, 20... 85, 90] | JPEG Quality | Quality of the jpeg image. | ALL |
| IMAGE.SEND | Action | PUBLIC | 5.5.0 | Retrieve the last camera image acquired. Returns number of bytes of image data followed by \r\n followed by image data. Whatever is set for ||>IMAGE.SIZE, ||>IMAGE.FORMAT, and ||>IMAGE.QUALITY before requesting the image will be used for the corresponding size, format, and quality. | ALL | ||||
| IMAGE.SIZE | Camera | PUBLIC | 4.4.0 | SET|GET | size |
[0-3] |
0: Full 1: 1/4 2: 1/16 3: 1/64 |
Image Size. | ALL |
| IMAGEBUFFER.ALLOW-OVERWRITE | RecordPlayback | PUBLIC | 4.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Allow buffered images that have not been transfered to be overwritten if all available buffers are used and new images arrive. | DM50, DM60, DM70, DM474, DM503, DM300 series readers, DM8050 and DM8600. |
| IMAGEBUFFER.AUTO-PREFER-CENTER | RecordPlayback | PUBLIC | 5.7.3 | SET|GET | Controls whether to use the decoders best symbol or the symbol closer to the ROI center. | DM50, DM60, DM70, DM474, DM503, DM300 series readers, DM8050 and DM8600. | |||
| IMAGEBUFFER.DELETE | RecordPlayback | PUBLIC | 4.0.0 | Release stored images. | DM50, DM60, DM70, DM474, DM503, DM300 series readers, DM8050 and DM8600. | ||||
| IMAGEBUFFER.DELETE-AFTER-TRANSFER | RecordPlayback | PUBLIC | 4.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Release stored images automatically after image has been transfered. | DM50, DM60, DM70, DM474, DM503, DM300 series readers, DM8050 and DM8600. |
| IMAGEBUFFER.FORMAT | RecordPlayback | PUBLIC | 5.6.3 | SET|GET | format |
[0-2] |
0: Bitmap 1: JPEG 2: PNG |
DM50, DM60, DM70, DM474, DM503, MX-1000, DM8000 series and DM300 series readers. | |
| IMAGEBUFFER.GOOD-IMAGE-MODE | RecordPlayback | PUBLIC | 5.2.0 | SET|GET | mode |
[0-1] |
0: Unlimited 1: Rate limited |
Good Read Image stores all buffered good read images unless you set a limit rate. | DM503, DM300 series readers, DM8050 and DM8600. |
| IMAGEBUFFER.GOOD-IMAGE-RATE-BURST | RecordPlayback | PUBLIC | 5.2.0 | SET|GET | interval |
[1-1000] | Burst determines the peak rate of the number of good read images buffered. | DM474, DM503, DM300 series readers, DM8050 and DM8600. | |
| IMAGEBUFFER.GOOD-IMAGE-RATE-COUNT | RecordPlayback | PUBLIC | 5.2.0 | SET|GET | interval |
Number of good read images to be buffered at a time unit (for example, minutes or hours) specified with IMAGEBUFFER.GOOD-IMAGE-RATE-COUNT. | DM474, DM503, DM300 series readers, DM8050 and DM8600. | ||
| IMAGEBUFFER.GOOD-IMAGE-RATE-TIME | RecordPlayback | PUBLIC | 5.2.0 | SET|GET | type |
[0-3] |
0: seconds 1: minutes 2: hours 3: days |
Time unit of good read images to be buffered at a rate number specified with IMAGEBUFFER.GOOD-IMAGE-RATE-TIME. | DM474, DM503, DM300 series readers, DM8050 and DM8600. |
| IMAGEBUFFER.IMAGE-TYPE | RecordPlayback | PUBLIC | 5.5.0 | SET|GET | int |
[0-2] |
0: All 1: Same as result 2: Auto |
Sets "What images to Buffer for a Result". When "Auto" is selected, the reader does intelligent image buffering. Requires the IntImageBuffer feature key to select the "Auto" option. |
DM70, DM150, DM260, DM300 series readers, DM474, DM503. |
| IMAGEBUFFER.MAX-IMAGES-PER-RESULT | RecordPlayback | PUBLIC | 5.0.0 | SET|GET | size |
[0-*] | Sets or gets how many images (n) per result are stored. | DM50, DM60, DM70, DM474, DM503, DM300 series readers, DM8050 and DM8600. | |
| IMAGEBUFFER.MAX-NUM | RecordPlayback | PUBLIC | 4.0.0 | SET|GET | size |
[0-*] | Maximum number of images that can be buffered. * Range varies depending depending on Camera ROI and memory allocated for burst length. |
DM50, DM60, DM70, DM474, DM503, DM300 series readers, DM8050 and DM8600. | |
| IMAGEBUFFER.NO-READ-IMAGE-NUMBER | RecordPlayback | PUBLIC | 5.0.0 | SET|GET | limit |
[n] [Max Int] |
In Burst trigger mode, n is the number of images in a burst In other trigger modes, there is no limit |
Store exactly one image. | DM50, DM60, DM70, DM474, DM503, DM300 series readers, only in Single, Burst, Self and Continuous modes. |
| IMAGEBUFFER.NO-READ-IMAGE-PERIOD | RecordPlayback | PUBLIC | 4.0.0 | SET|GET | interval |
[1-200] | Sets or gets the interval to save the image of a bad read. If, for example, you use an interval of 6, the first bad image is saved and the next 5 are not. The default is 1 which saves each bad read image. | DM50, DM60, DM70, DM474, DM503, DM300 series readers, only in Single, Burst, Self and Continuous modes. | |
| IMAGEBUFFER.NO-READ-IMAGE-RATE-BURST | RecordPlayback | PUBLIC | 5.2.0 | SET|GET | interval |
[1-1000] | Burst determines the peak rate of the number of bad read images buffered. | DM474, DM503, DM300 series readers, only in Single, Burst, Self and Continuous modes. | |
| IMAGEBUFFER.NO-READ-IMAGE-RATE-COUNT | RecordPlayback | PUBLIC | 5.2.0 | SET|GET | interval |
Number of bad read images to be buffered at a time unit (for example, minutes or hours) specified with IMAGEBUFFER.NO-READ-IMAGE-RATE-COUNT. | DM503, DM300 series readers, only in Single, Burst, Self and Continuous modes. | ||
| IMAGEBUFFER.NO-READ-IMAGE-RATE-TIME | RecordPlayback | PUBLIC | 5.2.0 | SET|GET | type |
[0-3] |
0: seconds 1: minutes 2: hours 3: days |
Time unit of bad read images to be buffered at a rate number specified with IMAGEBUFFER.NO-READ-IMAGE-RATE-TIME. | DM474, DM503, DM300 series readers, only in Single, Burst, Self and Continuous modes. |
| IMAGEBUFFER.NUM | RecordPlayback | PUBLIC | 4.0.0 | GET | size |
Returns the number of currently buffered images. | DM50, DM60, DM70, DM474, DM503, DM300 series readers, DM8050 and DM8600. | ||
| IMAGEBUFFER.OVERLAY | RecordPlayback | PUBLIC | 5.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enables Overlay Graphics (SVG) for buffered images. | DM50, DM60, DM70, DM474, DM503, DM300 series readers, DM8050 and DM8600. |
| IMAGEBUFFER.QUALITY | RecordPlayback | PUBLIC | 4.0.0 | SET|GET | quality |
[10, 15, 20... 85, 90] | JPEG Quality | DM50, DM60, DM70, DM474, DM503, MX-1000, DM8000 series and DM300 series readers. | |
| IMAGEBUFFER.RECORD-TYPE | RecordPlayback | PUBLIC | 4.0.0 | SET|GET | type |
[0-5] |
0: None 1: No-Read 2: Read 3: All 4: Validation Failure 5: No-Read + Validation failure |
Sets or gets the type of image to buffer. In case of No-Read, the image is buffered if the reader fails to read. |
DM50, DM60, DM70, DM474, DM503, MX-1000, DM8000 series and DM300 series readers. |
| IMAGEBUFFER.SEND-FTP | RecordPlayback | PUBLIC | 4.0.0 | Transmit buffered images to designated FTP server. | DM60, DM474, DM503, DM8000 series and DM300 series readers. | ||||
| IMAGEBUFFER.SIZE | RecordPlayback | PUBLIC | 4.0.0 | SET|GET | size |
[0-3] |
0: Full 1: 1/4 2: 1/16 3: 1/64 |
DM50, DM60, DM70, DM474, DM503, MX-1000, DM8000 series and DM300 series readers. | |
| IMAGEBUFFER.TRANSFER-MODE | RecordPlayback | PUBLIC | 4.0.0 | SET|GET | interval |
[0-1] |
0: On Request 1: FTP - runtime |
Sets or gets whether buffered images should automatically sent FTP or if they should be send only after requested. | DM60, DM70, DM474, DM503, MX-1000, DM8000 series, and DM300 series readers and DM260. |
| INPUT-STRING.ENABLE | Data Formatting | PUBLIC | 5.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enables or disables the use of the Input String feature (available for serial, telnet, NetworkClient). When enabled, a header and the footer can be set by the INPUT-STRING.HEADER and INPUT-STRING.FOOTER commands, respectively. A string of characters can be given between the header and the footer, which will be sent with the formatted output (for example, [hello world], if the header is set to ’[’ and the footer to ’]’). Since the input string is saved temporarily, it appears only in the next result output. Use Setup Tool (the <Input String> option) or <ISTR> with DMCC (see SET FORMAT.TOKEN) to allow Input string in the result output. | ALL |
| INPUT-STRING.FOOTER | Data Formatting | PUBLIC | 5.0.0 | SET|GET | string |
token string | Sets the footer for the Input String character string. | ALL | |
| INPUT-STRING.HEADER | Data Formatting | PUBLIC | 5.0.0 | SET|GET | string |
token string | Sets the header for the Input String character string. | ALL | |
| INPUT-STRING.MODE | Data Formatting | PUBLIC | 5.5.0 | SET|GET | int |
[0-4] |
0: Store 1: Send 2: Send with header and footer 3: Send with formatting 4: Send with header and footer formatting |
Controls whether the input string data is sent out as a result or stored in an internal variable. | Fixed-mount readers. |
| INPUT-STRING.VALUE | Data Formatting | PUBLIC | 5.5.0 | SET|GET | string |
token string | Sets the content of the Input String character string. | Fixed-mount readers | |
| INPUT.ACTION | IO | PUBLIC | 4.0.0 | SET|GET | line action state |
[0-3] [0-11] [ON|OFF] |
Input line number 0: Train Code 1: Optimize Brightness 2: Set Match String 3: Optimize Focus 4: Read Configuration Code 5: Trigger Off 6: Encoder 7: Allow Buffered No-Read Images 8: Clear Outputs 9: Tune (DM300 only) 10: Encoder direction 11: Trigger on ON: execute action when line is triggered OFF: no action |
Sets or gets the state for the specified line action. The input actions "Train Code," "Optimize Brightness," "Set Match String," and "Read Configuration Code" are carried out only after the next trigger. |
Fixed-mount readers. |
| INPUT.ACTION1 | IO | PUBLIC | 3.0.0 | SET|GET | mode state |
[0-3] [ON|OFF] |
0: Train Code 1: Optimize Brighness 2: Set Match String 3: Optimize focus (Only for readers with a liquid lens.) enable/disable |
Input Line 1 Action. | Fixed mount readers. |
| INPUT.STATE | Action | PUBLIC | 5.5.0 | GET | line |
[0-3] | input line number | Gets the current state of the input line specified. Returns 1 for high, 0 for low. | Fixed-mount readers |
| INPUT1.SAVE-MATCH-STRING | Communication | PUBLIC | 4.5.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enables or disables saving the match string to flash when Set Match String is enabled as Input line 1 action. | DM50, DM60, DM70, DM474, DM503, and DM300 series readers. |
| IO-LINE.DIRECTION | IO | PUBLIC | 5.5.0 | SET|GET | line direction |
[2,3] [0,1] |
line=2: sets direction of I/O Line 2 line=3: sets direction of I/O Line 3 direction=0: defines line as output direction=1: defines line as input |
Sets the direction of the programmable I/O lines of DM360 and DM474 series readers. | DM360 series, DM474 readers |
| KEY.INTERCHAR-DELAY | Communication | PUBLIC | 5.5.0 | SET|GET | us |
[0-1000] | milliseconds | Sets or gets the delay time between characters when in HID keyboard mode. | DM300 series readers, DM60, DM50, DM70, DM474. |
| KEY.LANGUAGE | IO | PUBLIC | 3.0.0 | SET|GET | language |
[0-7] |
0: Alt Key Combo 1: DE 2: US 3: JP 4: FR 5: ES 6: NO 7: FI |
ALL except for DM60, DM474, DM503, and DM300 series readers. | |
| KEY.PAUSE-TIME | Action | PUBLIC | 5.4.0 | SET|GET | Pause time |
[0-1000] | 0 to 1000 millisecond pause | Sets the time to pause for a specified pause key sequence. | DM8050, DM8600 series |
| KEY.ZERO-PAD | IO | PUBLIC | 3.0.0 | SET|GET | language |
[ON|OFF] | enable/disable | ALL except for DM60, DM474, DM503, and DM300 series readers. | |
| LIGHT.AIMER | Camera | PUBLIC | 3.0.0 | SET|GET | aimer-mode |
[0-1] |
0: Off 1: On |
Aimer Enable. Default is ON. |
ALL except for DM503 and DM8050. |
| LIGHT.AIMER | Camera | PUBLIC | 5.4.0 | SET|GET | aimer-mode |
[0,1,3] |
0: Off 1: On 3: Activated by Acceleration Sensor |
Aimer Enable. Default is ON. |
DM8050 |
| LIGHT.AIMER | Camera | PUBLIC | 6.1.6 | SET|GET | aimer-mode |
[0-1] |
0: Off 1: On |
Enables or disables the aimer. | DM370 series, DM470 readers. |
| LIGHT.AIMER-TIMEOUT | Camera | PUBLIC | 4.2.1 | SET|GET | int |
[0-600] | seconds | Aimer Timeout in seconds. | MX-1000 and DM8000 series readers. |
| LIGHT.DARKFIELD-INTENSITY | Camera | PUBLIC | 5.4.3 | SET|GET | value |
[0-15] | Intensity | Darkfield Illumination Intensity. | DM8600 |
| LIGHT.DIFFUSE-INTENSITY | Camera | PUBLIC | 5.4.3 | SET|GET | level |
[0-15] | Intensity | Diffuse Brightfield Illumination Intensity. | DM8600 |
| LIGHT.DIRECT | Camera | PUBLIC | 4.4.0 | SET|GET | north east south west NORTH EAST SOUTH WEST |
[ON|OFF]
[ON|OFF] [ON|OFF] [ON|OFF] [ON|OFF] [ON|OFF] [ON|OFF] [ON|OFF] |
enable/disable
enable/disable enable/disable enable/disable enable/disable enable/disable enable/disable enable/disable |
Sets the quadrants on the DM300. Small letters refer to the inner, capital letters to the outer circle, possible values are ON and OFF for each segment. Example for a SET command: SET LIGHT.DIRECT ON OFF ON ON OFF OFF OFF OFF if you want to have the inner north, south, and west lights on. | DM300 series readers, DM474. |
| LIGHT.DIRECT | Camera | PUBLIC | 5.5.0 | SET|GET | north-east north-west south-east south-west |
[ON|OFF]
[ON|OFF] [ON|OFF] [ON|OFF] |
enable/disable
enable/disable enable/disable enable/disable |
Sets the quadrants on the DM70, DM150 and DM260. Possible values are ON and OFF for each segment. Example for a SET command: SET LIGHT.DIRECT ON OFF OFF ON if you want to have the top-left and bottom-right LED on. | DM70, DM150 and DM260 readers. |
| LIGHT.DIRECT | Camera | PUBLIC | 5.7.7 | SET|GET | state |
[ON|OFF] | enable/disable | Turns on/off light banks for the 8072V. Verification should only take place with lighting combinations that can be described as 30 single, 30T (opposite sides), 30Q (all 30 panels), 45Q (all 45 panels), or 90. Other lighting combinations are allowed by the firmware, but will not result in valid verification result. | DM8072 Verifier |
| LIGHT.DIRECT | Camera | PUBLIC | 6.1.6 | SET|GET | North Corners South East-West |
[ON|OFF]
[ON|OFF] [ON|OFF] [ON|OFF] |
enable/disable
enable/disable enable/disable enable/disable |
Enables or disables the HPIT quadrants. | DM370 series, DM470 series readers. |
| LIGHT.DIRECT-INTENSITY | Camera | PUBLIC | 5.1.0 | SET|GET | level |
[0-15] | Intensity | Direct Illumination Intensity. | DM50, DM60, DM474, DM503 and DM300 series readers. |
| LIGHT.DIRECT-INTENSITY | Camera | PUBLIC | 5.4.3 | SET|GET | level |
[1-15] | Intensity | Direct Illumination Intensity. | DM8050 |
| LIGHT.EXTERNAL-ENABLE | Camera | PUBLIC | 4.1.0 | SET|GET | enable |
[ON|OFF] | enable/disable | Enable external illumination supported by I/O. | Fixed mount readers. |
| LIGHT.EXTERNAL-INTENSITY | Camera | PUBLIC | 5.2.0 | SET|GET | level |
[0-15] | Intensity | Sets the intensity of the external illumination. | Fixed mount readers. |
| LIGHT.EXTERNAL-POLARITY | Camera | PUBLIC | 3.0.0 | SET|GET | polarity |
[0-1] |
0: Active Low 1: Active High |
External illlumination output polarity. | Fixed mount readers except for DM70, DM150, DM260. |
| LIGHT.HIGH-FREQUENCY | Camera | PUBLIC | 5.2.0 | SET|GET | enable |
[ON|OFF] | enable/disable | Enables High Frequency Lights to avoid flickering illumination. | DM50, DM60, DM70, DM474, DM503, and DM300 series readers. |
| LIGHT.HIGH-FREQUENCY-ALWAYS | Camera | PUBLIC | 5.2.0 | SET|GET | enable seconds |
[ON|OFF] 0-86400 |
enable/disable auto off duration |
Enables High Frequency Light in Continuous trigger mode even if no trigger is active. After duration seconds the High Frequency Light is turned off. If the duration is 0 the light is never turned off. | DM50, DM60, DM70, DM474, DM503, and DM300 series readers. |
| LIGHT.INTERNAL-ENABLE | Camera | PUBLIC | 4.1.0 | SET|GET | enable |
[ON|OFF] | enable/disable | Enable the built-in internal illumination. Default value is OFF. | DM50, DM60, DM70, DM8050, MX-1000, MX-1502, Mobile. |
| LIGHT.LOW-ANGLE | Camera | PUBLIC | 5.7.0 | SET|GET | state |
[ON|OFF] [ON|OFF] | enable/disable low-angle illumination | Controls the DM262 UHD low-angle illumination. | DM262 |
| LIGHT.ON-AXIS | Camera | PUBLIC | 5.7.0 | SET|GET | state |
[ON|OFF] [ON|OFF] | enable/disable on-axis illumination | Controls the DM262 UHD on-axis illumination. | DM262 |
| LIGHT.POLARIZED | Camera | PUBLIC | 5.6.0 | SET|GET | polarized LED count |
[0|2|4] | Number of polarized filtered LEDs in the illumination | Use this command after applying a different HPIL front cover to publish the illumination filter status to the device. | DM70, DM150, DM260 |
| LIGHTCURTAIN.BEAM-SPACING | IO | PUBLIC | 4.1.0 | SET|GET | spacing |
[1-300000] | micrometers | Distance (in um) between beams of the Light Curtain. This determines the resolution of the light curtain. | DM503 |
| LIGHTRING.DURATION | IO | PUBLIC | 5.7.0 | SET|GET | duration |
[0..10000] |
0: Default behavior 10..10000: duration of lightring event in ms, step 10 ms |
Controls the duration of the lightring illumination event. | DM36x, DM474 and DM503 |
| LIVEIMG.MODE | Camera | PUBLIC | 5.2.0 | SET|GET | mode |
[0,2] |
0: Disable 2: Enable |
Controls live image display. | ALL |
| LIVEIMG.SEND | Camera | PUBLIC | 5.6.3 | size format quality |
[0-3] [0-2] [10, 15, 20... 85, 90] |
0: Full 1: 1/4 2: 1/16 3: 1/64 0: Bitmap 1: JPEG 2: PNG JPEG Quality |
Request image transfer to PC when LIVEIMG.MODE is set to 3. | ||
| MASTER-SLAVE.GROUP-NAME | Communication | PUBLIC | 4.0.0 | SET|GET | name |
Gets or sets the name of the master slave group. | DM60, DM474, DM503, and DM300 series readers. | ||
| MASTER-SLAVE.MODE | Communication | PUBLIC | 4.0.0 | SET|GET | mode |
[0-2] |
0: OFF 1: ON 2: Master |
Switches the master-slave functioning of the reader on or off. | DM60, DM474, DM503, and DM300 series readers. |
| MASTER-SLAVE.RX-HEIGHT-SENSOR | Camera | PUBLIC | 4.1.0 | SET|GET | enable |
[ON|OFF]* | enable/disable | Enables or disables this system receiving height information from another system in the network group. | DM60, DM474 and DM300 series readers. |
| MASTER-SLAVE.TEST | Communication | PUBLIC | 5.5.0 | mode message |
[0-2] |
0: Slave to Master 1: Master to Slave 2: Master to Slave to Master |
Transmits the test message from reader to reader as designated by mode. The terminating reader will output the message preceded by the initiating device delimited by a space | Fixed-mount readers. | |
| MASTER-SLAVE.TEST-EFP-OUTPUT | Communication | PUBLIC | 5.7.3 | SET|GET | state |
[ON|OFF] |
ON: enable OFF: disable |
Enables or disables mst-test messages on the Industrial Protocol interfaces. | DM300 series readers, DM474. |
| MASTER-SLAVE.TIMEOUT | Communication | PUBLIC | 4.0.0 | SET|GET | milliseconds |
[0-10000] | Gets or sets the time to wait for results from slave cameras. | DM60, DM474, DM503, and DM300 series readers. | |
| MASTER-SLAVE.TIMEOUT-DISTANCE | Communication | PUBLIC | 5.7.3 | SET|GET | int |
[0-1000000] | Distance | The distance for a master slave timeout. | DM60, DM70, DM260, DM474, DM503, and DM300 series readers. |
| MASTER-SLAVE.TIMEOUT-MODE | Communication | PUBLIC | 5.7.3 | SET|GET | mode |
[0-1] |
0: Time 1: Distance |
Controls if the mater slave response timeout will be time or distance based. | DM60, DM260, DM474, DM503, and DM300 series readers. |
| MAXICODE.TRAINED-MODEL | Decoder | PUBLIC | 5.7.0 | SET|GET | module size |
[1-1000] | Module size * 10 | Set training parameters for MaxiCode symbology. | Fixed-mount readers |
| MODBUSTCP.ENABLED | Communication | PUBLIC | SET|GET | state |
[ON|OFF] | enable/disable | Enable or disable Modbus/TCP communication. | Ethernet readers. The DM8000 series wireless readers also support this protocol if the base station is connected through Ethernet. In the case of a Bluetooth connection, the command has to be sent to the base station, not to the reader. | |
| MODBUSTCP.HOLDING-ONLY | Communication | PUBLIC | SET|GET | state |
[ON|OFF] | enable/disable | Ethernet readers. DM8000 series wireless readers also support this protocol if the base station is connected through Ethernet. | ||
| MONITOR-MODE.AUTOEXPOSURE | Camera | PUBLIC | 5.7.1 | SET|GET | state |
[ON|OFF] | enable/disable | Enable/disable autoregulation while in monitor mode. | ALL |
| MONITOR-MODE.DECODE-ENABLE | Camera | PUBLIC | 5.7.1 | SET|GET | mode |
[ON|OFF] | enable/disable | ALL | |
| MONITOR-MODE.ENABLE | Camera | PUBLIC | 6.0.1 | SET|GET | state |
[ON|OFF] | enable/disable | Enable/disable monitor mode. | ALL |
| MOTION-DETECTION.ACTIVE | Action | PUBLIC | 5.7.0 | GET | state |
[ON|OFF] |
ON: Active or Lights Off OFF: Inactive or Lights On |
Allows checking the current state of motion detection for presentation or self-internal trigger mode. | DM50, DN60, DM70, DM150, DM260, DM300, DM360, DM474. |
| MOTION-DETECTION.ENABLE | Action | PUBLIC | 5.7.0 | SET|GET | state |
[ON|OFF] |
ON: enable OFF: disable |
Enables or disables motion detection for Presentation trigger mode. | DM50, DN60, DM70, DM150, DM260, DM300, DM474, DM503. |
| MOTION-DETECTION.SENSITIVITY | Action | PUBLIC | 5.7.0 | SET|GET |
|
[0|2] |
0: Low 1: Medium 2: High |
Sets or gets the motion detection sensitivity level when in presentation mode. | DM50, DM60, DM70, DM150, DM260, DM300, DM474, DM503. |
| MSI.CHKCHAR | Symbology | PUBLIC | 5.0.0_cr5 | SET|GET | state |
[ON|OFF] | enable/disable | Sets or gets whether check character is used. Default value is OFF. | DM300 series, DM474, DM503, MX-1000, MX-1502, Mobile. |
| MSI.CHKCHAR-OPTION | Symbology | PUBLIC | 5.0.0_cr5 | SET|GET | mode |
[0-5] |
0: Mod10 1: Mod11 2: Mod1010 3: Mod1110 4: 5: |
Sets or gets the method for calculating checksum. | DM474, DM503 and DM300 series, MX-1000, MX-1502, Mobile. |
| MSI.CODESIZE | Symbology | PUBLIC | 5.0.0_cr5 | SET|GET | mode min max |
[ON|OFF] [1-max] [min-80] |
any length code minimum code length maximum code length |
Sets or gets the expected code size. | DM474, DM503, DM300 series readers, MX-1000, MX-1502. |
| MSI.QZ-SIZE | Symbology | PUBLIC | 5.0.0_cr5 | SET|GET | size |
[0-100] | Sets or gets the single side strictness as a percentage | DM474, DM503 and DM300 series readers. | |
| MSI.XMTCHK | Symbology | PUBLIC | 5.0.0_cr5 | SET|GET | state |
[ON|OFF] | enable/disable | Sets or gets whether to transmit the check digit. | DM474, DM503 and DM300 series readers. |
| MULTICODE.HORIZONTAL-REVERSE | Symbology | PUBLIC | 3.4.0 | SET|GET | state |
[ON|OFF] |
ON: sort right to left OFF: sort left to right |
Horizontal positional sorting order priority. | Fixed mount readers. |
| MULTICODE.IDENTICAL-SYMBOLS | Symbology | PUBLIC | 3.4.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enables/disables output of identical symbols when multicode is enabled. | Fixed mount readers. |
| MULTICODE.IMAGE-REVERSE | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] |
ON: sort last image first OFF: sort first image first |
Image sorting order preference. | Fixed mount readers. |
| MULTICODE.MAX-NUM-CODES | Symbology | PUBLIC | 3.2.0 | SET|GET | symbology number |
[1-5] [1-255] |
1: DataMatrix 2: QR Code/MaxiCode/AztecCode 3: Linear/ Postal/ Stacked 4: VeriCode® 5: DotCode |
The expected maximum number of codes to find for each symbology grouping 1 - 4; no expected value for any single symbology can exceed parameter 0, the total number of codes to find. | Fixed mount readers. |
| MULTICODE.NUM-CODES | Symbology | PUBLIC | 3.2.0 | SET|GET | number |
[1-255] | Number of codes readers must find for a successful read result. | Fixed mount readers. | |
| MULTICODE.PARTIAL-RESULTS | Symbology | PUBLIC | 3.2.0 | SET|GET | state |
[ON|OFF] | enable/disable | Controls how the reader interprets the number of codes to find. ON = reader will return a successful read if 1 or more codes are found. OFF = reader will return a successful read only if number of codes found equals MULTICODE.NUM-CODES value. | Fixed mount readers. |
| MULTICODE.SORT-PRIORITY | Symbology | PUBLIC | 3.4.0 | SET|GET | symbology image vertical position horizontal position |
[0-3] [0-3] [0-3] [0-3] |
Range for all four arguments indicates sort priority. Must be different for each criteria. |
Sorting order for multicode results: 0 is highest priority, 3 is lowest priority. | Fixed mount readers. |
| MULTICODE.SYMBOLOGY-REVERSE | Symbology | PUBLIC | 3.4.0 | SET|GET | state |
[ON|OFF] |
ON: DotCode, VeriCode ®, Linear/Postal/Stacked, QR Code/MaxiCode/AztecCode, Data Matrix OFF: Data Matrix, QR Code/MaxiCode/AztecCode, Linear/Postal/Stacked, VeriCode ®, DotCode |
Symbology sorting order preference. | Fixed mount readers. |
| MULTICODE.VERTICAL-REVERSE | Symbology | PUBLIC | 3.4.0 | SET|GET | state |
[ON|OFF] |
ON: sort bottom to top OFF: sort top to bottom |
Vertical position sorting order preference. | Fixed mount readers. |
| NET-LOCAL.DHCP | Communication | PUBLIC | 3.3.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable/Disable DHCP on reader. | Ethernet readers. |
| NET-LOCAL.DNS-SERVER | Communication | PUBLIC | 3.3.0 | SET|GET | server |
Gets or sets the DNS Server address. | Ethernet readers. | ||
| NET-LOCAL.GATEWAY | Communication | PUBLIC | 3.3.0 | SET|GET | string |
Reader's default gateway IP address. Uses dotted decimal form, such as "192.168.23.1". |
Ethernet readers. | ||
| NET-LOCAL.IP-ADDRESS | Communication | PUBLIC | 3.3.0 | SET|GET | string |
Reader's IP address. Uses dotted decimal form, such as "192.168.23.42". |
Ethernet readers. | ||
| NET-LOCAL.PORT | Communication | PUBLIC | 3.4.0 | SET|GET | port |
[1-65535] | Setup Tool server TCP port on reader. | Ethernet readers. | |
| NET-LOCAL.READER-IP-ADDRESS | Communication | PUBLIC | 4.2.0 | SET|GET | string |
dotted decimal form IPv4 address | Base station's IP address. Uses dotted decimal form, such as "192.168.23.42". |
Base stations. | |
| NET-LOCAL.READER-SUBNET-MASK | Communication | PUBLIC | 5.2.0 | SET|GET | string |
dotted decimal form IPv4 address | Base station's subnet mask. Uses dotted decimal form, such as "192.168.23.255". |
Base stationss. | |
| NET-LOCAL.SUBNET-MASK | Communication | PUBLIC | 3.3.0 | SET|GET | string |
Reader's subnet mask. Uses dotted decimal form, such as "192.168.23.255". |
Ethernet readers. | ||
| NETWORK-CLIENT.CLIENT-PORT | Communication | PUBLIC | 5.2.0 | SET|GET | int |
[0-65535] | The port on the reader to use as the outbound port (default is 0). | Ethernet readers except for the DM8000 wireless. | |
| NETWORK-CLIENT.CLOSE-CONNECTION | Communication | PUBLIC | 5.2.0 | SET|GET | int |
[0-1] |
0: Never 1: After reader data transfer |
Whether or not to keep the connection open after data transfer (default is 0). | Ethernet readers except for the DM8000 wireless. |
| NETWORK-CLIENT.CONNECTION-TIMEOUT | Communication | PUBLIC | 5.2.0 | SET|GET | int |
[1000-60000] | How long to wait before considering the connection dead (default is 3000). | Ethernet readers except for the DM8000 wireless. | |
| NETWORK-CLIENT.ENABLED | Communication | PUBLIC | 5.1.0 | SET|GET | state |
[ON|OFF] | enable/disable | Switch the Network Client feature on or off. | Ethernet readers except for the DM8000 wireless. |
| NETWORK-CLIENT.HOST-ADDRESS | Communication | PUBLIC | 5.2.0 | SET|GET | string |
Max length = 255 | The address of the server to connect to. | Ethernet readers except for the DM8000 wireless. | |
| NETWORK-CLIENT.HOST-PORT | Communication | PUBLIC | 5.2.0 | SET|GET | int |
[0–65535] | The remote port on the server to connect to (default is 1000). | Ethernet readers except for the DM8000 wireless. | |
| NETWORK-CLIENT.IDLE-TIMEOUT | Communication | PUBLIC | 5.2.0 | SET|GET | int |
[1–3600] | How long to keep the connection open after transfer (default is 1). | Ethernet readers except for the DM8000 wireless. | |
| NETWORK-CLIENT.OPEN-CONNECTION | Communication | PUBLIC | 5.2.0 | SET|GET | us |
[0-1] |
0: on Power-up 1: on Data Activity |
When to open the connection to the remote host (default is 0). | Ethernet readers except for the DM8000 wireless. |
| NETWORK-CLIENT.PROTOCOL | Communication | PUBLIC | 5.2.0 | SET|GET | int |
[0-1] |
0: TCP 1: UDP |
Which protocol to use for the connection (default is 0). | Ethernet readers except for the DM8000 wireless. |
| NETWORK-CLIENT.RECONNECT-DELAY | Communication | PUBLIC | 5.2.0 | SET|GET | int |
[100-60000] | How long to wait before reconnecting if the connection is lost (default is 1000). | Ethernet readers except for the DM8000 wireless. | |
| NTP.ENABLE | Communication | PUBLIC | 5.7.0 | SET|GET | state |
[ON|OFF] | enable/disable Enable/Disable | Enables or disables NTP. | All |
| NTP.SERVER1 | Communication | PUBLIC | 5.7.0 | SET|GET | server |
IP address or DNS name | Set the NTP server 1. | All | |
| NTP.SERVER2 | Communication | PUBLIC | 5.7.0 | SET|GET | server |
IP address or DNS name | Set the NTP server 2. | All | |
| OUTPUT-QUEUE.FLUSH | IO | PUBLIC | 4.1.0 | int |
[0-1] |
0: throw output away 1: send all output now |
To flush or send all output. | DM474, DM503, and DM300 series readers. | |
| OUTPUT.DELAY-DISTANCE | Decoder | PUBLIC | 4.4.0 | SET|GET | millimeters |
[0-100000] | Distance to output when using the Encoder. | DM474, DM503, and DM300 series readers. | |
| OUTPUT.DELAY-REFERENCE | Decoder | PUBLIC | 4.4.0 | SET|GET | mode |
[0-1] |
0: Trigger Start 1: Trigger End |
Sets or gets whether output is delayed relative to trigger start or trigger end. | DM50, DM60, DM70, DM474, DM503, and DM300 series readers. |
| OUTPUT.DELAY-TIME | Decoder | PUBLIC | 4.4.0 | SET|GET | milliseconds |
[0-10000] | Output delay in milliseconds. | DM50, DM60, DM70, DM503, DM300 series readers, DM474. | |
| OUTPUT.DELAY-TYPE | Decoder | PUBLIC | 4.4.0 | SET|GET | mode |
[0-1] |
0: None 1: Time |
Sets or gets whether output is delayed, and if so, whether according to time. | DM50, DM60, DM70, DM300 series readers, DM474. |
| OUTPUT.DELAY-TYPE | Decoder | PUBLIC | 4.4.0 | SET|GET | mode |
[0-2] |
0: None 1: Time 2: Distance |
Sets or gets whether output is delayed, and if so, whether according to time or distance. | DM503 |
| OUTPUT.PULSE-WIDTH | IO | PUBLIC | 3.0.0 | SET|GET | line ms |
[0-7] [0-30000] |
i/o line number milliseconds |
Output Pulse-width. | Fixed mount readers. |
| OUTPUT.RESERVED | IO | PUBLIC | 3.0.0 | SET|GET | line reserved |
[0-7] [ON|OFF] |
i/o line number enable/disable |
Output Reserved for External Illumination. Line will be controlled by acquisition system when enabled. | Fixed mount readers, except DM50, DM60 and DM70. |
| OUTPUT.USER-CONFIGURE | Communication | PUBLIC | 5.3.0 | SET|GET | event number beep tone beep number LED color vibration |
[1,2] [0-2] [0-3] [0-7] [ON|OFF] |
1: USER_EVENT_1 2: USER_EVENT_2 [0]: Low [1]: Medium [2]: High Number of beeps [0]: Off [1]: Blue [2]: Green [3]: Cyan [4]: Red [5]: Magenta [6]: Yellow [7]: White enable/disable ON: The reader vibrates on the given user event. OFF: The reader does not vibrate on the given user event. |
Sets the beeper tone and the number of beeps for USER_EVENT_1 or USER_EVENT_2. | DM8050 (except for the vibration parameter), ON|OFF is supported on DM8600 and MX-1000. |
| OUTPUT.USER1 | Action | PUBLIC | 5.3.0 | Device emits USER_EVENT_1 event. | DM8050, MX-1000, MX-1502, DM474, DM503 and DM300 series readers. | ||||
| OUTPUT.USER2 | Action | PUBLIC | 5.3.0 | Device emits USER_EVENT_2 event. | DM8050, MX-1000, MX-1502, DM474, DM503 and DM300 series readers. | ||||
| PCM-RESULT-STRING.EXTEND | Decoder | PUBLIC | 5.7.0 | SET|GET | enable |
[ON|OFF] | Enable or disable extending the result string with metric information. | Ethernet readers. | |
| PCM-RESULT-STRING.METRIC-FORMAT | Decoder | PUBLIC | 5.7.0 | SET|GET | type |
[0-2] |
0: Grade 1: Value 2: Grade + Value |
Set the format of a single metric entry. | Ethernet readers. |
| PCM-RESULT-STRING.METRIC-PREFIX | Decoder | PUBLIC | 5.7.0 | SET|GET | type |
[0-2] |
0: None 1: Acronym 2: Name |
Defines the prefix for a single metric entry. | Ethernet readers. |
| PCM-RESULT-STRING.METRIC-SEPARATOR | Decoder | PUBLIC | 5.7.0 | SET|GET | string |
Defines the metric separator. | Ethernet readers. | ||
| PCM-RESULT-STRING.OVERALL-GRADE | Decoder | PUBLIC | 5.7.0 | SET|GET | type |
[ON|OFF] | enable | Enables or disables showing the overall grade in at the beginning of the result string. | Ethernet readers. |
| PCM-RESULT-STRING.SEPARATOR | Decoder | PUBLIC | 5.7.0 | SET|GET | string |
Defines the main separator between result data and metric section. | Ethernet readers. | ||
| PCM.CUSTOM-DESCRIPTION | Decoder | PUBLIC | 5.7.0 | SET|GET | string |
Ethernet readers. | |||
| PCM.METRIC-PARM-OVERALL | Decoder | PUBLIC | 5.7.0 | SET|GET | type type state |
[0-5] [0-27] [ON|OFF] |
0: AIM-DPM 1: ISO-IEC 15415 2: ANSI-ISO-IEC 15416 3: SemiT10 4: 1D readability 5: DotCode Readybility 0: Symbol Contrast 1: Axial Non Uniformity 2: Print Growth 3: UEC 4: Modulation 5: Fixed Pattern Damage 6: Grid Non Uniformity 7: Extreme Reflectance 8: Reflect Min 9: Edge Contrast Min 10: Single Scan Int 11: Multi Scan Int 12: Signal To Noise Ratio 13: Horizontal Mark Growth 14: Vertical Mark Growth 15: Data Matrix Cell Width 16: Data Matrix Cell Height 17: Horizontal Mark Misplacement 18: Vertical Mark Misplacement 19: Cell Defects 20: Finder Pattern Defects 21: Overall Grade 22: Edge Determination 23: Defects 24: Reference Decode 25: Decodability 26: Contrast Uniformity 27: Reflectance Margin ON: use for overall calculation OFF: do not use for overall calculation |
Use the the metric grading result for calculating the overall result if enabled (e.g. AIM-DPM → Symbol Contrast → Use for Overall Calculation = ON) Not all metrics are available for each standard: AIM-DPM (0, 1, 2, 3, 4, 5, 6, 8), ISO-IEC 15415 (0, 1, 3, 4, 5, 6, 7), ANSI-ISO-IEC 15416 (1, 4, 8, 9, 22, 23, 24, 25), 1D readability (0, 2, 8, 9, 10, 11), DotCode (0, 1, 2, 3, 6, 8) | Ethernet readers. |
| PCM.METRIC-PARM-REPORT | Decoder | PUBLIC | 5.7.0 | SET|GET | type type state |
[0-5] [0-27] [ON|OFF] |
0: AIM-DPM 1: ISO-IEC 15415 2: ANSI-ISO-IEC 15416 3: SemiT10 4: 1D readability 5: DotCode Readybility 0: Symbol Contrast 1: Axial Non Uniformity 2: Print Growth 3: UEC 4: Modulation 5: Fixed Pattern Damage 6: Grid Non Uniformity 7: Extreme Reflectance 8: Reflect Min 9: Edge Contrast Min 10: Single Scan Int 11: Multi Scan Int 12: Signal To Noise Ratio 13: Horizontal Mark Growth 14: Vertical Mark Growth 15: Data Matrix Cell Width 16: Data Matrix Cell Height 17: Horizontal Mark Misplacement 18: Vertical Mark Misplacement 19: Cell Defects 20: Finder Pattern Defects 21: Overall Grade 22: Edge Determination 23: Defects 24: Reference Decode 25: Decodability 26: Contrast Uniformity 27: Reflectance Margin ON: include in report OFF: do not include in report |
Include the metric grading result for selected quality standard and metric in the report if enabled. Only available if not use for overall calculation (e.g. ISO-IEC 15415 → Modulation → Show in Report = ON) Not all metrics are available for each standard: AIM-DPM (0, 1, 2, 3, 4, 5, 6, 8), ISO-IEC 15415 (0, 1, 2, 3, 4, 5, 6, 7), ANSI-ISO-IEC 15416 (0, 4, 8, 9, 22, 23, 24, 25), SemiT10 (1, 4, 12, 13, 14, 15, 16, 17, 18, 19, 20), 1D readability (0, 2, 8, 9, 10, 11), DotCode (0, 1, 2, 3, 6, 8). | Ethernet readers. |
| PCM.METRIC-PARM-THRESHOLD | Decoder | PUBLIC | 5.7.0 | SET|GET | type type grade value |
[0-5] [0-25] [1-4] [0-1000] |
0: AIM-DPM 1: ISO-IEC 15415 2: ANSI-ISO-IEC 15416 3: SemiT10 4: 1D readability 5: DotCode Readybility 0: Symbol Contrast 1: Axial Non Uniformity 2: Print Growth 3: UEC 4: Modulation 5: Fixed Pattern Damage 6: Grid Non Uniformity 7: Extreme Reflectance 8: Reflect Min 9: Edge Contrast Min 10: Single Scan Int 11: Multi Scan Int 12: Signal To Noise Ratio 13: Horizontal Mark Growth 14: Vertical Mark Growth 15: Data Matrix Cell Width 16: Data Matrix Cell Height 17: Horizontal Mark Misplacement 18: Vertical Mark Misplacement 19: Cell Defects 20: Finder Pattern Defects 21: Overall Grade 22: Edge Determination 23: Defects 24: Reference Decode 25: Decodability 1: D 2: C 3: B 4: A Threshold raw value |
Set the raw value threshold for the selected quality standard, metric and grade (e.g. AIM-DPM → UEC → Threshold B = 50). Not all metrics are available for each standard: AIM-DPM (0, 1, 3, 4, 6, 8), ISO-IEC 15415 (0, 1, 3, 4, 6), ANSI-ISO-IEC 15416 (1, 4, 8, 9, 23, 25), 1D readability (0, 2, 8, 9, 11), DotCode (0, 1, 2, 3, 6, 8) | Ethernet readers. |
| PCM.MIN-PASS | Decoder | PUBLIC | 5.7.0 | SET|GET | type grade |
[0-5] [0-4] |
0: AIM-DPM 1: ISO-IEC 15415 2: ANSI-ISO-IEC 15416 3: SemiT10 4: 1D readability 5: DotCode Readybility 0: F 1: D 2: C 3: B 4: A |
Set the overall minimum passing grade. Results under this grade will mean the reading failed. | Ethernet readers. |
| PCM.USE-CUSTOM-THRESHOLDS | Decoder | PUBLIC | 5.7.0 | SET|GET | type state |
[0-5] [ON|OFF] |
0: AIM-DPM 1: ISO-IEC 15415 2: ANSI-ISO-IEC 15416 3: SemiT10 4: 1D readability 5: DotCode Readybility ON: do regrading OFF: keep current result |
Enable or disable regrading of metric results by using the custom thresholds. | Ethernet readers. |
| PHARMA.CODE-ORIENTATION | Symbology | PUBLIC | 3.4.0 | SET|GET | direction |
[0-2] |
0: Any (default) 1: Horizontal 2: Vertical |
Preferred orientation for decoding Pharmacode symbols. | ALL |
| PHARMA.CODESIZE | Symbology | PUBLIC | 3.4.0 | SET|GET | any min max |
[ON|OFF] [1-6] [1-6] |
any length code minimum code length maximum code length |
Expected Pharmacode size. | ALL |
| PHARMA.HORIZONTAL-DIRECTION | Symbology | PUBLIC | 3.4.0 | SET|GET | direction |
[0-1] |
0: left-to-right (default) 1: right-to-left |
Horizontal direction preference for decoding Pharmacode symbols. | ALL |
| PHARMA.VERTICAL-DIRECTION | Symbology | PUBLIC | 3.4.0 | SET|GET | direction |
[0-1] |
0: top-to-bottom (default) 1: bottom-to-top |
Vertical direction preference for decoding Pharmacode symbols. | ALL |
| PLANET.XMTCHK | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | PLANET Transmit Check Character. | ALL |
| POSTNET.XMTCHK | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | POSTNET Transmit Check Character. | ALL |
| POWER.HIBERNATE-DISABLE | System | PUBLIC | 4.2.1 | SET|GET | state |
[ON|OFF] | enable/disable | Turning the Hibernation feature on or off. ON means that the device never hibernates. OFF means that Hibernation is not disabled (it is enabled), thus the device will go into hibernation mode. | DM8000 wireless readers. |
| POWER.HIBERNATE-TIMEOUT | System | PUBLIC | 4.2.1 | SET|GET | int |
[1-600] | seconds | Hibernation timeout. | DM8000 wireless readers. |
| POWER.POWEROFF-DISABLE | System | PUBLIC | 4.2.1 | SET|GET | state |
[ON|OFF] | enable/disable | Turning the Power Off feature on or off. ON means that the device never turns off. OFF means that Power Off is not disabled (it is enabled), thus the device will turn off. | DM8050, DM8600, MX-1000 and MX-1502. |
| POWER.POWEROFF-TIMEOUT | System | PUBLIC | 4.2.1 | SET|GET | int |
[1-600] | seconds | Power Off timeout. | DM8050, DM8600, MX-1000 and MX-1502. |
| PROFINET.ENABLED | Communication | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enabled or disabled PROFINET communications. | Ethernet readers. The DM8000 series wireless readers also support this protocol if the base station is connected through Ethernet. In the case of a Bluetooth connection, the command has to be sent to the base station, not to the reader. |
| PTP-SYNC.DELAY | Communication | PUBLIC | 5.5.0 | SET|GET | time |
[0-1000000] | Time between trigger start and the synchronized acquisition timestamp. | DM360 series readers, DM474 | |
| PTP-SYNC.ENABLE | Communication | PUBLIC | 5.5.0 | SET|GET | mode |
[ON|OFF] | Enables MST synchronized by PTP. | DM360 series readers, DM474 | |
| PTP-SYNC.LOCAL-OFFSET | Communication | PUBLIC | 5.5.0 | SET|GET | time |
[0-1000000] | Local offset added to the synchronized acquisition timestamp. | DM360 series readers, DM474 | |
| PTP.ENABLE | Communication | PUBLIC | 5.5.0 | SET|GET | mode |
[ON|OFF] |
enable/disable
OFF: Disable the PTP timestamp synchronization ON: Enable the PTP timestamp synchronization |
Enable the PTP timestamp synchronization. | DM360 series readers, DM474 |
| PTP.PRIORITY1 | Communication | PUBLIC | 5.5.0 | SET|GET | level |
[0-255] | This is the first 8-bit priority value (lower number denotes a higher priority). Normally, this is set at 128 for master capable devices. | DM360 series readers, DM474 | |
| PTP.PRIORITY2 | Communication | PUBLIC | 5.5.0 | SET|GET | level |
[0-255] | This is the second 8-bit priority value (lower number denotes a higher priority). This parameter allows to configure backup clocks. | DM360 series readers, DM474 | |
| PTP.SLAVE-ONLY | Communication | PUBLIC | 5.5.0 | SET|GET | mode |
[ON|OFF] |
enable/disable
OFF: Disables PTP slave only configuration of the reader ON: Configures the reader as PTP slave only |
This parameter configures the reader as PTP slave only, even if no other master is active. | DM360 series readers, DM474 |
| QR.MAXIMUM-GRID-SIZE | Symbology | PUBLIC | 5.2.0 | SET|GET | size |
[49-177] | Step size: 4. | Maximum grid size which can be read by the QR decoder. | ALL |
| QR.MICRO | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Micro QR Code. | ALL except for DM300L, DM503L, and DM503QL. |
| QR.MODEL1 | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | QR model-1. | ALL except for DM300L, DM503L, and DM503QL. |
| QR.MODEL2 | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | QR model-2. | ALL except for DM300L, DM503L, and DM503QL. |
| QR.QUALITY-METRICS | Decoder | PUBLIC | 4.5.0 | SET|GET | type |
[0-2] |
0: none 1: ISO/IEC 15415 2: AIM-DPM / ISO/IEC TR 29158 |
Code quality metrics for QR codes. | ALL |
| QR.SYMBOL-DIFFICULTY | Symbology | PUBLIC | 5.1.0 | SET|GET | int |
[0-2] |
0: Easy 1: Medium 2: Hard |
Level of QR code symbol difficulty. | DM8600. |
| QR.TRAINED-MODEL | Decoder | PUBLIC | 5.7.0 | SET|GET | grid size module size model polarity mirrored |
[11-177] [1-1000] [0-3] [0-2] [ON|OFF] [ON|OFF] |
Grid size Module size * 10 0: Unknown model 1: Model-1 2: Model-2 3: Micro-QR 0: dark-on-light 1: light-on-dark 2: either enable/disable ON: mirrored OFF: not mirrored |
Set training parameters for QR-Code symbology. Option 3 for argument "model": Micro-QR is not applicable for 6.0.1. |
Fixed-mount readers |
| READER.ASSIGNED | Communication | PUBLIC | 5.2.0 | SET|GET | state |
[ON|OFF] | enable/disable | Unassignins the reader and the base station that is associated with it. | Base |
| REBOOT | Action | PUBLIC | 3.0.0 | Reboot the Device. Rebooting the Device restores the Configuration stored in Non-Volatile Memory. Commands will not be processed for several seconds while the device reboots. If communication settings are changed, connection with device may be lost. Note that when connected via USB-COM, the application must release the COM port. |
ALL | ||||
| REBOOT.DELAYED | Action | PUBLIC | 5.6.0 | Reboot the Device after delay in seconds. Rebooting the Device restores the Configuration stored in Non-Volatile Memory. Commands will not be processed for several seconds while the device reboots.If communication settings are changed, connection with device may be lost. Note that when connected via USB-COM, the application must release the COM port. | All | ||||
| RESULT | Action | PUBLIC | 3.0.0 | GET | target |
[0-1] |
0: Result string 1: XML formatted |
Optional Send Last Result. By default the result string is in ASCII format, but this can be changed to Base64 with the DATA.RESULT-ENCODING command. | ALL |
| RESULT.NO-READ-STRING | IO | PUBLIC | 3.0.0 | SET|GET | string |
no-read-string | No-Read Output String. | ALL | |
| RSS.EXPANDED | Symbology | PUBLIC | 4.4.0 | SET|GET | state |
[ON|OFF] | enable/disable | RSS Expanded. | ALL |
| SCRIPT.LOAD | Data Formatting | PUBLIC | 4.5.0 | num-bytes |
Loads the formatting script from the host to the reader. | DM50, DM60, DM70, DM474, DM503, MX-1000, MX-1502 and DM300 series readers. | |||
| SCRIPT.SEND | Data Formatting | PUBLIC | 4.5.0 | Sends the formatting script from the reader to the host. | DM50, DM60, DM70, DM474, DM503, MX-1000, MX-1502 and DM300 series readers. | ||||
| SDCARD.BACKUP-FILE | Communication | PUBLIC | 5.5.0 | SET|GET | state |
[ON|OFF] | enable/disable | SD card is used for creating and restoring a configuration file backup. | DM360 series readers, DM474 |
| SDCARD.PRESENT | Communication | PUBLIC | 5.5.0 | GET | Returns True if the SD card was detected, False otherwise. | DM360 series readers, DM474 | |||
| SETUP.ENABLE | Camera | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Setup Enable. One Setup must always be enabled. Enable the desired Setup, before disabiling another Setup. For DM300 series readers, this command works for the active setup. |
DM50, DM60, DM70, DM150, DM260, DM474, DM503, DM8600, MX-1000 and DM300 series readers. |
| SETUP.NAME | Camera | PUBLIC | 3.0.0 | SET|GET | name |
Setup Name. User defined name. |
DM50, DM60, DM70, DM150, DM260, DM474, DM503, DM8600, MX-1000, and DM300 series readers. | ||
| SETUP.PROG-TARGET | Camera | PUBLIC | 3.0.0 | SET|GET | category |
[0-3] |
0: General Purpose 1: Curved Surface 2: Under Marked 3: Mirrored Surface |
Setup Programming Target. Setup to be modified by subsequent commands. |
DM70, DM150, DM260, DM8600 and MX-1000 |
| SETUP.PROG-TARGET | Camera | PUBLIC | 5.0.0 | SET|GET | category |
[0-15] | A number signifying an already existing setup. | Setup Programming Target. Setup to be modified by subsequent commands. |
DM50, DM60, DM70, DM150, DM260, DM474, DM503 and DM300 series readers. |
| SETUP.START-WITH-LAST-READ | Camera | PUBLIC | 5.2.0 | SET|GET | mode |
[ON|OFF] |
enable/disable
OFF: Start with fixed setup ON: Start with setup of last good read |
Sets read setup. | DM8600, DM70, DM150, DM260, DM474, DM503, MX-1000, MX-1502 and DM300 series readers. |
| SETUP.START-WITH-SETUP | Camera | PUBLIC | 5.2.0 | SET|GET | setup |
[0-15] | setup number to start with | Starts read setup. | DM8600, DM70, DM150, DM260, DM474, DM503, MX-1000, MX-1502 and DM300 series readers. |
| SETUP.USE | Camera | PUBLIC | 5.2.0 | int state |
[1-15] [ON|OFF] |
Setup to change enable/disable Disables/Enables setup to be used. |
Adds or removes a setup from the list of usable Read Setups. | DM8600, DM70, DM150, DM260, DM474, DM503 and DM300 series readers. | |
| SLMP-PROTOCOL.ENABLED | Communication | PUBLIC | SET|GET | state |
[ON|OFF] | enable/disable | Enables or disables SLMP-Protocol communication. | Ethernet readers. DM8000 series wireless readers also support this protocol if the base station is connected through Ethernet. In the case of a Bluetooth connection, the command has to be sent to the base station, not to the reader. | |
| STATISTICS.RESET | Action | PUBLIC | 3.3.1 | Reset all statistics. | ALL | ||||
| SYMBOL.4STATE-AUS | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable 4-State Australia Post Symbology. | ALL except for DM150QL, DM260QL, DM300L, DM503L, and DM503QL. |
| SYMBOL.4STATE-IMB | Symbology | PUBLIC | 3.4.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable 4-State Intelligent Mail Barcode. | ALL except for DM150QL, DM260QL, DM300L, DM503L, and DM503QL. |
| SYMBOL.4STATE-JAP | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable 4-State Japan Post Symbology. | ALL except for DM150QL, DM260QL, DM300L, DM503L, and DM503QL. |
| SYMBOL.4STATE-UPU | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable 4-State UPU Symbology. | ALL except for DM150QL, DM260QL, DM300L, DM503L, and DM503QL. |
| SYMBOL.AZTECCODE | Symbology | PUBLIC | 5.0.0_cr2 | SET|GET | state |
[ON|OFF] | enable/disable | Enable Aztec code symbology. | DM70, DM150, DM260, DM503, DM300 series readers, DM474, DM8050, DM8600, MX-1000, MX-1502, Mobile. |
| SYMBOL.C11 | Symbology | PUBLIC | 5.7.1 | SET|GET | state |
[ON|OFF] | enable/disable | Enable Code 11 Symbology. | ALL |
| SYMBOL.C128 | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable Code 128 Symbology. | ALL |
| SYMBOL.C25 | Symbology | PUBLIC | 5.5.2 | SET|GET | state |
[ON|OFF] | enable/disable | Enable Code 25 Symbology. Manatee Works supports 7 subcodes: Standard, Interleaved, ITF-14, IATA, Matrix, COOP, and Inverted. | ALL |
| SYMBOL.C39 | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable Code 39 Symbology. | ALL |
| SYMBOL.C39-CONVERT-TO-C32 | Code Quality | PUBLIC | 5.5.0 | SET|GET | state |
[ON|OFF] | enable/disable | Parameter enables or disables Code39 to Code 32 conversion. | DM70, DM150, DM260 |
| SYMBOL.C39-CONVERT-TO-C32 | Symbology | PUBLIC | 5.5.0 | SET | state |
[ON|OFF] | enable/disable | Enables/disables the conversion of Code39 to Code32. | ALL |
| SYMBOL.C93 | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable Code 93 Symbology. | ALL |
| SYMBOL.CODABAR | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable Codabar Symbology. | ALL |
| SYMBOL.COOP | Symbology | PUBLIC | 5.7.1 | SET|GET | state |
[ON|OFF] | enable/disable | ALL | |
| SYMBOL.DATABAR | Symbology | PUBLIC | 3.4.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable Databar. It will enable EXPANDED and LIMITED in Manatee Works SDK (just like MX). | ALL |
| SYMBOL.DATAMATRIX | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable DataMatrix Symbology. | ALL except for DM150QL, DM260QL, DM300L, DM503L, and DM503QL. |
| SYMBOL.DOTCODE | Symbology | PUBLIC | 5.0.0_cr3 | SET|GET | state |
[ON|OFF] | enable/disable | Enable DotCode symbology. | DM70, DM150, DM260, DM300 series readers, DM474, DM8050X, DM8600, MX-1000, MX-1502, Mobile. |
| SYMBOL.EAN-UCC | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable EAN-UCC Symbology. | ALL |
| SYMBOL.I2O5 | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable Interleaved 2 of 5 Symbology. | ALL |
| SYMBOL.IATA | Symbology | PUBLIC | 5.7.1 | SET|GET | state |
[ON|OFF] | enable/disable | ALL | |
| SYMBOL.INVERTED | Symbology | PUBLIC | 5.7.1 | SET|GET | state |
[ON|OFF] | enable/disable | ALL | |
| SYMBOL.ITF14 | Symbology | PUBLIC | 5.7.1 | SET|GET | state |
[ON|OFF] | enable/disable | ALL | |
| SYMBOL.MATRIX | Symbology | PUBLIC | 4.7.1 | SET|GET | state |
[ON|OFF] | enable/disable | Enable Matrix symbology. | All. |
| SYMBOL.MAXICODE | Symbology | PUBLIC | 4.5.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable MaxiCode symbology. | DM50, DM60, DM70, DM150, DM260, DM300 series readers, DM474, DM503, DM8050, DM8600, MX-1000 and MX-1502, Mobile. |
| SYMBOL.MICROPDF417 | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable Micro-PDF 417 Symbology. | ALL |
| SYMBOL.MSI | Symbology | PUBLIC | 5.0.0_cr5 | SET|GET | state |
[ON|OFF] | enable/disable | Sets or gets whether MSI Code is enabled or disabled | DM70, DM150, DM260, DM503, DM300 series readers, DM474, MX-1000, MX-1502, Mobile. |
| SYMBOL.PDF417 | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable PDF 417 Symbology. | ALL |
| SYMBOL.PHARMACODE | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable Pharmacode symbology. | ALL |
| SYMBOL.PLANET | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable PLANET Symbology. | ALL except for DM150QL, DM260QL, DM300L, DM302L, DM503L, and DM503QL. |
| SYMBOL.POSTNET | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable POSTNET Symbology. | ALL except for DM150QL, DM260QL, DM300L, DM503L, and DM503QL. |
| SYMBOL.QR | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable QR-Code Symbology. Enables QR and Micro QR in Manatee Works SDK. | ALL except for DM150QL, DM260QL, DM300L, DM503L and DM503QL. |
| SYMBOL.UPC-EAN | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable UPC/EAN Symbology. It will enable UPC-A, UPC-E, EAN-8, and EAN-13 in Manatee Works SDK (just like MX). | ALL |
| SYMBOL.VERICODE | Symbology | PUBLIC | 3.2.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable VeriCode ® symbology. | DM70, DM150 and DM260 readers with VeriCode ® license. |
| SYNC-ACQUISITION.CABLE-END | Communication | PUBLIC | 5.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Sets or gets whether your device is a bus terminator at the end of the synchronization interface bus. | DM503 |
| SYNC-ACQUISITION.DELAY | Communication | PUBLIC | 5.0.0 | SET|GET | us |
[0-25000] | microseconds | Synchronized acquisition delay: the time the reader waits after sending or receiving the synchronized interface signal before the regular acquisition sequence starts. | DM503 |
| SYNC-ACQUISITION.ENABLED | Communication | PUBLIC | 5.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enables or disables synchronized triggering. | DM503 |
| SYNC-ACQUISITION.MASTER | Communication | PUBLIC | 5.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Sets or gets whether the device is the master among the synchronized readers. | DM503 |
| TELNET.CUSTOM-PORTS | Communication | PUBLIC | 5.5.0 | SET|GET | port |
[0-65535] | Comma separated list of TCP ports | Additional Telnet TCP ports for custom communication. | Ethernet readers |
| TELNET.PORT | Communication | PUBLIC | 3.3.0 | SET|GET | value |
[0-65535] | Telnet server TCP port on reader. | Ethernet readers. | |
| TEST-MODE.ACCEPT-TRIGGERS | Communication | PUBLIC | 5.2.0 | value |
[0-2000000000] | number of accepted triggers from all inputs | Allows a limited number of triggers from external inputs even if triggering from those should be rejected using TEST-MODE.INPUTS-ENABLE. | DM70, DM150, DM260, DM474, DM503 and DM300 series readers. | |
| TEST-MODE.AUTOMATIC | Communication | PUBLIC | 5.2.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enables automatic triggering. | DM70, DM150, DM260, DM474, DM503 and DM300 series readers. |
| TEST-MODE.AUTOMATIC-OFF-US | Communication | PUBLIC | 5.2.0 | SET|GET | microseconds |
[0-2000000000] | Inactive trigger phase for automatic triggering. | DM70, DM150, DM260, DM474, DM503 and DM300 series readers. | |
| TEST-MODE.AUTOMATIC-ON-US | Communication | PUBLIC | 5.2.0 | SET|GET | microseconds |
[0-2000000000] | Active trigger phase for automatic triggering. | DM70, DM150, DM260, DM474, DM503 and DM300 series readers. | |
| TEST-MODE.ENABLE | Communication | PUBLIC | 5.2.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enables test mode. | DM70, DM150, DM260, DM474, DM503 and DM300 series readers. |
| TEST-MODE.INPUTS-ENABLE | Communication | PUBLIC | 5.2.0 | SET|GET | state |
[ON|OFF] | enable/disable | Disables external trigger sources during test mode. | DM70, DM150, DM260, DM474, DM503 and DM300 series readers. |
| TEST-MODE.OUTPUTS-ENABLE | Communication | PUBLIC | 5.2.0 | SET|GET | state |
[ON|OFF] | enable/disable | Disables result reporting to external destinations during test mode. | DM70, DM150, DM260, DM474, DM503 and DM300 series readers. |
| TRAIN.BRIGHT | Action | PUBLIC | 3.0.0 | type |
[ON|OFF] |
ON: Start Train Brightness Algorithm OFF: Abort Train Brightness Algorithm |
Generate a fixed value for the exposure setting based on the particular scene, similar to the Optimize Brightness button in the Setup Tool. | Fixed mount devices. | |
| TRAIN.CODE | Action | PUBLIC | 3.0.0 | state |
[ON|OFF] | enable/disable | Train symbology using next sucessful decode. | Fixed mount devices. | |
| TRAIN.FOCUS | Action | PUBLIC | 3.3.0 | state |
[ON|OFF] | enable/disable | Optimize lens focus. | DM503, DM474 and DM300 series readers. | |
| TRAIN.INCREMENTAL | Symbology | PUBLIC | 3.2.0 | SET|GET | state |
[ON|OFF] | enable/disable | Indicates whether incremental training is used during the next attempt to train. | Fixed mount readers. |
| TRAIN.MATCH-STRING | Action | PUBLIC | 3.1.0 | Triggers the reader and sets the match string to the value of the decoded string. Match String validation must be enabled for this command to work. | Fixed mount devices, DM8050 and DM8600. | ||||
| TRAINED-CODE.INFO | Symbology | PUBLIC | 4.4.0 | GET | Gets information about the currently trained code type ('Untrained' if no code is trained). | Fixed mount devices. | |||
| TRIGGER | Action | PUBLIC | 3.0.0 | state |
[ON|OFF] |
enable/disable
ON: Scanning process is initiated, displaying the preview if necessary, decoding frames, etc. OFF: Scanning process is terminated, even if a barcode has not been decoded. |
Software Trigger. | ALL | |
| TRIGGER | Action | PUBLIC | 3.6.0 | GET | state |
[0|1] |
0: Off 1: On |
Get current state of the trigger. | ALL |
| TRIGGER.DEBOUNCE-DELAY | IO | PUBLIC | 4.0.0 | SET|GET | delay |
[0-6] |
0: short 1: 2: default 3: 4: 5: 6: long |
Sets or gets how long the trigger signal must be detected in order to be recognized as valid. | Fixed-mount readers. |
| TRIGGER.DELAY-DISTANCE | Camera | PUBLIC | 4.4.0 | SET|GET | millimeter |
[0-2147483646] | Delay camera acquisition by distance specified in millimeters. | DM503, DM474 and DM300 series readers. | |
| TRIGGER.DELAY-TIME | Camera | PUBLIC | 4.4.0 | SET|GET | milliseconds |
[0-10000] | Trigger delay in milliseconds. Delay camera acquisition by specified number of milliseconds. |
DM50, DM60, DM70, DM474, DM503, and DM300 series readers. | |
| TRIGGER.DELAY-TYPE | Camera | PUBLIC | 4.4.0 | SET|GET | mode |
[0-1] |
0: none 1: time |
Sets or gets whether trigger delay is according to time. | DM50, DM60 and DM70 |
| TRIGGER.DELAY-TYPE | Camera | PUBLIC | 4.4.0 | SET|GET | mode |
[0-2] |
0: none 1: time 2: distance |
Sets or gets whether trigger delay is according to time or distance. | DM503, DM474 and DM300 series readers. |
| TRIGGER.END-DELAY-DISTANCE | Camera | PUBLIC | 4.4.0 | SET|GET | millimeters |
[0-2147483646] | Sets or gets trigger end delay distance. | DM474, DM503 and DM300 series readers. | |
| TRIGGER.END-DELAY-TIME | Camera | PUBLIC | 4.4.0 | SET|GET | milliseconds |
[0-10000] | Sets or gets trigger end delay time. | DM50, DM60, DM70, DM474, DM503, and DM300 series readers. | |
| TRIGGER.END-HOLDOFF-DISTANCE | IO | PUBLIC | 5.5.0 | SET|GET | distance |
[0-10000 mm] | distance for hold-off at trigger end | When greater than 0, the distance with which to cancel a pending trigger off and allow the trigger to continue. | DM474, DM503 and DM300 series readers. |
| TRIGGER.END-HOLDOFF-TIME | IO | PUBLIC | 5.5.0 | SET|GET | rime |
[0-10000 ms] | time for hold-off at trigger end | When greater than 0, the time with which to cancel a pending trigger off and allow the trigger to continue. | Fixed-mount readers |
| TRIGGER.HOLDOFF-DISTANCE | IO | PUBLIC | 5.5.0 | SET|GET | distance |
[0-10000 mm] | distance for hold-off at trigger start | When greater than 0, the distance with which to cancel a pending trigger on and act like there was no trigger at all. | DM474, DM503 and DM300 series readers. |
| TRIGGER.HOLDOFF-TIME | IO | PUBLIC | 5.5.0 | SET|GET | time |
[0-10000 ms] | time for hold-off at trigger start | When greater than 0, the time with which to cancel a pending trigger on and act like there was no trigger at all. | Fixed-mount readers |
| TRIGGER.HOLDOFF-TYPE | IO | PUBLIC | 5.5.0 | SET|GET | type |
[0-2] |
0 = None 1 = Time 2 = Distance |
Which type of trigger hold-off to use, none, time or distance. | Fixed-mount readers |
| TRIGGER.POLARITY | IO | PUBLIC | 4.0.0 | SET|GET | line polarity |
[0-3] [ON|OFF] |
Input line ON: Rising edge OFF: Falling edge |
Sets or gets the polarity at which an input will be triggered. | Fixed mount readers. |
| TRIGGER.TYPE | Camera | PUBLIC | 3.0.0 | SET|GET | type |
[0-5] |
0: Single (external) 1: Presentation (internal) 2: Manual (button) 3: Burst (external) 4: Self (internal) 5: Continuous (external) |
Trigger Type. The camera API should return the current trigger type value. | DM700 and DM8000 series readers support only Presentation and Manual trigger types. MX-1000, MX-1502 and Mobile support only Manual and Continuous trigger types. |
| TRUCHECK.AG | Decoder | PUBLIC | 5.7.7 | GET | Returns the AG (average grade) score from the last verification attempt. | DM8072 Verifier | |||
| TRUCHECK.AG-GRADE | Decoder | PUBLIC | 5.7.7 | GET | Returns the AG (average grade) grade from the last verification attempt. | DM8072 Verifier | |||
| TRUCHECK.ANU | Decoder | PUBLIC | 5.7.7 | GET | Returns the ANU (axial non-uniformity) score from the last verification attempt. | DM8072 Verifier | |||
| TRUCHECK.ANU-GRADE | Decoder | PUBLIC | 5.7.7 | GET | Returns the ANU (axial non-uniformity) grade from the last verification attempt. | DM8072 Verifier | |||
| TRUCHECK.DECODE-GRADE | Decoder | PUBLIC | 5.7.7 | GET | Returns the DECODE grade from the last verification attempt. | DM8072 Verifier | |||
| TRUCHECK.FPD | Decoder | PUBLIC | 5.7.7 | GET | Returns the FPD (fixed pattern damage) score from the last verification attempt. | DM8072 Verifier | |||
| TRUCHECK.FPD-GRADE | Decoder | PUBLIC | 5.7.7 | GET | Returns the FPD (fixed pattern damage) grade from the last verification attempt. | DM8072 Verifier | |||
| TRUCHECK.GNU | Decoder | PUBLIC | 5.7.7 | GET | Returns the GNU (grid non-uniformity) score from the last verification attempt. | DM8072 Verifier | |||
| TRUCHECK.GNU-GRADE | Decoder | PUBLIC | 5.7.7 | GET | Returns the GNU (grid non-uniformity) grade from the last verification attempt. | DM8072 Verifier | |||
| TRUCHECK.MOD-GRADE | Decoder | PUBLIC | 5.7.7 | GET | Returns the MOD (modulation) grade from the last verification attempt. | DM8072 Verifier | |||
| TRUCHECK.RM-GRADE | Decoder | PUBLIC | 5.7.7 | GET | Returns the RM grade from the last verification attempt. | DM8072 Verifier | |||
| TRUCHECK.SC | Decoder | PUBLIC | 5.7.7 | GET | Returns the SC (symbol contrast) score from the last verification attempt. | DM8072 Verifier | |||
| TRUCHECK.SC-GRADE | Decoder | PUBLIC | 5.7.7 | GET | Returns the SC (symbol contrast) grade from the last verification attempt. | DM8072 Verifier | |||
| TRUCHECK.UEC | Decoder | PUBLIC | 5.7.7 | GET | Returns the UEC (unused error correction) score from the last verification attempt. | DM8072 Verifier | |||
| TRUCHECK.UEC-GRADE | Decoder | PUBLIC | 5.7.7 | GET | Returns the UEC (unused error correction) grade from the last verification attempt. | DM8072 Verifier | |||
| TUNE-BUTTON.3SEC-ACTION | System | PUBLIC | 5.0.0 | SET|GET | action state |
[0-6] [ON|OFF] |
action code (see BUTTON.3SEC-ACTION), enabled enable/disable |
Defines actions when the user pushes the tune button for more than 3 seconds. | DM474, DM503 and DM300 readers. |
| TUNE-BUTTON.3SEC-ACTION | System | PUBLIC | 5.4.0 | SET|GET | action state |
[2,7] [ON|OFF] |
2: Set Match String 7: Extended Read Attempts enable/disable |
Defines actions when the user pushes the tune button for more than 3 seconds. | DM8600 readers. |
| TUNE-BUTTON.ENABLE | IO | PUBLIC | 5.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enables or disables the tune button. | DM474, DM503, and DM300 series readers. |
| TUNE-BUTTON.SAVE-MATCH-STRING | System | PUBLIC | 5.2.0 | SET|GET | state |
[ON|OFF] | enable/disable tune button enabled | Enables the 'save match string' action when the user pushes the tune button for more than 3 seconds. | DM474, DM503, DM8600 and DM300 readers. |
| TUNE.ADJUST-FOCUS | Camera | PUBLIC | 4.3.0 | SET|GET | state |
[ON|OFF] | Enables or disables using adjusting focus while tuning. | DM70, DM150, DM260, DM474 and DM300 series readers with liquid lens. | |
| TUNE.CANCEL | Action | PUBLIC | 4.3.0 |
|
0: Tuning is cancelled. 104: Tuning is not running or there is an error. 101: Tuning is not available. |
Cancel tuning. | DM300 series readers, DM474, DM70, DM260, and DM150. | ||
| TUNE.EXCLUDE-AMBIENT-RESULTS | Camera | PUBLIC | 5.7.0 | SET|GET | disable ambient |
[ON|OFF] |
ON: Disables the automatic selection of ambient light results OFF: Allows ambient light results for atomatic seletion |
Control the automatic selection of tuning results where the prevailing illumination type is ambient light. | Fixed mount readers. |
| TUNE.START | Action | PUBLIC | 4.3.0 |
|
0: Tuning started. 104: Tuning is already running or there is an error. 101: Tuning is not available. |
Start tuning. | DM300 series readers, DM474, DM70, DM260, and DM150. | ||
| TUNE.STATUS | Action | PUBLIC | 5.5.0 | GET | Returns ON if tuning is running, OFF otherwise. | Fixed mount devices. | |||
| TUNE.TRAIN-CODE | Camera | PUBLIC | 4.3.0 | SET|GET | state |
[ON|OFF] | Enables or disables code training while tuning. | DM300 series readers, DM474, DM70, DM260, and DM150. | |
| TUNE.TUNE-LIGHT-BANKS | Camera | PUBLIC | 4.3.0 | SET|GET | state |
[ON|OFF] | Enables or disables using light banks while tuning. Only available when internal illumination is used. |
DM300 series readers, DM474, DM260, DM70 and DM150. | |
| TUNE.TUNE-LIGHT-COMBINATIONS | Camera | PUBLIC | 5.5.0 | SET|GET | mode |
[ON|OFF] | If it is ON, light combinations will always be tuned. | DM300 series readers, DM474, DM260, DM70 and DM150. | |
| UNTRAIN.MODEL | Action | PUBLIC | 3.2.0 | enum index |
[0-5] 0 |
0: All Symbologies 1: DataMatrix 2: QR Code/MaxiCode/AztecCode 3: Linear/ Postal/ Stacked 4: VeriCode® 5: DotCode |
Deletes the specified model. AztecCode is only supported on the DM503 and DM300 series readers. |
Fixed mount readers. | |
| UPC-EAN.DELZERO | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | UPC/EAN Delete Leading Zero. | ALL |
| UPC-EAN.EAN13 | Symbology | PUBLIC | 5.7.1 | SET|GET | state |
[ON|OFF] | enable/disable | UPC/EAN Allow EAN13. | ALL |
| UPC-EAN.EAN8 | Symbology | PUBLIC | 5.7.1 | SET|GET | state |
[ON|OFF] | enable/disable | UPC/EAN Allow EAN8. | ALL |
| UPC-EAN.EAN8SUPL | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | UPC/EAN Allow EAN8 Supplementals. | ALL |
| UPC-EAN.EXPANDED | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | UPC/EAN Expanded. | ALL |
| UPC-EAN.SUPPLEMENT | Symbology | PUBLIC | 3.0.0 | SET|GET | option |
[0-4] |
0: Ignore 1: Required 2: Required 2 digit 3: Required 5 digit 4: Not required |
UPC/EAN Supplementals. The Manatee Works SDK only supports turning UPC/EAN supplement code support on/off, while the DMCC command allows them to be off, required, require a 2 digit, require a 5 digit, or optionally permit them. The Manatee Works SDK will treat options 1-4 the same; to simply enable them. | ALL |
| UPC-EAN.UPC-A | Symbology | PUBLIC | 5.7.1 | SET|GET | state |
[ON|OFF] | enable/disable | UPC/EAN UPC-A enabled. | ALL |
| UPC-EAN.UPC-E | Symbology | PUBLIC | 5.7.1 | SET|GET | state |
[ON|OFF] | enable/disable | UPC/EAN UPC-E enabled. | ALL |
| UPC-EAN.UPCE1 | Symbology | PUBLIC | 5.7.1 | SET|GET | state |
[ON|OFF] | enable/disable | UPC/EAN UPCE1 enabled. | ALL |
| UPC-EAN.UPCE1 | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | UPC/EAN UPCE1 Enabled. | ALL |
| UPTIME | Action | PUBLIC | 5.7.0 | Shows the time since device started. | All | ||||
| VIBRATION.GOOD | System | PUBLIC | 3.1.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enables vibration. | Handheld readers, except for DM8050. |
| WIFI.AUTH-MODE | Communication | PUBLIC | 4.2.4 | SET|GET | int |
[0-3] |
0 – no auth 1 – WPA-PSK 2 – WPA2-PSK 3 – EAP/TLS 4 – PEAP-MSCHAPV2 |
Sets the authentication method. | DM8000 |
| WIFI.CA-CERT | Communication | PUBLIC | 4.2.4 | SET|GET | string |
NA | Used In WPA-Enterprise. This is the certificate of the certification authority we trust. | PEM formatted certificate, terminated by a space. | DM8000;Base |
| WIFI.CHANNEL | Communication | PUBLIC | 4.2.4 | SET|GET | int |
[1-11] | Sets the wifi channel number. | ||
| WIFI.CLIENT-CERT | Communication | PUBLIC | 4.2.4 | SET|GET | string |
NA | Used in WPA-Enterprise (EAP-TLS). This is the certificate of the reader signed by the trusted CA (set with the previous command). | PEM formatted certificate, terminated by a space. | DM8000;Base |
| WIFI.CLIENT-IDENTITY | Communication | PUBLIC | 4.2.4 | SET|GET | string |
NA | The identity the client certificate is issued to. | DM8000;Base | |
| WIFI.CLIENT-PRIVATE-KEY | Communication | PUBLIC | 4.2.4 | SET|GET | string |
NA | Used in WPA-Enterprise (EAP-TLS). The private key of the reader. | PEM formatted private key, terminated by a space. | DM8000;Base |
| WIFI.ENABLED | Communication | PUBLIC | 4.2.4 | SET|GET | state |
[ON|OFF] | enable/disable | Enables or disables wifi in ad-hoc mode. | |
| WIFI.ENC-METHOD | Communication | PUBLIC | 4.2.4 | SET|GET | int |
[0-5] |
0 – off 1 – WEP40 2 – WEP104 3 – TKIP 4 – AES 5 – TKIP/AES |
Sets the authentication method. | DM8000;Base |
| WIFI.NETWORK-TYPE | Communication | PUBLIC | 4.2.4 | SET|GET | int |
[0-1] |
0 – Infrastructure mode 1 – AD-HOC mode |
Sets whether wifi works in infrastructure or ad-hoc mode. | DM8000 |
| WIFI.PASSPHRASE | Communication | PUBLIC | 4.2.4 | SET|GET | string |
NA | In WEP encrpytion and in WPA(2)-PSK it is the passphrase set by the AP. | DM8000;Base | |
| WIFI.SSID | Communication | PUBLIC | 4.2.4 | SET|GET | string |
NA | Assigns an SSID name to the network. | ||
| CAMERA.FOV | Camera | PREVIEW | 3.2.0 | SET|GET | left (multiple of 8) right (multiple of 8) top (multiple of 4) bottom (multiple of 4) |
[0...] [left+64...] [0...] [top+64...] |
pixels from left pixels from right pixels from top pixels from bottom |
The camera field of view is the area of the camera used for image acquisition. | ALL |
| INTER-MESSAGE.DELAY | Communication | PREVIEW | 3.2.0 | SET|GET | value |
[0-10000] | milliseconds | Transmission delay between buffered read strings. | Wireless readers. |
| LIGHT.EXTERNAL-PRECHARGE-TIME | Camera | PREVIEW | 3.0.0 | SET|GET | time |
[1-980] | microseconds | External light precharge time. | Fixed mount readers. |
| OUTPUT.ACTION | IO | PREVIEW | 3.0.0 | SET|GET | line action |
[0-7] [0-1] |
line number 0: Open 1: Close |
Output Action. Open or Close output line on event. Only supported on line 1. |
Fixed mount readers. |
| OUTPUT.DATAVALID-FAIL | Action | PREVIEW | 3.0.0 | Virtual Data Validation Failure. Device beeps, flashes indicator lights, and sets output lines as if the specified Data Validation failure event occurred. |
ALL | ||||
| OUTPUT.EVENTS | IO | PREVIEW | 3.0.0 | SET|GET | line read no-read validation-failure trigger-overrun buffer-overflow user event 1 user event 2 |
[0-7] [0-1] [0-1] [0-1] [0-1] [0-1] [0-1] [0-1] |
i/o line number 0: Off 1: On 0: Off 1: On 0: Off 1: On 0: Off 1: On 0: Off 1: On 0: Off 1: On 0: Off 1: On |
Output Events. Configure output line to signal based on event. |
Fixed mount readers. |
| OUTPUT.GOOD | Action | PREVIEW | 3.0.0 | Virtual Good-Read. Device beeps, flashes indicator lights, and sets output lines as if the specified read event occurred. |
ALL | ||||
| OUTPUT.NOREAD | Action | PREVIEW | 3.0.0 | Virtual No-Read. Device beeps, flashes indicator lights, and sets output lines as if the specified no-read event occurred. |
ALL | ||||
| TRAIN.AUTO-DISABLE | Symbology | PREVIEW | 3.2.0 | SET|GET | state |
[ON|OFF] | enable/disable | Indicates whether untrained symbology groups will be disabled after the next attempt to train. | Fixed mount readers. |
| 3DVECTOR.CALIBRATED | Action | PRIVATE | 5.5.0 | GET | calibration_status |
[0-2] |
0:Neither factory, nor field calibration present 1:Only factory calibration loaded 2:Factory and field calibration loaded |
Query current calibration status. | ALL |
| 3DVECTOR.ENABLED | Action | PRIVATE | 5.5.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enables/disables the 3DVectoring functionality on the reader. | ALL |
| 3DVECTOR.FCALIB-CVL.LOAD | Action | PRIVATE | 5.5.0 | size_bytes |
Load factory calibration data blob in CVL style. | ALL | |||
| 3DVECTOR.FCALIB-CVL.SEND | Action | PRIVATE | 5.5.0 | Send factory calibration data blob in CVL style. | ALL | ||||
| 3DVECTOR.FCALIB-CVT.LOAD | Action | PRIVATE | 5.5.0 | size_bytes |
Load factory calibration data blob in CVT style. | ALL | |||
| 3DVECTOR.FCALIB-CVT.SEND | Action | PRIVATE | 5.5.0 | Send factory calibration data blob in CVT style. | ALL | ||||
| 3DVECTOR.LENGTH | Action | PRIVATE | 5.5.0 | SET|GET | This sets/gets the length of the output 3D line segment. | ALL | |||
| 3DVECTOR.SCALIB.LOAD | Action | PRIVATE | 5.5.0 | size_bytes |
Load system calibration data blob. | ALL | |||
| 3DVECTOR.SCALIB.SEND | Action | PRIVATE | 5.5.0 | Send system calibration data blob. | ALL | ||||
| ABORT | Action | PRIVATE | 3.0.0 | Abort command in process. Intended to abort image transfer. | ALL | ||||
| ANDROID.USB-ROLE-CHANGE | Action | PRIVATE | 5.7.1 | SET|GET | enabled timeout |
[ON|OFF] |
ON: (default) role change enabled, reader operates as usual OFF: role change disabled, reader stays in device mode Timeout in seconds after which the role change is automatically enabled again. |
Disables the USB role change. If role change is disabled, the reader stays in device mode, meaning the phone is not charged. If the role change is disabled, a timeout must be provided in seconds after which the role change is automatically enabled again. | ALL |
| BLUETOOTH.KBM-PIN | Communication | PRIVATE | 5.4.3 | SET|GET | string |
0-16 characters of decimal number | PIN number (e.g. "1234") | Gets or sets the PIN number of the remote target. | DM8050, DM8600. |
| BLUETOOTH.KBM-TARGET-ADDR | Communication | PRIVATE | 5.4.3 | SET|GET | string |
8 characters of hexadecimal number | MAC address (e.g. "0006660492A6") | Gets or sets the MAC address of the remote target. | DM8050, DM8600. |
| BLUETOOTH.OPERATION-MODE | Communication | PRIVATE | 5.4.3 | SET|GET | number |
[0-2] |
0: normal mode 1: PC connect mode 2: keyboard emulator mode |
Gets or sets the Bluetooth operation mode. | DM8050, DM8600. |
| BUTTON.VIRTUAL | Action | PRIVATE | 5.4.0 | int state |
[ON|OFF] |
Denotes the button id. enable/disable Denotes the new state of the button. |
Allows to virtually push the TUNE button for more than 3 seconds on a DM8600 to activate "magic mode". | DM8600 | |
| CAMERA.BURST-TRANSFER-ALL | Camera | PRIVATE | 3.3.0 | SET|GET | state |
[ON|OFF] | enable/disable | Force transfer of all burst images. Used by the DMCC .NET. |
|
| CAMERA.ENABLE | Camera | PRIVATE | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enables camera which can be disabled when loading images from the PC. | ALL |
| CAMERA.EXPOSURE | Camera | PRIVATE | 3.0.0 | SET|GET | auto target exposure gain |
[ON|OFF] [0-255] [0-20] [1-19] |
ON: Automatic OFF: Manual target pixel value 0: 1/20000 1: 1/10000 2: 1/7500 3: 1/5000 4: 1/3000 5: 1/2500 6: 1/2000 7: 1/1500 8: 1/1250 9: 1/1000 10: 1/750 11: 1/500 12: 1/300 13: 1/250 14: 1/200 15: 1/150 16: 1/125 17: 1/100 18: 1/75 19: 1/50 20: 1/40 camera gain |
Camera Parameters. The arguments 'exposure' and 'gain' have no effect if 'auto' is ON and the 'target' has no effect if 'auto' is OFF. | DM7500 |
| CAMERA.HDR-ESTIMATED-SCENE-KEY | Camera | PRIVATE | 6.1.0 | SET|GET | estimated scene key |
[0-4095] | Estimated scene key parameter for HDR | DM370 series, DM470 series readers. | |
| CAMERA.MAX-EXPOSURE | Camera | PRIVATE | 3.0.0 | SET|GET | exposure |
[0-20] |
0: 1/20000 1: 1/10000 2: 1/7500 3: 1/5000 4: 1/3000 5: 1/2500 6: 1/2000 7: 1/1500 8: 1/1250 9: 1/1000 10: 1/750 11: 1/500 12: 1/300 13: 1/250 14: 1/200 15: 1/150 16: 1/125 17: 1/100 18: 1/75 19: 1/50 20: 1/40 |
Maximum exposure limit for autoregulation. | MX-1000 and DM8000 series readers. |
| CODABAR.QZ-SIZE | Symbology | PRIVATE | 3.0.0 | SET|GET | state |
[0|100] | Quiet zone single strictness size. | ALL | |
| CODABAR.XMT-START-STOP-CHAR | Decoder | PRIVATE | 6.0.0 | SET|GET | state |
[ON|OFF] |
ON: Enable OFF: Disable |
Enable or disable transmitting start and stop character as part of the decoded string. | Ethernet readers |
| COM.ALTERNATE-MODE-DISABLE | Decoder | PRIVATE | 5.7.0 | SET|GET | enable |
[ON|OFF] |
ON: alternate mode cable detection enabled OFF: alternate mode cable detection disabled |
Disables alternate mode cable detection. | DM70 |
| COM.AUTO-DETECT | Communication | PRIVATE | 3.0.0 | SET|GET | state |
[ON|OFF] [ON|OFF] | enable/disable | Enables support for simultaneous connection to USB And RS-232. | |
| COM.BUFFER-DATA | IO | PRIVATE | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | ||
| COM.DATA-BITS | IO | PRIVATE | 3.0.0 | SET|GET | bits |
[7|8] | RS232 data bits | ||
| COM.DMCC-CHECKSUM | Communication | PRIVATE | 3.4.0 | SET|GET | type |
[0-3] |
0: none 1: XOR 2: CRC16 (Header/Response) 3: CRC16 (Header/Response/Data) |
Checksum used in DMCC response. | |
| COM.DMCC-EVENT | Communication | PRIVATE | 4.2.0 | SET|GET | event_mask |
[0-255] bitfield |
0: none 1: reader online/offline |
Sets which events are sent over DMCC. Used by DataMan SDK. | Wireless readers, base station. |
| COM.DMCC-HEADER | Communication | PRIVATE | 3.4.0 | SET|GET | type |
[0-1] |
0: default 1: include result ID |
Sets or gets the header option used in Extended mode. | |
| COM.DMCC-RESPONSE | Communication | PRIVATE | 3.0.0 | SET|GET | mode |
[0-2] |
0: Silent (default) 1: Extended 2: Extended mode with ||[xxx::length] CR NL data Responses |
DMCC response format. | ALL |
| COM.INTERFACE | Communication | PRIVATE | 5.4.3 | GET | Supported interfaces: RS232, USB, Ethernet, WiFi, Bluetooth. | ||||
| COM.RS232-FILTER | Communication | PRIVATE | 5.0.0_cr7 | SET|GET | state |
[ON|OFF] | enable/disable | Enable or disable the RS-232 filter. | DM300 series readers, DM474. |
| COM.RS232-FILTER-CHAR | Communication | PRIVATE | 5.0.0_cr7 | SET|GET | char |
[0x00-0xFF] | Hex char | Sets or gets the hex value of the character to start filtering after (e.g. 0x03 for ETX). | DM300 series readers, DM474. |
| COM.SCRIPT | Communication | PRIVATE | 5.3.0 | SET|GET | num-bytes |
Load script from communication channel. | DM474, DM503 and DM300 series readers. | ||
| COM.SCRIPT-ENABLED | Communication | PRIVATE | 5.3.0 | SET|GET | bool |
DM474, DM503 and DM300 series readers. | |||
| COM.USB-TEST-SN | Communication | PRIVATE | 4.2.0 | SET|GET | string |
test serial number | Used by manufacturing to make different devices enumerate on the same CDC COM port. | Base station, DM50, DM60 and DM70. | |
| COM.USB-USE-TEST-SN | Communication | PRIVATE | 4.2.0 | SET|GET | state |
[ON|OFF] [ON|OFF] | enable/disable | Used by manufacturing to make different devices enumerate on the same CDC COM port. | Base station, DM50, DM60 and DM70. |
| CONFIG.DUMP-UIDS | Action | PRIVATE | 3.0.0 | Returns all value tree parameters. | ALL | ||||
| CONFIG.SAVE-DEFAULTS | Action | PRIVATE | 5.4.0 | Saves current settings as defaults. This command does not reboot the device. | ALL | ||||
| CONTROL.RPC | Action | PRIVATE | 4.2.0 | SET|GET | string |
RP code to execute. | Executes RP codes passed as string. Used internally to route RP commands to the base station. | ALL | |
| CPFLASH.WRITE | Camera | PRIVATE | 5.0.0 | id |
[0-4] |
0: Unknown 1: Prototype 2: Alpha build with SRAM 3: Alpha build with SDRAM 4: Beta build |
Flash camera port ID. | DM 503. | |
| DATA.IMAGE-TYPE | Communication | PRIVATE | 3.4.0 | SET|GET | type |
[0-2] |
0: all 1: no read 2: read |
Sets or gets type of image automatically returned. Used in conjuction with DATA.RESULT-TYPE. | |
| DATA.RESULT-ALWAYSSEND | System | PRIVATE | 3.1.0 | SET|GET | state |
[ON|OFF] | enable/disable | Sets gets whether to always send result. | ALL |
| DATA.RESULT-TYPE | System | PRIVATE | 3.1.0 | SET|GET | bit-field |
[0-128] |
0x00 = None 0x01 = Result 0x02 = XML formated result 0x04 = XML formated statistics 0x08 = Image Data 0x10 = Image Graphics 0x20 = Traning Result 0x40 = Code Quality Graphics |
Controls automatic result transmitted from reader. Default is 1. | ALL |
| DATA.RESULT-TYPE | System | PRIVATE | 5.0.0_cr10 | SET|GET | bit-field |
[0-511] |
0x00 = None 0x01 = Result 0x100 = Input event message |
Controls automatic result transmitted from reader. Default is 1. | ALL |
| DATAMATRIX.IDMAX-SCALE-UNCERTAINTY-PERCENTAGE | Decoder | PRIVATE | 6.0.1 | SET | percentage |
Specifies Scale Uncertainty Percentage. It is a parameter that allows or limits the tuned DataMatrix decoder to examine code that has different PPM than the originally tuned code. The percentage should be PPM1-PPM2)/PPM1 * 100. Active when IDMax is enabled. | ALL | ||
| DATAMATRIX.SCALE-UNCERTAINTY-PERCENTAGE | Decoder | PRIVATE | 6.0.1 | SET | percentage |
Specifies Scale Uncertainty Percentage. It is a parameter that allows or limits the tuned DataMatrix decoder to examine code that has a PPM different than the originally tuned code. The percentage should be (PPM1-PPM2)/PPM1 * 100. Used when IDQuick decoder is enabled. | ALL | ||
| DATAMATRIX.SECURITY-KEY | Symbology | PRIVATE | 3.2.0 | SET | type name |
1 |
1: Custom1 |
Sets the secure Data Matrix key which is 32 byte string. This string needs to be entered in hexadecimal format. | |
| DATAMATRIX.SECURITY-TYPE | Symbology | PRIVATE | 3.2.0 | SET|GET | type state |
[0-1] [ON|OFF] |
0: None 1: Custom1 enable/disable |
Data Matrix security type used. Only valid with a valid security key is set. | ALL |
| DATAMATRIX.TYPE | Decoder | PRIVATE | 6.1.6 | SET|GET |
|
[1-3] |
1 = DataMatrix only 2 = DMRE 3 = Both |
Set support level for DataMatrix and/or DataMatrix Rectangular Extensions. | ALL |
| DEBUG.LOG | System | PRIVATE | 5.4.0 | GET | Gets the debug log in development builds, returns nothing for released firmware. | ALL | |||
| DECODER.1D-DECODE-STRICTNESS | Decoder | PRIVATE | 6.1.6 | SET|GET |
|
[0-2] |
0 = Conservative 1 = Moderate 2 = Tolerant |
Selects which 1D decoding strictness mode to use. The default is 1 ("Moderate"). With setting 0 ("Conservative"), misreads are reduced, with 2 ("Tolerant"), no-reads are reduced. With setting 1 ("Moderate") this is balanced. | ALL |
| DECODER.1D-LEARN-CODESIZE | Decoder | PRIVATE | 3.2.0_cr5 | SET|GET | state |
[ON|OFF] | enable/disable | Learn the code size of 1D Symbols. | ALL |
| DECODER.1D-PICKETFENCE-BARCODE-ONLY | System | PRIVATE | 5.4.0 | GET | |||||
| DECODER.1D-SHORT-HEIGHT-CODES | Decoder | PRIVATE | 6.0.0 | SET|GET | state |
[ON|OFF] |
ON: Enable OFF: Disable |
Enable or disable Short Height Codes. | Ethernet readers |
| DECODER.1D-TARGET | Decoder | PRIVATE | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Target Decoding. | MX-1000 and DM8000 series readers. |
| DECODER.1D-USAGE | Decoder | PRIVATE | 3.0.0 | SET|GET | usage-type |
[0-1] |
0: Standard 0: Extended |
1D Symbology Usage Type. | |
| DECODER.NO-READ-FEEDBACK | Decoder | PRIVATE | 5.5.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enables/disables found but not decoded symbol info. | ALL |
| DECODER.PREPROCESS | Decoder | PRIVATE | 3.4.0 | SET|GET | slot filter param1 param2 param3 |
[0] [0-2] [0-255] [0-255] [0-255] |
slot to configure 0: none 1: Equalize 2: Stretch Filter parameter 1. Filter parameter 2. Filter parameter 2. |
Sets or gets the filter to apply to an image before decoding. | |
| DEVICE.APPLOADER-VER | System | PRIVATE | 5.4.0 | GET | Returns the Apploader version. | ||||
| DEVICE.BOOT-VER | System | PRIVATE | 3.0.0 | ||||||
| DEVICE.CGNM-DEV-TYPE | System | PRIVATE | 5.5.1 | GET | Returns the CogNamer device type. | ALL | |||
| DEVICE.DEFAULT-MFG | Action | PRIVATE | 5.4.0 | Resets all device settings to Cognex defaults. This command reboots the device. | DM8050, DM8600. | ||||
| DEVICE.FAILSAFE-VER | System | PRIVATE | 5.4.0 | GET | Returns the Failsafe version. | ||||
| DEVICE.FLASH | PRIVATE | 3.0.0 | begin numbytes |
||||||
| DEVICE.ID | Camera | PRIVATE | 5.4.0 | GET | string |
Returns the device id. | ALL | ||
| DEVICE.LENS-TYPE | Camera | PRIVATE | 5.0.0 | GET | type |
This command gives you the lens type when a liquid lens is installed. | ALL | ||
| DEVICE.SAVE | System | PRIVATE | 3.0.0 | ||||||
| DEVICE.SCRIPT-HEAP-SIZE-LIMIT | Communication | PRIVATE | 5.5.0 | SET|GET | size |
204800-2147483647 | Maximum size in bytes | Maximum heap size the script engine may allocate. | Fixed mount readers |
| DEVICE.SCRIPT-HEAP-USAGE-CURRENT | Communication | PRIVATE | 5.5.0 | GET | size |
Currently used heap size | The size of heap the script currently allocates. | Fixed mount readers | |
| DEVICE.SCRIPT-HEAP-USAGE-MAX | Communication | PRIVATE | 5.5.0 | GET | size |
Maximum used heap size | The maximum size of heap the script allocated allocated. | Fixed mount readers | |
| DEVICE.SHIPPEDAS-VER | System | PRIVATE | 3.0.0 | GET | |||||
| DEVICE.START-VER | System | PRIVATE | 3.0.0 | ||||||
| DEVICE.STATS | Action | PRIVATE | 5.2.0 | GET | Get decode statistics. | All. | |||
| DEVICE.SUBCLASS | System | PRIVATE | 5.4.0 | GET | string |
Activates the relevant device subclasses. | |||
| DEVICE.SYSLOG-IP | Communication | PRIVATE | 5.0.0 | SET|GET | string |
Specifies the remote syslog server IP address. | |||
| DMPOP | System | PRIVATE | 3.0.0 | GET | vtree path |
Gets value tree parameter. | |||
| DMPOP.INFO | System | PRIVATE | 3.1.0 | GET | vtree path |
Gets Device Info value tree parameter. | |||
| DMPUSH | System | PRIVATE | 3.0.0 | SET | vtree path |
Sets value tree parameter. | |||
| DMPUSH.INFO | System | PRIVATE | 3.1.0 | SET | vtree path |
Sets Device Info value tree parameter. DMCC Key is required. | |||
| DMSTATS | System | PRIVATE | 3.1.0 | vtree path |
Returns argument range for value tree parameter. e.g. ||>DMSTATS /ROI/Left |
||||
| DOTCODE.QUALITY-METRICS | Decoder | PRIVATE | 5.5.0 | SET|GET | mode |
[0-1] |
0: none 1: enable AIM metrics |
Enable Subset of Quality Metrics from DotCode AIM Specification. | DM474, DM503, DM300 series readers, DM8050X and DM8600. |
| DVALID.MATCH-STRING-EMPTY-RESULT | Data Validation | PRIVATE | 4.4.0 | SET|GET | action |
[0-1] |
0: empty match string fails 1: empty match string passes |
Gets or sets if a match string validation attempt with an empty match string should fail (0=default) or pass (1). | ALL |
| ERROR-LED.ENABLE | Action | PRIVATE | 4.5.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enables/disables error log LED. | DM50, DM60, DM70, DM503, DM474 and DM300 series readers. |
| ERROR-LED.ENABLE | Action | PRIVATE | 4.4.0_cr1_sr1 | SET|GET | state |
[ON|OFF] | enable/disable | Enables/disables error log LED. | DM300 series readers. |
| EVENT.RULES | IO | PRIVATE | 3.4.0 | SET|GET | rules |
||||
| FILE.LOAD | Action | PRIVATE | 4.5.0 | This command can be used to upload a file into DataMan flash filesystem. It should be specified as 'FILE.LOAD "Length" "Filename"'. This DMCC is password-protected. |
ALL | ||||
| FILE.SAVE | Action | PRIVATE | 5.7.0 | filename |
This command can be used to load file from flash, e.g. FILE.SEND "/files/vs.cfg". | ALL | |||
| FILE.UNLINK | System | PRIVATE | 3.3.0 | file |
Remove file from file system. | ||||
| FIRMWARE.LOAD | System | PRIVATE | 3.1.0 | file size date from location |
|
|
Loads firmware file to reader. File data follows DMCC footer. Forces a reboot. | ||
| FIRMWARE.LOAD-NOREBOOT | System | PRIVATE | 3.1.0 | file size date from location |
|
|
Loads firmware file to reader. File data follows DMCC footer. | ||
| FKEY.LOAD | System | PRIVATE | 3.1.0 | key size |
Loads encrypted feature key string to reader. Key data follows DMCC footer. Forces a reboot. | ||||
| FKEY.LOAD-NOREBOOT | System | PRIVATE | 3.1.0 | key size |
Loads encrypted feature key string to reader. Key data follows DMCC footer. | ||||
| FKEY.SAVE | System | PRIVATE | 3.1.0 | Saves feature key to flash memory. | |||||
| FLASH.AT70-INIT | Action | PRIVATE | 5.7.1 | magic |
647391673 | Magic number | This command clears AT70 Config block in flash memory. | AT70 based devices | |
| FLASH.ERASE | System | PRIVATE | 3.1.0 | sec number sec offset size |
|
|
Used to reset feature key data section. Obsolete in 3.3 by FILE.UNLINK. | ||
| FLASH.GET | System | PRIVATE | 3.1.0 | sec number sec offset size |
|
|
Output the specified section of Flash. | ||
| FOCUS.CALIBRATE | Action | PRIVATE | 6.0.1 | Compute C-mount flange distance for early units and store in manufacturing data. | DM47x, DM37x | ||||
| FOCUS.COMPENSATE-AFTER-IDLE | Camera | PRIVATE | 5.2.0 | SET|GET | time |
[1-10000] | idle time | Compensates temperature changes after camera is idle for this time. | Liquid lens. |
| FOCUS.EXTENDED-RANGE-START | Camera | PRIVATE | 5.7.0 | SET|GET | distance |
[50..4000] | define start of extended range | Defines the start of the extended focus range. Above this distance only optical power can be used to control the Liquid Lens. | Fixed-mount readers with Liquid Lens |
| FOCUS.FAST-DELAY | Camera | PRIVATE | 4.0.0 | SET|GET | value |
??? | |||
| FOCUS.FOCUS-TIME | Camera | PRIVATE | 4.0.0 | SET|GET | value |
[0-3] | |||
| FOCUS.HALL-SENSOR | Camera | PRIVATE | 5.2.0 | GET | value |
??? | |||
| FOCUS.POWER-RANGE | Camera | PRIVATE | 5.7.1 | GET | Optical Power |
[liquid lens specific] | Optical Power in Diopters | Return minimum (first value) and maximun (second value) optical power values. | Readers with Liquid Lens |
| FOCUS.RELAX-TIME | Camera | PRIVATE | 4.0.0 | SET|GET | value |
??? | |||
| FOCUS.STRATEGY | Camera | PRIVATE | 4.0.0 | SET|GET | value |
??? | |||
| FOCUS.TEMPERATURE-COMPENSATIONS | Camera | PRIVATE | 5.7.0 | SET|GET | state |
ON/OFF | Enable or disable the temperature compensation for the liquid lense HSLC. | Fixed mount readers with a Liquid Lens. | |
| FTP-IMAGE.PRIORITY | Communication | PRIVATE | 5.2.0 | SET|GET | value |
[0-2] |
0: High - above decoder 1: Medium - same as running decoder 2: Low - below running decoder |
FTP thread priority. | Ethernet readers. DM8000 series wireless readers also support FTP if the base station is connected through Ethernet. |
| FTP-PROXY.CONNECT | Communication | PRIVATE | 4.2.0 | index |
[0-15] | FTP object index as returned by FTP-PROXY.CREATE | Used by wireless readers to proxy FTP transfer through base station. | Base station. | |
| FTP-PROXY.CREATE | Communication | PRIVATE | 4.2.0 | user pass server port type |
dotted decimal from IPv4 address [1-65535] [0-1] |
Password. Target FTP server address. Target FTP port number. Target FTP server type (Generic/Mitsubishi). |
Used by wireless readers to proxy FTP transfer through base station. | Base station. | |
| FTP-PROXY.DESTROY | Communication | PRIVATE | 4.2.0 | index |
[0-15] | FTP object index as returned by FTP-PROXY.CREATE | Used by wireless readers to proxy FTP transfer through base station. | Base station. | |
| FTP-PROXY.DISCONNECT | Communication | PRIVATE | 4.2.0 | index |
[0-15] | FTP object index as returned by FTP-PROXY.CREATE | Used by wireless readers to proxy FTP transfer through base station. | Base station. | |
| FTP-PROXY.EXECUTE | Communication | PRIVATE | 4.2.0 | index type path length data |
[0-15] [0-15] [0-15] [0-3] [0-3] |
FTP object index as returned by FTP-PROXY.CREATE FTP transfer type (STOR/STOU/APPE/RETR) File path for FTP transfer Data length Data |
Used by wireless readers to proxy FTP transfer through base station. | Base station. | |
| FTP-PROXY.NOOP | Communication | PRIVATE | 5.0.0 | session |
Sends NOOP using FTP proxy. | Wireless readers. | |||
| FTP.LOG | Action | PRIVATE | 4.4.0 | GET | Get the FTP log of FTP control connection commands and replies in case of FTP problems. | ALL | |||
| HEAP.STATS | System | PRIVATE | 3.1.0 | Returns heap memory statistics. | |||||
| HPIT.INDICATOR-ON-TIME-US | Action | PRIVATE | 6.1.6 | SET|GET | IND_ID TIME_US |
[0-1] [100-10000] |
0 = Left indicator 1 = Right indicator |
Allows to control the Indicator0 (Green LED) on time to be executed in the following illumination pulse after an event has been detected. | DM370 series, DM470 series readers. |
| HPT.CHANNEL-ENABLED | Action | PRIVATE | 5.7.0 | SET|GET | channel_name, state |
[ON|OFF] string, [ON|OFF] | enable/disable Channel name. Switch state. | Enables or disables a given HPT log channel. | ALL |
| HPT.LOG | Action | PRIVATE | 5.7.0 | GET | Retrieves the HPT log as a binary file content. | ALL | |||
| I2O5.QZ-SIZE | Symbology | PRIVATE | 3.0.0 | SET|GET | state |
[0|100] | Quiet zone single strictness size. | ALL | |
| IDFLASH.READ | System | PRIVATE | 5.4.0 | SET | Read ID/slide in EEPROM content. | All | |||
| IDFLASH.WRITE | System | PRIVATE | 5.4.0 | SET | string |
Write ID/slide in EEPROM content. | All | ||
| IMAGE.FETCH | Camera | PRIVATE | 5.7.1 | size format quality |
[0-3] [0-2] [10, 15, 20... 85, 90] |
0: Full 1: 1/4 2: 1/16 3: 1/64 0: Bitmap 1: JPEG 2: PNG JPEG quality |
Acquires an image and transfers it. | ||
| IMAGE.LOAD | Camera | PRIVATE | 3.0.0 | num-bytes |
Loads image from PC to Reader. | ||||
| IMAGE.LOAD-FTP-MULT-PARAM | Camera | PRIVATE | 4.0.0 | ??? | |||||
| IMAGE.LOAD-FTP-MULT-PARAM | IO | PRIVATE | 5.5.0 | SET | server_ip picture last_image more burst_count buffer-overflow seq_nbr ” ” ”user” ”passwd” port |
[ON|OFF] [3] [0-1] |
Server IP Picture name enable/disable Number of images to take 0: Off 1: On Sequence number in the burst User name Password Port used |
Allows uploading of multiple pictures as a burst. | ALL |
| IMAGE.LOAD-FTP-PARAM | Camera | PRIVATE | 4.0.0 | ??? | |||||
| IMAGE.SEND-BUFFER | Camera | PRIVATE | 5.6.3 | index size format quality |
[0-3] [0-2] [10, 15, 20... 85, 90] |
0: Full 1: 1/4 2: 1/16 3: 1/64 0: Bitmap 1: JPEG 2: PNG JPEG Quality |
Send specified image buffer date. | ||
| IMAGEBUFFER.NO-READ-IMAGE-LAST-NUMBER | RecordPlayback | PRIVATE | 5.5.0 | SET|GET | limit |
[n][Max Int] | In Burst trigger mode, n is the number of images in a burst. In other trigger modes, there is no limit. | Stores images up to the limit. | Fixed-mount readers, only in Single, Burst, Self and Continuous modes. |
| IMAGEBUFFER.NO-READ-IMAGE-MODE | RecordPlayback | PRIVATE | 5.0.0 | SET|GET | size |
[0-3] |
0: No-Read Image Period 1: No-Read Image Number 2: No-Read Image Rate 3: No-Read Image Range |
No-Read Image stores only one image per trigger and you can select which one. No-Read Image Period stores every nth bad read image. This is evaluated across trigger modes. For example, if you have burst trigger selected with a length of 5 and set period to 3, the 1st and 4th image of the first, but the 2nd and 5th of the second burst will be stored. No-Read Image Range stores all bad read images from the no-read image number to the last no-read image number. | Fixed-mount readers, only in Single, Burst, Self and Continuous modes. |
| IMAGEBUFFER.NO-READ-INDEX | RecordPlayback | PRIVATE | 4.4.0_cr2 | SET|GET | index |
0 is the default behavior to send all as selected; 1 – max burst is send only the index selected. | DM474, DM300 series readers, DM8050 and DM8600. | ||
| IMAGEBUFFER.SEND-FTP-PARAM | RecordPlayback | PRIVATE | 4.0.0 | Transmit buffered images to designated FTP server. | Fixed mount Ethernet readers, DM8050 and DM8600. | ||||
| INPUT-STRING.ENABLE | Data Formatting | PRIVATE | 4.4.0_cr10 | SET|GET | state |
[ON|OFF] | enable/disable | Enables or disables the use of the Input String feature (available for serial, telnet, NetworkClient). When enabled, a header and the footer can be set by the INPUT-STRING.HEADER and INPUT-STRING.FOOTER commands, respectively. A string of characters can be given between the header and the footer, which will be sent with the formatted output (for example, [hello world], if the header is set to ’[’ and the footer to ’]’). Since the input string is saved temporarily, it appears only in the next result output. Use Setup Tool (the <Input String> option) or <ISTR> with DMCC (see SET FORMAT.TOKEN) to allow Input string in the result output. | ALL |
| INPUT.EVENT-MESSAGE | IO | PRIVATE | 5.0.0_cr10 | SET|GET | state |
[ON|OFF] | enable/disable | Instructs the system to generate a message for every input line state change. | DM300 series readers, DM474. |
| INPUT.VIRTUAL | Action | PRIVATE | 3.0.0 | line state |
[0-7] [ON|OFF] |
enable/disable |
Software Virtual Input. Trigger is equivalent to line 0. Note that the input actions "Train Code," "Optimize Brightness," "Set Match String," and "Read Configuration Code" are carried out only after the next trigger. |
Fixed mount devices. | |
| INTELLIGRATED.ENABLED | Communication | PRIVATE | 5.0.0_cr14 | SET|GET | state |
[ON|OFF] | enable/disable | Enable or disable the Intelligrated protocol. | DM503 series readers. |
| INTELLIGRATED.HEARTBEAT | IO | PRIVATE | 5.0.0_cr14 | SET|GET | sec |
[0-50] | seconds | Sets or gets the time between heartbeat transmissions. A value of 0 disables the heartbeat. | DM503 series readers. |
| KEY.EMULATE-PS2 | IO | PRIVATE | 5.4.0 | SET|GET | state |
[ON|OFF]
[OFF, Wedge, EmulationG |
enable/disable
OFF: no emulation Wedge: reader and PS/2 keyboard are connected using a wedge cable Emulation: reader is connected to wedge and no PS/2 keyboard is present |
Wireless readers. | |
| LIGHT.AIMER | Camera | PRIVATE | 3.0.0 | SET|GET | aimer-mode |
[0-3] |
0: Off 1: LED 2: Laser 3: Both |
Aimer Enable. | DM700 |
| LIGHT.AIMER | Camera | PRIVATE | 3.0.0 | SET|GET | aimer-mode |
[0-3] |
0: Off 1: On when idle 2: Blink (default) 3: On (default) |
Aimer Enable. | DM7500 |
| LIGHT.HIGH-FREQUENCY-FORCE | Camera | PRIVATE | 5.2.0 | SET|GET | enable |
[ON|OFF] | enable/disable | Enable High Frequency Lights even if overheat protection would normally prohibit it. | DM300 series readers |
| LIGHT.ON-AXIS-INTENSITY | Camera | PRIVATE | 5.7.0 | SET|GET | intensity |
[0..3] | on-axis illumination intensity | Controls the intensity of the DM262 UHD on-axis illumination. | DM262 |
| LIGHT.SELF-REPAIR | Camera | PRIVATE | 5.5.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enables/disables internal illumination self repair mode. | DM300 series readers |
| LIMIT.CONS-NOREAD | System | PRIVATE | 5.4.0 | SET|GET | string |
empty string: feature disabled "CBRD>n": signal after n consecutive bad reads |
Sets/gets the threshold for consecutive bad read event signaling. | ALL | |
| LL.REGTODISTANCE | System | PRIVATE | 5.4.0 | register |
Get distance in mm for specified register steps at current temperature. | Readers with liquid lens. | |||
| LLFLASH.READ | System | PRIVATE | 5.4.0 | GET | Gets liquid lens flash content. | Readers with liquid lens. | |||
| LLFLASH.WRITE | System | PRIVATE | 5.4.0 | SET | Sets liquid lens flash content. | Readers with liquid lens. | |||
| LVHSTS.ENABLED | Communication | PRIVATE | 4.4.1_cr6_sr2 | SET|GET | state |
[ON|OFF] | enable/disable | Enable or disable the USPS Lehigh Valley HSTS protocol. | DM300 series readers, DM474. |
| MARKEM.ENABLED | Communication | PRIVATE | 5.0.0_cr11 | SET|GET | state |
[ON|OFF] | enable/disable | Enable or disable the Markem protocol. | DM300 series readers, DM474. |
| MC-PROTOCOL.ENABLED | Communication | PRIVATE | SET|GET | state |
[ON|OFF] | enable/disable | Enable or disable MC-Protocol communication. | Ethernet readers. The DM8000 series wireless readers also support this protocol if the base station is connected through Ethernet. In the case of a Bluetooth connection, the command has to be sent to the base station, not to the reader. | |
| MOTION-DETECTION.INIT-STATE | Action | PRIVATE | 5.7.0 | SET|GET | state |
[ON|OFF] | enable/disable ON: motion detection is default state\n; OFF: switch to motion detection state after timeout | Specify the motion detection default state. | DM50, DM60, DM70, DM150, DM260, DM300, DM474, DM503. |
| MOTION-DETECTION.TIMEOUT | Action | PRIVATE | 5.7.0 | SET|GET | [0 - 3600] | sec | Time after the reader switches into the motion detection mode. | DM50, DM60, DM70, DM150, DM260, DM300, DM474, DM503. | |
| MQA.POSTAL-HEIGHT_MICRON | Code Quality | PRIVATE | 4.4.1_cr7 and 5.0.0_cr6 | SET|GET | height |
Height in microns per pixel for MERLIN metrics. | DM300 series readers, DM474. | ||
| MQA.POSTAL-MODE | Code Quality | PRIVATE | 4.0.0 | SET|GET | mode |
[0-2] |
0: Off 1: Partial Metrics 2: All Metrics |
Gets or sets the postal verification mode. | ALL |
| NET-LOCAL.MAX-LINK-SPEED | Communication | PRIVATE | 5.2.0 | SET|GET | speed |
[0-4] |
0: 1000 MBits/sec Full Duplex 1: 100 MBits/sec Full Duplex 2: 100 MBits/sec Half Duplex 3: 10 MBits/sec Full Duplex 4: 10 MBits/sec Half Duplex |
Limits the advertised autonegotiation maximum link speed. | DM503 only |
| NET-LOCAL.PCAP | System | PRIVATE | 5.7.0 | SET|GET | interface |
interface | Retrieves packet capturing buffer. | ALL | |
| NET-LOCAL.SEC-ENABLE | Communication | PRIVATE | 5.2.0 | SET|GET | state |
[ON|OFF] |
enable/disable
ON: use authentication OFF: no authentication |
Use authentication over telnet for communciation between reader and base. | Ethernet readers. |
| NET-LOCAL.SEC-PASSWORD | Communication | PRIVATE | 5.2.0 | SET|GET | string |
password for authentication | Use authentication over telnet for communciation between reader and base. | Ethernet readers. | |
| NET-LOCAL.SEC-USERNAME | Communication | PRIVATE | 5.2.0 | SET|GET | string |
username for authentication | Use authentication over telnet for communciation between reader and base. | Ethernet readers. | |
| NET-LOCAL.TCP-KEEPALIVE | Communication | PRIVATE | 3.3.1 | SET|GET | state |
[ON|OFF] | enable/disable | Enable/Disable TCP keepalive message. | Ethernet readers. |
| NET-LOCAL.TCP-KEEPALIVE-COUNT | Communication | PRIVATE | 3.3.1 | SET|GET | value |
[0-32565] | TCP keep alive retry count. | Ethernet readers. | |
| NET-LOCAL.TCP-KEEPALIVE-IDLE | Communication | PRIVATE | 3.3.1 | SET|GET | value |
[0-32565] | TCP keep alive time. Ethernet readers. |
||
| NET-LOCAL.TCP-KEEPALIVE-INTERVAL | Communication | PRIVATE | 3.3.1 | SET|GET | value |
[0-32565] | TCP keep alive interval. Ethernet readers. |
||
| OUTPUT.CQ-FAIL | IO | PRIVATE | 3.0.0 | Output Code Quality failed actions. Verifiers only. |
|||||
| OUTPUT.DATAVALID-FAIL | IO | PRIVATE | 3.0.0 | Output Data Validation failed actions. | |||||
| OUTPUT.GOOD | IO | PRIVATE | 3.0.0 | Output good read actions. | |||||
| OUTPUT.NOREAD | IO | PRIVATE | 3.0.0 | Output no read actions. | |||||
| OUTPUT.TRIG-OVERRUN | IO | PRIVATE | 3.0.0 | Output trigger overrun actions. | |||||
| PHARMA.MAX-LENGTH | Symbology | PRIVATE | 4.4.0 | SET|GET | length |
[1-6] | Gets or sets the maximum length for a Pharmacode. Obsoleted in 5.1. |
ALL | |
| PHARMA.MIN-LENGTH | Symbology | PRIVATE | 4.4.0 | SET|GET | length |
[1-6] | Gets or sets the minimum length for a Pharmacode. Obsoleted in 5.1. |
ALL | |
| PHARMA.SUPPLEMENTARY | Symbology | PRIVATE | 3.4.0 | SET|GET | state |
[ON|OFF] | enable/disable | Get or set whether supplementary component is expected. | ALL |
| PHARMA.SUPPLEMENTARY-GAP-THRESH | Symbology | PRIVATE | 3.4.0 | SET|GET | gap |
[100-300] | Get or set the Pharmacode supplementary gap threshold in pixels. | ALL | |
| PHS.ADD-PACKAGE | System | PRIVATE | 5.4.0 | ||||||
| POWER.SLEEP | System | PRIVATE | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Power Save Mode Enable. | DM7500 |
| POWER.SLEEPTIME | System | PRIVATE | 3.0.0 | SET|GET | secs |
[0, 60, 120... 600] | seconds | Time before entering power-save mode. | DM7500 |
| PPP.IP-CLIENT | System | PRIVATE | 5.4.0 | SET|GET | Reader/client device IP address for internal communication between client and base station. | Wireless readers. | |||
| PPP.IP-SERVER | System | PRIVATE | 5.4.0 | SET|GET | Base/server device IP address for internal communication between client and base station. | Wireless readers. | |||
| PPP.NETMASK | System | PRIVATE | 5.4.0 | SET|GET | int |
Netmask for internal communication between reader and base. | Wireless readers. | ||
| PRESENT.NEVER2X | System | PRIVATE | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Never Read the Same Code Twice. OBSOLETED in 4.5. Presentation mode only. |
ALL |
| PRESENT.REREAD | System | PRIVATE | 3.0.0 | SET|GET | ms |
[0-10000] | milliseconds | OBSOLETED in 4.5. Presentation Mode Re-read Delay. | ALL |
| PRESENT.RESCAN | System | PRIVATE | 3.0.0 | SET|GET | ms |
[0-10000] | milliseconds | OBSOLETED in 4.5. Presentation Mode Rescan Delay. | ALL |
| PROFIBUS.GATEWAY-COM | Communication | PRIVATE | 5.5.0 | SET|GET | mode |
[0-2] |
0: Profibus 1: RS485 2: RS422 |
Get the COM configuration (Profibus / RS422 / RS485). | Fixed-mount readers |
| PROFIBUS.GATEWAY-FLOW | Communication | PRIVATE | 5.5.0 | SET|GET | mode |
[0-2] |
0: None 1: RTS/CTS 2: XON/XOFF |
The reader will return a value indicating the type of serial flow control to be used. | Fixed-mount readers |
| PROFIBUS.GATEWAY-HOST | Communication | PRIVATE | 5.5.0 | GET | type |
[0] | The reader will return a value indicating the host interface protocol. | Fixed-mount readers | |
| PROFIBUS.GATEWAY-MODE | Communication | PRIVATE | 5.5.0 | GET | mode |
[1] | Get the profibus mode configuration. | Fixed-mount readers | |
| PROFIBUS.GATEWAY-NODE | Communication | PRIVATE | 5.5.0 | SET|GET | node number |
[1-99] | The reader will return the Profinet node number for the gateway. | Fixed-mount readers | |
| PROFIBUS.GATEWAY-RUN | Communication | PRIVATE | 5.5.0 | SET|GET | state |
[ON|OFF] | Runtime start message or heartbeat. | Fixed-mount readers | |
| PROFIBUS.GATEWAY-STATUS | Communication | PRIVATE | 5.5.0 | SET|GET | status |
[0-4] |
0: ok, no error 1: Invalid op mode 2: Invalid node number 3: Invalid flow control 4: Invalid host interference |
Set Gateway error message. | Fixed-mount readers |
| PROFIBUS.GATEWAY-VERSION | Communication | PRIVATE | 5.5.0 | SET|GET | mode |
Set the GW firmware version, used for baud rate detection. | Fixed-mount readers | ||
| PROXIMITY.CURRENT | Communication | PRIVATE | 5.4.0 | SET|GET | int |
[10-200] step 10 | IR LED current of the proximity sensor in mA | A higher value will increase the sensitivity of the sensor. | DM8600 |
| PROXIMITY.THRESHOLD | Communication | PRIVATE | 5.4.0 | SET|GET | int |
[0-100] | Threshold value which defines if the optical button has been pressed or released. A lower value will increase the sensitivity of the sensor. | DM8600 | |
| SCRIPT.GARBAGE-COLLECT | Communication | PRIVATE | 5.5.0 | force |
[ON|OFF] | enable/disable Enforce the garbage collection | Check or enforce the Garbage Collection process. | Fixed mount readers | |
| SDCARD.TESTFILE | Communication | PRIVATE | 5.5.0 | SET|GET | string |
SET: writes argument to a predefined file on the card. GET: reads back the same file and returns its content. | DM360 series readers, DM474 | ||
| SDK.VERSION | System | PRIVATE | 3.0.0 | SET|GET | Gets or sets the SDK version. Used by early versions of the DataMan SDK. | ||||
| SSH.UNLOCK | Action | PRIVATE | 6.0.1 | GET | The PC (host) sends this command to the reader to initiate the unlocking mechanism. As a response, the reader sends back a 32 byte random challenge to the PC. | DM474 | |||
| SSH.UNLOCK | Action | PRIVATE | 6.0.1 | SET | signature of the challenge |
The argument is the signature of the random challenge generated by the reader and signed with a public key on the PC side. The reader then verifies that the challenge was signed with the proper key and sent back in one minute. In this case, the SSH service is started on the reader, otherwise, an invalid parameter error is returned. | DM474 | ||
| SYMBOL.4STATE-RMC | Symbology | PRIVATE | 5.6.0 | SET|GET | state |
[ON|OFF] | enable/disable Enable/Disable | Enables or disables Royal Mail Code Symbology. | DM50, DM60, DM70, DM150, DM260, DM30x, DM474, DM503, MX-1000, MX-1502. Mobile. |
| SYMBOL.RPC | Symbology | PRIVATE | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Reader Programming Code. | DM70, DM150, DM260 |
| SYNC-ACQUISITION.START-DELAY | Communication | PRIVATE | 5.0.0 | SET|GET | us |
[0-25000] | microseconds | This command is to adjust the delay between the master/slave trigger sent via Ethernet and the sync signal sent for RS-845 to compensate for the longer runtime of the message via Ethernet. Developer only command. |
DM503 |
| TEMPERATURE.CPU | System | PRIVATE | 6.1.0 | GET | CPU Temperature in °C. | DM370 series, DM470 series readers. | |||
| TEMPERATURE.LL | System | PRIVATE | 6.1.0 | GET | Get Liquid lens Temperature in °C. Only available if a Liquid lens is present. |
DM370 series, DM470 series readers. | |||
| TEMPERATURE.SENSOR | System | PRIVATE | 6.1.0 | GET | Get Imager Temperature in °C. Only available if compatible image sensor is present. Readout can interfere with image acquisition. |
DM370 series, DM470 series readers. | |||
| TLS.BENCHMARK | Action | PRIVATE | 5.7.0 | Starts a benchmark of the SSL/TLS library.This DMCC is password protected. The result can be checked in the HPT log output. | ALL | ||||
| TLS.SELFTEST | Action | PRIVATE | 5.7.0 | Starts a benchmark of the SSL/TLS library. This DMCC is password protected. The result can be checked in the HPT log output. | ALL | ||||
| TRACE.DUMPFILE | System | PRIVATE | 5.4.0 | filename |
Saves a trace log file, which is archived in flash, into a file. | ||||
| TRAIN.AVAILABLE | Symbology | PRIVATE | 3.2.0 | GET | symbology |
Indicates whether incremental training is available for the selected symbology group. | Fixed mount readers. | ||
| TRAIN.CODE-FROM-IMAGE | Action | PRIVATE | 4.5.0 | num-bytes |
Code is trained from uploaded image. | Fixed mount devices. | |||
| TRIGGER.DELAY | Camera | PRIVATE | 3.0.0 | SET|GET | milliseconds |
[0-10000] | Trigger Delay. Delay camera acquisition by specified number of milliseconds. |
ALL | |
| TRIGGER.IGNORE-DISTANCE | IO | PRIVATE | 5.5.0 | SET|GET | milliseconds |
[0-2147483646] | Sets or gets the minimum trigger distance for a trigger to be considered good. All trigger durations less than the specified duration will be aborted. | Fixed-mount readers | |
| TRIGGER.IGNORE-TIME | IO | PRIVATE | 5.5.0 | SET|GET | milliseconds |
[0-10000] | Sets or gets the minimum trigger duration for a trigger to be considered good. All trigger durations less than the specified duration will be aborted. | Fixed-mount readers | |
| TRIGGER.IGNORE-TYPE | IO | PRIVATE | 5.5.0 | SET|GET | mode |
[0-2] |
0: none 1: time 2: distance |
Sets or gets what type of triggers to ignore. | Fixed-mount readers |
| VSOC.ACCELERATION | Decoder | PRIVATE | 4.0.0 | SET|GET | enable |
[ON|OFF] | enable/disable | Enabled or disable VSOC acceleration. | |
| VSOC.LEGACY-AUTO-REG | Camera | PRIVATE | 4.0.0 | SET|GET | enable |
[ON|OFF] | enable/disable | Enabled or disable VSOC auto-regulation algorithm. | |
| CAMERA.ROI | Camera | 3.0.0 | SET|GET | left right top bottom |
|||||
| IMAGE.SEND-SLOT | Camera | 3.0.0 | |||||||
| IMAGE.SEND-TYPE | Camera | 3.0.0 | |||||||
| IMAGEBUFFER.RECORD | RecordPlayback | 4.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable or disable image buffereing. obsolete in 4.0.0. |
Fixed mount readers, DM8050 and DM8600. |
| Name |
Type |
Level |
Version |
Set/Get |
Args |
Range |
Meaning |
Description |
Support |
|---|---|---|---|---|---|---|---|---|---|
| CAMERA.ROI | Camera | 3.0.0 | SET|GET | left right top bottom |
|||||
| IMAGE.SEND-SLOT | Camera | 3.0.0 | |||||||
| IMAGE.SEND-TYPE | Camera | 3.0.0 | |||||||
| IMAGEBUFFER.RECORD | RecordPlayback | 4.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable or disable image buffereing. obsolete in 4.0.0. |
Fixed mount readers, DM8050 and DM8600. | |
| 3DVECTOR.CALIBRATED | Action | PRIVATE | 5.5.0 | GET | calibration_status |
[0-2] |
0:Neither factory, nor field calibration present 1:Only factory calibration loaded 2:Factory and field calibration loaded |
Query current calibration status. | ALL |
| 3DVECTOR.ENABLED | Action | PRIVATE | 5.5.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enables/disables the 3DVectoring functionality on the reader. | ALL |
| 3DVECTOR.FCALIB-CVL.LOAD | Action | PRIVATE | 5.5.0 | size_bytes |
Load factory calibration data blob in CVL style. | ALL | |||
| 3DVECTOR.FCALIB-CVL.SEND | Action | PRIVATE | 5.5.0 | Send factory calibration data blob in CVL style. | ALL | ||||
| 3DVECTOR.FCALIB-CVT.LOAD | Action | PRIVATE | 5.5.0 | size_bytes |
Load factory calibration data blob in CVT style. | ALL | |||
| 3DVECTOR.FCALIB-CVT.SEND | Action | PRIVATE | 5.5.0 | Send factory calibration data blob in CVT style. | ALL | ||||
| 3DVECTOR.LENGTH | Action | PRIVATE | 5.5.0 | SET|GET | This sets/gets the length of the output 3D line segment. | ALL | |||
| 3DVECTOR.SCALIB.LOAD | Action | PRIVATE | 5.5.0 | size_bytes |
Load system calibration data blob. | ALL | |||
| 3DVECTOR.SCALIB.SEND | Action | PRIVATE | 5.5.0 | Send system calibration data blob. | ALL | ||||
| ABORT | Action | PRIVATE | 3.0.0 | Abort command in process. Intended to abort image transfer. | ALL | ||||
| ANDROID.USB-ROLE-CHANGE | Action | PRIVATE | 5.7.1 | SET|GET | enabled timeout |
[ON|OFF] |
ON: (default) role change enabled, reader operates as usual OFF: role change disabled, reader stays in device mode Timeout in seconds after which the role change is automatically enabled again. |
Disables the USB role change. If role change is disabled, the reader stays in device mode, meaning the phone is not charged. If the role change is disabled, a timeout must be provided in seconds after which the role change is automatically enabled again. | ALL |
| BLUETOOTH.KBM-PIN | Communication | PRIVATE | 5.4.3 | SET|GET | string |
0-16 characters of decimal number | PIN number (e.g. "1234") | Gets or sets the PIN number of the remote target. | DM8050, DM8600. |
| BLUETOOTH.KBM-TARGET-ADDR | Communication | PRIVATE | 5.4.3 | SET|GET | string |
8 characters of hexadecimal number | MAC address (e.g. "0006660492A6") | Gets or sets the MAC address of the remote target. | DM8050, DM8600. |
| BLUETOOTH.OPERATION-MODE | Communication | PRIVATE | 5.4.3 | SET|GET | number |
[0-2] |
0: normal mode 1: PC connect mode 2: keyboard emulator mode |
Gets or sets the Bluetooth operation mode. | DM8050, DM8600. |
| BUTTON.VIRTUAL | Action | PRIVATE | 5.4.0 | int state |
[ON|OFF] |
Denotes the button id. enable/disable Denotes the new state of the button. |
Allows to virtually push the TUNE button for more than 3 seconds on a DM8600 to activate "magic mode". | DM8600 | |
| CAMERA.BURST-TRANSFER-ALL | Camera | PRIVATE | 3.3.0 | SET|GET | state |
[ON|OFF] | enable/disable | Force transfer of all burst images. Used by the DMCC .NET. |
|
| CAMERA.ENABLE | Camera | PRIVATE | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enables camera which can be disabled when loading images from the PC. | ALL |
| CAMERA.EXPOSURE | Camera | PRIVATE | 3.0.0 | SET|GET | auto target exposure gain |
[ON|OFF] [0-255] [0-20] [1-19] |
ON: Automatic OFF: Manual target pixel value 0: 1/20000 1: 1/10000 2: 1/7500 3: 1/5000 4: 1/3000 5: 1/2500 6: 1/2000 7: 1/1500 8: 1/1250 9: 1/1000 10: 1/750 11: 1/500 12: 1/300 13: 1/250 14: 1/200 15: 1/150 16: 1/125 17: 1/100 18: 1/75 19: 1/50 20: 1/40 camera gain |
Camera Parameters. The arguments 'exposure' and 'gain' have no effect if 'auto' is ON and the 'target' has no effect if 'auto' is OFF. | DM7500 |
| CAMERA.HDR-ESTIMATED-SCENE-KEY | Camera | PRIVATE | 6.1.0 | SET|GET | estimated scene key |
[0-4095] | Estimated scene key parameter for HDR | DM370 series, DM470 series readers. | |
| CAMERA.MAX-EXPOSURE | Camera | PRIVATE | 3.0.0 | SET|GET | exposure |
[0-20] |
0: 1/20000 1: 1/10000 2: 1/7500 3: 1/5000 4: 1/3000 5: 1/2500 6: 1/2000 7: 1/1500 8: 1/1250 9: 1/1000 10: 1/750 11: 1/500 12: 1/300 13: 1/250 14: 1/200 15: 1/150 16: 1/125 17: 1/100 18: 1/75 19: 1/50 20: 1/40 |
Maximum exposure limit for autoregulation. | MX-1000 and DM8000 series readers. |
| CODABAR.QZ-SIZE | Symbology | PRIVATE | 3.0.0 | SET|GET | state |
[0|100] | Quiet zone single strictness size. | ALL | |
| CODABAR.XMT-START-STOP-CHAR | Decoder | PRIVATE | 6.0.0 | SET|GET | state |
[ON|OFF] |
ON: Enable OFF: Disable |
Enable or disable transmitting start and stop character as part of the decoded string. | Ethernet readers |
| COM.ALTERNATE-MODE-DISABLE | Decoder | PRIVATE | 5.7.0 | SET|GET | enable |
[ON|OFF] |
ON: alternate mode cable detection enabled OFF: alternate mode cable detection disabled |
Disables alternate mode cable detection. | DM70 |
| COM.AUTO-DETECT | Communication | PRIVATE | 3.0.0 | SET|GET | state |
[ON|OFF] [ON|OFF] | enable/disable | Enables support for simultaneous connection to USB And RS-232. | |
| COM.BUFFER-DATA | IO | PRIVATE | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | ||
| COM.DATA-BITS | IO | PRIVATE | 3.0.0 | SET|GET | bits |
[7|8] | RS232 data bits | ||
| COM.DMCC-CHECKSUM | Communication | PRIVATE | 3.4.0 | SET|GET | type |
[0-3] |
0: none 1: XOR 2: CRC16 (Header/Response) 3: CRC16 (Header/Response/Data) |
Checksum used in DMCC response. | |
| COM.DMCC-EVENT | Communication | PRIVATE | 4.2.0 | SET|GET | event_mask |
[0-255] bitfield |
0: none 1: reader online/offline |
Sets which events are sent over DMCC. Used by DataMan SDK. | Wireless readers, base station. |
| COM.DMCC-HEADER | Communication | PRIVATE | 3.4.0 | SET|GET | type |
[0-1] |
0: default 1: include result ID |
Sets or gets the header option used in Extended mode. | |
| COM.DMCC-RESPONSE | Communication | PRIVATE | 3.0.0 | SET|GET | mode |
[0-2] |
0: Silent (default) 1: Extended 2: Extended mode with ||[xxx::length] CR NL data Responses |
DMCC response format. | ALL |
| COM.INTERFACE | Communication | PRIVATE | 5.4.3 | GET | Supported interfaces: RS232, USB, Ethernet, WiFi, Bluetooth. | ||||
| COM.RS232-FILTER | Communication | PRIVATE | 5.0.0_cr7 | SET|GET | state |
[ON|OFF] | enable/disable | Enable or disable the RS-232 filter. | DM300 series readers, DM474. |
| COM.RS232-FILTER-CHAR | Communication | PRIVATE | 5.0.0_cr7 | SET|GET | char |
[0x00-0xFF] | Hex char | Sets or gets the hex value of the character to start filtering after (e.g. 0x03 for ETX). | DM300 series readers, DM474. |
| COM.SCRIPT | Communication | PRIVATE | 5.3.0 | SET|GET | num-bytes |
Load script from communication channel. | DM474, DM503 and DM300 series readers. | ||
| COM.SCRIPT-ENABLED | Communication | PRIVATE | 5.3.0 | SET|GET | bool |
DM474, DM503 and DM300 series readers. | |||
| COM.USB-TEST-SN | Communication | PRIVATE | 4.2.0 | SET|GET | string |
test serial number | Used by manufacturing to make different devices enumerate on the same CDC COM port. | Base station, DM50, DM60 and DM70. | |
| COM.USB-USE-TEST-SN | Communication | PRIVATE | 4.2.0 | SET|GET | state |
[ON|OFF] [ON|OFF] | enable/disable | Used by manufacturing to make different devices enumerate on the same CDC COM port. | Base station, DM50, DM60 and DM70. |
| CONFIG.DUMP-UIDS | Action | PRIVATE | 3.0.0 | Returns all value tree parameters. | ALL | ||||
| CONFIG.SAVE-DEFAULTS | Action | PRIVATE | 5.4.0 | Saves current settings as defaults. This command does not reboot the device. | ALL | ||||
| CONTROL.RPC | Action | PRIVATE | 4.2.0 | SET|GET | string |
RP code to execute. | Executes RP codes passed as string. Used internally to route RP commands to the base station. | ALL | |
| CPFLASH.WRITE | Camera | PRIVATE | 5.0.0 | id |
[0-4] |
0: Unknown 1: Prototype 2: Alpha build with SRAM 3: Alpha build with SDRAM 4: Beta build |
Flash camera port ID. | DM 503. | |
| DATA.IMAGE-TYPE | Communication | PRIVATE | 3.4.0 | SET|GET | type |
[0-2] |
0: all 1: no read 2: read |
Sets or gets type of image automatically returned. Used in conjuction with DATA.RESULT-TYPE. | |
| DATA.RESULT-ALWAYSSEND | System | PRIVATE | 3.1.0 | SET|GET | state |
[ON|OFF] | enable/disable | Sets gets whether to always send result. | ALL |
| DATA.RESULT-TYPE | System | PRIVATE | 3.1.0 | SET|GET | bit-field |
[0-128] |
0x00 = None 0x01 = Result 0x02 = XML formated result 0x04 = XML formated statistics 0x08 = Image Data 0x10 = Image Graphics 0x20 = Traning Result 0x40 = Code Quality Graphics |
Controls automatic result transmitted from reader. Default is 1. | ALL |
| DATA.RESULT-TYPE | System | PRIVATE | 5.0.0_cr10 | SET|GET | bit-field |
[0-511] |
0x00 = None 0x01 = Result 0x100 = Input event message |
Controls automatic result transmitted from reader. Default is 1. | ALL |
| DATAMATRIX.IDMAX-SCALE-UNCERTAINTY-PERCENTAGE | Decoder | PRIVATE | 6.0.1 | SET | percentage |
Specifies Scale Uncertainty Percentage. It is a parameter that allows or limits the tuned DataMatrix decoder to examine code that has different PPM than the originally tuned code. The percentage should be PPM1-PPM2)/PPM1 * 100. Active when IDMax is enabled. | ALL | ||
| DATAMATRIX.SCALE-UNCERTAINTY-PERCENTAGE | Decoder | PRIVATE | 6.0.1 | SET | percentage |
Specifies Scale Uncertainty Percentage. It is a parameter that allows or limits the tuned DataMatrix decoder to examine code that has a PPM different than the originally tuned code. The percentage should be (PPM1-PPM2)/PPM1 * 100. Used when IDQuick decoder is enabled. | ALL | ||
| DATAMATRIX.SECURITY-KEY | Symbology | PRIVATE | 3.2.0 | SET | type name |
1 |
1: Custom1 |
Sets the secure Data Matrix key which is 32 byte string. This string needs to be entered in hexadecimal format. | |
| DATAMATRIX.SECURITY-TYPE | Symbology | PRIVATE | 3.2.0 | SET|GET | type state |
[0-1] [ON|OFF] |
0: None 1: Custom1 enable/disable |
Data Matrix security type used. Only valid with a valid security key is set. | ALL |
| DATAMATRIX.TYPE | Decoder | PRIVATE | 6.1.6 | SET|GET |
|
[1-3] |
1 = DataMatrix only 2 = DMRE 3 = Both |
Set support level for DataMatrix and/or DataMatrix Rectangular Extensions. | ALL |
| DEBUG.LOG | System | PRIVATE | 5.4.0 | GET | Gets the debug log in development builds, returns nothing for released firmware. | ALL | |||
| DECODER.1D-DECODE-STRICTNESS | Decoder | PRIVATE | 6.1.6 | SET|GET |
|
[0-2] |
0 = Conservative 1 = Moderate 2 = Tolerant |
Selects which 1D decoding strictness mode to use. The default is 1 ("Moderate"). With setting 0 ("Conservative"), misreads are reduced, with 2 ("Tolerant"), no-reads are reduced. With setting 1 ("Moderate") this is balanced. | ALL |
| DECODER.1D-LEARN-CODESIZE | Decoder | PRIVATE | 3.2.0_cr5 | SET|GET | state |
[ON|OFF] | enable/disable | Learn the code size of 1D Symbols. | ALL |
| DECODER.1D-PICKETFENCE-BARCODE-ONLY | System | PRIVATE | 5.4.0 | GET | |||||
| DECODER.1D-SHORT-HEIGHT-CODES | Decoder | PRIVATE | 6.0.0 | SET|GET | state |
[ON|OFF] |
ON: Enable OFF: Disable |
Enable or disable Short Height Codes. | Ethernet readers |
| DECODER.1D-TARGET | Decoder | PRIVATE | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Target Decoding. | MX-1000 and DM8000 series readers. |
| DECODER.1D-USAGE | Decoder | PRIVATE | 3.0.0 | SET|GET | usage-type |
[0-1] |
0: Standard 0: Extended |
1D Symbology Usage Type. | |
| DECODER.NO-READ-FEEDBACK | Decoder | PRIVATE | 5.5.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enables/disables found but not decoded symbol info. | ALL |
| DECODER.PREPROCESS | Decoder | PRIVATE | 3.4.0 | SET|GET | slot filter param1 param2 param3 |
[0] [0-2] [0-255] [0-255] [0-255] |
slot to configure 0: none 1: Equalize 2: Stretch Filter parameter 1. Filter parameter 2. Filter parameter 2. |
Sets or gets the filter to apply to an image before decoding. | |
| DEVICE.APPLOADER-VER | System | PRIVATE | 5.4.0 | GET | Returns the Apploader version. | ||||
| DEVICE.BOOT-VER | System | PRIVATE | 3.0.0 | ||||||
| DEVICE.CGNM-DEV-TYPE | System | PRIVATE | 5.5.1 | GET | Returns the CogNamer device type. | ALL | |||
| DEVICE.DEFAULT-MFG | Action | PRIVATE | 5.4.0 | Resets all device settings to Cognex defaults. This command reboots the device. | DM8050, DM8600. | ||||
| DEVICE.FAILSAFE-VER | System | PRIVATE | 5.4.0 | GET | Returns the Failsafe version. | ||||
| DEVICE.FLASH | PRIVATE | 3.0.0 | begin numbytes |
||||||
| DEVICE.ID | Camera | PRIVATE | 5.4.0 | GET | string |
Returns the device id. | ALL | ||
| DEVICE.LENS-TYPE | Camera | PRIVATE | 5.0.0 | GET | type |
This command gives you the lens type when a liquid lens is installed. | ALL | ||
| DEVICE.SAVE | System | PRIVATE | 3.0.0 | ||||||
| DEVICE.SCRIPT-HEAP-SIZE-LIMIT | Communication | PRIVATE | 5.5.0 | SET|GET | size |
204800-2147483647 | Maximum size in bytes | Maximum heap size the script engine may allocate. | Fixed mount readers |
| DEVICE.SCRIPT-HEAP-USAGE-CURRENT | Communication | PRIVATE | 5.5.0 | GET | size |
Currently used heap size | The size of heap the script currently allocates. | Fixed mount readers | |
| DEVICE.SCRIPT-HEAP-USAGE-MAX | Communication | PRIVATE | 5.5.0 | GET | size |
Maximum used heap size | The maximum size of heap the script allocated allocated. | Fixed mount readers | |
| DEVICE.SHIPPEDAS-VER | System | PRIVATE | 3.0.0 | GET | |||||
| DEVICE.START-VER | System | PRIVATE | 3.0.0 | ||||||
| DEVICE.STATS | Action | PRIVATE | 5.2.0 | GET | Get decode statistics. | All. | |||
| DEVICE.SUBCLASS | System | PRIVATE | 5.4.0 | GET | string |
Activates the relevant device subclasses. | |||
| DEVICE.SYSLOG-IP | Communication | PRIVATE | 5.0.0 | SET|GET | string |
Specifies the remote syslog server IP address. | |||
| DMPOP | System | PRIVATE | 3.0.0 | GET | vtree path |
Gets value tree parameter. | |||
| DMPOP.INFO | System | PRIVATE | 3.1.0 | GET | vtree path |
Gets Device Info value tree parameter. | |||
| DMPUSH | System | PRIVATE | 3.0.0 | SET | vtree path |
Sets value tree parameter. | |||
| DMPUSH.INFO | System | PRIVATE | 3.1.0 | SET | vtree path |
Sets Device Info value tree parameter. DMCC Key is required. | |||
| DMSTATS | System | PRIVATE | 3.1.0 | vtree path |
Returns argument range for value tree parameter. e.g. ||>DMSTATS /ROI/Left |
||||
| DOTCODE.QUALITY-METRICS | Decoder | PRIVATE | 5.5.0 | SET|GET | mode |
[0-1] |
0: none 1: enable AIM metrics |
Enable Subset of Quality Metrics from DotCode AIM Specification. | DM474, DM503, DM300 series readers, DM8050X and DM8600. |
| DVALID.MATCH-STRING-EMPTY-RESULT | Data Validation | PRIVATE | 4.4.0 | SET|GET | action |
[0-1] |
0: empty match string fails 1: empty match string passes |
Gets or sets if a match string validation attempt with an empty match string should fail (0=default) or pass (1). | ALL |
| ERROR-LED.ENABLE | Action | PRIVATE | 4.5.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enables/disables error log LED. | DM50, DM60, DM70, DM503, DM474 and DM300 series readers. |
| ERROR-LED.ENABLE | Action | PRIVATE | 4.4.0_cr1_sr1 | SET|GET | state |
[ON|OFF] | enable/disable | Enables/disables error log LED. | DM300 series readers. |
| EVENT.RULES | IO | PRIVATE | 3.4.0 | SET|GET | rules |
||||
| FILE.LOAD | Action | PRIVATE | 4.5.0 | This command can be used to upload a file into DataMan flash filesystem. It should be specified as 'FILE.LOAD "Length" "Filename"'. This DMCC is password-protected. |
ALL | ||||
| FILE.SAVE | Action | PRIVATE | 5.7.0 | filename |
This command can be used to load file from flash, e.g. FILE.SEND "/files/vs.cfg". | ALL | |||
| FILE.UNLINK | System | PRIVATE | 3.3.0 | file |
Remove file from file system. | ||||
| FIRMWARE.LOAD | System | PRIVATE | 3.1.0 | file size date from location |
|
|
Loads firmware file to reader. File data follows DMCC footer. Forces a reboot. | ||
| FIRMWARE.LOAD-NOREBOOT | System | PRIVATE | 3.1.0 | file size date from location |
|
|
Loads firmware file to reader. File data follows DMCC footer. | ||
| FKEY.LOAD | System | PRIVATE | 3.1.0 | key size |
Loads encrypted feature key string to reader. Key data follows DMCC footer. Forces a reboot. | ||||
| FKEY.LOAD-NOREBOOT | System | PRIVATE | 3.1.0 | key size |
Loads encrypted feature key string to reader. Key data follows DMCC footer. | ||||
| FKEY.SAVE | System | PRIVATE | 3.1.0 | Saves feature key to flash memory. | |||||
| FLASH.AT70-INIT | Action | PRIVATE | 5.7.1 | magic |
647391673 | Magic number | This command clears AT70 Config block in flash memory. | AT70 based devices | |
| FLASH.ERASE | System | PRIVATE | 3.1.0 | sec number sec offset size |
|
|
Used to reset feature key data section. Obsolete in 3.3 by FILE.UNLINK. | ||
| FLASH.GET | System | PRIVATE | 3.1.0 | sec number sec offset size |
|
|
Output the specified section of Flash. | ||
| FOCUS.CALIBRATE | Action | PRIVATE | 6.0.1 | Compute C-mount flange distance for early units and store in manufacturing data. | DM47x, DM37x | ||||
| FOCUS.COMPENSATE-AFTER-IDLE | Camera | PRIVATE | 5.2.0 | SET|GET | time |
[1-10000] | idle time | Compensates temperature changes after camera is idle for this time. | Liquid lens. |
| FOCUS.EXTENDED-RANGE-START | Camera | PRIVATE | 5.7.0 | SET|GET | distance |
[50..4000] | define start of extended range | Defines the start of the extended focus range. Above this distance only optical power can be used to control the Liquid Lens. | Fixed-mount readers with Liquid Lens |
| FOCUS.FAST-DELAY | Camera | PRIVATE | 4.0.0 | SET|GET | value |
??? | |||
| FOCUS.FOCUS-TIME | Camera | PRIVATE | 4.0.0 | SET|GET | value |
[0-3] | |||
| FOCUS.HALL-SENSOR | Camera | PRIVATE | 5.2.0 | GET | value |
??? | |||
| FOCUS.POWER-RANGE | Camera | PRIVATE | 5.7.1 | GET | Optical Power |
[liquid lens specific] | Optical Power in Diopters | Return minimum (first value) and maximun (second value) optical power values. | Readers with Liquid Lens |
| FOCUS.RELAX-TIME | Camera | PRIVATE | 4.0.0 | SET|GET | value |
??? | |||
| FOCUS.STRATEGY | Camera | PRIVATE | 4.0.0 | SET|GET | value |
??? | |||
| FOCUS.TEMPERATURE-COMPENSATIONS | Camera | PRIVATE | 5.7.0 | SET|GET | state |
ON/OFF | Enable or disable the temperature compensation for the liquid lense HSLC. | Fixed mount readers with a Liquid Lens. | |
| FTP-IMAGE.PRIORITY | Communication | PRIVATE | 5.2.0 | SET|GET | value |
[0-2] |
0: High - above decoder 1: Medium - same as running decoder 2: Low - below running decoder |
FTP thread priority. | Ethernet readers. DM8000 series wireless readers also support FTP if the base station is connected through Ethernet. |
| FTP-PROXY.CONNECT | Communication | PRIVATE | 4.2.0 | index |
[0-15] | FTP object index as returned by FTP-PROXY.CREATE | Used by wireless readers to proxy FTP transfer through base station. | Base station. | |
| FTP-PROXY.CREATE | Communication | PRIVATE | 4.2.0 | user pass server port type |
dotted decimal from IPv4 address [1-65535] [0-1] |
Password. Target FTP server address. Target FTP port number. Target FTP server type (Generic/Mitsubishi). |
Used by wireless readers to proxy FTP transfer through base station. | Base station. | |
| FTP-PROXY.DESTROY | Communication | PRIVATE | 4.2.0 | index |
[0-15] | FTP object index as returned by FTP-PROXY.CREATE | Used by wireless readers to proxy FTP transfer through base station. | Base station. | |
| FTP-PROXY.DISCONNECT | Communication | PRIVATE | 4.2.0 | index |
[0-15] | FTP object index as returned by FTP-PROXY.CREATE | Used by wireless readers to proxy FTP transfer through base station. | Base station. | |
| FTP-PROXY.EXECUTE | Communication | PRIVATE | 4.2.0 | index type path length data |
[0-15] [0-15] [0-15] [0-3] [0-3] |
FTP object index as returned by FTP-PROXY.CREATE FTP transfer type (STOR/STOU/APPE/RETR) File path for FTP transfer Data length Data |
Used by wireless readers to proxy FTP transfer through base station. | Base station. | |
| FTP-PROXY.NOOP | Communication | PRIVATE | 5.0.0 | session |
Sends NOOP using FTP proxy. | Wireless readers. | |||
| FTP.LOG | Action | PRIVATE | 4.4.0 | GET | Get the FTP log of FTP control connection commands and replies in case of FTP problems. | ALL | |||
| HEAP.STATS | System | PRIVATE | 3.1.0 | Returns heap memory statistics. | |||||
| HPIT.INDICATOR-ON-TIME-US | Action | PRIVATE | 6.1.6 | SET|GET | IND_ID TIME_US |
[0-1] [100-10000] |
0 = Left indicator 1 = Right indicator |
Allows to control the Indicator0 (Green LED) on time to be executed in the following illumination pulse after an event has been detected. | DM370 series, DM470 series readers. |
| HPT.CHANNEL-ENABLED | Action | PRIVATE | 5.7.0 | SET|GET | channel_name, state |
[ON|OFF] string, [ON|OFF] | enable/disable Channel name. Switch state. | Enables or disables a given HPT log channel. | ALL |
| HPT.LOG | Action | PRIVATE | 5.7.0 | GET | Retrieves the HPT log as a binary file content. | ALL | |||
| I2O5.QZ-SIZE | Symbology | PRIVATE | 3.0.0 | SET|GET | state |
[0|100] | Quiet zone single strictness size. | ALL | |
| IDFLASH.READ | System | PRIVATE | 5.4.0 | SET | Read ID/slide in EEPROM content. | All | |||
| IDFLASH.WRITE | System | PRIVATE | 5.4.0 | SET | string |
Write ID/slide in EEPROM content. | All | ||
| IMAGE.FETCH | Camera | PRIVATE | 5.7.1 | size format quality |
[0-3] [0-2] [10, 15, 20... 85, 90] |
0: Full 1: 1/4 2: 1/16 3: 1/64 0: Bitmap 1: JPEG 2: PNG JPEG quality |
Acquires an image and transfers it. | ||
| IMAGE.LOAD | Camera | PRIVATE | 3.0.0 | num-bytes |
Loads image from PC to Reader. | ||||
| IMAGE.LOAD-FTP-MULT-PARAM | Camera | PRIVATE | 4.0.0 | ??? | |||||
| IMAGE.LOAD-FTP-MULT-PARAM | IO | PRIVATE | 5.5.0 | SET | server_ip picture last_image more burst_count buffer-overflow seq_nbr ” ” ”user” ”passwd” port |
[ON|OFF] [3] [0-1] |
Server IP Picture name enable/disable Number of images to take 0: Off 1: On Sequence number in the burst User name Password Port used |
Allows uploading of multiple pictures as a burst. | ALL |
| IMAGE.LOAD-FTP-PARAM | Camera | PRIVATE | 4.0.0 | ??? | |||||
| IMAGE.SEND-BUFFER | Camera | PRIVATE | 5.6.3 | index size format quality |
[0-3] [0-2] [10, 15, 20... 85, 90] |
0: Full 1: 1/4 2: 1/16 3: 1/64 0: Bitmap 1: JPEG 2: PNG JPEG Quality |
Send specified image buffer date. | ||
| IMAGEBUFFER.NO-READ-IMAGE-LAST-NUMBER | RecordPlayback | PRIVATE | 5.5.0 | SET|GET | limit |
[n][Max Int] | In Burst trigger mode, n is the number of images in a burst. In other trigger modes, there is no limit. | Stores images up to the limit. | Fixed-mount readers, only in Single, Burst, Self and Continuous modes. |
| IMAGEBUFFER.NO-READ-IMAGE-MODE | RecordPlayback | PRIVATE | 5.0.0 | SET|GET | size |
[0-3] |
0: No-Read Image Period 1: No-Read Image Number 2: No-Read Image Rate 3: No-Read Image Range |
No-Read Image stores only one image per trigger and you can select which one. No-Read Image Period stores every nth bad read image. This is evaluated across trigger modes. For example, if you have burst trigger selected with a length of 5 and set period to 3, the 1st and 4th image of the first, but the 2nd and 5th of the second burst will be stored. No-Read Image Range stores all bad read images from the no-read image number to the last no-read image number. | Fixed-mount readers, only in Single, Burst, Self and Continuous modes. |
| IMAGEBUFFER.NO-READ-INDEX | RecordPlayback | PRIVATE | 4.4.0_cr2 | SET|GET | index |
0 is the default behavior to send all as selected; 1 – max burst is send only the index selected. | DM474, DM300 series readers, DM8050 and DM8600. | ||
| IMAGEBUFFER.SEND-FTP-PARAM | RecordPlayback | PRIVATE | 4.0.0 | Transmit buffered images to designated FTP server. | Fixed mount Ethernet readers, DM8050 and DM8600. | ||||
| INPUT-STRING.ENABLE | Data Formatting | PRIVATE | 4.4.0_cr10 | SET|GET | state |
[ON|OFF] | enable/disable | Enables or disables the use of the Input String feature (available for serial, telnet, NetworkClient). When enabled, a header and the footer can be set by the INPUT-STRING.HEADER and INPUT-STRING.FOOTER commands, respectively. A string of characters can be given between the header and the footer, which will be sent with the formatted output (for example, [hello world], if the header is set to ’[’ and the footer to ’]’). Since the input string is saved temporarily, it appears only in the next result output. Use Setup Tool (the <Input String> option) or <ISTR> with DMCC (see SET FORMAT.TOKEN) to allow Input string in the result output. | ALL |
| INPUT.EVENT-MESSAGE | IO | PRIVATE | 5.0.0_cr10 | SET|GET | state |
[ON|OFF] | enable/disable | Instructs the system to generate a message for every input line state change. | DM300 series readers, DM474. |
| INPUT.VIRTUAL | Action | PRIVATE | 3.0.0 | line state |
[0-7] [ON|OFF] |
enable/disable |
Software Virtual Input. Trigger is equivalent to line 0. Note that the input actions "Train Code," "Optimize Brightness," "Set Match String," and "Read Configuration Code" are carried out only after the next trigger. |
Fixed mount devices. | |
| INTELLIGRATED.ENABLED | Communication | PRIVATE | 5.0.0_cr14 | SET|GET | state |
[ON|OFF] | enable/disable | Enable or disable the Intelligrated protocol. | DM503 series readers. |
| INTELLIGRATED.HEARTBEAT | IO | PRIVATE | 5.0.0_cr14 | SET|GET | sec |
[0-50] | seconds | Sets or gets the time between heartbeat transmissions. A value of 0 disables the heartbeat. | DM503 series readers. |
| KEY.EMULATE-PS2 | IO | PRIVATE | 5.4.0 | SET|GET | state |
[ON|OFF]
[OFF, Wedge, EmulationG |
enable/disable
OFF: no emulation Wedge: reader and PS/2 keyboard are connected using a wedge cable Emulation: reader is connected to wedge and no PS/2 keyboard is present |
Wireless readers. | |
| LIGHT.AIMER | Camera | PRIVATE | 3.0.0 | SET|GET | aimer-mode |
[0-3] |
0: Off 1: LED 2: Laser 3: Both |
Aimer Enable. | DM700 |
| LIGHT.AIMER | Camera | PRIVATE | 3.0.0 | SET|GET | aimer-mode |
[0-3] |
0: Off 1: On when idle 2: Blink (default) 3: On (default) |
Aimer Enable. | DM7500 |
| LIGHT.HIGH-FREQUENCY-FORCE | Camera | PRIVATE | 5.2.0 | SET|GET | enable |
[ON|OFF] | enable/disable | Enable High Frequency Lights even if overheat protection would normally prohibit it. | DM300 series readers |
| LIGHT.ON-AXIS-INTENSITY | Camera | PRIVATE | 5.7.0 | SET|GET | intensity |
[0..3] | on-axis illumination intensity | Controls the intensity of the DM262 UHD on-axis illumination. | DM262 |
| LIGHT.SELF-REPAIR | Camera | PRIVATE | 5.5.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enables/disables internal illumination self repair mode. | DM300 series readers |
| LIMIT.CONS-NOREAD | System | PRIVATE | 5.4.0 | SET|GET | string |
empty string: feature disabled "CBRD>n": signal after n consecutive bad reads |
Sets/gets the threshold for consecutive bad read event signaling. | ALL | |
| LL.REGTODISTANCE | System | PRIVATE | 5.4.0 | register |
Get distance in mm for specified register steps at current temperature. | Readers with liquid lens. | |||
| LLFLASH.READ | System | PRIVATE | 5.4.0 | GET | Gets liquid lens flash content. | Readers with liquid lens. | |||
| LLFLASH.WRITE | System | PRIVATE | 5.4.0 | SET | Sets liquid lens flash content. | Readers with liquid lens. | |||
| LVHSTS.ENABLED | Communication | PRIVATE | 4.4.1_cr6_sr2 | SET|GET | state |
[ON|OFF] | enable/disable | Enable or disable the USPS Lehigh Valley HSTS protocol. | DM300 series readers, DM474. |
| MARKEM.ENABLED | Communication | PRIVATE | 5.0.0_cr11 | SET|GET | state |
[ON|OFF] | enable/disable | Enable or disable the Markem protocol. | DM300 series readers, DM474. |
| MC-PROTOCOL.ENABLED | Communication | PRIVATE | SET|GET | state |
[ON|OFF] | enable/disable | Enable or disable MC-Protocol communication. | Ethernet readers. The DM8000 series wireless readers also support this protocol if the base station is connected through Ethernet. In the case of a Bluetooth connection, the command has to be sent to the base station, not to the reader. | |
| MOTION-DETECTION.INIT-STATE | Action | PRIVATE | 5.7.0 | SET|GET | state |
[ON|OFF] | enable/disable ON: motion detection is default state\n; OFF: switch to motion detection state after timeout | Specify the motion detection default state. | DM50, DM60, DM70, DM150, DM260, DM300, DM474, DM503. |
| MOTION-DETECTION.TIMEOUT | Action | PRIVATE | 5.7.0 | SET|GET | [0 - 3600] | sec | Time after the reader switches into the motion detection mode. | DM50, DM60, DM70, DM150, DM260, DM300, DM474, DM503. | |
| MQA.POSTAL-HEIGHT_MICRON | Code Quality | PRIVATE | 4.4.1_cr7 and 5.0.0_cr6 | SET|GET | height |
Height in microns per pixel for MERLIN metrics. | DM300 series readers, DM474. | ||
| MQA.POSTAL-MODE | Code Quality | PRIVATE | 4.0.0 | SET|GET | mode |
[0-2] |
0: Off 1: Partial Metrics 2: All Metrics |
Gets or sets the postal verification mode. | ALL |
| NET-LOCAL.MAX-LINK-SPEED | Communication | PRIVATE | 5.2.0 | SET|GET | speed |
[0-4] |
0: 1000 MBits/sec Full Duplex 1: 100 MBits/sec Full Duplex 2: 100 MBits/sec Half Duplex 3: 10 MBits/sec Full Duplex 4: 10 MBits/sec Half Duplex |
Limits the advertised autonegotiation maximum link speed. | DM503 only |
| NET-LOCAL.PCAP | System | PRIVATE | 5.7.0 | SET|GET | interface |
interface | Retrieves packet capturing buffer. | ALL | |
| NET-LOCAL.SEC-ENABLE | Communication | PRIVATE | 5.2.0 | SET|GET | state |
[ON|OFF] |
enable/disable
ON: use authentication OFF: no authentication |
Use authentication over telnet for communciation between reader and base. | Ethernet readers. |
| NET-LOCAL.SEC-PASSWORD | Communication | PRIVATE | 5.2.0 | SET|GET | string |
password for authentication | Use authentication over telnet for communciation between reader and base. | Ethernet readers. | |
| NET-LOCAL.SEC-USERNAME | Communication | PRIVATE | 5.2.0 | SET|GET | string |
username for authentication | Use authentication over telnet for communciation between reader and base. | Ethernet readers. | |
| NET-LOCAL.TCP-KEEPALIVE | Communication | PRIVATE | 3.3.1 | SET|GET | state |
[ON|OFF] | enable/disable | Enable/Disable TCP keepalive message. | Ethernet readers. |
| NET-LOCAL.TCP-KEEPALIVE-COUNT | Communication | PRIVATE | 3.3.1 | SET|GET | value |
[0-32565] | TCP keep alive retry count. | Ethernet readers. | |
| NET-LOCAL.TCP-KEEPALIVE-IDLE | Communication | PRIVATE | 3.3.1 | SET|GET | value |
[0-32565] | TCP keep alive time. Ethernet readers. |
||
| NET-LOCAL.TCP-KEEPALIVE-INTERVAL | Communication | PRIVATE | 3.3.1 | SET|GET | value |
[0-32565] | TCP keep alive interval. Ethernet readers. |
||
| OUTPUT.CQ-FAIL | IO | PRIVATE | 3.0.0 | Output Code Quality failed actions. Verifiers only. |
|||||
| OUTPUT.DATAVALID-FAIL | IO | PRIVATE | 3.0.0 | Output Data Validation failed actions. | |||||
| OUTPUT.GOOD | IO | PRIVATE | 3.0.0 | Output good read actions. | |||||
| OUTPUT.NOREAD | IO | PRIVATE | 3.0.0 | Output no read actions. | |||||
| OUTPUT.TRIG-OVERRUN | IO | PRIVATE | 3.0.0 | Output trigger overrun actions. | |||||
| PHARMA.MAX-LENGTH | Symbology | PRIVATE | 4.4.0 | SET|GET | length |
[1-6] | Gets or sets the maximum length for a Pharmacode. Obsoleted in 5.1. |
ALL | |
| PHARMA.MIN-LENGTH | Symbology | PRIVATE | 4.4.0 | SET|GET | length |
[1-6] | Gets or sets the minimum length for a Pharmacode. Obsoleted in 5.1. |
ALL | |
| PHARMA.SUPPLEMENTARY | Symbology | PRIVATE | 3.4.0 | SET|GET | state |
[ON|OFF] | enable/disable | Get or set whether supplementary component is expected. | ALL |
| PHARMA.SUPPLEMENTARY-GAP-THRESH | Symbology | PRIVATE | 3.4.0 | SET|GET | gap |
[100-300] | Get or set the Pharmacode supplementary gap threshold in pixels. | ALL | |
| PHS.ADD-PACKAGE | System | PRIVATE | 5.4.0 | ||||||
| POWER.SLEEP | System | PRIVATE | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Power Save Mode Enable. | DM7500 |
| POWER.SLEEPTIME | System | PRIVATE | 3.0.0 | SET|GET | secs |
[0, 60, 120... 600] | seconds | Time before entering power-save mode. | DM7500 |
| PPP.IP-CLIENT | System | PRIVATE | 5.4.0 | SET|GET | Reader/client device IP address for internal communication between client and base station. | Wireless readers. | |||
| PPP.IP-SERVER | System | PRIVATE | 5.4.0 | SET|GET | Base/server device IP address for internal communication between client and base station. | Wireless readers. | |||
| PPP.NETMASK | System | PRIVATE | 5.4.0 | SET|GET | int |
Netmask for internal communication between reader and base. | Wireless readers. | ||
| PRESENT.NEVER2X | System | PRIVATE | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Never Read the Same Code Twice. OBSOLETED in 4.5. Presentation mode only. |
ALL |
| PRESENT.REREAD | System | PRIVATE | 3.0.0 | SET|GET | ms |
[0-10000] | milliseconds | OBSOLETED in 4.5. Presentation Mode Re-read Delay. | ALL |
| PRESENT.RESCAN | System | PRIVATE | 3.0.0 | SET|GET | ms |
[0-10000] | milliseconds | OBSOLETED in 4.5. Presentation Mode Rescan Delay. | ALL |
| PROFIBUS.GATEWAY-COM | Communication | PRIVATE | 5.5.0 | SET|GET | mode |
[0-2] |
0: Profibus 1: RS485 2: RS422 |
Get the COM configuration (Profibus / RS422 / RS485). | Fixed-mount readers |
| PROFIBUS.GATEWAY-FLOW | Communication | PRIVATE | 5.5.0 | SET|GET | mode |
[0-2] |
0: None 1: RTS/CTS 2: XON/XOFF |
The reader will return a value indicating the type of serial flow control to be used. | Fixed-mount readers |
| PROFIBUS.GATEWAY-HOST | Communication | PRIVATE | 5.5.0 | GET | type |
[0] | The reader will return a value indicating the host interface protocol. | Fixed-mount readers | |
| PROFIBUS.GATEWAY-MODE | Communication | PRIVATE | 5.5.0 | GET | mode |
[1] | Get the profibus mode configuration. | Fixed-mount readers | |
| PROFIBUS.GATEWAY-NODE | Communication | PRIVATE | 5.5.0 | SET|GET | node number |
[1-99] | The reader will return the Profinet node number for the gateway. | Fixed-mount readers | |
| PROFIBUS.GATEWAY-RUN | Communication | PRIVATE | 5.5.0 | SET|GET | state |
[ON|OFF] | Runtime start message or heartbeat. | Fixed-mount readers | |
| PROFIBUS.GATEWAY-STATUS | Communication | PRIVATE | 5.5.0 | SET|GET | status |
[0-4] |
0: ok, no error 1: Invalid op mode 2: Invalid node number 3: Invalid flow control 4: Invalid host interference |
Set Gateway error message. | Fixed-mount readers |
| PROFIBUS.GATEWAY-VERSION | Communication | PRIVATE | 5.5.0 | SET|GET | mode |
Set the GW firmware version, used for baud rate detection. | Fixed-mount readers | ||
| PROXIMITY.CURRENT | Communication | PRIVATE | 5.4.0 | SET|GET | int |
[10-200] step 10 | IR LED current of the proximity sensor in mA | A higher value will increase the sensitivity of the sensor. | DM8600 |
| PROXIMITY.THRESHOLD | Communication | PRIVATE | 5.4.0 | SET|GET | int |
[0-100] | Threshold value which defines if the optical button has been pressed or released. A lower value will increase the sensitivity of the sensor. | DM8600 | |
| SCRIPT.GARBAGE-COLLECT | Communication | PRIVATE | 5.5.0 | force |
[ON|OFF] | enable/disable Enforce the garbage collection | Check or enforce the Garbage Collection process. | Fixed mount readers | |
| SDCARD.TESTFILE | Communication | PRIVATE | 5.5.0 | SET|GET | string |
SET: writes argument to a predefined file on the card. GET: reads back the same file and returns its content. | DM360 series readers, DM474 | ||
| SDK.VERSION | System | PRIVATE | 3.0.0 | SET|GET | Gets or sets the SDK version. Used by early versions of the DataMan SDK. | ||||
| SSH.UNLOCK | Action | PRIVATE | 6.0.1 | GET | The PC (host) sends this command to the reader to initiate the unlocking mechanism. As a response, the reader sends back a 32 byte random challenge to the PC. | DM474 | |||
| SSH.UNLOCK | Action | PRIVATE | 6.0.1 | SET | signature of the challenge |
The argument is the signature of the random challenge generated by the reader and signed with a public key on the PC side. The reader then verifies that the challenge was signed with the proper key and sent back in one minute. In this case, the SSH service is started on the reader, otherwise, an invalid parameter error is returned. | DM474 | ||
| SYMBOL.4STATE-RMC | Symbology | PRIVATE | 5.6.0 | SET|GET | state |
[ON|OFF] | enable/disable Enable/Disable | Enables or disables Royal Mail Code Symbology. | DM50, DM60, DM70, DM150, DM260, DM30x, DM474, DM503, MX-1000, MX-1502. Mobile. |
| SYMBOL.RPC | Symbology | PRIVATE | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Reader Programming Code. | DM70, DM150, DM260 |
| SYNC-ACQUISITION.START-DELAY | Communication | PRIVATE | 5.0.0 | SET|GET | us |
[0-25000] | microseconds | This command is to adjust the delay between the master/slave trigger sent via Ethernet and the sync signal sent for RS-845 to compensate for the longer runtime of the message via Ethernet. Developer only command. |
DM503 |
| TEMPERATURE.CPU | System | PRIVATE | 6.1.0 | GET | CPU Temperature in °C. | DM370 series, DM470 series readers. | |||
| TEMPERATURE.LL | System | PRIVATE | 6.1.0 | GET | Get Liquid lens Temperature in °C. Only available if a Liquid lens is present. |
DM370 series, DM470 series readers. | |||
| TEMPERATURE.SENSOR | System | PRIVATE | 6.1.0 | GET | Get Imager Temperature in °C. Only available if compatible image sensor is present. Readout can interfere with image acquisition. |
DM370 series, DM470 series readers. | |||
| TLS.BENCHMARK | Action | PRIVATE | 5.7.0 | Starts a benchmark of the SSL/TLS library.This DMCC is password protected. The result can be checked in the HPT log output. | ALL | ||||
| TLS.SELFTEST | Action | PRIVATE | 5.7.0 | Starts a benchmark of the SSL/TLS library. This DMCC is password protected. The result can be checked in the HPT log output. | ALL | ||||
| TRACE.DUMPFILE | System | PRIVATE | 5.4.0 | filename |
Saves a trace log file, which is archived in flash, into a file. | ||||
| TRAIN.AVAILABLE | Symbology | PRIVATE | 3.2.0 | GET | symbology |
Indicates whether incremental training is available for the selected symbology group. | Fixed mount readers. | ||
| TRAIN.CODE-FROM-IMAGE | Action | PRIVATE | 4.5.0 | num-bytes |
Code is trained from uploaded image. | Fixed mount devices. | |||
| TRIGGER.DELAY | Camera | PRIVATE | 3.0.0 | SET|GET | milliseconds |
[0-10000] | Trigger Delay. Delay camera acquisition by specified number of milliseconds. |
ALL | |
| TRIGGER.IGNORE-DISTANCE | IO | PRIVATE | 5.5.0 | SET|GET | milliseconds |
[0-2147483646] | Sets or gets the minimum trigger distance for a trigger to be considered good. All trigger durations less than the specified duration will be aborted. | Fixed-mount readers | |
| TRIGGER.IGNORE-TIME | IO | PRIVATE | 5.5.0 | SET|GET | milliseconds |
[0-10000] | Sets or gets the minimum trigger duration for a trigger to be considered good. All trigger durations less than the specified duration will be aborted. | Fixed-mount readers | |
| TRIGGER.IGNORE-TYPE | IO | PRIVATE | 5.5.0 | SET|GET | mode |
[0-2] |
0: none 1: time 2: distance |
Sets or gets what type of triggers to ignore. | Fixed-mount readers |
| VSOC.ACCELERATION | Decoder | PRIVATE | 4.0.0 | SET|GET | enable |
[ON|OFF] | enable/disable | Enabled or disable VSOC acceleration. | |
| VSOC.LEGACY-AUTO-REG | Camera | PRIVATE | 4.0.0 | SET|GET | enable |
[ON|OFF] | enable/disable | Enabled or disable VSOC auto-regulation algorithm. | |
| CAMERA.FOV | Camera | PREVIEW | 3.2.0 | SET|GET | left (multiple of 8) right (multiple of 8) top (multiple of 4) bottom (multiple of 4) |
[0...] [left+64...] [0...] [top+64...] |
pixels from left pixels from right pixels from top pixels from bottom |
The camera field of view is the area of the camera used for image acquisition. | ALL |
| INTER-MESSAGE.DELAY | Communication | PREVIEW | 3.2.0 | SET|GET | value |
[0-10000] | milliseconds | Transmission delay between buffered read strings. | Wireless readers. |
| LIGHT.EXTERNAL-PRECHARGE-TIME | Camera | PREVIEW | 3.0.0 | SET|GET | time |
[1-980] | microseconds | External light precharge time. | Fixed mount readers. |
| OUTPUT.ACTION | IO | PREVIEW | 3.0.0 | SET|GET | line action |
[0-7] [0-1] |
line number 0: Open 1: Close |
Output Action. Open or Close output line on event. Only supported on line 1. |
Fixed mount readers. |
| OUTPUT.DATAVALID-FAIL | Action | PREVIEW | 3.0.0 | Virtual Data Validation Failure. Device beeps, flashes indicator lights, and sets output lines as if the specified Data Validation failure event occurred. |
ALL | ||||
| OUTPUT.EVENTS | IO | PREVIEW | 3.0.0 | SET|GET | line read no-read validation-failure trigger-overrun buffer-overflow user event 1 user event 2 |
[0-7] [0-1] [0-1] [0-1] [0-1] [0-1] [0-1] [0-1] |
i/o line number 0: Off 1: On 0: Off 1: On 0: Off 1: On 0: Off 1: On 0: Off 1: On 0: Off 1: On 0: Off 1: On |
Output Events. Configure output line to signal based on event. |
Fixed mount readers. |
| OUTPUT.GOOD | Action | PREVIEW | 3.0.0 | Virtual Good-Read. Device beeps, flashes indicator lights, and sets output lines as if the specified read event occurred. |
ALL | ||||
| OUTPUT.NOREAD | Action | PREVIEW | 3.0.0 | Virtual No-Read. Device beeps, flashes indicator lights, and sets output lines as if the specified no-read event occurred. |
ALL | ||||
| TRAIN.AUTO-DISABLE | Symbology | PREVIEW | 3.2.0 | SET|GET | state |
[ON|OFF] | enable/disable | Indicates whether untrained symbology groups will be disabled after the next attempt to train. | Fixed mount readers. |
| 2D.ALGORITHM | Symbology | PUBLIC | 3.0.0 | SET|GET | algorithm |
[0-1] |
0: IDMax ©
1: IDQuick |
IDQuick or IDMax© | X, XM, SX and QE fixed-mount readers. All Q models except for DM503Q. |
| ACCEL-SENSOR.OPERATION-MODE | Communication | PUBLIC | 5.4.0 | SET|GET | int |
[0-1] |
0: Acceleration Sensor is not used for waking the reader up from hibernation. 1: Acceleration Sensor is used for waking the reader up from hibernation. |
Configures the application of the acceleration sensor. This command is only valid for Bluetooth-connected readers. |
DM8050, DM8600. |
| ACCEL-SENSOR.SENSITIVITY | Communication | PUBLIC | 5.4.0 | SET|GET | int |
[0-2] |
0: Low 1: Medium 2: High |
Gets/sets the sensitivity of the acceleration sensor of/to the predefined value. | DM8050, DM8600. |
| ANDROID.AOA-SWITCH-TIMEOUT | Communication | PUBLIC | 5.7.1 | SET|GET | timeout [ms] |
0-3600000 | Timeout in milliseconds. | After boot the MX device won’t switch to AOA mode for this amount of time. | MX-1000, MX-1502 |
| ANDROID.ROLE | Communication | PUBLIC | 5.7.1 | SET|GET | role |
0-2 |
0: Auto 1: Device 2: AOA |
Sets the USB role of the MX device when in Android mode. | MX-1000, MX-1502 |
| AZTEC.TRAINED-MODEL | Decoder | PUBLIC | 5.7.0 | SET|GET | grid size module size polarity |
[15-151] [1-1000] [0-2] |
Grid size Module size * 10 0: dark-on-light 1: light-on-dark 2: either |
Set training parameters for Aztec symbology. | Fixed-mount readers |
| BACKUP.EXPORT | Action | PUBLIC | 5.7.0 | Exports a human readable version of the current reader backup. | ALL | ||||
| BATTERY.CHARGE | System | PUBLIC | 4.4.0 | GET | int |
[0-100] | Displays, in percentage, current battery level. | MX-1000 and DM8000 series readers. | |
| BATTERY.INFO | System | PUBLIC | 5.5.1 | GET | battery |
[0-1] |
0: internal battery 1: grip battery |
Gets verbose battery status. | MX-1000 |
| BEEP | Action | PUBLIC | 3.0.0 | repetition level |
[0-3] [0-2] |
Command audio beep. | ALL | ||
| BEEP.DATAVALID-FAIL | IO | PUBLIC | 3.0.0 | SET|GET | repetition level |
[0-3] [0-2] |
number of beeps 0: Lo pitch 1: Med pitch 2: Hi pitch |
Data Validation Failure Beep Settings. | ALL except for DM50, DM60 and DM70. |
| BEEP.DATAVALID-FAIL-OL | IO | PUBLIC | 3.0.0 | SET|GET | repetition level |
[0-3] [0-2] |
number of beeps 0: Lo pitch 1: Med pitch 2: Hi pitch |
Data Validation Failure Beep Settings when offline. | Wireless readers. |
| BEEP.GLOBAL-ENABLE | Action | PUBLIC | 5.7.0 | SET|GET | state |
[ON|OFF] |
ON: enable OFF: disable |
This command will disable all beeps on the DataMan product. | DM8050, DM8600 |
| BEEP.GOOD | IO | PUBLIC | 3.0.0 | SET|GET | repetition level |
[0-3] [0-2] |
number of beeps 0: Lo pitch 1: Med pitch 2: Hi pitch |
Good Read Beep Settings. | ALL except for DM50, DM60 and DM70. |
| BEEP.GOOD-OL | IO | PUBLIC | 3.0.0 | SET|GET | repetition level |
[0-3] [0-2] |
number of beeps 0: Lo pitch 1: Med pitch 2: Hi pitch |
Good Read Beep Settings when offline. | Wireless readers. |
| BEEP.NO-READ | IO | PUBLIC | 3.0.0 | SET|GET | repetition level |
[0-3] [0-2] |
number of beeps 0: Lo pitch 1: Med pitch 2: Hi pitch |
No-Read Beep Settings. | ALL except for DM50, DM60 and DM70. |
| BEEP.NO-READ-OL | IO | PUBLIC | 3.0.0 | SET|GET | repetition level |
[0-3] [0-2] |
number of beeps 0: Lo pitch 1: Med pitch 2: Hi pitch |
No-Read Beep Settings when offline. | Wireless readers. |
| BEEPER.ENABLED | IO | PUBLIC | 5.7.1 | SET|GET | state |
[ON|OFF] | Enable/disable beeper in general. | All | |
| BLUETOOTH.MAC-ADDRESS | Communication | PUBLIC | 5.4.0 | GET | Returns the own Bluetooth address of the device. | DM8050, DM8600. | |||
| BLUETOOTH.MAX-RF-POWER | Communication | PUBLIC | 5.4.3 | SET|GET | int |
-23-7 | Maximum output power in dBm | DM8050, DM8600, and Bluetooth base stations. | |
| BUTTON.3SEC-ACTION | IO | PUBLIC | 3.0.0 | SET|GET | mode state |
[0-6] [ON|OFF] |
0: Train 1: Optimize Brighness 2: Set Match String 3: Optimize Focus 4: Read Configuration Code 5: Tune 6: Toggle Test Mode enable/disable |
Three Second Button Action. | Fixed mount readers. Test Mode is only supported on the DM503, DM300 series readers and DM474. |
| BUTTON.ACTION | IO | PUBLIC | 5.5.1 | SET|GET | button action |
[0-2] [0-1] |
Index of button (0:Left;1:Right;2:Grip) 0: disabled 1: trigger |
Sets and gets the assigned feature for hardware buttons. | MX-1000 |
| BUTTON.ENABLE | IO | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enables or disables the trigger button. | Fixed mount readers. |
| BUTTON.SAVE-MATCH-STRING | Communication | PUBLIC | 4.5.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enables or disables saving the trained match string directly to flash when Set Match String is enabled for the 3 sec button press action. If disabled, the match string is only stored in RAM and if the configuration is not saved manually it will be gone after reboot. | DM474, DM503, and DM300 series readers. |
| C11.CHKCHAR | Symbology | PUBLIC | 5.7.1 | SET|GET | state |
[ON|OFF] |
ON: enable OFF: disable (default) |
Code 11 Check Character | Mobile |
| C11.CHKCHAR-OPTION | Symbology | PUBLIC | 5.7.1 | SET|GET | int |
[0-1] |
0: disable 1: enable (default) |
Mobile | |
| C11.CODESIZE | Symbology | PUBLIC | 5.7.1 | SET|GET | any, min, max |
[ON|OFF] [1-max] [min-80] |
any length code minimum code length maximum code length |
Code 11 Code Size | ALL |
| C128.CODESIZE | Symbology | PUBLIC | 3.0.0 | SET|GET | any min max |
[ON|OFF] [1-max] [min-80] |
any length code minimum code length maximum code length |
Code 128 Allowed Size. | ALL |
| C25.CHKCHAR | Symbology | PUBLIC | 5.5.2 | SET|GET | state |
[ON|OFF] |
ON: enable OFF: disable |
Code 25 Check Character | ALL |
| C25.CODESIZE | Symbology | PUBLIC | 5.5.2 | SET|GET | any, min, max |
[ON|OFF] [1-max] [min-80] |
any length code minimum code length maximum code length |
Code 25 Code Size. For the Manatee Works SDK, all of the Code 25 variants use the same minimum length; thus it will accept either C25.CODESIZE or I205.CODESIZE. | ALL |
| C25.QZ-SIZE | Symbology | PUBLIC | 5.5.2 | SET|GET | size |
[0..100] | any length code | Sets or gets the single side strictness as a percentage. | ALL |
| C25.XMTCHK | Symbology | PUBLIC | 5.5.2 | SET|GET | state |
[ON|OFF] |
ON: enable OFF: disable |
Sets or gets whether to transmit the check digit. | ALL |
| C39.ASCII | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Code 39 Full ASCII. | ALL |
| C39.CHKCHAR | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Code 39 Check Character. | ALL |
| C39.CODESIZE | Symbology | PUBLIC | 3.0.0 | SET|GET | any min max |
[ON|OFF] [1-max] [min-80] |
any length code minimum code length maximum code length |
Code 39 Code Size. | ALL |
| C39.XMTCHK | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Code 39 Transmit Check Character. | ALL |
| C93.CODESIZE | Symbology | PUBLIC | 3.0.0 | SET|GET | any min max |
[ON|OFF] [1-max] [min-80] |
any length code minimum code length maximum code length |
Code 93 Code Size. | ALL |
| CAMERA.AUTO-REGULATION | Camera | PUBLIC | 5.6.0 | SET|GET | auto |
[ON|OFF] |
ON: Automatic OFF: Manual |
Camera Parameters where exposure is in microseconds. | DM50, DM60, DM70, DM150, DM260, DM300 series readers, DM360 series readers, DM474, DM503, DM8600 |
| CAMERA.BURST-LENGTH | Camera | PUBLIC | 3.0.0 | SET|GET | count |
[2-*] | number-images | Burst Length. Number of Acquired Images in Burst Trigger-Mode. Actual maximum can be increased by reducing the camera field of view or reserving fewer images for Process Monitor/Record and Playback. |
Fixed mount readers. |
| CAMERA.EXPOSURE | Camera | PUBLIC | 3.0.0 | SET|GET | auto target exposure gain |
[ON|OFF] [0-255] [0-22] [4-60] |
ON: Automatic OFF: Manual target pixel value 0: 1/10000 1: 1/7500 2: 1/5000 3: 1/4000 4: 1/3000 5: 1/2500 6: 1/2000 7: 1/1500 8: 1/1250 9: 1/1000 10: 1/750 11: 1/500 12: 1/300 13: 1/250 14: 1/200 15: 1/150 16: 1/125 17: 1/100 18: 1/75 19: 1/50 20: 1/40 21: 1/30000 22: 1/15000 camera gain |
Camera Parameters. The arguments 'exposure' and 'gain' have no effect if 'auto' is ON and the 'target' has no effect if 'auto' is OFF. | DM700. |
| CAMERA.EXPOSURE | Camera | PUBLIC | 5.6.0 | SET|GET | exposure |
[18-25000] | exposure | Camera Parameters where exposure is in microseconds. | DM50, DM60, DM70, DM150, and DM260 |
| CAMERA.EXPOSURE | Camera | PUBLIC | 5.6.0 | SET|GET | exposure |
[5-1000] [12-1000] [5-100000] |
DM300 and DM302 internal illumination DM303 internal illumination with external or no illumination |
Camera Parameters where exposure is in microseconds. | DM300 series readers, DM360 series readers, DM474, DM8600. |
| CAMERA.EXPOSURE | Camera | PUBLIC | 5.6.0 | SET|GET | exposure |
[12-100000] | exposure independent of illumination | Camera Parameters where exposure is in microseconds. | DM503 |
| CAMERA.EXPOSURE-LIMIT-US | Camera | PUBLIC | 5.5.0 | GET | exposure |
maximum value allowed for SET CAMERA.EXPOSURE-US | Get the maximum allowed exposure limited by current settings in us. | Fixed Mount readers. | |
| CAMERA.EXPOSURE-US | Camera | PUBLIC | 5.5.0 | SET|GET | auto target exposure gain |
[ON|OFF] [0-255] [18-25000] [0-60] |
ON: Automatic OFF: Manual target pixel value exposure camera gain |
Camera Parameters where exposure is in microseconds. The argument 'exposure' and 'gain' has no effect if 'auto' is ON and 'target' has no effect at all. | DM50, DM60, DM70, DM150, DM260 |
| CAMERA.EXPOSURE-US | Camera | PUBLIC | 5.5.0 | SET|GET | auto target exposure gain |
[ON|OFF] [0-255] [5-1000] [12-1000] [5-100000] [0-106] |
ON: Automatic OFF: Manual target pixel value DM300 and DM302 internal illumination DM303 internal illumination with external or no illumination camera gain |
Camera Parameters where exposure is in microseconds. The argument 'exposure' and 'gain' has no effect if 'auto' is ON and 'target' has no effect at all. | DM300 series readers, DM360 series readers, DM474, DM8600. |
| CAMERA.EXPOSURE-US | Camera | PUBLIC | 5.5.0 | SET|GET | auto target exposure gain |
[ON|OFF] [0-255] [12-100000] [0-41] |
ON: Automatic OFF: Manual target pixel value exposure independent of illumination camera gain |
Camera Parameters where exposure is in microseconds. The argument 'exposure' and 'gain' has no effect if 'auto' is ON and 'target' has no effect at all. | DM503 |
| CAMERA.EXPOSURE-US | Camera | PUBLIC | 5.5.0 | SET|GET | auto target exposure gain |
[ON|OFF] [0-255] [50-25000] [0-60] |
ON: Automatic OFF: Manual target pixel value camera gain |
Camera Parameters where exposure is in microseconds. The argument 'exposure' and 'gain' has no effect if 'auto' is ON and 'target' has no effect at all. | MX-1000 and DM8000 series readers. |
| CAMERA.FOV-ENABLED | Camera | PUBLIC | 3.2.0 | SET|GET | state |
[ON|OFF] | enable/disable | Indicates whether the full FoV or a custom FoV will be used for image acquisition. You can change this value only for the following trigger types: single, burst, and continuous. |
ALL |
| CAMERA.FULL-BLACK-LEVEL-CORRECTION | Camera | PUBLIC | 5.5.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enables Full black level correction. | DM300 series readers, DM474. |
| CAMERA.GAIN | Camera | PUBLIC | 5.5.0 | SET|GET | gain |
[1.00-31.76] | The gain has no effect if the camera runs with automatic exposure | DM300 series readers, DM474. | |
| CAMERA.GAIN | Camera | PUBLIC | 5.5.0 | SET|GET | gain |
[1.00-13.88] | The gain has no effect if the camera runs with automatic exposure | DM503 | |
| CAMERA.GAIN | Camera | PUBLIC | 5.5.0 | SET|GET | gain |
[1.00-15.00] | The gain has no effect if the camera runs with automatic exposure | DM50, DM60, DM70 | |
| CAMERA.GAIN-LIMIT | Camera | PUBLIC | 5.7.0 | SET|GET | gain |
[1.00-max_gain] | 1.00-max_gain: The maximum gain to use | Controls the maximum gain the tuning and auto-regulation process uses to find the best reader settings. Useful to limit noise in Images. | Fixed mount readers. |
| CAMERA.HDR-MODE | Camera | PUBLIC | 6.1.0 | SET|GET | mode |
[0-2] |
0: Off 1: Global 2: Local |
HDR mode | DM470 series readers. |
| CAMERA.HDR-MODE | Camera | PUBLIC | 6.1.6 | SET|GET | mode |
[0-1] |
0: Off 1: Global |
HDR mode | DM370 series readers. |
| CAMERA.INTERVAL-US | Camera | PUBLIC | 4.0.0 | SET|GET | us |
[*-1000000] |
Microseconds. Step size is 250. * By default the minimum range is 6000 but this can change depending on decode timeout and field of view. |
Acquisition Interval, the time between successive camera acquisitions in microseconds. Supported with Burst, Self, and Continuous trigger types. | DM50, DM60, DM70, DM474, DM503, and DM300 series readers. |
| CAMERA.MAX-EXPOSURE-US | Camera | PUBLIC | 4.0.0 | SET|GET | exposure |
[1-50] [1-410] [1-100000] |
with HPIA without HPIA with external or no illumination |
Maximum exposure limit in microseconds for autoregulation. HPIA = High Powered Illumination Accessory. |
DM70, DM150, DM260, DM474, DM503, and DM300 series readers. |
| CAMERA.MAX-EXPOSURE-US | Camera | PUBLIC | 5.1.0 | SET|GET | exposure |
[18-25000] | Maximum exposure limit in microseconds for autoregulation. | DM50, DM60, DM70. | |
| CAMERA.MIRROR-HORIZONTAL | Camera | PUBLIC | 5.2.0 | SET|GET | state |
[ON|OFF] | enable/disable | Mirror acquired image over the vertical axis. | DM474, DM503 and DM300 series readers. |
| CAMERA.MIRROR-VERTICAL | Camera | PUBLIC | 5.2.0 | SET|GET | state |
[ON|OFF] | enable/disable | Mirror acquired image over the horizontal axis. | DM70, DM260, DM474, DM503 and DM300 series readers. |
| CAMERA.TARGET-BRIGHTNESS | Camera | PUBLIC | 5.6.0 | SET|GET | target |
[0-255] | target pixel value | Camera Parameters where exposure is in microseconds. | All, except MX series readers. |
| CAMERA.XPAND-ROI | Camera | PUBLIC | 5.5.0 | SET|GET | ROI index left right top bottom |
[1-2] [0 - sensor width] [0 - sensor width] [0 - sensor height] [0 - sensor height] |
ROI index pixels from left pixels from right pixels from top pixels from bottom |
Specifies custom FOVE regions. Requires the 1DDataStitching feature key. |
DM70, DM150, DM260, DM300 series readers, DM474, DM503. |
| CAMERA.XPAND-ROI-TYPE | Camera | PUBLIC | 5.5.0 | SET|GET | int |
[0-3] |
0: None 1: Xpand-15 2: Xpand-25 3: Custom |
Indicates the used FOVE type. Requires the 1DDataStitching feature key. |
DM70, DM150, DM260, DM300 series readers, DM474, DM503. |
| CODABAR.CHKCHAR | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Codabar Check Character. | ALL |
| CODABAR.CODESIZE | Symbology | PUBLIC | 3.0.0 | SET|GET | any min max |
[ON|OFF] [1-max] [min-80] |
any length code minimum code length maximum code length |
Codabar Code Size. | ALL |
| CODABAR.XMTCHK | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Codabar Transmit Check Character. | ALL |
| COM.BAUD-RATE | Communication | PUBLIC | 3.0.0 | SET|GET | rate |
[1-5] |
1: 115200 2: 57600 3: 38400 4: 19200 5: 9600 |
ALL except for MX-1000. | |
| COM.BUFFER-AUTO-FLUSH | Communication | PUBLIC | 4.2.1 | SET|GET | state |
[ON|OFF] | enable/disable | Determines if the whole content of the offline buffer is automatically flushed to the first Telnet client. If not, flushing must be activated by the client. | Wireless readers. |
| COM.BUFFER-DATA | Communication | PUBLIC | 4.2.1 | SET|GET | state |
[ON|OFF] | enable/disable | Offline buffering. | Wireless readers. |
| COM.BUFFER-MODE | Communication | PUBLIC | 4.2.2 | SET|GET | int |
[0-1] |
0: Multiple 1: Single |
Sets or gets the offline buffering mode. | Wireless DM8000 readers. |
| COM.BUFFER-RESET | Action | PUBLIC | 4.2.1 | Clears the content of the offline buffer. | DM8050, DM8600 and MX-1000. | ||||
| COM.BUFFER-START-SEND | Action | PUBLIC | 4.2.1 | Valid if auto-flush is off. Activates buffer data output over Telnet channels (and flushes buffered codes). Data output is stopped every time when all Telnet channels are disconnected. | DM8050, DM8600 and MX-1000. | ||||
| COM.COMMUNICATIONS-MODULE | Communication | PUBLIC | 4.2.0 | GET | type |
[0-3] |
0: Serial 1: Ethernet 2: Wireless 3: Bluetooth |
Returns the type of communication module being used. | MX-1000 and DM8000 series readers. |
| COM.DATA-BITS | Communication | PUBLIC | 3.0.0 | SET|GET | bits |
[7,8] | ALL except for MX-1000. | ||
| COM.DMCC-RESPONSE | Communication | PUBLIC | 3.0.0 | SET|GET | mode |
[0|1] |
0: Silent (default) 1: Extended |
DMCC response format. | ALL |
| COM.MULTI-PORT | Communication | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable daisy chaining of readers so they share one COM port. | Fixed mount readers. |
| COM.PARITY | Communication | PUBLIC | 3.0.0 | SET|GET | parity |
[0-4] |
0: None 1: Even 2: Odd 3: Space 4: Mark |
All except for MX-1000 and MX-1502. | |
| COM.PROTOCOL | Communication | PUBLIC | 5.7.0 | SET|GET | type |
0..1 |
0: Off 1: RTS/CTS |
Sets hardware handshake type of serial port. | Devices with RTS/CTS lines |
| COM.RS232-ENABLE-PAUSE | Communication | PUBLIC | 5.5.0 | SET|GET | mode |
ON/OFF | Enable/disable pause in output data stream. | DM300 series readers, DM60, DM50, DM70, DM474 | |
| COM.RS232-INTERCHAR-DELAY | Communication | PUBLIC | 5.5.0 | SET|GET | us |
[0-5000] | milliseconds | Sets or gets the internal delay between sending characters to the serial port. | DM300 series readers, DM60, DM50, DM70, DM360 series readers, DM474, DM503 |
| COM.RS232-ROUTE | Communication | PUBLIC | 4.2.1 | SET|GET | value |
[0-1] |
0: base station 1: associated reader |
Controls to which device RS-232 communication is routed. | DM8000 series wireless readers. |
| COM.SCRIPT | Communication | PUBLIC | 5.5.0 | SET|GET | num-bytes |
GET: Retrieves the current communication script. SET: Uploads a communication script. | Fixed-mount readers. | ||
| COM.SCRIPT-ENABLED | Communication | PUBLIC | 5.5.0 | SET|GET | bool |
Enables/disables communication scripting or retrieves current state. | Fixed-mount readers. | ||
| COM.SCRIPT-ERROR | Communication | PUBLIC | 5.5.0 | GET | message |
script error message | Get the error message for the Custom Communication protocol script | Fixed-mount readers. | |
| COM.STOP-BITS | Communication | PUBLIC | 3.0.0 | SET|GET | bits |
[1-2] | ALL except for MX-1000. | ||
| COM.USB-COMPATIBILITY-MODE | Communication | PUBLIC | 3.0.0 | SET|GET | legacy |
[ON|OFF] |
ON: use pre-3.5.0 driver OFF: default |
Controls USB driver. Reboot is required. |
DM50, DM70 and DM8000 series readers. |
| COM.USB-HID-ONLY | Communication | PUBLIC | 5.4.0 | SET|GET | state |
[ON|OFF] | enable/disable | When enabled, the base station will appear as a single USB Keyboard device on its USB port, instead of a composite device. | DM8000 base station G2 |
| COM.USB-MODE | Communication | PUBLIC | 4.2.1 | SET|GET | type |
[0-1] |
0: USB COM 1: USB HID |
Controls USB based communication channels. | DM50, DM60, DM70, MX-1000, MX-1502 and DM8000 series readers. |
| COM.USB-RE-ENUMERATE-ON-START | Communication | PUBLIC | 5.5 | SET|GET | state |
[ON|OFF]
[ON|OFF] |
enable/disable
ON: USB 1.1 mode OFF: USB 2.0 mode |
Feature to re-enumerate the COM port after firmware is started. | DM8000 series readers. |
| COM.USB-REQUIRE-DTR | Communication | PUBLIC | 5.5.0 | SET|GET | state |
[ON|OFF] [ON|OFF] | enable/disable Enable/Disable | Turns the requirement to assert DTR signal during USB communication On or Off. | DM8050 |
| COM.USB-SPEED | Communication | PUBLIC | 4.2.1 | SET|GET | int |
[ON|OFF] |
ON: USB 1.1 mode OFF: USB 2.0 mode |
Forces the USB into full speed mode. | Every reader connected through USB except MX-1000. |
| COM.WAKEUP | Communication | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Wakeup Message. | ALL |
| COM.XLATEPRNT | Communication | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Translate unprintable characters that are embedded in a symbol. The translated result is output over the connection (for example, COM, USB, Ethernet, USB-KEYBOARD). Note that Data Formatting leading and terminating text are not translated. The characters translated are ASCII values between 0x00 and 0x1F. For example, 0x00 = <NUL>, 0x04 = <EOT>, 0x0a = <LF>, 0x0d = <CR>. | ALL |
| CONFIG-BACKUP.ENABLE | Action | PUBLIC | 5.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enables automatic device configuration backup. | Ethernet readers. DM8000 series wireless readers also support FTP if the base station is connected through Ethernet. |
| CONFIG-BACKUP.IP-ADDRESS | Action | PUBLIC | 5.0.0 | SET|GET | string |
IP address of the Cognex Explorer FTP service. Uses dotted decimal form, such as "192.168.23.42". |
Ethernet readers. DM8000 series wireless readers also support FTP if the base station is connected through Ethernet. | ||
| CONFIG-BACKUP.PASSWORD | Action | PUBLIC | 5.0.0 | SET|GET | string |
Password used to log in to Cognex Explorer FTP service. | Ethernet readers. DM8000 series wireless readers also support FTP if the base station is connected through Ethernet. | ||
| CONFIG-BACKUP.PORT | Action | PUBLIC | 5.0.0 | SET|GET | port |
[0-65535] | Port number of the Cognex Explorer FTP service. | Ethernet readers. DM8000 series wireless readers also support FTP if the base station is connected through Ethernet. | |
| CONFIG-BACKUP.SERVER-TYPE | Communication | PUBLIC | 5.5.0 | SET|GET | type |
[0-1] |
0: Generic 1: Mitsubishi GOT |
Configuration backup server type. | DM474, DM503 and DM300 series readers. |
| CONFIG-BACKUP.USER-NAME | Action | PUBLIC | 5.0.0 | SET|GET | string |
User name used to log in to the Cognex Explorer FTP service. | Ethernet readers. DM8000 series wireless readers also support FTP if the base station is connected through Ethernet. | ||
| CONFIG.DEFAULT | Action | PUBLIC | 3.0.0 | Resets the device’s configuration settings to factory defaults. Device identification and communications settings are not changed. | ALL | ||||
| CONFIG.EXPORT | Action | PUBLIC | 5.7.0 | Exports a human readable version of the current reader configuration. | ALL | ||||
| CONFIG.LOAD | Action | PUBLIC | 4.4.0 | num-bytes |
Load Configuration from communication channel. Make sure you use a robust communications channel (for example, Ethernet) because this command does not have error checking or retry support and might cause the device to hang. | ALL | |||
| CONFIG.RESTORE | Action | PUBLIC | 3.0.0 | Restores Configuration from Non-Volatile Memory. | ALL | ||||
| CONFIG.SAVE | Action | PUBLIC | 3.0.0 | Saves Configuration to Non-Volatile Memory. | ALL | ||||
| CONFIG.SEND | Action | PUBLIC | 3.0.0 | Send device configuration to communication channel. | ALL | ||||
| CQ | Code Quality | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable Code Quality. Code Quality Measurements require reader calibration and the Verification Feature Key. |
DM8600V |
| CQ.CALIB-DATE | Code Quality | PUBLIC | 3.0.0 | GET | Device Code Quality Calibration Date. | DM8600V | |||
| CQ.ILLUMINATION | Code Quality | PUBLIC | 3.0.0 | SET|GET | illumination-option state |
[0-4] [ON|OFF] |
0: Direct on axis 1: 30-deg All Quadrants 2: 30-deg E-W Quadrants 3: 30-deg N-S Quadrants 4: Custom enable/disable |
Code Quality Illumination Option. | DM8600V |
| CQ.METRICS | Code Quality | PUBLIC | 3.0.0 | SET|GET | metric |
[0-3] |
0: AIM-DPM/ISO/IEC TR 29158 1: ISO/IEC 15415 2: AS9132 Laser-etch 3: AS9132 Dot-peen |
Code Quality Enabled Metrics. | DM8600V |
| CQ.MINPASS | Code Quality | PUBLIC | 3.0.0 | SET|GET | metric min-pass |
[0-1] [0-4] |
0: AIM-DPM/ISO/IEC TR 29158 1: ISO/IEC 15415 0: F 1: D 2: C 3: B 4: A |
Code Quality Minimum Passing Grade. Determines the threshold for "validation failure action" including beep and configured line output. |
DM8600V |
| CQ.PROCESSM | Code Quality | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Code Quality Process Control Metrics. | DM8600V |
| CQ.RESET-CALIBRATION | Code Quality | PUBLIC | 3.3.0 | Invalidates code quality calibration data. Reboot is required. |
DM8600V | ||||
| CQ.UNITS | Code Quality | PUBLIC | 3.0.0 | SET|GET | option |
[0-3] |
0: mils 1: mm 2: inches 3: pixels |
Code Quality Units. | DM8600V |
| CUSTOM-CMD.COMMAND-FOOTER | Communication | PUBLIC | 3.2.0 | SET|GET | string |
End of the string to be echoed. See the Overview topic for formatting requirements for the string argument. |
Fixed mount readers. | ||
| CUSTOM-CMD.COMMAND-HEADER | Communication | PUBLIC | 3.2.0 | SET|GET | string |
Start of the string to be echoed. | Fixed mount readers. | ||
| CUSTOM-CMD.ECHO | Communication | PUBLIC | 3.2.0 | SET|GET | state |
[ON|OFF] | enable/disable | Indicates if characters received between a COMMAND-HEADER and COMMAND-FOOTER are echoed. | Fixed mount readers. |
| CUSTOM-CMD.TRIGGER | Communication | PUBLIC | 3.2.0 | SET|GET | state |
[ON|OFF] | enable/disable | Indicates if reader will respond to the TRIGGER-ON or TRIGGER-OFF string. | Fixed mount readers. |
| CUSTOM-CMD.TRIGGER-OFF | Communication | PUBLIC | 3.2.0 | SET|GET | string |
String that will stop a trigger. See the Overview topic for formatting requirements for the string argument. |
Fixed mount readers. | ||
| CUSTOM-CMD.TRIGGER-ON | Communication | PUBLIC | 3.2.0 | SET|GET | string |
String that will start a trigger. See the Overview topic for formatting requirements for the string argument. |
Fixed mount readers. | ||
| DATA.RESULT-ENCODING | Communication | PUBLIC | 3.1.0 | SET|GET | encoding |
[0|1] |
0: ASCII (default) 1: Base64 |
Result string encoding. | ALL |
| DATA.RESULT-TYPE | System | PUBLIC | 5.5.0 | SET|GET | bit-field |
[0,1,512] |
0 = None 1 = Result 512 = MS test response |
Controls automatic, result transmitted from reader. Default bits are 1 and 512 (which is 513). | ALL |
| DATABAR.EXPANDED | Symbology | PUBLIC | 3.4.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable Databar expanded. | ALL |
| DATABAR.GROUP | Symbology | PUBLIC | 3.4.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable Databar group. | ALL |
| DATABAR.LIMITED | Symbology | PUBLIC | 3.4.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable Databar limited. | ALL |
| DATAMATRIX.ALGORITHM-VERSION | Symbology | PUBLIC | 3.5.3 | SET|GET | version |
[0-2] |
0: speed preferred 1: yield preferred 2: extended |
IDQuick Usage Type. | Fixed mount readers except for DM300L, DM503L, and DM503QL. 2 (extended) is supported by DM50, DM60, DM70, DM150, DM260. |
| DATAMATRIX.DAMAGE | Decoder | PUBLIC | 5.5.0 | SET|GET | damage level |
[2,4] |
2: moderate 4: extreme |
Set Extreme to enable PowerGrid. | DM300 series readers, DM360, DM474 readers |
| DATAMATRIX.EXTREME-PRINT-GROWTH | Symbology | PUBLIC | 3.4.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable extreme print growth for DataMatrix symbols. | ALL except for DM50, DM60, DM70, DM300, DM503, DM8050 and DM8600. |
| DATAMATRIX.PRINT-DEFORMATION | Symbology | PUBLIC | 5.2.0 | SET|GET | state |
[0|1] |
0: Minimal 1: Moderate |
Sets the IDMax Properties. | DM300, DM474, DM503. |
| DATAMATRIX.QUALITY-METRICS | Decoder | PUBLIC | 4.5.0 | SET|GET | type |
[0-3] |
0: none 1: AIM DPM 2: ISO 15415 3: SEMI T10 |
Code quality metrics for DataMatrix. | ALL |
| DATAMATRIX.SYMBOL-DIFFICULTY | Symbology | PUBLIC | 5.1.0 | SET|GET | int |
[0-2] |
0: Easy 1: Medium 2: Hard |
Level of DataMatrix code symbol difficulty. | DM8600. |
| DATAMATRIX.TRAINED-FLEX-GRID | Symbology | PUBLIC | 5.2.0 | SET|GET | state |
[ON|OFF] | enable/disable | Switches the Trained Code Property "Flexible Grid Size". | DM300, DM474, DM503. |
| DATAMATRIX.TRAINED-IGNORE-POLARITY | Symbology | PUBLIC | 5.2.0 | SET|GET | state |
[ON|OFF] | enable/disable | Switches the Trained Code Property "Ignore Polarity". | DM300, DM474, DM503. |
| DATAMATRIX.TRAINED-MODEL | Decoder | PUBLIC | 5.5.0 | SET|GET | rows columns module-size polarity mirrored |
[8-144] [8-144] [1-1000] [0-2] [ON|OFF] |
Number of rows Number of columns Module size * 10 0: dark-on-light 1: light-on-dark 2: either ON: mirrored OFF: not mirrored |
Train Data Matrix from the given parameters without needing to capture an image. | Fixed-mount readers |
| DATAMATRIX.USAGE | Symbology | PUBLIC | 3.0.0 | SET|GET | Usage Type |
[0-1] |
0: Default 1: High speed ink jet mode |
IDMax Usage Type. | ALL except for DM50, DM60, DM70, DM300, DM503. |
| DECODER.1D-DATA-STITCH | Decoder | PUBLIC | 5.5.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enables/disables 1D data-stitching. Requires the 1DDataStitching feature key. |
DM70, DM150, DM260, DM300 series readers, DM474, DM503. |
| DECODER.1D-EXTENDED-RESOLUTION | Decoder | PUBLIC | 5.5.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enables/disables the 1D extended resolution decoding method. Requires the 1DExtendedRes feature key. |
DM70, DM150, DM260, DM300 series readers, DM474, DM503. |
| DECODER.1D-LEARN-ORIENT | Decoder | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Learn Orientation of 1D Symbols. | Fixed mount readers. |
| DECODER.1D-MINIMUM-DECODES | Symbology | PUBLIC | 5.2.0 | SET|GET | int |
[0-5] | Minimum number of decoded scans to report a confident decoding (to prevent misread). | ALL | |
| DECODER.1D-QUALITY-METRICS | Decoder | PUBLIC | 5.2.0 | SET|GET | mode |
[0-1] |
0: none 1: 1D readability |
Enables/disables 1D Process Control Metrics. | ALL |
| DECODER.1D-SHORT-QUIET-ZONE | Decoder | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | When ON, the reader is tolerant with non-standard (i.e. short) quiet zones. | ALL |
| DECODER.1D-SYMBOL-ORIENTATION | Decoder | PUBLIC | 4.1 | SET|GET | orientation |
[0-3] |
0: Omnidirectional 1: Ladder and Picket Fence (default) 2: Ladder 3: Picket Fence |
Sets or gets the orientation at which codes can be found. Omnidirectional requires the Omnidirectional feature key. | DM50, DM60, DM70, DM474, DM503, MX-1000, MX-1502 and DM300 series readers. DM503L readers support only 2: Ladder and 3: Picket Fence. |
| DECODER.1D-USAGE | Decoder | PUBLIC | 3.0.0 | SET|GET | usage |
[0-1] |
0: Standard 1: Extended |
1D Symbology Usage Type. | Fixed mount readers. |
| DECODER.ALLOW-ALL-MST-RESULTS | Decoder | PUBLIC | 5.7.3 | SET|GET | state |
[ON|OFF] |
ON: enable OFF: disable |
Enables or disables re-read delay processing for slave results. | DM300 series readers, DM474, DM503, DM70, DM150, DM260 |
| DECODER.CENTERING-WINDOW | Decoder | PUBLIC | 6.0.0 | SET|GET | center x perc, center y perc, size x perc, size y perc |
[0-100] | Percentage | Location and size of centering window as a percentage of the sensor size. | DM50, DM60, DM70, DM150 DM260, DM300, DM360, DM474, MX-1000 series |
| DECODER.DISPLAY-TARGET | Decoder | PUBLIC | 6.0.0 | SET|GET | state |
[ON|OFF] | Enable/Disable | Displays centering window graphics. | DM50, DM60, DM70, DM150 DM260, DM300, DM360, DM474, MX-1000 series |
| DECODER.EFFORT | Decoder | PUBLIC | 5.7.1 | SET|GET | int |
[0-5] | Sets the effort level used by the decoding algorithms. Default is 2. | All | |
| DECODER.MAC-SCAN-TIMEOUT | Decoder | PUBLIC | 5.7.1 | SET|GET | int |
[0-60] | DM50, DM60, DM70, DM150 DM260, DM300, DM360, DM474, MX-1000, MX1502 | ||
| DECODER.REREAD-MODE | Decoder | PUBLIC | 4.4.0 | SET|GET | mode |
[0-1] |
0: last read 1: first read |
Code re-reading delay relative to either the first read or the last. | DM50, DM60, DM70, DM474, DM503, DM300 series readers, DM8050 and DM8600. |
| DECODER.REREAD-NEVER2X | Decoder | PUBLIC | 5.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Never read the same code twice. All trigger modes, e.g. Multicode Reading. |
ALL |
| DECODER.REREAD-NOT-LAST-N | Decoder | PUBLIC | 5.5 SR3 | SET|GET | int |
[0-100] |
0: no restriction 1-100 Define N |
Do not read code if this code was read within the last N reads. | All |
| DECODER.REREAD-TIME | Decoder | PUBLIC | 4.4.0 | SET|GET | ms |
[0-10000] | Milliseconds | Code re-reading delay in milliseconds. | ALL |
| DECODER.ROI | Decoder | PUBLIC | 3.0.0 | SET|GET | left (multiple of 8) right (multiple of 8) top (multiple of 4) bottom (multiple of 4) |
[0...] [left+64...] [0...] [top+64...] |
left of the ROI rectangle right of the ROI rectangle top of the ROI rectangle bottom of the ROI rectangle |
Decoder Region of Interest. Image Region examined by decoder for enabled symbols. Pixel coordinates are relative to the upper left corner of the displayed image. Left < Right and Top < Bottom. Values must not be outside the specified CAMERA.FOV settings. |
ALL |
| DECODER.TARGET-DECODING | Decoder | PUBLIC | 5.7.1 | SET|GET | state |
[ON|OFF] | enable/disable | Enable target decoding, where the reader attempts to symbols that lie only under the aiming dots. | MX-1000, MX-1502 series readers. |
| DECODER.TIMEOUT | Decoder | PUBLIC | 3.0.0 | SET|GET | ms |
[0-10000] | milliseconds | Decoder Timeout. Maximum allowed decode time. |
Fixed mount readers. |
| DECODER.USE-CENTERING | Decoder | PUBLIC | 6.0.0 | SET|GET | state |
[ON|OFF] | Enable/Disable | Only reads codes within the centering window. | DM50, DM60, DM70, DM150, DM260, DM300, DM360, DM474, MX-1000 series |
| DEVICE-LOG.CLEAR | Action | PUBLIC | 5.2.0 | This command clears the device log. | DM50, DM60, DM70, DM474, DM503, DM300 series readers, DM8050, DM8600, MX-1000 and MX-1502. | ||||
| DEVICE.BACKUP | Action | PUBLIC | 3.3.0 | Send encrypted backup file (.cdc) to the PC. | ALL | ||||
| DEVICE.DEFAULT | Action | PUBLIC | 3.0.0 | Resets all device settings to factory defaults. This command reboots the device. | ALL | ||||
| DEVICE.DESCRIPTION | System | PUBLIC | 5.7.0 | SET|GET | state |
[0-127] | description | Store device description for inventory management. | ALL |
| DEVICE.FEATURE-KEYS | System | PUBLIC | 3.0.0 | GET | Device Feature Keys. | ALL | |||
| DEVICE.FIRMWARE-VER | System | PUBLIC | 3.0.0 | GET | Device Firmware Version. | ALL | |||
| DEVICE.LOG | Action | PUBLIC | 4.4.0 | GET | Get the device log of error and exception conditions such as missed triggers and trigger overruns. | DM50, DM60, DM70, DM474, DM503, DM300 series readers, DM8050 and DM8600. | |||
| DEVICE.MAC-ADDRESS | Communication | PUBLIC | 3.3.0 | GET | Reader's MAC address. | Ethernet readers. | |||
| DEVICE.NAME | System | PUBLIC | 3.0.0 | SET|GET | string |
Device Name. MX + the last six digits of DEVICE.SERIAL-NUMBER | ALL | ||
| DEVICE.RESTORE | Action | PUBLIC | 3.3.0 | file size |
Transmits backup file (.cdc) to the reader. File size is in bytes. File data follows footer. | ALL | |||
| DEVICE.SERIAL-NUMBER | System | PUBLIC | 3.0.0 | GET | Device Serial Number. | ALL | |||
| DEVICE.SSID | Communication | PUBLIC | 4.2.0 | SET|GET | string |
Network name. | Wireless readers. | ||
| DEVICE.TIMEZONE | Action | PUBLIC | 5.7.0 | SET|GET | timezone |
Location or POSIX timezone | Get or set the timezone for local time. | All | |
| DEVICE.TYPE | System | PUBLIC | 3.0.0 | GET | Device Type. | ALL | |||
| DMCC.RESET | Action | PUBLIC | 4.4.0 | When sent, the DMCC resets the following DMCC back to default: COM.DMCC-RESPONSE, COM.DMCC-CHECKSUM, COM.DMCC-HEADER, DATA.RESULT-TYPE, DATA.RESULT-ENCODING, DATA.RESULT-ALWAYSSEND, DATA.IMAGE-TYPE. | ALL | ||||
| DMCC.SAVE | Action | PUBLIC | 4.4.0 | Saves DMCC connection settings. It also saves the status for a new connection session for the following DMCC: COM.DMCC-RESPONSE, COM.DMCC-CHECKSUM, COM.DMCC-HEADER, DATA.RESULT-TYPE, DATA.RESULT-ENCODING, DATA.RESULT-ALWAYSSEND, DATA.IMAGE-TYPE. | ALL | ||||
| DOTCODE.MAXIMUM-COLUMNS | Decoder | PUBLIC | 5.4.0 | SET|GET | int |
[11-128] | The default is 128. | DM300 series readers, DM474, DM8050X and DM8600. | |
| DOTCODE.MAXIMUM-ROWS | Decoder | PUBLIC | 5.4.0 | SET|GET | int |
[5-128] | The default is 32. | DM300 series readers, DM474, DM8050X and DM8600. | |
| DOTCODE.MINIMUM-COLUMNS | Decoder | PUBLIC | 5.4.0 | SET|GET | int |
[11-128] | The default is 16. | DM300 series readers, DM474, DM8050X and DM8600. | |
| DOTCODE.MINIMUM-ROWS | Decoder | PUBLIC | 5.4.0 | SET|GET | int |
[5-128] |
The default is 6. |
DM300 series readers, DM474, DM8050X and DM8600. | |
| DOTCODE.POLARITY | Decoder | PUBLIC | 5.4.0 | SET|GET | int |
[0-2] |
0: Dark on Light 1: Light on Dark 2: Either |
DM300 series readers, DM474, DM8050X and DM8600. | |
| DVALID.DOD-EXEID | Data Validation | PUBLIC | 3.0.0 | SET|GET | string |
expected-EID | DoD Expected Enterprise ID (EID). | ALL | |
| DVALID.DOD-EXPN | Data Validation | PUBLIC | 3.0.0 | SET|GET | string |
expected-PN | DoD Expected Part Number. See the Overview topic for formatting requirements for the string argument. |
ALL | |
| DVALID.DODCNSTRT | Data Validation | PUBLIC | 3.0.0 | SET|GET | construct |
[0-3] |
0: Any 1: Construct #1 2: Construct #2 3: Equivalent |
Data Validation DoD Construct. | ALL |
| DVALID.FAIL-ACTION | Data Validation | PUBLIC | 3.0.0 | SET|GET | action |
[0-3] |
0: Transmit "Validation Failure" 1: Transmit "Validation Failure" + decoded string 2: Transmit annotated decode string 3: Transmit nothing |
Data Validation Failure Action. | ALL |
| DVALID.FAIL-XMT-CRLF | Data Validation | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Data Validation Transimit CRLF on Failure. | ALL |
| DVALID.GS1-FORMAT | Data Validation | PUBLIC | 3.4.0 | SET|GET | string |
GS1 format string | Set GS1 format string. | ALL | |
| DVALID.ISO-CONSTRUCT | Data Validation | PUBLIC | 3.0.0 | SET|GET | construct |
[0-1] |
0: ISO 15434 1: ISO 15434 & ISO 15418 |
ISO Construct. | ALL |
| DVALID.MATCH-STRING | Data Validation | PUBLIC | 3.0.0 | SET|GET | string |
match-string | Data Validation Match-String. See the Overview topic for formatting requirements for the string argument. |
ALL | |
| DVALID.MATCH-STRING-PARAMS | Data Validation | PUBLIC | 3.0.0 | SET|GET | increment start length step no-read validation-fail |
[ON|OFF]
[0-*] [1-*] [-2|-1|0|1|2] [ON|OFF] [ON|OFF] |
enable/disable
start position of numerical match number of digits increment enable/disable update on no-read enable/disable update on validation failure |
Data Validation Match-String Parameters. | ALL |
| DVALID.PATTERN | Data Validation | PUBLIC | 3.0.0 | SET|GET | string |
pattern-string | Data Validation Pattern. Regexp Data Validation. See the Overview topic for formatting requirements for the string argument. |
ALL | |
| DVALID.PROG-TARG | Data Validation | PUBLIC | 4.4.0 | SET|GET | category |
[1-5] |
1: DataMatrix 2: QR Code/MaxiCode/AztecCode 3: Linear/ Postal/ Stacked 4: VeriCode® 5: DotCode |
Data Validation Programming Target. Data Validation Symbology Set to be modified by subsequent commands. Once issued, this command changes the subsequent behavior of the reader. |
ALL |
| DVALID.TYPE | Data Validation | PUBLIC | 3.0.0 | SET|GET | type |
[0-5] |
0: None 1: DoD UID 2: ISO 3: Pattern 4: Match String 5: GS1 |
ALL | |
| EAN-UCC.CC-C | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable or disable Composite Code C. | ALL |
| EAN-UCC.XMTMODE | Symbology | PUBLIC | 3.0.0 | SET|GET | mode |
[0-1] |
0: Standard (linear & 2D) 1: Linear only |
EAN-UCC Transmit mode. | ALL |
| ENCODER.COUNT | IO | PUBLIC | 4.1.0 | SET|GET | value |
[0-2 billion] | value to set | Gets the encoder count or sets it to the specified value. | Fixed-mount readers |
| ENCODER.DISTANCE-TO-OUTPUT | IO | PUBLIC | 4.1.0 | SET|GET | int |
0-1000000 mm |
Default: 0 Min: 0 Max: 1000000 Step: 1 |
Sets the output distance from the trigger on the sensor. | DM300 series readers, DM474. |
| ENCODER.DOUBLE-RATE | IO | PUBLIC | 5.7.0 | SET|GET | boolean |
[ON|OFF] | Edge detection | If set to ON, Encoder will count both edges on the Encoder Input line. If set to OFF, Encoder will count only the selected edge. | DM503 |
| ENCODER.DOUBLE-RATE | IO | PUBLIC | 6.1.6 | SET|GET | boolean |
[ON|OFF] | Edge detection | If set to ON, Encoder will count both edges on the Encoder Input line. If set to OFF, Encoder will count only the selected edge. | DM360, DM370, and DM470 series readers. |
| ENCODER.FLUSH | IO | PUBLIC | 4.1.0 | Flushes all encoder actions. | DM474, DM503 and DM300 series readers. | ||||
| ENCODER.MODE | IO | PUBLIC | 5.5.0 | SET|GET | value |
[0-4] |
0: Encoder A signal counts up, Encoder B signal counts down. 1: Encoder A signal counts up, Encoder B signal counts down. 2: Encoder A and Encoder B form quadrature (SIN/COS) signal, 1 count per cycle. 3: Encoder A and Encoder B form quadrature (SIN/COS) signal, 2 counts per cycle. 4: Encoder A and Encoder B form quadrature (SIN/COS) signal, 4 counts per cycle. |
Encoder mode. Sets the mode the encoder signals are interpreted if the Encoder Direction pin is defined. | Fixed-mount readers |
| ENCODER.RESET | IO | PUBLIC | 5.5.0 | Resets the encoder count to 0 and clears all encoder related events. | Fixed-mount readers | ||||
| ENCODER.RESOLUTION | IO | PUBLIC | 4.1.0 | SET|GET | int |
0-1000000 um |
Default: 5000 Min: 0 Max: 1000000 Step: 1 |
Sets the distance per pulse of the encoder. | DM474, DM503, and DM300 series readers. |
| ERROR-LED.ON-TIME-MS | System | PUBLIC | 5.7.0 | SET|GET | duration |
Sets the duration for the Error LED in ms. Use 0 for unlimited duration. | All devices with an error LED. | ||
| ETHERNET-IP.ENABLED | Communication | PUBLIC | 3.3.0_cr1 | SET|GET | state |
[ON|OFF] | enable/disable | Enabled or disabled EtherNet/IP communications. | Ethernet readers. The DM8000 series wireless readers also support this protocol if the base station is connected through Ethernet. In the case of a Bluetooth connection, the command has to be sent to the base station, not to the reader. |
| FILTER.IMAGE-TO-USE-SYMBOL | Decoder | PUBLIC | 4.3.0 | SET|GET | symbology input |
[1-5] [0-1] |
1: DataMatrix 2: QR Code/MaxiCode/AztecCode 3: Linear/ Postal/ Stacked 4: VeriCode® 5: DotCode 0: original image 1: filtered image |
Sets or gets which type of symbology should be filtered or not. AztecCode is only supported on the DM503 and DM300 series readers. |
DM50, DM60, DM70, DM150, DM260, DM300 series readers, DM474. |
| FILTER.NOREAD-IMAGE | Decoder | PUBLIC | 4.3.0 | SET|GET | symbology |
[0-5] |
0: Any 1: DataMatrix 2: QR Code/MaxiCode/AztecCode 3: Linear/ Postal/ Stacked 4: VeriCode® 5: DotCode |
Sets or gets if the symbology selected should be filtered if the image is no-read. AztecCode is only supported on the DM503 and DM300 series readers. |
DM50, DM60, DM70, DM150, DM260, DM300 series readers, DM474. |
| FILTER.STACK | Decoder | PUBLIC | 4.3.0 | SET|GET | step method value1 value2 value3 |
[1-4] [0-11] [0-255] |
Filter step 0: no filtering 1: equalize 2: stretch 3: low pass 4: dilate 5: erode 6: open 7: close 8: auto stretch 9: optical density 10: invert 11: median method parameter |
The first value sets the order of the filter steps. Filter step 1 is the first step, filter step 2 is the second, and so on. The second value sets the filter to be used. The third value means the additional properties that you can set for the given filter. You cannot configure the whole stack with one statement, but each on its own.The following example: SET FILTER.STACK 2 2 0 100 0 sets the second step in the filter, for stretch from 0 to 100, leaving the third value unused (0).The following example: GET FILTER.STACK 3 (for the third filter) returns 5 4 3 meaning that filter number 5, that is, erode is on, with parameters 4, 3. | DM50, DM60, DM70, DM150, DM260, DM300 series readers, DM474. |
| FOCUS.DISTANCE | Camera | PUBLIC | 4.0.0 | SET|GET | int |
Distance in mm from the front of the camera to the part. This command returns the value only if Focus Steps is set to 0, otherwise you need to use FOCUS.SWEEP-RANGE instead. |
DM300 series readers, DM474. | ||
| FOCUS.EXTENDED-RANGE | Camera | PUBLIC | 5.7.0 | GET | value |
[ON|OFF] | Extended Focus Range | Indicates that the reader operates in the extended focus range of ON. In this mode GET FOCUS.DISTANCE will return with an error. | Fixed-mount readers with Liquid Lens |
| FOCUS.FEEDBACK | Camera | PUBLIC | 4.3.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enables focus feedback. | DM474, DM503 and DM300 series readers. |
| FOCUS.POWER | Camera | PUBLIC | 5.7.0 | SET|GET | optical power |
[-6.0 .. 20.00] | Optical Power in Diopters | Conrols the optical power of the liquid lens. The actual range is dependent on the hardware and on manufacturing tolerances. | Fixed-mount readers with Liquid Lens |
| FOCUS.PRECISION | Camera | PUBLIC | 5.7.0 | SET|GET | settle mode |
[0..1] |
0: normal focus control 1: precise focus control |
Controls the liquid lens focus control between normal focus control and slow but more precise mode. | Fixed mount readers with a liquid lens. |
| FOCUS.PROGRESS | Camera | PUBLIC | 5.7.0 | SET|GET | enable |
[ON|OFF] |
ON: focus progress on OFF: focus progress off |
Enable transfer of intermittent focus images during adjust focus. | Fixed mount readers with a liquid lens. |
| FOCUS.SWEEP-POWER | Camera | PUBLIC | 5.7.3 | SET|GET | Optical Power for near distance Optical Power for far distance |
liquid lens specific liquid lens specific |
Optical Power in Diopters Optical Power in Diopters |
Returns near (first value) and far (second value) optical power values. | Readers with Liquid Lens. |
| FOCUS.SWEEP-RANGE | Camera | PUBLIC | 3.6.0 | SET|GET | DM8000 DM300 |
[0-500] [0-500] [40-500] [40-500] |
low sweep range high sweep range low sweep range high sweep range |
Defines the sweep range to be used for focusing. Low must be less than high. The low value is ignored if FOCUS.SWEEP-STEPS is set to 0. | DM70, DM260, DM300 series, DM474 and DM8000 series readers. |
| FOCUS.SWEEP-STEPS | Camera | PUBLIC | 3.6.0 | SET|GET | value |
[0-8] | number of steps to divide the sweep range | Sets the number of steps the sweep range should be divided by. If steps is set to 0 only the high sweep range value is used. | DM70, DM260, DM474, DM8000 series and DM300 series readers. |
| FORMAT.ADVANCED | Data Formatting | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable Data Formatting Advanced Mode. Advanced Mode Formatting Enables: Regexp Pattern Substitution. |
ALL |
| FORMAT.CRLF-END | Data Formatting | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Data Formatting CRLF Terminator. Requires Data Formatting Standard Mode Enabled. |
ALL |
| FORMAT.DELIMITER | Data Formatting | PUBLIC | 3.0.0 | SET|GET | delimiter-option |
[0-5] |
0: none 1: space 2: comma 3: tab 4: label 5: xml |
Data Formatting Delimiter. Sets the delimeter between Data Formatting Tokens. Requires Data Formatting Standard Mode Enabled. |
ALL |
| FORMAT.DISCARD-UNMATCHED | Data Formatting | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Data Formatting Discard Unmatched Data. | ALL |
| FORMAT.MODE | Data Formatting | PUBLIC | 4.5.0 | SET|GET | mode |
[0-1] |
0: basic formatting 1: script-based formatting |
Specifies data formatting mode. By default, basic formatting is the set formatting mode. |
DM50, DM60, DM70, DM474, DM503, MX-1000, MX-1502 and DM300 series readers. |
| FORMAT.MULTICODE-DELIMITER | Data Formatting | PUBLIC | 3.2.0 | SET|GET | type |
[0-6] |
0: none 1: space 2: comma 3: tab 4: label 5: xml 6: CRLF |
Data Formatting Delimiter. Sets the delimiter between codes in a multicode result. |
Fixed mount readers. |
| FORMAT.PROG-TARG | Data Formatting | PUBLIC | 3.2.0 | SET|GET | category |
[0-5] |
0: Universal 1: DataMatrix 2: QR Code/MaxiCode/AztecCode 3: Linear/ Postal/ Stacked 4: VeriCode® 5: DotCode |
Data Formatting Programming Target. Data Formatting Symbology Set to be modified by subsequent commands. Once issued, it changes the subsequent behavior of the reader. AztecCode is only supported on the DM503 and DM300 series readers. |
ALL |
| FORMAT.REGEXP | Data Formatting | PUBLIC | 3.0.0 | SET|GET | string |
regular expression string | Data Formatting Regular Expression. Requires Data Formatting Advanced Mode Enabled. See the Overview topic for formatting requirements for the string argument. |
ALL | |
| FORMAT.SCRIPT | Data Formatting | PUBLIC | 5.2.0 | SET|GET | num-bytes |
Set: loads the script from the host to the reader. Get: sends the script from the reader to the host. | DM474, DM503, MX-1000, MX-1502 and DM300 series readers. | ||
| FORMAT.STANDARD | Data Formatting | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable Data Formatting Standard Mode. Standard Mode Formatting Enables: Leading Text, Data, Data Delimeter, Terminating Text, Terminating CRLF. |
ALL |
| FORMAT.TEXT-BEGIN | Data Formatting | PUBLIC | 3.0.0 | SET|GET | string |
leading output text | Data Formatting Leading Text. Requires Data Formatting Standard Mode Enabled. See the Overview topic for formatting requirements for the string argument. |
ALL | |
| FORMAT.TEXT-END | Data Formatting | PUBLIC | 3.0.0 | SET|GET | string |
trailing text | Data Formatting Trailing Text. Requires Data Formatting Standard Mode Enabled. See the Overview topic for formatting requirements for the string argument. |
ALL | |
| FORMAT.TOKEN | Data Formatting | PUBLIC | 3.0.0 | SET|GET | string |
token string | Data Formatting Standard Data. Regardless of the parameters given to GET FORMAT.TOKEN, it will return the current data formatting token string contained in the Standard Formatting window pointed to by the current value of GET FORMAT.PROG-TARG. See Data Formatting Token Table for available elements. See the Overview topic for formatting requirements for the string argument. |
ALL | |
| FTP-IMAGE.CUSTOM-FILE-NAME | Communication | PUBLIC | 3.3.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable/disable FTP server generated file name. | Ethernet readers. DM8000 series wireless readers also support FTP if the base station is connected through Ethernet. |
| FTP-IMAGE.FILE-NAME | Communication | PUBLIC | 3.3.0 | SET|GET | string |
File name of FTP image. | Ethernet readers. DM8000 series wireless readers also support FTP if the base station is connected through Ethernet. | ||
| FTP-IMAGE.FILE-NAME-USE-SCRIPT | Communication | PUBLIC | 5.2.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enables FTP file name generation script. | DM474, DM503 and DM300 series readers. |
| FTP-IMAGE.IDLE-LIMIT | Communication | PUBLIC | 5.5.0 | SET|GET | state |
[ON|OFF] | enable/disable | Limit duration of idle connections. | DM474, DM503 and DM300 series readers. |
| FTP-IMAGE.IDLE-TIME | Communication | PUBLIC | 5.5.0 | SET|GET | seconds |
Maximum duration of telling the FTP server that the reader is alive. | DM474, DM503 and DM300 series readers. | ||
| FTP-IMAGE.IP-ADDRESS | Communication | PUBLIC | 3.3.0 | SET|GET | string |
IP address of target FTP server. Uses dotted decimal form, such as "192.168.23.42". |
Ethernet readers. DM8000 series wireless readers also support FTP if the base station is connected through Ethernet. | ||
| FTP-IMAGE.MAX-APPEND | Communication | PUBLIC | 3.3.0 | SET|GET | value |
[0-65535] | Max increment value to append to image name. | Ethernet readers. DM8000 series wireless readers also support FTP if the base station is connected through Ethernet. | |
| FTP-IMAGE.MAX-APPEND-START-VALUE | Communication | PUBLIC | 4.0.0 | SET|GET | value |
[0-65535] | Initial increment value to append to image name. | DM503 | |
| FTP-IMAGE.PASSWORD | Communication | PUBLIC | 3.3.0 | SET | string |
Password used to login to target FTP server. | Ethernet readers. DM8000 series wireless readers also support FTP if the base station is connected through Ethernet. | ||
| FTP-IMAGE.PORT | Communication | PUBLIC | 4.0.0 | SET|GET | port |
[0-65535] | FTP server port number. | Ethernet readers. DM8000 series wireless readers also support FTP if the base station is connected through Ethernet. | |
| FTP-IMAGE.SERVER-PATH | Communication | PUBLIC | 3.3.0 | SET|GET | string |
Path for FTP image. | Ethernet readers. DM8000 series wireless readers also support FTP if the base station is connected through Ethernet. | ||
| FTP-IMAGE.SERVER-PATH-SCRIPT | Communication | PUBLIC | 5.2.0 | SET|GET | num-bytes |
Set: loads the script from the host to the reader. Get: sends the script from the reader to the host. | DM474, DM503 and DM300 series readers. | ||
| FTP-IMAGE.SERVER-PATH-SCRIPT-ERROR | Communication | PUBLIC | 5.5.0 | GET | message |
script error message | Gets the script error message for FTP Storage name generation . | Fixed-mount readers. | |
| FTP-IMAGE.SERVER-TYPE | Communication | PUBLIC | 5.6.3 | SET|GET | type |
[0-2] |
0: Generic 1: Mitsubishi GOT 2: SFTP |
FTP image server type. 2 means that the server is an S(SH)FTP server. | DM474, DM503 and DM300 series readers. |
| FTP-IMAGE.USER-NAME | Communication | PUBLIC | 3.3.0 | SET|GET | string |
Username used to login to target FTP server. | Ethernet readers. DM8000 series wireless readers also support FTP if the base station is connected through Ethernet. | ||
| FTP-PCM-REPORT.CUSTOM-FILE-NAME | Communication | PUBLIC | 5.7.0 | SET|GET | state |
ON/OFF |
enable disable |
Enable/disable customize file name generation (if disabled the FTP server has to generate a unique name). | Ethernet readers |
| FTP-PCM-REPORT.ENABLE | Communication | PUBLIC | 5.7.0 | SET|GET | enable |
ON/OFF | Enable or disable a PCM Report FTP connection. | Ethernet readers | |
| FTP-PCM-REPORT.FILE-NAME | Communication | PUBLIC | 5.7.0 | SET|GET | string |
File name of PCM Report. | Ethernet readers | ||
| FTP-PCM-REPORT.FILE-NAME-USE-SCRIPT | Communication | PUBLIC | 5.7.0 | SET|GET | state |
ON/OFF |
enable disable |
Enables PCM report file name generation by script. | Ethernet readers |
| FTP-PCM-REPORT.IDLE-LIMIT | Communication | PUBLIC | 5.7.0 | SET|GET | state |
ON/OFF |
enable disable |
Limit duration of idle connections after a data transfer. | Ethernet readers |
| FTP-PCM-REPORT.IDLE-TIME | Communication | PUBLIC | 5.7.0 | SET|GET | seconds |
[0-3600] | Maximum duration of idle connections after a data transfer. | Ethernet readers | |
| FTP-PCM-REPORT.IP-ADDRESS | Communication | PUBLIC | 5.7.0 | SET|GET | server |
IP address or DNS name | Set the PCM Report FTP server. | Ethernet readers | |
| FTP-PCM-REPORT.MAX-APPEND | Communication | PUBLIC | 5.7.0 | SET|GET | value |
[0-65535] | Max increment value to append to PCM report file name. | Ethernet readers | |
| FTP-PCM-REPORT.MAX-APPEND-START-VALUE | Communication | PUBLIC | 5.7.0 | SET|GET | value |
[0-65535] | Initial increment value to append to PCM report file name. | Ethernet readers | |
| FTP-PCM-REPORT.PASSWORD | Communication | PUBLIC | 5.7.0 | SET|GET | string |
PASSWORD used to login to target PCM Report FTP server. | Ethernet readers | ||
| FTP-PCM-REPORT.PORT | Communication | PUBLIC | 5.7.0 | SET|GET | port |
[0-65535] | PCM Report FTP server port number. | Ethernet readers | |
| FTP-PCM-REPORT.SCRIPT-ERROR | Communication | PUBLIC | 5.7.0 | GET | message |
script error message | Gets the script error message for FTP PCM report file name generation. | Ethernet readers | |
| FTP-PCM-REPORT.SERVER-PATH | Communication | PUBLIC | 5.7.0 | SET|GET | string |
Path for PCM Reports which has to be named by the FTP Server. | Ethernet readers | ||
| FTP-PCM-REPORT.SERVER-TYPE | Communication | PUBLIC | 5.7.0 | SET|GET | type |
[0-2] |
0: Generic 1: Mitsubishi GOT 2: SFTP(encrypted) |
FTP server type. | Ethernet readers |
| FTP-PCM-REPORT.USER-NAME | Communication | PUBLIC | 5.7.0 | SET|GET | string |
Username used to login to target PCM Report FTP server. | Ethernet readers | ||
| FTP-RESULT.APPEND | Communication | PUBLIC | 3.3.0 | SET|GET | type |
[ON|OFF] |
ON: Append result to existing file. OFF: Overwrite file content with result. |
Append to or overwrite file when result is sent via FTP to the file specified by FTP-RESULT.FILE-NAME. The file will be created if it does not exist. | Ethernet readers. DM8000 series wireless readers also support FTP if the base station is connected through Ethernet. |
| FTP-RESULT.ENABLE | Communication | PUBLIC | 3.3.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable/disable FTP transfer of reader results. | Ethernet readers. DM8000 series wireless readers also support FTP if the base station is connected through Ethernet. |
| FTP-RESULT.FILE-NAME | Communication | PUBLIC | 3.3.0 | SET|GET | string |
File name of FTP result. | Ethernet readers. DM8000 series wireless readers also support FTP if the base station is connected through Ethernet. | ||
| FTP-RESULT.IDLE-LIMIT | Communication | PUBLIC | 5.5.0 | SET|GET | state |
[ON|OFF] | enable/disable | Limit duration of idle connections after a data transfer. | DM474, DM503 and DM300 series readers. |
| FTP-RESULT.IDLE-TIME | Communication | PUBLIC | 5.5.0 | SET|GET | seconds |
[0-3600] | Maximum duration of idle connections after a data transfer. | DM474, DM503 and DM300 series readers. | |
| FTP-RESULT.IP-ADDRESS | Communication | PUBLIC | 3.3.0 | SET|GET | string |
IP address of target FTP server. Uses dotted decimal form, such as "192.168.23.42". |
Ethernet readers and MX-1000. DM8000 series wireless readers also support FTP if the base station is connected through Ethernet. | ||
| FTP-RESULT.PASSWORD | Communication | PUBLIC | 3.3.0 | SET | string |
Password used to login to target FTP server. | Ethernet readers. DM8000 series wireless readers also support FTP if the base station is connected through Ethernet. | ||
| FTP-RESULT.PORT | Communication | PUBLIC | 4.0.0 | SET|GET | port |
[0-65535] | FTP server port number. | Ethernet readers. DM8000 series wireless readers also support FTP if the base station is connected through Ethernet. | |
| FTP-RESULT.SERVER-TYPE | Communication | PUBLIC | 5.6.3 | SET|GET | type |
[0-2] |
0: Generic 1: Mitsubishi GOT 2: SFTP |
FTP server type.2 means that the server is an S(SH)FTP server. | DM474, DM503 and DM300 series readers. |
| FTP-RESULT.USER-NAME | Communication | PUBLIC | 3.3.0 | SET|GET | string |
Username used to login to target FTP server. | Ethernet readers. DM8000 series wireless readers also support FTP if the base station is connected through Ethernet. | ||
| HEIGHT-SENSOR.CURRENT-MEASUREMENT | Camera | PUBLIC | 6.1.6 | GET | [0-4000] | Distance from the C-Mount Flange in mm | Returns the read out of the ToF range distance in mm. | DM370 series, DM470 series readers. | |
| HPIT.FRONT-COVER | Communication | PUBLIC | 6.1.6 | GET |
|
[0-4] |
0 = No cover 1 = Cross polarized NEWC Linear Polarized S 2 = Clear cover 3 = Undefined 4 = Diffused |
Detected front cover type. | DM370 series, DM470 series readers. |
| HPIT.INDICATOR-MODE | Action | PUBLIC | 6.1.6 | SET|GET | IND_ID IND_MODE |
[0-1] [0-1] |
0 = Left indicator 1 = Right indicator 0 = OFF 1 = ON |
Allows to control the LED indicators located in Torch according to the selected mode. This command is intended only for usability testing. | DM370 series, DM470 series readers. |
| I2O5.CHKCHAR | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | I2of5 Check Character. | ALL |
| I2O5.CODESIZE | Symbology | PUBLIC | 3.0.0 | SET|GET | any min max |
[ON|OFF] [4-max] [min-80] |
any length code minimum code length maximum code length |
I2of5 Code Size. For the Manatee Works SDK, all of the Code 25 variants use the same minimum length; thus it will accept either C25.CODESIZE or I205.CODESIZE. | ALL |
| I2O5.XMTCHK | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | I2of5 Transmit Check Character. | ALL |
| IMAGE.FORMAT | Camera | PUBLIC | 5.6.3 | SET|GET | format |
[0-2] |
0: Bitmap 1: JPEG 2: PNG |
Image File Format. | ALL |
| IMAGE.QUALITY | Camera | PUBLIC | 4.4.0 | SET|GET | quality |
[10, 15, 20... 85, 90] | JPEG Quality | Quality of the jpeg image. | ALL |
| IMAGE.SEND | Action | PUBLIC | 5.5.0 | Retrieve the last camera image acquired. Returns number of bytes of image data followed by \r\n followed by image data. Whatever is set for ||>IMAGE.SIZE, ||>IMAGE.FORMAT, and ||>IMAGE.QUALITY before requesting the image will be used for the corresponding size, format, and quality. | ALL | ||||
| IMAGE.SIZE | Camera | PUBLIC | 4.4.0 | SET|GET | size |
[0-3] |
0: Full 1: 1/4 2: 1/16 3: 1/64 |
Image Size. | ALL |
| IMAGEBUFFER.ALLOW-OVERWRITE | RecordPlayback | PUBLIC | 4.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Allow buffered images that have not been transfered to be overwritten if all available buffers are used and new images arrive. | DM50, DM60, DM70, DM474, DM503, DM300 series readers, DM8050 and DM8600. |
| IMAGEBUFFER.AUTO-PREFER-CENTER | RecordPlayback | PUBLIC | 5.7.3 | SET|GET | Controls whether to use the decoders best symbol or the symbol closer to the ROI center. | DM50, DM60, DM70, DM474, DM503, DM300 series readers, DM8050 and DM8600. | |||
| IMAGEBUFFER.DELETE | RecordPlayback | PUBLIC | 4.0.0 | Release stored images. | DM50, DM60, DM70, DM474, DM503, DM300 series readers, DM8050 and DM8600. | ||||
| IMAGEBUFFER.DELETE-AFTER-TRANSFER | RecordPlayback | PUBLIC | 4.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Release stored images automatically after image has been transfered. | DM50, DM60, DM70, DM474, DM503, DM300 series readers, DM8050 and DM8600. |
| IMAGEBUFFER.FORMAT | RecordPlayback | PUBLIC | 5.6.3 | SET|GET | format |
[0-2] |
0: Bitmap 1: JPEG 2: PNG |
DM50, DM60, DM70, DM474, DM503, MX-1000, DM8000 series and DM300 series readers. | |
| IMAGEBUFFER.GOOD-IMAGE-MODE | RecordPlayback | PUBLIC | 5.2.0 | SET|GET | mode |
[0-1] |
0: Unlimited 1: Rate limited |
Good Read Image stores all buffered good read images unless you set a limit rate. | DM503, DM300 series readers, DM8050 and DM8600. |
| IMAGEBUFFER.GOOD-IMAGE-RATE-BURST | RecordPlayback | PUBLIC | 5.2.0 | SET|GET | interval |
[1-1000] | Burst determines the peak rate of the number of good read images buffered. | DM474, DM503, DM300 series readers, DM8050 and DM8600. | |
| IMAGEBUFFER.GOOD-IMAGE-RATE-COUNT | RecordPlayback | PUBLIC | 5.2.0 | SET|GET | interval |
Number of good read images to be buffered at a time unit (for example, minutes or hours) specified with IMAGEBUFFER.GOOD-IMAGE-RATE-COUNT. | DM474, DM503, DM300 series readers, DM8050 and DM8600. | ||
| IMAGEBUFFER.GOOD-IMAGE-RATE-TIME | RecordPlayback | PUBLIC | 5.2.0 | SET|GET | type |
[0-3] |
0: seconds 1: minutes 2: hours 3: days |
Time unit of good read images to be buffered at a rate number specified with IMAGEBUFFER.GOOD-IMAGE-RATE-TIME. | DM474, DM503, DM300 series readers, DM8050 and DM8600. |
| IMAGEBUFFER.IMAGE-TYPE | RecordPlayback | PUBLIC | 5.5.0 | SET|GET | int |
[0-2] |
0: All 1: Same as result 2: Auto |
Sets "What images to Buffer for a Result". When "Auto" is selected, the reader does intelligent image buffering. Requires the IntImageBuffer feature key to select the "Auto" option. |
DM70, DM150, DM260, DM300 series readers, DM474, DM503. |
| IMAGEBUFFER.MAX-IMAGES-PER-RESULT | RecordPlayback | PUBLIC | 5.0.0 | SET|GET | size |
[0-*] | Sets or gets how many images (n) per result are stored. | DM50, DM60, DM70, DM474, DM503, DM300 series readers, DM8050 and DM8600. | |
| IMAGEBUFFER.MAX-NUM | RecordPlayback | PUBLIC | 4.0.0 | SET|GET | size |
[0-*] | Maximum number of images that can be buffered. * Range varies depending depending on Camera ROI and memory allocated for burst length. |
DM50, DM60, DM70, DM474, DM503, DM300 series readers, DM8050 and DM8600. | |
| IMAGEBUFFER.NO-READ-IMAGE-NUMBER | RecordPlayback | PUBLIC | 5.0.0 | SET|GET | limit |
[n] [Max Int] |
In Burst trigger mode, n is the number of images in a burst In other trigger modes, there is no limit |
Store exactly one image. | DM50, DM60, DM70, DM474, DM503, DM300 series readers, only in Single, Burst, Self and Continuous modes. |
| IMAGEBUFFER.NO-READ-IMAGE-PERIOD | RecordPlayback | PUBLIC | 4.0.0 | SET|GET | interval |
[1-200] | Sets or gets the interval to save the image of a bad read. If, for example, you use an interval of 6, the first bad image is saved and the next 5 are not. The default is 1 which saves each bad read image. | DM50, DM60, DM70, DM474, DM503, DM300 series readers, only in Single, Burst, Self and Continuous modes. | |
| IMAGEBUFFER.NO-READ-IMAGE-RATE-BURST | RecordPlayback | PUBLIC | 5.2.0 | SET|GET | interval |
[1-1000] | Burst determines the peak rate of the number of bad read images buffered. | DM474, DM503, DM300 series readers, only in Single, Burst, Self and Continuous modes. | |
| IMAGEBUFFER.NO-READ-IMAGE-RATE-COUNT | RecordPlayback | PUBLIC | 5.2.0 | SET|GET | interval |
Number of bad read images to be buffered at a time unit (for example, minutes or hours) specified with IMAGEBUFFER.NO-READ-IMAGE-RATE-COUNT. | DM503, DM300 series readers, only in Single, Burst, Self and Continuous modes. | ||
| IMAGEBUFFER.NO-READ-IMAGE-RATE-TIME | RecordPlayback | PUBLIC | 5.2.0 | SET|GET | type |
[0-3] |
0: seconds 1: minutes 2: hours 3: days |
Time unit of bad read images to be buffered at a rate number specified with IMAGEBUFFER.NO-READ-IMAGE-RATE-TIME. | DM474, DM503, DM300 series readers, only in Single, Burst, Self and Continuous modes. |
| IMAGEBUFFER.NUM | RecordPlayback | PUBLIC | 4.0.0 | GET | size |
Returns the number of currently buffered images. | DM50, DM60, DM70, DM474, DM503, DM300 series readers, DM8050 and DM8600. | ||
| IMAGEBUFFER.OVERLAY | RecordPlayback | PUBLIC | 5.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enables Overlay Graphics (SVG) for buffered images. | DM50, DM60, DM70, DM474, DM503, DM300 series readers, DM8050 and DM8600. |
| IMAGEBUFFER.QUALITY | RecordPlayback | PUBLIC | 4.0.0 | SET|GET | quality |
[10, 15, 20... 85, 90] | JPEG Quality | DM50, DM60, DM70, DM474, DM503, MX-1000, DM8000 series and DM300 series readers. | |
| IMAGEBUFFER.RECORD-TYPE | RecordPlayback | PUBLIC | 4.0.0 | SET|GET | type |
[0-5] |
0: None 1: No-Read 2: Read 3: All 4: Validation Failure 5: No-Read + Validation failure |
Sets or gets the type of image to buffer. In case of No-Read, the image is buffered if the reader fails to read. |
DM50, DM60, DM70, DM474, DM503, MX-1000, DM8000 series and DM300 series readers. |
| IMAGEBUFFER.SEND-FTP | RecordPlayback | PUBLIC | 4.0.0 | Transmit buffered images to designated FTP server. | DM60, DM474, DM503, DM8000 series and DM300 series readers. | ||||
| IMAGEBUFFER.SIZE | RecordPlayback | PUBLIC | 4.0.0 | SET|GET | size |
[0-3] |
0: Full 1: 1/4 2: 1/16 3: 1/64 |
DM50, DM60, DM70, DM474, DM503, MX-1000, DM8000 series and DM300 series readers. | |
| IMAGEBUFFER.TRANSFER-MODE | RecordPlayback | PUBLIC | 4.0.0 | SET|GET | interval |
[0-1] |
0: On Request 1: FTP - runtime |
Sets or gets whether buffered images should automatically sent FTP or if they should be send only after requested. | DM60, DM70, DM474, DM503, MX-1000, DM8000 series, and DM300 series readers and DM260. |
| INPUT-STRING.ENABLE | Data Formatting | PUBLIC | 5.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enables or disables the use of the Input String feature (available for serial, telnet, NetworkClient). When enabled, a header and the footer can be set by the INPUT-STRING.HEADER and INPUT-STRING.FOOTER commands, respectively. A string of characters can be given between the header and the footer, which will be sent with the formatted output (for example, [hello world], if the header is set to ’[’ and the footer to ’]’). Since the input string is saved temporarily, it appears only in the next result output. Use Setup Tool (the <Input String> option) or <ISTR> with DMCC (see SET FORMAT.TOKEN) to allow Input string in the result output. | ALL |
| INPUT-STRING.FOOTER | Data Formatting | PUBLIC | 5.0.0 | SET|GET | string |
token string | Sets the footer for the Input String character string. | ALL | |
| INPUT-STRING.HEADER | Data Formatting | PUBLIC | 5.0.0 | SET|GET | string |
token string | Sets the header for the Input String character string. | ALL | |
| INPUT-STRING.MODE | Data Formatting | PUBLIC | 5.5.0 | SET|GET | int |
[0-4] |
0: Store 1: Send 2: Send with header and footer 3: Send with formatting 4: Send with header and footer formatting |
Controls whether the input string data is sent out as a result or stored in an internal variable. | Fixed-mount readers. |
| INPUT-STRING.VALUE | Data Formatting | PUBLIC | 5.5.0 | SET|GET | string |
token string | Sets the content of the Input String character string. | Fixed-mount readers | |
| INPUT.ACTION | IO | PUBLIC | 4.0.0 | SET|GET | line action state |
[0-3] [0-11] [ON|OFF] |
Input line number 0: Train Code 1: Optimize Brightness 2: Set Match String 3: Optimize Focus 4: Read Configuration Code 5: Trigger Off 6: Encoder 7: Allow Buffered No-Read Images 8: Clear Outputs 9: Tune (DM300 only) 10: Encoder direction 11: Trigger on ON: execute action when line is triggered OFF: no action |
Sets or gets the state for the specified line action. The input actions "Train Code," "Optimize Brightness," "Set Match String," and "Read Configuration Code" are carried out only after the next trigger. |
Fixed-mount readers. |
| INPUT.ACTION1 | IO | PUBLIC | 3.0.0 | SET|GET | mode state |
[0-3] [ON|OFF] |
0: Train Code 1: Optimize Brighness 2: Set Match String 3: Optimize focus (Only for readers with a liquid lens.) enable/disable |
Input Line 1 Action. | Fixed mount readers. |
| INPUT.STATE | Action | PUBLIC | 5.5.0 | GET | line |
[0-3] | input line number | Gets the current state of the input line specified. Returns 1 for high, 0 for low. | Fixed-mount readers |
| INPUT1.SAVE-MATCH-STRING | Communication | PUBLIC | 4.5.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enables or disables saving the match string to flash when Set Match String is enabled as Input line 1 action. | DM50, DM60, DM70, DM474, DM503, and DM300 series readers. |
| IO-LINE.DIRECTION | IO | PUBLIC | 5.5.0 | SET|GET | line direction |
[2,3] [0,1] |
line=2: sets direction of I/O Line 2 line=3: sets direction of I/O Line 3 direction=0: defines line as output direction=1: defines line as input |
Sets the direction of the programmable I/O lines of DM360 and DM474 series readers. | DM360 series, DM474 readers |
| KEY.INTERCHAR-DELAY | Communication | PUBLIC | 5.5.0 | SET|GET | us |
[0-1000] | milliseconds | Sets or gets the delay time between characters when in HID keyboard mode. | DM300 series readers, DM60, DM50, DM70, DM474. |
| KEY.LANGUAGE | IO | PUBLIC | 3.0.0 | SET|GET | language |
[0-7] |
0: Alt Key Combo 1: DE 2: US 3: JP 4: FR 5: ES 6: NO 7: FI |
ALL except for DM60, DM474, DM503, and DM300 series readers. | |
| KEY.PAUSE-TIME | Action | PUBLIC | 5.4.0 | SET|GET | Pause time |
[0-1000] | 0 to 1000 millisecond pause | Sets the time to pause for a specified pause key sequence. | DM8050, DM8600 series |
| KEY.ZERO-PAD | IO | PUBLIC | 3.0.0 | SET|GET | language |
[ON|OFF] | enable/disable | ALL except for DM60, DM474, DM503, and DM300 series readers. | |
| LIGHT.AIMER | Camera | PUBLIC | 3.0.0 | SET|GET | aimer-mode |
[0-1] |
0: Off 1: On |
Aimer Enable. Default is ON. |
ALL except for DM503 and DM8050. |
| LIGHT.AIMER | Camera | PUBLIC | 5.4.0 | SET|GET | aimer-mode |
[0,1,3] |
0: Off 1: On 3: Activated by Acceleration Sensor |
Aimer Enable. Default is ON. |
DM8050 |
| LIGHT.AIMER | Camera | PUBLIC | 6.1.6 | SET|GET | aimer-mode |
[0-1] |
0: Off 1: On |
Enables or disables the aimer. | DM370 series, DM470 readers. |
| LIGHT.AIMER-TIMEOUT | Camera | PUBLIC | 4.2.1 | SET|GET | int |
[0-600] | seconds | Aimer Timeout in seconds. | MX-1000 and DM8000 series readers. |
| LIGHT.DARKFIELD-INTENSITY | Camera | PUBLIC | 5.4.3 | SET|GET | value |
[0-15] | Intensity | Darkfield Illumination Intensity. | DM8600 |
| LIGHT.DIFFUSE-INTENSITY | Camera | PUBLIC | 5.4.3 | SET|GET | level |
[0-15] | Intensity | Diffuse Brightfield Illumination Intensity. | DM8600 |
| LIGHT.DIRECT | Camera | PUBLIC | 4.4.0 | SET|GET | north east south west NORTH EAST SOUTH WEST |
[ON|OFF]
[ON|OFF] [ON|OFF] [ON|OFF] [ON|OFF] [ON|OFF] [ON|OFF] [ON|OFF] |
enable/disable
enable/disable enable/disable enable/disable enable/disable enable/disable enable/disable enable/disable |
Sets the quadrants on the DM300. Small letters refer to the inner, capital letters to the outer circle, possible values are ON and OFF for each segment. Example for a SET command: SET LIGHT.DIRECT ON OFF ON ON OFF OFF OFF OFF if you want to have the inner north, south, and west lights on. | DM300 series readers, DM474. |
| LIGHT.DIRECT | Camera | PUBLIC | 5.5.0 | SET|GET | north-east north-west south-east south-west |
[ON|OFF]
[ON|OFF] [ON|OFF] [ON|OFF] |
enable/disable
enable/disable enable/disable enable/disable |
Sets the quadrants on the DM70, DM150 and DM260. Possible values are ON and OFF for each segment. Example for a SET command: SET LIGHT.DIRECT ON OFF OFF ON if you want to have the top-left and bottom-right LED on. | DM70, DM150 and DM260 readers. |
| LIGHT.DIRECT | Camera | PUBLIC | 5.7.7 | SET|GET | state |
[ON|OFF] | enable/disable | Turns on/off light banks for the 8072V. Verification should only take place with lighting combinations that can be described as 30 single, 30T (opposite sides), 30Q (all 30 panels), 45Q (all 45 panels), or 90. Other lighting combinations are allowed by the firmware, but will not result in valid verification result. | DM8072 Verifier |
| LIGHT.DIRECT | Camera | PUBLIC | 6.1.6 | SET|GET | North Corners South East-West |
[ON|OFF]
[ON|OFF] [ON|OFF] [ON|OFF] |
enable/disable
enable/disable enable/disable enable/disable |
Enables or disables the HPIT quadrants. | DM370 series, DM470 series readers. |
| LIGHT.DIRECT-INTENSITY | Camera | PUBLIC | 5.1.0 | SET|GET | level |
[0-15] | Intensity | Direct Illumination Intensity. | DM50, DM60, DM474, DM503 and DM300 series readers. |
| LIGHT.DIRECT-INTENSITY | Camera | PUBLIC | 5.4.3 | SET|GET | level |
[1-15] | Intensity | Direct Illumination Intensity. | DM8050 |
| LIGHT.EXTERNAL-ENABLE | Camera | PUBLIC | 4.1.0 | SET|GET | enable |
[ON|OFF] | enable/disable | Enable external illumination supported by I/O. | Fixed mount readers. |
| LIGHT.EXTERNAL-INTENSITY | Camera | PUBLIC | 5.2.0 | SET|GET | level |
[0-15] | Intensity | Sets the intensity of the external illumination. | Fixed mount readers. |
| LIGHT.EXTERNAL-POLARITY | Camera | PUBLIC | 3.0.0 | SET|GET | polarity |
[0-1] |
0: Active Low 1: Active High |
External illlumination output polarity. | Fixed mount readers except for DM70, DM150, DM260. |
| LIGHT.HIGH-FREQUENCY | Camera | PUBLIC | 5.2.0 | SET|GET | enable |
[ON|OFF] | enable/disable | Enables High Frequency Lights to avoid flickering illumination. | DM50, DM60, DM70, DM474, DM503, and DM300 series readers. |
| LIGHT.HIGH-FREQUENCY-ALWAYS | Camera | PUBLIC | 5.2.0 | SET|GET | enable seconds |
[ON|OFF] 0-86400 |
enable/disable auto off duration |
Enables High Frequency Light in Continuous trigger mode even if no trigger is active. After duration seconds the High Frequency Light is turned off. If the duration is 0 the light is never turned off. | DM50, DM60, DM70, DM474, DM503, and DM300 series readers. |
| LIGHT.INTERNAL-ENABLE | Camera | PUBLIC | 4.1.0 | SET|GET | enable |
[ON|OFF] | enable/disable | Enable the built-in internal illumination. Default value is OFF. | DM50, DM60, DM70, DM8050, MX-1000, MX-1502, Mobile. |
| LIGHT.LOW-ANGLE | Camera | PUBLIC | 5.7.0 | SET|GET | state |
[ON|OFF] [ON|OFF] | enable/disable low-angle illumination | Controls the DM262 UHD low-angle illumination. | DM262 |
| LIGHT.ON-AXIS | Camera | PUBLIC | 5.7.0 | SET|GET | state |
[ON|OFF] [ON|OFF] | enable/disable on-axis illumination | Controls the DM262 UHD on-axis illumination. | DM262 |
| LIGHT.POLARIZED | Camera | PUBLIC | 5.6.0 | SET|GET | polarized LED count |
[0|2|4] | Number of polarized filtered LEDs in the illumination | Use this command after applying a different HPIL front cover to publish the illumination filter status to the device. | DM70, DM150, DM260 |
| LIGHTCURTAIN.BEAM-SPACING | IO | PUBLIC | 4.1.0 | SET|GET | spacing |
[1-300000] | micrometers | Distance (in um) between beams of the Light Curtain. This determines the resolution of the light curtain. | DM503 |
| LIGHTRING.DURATION | IO | PUBLIC | 5.7.0 | SET|GET | duration |
[0..10000] |
0: Default behavior 10..10000: duration of lightring event in ms, step 10 ms |
Controls the duration of the lightring illumination event. | DM36x, DM474 and DM503 |
| LIVEIMG.MODE | Camera | PUBLIC | 5.2.0 | SET|GET | mode |
[0,2] |
0: Disable 2: Enable |
Controls live image display. | ALL |
| LIVEIMG.SEND | Camera | PUBLIC | 5.6.3 | size format quality |
[0-3] [0-2] [10, 15, 20... 85, 90] |
0: Full 1: 1/4 2: 1/16 3: 1/64 0: Bitmap 1: JPEG 2: PNG JPEG Quality |
Request image transfer to PC when LIVEIMG.MODE is set to 3. | ||
| MASTER-SLAVE.GROUP-NAME | Communication | PUBLIC | 4.0.0 | SET|GET | name |
Gets or sets the name of the master slave group. | DM60, DM474, DM503, and DM300 series readers. | ||
| MASTER-SLAVE.MODE | Communication | PUBLIC | 4.0.0 | SET|GET | mode |
[0-2] |
0: OFF 1: ON 2: Master |
Switches the master-slave functioning of the reader on or off. | DM60, DM474, DM503, and DM300 series readers. |
| MASTER-SLAVE.RX-HEIGHT-SENSOR | Camera | PUBLIC | 4.1.0 | SET|GET | enable |
[ON|OFF]* | enable/disable | Enables or disables this system receiving height information from another system in the network group. | DM60, DM474 and DM300 series readers. |
| MASTER-SLAVE.TEST | Communication | PUBLIC | 5.5.0 | mode message |
[0-2] |
0: Slave to Master 1: Master to Slave 2: Master to Slave to Master |
Transmits the test message from reader to reader as designated by mode. The terminating reader will output the message preceded by the initiating device delimited by a space | Fixed-mount readers. | |
| MASTER-SLAVE.TEST-EFP-OUTPUT | Communication | PUBLIC | 5.7.3 | SET|GET | state |
[ON|OFF] |
ON: enable OFF: disable |
Enables or disables mst-test messages on the Industrial Protocol interfaces. | DM300 series readers, DM474. |
| MASTER-SLAVE.TIMEOUT | Communication | PUBLIC | 4.0.0 | SET|GET | milliseconds |
[0-10000] | Gets or sets the time to wait for results from slave cameras. | DM60, DM474, DM503, and DM300 series readers. | |
| MASTER-SLAVE.TIMEOUT-DISTANCE | Communication | PUBLIC | 5.7.3 | SET|GET | int |
[0-1000000] | Distance | The distance for a master slave timeout. | DM60, DM70, DM260, DM474, DM503, and DM300 series readers. |
| MASTER-SLAVE.TIMEOUT-MODE | Communication | PUBLIC | 5.7.3 | SET|GET | mode |
[0-1] |
0: Time 1: Distance |
Controls if the mater slave response timeout will be time or distance based. | DM60, DM260, DM474, DM503, and DM300 series readers. |
| MAXICODE.TRAINED-MODEL | Decoder | PUBLIC | 5.7.0 | SET|GET | module size |
[1-1000] | Module size * 10 | Set training parameters for MaxiCode symbology. | Fixed-mount readers |
| MODBUSTCP.ENABLED | Communication | PUBLIC | SET|GET | state |
[ON|OFF] | enable/disable | Enable or disable Modbus/TCP communication. | Ethernet readers. The DM8000 series wireless readers also support this protocol if the base station is connected through Ethernet. In the case of a Bluetooth connection, the command has to be sent to the base station, not to the reader. | |
| MODBUSTCP.HOLDING-ONLY | Communication | PUBLIC | SET|GET | state |
[ON|OFF] | enable/disable | Ethernet readers. DM8000 series wireless readers also support this protocol if the base station is connected through Ethernet. | ||
| MONITOR-MODE.AUTOEXPOSURE | Camera | PUBLIC | 5.7.1 | SET|GET | state |
[ON|OFF] | enable/disable | Enable/disable autoregulation while in monitor mode. | ALL |
| MONITOR-MODE.DECODE-ENABLE | Camera | PUBLIC | 5.7.1 | SET|GET | mode |
[ON|OFF] | enable/disable | ALL | |
| MONITOR-MODE.ENABLE | Camera | PUBLIC | 6.0.1 | SET|GET | state |
[ON|OFF] | enable/disable | Enable/disable monitor mode. | ALL |
| MOTION-DETECTION.ACTIVE | Action | PUBLIC | 5.7.0 | GET | state |
[ON|OFF] |
ON: Active or Lights Off OFF: Inactive or Lights On |
Allows checking the current state of motion detection for presentation or self-internal trigger mode. | DM50, DN60, DM70, DM150, DM260, DM300, DM360, DM474. |
| MOTION-DETECTION.ENABLE | Action | PUBLIC | 5.7.0 | SET|GET | state |
[ON|OFF] |
ON: enable OFF: disable |
Enables or disables motion detection for Presentation trigger mode. | DM50, DN60, DM70, DM150, DM260, DM300, DM474, DM503. |
| MOTION-DETECTION.SENSITIVITY | Action | PUBLIC | 5.7.0 | SET|GET |
|
[0|2] |
0: Low 1: Medium 2: High |
Sets or gets the motion detection sensitivity level when in presentation mode. | DM50, DM60, DM70, DM150, DM260, DM300, DM474, DM503. |
| MSI.CHKCHAR | Symbology | PUBLIC | 5.0.0_cr5 | SET|GET | state |
[ON|OFF] | enable/disable | Sets or gets whether check character is used. Default value is OFF. | DM300 series, DM474, DM503, MX-1000, MX-1502, Mobile. |
| MSI.CHKCHAR-OPTION | Symbology | PUBLIC | 5.0.0_cr5 | SET|GET | mode |
[0-5] |
0: Mod10 1: Mod11 2: Mod1010 3: Mod1110 4: 5: |
Sets or gets the method for calculating checksum. | DM474, DM503 and DM300 series, MX-1000, MX-1502, Mobile. |
| MSI.CODESIZE | Symbology | PUBLIC | 5.0.0_cr5 | SET|GET | mode min max |
[ON|OFF] [1-max] [min-80] |
any length code minimum code length maximum code length |
Sets or gets the expected code size. | DM474, DM503, DM300 series readers, MX-1000, MX-1502. |
| MSI.QZ-SIZE | Symbology | PUBLIC | 5.0.0_cr5 | SET|GET | size |
[0-100] | Sets or gets the single side strictness as a percentage | DM474, DM503 and DM300 series readers. | |
| MSI.XMTCHK | Symbology | PUBLIC | 5.0.0_cr5 | SET|GET | state |
[ON|OFF] | enable/disable | Sets or gets whether to transmit the check digit. | DM474, DM503 and DM300 series readers. |
| MULTICODE.HORIZONTAL-REVERSE | Symbology | PUBLIC | 3.4.0 | SET|GET | state |
[ON|OFF] |
ON: sort right to left OFF: sort left to right |
Horizontal positional sorting order priority. | Fixed mount readers. |
| MULTICODE.IDENTICAL-SYMBOLS | Symbology | PUBLIC | 3.4.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enables/disables output of identical symbols when multicode is enabled. | Fixed mount readers. |
| MULTICODE.IMAGE-REVERSE | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] |
ON: sort last image first OFF: sort first image first |
Image sorting order preference. | Fixed mount readers. |
| MULTICODE.MAX-NUM-CODES | Symbology | PUBLIC | 3.2.0 | SET|GET | symbology number |
[1-5] [1-255] |
1: DataMatrix 2: QR Code/MaxiCode/AztecCode 3: Linear/ Postal/ Stacked 4: VeriCode® 5: DotCode |
The expected maximum number of codes to find for each symbology grouping 1 - 4; no expected value for any single symbology can exceed parameter 0, the total number of codes to find. | Fixed mount readers. |
| MULTICODE.NUM-CODES | Symbology | PUBLIC | 3.2.0 | SET|GET | number |
[1-255] | Number of codes readers must find for a successful read result. | Fixed mount readers. | |
| MULTICODE.PARTIAL-RESULTS | Symbology | PUBLIC | 3.2.0 | SET|GET | state |
[ON|OFF] | enable/disable | Controls how the reader interprets the number of codes to find. ON = reader will return a successful read if 1 or more codes are found. OFF = reader will return a successful read only if number of codes found equals MULTICODE.NUM-CODES value. | Fixed mount readers. |
| MULTICODE.SORT-PRIORITY | Symbology | PUBLIC | 3.4.0 | SET|GET | symbology image vertical position horizontal position |
[0-3] [0-3] [0-3] [0-3] |
Range for all four arguments indicates sort priority. Must be different for each criteria. |
Sorting order for multicode results: 0 is highest priority, 3 is lowest priority. | Fixed mount readers. |
| MULTICODE.SYMBOLOGY-REVERSE | Symbology | PUBLIC | 3.4.0 | SET|GET | state |
[ON|OFF] |
ON: DotCode, VeriCode ®, Linear/Postal/Stacked, QR Code/MaxiCode/AztecCode, Data Matrix OFF: Data Matrix, QR Code/MaxiCode/AztecCode, Linear/Postal/Stacked, VeriCode ®, DotCode |
Symbology sorting order preference. | Fixed mount readers. |
| MULTICODE.VERTICAL-REVERSE | Symbology | PUBLIC | 3.4.0 | SET|GET | state |
[ON|OFF] |
ON: sort bottom to top OFF: sort top to bottom |
Vertical position sorting order preference. | Fixed mount readers. |
| NET-LOCAL.DHCP | Communication | PUBLIC | 3.3.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable/Disable DHCP on reader. | Ethernet readers. |
| NET-LOCAL.DNS-SERVER | Communication | PUBLIC | 3.3.0 | SET|GET | server |
Gets or sets the DNS Server address. | Ethernet readers. | ||
| NET-LOCAL.GATEWAY | Communication | PUBLIC | 3.3.0 | SET|GET | string |
Reader's default gateway IP address. Uses dotted decimal form, such as "192.168.23.1". |
Ethernet readers. | ||
| NET-LOCAL.IP-ADDRESS | Communication | PUBLIC | 3.3.0 | SET|GET | string |
Reader's IP address. Uses dotted decimal form, such as "192.168.23.42". |
Ethernet readers. | ||
| NET-LOCAL.PORT | Communication | PUBLIC | 3.4.0 | SET|GET | port |
[1-65535] | Setup Tool server TCP port on reader. | Ethernet readers. | |
| NET-LOCAL.READER-IP-ADDRESS | Communication | PUBLIC | 4.2.0 | SET|GET | string |
dotted decimal form IPv4 address | Base station's IP address. Uses dotted decimal form, such as "192.168.23.42". |
Base stations. | |
| NET-LOCAL.READER-SUBNET-MASK | Communication | PUBLIC | 5.2.0 | SET|GET | string |
dotted decimal form IPv4 address | Base station's subnet mask. Uses dotted decimal form, such as "192.168.23.255". |
Base stationss. | |
| NET-LOCAL.SUBNET-MASK | Communication | PUBLIC | 3.3.0 | SET|GET | string |
Reader's subnet mask. Uses dotted decimal form, such as "192.168.23.255". |
Ethernet readers. | ||
| NETWORK-CLIENT.CLIENT-PORT | Communication | PUBLIC | 5.2.0 | SET|GET | int |
[0-65535] | The port on the reader to use as the outbound port (default is 0). | Ethernet readers except for the DM8000 wireless. | |
| NETWORK-CLIENT.CLOSE-CONNECTION | Communication | PUBLIC | 5.2.0 | SET|GET | int |
[0-1] |
0: Never 1: After reader data transfer |
Whether or not to keep the connection open after data transfer (default is 0). | Ethernet readers except for the DM8000 wireless. |
| NETWORK-CLIENT.CONNECTION-TIMEOUT | Communication | PUBLIC | 5.2.0 | SET|GET | int |
[1000-60000] | How long to wait before considering the connection dead (default is 3000). | Ethernet readers except for the DM8000 wireless. | |
| NETWORK-CLIENT.ENABLED | Communication | PUBLIC | 5.1.0 | SET|GET | state |
[ON|OFF] | enable/disable | Switch the Network Client feature on or off. | Ethernet readers except for the DM8000 wireless. |
| NETWORK-CLIENT.HOST-ADDRESS | Communication | PUBLIC | 5.2.0 | SET|GET | string |
Max length = 255 | The address of the server to connect to. | Ethernet readers except for the DM8000 wireless. | |
| NETWORK-CLIENT.HOST-PORT | Communication | PUBLIC | 5.2.0 | SET|GET | int |
[0–65535] | The remote port on the server to connect to (default is 1000). | Ethernet readers except for the DM8000 wireless. | |
| NETWORK-CLIENT.IDLE-TIMEOUT | Communication | PUBLIC | 5.2.0 | SET|GET | int |
[1–3600] | How long to keep the connection open after transfer (default is 1). | Ethernet readers except for the DM8000 wireless. | |
| NETWORK-CLIENT.OPEN-CONNECTION | Communication | PUBLIC | 5.2.0 | SET|GET | us |
[0-1] |
0: on Power-up 1: on Data Activity |
When to open the connection to the remote host (default is 0). | Ethernet readers except for the DM8000 wireless. |
| NETWORK-CLIENT.PROTOCOL | Communication | PUBLIC | 5.2.0 | SET|GET | int |
[0-1] |
0: TCP 1: UDP |
Which protocol to use for the connection (default is 0). | Ethernet readers except for the DM8000 wireless. |
| NETWORK-CLIENT.RECONNECT-DELAY | Communication | PUBLIC | 5.2.0 | SET|GET | int |
[100-60000] | How long to wait before reconnecting if the connection is lost (default is 1000). | Ethernet readers except for the DM8000 wireless. | |
| NTP.ENABLE | Communication | PUBLIC | 5.7.0 | SET|GET | state |
[ON|OFF] | enable/disable Enable/Disable | Enables or disables NTP. | All |
| NTP.SERVER1 | Communication | PUBLIC | 5.7.0 | SET|GET | server |
IP address or DNS name | Set the NTP server 1. | All | |
| NTP.SERVER2 | Communication | PUBLIC | 5.7.0 | SET|GET | server |
IP address or DNS name | Set the NTP server 2. | All | |
| OUTPUT-QUEUE.FLUSH | IO | PUBLIC | 4.1.0 | int |
[0-1] |
0: throw output away 1: send all output now |
To flush or send all output. | DM474, DM503, and DM300 series readers. | |
| OUTPUT.DELAY-DISTANCE | Decoder | PUBLIC | 4.4.0 | SET|GET | millimeters |
[0-100000] | Distance to output when using the Encoder. | DM474, DM503, and DM300 series readers. | |
| OUTPUT.DELAY-REFERENCE | Decoder | PUBLIC | 4.4.0 | SET|GET | mode |
[0-1] |
0: Trigger Start 1: Trigger End |
Sets or gets whether output is delayed relative to trigger start or trigger end. | DM50, DM60, DM70, DM474, DM503, and DM300 series readers. |
| OUTPUT.DELAY-TIME | Decoder | PUBLIC | 4.4.0 | SET|GET | milliseconds |
[0-10000] | Output delay in milliseconds. | DM50, DM60, DM70, DM503, DM300 series readers, DM474. | |
| OUTPUT.DELAY-TYPE | Decoder | PUBLIC | 4.4.0 | SET|GET | mode |
[0-1] |
0: None 1: Time |
Sets or gets whether output is delayed, and if so, whether according to time. | DM50, DM60, DM70, DM300 series readers, DM474. |
| OUTPUT.DELAY-TYPE | Decoder | PUBLIC | 4.4.0 | SET|GET | mode |
[0-2] |
0: None 1: Time 2: Distance |
Sets or gets whether output is delayed, and if so, whether according to time or distance. | DM503 |
| OUTPUT.PULSE-WIDTH | IO | PUBLIC | 3.0.0 | SET|GET | line ms |
[0-7] [0-30000] |
i/o line number milliseconds |
Output Pulse-width. | Fixed mount readers. |
| OUTPUT.RESERVED | IO | PUBLIC | 3.0.0 | SET|GET | line reserved |
[0-7] [ON|OFF] |
i/o line number enable/disable |
Output Reserved for External Illumination. Line will be controlled by acquisition system when enabled. | Fixed mount readers, except DM50, DM60 and DM70. |
| OUTPUT.USER-CONFIGURE | Communication | PUBLIC | 5.3.0 | SET|GET | event number beep tone beep number LED color vibration |
[1,2] [0-2] [0-3] [0-7] [ON|OFF] |
1: USER_EVENT_1 2: USER_EVENT_2 [0]: Low [1]: Medium [2]: High Number of beeps [0]: Off [1]: Blue [2]: Green [3]: Cyan [4]: Red [5]: Magenta [6]: Yellow [7]: White enable/disable ON: The reader vibrates on the given user event. OFF: The reader does not vibrate on the given user event. |
Sets the beeper tone and the number of beeps for USER_EVENT_1 or USER_EVENT_2. | DM8050 (except for the vibration parameter), ON|OFF is supported on DM8600 and MX-1000. |
| OUTPUT.USER1 | Action | PUBLIC | 5.3.0 | Device emits USER_EVENT_1 event. | DM8050, MX-1000, MX-1502, DM474, DM503 and DM300 series readers. | ||||
| OUTPUT.USER2 | Action | PUBLIC | 5.3.0 | Device emits USER_EVENT_2 event. | DM8050, MX-1000, MX-1502, DM474, DM503 and DM300 series readers. | ||||
| PCM-RESULT-STRING.EXTEND | Decoder | PUBLIC | 5.7.0 | SET|GET | enable |
[ON|OFF] | Enable or disable extending the result string with metric information. | Ethernet readers. | |
| PCM-RESULT-STRING.METRIC-FORMAT | Decoder | PUBLIC | 5.7.0 | SET|GET | type |
[0-2] |
0: Grade 1: Value 2: Grade + Value |
Set the format of a single metric entry. | Ethernet readers. |
| PCM-RESULT-STRING.METRIC-PREFIX | Decoder | PUBLIC | 5.7.0 | SET|GET | type |
[0-2] |
0: None 1: Acronym 2: Name |
Defines the prefix for a single metric entry. | Ethernet readers. |
| PCM-RESULT-STRING.METRIC-SEPARATOR | Decoder | PUBLIC | 5.7.0 | SET|GET | string |
Defines the metric separator. | Ethernet readers. | ||
| PCM-RESULT-STRING.OVERALL-GRADE | Decoder | PUBLIC | 5.7.0 | SET|GET | type |
[ON|OFF] | enable | Enables or disables showing the overall grade in at the beginning of the result string. | Ethernet readers. |
| PCM-RESULT-STRING.SEPARATOR | Decoder | PUBLIC | 5.7.0 | SET|GET | string |
Defines the main separator between result data and metric section. | Ethernet readers. | ||
| PCM.CUSTOM-DESCRIPTION | Decoder | PUBLIC | 5.7.0 | SET|GET | string |
Ethernet readers. | |||
| PCM.METRIC-PARM-OVERALL | Decoder | PUBLIC | 5.7.0 | SET|GET | type type state |
[0-5] [0-27] [ON|OFF] |
0: AIM-DPM 1: ISO-IEC 15415 2: ANSI-ISO-IEC 15416 3: SemiT10 4: 1D readability 5: DotCode Readybility 0: Symbol Contrast 1: Axial Non Uniformity 2: Print Growth 3: UEC 4: Modulation 5: Fixed Pattern Damage 6: Grid Non Uniformity 7: Extreme Reflectance 8: Reflect Min 9: Edge Contrast Min 10: Single Scan Int 11: Multi Scan Int 12: Signal To Noise Ratio 13: Horizontal Mark Growth 14: Vertical Mark Growth 15: Data Matrix Cell Width 16: Data Matrix Cell Height 17: Horizontal Mark Misplacement 18: Vertical Mark Misplacement 19: Cell Defects 20: Finder Pattern Defects 21: Overall Grade 22: Edge Determination 23: Defects 24: Reference Decode 25: Decodability 26: Contrast Uniformity 27: Reflectance Margin ON: use for overall calculation OFF: do not use for overall calculation |
Use the the metric grading result for calculating the overall result if enabled (e.g. AIM-DPM → Symbol Contrast → Use for Overall Calculation = ON) Not all metrics are available for each standard: AIM-DPM (0, 1, 2, 3, 4, 5, 6, 8), ISO-IEC 15415 (0, 1, 3, 4, 5, 6, 7), ANSI-ISO-IEC 15416 (1, 4, 8, 9, 22, 23, 24, 25), 1D readability (0, 2, 8, 9, 10, 11), DotCode (0, 1, 2, 3, 6, 8) | Ethernet readers. |
| PCM.METRIC-PARM-REPORT | Decoder | PUBLIC | 5.7.0 | SET|GET | type type state |
[0-5] [0-27] [ON|OFF] |
0: AIM-DPM 1: ISO-IEC 15415 2: ANSI-ISO-IEC 15416 3: SemiT10 4: 1D readability 5: DotCode Readybility 0: Symbol Contrast 1: Axial Non Uniformity 2: Print Growth 3: UEC 4: Modulation 5: Fixed Pattern Damage 6: Grid Non Uniformity 7: Extreme Reflectance 8: Reflect Min 9: Edge Contrast Min 10: Single Scan Int 11: Multi Scan Int 12: Signal To Noise Ratio 13: Horizontal Mark Growth 14: Vertical Mark Growth 15: Data Matrix Cell Width 16: Data Matrix Cell Height 17: Horizontal Mark Misplacement 18: Vertical Mark Misplacement 19: Cell Defects 20: Finder Pattern Defects 21: Overall Grade 22: Edge Determination 23: Defects 24: Reference Decode 25: Decodability 26: Contrast Uniformity 27: Reflectance Margin ON: include in report OFF: do not include in report |
Include the metric grading result for selected quality standard and metric in the report if enabled. Only available if not use for overall calculation (e.g. ISO-IEC 15415 → Modulation → Show in Report = ON) Not all metrics are available for each standard: AIM-DPM (0, 1, 2, 3, 4, 5, 6, 8), ISO-IEC 15415 (0, 1, 2, 3, 4, 5, 6, 7), ANSI-ISO-IEC 15416 (0, 4, 8, 9, 22, 23, 24, 25), SemiT10 (1, 4, 12, 13, 14, 15, 16, 17, 18, 19, 20), 1D readability (0, 2, 8, 9, 10, 11), DotCode (0, 1, 2, 3, 6, 8). | Ethernet readers. |
| PCM.METRIC-PARM-THRESHOLD | Decoder | PUBLIC | 5.7.0 | SET|GET | type type grade value |
[0-5] [0-25] [1-4] [0-1000] |
0: AIM-DPM 1: ISO-IEC 15415 2: ANSI-ISO-IEC 15416 3: SemiT10 4: 1D readability 5: DotCode Readybility 0: Symbol Contrast 1: Axial Non Uniformity 2: Print Growth 3: UEC 4: Modulation 5: Fixed Pattern Damage 6: Grid Non Uniformity 7: Extreme Reflectance 8: Reflect Min 9: Edge Contrast Min 10: Single Scan Int 11: Multi Scan Int 12: Signal To Noise Ratio 13: Horizontal Mark Growth 14: Vertical Mark Growth 15: Data Matrix Cell Width 16: Data Matrix Cell Height 17: Horizontal Mark Misplacement 18: Vertical Mark Misplacement 19: Cell Defects 20: Finder Pattern Defects 21: Overall Grade 22: Edge Determination 23: Defects 24: Reference Decode 25: Decodability 1: D 2: C 3: B 4: A Threshold raw value |
Set the raw value threshold for the selected quality standard, metric and grade (e.g. AIM-DPM → UEC → Threshold B = 50). Not all metrics are available for each standard: AIM-DPM (0, 1, 3, 4, 6, 8), ISO-IEC 15415 (0, 1, 3, 4, 6), ANSI-ISO-IEC 15416 (1, 4, 8, 9, 23, 25), 1D readability (0, 2, 8, 9, 11), DotCode (0, 1, 2, 3, 6, 8) | Ethernet readers. |
| PCM.MIN-PASS | Decoder | PUBLIC | 5.7.0 | SET|GET | type grade |
[0-5] [0-4] |
0: AIM-DPM 1: ISO-IEC 15415 2: ANSI-ISO-IEC 15416 3: SemiT10 4: 1D readability 5: DotCode Readybility 0: F 1: D 2: C 3: B 4: A |
Set the overall minimum passing grade. Results under this grade will mean the reading failed. | Ethernet readers. |
| PCM.USE-CUSTOM-THRESHOLDS | Decoder | PUBLIC | 5.7.0 | SET|GET | type state |
[0-5] [ON|OFF] |
0: AIM-DPM 1: ISO-IEC 15415 2: ANSI-ISO-IEC 15416 3: SemiT10 4: 1D readability 5: DotCode Readybility ON: do regrading OFF: keep current result |
Enable or disable regrading of metric results by using the custom thresholds. | Ethernet readers. |
| PHARMA.CODE-ORIENTATION | Symbology | PUBLIC | 3.4.0 | SET|GET | direction |
[0-2] |
0: Any (default) 1: Horizontal 2: Vertical |
Preferred orientation for decoding Pharmacode symbols. | ALL |
| PHARMA.CODESIZE | Symbology | PUBLIC | 3.4.0 | SET|GET | any min max |
[ON|OFF] [1-6] [1-6] |
any length code minimum code length maximum code length |
Expected Pharmacode size. | ALL |
| PHARMA.HORIZONTAL-DIRECTION | Symbology | PUBLIC | 3.4.0 | SET|GET | direction |
[0-1] |
0: left-to-right (default) 1: right-to-left |
Horizontal direction preference for decoding Pharmacode symbols. | ALL |
| PHARMA.VERTICAL-DIRECTION | Symbology | PUBLIC | 3.4.0 | SET|GET | direction |
[0-1] |
0: top-to-bottom (default) 1: bottom-to-top |
Vertical direction preference for decoding Pharmacode symbols. | ALL |
| PLANET.XMTCHK | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | PLANET Transmit Check Character. | ALL |
| POSTNET.XMTCHK | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | POSTNET Transmit Check Character. | ALL |
| POWER.HIBERNATE-DISABLE | System | PUBLIC | 4.2.1 | SET|GET | state |
[ON|OFF] | enable/disable | Turning the Hibernation feature on or off. ON means that the device never hibernates. OFF means that Hibernation is not disabled (it is enabled), thus the device will go into hibernation mode. | DM8000 wireless readers. |
| POWER.HIBERNATE-TIMEOUT | System | PUBLIC | 4.2.1 | SET|GET | int |
[1-600] | seconds | Hibernation timeout. | DM8000 wireless readers. |
| POWER.POWEROFF-DISABLE | System | PUBLIC | 4.2.1 | SET|GET | state |
[ON|OFF] | enable/disable | Turning the Power Off feature on or off. ON means that the device never turns off. OFF means that Power Off is not disabled (it is enabled), thus the device will turn off. | DM8050, DM8600, MX-1000 and MX-1502. |
| POWER.POWEROFF-TIMEOUT | System | PUBLIC | 4.2.1 | SET|GET | int |
[1-600] | seconds | Power Off timeout. | DM8050, DM8600, MX-1000 and MX-1502. |
| PROFINET.ENABLED | Communication | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enabled or disabled PROFINET communications. | Ethernet readers. The DM8000 series wireless readers also support this protocol if the base station is connected through Ethernet. In the case of a Bluetooth connection, the command has to be sent to the base station, not to the reader. |
| PTP-SYNC.DELAY | Communication | PUBLIC | 5.5.0 | SET|GET | time |
[0-1000000] | Time between trigger start and the synchronized acquisition timestamp. | DM360 series readers, DM474 | |
| PTP-SYNC.ENABLE | Communication | PUBLIC | 5.5.0 | SET|GET | mode |
[ON|OFF] | Enables MST synchronized by PTP. | DM360 series readers, DM474 | |
| PTP-SYNC.LOCAL-OFFSET | Communication | PUBLIC | 5.5.0 | SET|GET | time |
[0-1000000] | Local offset added to the synchronized acquisition timestamp. | DM360 series readers, DM474 | |
| PTP.ENABLE | Communication | PUBLIC | 5.5.0 | SET|GET | mode |
[ON|OFF] |
enable/disable
OFF: Disable the PTP timestamp synchronization ON: Enable the PTP timestamp synchronization |
Enable the PTP timestamp synchronization. | DM360 series readers, DM474 |
| PTP.PRIORITY1 | Communication | PUBLIC | 5.5.0 | SET|GET | level |
[0-255] | This is the first 8-bit priority value (lower number denotes a higher priority). Normally, this is set at 128 for master capable devices. | DM360 series readers, DM474 | |
| PTP.PRIORITY2 | Communication | PUBLIC | 5.5.0 | SET|GET | level |
[0-255] | This is the second 8-bit priority value (lower number denotes a higher priority). This parameter allows to configure backup clocks. | DM360 series readers, DM474 | |
| PTP.SLAVE-ONLY | Communication | PUBLIC | 5.5.0 | SET|GET | mode |
[ON|OFF] |
enable/disable
OFF: Disables PTP slave only configuration of the reader ON: Configures the reader as PTP slave only |
This parameter configures the reader as PTP slave only, even if no other master is active. | DM360 series readers, DM474 |
| QR.MAXIMUM-GRID-SIZE | Symbology | PUBLIC | 5.2.0 | SET|GET | size |
[49-177] | Step size: 4. | Maximum grid size which can be read by the QR decoder. | ALL |
| QR.MICRO | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Micro QR Code. | ALL except for DM300L, DM503L, and DM503QL. |
| QR.MODEL1 | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | QR model-1. | ALL except for DM300L, DM503L, and DM503QL. |
| QR.MODEL2 | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | QR model-2. | ALL except for DM300L, DM503L, and DM503QL. |
| QR.QUALITY-METRICS | Decoder | PUBLIC | 4.5.0 | SET|GET | type |
[0-2] |
0: none 1: ISO/IEC 15415 2: AIM-DPM / ISO/IEC TR 29158 |
Code quality metrics for QR codes. | ALL |
| QR.SYMBOL-DIFFICULTY | Symbology | PUBLIC | 5.1.0 | SET|GET | int |
[0-2] |
0: Easy 1: Medium 2: Hard |
Level of QR code symbol difficulty. | DM8600. |
| QR.TRAINED-MODEL | Decoder | PUBLIC | 5.7.0 | SET|GET | grid size module size model polarity mirrored |
[11-177] [1-1000] [0-3] [0-2] [ON|OFF] [ON|OFF] |
Grid size Module size * 10 0: Unknown model 1: Model-1 2: Model-2 3: Micro-QR 0: dark-on-light 1: light-on-dark 2: either enable/disable ON: mirrored OFF: not mirrored |
Set training parameters for QR-Code symbology. Option 3 for argument "model": Micro-QR is not applicable for 6.0.1. |
Fixed-mount readers |
| READER.ASSIGNED | Communication | PUBLIC | 5.2.0 | SET|GET | state |
[ON|OFF] | enable/disable | Unassignins the reader and the base station that is associated with it. | Base |
| REBOOT | Action | PUBLIC | 3.0.0 | Reboot the Device. Rebooting the Device restores the Configuration stored in Non-Volatile Memory. Commands will not be processed for several seconds while the device reboots. If communication settings are changed, connection with device may be lost. Note that when connected via USB-COM, the application must release the COM port. |
ALL | ||||
| REBOOT.DELAYED | Action | PUBLIC | 5.6.0 | Reboot the Device after delay in seconds. Rebooting the Device restores the Configuration stored in Non-Volatile Memory. Commands will not be processed for several seconds while the device reboots.If communication settings are changed, connection with device may be lost. Note that when connected via USB-COM, the application must release the COM port. | All | ||||
| RESULT | Action | PUBLIC | 3.0.0 | GET | target |
[0-1] |
0: Result string 1: XML formatted |
Optional Send Last Result. By default the result string is in ASCII format, but this can be changed to Base64 with the DATA.RESULT-ENCODING command. | ALL |
| RESULT.NO-READ-STRING | IO | PUBLIC | 3.0.0 | SET|GET | string |
no-read-string | No-Read Output String. | ALL | |
| RSS.EXPANDED | Symbology | PUBLIC | 4.4.0 | SET|GET | state |
[ON|OFF] | enable/disable | RSS Expanded. | ALL |
| SCRIPT.LOAD | Data Formatting | PUBLIC | 4.5.0 | num-bytes |
Loads the formatting script from the host to the reader. | DM50, DM60, DM70, DM474, DM503, MX-1000, MX-1502 and DM300 series readers. | |||
| SCRIPT.SEND | Data Formatting | PUBLIC | 4.5.0 | Sends the formatting script from the reader to the host. | DM50, DM60, DM70, DM474, DM503, MX-1000, MX-1502 and DM300 series readers. | ||||
| SDCARD.BACKUP-FILE | Communication | PUBLIC | 5.5.0 | SET|GET | state |
[ON|OFF] | enable/disable | SD card is used for creating and restoring a configuration file backup. | DM360 series readers, DM474 |
| SDCARD.PRESENT | Communication | PUBLIC | 5.5.0 | GET | Returns True if the SD card was detected, False otherwise. | DM360 series readers, DM474 | |||
| SETUP.ENABLE | Camera | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Setup Enable. One Setup must always be enabled. Enable the desired Setup, before disabiling another Setup. For DM300 series readers, this command works for the active setup. |
DM50, DM60, DM70, DM150, DM260, DM474, DM503, DM8600, MX-1000 and DM300 series readers. |
| SETUP.NAME | Camera | PUBLIC | 3.0.0 | SET|GET | name |
Setup Name. User defined name. |
DM50, DM60, DM70, DM150, DM260, DM474, DM503, DM8600, MX-1000, and DM300 series readers. | ||
| SETUP.PROG-TARGET | Camera | PUBLIC | 3.0.0 | SET|GET | category |
[0-3] |
0: General Purpose 1: Curved Surface 2: Under Marked 3: Mirrored Surface |
Setup Programming Target. Setup to be modified by subsequent commands. |
DM70, DM150, DM260, DM8600 and MX-1000 |
| SETUP.PROG-TARGET | Camera | PUBLIC | 5.0.0 | SET|GET | category |
[0-15] | A number signifying an already existing setup. | Setup Programming Target. Setup to be modified by subsequent commands. |
DM50, DM60, DM70, DM150, DM260, DM474, DM503 and DM300 series readers. |
| SETUP.START-WITH-LAST-READ | Camera | PUBLIC | 5.2.0 | SET|GET | mode |
[ON|OFF] |
enable/disable
OFF: Start with fixed setup ON: Start with setup of last good read |
Sets read setup. | DM8600, DM70, DM150, DM260, DM474, DM503, MX-1000, MX-1502 and DM300 series readers. |
| SETUP.START-WITH-SETUP | Camera | PUBLIC | 5.2.0 | SET|GET | setup |
[0-15] | setup number to start with | Starts read setup. | DM8600, DM70, DM150, DM260, DM474, DM503, MX-1000, MX-1502 and DM300 series readers. |
| SETUP.USE | Camera | PUBLIC | 5.2.0 | int state |
[1-15] [ON|OFF] |
Setup to change enable/disable Disables/Enables setup to be used. |
Adds or removes a setup from the list of usable Read Setups. | DM8600, DM70, DM150, DM260, DM474, DM503 and DM300 series readers. | |
| SLMP-PROTOCOL.ENABLED | Communication | PUBLIC | SET|GET | state |
[ON|OFF] | enable/disable | Enables or disables SLMP-Protocol communication. | Ethernet readers. DM8000 series wireless readers also support this protocol if the base station is connected through Ethernet. In the case of a Bluetooth connection, the command has to be sent to the base station, not to the reader. | |
| STATISTICS.RESET | Action | PUBLIC | 3.3.1 | Reset all statistics. | ALL | ||||
| SYMBOL.4STATE-AUS | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable 4-State Australia Post Symbology. | ALL except for DM150QL, DM260QL, DM300L, DM503L, and DM503QL. |
| SYMBOL.4STATE-IMB | Symbology | PUBLIC | 3.4.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable 4-State Intelligent Mail Barcode. | ALL except for DM150QL, DM260QL, DM300L, DM503L, and DM503QL. |
| SYMBOL.4STATE-JAP | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable 4-State Japan Post Symbology. | ALL except for DM150QL, DM260QL, DM300L, DM503L, and DM503QL. |
| SYMBOL.4STATE-UPU | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable 4-State UPU Symbology. | ALL except for DM150QL, DM260QL, DM300L, DM503L, and DM503QL. |
| SYMBOL.AZTECCODE | Symbology | PUBLIC | 5.0.0_cr2 | SET|GET | state |
[ON|OFF] | enable/disable | Enable Aztec code symbology. | DM70, DM150, DM260, DM503, DM300 series readers, DM474, DM8050, DM8600, MX-1000, MX-1502, Mobile. |
| SYMBOL.C11 | Symbology | PUBLIC | 5.7.1 | SET|GET | state |
[ON|OFF] | enable/disable | Enable Code 11 Symbology. | ALL |
| SYMBOL.C128 | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable Code 128 Symbology. | ALL |
| SYMBOL.C25 | Symbology | PUBLIC | 5.5.2 | SET|GET | state |
[ON|OFF] | enable/disable | Enable Code 25 Symbology. Manatee Works supports 7 subcodes: Standard, Interleaved, ITF-14, IATA, Matrix, COOP, and Inverted. | ALL |
| SYMBOL.C39 | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable Code 39 Symbology. | ALL |
| SYMBOL.C39-CONVERT-TO-C32 | Code Quality | PUBLIC | 5.5.0 | SET|GET | state |
[ON|OFF] | enable/disable | Parameter enables or disables Code39 to Code 32 conversion. | DM70, DM150, DM260 |
| SYMBOL.C39-CONVERT-TO-C32 | Symbology | PUBLIC | 5.5.0 | SET | state |
[ON|OFF] | enable/disable | Enables/disables the conversion of Code39 to Code32. | ALL |
| SYMBOL.C93 | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable Code 93 Symbology. | ALL |
| SYMBOL.CODABAR | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable Codabar Symbology. | ALL |
| SYMBOL.COOP | Symbology | PUBLIC | 5.7.1 | SET|GET | state |
[ON|OFF] | enable/disable | ALL | |
| SYMBOL.DATABAR | Symbology | PUBLIC | 3.4.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable Databar. It will enable EXPANDED and LIMITED in Manatee Works SDK (just like MX). | ALL |
| SYMBOL.DATAMATRIX | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable DataMatrix Symbology. | ALL except for DM150QL, DM260QL, DM300L, DM503L, and DM503QL. |
| SYMBOL.DOTCODE | Symbology | PUBLIC | 5.0.0_cr3 | SET|GET | state |
[ON|OFF] | enable/disable | Enable DotCode symbology. | DM70, DM150, DM260, DM300 series readers, DM474, DM8050X, DM8600, MX-1000, MX-1502, Mobile. |
| SYMBOL.EAN-UCC | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable EAN-UCC Symbology. | ALL |
| SYMBOL.I2O5 | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable Interleaved 2 of 5 Symbology. | ALL |
| SYMBOL.IATA | Symbology | PUBLIC | 5.7.1 | SET|GET | state |
[ON|OFF] | enable/disable | ALL | |
| SYMBOL.INVERTED | Symbology | PUBLIC | 5.7.1 | SET|GET | state |
[ON|OFF] | enable/disable | ALL | |
| SYMBOL.ITF14 | Symbology | PUBLIC | 5.7.1 | SET|GET | state |
[ON|OFF] | enable/disable | ALL | |
| SYMBOL.MATRIX | Symbology | PUBLIC | 4.7.1 | SET|GET | state |
[ON|OFF] | enable/disable | Enable Matrix symbology. | All. |
| SYMBOL.MAXICODE | Symbology | PUBLIC | 4.5.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable MaxiCode symbology. | DM50, DM60, DM70, DM150, DM260, DM300 series readers, DM474, DM503, DM8050, DM8600, MX-1000 and MX-1502, Mobile. |
| SYMBOL.MICROPDF417 | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable Micro-PDF 417 Symbology. | ALL |
| SYMBOL.MSI | Symbology | PUBLIC | 5.0.0_cr5 | SET|GET | state |
[ON|OFF] | enable/disable | Sets or gets whether MSI Code is enabled or disabled | DM70, DM150, DM260, DM503, DM300 series readers, DM474, MX-1000, MX-1502, Mobile. |
| SYMBOL.PDF417 | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable PDF 417 Symbology. | ALL |
| SYMBOL.PHARMACODE | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable Pharmacode symbology. | ALL |
| SYMBOL.PLANET | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable PLANET Symbology. | ALL except for DM150QL, DM260QL, DM300L, DM302L, DM503L, and DM503QL. |
| SYMBOL.POSTNET | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable POSTNET Symbology. | ALL except for DM150QL, DM260QL, DM300L, DM503L, and DM503QL. |
| SYMBOL.QR | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable QR-Code Symbology. Enables QR and Micro QR in Manatee Works SDK. | ALL except for DM150QL, DM260QL, DM300L, DM503L and DM503QL. |
| SYMBOL.UPC-EAN | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable UPC/EAN Symbology. It will enable UPC-A, UPC-E, EAN-8, and EAN-13 in Manatee Works SDK (just like MX). | ALL |
| SYMBOL.VERICODE | Symbology | PUBLIC | 3.2.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable VeriCode ® symbology. | DM70, DM150 and DM260 readers with VeriCode ® license. |
| SYNC-ACQUISITION.CABLE-END | Communication | PUBLIC | 5.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Sets or gets whether your device is a bus terminator at the end of the synchronization interface bus. | DM503 |
| SYNC-ACQUISITION.DELAY | Communication | PUBLIC | 5.0.0 | SET|GET | us |
[0-25000] | microseconds | Synchronized acquisition delay: the time the reader waits after sending or receiving the synchronized interface signal before the regular acquisition sequence starts. | DM503 |
| SYNC-ACQUISITION.ENABLED | Communication | PUBLIC | 5.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enables or disables synchronized triggering. | DM503 |
| SYNC-ACQUISITION.MASTER | Communication | PUBLIC | 5.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Sets or gets whether the device is the master among the synchronized readers. | DM503 |
| TELNET.CUSTOM-PORTS | Communication | PUBLIC | 5.5.0 | SET|GET | port |
[0-65535] | Comma separated list of TCP ports | Additional Telnet TCP ports for custom communication. | Ethernet readers |
| TELNET.PORT | Communication | PUBLIC | 3.3.0 | SET|GET | value |
[0-65535] | Telnet server TCP port on reader. | Ethernet readers. | |
| TEST-MODE.ACCEPT-TRIGGERS | Communication | PUBLIC | 5.2.0 | value |
[0-2000000000] | number of accepted triggers from all inputs | Allows a limited number of triggers from external inputs even if triggering from those should be rejected using TEST-MODE.INPUTS-ENABLE. | DM70, DM150, DM260, DM474, DM503 and DM300 series readers. | |
| TEST-MODE.AUTOMATIC | Communication | PUBLIC | 5.2.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enables automatic triggering. | DM70, DM150, DM260, DM474, DM503 and DM300 series readers. |
| TEST-MODE.AUTOMATIC-OFF-US | Communication | PUBLIC | 5.2.0 | SET|GET | microseconds |
[0-2000000000] | Inactive trigger phase for automatic triggering. | DM70, DM150, DM260, DM474, DM503 and DM300 series readers. | |
| TEST-MODE.AUTOMATIC-ON-US | Communication | PUBLIC | 5.2.0 | SET|GET | microseconds |
[0-2000000000] | Active trigger phase for automatic triggering. | DM70, DM150, DM260, DM474, DM503 and DM300 series readers. | |
| TEST-MODE.ENABLE | Communication | PUBLIC | 5.2.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enables test mode. | DM70, DM150, DM260, DM474, DM503 and DM300 series readers. |
| TEST-MODE.INPUTS-ENABLE | Communication | PUBLIC | 5.2.0 | SET|GET | state |
[ON|OFF] | enable/disable | Disables external trigger sources during test mode. | DM70, DM150, DM260, DM474, DM503 and DM300 series readers. |
| TEST-MODE.OUTPUTS-ENABLE | Communication | PUBLIC | 5.2.0 | SET|GET | state |
[ON|OFF] | enable/disable | Disables result reporting to external destinations during test mode. | DM70, DM150, DM260, DM474, DM503 and DM300 series readers. |
| TRAIN.BRIGHT | Action | PUBLIC | 3.0.0 | type |
[ON|OFF] |
ON: Start Train Brightness Algorithm OFF: Abort Train Brightness Algorithm |
Generate a fixed value for the exposure setting based on the particular scene, similar to the Optimize Brightness button in the Setup Tool. | Fixed mount devices. | |
| TRAIN.CODE | Action | PUBLIC | 3.0.0 | state |
[ON|OFF] | enable/disable | Train symbology using next sucessful decode. | Fixed mount devices. | |
| TRAIN.FOCUS | Action | PUBLIC | 3.3.0 | state |
[ON|OFF] | enable/disable | Optimize lens focus. | DM503, DM474 and DM300 series readers. | |
| TRAIN.INCREMENTAL | Symbology | PUBLIC | 3.2.0 | SET|GET | state |
[ON|OFF] | enable/disable | Indicates whether incremental training is used during the next attempt to train. | Fixed mount readers. |
| TRAIN.MATCH-STRING | Action | PUBLIC | 3.1.0 | Triggers the reader and sets the match string to the value of the decoded string. Match String validation must be enabled for this command to work. | Fixed mount devices, DM8050 and DM8600. | ||||
| TRAINED-CODE.INFO | Symbology | PUBLIC | 4.4.0 | GET | Gets information about the currently trained code type ('Untrained' if no code is trained). | Fixed mount devices. | |||
| TRIGGER | Action | PUBLIC | 3.0.0 | state |
[ON|OFF] |
enable/disable
ON: Scanning process is initiated, displaying the preview if necessary, decoding frames, etc. OFF: Scanning process is terminated, even if a barcode has not been decoded. |
Software Trigger. | ALL | |
| TRIGGER | Action | PUBLIC | 3.6.0 | GET | state |
[0|1] |
0: Off 1: On |
Get current state of the trigger. | ALL |
| TRIGGER.DEBOUNCE-DELAY | IO | PUBLIC | 4.0.0 | SET|GET | delay |
[0-6] |
0: short 1: 2: default 3: 4: 5: 6: long |
Sets or gets how long the trigger signal must be detected in order to be recognized as valid. | Fixed-mount readers. |
| TRIGGER.DELAY-DISTANCE | Camera | PUBLIC | 4.4.0 | SET|GET | millimeter |
[0-2147483646] | Delay camera acquisition by distance specified in millimeters. | DM503, DM474 and DM300 series readers. | |
| TRIGGER.DELAY-TIME | Camera | PUBLIC | 4.4.0 | SET|GET | milliseconds |
[0-10000] | Trigger delay in milliseconds. Delay camera acquisition by specified number of milliseconds. |
DM50, DM60, DM70, DM474, DM503, and DM300 series readers. | |
| TRIGGER.DELAY-TYPE | Camera | PUBLIC | 4.4.0 | SET|GET | mode |
[0-1] |
0: none 1: time |
Sets or gets whether trigger delay is according to time. | DM50, DM60 and DM70 |
| TRIGGER.DELAY-TYPE | Camera | PUBLIC | 4.4.0 | SET|GET | mode |
[0-2] |
0: none 1: time 2: distance |
Sets or gets whether trigger delay is according to time or distance. | DM503, DM474 and DM300 series readers. |
| TRIGGER.END-DELAY-DISTANCE | Camera | PUBLIC | 4.4.0 | SET|GET | millimeters |
[0-2147483646] | Sets or gets trigger end delay distance. | DM474, DM503 and DM300 series readers. | |
| TRIGGER.END-DELAY-TIME | Camera | PUBLIC | 4.4.0 | SET|GET | milliseconds |
[0-10000] | Sets or gets trigger end delay time. | DM50, DM60, DM70, DM474, DM503, and DM300 series readers. | |
| TRIGGER.END-HOLDOFF-DISTANCE | IO | PUBLIC | 5.5.0 | SET|GET | distance |
[0-10000 mm] | distance for hold-off at trigger end | When greater than 0, the distance with which to cancel a pending trigger off and allow the trigger to continue. | DM474, DM503 and DM300 series readers. |
| TRIGGER.END-HOLDOFF-TIME | IO | PUBLIC | 5.5.0 | SET|GET | rime |
[0-10000 ms] | time for hold-off at trigger end | When greater than 0, the time with which to cancel a pending trigger off and allow the trigger to continue. | Fixed-mount readers |
| TRIGGER.HOLDOFF-DISTANCE | IO | PUBLIC | 5.5.0 | SET|GET | distance |
[0-10000 mm] | distance for hold-off at trigger start | When greater than 0, the distance with which to cancel a pending trigger on and act like there was no trigger at all. | DM474, DM503 and DM300 series readers. |
| TRIGGER.HOLDOFF-TIME | IO | PUBLIC | 5.5.0 | SET|GET | time |
[0-10000 ms] | time for hold-off at trigger start | When greater than 0, the time with which to cancel a pending trigger on and act like there was no trigger at all. | Fixed-mount readers |
| TRIGGER.HOLDOFF-TYPE | IO | PUBLIC | 5.5.0 | SET|GET | type |
[0-2] |
0 = None 1 = Time 2 = Distance |
Which type of trigger hold-off to use, none, time or distance. | Fixed-mount readers |
| TRIGGER.POLARITY | IO | PUBLIC | 4.0.0 | SET|GET | line polarity |
[0-3] [ON|OFF] |
Input line ON: Rising edge OFF: Falling edge |
Sets or gets the polarity at which an input will be triggered. | Fixed mount readers. |
| TRIGGER.TYPE | Camera | PUBLIC | 3.0.0 | SET|GET | type |
[0-5] |
0: Single (external) 1: Presentation (internal) 2: Manual (button) 3: Burst (external) 4: Self (internal) 5: Continuous (external) |
Trigger Type. The camera API should return the current trigger type value. | DM700 and DM8000 series readers support only Presentation and Manual trigger types. MX-1000, MX-1502 and Mobile support only Manual and Continuous trigger types. |
| TRUCHECK.AG | Decoder | PUBLIC | 5.7.7 | GET | Returns the AG (average grade) score from the last verification attempt. | DM8072 Verifier | |||
| TRUCHECK.AG-GRADE | Decoder | PUBLIC | 5.7.7 | GET | Returns the AG (average grade) grade from the last verification attempt. | DM8072 Verifier | |||
| TRUCHECK.ANU | Decoder | PUBLIC | 5.7.7 | GET | Returns the ANU (axial non-uniformity) score from the last verification attempt. | DM8072 Verifier | |||
| TRUCHECK.ANU-GRADE | Decoder | PUBLIC | 5.7.7 | GET | Returns the ANU (axial non-uniformity) grade from the last verification attempt. | DM8072 Verifier | |||
| TRUCHECK.DECODE-GRADE | Decoder | PUBLIC | 5.7.7 | GET | Returns the DECODE grade from the last verification attempt. | DM8072 Verifier | |||
| TRUCHECK.FPD | Decoder | PUBLIC | 5.7.7 | GET | Returns the FPD (fixed pattern damage) score from the last verification attempt. | DM8072 Verifier | |||
| TRUCHECK.FPD-GRADE | Decoder | PUBLIC | 5.7.7 | GET | Returns the FPD (fixed pattern damage) grade from the last verification attempt. | DM8072 Verifier | |||
| TRUCHECK.GNU | Decoder | PUBLIC | 5.7.7 | GET | Returns the GNU (grid non-uniformity) score from the last verification attempt. | DM8072 Verifier | |||
| TRUCHECK.GNU-GRADE | Decoder | PUBLIC | 5.7.7 | GET | Returns the GNU (grid non-uniformity) grade from the last verification attempt. | DM8072 Verifier | |||
| TRUCHECK.MOD-GRADE | Decoder | PUBLIC | 5.7.7 | GET | Returns the MOD (modulation) grade from the last verification attempt. | DM8072 Verifier | |||
| TRUCHECK.RM-GRADE | Decoder | PUBLIC | 5.7.7 | GET | Returns the RM grade from the last verification attempt. | DM8072 Verifier | |||
| TRUCHECK.SC | Decoder | PUBLIC | 5.7.7 | GET | Returns the SC (symbol contrast) score from the last verification attempt. | DM8072 Verifier | |||
| TRUCHECK.SC-GRADE | Decoder | PUBLIC | 5.7.7 | GET | Returns the SC (symbol contrast) grade from the last verification attempt. | DM8072 Verifier | |||
| TRUCHECK.UEC | Decoder | PUBLIC | 5.7.7 | GET | Returns the UEC (unused error correction) score from the last verification attempt. | DM8072 Verifier | |||
| TRUCHECK.UEC-GRADE | Decoder | PUBLIC | 5.7.7 | GET | Returns the UEC (unused error correction) grade from the last verification attempt. | DM8072 Verifier | |||
| TUNE-BUTTON.3SEC-ACTION | System | PUBLIC | 5.0.0 | SET|GET | action state |
[0-6] [ON|OFF] |
action code (see BUTTON.3SEC-ACTION), enabled enable/disable |
Defines actions when the user pushes the tune button for more than 3 seconds. | DM474, DM503 and DM300 readers. |
| TUNE-BUTTON.3SEC-ACTION | System | PUBLIC | 5.4.0 | SET|GET | action state |
[2,7] [ON|OFF] |
2: Set Match String 7: Extended Read Attempts enable/disable |
Defines actions when the user pushes the tune button for more than 3 seconds. | DM8600 readers. |
| TUNE-BUTTON.ENABLE | IO | PUBLIC | 5.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enables or disables the tune button. | DM474, DM503, and DM300 series readers. |
| TUNE-BUTTON.SAVE-MATCH-STRING | System | PUBLIC | 5.2.0 | SET|GET | state |
[ON|OFF] | enable/disable tune button enabled | Enables the 'save match string' action when the user pushes the tune button for more than 3 seconds. | DM474, DM503, DM8600 and DM300 readers. |
| TUNE.ADJUST-FOCUS | Camera | PUBLIC | 4.3.0 | SET|GET | state |
[ON|OFF] | Enables or disables using adjusting focus while tuning. | DM70, DM150, DM260, DM474 and DM300 series readers with liquid lens. | |
| TUNE.CANCEL | Action | PUBLIC | 4.3.0 |
|
0: Tuning is cancelled. 104: Tuning is not running or there is an error. 101: Tuning is not available. |
Cancel tuning. | DM300 series readers, DM474, DM70, DM260, and DM150. | ||
| TUNE.EXCLUDE-AMBIENT-RESULTS | Camera | PUBLIC | 5.7.0 | SET|GET | disable ambient |
[ON|OFF] |
ON: Disables the automatic selection of ambient light results OFF: Allows ambient light results for atomatic seletion |
Control the automatic selection of tuning results where the prevailing illumination type is ambient light. | Fixed mount readers. |
| TUNE.START | Action | PUBLIC | 4.3.0 |
|
0: Tuning started. 104: Tuning is already running or there is an error. 101: Tuning is not available. |
Start tuning. | DM300 series readers, DM474, DM70, DM260, and DM150. | ||
| TUNE.STATUS | Action | PUBLIC | 5.5.0 | GET | Returns ON if tuning is running, OFF otherwise. | Fixed mount devices. | |||
| TUNE.TRAIN-CODE | Camera | PUBLIC | 4.3.0 | SET|GET | state |
[ON|OFF] | Enables or disables code training while tuning. | DM300 series readers, DM474, DM70, DM260, and DM150. | |
| TUNE.TUNE-LIGHT-BANKS | Camera | PUBLIC | 4.3.0 | SET|GET | state |
[ON|OFF] | Enables or disables using light banks while tuning. Only available when internal illumination is used. |
DM300 series readers, DM474, DM260, DM70 and DM150. | |
| TUNE.TUNE-LIGHT-COMBINATIONS | Camera | PUBLIC | 5.5.0 | SET|GET | mode |
[ON|OFF] | If it is ON, light combinations will always be tuned. | DM300 series readers, DM474, DM260, DM70 and DM150. | |
| UNTRAIN.MODEL | Action | PUBLIC | 3.2.0 | enum index |
[0-5] 0 |
0: All Symbologies 1: DataMatrix 2: QR Code/MaxiCode/AztecCode 3: Linear/ Postal/ Stacked 4: VeriCode® 5: DotCode |
Deletes the specified model. AztecCode is only supported on the DM503 and DM300 series readers. |
Fixed mount readers. | |
| UPC-EAN.DELZERO | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | UPC/EAN Delete Leading Zero. | ALL |
| UPC-EAN.EAN13 | Symbology | PUBLIC | 5.7.1 | SET|GET | state |
[ON|OFF] | enable/disable | UPC/EAN Allow EAN13. | ALL |
| UPC-EAN.EAN8 | Symbology | PUBLIC | 5.7.1 | SET|GET | state |
[ON|OFF] | enable/disable | UPC/EAN Allow EAN8. | ALL |
| UPC-EAN.EAN8SUPL | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | UPC/EAN Allow EAN8 Supplementals. | ALL |
| UPC-EAN.EXPANDED | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | UPC/EAN Expanded. | ALL |
| UPC-EAN.SUPPLEMENT | Symbology | PUBLIC | 3.0.0 | SET|GET | option |
[0-4] |
0: Ignore 1: Required 2: Required 2 digit 3: Required 5 digit 4: Not required |
UPC/EAN Supplementals. The Manatee Works SDK only supports turning UPC/EAN supplement code support on/off, while the DMCC command allows them to be off, required, require a 2 digit, require a 5 digit, or optionally permit them. The Manatee Works SDK will treat options 1-4 the same; to simply enable them. | ALL |
| UPC-EAN.UPC-A | Symbology | PUBLIC | 5.7.1 | SET|GET | state |
[ON|OFF] | enable/disable | UPC/EAN UPC-A enabled. | ALL |
| UPC-EAN.UPC-E | Symbology | PUBLIC | 5.7.1 | SET|GET | state |
[ON|OFF] | enable/disable | UPC/EAN UPC-E enabled. | ALL |
| UPC-EAN.UPCE1 | Symbology | PUBLIC | 5.7.1 | SET|GET | state |
[ON|OFF] | enable/disable | UPC/EAN UPCE1 enabled. | ALL |
| UPC-EAN.UPCE1 | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | UPC/EAN UPCE1 Enabled. | ALL |
| UPTIME | Action | PUBLIC | 5.7.0 | Shows the time since device started. | All | ||||
| VIBRATION.GOOD | System | PUBLIC | 3.1.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enables vibration. | Handheld readers, except for DM8050. |
| WIFI.AUTH-MODE | Communication | PUBLIC | 4.2.4 | SET|GET | int |
[0-3] |
0 – no auth 1 – WPA-PSK 2 – WPA2-PSK 3 – EAP/TLS 4 – PEAP-MSCHAPV2 |
Sets the authentication method. | DM8000 |
| WIFI.CA-CERT | Communication | PUBLIC | 4.2.4 | SET|GET | string |
NA | Used In WPA-Enterprise. This is the certificate of the certification authority we trust. | PEM formatted certificate, terminated by a space. | DM8000;Base |
| WIFI.CHANNEL | Communication | PUBLIC | 4.2.4 | SET|GET | int |
[1-11] | Sets the wifi channel number. | ||
| WIFI.CLIENT-CERT | Communication | PUBLIC | 4.2.4 | SET|GET | string |
NA | Used in WPA-Enterprise (EAP-TLS). This is the certificate of the reader signed by the trusted CA (set with the previous command). | PEM formatted certificate, terminated by a space. | DM8000;Base |
| WIFI.CLIENT-IDENTITY | Communication | PUBLIC | 4.2.4 | SET|GET | string |
NA | The identity the client certificate is issued to. | DM8000;Base | |
| WIFI.CLIENT-PRIVATE-KEY | Communication | PUBLIC | 4.2.4 | SET|GET | string |
NA | Used in WPA-Enterprise (EAP-TLS). The private key of the reader. | PEM formatted private key, terminated by a space. | DM8000;Base |
| WIFI.ENABLED | Communication | PUBLIC | 4.2.4 | SET|GET | state |
[ON|OFF] | enable/disable | Enables or disables wifi in ad-hoc mode. | |
| WIFI.ENC-METHOD | Communication | PUBLIC | 4.2.4 | SET|GET | int |
[0-5] |
0 – off 1 – WEP40 2 – WEP104 3 – TKIP 4 – AES 5 – TKIP/AES |
Sets the authentication method. | DM8000;Base |
| WIFI.NETWORK-TYPE | Communication | PUBLIC | 4.2.4 | SET|GET | int |
[0-1] |
0 – Infrastructure mode 1 – AD-HOC mode |
Sets whether wifi works in infrastructure or ad-hoc mode. | DM8000 |
| WIFI.PASSPHRASE | Communication | PUBLIC | 4.2.4 | SET|GET | string |
NA | In WEP encrpytion and in WPA(2)-PSK it is the passphrase set by the AP. | DM8000;Base | |
| WIFI.SSID | Communication | PUBLIC | 4.2.4 | SET|GET | string |
NA | Assigns an SSID name to the network. | ||
| COM.BAUD-RATE - test data | Communication - sample | 3.0.0 | SET|GET | rate |
[1...5] |
1:115200 2:57600 3:38400 4:19200 5:9600 |
RS232 Communication Speed. Does not affect USB communication speed. |
ALL |
| Name |
Type |
Level |
Version |
Set/Get |
Args |
Range |
Meaning |
Description |
Support |
|---|---|---|---|---|---|---|---|---|---|
| MC-PROTOCOL.ENABLED | Communication | PRIVATE | SET|GET | state |
[ON|OFF] | enable/disable | Enable or disable MC-Protocol communication. | Ethernet readers. The DM8000 series wireless readers also support this protocol if the base station is connected through Ethernet. In the case of a Bluetooth connection, the command has to be sent to the base station, not to the reader. | |
| MODBUSTCP.ENABLED | Communication | PUBLIC | SET|GET | state |
[ON|OFF] | enable/disable | Enable or disable Modbus/TCP communication. | Ethernet readers. The DM8000 series wireless readers also support this protocol if the base station is connected through Ethernet. In the case of a Bluetooth connection, the command has to be sent to the base station, not to the reader. | |
| MODBUSTCP.HOLDING-ONLY | Communication | PUBLIC | SET|GET | state |
[ON|OFF] | enable/disable | Ethernet readers. DM8000 series wireless readers also support this protocol if the base station is connected through Ethernet. | ||
| SLMP-PROTOCOL.ENABLED | Communication | PUBLIC | SET|GET | state |
[ON|OFF] | enable/disable | Enables or disables SLMP-Protocol communication. | Ethernet readers. DM8000 series wireless readers also support this protocol if the base station is connected through Ethernet. In the case of a Bluetooth connection, the command has to be sent to the base station, not to the reader. | |
| 2D.ALGORITHM | Symbology | PUBLIC | 3.0.0 | SET|GET | algorithm |
[0-1] |
0: IDMax ©
1: IDQuick |
IDQuick or IDMax© | X, XM, SX and QE fixed-mount readers. All Q models except for DM503Q. |
| ABORT | Action | PRIVATE | 3.0.0 | Abort command in process. Intended to abort image transfer. | ALL | ||||
| BEEP | Action | PUBLIC | 3.0.0 | repetition level |
[0-3] [0-2] |
Command audio beep. | ALL | ||
| BEEP.DATAVALID-FAIL | IO | PUBLIC | 3.0.0 | SET|GET | repetition level |
[0-3] [0-2] |
number of beeps 0: Lo pitch 1: Med pitch 2: Hi pitch |
Data Validation Failure Beep Settings. | ALL except for DM50, DM60 and DM70. |
| BEEP.DATAVALID-FAIL-OL | IO | PUBLIC | 3.0.0 | SET|GET | repetition level |
[0-3] [0-2] |
number of beeps 0: Lo pitch 1: Med pitch 2: Hi pitch |
Data Validation Failure Beep Settings when offline. | Wireless readers. |
| BEEP.GOOD | IO | PUBLIC | 3.0.0 | SET|GET | repetition level |
[0-3] [0-2] |
number of beeps 0: Lo pitch 1: Med pitch 2: Hi pitch |
Good Read Beep Settings. | ALL except for DM50, DM60 and DM70. |
| BEEP.GOOD-OL | IO | PUBLIC | 3.0.0 | SET|GET | repetition level |
[0-3] [0-2] |
number of beeps 0: Lo pitch 1: Med pitch 2: Hi pitch |
Good Read Beep Settings when offline. | Wireless readers. |
| BEEP.NO-READ | IO | PUBLIC | 3.0.0 | SET|GET | repetition level |
[0-3] [0-2] |
number of beeps 0: Lo pitch 1: Med pitch 2: Hi pitch |
No-Read Beep Settings. | ALL except for DM50, DM60 and DM70. |
| BEEP.NO-READ-OL | IO | PUBLIC | 3.0.0 | SET|GET | repetition level |
[0-3] [0-2] |
number of beeps 0: Lo pitch 1: Med pitch 2: Hi pitch |
No-Read Beep Settings when offline. | Wireless readers. |
| BUTTON.3SEC-ACTION | IO | PUBLIC | 3.0.0 | SET|GET | mode state |
[0-6] [ON|OFF] |
0: Train 1: Optimize Brighness 2: Set Match String 3: Optimize Focus 4: Read Configuration Code 5: Tune 6: Toggle Test Mode enable/disable |
Three Second Button Action. | Fixed mount readers. Test Mode is only supported on the DM503, DM300 series readers and DM474. |
| BUTTON.ENABLE | IO | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enables or disables the trigger button. | Fixed mount readers. |
| C128.CODESIZE | Symbology | PUBLIC | 3.0.0 | SET|GET | any min max |
[ON|OFF] [1-max] [min-80] |
any length code minimum code length maximum code length |
Code 128 Allowed Size. | ALL |
| C39.ASCII | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Code 39 Full ASCII. | ALL |
| C39.CHKCHAR | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Code 39 Check Character. | ALL |
| C39.CODESIZE | Symbology | PUBLIC | 3.0.0 | SET|GET | any min max |
[ON|OFF] [1-max] [min-80] |
any length code minimum code length maximum code length |
Code 39 Code Size. | ALL |
| C39.XMTCHK | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Code 39 Transmit Check Character. | ALL |
| C93.CODESIZE | Symbology | PUBLIC | 3.0.0 | SET|GET | any min max |
[ON|OFF] [1-max] [min-80] |
any length code minimum code length maximum code length |
Code 93 Code Size. | ALL |
| CAMERA.BURST-LENGTH | Camera | PUBLIC | 3.0.0 | SET|GET | count |
[2-*] | number-images | Burst Length. Number of Acquired Images in Burst Trigger-Mode. Actual maximum can be increased by reducing the camera field of view or reserving fewer images for Process Monitor/Record and Playback. |
Fixed mount readers. |
| CAMERA.ENABLE | Camera | PRIVATE | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enables camera which can be disabled when loading images from the PC. | ALL |
| CAMERA.EXPOSURE | Camera | PUBLIC | 3.0.0 | SET|GET | auto target exposure gain |
[ON|OFF] [0-255] [0-22] [4-60] |
ON: Automatic OFF: Manual target pixel value 0: 1/10000 1: 1/7500 2: 1/5000 3: 1/4000 4: 1/3000 5: 1/2500 6: 1/2000 7: 1/1500 8: 1/1250 9: 1/1000 10: 1/750 11: 1/500 12: 1/300 13: 1/250 14: 1/200 15: 1/150 16: 1/125 17: 1/100 18: 1/75 19: 1/50 20: 1/40 21: 1/30000 22: 1/15000 camera gain |
Camera Parameters. The arguments 'exposure' and 'gain' have no effect if 'auto' is ON and the 'target' has no effect if 'auto' is OFF. | DM700. |
| CAMERA.EXPOSURE | Camera | PRIVATE | 3.0.0 | SET|GET | auto target exposure gain |
[ON|OFF] [0-255] [0-20] [1-19] |
ON: Automatic OFF: Manual target pixel value 0: 1/20000 1: 1/10000 2: 1/7500 3: 1/5000 4: 1/3000 5: 1/2500 6: 1/2000 7: 1/1500 8: 1/1250 9: 1/1000 10: 1/750 11: 1/500 12: 1/300 13: 1/250 14: 1/200 15: 1/150 16: 1/125 17: 1/100 18: 1/75 19: 1/50 20: 1/40 camera gain |
Camera Parameters. The arguments 'exposure' and 'gain' have no effect if 'auto' is ON and the 'target' has no effect if 'auto' is OFF. | DM7500 |
| CAMERA.MAX-EXPOSURE | Camera | PRIVATE | 3.0.0 | SET|GET | exposure |
[0-20] |
0: 1/20000 1: 1/10000 2: 1/7500 3: 1/5000 4: 1/3000 5: 1/2500 6: 1/2000 7: 1/1500 8: 1/1250 9: 1/1000 10: 1/750 11: 1/500 12: 1/300 13: 1/250 14: 1/200 15: 1/150 16: 1/125 17: 1/100 18: 1/75 19: 1/50 20: 1/40 |
Maximum exposure limit for autoregulation. | MX-1000 and DM8000 series readers. |
| CAMERA.ROI | Camera | 3.0.0 | SET|GET | left right top bottom |
|||||
| CODABAR.CHKCHAR | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Codabar Check Character. | ALL |
| CODABAR.CODESIZE | Symbology | PUBLIC | 3.0.0 | SET|GET | any min max |
[ON|OFF] [1-max] [min-80] |
any length code minimum code length maximum code length |
Codabar Code Size. | ALL |
| CODABAR.QZ-SIZE | Symbology | PRIVATE | 3.0.0 | SET|GET | state |
[0|100] | Quiet zone single strictness size. | ALL | |
| CODABAR.XMTCHK | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Codabar Transmit Check Character. | ALL |
| COM.AUTO-DETECT | Communication | PRIVATE | 3.0.0 | SET|GET | state |
[ON|OFF] [ON|OFF] | enable/disable | Enables support for simultaneous connection to USB And RS-232. | |
| COM.BAUD-RATE | Communication | PUBLIC | 3.0.0 | SET|GET | rate |
[1-5] |
1: 115200 2: 57600 3: 38400 4: 19200 5: 9600 |
ALL except for MX-1000. | |
| COM.BAUD-RATE - test data | Communication - sample | 3.0.0 | SET|GET | rate |
[1...5] |
1:115200 2:57600 3:38400 4:19200 5:9600 |
RS232 Communication Speed. Does not affect USB communication speed. |
ALL | |
| COM.BUFFER-DATA | IO | PRIVATE | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | ||
| COM.DATA-BITS | Communication | PUBLIC | 3.0.0 | SET|GET | bits |
[7,8] | ALL except for MX-1000. | ||
| COM.DATA-BITS | IO | PRIVATE | 3.0.0 | SET|GET | bits |
[7|8] | RS232 data bits | ||
| COM.DMCC-RESPONSE | Communication | PUBLIC | 3.0.0 | SET|GET | mode |
[0|1] |
0: Silent (default) 1: Extended |
DMCC response format. | ALL |
| COM.DMCC-RESPONSE | Communication | PRIVATE | 3.0.0 | SET|GET | mode |
[0-2] |
0: Silent (default) 1: Extended 2: Extended mode with ||[xxx::length] CR NL data Responses |
DMCC response format. | ALL |
| COM.MULTI-PORT | Communication | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable daisy chaining of readers so they share one COM port. | Fixed mount readers. |
| COM.PARITY | Communication | PUBLIC | 3.0.0 | SET|GET | parity |
[0-4] |
0: None 1: Even 2: Odd 3: Space 4: Mark |
All except for MX-1000 and MX-1502. | |
| COM.STOP-BITS | Communication | PUBLIC | 3.0.0 | SET|GET | bits |
[1-2] | ALL except for MX-1000. | ||
| COM.USB-COMPATIBILITY-MODE | Communication | PUBLIC | 3.0.0 | SET|GET | legacy |
[ON|OFF] |
ON: use pre-3.5.0 driver OFF: default |
Controls USB driver. Reboot is required. |
DM50, DM70 and DM8000 series readers. |
| COM.WAKEUP | Communication | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Wakeup Message. | ALL |
| COM.XLATEPRNT | Communication | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Translate unprintable characters that are embedded in a symbol. The translated result is output over the connection (for example, COM, USB, Ethernet, USB-KEYBOARD). Note that Data Formatting leading and terminating text are not translated. The characters translated are ASCII values between 0x00 and 0x1F. For example, 0x00 = <NUL>, 0x04 = <EOT>, 0x0a = <LF>, 0x0d = <CR>. | ALL |
| CONFIG.DEFAULT | Action | PUBLIC | 3.0.0 | Resets the device’s configuration settings to factory defaults. Device identification and communications settings are not changed. | ALL | ||||
| CONFIG.DUMP-UIDS | Action | PRIVATE | 3.0.0 | Returns all value tree parameters. | ALL | ||||
| CONFIG.RESTORE | Action | PUBLIC | 3.0.0 | Restores Configuration from Non-Volatile Memory. | ALL | ||||
| CONFIG.SAVE | Action | PUBLIC | 3.0.0 | Saves Configuration to Non-Volatile Memory. | ALL | ||||
| CONFIG.SEND | Action | PUBLIC | 3.0.0 | Send device configuration to communication channel. | ALL | ||||
| CQ | Code Quality | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable Code Quality. Code Quality Measurements require reader calibration and the Verification Feature Key. |
DM8600V |
| CQ.CALIB-DATE | Code Quality | PUBLIC | 3.0.0 | GET | Device Code Quality Calibration Date. | DM8600V | |||
| CQ.ILLUMINATION | Code Quality | PUBLIC | 3.0.0 | SET|GET | illumination-option state |
[0-4] [ON|OFF] |
0: Direct on axis 1: 30-deg All Quadrants 2: 30-deg E-W Quadrants 3: 30-deg N-S Quadrants 4: Custom enable/disable |
Code Quality Illumination Option. | DM8600V |
| CQ.METRICS | Code Quality | PUBLIC | 3.0.0 | SET|GET | metric |
[0-3] |
0: AIM-DPM/ISO/IEC TR 29158 1: ISO/IEC 15415 2: AS9132 Laser-etch 3: AS9132 Dot-peen |
Code Quality Enabled Metrics. | DM8600V |
| CQ.MINPASS | Code Quality | PUBLIC | 3.0.0 | SET|GET | metric min-pass |
[0-1] [0-4] |
0: AIM-DPM/ISO/IEC TR 29158 1: ISO/IEC 15415 0: F 1: D 2: C 3: B 4: A |
Code Quality Minimum Passing Grade. Determines the threshold for "validation failure action" including beep and configured line output. |
DM8600V |
| CQ.PROCESSM | Code Quality | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Code Quality Process Control Metrics. | DM8600V |
| CQ.UNITS | Code Quality | PUBLIC | 3.0.0 | SET|GET | option |
[0-3] |
0: mils 1: mm 2: inches 3: pixels |
Code Quality Units. | DM8600V |
| DATAMATRIX.USAGE | Symbology | PUBLIC | 3.0.0 | SET|GET | Usage Type |
[0-1] |
0: Default 1: High speed ink jet mode |
IDMax Usage Type. | ALL except for DM50, DM60, DM70, DM300, DM503. |
| DECODER.1D-LEARN-ORIENT | Decoder | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Learn Orientation of 1D Symbols. | Fixed mount readers. |
| DECODER.1D-SHORT-QUIET-ZONE | Decoder | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | When ON, the reader is tolerant with non-standard (i.e. short) quiet zones. | ALL |
| DECODER.1D-TARGET | Decoder | PRIVATE | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Target Decoding. | MX-1000 and DM8000 series readers. |
| DECODER.1D-USAGE | Decoder | PRIVATE | 3.0.0 | SET|GET | usage-type |
[0-1] |
0: Standard 0: Extended |
1D Symbology Usage Type. | |
| DECODER.1D-USAGE | Decoder | PUBLIC | 3.0.0 | SET|GET | usage |
[0-1] |
0: Standard 1: Extended |
1D Symbology Usage Type. | Fixed mount readers. |
| DECODER.ROI | Decoder | PUBLIC | 3.0.0 | SET|GET | left (multiple of 8) right (multiple of 8) top (multiple of 4) bottom (multiple of 4) |
[0...] [left+64...] [0...] [top+64...] |
left of the ROI rectangle right of the ROI rectangle top of the ROI rectangle bottom of the ROI rectangle |
Decoder Region of Interest. Image Region examined by decoder for enabled symbols. Pixel coordinates are relative to the upper left corner of the displayed image. Left < Right and Top < Bottom. Values must not be outside the specified CAMERA.FOV settings. |
ALL |
| DECODER.TIMEOUT | Decoder | PUBLIC | 3.0.0 | SET|GET | ms |
[0-10000] | milliseconds | Decoder Timeout. Maximum allowed decode time. |
Fixed mount readers. |
| DEVICE.BOOT-VER | System | PRIVATE | 3.0.0 | ||||||
| DEVICE.DEFAULT | Action | PUBLIC | 3.0.0 | Resets all device settings to factory defaults. This command reboots the device. | ALL | ||||
| DEVICE.FEATURE-KEYS | System | PUBLIC | 3.0.0 | GET | Device Feature Keys. | ALL | |||
| DEVICE.FIRMWARE-VER | System | PUBLIC | 3.0.0 | GET | Device Firmware Version. | ALL | |||
| DEVICE.FLASH | PRIVATE | 3.0.0 | begin numbytes |
||||||
| DEVICE.NAME | System | PUBLIC | 3.0.0 | SET|GET | string |
Device Name. MX + the last six digits of DEVICE.SERIAL-NUMBER | ALL | ||
| DEVICE.SAVE | System | PRIVATE | 3.0.0 | ||||||
| DEVICE.SERIAL-NUMBER | System | PUBLIC | 3.0.0 | GET | Device Serial Number. | ALL | |||
| DEVICE.SHIPPEDAS-VER | System | PRIVATE | 3.0.0 | GET | |||||
| DEVICE.START-VER | System | PRIVATE | 3.0.0 | ||||||
| DEVICE.TYPE | System | PUBLIC | 3.0.0 | GET | Device Type. | ALL | |||
| DMPOP | System | PRIVATE | 3.0.0 | GET | vtree path |
Gets value tree parameter. | |||
| DMPUSH | System | PRIVATE | 3.0.0 | SET | vtree path |
Sets value tree parameter. | |||
| DVALID.DOD-EXEID | Data Validation | PUBLIC | 3.0.0 | SET|GET | string |
expected-EID | DoD Expected Enterprise ID (EID). | ALL | |
| DVALID.DOD-EXPN | Data Validation | PUBLIC | 3.0.0 | SET|GET | string |
expected-PN | DoD Expected Part Number. See the Overview topic for formatting requirements for the string argument. |
ALL | |
| DVALID.DODCNSTRT | Data Validation | PUBLIC | 3.0.0 | SET|GET | construct |
[0-3] |
0: Any 1: Construct #1 2: Construct #2 3: Equivalent |
Data Validation DoD Construct. | ALL |
| DVALID.FAIL-ACTION | Data Validation | PUBLIC | 3.0.0 | SET|GET | action |
[0-3] |
0: Transmit "Validation Failure" 1: Transmit "Validation Failure" + decoded string 2: Transmit annotated decode string 3: Transmit nothing |
Data Validation Failure Action. | ALL |
| DVALID.FAIL-XMT-CRLF | Data Validation | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Data Validation Transimit CRLF on Failure. | ALL |
| DVALID.ISO-CONSTRUCT | Data Validation | PUBLIC | 3.0.0 | SET|GET | construct |
[0-1] |
0: ISO 15434 1: ISO 15434 & ISO 15418 |
ISO Construct. | ALL |
| DVALID.MATCH-STRING | Data Validation | PUBLIC | 3.0.0 | SET|GET | string |
match-string | Data Validation Match-String. See the Overview topic for formatting requirements for the string argument. |
ALL | |
| DVALID.MATCH-STRING-PARAMS | Data Validation | PUBLIC | 3.0.0 | SET|GET | increment start length step no-read validation-fail |
[ON|OFF]
[0-*] [1-*] [-2|-1|0|1|2] [ON|OFF] [ON|OFF] |
enable/disable
start position of numerical match number of digits increment enable/disable update on no-read enable/disable update on validation failure |
Data Validation Match-String Parameters. | ALL |
| DVALID.PATTERN | Data Validation | PUBLIC | 3.0.0 | SET|GET | string |
pattern-string | Data Validation Pattern. Regexp Data Validation. See the Overview topic for formatting requirements for the string argument. |
ALL | |
| DVALID.TYPE | Data Validation | PUBLIC | 3.0.0 | SET|GET | type |
[0-5] |
0: None 1: DoD UID 2: ISO 3: Pattern 4: Match String 5: GS1 |
ALL | |
| EAN-UCC.CC-C | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable or disable Composite Code C. | ALL |
| EAN-UCC.XMTMODE | Symbology | PUBLIC | 3.0.0 | SET|GET | mode |
[0-1] |
0: Standard (linear & 2D) 1: Linear only |
EAN-UCC Transmit mode. | ALL |
| FORMAT.ADVANCED | Data Formatting | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable Data Formatting Advanced Mode. Advanced Mode Formatting Enables: Regexp Pattern Substitution. |
ALL |
| FORMAT.CRLF-END | Data Formatting | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Data Formatting CRLF Terminator. Requires Data Formatting Standard Mode Enabled. |
ALL |
| FORMAT.DELIMITER | Data Formatting | PUBLIC | 3.0.0 | SET|GET | delimiter-option |
[0-5] |
0: none 1: space 2: comma 3: tab 4: label 5: xml |
Data Formatting Delimiter. Sets the delimeter between Data Formatting Tokens. Requires Data Formatting Standard Mode Enabled. |
ALL |
| FORMAT.DISCARD-UNMATCHED | Data Formatting | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Data Formatting Discard Unmatched Data. | ALL |
| FORMAT.REGEXP | Data Formatting | PUBLIC | 3.0.0 | SET|GET | string |
regular expression string | Data Formatting Regular Expression. Requires Data Formatting Advanced Mode Enabled. See the Overview topic for formatting requirements for the string argument. |
ALL | |
| FORMAT.STANDARD | Data Formatting | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable Data Formatting Standard Mode. Standard Mode Formatting Enables: Leading Text, Data, Data Delimeter, Terminating Text, Terminating CRLF. |
ALL |
| FORMAT.TEXT-BEGIN | Data Formatting | PUBLIC | 3.0.0 | SET|GET | string |
leading output text | Data Formatting Leading Text. Requires Data Formatting Standard Mode Enabled. See the Overview topic for formatting requirements for the string argument. |
ALL | |
| FORMAT.TEXT-END | Data Formatting | PUBLIC | 3.0.0 | SET|GET | string |
trailing text | Data Formatting Trailing Text. Requires Data Formatting Standard Mode Enabled. See the Overview topic for formatting requirements for the string argument. |
ALL | |
| FORMAT.TOKEN | Data Formatting | PUBLIC | 3.0.0 | SET|GET | string |
token string | Data Formatting Standard Data. Regardless of the parameters given to GET FORMAT.TOKEN, it will return the current data formatting token string contained in the Standard Formatting window pointed to by the current value of GET FORMAT.PROG-TARG. See Data Formatting Token Table for available elements. See the Overview topic for formatting requirements for the string argument. |
ALL | |
| I2O5.CHKCHAR | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | I2of5 Check Character. | ALL |
| I2O5.CODESIZE | Symbology | PUBLIC | 3.0.0 | SET|GET | any min max |
[ON|OFF] [4-max] [min-80] |
any length code minimum code length maximum code length |
I2of5 Code Size. For the Manatee Works SDK, all of the Code 25 variants use the same minimum length; thus it will accept either C25.CODESIZE or I205.CODESIZE. | ALL |
| I2O5.QZ-SIZE | Symbology | PRIVATE | 3.0.0 | SET|GET | state |
[0|100] | Quiet zone single strictness size. | ALL | |
| I2O5.XMTCHK | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | I2of5 Transmit Check Character. | ALL |
| IMAGE.LOAD | Camera | PRIVATE | 3.0.0 | num-bytes |
Loads image from PC to Reader. | ||||
| IMAGE.SEND-SLOT | Camera | 3.0.0 | |||||||
| IMAGE.SEND-TYPE | Camera | 3.0.0 | |||||||
| INPUT.ACTION1 | IO | PUBLIC | 3.0.0 | SET|GET | mode state |
[0-3] [ON|OFF] |
0: Train Code 1: Optimize Brighness 2: Set Match String 3: Optimize focus (Only for readers with a liquid lens.) enable/disable |
Input Line 1 Action. | Fixed mount readers. |
| INPUT.VIRTUAL | Action | PRIVATE | 3.0.0 | line state |
[0-7] [ON|OFF] |
enable/disable |
Software Virtual Input. Trigger is equivalent to line 0. Note that the input actions "Train Code," "Optimize Brightness," "Set Match String," and "Read Configuration Code" are carried out only after the next trigger. |
Fixed mount devices. | |
| KEY.LANGUAGE | IO | PUBLIC | 3.0.0 | SET|GET | language |
[0-7] |
0: Alt Key Combo 1: DE 2: US 3: JP 4: FR 5: ES 6: NO 7: FI |
ALL except for DM60, DM474, DM503, and DM300 series readers. | |
| KEY.ZERO-PAD | IO | PUBLIC | 3.0.0 | SET|GET | language |
[ON|OFF] | enable/disable | ALL except for DM60, DM474, DM503, and DM300 series readers. | |
| LIGHT.AIMER | Camera | PUBLIC | 3.0.0 | SET|GET | aimer-mode |
[0-1] |
0: Off 1: On |
Aimer Enable. Default is ON. |
ALL except for DM503 and DM8050. |
| LIGHT.AIMER | Camera | PRIVATE | 3.0.0 | SET|GET | aimer-mode |
[0-3] |
0: Off 1: LED 2: Laser 3: Both |
Aimer Enable. | DM700 |
| LIGHT.AIMER | Camera | PRIVATE | 3.0.0 | SET|GET | aimer-mode |
[0-3] |
0: Off 1: On when idle 2: Blink (default) 3: On (default) |
Aimer Enable. | DM7500 |
| LIGHT.EXTERNAL-POLARITY | Camera | PUBLIC | 3.0.0 | SET|GET | polarity |
[0-1] |
0: Active Low 1: Active High |
External illlumination output polarity. | Fixed mount readers except for DM70, DM150, DM260. |
| LIGHT.EXTERNAL-PRECHARGE-TIME | Camera | PREVIEW | 3.0.0 | SET|GET | time |
[1-980] | microseconds | External light precharge time. | Fixed mount readers. |
| MULTICODE.IMAGE-REVERSE | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] |
ON: sort last image first OFF: sort first image first |
Image sorting order preference. | Fixed mount readers. |
| OUTPUT.ACTION | IO | PREVIEW | 3.0.0 | SET|GET | line action |
[0-7] [0-1] |
line number 0: Open 1: Close |
Output Action. Open or Close output line on event. Only supported on line 1. |
Fixed mount readers. |
| OUTPUT.CQ-FAIL | IO | PRIVATE | 3.0.0 | Output Code Quality failed actions. Verifiers only. |
|||||
| OUTPUT.DATAVALID-FAIL | Action | PREVIEW | 3.0.0 | Virtual Data Validation Failure. Device beeps, flashes indicator lights, and sets output lines as if the specified Data Validation failure event occurred. |
ALL | ||||
| OUTPUT.DATAVALID-FAIL | IO | PRIVATE | 3.0.0 | Output Data Validation failed actions. | |||||
| OUTPUT.EVENTS | IO | PREVIEW | 3.0.0 | SET|GET | line read no-read validation-failure trigger-overrun buffer-overflow user event 1 user event 2 |
[0-7] [0-1] [0-1] [0-1] [0-1] [0-1] [0-1] [0-1] |
i/o line number 0: Off 1: On 0: Off 1: On 0: Off 1: On 0: Off 1: On 0: Off 1: On 0: Off 1: On 0: Off 1: On |
Output Events. Configure output line to signal based on event. |
Fixed mount readers. |
| OUTPUT.GOOD | Action | PREVIEW | 3.0.0 | Virtual Good-Read. Device beeps, flashes indicator lights, and sets output lines as if the specified read event occurred. |
ALL | ||||
| OUTPUT.GOOD | IO | PRIVATE | 3.0.0 | Output good read actions. | |||||
| OUTPUT.NOREAD | Action | PREVIEW | 3.0.0 | Virtual No-Read. Device beeps, flashes indicator lights, and sets output lines as if the specified no-read event occurred. |
ALL | ||||
| OUTPUT.NOREAD | IO | PRIVATE | 3.0.0 | Output no read actions. | |||||
| OUTPUT.PULSE-WIDTH | IO | PUBLIC | 3.0.0 | SET|GET | line ms |
[0-7] [0-30000] |
i/o line number milliseconds |
Output Pulse-width. | Fixed mount readers. |
| OUTPUT.RESERVED | IO | PUBLIC | 3.0.0 | SET|GET | line reserved |
[0-7] [ON|OFF] |
i/o line number enable/disable |
Output Reserved for External Illumination. Line will be controlled by acquisition system when enabled. | Fixed mount readers, except DM50, DM60 and DM70. |
| OUTPUT.TRIG-OVERRUN | IO | PRIVATE | 3.0.0 | Output trigger overrun actions. | |||||
| PLANET.XMTCHK | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | PLANET Transmit Check Character. | ALL |
| POSTNET.XMTCHK | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | POSTNET Transmit Check Character. | ALL |
| POWER.SLEEP | System | PRIVATE | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Power Save Mode Enable. | DM7500 |
| POWER.SLEEPTIME | System | PRIVATE | 3.0.0 | SET|GET | secs |
[0, 60, 120... 600] | seconds | Time before entering power-save mode. | DM7500 |
| PRESENT.NEVER2X | System | PRIVATE | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Never Read the Same Code Twice. OBSOLETED in 4.5. Presentation mode only. |
ALL |
| PRESENT.REREAD | System | PRIVATE | 3.0.0 | SET|GET | ms |
[0-10000] | milliseconds | OBSOLETED in 4.5. Presentation Mode Re-read Delay. | ALL |
| PRESENT.RESCAN | System | PRIVATE | 3.0.0 | SET|GET | ms |
[0-10000] | milliseconds | OBSOLETED in 4.5. Presentation Mode Rescan Delay. | ALL |
| PROFINET.ENABLED | Communication | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enabled or disabled PROFINET communications. | Ethernet readers. The DM8000 series wireless readers also support this protocol if the base station is connected through Ethernet. In the case of a Bluetooth connection, the command has to be sent to the base station, not to the reader. |
| QR.MICRO | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Micro QR Code. | ALL except for DM300L, DM503L, and DM503QL. |
| QR.MODEL1 | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | QR model-1. | ALL except for DM300L, DM503L, and DM503QL. |
| QR.MODEL2 | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | QR model-2. | ALL except for DM300L, DM503L, and DM503QL. |
| REBOOT | Action | PUBLIC | 3.0.0 | Reboot the Device. Rebooting the Device restores the Configuration stored in Non-Volatile Memory. Commands will not be processed for several seconds while the device reboots. If communication settings are changed, connection with device may be lost. Note that when connected via USB-COM, the application must release the COM port. |
ALL | ||||
| RESULT | Action | PUBLIC | 3.0.0 | GET | target |
[0-1] |
0: Result string 1: XML formatted |
Optional Send Last Result. By default the result string is in ASCII format, but this can be changed to Base64 with the DATA.RESULT-ENCODING command. | ALL |
| RESULT.NO-READ-STRING | IO | PUBLIC | 3.0.0 | SET|GET | string |
no-read-string | No-Read Output String. | ALL | |
| SDK.VERSION | System | PRIVATE | 3.0.0 | SET|GET | Gets or sets the SDK version. Used by early versions of the DataMan SDK. | ||||
| SETUP.ENABLE | Camera | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Setup Enable. One Setup must always be enabled. Enable the desired Setup, before disabiling another Setup. For DM300 series readers, this command works for the active setup. |
DM50, DM60, DM70, DM150, DM260, DM474, DM503, DM8600, MX-1000 and DM300 series readers. |
| SETUP.NAME | Camera | PUBLIC | 3.0.0 | SET|GET | name |
Setup Name. User defined name. |
DM50, DM60, DM70, DM150, DM260, DM474, DM503, DM8600, MX-1000, and DM300 series readers. | ||
| SETUP.PROG-TARGET | Camera | PUBLIC | 3.0.0 | SET|GET | category |
[0-3] |
0: General Purpose 1: Curved Surface 2: Under Marked 3: Mirrored Surface |
Setup Programming Target. Setup to be modified by subsequent commands. |
DM70, DM150, DM260, DM8600 and MX-1000 |
| SYMBOL.4STATE-AUS | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable 4-State Australia Post Symbology. | ALL except for DM150QL, DM260QL, DM300L, DM503L, and DM503QL. |
| SYMBOL.4STATE-JAP | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable 4-State Japan Post Symbology. | ALL except for DM150QL, DM260QL, DM300L, DM503L, and DM503QL. |
| SYMBOL.4STATE-UPU | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable 4-State UPU Symbology. | ALL except for DM150QL, DM260QL, DM300L, DM503L, and DM503QL. |
| SYMBOL.C128 | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable Code 128 Symbology. | ALL |
| SYMBOL.C39 | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable Code 39 Symbology. | ALL |
| SYMBOL.C93 | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable Code 93 Symbology. | ALL |
| SYMBOL.CODABAR | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable Codabar Symbology. | ALL |
| SYMBOL.DATAMATRIX | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable DataMatrix Symbology. | ALL except for DM150QL, DM260QL, DM300L, DM503L, and DM503QL. |
| SYMBOL.EAN-UCC | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable EAN-UCC Symbology. | ALL |
| SYMBOL.I2O5 | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable Interleaved 2 of 5 Symbology. | ALL |
| SYMBOL.MICROPDF417 | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable Micro-PDF 417 Symbology. | ALL |
| SYMBOL.PDF417 | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable PDF 417 Symbology. | ALL |
| SYMBOL.PHARMACODE | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable Pharmacode symbology. | ALL |
| SYMBOL.PLANET | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable PLANET Symbology. | ALL except for DM150QL, DM260QL, DM300L, DM302L, DM503L, and DM503QL. |
| SYMBOL.POSTNET | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable POSTNET Symbology. | ALL except for DM150QL, DM260QL, DM300L, DM503L, and DM503QL. |
| SYMBOL.QR | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable QR-Code Symbology. Enables QR and Micro QR in Manatee Works SDK. | ALL except for DM150QL, DM260QL, DM300L, DM503L and DM503QL. |
| SYMBOL.RPC | Symbology | PRIVATE | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Reader Programming Code. | DM70, DM150, DM260 |
| SYMBOL.UPC-EAN | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable UPC/EAN Symbology. It will enable UPC-A, UPC-E, EAN-8, and EAN-13 in Manatee Works SDK (just like MX). | ALL |
| TRAIN.BRIGHT | Action | PUBLIC | 3.0.0 | type |
[ON|OFF] |
ON: Start Train Brightness Algorithm OFF: Abort Train Brightness Algorithm |
Generate a fixed value for the exposure setting based on the particular scene, similar to the Optimize Brightness button in the Setup Tool. | Fixed mount devices. | |
| TRAIN.CODE | Action | PUBLIC | 3.0.0 | state |
[ON|OFF] | enable/disable | Train symbology using next sucessful decode. | Fixed mount devices. | |
| TRIGGER | Action | PUBLIC | 3.0.0 | state |
[ON|OFF] |
enable/disable
ON: Scanning process is initiated, displaying the preview if necessary, decoding frames, etc. OFF: Scanning process is terminated, even if a barcode has not been decoded. |
Software Trigger. | ALL | |
| TRIGGER.DELAY | Camera | PRIVATE | 3.0.0 | SET|GET | milliseconds |
[0-10000] | Trigger Delay. Delay camera acquisition by specified number of milliseconds. |
ALL | |
| TRIGGER.TYPE | Camera | PUBLIC | 3.0.0 | SET|GET | type |
[0-5] |
0: Single (external) 1: Presentation (internal) 2: Manual (button) 3: Burst (external) 4: Self (internal) 5: Continuous (external) |
Trigger Type. The camera API should return the current trigger type value. | DM700 and DM8000 series readers support only Presentation and Manual trigger types. MX-1000, MX-1502 and Mobile support only Manual and Continuous trigger types. |
| UPC-EAN.DELZERO | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | UPC/EAN Delete Leading Zero. | ALL |
| UPC-EAN.EAN8SUPL | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | UPC/EAN Allow EAN8 Supplementals. | ALL |
| UPC-EAN.EXPANDED | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | UPC/EAN Expanded. | ALL |
| UPC-EAN.SUPPLEMENT | Symbology | PUBLIC | 3.0.0 | SET|GET | option |
[0-4] |
0: Ignore 1: Required 2: Required 2 digit 3: Required 5 digit 4: Not required |
UPC/EAN Supplementals. The Manatee Works SDK only supports turning UPC/EAN supplement code support on/off, while the DMCC command allows them to be off, required, require a 2 digit, require a 5 digit, or optionally permit them. The Manatee Works SDK will treat options 1-4 the same; to simply enable them. | ALL |
| UPC-EAN.UPCE1 | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | UPC/EAN UPCE1 Enabled. | ALL |
| DATA.RESULT-ALWAYSSEND | System | PRIVATE | 3.1.0 | SET|GET | state |
[ON|OFF] | enable/disable | Sets gets whether to always send result. | ALL |
| DATA.RESULT-ENCODING | Communication | PUBLIC | 3.1.0 | SET|GET | encoding |
[0|1] |
0: ASCII (default) 1: Base64 |
Result string encoding. | ALL |
| DATA.RESULT-TYPE | System | PRIVATE | 3.1.0 | SET|GET | bit-field |
[0-128] |
0x00 = None 0x01 = Result 0x02 = XML formated result 0x04 = XML formated statistics 0x08 = Image Data 0x10 = Image Graphics 0x20 = Traning Result 0x40 = Code Quality Graphics |
Controls automatic result transmitted from reader. Default is 1. | ALL |
| DMPOP.INFO | System | PRIVATE | 3.1.0 | GET | vtree path |
Gets Device Info value tree parameter. | |||
| DMPUSH.INFO | System | PRIVATE | 3.1.0 | SET | vtree path |
Sets Device Info value tree parameter. DMCC Key is required. | |||
| DMSTATS | System | PRIVATE | 3.1.0 | vtree path |
Returns argument range for value tree parameter. e.g. ||>DMSTATS /ROI/Left |
||||
| FIRMWARE.LOAD | System | PRIVATE | 3.1.0 | file size date from location |
|
|
Loads firmware file to reader. File data follows DMCC footer. Forces a reboot. | ||
| FIRMWARE.LOAD-NOREBOOT | System | PRIVATE | 3.1.0 | file size date from location |
|
|
Loads firmware file to reader. File data follows DMCC footer. | ||
| FKEY.LOAD | System | PRIVATE | 3.1.0 | key size |
Loads encrypted feature key string to reader. Key data follows DMCC footer. Forces a reboot. | ||||
| FKEY.LOAD-NOREBOOT | System | PRIVATE | 3.1.0 | key size |
Loads encrypted feature key string to reader. Key data follows DMCC footer. | ||||
| FKEY.SAVE | System | PRIVATE | 3.1.0 | Saves feature key to flash memory. | |||||
| FLASH.ERASE | System | PRIVATE | 3.1.0 | sec number sec offset size |
|
|
Used to reset feature key data section. Obsolete in 3.3 by FILE.UNLINK. | ||
| FLASH.GET | System | PRIVATE | 3.1.0 | sec number sec offset size |
|
|
Output the specified section of Flash. | ||
| HEAP.STATS | System | PRIVATE | 3.1.0 | Returns heap memory statistics. | |||||
| TRAIN.MATCH-STRING | Action | PUBLIC | 3.1.0 | Triggers the reader and sets the match string to the value of the decoded string. Match String validation must be enabled for this command to work. | Fixed mount devices, DM8050 and DM8600. | ||||
| VIBRATION.GOOD | System | PUBLIC | 3.1.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enables vibration. | Handheld readers, except for DM8050. |
| CAMERA.FOV | Camera | PREVIEW | 3.2.0 | SET|GET | left (multiple of 8) right (multiple of 8) top (multiple of 4) bottom (multiple of 4) |
[0...] [left+64...] [0...] [top+64...] |
pixels from left pixels from right pixels from top pixels from bottom |
The camera field of view is the area of the camera used for image acquisition. | ALL |
| CAMERA.FOV-ENABLED | Camera | PUBLIC | 3.2.0 | SET|GET | state |
[ON|OFF] | enable/disable | Indicates whether the full FoV or a custom FoV will be used for image acquisition. You can change this value only for the following trigger types: single, burst, and continuous. |
ALL |
| CUSTOM-CMD.COMMAND-FOOTER | Communication | PUBLIC | 3.2.0 | SET|GET | string |
End of the string to be echoed. See the Overview topic for formatting requirements for the string argument. |
Fixed mount readers. | ||
| CUSTOM-CMD.COMMAND-HEADER | Communication | PUBLIC | 3.2.0 | SET|GET | string |
Start of the string to be echoed. | Fixed mount readers. | ||
| CUSTOM-CMD.ECHO | Communication | PUBLIC | 3.2.0 | SET|GET | state |
[ON|OFF] | enable/disable | Indicates if characters received between a COMMAND-HEADER and COMMAND-FOOTER are echoed. | Fixed mount readers. |
| CUSTOM-CMD.TRIGGER | Communication | PUBLIC | 3.2.0 | SET|GET | state |
[ON|OFF] | enable/disable | Indicates if reader will respond to the TRIGGER-ON or TRIGGER-OFF string. | Fixed mount readers. |
| CUSTOM-CMD.TRIGGER-OFF | Communication | PUBLIC | 3.2.0 | SET|GET | string |
String that will stop a trigger. See the Overview topic for formatting requirements for the string argument. |
Fixed mount readers. | ||
| CUSTOM-CMD.TRIGGER-ON | Communication | PUBLIC | 3.2.0 | SET|GET | string |
String that will start a trigger. See the Overview topic for formatting requirements for the string argument. |
Fixed mount readers. | ||
| DATAMATRIX.SECURITY-KEY | Symbology | PRIVATE | 3.2.0 | SET | type name |
1 |
1: Custom1 |
Sets the secure Data Matrix key which is 32 byte string. This string needs to be entered in hexadecimal format. | |
| DATAMATRIX.SECURITY-TYPE | Symbology | PRIVATE | 3.2.0 | SET|GET | type state |
[0-1] [ON|OFF] |
0: None 1: Custom1 enable/disable |
Data Matrix security type used. Only valid with a valid security key is set. | ALL |
| FORMAT.MULTICODE-DELIMITER | Data Formatting | PUBLIC | 3.2.0 | SET|GET | type |
[0-6] |
0: none 1: space 2: comma 3: tab 4: label 5: xml 6: CRLF |
Data Formatting Delimiter. Sets the delimiter between codes in a multicode result. |
Fixed mount readers. |
| FORMAT.PROG-TARG | Data Formatting | PUBLIC | 3.2.0 | SET|GET | category |
[0-5] |
0: Universal 1: DataMatrix 2: QR Code/MaxiCode/AztecCode 3: Linear/ Postal/ Stacked 4: VeriCode® 5: DotCode |
Data Formatting Programming Target. Data Formatting Symbology Set to be modified by subsequent commands. Once issued, it changes the subsequent behavior of the reader. AztecCode is only supported on the DM503 and DM300 series readers. |
ALL |
| INTER-MESSAGE.DELAY | Communication | PREVIEW | 3.2.0 | SET|GET | value |
[0-10000] | milliseconds | Transmission delay between buffered read strings. | Wireless readers. |
| MULTICODE.MAX-NUM-CODES | Symbology | PUBLIC | 3.2.0 | SET|GET | symbology number |
[1-5] [1-255] |
1: DataMatrix 2: QR Code/MaxiCode/AztecCode 3: Linear/ Postal/ Stacked 4: VeriCode® 5: DotCode |
The expected maximum number of codes to find for each symbology grouping 1 - 4; no expected value for any single symbology can exceed parameter 0, the total number of codes to find. | Fixed mount readers. |
| MULTICODE.NUM-CODES | Symbology | PUBLIC | 3.2.0 | SET|GET | number |
[1-255] | Number of codes readers must find for a successful read result. | Fixed mount readers. | |
| MULTICODE.PARTIAL-RESULTS | Symbology | PUBLIC | 3.2.0 | SET|GET | state |
[ON|OFF] | enable/disable | Controls how the reader interprets the number of codes to find. ON = reader will return a successful read if 1 or more codes are found. OFF = reader will return a successful read only if number of codes found equals MULTICODE.NUM-CODES value. | Fixed mount readers. |
| SYMBOL.VERICODE | Symbology | PUBLIC | 3.2.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable VeriCode ® symbology. | DM70, DM150 and DM260 readers with VeriCode ® license. |
| TRAIN.AUTO-DISABLE | Symbology | PREVIEW | 3.2.0 | SET|GET | state |
[ON|OFF] | enable/disable | Indicates whether untrained symbology groups will be disabled after the next attempt to train. | Fixed mount readers. |
| TRAIN.AVAILABLE | Symbology | PRIVATE | 3.2.0 | GET | symbology |
Indicates whether incremental training is available for the selected symbology group. | Fixed mount readers. | ||
| TRAIN.INCREMENTAL | Symbology | PUBLIC | 3.2.0 | SET|GET | state |
[ON|OFF] | enable/disable | Indicates whether incremental training is used during the next attempt to train. | Fixed mount readers. |
| UNTRAIN.MODEL | Action | PUBLIC | 3.2.0 | enum index |
[0-5] 0 |
0: All Symbologies 1: DataMatrix 2: QR Code/MaxiCode/AztecCode 3: Linear/ Postal/ Stacked 4: VeriCode® 5: DotCode |
Deletes the specified model. AztecCode is only supported on the DM503 and DM300 series readers. |
Fixed mount readers. | |
| DECODER.1D-LEARN-CODESIZE | Decoder | PRIVATE | 3.2.0_cr5 | SET|GET | state |
[ON|OFF] | enable/disable | Learn the code size of 1D Symbols. | ALL |
| CAMERA.BURST-TRANSFER-ALL | Camera | PRIVATE | 3.3.0 | SET|GET | state |
[ON|OFF] | enable/disable | Force transfer of all burst images. Used by the DMCC .NET. |
|
| CQ.RESET-CALIBRATION | Code Quality | PUBLIC | 3.3.0 | Invalidates code quality calibration data. Reboot is required. |
DM8600V | ||||
| DEVICE.BACKUP | Action | PUBLIC | 3.3.0 | Send encrypted backup file (.cdc) to the PC. | ALL | ||||
| DEVICE.MAC-ADDRESS | Communication | PUBLIC | 3.3.0 | GET | Reader's MAC address. | Ethernet readers. | |||
| DEVICE.RESTORE | Action | PUBLIC | 3.3.0 | file size |
Transmits backup file (.cdc) to the reader. File size is in bytes. File data follows footer. | ALL | |||
| FILE.UNLINK | System | PRIVATE | 3.3.0 | file |
Remove file from file system. | ||||
| FTP-IMAGE.CUSTOM-FILE-NAME | Communication | PUBLIC | 3.3.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable/disable FTP server generated file name. | Ethernet readers. DM8000 series wireless readers also support FTP if the base station is connected through Ethernet. |
| FTP-IMAGE.FILE-NAME | Communication | PUBLIC | 3.3.0 | SET|GET | string |
File name of FTP image. | Ethernet readers. DM8000 series wireless readers also support FTP if the base station is connected through Ethernet. | ||
| FTP-IMAGE.IP-ADDRESS | Communication | PUBLIC | 3.3.0 | SET|GET | string |
IP address of target FTP server. Uses dotted decimal form, such as "192.168.23.42". |
Ethernet readers. DM8000 series wireless readers also support FTP if the base station is connected through Ethernet. | ||
| FTP-IMAGE.MAX-APPEND | Communication | PUBLIC | 3.3.0 | SET|GET | value |
[0-65535] | Max increment value to append to image name. | Ethernet readers. DM8000 series wireless readers also support FTP if the base station is connected through Ethernet. | |
| FTP-IMAGE.PASSWORD | Communication | PUBLIC | 3.3.0 | SET | string |
Password used to login to target FTP server. | Ethernet readers. DM8000 series wireless readers also support FTP if the base station is connected through Ethernet. | ||
| FTP-IMAGE.SERVER-PATH | Communication | PUBLIC | 3.3.0 | SET|GET | string |
Path for FTP image. | Ethernet readers. DM8000 series wireless readers also support FTP if the base station is connected through Ethernet. | ||
| FTP-IMAGE.USER-NAME | Communication | PUBLIC | 3.3.0 | SET|GET | string |
Username used to login to target FTP server. | Ethernet readers. DM8000 series wireless readers also support FTP if the base station is connected through Ethernet. | ||
| FTP-RESULT.APPEND | Communication | PUBLIC | 3.3.0 | SET|GET | type |
[ON|OFF] |
ON: Append result to existing file. OFF: Overwrite file content with result. |
Append to or overwrite file when result is sent via FTP to the file specified by FTP-RESULT.FILE-NAME. The file will be created if it does not exist. | Ethernet readers. DM8000 series wireless readers also support FTP if the base station is connected through Ethernet. |
| FTP-RESULT.ENABLE | Communication | PUBLIC | 3.3.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable/disable FTP transfer of reader results. | Ethernet readers. DM8000 series wireless readers also support FTP if the base station is connected through Ethernet. |
| FTP-RESULT.FILE-NAME | Communication | PUBLIC | 3.3.0 | SET|GET | string |
File name of FTP result. | Ethernet readers. DM8000 series wireless readers also support FTP if the base station is connected through Ethernet. | ||
| FTP-RESULT.IP-ADDRESS | Communication | PUBLIC | 3.3.0 | SET|GET | string |
IP address of target FTP server. Uses dotted decimal form, such as "192.168.23.42". |
Ethernet readers and MX-1000. DM8000 series wireless readers also support FTP if the base station is connected through Ethernet. | ||
| FTP-RESULT.PASSWORD | Communication | PUBLIC | 3.3.0 | SET | string |
Password used to login to target FTP server. | Ethernet readers. DM8000 series wireless readers also support FTP if the base station is connected through Ethernet. | ||
| FTP-RESULT.USER-NAME | Communication | PUBLIC | 3.3.0 | SET|GET | string |
Username used to login to target FTP server. | Ethernet readers. DM8000 series wireless readers also support FTP if the base station is connected through Ethernet. | ||
| NET-LOCAL.DHCP | Communication | PUBLIC | 3.3.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable/Disable DHCP on reader. | Ethernet readers. |
| NET-LOCAL.DNS-SERVER | Communication | PUBLIC | 3.3.0 | SET|GET | server |
Gets or sets the DNS Server address. | Ethernet readers. | ||
| NET-LOCAL.GATEWAY | Communication | PUBLIC | 3.3.0 | SET|GET | string |
Reader's default gateway IP address. Uses dotted decimal form, such as "192.168.23.1". |
Ethernet readers. | ||
| NET-LOCAL.IP-ADDRESS | Communication | PUBLIC | 3.3.0 | SET|GET | string |
Reader's IP address. Uses dotted decimal form, such as "192.168.23.42". |
Ethernet readers. | ||
| NET-LOCAL.SUBNET-MASK | Communication | PUBLIC | 3.3.0 | SET|GET | string |
Reader's subnet mask. Uses dotted decimal form, such as "192.168.23.255". |
Ethernet readers. | ||
| TELNET.PORT | Communication | PUBLIC | 3.3.0 | SET|GET | value |
[0-65535] | Telnet server TCP port on reader. | Ethernet readers. | |
| TRAIN.FOCUS | Action | PUBLIC | 3.3.0 | state |
[ON|OFF] | enable/disable | Optimize lens focus. | DM503, DM474 and DM300 series readers. | |
| ETHERNET-IP.ENABLED | Communication | PUBLIC | 3.3.0_cr1 | SET|GET | state |
[ON|OFF] | enable/disable | Enabled or disabled EtherNet/IP communications. | Ethernet readers. The DM8000 series wireless readers also support this protocol if the base station is connected through Ethernet. In the case of a Bluetooth connection, the command has to be sent to the base station, not to the reader. |
| NET-LOCAL.TCP-KEEPALIVE | Communication | PRIVATE | 3.3.1 | SET|GET | state |
[ON|OFF] | enable/disable | Enable/Disable TCP keepalive message. | Ethernet readers. |
| NET-LOCAL.TCP-KEEPALIVE-COUNT | Communication | PRIVATE | 3.3.1 | SET|GET | value |
[0-32565] | TCP keep alive retry count. | Ethernet readers. | |
| NET-LOCAL.TCP-KEEPALIVE-IDLE | Communication | PRIVATE | 3.3.1 | SET|GET | value |
[0-32565] | TCP keep alive time. Ethernet readers. |
||
| NET-LOCAL.TCP-KEEPALIVE-INTERVAL | Communication | PRIVATE | 3.3.1 | SET|GET | value |
[0-32565] | TCP keep alive interval. Ethernet readers. |
||
| STATISTICS.RESET | Action | PUBLIC | 3.3.1 | Reset all statistics. | ALL | ||||
| COM.DMCC-CHECKSUM | Communication | PRIVATE | 3.4.0 | SET|GET | type |
[0-3] |
0: none 1: XOR 2: CRC16 (Header/Response) 3: CRC16 (Header/Response/Data) |
Checksum used in DMCC response. | |
| COM.DMCC-HEADER | Communication | PRIVATE | 3.4.0 | SET|GET | type |
[0-1] |
0: default 1: include result ID |
Sets or gets the header option used in Extended mode. | |
| DATA.IMAGE-TYPE | Communication | PRIVATE | 3.4.0 | SET|GET | type |
[0-2] |
0: all 1: no read 2: read |
Sets or gets type of image automatically returned. Used in conjuction with DATA.RESULT-TYPE. | |
| DATABAR.EXPANDED | Symbology | PUBLIC | 3.4.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable Databar expanded. | ALL |
| DATABAR.GROUP | Symbology | PUBLIC | 3.4.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable Databar group. | ALL |
| DATABAR.LIMITED | Symbology | PUBLIC | 3.4.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable Databar limited. | ALL |
| DATAMATRIX.EXTREME-PRINT-GROWTH | Symbology | PUBLIC | 3.4.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable extreme print growth for DataMatrix symbols. | ALL except for DM50, DM60, DM70, DM300, DM503, DM8050 and DM8600. |
| DECODER.PREPROCESS | Decoder | PRIVATE | 3.4.0 | SET|GET | slot filter param1 param2 param3 |
[0] [0-2] [0-255] [0-255] [0-255] |
slot to configure 0: none 1: Equalize 2: Stretch Filter parameter 1. Filter parameter 2. Filter parameter 2. |
Sets or gets the filter to apply to an image before decoding. | |
| DVALID.GS1-FORMAT | Data Validation | PUBLIC | 3.4.0 | SET|GET | string |
GS1 format string | Set GS1 format string. | ALL | |
| EVENT.RULES | IO | PRIVATE | 3.4.0 | SET|GET | rules |
||||
| MULTICODE.HORIZONTAL-REVERSE | Symbology | PUBLIC | 3.4.0 | SET|GET | state |
[ON|OFF] |
ON: sort right to left OFF: sort left to right |
Horizontal positional sorting order priority. | Fixed mount readers. |
| MULTICODE.IDENTICAL-SYMBOLS | Symbology | PUBLIC | 3.4.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enables/disables output of identical symbols when multicode is enabled. | Fixed mount readers. |
| MULTICODE.SORT-PRIORITY | Symbology | PUBLIC | 3.4.0 | SET|GET | symbology image vertical position horizontal position |
[0-3] [0-3] [0-3] [0-3] |
Range for all four arguments indicates sort priority. Must be different for each criteria. |
Sorting order for multicode results: 0 is highest priority, 3 is lowest priority. | Fixed mount readers. |
| MULTICODE.SYMBOLOGY-REVERSE | Symbology | PUBLIC | 3.4.0 | SET|GET | state |
[ON|OFF] |
ON: DotCode, VeriCode ®, Linear/Postal/Stacked, QR Code/MaxiCode/AztecCode, Data Matrix OFF: Data Matrix, QR Code/MaxiCode/AztecCode, Linear/Postal/Stacked, VeriCode ®, DotCode |
Symbology sorting order preference. | Fixed mount readers. |
| MULTICODE.VERTICAL-REVERSE | Symbology | PUBLIC | 3.4.0 | SET|GET | state |
[ON|OFF] |
ON: sort bottom to top OFF: sort top to bottom |
Vertical position sorting order preference. | Fixed mount readers. |
| NET-LOCAL.PORT | Communication | PUBLIC | 3.4.0 | SET|GET | port |
[1-65535] | Setup Tool server TCP port on reader. | Ethernet readers. | |
| PHARMA.CODE-ORIENTATION | Symbology | PUBLIC | 3.4.0 | SET|GET | direction |
[0-2] |
0: Any (default) 1: Horizontal 2: Vertical |
Preferred orientation for decoding Pharmacode symbols. | ALL |
| PHARMA.CODESIZE | Symbology | PUBLIC | 3.4.0 | SET|GET | any min max |
[ON|OFF] [1-6] [1-6] |
any length code minimum code length maximum code length |
Expected Pharmacode size. | ALL |
| PHARMA.HORIZONTAL-DIRECTION | Symbology | PUBLIC | 3.4.0 | SET|GET | direction |
[0-1] |
0: left-to-right (default) 1: right-to-left |
Horizontal direction preference for decoding Pharmacode symbols. | ALL |
| PHARMA.SUPPLEMENTARY | Symbology | PRIVATE | 3.4.0 | SET|GET | state |
[ON|OFF] | enable/disable | Get or set whether supplementary component is expected. | ALL |
| PHARMA.SUPPLEMENTARY-GAP-THRESH | Symbology | PRIVATE | 3.4.0 | SET|GET | gap |
[100-300] | Get or set the Pharmacode supplementary gap threshold in pixels. | ALL | |
| PHARMA.VERTICAL-DIRECTION | Symbology | PUBLIC | 3.4.0 | SET|GET | direction |
[0-1] |
0: top-to-bottom (default) 1: bottom-to-top |
Vertical direction preference for decoding Pharmacode symbols. | ALL |
| SYMBOL.4STATE-IMB | Symbology | PUBLIC | 3.4.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable 4-State Intelligent Mail Barcode. | ALL except for DM150QL, DM260QL, DM300L, DM503L, and DM503QL. |
| SYMBOL.DATABAR | Symbology | PUBLIC | 3.4.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable Databar. It will enable EXPANDED and LIMITED in Manatee Works SDK (just like MX). | ALL |
| DATAMATRIX.ALGORITHM-VERSION | Symbology | PUBLIC | 3.5.3 | SET|GET | version |
[0-2] |
0: speed preferred 1: yield preferred 2: extended |
IDQuick Usage Type. | Fixed mount readers except for DM300L, DM503L, and DM503QL. 2 (extended) is supported by DM50, DM60, DM70, DM150, DM260. |
| FOCUS.SWEEP-RANGE | Camera | PUBLIC | 3.6.0 | SET|GET | DM8000 DM300 |
[0-500] [0-500] [40-500] [40-500] |
low sweep range high sweep range low sweep range high sweep range |
Defines the sweep range to be used for focusing. Low must be less than high. The low value is ignored if FOCUS.SWEEP-STEPS is set to 0. | DM70, DM260, DM300 series, DM474 and DM8000 series readers. |
| FOCUS.SWEEP-STEPS | Camera | PUBLIC | 3.6.0 | SET|GET | value |
[0-8] | number of steps to divide the sweep range | Sets the number of steps the sweep range should be divided by. If steps is set to 0 only the high sweep range value is used. | DM70, DM260, DM474, DM8000 series and DM300 series readers. |
| TRIGGER | Action | PUBLIC | 3.6.0 | GET | state |
[0|1] |
0: Off 1: On |
Get current state of the trigger. | ALL |
| CAMERA.INTERVAL-US | Camera | PUBLIC | 4.0.0 | SET|GET | us |
[*-1000000] |
Microseconds. Step size is 250. * By default the minimum range is 6000 but this can change depending on decode timeout and field of view. |
Acquisition Interval, the time between successive camera acquisitions in microseconds. Supported with Burst, Self, and Continuous trigger types. | DM50, DM60, DM70, DM474, DM503, and DM300 series readers. |
| CAMERA.MAX-EXPOSURE-US | Camera | PUBLIC | 4.0.0 | SET|GET | exposure |
[1-50] [1-410] [1-100000] |
with HPIA without HPIA with external or no illumination |
Maximum exposure limit in microseconds for autoregulation. HPIA = High Powered Illumination Accessory. |
DM70, DM150, DM260, DM474, DM503, and DM300 series readers. |
| FOCUS.DISTANCE | Camera | PUBLIC | 4.0.0 | SET|GET | int |
Distance in mm from the front of the camera to the part. This command returns the value only if Focus Steps is set to 0, otherwise you need to use FOCUS.SWEEP-RANGE instead. |
DM300 series readers, DM474. | ||
| FOCUS.FAST-DELAY | Camera | PRIVATE | 4.0.0 | SET|GET | value |
??? | |||
| FOCUS.FOCUS-TIME | Camera | PRIVATE | 4.0.0 | SET|GET | value |
[0-3] | |||
| FOCUS.RELAX-TIME | Camera | PRIVATE | 4.0.0 | SET|GET | value |
??? | |||
| FOCUS.STRATEGY | Camera | PRIVATE | 4.0.0 | SET|GET | value |
??? | |||
| FTP-IMAGE.MAX-APPEND-START-VALUE | Communication | PUBLIC | 4.0.0 | SET|GET | value |
[0-65535] | Initial increment value to append to image name. | DM503 | |
| FTP-IMAGE.PORT | Communication | PUBLIC | 4.0.0 | SET|GET | port |
[0-65535] | FTP server port number. | Ethernet readers. DM8000 series wireless readers also support FTP if the base station is connected through Ethernet. | |
| FTP-RESULT.PORT | Communication | PUBLIC | 4.0.0 | SET|GET | port |
[0-65535] | FTP server port number. | Ethernet readers. DM8000 series wireless readers also support FTP if the base station is connected through Ethernet. | |
| IMAGE.LOAD-FTP-MULT-PARAM | Camera | PRIVATE | 4.0.0 | ??? | |||||
| IMAGE.LOAD-FTP-PARAM | Camera | PRIVATE | 4.0.0 | ??? | |||||
| IMAGEBUFFER.ALLOW-OVERWRITE | RecordPlayback | PUBLIC | 4.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Allow buffered images that have not been transfered to be overwritten if all available buffers are used and new images arrive. | DM50, DM60, DM70, DM474, DM503, DM300 series readers, DM8050 and DM8600. |
| IMAGEBUFFER.DELETE | RecordPlayback | PUBLIC | 4.0.0 | Release stored images. | DM50, DM60, DM70, DM474, DM503, DM300 series readers, DM8050 and DM8600. | ||||
| IMAGEBUFFER.DELETE-AFTER-TRANSFER | RecordPlayback | PUBLIC | 4.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Release stored images automatically after image has been transfered. | DM50, DM60, DM70, DM474, DM503, DM300 series readers, DM8050 and DM8600. |
| IMAGEBUFFER.MAX-NUM | RecordPlayback | PUBLIC | 4.0.0 | SET|GET | size |
[0-*] | Maximum number of images that can be buffered. * Range varies depending depending on Camera ROI and memory allocated for burst length. |
DM50, DM60, DM70, DM474, DM503, DM300 series readers, DM8050 and DM8600. | |
| IMAGEBUFFER.NO-READ-IMAGE-PERIOD | RecordPlayback | PUBLIC | 4.0.0 | SET|GET | interval |
[1-200] | Sets or gets the interval to save the image of a bad read. If, for example, you use an interval of 6, the first bad image is saved and the next 5 are not. The default is 1 which saves each bad read image. | DM50, DM60, DM70, DM474, DM503, DM300 series readers, only in Single, Burst, Self and Continuous modes. | |
| IMAGEBUFFER.NUM | RecordPlayback | PUBLIC | 4.0.0 | GET | size |
Returns the number of currently buffered images. | DM50, DM60, DM70, DM474, DM503, DM300 series readers, DM8050 and DM8600. | ||
| IMAGEBUFFER.QUALITY | RecordPlayback | PUBLIC | 4.0.0 | SET|GET | quality |
[10, 15, 20... 85, 90] | JPEG Quality | DM50, DM60, DM70, DM474, DM503, MX-1000, DM8000 series and DM300 series readers. | |
| IMAGEBUFFER.RECORD | RecordPlayback | 4.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable or disable image buffereing. obsolete in 4.0.0. |
Fixed mount readers, DM8050 and DM8600. | |
| IMAGEBUFFER.RECORD-TYPE | RecordPlayback | PUBLIC | 4.0.0 | SET|GET | type |
[0-5] |
0: None 1: No-Read 2: Read 3: All 4: Validation Failure 5: No-Read + Validation failure |
Sets or gets the type of image to buffer. In case of No-Read, the image is buffered if the reader fails to read. |
DM50, DM60, DM70, DM474, DM503, MX-1000, DM8000 series and DM300 series readers. |
| IMAGEBUFFER.SEND-FTP | RecordPlayback | PUBLIC | 4.0.0 | Transmit buffered images to designated FTP server. | DM60, DM474, DM503, DM8000 series and DM300 series readers. | ||||
| IMAGEBUFFER.SEND-FTP-PARAM | RecordPlayback | PRIVATE | 4.0.0 | Transmit buffered images to designated FTP server. | Fixed mount Ethernet readers, DM8050 and DM8600. | ||||
| IMAGEBUFFER.SIZE | RecordPlayback | PUBLIC | 4.0.0 | SET|GET | size |
[0-3] |
0: Full 1: 1/4 2: 1/16 3: 1/64 |
DM50, DM60, DM70, DM474, DM503, MX-1000, DM8000 series and DM300 series readers. | |
| IMAGEBUFFER.TRANSFER-MODE | RecordPlayback | PUBLIC | 4.0.0 | SET|GET | interval |
[0-1] |
0: On Request 1: FTP - runtime |
Sets or gets whether buffered images should automatically sent FTP or if they should be send only after requested. | DM60, DM70, DM474, DM503, MX-1000, DM8000 series, and DM300 series readers and DM260. |
| INPUT.ACTION | IO | PUBLIC | 4.0.0 | SET|GET | line action state |
[0-3] [0-11] [ON|OFF] |
Input line number 0: Train Code 1: Optimize Brightness 2: Set Match String 3: Optimize Focus 4: Read Configuration Code 5: Trigger Off 6: Encoder 7: Allow Buffered No-Read Images 8: Clear Outputs 9: Tune (DM300 only) 10: Encoder direction 11: Trigger on ON: execute action when line is triggered OFF: no action |
Sets or gets the state for the specified line action. The input actions "Train Code," "Optimize Brightness," "Set Match String," and "Read Configuration Code" are carried out only after the next trigger. |
Fixed-mount readers. |
| MASTER-SLAVE.GROUP-NAME | Communication | PUBLIC | 4.0.0 | SET|GET | name |
Gets or sets the name of the master slave group. | DM60, DM474, DM503, and DM300 series readers. | ||
| MASTER-SLAVE.MODE | Communication | PUBLIC | 4.0.0 | SET|GET | mode |
[0-2] |
0: OFF 1: ON 2: Master |
Switches the master-slave functioning of the reader on or off. | DM60, DM474, DM503, and DM300 series readers. |
| MASTER-SLAVE.TIMEOUT | Communication | PUBLIC | 4.0.0 | SET|GET | milliseconds |
[0-10000] | Gets or sets the time to wait for results from slave cameras. | DM60, DM474, DM503, and DM300 series readers. | |
| MQA.POSTAL-MODE | Code Quality | PRIVATE | 4.0.0 | SET|GET | mode |
[0-2] |
0: Off 1: Partial Metrics 2: All Metrics |
Gets or sets the postal verification mode. | ALL |
| TRIGGER.DEBOUNCE-DELAY | IO | PUBLIC | 4.0.0 | SET|GET | delay |
[0-6] |
0: short 1: 2: default 3: 4: 5: 6: long |
Sets or gets how long the trigger signal must be detected in order to be recognized as valid. | Fixed-mount readers. |
| TRIGGER.POLARITY | IO | PUBLIC | 4.0.0 | SET|GET | line polarity |
[0-3] [ON|OFF] |
Input line ON: Rising edge OFF: Falling edge |
Sets or gets the polarity at which an input will be triggered. | Fixed mount readers. |
| VSOC.ACCELERATION | Decoder | PRIVATE | 4.0.0 | SET|GET | enable |
[ON|OFF] | enable/disable | Enabled or disable VSOC acceleration. | |
| VSOC.LEGACY-AUTO-REG | Camera | PRIVATE | 4.0.0 | SET|GET | enable |
[ON|OFF] | enable/disable | Enabled or disable VSOC auto-regulation algorithm. | |
| DECODER.1D-SYMBOL-ORIENTATION | Decoder | PUBLIC | 4.1 | SET|GET | orientation |
[0-3] |
0: Omnidirectional 1: Ladder and Picket Fence (default) 2: Ladder 3: Picket Fence |
Sets or gets the orientation at which codes can be found. Omnidirectional requires the Omnidirectional feature key. | DM50, DM60, DM70, DM474, DM503, MX-1000, MX-1502 and DM300 series readers. DM503L readers support only 2: Ladder and 3: Picket Fence. |
| ENCODER.COUNT | IO | PUBLIC | 4.1.0 | SET|GET | value |
[0-2 billion] | value to set | Gets the encoder count or sets it to the specified value. | Fixed-mount readers |
| ENCODER.DISTANCE-TO-OUTPUT | IO | PUBLIC | 4.1.0 | SET|GET | int |
0-1000000 mm |
Default: 0 Min: 0 Max: 1000000 Step: 1 |
Sets the output distance from the trigger on the sensor. | DM300 series readers, DM474. |
| ENCODER.FLUSH | IO | PUBLIC | 4.1.0 | Flushes all encoder actions. | DM474, DM503 and DM300 series readers. | ||||
| ENCODER.RESOLUTION | IO | PUBLIC | 4.1.0 | SET|GET | int |
0-1000000 um |
Default: 5000 Min: 0 Max: 1000000 Step: 1 |
Sets the distance per pulse of the encoder. | DM474, DM503, and DM300 series readers. |
| LIGHT.EXTERNAL-ENABLE | Camera | PUBLIC | 4.1.0 | SET|GET | enable |
[ON|OFF] | enable/disable | Enable external illumination supported by I/O. | Fixed mount readers. |
| LIGHT.INTERNAL-ENABLE | Camera | PUBLIC | 4.1.0 | SET|GET | enable |
[ON|OFF] | enable/disable | Enable the built-in internal illumination. Default value is OFF. | DM50, DM60, DM70, DM8050, MX-1000, MX-1502, Mobile. |
| LIGHTCURTAIN.BEAM-SPACING | IO | PUBLIC | 4.1.0 | SET|GET | spacing |
[1-300000] | micrometers | Distance (in um) between beams of the Light Curtain. This determines the resolution of the light curtain. | DM503 |
| MASTER-SLAVE.RX-HEIGHT-SENSOR | Camera | PUBLIC | 4.1.0 | SET|GET | enable |
[ON|OFF]* | enable/disable | Enables or disables this system receiving height information from another system in the network group. | DM60, DM474 and DM300 series readers. |
| OUTPUT-QUEUE.FLUSH | IO | PUBLIC | 4.1.0 | int |
[0-1] |
0: throw output away 1: send all output now |
To flush or send all output. | DM474, DM503, and DM300 series readers. | |
| COM.COMMUNICATIONS-MODULE | Communication | PUBLIC | 4.2.0 | GET | type |
[0-3] |
0: Serial 1: Ethernet 2: Wireless 3: Bluetooth |
Returns the type of communication module being used. | MX-1000 and DM8000 series readers. |
| COM.DMCC-EVENT | Communication | PRIVATE | 4.2.0 | SET|GET | event_mask |
[0-255] bitfield |
0: none 1: reader online/offline |
Sets which events are sent over DMCC. Used by DataMan SDK. | Wireless readers, base station. |
| COM.USB-TEST-SN | Communication | PRIVATE | 4.2.0 | SET|GET | string |
test serial number | Used by manufacturing to make different devices enumerate on the same CDC COM port. | Base station, DM50, DM60 and DM70. | |
| COM.USB-USE-TEST-SN | Communication | PRIVATE | 4.2.0 | SET|GET | state |
[ON|OFF] [ON|OFF] | enable/disable | Used by manufacturing to make different devices enumerate on the same CDC COM port. | Base station, DM50, DM60 and DM70. |
| CONTROL.RPC | Action | PRIVATE | 4.2.0 | SET|GET | string |
RP code to execute. | Executes RP codes passed as string. Used internally to route RP commands to the base station. | ALL | |
| DEVICE.SSID | Communication | PUBLIC | 4.2.0 | SET|GET | string |
Network name. | Wireless readers. | ||
| FTP-PROXY.CONNECT | Communication | PRIVATE | 4.2.0 | index |
[0-15] | FTP object index as returned by FTP-PROXY.CREATE | Used by wireless readers to proxy FTP transfer through base station. | Base station. | |
| FTP-PROXY.CREATE | Communication | PRIVATE | 4.2.0 | user pass server port type |
dotted decimal from IPv4 address [1-65535] [0-1] |
Password. Target FTP server address. Target FTP port number. Target FTP server type (Generic/Mitsubishi). |
Used by wireless readers to proxy FTP transfer through base station. | Base station. | |
| FTP-PROXY.DESTROY | Communication | PRIVATE | 4.2.0 | index |
[0-15] | FTP object index as returned by FTP-PROXY.CREATE | Used by wireless readers to proxy FTP transfer through base station. | Base station. | |
| FTP-PROXY.DISCONNECT | Communication | PRIVATE | 4.2.0 | index |
[0-15] | FTP object index as returned by FTP-PROXY.CREATE | Used by wireless readers to proxy FTP transfer through base station. | Base station. | |
| FTP-PROXY.EXECUTE | Communication | PRIVATE | 4.2.0 | index type path length data |
[0-15] [0-15] [0-15] [0-3] [0-3] |
FTP object index as returned by FTP-PROXY.CREATE FTP transfer type (STOR/STOU/APPE/RETR) File path for FTP transfer Data length Data |
Used by wireless readers to proxy FTP transfer through base station. | Base station. | |
| NET-LOCAL.READER-IP-ADDRESS | Communication | PUBLIC | 4.2.0 | SET|GET | string |
dotted decimal form IPv4 address | Base station's IP address. Uses dotted decimal form, such as "192.168.23.42". |
Base stations. | |
| COM.BUFFER-AUTO-FLUSH | Communication | PUBLIC | 4.2.1 | SET|GET | state |
[ON|OFF] | enable/disable | Determines if the whole content of the offline buffer is automatically flushed to the first Telnet client. If not, flushing must be activated by the client. | Wireless readers. |
| COM.BUFFER-DATA | Communication | PUBLIC | 4.2.1 | SET|GET | state |
[ON|OFF] | enable/disable | Offline buffering. | Wireless readers. |
| COM.BUFFER-RESET | Action | PUBLIC | 4.2.1 | Clears the content of the offline buffer. | DM8050, DM8600 and MX-1000. | ||||
| COM.BUFFER-START-SEND | Action | PUBLIC | 4.2.1 | Valid if auto-flush is off. Activates buffer data output over Telnet channels (and flushes buffered codes). Data output is stopped every time when all Telnet channels are disconnected. | DM8050, DM8600 and MX-1000. | ||||
| COM.RS232-ROUTE | Communication | PUBLIC | 4.2.1 | SET|GET | value |
[0-1] |
0: base station 1: associated reader |
Controls to which device RS-232 communication is routed. | DM8000 series wireless readers. |
| COM.USB-MODE | Communication | PUBLIC | 4.2.1 | SET|GET | type |
[0-1] |
0: USB COM 1: USB HID |
Controls USB based communication channels. | DM50, DM60, DM70, MX-1000, MX-1502 and DM8000 series readers. |
| COM.USB-SPEED | Communication | PUBLIC | 4.2.1 | SET|GET | int |
[ON|OFF] |
ON: USB 1.1 mode OFF: USB 2.0 mode |
Forces the USB into full speed mode. | Every reader connected through USB except MX-1000. |
| LIGHT.AIMER-TIMEOUT | Camera | PUBLIC | 4.2.1 | SET|GET | int |
[0-600] | seconds | Aimer Timeout in seconds. | MX-1000 and DM8000 series readers. |
| POWER.HIBERNATE-DISABLE | System | PUBLIC | 4.2.1 | SET|GET | state |
[ON|OFF] | enable/disable | Turning the Hibernation feature on or off. ON means that the device never hibernates. OFF means that Hibernation is not disabled (it is enabled), thus the device will go into hibernation mode. | DM8000 wireless readers. |
| POWER.HIBERNATE-TIMEOUT | System | PUBLIC | 4.2.1 | SET|GET | int |
[1-600] | seconds | Hibernation timeout. | DM8000 wireless readers. |
| POWER.POWEROFF-DISABLE | System | PUBLIC | 4.2.1 | SET|GET | state |
[ON|OFF] | enable/disable | Turning the Power Off feature on or off. ON means that the device never turns off. OFF means that Power Off is not disabled (it is enabled), thus the device will turn off. | DM8050, DM8600, MX-1000 and MX-1502. |
| POWER.POWEROFF-TIMEOUT | System | PUBLIC | 4.2.1 | SET|GET | int |
[1-600] | seconds | Power Off timeout. | DM8050, DM8600, MX-1000 and MX-1502. |
| COM.BUFFER-MODE | Communication | PUBLIC | 4.2.2 | SET|GET | int |
[0-1] |
0: Multiple 1: Single |
Sets or gets the offline buffering mode. | Wireless DM8000 readers. |
| WIFI.AUTH-MODE | Communication | PUBLIC | 4.2.4 | SET|GET | int |
[0-3] |
0 – no auth 1 – WPA-PSK 2 – WPA2-PSK 3 – EAP/TLS 4 – PEAP-MSCHAPV2 |
Sets the authentication method. | DM8000 |
| WIFI.CA-CERT | Communication | PUBLIC | 4.2.4 | SET|GET | string |
NA | Used In WPA-Enterprise. This is the certificate of the certification authority we trust. | PEM formatted certificate, terminated by a space. | DM8000;Base |
| WIFI.CHANNEL | Communication | PUBLIC | 4.2.4 | SET|GET | int |
[1-11] | Sets the wifi channel number. | ||
| WIFI.CLIENT-CERT | Communication | PUBLIC | 4.2.4 | SET|GET | string |
NA | Used in WPA-Enterprise (EAP-TLS). This is the certificate of the reader signed by the trusted CA (set with the previous command). | PEM formatted certificate, terminated by a space. | DM8000;Base |
| WIFI.CLIENT-IDENTITY | Communication | PUBLIC | 4.2.4 | SET|GET | string |
NA | The identity the client certificate is issued to. | DM8000;Base | |
| WIFI.CLIENT-PRIVATE-KEY | Communication | PUBLIC | 4.2.4 | SET|GET | string |
NA | Used in WPA-Enterprise (EAP-TLS). The private key of the reader. | PEM formatted private key, terminated by a space. | DM8000;Base |
| WIFI.ENABLED | Communication | PUBLIC | 4.2.4 | SET|GET | state |
[ON|OFF] | enable/disable | Enables or disables wifi in ad-hoc mode. | |
| WIFI.ENC-METHOD | Communication | PUBLIC | 4.2.4 | SET|GET | int |
[0-5] |
0 – off 1 – WEP40 2 – WEP104 3 – TKIP 4 – AES 5 – TKIP/AES |
Sets the authentication method. | DM8000;Base |
| WIFI.NETWORK-TYPE | Communication | PUBLIC | 4.2.4 | SET|GET | int |
[0-1] |
0 – Infrastructure mode 1 – AD-HOC mode |
Sets whether wifi works in infrastructure or ad-hoc mode. | DM8000 |
| WIFI.PASSPHRASE | Communication | PUBLIC | 4.2.4 | SET|GET | string |
NA | In WEP encrpytion and in WPA(2)-PSK it is the passphrase set by the AP. | DM8000;Base | |
| WIFI.SSID | Communication | PUBLIC | 4.2.4 | SET|GET | string |
NA | Assigns an SSID name to the network. | ||
| FILTER.IMAGE-TO-USE-SYMBOL | Decoder | PUBLIC | 4.3.0 | SET|GET | symbology input |
[1-5] [0-1] |
1: DataMatrix 2: QR Code/MaxiCode/AztecCode 3: Linear/ Postal/ Stacked 4: VeriCode® 5: DotCode 0: original image 1: filtered image |
Sets or gets which type of symbology should be filtered or not. AztecCode is only supported on the DM503 and DM300 series readers. |
DM50, DM60, DM70, DM150, DM260, DM300 series readers, DM474. |
| FILTER.NOREAD-IMAGE | Decoder | PUBLIC | 4.3.0 | SET|GET | symbology |
[0-5] |
0: Any 1: DataMatrix 2: QR Code/MaxiCode/AztecCode 3: Linear/ Postal/ Stacked 4: VeriCode® 5: DotCode |
Sets or gets if the symbology selected should be filtered if the image is no-read. AztecCode is only supported on the DM503 and DM300 series readers. |
DM50, DM60, DM70, DM150, DM260, DM300 series readers, DM474. |
| FILTER.STACK | Decoder | PUBLIC | 4.3.0 | SET|GET | step method value1 value2 value3 |
[1-4] [0-11] [0-255] |
Filter step 0: no filtering 1: equalize 2: stretch 3: low pass 4: dilate 5: erode 6: open 7: close 8: auto stretch 9: optical density 10: invert 11: median method parameter |
The first value sets the order of the filter steps. Filter step 1 is the first step, filter step 2 is the second, and so on. The second value sets the filter to be used. The third value means the additional properties that you can set for the given filter. You cannot configure the whole stack with one statement, but each on its own.The following example: SET FILTER.STACK 2 2 0 100 0 sets the second step in the filter, for stretch from 0 to 100, leaving the third value unused (0).The following example: GET FILTER.STACK 3 (for the third filter) returns 5 4 3 meaning that filter number 5, that is, erode is on, with parameters 4, 3. | DM50, DM60, DM70, DM150, DM260, DM300 series readers, DM474. |
| FOCUS.FEEDBACK | Camera | PUBLIC | 4.3.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enables focus feedback. | DM474, DM503 and DM300 series readers. |
| TUNE.ADJUST-FOCUS | Camera | PUBLIC | 4.3.0 | SET|GET | state |
[ON|OFF] | Enables or disables using adjusting focus while tuning. | DM70, DM150, DM260, DM474 and DM300 series readers with liquid lens. | |
| TUNE.CANCEL | Action | PUBLIC | 4.3.0 |
|
0: Tuning is cancelled. 104: Tuning is not running or there is an error. 101: Tuning is not available. |
Cancel tuning. | DM300 series readers, DM474, DM70, DM260, and DM150. | ||
| TUNE.START | Action | PUBLIC | 4.3.0 |
|
0: Tuning started. 104: Tuning is already running or there is an error. 101: Tuning is not available. |
Start tuning. | DM300 series readers, DM474, DM70, DM260, and DM150. | ||
| TUNE.TRAIN-CODE | Camera | PUBLIC | 4.3.0 | SET|GET | state |
[ON|OFF] | Enables or disables code training while tuning. | DM300 series readers, DM474, DM70, DM260, and DM150. | |
| TUNE.TUNE-LIGHT-BANKS | Camera | PUBLIC | 4.3.0 | SET|GET | state |
[ON|OFF] | Enables or disables using light banks while tuning. Only available when internal illumination is used. |
DM300 series readers, DM474, DM260, DM70 and DM150. | |
| BATTERY.CHARGE | System | PUBLIC | 4.4.0 | GET | int |
[0-100] | Displays, in percentage, current battery level. | MX-1000 and DM8000 series readers. | |
| CONFIG.LOAD | Action | PUBLIC | 4.4.0 | num-bytes |
Load Configuration from communication channel. Make sure you use a robust communications channel (for example, Ethernet) because this command does not have error checking or retry support and might cause the device to hang. | ALL | |||
| DECODER.REREAD-MODE | Decoder | PUBLIC | 4.4.0 | SET|GET | mode |
[0-1] |
0: last read 1: first read |
Code re-reading delay relative to either the first read or the last. | DM50, DM60, DM70, DM474, DM503, DM300 series readers, DM8050 and DM8600. |
| DECODER.REREAD-TIME | Decoder | PUBLIC | 4.4.0 | SET|GET | ms |
[0-10000] | Milliseconds | Code re-reading delay in milliseconds. | ALL |
| DEVICE.LOG | Action | PUBLIC | 4.4.0 | GET | Get the device log of error and exception conditions such as missed triggers and trigger overruns. | DM50, DM60, DM70, DM474, DM503, DM300 series readers, DM8050 and DM8600. | |||
| DMCC.RESET | Action | PUBLIC | 4.4.0 | When sent, the DMCC resets the following DMCC back to default: COM.DMCC-RESPONSE, COM.DMCC-CHECKSUM, COM.DMCC-HEADER, DATA.RESULT-TYPE, DATA.RESULT-ENCODING, DATA.RESULT-ALWAYSSEND, DATA.IMAGE-TYPE. | ALL | ||||
| DMCC.SAVE | Action | PUBLIC | 4.4.0 | Saves DMCC connection settings. It also saves the status for a new connection session for the following DMCC: COM.DMCC-RESPONSE, COM.DMCC-CHECKSUM, COM.DMCC-HEADER, DATA.RESULT-TYPE, DATA.RESULT-ENCODING, DATA.RESULT-ALWAYSSEND, DATA.IMAGE-TYPE. | ALL | ||||
| DVALID.MATCH-STRING-EMPTY-RESULT | Data Validation | PRIVATE | 4.4.0 | SET|GET | action |
[0-1] |
0: empty match string fails 1: empty match string passes |
Gets or sets if a match string validation attempt with an empty match string should fail (0=default) or pass (1). | ALL |
| DVALID.PROG-TARG | Data Validation | PUBLIC | 4.4.0 | SET|GET | category |
[1-5] |
1: DataMatrix 2: QR Code/MaxiCode/AztecCode 3: Linear/ Postal/ Stacked 4: VeriCode® 5: DotCode |
Data Validation Programming Target. Data Validation Symbology Set to be modified by subsequent commands. Once issued, this command changes the subsequent behavior of the reader. |
ALL |
| FTP.LOG | Action | PRIVATE | 4.4.0 | GET | Get the FTP log of FTP control connection commands and replies in case of FTP problems. | ALL | |||
| IMAGE.QUALITY | Camera | PUBLIC | 4.4.0 | SET|GET | quality |
[10, 15, 20... 85, 90] | JPEG Quality | Quality of the jpeg image. | ALL |
| IMAGE.SIZE | Camera | PUBLIC | 4.4.0 | SET|GET | size |
[0-3] |
0: Full 1: 1/4 2: 1/16 3: 1/64 |
Image Size. | ALL |
| LIGHT.DIRECT | Camera | PUBLIC | 4.4.0 | SET|GET | north east south west NORTH EAST SOUTH WEST |
[ON|OFF]
[ON|OFF] [ON|OFF] [ON|OFF] [ON|OFF] [ON|OFF] [ON|OFF] [ON|OFF] |
enable/disable
enable/disable enable/disable enable/disable enable/disable enable/disable enable/disable enable/disable |
Sets the quadrants on the DM300. Small letters refer to the inner, capital letters to the outer circle, possible values are ON and OFF for each segment. Example for a SET command: SET LIGHT.DIRECT ON OFF ON ON OFF OFF OFF OFF if you want to have the inner north, south, and west lights on. | DM300 series readers, DM474. |
| OUTPUT.DELAY-DISTANCE | Decoder | PUBLIC | 4.4.0 | SET|GET | millimeters |
[0-100000] | Distance to output when using the Encoder. | DM474, DM503, and DM300 series readers. | |
| OUTPUT.DELAY-REFERENCE | Decoder | PUBLIC | 4.4.0 | SET|GET | mode |
[0-1] |
0: Trigger Start 1: Trigger End |
Sets or gets whether output is delayed relative to trigger start or trigger end. | DM50, DM60, DM70, DM474, DM503, and DM300 series readers. |
| OUTPUT.DELAY-TIME | Decoder | PUBLIC | 4.4.0 | SET|GET | milliseconds |
[0-10000] | Output delay in milliseconds. | DM50, DM60, DM70, DM503, DM300 series readers, DM474. | |
| OUTPUT.DELAY-TYPE | Decoder | PUBLIC | 4.4.0 | SET|GET | mode |
[0-1] |
0: None 1: Time |
Sets or gets whether output is delayed, and if so, whether according to time. | DM50, DM60, DM70, DM300 series readers, DM474. |
| OUTPUT.DELAY-TYPE | Decoder | PUBLIC | 4.4.0 | SET|GET | mode |
[0-2] |
0: None 1: Time 2: Distance |
Sets or gets whether output is delayed, and if so, whether according to time or distance. | DM503 |
| PHARMA.MAX-LENGTH | Symbology | PRIVATE | 4.4.0 | SET|GET | length |
[1-6] | Gets or sets the maximum length for a Pharmacode. Obsoleted in 5.1. |
ALL | |
| PHARMA.MIN-LENGTH | Symbology | PRIVATE | 4.4.0 | SET|GET | length |
[1-6] | Gets or sets the minimum length for a Pharmacode. Obsoleted in 5.1. |
ALL | |
| RSS.EXPANDED | Symbology | PUBLIC | 4.4.0 | SET|GET | state |
[ON|OFF] | enable/disable | RSS Expanded. | ALL |
| TRAINED-CODE.INFO | Symbology | PUBLIC | 4.4.0 | GET | Gets information about the currently trained code type ('Untrained' if no code is trained). | Fixed mount devices. | |||
| TRIGGER.DELAY-DISTANCE | Camera | PUBLIC | 4.4.0 | SET|GET | millimeter |
[0-2147483646] | Delay camera acquisition by distance specified in millimeters. | DM503, DM474 and DM300 series readers. | |
| TRIGGER.DELAY-TIME | Camera | PUBLIC | 4.4.0 | SET|GET | milliseconds |
[0-10000] | Trigger delay in milliseconds. Delay camera acquisition by specified number of milliseconds. |
DM50, DM60, DM70, DM474, DM503, and DM300 series readers. | |
| TRIGGER.DELAY-TYPE | Camera | PUBLIC | 4.4.0 | SET|GET | mode |
[0-1] |
0: none 1: time |
Sets or gets whether trigger delay is according to time. | DM50, DM60 and DM70 |
| TRIGGER.DELAY-TYPE | Camera | PUBLIC | 4.4.0 | SET|GET | mode |
[0-2] |
0: none 1: time 2: distance |
Sets or gets whether trigger delay is according to time or distance. | DM503, DM474 and DM300 series readers. |
| TRIGGER.END-DELAY-DISTANCE | Camera | PUBLIC | 4.4.0 | SET|GET | millimeters |
[0-2147483646] | Sets or gets trigger end delay distance. | DM474, DM503 and DM300 series readers. | |
| TRIGGER.END-DELAY-TIME | Camera | PUBLIC | 4.4.0 | SET|GET | milliseconds |
[0-10000] | Sets or gets trigger end delay time. | DM50, DM60, DM70, DM474, DM503, and DM300 series readers. | |
| INPUT-STRING.ENABLE | Data Formatting | PRIVATE | 4.4.0_cr10 | SET|GET | state |
[ON|OFF] | enable/disable | Enables or disables the use of the Input String feature (available for serial, telnet, NetworkClient). When enabled, a header and the footer can be set by the INPUT-STRING.HEADER and INPUT-STRING.FOOTER commands, respectively. A string of characters can be given between the header and the footer, which will be sent with the formatted output (for example, [hello world], if the header is set to ’[’ and the footer to ’]’). Since the input string is saved temporarily, it appears only in the next result output. Use Setup Tool (the <Input String> option) or <ISTR> with DMCC (see SET FORMAT.TOKEN) to allow Input string in the result output. | ALL |
| ERROR-LED.ENABLE | Action | PRIVATE | 4.4.0_cr1_sr1 | SET|GET | state |
[ON|OFF] | enable/disable | Enables/disables error log LED. | DM300 series readers. |
| IMAGEBUFFER.NO-READ-INDEX | RecordPlayback | PRIVATE | 4.4.0_cr2 | SET|GET | index |
0 is the default behavior to send all as selected; 1 – max burst is send only the index selected. | DM474, DM300 series readers, DM8050 and DM8600. | ||
| LVHSTS.ENABLED | Communication | PRIVATE | 4.4.1_cr6_sr2 | SET|GET | state |
[ON|OFF] | enable/disable | Enable or disable the USPS Lehigh Valley HSTS protocol. | DM300 series readers, DM474. |
| MQA.POSTAL-HEIGHT_MICRON | Code Quality | PRIVATE | 4.4.1_cr7 and 5.0.0_cr6 | SET|GET | height |
Height in microns per pixel for MERLIN metrics. | DM300 series readers, DM474. | ||
| BUTTON.SAVE-MATCH-STRING | Communication | PUBLIC | 4.5.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enables or disables saving the trained match string directly to flash when Set Match String is enabled for the 3 sec button press action. If disabled, the match string is only stored in RAM and if the configuration is not saved manually it will be gone after reboot. | DM474, DM503, and DM300 series readers. |
| DATAMATRIX.QUALITY-METRICS | Decoder | PUBLIC | 4.5.0 | SET|GET | type |
[0-3] |
0: none 1: AIM DPM 2: ISO 15415 3: SEMI T10 |
Code quality metrics for DataMatrix. | ALL |
| ERROR-LED.ENABLE | Action | PRIVATE | 4.5.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enables/disables error log LED. | DM50, DM60, DM70, DM503, DM474 and DM300 series readers. |
| FILE.LOAD | Action | PRIVATE | 4.5.0 | This command can be used to upload a file into DataMan flash filesystem. It should be specified as 'FILE.LOAD "Length" "Filename"'. This DMCC is password-protected. |
ALL | ||||
| FORMAT.MODE | Data Formatting | PUBLIC | 4.5.0 | SET|GET | mode |
[0-1] |
0: basic formatting 1: script-based formatting |
Specifies data formatting mode. By default, basic formatting is the set formatting mode. |
DM50, DM60, DM70, DM474, DM503, MX-1000, MX-1502 and DM300 series readers. |
| INPUT1.SAVE-MATCH-STRING | Communication | PUBLIC | 4.5.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enables or disables saving the match string to flash when Set Match String is enabled as Input line 1 action. | DM50, DM60, DM70, DM474, DM503, and DM300 series readers. |
| QR.QUALITY-METRICS | Decoder | PUBLIC | 4.5.0 | SET|GET | type |
[0-2] |
0: none 1: ISO/IEC 15415 2: AIM-DPM / ISO/IEC TR 29158 |
Code quality metrics for QR codes. | ALL |
| SCRIPT.LOAD | Data Formatting | PUBLIC | 4.5.0 | num-bytes |
Loads the formatting script from the host to the reader. | DM50, DM60, DM70, DM474, DM503, MX-1000, MX-1502 and DM300 series readers. | |||
| SCRIPT.SEND | Data Formatting | PUBLIC | 4.5.0 | Sends the formatting script from the reader to the host. | DM50, DM60, DM70, DM474, DM503, MX-1000, MX-1502 and DM300 series readers. | ||||
| SYMBOL.MAXICODE | Symbology | PUBLIC | 4.5.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable MaxiCode symbology. | DM50, DM60, DM70, DM150, DM260, DM300 series readers, DM474, DM503, DM8050, DM8600, MX-1000 and MX-1502, Mobile. |
| TRAIN.CODE-FROM-IMAGE | Action | PRIVATE | 4.5.0 | num-bytes |
Code is trained from uploaded image. | Fixed mount devices. | |||
| SYMBOL.MATRIX | Symbology | PUBLIC | 4.7.1 | SET|GET | state |
[ON|OFF] | enable/disable | Enable Matrix symbology. | All. |
| CONFIG-BACKUP.ENABLE | Action | PUBLIC | 5.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enables automatic device configuration backup. | Ethernet readers. DM8000 series wireless readers also support FTP if the base station is connected through Ethernet. |
| CONFIG-BACKUP.IP-ADDRESS | Action | PUBLIC | 5.0.0 | SET|GET | string |
IP address of the Cognex Explorer FTP service. Uses dotted decimal form, such as "192.168.23.42". |
Ethernet readers. DM8000 series wireless readers also support FTP if the base station is connected through Ethernet. | ||
| CONFIG-BACKUP.PASSWORD | Action | PUBLIC | 5.0.0 | SET|GET | string |
Password used to log in to Cognex Explorer FTP service. | Ethernet readers. DM8000 series wireless readers also support FTP if the base station is connected through Ethernet. | ||
| CONFIG-BACKUP.PORT | Action | PUBLIC | 5.0.0 | SET|GET | port |
[0-65535] | Port number of the Cognex Explorer FTP service. | Ethernet readers. DM8000 series wireless readers also support FTP if the base station is connected through Ethernet. | |
| CONFIG-BACKUP.USER-NAME | Action | PUBLIC | 5.0.0 | SET|GET | string |
User name used to log in to the Cognex Explorer FTP service. | Ethernet readers. DM8000 series wireless readers also support FTP if the base station is connected through Ethernet. | ||
| CPFLASH.WRITE | Camera | PRIVATE | 5.0.0 | id |
[0-4] |
0: Unknown 1: Prototype 2: Alpha build with SRAM 3: Alpha build with SDRAM 4: Beta build |
Flash camera port ID. | DM 503. | |
| DECODER.REREAD-NEVER2X | Decoder | PUBLIC | 5.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Never read the same code twice. All trigger modes, e.g. Multicode Reading. |
ALL |
| DEVICE.LENS-TYPE | Camera | PRIVATE | 5.0.0 | GET | type |
This command gives you the lens type when a liquid lens is installed. | ALL | ||
| DEVICE.SYSLOG-IP | Communication | PRIVATE | 5.0.0 | SET|GET | string |
Specifies the remote syslog server IP address. | |||
| FTP-PROXY.NOOP | Communication | PRIVATE | 5.0.0 | session |
Sends NOOP using FTP proxy. | Wireless readers. | |||
| IMAGEBUFFER.MAX-IMAGES-PER-RESULT | RecordPlayback | PUBLIC | 5.0.0 | SET|GET | size |
[0-*] | Sets or gets how many images (n) per result are stored. | DM50, DM60, DM70, DM474, DM503, DM300 series readers, DM8050 and DM8600. | |
| IMAGEBUFFER.NO-READ-IMAGE-MODE | RecordPlayback | PRIVATE | 5.0.0 | SET|GET | size |
[0-3] |
0: No-Read Image Period 1: No-Read Image Number 2: No-Read Image Rate 3: No-Read Image Range |
No-Read Image stores only one image per trigger and you can select which one. No-Read Image Period stores every nth bad read image. This is evaluated across trigger modes. For example, if you have burst trigger selected with a length of 5 and set period to 3, the 1st and 4th image of the first, but the 2nd and 5th of the second burst will be stored. No-Read Image Range stores all bad read images from the no-read image number to the last no-read image number. | Fixed-mount readers, only in Single, Burst, Self and Continuous modes. |
| IMAGEBUFFER.NO-READ-IMAGE-NUMBER | RecordPlayback | PUBLIC | 5.0.0 | SET|GET | limit |
[n] [Max Int] |
In Burst trigger mode, n is the number of images in a burst In other trigger modes, there is no limit |
Store exactly one image. | DM50, DM60, DM70, DM474, DM503, DM300 series readers, only in Single, Burst, Self and Continuous modes. |
| IMAGEBUFFER.OVERLAY | RecordPlayback | PUBLIC | 5.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enables Overlay Graphics (SVG) for buffered images. | DM50, DM60, DM70, DM474, DM503, DM300 series readers, DM8050 and DM8600. |
| INPUT-STRING.ENABLE | Data Formatting | PUBLIC | 5.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enables or disables the use of the Input String feature (available for serial, telnet, NetworkClient). When enabled, a header and the footer can be set by the INPUT-STRING.HEADER and INPUT-STRING.FOOTER commands, respectively. A string of characters can be given between the header and the footer, which will be sent with the formatted output (for example, [hello world], if the header is set to ’[’ and the footer to ’]’). Since the input string is saved temporarily, it appears only in the next result output. Use Setup Tool (the <Input String> option) or <ISTR> with DMCC (see SET FORMAT.TOKEN) to allow Input string in the result output. | ALL |
| INPUT-STRING.FOOTER | Data Formatting | PUBLIC | 5.0.0 | SET|GET | string |
token string | Sets the footer for the Input String character string. | ALL | |
| INPUT-STRING.HEADER | Data Formatting | PUBLIC | 5.0.0 | SET|GET | string |
token string | Sets the header for the Input String character string. | ALL | |
| SETUP.PROG-TARGET | Camera | PUBLIC | 5.0.0 | SET|GET | category |
[0-15] | A number signifying an already existing setup. | Setup Programming Target. Setup to be modified by subsequent commands. |
DM50, DM60, DM70, DM150, DM260, DM474, DM503 and DM300 series readers. |
| SYNC-ACQUISITION.CABLE-END | Communication | PUBLIC | 5.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Sets or gets whether your device is a bus terminator at the end of the synchronization interface bus. | DM503 |
| SYNC-ACQUISITION.DELAY | Communication | PUBLIC | 5.0.0 | SET|GET | us |
[0-25000] | microseconds | Synchronized acquisition delay: the time the reader waits after sending or receiving the synchronized interface signal before the regular acquisition sequence starts. | DM503 |
| SYNC-ACQUISITION.ENABLED | Communication | PUBLIC | 5.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enables or disables synchronized triggering. | DM503 |
| SYNC-ACQUISITION.MASTER | Communication | PUBLIC | 5.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Sets or gets whether the device is the master among the synchronized readers. | DM503 |
| SYNC-ACQUISITION.START-DELAY | Communication | PRIVATE | 5.0.0 | SET|GET | us |
[0-25000] | microseconds | This command is to adjust the delay between the master/slave trigger sent via Ethernet and the sync signal sent for RS-845 to compensate for the longer runtime of the message via Ethernet. Developer only command. |
DM503 |
| TUNE-BUTTON.3SEC-ACTION | System | PUBLIC | 5.0.0 | SET|GET | action state |
[0-6] [ON|OFF] |
action code (see BUTTON.3SEC-ACTION), enabled enable/disable |
Defines actions when the user pushes the tune button for more than 3 seconds. | DM474, DM503 and DM300 readers. |
| TUNE-BUTTON.ENABLE | IO | PUBLIC | 5.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enables or disables the tune button. | DM474, DM503, and DM300 series readers. |
| DATA.RESULT-TYPE | System | PRIVATE | 5.0.0_cr10 | SET|GET | bit-field |
[0-511] |
0x00 = None 0x01 = Result 0x100 = Input event message |
Controls automatic result transmitted from reader. Default is 1. | ALL |
| INPUT.EVENT-MESSAGE | IO | PRIVATE | 5.0.0_cr10 | SET|GET | state |
[ON|OFF] | enable/disable | Instructs the system to generate a message for every input line state change. | DM300 series readers, DM474. |
| MARKEM.ENABLED | Communication | PRIVATE | 5.0.0_cr11 | SET|GET | state |
[ON|OFF] | enable/disable | Enable or disable the Markem protocol. | DM300 series readers, DM474. |
| INTELLIGRATED.ENABLED | Communication | PRIVATE | 5.0.0_cr14 | SET|GET | state |
[ON|OFF] | enable/disable | Enable or disable the Intelligrated protocol. | DM503 series readers. |
| INTELLIGRATED.HEARTBEAT | IO | PRIVATE | 5.0.0_cr14 | SET|GET | sec |
[0-50] | seconds | Sets or gets the time between heartbeat transmissions. A value of 0 disables the heartbeat. | DM503 series readers. |
| SYMBOL.AZTECCODE | Symbology | PUBLIC | 5.0.0_cr2 | SET|GET | state |
[ON|OFF] | enable/disable | Enable Aztec code symbology. | DM70, DM150, DM260, DM503, DM300 series readers, DM474, DM8050, DM8600, MX-1000, MX-1502, Mobile. |
| SYMBOL.DOTCODE | Symbology | PUBLIC | 5.0.0_cr3 | SET|GET | state |
[ON|OFF] | enable/disable | Enable DotCode symbology. | DM70, DM150, DM260, DM300 series readers, DM474, DM8050X, DM8600, MX-1000, MX-1502, Mobile. |
| MSI.CHKCHAR | Symbology | PUBLIC | 5.0.0_cr5 | SET|GET | state |
[ON|OFF] | enable/disable | Sets or gets whether check character is used. Default value is OFF. | DM300 series, DM474, DM503, MX-1000, MX-1502, Mobile. |
| MSI.CHKCHAR-OPTION | Symbology | PUBLIC | 5.0.0_cr5 | SET|GET | mode |
[0-5] |
0: Mod10 1: Mod11 2: Mod1010 3: Mod1110 4: 5: |
Sets or gets the method for calculating checksum. | DM474, DM503 and DM300 series, MX-1000, MX-1502, Mobile. |
| MSI.CODESIZE | Symbology | PUBLIC | 5.0.0_cr5 | SET|GET | mode min max |
[ON|OFF] [1-max] [min-80] |
any length code minimum code length maximum code length |
Sets or gets the expected code size. | DM474, DM503, DM300 series readers, MX-1000, MX-1502. |
| MSI.QZ-SIZE | Symbology | PUBLIC | 5.0.0_cr5 | SET|GET | size |
[0-100] | Sets or gets the single side strictness as a percentage | DM474, DM503 and DM300 series readers. | |
| MSI.XMTCHK | Symbology | PUBLIC | 5.0.0_cr5 | SET|GET | state |
[ON|OFF] | enable/disable | Sets or gets whether to transmit the check digit. | DM474, DM503 and DM300 series readers. |
| SYMBOL.MSI | Symbology | PUBLIC | 5.0.0_cr5 | SET|GET | state |
[ON|OFF] | enable/disable | Sets or gets whether MSI Code is enabled or disabled | DM70, DM150, DM260, DM503, DM300 series readers, DM474, MX-1000, MX-1502, Mobile. |
| COM.RS232-FILTER | Communication | PRIVATE | 5.0.0_cr7 | SET|GET | state |
[ON|OFF] | enable/disable | Enable or disable the RS-232 filter. | DM300 series readers, DM474. |
| COM.RS232-FILTER-CHAR | Communication | PRIVATE | 5.0.0_cr7 | SET|GET | char |
[0x00-0xFF] | Hex char | Sets or gets the hex value of the character to start filtering after (e.g. 0x03 for ETX). | DM300 series readers, DM474. |
| CAMERA.MAX-EXPOSURE-US | Camera | PUBLIC | 5.1.0 | SET|GET | exposure |
[18-25000] | Maximum exposure limit in microseconds for autoregulation. | DM50, DM60, DM70. | |
| DATAMATRIX.SYMBOL-DIFFICULTY | Symbology | PUBLIC | 5.1.0 | SET|GET | int |
[0-2] |
0: Easy 1: Medium 2: Hard |
Level of DataMatrix code symbol difficulty. | DM8600. |
| LIGHT.DIRECT-INTENSITY | Camera | PUBLIC | 5.1.0 | SET|GET | level |
[0-15] | Intensity | Direct Illumination Intensity. | DM50, DM60, DM474, DM503 and DM300 series readers. |
| NETWORK-CLIENT.ENABLED | Communication | PUBLIC | 5.1.0 | SET|GET | state |
[ON|OFF] | enable/disable | Switch the Network Client feature on or off. | Ethernet readers except for the DM8000 wireless. |
| QR.SYMBOL-DIFFICULTY | Symbology | PUBLIC | 5.1.0 | SET|GET | int |
[0-2] |
0: Easy 1: Medium 2: Hard |
Level of QR code symbol difficulty. | DM8600. |
| CAMERA.MIRROR-HORIZONTAL | Camera | PUBLIC | 5.2.0 | SET|GET | state |
[ON|OFF] | enable/disable | Mirror acquired image over the vertical axis. | DM474, DM503 and DM300 series readers. |
| CAMERA.MIRROR-VERTICAL | Camera | PUBLIC | 5.2.0 | SET|GET | state |
[ON|OFF] | enable/disable | Mirror acquired image over the horizontal axis. | DM70, DM260, DM474, DM503 and DM300 series readers. |
| DATAMATRIX.PRINT-DEFORMATION | Symbology | PUBLIC | 5.2.0 | SET|GET | state |
[0|1] |
0: Minimal 1: Moderate |
Sets the IDMax Properties. | DM300, DM474, DM503. |
| DATAMATRIX.TRAINED-FLEX-GRID | Symbology | PUBLIC | 5.2.0 | SET|GET | state |
[ON|OFF] | enable/disable | Switches the Trained Code Property "Flexible Grid Size". | DM300, DM474, DM503. |
| DATAMATRIX.TRAINED-IGNORE-POLARITY | Symbology | PUBLIC | 5.2.0 | SET|GET | state |
[ON|OFF] | enable/disable | Switches the Trained Code Property "Ignore Polarity". | DM300, DM474, DM503. |
| DECODER.1D-MINIMUM-DECODES | Symbology | PUBLIC | 5.2.0 | SET|GET | int |
[0-5] | Minimum number of decoded scans to report a confident decoding (to prevent misread). | ALL | |
| DECODER.1D-QUALITY-METRICS | Decoder | PUBLIC | 5.2.0 | SET|GET | mode |
[0-1] |
0: none 1: 1D readability |
Enables/disables 1D Process Control Metrics. | ALL |
| DEVICE-LOG.CLEAR | Action | PUBLIC | 5.2.0 | This command clears the device log. | DM50, DM60, DM70, DM474, DM503, DM300 series readers, DM8050, DM8600, MX-1000 and MX-1502. | ||||
| DEVICE.STATS | Action | PRIVATE | 5.2.0 | GET | Get decode statistics. | All. | |||
| FOCUS.COMPENSATE-AFTER-IDLE | Camera | PRIVATE | 5.2.0 | SET|GET | time |
[1-10000] | idle time | Compensates temperature changes after camera is idle for this time. | Liquid lens. |
| FOCUS.HALL-SENSOR | Camera | PRIVATE | 5.2.0 | GET | value |
??? | |||
| FORMAT.SCRIPT | Data Formatting | PUBLIC | 5.2.0 | SET|GET | num-bytes |
Set: loads the script from the host to the reader. Get: sends the script from the reader to the host. | DM474, DM503, MX-1000, MX-1502 and DM300 series readers. | ||
| FTP-IMAGE.FILE-NAME-USE-SCRIPT | Communication | PUBLIC | 5.2.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enables FTP file name generation script. | DM474, DM503 and DM300 series readers. |
| FTP-IMAGE.PRIORITY | Communication | PRIVATE | 5.2.0 | SET|GET | value |
[0-2] |
0: High - above decoder 1: Medium - same as running decoder 2: Low - below running decoder |
FTP thread priority. | Ethernet readers. DM8000 series wireless readers also support FTP if the base station is connected through Ethernet. |
| FTP-IMAGE.SERVER-PATH-SCRIPT | Communication | PUBLIC | 5.2.0 | SET|GET | num-bytes |
Set: loads the script from the host to the reader. Get: sends the script from the reader to the host. | DM474, DM503 and DM300 series readers. | ||
| IMAGEBUFFER.GOOD-IMAGE-MODE | RecordPlayback | PUBLIC | 5.2.0 | SET|GET | mode |
[0-1] |
0: Unlimited 1: Rate limited |
Good Read Image stores all buffered good read images unless you set a limit rate. | DM503, DM300 series readers, DM8050 and DM8600. |
| IMAGEBUFFER.GOOD-IMAGE-RATE-BURST | RecordPlayback | PUBLIC | 5.2.0 | SET|GET | interval |
[1-1000] | Burst determines the peak rate of the number of good read images buffered. | DM474, DM503, DM300 series readers, DM8050 and DM8600. | |
| IMAGEBUFFER.GOOD-IMAGE-RATE-COUNT | RecordPlayback | PUBLIC | 5.2.0 | SET|GET | interval |
Number of good read images to be buffered at a time unit (for example, minutes or hours) specified with IMAGEBUFFER.GOOD-IMAGE-RATE-COUNT. | DM474, DM503, DM300 series readers, DM8050 and DM8600. | ||
| IMAGEBUFFER.GOOD-IMAGE-RATE-TIME | RecordPlayback | PUBLIC | 5.2.0 | SET|GET | type |
[0-3] |
0: seconds 1: minutes 2: hours 3: days |
Time unit of good read images to be buffered at a rate number specified with IMAGEBUFFER.GOOD-IMAGE-RATE-TIME. | DM474, DM503, DM300 series readers, DM8050 and DM8600. |
| IMAGEBUFFER.NO-READ-IMAGE-RATE-BURST | RecordPlayback | PUBLIC | 5.2.0 | SET|GET | interval |
[1-1000] | Burst determines the peak rate of the number of bad read images buffered. | DM474, DM503, DM300 series readers, only in Single, Burst, Self and Continuous modes. | |
| IMAGEBUFFER.NO-READ-IMAGE-RATE-COUNT | RecordPlayback | PUBLIC | 5.2.0 | SET|GET | interval |
Number of bad read images to be buffered at a time unit (for example, minutes or hours) specified with IMAGEBUFFER.NO-READ-IMAGE-RATE-COUNT. | DM503, DM300 series readers, only in Single, Burst, Self and Continuous modes. | ||
| IMAGEBUFFER.NO-READ-IMAGE-RATE-TIME | RecordPlayback | PUBLIC | 5.2.0 | SET|GET | type |
[0-3] |
0: seconds 1: minutes 2: hours 3: days |
Time unit of bad read images to be buffered at a rate number specified with IMAGEBUFFER.NO-READ-IMAGE-RATE-TIME. | DM474, DM503, DM300 series readers, only in Single, Burst, Self and Continuous modes. |
| LIGHT.EXTERNAL-INTENSITY | Camera | PUBLIC | 5.2.0 | SET|GET | level |
[0-15] | Intensity | Sets the intensity of the external illumination. | Fixed mount readers. |
| LIGHT.HIGH-FREQUENCY | Camera | PUBLIC | 5.2.0 | SET|GET | enable |
[ON|OFF] | enable/disable | Enables High Frequency Lights to avoid flickering illumination. | DM50, DM60, DM70, DM474, DM503, and DM300 series readers. |
| LIGHT.HIGH-FREQUENCY-ALWAYS | Camera | PUBLIC | 5.2.0 | SET|GET | enable seconds |
[ON|OFF] 0-86400 |
enable/disable auto off duration |
Enables High Frequency Light in Continuous trigger mode even if no trigger is active. After duration seconds the High Frequency Light is turned off. If the duration is 0 the light is never turned off. | DM50, DM60, DM70, DM474, DM503, and DM300 series readers. |
| LIGHT.HIGH-FREQUENCY-FORCE | Camera | PRIVATE | 5.2.0 | SET|GET | enable |
[ON|OFF] | enable/disable | Enable High Frequency Lights even if overheat protection would normally prohibit it. | DM300 series readers |
| LIVEIMG.MODE | Camera | PUBLIC | 5.2.0 | SET|GET | mode |
[0,2] |
0: Disable 2: Enable |
Controls live image display. | ALL |
| NET-LOCAL.MAX-LINK-SPEED | Communication | PRIVATE | 5.2.0 | SET|GET | speed |
[0-4] |
0: 1000 MBits/sec Full Duplex 1: 100 MBits/sec Full Duplex 2: 100 MBits/sec Half Duplex 3: 10 MBits/sec Full Duplex 4: 10 MBits/sec Half Duplex |
Limits the advertised autonegotiation maximum link speed. | DM503 only |
| NET-LOCAL.READER-SUBNET-MASK | Communication | PUBLIC | 5.2.0 | SET|GET | string |
dotted decimal form IPv4 address | Base station's subnet mask. Uses dotted decimal form, such as "192.168.23.255". |
Base stationss. | |
| NET-LOCAL.SEC-ENABLE | Communication | PRIVATE | 5.2.0 | SET|GET | state |
[ON|OFF] |
enable/disable
ON: use authentication OFF: no authentication |
Use authentication over telnet for communciation between reader and base. | Ethernet readers. |
| NET-LOCAL.SEC-PASSWORD | Communication | PRIVATE | 5.2.0 | SET|GET | string |
password for authentication | Use authentication over telnet for communciation between reader and base. | Ethernet readers. | |
| NET-LOCAL.SEC-USERNAME | Communication | PRIVATE | 5.2.0 | SET|GET | string |
username for authentication | Use authentication over telnet for communciation between reader and base. | Ethernet readers. | |
| NETWORK-CLIENT.CLIENT-PORT | Communication | PUBLIC | 5.2.0 | SET|GET | int |
[0-65535] | The port on the reader to use as the outbound port (default is 0). | Ethernet readers except for the DM8000 wireless. | |
| NETWORK-CLIENT.CLOSE-CONNECTION | Communication | PUBLIC | 5.2.0 | SET|GET | int |
[0-1] |
0: Never 1: After reader data transfer |
Whether or not to keep the connection open after data transfer (default is 0). | Ethernet readers except for the DM8000 wireless. |
| NETWORK-CLIENT.CONNECTION-TIMEOUT | Communication | PUBLIC | 5.2.0 | SET|GET | int |
[1000-60000] | How long to wait before considering the connection dead (default is 3000). | Ethernet readers except for the DM8000 wireless. | |
| NETWORK-CLIENT.HOST-ADDRESS | Communication | PUBLIC | 5.2.0 | SET|GET | string |
Max length = 255 | The address of the server to connect to. | Ethernet readers except for the DM8000 wireless. | |
| NETWORK-CLIENT.HOST-PORT | Communication | PUBLIC | 5.2.0 | SET|GET | int |
[0–65535] | The remote port on the server to connect to (default is 1000). | Ethernet readers except for the DM8000 wireless. | |
| NETWORK-CLIENT.IDLE-TIMEOUT | Communication | PUBLIC | 5.2.0 | SET|GET | int |
[1–3600] | How long to keep the connection open after transfer (default is 1). | Ethernet readers except for the DM8000 wireless. | |
| NETWORK-CLIENT.OPEN-CONNECTION | Communication | PUBLIC | 5.2.0 | SET|GET | us |
[0-1] |
0: on Power-up 1: on Data Activity |
When to open the connection to the remote host (default is 0). | Ethernet readers except for the DM8000 wireless. |
| NETWORK-CLIENT.PROTOCOL | Communication | PUBLIC | 5.2.0 | SET|GET | int |
[0-1] |
0: TCP 1: UDP |
Which protocol to use for the connection (default is 0). | Ethernet readers except for the DM8000 wireless. |
| NETWORK-CLIENT.RECONNECT-DELAY | Communication | PUBLIC | 5.2.0 | SET|GET | int |
[100-60000] | How long to wait before reconnecting if the connection is lost (default is 1000). | Ethernet readers except for the DM8000 wireless. | |
| QR.MAXIMUM-GRID-SIZE | Symbology | PUBLIC | 5.2.0 | SET|GET | size |
[49-177] | Step size: 4. | Maximum grid size which can be read by the QR decoder. | ALL |
| READER.ASSIGNED | Communication | PUBLIC | 5.2.0 | SET|GET | state |
[ON|OFF] | enable/disable | Unassignins the reader and the base station that is associated with it. | Base |
| SETUP.START-WITH-LAST-READ | Camera | PUBLIC | 5.2.0 | SET|GET | mode |
[ON|OFF] |
enable/disable
OFF: Start with fixed setup ON: Start with setup of last good read |
Sets read setup. | DM8600, DM70, DM150, DM260, DM474, DM503, MX-1000, MX-1502 and DM300 series readers. |
| SETUP.START-WITH-SETUP | Camera | PUBLIC | 5.2.0 | SET|GET | setup |
[0-15] | setup number to start with | Starts read setup. | DM8600, DM70, DM150, DM260, DM474, DM503, MX-1000, MX-1502 and DM300 series readers. |
| SETUP.USE | Camera | PUBLIC | 5.2.0 | int state |
[1-15] [ON|OFF] |
Setup to change enable/disable Disables/Enables setup to be used. |
Adds or removes a setup from the list of usable Read Setups. | DM8600, DM70, DM150, DM260, DM474, DM503 and DM300 series readers. | |
| TEST-MODE.ACCEPT-TRIGGERS | Communication | PUBLIC | 5.2.0 | value |
[0-2000000000] | number of accepted triggers from all inputs | Allows a limited number of triggers from external inputs even if triggering from those should be rejected using TEST-MODE.INPUTS-ENABLE. | DM70, DM150, DM260, DM474, DM503 and DM300 series readers. | |
| TEST-MODE.AUTOMATIC | Communication | PUBLIC | 5.2.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enables automatic triggering. | DM70, DM150, DM260, DM474, DM503 and DM300 series readers. |
| TEST-MODE.AUTOMATIC-OFF-US | Communication | PUBLIC | 5.2.0 | SET|GET | microseconds |
[0-2000000000] | Inactive trigger phase for automatic triggering. | DM70, DM150, DM260, DM474, DM503 and DM300 series readers. | |
| TEST-MODE.AUTOMATIC-ON-US | Communication | PUBLIC | 5.2.0 | SET|GET | microseconds |
[0-2000000000] | Active trigger phase for automatic triggering. | DM70, DM150, DM260, DM474, DM503 and DM300 series readers. | |
| TEST-MODE.ENABLE | Communication | PUBLIC | 5.2.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enables test mode. | DM70, DM150, DM260, DM474, DM503 and DM300 series readers. |
| TEST-MODE.INPUTS-ENABLE | Communication | PUBLIC | 5.2.0 | SET|GET | state |
[ON|OFF] | enable/disable | Disables external trigger sources during test mode. | DM70, DM150, DM260, DM474, DM503 and DM300 series readers. |
| TEST-MODE.OUTPUTS-ENABLE | Communication | PUBLIC | 5.2.0 | SET|GET | state |
[ON|OFF] | enable/disable | Disables result reporting to external destinations during test mode. | DM70, DM150, DM260, DM474, DM503 and DM300 series readers. |
| TUNE-BUTTON.SAVE-MATCH-STRING | System | PUBLIC | 5.2.0 | SET|GET | state |
[ON|OFF] | enable/disable tune button enabled | Enables the 'save match string' action when the user pushes the tune button for more than 3 seconds. | DM474, DM503, DM8600 and DM300 readers. |
| COM.SCRIPT | Communication | PRIVATE | 5.3.0 | SET|GET | num-bytes |
Load script from communication channel. | DM474, DM503 and DM300 series readers. | ||
| COM.SCRIPT-ENABLED | Communication | PRIVATE | 5.3.0 | SET|GET | bool |
DM474, DM503 and DM300 series readers. | |||
| OUTPUT.USER-CONFIGURE | Communication | PUBLIC | 5.3.0 | SET|GET | event number beep tone beep number LED color vibration |
[1,2] [0-2] [0-3] [0-7] [ON|OFF] |
1: USER_EVENT_1 2: USER_EVENT_2 [0]: Low [1]: Medium [2]: High Number of beeps [0]: Off [1]: Blue [2]: Green [3]: Cyan [4]: Red [5]: Magenta [6]: Yellow [7]: White enable/disable ON: The reader vibrates on the given user event. OFF: The reader does not vibrate on the given user event. |
Sets the beeper tone and the number of beeps for USER_EVENT_1 or USER_EVENT_2. | DM8050 (except for the vibration parameter), ON|OFF is supported on DM8600 and MX-1000. |
| OUTPUT.USER1 | Action | PUBLIC | 5.3.0 | Device emits USER_EVENT_1 event. | DM8050, MX-1000, MX-1502, DM474, DM503 and DM300 series readers. | ||||
| OUTPUT.USER2 | Action | PUBLIC | 5.3.0 | Device emits USER_EVENT_2 event. | DM8050, MX-1000, MX-1502, DM474, DM503 and DM300 series readers. | ||||
| ACCEL-SENSOR.OPERATION-MODE | Communication | PUBLIC | 5.4.0 | SET|GET | int |
[0-1] |
0: Acceleration Sensor is not used for waking the reader up from hibernation. 1: Acceleration Sensor is used for waking the reader up from hibernation. |
Configures the application of the acceleration sensor. This command is only valid for Bluetooth-connected readers. |
DM8050, DM8600. |
| ACCEL-SENSOR.SENSITIVITY | Communication | PUBLIC | 5.4.0 | SET|GET | int |
[0-2] |
0: Low 1: Medium 2: High |
Gets/sets the sensitivity of the acceleration sensor of/to the predefined value. | DM8050, DM8600. |
| BLUETOOTH.MAC-ADDRESS | Communication | PUBLIC | 5.4.0 | GET | Returns the own Bluetooth address of the device. | DM8050, DM8600. | |||
| BUTTON.VIRTUAL | Action | PRIVATE | 5.4.0 | int state |
[ON|OFF] |
Denotes the button id. enable/disable Denotes the new state of the button. |
Allows to virtually push the TUNE button for more than 3 seconds on a DM8600 to activate "magic mode". | DM8600 | |
| COM.USB-HID-ONLY | Communication | PUBLIC | 5.4.0 | SET|GET | state |
[ON|OFF] | enable/disable | When enabled, the base station will appear as a single USB Keyboard device on its USB port, instead of a composite device. | DM8000 base station G2 |
| CONFIG.SAVE-DEFAULTS | Action | PRIVATE | 5.4.0 | Saves current settings as defaults. This command does not reboot the device. | ALL | ||||
| DEBUG.LOG | System | PRIVATE | 5.4.0 | GET | Gets the debug log in development builds, returns nothing for released firmware. | ALL | |||
| DECODER.1D-PICKETFENCE-BARCODE-ONLY | System | PRIVATE | 5.4.0 | GET | |||||
| DEVICE.APPLOADER-VER | System | PRIVATE | 5.4.0 | GET | Returns the Apploader version. | ||||
| DEVICE.DEFAULT-MFG | Action | PRIVATE | 5.4.0 | Resets all device settings to Cognex defaults. This command reboots the device. | DM8050, DM8600. | ||||
| DEVICE.FAILSAFE-VER | System | PRIVATE | 5.4.0 | GET | Returns the Failsafe version. | ||||
| DEVICE.ID | Camera | PRIVATE | 5.4.0 | GET | string |
Returns the device id. | ALL | ||
| DEVICE.SUBCLASS | System | PRIVATE | 5.4.0 | GET | string |
Activates the relevant device subclasses. | |||
| DOTCODE.MAXIMUM-COLUMNS | Decoder | PUBLIC | 5.4.0 | SET|GET | int |
[11-128] | The default is 128. | DM300 series readers, DM474, DM8050X and DM8600. | |
| DOTCODE.MAXIMUM-ROWS | Decoder | PUBLIC | 5.4.0 | SET|GET | int |
[5-128] | The default is 32. | DM300 series readers, DM474, DM8050X and DM8600. | |
| DOTCODE.MINIMUM-COLUMNS | Decoder | PUBLIC | 5.4.0 | SET|GET | int |
[11-128] | The default is 16. | DM300 series readers, DM474, DM8050X and DM8600. | |
| DOTCODE.MINIMUM-ROWS | Decoder | PUBLIC | 5.4.0 | SET|GET | int |
[5-128] |
The default is 6. |
DM300 series readers, DM474, DM8050X and DM8600. | |
| DOTCODE.POLARITY | Decoder | PUBLIC | 5.4.0 | SET|GET | int |
[0-2] |
0: Dark on Light 1: Light on Dark 2: Either |
DM300 series readers, DM474, DM8050X and DM8600. | |
| IDFLASH.READ | System | PRIVATE | 5.4.0 | SET | Read ID/slide in EEPROM content. | All | |||
| IDFLASH.WRITE | System | PRIVATE | 5.4.0 | SET | string |
Write ID/slide in EEPROM content. | All | ||
| KEY.EMULATE-PS2 | IO | PRIVATE | 5.4.0 | SET|GET | state |
[ON|OFF]
[OFF, Wedge, EmulationG |
enable/disable
OFF: no emulation Wedge: reader and PS/2 keyboard are connected using a wedge cable Emulation: reader is connected to wedge and no PS/2 keyboard is present |
Wireless readers. | |
| KEY.PAUSE-TIME | Action | PUBLIC | 5.4.0 | SET|GET | Pause time |
[0-1000] | 0 to 1000 millisecond pause | Sets the time to pause for a specified pause key sequence. | DM8050, DM8600 series |
| LIGHT.AIMER | Camera | PUBLIC | 5.4.0 | SET|GET | aimer-mode |
[0,1,3] |
0: Off 1: On 3: Activated by Acceleration Sensor |
Aimer Enable. Default is ON. |
DM8050 |
| LIMIT.CONS-NOREAD | System | PRIVATE | 5.4.0 | SET|GET | string |
empty string: feature disabled "CBRD>n": signal after n consecutive bad reads |
Sets/gets the threshold for consecutive bad read event signaling. | ALL | |
| LL.REGTODISTANCE | System | PRIVATE | 5.4.0 | register |
Get distance in mm for specified register steps at current temperature. | Readers with liquid lens. | |||
| LLFLASH.READ | System | PRIVATE | 5.4.0 | GET | Gets liquid lens flash content. | Readers with liquid lens. | |||
| LLFLASH.WRITE | System | PRIVATE | 5.4.0 | SET | Sets liquid lens flash content. | Readers with liquid lens. | |||
| PHS.ADD-PACKAGE | System | PRIVATE | 5.4.0 | ||||||
| PPP.IP-CLIENT | System | PRIVATE | 5.4.0 | SET|GET | Reader/client device IP address for internal communication between client and base station. | Wireless readers. | |||
| PPP.IP-SERVER | System | PRIVATE | 5.4.0 | SET|GET | Base/server device IP address for internal communication between client and base station. | Wireless readers. | |||
| PPP.NETMASK | System | PRIVATE | 5.4.0 | SET|GET | int |
Netmask for internal communication between reader and base. | Wireless readers. | ||
| PROXIMITY.CURRENT | Communication | PRIVATE | 5.4.0 | SET|GET | int |
[10-200] step 10 | IR LED current of the proximity sensor in mA | A higher value will increase the sensitivity of the sensor. | DM8600 |
| PROXIMITY.THRESHOLD | Communication | PRIVATE | 5.4.0 | SET|GET | int |
[0-100] | Threshold value which defines if the optical button has been pressed or released. A lower value will increase the sensitivity of the sensor. | DM8600 | |
| TRACE.DUMPFILE | System | PRIVATE | 5.4.0 | filename |
Saves a trace log file, which is archived in flash, into a file. | ||||
| TUNE-BUTTON.3SEC-ACTION | System | PUBLIC | 5.4.0 | SET|GET | action state |
[2,7] [ON|OFF] |
2: Set Match String 7: Extended Read Attempts enable/disable |
Defines actions when the user pushes the tune button for more than 3 seconds. | DM8600 readers. |
| BLUETOOTH.KBM-PIN | Communication | PRIVATE | 5.4.3 | SET|GET | string |
0-16 characters of decimal number | PIN number (e.g. "1234") | Gets or sets the PIN number of the remote target. | DM8050, DM8600. |
| BLUETOOTH.KBM-TARGET-ADDR | Communication | PRIVATE | 5.4.3 | SET|GET | string |
8 characters of hexadecimal number | MAC address (e.g. "0006660492A6") | Gets or sets the MAC address of the remote target. | DM8050, DM8600. |
| BLUETOOTH.MAX-RF-POWER | Communication | PUBLIC | 5.4.3 | SET|GET | int |
-23-7 | Maximum output power in dBm | DM8050, DM8600, and Bluetooth base stations. | |
| BLUETOOTH.OPERATION-MODE | Communication | PRIVATE | 5.4.3 | SET|GET | number |
[0-2] |
0: normal mode 1: PC connect mode 2: keyboard emulator mode |
Gets or sets the Bluetooth operation mode. | DM8050, DM8600. |
| COM.INTERFACE | Communication | PRIVATE | 5.4.3 | GET | Supported interfaces: RS232, USB, Ethernet, WiFi, Bluetooth. | ||||
| LIGHT.DARKFIELD-INTENSITY | Camera | PUBLIC | 5.4.3 | SET|GET | value |
[0-15] | Intensity | Darkfield Illumination Intensity. | DM8600 |
| LIGHT.DIFFUSE-INTENSITY | Camera | PUBLIC | 5.4.3 | SET|GET | level |
[0-15] | Intensity | Diffuse Brightfield Illumination Intensity. | DM8600 |
| LIGHT.DIRECT-INTENSITY | Camera | PUBLIC | 5.4.3 | SET|GET | level |
[1-15] | Intensity | Direct Illumination Intensity. | DM8050 |
| COM.USB-RE-ENUMERATE-ON-START | Communication | PUBLIC | 5.5 | SET|GET | state |
[ON|OFF]
[ON|OFF] |
enable/disable
ON: USB 1.1 mode OFF: USB 2.0 mode |
Feature to re-enumerate the COM port after firmware is started. | DM8000 series readers. |
| DECODER.REREAD-NOT-LAST-N | Decoder | PUBLIC | 5.5 SR3 | SET|GET | int |
[0-100] |
0: no restriction 1-100 Define N |
Do not read code if this code was read within the last N reads. | All |
| 3DVECTOR.CALIBRATED | Action | PRIVATE | 5.5.0 | GET | calibration_status |
[0-2] |
0:Neither factory, nor field calibration present 1:Only factory calibration loaded 2:Factory and field calibration loaded |
Query current calibration status. | ALL |
| 3DVECTOR.ENABLED | Action | PRIVATE | 5.5.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enables/disables the 3DVectoring functionality on the reader. | ALL |
| 3DVECTOR.FCALIB-CVL.LOAD | Action | PRIVATE | 5.5.0 | size_bytes |
Load factory calibration data blob in CVL style. | ALL | |||
| 3DVECTOR.FCALIB-CVL.SEND | Action | PRIVATE | 5.5.0 | Send factory calibration data blob in CVL style. | ALL | ||||
| 3DVECTOR.FCALIB-CVT.LOAD | Action | PRIVATE | 5.5.0 | size_bytes |
Load factory calibration data blob in CVT style. | ALL | |||
| 3DVECTOR.FCALIB-CVT.SEND | Action | PRIVATE | 5.5.0 | Send factory calibration data blob in CVT style. | ALL | ||||
| 3DVECTOR.LENGTH | Action | PRIVATE | 5.5.0 | SET|GET | This sets/gets the length of the output 3D line segment. | ALL | |||
| 3DVECTOR.SCALIB.LOAD | Action | PRIVATE | 5.5.0 | size_bytes |
Load system calibration data blob. | ALL | |||
| 3DVECTOR.SCALIB.SEND | Action | PRIVATE | 5.5.0 | Send system calibration data blob. | ALL | ||||
| CAMERA.EXPOSURE-LIMIT-US | Camera | PUBLIC | 5.5.0 | GET | exposure |
maximum value allowed for SET CAMERA.EXPOSURE-US | Get the maximum allowed exposure limited by current settings in us. | Fixed Mount readers. | |
| CAMERA.EXPOSURE-US | Camera | PUBLIC | 5.5.0 | SET|GET | auto target exposure gain |
[ON|OFF] [0-255] [18-25000] [0-60] |
ON: Automatic OFF: Manual target pixel value exposure camera gain |
Camera Parameters where exposure is in microseconds. The argument 'exposure' and 'gain' has no effect if 'auto' is ON and 'target' has no effect at all. | DM50, DM60, DM70, DM150, DM260 |
| CAMERA.EXPOSURE-US | Camera | PUBLIC | 5.5.0 | SET|GET | auto target exposure gain |
[ON|OFF] [0-255] [5-1000] [12-1000] [5-100000] [0-106] |
ON: Automatic OFF: Manual target pixel value DM300 and DM302 internal illumination DM303 internal illumination with external or no illumination camera gain |
Camera Parameters where exposure is in microseconds. The argument 'exposure' and 'gain' has no effect if 'auto' is ON and 'target' has no effect at all. | DM300 series readers, DM360 series readers, DM474, DM8600. |
| CAMERA.EXPOSURE-US | Camera | PUBLIC | 5.5.0 | SET|GET | auto target exposure gain |
[ON|OFF] [0-255] [12-100000] [0-41] |
ON: Automatic OFF: Manual target pixel value exposure independent of illumination camera gain |
Camera Parameters where exposure is in microseconds. The argument 'exposure' and 'gain' has no effect if 'auto' is ON and 'target' has no effect at all. | DM503 |
| CAMERA.EXPOSURE-US | Camera | PUBLIC | 5.5.0 | SET|GET | auto target exposure gain |
[ON|OFF] [0-255] [50-25000] [0-60] |
ON: Automatic OFF: Manual target pixel value camera gain |
Camera Parameters where exposure is in microseconds. The argument 'exposure' and 'gain' has no effect if 'auto' is ON and 'target' has no effect at all. | MX-1000 and DM8000 series readers. |
| CAMERA.FULL-BLACK-LEVEL-CORRECTION | Camera | PUBLIC | 5.5.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enables Full black level correction. | DM300 series readers, DM474. |
| CAMERA.GAIN | Camera | PUBLIC | 5.5.0 | SET|GET | gain |
[1.00-31.76] | The gain has no effect if the camera runs with automatic exposure | DM300 series readers, DM474. | |
| CAMERA.GAIN | Camera | PUBLIC | 5.5.0 | SET|GET | gain |
[1.00-13.88] | The gain has no effect if the camera runs with automatic exposure | DM503 | |
| CAMERA.GAIN | Camera | PUBLIC | 5.5.0 | SET|GET | gain |
[1.00-15.00] | The gain has no effect if the camera runs with automatic exposure | DM50, DM60, DM70 | |
| CAMERA.XPAND-ROI | Camera | PUBLIC | 5.5.0 | SET|GET | ROI index left right top bottom |
[1-2] [0 - sensor width] [0 - sensor width] [0 - sensor height] [0 - sensor height] |
ROI index pixels from left pixels from right pixels from top pixels from bottom |
Specifies custom FOVE regions. Requires the 1DDataStitching feature key. |
DM70, DM150, DM260, DM300 series readers, DM474, DM503. |
| CAMERA.XPAND-ROI-TYPE | Camera | PUBLIC | 5.5.0 | SET|GET | int |
[0-3] |
0: None 1: Xpand-15 2: Xpand-25 3: Custom |
Indicates the used FOVE type. Requires the 1DDataStitching feature key. |
DM70, DM150, DM260, DM300 series readers, DM474, DM503. |
| COM.RS232-ENABLE-PAUSE | Communication | PUBLIC | 5.5.0 | SET|GET | mode |
ON/OFF | Enable/disable pause in output data stream. | DM300 series readers, DM60, DM50, DM70, DM474 | |
| COM.RS232-INTERCHAR-DELAY | Communication | PUBLIC | 5.5.0 | SET|GET | us |
[0-5000] | milliseconds | Sets or gets the internal delay between sending characters to the serial port. | DM300 series readers, DM60, DM50, DM70, DM360 series readers, DM474, DM503 |
| COM.SCRIPT | Communication | PUBLIC | 5.5.0 | SET|GET | num-bytes |
GET: Retrieves the current communication script. SET: Uploads a communication script. | Fixed-mount readers. | ||
| COM.SCRIPT-ENABLED | Communication | PUBLIC | 5.5.0 | SET|GET | bool |
Enables/disables communication scripting or retrieves current state. | Fixed-mount readers. | ||
| COM.SCRIPT-ERROR | Communication | PUBLIC | 5.5.0 | GET | message |
script error message | Get the error message for the Custom Communication protocol script | Fixed-mount readers. | |
| COM.USB-REQUIRE-DTR | Communication | PUBLIC | 5.5.0 | SET|GET | state |
[ON|OFF] [ON|OFF] | enable/disable Enable/Disable | Turns the requirement to assert DTR signal during USB communication On or Off. | DM8050 |
| CONFIG-BACKUP.SERVER-TYPE | Communication | PUBLIC | 5.5.0 | SET|GET | type |
[0-1] |
0: Generic 1: Mitsubishi GOT |
Configuration backup server type. | DM474, DM503 and DM300 series readers. |
| DATA.RESULT-TYPE | System | PUBLIC | 5.5.0 | SET|GET | bit-field |
[0,1,512] |
0 = None 1 = Result 512 = MS test response |
Controls automatic, result transmitted from reader. Default bits are 1 and 512 (which is 513). | ALL |
| DATAMATRIX.DAMAGE | Decoder | PUBLIC | 5.5.0 | SET|GET | damage level |
[2,4] |
2: moderate 4: extreme |
Set Extreme to enable PowerGrid. | DM300 series readers, DM360, DM474 readers |
| DATAMATRIX.TRAINED-MODEL | Decoder | PUBLIC | 5.5.0 | SET|GET | rows columns module-size polarity mirrored |
[8-144] [8-144] [1-1000] [0-2] [ON|OFF] |
Number of rows Number of columns Module size * 10 0: dark-on-light 1: light-on-dark 2: either ON: mirrored OFF: not mirrored |
Train Data Matrix from the given parameters without needing to capture an image. | Fixed-mount readers |
| DECODER.1D-DATA-STITCH | Decoder | PUBLIC | 5.5.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enables/disables 1D data-stitching. Requires the 1DDataStitching feature key. |
DM70, DM150, DM260, DM300 series readers, DM474, DM503. |
| DECODER.1D-EXTENDED-RESOLUTION | Decoder | PUBLIC | 5.5.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enables/disables the 1D extended resolution decoding method. Requires the 1DExtendedRes feature key. |
DM70, DM150, DM260, DM300 series readers, DM474, DM503. |
| DECODER.NO-READ-FEEDBACK | Decoder | PRIVATE | 5.5.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enables/disables found but not decoded symbol info. | ALL |
| DEVICE.SCRIPT-HEAP-SIZE-LIMIT | Communication | PRIVATE | 5.5.0 | SET|GET | size |
204800-2147483647 | Maximum size in bytes | Maximum heap size the script engine may allocate. | Fixed mount readers |
| DEVICE.SCRIPT-HEAP-USAGE-CURRENT | Communication | PRIVATE | 5.5.0 | GET | size |
Currently used heap size | The size of heap the script currently allocates. | Fixed mount readers | |
| DEVICE.SCRIPT-HEAP-USAGE-MAX | Communication | PRIVATE | 5.5.0 | GET | size |
Maximum used heap size | The maximum size of heap the script allocated allocated. | Fixed mount readers | |
| DOTCODE.QUALITY-METRICS | Decoder | PRIVATE | 5.5.0 | SET|GET | mode |
[0-1] |
0: none 1: enable AIM metrics |
Enable Subset of Quality Metrics from DotCode AIM Specification. | DM474, DM503, DM300 series readers, DM8050X and DM8600. |
| ENCODER.MODE | IO | PUBLIC | 5.5.0 | SET|GET | value |
[0-4] |
0: Encoder A signal counts up, Encoder B signal counts down. 1: Encoder A signal counts up, Encoder B signal counts down. 2: Encoder A and Encoder B form quadrature (SIN/COS) signal, 1 count per cycle. 3: Encoder A and Encoder B form quadrature (SIN/COS) signal, 2 counts per cycle. 4: Encoder A and Encoder B form quadrature (SIN/COS) signal, 4 counts per cycle. |
Encoder mode. Sets the mode the encoder signals are interpreted if the Encoder Direction pin is defined. | Fixed-mount readers |
| ENCODER.RESET | IO | PUBLIC | 5.5.0 | Resets the encoder count to 0 and clears all encoder related events. | Fixed-mount readers | ||||
| FTP-IMAGE.IDLE-LIMIT | Communication | PUBLIC | 5.5.0 | SET|GET | state |
[ON|OFF] | enable/disable | Limit duration of idle connections. | DM474, DM503 and DM300 series readers. |
| FTP-IMAGE.IDLE-TIME | Communication | PUBLIC | 5.5.0 | SET|GET | seconds |
Maximum duration of telling the FTP server that the reader is alive. | DM474, DM503 and DM300 series readers. | ||
| FTP-IMAGE.SERVER-PATH-SCRIPT-ERROR | Communication | PUBLIC | 5.5.0 | GET | message |
script error message | Gets the script error message for FTP Storage name generation . | Fixed-mount readers. | |
| FTP-RESULT.IDLE-LIMIT | Communication | PUBLIC | 5.5.0 | SET|GET | state |
[ON|OFF] | enable/disable | Limit duration of idle connections after a data transfer. | DM474, DM503 and DM300 series readers. |
| FTP-RESULT.IDLE-TIME | Communication | PUBLIC | 5.5.0 | SET|GET | seconds |
[0-3600] | Maximum duration of idle connections after a data transfer. | DM474, DM503 and DM300 series readers. | |
| IMAGE.LOAD-FTP-MULT-PARAM | IO | PRIVATE | 5.5.0 | SET | server_ip picture last_image more burst_count buffer-overflow seq_nbr ” ” ”user” ”passwd” port |
[ON|OFF] [3] [0-1] |
Server IP Picture name enable/disable Number of images to take 0: Off 1: On Sequence number in the burst User name Password Port used |
Allows uploading of multiple pictures as a burst. | ALL |
| IMAGE.SEND | Action | PUBLIC | 5.5.0 | Retrieve the last camera image acquired. Returns number of bytes of image data followed by \r\n followed by image data. Whatever is set for ||>IMAGE.SIZE, ||>IMAGE.FORMAT, and ||>IMAGE.QUALITY before requesting the image will be used for the corresponding size, format, and quality. | ALL | ||||
| IMAGEBUFFER.IMAGE-TYPE | RecordPlayback | PUBLIC | 5.5.0 | SET|GET | int |
[0-2] |
0: All 1: Same as result 2: Auto |
Sets "What images to Buffer for a Result". When "Auto" is selected, the reader does intelligent image buffering. Requires the IntImageBuffer feature key to select the "Auto" option. |
DM70, DM150, DM260, DM300 series readers, DM474, DM503. |
| IMAGEBUFFER.NO-READ-IMAGE-LAST-NUMBER | RecordPlayback | PRIVATE | 5.5.0 | SET|GET | limit |
[n][Max Int] | In Burst trigger mode, n is the number of images in a burst. In other trigger modes, there is no limit. | Stores images up to the limit. | Fixed-mount readers, only in Single, Burst, Self and Continuous modes. |
| INPUT-STRING.MODE | Data Formatting | PUBLIC | 5.5.0 | SET|GET | int |
[0-4] |
0: Store 1: Send 2: Send with header and footer 3: Send with formatting 4: Send with header and footer formatting |
Controls whether the input string data is sent out as a result or stored in an internal variable. | Fixed-mount readers. |
| INPUT-STRING.VALUE | Data Formatting | PUBLIC | 5.5.0 | SET|GET | string |
token string | Sets the content of the Input String character string. | Fixed-mount readers | |
| INPUT.STATE | Action | PUBLIC | 5.5.0 | GET | line |
[0-3] | input line number | Gets the current state of the input line specified. Returns 1 for high, 0 for low. | Fixed-mount readers |
| IO-LINE.DIRECTION | IO | PUBLIC | 5.5.0 | SET|GET | line direction |
[2,3] [0,1] |
line=2: sets direction of I/O Line 2 line=3: sets direction of I/O Line 3 direction=0: defines line as output direction=1: defines line as input |
Sets the direction of the programmable I/O lines of DM360 and DM474 series readers. | DM360 series, DM474 readers |
| KEY.INTERCHAR-DELAY | Communication | PUBLIC | 5.5.0 | SET|GET | us |
[0-1000] | milliseconds | Sets or gets the delay time between characters when in HID keyboard mode. | DM300 series readers, DM60, DM50, DM70, DM474. |
| LIGHT.DIRECT | Camera | PUBLIC | 5.5.0 | SET|GET | north-east north-west south-east south-west |
[ON|OFF]
[ON|OFF] [ON|OFF] [ON|OFF] |
enable/disable
enable/disable enable/disable enable/disable |
Sets the quadrants on the DM70, DM150 and DM260. Possible values are ON and OFF for each segment. Example for a SET command: SET LIGHT.DIRECT ON OFF OFF ON if you want to have the top-left and bottom-right LED on. | DM70, DM150 and DM260 readers. |
| LIGHT.SELF-REPAIR | Camera | PRIVATE | 5.5.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enables/disables internal illumination self repair mode. | DM300 series readers |
| MASTER-SLAVE.TEST | Communication | PUBLIC | 5.5.0 | mode message |
[0-2] |
0: Slave to Master 1: Master to Slave 2: Master to Slave to Master |
Transmits the test message from reader to reader as designated by mode. The terminating reader will output the message preceded by the initiating device delimited by a space | Fixed-mount readers. | |
| PROFIBUS.GATEWAY-COM | Communication | PRIVATE | 5.5.0 | SET|GET | mode |
[0-2] |
0: Profibus 1: RS485 2: RS422 |
Get the COM configuration (Profibus / RS422 / RS485). | Fixed-mount readers |
| PROFIBUS.GATEWAY-FLOW | Communication | PRIVATE | 5.5.0 | SET|GET | mode |
[0-2] |
0: None 1: RTS/CTS 2: XON/XOFF |
The reader will return a value indicating the type of serial flow control to be used. | Fixed-mount readers |
| PROFIBUS.GATEWAY-HOST | Communication | PRIVATE | 5.5.0 | GET | type |
[0] | The reader will return a value indicating the host interface protocol. | Fixed-mount readers | |
| PROFIBUS.GATEWAY-MODE | Communication | PRIVATE | 5.5.0 | GET | mode |
[1] | Get the profibus mode configuration. | Fixed-mount readers | |
| PROFIBUS.GATEWAY-NODE | Communication | PRIVATE | 5.5.0 | SET|GET | node number |
[1-99] | The reader will return the Profinet node number for the gateway. | Fixed-mount readers | |
| PROFIBUS.GATEWAY-RUN | Communication | PRIVATE | 5.5.0 | SET|GET | state |
[ON|OFF] | Runtime start message or heartbeat. | Fixed-mount readers | |
| PROFIBUS.GATEWAY-STATUS | Communication | PRIVATE | 5.5.0 | SET|GET | status |
[0-4] |
0: ok, no error 1: Invalid op mode 2: Invalid node number 3: Invalid flow control 4: Invalid host interference |
Set Gateway error message. | Fixed-mount readers |
| PROFIBUS.GATEWAY-VERSION | Communication | PRIVATE | 5.5.0 | SET|GET | mode |
Set the GW firmware version, used for baud rate detection. | Fixed-mount readers | ||
| PTP-SYNC.DELAY | Communication | PUBLIC | 5.5.0 | SET|GET | time |
[0-1000000] | Time between trigger start and the synchronized acquisition timestamp. | DM360 series readers, DM474 | |
| PTP-SYNC.ENABLE | Communication | PUBLIC | 5.5.0 | SET|GET | mode |
[ON|OFF] | Enables MST synchronized by PTP. | DM360 series readers, DM474 | |
| PTP-SYNC.LOCAL-OFFSET | Communication | PUBLIC | 5.5.0 | SET|GET | time |
[0-1000000] | Local offset added to the synchronized acquisition timestamp. | DM360 series readers, DM474 | |
| PTP.ENABLE | Communication | PUBLIC | 5.5.0 | SET|GET | mode |
[ON|OFF] |
enable/disable
OFF: Disable the PTP timestamp synchronization ON: Enable the PTP timestamp synchronization |
Enable the PTP timestamp synchronization. | DM360 series readers, DM474 |
| PTP.PRIORITY1 | Communication | PUBLIC | 5.5.0 | SET|GET | level |
[0-255] | This is the first 8-bit priority value (lower number denotes a higher priority). Normally, this is set at 128 for master capable devices. | DM360 series readers, DM474 | |
| PTP.PRIORITY2 | Communication | PUBLIC | 5.5.0 | SET|GET | level |
[0-255] | This is the second 8-bit priority value (lower number denotes a higher priority). This parameter allows to configure backup clocks. | DM360 series readers, DM474 | |
| PTP.SLAVE-ONLY | Communication | PUBLIC | 5.5.0 | SET|GET | mode |
[ON|OFF] |
enable/disable
OFF: Disables PTP slave only configuration of the reader ON: Configures the reader as PTP slave only |
This parameter configures the reader as PTP slave only, even if no other master is active. | DM360 series readers, DM474 |
| SCRIPT.GARBAGE-COLLECT | Communication | PRIVATE | 5.5.0 | force |
[ON|OFF] | enable/disable Enforce the garbage collection | Check or enforce the Garbage Collection process. | Fixed mount readers | |
| SDCARD.BACKUP-FILE | Communication | PUBLIC | 5.5.0 | SET|GET | state |
[ON|OFF] | enable/disable | SD card is used for creating and restoring a configuration file backup. | DM360 series readers, DM474 |
| SDCARD.PRESENT | Communication | PUBLIC | 5.5.0 | GET | Returns True if the SD card was detected, False otherwise. | DM360 series readers, DM474 | |||
| SDCARD.TESTFILE | Communication | PRIVATE | 5.5.0 | SET|GET | string |
SET: writes argument to a predefined file on the card. GET: reads back the same file and returns its content. | DM360 series readers, DM474 | ||
| SYMBOL.C39-CONVERT-TO-C32 | Code Quality | PUBLIC | 5.5.0 | SET|GET | state |
[ON|OFF] | enable/disable | Parameter enables or disables Code39 to Code 32 conversion. | DM70, DM150, DM260 |
| SYMBOL.C39-CONVERT-TO-C32 | Symbology | PUBLIC | 5.5.0 | SET | state |
[ON|OFF] | enable/disable | Enables/disables the conversion of Code39 to Code32. | ALL |
| TELNET.CUSTOM-PORTS | Communication | PUBLIC | 5.5.0 | SET|GET | port |
[0-65535] | Comma separated list of TCP ports | Additional Telnet TCP ports for custom communication. | Ethernet readers |
| TRIGGER.END-HOLDOFF-DISTANCE | IO | PUBLIC | 5.5.0 | SET|GET | distance |
[0-10000 mm] | distance for hold-off at trigger end | When greater than 0, the distance with which to cancel a pending trigger off and allow the trigger to continue. | DM474, DM503 and DM300 series readers. |
| TRIGGER.END-HOLDOFF-TIME | IO | PUBLIC | 5.5.0 | SET|GET | rime |
[0-10000 ms] | time for hold-off at trigger end | When greater than 0, the time with which to cancel a pending trigger off and allow the trigger to continue. | Fixed-mount readers |
| TRIGGER.HOLDOFF-DISTANCE | IO | PUBLIC | 5.5.0 | SET|GET | distance |
[0-10000 mm] | distance for hold-off at trigger start | When greater than 0, the distance with which to cancel a pending trigger on and act like there was no trigger at all. | DM474, DM503 and DM300 series readers. |
| TRIGGER.HOLDOFF-TIME | IO | PUBLIC | 5.5.0 | SET|GET | time |
[0-10000 ms] | time for hold-off at trigger start | When greater than 0, the time with which to cancel a pending trigger on and act like there was no trigger at all. | Fixed-mount readers |
| TRIGGER.HOLDOFF-TYPE | IO | PUBLIC | 5.5.0 | SET|GET | type |
[0-2] |
0 = None 1 = Time 2 = Distance |
Which type of trigger hold-off to use, none, time or distance. | Fixed-mount readers |
| TRIGGER.IGNORE-DISTANCE | IO | PRIVATE | 5.5.0 | SET|GET | milliseconds |
[0-2147483646] | Sets or gets the minimum trigger distance for a trigger to be considered good. All trigger durations less than the specified duration will be aborted. | Fixed-mount readers | |
| TRIGGER.IGNORE-TIME | IO | PRIVATE | 5.5.0 | SET|GET | milliseconds |
[0-10000] | Sets or gets the minimum trigger duration for a trigger to be considered good. All trigger durations less than the specified duration will be aborted. | Fixed-mount readers | |
| TRIGGER.IGNORE-TYPE | IO | PRIVATE | 5.5.0 | SET|GET | mode |
[0-2] |
0: none 1: time 2: distance |
Sets or gets what type of triggers to ignore. | Fixed-mount readers |
| TUNE.STATUS | Action | PUBLIC | 5.5.0 | GET | Returns ON if tuning is running, OFF otherwise. | Fixed mount devices. | |||
| TUNE.TUNE-LIGHT-COMBINATIONS | Camera | PUBLIC | 5.5.0 | SET|GET | mode |
[ON|OFF] | If it is ON, light combinations will always be tuned. | DM300 series readers, DM474, DM260, DM70 and DM150. | |
| BATTERY.INFO | System | PUBLIC | 5.5.1 | GET | battery |
[0-1] |
0: internal battery 1: grip battery |
Gets verbose battery status. | MX-1000 |
| BUTTON.ACTION | IO | PUBLIC | 5.5.1 | SET|GET | button action |
[0-2] [0-1] |
Index of button (0:Left;1:Right;2:Grip) 0: disabled 1: trigger |
Sets and gets the assigned feature for hardware buttons. | MX-1000 |
| DEVICE.CGNM-DEV-TYPE | System | PRIVATE | 5.5.1 | GET | Returns the CogNamer device type. | ALL | |||
| C25.CHKCHAR | Symbology | PUBLIC | 5.5.2 | SET|GET | state |
[ON|OFF] |
ON: enable OFF: disable |
Code 25 Check Character | ALL |
| C25.CODESIZE | Symbology | PUBLIC | 5.5.2 | SET|GET | any, min, max |
[ON|OFF] [1-max] [min-80] |
any length code minimum code length maximum code length |
Code 25 Code Size. For the Manatee Works SDK, all of the Code 25 variants use the same minimum length; thus it will accept either C25.CODESIZE or I205.CODESIZE. | ALL |
| C25.QZ-SIZE | Symbology | PUBLIC | 5.5.2 | SET|GET | size |
[0..100] | any length code | Sets or gets the single side strictness as a percentage. | ALL |
| C25.XMTCHK | Symbology | PUBLIC | 5.5.2 | SET|GET | state |
[ON|OFF] |
ON: enable OFF: disable |
Sets or gets whether to transmit the check digit. | ALL |
| SYMBOL.C25 | Symbology | PUBLIC | 5.5.2 | SET|GET | state |
[ON|OFF] | enable/disable | Enable Code 25 Symbology. Manatee Works supports 7 subcodes: Standard, Interleaved, ITF-14, IATA, Matrix, COOP, and Inverted. | ALL |
| CAMERA.AUTO-REGULATION | Camera | PUBLIC | 5.6.0 | SET|GET | auto |
[ON|OFF] |
ON: Automatic OFF: Manual |
Camera Parameters where exposure is in microseconds. | DM50, DM60, DM70, DM150, DM260, DM300 series readers, DM360 series readers, DM474, DM503, DM8600 |
| CAMERA.EXPOSURE | Camera | PUBLIC | 5.6.0 | SET|GET | exposure |
[18-25000] | exposure | Camera Parameters where exposure is in microseconds. | DM50, DM60, DM70, DM150, and DM260 |
| CAMERA.EXPOSURE | Camera | PUBLIC | 5.6.0 | SET|GET | exposure |
[5-1000] [12-1000] [5-100000] |
DM300 and DM302 internal illumination DM303 internal illumination with external or no illumination |
Camera Parameters where exposure is in microseconds. | DM300 series readers, DM360 series readers, DM474, DM8600. |
| CAMERA.EXPOSURE | Camera | PUBLIC | 5.6.0 | SET|GET | exposure |
[12-100000] | exposure independent of illumination | Camera Parameters where exposure is in microseconds. | DM503 |
| CAMERA.TARGET-BRIGHTNESS | Camera | PUBLIC | 5.6.0 | SET|GET | target |
[0-255] | target pixel value | Camera Parameters where exposure is in microseconds. | All, except MX series readers. |
| LIGHT.POLARIZED | Camera | PUBLIC | 5.6.0 | SET|GET | polarized LED count |
[0|2|4] | Number of polarized filtered LEDs in the illumination | Use this command after applying a different HPIL front cover to publish the illumination filter status to the device. | DM70, DM150, DM260 |
| REBOOT.DELAYED | Action | PUBLIC | 5.6.0 | Reboot the Device after delay in seconds. Rebooting the Device restores the Configuration stored in Non-Volatile Memory. Commands will not be processed for several seconds while the device reboots.If communication settings are changed, connection with device may be lost. Note that when connected via USB-COM, the application must release the COM port. | All | ||||
| SYMBOL.4STATE-RMC | Symbology | PRIVATE | 5.6.0 | SET|GET | state |
[ON|OFF] | enable/disable Enable/Disable | Enables or disables Royal Mail Code Symbology. | DM50, DM60, DM70, DM150, DM260, DM30x, DM474, DM503, MX-1000, MX-1502. Mobile. |
| FTP-IMAGE.SERVER-TYPE | Communication | PUBLIC | 5.6.3 | SET|GET | type |
[0-2] |
0: Generic 1: Mitsubishi GOT 2: SFTP |
FTP image server type. 2 means that the server is an S(SH)FTP server. | DM474, DM503 and DM300 series readers. |
| FTP-RESULT.SERVER-TYPE | Communication | PUBLIC | 5.6.3 | SET|GET | type |
[0-2] |
0: Generic 1: Mitsubishi GOT 2: SFTP |
FTP server type.2 means that the server is an S(SH)FTP server. | DM474, DM503 and DM300 series readers. |
| IMAGE.FORMAT | Camera | PUBLIC | 5.6.3 | SET|GET | format |
[0-2] |
0: Bitmap 1: JPEG 2: PNG |
Image File Format. | ALL |
| IMAGE.SEND-BUFFER | Camera | PRIVATE | 5.6.3 | index size format quality |
[0-3] [0-2] [10, 15, 20... 85, 90] |
0: Full 1: 1/4 2: 1/16 3: 1/64 0: Bitmap 1: JPEG 2: PNG JPEG Quality |
Send specified image buffer date. | ||
| IMAGEBUFFER.FORMAT | RecordPlayback | PUBLIC | 5.6.3 | SET|GET | format |
[0-2] |
0: Bitmap 1: JPEG 2: PNG |
DM50, DM60, DM70, DM474, DM503, MX-1000, DM8000 series and DM300 series readers. | |
| LIVEIMG.SEND | Camera | PUBLIC | 5.6.3 | size format quality |
[0-3] [0-2] [10, 15, 20... 85, 90] |
0: Full 1: 1/4 2: 1/16 3: 1/64 0: Bitmap 1: JPEG 2: PNG JPEG Quality |
Request image transfer to PC when LIVEIMG.MODE is set to 3. | ||
| AZTEC.TRAINED-MODEL | Decoder | PUBLIC | 5.7.0 | SET|GET | grid size module size polarity |
[15-151] [1-1000] [0-2] |
Grid size Module size * 10 0: dark-on-light 1: light-on-dark 2: either |
Set training parameters for Aztec symbology. | Fixed-mount readers |
| BACKUP.EXPORT | Action | PUBLIC | 5.7.0 | Exports a human readable version of the current reader backup. | ALL | ||||
| BEEP.GLOBAL-ENABLE | Action | PUBLIC | 5.7.0 | SET|GET | state |
[ON|OFF] |
ON: enable OFF: disable |
This command will disable all beeps on the DataMan product. | DM8050, DM8600 |
| CAMERA.GAIN-LIMIT | Camera | PUBLIC | 5.7.0 | SET|GET | gain |
[1.00-max_gain] | 1.00-max_gain: The maximum gain to use | Controls the maximum gain the tuning and auto-regulation process uses to find the best reader settings. Useful to limit noise in Images. | Fixed mount readers. |
| COM.ALTERNATE-MODE-DISABLE | Decoder | PRIVATE | 5.7.0 | SET|GET | enable |
[ON|OFF] |
ON: alternate mode cable detection enabled OFF: alternate mode cable detection disabled |
Disables alternate mode cable detection. | DM70 |
| COM.PROTOCOL | Communication | PUBLIC | 5.7.0 | SET|GET | type |
0..1 |
0: Off 1: RTS/CTS |
Sets hardware handshake type of serial port. | Devices with RTS/CTS lines |
| CONFIG.EXPORT | Action | PUBLIC | 5.7.0 | Exports a human readable version of the current reader configuration. | ALL | ||||
| DEVICE.DESCRIPTION | System | PUBLIC | 5.7.0 | SET|GET | state |
[0-127] | description | Store device description for inventory management. | ALL |
| DEVICE.TIMEZONE | Action | PUBLIC | 5.7.0 | SET|GET | timezone |
Location or POSIX timezone | Get or set the timezone for local time. | All | |
| ENCODER.DOUBLE-RATE | IO | PUBLIC | 5.7.0 | SET|GET | boolean |
[ON|OFF] | Edge detection | If set to ON, Encoder will count both edges on the Encoder Input line. If set to OFF, Encoder will count only the selected edge. | DM503 |
| ERROR-LED.ON-TIME-MS | System | PUBLIC | 5.7.0 | SET|GET | duration |
Sets the duration for the Error LED in ms. Use 0 for unlimited duration. | All devices with an error LED. | ||
| FILE.SAVE | Action | PRIVATE | 5.7.0 | filename |
This command can be used to load file from flash, e.g. FILE.SEND "/files/vs.cfg". | ALL | |||
| FOCUS.EXTENDED-RANGE | Camera | PUBLIC | 5.7.0 | GET | value |
[ON|OFF] | Extended Focus Range | Indicates that the reader operates in the extended focus range of ON. In this mode GET FOCUS.DISTANCE will return with an error. | Fixed-mount readers with Liquid Lens |
| FOCUS.EXTENDED-RANGE-START | Camera | PRIVATE | 5.7.0 | SET|GET | distance |
[50..4000] | define start of extended range | Defines the start of the extended focus range. Above this distance only optical power can be used to control the Liquid Lens. | Fixed-mount readers with Liquid Lens |
| FOCUS.POWER | Camera | PUBLIC | 5.7.0 | SET|GET | optical power |
[-6.0 .. 20.00] | Optical Power in Diopters | Conrols the optical power of the liquid lens. The actual range is dependent on the hardware and on manufacturing tolerances. | Fixed-mount readers with Liquid Lens |
| FOCUS.PRECISION | Camera | PUBLIC | 5.7.0 | SET|GET | settle mode |
[0..1] |
0: normal focus control 1: precise focus control |
Controls the liquid lens focus control between normal focus control and slow but more precise mode. | Fixed mount readers with a liquid lens. |
| FOCUS.PROGRESS | Camera | PUBLIC | 5.7.0 | SET|GET | enable |
[ON|OFF] |
ON: focus progress on OFF: focus progress off |
Enable transfer of intermittent focus images during adjust focus. | Fixed mount readers with a liquid lens. |
| FOCUS.TEMPERATURE-COMPENSATIONS | Camera | PRIVATE | 5.7.0 | SET|GET | state |
ON/OFF | Enable or disable the temperature compensation for the liquid lense HSLC. | Fixed mount readers with a Liquid Lens. | |
| FTP-PCM-REPORT.CUSTOM-FILE-NAME | Communication | PUBLIC | 5.7.0 | SET|GET | state |
ON/OFF |
enable disable |
Enable/disable customize file name generation (if disabled the FTP server has to generate a unique name). | Ethernet readers |
| FTP-PCM-REPORT.ENABLE | Communication | PUBLIC | 5.7.0 | SET|GET | enable |
ON/OFF | Enable or disable a PCM Report FTP connection. | Ethernet readers | |
| FTP-PCM-REPORT.FILE-NAME | Communication | PUBLIC | 5.7.0 | SET|GET | string |
File name of PCM Report. | Ethernet readers | ||
| FTP-PCM-REPORT.FILE-NAME-USE-SCRIPT | Communication | PUBLIC | 5.7.0 | SET|GET | state |
ON/OFF |
enable disable |
Enables PCM report file name generation by script. | Ethernet readers |
| FTP-PCM-REPORT.IDLE-LIMIT | Communication | PUBLIC | 5.7.0 | SET|GET | state |
ON/OFF |
enable disable |
Limit duration of idle connections after a data transfer. | Ethernet readers |
| FTP-PCM-REPORT.IDLE-TIME | Communication | PUBLIC | 5.7.0 | SET|GET | seconds |
[0-3600] | Maximum duration of idle connections after a data transfer. | Ethernet readers | |
| FTP-PCM-REPORT.IP-ADDRESS | Communication | PUBLIC | 5.7.0 | SET|GET | server |
IP address or DNS name | Set the PCM Report FTP server. | Ethernet readers | |
| FTP-PCM-REPORT.MAX-APPEND | Communication | PUBLIC | 5.7.0 | SET|GET | value |
[0-65535] | Max increment value to append to PCM report file name. | Ethernet readers | |
| FTP-PCM-REPORT.MAX-APPEND-START-VALUE | Communication | PUBLIC | 5.7.0 | SET|GET | value |
[0-65535] | Initial increment value to append to PCM report file name. | Ethernet readers | |
| FTP-PCM-REPORT.PASSWORD | Communication | PUBLIC | 5.7.0 | SET|GET | string |
PASSWORD used to login to target PCM Report FTP server. | Ethernet readers | ||
| FTP-PCM-REPORT.PORT | Communication | PUBLIC | 5.7.0 | SET|GET | port |
[0-65535] | PCM Report FTP server port number. | Ethernet readers | |
| FTP-PCM-REPORT.SCRIPT-ERROR | Communication | PUBLIC | 5.7.0 | GET | message |
script error message | Gets the script error message for FTP PCM report file name generation. | Ethernet readers | |
| FTP-PCM-REPORT.SERVER-PATH | Communication | PUBLIC | 5.7.0 | SET|GET | string |
Path for PCM Reports which has to be named by the FTP Server. | Ethernet readers | ||
| FTP-PCM-REPORT.SERVER-TYPE | Communication | PUBLIC | 5.7.0 | SET|GET | type |
[0-2] |
0: Generic 1: Mitsubishi GOT 2: SFTP(encrypted) |
FTP server type. | Ethernet readers |
| FTP-PCM-REPORT.USER-NAME | Communication | PUBLIC | 5.7.0 | SET|GET | string |
Username used to login to target PCM Report FTP server. | Ethernet readers | ||
| HPT.CHANNEL-ENABLED | Action | PRIVATE | 5.7.0 | SET|GET | channel_name, state |
[ON|OFF] string, [ON|OFF] | enable/disable Channel name. Switch state. | Enables or disables a given HPT log channel. | ALL |
| HPT.LOG | Action | PRIVATE | 5.7.0 | GET | Retrieves the HPT log as a binary file content. | ALL | |||
| LIGHT.LOW-ANGLE | Camera | PUBLIC | 5.7.0 | SET|GET | state |
[ON|OFF] [ON|OFF] | enable/disable low-angle illumination | Controls the DM262 UHD low-angle illumination. | DM262 |
| LIGHT.ON-AXIS | Camera | PUBLIC | 5.7.0 | SET|GET | state |
[ON|OFF] [ON|OFF] | enable/disable on-axis illumination | Controls the DM262 UHD on-axis illumination. | DM262 |
| LIGHT.ON-AXIS-INTENSITY | Camera | PRIVATE | 5.7.0 | SET|GET | intensity |
[0..3] | on-axis illumination intensity | Controls the intensity of the DM262 UHD on-axis illumination. | DM262 |
| LIGHTRING.DURATION | IO | PUBLIC | 5.7.0 | SET|GET | duration |
[0..10000] |
0: Default behavior 10..10000: duration of lightring event in ms, step 10 ms |
Controls the duration of the lightring illumination event. | DM36x, DM474 and DM503 |
| MAXICODE.TRAINED-MODEL | Decoder | PUBLIC | 5.7.0 | SET|GET | module size |
[1-1000] | Module size * 10 | Set training parameters for MaxiCode symbology. | Fixed-mount readers |
| MOTION-DETECTION.ACTIVE | Action | PUBLIC | 5.7.0 | GET | state |
[ON|OFF] |
ON: Active or Lights Off OFF: Inactive or Lights On |
Allows checking the current state of motion detection for presentation or self-internal trigger mode. | DM50, DN60, DM70, DM150, DM260, DM300, DM360, DM474. |
| MOTION-DETECTION.ENABLE | Action | PUBLIC | 5.7.0 | SET|GET | state |
[ON|OFF] |
ON: enable OFF: disable |
Enables or disables motion detection for Presentation trigger mode. | DM50, DN60, DM70, DM150, DM260, DM300, DM474, DM503. |
| MOTION-DETECTION.INIT-STATE | Action | PRIVATE | 5.7.0 | SET|GET | state |
[ON|OFF] | enable/disable ON: motion detection is default state\n; OFF: switch to motion detection state after timeout | Specify the motion detection default state. | DM50, DM60, DM70, DM150, DM260, DM300, DM474, DM503. |
| MOTION-DETECTION.SENSITIVITY | Action | PUBLIC | 5.7.0 | SET|GET |
|
[0|2] |
0: Low 1: Medium 2: High |
Sets or gets the motion detection sensitivity level when in presentation mode. | DM50, DM60, DM70, DM150, DM260, DM300, DM474, DM503. |
| MOTION-DETECTION.TIMEOUT | Action | PRIVATE | 5.7.0 | SET|GET | [0 - 3600] | sec | Time after the reader switches into the motion detection mode. | DM50, DM60, DM70, DM150, DM260, DM300, DM474, DM503. | |
| NET-LOCAL.PCAP | System | PRIVATE | 5.7.0 | SET|GET | interface |
interface | Retrieves packet capturing buffer. | ALL | |
| NTP.ENABLE | Communication | PUBLIC | 5.7.0 | SET|GET | state |
[ON|OFF] | enable/disable Enable/Disable | Enables or disables NTP. | All |
| NTP.SERVER1 | Communication | PUBLIC | 5.7.0 | SET|GET | server |
IP address or DNS name | Set the NTP server 1. | All | |
| NTP.SERVER2 | Communication | PUBLIC | 5.7.0 | SET|GET | server |
IP address or DNS name | Set the NTP server 2. | All | |
| PCM-RESULT-STRING.EXTEND | Decoder | PUBLIC | 5.7.0 | SET|GET | enable |
[ON|OFF] | Enable or disable extending the result string with metric information. | Ethernet readers. | |
| PCM-RESULT-STRING.METRIC-FORMAT | Decoder | PUBLIC | 5.7.0 | SET|GET | type |
[0-2] |
0: Grade 1: Value 2: Grade + Value |
Set the format of a single metric entry. | Ethernet readers. |
| PCM-RESULT-STRING.METRIC-PREFIX | Decoder | PUBLIC | 5.7.0 | SET|GET | type |
[0-2] |
0: None 1: Acronym 2: Name |
Defines the prefix for a single metric entry. | Ethernet readers. |
| PCM-RESULT-STRING.METRIC-SEPARATOR | Decoder | PUBLIC | 5.7.0 | SET|GET | string |
Defines the metric separator. | Ethernet readers. | ||
| PCM-RESULT-STRING.OVERALL-GRADE | Decoder | PUBLIC | 5.7.0 | SET|GET | type |
[ON|OFF] | enable | Enables or disables showing the overall grade in at the beginning of the result string. | Ethernet readers. |
| PCM-RESULT-STRING.SEPARATOR | Decoder | PUBLIC | 5.7.0 | SET|GET | string |
Defines the main separator between result data and metric section. | Ethernet readers. | ||
| PCM.CUSTOM-DESCRIPTION | Decoder | PUBLIC | 5.7.0 | SET|GET | string |
Ethernet readers. | |||
| PCM.METRIC-PARM-OVERALL | Decoder | PUBLIC | 5.7.0 | SET|GET | type type state |
[0-5] [0-27] [ON|OFF] |
0: AIM-DPM 1: ISO-IEC 15415 2: ANSI-ISO-IEC 15416 3: SemiT10 4: 1D readability 5: DotCode Readybility 0: Symbol Contrast 1: Axial Non Uniformity 2: Print Growth 3: UEC 4: Modulation 5: Fixed Pattern Damage 6: Grid Non Uniformity 7: Extreme Reflectance 8: Reflect Min 9: Edge Contrast Min 10: Single Scan Int 11: Multi Scan Int 12: Signal To Noise Ratio 13: Horizontal Mark Growth 14: Vertical Mark Growth 15: Data Matrix Cell Width 16: Data Matrix Cell Height 17: Horizontal Mark Misplacement 18: Vertical Mark Misplacement 19: Cell Defects 20: Finder Pattern Defects 21: Overall Grade 22: Edge Determination 23: Defects 24: Reference Decode 25: Decodability 26: Contrast Uniformity 27: Reflectance Margin ON: use for overall calculation OFF: do not use for overall calculation |
Use the the metric grading result for calculating the overall result if enabled (e.g. AIM-DPM → Symbol Contrast → Use for Overall Calculation = ON) Not all metrics are available for each standard: AIM-DPM (0, 1, 2, 3, 4, 5, 6, 8), ISO-IEC 15415 (0, 1, 3, 4, 5, 6, 7), ANSI-ISO-IEC 15416 (1, 4, 8, 9, 22, 23, 24, 25), 1D readability (0, 2, 8, 9, 10, 11), DotCode (0, 1, 2, 3, 6, 8) | Ethernet readers. |
| PCM.METRIC-PARM-REPORT | Decoder | PUBLIC | 5.7.0 | SET|GET | type type state |
[0-5] [0-27] [ON|OFF] |
0: AIM-DPM 1: ISO-IEC 15415 2: ANSI-ISO-IEC 15416 3: SemiT10 4: 1D readability 5: DotCode Readybility 0: Symbol Contrast 1: Axial Non Uniformity 2: Print Growth 3: UEC 4: Modulation 5: Fixed Pattern Damage 6: Grid Non Uniformity 7: Extreme Reflectance 8: Reflect Min 9: Edge Contrast Min 10: Single Scan Int 11: Multi Scan Int 12: Signal To Noise Ratio 13: Horizontal Mark Growth 14: Vertical Mark Growth 15: Data Matrix Cell Width 16: Data Matrix Cell Height 17: Horizontal Mark Misplacement 18: Vertical Mark Misplacement 19: Cell Defects 20: Finder Pattern Defects 21: Overall Grade 22: Edge Determination 23: Defects 24: Reference Decode 25: Decodability 26: Contrast Uniformity 27: Reflectance Margin ON: include in report OFF: do not include in report |
Include the metric grading result for selected quality standard and metric in the report if enabled. Only available if not use for overall calculation (e.g. ISO-IEC 15415 → Modulation → Show in Report = ON) Not all metrics are available for each standard: AIM-DPM (0, 1, 2, 3, 4, 5, 6, 8), ISO-IEC 15415 (0, 1, 2, 3, 4, 5, 6, 7), ANSI-ISO-IEC 15416 (0, 4, 8, 9, 22, 23, 24, 25), SemiT10 (1, 4, 12, 13, 14, 15, 16, 17, 18, 19, 20), 1D readability (0, 2, 8, 9, 10, 11), DotCode (0, 1, 2, 3, 6, 8). | Ethernet readers. |
| PCM.METRIC-PARM-THRESHOLD | Decoder | PUBLIC | 5.7.0 | SET|GET | type type grade value |
[0-5] [0-25] [1-4] [0-1000] |
0: AIM-DPM 1: ISO-IEC 15415 2: ANSI-ISO-IEC 15416 3: SemiT10 4: 1D readability 5: DotCode Readybility 0: Symbol Contrast 1: Axial Non Uniformity 2: Print Growth 3: UEC 4: Modulation 5: Fixed Pattern Damage 6: Grid Non Uniformity 7: Extreme Reflectance 8: Reflect Min 9: Edge Contrast Min 10: Single Scan Int 11: Multi Scan Int 12: Signal To Noise Ratio 13: Horizontal Mark Growth 14: Vertical Mark Growth 15: Data Matrix Cell Width 16: Data Matrix Cell Height 17: Horizontal Mark Misplacement 18: Vertical Mark Misplacement 19: Cell Defects 20: Finder Pattern Defects 21: Overall Grade 22: Edge Determination 23: Defects 24: Reference Decode 25: Decodability 1: D 2: C 3: B 4: A Threshold raw value |
Set the raw value threshold for the selected quality standard, metric and grade (e.g. AIM-DPM → UEC → Threshold B = 50). Not all metrics are available for each standard: AIM-DPM (0, 1, 3, 4, 6, 8), ISO-IEC 15415 (0, 1, 3, 4, 6), ANSI-ISO-IEC 15416 (1, 4, 8, 9, 23, 25), 1D readability (0, 2, 8, 9, 11), DotCode (0, 1, 2, 3, 6, 8) | Ethernet readers. |
| PCM.MIN-PASS | Decoder | PUBLIC | 5.7.0 | SET|GET | type grade |
[0-5] [0-4] |
0: AIM-DPM 1: ISO-IEC 15415 2: ANSI-ISO-IEC 15416 3: SemiT10 4: 1D readability 5: DotCode Readybility 0: F 1: D 2: C 3: B 4: A |
Set the overall minimum passing grade. Results under this grade will mean the reading failed. | Ethernet readers. |
| PCM.USE-CUSTOM-THRESHOLDS | Decoder | PUBLIC | 5.7.0 | SET|GET | type state |
[0-5] [ON|OFF] |
0: AIM-DPM 1: ISO-IEC 15415 2: ANSI-ISO-IEC 15416 3: SemiT10 4: 1D readability 5: DotCode Readybility ON: do regrading OFF: keep current result |
Enable or disable regrading of metric results by using the custom thresholds. | Ethernet readers. |
| QR.TRAINED-MODEL | Decoder | PUBLIC | 5.7.0 | SET|GET | grid size module size model polarity mirrored |
[11-177] [1-1000] [0-3] [0-2] [ON|OFF] [ON|OFF] |
Grid size Module size * 10 0: Unknown model 1: Model-1 2: Model-2 3: Micro-QR 0: dark-on-light 1: light-on-dark 2: either enable/disable ON: mirrored OFF: not mirrored |
Set training parameters for QR-Code symbology. Option 3 for argument "model": Micro-QR is not applicable for 6.0.1. |
Fixed-mount readers |
| TLS.BENCHMARK | Action | PRIVATE | 5.7.0 | Starts a benchmark of the SSL/TLS library.This DMCC is password protected. The result can be checked in the HPT log output. | ALL | ||||
| TLS.SELFTEST | Action | PRIVATE | 5.7.0 | Starts a benchmark of the SSL/TLS library. This DMCC is password protected. The result can be checked in the HPT log output. | ALL | ||||
| TUNE.EXCLUDE-AMBIENT-RESULTS | Camera | PUBLIC | 5.7.0 | SET|GET | disable ambient |
[ON|OFF] |
ON: Disables the automatic selection of ambient light results OFF: Allows ambient light results for atomatic seletion |
Control the automatic selection of tuning results where the prevailing illumination type is ambient light. | Fixed mount readers. |
| UPTIME | Action | PUBLIC | 5.7.0 | Shows the time since device started. | All | ||||
| ANDROID.AOA-SWITCH-TIMEOUT | Communication | PUBLIC | 5.7.1 | SET|GET | timeout [ms] |
0-3600000 | Timeout in milliseconds. | After boot the MX device won’t switch to AOA mode for this amount of time. | MX-1000, MX-1502 |
| ANDROID.ROLE | Communication | PUBLIC | 5.7.1 | SET|GET | role |
0-2 |
0: Auto 1: Device 2: AOA |
Sets the USB role of the MX device when in Android mode. | MX-1000, MX-1502 |
| ANDROID.USB-ROLE-CHANGE | Action | PRIVATE | 5.7.1 | SET|GET | enabled timeout |
[ON|OFF] |
ON: (default) role change enabled, reader operates as usual OFF: role change disabled, reader stays in device mode Timeout in seconds after which the role change is automatically enabled again. |
Disables the USB role change. If role change is disabled, the reader stays in device mode, meaning the phone is not charged. If the role change is disabled, a timeout must be provided in seconds after which the role change is automatically enabled again. | ALL |
| BEEPER.ENABLED | IO | PUBLIC | 5.7.1 | SET|GET | state |
[ON|OFF] | Enable/disable beeper in general. | All | |
| C11.CHKCHAR | Symbology | PUBLIC | 5.7.1 | SET|GET | state |
[ON|OFF] |
ON: enable OFF: disable (default) |
Code 11 Check Character | Mobile |
| C11.CHKCHAR-OPTION | Symbology | PUBLIC | 5.7.1 | SET|GET | int |
[0-1] |
0: disable 1: enable (default) |
Mobile | |
| C11.CODESIZE | Symbology | PUBLIC | 5.7.1 | SET|GET | any, min, max |
[ON|OFF] [1-max] [min-80] |
any length code minimum code length maximum code length |
Code 11 Code Size | ALL |
| DECODER.EFFORT | Decoder | PUBLIC | 5.7.1 | SET|GET | int |
[0-5] | Sets the effort level used by the decoding algorithms. Default is 2. | All | |
| DECODER.MAC-SCAN-TIMEOUT | Decoder | PUBLIC | 5.7.1 | SET|GET | int |
[0-60] | DM50, DM60, DM70, DM150 DM260, DM300, DM360, DM474, MX-1000, MX1502 | ||
| DECODER.TARGET-DECODING | Decoder | PUBLIC | 5.7.1 | SET|GET | state |
[ON|OFF] | enable/disable | Enable target decoding, where the reader attempts to symbols that lie only under the aiming dots. | MX-1000, MX-1502 series readers. |
| FLASH.AT70-INIT | Action | PRIVATE | 5.7.1 | magic |
647391673 | Magic number | This command clears AT70 Config block in flash memory. | AT70 based devices | |
| FOCUS.POWER-RANGE | Camera | PRIVATE | 5.7.1 | GET | Optical Power |
[liquid lens specific] | Optical Power in Diopters | Return minimum (first value) and maximun (second value) optical power values. | Readers with Liquid Lens |
| IMAGE.FETCH | Camera | PRIVATE | 5.7.1 | size format quality |
[0-3] [0-2] [10, 15, 20... 85, 90] |
0: Full 1: 1/4 2: 1/16 3: 1/64 0: Bitmap 1: JPEG 2: PNG JPEG quality |
Acquires an image and transfers it. | ||
| MONITOR-MODE.AUTOEXPOSURE | Camera | PUBLIC | 5.7.1 | SET|GET | state |
[ON|OFF] | enable/disable | Enable/disable autoregulation while in monitor mode. | ALL |
| MONITOR-MODE.DECODE-ENABLE | Camera | PUBLIC | 5.7.1 | SET|GET | mode |
[ON|OFF] | enable/disable | ALL | |
| SYMBOL.C11 | Symbology | PUBLIC | 5.7.1 | SET|GET | state |
[ON|OFF] | enable/disable | Enable Code 11 Symbology. | ALL |
| SYMBOL.COOP | Symbology | PUBLIC | 5.7.1 | SET|GET | state |
[ON|OFF] | enable/disable | ALL | |
| SYMBOL.IATA | Symbology | PUBLIC | 5.7.1 | SET|GET | state |
[ON|OFF] | enable/disable | ALL | |
| SYMBOL.INVERTED | Symbology | PUBLIC | 5.7.1 | SET|GET | state |
[ON|OFF] | enable/disable | ALL | |
| SYMBOL.ITF14 | Symbology | PUBLIC | 5.7.1 | SET|GET | state |
[ON|OFF] | enable/disable | ALL | |
| UPC-EAN.EAN13 | Symbology | PUBLIC | 5.7.1 | SET|GET | state |
[ON|OFF] | enable/disable | UPC/EAN Allow EAN13. | ALL |
| UPC-EAN.EAN8 | Symbology | PUBLIC | 5.7.1 | SET|GET | state |
[ON|OFF] | enable/disable | UPC/EAN Allow EAN8. | ALL |
| UPC-EAN.UPC-A | Symbology | PUBLIC | 5.7.1 | SET|GET | state |
[ON|OFF] | enable/disable | UPC/EAN UPC-A enabled. | ALL |
| UPC-EAN.UPC-E | Symbology | PUBLIC | 5.7.1 | SET|GET | state |
[ON|OFF] | enable/disable | UPC/EAN UPC-E enabled. | ALL |
| UPC-EAN.UPCE1 | Symbology | PUBLIC | 5.7.1 | SET|GET | state |
[ON|OFF] | enable/disable | UPC/EAN UPCE1 enabled. | ALL |
| DECODER.ALLOW-ALL-MST-RESULTS | Decoder | PUBLIC | 5.7.3 | SET|GET | state |
[ON|OFF] |
ON: enable OFF: disable |
Enables or disables re-read delay processing for slave results. | DM300 series readers, DM474, DM503, DM70, DM150, DM260 |
| FOCUS.SWEEP-POWER | Camera | PUBLIC | 5.7.3 | SET|GET | Optical Power for near distance Optical Power for far distance |
liquid lens specific liquid lens specific |
Optical Power in Diopters Optical Power in Diopters |
Returns near (first value) and far (second value) optical power values. | Readers with Liquid Lens. |
| IMAGEBUFFER.AUTO-PREFER-CENTER | RecordPlayback | PUBLIC | 5.7.3 | SET|GET | Controls whether to use the decoders best symbol or the symbol closer to the ROI center. | DM50, DM60, DM70, DM474, DM503, DM300 series readers, DM8050 and DM8600. | |||
| MASTER-SLAVE.TEST-EFP-OUTPUT | Communication | PUBLIC | 5.7.3 | SET|GET | state |
[ON|OFF] |
ON: enable OFF: disable |
Enables or disables mst-test messages on the Industrial Protocol interfaces. | DM300 series readers, DM474. |
| MASTER-SLAVE.TIMEOUT-DISTANCE | Communication | PUBLIC | 5.7.3 | SET|GET | int |
[0-1000000] | Distance | The distance for a master slave timeout. | DM60, DM70, DM260, DM474, DM503, and DM300 series readers. |
| MASTER-SLAVE.TIMEOUT-MODE | Communication | PUBLIC | 5.7.3 | SET|GET | mode |
[0-1] |
0: Time 1: Distance |
Controls if the mater slave response timeout will be time or distance based. | DM60, DM260, DM474, DM503, and DM300 series readers. |
| LIGHT.DIRECT | Camera | PUBLIC | 5.7.7 | SET|GET | state |
[ON|OFF] | enable/disable | Turns on/off light banks for the 8072V. Verification should only take place with lighting combinations that can be described as 30 single, 30T (opposite sides), 30Q (all 30 panels), 45Q (all 45 panels), or 90. Other lighting combinations are allowed by the firmware, but will not result in valid verification result. | DM8072 Verifier |
| TRUCHECK.AG | Decoder | PUBLIC | 5.7.7 | GET | Returns the AG (average grade) score from the last verification attempt. | DM8072 Verifier | |||
| TRUCHECK.AG-GRADE | Decoder | PUBLIC | 5.7.7 | GET | Returns the AG (average grade) grade from the last verification attempt. | DM8072 Verifier | |||
| TRUCHECK.ANU | Decoder | PUBLIC | 5.7.7 | GET | Returns the ANU (axial non-uniformity) score from the last verification attempt. | DM8072 Verifier | |||
| TRUCHECK.ANU-GRADE | Decoder | PUBLIC | 5.7.7 | GET | Returns the ANU (axial non-uniformity) grade from the last verification attempt. | DM8072 Verifier | |||
| TRUCHECK.DECODE-GRADE | Decoder | PUBLIC | 5.7.7 | GET | Returns the DECODE grade from the last verification attempt. | DM8072 Verifier | |||
| TRUCHECK.FPD | Decoder | PUBLIC | 5.7.7 | GET | Returns the FPD (fixed pattern damage) score from the last verification attempt. | DM8072 Verifier | |||
| TRUCHECK.FPD-GRADE | Decoder | PUBLIC | 5.7.7 | GET | Returns the FPD (fixed pattern damage) grade from the last verification attempt. | DM8072 Verifier | |||
| TRUCHECK.GNU | Decoder | PUBLIC | 5.7.7 | GET | Returns the GNU (grid non-uniformity) score from the last verification attempt. | DM8072 Verifier | |||
| TRUCHECK.GNU-GRADE | Decoder | PUBLIC | 5.7.7 | GET | Returns the GNU (grid non-uniformity) grade from the last verification attempt. | DM8072 Verifier | |||
| TRUCHECK.MOD-GRADE | Decoder | PUBLIC | 5.7.7 | GET | Returns the MOD (modulation) grade from the last verification attempt. | DM8072 Verifier | |||
| TRUCHECK.RM-GRADE | Decoder | PUBLIC | 5.7.7 | GET | Returns the RM grade from the last verification attempt. | DM8072 Verifier | |||
| TRUCHECK.SC | Decoder | PUBLIC | 5.7.7 | GET | Returns the SC (symbol contrast) score from the last verification attempt. | DM8072 Verifier | |||
| TRUCHECK.SC-GRADE | Decoder | PUBLIC | 5.7.7 | GET | Returns the SC (symbol contrast) grade from the last verification attempt. | DM8072 Verifier | |||
| TRUCHECK.UEC | Decoder | PUBLIC | 5.7.7 | GET | Returns the UEC (unused error correction) score from the last verification attempt. | DM8072 Verifier | |||
| TRUCHECK.UEC-GRADE | Decoder | PUBLIC | 5.7.7 | GET | Returns the UEC (unused error correction) grade from the last verification attempt. | DM8072 Verifier | |||
| CODABAR.XMT-START-STOP-CHAR | Decoder | PRIVATE | 6.0.0 | SET|GET | state |
[ON|OFF] |
ON: Enable OFF: Disable |
Enable or disable transmitting start and stop character as part of the decoded string. | Ethernet readers |
| DECODER.1D-SHORT-HEIGHT-CODES | Decoder | PRIVATE | 6.0.0 | SET|GET | state |
[ON|OFF] |
ON: Enable OFF: Disable |
Enable or disable Short Height Codes. | Ethernet readers |
| DECODER.CENTERING-WINDOW | Decoder | PUBLIC | 6.0.0 | SET|GET | center x perc, center y perc, size x perc, size y perc |
[0-100] | Percentage | Location and size of centering window as a percentage of the sensor size. | DM50, DM60, DM70, DM150 DM260, DM300, DM360, DM474, MX-1000 series |
| DECODER.DISPLAY-TARGET | Decoder | PUBLIC | 6.0.0 | SET|GET | state |
[ON|OFF] | Enable/Disable | Displays centering window graphics. | DM50, DM60, DM70, DM150 DM260, DM300, DM360, DM474, MX-1000 series |
| DECODER.USE-CENTERING | Decoder | PUBLIC | 6.0.0 | SET|GET | state |
[ON|OFF] | Enable/Disable | Only reads codes within the centering window. | DM50, DM60, DM70, DM150, DM260, DM300, DM360, DM474, MX-1000 series |
| DATAMATRIX.IDMAX-SCALE-UNCERTAINTY-PERCENTAGE | Decoder | PRIVATE | 6.0.1 | SET | percentage |
Specifies Scale Uncertainty Percentage. It is a parameter that allows or limits the tuned DataMatrix decoder to examine code that has different PPM than the originally tuned code. The percentage should be PPM1-PPM2)/PPM1 * 100. Active when IDMax is enabled. | ALL | ||
| DATAMATRIX.SCALE-UNCERTAINTY-PERCENTAGE | Decoder | PRIVATE | 6.0.1 | SET | percentage |
Specifies Scale Uncertainty Percentage. It is a parameter that allows or limits the tuned DataMatrix decoder to examine code that has a PPM different than the originally tuned code. The percentage should be (PPM1-PPM2)/PPM1 * 100. Used when IDQuick decoder is enabled. | ALL | ||
| FOCUS.CALIBRATE | Action | PRIVATE | 6.0.1 | Compute C-mount flange distance for early units and store in manufacturing data. | DM47x, DM37x | ||||
| MONITOR-MODE.ENABLE | Camera | PUBLIC | 6.0.1 | SET|GET | state |
[ON|OFF] | enable/disable | Enable/disable monitor mode. | ALL |
| SSH.UNLOCK | Action | PRIVATE | 6.0.1 | GET | The PC (host) sends this command to the reader to initiate the unlocking mechanism. As a response, the reader sends back a 32 byte random challenge to the PC. | DM474 | |||
| SSH.UNLOCK | Action | PRIVATE | 6.0.1 | SET | signature of the challenge |
The argument is the signature of the random challenge generated by the reader and signed with a public key on the PC side. The reader then verifies that the challenge was signed with the proper key and sent back in one minute. In this case, the SSH service is started on the reader, otherwise, an invalid parameter error is returned. | DM474 | ||
| CAMERA.HDR-ESTIMATED-SCENE-KEY | Camera | PRIVATE | 6.1.0 | SET|GET | estimated scene key |
[0-4095] | Estimated scene key parameter for HDR | DM370 series, DM470 series readers. | |
| CAMERA.HDR-MODE | Camera | PUBLIC | 6.1.0 | SET|GET | mode |
[0-2] |
0: Off 1: Global 2: Local |
HDR mode | DM470 series readers. |
| TEMPERATURE.CPU | System | PRIVATE | 6.1.0 | GET | CPU Temperature in °C. | DM370 series, DM470 series readers. | |||
| TEMPERATURE.LL | System | PRIVATE | 6.1.0 | GET | Get Liquid lens Temperature in °C. Only available if a Liquid lens is present. |
DM370 series, DM470 series readers. | |||
| TEMPERATURE.SENSOR | System | PRIVATE | 6.1.0 | GET | Get Imager Temperature in °C. Only available if compatible image sensor is present. Readout can interfere with image acquisition. |
DM370 series, DM470 series readers. | |||
| CAMERA.HDR-MODE | Camera | PUBLIC | 6.1.6 | SET|GET | mode |
[0-1] |
0: Off 1: Global |
HDR mode | DM370 series readers. |
| DATAMATRIX.TYPE | Decoder | PRIVATE | 6.1.6 | SET|GET |
|
[1-3] |
1 = DataMatrix only 2 = DMRE 3 = Both |
Set support level for DataMatrix and/or DataMatrix Rectangular Extensions. | ALL |
| DECODER.1D-DECODE-STRICTNESS | Decoder | PRIVATE | 6.1.6 | SET|GET |
|
[0-2] |
0 = Conservative 1 = Moderate 2 = Tolerant |
Selects which 1D decoding strictness mode to use. The default is 1 ("Moderate"). With setting 0 ("Conservative"), misreads are reduced, with 2 ("Tolerant"), no-reads are reduced. With setting 1 ("Moderate") this is balanced. | ALL |
| ENCODER.DOUBLE-RATE | IO | PUBLIC | 6.1.6 | SET|GET | boolean |
[ON|OFF] | Edge detection | If set to ON, Encoder will count both edges on the Encoder Input line. If set to OFF, Encoder will count only the selected edge. | DM360, DM370, and DM470 series readers. |
| HEIGHT-SENSOR.CURRENT-MEASUREMENT | Camera | PUBLIC | 6.1.6 | GET | [0-4000] | Distance from the C-Mount Flange in mm | Returns the read out of the ToF range distance in mm. | DM370 series, DM470 series readers. | |
| HPIT.FRONT-COVER | Communication | PUBLIC | 6.1.6 | GET |
|
[0-4] |
0 = No cover 1 = Cross polarized NEWC Linear Polarized S 2 = Clear cover 3 = Undefined 4 = Diffused |
Detected front cover type. | DM370 series, DM470 series readers. |
| HPIT.INDICATOR-MODE | Action | PUBLIC | 6.1.6 | SET|GET | IND_ID IND_MODE |
[0-1] [0-1] |
0 = Left indicator 1 = Right indicator 0 = OFF 1 = ON |
Allows to control the LED indicators located in Torch according to the selected mode. This command is intended only for usability testing. | DM370 series, DM470 series readers. |
| HPIT.INDICATOR-ON-TIME-US | Action | PRIVATE | 6.1.6 | SET|GET | IND_ID TIME_US |
[0-1] [100-10000] |
0 = Left indicator 1 = Right indicator |
Allows to control the Indicator0 (Green LED) on time to be executed in the following illumination pulse after an event has been detected. | DM370 series, DM470 series readers. |
| LIGHT.AIMER | Camera | PUBLIC | 6.1.6 | SET|GET | aimer-mode |
[0-1] |
0: Off 1: On |
Enables or disables the aimer. | DM370 series, DM470 readers. |
| LIGHT.DIRECT | Camera | PUBLIC | 6.1.6 | SET|GET | North Corners South East-West |
[ON|OFF]
[ON|OFF] [ON|OFF] [ON|OFF] |
enable/disable
enable/disable enable/disable enable/disable |
Enables or disables the HPIT quadrants. | DM370 series, DM470 series readers. |
| Name |
Type |
Level |
Version |
Set/Get |
Args |
Range |
Meaning |
Description |
Support |
|---|---|---|---|---|---|---|---|---|---|
| CAMERA.HDR-MODE | Camera | PUBLIC | 6.1.6 | SET|GET | mode |
[0-1] |
0: Off 1: Global |
HDR mode | DM370 series readers. |
| DATAMATRIX.TYPE | Decoder | PRIVATE | 6.1.6 | SET|GET |
|
[1-3] |
1 = DataMatrix only 2 = DMRE 3 = Both |
Set support level for DataMatrix and/or DataMatrix Rectangular Extensions. | ALL |
| DECODER.1D-DECODE-STRICTNESS | Decoder | PRIVATE | 6.1.6 | SET|GET |
|
[0-2] |
0 = Conservative 1 = Moderate 2 = Tolerant |
Selects which 1D decoding strictness mode to use. The default is 1 ("Moderate"). With setting 0 ("Conservative"), misreads are reduced, with 2 ("Tolerant"), no-reads are reduced. With setting 1 ("Moderate") this is balanced. | ALL |
| ENCODER.DOUBLE-RATE | IO | PUBLIC | 6.1.6 | SET|GET | boolean |
[ON|OFF] | Edge detection | If set to ON, Encoder will count both edges on the Encoder Input line. If set to OFF, Encoder will count only the selected edge. | DM360, DM370, and DM470 series readers. |
| HEIGHT-SENSOR.CURRENT-MEASUREMENT | Camera | PUBLIC | 6.1.6 | GET | [0-4000] | Distance from the C-Mount Flange in mm | Returns the read out of the ToF range distance in mm. | DM370 series, DM470 series readers. | |
| HPIT.FRONT-COVER | Communication | PUBLIC | 6.1.6 | GET |
|
[0-4] |
0 = No cover 1 = Cross polarized NEWC Linear Polarized S 2 = Clear cover 3 = Undefined 4 = Diffused |
Detected front cover type. | DM370 series, DM470 series readers. |
| HPIT.INDICATOR-MODE | Action | PUBLIC | 6.1.6 | SET|GET | IND_ID IND_MODE |
[0-1] [0-1] |
0 = Left indicator 1 = Right indicator 0 = OFF 1 = ON |
Allows to control the LED indicators located in Torch according to the selected mode. This command is intended only for usability testing. | DM370 series, DM470 series readers. |
| HPIT.INDICATOR-ON-TIME-US | Action | PRIVATE | 6.1.6 | SET|GET | IND_ID TIME_US |
[0-1] [100-10000] |
0 = Left indicator 1 = Right indicator |
Allows to control the Indicator0 (Green LED) on time to be executed in the following illumination pulse after an event has been detected. | DM370 series, DM470 series readers. |
| LIGHT.AIMER | Camera | PUBLIC | 6.1.6 | SET|GET | aimer-mode |
[0-1] |
0: Off 1: On |
Enables or disables the aimer. | DM370 series, DM470 readers. |
| LIGHT.DIRECT | Camera | PUBLIC | 6.1.6 | SET|GET | North Corners South East-West |
[ON|OFF]
[ON|OFF] [ON|OFF] [ON|OFF] |
enable/disable
enable/disable enable/disable enable/disable |
Enables or disables the HPIT quadrants. | DM370 series, DM470 series readers. |
| CAMERA.HDR-ESTIMATED-SCENE-KEY | Camera | PRIVATE | 6.1.0 | SET|GET | estimated scene key |
[0-4095] | Estimated scene key parameter for HDR | DM370 series, DM470 series readers. | |
| CAMERA.HDR-MODE | Camera | PUBLIC | 6.1.0 | SET|GET | mode |
[0-2] |
0: Off 1: Global 2: Local |
HDR mode | DM470 series readers. |
| TEMPERATURE.CPU | System | PRIVATE | 6.1.0 | GET | CPU Temperature in °C. | DM370 series, DM470 series readers. | |||
| TEMPERATURE.LL | System | PRIVATE | 6.1.0 | GET | Get Liquid lens Temperature in °C. Only available if a Liquid lens is present. |
DM370 series, DM470 series readers. | |||
| TEMPERATURE.SENSOR | System | PRIVATE | 6.1.0 | GET | Get Imager Temperature in °C. Only available if compatible image sensor is present. Readout can interfere with image acquisition. |
DM370 series, DM470 series readers. | |||
| DATAMATRIX.IDMAX-SCALE-UNCERTAINTY-PERCENTAGE | Decoder | PRIVATE | 6.0.1 | SET | percentage |
Specifies Scale Uncertainty Percentage. It is a parameter that allows or limits the tuned DataMatrix decoder to examine code that has different PPM than the originally tuned code. The percentage should be PPM1-PPM2)/PPM1 * 100. Active when IDMax is enabled. | ALL | ||
| DATAMATRIX.SCALE-UNCERTAINTY-PERCENTAGE | Decoder | PRIVATE | 6.0.1 | SET | percentage |
Specifies Scale Uncertainty Percentage. It is a parameter that allows or limits the tuned DataMatrix decoder to examine code that has a PPM different than the originally tuned code. The percentage should be (PPM1-PPM2)/PPM1 * 100. Used when IDQuick decoder is enabled. | ALL | ||
| FOCUS.CALIBRATE | Action | PRIVATE | 6.0.1 | Compute C-mount flange distance for early units and store in manufacturing data. | DM47x, DM37x | ||||
| MONITOR-MODE.ENABLE | Camera | PUBLIC | 6.0.1 | SET|GET | state |
[ON|OFF] | enable/disable | Enable/disable monitor mode. | ALL |
| SSH.UNLOCK | Action | PRIVATE | 6.0.1 | GET | The PC (host) sends this command to the reader to initiate the unlocking mechanism. As a response, the reader sends back a 32 byte random challenge to the PC. | DM474 | |||
| SSH.UNLOCK | Action | PRIVATE | 6.0.1 | SET | signature of the challenge |
The argument is the signature of the random challenge generated by the reader and signed with a public key on the PC side. The reader then verifies that the challenge was signed with the proper key and sent back in one minute. In this case, the SSH service is started on the reader, otherwise, an invalid parameter error is returned. | DM474 | ||
| CODABAR.XMT-START-STOP-CHAR | Decoder | PRIVATE | 6.0.0 | SET|GET | state |
[ON|OFF] |
ON: Enable OFF: Disable |
Enable or disable transmitting start and stop character as part of the decoded string. | Ethernet readers |
| DECODER.1D-SHORT-HEIGHT-CODES | Decoder | PRIVATE | 6.0.0 | SET|GET | state |
[ON|OFF] |
ON: Enable OFF: Disable |
Enable or disable Short Height Codes. | Ethernet readers |
| DECODER.CENTERING-WINDOW | Decoder | PUBLIC | 6.0.0 | SET|GET | center x perc, center y perc, size x perc, size y perc |
[0-100] | Percentage | Location and size of centering window as a percentage of the sensor size. | DM50, DM60, DM70, DM150 DM260, DM300, DM360, DM474, MX-1000 series |
| DECODER.DISPLAY-TARGET | Decoder | PUBLIC | 6.0.0 | SET|GET | state |
[ON|OFF] | Enable/Disable | Displays centering window graphics. | DM50, DM60, DM70, DM150 DM260, DM300, DM360, DM474, MX-1000 series |
| DECODER.USE-CENTERING | Decoder | PUBLIC | 6.0.0 | SET|GET | state |
[ON|OFF] | Enable/Disable | Only reads codes within the centering window. | DM50, DM60, DM70, DM150, DM260, DM300, DM360, DM474, MX-1000 series |
| LIGHT.DIRECT | Camera | PUBLIC | 5.7.7 | SET|GET | state |
[ON|OFF] | enable/disable | Turns on/off light banks for the 8072V. Verification should only take place with lighting combinations that can be described as 30 single, 30T (opposite sides), 30Q (all 30 panels), 45Q (all 45 panels), or 90. Other lighting combinations are allowed by the firmware, but will not result in valid verification result. | DM8072 Verifier |
| TRUCHECK.AG | Decoder | PUBLIC | 5.7.7 | GET | Returns the AG (average grade) score from the last verification attempt. | DM8072 Verifier | |||
| TRUCHECK.AG-GRADE | Decoder | PUBLIC | 5.7.7 | GET | Returns the AG (average grade) grade from the last verification attempt. | DM8072 Verifier | |||
| TRUCHECK.ANU | Decoder | PUBLIC | 5.7.7 | GET | Returns the ANU (axial non-uniformity) score from the last verification attempt. | DM8072 Verifier | |||
| TRUCHECK.ANU-GRADE | Decoder | PUBLIC | 5.7.7 | GET | Returns the ANU (axial non-uniformity) grade from the last verification attempt. | DM8072 Verifier | |||
| TRUCHECK.DECODE-GRADE | Decoder | PUBLIC | 5.7.7 | GET | Returns the DECODE grade from the last verification attempt. | DM8072 Verifier | |||
| TRUCHECK.FPD | Decoder | PUBLIC | 5.7.7 | GET | Returns the FPD (fixed pattern damage) score from the last verification attempt. | DM8072 Verifier | |||
| TRUCHECK.FPD-GRADE | Decoder | PUBLIC | 5.7.7 | GET | Returns the FPD (fixed pattern damage) grade from the last verification attempt. | DM8072 Verifier | |||
| TRUCHECK.GNU | Decoder | PUBLIC | 5.7.7 | GET | Returns the GNU (grid non-uniformity) score from the last verification attempt. | DM8072 Verifier | |||
| TRUCHECK.GNU-GRADE | Decoder | PUBLIC | 5.7.7 | GET | Returns the GNU (grid non-uniformity) grade from the last verification attempt. | DM8072 Verifier | |||
| TRUCHECK.MOD-GRADE | Decoder | PUBLIC | 5.7.7 | GET | Returns the MOD (modulation) grade from the last verification attempt. | DM8072 Verifier | |||
| TRUCHECK.RM-GRADE | Decoder | PUBLIC | 5.7.7 | GET | Returns the RM grade from the last verification attempt. | DM8072 Verifier | |||
| TRUCHECK.SC | Decoder | PUBLIC | 5.7.7 | GET | Returns the SC (symbol contrast) score from the last verification attempt. | DM8072 Verifier | |||
| TRUCHECK.SC-GRADE | Decoder | PUBLIC | 5.7.7 | GET | Returns the SC (symbol contrast) grade from the last verification attempt. | DM8072 Verifier | |||
| TRUCHECK.UEC | Decoder | PUBLIC | 5.7.7 | GET | Returns the UEC (unused error correction) score from the last verification attempt. | DM8072 Verifier | |||
| TRUCHECK.UEC-GRADE | Decoder | PUBLIC | 5.7.7 | GET | Returns the UEC (unused error correction) grade from the last verification attempt. | DM8072 Verifier | |||
| DECODER.ALLOW-ALL-MST-RESULTS | Decoder | PUBLIC | 5.7.3 | SET|GET | state |
[ON|OFF] |
ON: enable OFF: disable |
Enables or disables re-read delay processing for slave results. | DM300 series readers, DM474, DM503, DM70, DM150, DM260 |
| FOCUS.SWEEP-POWER | Camera | PUBLIC | 5.7.3 | SET|GET | Optical Power for near distance Optical Power for far distance |
liquid lens specific liquid lens specific |
Optical Power in Diopters Optical Power in Diopters |
Returns near (first value) and far (second value) optical power values. | Readers with Liquid Lens. |
| IMAGEBUFFER.AUTO-PREFER-CENTER | RecordPlayback | PUBLIC | 5.7.3 | SET|GET | Controls whether to use the decoders best symbol or the symbol closer to the ROI center. | DM50, DM60, DM70, DM474, DM503, DM300 series readers, DM8050 and DM8600. | |||
| MASTER-SLAVE.TEST-EFP-OUTPUT | Communication | PUBLIC | 5.7.3 | SET|GET | state |
[ON|OFF] |
ON: enable OFF: disable |
Enables or disables mst-test messages on the Industrial Protocol interfaces. | DM300 series readers, DM474. |
| MASTER-SLAVE.TIMEOUT-DISTANCE | Communication | PUBLIC | 5.7.3 | SET|GET | int |
[0-1000000] | Distance | The distance for a master slave timeout. | DM60, DM70, DM260, DM474, DM503, and DM300 series readers. |
| MASTER-SLAVE.TIMEOUT-MODE | Communication | PUBLIC | 5.7.3 | SET|GET | mode |
[0-1] |
0: Time 1: Distance |
Controls if the mater slave response timeout will be time or distance based. | DM60, DM260, DM474, DM503, and DM300 series readers. |
| ANDROID.AOA-SWITCH-TIMEOUT | Communication | PUBLIC | 5.7.1 | SET|GET | timeout [ms] |
0-3600000 | Timeout in milliseconds. | After boot the MX device won’t switch to AOA mode for this amount of time. | MX-1000, MX-1502 |
| ANDROID.ROLE | Communication | PUBLIC | 5.7.1 | SET|GET | role |
0-2 |
0: Auto 1: Device 2: AOA |
Sets the USB role of the MX device when in Android mode. | MX-1000, MX-1502 |
| ANDROID.USB-ROLE-CHANGE | Action | PRIVATE | 5.7.1 | SET|GET | enabled timeout |
[ON|OFF] |
ON: (default) role change enabled, reader operates as usual OFF: role change disabled, reader stays in device mode Timeout in seconds after which the role change is automatically enabled again. |
Disables the USB role change. If role change is disabled, the reader stays in device mode, meaning the phone is not charged. If the role change is disabled, a timeout must be provided in seconds after which the role change is automatically enabled again. | ALL |
| BEEPER.ENABLED | IO | PUBLIC | 5.7.1 | SET|GET | state |
[ON|OFF] | Enable/disable beeper in general. | All | |
| C11.CHKCHAR | Symbology | PUBLIC | 5.7.1 | SET|GET | state |
[ON|OFF] |
ON: enable OFF: disable (default) |
Code 11 Check Character | Mobile |
| C11.CHKCHAR-OPTION | Symbology | PUBLIC | 5.7.1 | SET|GET | int |
[0-1] |
0: disable 1: enable (default) |
Mobile | |
| C11.CODESIZE | Symbology | PUBLIC | 5.7.1 | SET|GET | any, min, max |
[ON|OFF] [1-max] [min-80] |
any length code minimum code length maximum code length |
Code 11 Code Size | ALL |
| DECODER.EFFORT | Decoder | PUBLIC | 5.7.1 | SET|GET | int |
[0-5] | Sets the effort level used by the decoding algorithms. Default is 2. | All | |
| DECODER.MAC-SCAN-TIMEOUT | Decoder | PUBLIC | 5.7.1 | SET|GET | int |
[0-60] | DM50, DM60, DM70, DM150 DM260, DM300, DM360, DM474, MX-1000, MX1502 | ||
| DECODER.TARGET-DECODING | Decoder | PUBLIC | 5.7.1 | SET|GET | state |
[ON|OFF] | enable/disable | Enable target decoding, where the reader attempts to symbols that lie only under the aiming dots. | MX-1000, MX-1502 series readers. |
| FLASH.AT70-INIT | Action | PRIVATE | 5.7.1 | magic |
647391673 | Magic number | This command clears AT70 Config block in flash memory. | AT70 based devices | |
| FOCUS.POWER-RANGE | Camera | PRIVATE | 5.7.1 | GET | Optical Power |
[liquid lens specific] | Optical Power in Diopters | Return minimum (first value) and maximun (second value) optical power values. | Readers with Liquid Lens |
| IMAGE.FETCH | Camera | PRIVATE | 5.7.1 | size format quality |
[0-3] [0-2] [10, 15, 20... 85, 90] |
0: Full 1: 1/4 2: 1/16 3: 1/64 0: Bitmap 1: JPEG 2: PNG JPEG quality |
Acquires an image and transfers it. | ||
| MONITOR-MODE.AUTOEXPOSURE | Camera | PUBLIC | 5.7.1 | SET|GET | state |
[ON|OFF] | enable/disable | Enable/disable autoregulation while in monitor mode. | ALL |
| MONITOR-MODE.DECODE-ENABLE | Camera | PUBLIC | 5.7.1 | SET|GET | mode |
[ON|OFF] | enable/disable | ALL | |
| SYMBOL.C11 | Symbology | PUBLIC | 5.7.1 | SET|GET | state |
[ON|OFF] | enable/disable | Enable Code 11 Symbology. | ALL |
| SYMBOL.COOP | Symbology | PUBLIC | 5.7.1 | SET|GET | state |
[ON|OFF] | enable/disable | ALL | |
| SYMBOL.IATA | Symbology | PUBLIC | 5.7.1 | SET|GET | state |
[ON|OFF] | enable/disable | ALL | |
| SYMBOL.INVERTED | Symbology | PUBLIC | 5.7.1 | SET|GET | state |
[ON|OFF] | enable/disable | ALL | |
| SYMBOL.ITF14 | Symbology | PUBLIC | 5.7.1 | SET|GET | state |
[ON|OFF] | enable/disable | ALL | |
| UPC-EAN.EAN13 | Symbology | PUBLIC | 5.7.1 | SET|GET | state |
[ON|OFF] | enable/disable | UPC/EAN Allow EAN13. | ALL |
| UPC-EAN.EAN8 | Symbology | PUBLIC | 5.7.1 | SET|GET | state |
[ON|OFF] | enable/disable | UPC/EAN Allow EAN8. | ALL |
| UPC-EAN.UPC-A | Symbology | PUBLIC | 5.7.1 | SET|GET | state |
[ON|OFF] | enable/disable | UPC/EAN UPC-A enabled. | ALL |
| UPC-EAN.UPC-E | Symbology | PUBLIC | 5.7.1 | SET|GET | state |
[ON|OFF] | enable/disable | UPC/EAN UPC-E enabled. | ALL |
| UPC-EAN.UPCE1 | Symbology | PUBLIC | 5.7.1 | SET|GET | state |
[ON|OFF] | enable/disable | UPC/EAN UPCE1 enabled. | ALL |
| AZTEC.TRAINED-MODEL | Decoder | PUBLIC | 5.7.0 | SET|GET | grid size module size polarity |
[15-151] [1-1000] [0-2] |
Grid size Module size * 10 0: dark-on-light 1: light-on-dark 2: either |
Set training parameters for Aztec symbology. | Fixed-mount readers |
| BACKUP.EXPORT | Action | PUBLIC | 5.7.0 | Exports a human readable version of the current reader backup. | ALL | ||||
| BEEP.GLOBAL-ENABLE | Action | PUBLIC | 5.7.0 | SET|GET | state |
[ON|OFF] |
ON: enable OFF: disable |
This command will disable all beeps on the DataMan product. | DM8050, DM8600 |
| CAMERA.GAIN-LIMIT | Camera | PUBLIC | 5.7.0 | SET|GET | gain |
[1.00-max_gain] | 1.00-max_gain: The maximum gain to use | Controls the maximum gain the tuning and auto-regulation process uses to find the best reader settings. Useful to limit noise in Images. | Fixed mount readers. |
| COM.ALTERNATE-MODE-DISABLE | Decoder | PRIVATE | 5.7.0 | SET|GET | enable |
[ON|OFF] |
ON: alternate mode cable detection enabled OFF: alternate mode cable detection disabled |
Disables alternate mode cable detection. | DM70 |
| COM.PROTOCOL | Communication | PUBLIC | 5.7.0 | SET|GET | type |
0..1 |
0: Off 1: RTS/CTS |
Sets hardware handshake type of serial port. | Devices with RTS/CTS lines |
| CONFIG.EXPORT | Action | PUBLIC | 5.7.0 | Exports a human readable version of the current reader configuration. | ALL | ||||
| DEVICE.DESCRIPTION | System | PUBLIC | 5.7.0 | SET|GET | state |
[0-127] | description | Store device description for inventory management. | ALL |
| DEVICE.TIMEZONE | Action | PUBLIC | 5.7.0 | SET|GET | timezone |
Location or POSIX timezone | Get or set the timezone for local time. | All | |
| ENCODER.DOUBLE-RATE | IO | PUBLIC | 5.7.0 | SET|GET | boolean |
[ON|OFF] | Edge detection | If set to ON, Encoder will count both edges on the Encoder Input line. If set to OFF, Encoder will count only the selected edge. | DM503 |
| ERROR-LED.ON-TIME-MS | System | PUBLIC | 5.7.0 | SET|GET | duration |
Sets the duration for the Error LED in ms. Use 0 for unlimited duration. | All devices with an error LED. | ||
| FILE.SAVE | Action | PRIVATE | 5.7.0 | filename |
This command can be used to load file from flash, e.g. FILE.SEND "/files/vs.cfg". | ALL | |||
| FOCUS.EXTENDED-RANGE | Camera | PUBLIC | 5.7.0 | GET | value |
[ON|OFF] | Extended Focus Range | Indicates that the reader operates in the extended focus range of ON. In this mode GET FOCUS.DISTANCE will return with an error. | Fixed-mount readers with Liquid Lens |
| FOCUS.EXTENDED-RANGE-START | Camera | PRIVATE | 5.7.0 | SET|GET | distance |
[50..4000] | define start of extended range | Defines the start of the extended focus range. Above this distance only optical power can be used to control the Liquid Lens. | Fixed-mount readers with Liquid Lens |
| FOCUS.POWER | Camera | PUBLIC | 5.7.0 | SET|GET | optical power |
[-6.0 .. 20.00] | Optical Power in Diopters | Conrols the optical power of the liquid lens. The actual range is dependent on the hardware and on manufacturing tolerances. | Fixed-mount readers with Liquid Lens |
| FOCUS.PRECISION | Camera | PUBLIC | 5.7.0 | SET|GET | settle mode |
[0..1] |
0: normal focus control 1: precise focus control |
Controls the liquid lens focus control between normal focus control and slow but more precise mode. | Fixed mount readers with a liquid lens. |
| FOCUS.PROGRESS | Camera | PUBLIC | 5.7.0 | SET|GET | enable |
[ON|OFF] |
ON: focus progress on OFF: focus progress off |
Enable transfer of intermittent focus images during adjust focus. | Fixed mount readers with a liquid lens. |
| FOCUS.TEMPERATURE-COMPENSATIONS | Camera | PRIVATE | 5.7.0 | SET|GET | state |
ON/OFF | Enable or disable the temperature compensation for the liquid lense HSLC. | Fixed mount readers with a Liquid Lens. | |
| FTP-PCM-REPORT.CUSTOM-FILE-NAME | Communication | PUBLIC | 5.7.0 | SET|GET | state |
ON/OFF |
enable disable |
Enable/disable customize file name generation (if disabled the FTP server has to generate a unique name). | Ethernet readers |
| FTP-PCM-REPORT.ENABLE | Communication | PUBLIC | 5.7.0 | SET|GET | enable |
ON/OFF | Enable or disable a PCM Report FTP connection. | Ethernet readers | |
| FTP-PCM-REPORT.FILE-NAME | Communication | PUBLIC | 5.7.0 | SET|GET | string |
File name of PCM Report. | Ethernet readers | ||
| FTP-PCM-REPORT.FILE-NAME-USE-SCRIPT | Communication | PUBLIC | 5.7.0 | SET|GET | state |
ON/OFF |
enable disable |
Enables PCM report file name generation by script. | Ethernet readers |
| FTP-PCM-REPORT.IDLE-LIMIT | Communication | PUBLIC | 5.7.0 | SET|GET | state |
ON/OFF |
enable disable |
Limit duration of idle connections after a data transfer. | Ethernet readers |
| FTP-PCM-REPORT.IDLE-TIME | Communication | PUBLIC | 5.7.0 | SET|GET | seconds |
[0-3600] | Maximum duration of idle connections after a data transfer. | Ethernet readers | |
| FTP-PCM-REPORT.IP-ADDRESS | Communication | PUBLIC | 5.7.0 | SET|GET | server |
IP address or DNS name | Set the PCM Report FTP server. | Ethernet readers | |
| FTP-PCM-REPORT.MAX-APPEND | Communication | PUBLIC | 5.7.0 | SET|GET | value |
[0-65535] | Max increment value to append to PCM report file name. | Ethernet readers | |
| FTP-PCM-REPORT.MAX-APPEND-START-VALUE | Communication | PUBLIC | 5.7.0 | SET|GET | value |
[0-65535] | Initial increment value to append to PCM report file name. | Ethernet readers | |
| FTP-PCM-REPORT.PASSWORD | Communication | PUBLIC | 5.7.0 | SET|GET | string |
PASSWORD used to login to target PCM Report FTP server. | Ethernet readers | ||
| FTP-PCM-REPORT.PORT | Communication | PUBLIC | 5.7.0 | SET|GET | port |
[0-65535] | PCM Report FTP server port number. | Ethernet readers | |
| FTP-PCM-REPORT.SCRIPT-ERROR | Communication | PUBLIC | 5.7.0 | GET | message |
script error message | Gets the script error message for FTP PCM report file name generation. | Ethernet readers | |
| FTP-PCM-REPORT.SERVER-PATH | Communication | PUBLIC | 5.7.0 | SET|GET | string |
Path for PCM Reports which has to be named by the FTP Server. | Ethernet readers | ||
| FTP-PCM-REPORT.SERVER-TYPE | Communication | PUBLIC | 5.7.0 | SET|GET | type |
[0-2] |
0: Generic 1: Mitsubishi GOT 2: SFTP(encrypted) |
FTP server type. | Ethernet readers |
| FTP-PCM-REPORT.USER-NAME | Communication | PUBLIC | 5.7.0 | SET|GET | string |
Username used to login to target PCM Report FTP server. | Ethernet readers | ||
| HPT.CHANNEL-ENABLED | Action | PRIVATE | 5.7.0 | SET|GET | channel_name, state |
[ON|OFF] string, [ON|OFF] | enable/disable Channel name. Switch state. | Enables or disables a given HPT log channel. | ALL |
| HPT.LOG | Action | PRIVATE | 5.7.0 | GET | Retrieves the HPT log as a binary file content. | ALL | |||
| LIGHT.LOW-ANGLE | Camera | PUBLIC | 5.7.0 | SET|GET | state |
[ON|OFF] [ON|OFF] | enable/disable low-angle illumination | Controls the DM262 UHD low-angle illumination. | DM262 |
| LIGHT.ON-AXIS | Camera | PUBLIC | 5.7.0 | SET|GET | state |
[ON|OFF] [ON|OFF] | enable/disable on-axis illumination | Controls the DM262 UHD on-axis illumination. | DM262 |
| LIGHT.ON-AXIS-INTENSITY | Camera | PRIVATE | 5.7.0 | SET|GET | intensity |
[0..3] | on-axis illumination intensity | Controls the intensity of the DM262 UHD on-axis illumination. | DM262 |
| LIGHTRING.DURATION | IO | PUBLIC | 5.7.0 | SET|GET | duration |
[0..10000] |
0: Default behavior 10..10000: duration of lightring event in ms, step 10 ms |
Controls the duration of the lightring illumination event. | DM36x, DM474 and DM503 |
| MAXICODE.TRAINED-MODEL | Decoder | PUBLIC | 5.7.0 | SET|GET | module size |
[1-1000] | Module size * 10 | Set training parameters for MaxiCode symbology. | Fixed-mount readers |
| MOTION-DETECTION.ACTIVE | Action | PUBLIC | 5.7.0 | GET | state |
[ON|OFF] |
ON: Active or Lights Off OFF: Inactive or Lights On |
Allows checking the current state of motion detection for presentation or self-internal trigger mode. | DM50, DN60, DM70, DM150, DM260, DM300, DM360, DM474. |
| MOTION-DETECTION.ENABLE | Action | PUBLIC | 5.7.0 | SET|GET | state |
[ON|OFF] |
ON: enable OFF: disable |
Enables or disables motion detection for Presentation trigger mode. | DM50, DN60, DM70, DM150, DM260, DM300, DM474, DM503. |
| MOTION-DETECTION.INIT-STATE | Action | PRIVATE | 5.7.0 | SET|GET | state |
[ON|OFF] | enable/disable ON: motion detection is default state\n; OFF: switch to motion detection state after timeout | Specify the motion detection default state. | DM50, DM60, DM70, DM150, DM260, DM300, DM474, DM503. |
| MOTION-DETECTION.SENSITIVITY | Action | PUBLIC | 5.7.0 | SET|GET |
|
[0|2] |
0: Low 1: Medium 2: High |
Sets or gets the motion detection sensitivity level when in presentation mode. | DM50, DM60, DM70, DM150, DM260, DM300, DM474, DM503. |
| MOTION-DETECTION.TIMEOUT | Action | PRIVATE | 5.7.0 | SET|GET | [0 - 3600] | sec | Time after the reader switches into the motion detection mode. | DM50, DM60, DM70, DM150, DM260, DM300, DM474, DM503. | |
| NET-LOCAL.PCAP | System | PRIVATE | 5.7.0 | SET|GET | interface |
interface | Retrieves packet capturing buffer. | ALL | |
| NTP.ENABLE | Communication | PUBLIC | 5.7.0 | SET|GET | state |
[ON|OFF] | enable/disable Enable/Disable | Enables or disables NTP. | All |
| NTP.SERVER1 | Communication | PUBLIC | 5.7.0 | SET|GET | server |
IP address or DNS name | Set the NTP server 1. | All | |
| NTP.SERVER2 | Communication | PUBLIC | 5.7.0 | SET|GET | server |
IP address or DNS name | Set the NTP server 2. | All | |
| PCM-RESULT-STRING.EXTEND | Decoder | PUBLIC | 5.7.0 | SET|GET | enable |
[ON|OFF] | Enable or disable extending the result string with metric information. | Ethernet readers. | |
| PCM-RESULT-STRING.METRIC-FORMAT | Decoder | PUBLIC | 5.7.0 | SET|GET | type |
[0-2] |
0: Grade 1: Value 2: Grade + Value |
Set the format of a single metric entry. | Ethernet readers. |
| PCM-RESULT-STRING.METRIC-PREFIX | Decoder | PUBLIC | 5.7.0 | SET|GET | type |
[0-2] |
0: None 1: Acronym 2: Name |
Defines the prefix for a single metric entry. | Ethernet readers. |
| PCM-RESULT-STRING.METRIC-SEPARATOR | Decoder | PUBLIC | 5.7.0 | SET|GET | string |
Defines the metric separator. | Ethernet readers. | ||
| PCM-RESULT-STRING.OVERALL-GRADE | Decoder | PUBLIC | 5.7.0 | SET|GET | type |
[ON|OFF] | enable | Enables or disables showing the overall grade in at the beginning of the result string. | Ethernet readers. |
| PCM-RESULT-STRING.SEPARATOR | Decoder | PUBLIC | 5.7.0 | SET|GET | string |
Defines the main separator between result data and metric section. | Ethernet readers. | ||
| PCM.CUSTOM-DESCRIPTION | Decoder | PUBLIC | 5.7.0 | SET|GET | string |
Ethernet readers. | |||
| PCM.METRIC-PARM-OVERALL | Decoder | PUBLIC | 5.7.0 | SET|GET | type type state |
[0-5] [0-27] [ON|OFF] |
0: AIM-DPM 1: ISO-IEC 15415 2: ANSI-ISO-IEC 15416 3: SemiT10 4: 1D readability 5: DotCode Readybility 0: Symbol Contrast 1: Axial Non Uniformity 2: Print Growth 3: UEC 4: Modulation 5: Fixed Pattern Damage 6: Grid Non Uniformity 7: Extreme Reflectance 8: Reflect Min 9: Edge Contrast Min 10: Single Scan Int 11: Multi Scan Int 12: Signal To Noise Ratio 13: Horizontal Mark Growth 14: Vertical Mark Growth 15: Data Matrix Cell Width 16: Data Matrix Cell Height 17: Horizontal Mark Misplacement 18: Vertical Mark Misplacement 19: Cell Defects 20: Finder Pattern Defects 21: Overall Grade 22: Edge Determination 23: Defects 24: Reference Decode 25: Decodability 26: Contrast Uniformity 27: Reflectance Margin ON: use for overall calculation OFF: do not use for overall calculation |
Use the the metric grading result for calculating the overall result if enabled (e.g. AIM-DPM → Symbol Contrast → Use for Overall Calculation = ON) Not all metrics are available for each standard: AIM-DPM (0, 1, 2, 3, 4, 5, 6, 8), ISO-IEC 15415 (0, 1, 3, 4, 5, 6, 7), ANSI-ISO-IEC 15416 (1, 4, 8, 9, 22, 23, 24, 25), 1D readability (0, 2, 8, 9, 10, 11), DotCode (0, 1, 2, 3, 6, 8) | Ethernet readers. |
| PCM.METRIC-PARM-REPORT | Decoder | PUBLIC | 5.7.0 | SET|GET | type type state |
[0-5] [0-27] [ON|OFF] |
0: AIM-DPM 1: ISO-IEC 15415 2: ANSI-ISO-IEC 15416 3: SemiT10 4: 1D readability 5: DotCode Readybility 0: Symbol Contrast 1: Axial Non Uniformity 2: Print Growth 3: UEC 4: Modulation 5: Fixed Pattern Damage 6: Grid Non Uniformity 7: Extreme Reflectance 8: Reflect Min 9: Edge Contrast Min 10: Single Scan Int 11: Multi Scan Int 12: Signal To Noise Ratio 13: Horizontal Mark Growth 14: Vertical Mark Growth 15: Data Matrix Cell Width 16: Data Matrix Cell Height 17: Horizontal Mark Misplacement 18: Vertical Mark Misplacement 19: Cell Defects 20: Finder Pattern Defects 21: Overall Grade 22: Edge Determination 23: Defects 24: Reference Decode 25: Decodability 26: Contrast Uniformity 27: Reflectance Margin ON: include in report OFF: do not include in report |
Include the metric grading result for selected quality standard and metric in the report if enabled. Only available if not use for overall calculation (e.g. ISO-IEC 15415 → Modulation → Show in Report = ON) Not all metrics are available for each standard: AIM-DPM (0, 1, 2, 3, 4, 5, 6, 8), ISO-IEC 15415 (0, 1, 2, 3, 4, 5, 6, 7), ANSI-ISO-IEC 15416 (0, 4, 8, 9, 22, 23, 24, 25), SemiT10 (1, 4, 12, 13, 14, 15, 16, 17, 18, 19, 20), 1D readability (0, 2, 8, 9, 10, 11), DotCode (0, 1, 2, 3, 6, 8). | Ethernet readers. |
| PCM.METRIC-PARM-THRESHOLD | Decoder | PUBLIC | 5.7.0 | SET|GET | type type grade value |
[0-5] [0-25] [1-4] [0-1000] |
0: AIM-DPM 1: ISO-IEC 15415 2: ANSI-ISO-IEC 15416 3: SemiT10 4: 1D readability 5: DotCode Readybility 0: Symbol Contrast 1: Axial Non Uniformity 2: Print Growth 3: UEC 4: Modulation 5: Fixed Pattern Damage 6: Grid Non Uniformity 7: Extreme Reflectance 8: Reflect Min 9: Edge Contrast Min 10: Single Scan Int 11: Multi Scan Int 12: Signal To Noise Ratio 13: Horizontal Mark Growth 14: Vertical Mark Growth 15: Data Matrix Cell Width 16: Data Matrix Cell Height 17: Horizontal Mark Misplacement 18: Vertical Mark Misplacement 19: Cell Defects 20: Finder Pattern Defects 21: Overall Grade 22: Edge Determination 23: Defects 24: Reference Decode 25: Decodability 1: D 2: C 3: B 4: A Threshold raw value |
Set the raw value threshold for the selected quality standard, metric and grade (e.g. AIM-DPM → UEC → Threshold B = 50). Not all metrics are available for each standard: AIM-DPM (0, 1, 3, 4, 6, 8), ISO-IEC 15415 (0, 1, 3, 4, 6), ANSI-ISO-IEC 15416 (1, 4, 8, 9, 23, 25), 1D readability (0, 2, 8, 9, 11), DotCode (0, 1, 2, 3, 6, 8) | Ethernet readers. |
| PCM.MIN-PASS | Decoder | PUBLIC | 5.7.0 | SET|GET | type grade |
[0-5] [0-4] |
0: AIM-DPM 1: ISO-IEC 15415 2: ANSI-ISO-IEC 15416 3: SemiT10 4: 1D readability 5: DotCode Readybility 0: F 1: D 2: C 3: B 4: A |
Set the overall minimum passing grade. Results under this grade will mean the reading failed. | Ethernet readers. |
| PCM.USE-CUSTOM-THRESHOLDS | Decoder | PUBLIC | 5.7.0 | SET|GET | type state |
[0-5] [ON|OFF] |
0: AIM-DPM 1: ISO-IEC 15415 2: ANSI-ISO-IEC 15416 3: SemiT10 4: 1D readability 5: DotCode Readybility ON: do regrading OFF: keep current result |
Enable or disable regrading of metric results by using the custom thresholds. | Ethernet readers. |
| QR.TRAINED-MODEL | Decoder | PUBLIC | 5.7.0 | SET|GET | grid size module size model polarity mirrored |
[11-177] [1-1000] [0-3] [0-2] [ON|OFF] [ON|OFF] |
Grid size Module size * 10 0: Unknown model 1: Model-1 2: Model-2 3: Micro-QR 0: dark-on-light 1: light-on-dark 2: either enable/disable ON: mirrored OFF: not mirrored |
Set training parameters for QR-Code symbology. Option 3 for argument "model": Micro-QR is not applicable for 6.0.1. |
Fixed-mount readers |
| TLS.BENCHMARK | Action | PRIVATE | 5.7.0 | Starts a benchmark of the SSL/TLS library.This DMCC is password protected. The result can be checked in the HPT log output. | ALL | ||||
| TLS.SELFTEST | Action | PRIVATE | 5.7.0 | Starts a benchmark of the SSL/TLS library. This DMCC is password protected. The result can be checked in the HPT log output. | ALL | ||||
| TUNE.EXCLUDE-AMBIENT-RESULTS | Camera | PUBLIC | 5.7.0 | SET|GET | disable ambient |
[ON|OFF] |
ON: Disables the automatic selection of ambient light results OFF: Allows ambient light results for atomatic seletion |
Control the automatic selection of tuning results where the prevailing illumination type is ambient light. | Fixed mount readers. |
| UPTIME | Action | PUBLIC | 5.7.0 | Shows the time since device started. | All | ||||
| FTP-IMAGE.SERVER-TYPE | Communication | PUBLIC | 5.6.3 | SET|GET | type |
[0-2] |
0: Generic 1: Mitsubishi GOT 2: SFTP |
FTP image server type. 2 means that the server is an S(SH)FTP server. | DM474, DM503 and DM300 series readers. |
| FTP-RESULT.SERVER-TYPE | Communication | PUBLIC | 5.6.3 | SET|GET | type |
[0-2] |
0: Generic 1: Mitsubishi GOT 2: SFTP |
FTP server type.2 means that the server is an S(SH)FTP server. | DM474, DM503 and DM300 series readers. |
| IMAGE.FORMAT | Camera | PUBLIC | 5.6.3 | SET|GET | format |
[0-2] |
0: Bitmap 1: JPEG 2: PNG |
Image File Format. | ALL |
| IMAGE.SEND-BUFFER | Camera | PRIVATE | 5.6.3 | index size format quality |
[0-3] [0-2] [10, 15, 20... 85, 90] |
0: Full 1: 1/4 2: 1/16 3: 1/64 0: Bitmap 1: JPEG 2: PNG JPEG Quality |
Send specified image buffer date. | ||
| IMAGEBUFFER.FORMAT | RecordPlayback | PUBLIC | 5.6.3 | SET|GET | format |
[0-2] |
0: Bitmap 1: JPEG 2: PNG |
DM50, DM60, DM70, DM474, DM503, MX-1000, DM8000 series and DM300 series readers. | |
| LIVEIMG.SEND | Camera | PUBLIC | 5.6.3 | size format quality |
[0-3] [0-2] [10, 15, 20... 85, 90] |
0: Full 1: 1/4 2: 1/16 3: 1/64 0: Bitmap 1: JPEG 2: PNG JPEG Quality |
Request image transfer to PC when LIVEIMG.MODE is set to 3. | ||
| CAMERA.AUTO-REGULATION | Camera | PUBLIC | 5.6.0 | SET|GET | auto |
[ON|OFF] |
ON: Automatic OFF: Manual |
Camera Parameters where exposure is in microseconds. | DM50, DM60, DM70, DM150, DM260, DM300 series readers, DM360 series readers, DM474, DM503, DM8600 |
| CAMERA.EXPOSURE | Camera | PUBLIC | 5.6.0 | SET|GET | exposure |
[18-25000] | exposure | Camera Parameters where exposure is in microseconds. | DM50, DM60, DM70, DM150, and DM260 |
| CAMERA.EXPOSURE | Camera | PUBLIC | 5.6.0 | SET|GET | exposure |
[5-1000] [12-1000] [5-100000] |
DM300 and DM302 internal illumination DM303 internal illumination with external or no illumination |
Camera Parameters where exposure is in microseconds. | DM300 series readers, DM360 series readers, DM474, DM8600. |
| CAMERA.EXPOSURE | Camera | PUBLIC | 5.6.0 | SET|GET | exposure |
[12-100000] | exposure independent of illumination | Camera Parameters where exposure is in microseconds. | DM503 |
| CAMERA.TARGET-BRIGHTNESS | Camera | PUBLIC | 5.6.0 | SET|GET | target |
[0-255] | target pixel value | Camera Parameters where exposure is in microseconds. | All, except MX series readers. |
| LIGHT.POLARIZED | Camera | PUBLIC | 5.6.0 | SET|GET | polarized LED count |
[0|2|4] | Number of polarized filtered LEDs in the illumination | Use this command after applying a different HPIL front cover to publish the illumination filter status to the device. | DM70, DM150, DM260 |
| REBOOT.DELAYED | Action | PUBLIC | 5.6.0 | Reboot the Device after delay in seconds. Rebooting the Device restores the Configuration stored in Non-Volatile Memory. Commands will not be processed for several seconds while the device reboots.If communication settings are changed, connection with device may be lost. Note that when connected via USB-COM, the application must release the COM port. | All | ||||
| SYMBOL.4STATE-RMC | Symbology | PRIVATE | 5.6.0 | SET|GET | state |
[ON|OFF] | enable/disable Enable/Disable | Enables or disables Royal Mail Code Symbology. | DM50, DM60, DM70, DM150, DM260, DM30x, DM474, DM503, MX-1000, MX-1502. Mobile. |
| C25.CHKCHAR | Symbology | PUBLIC | 5.5.2 | SET|GET | state |
[ON|OFF] |
ON: enable OFF: disable |
Code 25 Check Character | ALL |
| C25.CODESIZE | Symbology | PUBLIC | 5.5.2 | SET|GET | any, min, max |
[ON|OFF] [1-max] [min-80] |
any length code minimum code length maximum code length |
Code 25 Code Size. For the Manatee Works SDK, all of the Code 25 variants use the same minimum length; thus it will accept either C25.CODESIZE or I205.CODESIZE. | ALL |
| C25.QZ-SIZE | Symbology | PUBLIC | 5.5.2 | SET|GET | size |
[0..100] | any length code | Sets or gets the single side strictness as a percentage. | ALL |
| C25.XMTCHK | Symbology | PUBLIC | 5.5.2 | SET|GET | state |
[ON|OFF] |
ON: enable OFF: disable |
Sets or gets whether to transmit the check digit. | ALL |
| SYMBOL.C25 | Symbology | PUBLIC | 5.5.2 | SET|GET | state |
[ON|OFF] | enable/disable | Enable Code 25 Symbology. Manatee Works supports 7 subcodes: Standard, Interleaved, ITF-14, IATA, Matrix, COOP, and Inverted. | ALL |
| BATTERY.INFO | System | PUBLIC | 5.5.1 | GET | battery |
[0-1] |
0: internal battery 1: grip battery |
Gets verbose battery status. | MX-1000 |
| BUTTON.ACTION | IO | PUBLIC | 5.5.1 | SET|GET | button action |
[0-2] [0-1] |
Index of button (0:Left;1:Right;2:Grip) 0: disabled 1: trigger |
Sets and gets the assigned feature for hardware buttons. | MX-1000 |
| DEVICE.CGNM-DEV-TYPE | System | PRIVATE | 5.5.1 | GET | Returns the CogNamer device type. | ALL | |||
| 3DVECTOR.CALIBRATED | Action | PRIVATE | 5.5.0 | GET | calibration_status |
[0-2] |
0:Neither factory, nor field calibration present 1:Only factory calibration loaded 2:Factory and field calibration loaded |
Query current calibration status. | ALL |
| 3DVECTOR.ENABLED | Action | PRIVATE | 5.5.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enables/disables the 3DVectoring functionality on the reader. | ALL |
| 3DVECTOR.FCALIB-CVL.LOAD | Action | PRIVATE | 5.5.0 | size_bytes |
Load factory calibration data blob in CVL style. | ALL | |||
| 3DVECTOR.FCALIB-CVL.SEND | Action | PRIVATE | 5.5.0 | Send factory calibration data blob in CVL style. | ALL | ||||
| 3DVECTOR.FCALIB-CVT.LOAD | Action | PRIVATE | 5.5.0 | size_bytes |
Load factory calibration data blob in CVT style. | ALL | |||
| 3DVECTOR.FCALIB-CVT.SEND | Action | PRIVATE | 5.5.0 | Send factory calibration data blob in CVT style. | ALL | ||||
| 3DVECTOR.LENGTH | Action | PRIVATE | 5.5.0 | SET|GET | This sets/gets the length of the output 3D line segment. | ALL | |||
| 3DVECTOR.SCALIB.LOAD | Action | PRIVATE | 5.5.0 | size_bytes |
Load system calibration data blob. | ALL | |||
| 3DVECTOR.SCALIB.SEND | Action | PRIVATE | 5.5.0 | Send system calibration data blob. | ALL | ||||
| CAMERA.EXPOSURE-LIMIT-US | Camera | PUBLIC | 5.5.0 | GET | exposure |
maximum value allowed for SET CAMERA.EXPOSURE-US | Get the maximum allowed exposure limited by current settings in us. | Fixed Mount readers. | |
| CAMERA.EXPOSURE-US | Camera | PUBLIC | 5.5.0 | SET|GET | auto target exposure gain |
[ON|OFF] [0-255] [18-25000] [0-60] |
ON: Automatic OFF: Manual target pixel value exposure camera gain |
Camera Parameters where exposure is in microseconds. The argument 'exposure' and 'gain' has no effect if 'auto' is ON and 'target' has no effect at all. | DM50, DM60, DM70, DM150, DM260 |
| CAMERA.EXPOSURE-US | Camera | PUBLIC | 5.5.0 | SET|GET | auto target exposure gain |
[ON|OFF] [0-255] [5-1000] [12-1000] [5-100000] [0-106] |
ON: Automatic OFF: Manual target pixel value DM300 and DM302 internal illumination DM303 internal illumination with external or no illumination camera gain |
Camera Parameters where exposure is in microseconds. The argument 'exposure' and 'gain' has no effect if 'auto' is ON and 'target' has no effect at all. | DM300 series readers, DM360 series readers, DM474, DM8600. |
| CAMERA.EXPOSURE-US | Camera | PUBLIC | 5.5.0 | SET|GET | auto target exposure gain |
[ON|OFF] [0-255] [12-100000] [0-41] |
ON: Automatic OFF: Manual target pixel value exposure independent of illumination camera gain |
Camera Parameters where exposure is in microseconds. The argument 'exposure' and 'gain' has no effect if 'auto' is ON and 'target' has no effect at all. | DM503 |
| CAMERA.EXPOSURE-US | Camera | PUBLIC | 5.5.0 | SET|GET | auto target exposure gain |
[ON|OFF] [0-255] [50-25000] [0-60] |
ON: Automatic OFF: Manual target pixel value camera gain |
Camera Parameters where exposure is in microseconds. The argument 'exposure' and 'gain' has no effect if 'auto' is ON and 'target' has no effect at all. | MX-1000 and DM8000 series readers. |
| CAMERA.FULL-BLACK-LEVEL-CORRECTION | Camera | PUBLIC | 5.5.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enables Full black level correction. | DM300 series readers, DM474. |
| CAMERA.GAIN | Camera | PUBLIC | 5.5.0 | SET|GET | gain |
[1.00-31.76] | The gain has no effect if the camera runs with automatic exposure | DM300 series readers, DM474. | |
| CAMERA.GAIN | Camera | PUBLIC | 5.5.0 | SET|GET | gain |
[1.00-13.88] | The gain has no effect if the camera runs with automatic exposure | DM503 | |
| CAMERA.GAIN | Camera | PUBLIC | 5.5.0 | SET|GET | gain |
[1.00-15.00] | The gain has no effect if the camera runs with automatic exposure | DM50, DM60, DM70 | |
| CAMERA.XPAND-ROI | Camera | PUBLIC | 5.5.0 | SET|GET | ROI index left right top bottom |
[1-2] [0 - sensor width] [0 - sensor width] [0 - sensor height] [0 - sensor height] |
ROI index pixels from left pixels from right pixels from top pixels from bottom |
Specifies custom FOVE regions. Requires the 1DDataStitching feature key. |
DM70, DM150, DM260, DM300 series readers, DM474, DM503. |
| CAMERA.XPAND-ROI-TYPE | Camera | PUBLIC | 5.5.0 | SET|GET | int |
[0-3] |
0: None 1: Xpand-15 2: Xpand-25 3: Custom |
Indicates the used FOVE type. Requires the 1DDataStitching feature key. |
DM70, DM150, DM260, DM300 series readers, DM474, DM503. |
| COM.RS232-ENABLE-PAUSE | Communication | PUBLIC | 5.5.0 | SET|GET | mode |
ON/OFF | Enable/disable pause in output data stream. | DM300 series readers, DM60, DM50, DM70, DM474 | |
| COM.RS232-INTERCHAR-DELAY | Communication | PUBLIC | 5.5.0 | SET|GET | us |
[0-5000] | milliseconds | Sets or gets the internal delay between sending characters to the serial port. | DM300 series readers, DM60, DM50, DM70, DM360 series readers, DM474, DM503 |
| COM.SCRIPT | Communication | PUBLIC | 5.5.0 | SET|GET | num-bytes |
GET: Retrieves the current communication script. SET: Uploads a communication script. | Fixed-mount readers. | ||
| COM.SCRIPT-ENABLED | Communication | PUBLIC | 5.5.0 | SET|GET | bool |
Enables/disables communication scripting or retrieves current state. | Fixed-mount readers. | ||
| COM.SCRIPT-ERROR | Communication | PUBLIC | 5.5.0 | GET | message |
script error message | Get the error message for the Custom Communication protocol script | Fixed-mount readers. | |
| COM.USB-REQUIRE-DTR | Communication | PUBLIC | 5.5.0 | SET|GET | state |
[ON|OFF] [ON|OFF] | enable/disable Enable/Disable | Turns the requirement to assert DTR signal during USB communication On or Off. | DM8050 |
| CONFIG-BACKUP.SERVER-TYPE | Communication | PUBLIC | 5.5.0 | SET|GET | type |
[0-1] |
0: Generic 1: Mitsubishi GOT |
Configuration backup server type. | DM474, DM503 and DM300 series readers. |
| DATA.RESULT-TYPE | System | PUBLIC | 5.5.0 | SET|GET | bit-field |
[0,1,512] |
0 = None 1 = Result 512 = MS test response |
Controls automatic, result transmitted from reader. Default bits are 1 and 512 (which is 513). | ALL |
| DATAMATRIX.DAMAGE | Decoder | PUBLIC | 5.5.0 | SET|GET | damage level |
[2,4] |
2: moderate 4: extreme |
Set Extreme to enable PowerGrid. | DM300 series readers, DM360, DM474 readers |
| DATAMATRIX.TRAINED-MODEL | Decoder | PUBLIC | 5.5.0 | SET|GET | rows columns module-size polarity mirrored |
[8-144] [8-144] [1-1000] [0-2] [ON|OFF] |
Number of rows Number of columns Module size * 10 0: dark-on-light 1: light-on-dark 2: either ON: mirrored OFF: not mirrored |
Train Data Matrix from the given parameters without needing to capture an image. | Fixed-mount readers |
| DECODER.1D-DATA-STITCH | Decoder | PUBLIC | 5.5.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enables/disables 1D data-stitching. Requires the 1DDataStitching feature key. |
DM70, DM150, DM260, DM300 series readers, DM474, DM503. |
| DECODER.1D-EXTENDED-RESOLUTION | Decoder | PUBLIC | 5.5.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enables/disables the 1D extended resolution decoding method. Requires the 1DExtendedRes feature key. |
DM70, DM150, DM260, DM300 series readers, DM474, DM503. |
| DECODER.NO-READ-FEEDBACK | Decoder | PRIVATE | 5.5.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enables/disables found but not decoded symbol info. | ALL |
| DEVICE.SCRIPT-HEAP-SIZE-LIMIT | Communication | PRIVATE | 5.5.0 | SET|GET | size |
204800-2147483647 | Maximum size in bytes | Maximum heap size the script engine may allocate. | Fixed mount readers |
| DEVICE.SCRIPT-HEAP-USAGE-CURRENT | Communication | PRIVATE | 5.5.0 | GET | size |
Currently used heap size | The size of heap the script currently allocates. | Fixed mount readers | |
| DEVICE.SCRIPT-HEAP-USAGE-MAX | Communication | PRIVATE | 5.5.0 | GET | size |
Maximum used heap size | The maximum size of heap the script allocated allocated. | Fixed mount readers | |
| DOTCODE.QUALITY-METRICS | Decoder | PRIVATE | 5.5.0 | SET|GET | mode |
[0-1] |
0: none 1: enable AIM metrics |
Enable Subset of Quality Metrics from DotCode AIM Specification. | DM474, DM503, DM300 series readers, DM8050X and DM8600. |
| ENCODER.MODE | IO | PUBLIC | 5.5.0 | SET|GET | value |
[0-4] |
0: Encoder A signal counts up, Encoder B signal counts down. 1: Encoder A signal counts up, Encoder B signal counts down. 2: Encoder A and Encoder B form quadrature (SIN/COS) signal, 1 count per cycle. 3: Encoder A and Encoder B form quadrature (SIN/COS) signal, 2 counts per cycle. 4: Encoder A and Encoder B form quadrature (SIN/COS) signal, 4 counts per cycle. |
Encoder mode. Sets the mode the encoder signals are interpreted if the Encoder Direction pin is defined. | Fixed-mount readers |
| ENCODER.RESET | IO | PUBLIC | 5.5.0 | Resets the encoder count to 0 and clears all encoder related events. | Fixed-mount readers | ||||
| FTP-IMAGE.IDLE-LIMIT | Communication | PUBLIC | 5.5.0 | SET|GET | state |
[ON|OFF] | enable/disable | Limit duration of idle connections. | DM474, DM503 and DM300 series readers. |
| FTP-IMAGE.IDLE-TIME | Communication | PUBLIC | 5.5.0 | SET|GET | seconds |
Maximum duration of telling the FTP server that the reader is alive. | DM474, DM503 and DM300 series readers. | ||
| FTP-IMAGE.SERVER-PATH-SCRIPT-ERROR | Communication | PUBLIC | 5.5.0 | GET | message |
script error message | Gets the script error message for FTP Storage name generation . | Fixed-mount readers. | |
| FTP-RESULT.IDLE-LIMIT | Communication | PUBLIC | 5.5.0 | SET|GET | state |
[ON|OFF] | enable/disable | Limit duration of idle connections after a data transfer. | DM474, DM503 and DM300 series readers. |
| FTP-RESULT.IDLE-TIME | Communication | PUBLIC | 5.5.0 | SET|GET | seconds |
[0-3600] | Maximum duration of idle connections after a data transfer. | DM474, DM503 and DM300 series readers. | |
| IMAGE.LOAD-FTP-MULT-PARAM | IO | PRIVATE | 5.5.0 | SET | server_ip picture last_image more burst_count buffer-overflow seq_nbr ” ” ”user” ”passwd” port |
[ON|OFF] [3] [0-1] |
Server IP Picture name enable/disable Number of images to take 0: Off 1: On Sequence number in the burst User name Password Port used |
Allows uploading of multiple pictures as a burst. | ALL |
| IMAGE.SEND | Action | PUBLIC | 5.5.0 | Retrieve the last camera image acquired. Returns number of bytes of image data followed by \r\n followed by image data. Whatever is set for ||>IMAGE.SIZE, ||>IMAGE.FORMAT, and ||>IMAGE.QUALITY before requesting the image will be used for the corresponding size, format, and quality. | ALL | ||||
| IMAGEBUFFER.IMAGE-TYPE | RecordPlayback | PUBLIC | 5.5.0 | SET|GET | int |
[0-2] |
0: All 1: Same as result 2: Auto |
Sets "What images to Buffer for a Result". When "Auto" is selected, the reader does intelligent image buffering. Requires the IntImageBuffer feature key to select the "Auto" option. |
DM70, DM150, DM260, DM300 series readers, DM474, DM503. |
| IMAGEBUFFER.NO-READ-IMAGE-LAST-NUMBER | RecordPlayback | PRIVATE | 5.5.0 | SET|GET | limit |
[n][Max Int] | In Burst trigger mode, n is the number of images in a burst. In other trigger modes, there is no limit. | Stores images up to the limit. | Fixed-mount readers, only in Single, Burst, Self and Continuous modes. |
| INPUT-STRING.MODE | Data Formatting | PUBLIC | 5.5.0 | SET|GET | int |
[0-4] |
0: Store 1: Send 2: Send with header and footer 3: Send with formatting 4: Send with header and footer formatting |
Controls whether the input string data is sent out as a result or stored in an internal variable. | Fixed-mount readers. |
| INPUT-STRING.VALUE | Data Formatting | PUBLIC | 5.5.0 | SET|GET | string |
token string | Sets the content of the Input String character string. | Fixed-mount readers | |
| INPUT.STATE | Action | PUBLIC | 5.5.0 | GET | line |
[0-3] | input line number | Gets the current state of the input line specified. Returns 1 for high, 0 for low. | Fixed-mount readers |
| IO-LINE.DIRECTION | IO | PUBLIC | 5.5.0 | SET|GET | line direction |
[2,3] [0,1] |
line=2: sets direction of I/O Line 2 line=3: sets direction of I/O Line 3 direction=0: defines line as output direction=1: defines line as input |
Sets the direction of the programmable I/O lines of DM360 and DM474 series readers. | DM360 series, DM474 readers |
| KEY.INTERCHAR-DELAY | Communication | PUBLIC | 5.5.0 | SET|GET | us |
[0-1000] | milliseconds | Sets or gets the delay time between characters when in HID keyboard mode. | DM300 series readers, DM60, DM50, DM70, DM474. |
| LIGHT.DIRECT | Camera | PUBLIC | 5.5.0 | SET|GET | north-east north-west south-east south-west |
[ON|OFF]
[ON|OFF] [ON|OFF] [ON|OFF] |
enable/disable
enable/disable enable/disable enable/disable |
Sets the quadrants on the DM70, DM150 and DM260. Possible values are ON and OFF for each segment. Example for a SET command: SET LIGHT.DIRECT ON OFF OFF ON if you want to have the top-left and bottom-right LED on. | DM70, DM150 and DM260 readers. |
| LIGHT.SELF-REPAIR | Camera | PRIVATE | 5.5.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enables/disables internal illumination self repair mode. | DM300 series readers |
| MASTER-SLAVE.TEST | Communication | PUBLIC | 5.5.0 | mode message |
[0-2] |
0: Slave to Master 1: Master to Slave 2: Master to Slave to Master |
Transmits the test message from reader to reader as designated by mode. The terminating reader will output the message preceded by the initiating device delimited by a space | Fixed-mount readers. | |
| PROFIBUS.GATEWAY-COM | Communication | PRIVATE | 5.5.0 | SET|GET | mode |
[0-2] |
0: Profibus 1: RS485 2: RS422 |
Get the COM configuration (Profibus / RS422 / RS485). | Fixed-mount readers |
| PROFIBUS.GATEWAY-FLOW | Communication | PRIVATE | 5.5.0 | SET|GET | mode |
[0-2] |
0: None 1: RTS/CTS 2: XON/XOFF |
The reader will return a value indicating the type of serial flow control to be used. | Fixed-mount readers |
| PROFIBUS.GATEWAY-HOST | Communication | PRIVATE | 5.5.0 | GET | type |
[0] | The reader will return a value indicating the host interface protocol. | Fixed-mount readers | |
| PROFIBUS.GATEWAY-MODE | Communication | PRIVATE | 5.5.0 | GET | mode |
[1] | Get the profibus mode configuration. | Fixed-mount readers | |
| PROFIBUS.GATEWAY-NODE | Communication | PRIVATE | 5.5.0 | SET|GET | node number |
[1-99] | The reader will return the Profinet node number for the gateway. | Fixed-mount readers | |
| PROFIBUS.GATEWAY-RUN | Communication | PRIVATE | 5.5.0 | SET|GET | state |
[ON|OFF] | Runtime start message or heartbeat. | Fixed-mount readers | |
| PROFIBUS.GATEWAY-STATUS | Communication | PRIVATE | 5.5.0 | SET|GET | status |
[0-4] |
0: ok, no error 1: Invalid op mode 2: Invalid node number 3: Invalid flow control 4: Invalid host interference |
Set Gateway error message. | Fixed-mount readers |
| PROFIBUS.GATEWAY-VERSION | Communication | PRIVATE | 5.5.0 | SET|GET | mode |
Set the GW firmware version, used for baud rate detection. | Fixed-mount readers | ||
| PTP-SYNC.DELAY | Communication | PUBLIC | 5.5.0 | SET|GET | time |
[0-1000000] | Time between trigger start and the synchronized acquisition timestamp. | DM360 series readers, DM474 | |
| PTP-SYNC.ENABLE | Communication | PUBLIC | 5.5.0 | SET|GET | mode |
[ON|OFF] | Enables MST synchronized by PTP. | DM360 series readers, DM474 | |
| PTP-SYNC.LOCAL-OFFSET | Communication | PUBLIC | 5.5.0 | SET|GET | time |
[0-1000000] | Local offset added to the synchronized acquisition timestamp. | DM360 series readers, DM474 | |
| PTP.ENABLE | Communication | PUBLIC | 5.5.0 | SET|GET | mode |
[ON|OFF] |
enable/disable
OFF: Disable the PTP timestamp synchronization ON: Enable the PTP timestamp synchronization |
Enable the PTP timestamp synchronization. | DM360 series readers, DM474 |
| PTP.PRIORITY1 | Communication | PUBLIC | 5.5.0 | SET|GET | level |
[0-255] | This is the first 8-bit priority value (lower number denotes a higher priority). Normally, this is set at 128 for master capable devices. | DM360 series readers, DM474 | |
| PTP.PRIORITY2 | Communication | PUBLIC | 5.5.0 | SET|GET | level |
[0-255] | This is the second 8-bit priority value (lower number denotes a higher priority). This parameter allows to configure backup clocks. | DM360 series readers, DM474 | |
| PTP.SLAVE-ONLY | Communication | PUBLIC | 5.5.0 | SET|GET | mode |
[ON|OFF] |
enable/disable
OFF: Disables PTP slave only configuration of the reader ON: Configures the reader as PTP slave only |
This parameter configures the reader as PTP slave only, even if no other master is active. | DM360 series readers, DM474 |
| SCRIPT.GARBAGE-COLLECT | Communication | PRIVATE | 5.5.0 | force |
[ON|OFF] | enable/disable Enforce the garbage collection | Check or enforce the Garbage Collection process. | Fixed mount readers | |
| SDCARD.BACKUP-FILE | Communication | PUBLIC | 5.5.0 | SET|GET | state |
[ON|OFF] | enable/disable | SD card is used for creating and restoring a configuration file backup. | DM360 series readers, DM474 |
| SDCARD.PRESENT | Communication | PUBLIC | 5.5.0 | GET | Returns True if the SD card was detected, False otherwise. | DM360 series readers, DM474 | |||
| SDCARD.TESTFILE | Communication | PRIVATE | 5.5.0 | SET|GET | string |
SET: writes argument to a predefined file on the card. GET: reads back the same file and returns its content. | DM360 series readers, DM474 | ||
| SYMBOL.C39-CONVERT-TO-C32 | Code Quality | PUBLIC | 5.5.0 | SET|GET | state |
[ON|OFF] | enable/disable | Parameter enables or disables Code39 to Code 32 conversion. | DM70, DM150, DM260 |
| SYMBOL.C39-CONVERT-TO-C32 | Symbology | PUBLIC | 5.5.0 | SET | state |
[ON|OFF] | enable/disable | Enables/disables the conversion of Code39 to Code32. | ALL |
| TELNET.CUSTOM-PORTS | Communication | PUBLIC | 5.5.0 | SET|GET | port |
[0-65535] | Comma separated list of TCP ports | Additional Telnet TCP ports for custom communication. | Ethernet readers |
| TRIGGER.END-HOLDOFF-DISTANCE | IO | PUBLIC | 5.5.0 | SET|GET | distance |
[0-10000 mm] | distance for hold-off at trigger end | When greater than 0, the distance with which to cancel a pending trigger off and allow the trigger to continue. | DM474, DM503 and DM300 series readers. |
| TRIGGER.END-HOLDOFF-TIME | IO | PUBLIC | 5.5.0 | SET|GET | rime |
[0-10000 ms] | time for hold-off at trigger end | When greater than 0, the time with which to cancel a pending trigger off and allow the trigger to continue. | Fixed-mount readers |
| TRIGGER.HOLDOFF-DISTANCE | IO | PUBLIC | 5.5.0 | SET|GET | distance |
[0-10000 mm] | distance for hold-off at trigger start | When greater than 0, the distance with which to cancel a pending trigger on and act like there was no trigger at all. | DM474, DM503 and DM300 series readers. |
| TRIGGER.HOLDOFF-TIME | IO | PUBLIC | 5.5.0 | SET|GET | time |
[0-10000 ms] | time for hold-off at trigger start | When greater than 0, the time with which to cancel a pending trigger on and act like there was no trigger at all. | Fixed-mount readers |
| TRIGGER.HOLDOFF-TYPE | IO | PUBLIC | 5.5.0 | SET|GET | type |
[0-2] |
0 = None 1 = Time 2 = Distance |
Which type of trigger hold-off to use, none, time or distance. | Fixed-mount readers |
| TRIGGER.IGNORE-DISTANCE | IO | PRIVATE | 5.5.0 | SET|GET | milliseconds |
[0-2147483646] | Sets or gets the minimum trigger distance for a trigger to be considered good. All trigger durations less than the specified duration will be aborted. | Fixed-mount readers | |
| TRIGGER.IGNORE-TIME | IO | PRIVATE | 5.5.0 | SET|GET | milliseconds |
[0-10000] | Sets or gets the minimum trigger duration for a trigger to be considered good. All trigger durations less than the specified duration will be aborted. | Fixed-mount readers | |
| TRIGGER.IGNORE-TYPE | IO | PRIVATE | 5.5.0 | SET|GET | mode |
[0-2] |
0: none 1: time 2: distance |
Sets or gets what type of triggers to ignore. | Fixed-mount readers |
| TUNE.STATUS | Action | PUBLIC | 5.5.0 | GET | Returns ON if tuning is running, OFF otherwise. | Fixed mount devices. | |||
| TUNE.TUNE-LIGHT-COMBINATIONS | Camera | PUBLIC | 5.5.0 | SET|GET | mode |
[ON|OFF] | If it is ON, light combinations will always be tuned. | DM300 series readers, DM474, DM260, DM70 and DM150. | |
| DECODER.REREAD-NOT-LAST-N | Decoder | PUBLIC | 5.5 SR3 | SET|GET | int |
[0-100] |
0: no restriction 1-100 Define N |
Do not read code if this code was read within the last N reads. | All |
| COM.USB-RE-ENUMERATE-ON-START | Communication | PUBLIC | 5.5 | SET|GET | state |
[ON|OFF]
[ON|OFF] |
enable/disable
ON: USB 1.1 mode OFF: USB 2.0 mode |
Feature to re-enumerate the COM port after firmware is started. | DM8000 series readers. |
| BLUETOOTH.KBM-PIN | Communication | PRIVATE | 5.4.3 | SET|GET | string |
0-16 characters of decimal number | PIN number (e.g. "1234") | Gets or sets the PIN number of the remote target. | DM8050, DM8600. |
| BLUETOOTH.KBM-TARGET-ADDR | Communication | PRIVATE | 5.4.3 | SET|GET | string |
8 characters of hexadecimal number | MAC address (e.g. "0006660492A6") | Gets or sets the MAC address of the remote target. | DM8050, DM8600. |
| BLUETOOTH.MAX-RF-POWER | Communication | PUBLIC | 5.4.3 | SET|GET | int |
-23-7 | Maximum output power in dBm | DM8050, DM8600, and Bluetooth base stations. | |
| BLUETOOTH.OPERATION-MODE | Communication | PRIVATE | 5.4.3 | SET|GET | number |
[0-2] |
0: normal mode 1: PC connect mode 2: keyboard emulator mode |
Gets or sets the Bluetooth operation mode. | DM8050, DM8600. |
| COM.INTERFACE | Communication | PRIVATE | 5.4.3 | GET | Supported interfaces: RS232, USB, Ethernet, WiFi, Bluetooth. | ||||
| LIGHT.DARKFIELD-INTENSITY | Camera | PUBLIC | 5.4.3 | SET|GET | value |
[0-15] | Intensity | Darkfield Illumination Intensity. | DM8600 |
| LIGHT.DIFFUSE-INTENSITY | Camera | PUBLIC | 5.4.3 | SET|GET | level |
[0-15] | Intensity | Diffuse Brightfield Illumination Intensity. | DM8600 |
| LIGHT.DIRECT-INTENSITY | Camera | PUBLIC | 5.4.3 | SET|GET | level |
[1-15] | Intensity | Direct Illumination Intensity. | DM8050 |
| ACCEL-SENSOR.OPERATION-MODE | Communication | PUBLIC | 5.4.0 | SET|GET | int |
[0-1] |
0: Acceleration Sensor is not used for waking the reader up from hibernation. 1: Acceleration Sensor is used for waking the reader up from hibernation. |
Configures the application of the acceleration sensor. This command is only valid for Bluetooth-connected readers. |
DM8050, DM8600. |
| ACCEL-SENSOR.SENSITIVITY | Communication | PUBLIC | 5.4.0 | SET|GET | int |
[0-2] |
0: Low 1: Medium 2: High |
Gets/sets the sensitivity of the acceleration sensor of/to the predefined value. | DM8050, DM8600. |
| BLUETOOTH.MAC-ADDRESS | Communication | PUBLIC | 5.4.0 | GET | Returns the own Bluetooth address of the device. | DM8050, DM8600. | |||
| BUTTON.VIRTUAL | Action | PRIVATE | 5.4.0 | int state |
[ON|OFF] |
Denotes the button id. enable/disable Denotes the new state of the button. |
Allows to virtually push the TUNE button for more than 3 seconds on a DM8600 to activate "magic mode". | DM8600 | |
| COM.USB-HID-ONLY | Communication | PUBLIC | 5.4.0 | SET|GET | state |
[ON|OFF] | enable/disable | When enabled, the base station will appear as a single USB Keyboard device on its USB port, instead of a composite device. | DM8000 base station G2 |
| CONFIG.SAVE-DEFAULTS | Action | PRIVATE | 5.4.0 | Saves current settings as defaults. This command does not reboot the device. | ALL | ||||
| DEBUG.LOG | System | PRIVATE | 5.4.0 | GET | Gets the debug log in development builds, returns nothing for released firmware. | ALL | |||
| DECODER.1D-PICKETFENCE-BARCODE-ONLY | System | PRIVATE | 5.4.0 | GET | |||||
| DEVICE.APPLOADER-VER | System | PRIVATE | 5.4.0 | GET | Returns the Apploader version. | ||||
| DEVICE.DEFAULT-MFG | Action | PRIVATE | 5.4.0 | Resets all device settings to Cognex defaults. This command reboots the device. | DM8050, DM8600. | ||||
| DEVICE.FAILSAFE-VER | System | PRIVATE | 5.4.0 | GET | Returns the Failsafe version. | ||||
| DEVICE.ID | Camera | PRIVATE | 5.4.0 | GET | string |
Returns the device id. | ALL | ||
| DEVICE.SUBCLASS | System | PRIVATE | 5.4.0 | GET | string |
Activates the relevant device subclasses. | |||
| DOTCODE.MAXIMUM-COLUMNS | Decoder | PUBLIC | 5.4.0 | SET|GET | int |
[11-128] | The default is 128. | DM300 series readers, DM474, DM8050X and DM8600. | |
| DOTCODE.MAXIMUM-ROWS | Decoder | PUBLIC | 5.4.0 | SET|GET | int |
[5-128] | The default is 32. | DM300 series readers, DM474, DM8050X and DM8600. | |
| DOTCODE.MINIMUM-COLUMNS | Decoder | PUBLIC | 5.4.0 | SET|GET | int |
[11-128] | The default is 16. | DM300 series readers, DM474, DM8050X and DM8600. | |
| DOTCODE.MINIMUM-ROWS | Decoder | PUBLIC | 5.4.0 | SET|GET | int |
[5-128] |
The default is 6. |
DM300 series readers, DM474, DM8050X and DM8600. | |
| DOTCODE.POLARITY | Decoder | PUBLIC | 5.4.0 | SET|GET | int |
[0-2] |
0: Dark on Light 1: Light on Dark 2: Either |
DM300 series readers, DM474, DM8050X and DM8600. | |
| IDFLASH.READ | System | PRIVATE | 5.4.0 | SET | Read ID/slide in EEPROM content. | All | |||
| IDFLASH.WRITE | System | PRIVATE | 5.4.0 | SET | string |
Write ID/slide in EEPROM content. | All | ||
| KEY.EMULATE-PS2 | IO | PRIVATE | 5.4.0 | SET|GET | state |
[ON|OFF]
[OFF, Wedge, EmulationG |
enable/disable
OFF: no emulation Wedge: reader and PS/2 keyboard are connected using a wedge cable Emulation: reader is connected to wedge and no PS/2 keyboard is present |
Wireless readers. | |
| KEY.PAUSE-TIME | Action | PUBLIC | 5.4.0 | SET|GET | Pause time |
[0-1000] | 0 to 1000 millisecond pause | Sets the time to pause for a specified pause key sequence. | DM8050, DM8600 series |
| LIGHT.AIMER | Camera | PUBLIC | 5.4.0 | SET|GET | aimer-mode |
[0,1,3] |
0: Off 1: On 3: Activated by Acceleration Sensor |
Aimer Enable. Default is ON. |
DM8050 |
| LIMIT.CONS-NOREAD | System | PRIVATE | 5.4.0 | SET|GET | string |
empty string: feature disabled "CBRD>n": signal after n consecutive bad reads |
Sets/gets the threshold for consecutive bad read event signaling. | ALL | |
| LL.REGTODISTANCE | System | PRIVATE | 5.4.0 | register |
Get distance in mm for specified register steps at current temperature. | Readers with liquid lens. | |||
| LLFLASH.READ | System | PRIVATE | 5.4.0 | GET | Gets liquid lens flash content. | Readers with liquid lens. | |||
| LLFLASH.WRITE | System | PRIVATE | 5.4.0 | SET | Sets liquid lens flash content. | Readers with liquid lens. | |||
| PHS.ADD-PACKAGE | System | PRIVATE | 5.4.0 | ||||||
| PPP.IP-CLIENT | System | PRIVATE | 5.4.0 | SET|GET | Reader/client device IP address for internal communication between client and base station. | Wireless readers. | |||
| PPP.IP-SERVER | System | PRIVATE | 5.4.0 | SET|GET | Base/server device IP address for internal communication between client and base station. | Wireless readers. | |||
| PPP.NETMASK | System | PRIVATE | 5.4.0 | SET|GET | int |
Netmask for internal communication between reader and base. | Wireless readers. | ||
| PROXIMITY.CURRENT | Communication | PRIVATE | 5.4.0 | SET|GET | int |
[10-200] step 10 | IR LED current of the proximity sensor in mA | A higher value will increase the sensitivity of the sensor. | DM8600 |
| PROXIMITY.THRESHOLD | Communication | PRIVATE | 5.4.0 | SET|GET | int |
[0-100] | Threshold value which defines if the optical button has been pressed or released. A lower value will increase the sensitivity of the sensor. | DM8600 | |
| TRACE.DUMPFILE | System | PRIVATE | 5.4.0 | filename |
Saves a trace log file, which is archived in flash, into a file. | ||||
| TUNE-BUTTON.3SEC-ACTION | System | PUBLIC | 5.4.0 | SET|GET | action state |
[2,7] [ON|OFF] |
2: Set Match String 7: Extended Read Attempts enable/disable |
Defines actions when the user pushes the tune button for more than 3 seconds. | DM8600 readers. |
| COM.SCRIPT | Communication | PRIVATE | 5.3.0 | SET|GET | num-bytes |
Load script from communication channel. | DM474, DM503 and DM300 series readers. | ||
| COM.SCRIPT-ENABLED | Communication | PRIVATE | 5.3.0 | SET|GET | bool |
DM474, DM503 and DM300 series readers. | |||
| OUTPUT.USER-CONFIGURE | Communication | PUBLIC | 5.3.0 | SET|GET | event number beep tone beep number LED color vibration |
[1,2] [0-2] [0-3] [0-7] [ON|OFF] |
1: USER_EVENT_1 2: USER_EVENT_2 [0]: Low [1]: Medium [2]: High Number of beeps [0]: Off [1]: Blue [2]: Green [3]: Cyan [4]: Red [5]: Magenta [6]: Yellow [7]: White enable/disable ON: The reader vibrates on the given user event. OFF: The reader does not vibrate on the given user event. |
Sets the beeper tone and the number of beeps for USER_EVENT_1 or USER_EVENT_2. | DM8050 (except for the vibration parameter), ON|OFF is supported on DM8600 and MX-1000. |
| OUTPUT.USER1 | Action | PUBLIC | 5.3.0 | Device emits USER_EVENT_1 event. | DM8050, MX-1000, MX-1502, DM474, DM503 and DM300 series readers. | ||||
| OUTPUT.USER2 | Action | PUBLIC | 5.3.0 | Device emits USER_EVENT_2 event. | DM8050, MX-1000, MX-1502, DM474, DM503 and DM300 series readers. | ||||
| CAMERA.MIRROR-HORIZONTAL | Camera | PUBLIC | 5.2.0 | SET|GET | state |
[ON|OFF] | enable/disable | Mirror acquired image over the vertical axis. | DM474, DM503 and DM300 series readers. |
| CAMERA.MIRROR-VERTICAL | Camera | PUBLIC | 5.2.0 | SET|GET | state |
[ON|OFF] | enable/disable | Mirror acquired image over the horizontal axis. | DM70, DM260, DM474, DM503 and DM300 series readers. |
| DATAMATRIX.PRINT-DEFORMATION | Symbology | PUBLIC | 5.2.0 | SET|GET | state |
[0|1] |
0: Minimal 1: Moderate |
Sets the IDMax Properties. | DM300, DM474, DM503. |
| DATAMATRIX.TRAINED-FLEX-GRID | Symbology | PUBLIC | 5.2.0 | SET|GET | state |
[ON|OFF] | enable/disable | Switches the Trained Code Property "Flexible Grid Size". | DM300, DM474, DM503. |
| DATAMATRIX.TRAINED-IGNORE-POLARITY | Symbology | PUBLIC | 5.2.0 | SET|GET | state |
[ON|OFF] | enable/disable | Switches the Trained Code Property "Ignore Polarity". | DM300, DM474, DM503. |
| DECODER.1D-MINIMUM-DECODES | Symbology | PUBLIC | 5.2.0 | SET|GET | int |
[0-5] | Minimum number of decoded scans to report a confident decoding (to prevent misread). | ALL | |
| DECODER.1D-QUALITY-METRICS | Decoder | PUBLIC | 5.2.0 | SET|GET | mode |
[0-1] |
0: none 1: 1D readability |
Enables/disables 1D Process Control Metrics. | ALL |
| DEVICE-LOG.CLEAR | Action | PUBLIC | 5.2.0 | This command clears the device log. | DM50, DM60, DM70, DM474, DM503, DM300 series readers, DM8050, DM8600, MX-1000 and MX-1502. | ||||
| DEVICE.STATS | Action | PRIVATE | 5.2.0 | GET | Get decode statistics. | All. | |||
| FOCUS.COMPENSATE-AFTER-IDLE | Camera | PRIVATE | 5.2.0 | SET|GET | time |
[1-10000] | idle time | Compensates temperature changes after camera is idle for this time. | Liquid lens. |
| FOCUS.HALL-SENSOR | Camera | PRIVATE | 5.2.0 | GET | value |
??? | |||
| FORMAT.SCRIPT | Data Formatting | PUBLIC | 5.2.0 | SET|GET | num-bytes |
Set: loads the script from the host to the reader. Get: sends the script from the reader to the host. | DM474, DM503, MX-1000, MX-1502 and DM300 series readers. | ||
| FTP-IMAGE.FILE-NAME-USE-SCRIPT | Communication | PUBLIC | 5.2.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enables FTP file name generation script. | DM474, DM503 and DM300 series readers. |
| FTP-IMAGE.PRIORITY | Communication | PRIVATE | 5.2.0 | SET|GET | value |
[0-2] |
0: High - above decoder 1: Medium - same as running decoder 2: Low - below running decoder |
FTP thread priority. | Ethernet readers. DM8000 series wireless readers also support FTP if the base station is connected through Ethernet. |
| FTP-IMAGE.SERVER-PATH-SCRIPT | Communication | PUBLIC | 5.2.0 | SET|GET | num-bytes |
Set: loads the script from the host to the reader. Get: sends the script from the reader to the host. | DM474, DM503 and DM300 series readers. | ||
| IMAGEBUFFER.GOOD-IMAGE-MODE | RecordPlayback | PUBLIC | 5.2.0 | SET|GET | mode |
[0-1] |
0: Unlimited 1: Rate limited |
Good Read Image stores all buffered good read images unless you set a limit rate. | DM503, DM300 series readers, DM8050 and DM8600. |
| IMAGEBUFFER.GOOD-IMAGE-RATE-BURST | RecordPlayback | PUBLIC | 5.2.0 | SET|GET | interval |
[1-1000] | Burst determines the peak rate of the number of good read images buffered. | DM474, DM503, DM300 series readers, DM8050 and DM8600. | |
| IMAGEBUFFER.GOOD-IMAGE-RATE-COUNT | RecordPlayback | PUBLIC | 5.2.0 | SET|GET | interval |
Number of good read images to be buffered at a time unit (for example, minutes or hours) specified with IMAGEBUFFER.GOOD-IMAGE-RATE-COUNT. | DM474, DM503, DM300 series readers, DM8050 and DM8600. | ||
| IMAGEBUFFER.GOOD-IMAGE-RATE-TIME | RecordPlayback | PUBLIC | 5.2.0 | SET|GET | type |
[0-3] |
0: seconds 1: minutes 2: hours 3: days |
Time unit of good read images to be buffered at a rate number specified with IMAGEBUFFER.GOOD-IMAGE-RATE-TIME. | DM474, DM503, DM300 series readers, DM8050 and DM8600. |
| IMAGEBUFFER.NO-READ-IMAGE-RATE-BURST | RecordPlayback | PUBLIC | 5.2.0 | SET|GET | interval |
[1-1000] | Burst determines the peak rate of the number of bad read images buffered. | DM474, DM503, DM300 series readers, only in Single, Burst, Self and Continuous modes. | |
| IMAGEBUFFER.NO-READ-IMAGE-RATE-COUNT | RecordPlayback | PUBLIC | 5.2.0 | SET|GET | interval |
Number of bad read images to be buffered at a time unit (for example, minutes or hours) specified with IMAGEBUFFER.NO-READ-IMAGE-RATE-COUNT. | DM503, DM300 series readers, only in Single, Burst, Self and Continuous modes. | ||
| IMAGEBUFFER.NO-READ-IMAGE-RATE-TIME | RecordPlayback | PUBLIC | 5.2.0 | SET|GET | type |
[0-3] |
0: seconds 1: minutes 2: hours 3: days |
Time unit of bad read images to be buffered at a rate number specified with IMAGEBUFFER.NO-READ-IMAGE-RATE-TIME. | DM474, DM503, DM300 series readers, only in Single, Burst, Self and Continuous modes. |
| LIGHT.EXTERNAL-INTENSITY | Camera | PUBLIC | 5.2.0 | SET|GET | level |
[0-15] | Intensity | Sets the intensity of the external illumination. | Fixed mount readers. |
| LIGHT.HIGH-FREQUENCY | Camera | PUBLIC | 5.2.0 | SET|GET | enable |
[ON|OFF] | enable/disable | Enables High Frequency Lights to avoid flickering illumination. | DM50, DM60, DM70, DM474, DM503, and DM300 series readers. |
| LIGHT.HIGH-FREQUENCY-ALWAYS | Camera | PUBLIC | 5.2.0 | SET|GET | enable seconds |
[ON|OFF] 0-86400 |
enable/disable auto off duration |
Enables High Frequency Light in Continuous trigger mode even if no trigger is active. After duration seconds the High Frequency Light is turned off. If the duration is 0 the light is never turned off. | DM50, DM60, DM70, DM474, DM503, and DM300 series readers. |
| LIGHT.HIGH-FREQUENCY-FORCE | Camera | PRIVATE | 5.2.0 | SET|GET | enable |
[ON|OFF] | enable/disable | Enable High Frequency Lights even if overheat protection would normally prohibit it. | DM300 series readers |
| LIVEIMG.MODE | Camera | PUBLIC | 5.2.0 | SET|GET | mode |
[0,2] |
0: Disable 2: Enable |
Controls live image display. | ALL |
| NET-LOCAL.MAX-LINK-SPEED | Communication | PRIVATE | 5.2.0 | SET|GET | speed |
[0-4] |
0: 1000 MBits/sec Full Duplex 1: 100 MBits/sec Full Duplex 2: 100 MBits/sec Half Duplex 3: 10 MBits/sec Full Duplex 4: 10 MBits/sec Half Duplex |
Limits the advertised autonegotiation maximum link speed. | DM503 only |
| NET-LOCAL.READER-SUBNET-MASK | Communication | PUBLIC | 5.2.0 | SET|GET | string |
dotted decimal form IPv4 address | Base station's subnet mask. Uses dotted decimal form, such as "192.168.23.255". |
Base stationss. | |
| NET-LOCAL.SEC-ENABLE | Communication | PRIVATE | 5.2.0 | SET|GET | state |
[ON|OFF] |
enable/disable
ON: use authentication OFF: no authentication |
Use authentication over telnet for communciation between reader and base. | Ethernet readers. |
| NET-LOCAL.SEC-PASSWORD | Communication | PRIVATE | 5.2.0 | SET|GET | string |
password for authentication | Use authentication over telnet for communciation between reader and base. | Ethernet readers. | |
| NET-LOCAL.SEC-USERNAME | Communication | PRIVATE | 5.2.0 | SET|GET | string |
username for authentication | Use authentication over telnet for communciation between reader and base. | Ethernet readers. | |
| NETWORK-CLIENT.CLIENT-PORT | Communication | PUBLIC | 5.2.0 | SET|GET | int |
[0-65535] | The port on the reader to use as the outbound port (default is 0). | Ethernet readers except for the DM8000 wireless. | |
| NETWORK-CLIENT.CLOSE-CONNECTION | Communication | PUBLIC | 5.2.0 | SET|GET | int |
[0-1] |
0: Never 1: After reader data transfer |
Whether or not to keep the connection open after data transfer (default is 0). | Ethernet readers except for the DM8000 wireless. |
| NETWORK-CLIENT.CONNECTION-TIMEOUT | Communication | PUBLIC | 5.2.0 | SET|GET | int |
[1000-60000] | How long to wait before considering the connection dead (default is 3000). | Ethernet readers except for the DM8000 wireless. | |
| NETWORK-CLIENT.HOST-ADDRESS | Communication | PUBLIC | 5.2.0 | SET|GET | string |
Max length = 255 | The address of the server to connect to. | Ethernet readers except for the DM8000 wireless. | |
| NETWORK-CLIENT.HOST-PORT | Communication | PUBLIC | 5.2.0 | SET|GET | int |
[0–65535] | The remote port on the server to connect to (default is 1000). | Ethernet readers except for the DM8000 wireless. | |
| NETWORK-CLIENT.IDLE-TIMEOUT | Communication | PUBLIC | 5.2.0 | SET|GET | int |
[1–3600] | How long to keep the connection open after transfer (default is 1). | Ethernet readers except for the DM8000 wireless. | |
| NETWORK-CLIENT.OPEN-CONNECTION | Communication | PUBLIC | 5.2.0 | SET|GET | us |
[0-1] |
0: on Power-up 1: on Data Activity |
When to open the connection to the remote host (default is 0). | Ethernet readers except for the DM8000 wireless. |
| NETWORK-CLIENT.PROTOCOL | Communication | PUBLIC | 5.2.0 | SET|GET | int |
[0-1] |
0: TCP 1: UDP |
Which protocol to use for the connection (default is 0). | Ethernet readers except for the DM8000 wireless. |
| NETWORK-CLIENT.RECONNECT-DELAY | Communication | PUBLIC | 5.2.0 | SET|GET | int |
[100-60000] | How long to wait before reconnecting if the connection is lost (default is 1000). | Ethernet readers except for the DM8000 wireless. | |
| QR.MAXIMUM-GRID-SIZE | Symbology | PUBLIC | 5.2.0 | SET|GET | size |
[49-177] | Step size: 4. | Maximum grid size which can be read by the QR decoder. | ALL |
| READER.ASSIGNED | Communication | PUBLIC | 5.2.0 | SET|GET | state |
[ON|OFF] | enable/disable | Unassignins the reader and the base station that is associated with it. | Base |
| SETUP.START-WITH-LAST-READ | Camera | PUBLIC | 5.2.0 | SET|GET | mode |
[ON|OFF] |
enable/disable
OFF: Start with fixed setup ON: Start with setup of last good read |
Sets read setup. | DM8600, DM70, DM150, DM260, DM474, DM503, MX-1000, MX-1502 and DM300 series readers. |
| SETUP.START-WITH-SETUP | Camera | PUBLIC | 5.2.0 | SET|GET | setup |
[0-15] | setup number to start with | Starts read setup. | DM8600, DM70, DM150, DM260, DM474, DM503, MX-1000, MX-1502 and DM300 series readers. |
| SETUP.USE | Camera | PUBLIC | 5.2.0 | int state |
[1-15] [ON|OFF] |
Setup to change enable/disable Disables/Enables setup to be used. |
Adds or removes a setup from the list of usable Read Setups. | DM8600, DM70, DM150, DM260, DM474, DM503 and DM300 series readers. | |
| TEST-MODE.ACCEPT-TRIGGERS | Communication | PUBLIC | 5.2.0 | value |
[0-2000000000] | number of accepted triggers from all inputs | Allows a limited number of triggers from external inputs even if triggering from those should be rejected using TEST-MODE.INPUTS-ENABLE. | DM70, DM150, DM260, DM474, DM503 and DM300 series readers. | |
| TEST-MODE.AUTOMATIC | Communication | PUBLIC | 5.2.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enables automatic triggering. | DM70, DM150, DM260, DM474, DM503 and DM300 series readers. |
| TEST-MODE.AUTOMATIC-OFF-US | Communication | PUBLIC | 5.2.0 | SET|GET | microseconds |
[0-2000000000] | Inactive trigger phase for automatic triggering. | DM70, DM150, DM260, DM474, DM503 and DM300 series readers. | |
| TEST-MODE.AUTOMATIC-ON-US | Communication | PUBLIC | 5.2.0 | SET|GET | microseconds |
[0-2000000000] | Active trigger phase for automatic triggering. | DM70, DM150, DM260, DM474, DM503 and DM300 series readers. | |
| TEST-MODE.ENABLE | Communication | PUBLIC | 5.2.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enables test mode. | DM70, DM150, DM260, DM474, DM503 and DM300 series readers. |
| TEST-MODE.INPUTS-ENABLE | Communication | PUBLIC | 5.2.0 | SET|GET | state |
[ON|OFF] | enable/disable | Disables external trigger sources during test mode. | DM70, DM150, DM260, DM474, DM503 and DM300 series readers. |
| TEST-MODE.OUTPUTS-ENABLE | Communication | PUBLIC | 5.2.0 | SET|GET | state |
[ON|OFF] | enable/disable | Disables result reporting to external destinations during test mode. | DM70, DM150, DM260, DM474, DM503 and DM300 series readers. |
| TUNE-BUTTON.SAVE-MATCH-STRING | System | PUBLIC | 5.2.0 | SET|GET | state |
[ON|OFF] | enable/disable tune button enabled | Enables the 'save match string' action when the user pushes the tune button for more than 3 seconds. | DM474, DM503, DM8600 and DM300 readers. |
| CAMERA.MAX-EXPOSURE-US | Camera | PUBLIC | 5.1.0 | SET|GET | exposure |
[18-25000] | Maximum exposure limit in microseconds for autoregulation. | DM50, DM60, DM70. | |
| DATAMATRIX.SYMBOL-DIFFICULTY | Symbology | PUBLIC | 5.1.0 | SET|GET | int |
[0-2] |
0: Easy 1: Medium 2: Hard |
Level of DataMatrix code symbol difficulty. | DM8600. |
| LIGHT.DIRECT-INTENSITY | Camera | PUBLIC | 5.1.0 | SET|GET | level |
[0-15] | Intensity | Direct Illumination Intensity. | DM50, DM60, DM474, DM503 and DM300 series readers. |
| NETWORK-CLIENT.ENABLED | Communication | PUBLIC | 5.1.0 | SET|GET | state |
[ON|OFF] | enable/disable | Switch the Network Client feature on or off. | Ethernet readers except for the DM8000 wireless. |
| QR.SYMBOL-DIFFICULTY | Symbology | PUBLIC | 5.1.0 | SET|GET | int |
[0-2] |
0: Easy 1: Medium 2: Hard |
Level of QR code symbol difficulty. | DM8600. |
| COM.RS232-FILTER | Communication | PRIVATE | 5.0.0_cr7 | SET|GET | state |
[ON|OFF] | enable/disable | Enable or disable the RS-232 filter. | DM300 series readers, DM474. |
| COM.RS232-FILTER-CHAR | Communication | PRIVATE | 5.0.0_cr7 | SET|GET | char |
[0x00-0xFF] | Hex char | Sets or gets the hex value of the character to start filtering after (e.g. 0x03 for ETX). | DM300 series readers, DM474. |
| MSI.CHKCHAR | Symbology | PUBLIC | 5.0.0_cr5 | SET|GET | state |
[ON|OFF] | enable/disable | Sets or gets whether check character is used. Default value is OFF. | DM300 series, DM474, DM503, MX-1000, MX-1502, Mobile. |
| MSI.CHKCHAR-OPTION | Symbology | PUBLIC | 5.0.0_cr5 | SET|GET | mode |
[0-5] |
0: Mod10 1: Mod11 2: Mod1010 3: Mod1110 4: 5: |
Sets or gets the method for calculating checksum. | DM474, DM503 and DM300 series, MX-1000, MX-1502, Mobile. |
| MSI.CODESIZE | Symbology | PUBLIC | 5.0.0_cr5 | SET|GET | mode min max |
[ON|OFF] [1-max] [min-80] |
any length code minimum code length maximum code length |
Sets or gets the expected code size. | DM474, DM503, DM300 series readers, MX-1000, MX-1502. |
| MSI.QZ-SIZE | Symbology | PUBLIC | 5.0.0_cr5 | SET|GET | size |
[0-100] | Sets or gets the single side strictness as a percentage | DM474, DM503 and DM300 series readers. | |
| MSI.XMTCHK | Symbology | PUBLIC | 5.0.0_cr5 | SET|GET | state |
[ON|OFF] | enable/disable | Sets or gets whether to transmit the check digit. | DM474, DM503 and DM300 series readers. |
| SYMBOL.MSI | Symbology | PUBLIC | 5.0.0_cr5 | SET|GET | state |
[ON|OFF] | enable/disable | Sets or gets whether MSI Code is enabled or disabled | DM70, DM150, DM260, DM503, DM300 series readers, DM474, MX-1000, MX-1502, Mobile. |
| SYMBOL.DOTCODE | Symbology | PUBLIC | 5.0.0_cr3 | SET|GET | state |
[ON|OFF] | enable/disable | Enable DotCode symbology. | DM70, DM150, DM260, DM300 series readers, DM474, DM8050X, DM8600, MX-1000, MX-1502, Mobile. |
| SYMBOL.AZTECCODE | Symbology | PUBLIC | 5.0.0_cr2 | SET|GET | state |
[ON|OFF] | enable/disable | Enable Aztec code symbology. | DM70, DM150, DM260, DM503, DM300 series readers, DM474, DM8050, DM8600, MX-1000, MX-1502, Mobile. |
| INTELLIGRATED.ENABLED | Communication | PRIVATE | 5.0.0_cr14 | SET|GET | state |
[ON|OFF] | enable/disable | Enable or disable the Intelligrated protocol. | DM503 series readers. |
| INTELLIGRATED.HEARTBEAT | IO | PRIVATE | 5.0.0_cr14 | SET|GET | sec |
[0-50] | seconds | Sets or gets the time between heartbeat transmissions. A value of 0 disables the heartbeat. | DM503 series readers. |
| MARKEM.ENABLED | Communication | PRIVATE | 5.0.0_cr11 | SET|GET | state |
[ON|OFF] | enable/disable | Enable or disable the Markem protocol. | DM300 series readers, DM474. |
| DATA.RESULT-TYPE | System | PRIVATE | 5.0.0_cr10 | SET|GET | bit-field |
[0-511] |
0x00 = None 0x01 = Result 0x100 = Input event message |
Controls automatic result transmitted from reader. Default is 1. | ALL |
| INPUT.EVENT-MESSAGE | IO | PRIVATE | 5.0.0_cr10 | SET|GET | state |
[ON|OFF] | enable/disable | Instructs the system to generate a message for every input line state change. | DM300 series readers, DM474. |
| CONFIG-BACKUP.ENABLE | Action | PUBLIC | 5.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enables automatic device configuration backup. | Ethernet readers. DM8000 series wireless readers also support FTP if the base station is connected through Ethernet. |
| CONFIG-BACKUP.IP-ADDRESS | Action | PUBLIC | 5.0.0 | SET|GET | string |
IP address of the Cognex Explorer FTP service. Uses dotted decimal form, such as "192.168.23.42". |
Ethernet readers. DM8000 series wireless readers also support FTP if the base station is connected through Ethernet. | ||
| CONFIG-BACKUP.PASSWORD | Action | PUBLIC | 5.0.0 | SET|GET | string |
Password used to log in to Cognex Explorer FTP service. | Ethernet readers. DM8000 series wireless readers also support FTP if the base station is connected through Ethernet. | ||
| CONFIG-BACKUP.PORT | Action | PUBLIC | 5.0.0 | SET|GET | port |
[0-65535] | Port number of the Cognex Explorer FTP service. | Ethernet readers. DM8000 series wireless readers also support FTP if the base station is connected through Ethernet. | |
| CONFIG-BACKUP.USER-NAME | Action | PUBLIC | 5.0.0 | SET|GET | string |
User name used to log in to the Cognex Explorer FTP service. | Ethernet readers. DM8000 series wireless readers also support FTP if the base station is connected through Ethernet. | ||
| CPFLASH.WRITE | Camera | PRIVATE | 5.0.0 | id |
[0-4] |
0: Unknown 1: Prototype 2: Alpha build with SRAM 3: Alpha build with SDRAM 4: Beta build |
Flash camera port ID. | DM 503. | |
| DECODER.REREAD-NEVER2X | Decoder | PUBLIC | 5.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Never read the same code twice. All trigger modes, e.g. Multicode Reading. |
ALL |
| DEVICE.LENS-TYPE | Camera | PRIVATE | 5.0.0 | GET | type |
This command gives you the lens type when a liquid lens is installed. | ALL | ||
| DEVICE.SYSLOG-IP | Communication | PRIVATE | 5.0.0 | SET|GET | string |
Specifies the remote syslog server IP address. | |||
| FTP-PROXY.NOOP | Communication | PRIVATE | 5.0.0 | session |
Sends NOOP using FTP proxy. | Wireless readers. | |||
| IMAGEBUFFER.MAX-IMAGES-PER-RESULT | RecordPlayback | PUBLIC | 5.0.0 | SET|GET | size |
[0-*] | Sets or gets how many images (n) per result are stored. | DM50, DM60, DM70, DM474, DM503, DM300 series readers, DM8050 and DM8600. | |
| IMAGEBUFFER.NO-READ-IMAGE-MODE | RecordPlayback | PRIVATE | 5.0.0 | SET|GET | size |
[0-3] |
0: No-Read Image Period 1: No-Read Image Number 2: No-Read Image Rate 3: No-Read Image Range |
No-Read Image stores only one image per trigger and you can select which one. No-Read Image Period stores every nth bad read image. This is evaluated across trigger modes. For example, if you have burst trigger selected with a length of 5 and set period to 3, the 1st and 4th image of the first, but the 2nd and 5th of the second burst will be stored. No-Read Image Range stores all bad read images from the no-read image number to the last no-read image number. | Fixed-mount readers, only in Single, Burst, Self and Continuous modes. |
| IMAGEBUFFER.NO-READ-IMAGE-NUMBER | RecordPlayback | PUBLIC | 5.0.0 | SET|GET | limit |
[n] [Max Int] |
In Burst trigger mode, n is the number of images in a burst In other trigger modes, there is no limit |
Store exactly one image. | DM50, DM60, DM70, DM474, DM503, DM300 series readers, only in Single, Burst, Self and Continuous modes. |
| IMAGEBUFFER.OVERLAY | RecordPlayback | PUBLIC | 5.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enables Overlay Graphics (SVG) for buffered images. | DM50, DM60, DM70, DM474, DM503, DM300 series readers, DM8050 and DM8600. |
| INPUT-STRING.ENABLE | Data Formatting | PUBLIC | 5.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enables or disables the use of the Input String feature (available for serial, telnet, NetworkClient). When enabled, a header and the footer can be set by the INPUT-STRING.HEADER and INPUT-STRING.FOOTER commands, respectively. A string of characters can be given between the header and the footer, which will be sent with the formatted output (for example, [hello world], if the header is set to ’[’ and the footer to ’]’). Since the input string is saved temporarily, it appears only in the next result output. Use Setup Tool (the <Input String> option) or <ISTR> with DMCC (see SET FORMAT.TOKEN) to allow Input string in the result output. | ALL |
| INPUT-STRING.FOOTER | Data Formatting | PUBLIC | 5.0.0 | SET|GET | string |
token string | Sets the footer for the Input String character string. | ALL | |
| INPUT-STRING.HEADER | Data Formatting | PUBLIC | 5.0.0 | SET|GET | string |
token string | Sets the header for the Input String character string. | ALL | |
| SETUP.PROG-TARGET | Camera | PUBLIC | 5.0.0 | SET|GET | category |
[0-15] | A number signifying an already existing setup. | Setup Programming Target. Setup to be modified by subsequent commands. |
DM50, DM60, DM70, DM150, DM260, DM474, DM503 and DM300 series readers. |
| SYNC-ACQUISITION.CABLE-END | Communication | PUBLIC | 5.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Sets or gets whether your device is a bus terminator at the end of the synchronization interface bus. | DM503 |
| SYNC-ACQUISITION.DELAY | Communication | PUBLIC | 5.0.0 | SET|GET | us |
[0-25000] | microseconds | Synchronized acquisition delay: the time the reader waits after sending or receiving the synchronized interface signal before the regular acquisition sequence starts. | DM503 |
| SYNC-ACQUISITION.ENABLED | Communication | PUBLIC | 5.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enables or disables synchronized triggering. | DM503 |
| SYNC-ACQUISITION.MASTER | Communication | PUBLIC | 5.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Sets or gets whether the device is the master among the synchronized readers. | DM503 |
| SYNC-ACQUISITION.START-DELAY | Communication | PRIVATE | 5.0.0 | SET|GET | us |
[0-25000] | microseconds | This command is to adjust the delay between the master/slave trigger sent via Ethernet and the sync signal sent for RS-845 to compensate for the longer runtime of the message via Ethernet. Developer only command. |
DM503 |
| TUNE-BUTTON.3SEC-ACTION | System | PUBLIC | 5.0.0 | SET|GET | action state |
[0-6] [ON|OFF] |
action code (see BUTTON.3SEC-ACTION), enabled enable/disable |
Defines actions when the user pushes the tune button for more than 3 seconds. | DM474, DM503 and DM300 readers. |
| TUNE-BUTTON.ENABLE | IO | PUBLIC | 5.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enables or disables the tune button. | DM474, DM503, and DM300 series readers. |
| SYMBOL.MATRIX | Symbology | PUBLIC | 4.7.1 | SET|GET | state |
[ON|OFF] | enable/disable | Enable Matrix symbology. | All. |
| BUTTON.SAVE-MATCH-STRING | Communication | PUBLIC | 4.5.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enables or disables saving the trained match string directly to flash when Set Match String is enabled for the 3 sec button press action. If disabled, the match string is only stored in RAM and if the configuration is not saved manually it will be gone after reboot. | DM474, DM503, and DM300 series readers. |
| DATAMATRIX.QUALITY-METRICS | Decoder | PUBLIC | 4.5.0 | SET|GET | type |
[0-3] |
0: none 1: AIM DPM 2: ISO 15415 3: SEMI T10 |
Code quality metrics for DataMatrix. | ALL |
| ERROR-LED.ENABLE | Action | PRIVATE | 4.5.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enables/disables error log LED. | DM50, DM60, DM70, DM503, DM474 and DM300 series readers. |
| FILE.LOAD | Action | PRIVATE | 4.5.0 | This command can be used to upload a file into DataMan flash filesystem. It should be specified as 'FILE.LOAD "Length" "Filename"'. This DMCC is password-protected. |
ALL | ||||
| FORMAT.MODE | Data Formatting | PUBLIC | 4.5.0 | SET|GET | mode |
[0-1] |
0: basic formatting 1: script-based formatting |
Specifies data formatting mode. By default, basic formatting is the set formatting mode. |
DM50, DM60, DM70, DM474, DM503, MX-1000, MX-1502 and DM300 series readers. |
| INPUT1.SAVE-MATCH-STRING | Communication | PUBLIC | 4.5.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enables or disables saving the match string to flash when Set Match String is enabled as Input line 1 action. | DM50, DM60, DM70, DM474, DM503, and DM300 series readers. |
| QR.QUALITY-METRICS | Decoder | PUBLIC | 4.5.0 | SET|GET | type |
[0-2] |
0: none 1: ISO/IEC 15415 2: AIM-DPM / ISO/IEC TR 29158 |
Code quality metrics for QR codes. | ALL |
| SCRIPT.LOAD | Data Formatting | PUBLIC | 4.5.0 | num-bytes |
Loads the formatting script from the host to the reader. | DM50, DM60, DM70, DM474, DM503, MX-1000, MX-1502 and DM300 series readers. | |||
| SCRIPT.SEND | Data Formatting | PUBLIC | 4.5.0 | Sends the formatting script from the reader to the host. | DM50, DM60, DM70, DM474, DM503, MX-1000, MX-1502 and DM300 series readers. | ||||
| SYMBOL.MAXICODE | Symbology | PUBLIC | 4.5.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable MaxiCode symbology. | DM50, DM60, DM70, DM150, DM260, DM300 series readers, DM474, DM503, DM8050, DM8600, MX-1000 and MX-1502, Mobile. |
| TRAIN.CODE-FROM-IMAGE | Action | PRIVATE | 4.5.0 | num-bytes |
Code is trained from uploaded image. | Fixed mount devices. | |||
| MQA.POSTAL-HEIGHT_MICRON | Code Quality | PRIVATE | 4.4.1_cr7 and 5.0.0_cr6 | SET|GET | height |
Height in microns per pixel for MERLIN metrics. | DM300 series readers, DM474. | ||
| LVHSTS.ENABLED | Communication | PRIVATE | 4.4.1_cr6_sr2 | SET|GET | state |
[ON|OFF] | enable/disable | Enable or disable the USPS Lehigh Valley HSTS protocol. | DM300 series readers, DM474. |
| IMAGEBUFFER.NO-READ-INDEX | RecordPlayback | PRIVATE | 4.4.0_cr2 | SET|GET | index |
0 is the default behavior to send all as selected; 1 – max burst is send only the index selected. | DM474, DM300 series readers, DM8050 and DM8600. | ||
| ERROR-LED.ENABLE | Action | PRIVATE | 4.4.0_cr1_sr1 | SET|GET | state |
[ON|OFF] | enable/disable | Enables/disables error log LED. | DM300 series readers. |
| INPUT-STRING.ENABLE | Data Formatting | PRIVATE | 4.4.0_cr10 | SET|GET | state |
[ON|OFF] | enable/disable | Enables or disables the use of the Input String feature (available for serial, telnet, NetworkClient). When enabled, a header and the footer can be set by the INPUT-STRING.HEADER and INPUT-STRING.FOOTER commands, respectively. A string of characters can be given between the header and the footer, which will be sent with the formatted output (for example, [hello world], if the header is set to ’[’ and the footer to ’]’). Since the input string is saved temporarily, it appears only in the next result output. Use Setup Tool (the <Input String> option) or <ISTR> with DMCC (see SET FORMAT.TOKEN) to allow Input string in the result output. | ALL |
| BATTERY.CHARGE | System | PUBLIC | 4.4.0 | GET | int |
[0-100] | Displays, in percentage, current battery level. | MX-1000 and DM8000 series readers. | |
| CONFIG.LOAD | Action | PUBLIC | 4.4.0 | num-bytes |
Load Configuration from communication channel. Make sure you use a robust communications channel (for example, Ethernet) because this command does not have error checking or retry support and might cause the device to hang. | ALL | |||
| DECODER.REREAD-MODE | Decoder | PUBLIC | 4.4.0 | SET|GET | mode |
[0-1] |
0: last read 1: first read |
Code re-reading delay relative to either the first read or the last. | DM50, DM60, DM70, DM474, DM503, DM300 series readers, DM8050 and DM8600. |
| DECODER.REREAD-TIME | Decoder | PUBLIC | 4.4.0 | SET|GET | ms |
[0-10000] | Milliseconds | Code re-reading delay in milliseconds. | ALL |
| DEVICE.LOG | Action | PUBLIC | 4.4.0 | GET | Get the device log of error and exception conditions such as missed triggers and trigger overruns. | DM50, DM60, DM70, DM474, DM503, DM300 series readers, DM8050 and DM8600. | |||
| DMCC.RESET | Action | PUBLIC | 4.4.0 | When sent, the DMCC resets the following DMCC back to default: COM.DMCC-RESPONSE, COM.DMCC-CHECKSUM, COM.DMCC-HEADER, DATA.RESULT-TYPE, DATA.RESULT-ENCODING, DATA.RESULT-ALWAYSSEND, DATA.IMAGE-TYPE. | ALL | ||||
| DMCC.SAVE | Action | PUBLIC | 4.4.0 | Saves DMCC connection settings. It also saves the status for a new connection session for the following DMCC: COM.DMCC-RESPONSE, COM.DMCC-CHECKSUM, COM.DMCC-HEADER, DATA.RESULT-TYPE, DATA.RESULT-ENCODING, DATA.RESULT-ALWAYSSEND, DATA.IMAGE-TYPE. | ALL | ||||
| DVALID.MATCH-STRING-EMPTY-RESULT | Data Validation | PRIVATE | 4.4.0 | SET|GET | action |
[0-1] |
0: empty match string fails 1: empty match string passes |
Gets or sets if a match string validation attempt with an empty match string should fail (0=default) or pass (1). | ALL |
| DVALID.PROG-TARG | Data Validation | PUBLIC | 4.4.0 | SET|GET | category |
[1-5] |
1: DataMatrix 2: QR Code/MaxiCode/AztecCode 3: Linear/ Postal/ Stacked 4: VeriCode® 5: DotCode |
Data Validation Programming Target. Data Validation Symbology Set to be modified by subsequent commands. Once issued, this command changes the subsequent behavior of the reader. |
ALL |
| FTP.LOG | Action | PRIVATE | 4.4.0 | GET | Get the FTP log of FTP control connection commands and replies in case of FTP problems. | ALL | |||
| IMAGE.QUALITY | Camera | PUBLIC | 4.4.0 | SET|GET | quality |
[10, 15, 20... 85, 90] | JPEG Quality | Quality of the jpeg image. | ALL |
| IMAGE.SIZE | Camera | PUBLIC | 4.4.0 | SET|GET | size |
[0-3] |
0: Full 1: 1/4 2: 1/16 3: 1/64 |
Image Size. | ALL |
| LIGHT.DIRECT | Camera | PUBLIC | 4.4.0 | SET|GET | north east south west NORTH EAST SOUTH WEST |
[ON|OFF]
[ON|OFF] [ON|OFF] [ON|OFF] [ON|OFF] [ON|OFF] [ON|OFF] [ON|OFF] |
enable/disable
enable/disable enable/disable enable/disable enable/disable enable/disable enable/disable enable/disable |
Sets the quadrants on the DM300. Small letters refer to the inner, capital letters to the outer circle, possible values are ON and OFF for each segment. Example for a SET command: SET LIGHT.DIRECT ON OFF ON ON OFF OFF OFF OFF if you want to have the inner north, south, and west lights on. | DM300 series readers, DM474. |
| OUTPUT.DELAY-DISTANCE | Decoder | PUBLIC | 4.4.0 | SET|GET | millimeters |
[0-100000] | Distance to output when using the Encoder. | DM474, DM503, and DM300 series readers. | |
| OUTPUT.DELAY-REFERENCE | Decoder | PUBLIC | 4.4.0 | SET|GET | mode |
[0-1] |
0: Trigger Start 1: Trigger End |
Sets or gets whether output is delayed relative to trigger start or trigger end. | DM50, DM60, DM70, DM474, DM503, and DM300 series readers. |
| OUTPUT.DELAY-TIME | Decoder | PUBLIC | 4.4.0 | SET|GET | milliseconds |
[0-10000] | Output delay in milliseconds. | DM50, DM60, DM70, DM503, DM300 series readers, DM474. | |
| OUTPUT.DELAY-TYPE | Decoder | PUBLIC | 4.4.0 | SET|GET | mode |
[0-1] |
0: None 1: Time |
Sets or gets whether output is delayed, and if so, whether according to time. | DM50, DM60, DM70, DM300 series readers, DM474. |
| OUTPUT.DELAY-TYPE | Decoder | PUBLIC | 4.4.0 | SET|GET | mode |
[0-2] |
0: None 1: Time 2: Distance |
Sets or gets whether output is delayed, and if so, whether according to time or distance. | DM503 |
| PHARMA.MAX-LENGTH | Symbology | PRIVATE | 4.4.0 | SET|GET | length |
[1-6] | Gets or sets the maximum length for a Pharmacode. Obsoleted in 5.1. |
ALL | |
| PHARMA.MIN-LENGTH | Symbology | PRIVATE | 4.4.0 | SET|GET | length |
[1-6] | Gets or sets the minimum length for a Pharmacode. Obsoleted in 5.1. |
ALL | |
| RSS.EXPANDED | Symbology | PUBLIC | 4.4.0 | SET|GET | state |
[ON|OFF] | enable/disable | RSS Expanded. | ALL |
| TRAINED-CODE.INFO | Symbology | PUBLIC | 4.4.0 | GET | Gets information about the currently trained code type ('Untrained' if no code is trained). | Fixed mount devices. | |||
| TRIGGER.DELAY-DISTANCE | Camera | PUBLIC | 4.4.0 | SET|GET | millimeter |
[0-2147483646] | Delay camera acquisition by distance specified in millimeters. | DM503, DM474 and DM300 series readers. | |
| TRIGGER.DELAY-TIME | Camera | PUBLIC | 4.4.0 | SET|GET | milliseconds |
[0-10000] | Trigger delay in milliseconds. Delay camera acquisition by specified number of milliseconds. |
DM50, DM60, DM70, DM474, DM503, and DM300 series readers. | |
| TRIGGER.DELAY-TYPE | Camera | PUBLIC | 4.4.0 | SET|GET | mode |
[0-1] |
0: none 1: time |
Sets or gets whether trigger delay is according to time. | DM50, DM60 and DM70 |
| TRIGGER.DELAY-TYPE | Camera | PUBLIC | 4.4.0 | SET|GET | mode |
[0-2] |
0: none 1: time 2: distance |
Sets or gets whether trigger delay is according to time or distance. | DM503, DM474 and DM300 series readers. |
| TRIGGER.END-DELAY-DISTANCE | Camera | PUBLIC | 4.4.0 | SET|GET | millimeters |
[0-2147483646] | Sets or gets trigger end delay distance. | DM474, DM503 and DM300 series readers. | |
| TRIGGER.END-DELAY-TIME | Camera | PUBLIC | 4.4.0 | SET|GET | milliseconds |
[0-10000] | Sets or gets trigger end delay time. | DM50, DM60, DM70, DM474, DM503, and DM300 series readers. | |
| FILTER.IMAGE-TO-USE-SYMBOL | Decoder | PUBLIC | 4.3.0 | SET|GET | symbology input |
[1-5] [0-1] |
1: DataMatrix 2: QR Code/MaxiCode/AztecCode 3: Linear/ Postal/ Stacked 4: VeriCode® 5: DotCode 0: original image 1: filtered image |
Sets or gets which type of symbology should be filtered or not. AztecCode is only supported on the DM503 and DM300 series readers. |
DM50, DM60, DM70, DM150, DM260, DM300 series readers, DM474. |
| FILTER.NOREAD-IMAGE | Decoder | PUBLIC | 4.3.0 | SET|GET | symbology |
[0-5] |
0: Any 1: DataMatrix 2: QR Code/MaxiCode/AztecCode 3: Linear/ Postal/ Stacked 4: VeriCode® 5: DotCode |
Sets or gets if the symbology selected should be filtered if the image is no-read. AztecCode is only supported on the DM503 and DM300 series readers. |
DM50, DM60, DM70, DM150, DM260, DM300 series readers, DM474. |
| FILTER.STACK | Decoder | PUBLIC | 4.3.0 | SET|GET | step method value1 value2 value3 |
[1-4] [0-11] [0-255] |
Filter step 0: no filtering 1: equalize 2: stretch 3: low pass 4: dilate 5: erode 6: open 7: close 8: auto stretch 9: optical density 10: invert 11: median method parameter |
The first value sets the order of the filter steps. Filter step 1 is the first step, filter step 2 is the second, and so on. The second value sets the filter to be used. The third value means the additional properties that you can set for the given filter. You cannot configure the whole stack with one statement, but each on its own.The following example: SET FILTER.STACK 2 2 0 100 0 sets the second step in the filter, for stretch from 0 to 100, leaving the third value unused (0).The following example: GET FILTER.STACK 3 (for the third filter) returns 5 4 3 meaning that filter number 5, that is, erode is on, with parameters 4, 3. | DM50, DM60, DM70, DM150, DM260, DM300 series readers, DM474. |
| FOCUS.FEEDBACK | Camera | PUBLIC | 4.3.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enables focus feedback. | DM474, DM503 and DM300 series readers. |
| TUNE.ADJUST-FOCUS | Camera | PUBLIC | 4.3.0 | SET|GET | state |
[ON|OFF] | Enables or disables using adjusting focus while tuning. | DM70, DM150, DM260, DM474 and DM300 series readers with liquid lens. | |
| TUNE.CANCEL | Action | PUBLIC | 4.3.0 |
|
0: Tuning is cancelled. 104: Tuning is not running or there is an error. 101: Tuning is not available. |
Cancel tuning. | DM300 series readers, DM474, DM70, DM260, and DM150. | ||
| TUNE.START | Action | PUBLIC | 4.3.0 |
|
0: Tuning started. 104: Tuning is already running or there is an error. 101: Tuning is not available. |
Start tuning. | DM300 series readers, DM474, DM70, DM260, and DM150. | ||
| TUNE.TRAIN-CODE | Camera | PUBLIC | 4.3.0 | SET|GET | state |
[ON|OFF] | Enables or disables code training while tuning. | DM300 series readers, DM474, DM70, DM260, and DM150. | |
| TUNE.TUNE-LIGHT-BANKS | Camera | PUBLIC | 4.3.0 | SET|GET | state |
[ON|OFF] | Enables or disables using light banks while tuning. Only available when internal illumination is used. |
DM300 series readers, DM474, DM260, DM70 and DM150. | |
| WIFI.AUTH-MODE | Communication | PUBLIC | 4.2.4 | SET|GET | int |
[0-3] |
0 – no auth 1 – WPA-PSK 2 – WPA2-PSK 3 – EAP/TLS 4 – PEAP-MSCHAPV2 |
Sets the authentication method. | DM8000 |
| WIFI.CA-CERT | Communication | PUBLIC | 4.2.4 | SET|GET | string |
NA | Used In WPA-Enterprise. This is the certificate of the certification authority we trust. | PEM formatted certificate, terminated by a space. | DM8000;Base |
| WIFI.CHANNEL | Communication | PUBLIC | 4.2.4 | SET|GET | int |
[1-11] | Sets the wifi channel number. | ||
| WIFI.CLIENT-CERT | Communication | PUBLIC | 4.2.4 | SET|GET | string |
NA | Used in WPA-Enterprise (EAP-TLS). This is the certificate of the reader signed by the trusted CA (set with the previous command). | PEM formatted certificate, terminated by a space. | DM8000;Base |
| WIFI.CLIENT-IDENTITY | Communication | PUBLIC | 4.2.4 | SET|GET | string |
NA | The identity the client certificate is issued to. | DM8000;Base | |
| WIFI.CLIENT-PRIVATE-KEY | Communication | PUBLIC | 4.2.4 | SET|GET | string |
NA | Used in WPA-Enterprise (EAP-TLS). The private key of the reader. | PEM formatted private key, terminated by a space. | DM8000;Base |
| WIFI.ENABLED | Communication | PUBLIC | 4.2.4 | SET|GET | state |
[ON|OFF] | enable/disable | Enables or disables wifi in ad-hoc mode. | |
| WIFI.ENC-METHOD | Communication | PUBLIC | 4.2.4 | SET|GET | int |
[0-5] |
0 – off 1 – WEP40 2 – WEP104 3 – TKIP 4 – AES 5 – TKIP/AES |
Sets the authentication method. | DM8000;Base |
| WIFI.NETWORK-TYPE | Communication | PUBLIC | 4.2.4 | SET|GET | int |
[0-1] |
0 – Infrastructure mode 1 – AD-HOC mode |
Sets whether wifi works in infrastructure or ad-hoc mode. | DM8000 |
| WIFI.PASSPHRASE | Communication | PUBLIC | 4.2.4 | SET|GET | string |
NA | In WEP encrpytion and in WPA(2)-PSK it is the passphrase set by the AP. | DM8000;Base | |
| WIFI.SSID | Communication | PUBLIC | 4.2.4 | SET|GET | string |
NA | Assigns an SSID name to the network. | ||
| COM.BUFFER-MODE | Communication | PUBLIC | 4.2.2 | SET|GET | int |
[0-1] |
0: Multiple 1: Single |
Sets or gets the offline buffering mode. | Wireless DM8000 readers. |
| COM.BUFFER-AUTO-FLUSH | Communication | PUBLIC | 4.2.1 | SET|GET | state |
[ON|OFF] | enable/disable | Determines if the whole content of the offline buffer is automatically flushed to the first Telnet client. If not, flushing must be activated by the client. | Wireless readers. |
| COM.BUFFER-DATA | Communication | PUBLIC | 4.2.1 | SET|GET | state |
[ON|OFF] | enable/disable | Offline buffering. | Wireless readers. |
| COM.BUFFER-RESET | Action | PUBLIC | 4.2.1 | Clears the content of the offline buffer. | DM8050, DM8600 and MX-1000. | ||||
| COM.BUFFER-START-SEND | Action | PUBLIC | 4.2.1 | Valid if auto-flush is off. Activates buffer data output over Telnet channels (and flushes buffered codes). Data output is stopped every time when all Telnet channels are disconnected. | DM8050, DM8600 and MX-1000. | ||||
| COM.RS232-ROUTE | Communication | PUBLIC | 4.2.1 | SET|GET | value |
[0-1] |
0: base station 1: associated reader |
Controls to which device RS-232 communication is routed. | DM8000 series wireless readers. |
| COM.USB-MODE | Communication | PUBLIC | 4.2.1 | SET|GET | type |
[0-1] |
0: USB COM 1: USB HID |
Controls USB based communication channels. | DM50, DM60, DM70, MX-1000, MX-1502 and DM8000 series readers. |
| COM.USB-SPEED | Communication | PUBLIC | 4.2.1 | SET|GET | int |
[ON|OFF] |
ON: USB 1.1 mode OFF: USB 2.0 mode |
Forces the USB into full speed mode. | Every reader connected through USB except MX-1000. |
| LIGHT.AIMER-TIMEOUT | Camera | PUBLIC | 4.2.1 | SET|GET | int |
[0-600] | seconds | Aimer Timeout in seconds. | MX-1000 and DM8000 series readers. |
| POWER.HIBERNATE-DISABLE | System | PUBLIC | 4.2.1 | SET|GET | state |
[ON|OFF] | enable/disable | Turning the Hibernation feature on or off. ON means that the device never hibernates. OFF means that Hibernation is not disabled (it is enabled), thus the device will go into hibernation mode. | DM8000 wireless readers. |
| POWER.HIBERNATE-TIMEOUT | System | PUBLIC | 4.2.1 | SET|GET | int |
[1-600] | seconds | Hibernation timeout. | DM8000 wireless readers. |
| POWER.POWEROFF-DISABLE | System | PUBLIC | 4.2.1 | SET|GET | state |
[ON|OFF] | enable/disable | Turning the Power Off feature on or off. ON means that the device never turns off. OFF means that Power Off is not disabled (it is enabled), thus the device will turn off. | DM8050, DM8600, MX-1000 and MX-1502. |
| POWER.POWEROFF-TIMEOUT | System | PUBLIC | 4.2.1 | SET|GET | int |
[1-600] | seconds | Power Off timeout. | DM8050, DM8600, MX-1000 and MX-1502. |
| COM.COMMUNICATIONS-MODULE | Communication | PUBLIC | 4.2.0 | GET | type |
[0-3] |
0: Serial 1: Ethernet 2: Wireless 3: Bluetooth |
Returns the type of communication module being used. | MX-1000 and DM8000 series readers. |
| COM.DMCC-EVENT | Communication | PRIVATE | 4.2.0 | SET|GET | event_mask |
[0-255] bitfield |
0: none 1: reader online/offline |
Sets which events are sent over DMCC. Used by DataMan SDK. | Wireless readers, base station. |
| COM.USB-TEST-SN | Communication | PRIVATE | 4.2.0 | SET|GET | string |
test serial number | Used by manufacturing to make different devices enumerate on the same CDC COM port. | Base station, DM50, DM60 and DM70. | |
| COM.USB-USE-TEST-SN | Communication | PRIVATE | 4.2.0 | SET|GET | state |
[ON|OFF] [ON|OFF] | enable/disable | Used by manufacturing to make different devices enumerate on the same CDC COM port. | Base station, DM50, DM60 and DM70. |
| CONTROL.RPC | Action | PRIVATE | 4.2.0 | SET|GET | string |
RP code to execute. | Executes RP codes passed as string. Used internally to route RP commands to the base station. | ALL | |
| DEVICE.SSID | Communication | PUBLIC | 4.2.0 | SET|GET | string |
Network name. | Wireless readers. | ||
| FTP-PROXY.CONNECT | Communication | PRIVATE | 4.2.0 | index |
[0-15] | FTP object index as returned by FTP-PROXY.CREATE | Used by wireless readers to proxy FTP transfer through base station. | Base station. | |
| FTP-PROXY.CREATE | Communication | PRIVATE | 4.2.0 | user pass server port type |
dotted decimal from IPv4 address [1-65535] [0-1] |
Password. Target FTP server address. Target FTP port number. Target FTP server type (Generic/Mitsubishi). |
Used by wireless readers to proxy FTP transfer through base station. | Base station. | |
| FTP-PROXY.DESTROY | Communication | PRIVATE | 4.2.0 | index |
[0-15] | FTP object index as returned by FTP-PROXY.CREATE | Used by wireless readers to proxy FTP transfer through base station. | Base station. | |
| FTP-PROXY.DISCONNECT | Communication | PRIVATE | 4.2.0 | index |
[0-15] | FTP object index as returned by FTP-PROXY.CREATE | Used by wireless readers to proxy FTP transfer through base station. | Base station. | |
| FTP-PROXY.EXECUTE | Communication | PRIVATE | 4.2.0 | index type path length data |
[0-15] [0-15] [0-15] [0-3] [0-3] |
FTP object index as returned by FTP-PROXY.CREATE FTP transfer type (STOR/STOU/APPE/RETR) File path for FTP transfer Data length Data |
Used by wireless readers to proxy FTP transfer through base station. | Base station. | |
| NET-LOCAL.READER-IP-ADDRESS | Communication | PUBLIC | 4.2.0 | SET|GET | string |
dotted decimal form IPv4 address | Base station's IP address. Uses dotted decimal form, such as "192.168.23.42". |
Base stations. | |
| ENCODER.COUNT | IO | PUBLIC | 4.1.0 | SET|GET | value |
[0-2 billion] | value to set | Gets the encoder count or sets it to the specified value. | Fixed-mount readers |
| ENCODER.DISTANCE-TO-OUTPUT | IO | PUBLIC | 4.1.0 | SET|GET | int |
0-1000000 mm |
Default: 0 Min: 0 Max: 1000000 Step: 1 |
Sets the output distance from the trigger on the sensor. | DM300 series readers, DM474. |
| ENCODER.FLUSH | IO | PUBLIC | 4.1.0 | Flushes all encoder actions. | DM474, DM503 and DM300 series readers. | ||||
| ENCODER.RESOLUTION | IO | PUBLIC | 4.1.0 | SET|GET | int |
0-1000000 um |
Default: 5000 Min: 0 Max: 1000000 Step: 1 |
Sets the distance per pulse of the encoder. | DM474, DM503, and DM300 series readers. |
| LIGHT.EXTERNAL-ENABLE | Camera | PUBLIC | 4.1.0 | SET|GET | enable |
[ON|OFF] | enable/disable | Enable external illumination supported by I/O. | Fixed mount readers. |
| LIGHT.INTERNAL-ENABLE | Camera | PUBLIC | 4.1.0 | SET|GET | enable |
[ON|OFF] | enable/disable | Enable the built-in internal illumination. Default value is OFF. | DM50, DM60, DM70, DM8050, MX-1000, MX-1502, Mobile. |
| LIGHTCURTAIN.BEAM-SPACING | IO | PUBLIC | 4.1.0 | SET|GET | spacing |
[1-300000] | micrometers | Distance (in um) between beams of the Light Curtain. This determines the resolution of the light curtain. | DM503 |
| MASTER-SLAVE.RX-HEIGHT-SENSOR | Camera | PUBLIC | 4.1.0 | SET|GET | enable |
[ON|OFF]* | enable/disable | Enables or disables this system receiving height information from another system in the network group. | DM60, DM474 and DM300 series readers. |
| OUTPUT-QUEUE.FLUSH | IO | PUBLIC | 4.1.0 | int |
[0-1] |
0: throw output away 1: send all output now |
To flush or send all output. | DM474, DM503, and DM300 series readers. | |
| DECODER.1D-SYMBOL-ORIENTATION | Decoder | PUBLIC | 4.1 | SET|GET | orientation |
[0-3] |
0: Omnidirectional 1: Ladder and Picket Fence (default) 2: Ladder 3: Picket Fence |
Sets or gets the orientation at which codes can be found. Omnidirectional requires the Omnidirectional feature key. | DM50, DM60, DM70, DM474, DM503, MX-1000, MX-1502 and DM300 series readers. DM503L readers support only 2: Ladder and 3: Picket Fence. |
| CAMERA.INTERVAL-US | Camera | PUBLIC | 4.0.0 | SET|GET | us |
[*-1000000] |
Microseconds. Step size is 250. * By default the minimum range is 6000 but this can change depending on decode timeout and field of view. |
Acquisition Interval, the time between successive camera acquisitions in microseconds. Supported with Burst, Self, and Continuous trigger types. | DM50, DM60, DM70, DM474, DM503, and DM300 series readers. |
| CAMERA.MAX-EXPOSURE-US | Camera | PUBLIC | 4.0.0 | SET|GET | exposure |
[1-50] [1-410] [1-100000] |
with HPIA without HPIA with external or no illumination |
Maximum exposure limit in microseconds for autoregulation. HPIA = High Powered Illumination Accessory. |
DM70, DM150, DM260, DM474, DM503, and DM300 series readers. |
| FOCUS.DISTANCE | Camera | PUBLIC | 4.0.0 | SET|GET | int |
Distance in mm from the front of the camera to the part. This command returns the value only if Focus Steps is set to 0, otherwise you need to use FOCUS.SWEEP-RANGE instead. |
DM300 series readers, DM474. | ||
| FOCUS.FAST-DELAY | Camera | PRIVATE | 4.0.0 | SET|GET | value |
??? | |||
| FOCUS.FOCUS-TIME | Camera | PRIVATE | 4.0.0 | SET|GET | value |
[0-3] | |||
| FOCUS.RELAX-TIME | Camera | PRIVATE | 4.0.0 | SET|GET | value |
??? | |||
| FOCUS.STRATEGY | Camera | PRIVATE | 4.0.0 | SET|GET | value |
??? | |||
| FTP-IMAGE.MAX-APPEND-START-VALUE | Communication | PUBLIC | 4.0.0 | SET|GET | value |
[0-65535] | Initial increment value to append to image name. | DM503 | |
| FTP-IMAGE.PORT | Communication | PUBLIC | 4.0.0 | SET|GET | port |
[0-65535] | FTP server port number. | Ethernet readers. DM8000 series wireless readers also support FTP if the base station is connected through Ethernet. | |
| FTP-RESULT.PORT | Communication | PUBLIC | 4.0.0 | SET|GET | port |
[0-65535] | FTP server port number. | Ethernet readers. DM8000 series wireless readers also support FTP if the base station is connected through Ethernet. | |
| IMAGE.LOAD-FTP-MULT-PARAM | Camera | PRIVATE | 4.0.0 | ??? | |||||
| IMAGE.LOAD-FTP-PARAM | Camera | PRIVATE | 4.0.0 | ??? | |||||
| IMAGEBUFFER.ALLOW-OVERWRITE | RecordPlayback | PUBLIC | 4.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Allow buffered images that have not been transfered to be overwritten if all available buffers are used and new images arrive. | DM50, DM60, DM70, DM474, DM503, DM300 series readers, DM8050 and DM8600. |
| IMAGEBUFFER.DELETE | RecordPlayback | PUBLIC | 4.0.0 | Release stored images. | DM50, DM60, DM70, DM474, DM503, DM300 series readers, DM8050 and DM8600. | ||||
| IMAGEBUFFER.DELETE-AFTER-TRANSFER | RecordPlayback | PUBLIC | 4.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Release stored images automatically after image has been transfered. | DM50, DM60, DM70, DM474, DM503, DM300 series readers, DM8050 and DM8600. |
| IMAGEBUFFER.MAX-NUM | RecordPlayback | PUBLIC | 4.0.0 | SET|GET | size |
[0-*] | Maximum number of images that can be buffered. * Range varies depending depending on Camera ROI and memory allocated for burst length. |
DM50, DM60, DM70, DM474, DM503, DM300 series readers, DM8050 and DM8600. | |
| IMAGEBUFFER.NO-READ-IMAGE-PERIOD | RecordPlayback | PUBLIC | 4.0.0 | SET|GET | interval |
[1-200] | Sets or gets the interval to save the image of a bad read. If, for example, you use an interval of 6, the first bad image is saved and the next 5 are not. The default is 1 which saves each bad read image. | DM50, DM60, DM70, DM474, DM503, DM300 series readers, only in Single, Burst, Self and Continuous modes. | |
| IMAGEBUFFER.NUM | RecordPlayback | PUBLIC | 4.0.0 | GET | size |
Returns the number of currently buffered images. | DM50, DM60, DM70, DM474, DM503, DM300 series readers, DM8050 and DM8600. | ||
| IMAGEBUFFER.QUALITY | RecordPlayback | PUBLIC | 4.0.0 | SET|GET | quality |
[10, 15, 20... 85, 90] | JPEG Quality | DM50, DM60, DM70, DM474, DM503, MX-1000, DM8000 series and DM300 series readers. | |
| IMAGEBUFFER.RECORD | RecordPlayback | 4.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable or disable image buffereing. obsolete in 4.0.0. |
Fixed mount readers, DM8050 and DM8600. | |
| IMAGEBUFFER.RECORD-TYPE | RecordPlayback | PUBLIC | 4.0.0 | SET|GET | type |
[0-5] |
0: None 1: No-Read 2: Read 3: All 4: Validation Failure 5: No-Read + Validation failure |
Sets or gets the type of image to buffer. In case of No-Read, the image is buffered if the reader fails to read. |
DM50, DM60, DM70, DM474, DM503, MX-1000, DM8000 series and DM300 series readers. |
| IMAGEBUFFER.SEND-FTP | RecordPlayback | PUBLIC | 4.0.0 | Transmit buffered images to designated FTP server. | DM60, DM474, DM503, DM8000 series and DM300 series readers. | ||||
| IMAGEBUFFER.SEND-FTP-PARAM | RecordPlayback | PRIVATE | 4.0.0 | Transmit buffered images to designated FTP server. | Fixed mount Ethernet readers, DM8050 and DM8600. | ||||
| IMAGEBUFFER.SIZE | RecordPlayback | PUBLIC | 4.0.0 | SET|GET | size |
[0-3] |
0: Full 1: 1/4 2: 1/16 3: 1/64 |
DM50, DM60, DM70, DM474, DM503, MX-1000, DM8000 series and DM300 series readers. | |
| IMAGEBUFFER.TRANSFER-MODE | RecordPlayback | PUBLIC | 4.0.0 | SET|GET | interval |
[0-1] |
0: On Request 1: FTP - runtime |
Sets or gets whether buffered images should automatically sent FTP or if they should be send only after requested. | DM60, DM70, DM474, DM503, MX-1000, DM8000 series, and DM300 series readers and DM260. |
| INPUT.ACTION | IO | PUBLIC | 4.0.0 | SET|GET | line action state |
[0-3] [0-11] [ON|OFF] |
Input line number 0: Train Code 1: Optimize Brightness 2: Set Match String 3: Optimize Focus 4: Read Configuration Code 5: Trigger Off 6: Encoder 7: Allow Buffered No-Read Images 8: Clear Outputs 9: Tune (DM300 only) 10: Encoder direction 11: Trigger on ON: execute action when line is triggered OFF: no action |
Sets or gets the state for the specified line action. The input actions "Train Code," "Optimize Brightness," "Set Match String," and "Read Configuration Code" are carried out only after the next trigger. |
Fixed-mount readers. |
| MASTER-SLAVE.GROUP-NAME | Communication | PUBLIC | 4.0.0 | SET|GET | name |
Gets or sets the name of the master slave group. | DM60, DM474, DM503, and DM300 series readers. | ||
| MASTER-SLAVE.MODE | Communication | PUBLIC | 4.0.0 | SET|GET | mode |
[0-2] |
0: OFF 1: ON 2: Master |
Switches the master-slave functioning of the reader on or off. | DM60, DM474, DM503, and DM300 series readers. |
| MASTER-SLAVE.TIMEOUT | Communication | PUBLIC | 4.0.0 | SET|GET | milliseconds |
[0-10000] | Gets or sets the time to wait for results from slave cameras. | DM60, DM474, DM503, and DM300 series readers. | |
| MQA.POSTAL-MODE | Code Quality | PRIVATE | 4.0.0 | SET|GET | mode |
[0-2] |
0: Off 1: Partial Metrics 2: All Metrics |
Gets or sets the postal verification mode. | ALL |
| TRIGGER.DEBOUNCE-DELAY | IO | PUBLIC | 4.0.0 | SET|GET | delay |
[0-6] |
0: short 1: 2: default 3: 4: 5: 6: long |
Sets or gets how long the trigger signal must be detected in order to be recognized as valid. | Fixed-mount readers. |
| TRIGGER.POLARITY | IO | PUBLIC | 4.0.0 | SET|GET | line polarity |
[0-3] [ON|OFF] |
Input line ON: Rising edge OFF: Falling edge |
Sets or gets the polarity at which an input will be triggered. | Fixed mount readers. |
| VSOC.ACCELERATION | Decoder | PRIVATE | 4.0.0 | SET|GET | enable |
[ON|OFF] | enable/disable | Enabled or disable VSOC acceleration. | |
| VSOC.LEGACY-AUTO-REG | Camera | PRIVATE | 4.0.0 | SET|GET | enable |
[ON|OFF] | enable/disable | Enabled or disable VSOC auto-regulation algorithm. | |
| FOCUS.SWEEP-RANGE | Camera | PUBLIC | 3.6.0 | SET|GET | DM8000 DM300 |
[0-500] [0-500] [40-500] [40-500] |
low sweep range high sweep range low sweep range high sweep range |
Defines the sweep range to be used for focusing. Low must be less than high. The low value is ignored if FOCUS.SWEEP-STEPS is set to 0. | DM70, DM260, DM300 series, DM474 and DM8000 series readers. |
| FOCUS.SWEEP-STEPS | Camera | PUBLIC | 3.6.0 | SET|GET | value |
[0-8] | number of steps to divide the sweep range | Sets the number of steps the sweep range should be divided by. If steps is set to 0 only the high sweep range value is used. | DM70, DM260, DM474, DM8000 series and DM300 series readers. |
| TRIGGER | Action | PUBLIC | 3.6.0 | GET | state |
[0|1] |
0: Off 1: On |
Get current state of the trigger. | ALL |
| DATAMATRIX.ALGORITHM-VERSION | Symbology | PUBLIC | 3.5.3 | SET|GET | version |
[0-2] |
0: speed preferred 1: yield preferred 2: extended |
IDQuick Usage Type. | Fixed mount readers except for DM300L, DM503L, and DM503QL. 2 (extended) is supported by DM50, DM60, DM70, DM150, DM260. |
| COM.DMCC-CHECKSUM | Communication | PRIVATE | 3.4.0 | SET|GET | type |
[0-3] |
0: none 1: XOR 2: CRC16 (Header/Response) 3: CRC16 (Header/Response/Data) |
Checksum used in DMCC response. | |
| COM.DMCC-HEADER | Communication | PRIVATE | 3.4.0 | SET|GET | type |
[0-1] |
0: default 1: include result ID |
Sets or gets the header option used in Extended mode. | |
| DATA.IMAGE-TYPE | Communication | PRIVATE | 3.4.0 | SET|GET | type |
[0-2] |
0: all 1: no read 2: read |
Sets or gets type of image automatically returned. Used in conjuction with DATA.RESULT-TYPE. | |
| DATABAR.EXPANDED | Symbology | PUBLIC | 3.4.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable Databar expanded. | ALL |
| DATABAR.GROUP | Symbology | PUBLIC | 3.4.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable Databar group. | ALL |
| DATABAR.LIMITED | Symbology | PUBLIC | 3.4.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable Databar limited. | ALL |
| DATAMATRIX.EXTREME-PRINT-GROWTH | Symbology | PUBLIC | 3.4.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable extreme print growth for DataMatrix symbols. | ALL except for DM50, DM60, DM70, DM300, DM503, DM8050 and DM8600. |
| DECODER.PREPROCESS | Decoder | PRIVATE | 3.4.0 | SET|GET | slot filter param1 param2 param3 |
[0] [0-2] [0-255] [0-255] [0-255] |
slot to configure 0: none 1: Equalize 2: Stretch Filter parameter 1. Filter parameter 2. Filter parameter 2. |
Sets or gets the filter to apply to an image before decoding. | |
| DVALID.GS1-FORMAT | Data Validation | PUBLIC | 3.4.0 | SET|GET | string |
GS1 format string | Set GS1 format string. | ALL | |
| EVENT.RULES | IO | PRIVATE | 3.4.0 | SET|GET | rules |
||||
| MULTICODE.HORIZONTAL-REVERSE | Symbology | PUBLIC | 3.4.0 | SET|GET | state |
[ON|OFF] |
ON: sort right to left OFF: sort left to right |
Horizontal positional sorting order priority. | Fixed mount readers. |
| MULTICODE.IDENTICAL-SYMBOLS | Symbology | PUBLIC | 3.4.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enables/disables output of identical symbols when multicode is enabled. | Fixed mount readers. |
| MULTICODE.SORT-PRIORITY | Symbology | PUBLIC | 3.4.0 | SET|GET | symbology image vertical position horizontal position |
[0-3] [0-3] [0-3] [0-3] |
Range for all four arguments indicates sort priority. Must be different for each criteria. |
Sorting order for multicode results: 0 is highest priority, 3 is lowest priority. | Fixed mount readers. |
| MULTICODE.SYMBOLOGY-REVERSE | Symbology | PUBLIC | 3.4.0 | SET|GET | state |
[ON|OFF] |
ON: DotCode, VeriCode ®, Linear/Postal/Stacked, QR Code/MaxiCode/AztecCode, Data Matrix OFF: Data Matrix, QR Code/MaxiCode/AztecCode, Linear/Postal/Stacked, VeriCode ®, DotCode |
Symbology sorting order preference. | Fixed mount readers. |
| MULTICODE.VERTICAL-REVERSE | Symbology | PUBLIC | 3.4.0 | SET|GET | state |
[ON|OFF] |
ON: sort bottom to top OFF: sort top to bottom |
Vertical position sorting order preference. | Fixed mount readers. |
| NET-LOCAL.PORT | Communication | PUBLIC | 3.4.0 | SET|GET | port |
[1-65535] | Setup Tool server TCP port on reader. | Ethernet readers. | |
| PHARMA.CODE-ORIENTATION | Symbology | PUBLIC | 3.4.0 | SET|GET | direction |
[0-2] |
0: Any (default) 1: Horizontal 2: Vertical |
Preferred orientation for decoding Pharmacode symbols. | ALL |
| PHARMA.CODESIZE | Symbology | PUBLIC | 3.4.0 | SET|GET | any min max |
[ON|OFF] [1-6] [1-6] |
any length code minimum code length maximum code length |
Expected Pharmacode size. | ALL |
| PHARMA.HORIZONTAL-DIRECTION | Symbology | PUBLIC | 3.4.0 | SET|GET | direction |
[0-1] |
0: left-to-right (default) 1: right-to-left |
Horizontal direction preference for decoding Pharmacode symbols. | ALL |
| PHARMA.SUPPLEMENTARY | Symbology | PRIVATE | 3.4.0 | SET|GET | state |
[ON|OFF] | enable/disable | Get or set whether supplementary component is expected. | ALL |
| PHARMA.SUPPLEMENTARY-GAP-THRESH | Symbology | PRIVATE | 3.4.0 | SET|GET | gap |
[100-300] | Get or set the Pharmacode supplementary gap threshold in pixels. | ALL | |
| PHARMA.VERTICAL-DIRECTION | Symbology | PUBLIC | 3.4.0 | SET|GET | direction |
[0-1] |
0: top-to-bottom (default) 1: bottom-to-top |
Vertical direction preference for decoding Pharmacode symbols. | ALL |
| SYMBOL.4STATE-IMB | Symbology | PUBLIC | 3.4.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable 4-State Intelligent Mail Barcode. | ALL except for DM150QL, DM260QL, DM300L, DM503L, and DM503QL. |
| SYMBOL.DATABAR | Symbology | PUBLIC | 3.4.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable Databar. It will enable EXPANDED and LIMITED in Manatee Works SDK (just like MX). | ALL |
| NET-LOCAL.TCP-KEEPALIVE | Communication | PRIVATE | 3.3.1 | SET|GET | state |
[ON|OFF] | enable/disable | Enable/Disable TCP keepalive message. | Ethernet readers. |
| NET-LOCAL.TCP-KEEPALIVE-COUNT | Communication | PRIVATE | 3.3.1 | SET|GET | value |
[0-32565] | TCP keep alive retry count. | Ethernet readers. | |
| NET-LOCAL.TCP-KEEPALIVE-IDLE | Communication | PRIVATE | 3.3.1 | SET|GET | value |
[0-32565] | TCP keep alive time. Ethernet readers. |
||
| NET-LOCAL.TCP-KEEPALIVE-INTERVAL | Communication | PRIVATE | 3.3.1 | SET|GET | value |
[0-32565] | TCP keep alive interval. Ethernet readers. |
||
| STATISTICS.RESET | Action | PUBLIC | 3.3.1 | Reset all statistics. | ALL | ||||
| ETHERNET-IP.ENABLED | Communication | PUBLIC | 3.3.0_cr1 | SET|GET | state |
[ON|OFF] | enable/disable | Enabled or disabled EtherNet/IP communications. | Ethernet readers. The DM8000 series wireless readers also support this protocol if the base station is connected through Ethernet. In the case of a Bluetooth connection, the command has to be sent to the base station, not to the reader. |
| CAMERA.BURST-TRANSFER-ALL | Camera | PRIVATE | 3.3.0 | SET|GET | state |
[ON|OFF] | enable/disable | Force transfer of all burst images. Used by the DMCC .NET. |
|
| CQ.RESET-CALIBRATION | Code Quality | PUBLIC | 3.3.0 | Invalidates code quality calibration data. Reboot is required. |
DM8600V | ||||
| DEVICE.BACKUP | Action | PUBLIC | 3.3.0 | Send encrypted backup file (.cdc) to the PC. | ALL | ||||
| DEVICE.MAC-ADDRESS | Communication | PUBLIC | 3.3.0 | GET | Reader's MAC address. | Ethernet readers. | |||
| DEVICE.RESTORE | Action | PUBLIC | 3.3.0 | file size |
Transmits backup file (.cdc) to the reader. File size is in bytes. File data follows footer. | ALL | |||
| FILE.UNLINK | System | PRIVATE | 3.3.0 | file |
Remove file from file system. | ||||
| FTP-IMAGE.CUSTOM-FILE-NAME | Communication | PUBLIC | 3.3.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable/disable FTP server generated file name. | Ethernet readers. DM8000 series wireless readers also support FTP if the base station is connected through Ethernet. |
| FTP-IMAGE.FILE-NAME | Communication | PUBLIC | 3.3.0 | SET|GET | string |
File name of FTP image. | Ethernet readers. DM8000 series wireless readers also support FTP if the base station is connected through Ethernet. | ||
| FTP-IMAGE.IP-ADDRESS | Communication | PUBLIC | 3.3.0 | SET|GET | string |
IP address of target FTP server. Uses dotted decimal form, such as "192.168.23.42". |
Ethernet readers. DM8000 series wireless readers also support FTP if the base station is connected through Ethernet. | ||
| FTP-IMAGE.MAX-APPEND | Communication | PUBLIC | 3.3.0 | SET|GET | value |
[0-65535] | Max increment value to append to image name. | Ethernet readers. DM8000 series wireless readers also support FTP if the base station is connected through Ethernet. | |
| FTP-IMAGE.PASSWORD | Communication | PUBLIC | 3.3.0 | SET | string |
Password used to login to target FTP server. | Ethernet readers. DM8000 series wireless readers also support FTP if the base station is connected through Ethernet. | ||
| FTP-IMAGE.SERVER-PATH | Communication | PUBLIC | 3.3.0 | SET|GET | string |
Path for FTP image. | Ethernet readers. DM8000 series wireless readers also support FTP if the base station is connected through Ethernet. | ||
| FTP-IMAGE.USER-NAME | Communication | PUBLIC | 3.3.0 | SET|GET | string |
Username used to login to target FTP server. | Ethernet readers. DM8000 series wireless readers also support FTP if the base station is connected through Ethernet. | ||
| FTP-RESULT.APPEND | Communication | PUBLIC | 3.3.0 | SET|GET | type |
[ON|OFF] |
ON: Append result to existing file. OFF: Overwrite file content with result. |
Append to or overwrite file when result is sent via FTP to the file specified by FTP-RESULT.FILE-NAME. The file will be created if it does not exist. | Ethernet readers. DM8000 series wireless readers also support FTP if the base station is connected through Ethernet. |
| FTP-RESULT.ENABLE | Communication | PUBLIC | 3.3.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable/disable FTP transfer of reader results. | Ethernet readers. DM8000 series wireless readers also support FTP if the base station is connected through Ethernet. |
| FTP-RESULT.FILE-NAME | Communication | PUBLIC | 3.3.0 | SET|GET | string |
File name of FTP result. | Ethernet readers. DM8000 series wireless readers also support FTP if the base station is connected through Ethernet. | ||
| FTP-RESULT.IP-ADDRESS | Communication | PUBLIC | 3.3.0 | SET|GET | string |
IP address of target FTP server. Uses dotted decimal form, such as "192.168.23.42". |
Ethernet readers and MX-1000. DM8000 series wireless readers also support FTP if the base station is connected through Ethernet. | ||
| FTP-RESULT.PASSWORD | Communication | PUBLIC | 3.3.0 | SET | string |
Password used to login to target FTP server. | Ethernet readers. DM8000 series wireless readers also support FTP if the base station is connected through Ethernet. | ||
| FTP-RESULT.USER-NAME | Communication | PUBLIC | 3.3.0 | SET|GET | string |
Username used to login to target FTP server. | Ethernet readers. DM8000 series wireless readers also support FTP if the base station is connected through Ethernet. | ||
| NET-LOCAL.DHCP | Communication | PUBLIC | 3.3.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable/Disable DHCP on reader. | Ethernet readers. |
| NET-LOCAL.DNS-SERVER | Communication | PUBLIC | 3.3.0 | SET|GET | server |
Gets or sets the DNS Server address. | Ethernet readers. | ||
| NET-LOCAL.GATEWAY | Communication | PUBLIC | 3.3.0 | SET|GET | string |
Reader's default gateway IP address. Uses dotted decimal form, such as "192.168.23.1". |
Ethernet readers. | ||
| NET-LOCAL.IP-ADDRESS | Communication | PUBLIC | 3.3.0 | SET|GET | string |
Reader's IP address. Uses dotted decimal form, such as "192.168.23.42". |
Ethernet readers. | ||
| NET-LOCAL.SUBNET-MASK | Communication | PUBLIC | 3.3.0 | SET|GET | string |
Reader's subnet mask. Uses dotted decimal form, such as "192.168.23.255". |
Ethernet readers. | ||
| TELNET.PORT | Communication | PUBLIC | 3.3.0 | SET|GET | value |
[0-65535] | Telnet server TCP port on reader. | Ethernet readers. | |
| TRAIN.FOCUS | Action | PUBLIC | 3.3.0 | state |
[ON|OFF] | enable/disable | Optimize lens focus. | DM503, DM474 and DM300 series readers. | |
| DECODER.1D-LEARN-CODESIZE | Decoder | PRIVATE | 3.2.0_cr5 | SET|GET | state |
[ON|OFF] | enable/disable | Learn the code size of 1D Symbols. | ALL |
| CAMERA.FOV | Camera | PREVIEW | 3.2.0 | SET|GET | left (multiple of 8) right (multiple of 8) top (multiple of 4) bottom (multiple of 4) |
[0...] [left+64...] [0...] [top+64...] |
pixels from left pixels from right pixels from top pixels from bottom |
The camera field of view is the area of the camera used for image acquisition. | ALL |
| CAMERA.FOV-ENABLED | Camera | PUBLIC | 3.2.0 | SET|GET | state |
[ON|OFF] | enable/disable | Indicates whether the full FoV or a custom FoV will be used for image acquisition. You can change this value only for the following trigger types: single, burst, and continuous. |
ALL |
| CUSTOM-CMD.COMMAND-FOOTER | Communication | PUBLIC | 3.2.0 | SET|GET | string |
End of the string to be echoed. See the Overview topic for formatting requirements for the string argument. |
Fixed mount readers. | ||
| CUSTOM-CMD.COMMAND-HEADER | Communication | PUBLIC | 3.2.0 | SET|GET | string |
Start of the string to be echoed. | Fixed mount readers. | ||
| CUSTOM-CMD.ECHO | Communication | PUBLIC | 3.2.0 | SET|GET | state |
[ON|OFF] | enable/disable | Indicates if characters received between a COMMAND-HEADER and COMMAND-FOOTER are echoed. | Fixed mount readers. |
| CUSTOM-CMD.TRIGGER | Communication | PUBLIC | 3.2.0 | SET|GET | state |
[ON|OFF] | enable/disable | Indicates if reader will respond to the TRIGGER-ON or TRIGGER-OFF string. | Fixed mount readers. |
| CUSTOM-CMD.TRIGGER-OFF | Communication | PUBLIC | 3.2.0 | SET|GET | string |
String that will stop a trigger. See the Overview topic for formatting requirements for the string argument. |
Fixed mount readers. | ||
| CUSTOM-CMD.TRIGGER-ON | Communication | PUBLIC | 3.2.0 | SET|GET | string |
String that will start a trigger. See the Overview topic for formatting requirements for the string argument. |
Fixed mount readers. | ||
| DATAMATRIX.SECURITY-KEY | Symbology | PRIVATE | 3.2.0 | SET | type name |
1 |
1: Custom1 |
Sets the secure Data Matrix key which is 32 byte string. This string needs to be entered in hexadecimal format. | |
| DATAMATRIX.SECURITY-TYPE | Symbology | PRIVATE | 3.2.0 | SET|GET | type state |
[0-1] [ON|OFF] |
0: None 1: Custom1 enable/disable |
Data Matrix security type used. Only valid with a valid security key is set. | ALL |
| FORMAT.MULTICODE-DELIMITER | Data Formatting | PUBLIC | 3.2.0 | SET|GET | type |
[0-6] |
0: none 1: space 2: comma 3: tab 4: label 5: xml 6: CRLF |
Data Formatting Delimiter. Sets the delimiter between codes in a multicode result. |
Fixed mount readers. |
| FORMAT.PROG-TARG | Data Formatting | PUBLIC | 3.2.0 | SET|GET | category |
[0-5] |
0: Universal 1: DataMatrix 2: QR Code/MaxiCode/AztecCode 3: Linear/ Postal/ Stacked 4: VeriCode® 5: DotCode |
Data Formatting Programming Target. Data Formatting Symbology Set to be modified by subsequent commands. Once issued, it changes the subsequent behavior of the reader. AztecCode is only supported on the DM503 and DM300 series readers. |
ALL |
| INTER-MESSAGE.DELAY | Communication | PREVIEW | 3.2.0 | SET|GET | value |
[0-10000] | milliseconds | Transmission delay between buffered read strings. | Wireless readers. |
| MULTICODE.MAX-NUM-CODES | Symbology | PUBLIC | 3.2.0 | SET|GET | symbology number |
[1-5] [1-255] |
1: DataMatrix 2: QR Code/MaxiCode/AztecCode 3: Linear/ Postal/ Stacked 4: VeriCode® 5: DotCode |
The expected maximum number of codes to find for each symbology grouping 1 - 4; no expected value for any single symbology can exceed parameter 0, the total number of codes to find. | Fixed mount readers. |
| MULTICODE.NUM-CODES | Symbology | PUBLIC | 3.2.0 | SET|GET | number |
[1-255] | Number of codes readers must find for a successful read result. | Fixed mount readers. | |
| MULTICODE.PARTIAL-RESULTS | Symbology | PUBLIC | 3.2.0 | SET|GET | state |
[ON|OFF] | enable/disable | Controls how the reader interprets the number of codes to find. ON = reader will return a successful read if 1 or more codes are found. OFF = reader will return a successful read only if number of codes found equals MULTICODE.NUM-CODES value. | Fixed mount readers. |
| SYMBOL.VERICODE | Symbology | PUBLIC | 3.2.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable VeriCode ® symbology. | DM70, DM150 and DM260 readers with VeriCode ® license. |
| TRAIN.AUTO-DISABLE | Symbology | PREVIEW | 3.2.0 | SET|GET | state |
[ON|OFF] | enable/disable | Indicates whether untrained symbology groups will be disabled after the next attempt to train. | Fixed mount readers. |
| TRAIN.AVAILABLE | Symbology | PRIVATE | 3.2.0 | GET | symbology |
Indicates whether incremental training is available for the selected symbology group. | Fixed mount readers. | ||
| TRAIN.INCREMENTAL | Symbology | PUBLIC | 3.2.0 | SET|GET | state |
[ON|OFF] | enable/disable | Indicates whether incremental training is used during the next attempt to train. | Fixed mount readers. |
| UNTRAIN.MODEL | Action | PUBLIC | 3.2.0 | enum index |
[0-5] 0 |
0: All Symbologies 1: DataMatrix 2: QR Code/MaxiCode/AztecCode 3: Linear/ Postal/ Stacked 4: VeriCode® 5: DotCode |
Deletes the specified model. AztecCode is only supported on the DM503 and DM300 series readers. |
Fixed mount readers. | |
| DATA.RESULT-ALWAYSSEND | System | PRIVATE | 3.1.0 | SET|GET | state |
[ON|OFF] | enable/disable | Sets gets whether to always send result. | ALL |
| DATA.RESULT-ENCODING | Communication | PUBLIC | 3.1.0 | SET|GET | encoding |
[0|1] |
0: ASCII (default) 1: Base64 |
Result string encoding. | ALL |
| DATA.RESULT-TYPE | System | PRIVATE | 3.1.0 | SET|GET | bit-field |
[0-128] |
0x00 = None 0x01 = Result 0x02 = XML formated result 0x04 = XML formated statistics 0x08 = Image Data 0x10 = Image Graphics 0x20 = Traning Result 0x40 = Code Quality Graphics |
Controls automatic result transmitted from reader. Default is 1. | ALL |
| DMPOP.INFO | System | PRIVATE | 3.1.0 | GET | vtree path |
Gets Device Info value tree parameter. | |||
| DMPUSH.INFO | System | PRIVATE | 3.1.0 | SET | vtree path |
Sets Device Info value tree parameter. DMCC Key is required. | |||
| DMSTATS | System | PRIVATE | 3.1.0 | vtree path |
Returns argument range for value tree parameter. e.g. ||>DMSTATS /ROI/Left |
||||
| FIRMWARE.LOAD | System | PRIVATE | 3.1.0 | file size date from location |
|
|
Loads firmware file to reader. File data follows DMCC footer. Forces a reboot. | ||
| FIRMWARE.LOAD-NOREBOOT | System | PRIVATE | 3.1.0 | file size date from location |
|
|
Loads firmware file to reader. File data follows DMCC footer. | ||
| FKEY.LOAD | System | PRIVATE | 3.1.0 | key size |
Loads encrypted feature key string to reader. Key data follows DMCC footer. Forces a reboot. | ||||
| FKEY.LOAD-NOREBOOT | System | PRIVATE | 3.1.0 | key size |
Loads encrypted feature key string to reader. Key data follows DMCC footer. | ||||
| FKEY.SAVE | System | PRIVATE | 3.1.0 | Saves feature key to flash memory. | |||||
| FLASH.ERASE | System | PRIVATE | 3.1.0 | sec number sec offset size |
|
|
Used to reset feature key data section. Obsolete in 3.3 by FILE.UNLINK. | ||
| FLASH.GET | System | PRIVATE | 3.1.0 | sec number sec offset size |
|
|
Output the specified section of Flash. | ||
| HEAP.STATS | System | PRIVATE | 3.1.0 | Returns heap memory statistics. | |||||
| TRAIN.MATCH-STRING | Action | PUBLIC | 3.1.0 | Triggers the reader and sets the match string to the value of the decoded string. Match String validation must be enabled for this command to work. | Fixed mount devices, DM8050 and DM8600. | ||||
| VIBRATION.GOOD | System | PUBLIC | 3.1.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enables vibration. | Handheld readers, except for DM8050. |
| 2D.ALGORITHM | Symbology | PUBLIC | 3.0.0 | SET|GET | algorithm |
[0-1] |
0: IDMax ©
1: IDQuick |
IDQuick or IDMax© | X, XM, SX and QE fixed-mount readers. All Q models except for DM503Q. |
| ABORT | Action | PRIVATE | 3.0.0 | Abort command in process. Intended to abort image transfer. | ALL | ||||
| BEEP | Action | PUBLIC | 3.0.0 | repetition level |
[0-3] [0-2] |
Command audio beep. | ALL | ||
| BEEP.DATAVALID-FAIL | IO | PUBLIC | 3.0.0 | SET|GET | repetition level |
[0-3] [0-2] |
number of beeps 0: Lo pitch 1: Med pitch 2: Hi pitch |
Data Validation Failure Beep Settings. | ALL except for DM50, DM60 and DM70. |
| BEEP.DATAVALID-FAIL-OL | IO | PUBLIC | 3.0.0 | SET|GET | repetition level |
[0-3] [0-2] |
number of beeps 0: Lo pitch 1: Med pitch 2: Hi pitch |
Data Validation Failure Beep Settings when offline. | Wireless readers. |
| BEEP.GOOD | IO | PUBLIC | 3.0.0 | SET|GET | repetition level |
[0-3] [0-2] |
number of beeps 0: Lo pitch 1: Med pitch 2: Hi pitch |
Good Read Beep Settings. | ALL except for DM50, DM60 and DM70. |
| BEEP.GOOD-OL | IO | PUBLIC | 3.0.0 | SET|GET | repetition level |
[0-3] [0-2] |
number of beeps 0: Lo pitch 1: Med pitch 2: Hi pitch |
Good Read Beep Settings when offline. | Wireless readers. |
| BEEP.NO-READ | IO | PUBLIC | 3.0.0 | SET|GET | repetition level |
[0-3] [0-2] |
number of beeps 0: Lo pitch 1: Med pitch 2: Hi pitch |
No-Read Beep Settings. | ALL except for DM50, DM60 and DM70. |
| BEEP.NO-READ-OL | IO | PUBLIC | 3.0.0 | SET|GET | repetition level |
[0-3] [0-2] |
number of beeps 0: Lo pitch 1: Med pitch 2: Hi pitch |
No-Read Beep Settings when offline. | Wireless readers. |
| BUTTON.3SEC-ACTION | IO | PUBLIC | 3.0.0 | SET|GET | mode state |
[0-6] [ON|OFF] |
0: Train 1: Optimize Brighness 2: Set Match String 3: Optimize Focus 4: Read Configuration Code 5: Tune 6: Toggle Test Mode enable/disable |
Three Second Button Action. | Fixed mount readers. Test Mode is only supported on the DM503, DM300 series readers and DM474. |
| BUTTON.ENABLE | IO | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enables or disables the trigger button. | Fixed mount readers. |
| C128.CODESIZE | Symbology | PUBLIC | 3.0.0 | SET|GET | any min max |
[ON|OFF] [1-max] [min-80] |
any length code minimum code length maximum code length |
Code 128 Allowed Size. | ALL |
| C39.ASCII | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Code 39 Full ASCII. | ALL |
| C39.CHKCHAR | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Code 39 Check Character. | ALL |
| C39.CODESIZE | Symbology | PUBLIC | 3.0.0 | SET|GET | any min max |
[ON|OFF] [1-max] [min-80] |
any length code minimum code length maximum code length |
Code 39 Code Size. | ALL |
| C39.XMTCHK | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Code 39 Transmit Check Character. | ALL |
| C93.CODESIZE | Symbology | PUBLIC | 3.0.0 | SET|GET | any min max |
[ON|OFF] [1-max] [min-80] |
any length code minimum code length maximum code length |
Code 93 Code Size. | ALL |
| CAMERA.BURST-LENGTH | Camera | PUBLIC | 3.0.0 | SET|GET | count |
[2-*] | number-images | Burst Length. Number of Acquired Images in Burst Trigger-Mode. Actual maximum can be increased by reducing the camera field of view or reserving fewer images for Process Monitor/Record and Playback. |
Fixed mount readers. |
| CAMERA.ENABLE | Camera | PRIVATE | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enables camera which can be disabled when loading images from the PC. | ALL |
| CAMERA.EXPOSURE | Camera | PUBLIC | 3.0.0 | SET|GET | auto target exposure gain |
[ON|OFF] [0-255] [0-22] [4-60] |
ON: Automatic OFF: Manual target pixel value 0: 1/10000 1: 1/7500 2: 1/5000 3: 1/4000 4: 1/3000 5: 1/2500 6: 1/2000 7: 1/1500 8: 1/1250 9: 1/1000 10: 1/750 11: 1/500 12: 1/300 13: 1/250 14: 1/200 15: 1/150 16: 1/125 17: 1/100 18: 1/75 19: 1/50 20: 1/40 21: 1/30000 22: 1/15000 camera gain |
Camera Parameters. The arguments 'exposure' and 'gain' have no effect if 'auto' is ON and the 'target' has no effect if 'auto' is OFF. | DM700. |
| CAMERA.EXPOSURE | Camera | PRIVATE | 3.0.0 | SET|GET | auto target exposure gain |
[ON|OFF] [0-255] [0-20] [1-19] |
ON: Automatic OFF: Manual target pixel value 0: 1/20000 1: 1/10000 2: 1/7500 3: 1/5000 4: 1/3000 5: 1/2500 6: 1/2000 7: 1/1500 8: 1/1250 9: 1/1000 10: 1/750 11: 1/500 12: 1/300 13: 1/250 14: 1/200 15: 1/150 16: 1/125 17: 1/100 18: 1/75 19: 1/50 20: 1/40 camera gain |
Camera Parameters. The arguments 'exposure' and 'gain' have no effect if 'auto' is ON and the 'target' has no effect if 'auto' is OFF. | DM7500 |
| CAMERA.MAX-EXPOSURE | Camera | PRIVATE | 3.0.0 | SET|GET | exposure |
[0-20] |
0: 1/20000 1: 1/10000 2: 1/7500 3: 1/5000 4: 1/3000 5: 1/2500 6: 1/2000 7: 1/1500 8: 1/1250 9: 1/1000 10: 1/750 11: 1/500 12: 1/300 13: 1/250 14: 1/200 15: 1/150 16: 1/125 17: 1/100 18: 1/75 19: 1/50 20: 1/40 |
Maximum exposure limit for autoregulation. | MX-1000 and DM8000 series readers. |
| CAMERA.ROI | Camera | 3.0.0 | SET|GET | left right top bottom |
|||||
| CODABAR.CHKCHAR | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Codabar Check Character. | ALL |
| CODABAR.CODESIZE | Symbology | PUBLIC | 3.0.0 | SET|GET | any min max |
[ON|OFF] [1-max] [min-80] |
any length code minimum code length maximum code length |
Codabar Code Size. | ALL |
| CODABAR.QZ-SIZE | Symbology | PRIVATE | 3.0.0 | SET|GET | state |
[0|100] | Quiet zone single strictness size. | ALL | |
| CODABAR.XMTCHK | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Codabar Transmit Check Character. | ALL |
| COM.AUTO-DETECT | Communication | PRIVATE | 3.0.0 | SET|GET | state |
[ON|OFF] [ON|OFF] | enable/disable | Enables support for simultaneous connection to USB And RS-232. | |
| COM.BAUD-RATE | Communication | PUBLIC | 3.0.0 | SET|GET | rate |
[1-5] |
1: 115200 2: 57600 3: 38400 4: 19200 5: 9600 |
ALL except for MX-1000. | |
| COM.BAUD-RATE - test data | Communication - sample | 3.0.0 | SET|GET | rate |
[1...5] |
1:115200 2:57600 3:38400 4:19200 5:9600 |
RS232 Communication Speed. Does not affect USB communication speed. |
ALL | |
| COM.BUFFER-DATA | IO | PRIVATE | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | ||
| COM.DATA-BITS | Communication | PUBLIC | 3.0.0 | SET|GET | bits |
[7,8] | ALL except for MX-1000. | ||
| COM.DATA-BITS | IO | PRIVATE | 3.0.0 | SET|GET | bits |
[7|8] | RS232 data bits | ||
| COM.DMCC-RESPONSE | Communication | PUBLIC | 3.0.0 | SET|GET | mode |
[0|1] |
0: Silent (default) 1: Extended |
DMCC response format. | ALL |
| COM.DMCC-RESPONSE | Communication | PRIVATE | 3.0.0 | SET|GET | mode |
[0-2] |
0: Silent (default) 1: Extended 2: Extended mode with ||[xxx::length] CR NL data Responses |
DMCC response format. | ALL |
| COM.MULTI-PORT | Communication | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable daisy chaining of readers so they share one COM port. | Fixed mount readers. |
| COM.PARITY | Communication | PUBLIC | 3.0.0 | SET|GET | parity |
[0-4] |
0: None 1: Even 2: Odd 3: Space 4: Mark |
All except for MX-1000 and MX-1502. | |
| COM.STOP-BITS | Communication | PUBLIC | 3.0.0 | SET|GET | bits |
[1-2] | ALL except for MX-1000. | ||
| COM.USB-COMPATIBILITY-MODE | Communication | PUBLIC | 3.0.0 | SET|GET | legacy |
[ON|OFF] |
ON: use pre-3.5.0 driver OFF: default |
Controls USB driver. Reboot is required. |
DM50, DM70 and DM8000 series readers. |
| COM.WAKEUP | Communication | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Wakeup Message. | ALL |
| COM.XLATEPRNT | Communication | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Translate unprintable characters that are embedded in a symbol. The translated result is output over the connection (for example, COM, USB, Ethernet, USB-KEYBOARD). Note that Data Formatting leading and terminating text are not translated. The characters translated are ASCII values between 0x00 and 0x1F. For example, 0x00 = <NUL>, 0x04 = <EOT>, 0x0a = <LF>, 0x0d = <CR>. | ALL |
| CONFIG.DEFAULT | Action | PUBLIC | 3.0.0 | Resets the device’s configuration settings to factory defaults. Device identification and communications settings are not changed. | ALL | ||||
| CONFIG.DUMP-UIDS | Action | PRIVATE | 3.0.0 | Returns all value tree parameters. | ALL | ||||
| CONFIG.RESTORE | Action | PUBLIC | 3.0.0 | Restores Configuration from Non-Volatile Memory. | ALL | ||||
| CONFIG.SAVE | Action | PUBLIC | 3.0.0 | Saves Configuration to Non-Volatile Memory. | ALL | ||||
| CONFIG.SEND | Action | PUBLIC | 3.0.0 | Send device configuration to communication channel. | ALL | ||||
| CQ | Code Quality | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable Code Quality. Code Quality Measurements require reader calibration and the Verification Feature Key. |
DM8600V |
| CQ.CALIB-DATE | Code Quality | PUBLIC | 3.0.0 | GET | Device Code Quality Calibration Date. | DM8600V | |||
| CQ.ILLUMINATION | Code Quality | PUBLIC | 3.0.0 | SET|GET | illumination-option state |
[0-4] [ON|OFF] |
0: Direct on axis 1: 30-deg All Quadrants 2: 30-deg E-W Quadrants 3: 30-deg N-S Quadrants 4: Custom enable/disable |
Code Quality Illumination Option. | DM8600V |
| CQ.METRICS | Code Quality | PUBLIC | 3.0.0 | SET|GET | metric |
[0-3] |
0: AIM-DPM/ISO/IEC TR 29158 1: ISO/IEC 15415 2: AS9132 Laser-etch 3: AS9132 Dot-peen |
Code Quality Enabled Metrics. | DM8600V |
| CQ.MINPASS | Code Quality | PUBLIC | 3.0.0 | SET|GET | metric min-pass |
[0-1] [0-4] |
0: AIM-DPM/ISO/IEC TR 29158 1: ISO/IEC 15415 0: F 1: D 2: C 3: B 4: A |
Code Quality Minimum Passing Grade. Determines the threshold for "validation failure action" including beep and configured line output. |
DM8600V |
| CQ.PROCESSM | Code Quality | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Code Quality Process Control Metrics. | DM8600V |
| CQ.UNITS | Code Quality | PUBLIC | 3.0.0 | SET|GET | option |
[0-3] |
0: mils 1: mm 2: inches 3: pixels |
Code Quality Units. | DM8600V |
| DATAMATRIX.USAGE | Symbology | PUBLIC | 3.0.0 | SET|GET | Usage Type |
[0-1] |
0: Default 1: High speed ink jet mode |
IDMax Usage Type. | ALL except for DM50, DM60, DM70, DM300, DM503. |
| DECODER.1D-LEARN-ORIENT | Decoder | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Learn Orientation of 1D Symbols. | Fixed mount readers. |
| DECODER.1D-SHORT-QUIET-ZONE | Decoder | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | When ON, the reader is tolerant with non-standard (i.e. short) quiet zones. | ALL |
| DECODER.1D-TARGET | Decoder | PRIVATE | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Target Decoding. | MX-1000 and DM8000 series readers. |
| DECODER.1D-USAGE | Decoder | PRIVATE | 3.0.0 | SET|GET | usage-type |
[0-1] |
0: Standard 0: Extended |
1D Symbology Usage Type. | |
| DECODER.1D-USAGE | Decoder | PUBLIC | 3.0.0 | SET|GET | usage |
[0-1] |
0: Standard 1: Extended |
1D Symbology Usage Type. | Fixed mount readers. |
| DECODER.ROI | Decoder | PUBLIC | 3.0.0 | SET|GET | left (multiple of 8) right (multiple of 8) top (multiple of 4) bottom (multiple of 4) |
[0...] [left+64...] [0...] [top+64...] |
left of the ROI rectangle right of the ROI rectangle top of the ROI rectangle bottom of the ROI rectangle |
Decoder Region of Interest. Image Region examined by decoder for enabled symbols. Pixel coordinates are relative to the upper left corner of the displayed image. Left < Right and Top < Bottom. Values must not be outside the specified CAMERA.FOV settings. |
ALL |
| DECODER.TIMEOUT | Decoder | PUBLIC | 3.0.0 | SET|GET | ms |
[0-10000] | milliseconds | Decoder Timeout. Maximum allowed decode time. |
Fixed mount readers. |
| DEVICE.BOOT-VER | System | PRIVATE | 3.0.0 | ||||||
| DEVICE.DEFAULT | Action | PUBLIC | 3.0.0 | Resets all device settings to factory defaults. This command reboots the device. | ALL | ||||
| DEVICE.FEATURE-KEYS | System | PUBLIC | 3.0.0 | GET | Device Feature Keys. | ALL | |||
| DEVICE.FIRMWARE-VER | System | PUBLIC | 3.0.0 | GET | Device Firmware Version. | ALL | |||
| DEVICE.FLASH | PRIVATE | 3.0.0 | begin numbytes |
||||||
| DEVICE.NAME | System | PUBLIC | 3.0.0 | SET|GET | string |
Device Name. MX + the last six digits of DEVICE.SERIAL-NUMBER | ALL | ||
| DEVICE.SAVE | System | PRIVATE | 3.0.0 | ||||||
| DEVICE.SERIAL-NUMBER | System | PUBLIC | 3.0.0 | GET | Device Serial Number. | ALL | |||
| DEVICE.SHIPPEDAS-VER | System | PRIVATE | 3.0.0 | GET | |||||
| DEVICE.START-VER | System | PRIVATE | 3.0.0 | ||||||
| DEVICE.TYPE | System | PUBLIC | 3.0.0 | GET | Device Type. | ALL | |||
| DMPOP | System | PRIVATE | 3.0.0 | GET | vtree path |
Gets value tree parameter. | |||
| DMPUSH | System | PRIVATE | 3.0.0 | SET | vtree path |
Sets value tree parameter. | |||
| DVALID.DOD-EXEID | Data Validation | PUBLIC | 3.0.0 | SET|GET | string |
expected-EID | DoD Expected Enterprise ID (EID). | ALL | |
| DVALID.DOD-EXPN | Data Validation | PUBLIC | 3.0.0 | SET|GET | string |
expected-PN | DoD Expected Part Number. See the Overview topic for formatting requirements for the string argument. |
ALL | |
| DVALID.DODCNSTRT | Data Validation | PUBLIC | 3.0.0 | SET|GET | construct |
[0-3] |
0: Any 1: Construct #1 2: Construct #2 3: Equivalent |
Data Validation DoD Construct. | ALL |
| DVALID.FAIL-ACTION | Data Validation | PUBLIC | 3.0.0 | SET|GET | action |
[0-3] |
0: Transmit "Validation Failure" 1: Transmit "Validation Failure" + decoded string 2: Transmit annotated decode string 3: Transmit nothing |
Data Validation Failure Action. | ALL |
| DVALID.FAIL-XMT-CRLF | Data Validation | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Data Validation Transimit CRLF on Failure. | ALL |
| DVALID.ISO-CONSTRUCT | Data Validation | PUBLIC | 3.0.0 | SET|GET | construct |
[0-1] |
0: ISO 15434 1: ISO 15434 & ISO 15418 |
ISO Construct. | ALL |
| DVALID.MATCH-STRING | Data Validation | PUBLIC | 3.0.0 | SET|GET | string |
match-string | Data Validation Match-String. See the Overview topic for formatting requirements for the string argument. |
ALL | |
| DVALID.MATCH-STRING-PARAMS | Data Validation | PUBLIC | 3.0.0 | SET|GET | increment start length step no-read validation-fail |
[ON|OFF]
[0-*] [1-*] [-2|-1|0|1|2] [ON|OFF] [ON|OFF] |
enable/disable
start position of numerical match number of digits increment enable/disable update on no-read enable/disable update on validation failure |
Data Validation Match-String Parameters. | ALL |
| DVALID.PATTERN | Data Validation | PUBLIC | 3.0.0 | SET|GET | string |
pattern-string | Data Validation Pattern. Regexp Data Validation. See the Overview topic for formatting requirements for the string argument. |
ALL | |
| DVALID.TYPE | Data Validation | PUBLIC | 3.0.0 | SET|GET | type |
[0-5] |
0: None 1: DoD UID 2: ISO 3: Pattern 4: Match String 5: GS1 |
ALL | |
| EAN-UCC.CC-C | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable or disable Composite Code C. | ALL |
| EAN-UCC.XMTMODE | Symbology | PUBLIC | 3.0.0 | SET|GET | mode |
[0-1] |
0: Standard (linear & 2D) 1: Linear only |
EAN-UCC Transmit mode. | ALL |
| FORMAT.ADVANCED | Data Formatting | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable Data Formatting Advanced Mode. Advanced Mode Formatting Enables: Regexp Pattern Substitution. |
ALL |
| FORMAT.CRLF-END | Data Formatting | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Data Formatting CRLF Terminator. Requires Data Formatting Standard Mode Enabled. |
ALL |
| FORMAT.DELIMITER | Data Formatting | PUBLIC | 3.0.0 | SET|GET | delimiter-option |
[0-5] |
0: none 1: space 2: comma 3: tab 4: label 5: xml |
Data Formatting Delimiter. Sets the delimeter between Data Formatting Tokens. Requires Data Formatting Standard Mode Enabled. |
ALL |
| FORMAT.DISCARD-UNMATCHED | Data Formatting | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Data Formatting Discard Unmatched Data. | ALL |
| FORMAT.REGEXP | Data Formatting | PUBLIC | 3.0.0 | SET|GET | string |
regular expression string | Data Formatting Regular Expression. Requires Data Formatting Advanced Mode Enabled. See the Overview topic for formatting requirements for the string argument. |
ALL | |
| FORMAT.STANDARD | Data Formatting | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable Data Formatting Standard Mode. Standard Mode Formatting Enables: Leading Text, Data, Data Delimeter, Terminating Text, Terminating CRLF. |
ALL |
| FORMAT.TEXT-BEGIN | Data Formatting | PUBLIC | 3.0.0 | SET|GET | string |
leading output text | Data Formatting Leading Text. Requires Data Formatting Standard Mode Enabled. See the Overview topic for formatting requirements for the string argument. |
ALL | |
| FORMAT.TEXT-END | Data Formatting | PUBLIC | 3.0.0 | SET|GET | string |
trailing text | Data Formatting Trailing Text. Requires Data Formatting Standard Mode Enabled. See the Overview topic for formatting requirements for the string argument. |
ALL | |
| FORMAT.TOKEN | Data Formatting | PUBLIC | 3.0.0 | SET|GET | string |
token string | Data Formatting Standard Data. Regardless of the parameters given to GET FORMAT.TOKEN, it will return the current data formatting token string contained in the Standard Formatting window pointed to by the current value of GET FORMAT.PROG-TARG. See Data Formatting Token Table for available elements. See the Overview topic for formatting requirements for the string argument. |
ALL | |
| I2O5.CHKCHAR | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | I2of5 Check Character. | ALL |
| I2O5.CODESIZE | Symbology | PUBLIC | 3.0.0 | SET|GET | any min max |
[ON|OFF] [4-max] [min-80] |
any length code minimum code length maximum code length |
I2of5 Code Size. For the Manatee Works SDK, all of the Code 25 variants use the same minimum length; thus it will accept either C25.CODESIZE or I205.CODESIZE. | ALL |
| I2O5.QZ-SIZE | Symbology | PRIVATE | 3.0.0 | SET|GET | state |
[0|100] | Quiet zone single strictness size. | ALL | |
| I2O5.XMTCHK | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | I2of5 Transmit Check Character. | ALL |
| IMAGE.LOAD | Camera | PRIVATE | 3.0.0 | num-bytes |
Loads image from PC to Reader. | ||||
| IMAGE.SEND-SLOT | Camera | 3.0.0 | |||||||
| IMAGE.SEND-TYPE | Camera | 3.0.0 | |||||||
| INPUT.ACTION1 | IO | PUBLIC | 3.0.0 | SET|GET | mode state |
[0-3] [ON|OFF] |
0: Train Code 1: Optimize Brighness 2: Set Match String 3: Optimize focus (Only for readers with a liquid lens.) enable/disable |
Input Line 1 Action. | Fixed mount readers. |
| INPUT.VIRTUAL | Action | PRIVATE | 3.0.0 | line state |
[0-7] [ON|OFF] |
enable/disable |
Software Virtual Input. Trigger is equivalent to line 0. Note that the input actions "Train Code," "Optimize Brightness," "Set Match String," and "Read Configuration Code" are carried out only after the next trigger. |
Fixed mount devices. | |
| KEY.LANGUAGE | IO | PUBLIC | 3.0.0 | SET|GET | language |
[0-7] |
0: Alt Key Combo 1: DE 2: US 3: JP 4: FR 5: ES 6: NO 7: FI |
ALL except for DM60, DM474, DM503, and DM300 series readers. | |
| KEY.ZERO-PAD | IO | PUBLIC | 3.0.0 | SET|GET | language |
[ON|OFF] | enable/disable | ALL except for DM60, DM474, DM503, and DM300 series readers. | |
| LIGHT.AIMER | Camera | PUBLIC | 3.0.0 | SET|GET | aimer-mode |
[0-1] |
0: Off 1: On |
Aimer Enable. Default is ON. |
ALL except for DM503 and DM8050. |
| LIGHT.AIMER | Camera | PRIVATE | 3.0.0 | SET|GET | aimer-mode |
[0-3] |
0: Off 1: LED 2: Laser 3: Both |
Aimer Enable. | DM700 |
| LIGHT.AIMER | Camera | PRIVATE | 3.0.0 | SET|GET | aimer-mode |
[0-3] |
0: Off 1: On when idle 2: Blink (default) 3: On (default) |
Aimer Enable. | DM7500 |
| LIGHT.EXTERNAL-POLARITY | Camera | PUBLIC | 3.0.0 | SET|GET | polarity |
[0-1] |
0: Active Low 1: Active High |
External illlumination output polarity. | Fixed mount readers except for DM70, DM150, DM260. |
| LIGHT.EXTERNAL-PRECHARGE-TIME | Camera | PREVIEW | 3.0.0 | SET|GET | time |
[1-980] | microseconds | External light precharge time. | Fixed mount readers. |
| MULTICODE.IMAGE-REVERSE | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] |
ON: sort last image first OFF: sort first image first |
Image sorting order preference. | Fixed mount readers. |
| OUTPUT.ACTION | IO | PREVIEW | 3.0.0 | SET|GET | line action |
[0-7] [0-1] |
line number 0: Open 1: Close |
Output Action. Open or Close output line on event. Only supported on line 1. |
Fixed mount readers. |
| OUTPUT.CQ-FAIL | IO | PRIVATE | 3.0.0 | Output Code Quality failed actions. Verifiers only. |
|||||
| OUTPUT.DATAVALID-FAIL | Action | PREVIEW | 3.0.0 | Virtual Data Validation Failure. Device beeps, flashes indicator lights, and sets output lines as if the specified Data Validation failure event occurred. |
ALL | ||||
| OUTPUT.DATAVALID-FAIL | IO | PRIVATE | 3.0.0 | Output Data Validation failed actions. | |||||
| OUTPUT.EVENTS | IO | PREVIEW | 3.0.0 | SET|GET | line read no-read validation-failure trigger-overrun buffer-overflow user event 1 user event 2 |
[0-7] [0-1] [0-1] [0-1] [0-1] [0-1] [0-1] [0-1] |
i/o line number 0: Off 1: On 0: Off 1: On 0: Off 1: On 0: Off 1: On 0: Off 1: On 0: Off 1: On 0: Off 1: On |
Output Events. Configure output line to signal based on event. |
Fixed mount readers. |
| OUTPUT.GOOD | Action | PREVIEW | 3.0.0 | Virtual Good-Read. Device beeps, flashes indicator lights, and sets output lines as if the specified read event occurred. |
ALL | ||||
| OUTPUT.GOOD | IO | PRIVATE | 3.0.0 | Output good read actions. | |||||
| OUTPUT.NOREAD | Action | PREVIEW | 3.0.0 | Virtual No-Read. Device beeps, flashes indicator lights, and sets output lines as if the specified no-read event occurred. |
ALL | ||||
| OUTPUT.NOREAD | IO | PRIVATE | 3.0.0 | Output no read actions. | |||||
| OUTPUT.PULSE-WIDTH | IO | PUBLIC | 3.0.0 | SET|GET | line ms |
[0-7] [0-30000] |
i/o line number milliseconds |
Output Pulse-width. | Fixed mount readers. |
| OUTPUT.RESERVED | IO | PUBLIC | 3.0.0 | SET|GET | line reserved |
[0-7] [ON|OFF] |
i/o line number enable/disable |
Output Reserved for External Illumination. Line will be controlled by acquisition system when enabled. | Fixed mount readers, except DM50, DM60 and DM70. |
| OUTPUT.TRIG-OVERRUN | IO | PRIVATE | 3.0.0 | Output trigger overrun actions. | |||||
| PLANET.XMTCHK | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | PLANET Transmit Check Character. | ALL |
| POSTNET.XMTCHK | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | POSTNET Transmit Check Character. | ALL |
| POWER.SLEEP | System | PRIVATE | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Power Save Mode Enable. | DM7500 |
| POWER.SLEEPTIME | System | PRIVATE | 3.0.0 | SET|GET | secs |
[0, 60, 120... 600] | seconds | Time before entering power-save mode. | DM7500 |
| PRESENT.NEVER2X | System | PRIVATE | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Never Read the Same Code Twice. OBSOLETED in 4.5. Presentation mode only. |
ALL |
| PRESENT.REREAD | System | PRIVATE | 3.0.0 | SET|GET | ms |
[0-10000] | milliseconds | OBSOLETED in 4.5. Presentation Mode Re-read Delay. | ALL |
| PRESENT.RESCAN | System | PRIVATE | 3.0.0 | SET|GET | ms |
[0-10000] | milliseconds | OBSOLETED in 4.5. Presentation Mode Rescan Delay. | ALL |
| PROFINET.ENABLED | Communication | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enabled or disabled PROFINET communications. | Ethernet readers. The DM8000 series wireless readers also support this protocol if the base station is connected through Ethernet. In the case of a Bluetooth connection, the command has to be sent to the base station, not to the reader. |
| QR.MICRO | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Micro QR Code. | ALL except for DM300L, DM503L, and DM503QL. |
| QR.MODEL1 | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | QR model-1. | ALL except for DM300L, DM503L, and DM503QL. |
| QR.MODEL2 | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | QR model-2. | ALL except for DM300L, DM503L, and DM503QL. |
| REBOOT | Action | PUBLIC | 3.0.0 | Reboot the Device. Rebooting the Device restores the Configuration stored in Non-Volatile Memory. Commands will not be processed for several seconds while the device reboots. If communication settings are changed, connection with device may be lost. Note that when connected via USB-COM, the application must release the COM port. |
ALL | ||||
| RESULT | Action | PUBLIC | 3.0.0 | GET | target |
[0-1] |
0: Result string 1: XML formatted |
Optional Send Last Result. By default the result string is in ASCII format, but this can be changed to Base64 with the DATA.RESULT-ENCODING command. | ALL |
| RESULT.NO-READ-STRING | IO | PUBLIC | 3.0.0 | SET|GET | string |
no-read-string | No-Read Output String. | ALL | |
| SDK.VERSION | System | PRIVATE | 3.0.0 | SET|GET | Gets or sets the SDK version. Used by early versions of the DataMan SDK. | ||||
| SETUP.ENABLE | Camera | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Setup Enable. One Setup must always be enabled. Enable the desired Setup, before disabiling another Setup. For DM300 series readers, this command works for the active setup. |
DM50, DM60, DM70, DM150, DM260, DM474, DM503, DM8600, MX-1000 and DM300 series readers. |
| SETUP.NAME | Camera | PUBLIC | 3.0.0 | SET|GET | name |
Setup Name. User defined name. |
DM50, DM60, DM70, DM150, DM260, DM474, DM503, DM8600, MX-1000, and DM300 series readers. | ||
| SETUP.PROG-TARGET | Camera | PUBLIC | 3.0.0 | SET|GET | category |
[0-3] |
0: General Purpose 1: Curved Surface 2: Under Marked 3: Mirrored Surface |
Setup Programming Target. Setup to be modified by subsequent commands. |
DM70, DM150, DM260, DM8600 and MX-1000 |
| SYMBOL.4STATE-AUS | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable 4-State Australia Post Symbology. | ALL except for DM150QL, DM260QL, DM300L, DM503L, and DM503QL. |
| SYMBOL.4STATE-JAP | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable 4-State Japan Post Symbology. | ALL except for DM150QL, DM260QL, DM300L, DM503L, and DM503QL. |
| SYMBOL.4STATE-UPU | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable 4-State UPU Symbology. | ALL except for DM150QL, DM260QL, DM300L, DM503L, and DM503QL. |
| SYMBOL.C128 | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable Code 128 Symbology. | ALL |
| SYMBOL.C39 | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable Code 39 Symbology. | ALL |
| SYMBOL.C93 | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable Code 93 Symbology. | ALL |
| SYMBOL.CODABAR | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable Codabar Symbology. | ALL |
| SYMBOL.DATAMATRIX | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable DataMatrix Symbology. | ALL except for DM150QL, DM260QL, DM300L, DM503L, and DM503QL. |
| SYMBOL.EAN-UCC | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable EAN-UCC Symbology. | ALL |
| SYMBOL.I2O5 | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable Interleaved 2 of 5 Symbology. | ALL |
| SYMBOL.MICROPDF417 | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable Micro-PDF 417 Symbology. | ALL |
| SYMBOL.PDF417 | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable PDF 417 Symbology. | ALL |
| SYMBOL.PHARMACODE | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable Pharmacode symbology. | ALL |
| SYMBOL.PLANET | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable PLANET Symbology. | ALL except for DM150QL, DM260QL, DM300L, DM302L, DM503L, and DM503QL. |
| SYMBOL.POSTNET | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable POSTNET Symbology. | ALL except for DM150QL, DM260QL, DM300L, DM503L, and DM503QL. |
| SYMBOL.QR | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable QR-Code Symbology. Enables QR and Micro QR in Manatee Works SDK. | ALL except for DM150QL, DM260QL, DM300L, DM503L and DM503QL. |
| SYMBOL.RPC | Symbology | PRIVATE | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Reader Programming Code. | DM70, DM150, DM260 |
| SYMBOL.UPC-EAN | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | Enable UPC/EAN Symbology. It will enable UPC-A, UPC-E, EAN-8, and EAN-13 in Manatee Works SDK (just like MX). | ALL |
| TRAIN.BRIGHT | Action | PUBLIC | 3.0.0 | type |
[ON|OFF] |
ON: Start Train Brightness Algorithm OFF: Abort Train Brightness Algorithm |
Generate a fixed value for the exposure setting based on the particular scene, similar to the Optimize Brightness button in the Setup Tool. | Fixed mount devices. | |
| TRAIN.CODE | Action | PUBLIC | 3.0.0 | state |
[ON|OFF] | enable/disable | Train symbology using next sucessful decode. | Fixed mount devices. | |
| TRIGGER | Action | PUBLIC | 3.0.0 | state |
[ON|OFF] |
enable/disable
ON: Scanning process is initiated, displaying the preview if necessary, decoding frames, etc. OFF: Scanning process is terminated, even if a barcode has not been decoded. |
Software Trigger. | ALL | |
| TRIGGER.DELAY | Camera | PRIVATE | 3.0.0 | SET|GET | milliseconds |
[0-10000] | Trigger Delay. Delay camera acquisition by specified number of milliseconds. |
ALL | |
| TRIGGER.TYPE | Camera | PUBLIC | 3.0.0 | SET|GET | type |
[0-5] |
0: Single (external) 1: Presentation (internal) 2: Manual (button) 3: Burst (external) 4: Self (internal) 5: Continuous (external) |
Trigger Type. The camera API should return the current trigger type value. | DM700 and DM8000 series readers support only Presentation and Manual trigger types. MX-1000, MX-1502 and Mobile support only Manual and Continuous trigger types. |
| UPC-EAN.DELZERO | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | UPC/EAN Delete Leading Zero. | ALL |
| UPC-EAN.EAN8SUPL | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | UPC/EAN Allow EAN8 Supplementals. | ALL |
| UPC-EAN.EXPANDED | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | UPC/EAN Expanded. | ALL |
| UPC-EAN.SUPPLEMENT | Symbology | PUBLIC | 3.0.0 | SET|GET | option |
[0-4] |
0: Ignore 1: Required 2: Required 2 digit 3: Required 5 digit 4: Not required |
UPC/EAN Supplementals. The Manatee Works SDK only supports turning UPC/EAN supplement code support on/off, while the DMCC command allows them to be off, required, require a 2 digit, require a 5 digit, or optionally permit them. The Manatee Works SDK will treat options 1-4 the same; to simply enable them. | ALL |
| UPC-EAN.UPCE1 | Symbology | PUBLIC | 3.0.0 | SET|GET | state |
[ON|OFF] | enable/disable | UPC/EAN UPCE1 Enabled. | ALL |
| MC-PROTOCOL.ENABLED | Communication | PRIVATE | SET|GET | state |
[ON|OFF] | enable/disable | Enable or disable MC-Protocol communication. | Ethernet readers. The DM8000 series wireless readers also support this protocol if the base station is connected through Ethernet. In the case of a Bluetooth connection, the command has to be sent to the base station, not to the reader. | |
| MODBUSTCP.ENABLED | Communication | PUBLIC | SET|GET | state |
[ON|OFF] | enable/disable | Enable or disable Modbus/TCP communication. | Ethernet readers. The DM8000 series wireless readers also support this protocol if the base station is connected through Ethernet. In the case of a Bluetooth connection, the command has to be sent to the base station, not to the reader. | |
| MODBUSTCP.HOLDING-ONLY | Communication | PUBLIC | SET|GET | state |
[ON|OFF] | enable/disable | Ethernet readers. DM8000 series wireless readers also support this protocol if the base station is connected through Ethernet. | ||
| SLMP-PROTOCOL.ENABLED | Communication | PUBLIC | SET|GET | state |
[ON|OFF] | enable/disable | Enables or disables SLMP-Protocol communication. | Ethernet readers. DM8000 series wireless readers also support this protocol if the base station is connected through Ethernet. In the case of a Bluetooth connection, the command has to be sent to the base station, not to the reader. |