OPOS DLRMUS User Guide
OPOS DLRMUS User Guide
MANAGEMENT UTILITY
USER GUIDE
All rights reserved. Without limiting the rights under copyright, no part of this documentation may be repro-
duced, stored in or introduced into a retrieval system, or transmitted in any form or by any means, or for any
purpose, without the express written permission of Datalogic S.p.A. and/or its affiliates.
Owners of Datalogic products are hereby granted a non-exclusive, revocable license to reproduce and transmit
this documentation for the purchaser's own internal business purposes. Purchaser shall not remove or alter
any proprietary notices, including copyright notices, contained in this documentation and shall ensure that all
notices appear on any reproductions of the documentation.
Electronic versions of this document may be downloaded from the Datalogic website (www.datalogic.com). If
you visit our website and would like to make comments or suggestions about this or other Datalogic publica-
tions, please let us know via the "Contact" page.
Disclaimer
Datalogic has taken reasonable measures to provide information in this manual that is complete and accurate,
however, Datalogic shall not be liable for technical or editorial errors or omissions contained herein, nor for
incidental or consequential damages resulting from the use of this material. Datalogic reserves the right to
change any specification at any time without prior notice.
Trademarks
Datalogic and the Datalogic logo are registered trademarks of Datalogic S.p.A. in many countries, including the
U.S.A. and the E.U.
Patents
See www.patents.datalogic.com for patent list.
TABLE OF CONTENTS
DATALOGIC REMOTE MANAGEMENT UTILITY.............................................................. 1
INTRODUCTION ............................................................................................................... 1
DISTRIBUTION ................................................................................................................. 1
INSTALLATION (Windows & Linux) .................................................................................. 1
CONFIGURATION ............................................................................................................. 1
OPERATIONS ................................................................................................................... 2
Overview .............................................................................................................................................. 2
Supported Operations ......................................................................................................................... 3
Command Line Options ...................................................................................................................... 3
Information ................................................................................................................................. 3
Querying a scanner ............................................................................................................................. 4
Updating Scanner Firmware .............................................................................................................. 5
APPENDIX A .............................................................................................................. 7
Command Line Parameter Details .................................................................................... 7
Example Batch file .............................................................................................................................. 8
Linux Terminal Setup ......................................................................................................................... 9
USER GUIDE I
CONTENTS
NOTES
INTRODUCTION
DLRMUs is a utility whose purpose is to remotely update scanner firmware. It exists as
both Windows and Linux implementations and is intended to replace the older utilities
DLRMU (Windows) and cmdfw (Linux).
The s in DLRMUs means ‘standalone’, that is, the application doesn’t require either OPOS or
JavaPOS to be installed, as did its predecessors. Note, however, the Centos operating sys‐
tem is not supported because its kernel is too old to be compatible.
DISTRIBUTION
Windows (dlrmus.<version>.zip)
Contains [dlrmus.exe, properties.json, prf_parser.json]
Linux (dlrmus.<version>.tar.gz)
Contains [dlrmus, properties.json, prf_parser.json]
CONFIGURATION
Configuration is managed via the JSON file properties.json, and from here on will be
referred to as the properties file. If you’re not already, you had better familiarize yourself
with the JSON format because something as simple as a missing comma will cause you
grief.
The properties file has three basic sections 1) Profiles, 2) Models and 3) miscellaneous
parameters. Viewing the properties file in an editor, the first two sections can be found by
simply searching for either Profiles or Models. The miscellaneous parameters have no sec‐
tion name but are seen at the top of the file as:
"MaxLogFiles": 10,
"ConsoleInfo": false,
"ConsoleHealth": false,
"ConsoleStatistics": false,
USER GUIDE 1
OPERATIONS
Of the miscellaneous parameters, the MaxLogFiles will likely be the most important
because it controls the maximum number of log files generated before log files begin to be
recycled. The remaining miscellaneous parameters simply control various output to the
command/terminal window. Note, this same information is recorded in the log files with
more context.
The Profiles section is where scanners (and their associated communication parameters)
are defined. For a given scanner, you can use the Name parameter to reference the scanner
and the Interface parameter identifies the communication interface to be used. Examples
are provided in the OPERATIONS segment of this manual.
The Models section is where various validation and filtering data are defined. Briefly, failing
these checks, the scanner will not be updated. Again, examples are provided in the OPERA-
TIONS segment of this manual.
OPERATIONS
Overview
DLRMUs is a command line application; it doesn’t have a user interface. As such, DLRMUs
must be executed via a command/terminal window or via scripts. Upon execution of a com‐
mand, DLRMUs performs an integrity check, ensuring the existence of the required configu‐
ration (JSON) files and a folder to which log files can be written. Failing the integrity check,
DLRMUs will report the source of the error and exit immediately. Excluding such cases of
catastrophic failure, DLRMUs generates output in two log files:
1.dlslog.txt (a summary/overview log file)
2.dlslogX.txt (a traffic log file, where X is some value in the range 0..MaxLogFiles‐1)
Entries in the summary log are made per command, and each entry provides a reference to
its associated traffic log. The traffic logs are recycled when the maximum is reached but the
summary log is cumulative. As such, you are responsible for managing the lifetime of the
summary log.
Under the Windows environment, log files are recorded in the directory:
C:\ProgramData\Datalogic\Logs\dlrmus
Under the Linux environment, log files are recorded in the directory:
logs (beneath your installation directory)
Upon completion of each command, a status code will be written to the summary log and
to the command/terminal window.
Status Codes
0: success (regardless of the operation)
-1: failed to update scanner
-2: successfully updated scanner and configurations are identical
-3: scanner EC >= file EC OR failed to find a matching scanner based on model num‐
ber, etc.
-4: failure to connect to scanner, regardless of reason OR failure to load/parse PRF
5: various numbers issued by failure to update scanner.
When formulating a command line, one requiring interaction with a scanner, you must
always indicate the scanner of interest by referencing one of the names listed in the Profiles
section of the properties file. Whether you supply additional command line parameters
depends upon your goal and your programming style. In the event you choose to not pro‐
vide command line options, the parameters associated with your scanner profile provide
default values for any missing options. However, this technique works only if default values
match the parameters used to configure the scanner.
Supported Operations
DLRMUs supports the following operations:
1. Providing help about command line options
2. Querying a scanner.
3. Updating scanner firmware.
The details of these operations will be discussed in subsequent sections.
dlrmus --help
This command should yield output like:
Information
-N Display a list of profile names (with associated interface).
-n Display a list of short model names.
Update a Scanner
-a [...] Select the scanner interface profile. e.g. ‐a RS232Scanner
-r Enable short model numbers on the ‐F option.
e.g. ‐r ‐F "9800i SS"
-F [...] Select the model of the scanner. e.g. ‐F 981234567890
-f [...] Select the firmware to update with. e.g. ‐f .\update.S37
-e [...] Select the Firmware Revision of the firmware file.
The Firmware Revision is four digits. e.g. ‐e 1234
-l [...] Select a custom log file. e.g. ‐l .\log.txt
-v [...] Select the delay between resetting the device and
reconnecting to it (sec.) e.g. ‐v 30. Defaults to 60
-E Leave the device enabled after an update.
USER GUIDE 3
OPERATIONS
Querying a scanner
You can obtain the Information, Health and Statistics (IHS) from a scanner with a command
a simple as:
dlrmus ‐a USBScanner
This works only because the USBScanner profile represents a scanner having a USB‐OEM
interface, so no other parameters are required to establish communication with the scan‐
ner.
Two more examples of querying IHS data are:
dlrmus ‐a RS232Scanner
dlrmus ‐a RS232Scanner ‐c 0 ‐b 9600 ‐d 8 ‐s 1 ‐p n
When you query a scanner for IHS data, the human‐readable data is recorded in the sum‐
mary log. IHS data is also twice recorded in the summary log every time you update the
firmware of a scanner (prior to updating and after updating).
Additionally, IHS data (though in a slightly different form) is recorded in a .PRF file along
side the log files. The name of the file is based upon the scanner’s profile name (e.g.
RS232Scanner.PRF) and its content is tailored to specific clients (that is, not everyone will
find it useful).
Example High Speed Scanner Firmware Update Sequence with Short Model
Number Validation
Please note, the following sequence of commands is better suited for use in a batch file or
script. Here, we simply explain the sequence. See the appendix for an example batch file.
dlrmus -c 1 -p n -d 8 -a RS232Scanner -b 9600 -r -F "9400i SO" -e 0390 -v 30
Validates short model name (9400i SO), communicates at 9600 baud for scanner ID
dlrmus -c 1 -p n -d 8 -a RS232Scanner -b 9600 -t 115200 -r -F "9400i SO" -f
115K.S37 -v 30 Communicates at 9600 for scanner ID, change to 115200 and
switch @115200 after the update
USER GUIDE 5
OPERATIONS
USER GUIDE 7
COMMAND LINE PARAMETER DETAILS
:download_9400i
dlrmus ‐a RS232Scanner ‐c %comport% ‐b 9600 ‐t 115200 ‐r ‐F "9400i SO" –f 115K.s37
dlrmus ‐a RS232Scanner ‐c %comport% ‐b 115200 ‐t 115200 ‐r ‐F "9400i SO" –f
DR9401143.S37
dlrmus ‐a RS232Scanner ‐c %comport% ‐b 115200 ‐t 9600 ‐r ‐F "9400i SO" –f 9600.s37
goto exit
:download_9800i
dlrmus ‐a SCRS232Scanner ‐c %comport% ‐b 9600 ‐t 115200 ‐r ‐F "9800i SS" –f
9800i_115200.s37 ‐v 10
dlrmus ‐a SCRS232Scanner ‐c %comport% ‐b 115200 ‐t 9600 ‐r ‐F "9800i SS" –f
MR21_0494_KRSCO.s37 ‐v 10
goto exit
:exit
USER GUIDE 9
COMMAND LINE PARAMETER DETAILS
www.datalogic.com
Datalogic S.r.l.
Via S. Vitalino, 13 | 40012 Calderara di Reno | Bologna - Italy
Tel. +39 051 3147011 | Fax +39 051 3147205