RFID READER
SOFTWARE
INTERFACE
Control Guide
72E-131718-10EN
Table of Contents
Copyright ......................................................................................................................................... 11
For Australia Only ..................................................................................................................... 11
Terms of Use .................................................................................................................................. 11
Revision History .............................................................................................................................. 12
About This Guide
Introduction 13
Configurations 13
Chapter Descriptions 14
Notational Conventions 15
Related Documents and Software 15
Service Information 16
Getting Started
Introduction ..................................................................................................................................... 17
RFID Control and Data Plane ................................................................................................... 17
Reader (Device) Management Plane ........................................................................................ 17
Audience ......................................................................................................................................... 17
Zebra Extensions ............................................................................................................................ 18
LLRP Custom Extensions Operation
Introduction ..................................................................................................................................... 19
Asynchronous Tag Events in Autonomous Mode Operation .......................................................... 20
Filtering Tags Based on RSSI and Time ......................................................................................... 22
Class 1 Generation 2 (C1G2) Extensions Operation ...................................................................... 22
Reader Management Custom Extensions
Introduction ..................................................................................................................................... 23
RM Extensions by Product .............................................................................................................. 24
ReaderDevice.getCPUUsage ......................................................................................................... 30
ReaderDevice.getRAMUsage ......................................................................................................... 30
ReaderDevice.doFirmwareUpdate .................................................................................................. 31
ReaderDevice.setFirmwareUpdateParams .................................................................................... 31
ReaderDevice.updateCertificate ..................................................................................................... 32
1
Table of Contents
ReaderDevice.setUserLED ............................................................................................................. 33
ReaderDevice.getFlashMemoryUsage ........................................................................................... 33
ReaderDevice.getFirmwareUpdateProgress .................................................................................. 34
ReaderDevice.getUserList .............................................................................................................. 34
ReaderDevice.doAddUser .............................................................................................................. 35
ReaderDevice.doDelUser ............................................................................................................... 36
ReaderDevice.doChangePassword ................................................................................................ 36
ReaderDevice.doChangeUserRole ................................................................................................. 37
ReaderDevice.doLogin ................................................................................................................... 37
ReaderDevice.doLogout ................................................................................................................. 38
ReaderDevice.doChangeDefaultUserPassword ............................................................................. 38
ReaderDevice.getSupportedRegionList .......................................................................................... 39
ReaderDevice.getRegionStandardList ............................................................................................ 39
ReaderDevice.getActiveRegion ...................................................................................................... 40
ReaderDevice.setActiveRegion ...................................................................................................... 41
ReaderDevice.getMaxAntennasSupported ..................................................................................... 41
ReaderDevice.getAlarmNotificationSNMPHost .............................................................................. 42
ReaderDevice.setAlarmNotificationSNMPHost .............................................................................. 42
ReaderDevice.getNetworkInterfaceSettings ................................................................................... 43
ReaderDevice.setNetworkInterfaceSettings ................................................................................... 44
ReaderDevice.setDHCPConfig ....................................................................................................... 45
ReaderDevice.getBTConfig ............................................................................................................ 45
ReaderDevice.setBTConfig ............................................................................................................ 46
ReaderDevice.getWebServerSecuritySetting ................................................................................. 46
ReaderDevice.setWebServerSecuritySetting ................................................................................. 47
ReaderDevice.getShellStatus ......................................................................................................... 47
ReaderDevice.setShellStatus ......................................................................................................... 48
ReaderDevice.getFTPStatus .......................................................................................................... 48
ReaderDevice.setFTPStatus .......................................................................................................... 49
ReaderDevice.getUSBMode ........................................................................................................... 49
ReaderDevice.setUSBMode ........................................................................................................... 50
ReaderDevice.getLLRPConfig ........................................................................................................ 51
ReaderDevice.setLLRPConfig ........................................................................................................ 52
ReaderDevice.isLLRPRunning ....................................................................................................... 52
ReaderDevice.isLLRPConnected ................................................................................................... 53
ReaderDevice.ConnectLLRP .......................................................................................................... 53
ReaderDevice.viewSystemLog ....................................................................................................... 54
ReaderDevice.viewAccessLog ....................................................................................................... 54
ReaderDevice.viewCurrentCertificateDetails .................................................................................. 55
ReaderDevice.setNTPConfig .......................................................................................................... 55
ReaderDevice.getWatchdogStatus ................................................................................................. 56
ReaderDevice.setWatchdogStatus ................................................................................................. 56
ReaderDevice.shutDown ................................................................................................................ 57
ReaderDevice.getExtAntennaMode ................................................................................................ 57
ReaderDevice.setExtAntennaMode ................................................................................................ 58
ReaderDevice.getReaderVersionInfo ............................................................................................. 58
ReaderDevice.getManufacturer ...................................................................................................... 59
ReaderDevice.getModel ................................................................................................................. 59
ReaderDevice.getName .................................................................................................................. 60
ReaderDevice.setName .................................................................................................................. 60
ReaderDevice.getDebounceTime ................................................................................................... 61
2
Table of Contents
ReaderDevice.setDebounceTime ................................................................................................... 61
ReaderDevice.getTimeTicks ........................................................................................................... 62
ReaderDevice.getLocalTime ........................................................................................................... 62
ReaderDevice.setLocalTime ........................................................................................................... 63
ReaderDevice.getAllReadPoints ..................................................................................................... 63
ReaderDevice.saveConfigChanges ................................................................................................ 64
ReaderDevice.discardConfigChanges ............................................................................................ 64
ReaderDevice.hasConfigChanged ................................................................................................. 65
ReaderDevice.getUncommitedConfigChangesDescription ............................................................ 65
ReaderDevice.getTimeZones ......................................................................................................... 66
ReaderDevice.setTimeZone ........................................................................................................... 66
ReaderDevice.getReaderProfileList ................................................................................................ 67
ReaderDevice.setProfileActive ....................................................................................................... 67
ReaderDevice.deleteProfile ............................................................................................................ 68
ReaderDevice.importProfileToReader ............................................................................................ 69
ReaderDevice.exportProfileFromReader ........................................................................................ 70
ReaderDevice.getSerialTimeout ..................................................................................................... 70
ReaderDevice.setSerialTimeout ..................................................................................................... 71
ReaderDevice.getAntennaCheck .................................................................................................... 71
ReaderDevice.setAntennaCheck .................................................................................................... 72
ReaderDevice.getReaderDetails .................................................................................................... 72
ReaderDevice.firmwareRevertBack ................................................................................................ 73
ReaderDevice.addIPSecParams .................................................................................................... 73
ReaderDevice.removeIPSecParams .............................................................................................. 74
ReaderDevice.getGPIPortStatus .................................................................................................... 74
ReaderDevice.setGPOPinStatus .................................................................................................... 75
ReaderDevice.getEnableRevertBackStatus ................................................................................... 75
ReaderDevice.getGPOPortStatus .................................................................................................. 76
ReaderDevice.getIPSecParamsList ................................................................................................ 76
ReaderDevice.getIdleModeTimeout ............................................................................................... 77
ReaderDevice.setIdleModeTimeout ................................................................................................ 77
ReaderDevice.processResponseFile .............................................................................................. 78
ReaderDevice.startOSupdate ......................................................................................................... 78
ReaderDevice.installUserApp ......................................................................................................... 79
ReaderDevice.getMaxUserApps ...................................
ReaderDevice.startUserApp ........................................................................................................... 80
ReaderDevice.autostarUserApp ..................................................................................................... 80
ReaderDevice.uninstalluserapp ...................................................................................................... 81
ReaderDevice.getInstalledApps ...................................................................................................... 81
ReaderDevice.getCurrentRunStatus .............................................................................................. 82
ReaderDevice.generateCustomerSupportDataFile ........................................................................ 82
ReaderDevice.purgeLogs ............................................................................................................... 83
ReaderDevice.getwirelessnwlist ..................................................................................................... 83
ReaderDevice.addwirelessnw ......................................................................................................... 84
ReaderDevice.getwirelessnwproperties .......................................................................................... 84
ReaderDevice.getwirelessconfiguredparams ................................................................................. 85
ReaderDevice.disconnectwirelessnw ............................................................................................. 85
ReaderDevice.getGPIOSettings ..................................................................................................... 86
ReaderDevice.setGPIOSettings ..................................................................................................... 87
ReaderDevice.resetToFactoryDefaults ........................................................................................... 87
ReaderDevice.setSystemLogConfiguration .................................................................................... 88
.................................................................. 79
3
Table of Contents
ReaderDevice.getSystemLogConfiguration .................................................................................... 88
ReaderDevice.getRadioModuleOnTime ......................................................................................... 89
ReaderDevice.setDiagnosticMode .................................................................................................. 89
ReaderDevice.startReaderDiagnostics ........................................................................................... 90
ReaderDevice.getEventAmbientTemperatureHighAlarmCount ...................................................... 90
ReaderDevice.getEventAmbientTemperatureCriticalAlarmCount .................................................. 91
ReaderDevice.getEventPATemperatureHighAlarmCount .............................................................. 91
ReaderDevice.getEventPATemperatureCriticalAlarmCount ........................................................... 92
ReaderDevice.getEventForwardPowerHighAlarmCount ................................................................ 92
ReaderDevice.getEventForwardPowerLowAlarmCount ................................................................. 93
ReaderDevice.getEventReversePowerHighAlarmCount ................................................................ 93
ReaderDevice.getEventEchoThresholdAlarmCount ....................................................................... 94
ReaderDevice.getEventDatabaseWarningCount ............................................................................ 94
ReaderDevice.getEventDatabaseErrorCount ................................................................................. 95
ReaderDevice.getEventGPIOInformationCount ............................................................................. 95
ReaderDevice.getRadioPowerState ............................................................................................... 96
ReaderDevice.getUSBState ........................................................................................................... 96
ReaderDevice.viewMACErrorLog ................................................................................................... 97
ReaderDevice.getPowerNegotiation ............................................................................................... 97
ReaderDevice.setPowerNegotiation ............................................................................................... 98
ReaderDevice.getAllowGuestStatus ............................................................................................... 98
ReaderDevice.setAllowGuestStatus ............................................................................................... 99
ReaderDevice.manageLicense ....................................................................................................... 99
ReaderDevice.getNodeJSPortnum ............................................................................................... 100
ReaderDevice.setNodeJSPortnum ............................................................................................... 100
ReaderDevice.setLEDFirmwareUpdate ........................................................................................ 101
ReaderDevice.getInstalledLicenseList .......................................................................................... 101
ReaderDevice.manageFXEasyConnection .................................................................................. 102
ReaderDevice.getSerialConfig ...................................................................................................... 103
ReaderDevice.setSerialConfig ...................................................................................................... 104
ReaderDevice.getTempSensorData ............................................................................................. 104
AntennaReadPoint.getSupportedAirProtocols .............................................................................. 105
AntennaReadPoint.getCurrentAirProtocol .................................................................................... 105
AntennaReadPoint.setAirProtocol ................................................................................................ 106
AntennaReadPoint.getTransmitPowerLevel ................................................................................. 106
AntennaReadPoint.setTransmitPowerLevel ................................................................................. 107
AntennaReadPoint.getCableLossCompensation .......................................................................... 107
AntennaReadPoint.setCableLossCompensation .......................................................................... 108
AntennaReadPoint.getCRCErrors ................................................................................................ 108
AntennaReadPoint.resetCRCErrors .............................................................................................
AntennaReadPoint.getRFOnTime ................................................................................................ 109
AntennaReadPoint.getGen2OptionalOperCounts ........................................................................ 110
AntennaReadPoint.getNXPCustomOperCounts ........................................................................... 111
AntennaReadPoint.getFujitsuCustomOperCounts ....................................................................... 112
AntennaReadPoint.getImpinjCustomOperCounts ........................................................................ 113
Reader Management Custom Error Codes .................................................................................. 114
109
LLRP Custom Extensions
Introduction ................................................................................................................................... 120
LLRP Custom Messages Per Product .......................................................................................... 120
4
Table of Contents
MOTO_GET_TAG_EVENT_REPORT .................................................................................... 121
MOTO_PURGE_TAGS ........................................................................................................... 121
MOTO_PURGE_TAGS_RESPONSE ..................................................................................... 121
MOTO_TAG_EVENT_NOTIFY ............................................................................................... 122
MOTO_UPDATE_RADIO_FIRMWARE .................................................................................. 122
MOTO_UPDATE_RADIO_FIRMWARE_RESPONSE ............................................................. 122
MOTO_UPDATE_RADIO_CONFIG ........................................................................................ 122
MOTO_UPDATE_RADIO_CONFIG_RESPONSE .................................................................. 123
MOTO_GET_RADIO_UPDATE_STATUS ............................................................................... 123
MOTO_GET_RADIO_UPDATE_STATUS_RESPONSE ......................................................... 123
LLRP Custom Parameters Per Product ........................................................................................ 124
MotoGeneralRequestCapabilities ........................................................................................... 128
MotoGeneralCapabilities ......................................................................................................... 128
MotoAutonomousCapabilities ................................................................................................. 129
MotoTagEventsGenerationCapabilities ................................................................................... 129
MotoLocationCapabilities ........................................................................................................ 130
MotoFilterCapabilities .............................................................................................................. 130
MotoPersistenceCapabilities ................................................................................................... 131
MotoAdvancedCapabilities ...................................................................................................... 132
MotoRadioTransmitDelay ........................................................................................................ 132
MotoGeneralGetParams ......................................................................................................... 133
MotoRadioPowerState ............................................................................................................ 133
MotoRadioUpdateStatusInfo ................................................................................................... 133
MotoRadioDutyCycle .............................................................................................................. 134
MotoRadioDutyCycleTable ..................................................................................................... 134
MotoVersion ............................................................................................................................ 134
MotoVersionList ...................................................................................................................... 134
MotoSledBatteryStatus ........................................................................................................... 135
MotoFilterRule ......................................................................................................................... 135
MotoFilterTimeOfDay .............................................................................................................. 136
MotoFilterTimeRange .............................................................................................................. 136
MotoUTCTimestamp ............................................................................................................... 136
MotoFilterRSSIRange ............................................................................................................. 137
MotoFilterTagList .................................................................................................................... 137
MotoFindItem .................................................................................................................
MotoLocationResult ................................................................................................................ 138
MotoAutonomousState ............................................................................................................ 138
MotoTagEventSelector ............................................................................................................ 139
MotoTagReportMode .............................................................................................................. 140
MovingStationaryTagReport ................................................................................................... 140
MotoFilterList ........................................................................................................................... 141
Notes ................................................................................................................................. 141
MotoPersistenceSaveParams ................................................................................................. 142
MotoDefaultSpec ..................................................................................................................... 142
RO Specs .......................................................................................................................... 144
MotoTagEventList ................................................................................................................... 145
MotoTagEventEntry ................................................................................................................ 145
MotoROReportTrigger ............................................................................................................. 146
MotoC1G2LLRPCapabilities ................................................................................................... 147
MotoC1G2ExtendedPC ........................................................................................................... 147
MotoC1G2Recommission ....................................................................................................... 148
......... 137
5
Table of Contents
MotoC1G2RecommissionOpSpecResult ................................................................................ 149
MotoC1G2BlockPermalock ..................................................................................................... 149
MotoC1G2BlockPermalockOpSpecResult .............................................................................. 150
MotoNXPChangeEAS ............................................................................................................. 150
MotoNXPChangeEASOpSpecResult ...................................................................................... 151
MotoNXPSetQuiet ................................................................................................................... 151
MotoNXPSetQuietOpSpecResult ............................................................................................ 152
MotoNXPResetQuiet ............................................................................................................... 152
MotoNXPResetQuietOpSpecResult ........................................................................................ 153
MotoNXPCalibrate .................................................................................................................. 153
MotoNXPCalibrateOpSpecResult ........................................................................................... 154
MotoNXPEASAlarmSpec ........................................................................................................ 154
MotoNXPEASAlarmNotification .............................................................................................. 155
MotoConnectionFailureReason ............................................................................................... 155
MotoCustomCommandOptions ............................................................................................... 155
MotoFujitsuChangeWordLock ................................................................................................. 156
MotoFujitsuChangeWordLockOpSpecResult .......................................................................... 156
MotoFujitsuChangeBlockLock ................................................................................................. 157
MotoFujitsuChangeBlockLockOpSpecResult ......................................................................... 157
MotoFujitsuReadBlockLock ..................................................................................................... 158
MotoFujitsuReadBlockLockOpSpecResult ............................................................................. 158
MotoFujitsuChangeBlockOrAreaGroupPassword ................................................................... 159
MotoFujitsuChangeBlockOrAreaGroupPasswordOpSpecResult ............................................ 159
MotoFujitsuBurstWrite ............................................................................................................. 160
MotoFujitsuBurstWriteOpSpecResult ...................................................................................... 160
MotoFujitsuBurstErase ............................................................................................................ 161
MotoFujitsuBurstEraseOpSpecResult ..................................................................................... 161
MotoFujitsuAreaReadLock ...................................................................................................... 162
MotoFujitsuAreaReadLockOpSpecResult ............................................................................... 162
MotoFujitsuAreaWriteLock ...................................................................................................... 163
MotoFujitsuAreaWriteLockOpSpecResult ............................................................................... 163
MotoFujitsuAreaWriteLockWOPassword ................................................................................ 164
MotoFujitsuAreaWriteLockWOPasswordOpSpecResult ......................................................... 164
MotoNXPChangeConfig .......................................................................................................... 165
MotoNXPChangeConfigOpSpecResult ................................................................................... 165
MotoImpinjQT .......................................................................................................................... 166
QTData .................................................................................................................................... 166
MotoImpinjQTOpSpecResult .................................................................................................. 167
MotoC1G2Authenticate ........................................................................................................... 167
MotoC1G2AuthenticateOpSpecResult .................................................................................... 168
MotoC1G2ReadBuffer ............................................................................................................. 168
MotoC1G2ReadBufferOpSpecResult ..................................................................................... 169
MotoC1G2Untraceable ........................................................................................................... 169
MotoC1G2UntraceableOpSpecResult .................................................................................... 170
MotoC1G2Crypto .................................................................................................................... 171
MotoC1G2CryptoOpSpecResult ............................................................................................. 172
MotoTagGPS .......................................................................................................................... 172
MotoAntennaConfig ................................................................................................................ 173
MotoAntennaStopCondition .................................................................................................... 173
MotoAntennaPhysicalPortConfig ............................................................................................ 174
MotoTagReportContentSelector ............................................................................................. 174
6
Table of Contents
MotoTagPhase ........................................................................................................................ 175
MotoAntennaQueryConfig ....................................................................................................... 175
NXPBrandIDCheckConfig ....................................................................................................... 175
BrandIDCheckStatus ............................................................................................................... 176
ZebraROTriggerSpec .............................................................................................................. 176
ZebraROSpecStartTrigger ...................................................................................................... 176
ZebraTimelapseStart ............................................................................................................... 177
ZebraDistance ......................................................................................................................... 177
ZebraROSpecStopTrigger ...................................................................................................... 177
ZebraTimelapseStop ............................................................................................................... 177
Binary Packet Format for Custom Parameters ............................................................................. 178
MOTO_GET_TAG_EVENT_REPORT .................................................................................... 178
MOTO_PURGE_TAGS ........................................................................................................... 178
MOTO_PURGE_TAGS_RESPONSE ..................................................................................... 179
MOTO_TAG_EVENT_NOTIFY ............................................................................................... 179
MOTO_UPDATE_RADIO_FIRMWARE .................................................................................. 179
MOTO_UPDATE_RADIO_FIRMWARE_RESPONSE ............................................................. 180
MOTO_UPDATE_RADIO_CONFIG ........................................................................................ 180
MOTO_UPDATE_RADIO_CONFIG_RESPONSE .................................................................. 180
MOTO_GET_RADIO_UPDATE_STATUS ............................................................................... 181
MOTO_GET_RADIO_UPDATE_STATUS_RESPONSE ......................................................... 181
MotoGeneralRequestCapabilities ........................................................................................... 181
MotoGeneralCapabilities ......................................................................................................... 182
MotoAutonomousCapabilities ................................................................................................. 182
MotoTagEventsGenerationCapabilities ................................................................................... 183
MotoLocationCapabilities ........................................................................................................ 183
MotoFilterCapabilities .............................................................................................................. 184
MotoPersistenceCapabilities ................................................................................................... 184
MotoAdvancedCapabilities ...................................................................................................... 185
MotoRadioTransmitDelay ........................................................................................................ 185
MotoGeneralGetParams ......................................................................................................... 186
MotoRadioPowerState ............................................................................................................ 186
MotoRadioUpdateStatusInfo ................................................................................................... 186
MotoRadioDutyCycle .............................................................................................................. 187
MotoRadioDutyCycleTable ..................................................................................................... 187
MotoVersion ............................................................................................................................ 187
MotoVersion List ..................................................................................................................... 188
MotoSledBatteryStatus ........................................................................................................... 188
MotoFilterRule ......................................................................................................................... 188
MotoFilterTimeOfDay .............................................................................................................. 189
MotoFilterTimeRange .............................................................................................................. 189
MotoUTCTimestamp ............................................................................................................... 189
MotoFilterRSSIRange ............................................................................................................. 190
MotoFilterTagList .................................................................................................................... 190
MotoFindItem .......................................................................................................................... 190
MotoLocationResult ................................................................................................................ 191
MotoAutonomousState ............................................................................................................ 191
MotoTagEventSelector ............................................................................................................ 192
MotoTagReportMode .............................................................................................................. 192
MovingStationaryTagReport ................................................................................................... 192
MotoFilterList ........................................................................................................................... 193
7
Table of Contents
MotoPersistenceSaveParams ................................................................................................. 193
MotoDefaultSpec ..................................................................................................................... 194
MotoTagEventList ................................................................................................................... 194
MotoTagEventEntry ................................................................................................................ 195
MotoROReportTrigger ............................................................................................................. 195
MotoC1G2LLRPCapabilities ................................................................................................... 196
MotoC1G2ExtendedPC ........................................................................................................... 196
MotoC1G2Recommission ....................................................................................................... 197
MotoC1G2RecommissionOpSpecResult ................................................................................ 197
MotoC1G2BlockPermalock ..................................................................................................... 198
MotoC1G2BlockPermalockOpSpecResult .............................................................................. 198
MotoNXPChangeEAS ............................................................................................................. 199
MotoNXPChangeEASOpSpecResult ...................................................................................... 199
MotoNXPSetQuiet ................................................................................................................... 199
MotoNXPSetQuietOpSpecResult ............................................................................................ 200
MotoNXPResetQuiet ............................................................................................................... 200
MotoNXPResetQuietOpSpecResult ........................................................................................ 200
MotoNXPCalibrate .................................................................................................................. 201
MotoNXPCalibrateOpSpecResult ........................................................................................... 201
MotoNXPEASAlarmSpec ........................................................................................................ 201
MotoNXPEASAlarmNotification .............................................................................................. 202
MotoConnectionFailureReason ............................................................................................... 202
MotoCustomCommandOptions ............................................................................................... 202
MotoFujitsuChangeWordLock ................................................................................................. 203
MotoFujitsuChangeWordLockOpSpecResult .......................................................................... 203
MotoFujitsuChangeBlockLock ................................................................................................. 204
MotoFujitsuChangeBlockLockOpSpecResult ......................................................................... 204
MotoFujitsuReadBlockLock ..................................................................................................... 204
MotoFujitsuReadBlockLockOpSpecResult ............................................................................. 205
MotoFujitsuChangeBlockOrAreaGroupPassword ................................................................... 205
MotoFujitsuChangeBlockOrAreaGroupPasswordOpSpecResult ............................................ 205
MotoFujitsuBurstWrite ............................................................................................................. 206
MotoFujitsuBurstWriteOpSpecResult ...................................................................................... 206
MotoFujitsuBurstErase ............................................................................................................ 207
MotoFujitsuBurstEraseOpSpecResult ..................................................................................... 207
MotoFujitsuAreaReadLock ...................................................................................................... 208
MotoFujitsuAreaReadLockOpSpecResult ...........................
MotoFujitsuAreaWriteLock ...................................................................................................... 208
MotoFujitsuAreaWriteLockOpSpecResult ............................................................................... 209
MotoFujitsuAreaWriteLockWOPassword ................................................................................ 209
MotoFujitsuAreaWriteLockWOPasswordOpSpecResult ......................................................... 209
MotoNXPChangeConfig .......................................................................................................... 210
MotoNXPChangeConfigOpSpecResult ................................................................................... 210
MotoImpinjQT .......................................................................................................................... 210
QTData .................................................................................................................................... 211
MotoImpinjQTOpSpecResult .................................................................................................. 211
MotoC1G2Authenticate ........................................................................................................... 211
MotoC1G2AuthenticateOpSpecResult .................................................................................... 212
MotoC1G2ReadBuffer ............................................................................................................. 212
MotoC1G2ReadBufferOpSpecResult ..................................................................................... 212
MotoC1G2Untraceable ........................................................................................................... 213
.................................................... 208
8
Table of Contents
MotoC1G2UntraceableOpSpecResult .................................................................................... 213
MotoC1G2Crypto .................................................................................................................... 214
MotoC1G2CryptoOpSpecResult ............................................................................................. 214
MotoTagGPS .......................................................................................................................... 215
MotoAntennaConfig ................................................................................................................ 215
MotoAntennaStopCondition .................................................................................................... 215
MotoAntennaPhysicalPortConfig ............................................................................................ 216
MotoTagReportContentSelector ............................................................................................. 216
MotoTagPhase ........................................................................................................................ 216
MotoAntennaQueryConfig ....................................................................................................... 217
NXPBrandIDCheckConfig ....................................................................................................... 217
BrandIDCheckStatus ............................................................................................................... 217
ZebraROTriggerSpec .............................................................................................................. 218
ZebraROSpecStartTrigger ...................................................................................................... 218
ZebraTimelapseStart ............................................................................................................... 218
ZebraDistance ......................................................................................................................... 219
ZebraROSpecStopTrigger ...................................................................................................... 219
ZebraTimelapseStop ............................................................................................................... 219
SNMP
Introduction ................................................................................................................................... 220
GS1 RM protocol MIB ................................................................................................................... 220
Zebra Custom MIB ........................................................................................................................ 221
SNMP MIB .................................................................................................................................... 222
Global RM MIB ............................................................................................................................. 223
TRAP Services .............................................................................................................................. 227
XML Schema for RM Extensions
Introduction ................................................................................................................................... 228
Index
9
RFID READER SOFTWARE INTERFACE
CONTROL GUIDE
72E-131718-10EN
Revision A
March 2020
Copyright
© 2017 ZIH Corp. and/or its affiliates. All rights reserved. ZEBRA and the stylized Zebra head are trademarks of
ZIH Corp., registered in many jurisdictions worldwide. All other trademarks are the property of their respective
owners.
COPYRIGHTS & TRADEMARKS: For complete copyright and trademark information, go to www.zebra.com/
copyright.
WARRANTY: For complete warranty information, go to www.zebra.com/warranty.
END USER LICENSE AGREEMENT: For complete EULA information, go to www.zebra.com/eula.
For Australia Only
For Australia Only. This warranty is given by Zebra Technologies Asia Pacific Pte. Ltd., 71 Robinson Road, #0502/03, Singapore 068895, Singapore. Our goods come with guarantees that cannot be excluded under the
Australia Consumer Law. You are entitled to a replacement or refund for a major failure and compensation for any
other reasonably foreseeable loss or damage. You are also entitled to have the goods repaired or replaced if the
goods fail to be of acceptable quality and the failure does not amount to a major failure.
Zebra Technologies Corporation Australia’s limited warranty above is in addition to any rights and remedies you
may have under the Australian Consumer Law. If you have any queries, please call Zebra Technologies
Corporation at +65 6858 0722. You may also visit our website: www.zebra.com for the most updated warranty
terms.
Terms of Use
•
Proprietary Statement
This manual contains proprietary information of Zebra Technologies Corporation and its subsidiaries
(“Zebra Technologies”). It is intended solely for the information and use of parties operating and
maintaining the equipment described herein. Such proprietary information may not be used, reproduced,
or disclosed to any other parties for any other purpose without the express, written permission of Zebra
Technologies.
•
Product Improvements
Continuous improvement of products is a policy of Zebra Technologies. All specifications and designs are
subject to change without notice.
•
Liability Disclaimer
Zebra Technologies takes steps to ensure that its published Engineering specifications and manuals are
correct; however, errors do occur. Zebra Technologies reserves the right to correct any such errors and
disclaims liability resulting therefrom.
•
Limitation of Liability
In no event shall Zebra Technologies or anyone else involved in the creation, production, or delivery of the
accompanying product (including hardware and software) be liable for any damages whatsoever
(including, without limitation, consequential damages including loss of business profits, business
interruption, or loss of business information) arising out of the use of, the results of use of, or inability to
use such product, even if Zebra Technologies has been advised of the possibility of such damages. Some
jurisdictions do not allow the exclusion or limitation of incidental or consequential damages, so the above
limitation or exclusion may not apply to you.
11
Revision History
Changes to the original manual are listed below:
Change Date Description
-01 Rev A 11/2009 Initial release
-02 Rev A 07/2010 Added reader management custom extensions, LLRP custom messages, and
-03 Rev A 06/2011 Added Fujitsu commands
-04 Rev A 02/2012 Added: RM and LLRP custom extension tables by product
-05 Rev A 01/2014 Added support for FX7500
-06 Rev A 02/2015 Zebra Re-Branding
-07 Rev A 02/2016 Page 3-22 - updates for SNAP
-08 Rev A 11/2017 Added: FX9600; getPowerNegotiation, setPowerNegotiation,
-09 Rev A 11/2017 Added support for ATR7000
LLRP custom parameters; added SNMP chapter, updated XML schema.
Removed: MOTO_C2_COMMAND, MOTO_C2_COMMAND_RESPONSE.
getAllowGuestStatus, setAllowGuestStatus; error codes 281-293.
-10EN Rev A 03/2020 Updated RM and LLRP custom extension tables by product.
Added RM and LLRP custom extension tables by product, error codes 294-306.
12
ABOUT THIS GUIDE
Introduction
This
Software Interface Control Guide
for evaluating and applying Zebra RFID products in RFID applications, and describes Low Level Reader Protocol
(LLRP) extensions for RFID control, and Reader Management (RM) protocol extensions which use XML over
HTTP methods for reader web page control.
Configurations
This guide applies to the following RFID configurations:
• FX7400-42350A30-US: 4-Port RFID Reader, US
• FX7400-22350A30-US: 2-Port RFID Reader, US
• FX7400-42310A30-WR: 4-Port RFID Reader, Global
• FX7400-22310A30-WR: 2-Port RFID Reader, Global
• FX7500-42320A50-US: 4-Port FCC
provides information for RFID system integrators and software developers
• FX7500-22320A50-US: 2-Port FCC
• FX7500-42325A50-WR: 4-Port Worldwide
• FX7500-22325A50-WR: 2-Port Worldwide
• FX9500-41324D41-US: 4-port configuration, US and Canada
• FX9500-41324D41-WW: 4-port configuration, International
• FX9500-81324D41-US: 8-port configuration, US and Canada
• FX9500-81324D41-WW: 8-port configuration, International
• FX9600-42320A50-US: 4-port RFID Reader, US and Canada
• FX9600-42325A50-WR: 4-port RFID Reader, Worldwide
• FX9600-42320A50-JP: 4-port RFID Reader, Japan
• FX9600-82320A50-US: 8-port RFID Reader, US and Canada
• FX9600-82325A50-WR: 8-port RFID Reader, Worldwide
• FX9600-82320A50-JP: 8-port RFID Reader, Japan
• MC3090Z-LC48HBAQE1: RFID Mobile Computer, US
• MC3090Z-LC48HBAQE2: RFID Mobile Computer, US and Canada
13
About This Guide
• MC319Z-GL4H24E0W: Laser, RFID, Worldwide
• MC319Z-GL4H24E0E: Laser, RFID, EU
• MC319Z-GI4H24E0W: Imager, RFID, Worldwide
• MC319Z-GI4H24E0E: Imager, RFID, EU
• MC9090-GJ0HJEQZ1US: Laser, RFID, US and Canada
• MC9090-GK0HJEQZ1US: 2D imager, RFID, US and Canada
• MC9090-GU0HJEQZ1US: 1D imager, RFID, US and Canada
• MC9090-GJ0HJEQZ4ER: Laser, RFID, EU
• MC9090-GK0HJEQZ4ER: 2D imager, RFID, EU
• MC9090-GU0HJEQZ4ER: 1D, RFID, EU
• MC919Z-GA0SWEQZ1WR: 1D, RFID, Worldwide
• MC919Z-GA0SWEQZ2EU: 1D, RFID, EU
• MC919Z-G30SWEQZ1WR: 2D imager, RFID, Worldwide
• MC919Z-G30SWEQZ2EU: 2D imager, RFID, EU
• MC919Z-G50SWEQZ1WR: 2D DPM Imager, RFID, Worldwide
• MC919Z-G50SWEQZ2EU: 2D DPM Imager, RFID, EU
• MC919Z-GJ0SWEQZ1WR: 1D LRX, RFID, Worldwide
• MC919Z-GJ0SWEQZ2EU: 1D LRX, RFID, EU
• MC919Z-GA0SWEQZ12R: 1D, RFID, Worldwide
• MC919Z-GA0SWEQZ22R: 1D, RFID, EU
• ATR7000-P1100A0-US
Chapter Descriptions
Topics covered in this guide are as follows:
• Getting Started provides an overview of Zebra extensions.
• LLRP Custom Extensions Operation provides general information on the Low Level Reader Protocol
(LLRP) application.
• Reader Management Custom Extensions describes Reader Management (RM) custom extensions.
• LLRP Custom Extensions describes custom messages and parameters and provides the binary packet
format for these.
• SNMP describes reader support for RFC1213 (MIB for Network Management of TCP/IP-based internets:
MIB-II), RM MIB, and a Zebra custom MIB.
•
Appendix , XML Schema for RM Extensions
commands.
provides XML schema as a simple method of exercising RM
14
About This Guide
Notational Conventions
The following conventions are used in this document:
• “RFID Reader” or “reader” refers to the Zebra FX Series RFID reader or RFID enabled MC Series mobile
computers.
• Bullets (•) indicate:
• Action items
• Lists of alternatives
• Lists of required steps that are not necessarily sequential.
• Sequential lists (e.g., those that describe step-by-step procedures) appear as numbered lists.
Related Documents and Software
The following documents provide more information about the RFID readers mentioned in this guide.
•
FX Series RFID Reader Integrator Guide
•
FX7400 Series RFID Reader Regulatory Guide
•
FX7500 RFID Reader Quick Start Guide
•
FX7500 RFID Reader Regulatory Information
•
FX9500 RFID Reader User Guide
•
FX9500 RFID Reader Regulatory Guide
• FX9600 RFID Reader Quick Start Guide
,
•
MC3090Z RFID Mobile Computer Integrator Guide
•
MC3090Z RFID Mobile Computer Quick Start Guide
•
MC3090Z RFID Mobile Computer Regulatory Guide
•
MC3191Z RFID Mobile Computer Integrator Guide
•
MC3191Z Mobile Computer Quick Start Guide
•
MC3191Z Mobile Computer Regulatory Guide
•
MC9090 Mobile Computer Integrator Guide
•
MC9090 Mobile Computer User Guide
•
MC9090 Mobile Computer Quick Start Guide
•
MC9090 Mobile Computer Regulatory Guide
•
MC919Z Mobile Computer User Guide
•
MC919Z Mobile Computer Quick Start Guide
•
MC919Z Mobile Computer Regulatory Guide
•
ATR7000 Advanced Array RFID Reader Integration Guide
•
ATR7000 Advanced Array RFID Reader Quick Reference Guide
For the latest version of all software and guides, go to: www.zebra.com/support.
15
Service Information
If you have a problem with your equipment, contact Zebra support for your region. Contact information is available
at: www.zebra.com/support.
When contacting Zebra support, please have the following information available:
• Serial number of the unit
• Model number or product name
• Software type and version number
Zebra responds to calls by e-mail, telephone or fax within the time limits set forth in service agreements.
If your problem cannot be solved by Zebra support, you may need to return your equipment for servicing and will
be given specific directions. Zebra is not responsible for any damages incurred during shipment if the approved
shipping container is not used. Shipping the units improperly can possibly void the warranty.
If you purchased your business product from a Zebra business partner, please contact that business partner for
support.
About This Guide
16
Getting Started
Introduction
This guide describes LLRP protocol extensions for RFID control, and RM protocol extensions which use XML over
HTTP methods for reader web page control. These extensions, in addition to LLRP and RM standard protocols,
constitute the native and most direct software interfaces to the RFID readers and RFID enabled mobile computers,
and as such are used by the Zebra RFID3 API for C, .NET, and Java.
The RFID Reader software interface consists of the following two components.
RFID Control and Data Plane
The FX Series RFID reader and RFID enabled MC Series mobile computers support EPCGlobal Inc.’s, LLRP (low
level reader) protocol v1.0.1 standard. In addition to standard LLRP support, the readers supports LLRP custom
extensions detailed in this guide.
Reader (Device) Management Plane
The FX Series supports a number of software interfaces such as SNMP, Web Services, and Reader Management
(RM) protocol v1.0.1 by EPCGlobal Inc. For the management interface, this guide includes XML extensions over
HTTP that support a reader web page interface. Since the FX Series supports XML over HTTP message transport
binding as defined in global’s RM protocol, the XML custom extensions can be regarded as RM custom
extensions. The MC Series mobile computers do not support RM protocol.
Audience
The target audience for this guide are RFID system integrators, RFID middleware software developers, and RFID
application software developers who want to control the reader directly while bypassing the RFID3 API interface,
particularly developers familiar with LLRP and RM protocols.
17
Zebra Extensions
The Reader currently supports Gen 2 v 1.2 new features, such as extended protocol control word (XPC), block
permalocking, and re-commissioning using LLRP custom extensions. In the future, new functionality will be added
to a new LLRP standard.
Another important set of LLRP extensions supports asynchronous events which enable efficient tag reporting of
visibility events, typically referred to as XR autonomous mode. Because this method allows for more efficient use
of network resources, and because it was the preferred method for many XR customers, the FX and MC series
supports it over the LLRP interface through a set of LLRP custom extensions.
The RM protocol addresses basic RFID device management functionality. RM custom extensions address the
need to extend the support of management interfaces beyond what is defined in the RM protocol, such as firmware
upgrade and downgrade. The RM specification enables defining new vendor commands in a separate XML
namespace. The RM custom extensions define the command interface (using XML over HTTP) to the reader’s web
management functions, available on the reader’s web page. For example, the reader’s web interface allows
managing user (login) accounts, read point control, and region control.
NOTE: MC Series readers do not support RM.
Getting Started
18
LLRP Custom Extensions Operation
Introduction
The Low Level Reader Protocol (LLRP) application provides necessary features for operating and monitoring the
LLRP server and the lower level reader entities. In order to minimize changes on the LLRP client side, it is strongly
recommended to issue a capability query before using custom extensions as the capability value set can change in
each software release.
19
LLRP Custom Extensions Operation
Asynchronous Tag Events in Autonomous Mode Operation
Traditional LLRP operations use a client controller model where the LLRP client instructs the reader to perform an
operation and the reader reports the results of the operation. Class 1 Gen 2 provisions limit the level of data
filtering that the reader returns so the reader reports all results of the operation to the client. In typical continuous
read modes where tags remain in the field of view for many read cycles, this type of operation can introduce
overhead on the network as the same set of tag information is reported to the client across multiple operation
cycles. Figure 1 illustrates a typical usage model.
Figure 1 Command Driven Reader Operation Model
Readers support an event driven model called autonomous mode with event reporting, via custom extensions to
LLRP. This enables the client to put reader into continuous operation mode and configure it to report only changes
20
LLRP Custom Extensions Operation
in tag visibility states. A pre-configured ROSpec is provided as a custom extension to reader configuration. See
MotoDefaultSpec on page 142. Use GET_READER_CONFIG and SET_READER_CONFIG to respectively retrieve
and manipulate this extension. Use custom extensions to ROReportSpec associated with the ROSpec to control
the format and criteria for reporting tags. After setting a reporting preference, use the
custom parameter in the reader configuration to enable autonomous mode on the reader. Figure 2 provides an
example usage under this model.
Figure 2 Autonomous Event Driven Reader Operation Model
MotoAutonomousState
See LLRP Custom Extensions for information on the message and parameter extensions associated with
autonomous mode of operation.
21
LLRP Custom Extensions Operation
Filtering Tags Based on RSSI and Time
In addition to the Class 1 Gen 2 tag filtering mechanism, the reader can filter tags reported to the client based on
the received signal strength, the time that the reader read the tag, or a combination of both. Use multiple rules to
create a custom filter which can also filter multiple ranges of data. See LLRP Custom Extensions for details on the
message and parameter extensions for custom filtering.
Class 1 Generation 2 (C1G2) Extensions Operation
Extensions support features such as block permalocking, XPC, and re-commissioning. There are two custom
OpSpecs that support block permalock and re-commissioning access commands:
the OpSpec result enable block permalock operations.
re-commissioning operations. When re-commissioning a tag during an inventory operation, the reader sees the
re-commissioning command type previously issued to the tag via the XPC (refer to the Gen 2 v1.2 specification for
details on re-commissioning types). Therefore, the LLRP
information.
All rules and functionality that apply to the OpSpec within an AccessSpec also apply to custom OpSpecs. For
example, use the
filter data.
C1G2TagSpec parameter in conjunction with the OpSpec within an AccessSpec to specify tag
MotoC1G2Recommission and the OpSpec result enable
TagReportData parameter is extended to include XPC
MotoC1G2BlockPermalock and
Before using a custom OpSpec, send the
RequestedData field. Alternatively, to avoid getting the entire capability set, specify the custom capability parameter
subset to get using the
GET_READER_CAPABILITIES message. Use the RequestData field in MotoGeneralRequestCapability to return the
following custom capability sets: All (custom capabilities), general capabilities, autonomous mode capabilities,
filtering capabilities, persistent capabilities, and C1G2 V1.2 capabilities. Querying for C1G2 v1.2 capabilities
returns the reader’s ability to support the custom C1G2 command.
Currently, tags supporting re-commissioning are not available. Therefore, the
the
MotoAirProtocolCapabilities parameter is set to FALSE even though it is implemented. In the near future,
CanSupportRecommissioning will be set to TRUE when this feature is tested with real tags.
Refer to global’s Gen v1.2 specification for operational details of XPC, block permalock, and e-commissioning.
MotoGeneralRequestCapability parameter in the extension point of the
GET_READER_CAPABILITIES message specifying 0 or All in the
CanSupportRecommissioning field in
22
Reader Management Custom Extensions
Introduction
This chapter describes Reader Management (RM) custom extensions.
NOTE: MC Series readers do not support RM.
NOTE: FX Series readers do not support commands under the AntennaReadPoint object.
Reader support for RM over SNMP transport binding is limited to mandatory features defined in GSI RM Spec
1.0.1. Refer to this specification for the MIB definition.
Go to https://www.gs1.org/standards/epc-rfid/reader-management/1-0-1 for more details.
Extensions described in this chapter are available only for RM over HTTP/XML transport binding.
Appendix , XML Schema for RM Extensions
See
chapter.
for XML schema definitions of the extensions defined in this
RM over HTTP/XML transport binding mandates that a valid user is logged in before using RM commands. In
addition, the user can use only one session for the RM over HTTP/XML transport interface.
The RM commands return the following errors when a valid user is not logged in or the current session is not valid:
• sessionTimeout
• notCurrentSession
• notLoggedIn
RM commands involving configuration changes mandate that a user with administrator privileges is logged in
before making these changes, otherwise the following error returns:
• noEdit
During reader software update, all RM commands except getFirmwareUpdateProgress return the following error:
• osUpdateInProgress
When the reader is in diagnostic mode, all RM commands except the viewSystemLog command return the
following error:
• diagnosticsInProgress
23
Reader Management Custom Extensions
RM Extensions by Product
The RM commands supported by the various RFID fixed readers are outlined in Table 1.
Table 1 RM Extensions by Product
RM Command FX7400 FX7500 FX9500 FX9600 ATR7000 Page
ReaderDevice.getCPUUsage YYYYY
ReaderDevice.getRAMUsage YYYYY
ReaderDevice.doFirmwareUpdate YYYYY
ReaderDevice.setFirmwareUpdateParams YYNYY
ReaderDevice.updateCertificate YYNYY
ReaderDevice.setUserLED YYYYN
ReaderDevice.getFlashMemoryUsage YYNYY
ReaderDevice.getFirmwareUpdateProgress YYNYY
ReaderDevice.getUserList YYNYY
ReaderDevice.doAddUser YNNNN
ReaderDevice.doDelUser YNNNN
ReaderDevice.doChangePassword YYYYY
ReaderDevice.doChangeUserRole YNNYN
ReaderDevice.doLogin YYYYY
ReaderDevice.doLogout YYYYY
ReaderDevice.doChangeDefaultUserPassword YNNNN
30
30
31
31
32
33
33
34
34
35
36
36
37
37
38
38
ReaderDevice.getSupportedRegionList YYNYY
ReaderDevice.getRegionStandardList NYNYN
ReaderDevice.getActiveRegion YYYYY
ReaderDevice.setActiveRegion YYNYN
ReaderDevice.getMaxAntennasSupported YYYYY
ReaderDevice.getAlarmNotificationSNMPHost YYNYY
ReaderDevice.setAlarmNotificationSNMPHost YYNYY
ReaderDevice.getNetworkInterfaceSettings YYYYY
ReaderDevice.setNetworkInterfaceSettings YYNYY
ReaderDevice.setDHCPConfig YYNYY
ReaderDevice.getWebServerSecuritySetting NYNYY
ReaderDevice.setBTConfig NYNYN
RM Commands are applicable for fixed readers only.
3 = Supported / X = Not Supported
24
39
39
40
41
41
42
42
43
44
45
45
46
Table 1 RM Extensions by Product
RM Command FX7400 FX7500 FX9500 FX9600 ATR7000 Page
Reader Management Custom Extensions
ReaderDevice.getWebServerSecuritySetting YYNYY
ReaderDevice.setWebServerSecuritySetting YYNYY
ReaderDevice.getShellStatus YYYYY
ReaderDevice.setShellStatus YYNYY
ReaderDevice.getFTPStatus YYYYY
ReaderDevice.setFTPStatus YYNYY
ReaderDevice.getUSBMode YYNYN
ReaderDevice.setUSBMode YYNYN
ReaderDevice.getLLRPConfig YYYYY
ReaderDevice.setLLRPConfig YYYYY
ReaderDevice.isLLRPRunning YYNYY
ReaderDevice.isLLRPConnected YYNYY
ReaderDevice.ConnectLLRP YYYYY
ReaderDevice.viewSystemLog YYNYY
ReaderDevice.viewAccessLog YYNYY
ReaderDevice.viewCurrentCertificateDetails YYNYY
46
47
47
48
48
49
49
50
51
52
52
53
53
54
54
55
ReaderDevice.setNTPConfig YYNYY
ReaderDevice.getWatchdogStatus YYNYY
ReaderDevice.setWatchdogStatus YYNYY
ReaderDevice.shutDown YYYYY
ReaderDevice.getExtAntennaMode YYYYY
ReaderDevice.setExtAntennaMode YYYYY
ReaderDevice.getReaderVersionInfo YYYYY
ReaderDevice.getManufacturer YYYYY
ReaderDevice.getModel YYYYY
ReaderDevice.getName YYYYY
ReaderDevice.setName YYYYY
ReaderDevice.getDebounceTime YYYYY
ReaderDevice.setDebounceTime YYYYY
ReaderDevice.getTimeTicks YYYYY
ReaderDevice.getLocalTime YYYYY
RM Commands are applicable for fixed readers only.
3 = Supported / X = Not Supported
55
56
56
57
57
58
58
59
59
60
60
61
61
62
62
25
Table 1 RM Extensions by Product
RM Command FX7400 FX7500 FX9500 FX9600 ATR7000 Page
Reader Management Custom Extensions
ReaderDevice.setLocalTime YYYYY
ReaderDevice.getAllReadPoints YYYYY
ReaderDevice.saveConfigChanges YYYYY
ReaderDevice.discardConfigChanges YYNYY
ReaderDevice.hasConfigChanged YYNYY
ReaderDevice.getUncommitedConfigChangesDe
scription
ReaderDevice.getTimeZones YYYYY
ReaderDevice.setTimeZone YYYYY
ReaderDevice.getReaderProfileList YYYYY
ReaderDevice.setProfileActive YYYYY
ReaderDevice.deleteProfile YYYYY
ReaderDevice.importProfileToReader YYNYY
ReaderDevice.exportProfileFromReader YYNYY
ReaderDevice.getSerialTimeout YNNNN
ReaderDevice.setSerialTimeout YNNNN
YYNYY
63
63
64
64
65
65
66
66
67
67
68
69
70
70
71
ReaderDevice.getAntennaCheck YYNYY
ReaderDevice.setAntennaCheck YYNYY
ReaderDevice.getReaderDetails YYYYY
ReaderDevice.firmwareRevertBack NYNYY
ReaderDevice.addIPSecParams NYNYY
ReaderDevice.removeIPSecParams NYNYY
ReaderDevice.getGPIPortStatus NYNYY
ReaderDevice.setGPOPinStatus NYNYY
ReaderDevice.getEnableRevertBackStatus NYNYY
ReaderDevice.getGPOPortStatus NYNYY
ReaderDevice.getIPSecParamsList NYNYY
ReaderDevice.getIdleModeTimeout NYNYY
ReaderDevice.setIdleModeTimeout NYNYY
ReaderDevice.processResponseFile YYNYY
ReaderDevice.startOSupdate NYNYN
ReaderDevice.getMaxUserApps NYNYY
71
72
72
73
73
74
74
75
75
76
76
77
77
78
78
79
RM Commands are applicable for fixed readers only.
3 = Supported / X = Not Supported
26
Table 1 RM Extensions by Product
RM Command FX7400 FX7500 FX9500 FX9600 ATR7000 Page
Reader Management Custom Extensions
ReaderDevice.installUserApp NYNYY
ReaderDevice.startUserApp NYNYY
ReaderDevice.autostarUserApp NYNYY
ReaderDevice.uninstalluserapp NYNYY
ReaderDevice.getInstalledApps NYNYY
ReaderDevice.getCurrentRunStatus NYNYY
ReaderDevice.generateCustomerSupportDataFile NYNYY
ReaderDevice.purgeLogs NYNYY
ReaderDevice.getwirelessnwlist NYNYY
ReaderDevice.addwirelessnw NYNYY
ReaderDevice.getwirelessnwproperties NYNYY
ReaderDevice.getwirelessconfiguredparams NYNYY
ReaderDevice.getGPIOSettings NYNYY
ReaderDevice.setGPIOSettings NYNYY
ReaderDevice.resetToFactoryDefaults NYNYY
ReaderDevice.getSystemLogConfiguration NYNYY
79
80
80
81
81
82
82
83
83
84
84
85
86
87
87
88
ReaderDevice.setSystemLogConfiguration NYNYY
ReaderDevice.getRadioModuleOnTime NYNYY
ReaderDevice.setDiagnosticMode NYNYY
ReaderDevice.startReaderDiagnostics NYNYY
ReaderDevice.getEventAmbientTemperatureHigh
AlarmCount
ReaderDevice.getEventAmbientTemperatureCriti
calAlarmCount
ReaderDevice.getEventPATemperatureHighAlar
mCount
ReaderDevice.getEventPATemperatureCriticalAla
rmCount
ReaderDevice.getEventForwardPowerHighAlarm
Count
ReaderDevice.getEventForwardPowerLowAlarm
Count
ReaderDevice.getEventReversePowerHighAlarm
Count
RM Commands are applicable for fixed readers only.
3 = Supported / X = Not Supported
NYNYY
NYNYY
NYNYY
NYNYY
NYNYY
NYNYY
NYNYY
88
89
89
90
90
91
91
92
92
93
93
27
Table 1 RM Extensions by Product
RM Command FX7400 FX7500 FX9500 FX9600 ATR7000 Page
Reader Management Custom Extensions
ReaderDevice.getEventEchoThresholdAlarmCou
nt
ReaderDevice.getEventDatabaseWarningCount NYNYY
ReaderDevice.getEventDatabaseErrorCount NYNYY
ReaderDevice.getEventGPIOInformationCount NYNYY
ReaderDevice.getRadioPowerState NYNYY
ReaderDevice.getUSBState NYNYY
ReaderDevice.viewMACErrorLog YNNNN
ReaderDevice.getPowerNegotiation NYNYY
ReaderDevice.setPowerNegotiation NYNYY
ReaderDevice.getAllowGuestStatus NYNYY
ReaderDevice.setAllowGuestStatus NYNYY
ReaderDevice.manageLicense NYNYN
ReaderDevice.getNodeJSPortnum NYNYN
ReaderDevice.setNodeJSPortnum NYNYN
ReaderDevice.setLEDFirmwareUpdate NYNYN
NYNYY
94
94
95
95
96
96
97
97
98
98
99
99
100
100
101
ReaderDevice.getInstalledLicenseList NYNYN
ReaderDevice.manageFXEasyConnection NYNYN
ReaderDevice.getSerialConfig NYNYN
ReaderDevice.setSerialConfig NYNYN
ReaderDevice.getTempSensorData NYNYN
AntennaReadPoint.getSupportedAirProtocols YYNYY
AntennaReadPoint.getCurrentAirProtocol YYNYY
AntennaReadPoint.setAirProtocol YYNYY
AntennaReadPoint.getTransmitPowerLevel YYNYY
AntennaReadPoint.setTransmitPowerLevel YYNYY
AntennaReadPoint.getCableLossCompensation NYNYN
AntennaReadPoint.setCableLossCompensation NYNYN
AntennaReadPoint.getCRCErrors YYNYY
AntennaReadPoint.resetCRCErrors YYNYY
AntennaReadPoint.getRFOnTime YYNYY
AntennaReadPoint.getGen2OptionalOperCounts YYNYY
101
102
103
104
104
105
105
106
106
107
107
108
108
109
109
110
RM Commands are applicable for fixed readers only.
3 = Supported / X = Not Supported
28
Table 1 RM Extensions by Product
RM Command FX7400 FX7500 FX9500 FX9600 ATR7000 Page
Reader Management Custom Extensions
AntennaReadPoint.getNXPCustomOperCounts YYNYY
AntennaReadPoint.getFujitsuCustomOperCounts YNNNN
AntennaReadPoint.getImpinjCustomOperCounts YYNYY
RM Commands are applicable for fixed readers only.
3 = Supported / X = Not Supported
111
112
113
29
Reader Management Custom Extensions
ReaderDevice.getCPUUsage
Get CPU usage information.
Usage
ReaderDevice.getCPUUsage( void ): user: int, system: int
Parameter(s)
• Data Type: void. This command takes no parameters.
Return Value(s)
• user - Data type: integer. Percent of CPU utilization for user processes.
• system - Data type: integer. Percent of CPU utilization for system processes.
Possible Error Conditions
N/A
ReaderDevice.getRAMUsage
Get RAM usage information.
Usage
ReaderDevice.getRAMUsage( void ): total: unsignedInt, used: unsignedInt, free: unsignedInt
Parameter(s)
• Data Type: void. This command takes no parameters.
Return Value(s)
• total - Data type: unsignedInt. Total RAM.
• used - Data type: unsignedInt. RAM used.
• free - Data type: unsignedInt. RAM available for use.
Possible Error Conditions
• operationFailed
30
Reader Management Custom Extensions
ReaderDevice.doFirmwareUpdate
Initiate firmware update.
Usage
ReaderDevice.doFirmwareUpdate( void ): void
Parameter(s)
• Data Type: void. This command takes no parameters.
Return Value(s)
• Data Type: void. This command does not return a value.
Possible Error Conditions
• nosuchFileOrPath
• operationFailed
ReaderDevice.setFirmwareUpdateParams
Set firmware image location parameters.
Usage
ReaderDevice.setFirmwareUpdateParams( imageLocationURL: string, userName: string, password: string,
updateAllPartitions: boolean ): void
Parameter(s)
• imageLocationURL - Data type: string. FTP or secure FTP server location of image files.
• userName - Data type: string. User login name for FTP or secure FTP server.
• password - Data type: string. Password for user login.
• updateAllPartitions - Data type: boolean. Flag indicating if all partitions must be updated.
Return Value(s)
• Data Type: void. This command does not return a value.
Possible Error Conditions
• malformedFTPURL
• invalidUser
31
Reader Management Custom Extensions
ReaderDevice.updateCertificate
In secure mode, update the security certificate on the reader using secure FTP.
Usage
ReaderDevice.updateCertificate( ftpsUrl: string, ftpsUserName: string, ftpsPassword: string, pfxPassword:
string, restartConfirm: boolean ): void
Parameter(s)
• ftpsUrl - Data type: string. URL of the secure FTP server.
• ftpsUserName - Data type: string. User name for the secure FTP server.
• ftpsPassword - Data type: string. Password for the secure FTP server.
• pfxPassword - Data type: string. Public key for the certificate.
• restartConfirm - Data type: boolean. Specifies whether to restart the FTPS and SSH services.
Return Value(s)
• Data Type: void. This command does not return a value.
Possible Error Conditions
• noRestartPermission
• noMaint
• notInSecureMode
• malformedFTPSURL
• malformedFTPURL
• invalidIpAddr
• invalidUser
• nosuchFileOrPath
• operationFailed
• wrongPFXPassword
• couldNotUninstallCert
• wrongPFXPassword
• noPrivateKeyFound
• failedCertImport
• errorReadingPassFile
• invalidDataInPfx
• couldNotInstallCertificate
32
Reader Management Custom Extensions
ReaderDevice.setUserLED
Set the user LED.
Usage
ReaderDevice.setUserLED( ledColor: string, duration: int, blink: boolean ): void
Parameter(s)
• ledColor - Data type: string. Color for the user LED.
• duration - Data type: integer. Duration in which the LED is turned on.
• blink - Data type: boolean. Flag indicating blink status.
Return Value(s)
• Data Type: void. This command does not return a value.
Possible Error Conditions
N/A
ReaderDevice.getFlashMemoryUsage
Get the flash memory usage information.
Usage
ReaderDevice.getFlashMemoryUsage( void ): list of <value: motorm:FlashPartitionParamType>
Parameter(s)
• Data Type: void. This command takes no parameters.
Return Value(s)
• value - Data Type: motorm:FlashPartitionParamType. Flash partition usage information.
Possible Error Conditions
• operationFailed
33
Reader Management Custom Extensions
ReaderDevice.getFirmwareUpdateProgress
Get the progress status on the firmware update.
Usage
ReaderDevice.getFirmwareUpdateProgress( void ): progressValue: motorm:firmwareUpdtProgress
Parameter(s)
• Data Type: void. This command takes no parameters.
Return Value(s)
• progressValue - Data Type: motorm:firmwareUpdtProgress. Progress value.
Possible Error Conditions
• FirmwareUpdateNotStarted
• startingFirmwareUpdate
• failedToGetUpdateProgress
ReaderDevice.getUserList
Get the list of the configured user along with the permission.
Usage
ReaderDevice.getUserList( void ): list of <value: motorm:UserInfoValueParamType>
Parameter(s)
• Data Type: void. This command takes no parameters.
Return Value(s)
• value - Data Type: motorm:UserInfoValueParamType. List of user with current permission level.
Possible Error Conditions
• dbOpenFailed
34
Reader Management Custom Extensions
ReaderDevice.doAddUser
Add the user along with the password and permission specified.
Usage
ReaderDevice.doAddUser( userName: string, password: string, isAdmin: boolean ): void
Parameter(s)
• userName - Data type: string. Name of the user to add.
• password - Data type: string. Password for user login.
• isAdmin - Data type: boolean. Indicates whether the user is an administrator.
Return Value(s)
• Data Type: void. This command does not return a value.
Possible Error Conditions
• invalidName
• invalidPassword
• invalidAccess
• addAdminUser
• dbOpenFailed
• duplicatedUserName
• dbPutFailed
35
Reader Management Custom Extensions
ReaderDevice.doDelUser
Delete the user specified by userName.
Usage
ReaderDevice.doDelUser( userName: string ): void
Parameter(s)
• userName - Data type: string. Name of the user to delete.
Return Value(s)
• Data Type: void. This command does not return a value.
Possible Error Conditions
• invalidSelection
• dbOpenFailed
ReaderDevice.doChangePassword
Change the password for the user specified by userName.
Usage
ReaderDevice.doChangePassword( userName: string, oldPassword: string, newPassword: string ): void
Parameter(s)
• userName - Data type:string. Name of the user whose password is to change.
• oldPassword - Data type: string. Existing password of the user.
• newPassword - Data type: string. New password specified for the user.
Return Value(s)
• Data Type: void. This command does not return a value.
Possible Error Conditions
• invalidSelection
• invalidPassword
• newPswdSameAsOld
• dbOpenFailed
• invalidName
• wrongOldPswd
• notFindUser
36
Reader Management Custom Extensions
ReaderDevice.doChangeUserRole
Change the user role for the user specified by userName.
Usage
ReaderDevice.doChangeUserRole( userName: string, isAdmin: boolean ): void
Parameter(s)
• userName - Data type: string. Name of the user whose role is to change.
• isAdmin - Data type: boolean. Indicates whether the user is an administrator.
Return Value(s)
• Data Type: void. This command does not return a value.
Possible Error Conditions
• invalidSelection
• dbOpenFailed
• operationFailed
ReaderDevice.doLogin
Log in to the management console.
Usage
ReaderDevice.doLogin( username: string, password: string ): sessionID: string
Parameter(s)
• username - Data type: string. User name.
• password - Data type: string. Password for the user.
Return Value(s)
• sessionID - Data type: string. Session ID used for this login session.
Possible Error Conditions
• invalidUser
• userLoggedIn
• AdminLoggedIn
• notCurrentSession
37
Reader Management Custom Extensions
ReaderDevice.doLogout
Logout current session from issuing host over HTTP interface.
Usage
ReaderDevice.doLogout( forceLogout: boolean ): void
Parameter(s)
• forceLogout - Data type: boolean. Force logout even if there are configuration changes.
Return Value(s)
• Data Type: void. This command does not return a value.
Possible Error Conditions
• pendingChanges
ReaderDevice.doChangeDefaultUserPassword
Change the default user name and password on the first login.
Usage
ReaderDevice.doChangeDefaultUserPassword( defaultUsername: string, defaultPassword: string,
newUsername: string, newPassword: string ): void
Parameter(s)
• defaultUsername - Data type: string. Default user name.
• defaultPassword - Data type: string. Default password for the user.
• newUsername - Data type: string. New user name.
• newPassword - Data type: string. New password for the user.
Return Value(s)
• Data Type: void. This command does not return a value.
Possible Error Conditions
• invalidUser
• addAdminUser
• dbOpenFailed
• defaultUserNotPresent
• invalidName
• invalidPassword
• duplicatedUserName
• dbPutFailed
38
Reader Management Custom Extensions
ReaderDevice.getSupportedRegionList
Get the supported region list on the reader.
Usage
ReaderDevice.getSupportedRegionList( void ): list of <value: string>
Parameter(s)
• Data Type: void. This command takes no parameters.
Return Value(s)
• value - Data type: string. List of regions supported.
Possible Error Conditions
N/A
ReaderDevice.getRegionStandardList
Get the supported communication standard list along with details for the chosen region.
Usage
ReaderDevice.getRegionStandardList( regionName: string ):
list of <value: motorm:RegionInfoValueParamType>
Parameter(s)
• regionName - Data type: string. Name of the chosen region.
• requestChannelList - Data Type: Boolean. Request to include the channel list as part of the response.
Return Value(s)
• value - Data type: motorm:RegionInfoValueParamType. List of supported standards for the region with
supported settings for each region.
Possible Error Conditions
• unsupportedRegion
39
Reader Management Custom Extensions
ReaderDevice.getActiveRegion
Get details of the active region.
Usage
ReaderDevice.getActiveRegion( void ): regionName: string, standardName: string, list of <channelUsed: int>,
isLBTOn: boolean, isHoppingOn: boolean
Parameter(s)
• Data Type: void. This command takes no parameters.
Return Value(s)
• regionName - Data type: string. Name of the active country.
• standardName - Data type: string. Name of the active region.
• channelUsed - Data type: integer. One instance of the channel used in the region.
• isLBTOn - Data type: boolean. Indicates if LBT is on for the active region.
• isHoppingOn - Data type: boolean. Indicates if frequency hopping is on for the active region.
Possible Error Conditions
N/A
40
Reader Management Custom Extensions
ReaderDevice.setActiveRegion
Set the active region.
Usage
ReaderDevice.setActiveRegion( regionName: string, standardName: string, list of<channelUsed:int>,
doLBT: boolean, doHopping: boolean ): void
Parameter(s)
• regionName - Data type: string. Name of the active region.
• standardName - Data type: string. Name of the active communication standard.
• channelUsed - Data type: integer. One instance of channel used in the region.
• doLBT - Data type: boolean. Indicates whether to use LBT for this region.
• doHopping - Data type: boolean. Indicates whether to use frequency hopping for this region.
Return Value(s)
• Data Type: void. This command does not return a value.
Possible Error Conditions
• radioNotInitialised
• unsupportedStandard
• unsupportedRegion
• invalidValue
ReaderDevice.getMaxAntennasSupported
Get the maximum number of antennas supported by the reader.
Usage
ReaderDevice.getMaxAntennasSupported( void ): maxAntennasSupported: int
Parameter(s)
• Data Type: void. This command takes no parameters.
Return Value(s)
maxAntennasSupported - Data type: integer. Maximum number of antennas the reader supports.
Possible Error Conditions
N/A
41
Reader Management Custom Extensions
ReaderDevice.getAlarmNotificationSNMPHost
Get host information for the currently registered SNMP-based alarm notification receiver.
Usage
ReaderDevice.getAlarmNotificationSNMPHost( void ): hostIP: string, version: string, community: string,
sendServerHeartBeat: boolean
Parameter(s)
• Data Type: void. This command takes no parameters.
Return Value(s)
• hostIP - Data type: string. IP address of listener.
• version - Data type: string. SNMP version.
• community - Data type: string. SNMP community string.
• sendServerHeartBeat - Data type: boolean. Send the server heartbeat.
Possible Error Conditions
N/A
ReaderDevice.setAlarmNotificationSNMPHost
Method to set SNMP trap listener host to which reader alarms must be issued.
Usage
ReaderDevice.setAlarmNotificationSNMPHost( hostIP: string, version: string, community: string,
sendServerHeartBeat: boolean ): void
Parameter(s)
• hostIP - Data type: string. IP address of the SNMP trap listener.
• version - Data type: string. SNMP protocol version number the host supports.
• community - Data type: string. SNMP community string.
• sendServerHeartBeat - Data type: boolean. Send the server heartbeat.
Return Value(s)
• Data Type: void. This command does not return a value.
Possible Error Conditions
• invalidIpAddr
• valueOverSize
• invalidSnmpVersion
42
Reader Management Custom Extensions
ReaderDevice.getNetworkInterfaceSettings
Retrieve network interface settings on the reader.
Usage
ReaderDevice.getNetworkInterfaceSettings( Interface: motorm:InterfaceType, isCoreConfig: boolean ):
isDHCPEnabled: boolean, IPAddress: string, MACAddress: string, SubnetMask: string, Gateway: string,
DNSServer: string, isCoreConfig: boolean, IPVersion: string, isDHCPv6Enabled: boolean, IPV6Address:
string, IPV6Suffix: string, IPV6DNS: string, IPV6GateWay: string, EnableRAPAckets: boolean
Parameter(s)
• Interface - Data type:motorm:InterfaceType. Network interface to be queried for settings. Possible values are ETH,
WIFI, or BT.
• isCoreConfig - Data type: boolean. Is the core config asked for.
Return Value(s)
• isDHCPEnabled - Data type: boolean. Indicates whether DHCP is enabled on the reader.
• IPAddress - Data type: string. IP address of the reader.
• MACAddress - Data type: string. MAC address of the reader.
• SubnetMask - Data type: string. Subnetmask of the reader.
• Gateway - Data type: string. Gateway of the reader.
• DNSServer - Data type: string. DNS server of the reader.
• isCoreConfig - Data type: boolean. Indicates whether the core configuration is requested.
• IPVersion - Data type: string. Indicates IP version enabled - IPV4/IPV6/Both.
• isDHCPv6Enabled - Data type: boolean. Is DHCPv6 enabled on the reader.
• IPV6Address - Data type: string. IPV6 IP address.
• IPV6Suffix - Data type: string. IPV6 suffix or netmask.
• IPV6DNS - Data type: string. IPV6 DNS server.
• IPV6GateWay - Data type: string. IPV6 gateway.
• EnableRAPAckets - Data type: boolean. Enable the acceptance of RA packets.
Possible Error Conditions
• operationFailed
43
Reader Management Custom Extensions
ReaderDevice.setNetworkInterfaceSettings
Set the network interface parameters on the reader.
Usage
ReaderDevice.setNetworkInterfaceSettings( Interface: motorm:InterfaceType, IPAddress: string, SubnetMask:
string, Gateway: string, DNSServer: string, IPV6Address: string, IPV6Suffix: string, IPV6GateWay: string,
IPV6DNS: string, IPVersion: string, EnableRAPackets: boolean ): void
Parameter(s)
• Interface - Data type: motorm:InterfaceType. Network interface to which the settings apply. Possible values are ETH,
WIFI, or BT.
• IPAddress - Data type: string. IP address of the reader.
• SubnetMask - Data type: string. Subnetmask of the reader.
• Gateway - Data type: string. Gateway of the reader.
• DNSServer - Data type: string. DNS server of the reader.
• IPV6Address - Data type: string. IPV6 address of the reader.
• IPV6Suffix - Data type: string. IPV6 network suffix.
• IPV6GateWay - Data type: string. IPV6 gateway of the reader.
• IPV6DNS - Data type: string. IPV6 DNS server of the reader.
• IPVersion - Data type: string. Indicates IP version enabled - IPV4/IPV6/Both.
• EnableRAPackets - Data type: boolean. Enable the acceptance of RA packets.
Return Value(s)
• Data Type: void. This command does not return a value.
Possible Error Conditions
• invalidIpAddr
• invalidNetworkMask
Notes
• InterfaceType currently supports only ETH.
• IPV4 elements are mandatory.
• IPV6 elements are optional.
44
Reader Management Custom Extensions
ReaderDevice.setDHCPConfig
Modify (enable or disable) the DHCP configuration on the reader.
Usage
ReaderDevice.setDHCPConfig( Interface: motorm:InterfaceType, enableDHCP: boolean, enableDHCPv6:
boolean ): void
Parameter(s)
• Interface - Data type: motorm:InterfaceType. Network interface to which the DHCP setting apply. Possible values are
ETH, WIFI, or BT.
• enableDHCP - Data type: Boolean. Indicates whether to enable or disable DHCP.
• enableDHCPV6 - Data type: Boolean. Indicates whether to enable or disable DHCPv6.
Return Value(s)
• Data Type: void. This command does not return a value.
Possible Error Conditions
N/A
Notes
• InterfaceType supports Ethernet, Wi-Fi, and Bluetooth.
ReaderDevice.getBTConfig
Get Bluetooth specific parameters from the reader.
Usage
ReaderDevice. getBTConfig ( void ) : isDiscoverable: Boolean, isPairable: Boolean, isPasskeyenabled:
Boolean, startIP: string, endIP: string
Parameter(s)
• isCoreConfig - Data type: boolean. Is the core configuration requested.
Return Value(s)
• isDiscoverable - Data type: boolean. Flag indicating if the Bluetooth is discoverable.
• isPairable - Data type: boolean. Is Bluetooth pairable.
• isPasskeyenabled - Data type: boolean. Is passkey required for pairing with the reader.
• startIP - Data type: string. Start of the IP address range assigned for BT client devices.
• endIP - Data type: string. End of the IP address range assigned for BT client devices.
Possible Error Conditions
N/A
45
Reader Management Custom Extensions
ReaderDevice.setBTConfig
Modify Bluetooth specific parameters on the reader.
Usage
ReaderDevice. setBTConfig (Discoverable: Boolean, Pairable: Boolean, enablePasswordPairing:
string, setPassword: string, startIP: string, endIP: string): void
Parameter(s)
• Discoverable - Data type: boolean. Enable Bluetooth discoverable mode.
• Pairable - Data type: boolean. Enable pairing of Bluetooth devices.
• enablePasswordPairing - Data type: boolean. Enable password based authentication while pairing.
• setPassword - Data type: string. Set the password used for pairing.
• startIP - Data type: string. Set the start of the IP address range for Bluetooth client devices.
• endIP - Data type: string. Set the end of the IP address range for Bluetooth client devices.
Return Value(s)
• Data Type: void. This command does not return a value.
Possible Error Conditions
• invalidIpAddr
ReaderDevice.getWebServerSecuritySetting
Retrieve if the web server is configured as secure on the reader.
Usage
ReaderDevice.getWebServerSecuritySetting( isCoreConfig: boolean ): IsSecure: boolean,
isCoreConfig: boolean
Parameter(s)
• isCoreConfig - Data type: boolean. Indicates whether the core configuration is requested.
Return Value(s)
• IsSecure - Data type: boolean. Flag indicating if the web server is secure.
• isCoreConfig - Data type: boolean. Indicates whether the core configuration is requested.
Possible Error Conditions
N/A
46
Reader Management Custom Extensions
ReaderDevice.setWebServerSecuritySetting
Set the web server to be secure or nonsecure on the reader.
Usage
ReaderDevice.setWebServerSecuritySetting( IsSecure: boolean ): void
Parameter(s)
• IsSecure - Data type: boolean. Flag indicating if the web server is secure.
Return Value(s)
• Data Type: void. This command does not return a value.
Possible Error Conditions
N/A
ReaderDevice.getShellStatus
Get the shell status.
Usage
ReaderDevice.getShellStatus( void ): shellState: motorm:ShellMode
Parameter(s)
• Data Type: void. This command takes no parameters.
Return Value(s)
• shellState - Data type: motorm:ShellMode. Shell state configured on the reader.
Possible Error Conditions
N/A
47
Reader Management Custom Extensions
ReaderDevice.setShellStatus
Modify the shell status on the reader.
Usage
ReaderDevice.setShellStatus( shellState: motorm:ShellMode): void
Parameter(s)
• shellState - Data type: motorm:ShellMode. Sets the shell mode.
Return Value(s)
• Data Type: void. This command does not return a value.
Possible Error Conditions
N/A
ReaderDevice.getFTPStatus
Get the FTP status.
Usage
ReaderDevice.getFTPStatus( void ): ftpState: motorm:FileServerMode
Parameter(s)
• Data Type: void. This command takes no parameters.
Return Value(s)
• ftpState - Data type: motorm:FileServerMode. The FTP state configured on the reader.
Possible Error Conditions
N/A
48
Reader Management Custom Extensions
ReaderDevice.setFTPStatus
Modify the FTP status on the reader.
Usage
ReaderDevice.setFTPStatus( ftpState: motorm:FileServerMode): void
Parameter(s)
• ftpState - Data type: motorm:FileServerMode. Sets the FTP mode.
Return Value(s)
• Data Type: void. This command does not return a value.
Possible Error Conditions
N/A
ReaderDevice.getUSBMode
Get the USB operation mode.
Usage
ReaderDevice.getUSBMode( void ): usbMode: motorm:USBOperationMode,
allowLLRPConnectionOverride: boolean
Parameter(s)
• Data Type: void. This command takes no parameters.
Return Value(s)
• usbMode - Data type: motorm:USBOperationMode. Get the USB operation mode configured on the reader.
• allowLLRPConnectionOverride - Data type: boolean. Allow overriding the LLRP connection established on
the other interface. Does not apply when using USB ActiveSync.
Possible Error Conditions
• unknownUSBMode
49
Reader Management Custom Extensions
ReaderDevice.setUSBMode
Modify the USB operation mode on the reader.
Usage
ReaderDevice.setUSBMode( usbMode: motorm:USBOperationMode,
allowLLRPConnectionOverride: boolean ): void
Parameter(s)
• usbMode - Data type: motorm:USBOperationMode. Set the USB operation mode based on this element.
• allowLLRPConnectionOverride - Data type: boolean. Set the value for allowing override of the LLRP
connection established on the other interface. Does not apply when using USB ActiveSync.
Return Value(s)
• void. This command does not return a value.
Possible Error Conditions
• noEdit
• invalidOption
50
Reader Management Custom Extensions
ReaderDevice.getLLRPConfig
Retrieve the LLRP configuration items from the reader.
Usage
ReaderDevice.getLLRPConfig( isCoreConfig: boolean ): portNum: int, IsSecure: boolean,
ValidatePeerInSecureMode: boolean, IsClient: boolean, serverIP: string, ShouldReconnect: boolean,
isCoreConfig: boolean
Parameter(s)
• isCoreConfig - Data type: boolean. Indicates whether the core configuration is requested.
Return Value(s)
• portNum - Data type: integer. The LLRP port number configured on the reader.
• IsSecure - Data type: boolean. Indicates whether LLRP is configured for secure mode.
• ValidatePeerInSecureMode - Data type: boolean. Indicates whether peer certificate validation is enabled
in secure mode.
• IsClient - Data type: boolean. Indicates whether LLRP is configured as a client.
• serverIP - Data type: string. The IP address of the LLRP server to which the reader is connecting.
• ShouldReconnect - Data type: boolean. Indicates whether the reader should attempt to reconnect to the
server.
• isCoreConfig - Data type: boolean. Indicates whether the core configuration is requested.
Possible Error Conditions
N/A
51
Reader Management Custom Extensions
ReaderDevice.setLLRPConfig
Set one or more LLRP configuration items from the reader.
Usage
ReaderDevice.setLLRPConfig(portNum: int, IsSecure: boolean, ValidatePeerInSecureMode: boolean,
IsClient: boolean, serverIP: string, ShouldReconnect: Boolean): void
Parameter(s)
• portNum - Data type: integer. The LLRP port number configured on the reader.
• IsSecure - Data type: boolean. Indicates whether LLRP is configured for secure mode.
• ValidatePeerInSecureMode - Data type: boolean. Indicates whether peer certificate validation is enabled
in secure mode.
• IsClient - Data type: boolean. Indicates whether LLRP is configured as a client.
• serverIP - Data type: string. The IP address of the LLRP server to which the reader is connecting.
• ShouldReconnect - Data type: boolean. Indicates whether the reader should attempt to reconnect to the
server.
Return Value(s)
• Data Type: void. This command does not return a value.
Possible Error Conditions
• invalidValue
• StandardportConflict
• invalidIpAddr
ReaderDevice.isLLRPRunning
Check if the LLRP service is running on the reader.
Usage
ReaderDevice.isLLRPRunning( void ): LLRPStartStatus: boolean
Parameter(s)
• Data Type: void. This command takes no parameters.
Return Value(s)
• LLRPStartStatus - Data type: boolean. Indicates if LLRP is running.
Possible Error Conditions
N/A
52
Reader Management Custom Extensions
ReaderDevice.isLLRPConnected
Check if the reader is connected over LLRP to host.
Usage
ReaderDevice.isLLRPConnected( void ): LLRPConnectStatus: boolean
Parameter(s)
• Data Type: void. This command takes no parameters.
Return Value(s)
• LLRPConnectStatus - Data type: boolean. Indicates if the reader is connected over LLRP.
Possible Error Conditions
N/A
ReaderDevice.ConnectLLRP
Connect or disconnect the reader using LLRP to host.
Usage
ReaderDevice.ConnectLLRP( LLRPConnectAction: boolean ): void
Parameter(s)
• LLRPConnectAction - Data type: boolean. Connect or disconnect LLRP.
Return Value(s)
• Data Type: void. This command does not return a value.
Possible Error Conditions
• llrpServerMode
• llrpConnectFailed
• llrpDisconnectFailed
53
Reader Management Custom Extensions
ReaderDevice.viewSystemLog
View the system log on the reader.
Usage
ReaderDevice.viewSystemLog( filterRules: motorm:systemLogFilterRules, saveFilterSettings:
unsignedInt ): systemLogContent: string, filterRules: motorm:systemLogFilterRules
Parameter(s)
• filterRules - Data type: motorm:systemLogFilterRules. Specify the filter parameters to apply before
sending back the system log. Currently supports Severity and Process based filtering.
• saveFilterSettings - Data type: unsignedInt. Indicates whether to save the filter configuration.
Return Value(s)
• systemLogContent - Data type: string. Current system log on the reader.
• filterRules - Data type: motorm:systemLogFilterRules. Provides the filter rules used for filtering.
Possible Error Conditions
• generatefilteredSyslogFailed
• generatefilteredSyslogStarted
ReaderDevice.viewAccessLog
View the access log on the reader.
Usage
ReaderDevice.viewAccessLog( void ): accessLogContent: string
Parameter(s)
• Data Type: void. This command takes no parameters.
Return Value(s)
• accessLogContent - Data type: string. Current access log on the reader.
Possible Error Conditions
N/A
54
Reader Management Custom Extensions
ReaderDevice.viewCurrentCertificateDetails
In secure mode, view the current security certificate on the reader.
Usage
ReaderDevice.viewCurrentCertificateDetails( void ): subjectName: string, issuerName: string,
validityStart: string, validityEnd: string, serial: string, installTime: string
Parameter(s)
• Data Type: void. This command takes no parameters.
Return Value(s)
• subjectName - Data type: string. Subject name of the current certificate.
• issuerName - Data type: string. Issuer name of the current certificate.
• validityStart - Data type: string. Validity start of the current certificate.
• validityEnd - Data type: string. Validity end of the current certificate.
• serial - Data type: string. Serial of the current certificate.
• installTime - Data type: string. Install date and time of the current certificate.
Possible Error Conditions
• failedCertImport
ReaderDevice.setNTPConfig
Set the system time with the option to use NTP-based time synchronization.
Usage
ReaderDevice.setNTPConfig( Server: string ): void
Parameter(s)
• Server - Data type: string. NTP server IP or name.
Return Value(s)
• Data Type: void. This command does not return a value.
Possible Error Conditions
• notFindHost
• invalidIpAddr
55
Reader Management Custom Extensions
ReaderDevice.getWatchdogStatus
Response to getWatchdogStatus command.
Usage
ReaderDevice.getWatchdogStatus( void ): enableWatchdog: boolean
Parameter(s)
• Data Type: void. This command takes no parameters.
Return Value(s)
• enableWatchdog - Data type: boolean. Indicates the status of the watchdog (enabled or disabled).
Possible Error Conditions
N/A
ReaderDevice.setWatchdogStatus
Modify (enable or disable) the watchdog on the reader.
Usage
ReaderDevice.setWatchdogStatus( enableWatchdog: boolean ): void
Parameter(s)
• enableWatchdog - Data type: boolean. Enables or disables the watchdog.
Return Value(s)
• Data Type: void. This command does not return a value.
Possible Error Conditions
N/A
56
Reader Management Custom Extensions
ReaderDevice.shutDown
Shutdown or restart the reader.
Usage
ReaderDevice.shutDown( restartNeeded: boolean, forceShutdown: boolean ): void
Parameter(s)
• restartNeeded - Data type: boolean. Indicates if a restart is needed.
• forceShutdown - Data type: boolean. Forces the shutdown even if there are configuration changes.
Return Value(s)
• Data Type: void. This command does not return a value.
Possible Error Conditions
• pendingChanges
ReaderDevice.getExtAntennaMode
Get the reader’s external antenna mode (monostatic or bistatic).
Usage
ReaderDevice.getExtAntennaMode( void ): returnValue: motorm:ExtAntennaMode
Parameter(s)
• Data Type: void. This command takes no parameters.
Return Value(s)
• returnValue - Data type: motorm:ExtAntennaMode. Indicates whether the external antenna is set to
monostatic, bistatic, or mixed mode.
Possible Error Conditions
N/A
57
Reader Management Custom Extensions
ReaderDevice.setExtAntennaMode
Set the reader’s external antenna to monostatic or bistatic.
Usage
ReaderDevice.setExtAntennaMode( extAntennaMode: motorm:ExtAntennaMode): void
Parameter(s)
• extAntennaMode - Data type: motorm:ExtAntennaMode. Sets the external antenna to monostatic, bistatic,
or mixed mode.
Return Value(s)
• Data Type: void. This command does not return a value.
Possible Error Conditions
• invalidOption
ReaderDevice.getReaderVersionInfo
Get the version of software on the reader.
Usage
ReaderDevice.getReaderVersionInfo( void ): list of <value: motorm:VersionInfoParamType>
Parameter(s)
• Data Type: void. This command takes no parameters.
Return Value(s)
• value - Data type: motorm:VersionInfoParamType. Flash partition usage information.
Possible Error Conditions
N/A
58
Reader Management Custom Extensions
ReaderDevice.getManufacturer
Get the manufacturer of the reader.
Usage
ReaderDevice.getManufacturer( void ): returnValue: string
Parameter(s)
• Data Type: void. This command takes no parameters.
Return Value(s)
• returnValue - Data type: string. Name of the manufacturer.
Possible Error Conditions
N/A
ReaderDevice.getModel
Get the reader model.
Usage
ReaderDevice.getModel( void ): returnValue: string
Parameter(s)
• Data Type: void. This command takes no parameters.
Return Value(s)
• returnValue - Data type: string. Model name.
Possible Error Conditions
N/A
59
Reader Management Custom Extensions
ReaderDevice.getName
Get the name of the reader.
Usage
ReaderDevice.getName( void ): returnValue: string
Parameter(s)
• Data Type: void. This command takes no parameters.
Return Value(s)
• returnValue - Data type: string. Name of the reader.
Possible Error Conditions
N/A
ReaderDevice.setName
Set the name of the reader.
Usage
ReaderDevice.setName( name: string ): void
Parameter(s)
• name - Data type: string. Sets a new name for the reader.
Return Value(s)
• Data Type: void. This command does not return a value.
Possible Error Conditions
• invalidName
• valueOverSize
60
Reader Management Custom Extensions
ReaderDevice.getDebounceTime
Get the GPI debounce time.
Usage
ReaderDevice.getDebounceTime( void ): returnValue: int
Parameter(s)
• Data type: void. This command takes no parameters.
Return Value(s)
• returnValue - Data type: int. Current Debounce time.
Possible Error Conditions
• notLoggedIn
• sessionTimeout
• notCurrentSession
ReaderDevice.setDebounceTime
Set the GPI debounce time.
Usage
ReaderDevice.setDebounceTime( dbtime: int ): void
Parameter(s)
• dbtime - Data Type: int. new debounce time to set.
Return Value(s)
• Data Type: void. This command does not return a value.
Possible Error Conditions
• noEdit
• valueOverSize
• invalidData
61
Reader Management Custom Extensions
ReaderDevice.getTimeTicks
Get the time in ticks at the reader.
Usage
ReaderDevice.getTimeTicks( void ): returnValue: unsignedLong
Parameter(s)
• Data Type: void. This command takes no parameters.
Return Value(s)
• returnValue - Data type: unsignedLong. Indicates the uptime in ticks.
Possible Error Conditions
N/A
ReaderDevice.getLocalTime
Get the local time of the reader.
Usage
ReaderDevice.getLocalTime( void ): returnValue: dateTime
Parameter(s)
• Data Type: void. This command takes no parameters.
Return Value(s)
• returnValue - Data type: dateTime. Local time of the reader.
Possible Error Conditions
N/A
62
Reader Management Custom Extensions
ReaderDevice.setLocalTime
Set the UTC time of the reader.
Usage
ReaderDevice.setLocalTime( dateTime: dateTime ): void
Parameter(s)
• dateTime - Data type:dateTime. Sets the local time.
Return Value(s)
• Data Type: void. This command does not return a value.
Possible Error Conditions
• invalidValue
• operationFailed
ReaderDevice.getAllReadPoints
Get all read points in the reader.
Usage
ReaderDevice.getAllReadPoints( maintenanceMode: boolean, refreshInterval: int ): list of <value: string,
readPointId: int>
Parameter(s)
• maintenanceMode - Data type: boolean. Flag indicating if maintenance mode is enabled.
• refreshInterval - Data type: int. Refresh interval value to update status.
Return Value(s)
• value - Data type: string. Read point name
• readPointId - Data type: integer. Read point ID.
Possible Error Conditions
N/A
63
Reader Management Custom Extensions
ReaderDevice.saveConfigChanges
Commit configuration changes.
Usage
ReaderDevice.saveConfigChanges( void ): void
Parameter(s)
• Data Type: void. This command takes no parameters.
Return Value(s)
• Data Type: void. This command does not return a value.
Possible Error Conditions
• operationFailed
• httpErr
• reinitWait
• changeNeedsReboot
• noChangesCommit
ReaderDevice.discardConfigChanges
Discard configuration changes.
Usage
ReaderDevice.discardConfigChanges( void ): void
Parameter(s)
• Data Type: void. This command takes no parameters.
Return Value(s)
• Data Type: void. This command does not return a value.
Possible Error Conditions
• noChangesDiscard
64
Reader Management Custom Extensions
ReaderDevice.hasConfigChanged
Response to hasConfigChanged.
Usage
ReaderDevice.hasConfigChanged( void ): configChanged: boolean
Parameter(s)
• Data Type: void. This command takes no parameters.
Return Value(s)
• configChanged - Data type: boolean. Indicates if the configuration changed.
Possible Error Conditions
N/A
ReaderDevice.getUncommitedConfigChangesDescription
Get the description of configuration changes not yet committed.
Usage
ReaderDevice.getUncommitedConfigChangesDescription( void ): list of <configChangeInfo: string>
Parameter(s)
• Data Type: void. This command takes no parameters.
Return Value(s)
• configChangeInfo - Data type: string. Indicates additional information based on the configuration changes.
Possible Error Conditions
N/A
65
Reader Management Custom Extensions
ReaderDevice.getTimeZones
Get the list of time zones supported in the reader along with the current time zone.
Usage
ReaderDevice.getTimeZones( void ): list of <TimeZoneDescription: string>, currentTimeZone: int
Parameter(s)
• Data Type: void. This command takes no parameters.
Return Value(s)
• TimeZoneDescription - Data type: string. Indicates the time zone description.
• currentTimeZone - Data type: integer. Index of the current time zone.
Possible Error Conditions
N/A
ReaderDevice.setTimeZone
Set the time zone in the reader.
Usage
ReaderDevice.setTimeZone( timeZoneIndex: int ): void
Parameter(s)
• timeZoneIndex - Data type: integer. Index of the time zone to set.
Return Value(s)
• Data Type: void. This command does not return a value.
Possible Error Conditions
invalidOption
66
Reader Management Custom Extensions
ReaderDevice.getReaderProfileList
Get the profile present in the reader.
Usage
ReaderDevice.getReaderProfileList( void ): list of <value: string, isStandardProfile: boolean>,
activeProfileName: string
Parameter(s)
• Data Type: void. This command takes no parameters.
Return Value(s)
• value - Data type: string. Specifies a single profile name.
• isStandardProfile - Data type: boolean. Indicates whether the profile is a standard profile.
• activeProfileName - Data type: string. Name of the active profile on the reader, if any. If absent, no profile is
active.
Possible Error Conditions
N/A
ReaderDevice.setProfileActive
Activate the chosen profile on the reader.
Usage
ReaderDevice.setProfileActive( ProfileName: string ): void
Parameter(s)
• ProfileName - Data type: string. Name of the profile.
Return Value(s)
• Data Type: void. This command does not return a value.
Possible Error Conditions
• currentProfile
• operationFailed
• nosuchFileOrPath
• invalidProfile
67
Reader Management Custom Extensions
ReaderDevice.deleteProfile
Delete the chosen profile from the reader.
Usage
ReaderDevice.deleteProfile( ProfileName: string ): void
Parameter(s)
• ProfileName - Data type: string. Name of the profile.
Return Value(s)
• Data Type: void. This command does not return a value.
Possible Error Conditions
• currentProfile
• nosuchFileOrPath
• operationFailed
68
Reader Management Custom Extensions
ReaderDevice.importProfileToReader
Import a profile to the reader.
Usage
ReaderDevice.importProfileToReader( ProfileName: string, ProfileData: string, doSetActive: boolean,
doSaveChange: boolean, doForceOverwrite: boolean ): void
Parameter(s)
• ProfileName - Data type: string. Name of the profile.
• ProfileData - Data type: string. Content of the profile file.
• doSetActive - Data type: boolean. Set the profile active after importing it.
• doSaveChange - Data type: boolean. Commit the changes after setting the profile active. Use this if
doSetActive is true.
• doForceOverwrite - Data type: boolean. Flag indicating whether to forcefully overwrite the profile on the
reader.
Return Value(s)
• Data Type: void. This command does not return a value.
Possible Error Conditions
• currentProfile
• stdProfileNoImport
• maxProfilesPresent
• operationFailed
• nosuchFileOrPath
• invalidProfile
69
Reader Management Custom Extensions
ReaderDevice.exportProfileFromReader
Retrieve the profile file contents from the reader.
Usage
ReaderDevice.exportProfileFromReader( ProfileName: string ): ProfileName: string, ProfileData: string
Parameter(s)
• ProfileName - Data type: string. Name of the profile.
Return Value(s)
• ProfileName - Data type: string. Name of the profile.
• ProfileData - Data type: string. Content of the profile file.
Possible Error Conditions
• operationFailed
• nosuchFileOrPath
ReaderDevice.getSerialTimeout
Get the serial connection timeout on the reader.
Usage
ReaderDevice.getSerialTimeout( void ): timeOutValue: unsignedInt
Parameter(s)
• Data Type: void. This command takes no parameters.
Return Value(s)
• timeOutValue - Data type: unsignedInt. Value of the serial timeout in seconds. 0 is no timeout.
Possible Error Conditions
• unsupportedCommand
70
Reader Management Custom Extensions
ReaderDevice.setSerialTimeout
Set the serial connection timeout on the reader.
Usage
ReaderDevice.setSerialTimeout( timeOutValue: unsignedInt ): void
Parameter(s)
• timeOutValue - Data type: unsignedInt. Value of the serial timeout in seconds. 0 is no timeout.
Return Value(s)
• Data Type: void. This command does not return a value.
Possible Error Conditions
• unsupportedCommand
• invalidSerialTimeOut
ReaderDevice.getAntennaCheck
Get whether the antenna check is enabled on the reader.
Usage
ReaderDevice.getAntennaCheck( void ): antennaCheckStatus: boolean
Parameter(s)
• Data Type: void. This command takes no parameters.
Return Value(s)
• antennaCheckStatus - Data type: boolean. Indicates whether to enable or disable the antenna check.
Possible Error Conditions
N/A
71
Reader Management Custom Extensions
ReaderDevice.setAntennaCheck
Enable or disable the antenna check on the reader.
Usage
ReaderDevice.setAntennaCheck( antennaCheckStatus: boolean ): void
Parameter(s)
• antennaCheckStatus - Data type: boolean. Indicates whether to enable or disable the antenna check.
Return Value(s)
• Data Type: void. This command does not return a value.
Possible Error Conditions
N/A
ReaderDevice.getReaderDetails
Get the reader details including HostName, IP-Address, Serial Number, Software Version, NumPorts.
Usage
ReaderDevice.getReaderDetails( void ): HostName: string, IPAddress: string, SerialNumber: string,
SoftwareVersion: string, NumPorts: int
Parameter(s)
• Data Type: void. This command takes no parameters.
Return Value(s)
• HostName - Data type: string. Host name of the reader.
• IPAddress - Data type: string. IP address of the reader.
• SerialNumber - Data type: string. Serial number of the reader.
• SoftwareVersion - Data type: string. Software version of the reader.
• NumPorts - Data type: integer. Number of ports in the reader.
• PowerSource - Power source type used to power the reader. 0 = 24V DC power, 2 = POE Standard.
Possible Error Conditions
N/A
72
Reader Management Custom Extensions
ReaderDevice.firmwareRevertBack
Revert firmware to last known bootable configuration.
Usage
ReaderDevice.firmwareRevertBack( void ): void
Parameter(s)
• Data Type: void. This command takes no parameters.
Return Value(s)
• Data Type: void. This command does not return a value.
Possible Error Conditions
• bootdatareadfailed
• bootdatawritefailed
• revertBackNotAllowed
• revertbackFailed
ReaderDevice.addIPSecParams
Set the parameters for IPSec.
Usage
ReaderDevice.addIPSecParams( IPMode: string, IPAddress: string, PassCode: string ): void
Parameter(s)
• IPMode - Data type: string. Mode for IPSec Tunnel/Transport.
• IPAddress - Data type: string. IP address of the peer.
• PassCode - Data type: string. Pre-shared key.
Return Value(s)
• Data Type: void. This command does not return a value.
Possible Error Conditions
• invalidIpAddr
• addIPSecParamsFailed
73
Reader Management Custom Extensions
ReaderDevice.removeIPSecParams
Remove the parameters for IPSec.
Usage
ReaderDevice.removeIPSecParams( IPAddress: string ): void
Parameter(s)
• IPAddress - Data type: string. IP address of the peer.
Return Value(s)
• Data Type: void. This command does not return a value.
Possible Error Conditions
• invalidIpAddr
• removeIPSecParamsFailed
ReaderDevice.getGPIPortStatus
Get the PIN status for all GPI pins.
Usage
ReaderDevice.getGPIPortStatus( void ): GPIPortStatus: int
Parameter(s)
• Data Type: void. This command takes no parameters.
Return Value(s)
• GPIPortStatus - Data type: int. Value of all GPI pins. LSB maps to Pin1, etc.
Possible Error Conditions
• getGPIPortStatusFailed
74
Reader Management Custom Extensions
ReaderDevice.setGPOPinStatus
Set the status of GPO pin.
Usage
ReaderDevice.setGPOPinStatus( PinNumber: int, GPOPintStatus: boolean ): void
Parameter(s)
• PinNumber - Data type: int. GPO pin number.
• GPOPintStatus - Data type: boolean. GPO pIN status. TRUE indicates PIN HIGH, FALSE indicates PIN
LOW.
Return Value(s)
• Data Type: void. This command does not return a value.
Possible Error Conditions
N/A
ReaderDevice.getEnableRevertBackStatus
Indicates if revert back can be enabled.
Usage
ReaderDevice.getEnableRevertBackStatus( void ): canRevertBackEnabled: boolean
Parameter(s)
• Data Type: void. This command takes no parameters.
Return Value(s)
• canRevertBackEnabled - Data type: boolean. Status for canRevertBackEnabled.
Possible Error Conditions
• getEnableRevertBackStatusFailed
75
Reader Management Custom Extensions
ReaderDevice.getGPOPortStatus
Get the PIN status for all GPO pins.
Usage
ReaderDevice.getGPOPortStatus( void ): GPOPortStatus: int
Parameter(s)
• Data Type: void. This command takes no parameters.
Return Value(s)
• GPOPortStatus - Data type: int. Value of all GPO pins. LSB maps to Pin1, etc.
Possible Error Conditions
• getGPOPortStatusFailed
ReaderDevice.getIPSecParamsList
Get list of parameters added for IPSEC.
Usage
ReaderDevice.getIPSecParamsList( void ): IpsecParamsList: string
Parameter(s)
• Data Type: void. This command takes no parameters.
Return Value(s)
• IpsecParamsList - Data type: string. List of IPSec parameters added.
Possible Error Conditions
• getIPSecParamsListFailed
76
Reader Management Custom Extensions
ReaderDevice.getIdleModeTimeout
Get the idle mode timeout.
Usage
ReaderDevice.getIdleModeTimeout( void ): timeoutValue: int
Parameter(s)
• Data Type: void. This command takes no parameters.
Return Value(s)
• timeoutValue - Data type: int. Current idle mode timeout.
Possible Error Conditions
• notLoggedIn
• sessionTimeout
• notCurrentSession
ReaderDevice.setIdleModeTimeout
Set idle mode timeout.
Usage
ReaderDevice.setIdleModeTimeout( timeOutValue: int ): void
Parameter(s)
• timeoutValue - Idle mode timeout in seconds. Radio turns off when the reader is idle (there is no RF
operation) for the specified time interval. When the radio turns off, the antenna check feature is not
supported if inventory is not occurring. Set this value to 0 to disable this feature. The minimum allowed
value is 10 and the maximum is 60000 seconds.
Return Value(s)
• Data Type: void. This command does not return a value.
Possible Error Conditions
• noEdit valueOverSize
• invalidData
77
Reader Management Custom Extensions
ReaderDevice.processResponseFile
Start file based firmware update.
Usage
ReaderDevice.processResponseFile( updateAllPartitions: boolean ): list of <value: string>
Parameter(s)
• updateAllPartitions - Data type: boolean. Flag indicating if all the partitions need to be updated.
Return Value(s)
• value - Data type: string. List of files to upload.
Possible Error Conditions
N/A
ReaderDevice.startOSupdate
Initiate file based firmware update.
Usage
ReaderDevice.startOSupdate( void ): void
Parameter(s)
• updateCommand - Data Type: string. Update command with file name to be flashed
• isForceUpdate - Data Type: int. Set 1 if all the partitions need to be updated
Return Value(s)
• Data Type: void. This command does not return a value.
Possible Error Conditions
N/A
78
Reader Management Custom Extensions
ReaderDevice.installUserApp
Install the customer application.
Usage
ReaderDevice.installUserApp( appName: string ): void
Parameter(s)
• appName - Data type: string. Name of the application.
Return Value(s)
• Data Type: void. This command does not return a value.
Possible Error Conditions
• packageinstallfailed
• packageDoesNotExist
• operationFailed
ReaderDevice.getMaxUserApps
Get the number of user apps installed in the reader.
Usage
ReaderDevice.getMaxUserApps( void ): maxApps: int
Parameter(s)
• Data Type: void. This command takes no parameters.
Return Value(s)
• maxApps - Data type: int. Maximum number of user apps.
Possible Error Conditions
N/A
79
Reader Management Custom Extensions
ReaderDevice.startUserApp
Start/Stop customer application.
Usage
ReaderDevice.startUserApp( appName: string, start: boolean ): void
Parameter(s)
• appName - Data type: string. Name of the application.
• start - Data type: boolean. Set TRUE to start the application, FALSE to stop.
Return Value(s)
• Data Type: void. This command does not return a value.
Possible Error Conditions
• appAlreadyRunning
• startupFileDoesNotExist
• operationFailed
ReaderDevice.autostarUserApp
Autostart the customer application.
Usage
ReaderDevice.autostarUserApp( appName: string, autostart: boolean ): void
Parameter(s)
• appName - Data type: string. Name of the application.
• autostart - Data type: boolean. Set TRUE to auto start the application on boot up.
Return Value(s)
• Data Type: void. This command does not return a value.
Possible Error Conditions
• operationFailed
80
Reader Management Custom Extensions
ReaderDevice.uninstalluserapp
Unnstall the customer application.
Usage
ReaderDevice.uninstalluserapp( appName: string ): void
Parameter(s)
• appName - Data type: string. Name of the application.
Return Value(s)
• Data Type: void. This command does not return a value.
Possible Error Conditions
• uninstallAppFailed
• insufficientpermissions
ReaderDevice.getInstalledApps
Get list of installed applications.
Usage
ReaderDevice.getInstalledApps( AppIndex: int ): appName: string, runningStatus: boolean, autostart: boolean,
metadata: string
Parameter(s)
• AppIndex - Data type: int. Index of applications.
Return Value(s)
• appName - Data type: string. Maximum number of user applications.
• runningStatus - Data type: boolean. Current running status.
• autostart - Data type: boolean. Autostart status.
• metadata - Data type: string. Metadata of application.
Possible Error Conditions
• operationFailed
81
Reader Management Custom Extensions
ReaderDevice.getCurrentRunStatus
Get the current running status.
Usage
ReaderDevice.getCurrentRunStatus( appName: string ): runstatus: boolean
Parameter(s)
• appName - Data type: string. Name of the application.
Return Value(s)
• runstatus - Data type: boolean. TRUE if the application is running, else set to FALSE
Possible Error Conditions
N/A
ReaderDevice.generateCustomerSupportDataFile
Generates the customer support data file.
Usage
ReaderDevice.generateCustomerSupportDataFile( void ): void
Parameter(s)
• Data Type: void. This command takes no parameters.
Return Value(s)
• Data Type: void. This command does not return a value.
Possible Error Conditions
• generateCSDFailed
• generateCSDStarted
82
Reader Management Custom Extensions
ReaderDevice.purgeLogs
Purges the system logs and temporary files created in log path.
Usage
ReaderDevice.purgeLogs( void ): void
Parameter(s)
• Data Type: void. This command takes no parameters.
Return Value(s)
• Data Type: void. This command does not return a value.
Possible Error Conditions
• purgeLogsFailed
ReaderDevice.getwirelessnwlist
Get the list of wireless networks.
Usage
ReaderDevice. Getwirelessnwlist(void) : essid: string, signalStrength: string, metadata: string
Parameter(s)
• Data Type: void. This command takes no parameters.
Return Value(s)
• essid - Data type: string. ESSID of the of the available networks.
• signalStrength - Data type: string. Signal strength of the available networks.
• metadata - Data type: string. Reserved for future use.
Possible Error Conditions
• wirelessScanErr
83
Reader Management Custom Extensions
ReaderDevice.addwirelessnw
Add a Wifi net work setting.
Usage
ReaderDevice.addwirelessnw( essid: string, passkey: string, autoconnect: boolean, metadata: string ): void
Parameter(s)
• essid - Data type: string. ESSID of the network.
• passkey - Data type: string. Passkey of the network.
• autoconnect - Data type: boolean. Connect automatically on restart.
• metadata - Data type: string. Reserved for future use.
Return Value(s)
• Data Type: void. This command does not return a value.
Possible Error Conditions
• operationFailed
ReaderDevice.getwirelessnwproperties
Get the details of the connected wireless network.
Usage
ReaderDevice.getwirelessnwproperties( void ): essid: string, signalstrength: string, connectionstatus:
motorm:WirelessConnectionStatus, ipaddress: string
Parameter(s)
• Data Type: void. This command takes no parameters.
Return Value(s)
• essid - Data type: string. ESSID of the network.
• signalstrength - Data type: string. Signal strength of the connected network. Possible values are poor,
average, excellent, or in % terms.
• connectionstatus - Data type: motorm:WirelessConnectionStatus. Get wireless network connection
status.
• ipaddress - Data type: string. IP address.
Possible Error Conditions
• getGPOPortStatusFailed
84
Reader Management Custom Extensions
ReaderDevice.getwirelessconfiguredparams
Get the details of parameters configured for the wireless network.
Usage
ReaderDevice.getwirelessconfiguredparams( void ): essid: string, passkey: string, autoconnect: boolean
Parameter(s)
• Data Type: void. This command takes no parameters.
Return Value(s)
• essid - Data type: string. ESSID of the configured network.
• passkey - Data type: string. Passkey of the configured network.
• autoconnect - Data type: boolean. Indicates whether to autoconnect to the network after reader restart.
Possible Error Conditions
• operationFailed
ReaderDevice.disconnectwirelessnw
Disconnect the Wifi connection.
Usage
ReaderDevice.disconnectwirelessnw( void ): void
Parameter(s)
• Data Type: void. This command takes no parameters.
Return Value(s)
• Data Type: void. This command does not return a value.
Possible Error Conditions
• addwirelessnwfailed
85
Reader Management Custom Extensions
ReaderDevice.getGPIOSettings
Get the mapping information of GPIO.
Usage
ReaderDevice.getGPIOSettings( void ): isGPI1MappedToRadioGPIO1: boolean,
isGPI2MappedToRadioGPIO2: boolean, isGPO1MappedToRadioGPIO1: boolean,
isGPO2MappedToRadioGPIO2: boolean, maxNumOfGPIOs: int
Parameter(s)
• Data Type: void. This command takes no parameters.
Return Value(s)
• isGPI1MappedToRadioGPIO1 - Data type: boolean. Indicates whether GPI1 is mapped with Radio
GPIO1.
• isGPI2MappedToRadioGPIO2 - Data type: boolean. Indicates whether GPI2 is mapped with Radio
GPIO2.
• isGPO1MappedToRadioGPIO1 - Data type: boolean. Indicates whether GPO1 is mapped with Radio
GPIO1.
• isGPO2MappedToRadioGPIO2 - Data type: boolean. Indicates whether GPO2 is mapped with Radio
GPIO2.
• maxNumOfRadioGPIOs - Data type: int. Maximum number of radio GPIOs supported in this reader.
Possible Error Conditions
N/A
86
Reader Management Custom Extensions
ReaderDevice.setGPIOSettings
Set GPIO mapping information.
Usage
ReaderDevice.setGPIOSettings( isGPI1MappedToRadioGPIO1: boolean, isGPI2MappedToRadioGPIO2:
boolean, isGPO1MappedToRadioGPIO1: boolean, isGPO2MappedToRadioGPIO2: boolean ): void
Parameter(s)
• isGPI1MappedToRadioGPIO1 - Data type: boolean. Indicates whether GPI1 is mapped with Radio
GPIO1.
• isGPI2MappedToRadioGPIO2 - Data type: boolean. Indicates whether GPI2 is mapped with Radio
GPIO2.
• isGPO1MappedToRadioGPIO1 - Data type: boolean. Indicates whether GPO1 is mapped with Radio
GPIO1.
• isGPO2MappedToRadioGPIO2 - Data type: boolean. Indicates whether GPO2 is mapped with Radio
GPIO2.
Return Value(s)
• Data Type: void. This command does not return a value.
Possible Error Conditions
N/A
ReaderDevice.resetToFactoryDefaults
Return the reader to factory default configuration after a system reboot.
Usage
ReaderDevice.resetToFactoryDefaults( void ): void
Parameter(s)
• Data Type: void. This command takes no parameters.
Return Value(s)
• Data Type: void. This command does not return a value.
Possible Error Conditions
N/A
87
Reader Management Custom Extensions
ReaderDevice.setSystemLogConfiguration
Set system log configuration.
Usage
ReaderDevice.setSystemLogConfiguration( remoteServerIP: string, remoteServerPort:
int,remoteServerMinSeverity: int ): void
Parameter(s)
• remoteServerIP - Data type: string. IP address of remote logger.
• remoteServerPort - Data type: int. Port number of remote logger.
• remoteServerMinSeverity - Data type: int. Minimum severity above which to send to remote logger.
Return Value(s)
• Data Type: void. This command does not return a value.
Possible Error Conditions
• invalidIpAddr
• valueOverSize
• invalidSnmpVersion
ReaderDevice.getSystemLogConfiguration
Get system log configuration.
Usage
ReaderDevice.getSystemLogConfiguration( void ): remoteServerIP: string, remoteServerPort: int,
remoteServerMinSeverity: int
Parameter(s)
• Data Type: void. This command takes no parameters.
Return Value(s)
• remoteServerIP - Data Type: string. IP address of Remote Logger
• remoteServerPort - Data Type: int. Port Number of Remote Logger
• remoteServerMinSeverity - Data Type: int. Minimum Severity above which to be send to Remote Logger
Possible Error Conditions
N/A
88
Reader Management Custom Extensions
ReaderDevice.getRadioModuleOnTime
Get duration in seconds, since power-on of the reader, for which the radio module was powered on.
Usage
ReaderDevice.getRadioModuleOnTime( void ): radioModuleOnTime: int
Parameter(s)
• Data Type: void. This command takes no parameters.
Return Value(s)
• radioModuleOnTime - Data type: int. Time elapsed in seconds since radio module was turned on.
Possible Error Conditions
N/A
ReaderDevice.setDiagnosticMode
Configure diagnostic mode parameters on the reader.
Usage
ReaderDevice.setDiagnosticMode( enableDiagnostics: boolean, extended: boolean ): void
Parameter(s)
• enableDiagnostics - Data type: boolean. Generic flag, indicating which diagnostics to turn on in the
reader.
• extended - Data type: boolean. Enable extended diagnostic monitoring functions. Applies only if
enableDiagnostic is true. This parameter is for internal use only.
Return Value(s)
• Data Type: void. This command does not return a value.
Possible Error Conditions
N/A
89
Reader Management Custom Extensions
ReaderDevice.startReaderDiagnostics
Start the diagnostics of the reader.
Usage
ReaderDevice.startReaderDiagnostics( void ): void
Parameter(s)
• Data Type: void. This command takes no parameters.
Return Value(s)
• Data Type: void. This command does not return a value.
Possible Error Conditions
N/A
ReaderDevice.getEventAmbientTemperatureHighAlarmCount
Get the number of the ambient temperature high alarm events.
Usage
ReaderDevice.getEventAmbientTemperatureHighAlarmCount( void ): returnValue: int
Parameter(s)
• Data Type: void. This command takes no parameters.
Return Value(s)
• returnValue - Data Type: int.
Possible Error Conditions
N/A
90
Reader Management Custom Extensions
ReaderDevice.getEventAmbientTemperatureCriticalAlarmCount
Get the number of the ambient temperature critical alarm events.
Usage
ReaderDevice.getEventAmbientTemperatureCriticalAlarmCount( void ): returnValue: int
Parameter(s)
• Data Type: void. This command takes no parameters.
Return Value(s)
• returnValue - Data Type: int.
Possible Error Conditions
N/A
ReaderDevice.getEventPATemperatureHighAlarmCount
Get the number of the PA temperature high alarm events.
Usage
ReaderDevice.getEventPATemperatureHighAlarmCount( void ): returnValue: int
Parameter(s)
• Data Type: void. This command takes no parameters.
Return Value(s)
• returnValue - Data Type: int.
Possible Error Conditions
N/A
91
Reader Management Custom Extensions
ReaderDevice.getEventPATemperatureCriticalAlarmCount
Get the number of the PA temperature critical alarm events.
Usage
ReaderDevice.getEventPATemperatureCriticalAlarmCount( void ): returnValue: int
Parameter(s)
• Data Type: void. This command takes no parameters.
Return Value(s)
• returnValue - Data Type: int.
Possible Error Conditions
N/A
ReaderDevice.getEventForwardPowerHighAlarmCount
Get the number of the forward power high alarm events.
Usage
ReaderDevice.getEventForwardPowerHighAlarmCount( void ): returnValue: int
Parameter(s)
• Data Type: void. This command takes no parameters.
Return Value(s)
• returnValue - Data Type: int.
Possible Error Conditions
N/A
92
Reader Management Custom Extensions
ReaderDevice.getEventForwardPowerLowAlarmCount
Get the number of the forward power low alarm events.
Usage
ReaderDevice.getEventForwardPowerLowAlarmCount( void ): returnValue: int
Parameter(s)
• Data Type: void. This command takes no parameters.
Return Value(s)
• returnValue - Data Type: int.
Possible Error Conditions
N/A
ReaderDevice.getEventReversePowerHighAlarmCount
Get the number of the reverse power high alarm events.
Usage
ReaderDevice.getEventReversePowerHighAlarmCount( void ): returnValue: int
Parameter(s)
• Data Type: void. This command takes no parameters.
Return Value(s)
• returnValue - Data Type: int.
Possible Error Conditions
N/A
93
Reader Management Custom Extensions
ReaderDevice.getEventEchoThresholdAlarmCount
Get the number of the echo threshold alarm events.
Usage
ReaderDevice.getEventEchoThresholdAlarmCount( void ): returnValue: int
Parameter(s)
• Data Type: void. This command takes no parameters.
Return Value(s)
• returnValue - Data Type: int.
Possible Error Conditions
N/A
ReaderDevice.getEventDatabaseWarningCount
Get the number of the database warning events.
Usage
ReaderDevice.getEventDatabaseWarningCount( void ): returnValue: int
Parameter(s)
• Data Type: void. This command takes no parameters.
Return Value(s)
• returnValue - Data Type: int.
Possible Error Conditions
N/A
94
Reader Management Custom Extensions
ReaderDevice.getEventDatabaseErrorCount
Get the number of the database error events.
Usage
ReaderDevice.getEventDatabaseErrorCount( void ): returnValue: int
Parameter(s)
• Data Type: void. This command takes no parameters.
Return Value(s)
• returnValue - Data Type: int.
Possible Error Conditions
N/A
ReaderDevice.getEventGPIOInformationCount
Get the number of the GPIO information events.
Usage
ReaderDevice.getEventGPIOInformationCount( void ): returnValue: int
Parameter(s)
• Data Type: void. This command takes no parameters.
Return Value(s)
• returnValue - Data Type: int.
Possible Error Conditions
N/A
95
Reader Management Custom Extensions
ReaderDevice.getRadioPowerState
Get the current radio power state information.
Usage
ReaderDevice.getRadioPowerState( void ): returnValue: int
Parameter(s)
• Data Type: void. This command takes no parameters.
Return Value(s)
• returnValue - Data Type: int. int. The current state (On = 0 / Off = 1) of the radio.
Possible Error Conditions
N/A
ReaderDevice.getUSBState
Get the current USB device status information.
Usage
ReaderDevice.getUSBState( void ): PortStatus: motorm:USBPortStatus, list of
<DeviceInfo:motorm:USBDeviceInfo>
Parameter(s)
• Data Type: void. This command takes no parameters.
Return Value(s)
• PortStatus - Data Type: motorm:USBPortStatus. The status of the USB connection
(Connected/Unconnected/Powered off).
• DeviceInfo - Data Type: motorm:USBDeviceInfo. Device Information of each USB device connected.
1. Type of device ("Mass Storage Device", "Wireless LAN adapter" or "Bluetooth adapter")
2. Model Name of the USB device connected
3. Vendor ID of the USB device manufacturer
4. Serial Number of the connected USB Device.
Possible Error Conditions
N/A
96
Reader Management Custom Extensions
ReaderDevice.viewMACErrorLog
View the MAC error log on the reader.
Usage
ReaderDevice.viewMACErrorLog( void ): MACErrorLogContent: string
Parameter(s)
• Data Type: void. This command takes no parameters.
Return Value(s)
• MACErrorLogContent - Data type: string. Current MAC Error log on the reader.
Possible Error Conditions
N/A
ReaderDevice.getPowerNegotiation
Get whether Power Negotiation is enabled on the Reader.
Usage
ReaderDevice. getPowerNegotiation ( void ): powerNegotiationStatus : boolean
Parameter(s)
• Data Type: void. This command takes no parameters.
Return Value(s)
• powerNegotiationStatus - Data Type: boolean. The state on whether powerNegotiationStatus is enabled or
disabled.
Possible Error Conditions
N/A
97
Reader Management Custom Extensions
ReaderDevice.setPowerNegotiation
Set whether Power Negotiation is to be enabled on the Reader.
Usage
ReaderDevice. setPowerNegotiation (powerNegotiationStatus : boolean): void
Parameter(s)
• powerNegotiationStatus Data Type: boolean. Power Negotiation status to be set on the reader.
Return Value(s)
• Data Type: void. This command does not return a value.
Possible Error Conditions
N/A
ReaderDevice.getAllowGuestStatus
Get whether Guest login is allowed to reader.
Usage
ReaderDevice. getAllowGuestStatus ( void ): setAllowGuestStatus: boolean
Parameter(s)
• Data Type: void. This command takes no parameters.
Return Value(s)
• setAllowGuestStatus- Data Type: boolean. The state on whether Guest login is enabled or disabled.
Possible Error Conditions
N/A
98
Reader Management Custom Extensions
ReaderDevice.setAllowGuestStatus
Set whether Guest login is to be enabled on the Reader.
Usage
ReaderDevice. setAllowGuestStatus ( allowGuestStatus: boolean): void
Parameter(s)
o allowGuestStatusData Type: boolean. Allow Guest status to be set on the reader.
Return Value(s)
o Data Type: void. This command does not return a value.
Possible Error Conditions
"insufficientpermissions
ReaderDevice.manageLicense
RM Command to manage license on the FX Series RFID Reader. Supports activating and returning license for a
software feature.
Usage
ReaderDevice.manageLicense(operationType : string, isOfflineSource : Boolean, serverURL : string, activationId :
string, installApp : Boolean): void
Parameter(s)
• operationType - Data Type: string. Operation to be performed related to managing license. Can be
ActivateLicense or ReturnLicense
• isOfflineSource - Data Type: Boolean. License server source type to be used in managing the license. In
case of Offline source license bin file should be transferred to reader before this command is called
• serverURL – Data Type: string. URL of the license server that is to be used Activate or Return License
• activationId - Data Type: string. Activation Id of the customer that the license is linked to.
• installApp - Data Type: Boolean. Activation Id of the customer that the license is linked to.
Return Value(s)
Data Type: void. This command does not return a value.
Possible Error Conditions
• licenseCheckFailed
• onlineLicenseAcquireFailed
• offlineLicenseAcquiredFailed
• releaseLicenseFailed
99
Loading...