0% found this document useful (0 votes)
510 views15 pages

OPOS DLRMUS User Guide

Uploaded by

Avi Nash
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
0% found this document useful (0 votes)
510 views15 pages

OPOS DLRMUS User Guide

Uploaded by

Avi Nash
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
You are on page 1/ 15

DATALOGIC REMOTE

MANAGEMENT UTILITY

USER GUIDE

Windows® and Linux Standalone Utility


Datalogic USA, Inc.
959 Terry Street
Eugene, OR 97402
U.S.A.
Telephone: (541) 683-5700
Fax: (541) 345-7140

©2020 Datalogic S.p.A. and /or its affiliates

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

II DATALOGIC REMOTE MANAGEMENT UTILITY


DATALOGIC REMOTE MANAGEMENT
UTILITY

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]

INSTALLATION (WINDOWS & LINUX)


DLRMUs doesn’t require an installer; you must simply unzip the distribution into a directory
having read and write permissions.

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.

2 DATALOGIC REMOTE MANAGEMENT UTILITY


SUPPORTED OPERATIONS

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.

Command Line Options


You can obtain a summary of the available command line options by executing the com‐
mand:

dlrmus --help
This command should yield output like:

DLRMUs, Version=0.5.0.19, Datalogic 2019


--help Show this message

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

Configure the Serial Port


-c [...] Select the port to communicate with. e.g. ‐c 2
-b [...] Select the starting baud rate. e.g. ‐b 115200
-t [...] Select the ending baud rate. e.g. ‐t 9600
-d [...] Select the data bits. Must be 7 or 8.
-p [...] Select the parity. Must be n, e, o, m, or s.
-s [...] Select the stop bits. Must be 1 or 2.
--BCC Enable block check character over Single Cable.

Properties are located at:


C:\Projects\DLRMUs\properties.json

Log files are located at:


C:\ProgramData\Datalogic\Logs\dlrmus

Exiting with code 0

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).

Examples of querying a scanner (various interfaces)


dlrmus ‐a SCRS232Scanner ‐c 5 (Single‐Cable RS232 Scanner, COM 5)
dlrmus ‐a RS232Imager ‐c 18 (USBCOM Scanner, COM 18)
dlrmus ‐a RS232Imager (USBCOM Scanner, using a virtual COM port)
dlrmus ‐a RS232Scanner ‐c 1 ‐p n ‐d 8 (RS232 Scanner, COM 1, No Parity, 8 data bits)
dlrmus ‐c 5 ‐b 115200 ‐a SCRS232Scanner (Single‐Cable RS232 Scanner, COM 5, @115200)
dlrmus ‐a USBHHScanner (USBOEM, Handheld Scanner)

4 DATALOGIC REMOTE MANAGEMENT UTILITY


UPDATING SCANNER FIRMWARE

Updating Scanner Firmware


Updating scanner firmware requires the most complex command lines but, again, the level
of complexity depends upon your goal and programming style. For example, if you’re only
sending a small configuration file to the scanner then you might be able to use a simple
command line like:
dlrmus ‐a RS232Scanner ‐f config.S37
However, if you’ve reconfigured the scanner and want to ensure you’re updating the cor‐
rect scanner with a firmware payload then you might need a more complicated command
line like:
dlrmus ‐a RS232Scanner ‐c 1 ‐p n ‐d 8 ‐b 115200 ‐t 9600 ‐r ‐F "9400i SO" ‐f 9600.S37
‐v 30
The number of possible command lines is very large and cannot be reasonably discussed in
this document. However, the following sections present categorized examples.

Example Scanner Firmware Update


The ‐f option is used to perform a firmware update. The name of the firmware file to be
uploaded follows the ‐f parameter. For example, to update a Single‐Cable RS232 scanner
connected to COM2, the following command may be used:
dlrmus ‐a SCRS232Scanner ‐c 2 ‐f DRxxxxxxxx.S37

Example Scanner Firmware Update with Model Number Validation.


The ‐F option validates the scanners model number (among the regular expressions in the
“Patterns” of the properties file) before updating the firmware. The long model number fol‐
lows the ‐F parameter e.g. ‐F “984‐8”. The ‐f option is used to specify the firmware or config
file to upload. For example, to update any scanner whose model number begins with 86800
and connect to COM2, the following command may be used:
dlrmus ‐a SCRS232Scanner ‐c 2 ‐F 86800 ‐f DRxxxxxxxx.S37

Example Scanner Firmware Update with Short Model Number Validation.


The -r option specifies the use of short model numbers; it must be used in combination
with the ‐F option. The short model number follows the ‐F parameter and it must be
bounded by quotes (e.g. ‐r ‐F “9400i SS”). If the application finds a matching string among
the “ShortName” properties in the properties file then the firmware update will proceed.
For example, to update a scanner with a short model number of 9400i SO and connected to
COM1, the following command may be used:
dlrmus ‐a RS232Scanner ‐c 1 ‐b 9600 ‐r ‐F "9400i SO" ‐f DR9401285.S37

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

dlrmus -c 1 -p n -d 8 -a RS232Scanner -b 115200 -t 115200 -r -F "9400i SO" -f


DR9401285.S37 –E
Communicates at 115200 baud for scanner ID and file download.
Communicates at 115200 for scanner ID and to validate firmware update. It will
reduce the time to upgrade the firmware (~21min)
Scanner will stay enable after upgrade
dlrmus -c 1 -p n -d 8 -a RS232Scanner -b 115200 -t 9600 -r -F "9400i SO" -f
9600.S37 -v 30 
Communicates at 115200 baud for scanner ID and file download.
Communicates at 9600 for scanner ID and to validate baud change.

6 DATALOGIC REMOTE MANAGEMENT UTILITY


APPENDIX A

COMMAND LINE PARAMETER DETAILS


The parameter following -a represents the name of the scanner profile you are going to reference
to obtain communication parameters.
-a You can obtain the list of available profile names using: dlrmus -N
Also, you can add you own profiles to the properties files but you must take care to 1) honor the
JSON file format and 2) backup your files.
The parameter following -f represents the name of the file to be uploaded to the scanner. If the file
is local to the program then you can simply provide the file name (e.g. -f file.ext). Otherwise, you
-f […] should provide a fully qualified file name (e.g. -f c:\tmp\myfiles\file.ext).
Also, while USB-OEM scanners accept only .DAT files, all other scanners accept only .S37 files.
The parameter following the -F is compared against the model number returned by the scanner. All
-F […] digits must match exactly (up to the limit provided by your parameter). The scanner will not be
updated if there is a mismatch.
The parameter following the -F is compared against the list of available “short model names”
found in the Models section of the properties file. The short model name you provide must be
-r -F […] bounded by quotes (e.g. -r -F "9400i SO").
You can obtain the list of available short model names using: dlrmus -n
The parameter following the -e is four digits representing the Firmware Revision of the file you
-e […] intend to upload to the scanner. The scanner will not be updated if the EC Level it returns is
greater-than-or-equal-to the value you provide.
The parameter following the -c indicates the port to be used for serial communication. You can rely
on the default value in the properties file. However, if you insist on defining the parameter on the
command line then the value you provide depends upon whether you are a Windows or Linux user.
-c […] A Windows user need simply provide an integer value representing the COM port number.
A Linux user must specify the device path (e.g. -c /dev/ttyS0)
Finally, with respect to USB-COM devices, it is possible to use virtual COM port behavior. You can
do this by setting “UseVirtualPort” to 1 in the properties file.

USER GUIDE 7
COMMAND LINE PARAMETER DETAILS

Example Batch file


The following batch file is an example of how DLRMUs can be used to target specific scan‐
ners and perform updates across an enterprise with different Datalogic Magellan Scanner
(i.e. Mgl9400, Mgl9800i). This batch file determines the type of scanner, if there is need to
update the firmware based on EC level and send the correct file is one of the two needing
an update or not then loads the appropriate firmware for the scanner found. This batch file
combines many of the DLRMU features to form a very powerful update solution.

• Queries the scanner and gathers Information, Health and Statistics.


• Verifies the responding scanner is one of the two desired models.
• Uses “Short Model Names” and “Model Number Validation”.
• Validates the scanner needs updating. Uses the “EC Level Checking”.
• Checks command status to make decision on which firmware to load.
• Changes baud rate to 115200 to increase the update speed.
• Changes baud rate back to 9600 for customer’s application.(8500Xt only).
set comport=2
dlrmus ‐a RS232Scanner ‐c %comport% ‐b 9600 ‐r ‐F "9400i SO" ‐e 0390
if "%errorlevel%"=="0" goto download_9400i

dlrmus ‐a SCRS232Scanner ‐c %comport% ‐b 9600 ‐r ‐F "9800i SS" ‐e 0340


if "%errorlevel%"=="0" goto download_9800i
goto exit

: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

8 DATALOGIC REMOTE MANAGEMENT UTILITY


LINUX TERMINAL SETUP

Linux Terminal Setup


To grant group permissions to access USB devices:
sudo usermod ‐a ‐G dialout <user>

To set the baud rate to 9600, 8 bits, 1 stop bit, no parity:


stty ‐F /dev/ttyS0 raw
stty ‐F /dev/ttyS0 9600 cs8 ‐cstopb ‐parenb

To set the baud rate to 9600, 8 bits, 1 stop bit, no parity:


stty ‐F /dev/ttyS0 raw
stty ‐F /dev/ttyS0 9600 cs7 ‐cstopb parenb parodd

USER GUIDE 9
COMMAND LINE PARAMETER DETAILS

10 DATALOGIC REMOTE MANAGEMENT UTILITY


©2020 Datalogic S.p.A. and /or its affiliates • All rights reserved • Without limiting
the rights under copyright, no part of this documentation may be reproduced,
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 • Datalogic and the Datalogic logo are registered trade-
marks of Datalogic S.p.A. in many countries, including the U.S. and the E.U.

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

820116700 (Rev A) August 2020

You might also like