All Legacy 9320.zip

Czytnik Samsys RFID MP9320 EPC UHF GEN2

Udało mi się odczytać tagi, niestety nie są to tagi w standardzie EPC Class1Gen2, Przestudiowałem dokumentację i model MP9320 2.7 nie czyta tego standardu, dopiero model 2.8 go obsługuje. Za to mój czytnik MP9320 2.7 dobrze radzi se z tagami ISO18000-6B wykrywa je szybko i bezbłędnie. Co mogę doradzić? Trzeba dobrze dopasować antenę i długość przewodu antenowego, zgodnie z zaleceniami z dokumentacji, w innym przypadku czytnik będzie zgłaszał różne błędy związane z sygnałem i anteną. Jeśli wyjścia antenowe są nie używane to należy je zaekranować nakrętką zaślepiającą. I najważniejsze jest to że jeżeli do wyjść antenowych nie są podłączone anteny, to należy je jak najszybciej ustawić w rejestrach jako nieaktywne, gdyż jak pisze producent grozi to spaleniem multipleksera. W załączniku dokumentacja, jak by ktoś potrzebował.

  • All Legacy 9320.zip
    • MP9320v28Brochure.pdf
    • Forth_Ref_Guide_V1.2.pdf
    • SAMsys Web Password.txt
    • MP9320_2.7_Users_Guide_V6.0.pdf
    • MP9320_2.8_Users_Guide_V1.0.pdf
    • SOAP_Ref_Guide.pdf
    • RAPID_API_Dev_Guide_V1.0.1.pdf
    • Digi Module 9320 Manual.pdf
    • MP9320_2.8e_Users_Guide_V1.0.pdf
    • RFCommandSuite_Users_Guide_V1.1.pdf
    • CHUMP_Ref_Guide_UHF_V6.1.pdf
    • Setup_RFCommandSuite_1_0_18b.msi


Pobierz plik - link do postu

All Legacy 9320.zip > MP9320v28Brochure.pdf

MP9320 v2.8
THE POWER TO CHOOSE

Multi-Protocol
o EPC Gen 2
o ISO 18000-6A, 6B
o UCode 1.19
o Class 1
o Class 0, 0+
Multi-Regional
o MP9320 v2.8 (FCC)
o MP9320 v2.8e (ETSI)
Highest rated reader flexibility
and configurability
New user-friendly RAPID API and
RF Command Suite

EPC Gen 2 RFID READER

EPC Gen 2 Ready
The MP9320 v2.8 reader extends its acclaimed multi-protocol capability
by adding support for EPC Gen 2 tags. The full complement of mandatory
and optional Gen 2 features is provided, making it fully interoperable with
mixed populations of Gen 2 and legacy UHF tags.
Robust RFID Network Performance
The DSP-based software-defined architecture of the MP9320 v2.8 reader
offers a number of feature and performance enhancements designed for
high performance RFID network operation including:
o Support for mixed RFID tag protocol operation including EPC Gen 2,
Class 1, 0, 0+, ISO 18000-6A, 6B, and UCode 1.19 tags;
o Regulatory compliance for use in multi-regional regulatory markets
(MP9320 v2.8 for North America, v2.8e for European and Asian
markets);
o Configurable read/write power settings on each of its four antenna
ports makes the MP9320 v2.8 reader well suited for loading dock
portals, conveyors, tagging stations, and other UHF RFID applications.
Easy-to-Use, Easy-to-Integrate
The Microsoft Windows -based RF Command Suite (RFCS) program
makes it easier than ever to configure the reader for each application.
TM

RAPID (RFID Applications Programming Interface for Developers) is a
new API that simplifies enterprise application integration of SAMSys
RFID readers using familiar Java and Microsoft .NET programming
environments.
A full complement of network connections are provided including serial
RS-232, RS-485, and 10/100 Mbps Ethernet.
And the MP9320 v2.8 is software upgradable to ensure it always stays
current with the latest feature offerings.

877.367.4342 (toll free)
919.281.1541
www.samsys.com

MP 9 3 2 0 v 2 . 8

F E AT U R E S

DESCRIPTION

EPC Gen 2 ready

Provides Gen 2 operational feature set including all mandatory and optional commands
for reading and writing to Gen 2 tags

Multi-protocol operation

Supports multiple tag protocols concurrently (Gen 2, Class 1, 0, 0+, ISO18000-6A, 6B,
UCode 1.19 - simultaneously or individually)

DSP-based software architecture

Enhanced system performance, improved read and write speeds

Four (4) TX/RX antenna ports with individually
adjustable power settings and sensitivity

Well suited for loading dock portal and conveyor applications

Multi-regional regulatory compliance:

Compliant with North American (FCC) regulatory requirements (MP9320 v2.8e for
European and Asian compliance)

Full network connectivity

RS-232, RS-485, 10/100 Mbps Ethernet connections

Four (4) digital input / four (4) digital output lines

Integrated ability to sense external triggers and control actuators enhances
performance in multi-reader environments

Unique label applicator features

Gated tag operation, write/verify, dynamic power boost features for high speed label
applicators

RF Command Suite

Easy to set up using MS Windows-based configurator

RAPID API

New API makes enterprise applications integration capability easy using Java and
Microsoft .NET development platforms

Firmware upgradeable

Keeps the reader current with latest firmware updates

The MP9320 v2.8 reader is
supported by the SAMSys TruBlue

S PECIFICATIONS
Frequency

902-928 MHz

Gen 2 assurance of interoperability

RF Power

4W EIRP

between EPC Global, ISO and other

Antenna

Four SMA connectors

Electrical Power

15 Vdc, 3A

popular UHF RFID tags.

world-leading provider of RFID

110-240 VAC Input

Communication Ports

About SAMSys
SAMSys Technologies, Inc. is a

Power Supply

RS-232, RS-485, 10/100 Mbps Ethernet

Digital Input/Output

Four digital input lines, four digital output lines

Case Material

Aluminum

Dimensions

5 in x 7 in x 9.5 in (127 mm x 178 mm x 241 mm)

Weight

(4 lbs.) 1.8 kg

reader solutions designed to simplify

Operating Temperature

-4° F to 104° F (-20° C to 40° C)

the installation and ensure the robust

Operating Humidity

5-95% relative, noncondensing

performance of the overall RFID
infrastructure.

Storage Temperature

-40° F to 185° F (-40° C to 85° C)

Mounting

Horizontal or vertical orientation

Regulatory Compliance

FCC Part 15

SAMSys Technologies, Inc. o 2525 Meridian Parkway, Suite 60 o Durham NC, 27713
Phone: 919-281-1541 / Toll free: 877-367-4342 o Fax: 919-281-1551
E-mail: samsys@samsys.com
THE POWER TO CHOOSE

Web: www.samsys.com
Specifications subject to change without notice. SAMSys is a trademark of SAMSys, Inc. or it subsidiaries in the United
States and other countries. (C) Copyright 2005 SAMSys, Inc. All rights reserved.


All Legacy 9320.zip > Forth_Ref_Guide_V1.2.pdf

Reference
Guide
SAMSys Forth
Programming Language

SAMSys
SAMSys Forth Programming Language
Reference Guide
First Edition (March 2004)
(C) Copyright 2003 SAMSys Technologies, Inc. All Rights Reserved.
Disclaimer and Limitation of Liability
The content of this manual is for information use only and is subject to change without notice. SAMSys assumes
no responsibility or liability for any errors or inaccuracies that may appear in this publication. No part of this
manual may be reproduced in any form or by any means, electronic, mechanical, recording, or otherwise, without
the prior written permission of SAMSys.
SAMSys products are not designed, intended, authorized or warranted to be suitable for life support applications
or any other life critical applications which could involve potential risk of death, personal injury, property damage,
or environmental damage.
About SAMSys
SAMSys is the world leader in the design and supply of Radio Frequency Identification (RFID) hardware
solutions for high volume pallet and reusable container tracking applications in global logistics management,
materials handling, and supply chain industries. SAMSys is a public company listed on the Canadian Venture
Exchange under the symbol SMY.
SAMSys Technologies, Inc.
44 East Beaver Creek Rd., Unit 11
Richmond Hill, Ontario L4B 1G8 Canada
Phone: (905) 707-0404
Toll Free: (877) 463-6546
Fax: (905) 707-9944
E-mail: samsys@samsys.com
Web: www.samsys.com
Part Number: HI471-FR-RG-V1.2

Trademarks
SAMSys is a trademark of SAMSys Technologies, Inc.
HyperTerminal(R) is a registered trademark of Hilgraeve, Inc.
Other company, product or service names appearing in this manual may be trademarks or service marks of their
respective owners.

FORTH Reference Guide

Contents
Chapter 1 - Introduction . . . . . . . . . . . . . . . . . . . . . . 1
Forth Programming Overview . . . . . . . . . . . . . . . . 2
SAMSys Forth Language Structure . . . . . . . . . . . . 8
Chapter 2 - Writing Programs . . . . . . . . . . . . . . . . 17
Defining Simple Forth Words . . . . . . . . . . . . . . . 18
Short Forth Routines . . . . . . . . . . . . . . . . . . . . . . 20
Chapter 3 - Variable Functions . . . . . . . . . . . . . . . 23
! (Set Variable Value) . . . . . . . . . . . . . . . . . . . . . 24
@ (Get Variable Value) . . . . . . . . . . . . . . . . . . . . 25
CreateIntVar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
CreateStrVar . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
GetNumber . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
GetString . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
SetNumber . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
SetString . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
Chapter 4 - String Functions . . . . . . . . . . . . . . . . . 33
CAT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
EQ . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
Eval . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
EvalToString . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
ExpandInlineForth . . . . . . . . . . . . . . . . . . . . . . . . 38
GetPostValue . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
FREE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
Load . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
LoadBlock . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
LoadFile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
NEQ . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
i

FORTH Reference Guide

SCAT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
SDUP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
StrLen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
SWORDS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
Split . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
StrStr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
StrTok . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
SerialPuts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
Chapter 5 - Mathematical Functions . . . . . . . . . . . 55
+ (Add) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56
++ (Increment) . . . . . . . . . . . . . . . . . . . . . . . . . . . 57
- (Subtract) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58
* (Multiply) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59
/ (Divide) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60
& lt; (Less Than) . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61
& gt; (Greater Than) . . . . . . . . . . . . . . . . . . . . . . . . . 62
== (Equality) . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63
!= (Numeric Non-Equality) . . . . . . . . . . . . . . . . . 64
& lt; & lt; (Shift Left) . . . . . . . . . . . . . . . . . . . . . . . . . . . 65
& gt; & gt; (Shift Right) . . . . . . . . . . . . . . . . . . . . . . . . . . 66
% (Modulo) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67
& (Bitwise And) . . . . . . . . . . . . . . . . . . . . . . . . . . 68
& & (Logical And) . . . . . . . . . . . . . . . . . . . . . . . . 69
^ (Bitwise Exclusive Or) . . . . . . . . . . . . . . . . . . . 70
| (Bitwise Or) . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71
|| (Logical Or) . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72
NOT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73

ii

FORTH Reference Guide

Chapter 6 - Stack Functions . . . . . . . . . . . . . . . . . . 75
& gt; R (Return Stack Push) . . . . . . . . . . . . . . . . . . . . 76
. (Print) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77
.H (Print Hex) . . . . . . . . . . . . . . . . . . . . . . . . . . . 78
.S (Stack Print) . . . . . . . . . . . . . . . . . . . . . . . . . . . 79
# (Stack Clear) . . . . . . . . . . . . . . . . . . . . . . . . . . . 80
DROP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81
DUP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82
Over . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83
Peek . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84
Peekb . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85
Pick . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86
Poke . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87
Pokeb . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88
PushErrorMessage . . . . . . . . . . . . . . . . . . . . . . . . 89
R & gt; (Pop Return Stack) . . . . . . . . . . . . . . . . . . . . . 90
Reverse . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91
SPick . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92
StacksAsHTML . . . . . . . . . . . . . . . . . . . . . . . . . . 93
Swap . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94
Chapter 7 - Conversion Functions . . . . . . . . . . . . . 95
GetHexByte . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96
ByteToHex . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97
ToHexStr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98
ToInt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99
ToStr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100
Chapter 8 - Dictionary Functions . . . . . . . . . . . . . 101
DictionaryCount . . . . . . . . . . . . . . . . . . . . . . . . . 102
DictionaryEntry . . . . . . . . . . . . . . . . . . . . . . . . . 103
EntryName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104
Words . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105
iii

FORTH Reference Guide

Chapter 89- Digital I/O Functions . . . . . . . . . . . . 107
DIOGet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108
DIOGetNumPorts . . . . . . . . . . . . . . . . . . . . . . . 109
DIOGetPortConfig . . . . . . . . . . . . . . . . . . . . . . . 110
DIOGetPortSize . . . . . . . . . . . . . . . . . . . . . . . . . 111
DIOPortGet . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112
DIOPortGetDirection . . . . . . . . . . . . . . . . . . . . . 113
DIOPortSet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114
DIOPortSetDirection . . . . . . . . . . . . . . . . . . . . . 115
DIOSet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116
Chapter 10 - Tag Functions . . . . . . . . . . . . . . . . . 117
GetChumpTagElement . . . . . . . . . . . . . . . . . . . 118
GetTagFormatInfo . . . . . . . . . . . . . . . . . . . . . . . 119
TagGetLockBlockStatus . . . . . . . . . . . . . . . . . . . 120
TagGetSysInfo . . . . . . . . . . . . . . . . . . . . . . . . . . 121
TagHalt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122
TagLastRead . . . . . . . . . . . . . . . . . . . . . . . . . . . 123
TagLastWrite . . . . . . . . . . . . . . . . . . . . . . . . . . . 124
TagLockAFI . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125
TagLockBlock . . . . . . . . . . . . . . . . . . . . . . . . . . 126
TagLockDSFID . . . . . . . . . . . . . . . . . . . . . . . . . 127
TagRead . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128
TagReadDetectInitRoundAll . . . . . . . . . . . . . . . 129
TagReadDetectNewRound . . . . . . . . . . . . . . . . 130
TagReadStats . . . . . . . . . . . . . . . . . . . . . . . . . . . 131
TagReadUnselect . . . . . . . . . . . . . . . . . . . . . . . . 132
TagReadUserData . . . . . . . . . . . . . . . . . . . . . . . 133
TagReset . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 134
TagSelect . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 135
TagStackArrival . . . . . . . . . . . . . . . . . . . . . . . . . 136
TagStackArrival? . . . . . . . . . . . . . . . . . . . . . . . . 137
iv

FORTH Reference Guide

TagStackClear . . . . . . . . . . . . . . . . . . . . . . . . . . 138
TagStackClearAll . . . . . . . . . . . . . . . . . . . . . . . . 139
TagStackDeparture? . . . . . . . . . . . . . . . . . . . . . . 140
TagStackFind . . . . . . . . . . . . . . . . . . . . . . . . . . . 141
TagStackPeek . . . . . . . . . . . . . . . . . . . . . . . . . . . 142
TagStackPop . . . . . . . . . . . . . . . . . . . . . . . . . . . 143
TagStackPull . . . . . . . . . . . . . . . . . . . . . . . . . . . 144
TagStackPush . . . . . . . . . . . . . . . . . . . . . . . . . . . 145
TagStackRead . . . . . . . . . . . . . . . . . . . . . . . . . . 146
TagStackSize . . . . . . . . . . . . . . . . . . . . . . . . . . . 147
TagStackWrite . . . . . . . . . . . . . . . . . . . . . . . . . . 148
TagWakeup . . . . . . . . . . . . . . . . . . . . . . . . . . . . 149
TagWrite . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150
TagWriteAFI . . . . . . . . . . . . . . . . . . . . . . . . . . . 151
TagWriteDSFID . . . . . . . . . . . . . . . . . . . . . . . . . 152
TagWriteInc . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153
TagWriteIncEnd . . . . . . . . . . . . . . . . . . . . . . . . . 154
TagWriteStats . . . . . . . . . . . . . . . . . . . . . . . . . . 155
TagWriteUserData . . . . . . . . . . . . . . . . . . . . . . . 156
TimeFromStr . . . . . . . . . . . . . . . . . . . . . . . . . . . 157
TimeToStr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 158
Chapter 11 - Reader Functions . . . . . . . . . . . . . . . 159
AttachReader . . . . . . . . . . . . . . . . . . . . . . . . . . . 160
ConfigurationVarGet . . . . . . . . . . . . . . . . . . . . . 161
ConfigurationVarSet . . . . . . . . . . . . . . . . . . . . . 162
GetRdrAddr . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163
GetReaderInfo . . . . . . . . . . . . . . . . . . . . . . . . . . 164
GetReaderPolledMode . . . . . . . . . . . . . . . . . . . . 165
NumReaders . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166
ReaderAddress . . . . . . . . . . . . . . . . . . . . . . . . . . 167
ReaderPoll . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 168
ReaderVersion . . . . . . . . . . . . . . . . . . . . . . . . . . 169
v

FORTH Reference Guide

RegisterReader . . . . . . . . . . . . . . . . . . . . . . . . . . 170
SetReaderInfo . . . . . . . . . . . . . . . . . . . . . . . . . . 171
SetReaderPolledMode . . . . . . . . . . . . . . . . . . . . 172
Chapter 12 - ICCM Functions . . . . . . . . . . . . . . . . 173
ICMBeep . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 174
ICMClearScreen . . . . . . . . . . . . . . . . . . . . . . . . 175
ICMLoad . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 176
ICMLoadCGI . . . . . . . . . . . . . . . . . . . . . . . . . . . 177
ICMWriteText . . . . . . . . . . . . . . . . . . . . . . . . . . 178
ICMOpen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 179
LCGetScreen . . . . . . . . . . . . . . . . . . . . . . . . . . . 180
LCSetScreen . . . . . . . . . . . . . . . . . . . . . . . . . . . 181
LCWriteText . . . . . . . . . . . . . . . . . . . . . . . . . . . 182
RedirectString . . . . . . . . . . . . . . . . . . . . . . . . . . 183
SerialInit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 184
Chapter 13 - Utility Functions . . . . . . . . . . . . . . . 185
CR . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 186
CRDelim . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 187
Chmod . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 188
Coreleft . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 189
DoEval . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 190
EvalIfNotDefined . . . . . . . . . . . . . . . . . . . . . . . . 191
Endl . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 192
FGetLine . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 193
FileTime . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 194
CTime . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 195
GetTime . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 196
Quit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 197
SaveFile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 198
SetTime . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 199
Sleep . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 200
vi

FORTH Reference Guide

Sleep_ms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 201
UnLink . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 202
WebPickFile . . . . . . . . . . . . . . . . . . . . . . . . . . . . 203
WebPickReader . . . . . . . . . . . . . . . . . . . . . . . . . 204
Version . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 205

vii

FORTH Reference Guide

viii

Chapter 1
Introduction
This chapter provides a general overview of the SAMSys Forth
programming language. Topics discussed in this chapter include
the following:
o

Forth Programming Overview

o

SAMSys Forth Language Structure

1

Forth Reference Guide

Forth Programming Overview
What is Forth?
Forth is a simple programming language that was originally
developed by Charles Moore for small, embedded control
systems. The first program was written in 1970 and the first fullscale application was implemented in 1971 to control the
National Radio Astronomy Observatory's 11-meter radio
telescope in Arizona.
Forth is a stack-based language. The stack concept is similar to a
stack of blocks with numbers. Blocks are added or removed from
the top of the stack using a "last-in, first-out" methodology. The
blocks can also be duplicated and rearranged.
Forth is an interpretive language and the syntax is very simple
compared to most higher-level computer languages. This syntax
has been described as a "bunch of words with spaces between
them."
In Forth, each word is the same as a function or subroutine in a
language like "C". Forth words operate on the stack that contains
numbers or addresses and are executed in the order they appear in
the code.
Forth is somewhat unconventional in that it is extensible. In other
words, the programming process in Forth consists of defining
new words or new commands in the language. These words are
defined in terms of previously defined words. Such words are
called "high level definitions". Alternatively, new words can also
be defined with primitives such as assembly language routines.

2

Introduction

Forth Notation
The following is a typical addition operation:
25+
In this addition example, the following operations are performed:
1.
2.
3.
4.
5.
6.

Push 2 onto the stack.
Push 5 onto the stack.
Read the "+" operator.
Pop the top two values off of the stack.
Add the two values
Push the resulting 7 back onto the stack.
7

The next example contains both addition and multiplication:
1.
2.
3.
4.
5.
6.
7.

345+*
Push 3 onto the stack.
Push 4 onto the stack
Push 5 onto the stack
Read the "+" operator.
Pop the two values off the stack
Add the two values
Push the resulting 9 onto the stack.

Now, the stack contains:
39
8.
9.
10.
11.

Read the "*" operator.
Pop the top two values off the stack.
Multiply the two values.
Push the resulting 27 back onto the stack.
27

3

Forth Reference Guide

Forth Structure
Although not a classical structured language, Forth adheres to the
following principles of structured programming:
o

Words must be defined before they can be used.

o

Program flow can only be sequential, conditional, or
iterative.

o

Programs are developed with small independent modules.

Dictionary
As described earlier, Forth words and functions can be defined
using previously defined words or assembly language routines.
These functions are similar to subroutines or macros. When a
word or function is defined, the new word is added to the master
list and the word definition is added to a dictionary.
When a Forth word or function is encountered, the dictionary is
searched for the definition. The function is either executed or a
reference is compiled into a new definition.
The dictionary occupies most of the memory used by the system.
It consists of a threaded list of variable-length items, each of
which defines a word. The content of each definition depends on
the type of word such as a data item, constant, or sequence of
operations.
Words and functions are added to the dictionary by defining
operators. The most common operator is the colon ":". When a
colon is executed, a dictionary entry is constructed for the
following word and the word is compiled. The definition is
terminated by a semicolon ";".

4

Introduction

The following is an example function definition for calculating
the square of a number:
: square DUP * ;
OK
22 square .
484
OK
When a name entry (or definition head) is compiled into the
dictionary, it has a pointer to the head of the previous word in the
dictionary. The name of the new word (in this case "square") is
then placed in the dictionary. Finally, a pointer to the colon ":"
routine is compiled into the dictionary as the first part of the
definition. This is the pointer to the code that performs the
interpretation of the body of the definition.
Stacks
As stated earlier, Forth has two push-down stacks, or Last-In,
First-Out lists. These stacks provide communication between
Forth words and control the logical flow.
Although the structure of both stacks is the same, they have very
different uses. The programmer interacts most directly with the
Data Stack. This stack holds the arguments being passed between
words. This replaces the parameter lists used by higher level
languages. The second stack or Return Stack holds return
addresses for nested definitions.
In the following example, the DUP function is used to duplicate
the number on top of the stack. The "*" operator multiplies the
two numbers and pushes the result onto the stack. The period "."
operator displays the top value on the stack.

5

Forth Reference Guide

The following example uses the SWAP function to swap two
values on the stack.
2 3 DUP * .
9
2
OK
SWAP DUP * .
4
9
OK
*.
36
OK

How is SAMSys Forth Different?
SAMSys Forth is based on Forth 79 and in most cases uses the
same syntax and conventions. However, the following extensions
are implemented in SAMSys Forth.
Case
SAMSys Forth words, functions, and variables are not case
sensitive (DUP, Dup, dup are the same command).
String Handling
Strings are created with SAMSys Forth by placing text inside
double quotes ("xxxx"). This pushes a pointer to the string onto
the stack.

6

Introduction

The following functions are also implemented:
.S - displays the string contents at the top of the stack
SDUP - duplicates a string (use instead of DUP)
FREE - removes a string (use instead of DROP)
The follow example illustrate simple string handling:
"Hello" TYPE
Hello
OK
1 2 "Hello" .S
1050869764 [Hello]
2
1
OK
In the previous example, the numbers 1 and 2 are pushed onto the
stack. Next, the pointer to the string "Hello" is pushed onto the
stack. The operator ".S" displays the contents of the stack.
SDUP .S
1050738692 [Hello]
1050869764 [Hello]
2
1
OK
The SDUP function duplicates the string on top of the stack.

7

Forth Reference Guide

SAMSys Forth Language Structure
Variables
Variables are a place to store string and numeric values. The !
operator stores a value to a variable and @ retrieves a value from
a variable. The variable WebHostName is a pre-defined variable
that is the friendly name of a concentrator. ConcentratorNumber
is the number of the concentrator .
To get the name of the concentrator:
WebHostName @ .S
1050869764 [HDIC1]
OK
To set the name of the concentrator:
" My New Name " WebHostName !
OK
WebHostName @ TYPE
My New Name
OK
This stores the string " My New Name " to the variable
WebHostName.

8

Introduction

Functions
Functions can be built in or defined by colon definitions. To
define a new Forth function use a colon definition. The following
example computes the square of number:
: square DUP * ;
OK
22 square .
484
OK
The colon starts the definition, with the name of the function
following the colon. The definition is terminated with a semicolon.

Control Structures
As stated earlier, Forth is a structured language. However, Forth
does not have a branching function such as GOTO. Forth does
have control words that can be used for control structures. The
most common control words are as follows:
o

IF

o

ELSE

o

THEN

o

BEGIN

o

UNTIL

o

WHILE

o

REPEAT

o

DO

o

LOOP

9

Forth Reference Guide

These control words can be used to construct simple control
structures such as:
IF ... THEN

IF ... ELSE ... THEN
BEGIN ... UNTIL
BEGIN ... WHILE ... REPEAT
DO ... LOOP
All the standard control structures can be used. However, they
must be defined inside a colon function.
IF THEN
The general form of the IF THEN structure is:
conditional words
IF
& lt; "true" words & gt;
THEN
The conditional words are executed. IF pops the value off the top
of the stack and tests it. If it is non-zero then the & lt; "true" words & gt;
are executed.

10

Introduction

IF ELSE THEN
The general form of the IF THEN ELSE structure is:
: & lt; function name & gt;
& lt; conditional words & gt;
IF
& lt; "true" words & gt;
ELSE
& lt; "false" words & gt;
THEN
The conditional words are executed. IF pops the value off the top
of the stack and tests if it is non-zero. If so, the "true" words are
executed. If the value is zero then the "false" words are executed.
In the following example, the "negative" function is first defined
as a test for negative numbers. If negative numbers are found,
Negative is printed to the console. Otherwise, Positive is
printed.
: negative 0 & lt; IF " Negative " TYPE ELSE
" Positive " TYPE THEN ;
OK
-2 negative
Negative
OK
2 negative
Positive
OK

11

Forth Reference Guide

DO LOOP
The DO LOOP allows repetitive operations. The general form of
the DO LOOP structure is:
: & lt; function name & gt;
& lt; end count & gt; & lt; start Count & gt; DO
& lt; repeated function & gt;
LOOP
Where the number of loops = start count - end count - 1.
In the following example, the function "echo" is first defined as 0
DO SDUP TYPE LOOP. For example:
: echo 0 DO SDUP TYPE LOOP;
OK
Using the previously defined "Echo" function, a command can be
entered to type the string "Hello" three times.
"Hello" 3 echo
Hello
Hello
Hello
OK
NOTE: The "echo" function leaves the original "Hello" on the stack.

12

Introduction

DO LOOP Index Counter
The reserved word "I" is used to return the current loop count.
In the following example, the function "countUp" is first defined
as a DO LOOP index counter from 0 to 5.
: countUp 5 0 DO I LOOP ;
OK
countUp
0
1
2
3
4
OK

13

Forth Reference Guide

Nested DO LOOP Index Counters
If you have two nested loops, use the reserved word "J" to return
the outer loop count and "I" to return the inner loop count.
If you have three nested loops, use the reserved word "K" to
return the outer loop count, use "J" for the middle loop count, and
use "I" for the inner loop count.
NOTE: On the console, the colon definition must be typed in as one
continuous line.

In the following example, the function "testIJK" is first defined
as a three-level loop with index counters.
: testIJK 2 0 DO 2 0 DO 3 0 DO I ToStr "
" CAT J ToStr CAT " " CAT K ToStr CAT TYPE
LOOP LOOP LOOP ;
OK
NOTE: In the previous example, ToStr converts the number to a string, " "
adds a space between the numbers, CAT concatenates the
numbers, and TYPE outputs the numbers to the console.

testIJK
000
100
200
...
211
OK

14

Introduction

BEGIN UNTIL
The general form of the Begin Until loop is:
: & lt; function name & gt;
BEGIN
& lt; words & gt;
& lt; condition & gt; UNTIL
This function repeats executing the & lt; words & gt; until & lt; condition & gt;
evaluates to a non-zero value. For example:
: testLoop BEGIN DUP . 1 - DUP 0 & lt; UNTIL ;
OK
6 testLoop
6
5
4
3
2
1
0
OK

15

Forth Reference Guide

BEGIN WHILE REPEAT
The general form of the while loop is:
: & lt; function name & gt;
BEGIN & lt; condition & gt; WHILE
& lt; words & gt;
REPEAT
The & lt; words & gt; are repeated until the condition evaluates to a zero
value.
: testWhile 2 BEGIN DUP 1024 & lt; WHILE DUP
. 2 * REPEAT ;
OK
testWhile
2
4
8
16
32
64
128
256
512
OK

16

Chapter 2
Writing Programs
This chapter provides instructions for writing basic Forth
programs. Sample programs are also provided. Information
provided in this chapter includes the following:
o

Defining Simple Forth Words

o

Short Forth Routines

17

Forth Reference Guide

Defining Simple Forth Words
This section provides sample Forth routines to aid in defining
simple Forth words and functions.
Sum Four Numbers
The following routine is Forth at its most basic. This program
defines the word Sum4 which returns the sum of the top four
numbers on the stack.
: Sum4 + + + ;
In this example, Sum4 is defined as three add functions. Each
"+" adds the next number on the stack to the previous total. The
final total is left on the top of the stack.
Return the Max of N Numbers
The following routine defines the word MaxN. This word returns
the Max (or largest) number from the top N numbers on the stack.
:
: MaxN
1 do
over

over & lt; if swap then

drop
loop ;
In this example, a do loop is set up to compare the top two
numbers. After the comparison, the smaller number is dropped
(removed) from the stack. The process continues until the
maximum value is the only value remaining on the stack.

18

Writing Programs

Print a Conditional Message
The following routine defines the word greeting. This word
prints either "Hello" or "Good-bye" depending on the condition
(0 or 1).
: greeting 0 == if " Hello " else " Goodbye " then type cr ;
In this example, an If...Else...Then structure is used to
set up a conditional print. If the condition = 0, "Hello" is printed.
If the condition = 1, "Good-bye" is printed. A carriage return is
then printed.
Pick a String
The following routine defines the word Spick. This word works
just like Pick, but for strings. As a result, the sdup function is
used for duplication.
: spick pick sdup swap drop;

19

Forth Reference Guide

Short Forth Routines
DO Loop Array Indexer
This routine uses a nested DO loop to step through the indexes of
a two-dimensional array.

: INDEXES

( rows columns -- )

SWAP

( columns rows )

0 ?DO

\ For number of rows

CR

\ CR goes to next line

DUP

\ Duplicate columns

0 ?DO

\ Number of rows

J.

\ Row index

I.

\ Column index

SPACE
LOOP
LOOP ;
3 4 INDEXES

20

Writing Programs

Fibonacci Numbers
This routine uses a BEGIN UNTIL loop to return the first X
numbers in the Fibonacci series.
: fib { x -- }
1 dup .

\ local index variable x
\ print initial values

1 dup .
begin
over over +

\ add prev 2 #s in seq

dup . rot drop \ add new number to stack,
drop bottom number
x 1- dup - & gt; x 3 & lt;
\ dec x, exit if x & lt; 3
until
drop drop
\ drop top 2 #s off stack
;

21

Forth Reference Guide

22

Chapter 3
Variable Functions
This chapter provides descriptions of Forth's variable functions.
Functions described in this chapter include the following:
o Set Variable Value
o Get Variable Value
o Create Integer Variable
o Create String Variable
o Get Number Variable Value
o Get String Variable Value
o Set Number Variable Value
o Set String Variable Value

23

Forth Reference Guide

! (Set Variable Value)
Name
Set Variable Value
Description
Sets the value of a variable.
Signature
[ Value VariableIndex a ]
Parameters
Name

Dir

Description

Value

Numeric

In

New value for the variable.

VariableIndex

24

Type
Numeric

In

Index of the variable in the
dictionary.

Variable Functions

@ (Get Variable Value)
Name
Get Variable Value
Description
Returns the value of a variable.
Signature
[ VariableIndex a Value ]
Parameters
Name

Type

Dir

Description

VariableIndex

Numeric

In

The index of the variable in the
dictionary.

Value

Numeric

Out The value of the variable.

25

Forth Reference Guide

CreateIntVar
Name
Create Integer Variable
Description
Creates a new integer variable on the stack.
Signature
[ "Name" a ]
Parameters
Name

Dir

Description

Name

26

Type
String

In

Name of the new integer variable
to create.

Variable Functions

CreateStrVar
Name
Create String Variable
Description
Creates a new string variable on the stack.
Signature
[ "Name" a ]
Parameters
Name

Type

Dir

Description

Name

String

In

Name of the new string variable to
create.

27

Forth Reference Guide

GetNumber
Name
Get Number Variable Value
Description
Returns the value of a number variable.
Signature
[ "VariableName" a Value ]
Parameters
Name

Dir

Description

VariableName String

In

Name of the number variable in the
dictionary.

Value

28

Type

Out Value of the number variable.

Numeric

Variable Functions

GetString
Name
Get String Variable Value
Description
Returns the value of a string variable.
Signature
[ "VariableName" a "Value" ]
Parameters
Name

Type

Dir

Description

VariableName String

In

Name of the string variable in the
dictionary.

Value

Out Value of the string variable.

String

29

Forth Reference Guide

SetNumber
Name
Set Number Variable Value
Description
Sets the value of a numeric variable.
Signature
[ Value "VariableName" a ]
Parameters
Name

Type

Dir

Description

Value

Numeric

In

New variable value.

In

Variable index in dictionary.

VariableName String

30

Variable Functions

SetString
Name
Set String Variable Value
Description
Sets the value of a string variable.
Signature
[ Value "VariableName" a ]
Parameters
Name

Type

Dir

Description

Value

Numeric

In

New variable value.

In

Variable index in dictionary.

VariableName String

31

Forth Reference Guide

32

Chapter 5
String Functions
This chapter provides descriptions of Forth's string functions.
Functions described in this chapter include the following:
o

Concatenate

o

String Equality

o

Evaluate String

o

Evaluate and Convert

o

Expand Inline Forth

o

Get Post Value

o

String Remove

o

Read Text File

o

Read 1000 Byte Block

o

Load File

o

String Inequality

o

Concatenate Integer to String

o

Duplicate String

o

String Length

o

String Search

o

String Split

o

Substring in String

o

String Token

o

Print String (to COM Port)

o

Print String

33

Forth Reference Guide

CAT
Name
Concatenate
Description
Concatenates the two strings on the top of the stack.
Signature
[ "s1" "s2" a "s1s2" ]
Parameters
Name

Dir

Description

s1

String

In

String

s2

String

In

String

s1s2r

34

Type

String

Out Concatenation of the two strings.

String Functions

EQ
Name
String Equality
Description
Tests the equality relationship between the two top stack items.
Returns 1, if the two strings are equal.
Returns 0, if the two strings are not equal.

NOTE: Use EQ for strings only. Use == for numbers.

Signature
[ "s1" "s2" a b ]
Parameters
Name

Type

Dir

Description

s1

String

In

String

s2

String

In

String

b

Numeric

Out s1 = s2.
1 if s1 equals s2.
0 if s1 is not equal to s2.

35

Forth Reference Guide

Eval
Name
Evaluate String
Description
Evaluate the string on the top of the stack as Forth expression.
Signature
[ "Forth" a ]
Parameters
Name

Dir

Description

Forth

36

Type
String

In

Forth commands as a string.

String Functions

EvalToString
Name
Evaluate and Convert
Description
Converts a variable or Forth word to a string.
If the string is a command, the name is searched in the dictionary.
If the name is found, the command is executed.
If the string is a variable, the value is placed on the stack. If
necessary, numeric values are converted to a string.
Signature
[ "Cmd" a "Result" ]
Parameters
Name

Type

Dir

Description

Cmd

String

In

Name of the Forth word to execute
or name of variable.

Result

String

Out Output of the function or value of
the variable converted to a string.

37

Forth Reference Guide

ExpandInlineForth
Name
Expand Inline Forth
Description
Expands inline Forth statements embedded in strings.
Signature
[ "Unexpanded" a "Expanded" ]
Parameters
Name

Dir

Description

Unexpanded

String

In

String with enbedded Forth
statements (delimited by %...%).

Expanded

38

Type

String

Out Same string with commands
replaced by values returned by
executing the commands.

String Functions

GetPostValue
Name
Get Post Value
Description
Returns the value of a POST key-value pair.

NOTE: This function should only be called within a CGI word.

Signature
[ "Key" a "Value" ]
Parameters
Name

Type

Dir

Description

Key

String

In

Key to look up.

Value

String

Out Value of the key as a string. Empty
string if key not found.

39

Forth Reference Guide

FREE
Name
String Remove
Description
Removes the top stack item. Also, frees the memory associated
with the string.

NOTE: Use FREE for strings only. Use DROP for numbers.

Signature
[ "S" a ]
Parameters
Name

Dir

Description

S

40

Type
String

In

String to be removed.

String Functions

Load
Name
Read Text File
Description
Reads the contents of the text file "filename" and parses the
contents as Forth.
Signature
[ "filename" a ]
Parameters
Name

Type

Dir

Description

filename

String

In

Name of the file to read.

41

Forth Reference Guide

LoadBlock
Name
Read 1000 Byte Block
Description
Reads the specified 1000 byte block of the text file "filename"
and pushes the contents as a single string onto the stack.
Signature
[ "filename" blocknumber a "blockContents"
success ]
Parameters
Name

Type

Dir

Description

filename

String

In

Name of the file to read.

blocknumber

Numeric

In

Index of 1000 byte block.

blockContents String

Out String that was read (NULL if
nothing read).

success

Out 1 = Success.

Numeric

0 = Failure (EOF or bad filename).

42

String Functions

LoadFile
Name

Load File
Description
Reads the contents of the text file "filename" and pushes the
contents as a single string onto the stack.
Signature
[ "filename" a "fileContents" ]
Parameters
Name

Type

Dir

Description

filename

String

In

Name of the file to read.

fileContents

String

Out Contents of the file as a single
string.

43

Forth Reference Guide

NEQ
Name
String Inequality
Description
Tests the inequality of two string quantities on the top of the
stack.
Returns 1, if the two strings are not equal.
Returns 0, if the two strings are equal.

Signature
[ "s1" "s2" a b ]
Parameters
Name

Type

Dir

Description

s1

String

In

String

s2

String

In

String

b

Numeric

Out 1 if s1 is not equal to s2.
0 if s1 equals s2.

44

String Functions

SCAT
Name
Concatenate Integer to String
Description
Concatenates an integer to a string with an intervening space
added.
Signature
[ "S" N a "S1bn" ]
Parameters
Name

Type

Dir

Description

S

String

In

String

N

Numeric

In

Integer

S1bn

String

Out Concatenation of integer and string
with space.

45

Forth Reference Guide

SDUP
Name
Duplicate String
Description
Duplicates the top stack item.

NOTE: Use SDUP for strings only. Use DUP for numbers.

Signature
[ "S" a "S" "S" ]
Parameters
Name

Dir

Description

S

String

In

Value

S

String

Out Value

S

46

Type

String

Out Value

String Functions

StrLen
Name
String Length
Description
Returns the length of the string.
Signature
[ "String" a Length]
Parameters
Name

Type

Dir

Description

String

String

In

String

Length

Numeric

Out Length of string.

47

Forth Reference Guide

SWORDS
Name
String Search
Description
Searches the entire list of definitions in the dictionary and outputs
the match to the console. The match is case sensitive.
Signature
[ "StringToMatch" a ]
Parameters
Name

Type

StringToMatch String

48

Dir

Description

In

String to search.

String Functions

Split
Name
String Split
Description
Splits a string into seprate substrings at the whitespaces and
pushes each word onto the stack. All text in parenthesis (xxx) is
ignored.
Signature
[ "string" a "strings"]
Parameters
Name

Type

Dir

Description

string

String

In

String to be split.

strings

String

Out Substrings (words) to be pushed
onto the stack.

49

Forth Reference Guide

StrStr
Name
Substring in String.
Description
Searches for a substring in a string. If found, returns the tail of the
string starting with the match.
Signature
[ "String" "Substring" a "Match" ]
Parameters
Name

Dir

Description

String

String

In

String to search.

Substring

String

In

Substring to search.

Match

50

Type

String

Out Match + rest of string.'''' if no match
found.

String Functions

StrTok
Name
String Token
Description
Tokenize a string. Breaks apart a string depending on the
delimiter.
Signature
[ "String" "Delimiters" a "RemainingString"
"Token" ]
Parameters
Name

Type

Dir

Description

String

String

In

String to search

Delimiters

String

In

List of characters between tokens

RemainingString String

Out Rest of string with first token
removed.

Token

Out First token. '''' if failure.

String

51

Forth Reference Guide

SerialPuts
Name
Print String (to COM Port)
Description
Prints a string to a COM port.
Signature
[ Comn "String" a ]
Parameters
Name

Type

Dir

Description

Comn

Numeric

In

Serial COM port.
For example: 1 = COM1, 2=COM2.

String

52

String

In

String to be sent.

String Functions

Type
Name
Print String
Description
Prints the string on the top of the stack.
Signature
[ "Str" a ]
Parameters
Name

Type

Dir

Description

Str

String

In

String to be printed.

53

Forth Reference Guide

54

Chapter 4
Mathematical Functions
This chapter provides descriptions of Forth's mathematical
functions. Functions described in this chapter include the
following:
o Add
o Increment
o Subtract
o Multiply
o Divide
o Less Than
o Greater Than
o Equality
o Numeric Non-Equality
o Shift Left
o Shift Right
o Modulo
o Bitwise AND (BAND)
o Logical AND (LAND)
o Bitwise Exclusive OR (XOR)
o Bitwise OR
o Logical OR
o Negation
55

Forth Reference Guide

+ (Add)
Name
Add
Description
Adds two values.
Signature
[ N1 N2 a B ]
Parameters
Name

Dir

Description

N1

Numeric

In

Number

N2

Numeric

In

Number

B

56

Type

Numeric

Out N1 + N2

Mathematical Functions

++ (Increment)
Name
Increment
Description
Increments a variable by one.
Signature
[ VarAddr a ]
Parameters
Name

Type

Dir

Description

VarAddr

Numeric

In

Address of numeric variable.

57

Forth Reference Guide

- (Subtract)
Name
Subtract
Description
Subtracts one value from another.
Signature
[ N1 N2 a B ]
Parameters
Name

Dir

Description

N1

Numeric

In

Number

N2

Numeric

In

Number

B

58

Type

Numeric

Out N1 - N2

Mathematical Functions

* (Multiply)
Name
Multiply
Description
Multiplies two values.
Signature
[ N1 N2 a B ]
Parameters
Name

Type

Dir

Description

N1

Numeric

In

Number

N2

Numeric

In

Number

B

Numeric

Out N1 * N2

59

Forth Reference Guide

/ (Divide)
Name
Divide
Description
Divides one value by another.
Signature
[ N1 N2 a B ]
Parameters
Name

Dir

Description

N1

Numeric

In

Number

N2

Numeric

In

Number

B

60

Type

Numeric

Out N1 / N2

Mathematical Functions

& lt; (Less Than)
Name
Less Than
Description
Tests the less than relationship between the two top stack items.
Returns 1, if N1 is less than N2..
Returns 0, if N1 is greater than or equal to N2.
Signature
[ N1 N2 a B ]
Parameters
Name

Type

Dir

Description

N1

Numeric

In

Number

N2

Numeric

In

Number

B

Numeric

Out N1 & lt; N2
1 if N1 is less than N2.
0 if N1 is greater than or equal to N2.

61

Forth Reference Guide

& gt; (Greater Than)
Name
Greater Than
Description
Tests the greater than relationship between the two top stack
items.
Returns 1, if N1 is greater than N2.
Returns 0, if N1 is less than or equal to N2.
Signature
[ N1 N2 a B ]
Parameters
Name

Type

Dir

Description

N1

Numeric

In

Number

N2

Numeric

In

Number

B

Numeric

Out N1 & gt; N2
1 if N1 is greater than N2.
0 if N1 is less than or equal to N2.

62

Mathematical Functions

== (Equality)
Name
Equality
Description
Tests the equality relationship between the two top stack items.
Returns 1, if the two numbers are equal.
Returns 0, if the two numbers are not equal.

NOTE: Use == for numbers only. Use EQ for strings.

Signature
[ N1 N2 a B ]
Parameters
Name

Type

Dir

Description

N1

Numeric

In

Number

N2

Numeric

In

Number

B

Numeric

Out N1==N2.
1 if N1 equals N2.
0 if N1 is not equal to N2.

63

Forth Reference Guide

!= (Numeric Non-Equality)
Name
Numeric Non-Equality
Description
Tests the non-equality relationship between the two top stack
items.
Returns 1, if the two numbers are not equal.
Returns 0, if the two numbers are equal.
Signature
[ N1 N2 a B ]
Parameters
Name

Type

Dir

Description

N1

Numeric

In

Number

N2

Numeric

In

Number

B

Numeric

Out N1 != N2
1 if N1 is not equal to N2.
0 if N1 equals N2.

64

Mathematical Functions

& lt; & lt; (Shift Left)
Name
Shift Left
Description
Shift Value N bits to the left.
Signature
[ Value N a Value ]
Parameters
Name

Type

Dir

Description

Value

Numeric

In

Number to be shifted.

N

Numeric

In

Number of bits to shift.

Value

Numeric

Out Number after shifting N bits to left.

65

Forth Reference Guide

& gt; & gt; (Shift Right)
Name
Shift Right
Description
Shift Value N bits to the right.
Signature
[ Value N a Value ]
Parameters
Name

Dir

Description

Value

Numeric

In

Number to be shifted.

N

Numeric

In

Number of bits to shift.

Value

66

Type

Numeric

Out Number after shifting N bits to right.

Mathematical Functions

% (Modulo)
Name
Modulo
Description
Returns the remainder of N1/N2.
Signature
[ N1 N2 a B ]
Parameters
Name

Type

Dir

Description

N1

Numeric

In

Number

N2

Numeric

In

Number

B

Numeric

Out N1 % N2
Returns the remainder of N1/ N2.

67

Forth Reference Guide

& (Bitwise And)
Name
Bitwise AND (BAND)
Description
Performs a bitwise AND of the two top stack items.
Signature
[ N1 N2 a BAND ]
Parameters
Name

Type

Dir

Description

N1

Numeric

In

Number

N2

Numeric

In

Number

BAND

Numeric

Out N1 & N2
Returns bitwise AND of N1 and N2.

68

Mathematical Functions

& & (Logical And)
Name
Logical AND (LAND)
Description
Performs a logical AND of the two top stack items.
Signature
[ N1 N2 a LAND ]
Parameters
Name

Type

Dir

Description

N1

Numeric

In

Number

N2

Numeric

In

Number

LAND

Numeric

Out N1 & N2
Returns logical AND of N1 and N2.

69

Forth Reference Guide

^ (Bitwise Exclusive Or)
Name
Bitwise Exclusive OR (XOR)
Description
Performs a bitwise XOR of the two top stack items.
Signature
[ N1 N2 a XOR ]
Parameters
Name

Type

Dir

Description

N1

Numeric

In

Number

N2

Numeric

In

Number

XOR

Numeric

Out N1 ^ N2
Returns bitwise XOR of N1 and N2.

70

Mathematical Functions

| (Bitwise Or)
Name
Bitwise OR
Description
Performs a bitwise OR of the two top stack items.
Signature
[ N1 N2 a BOR ]
Parameters
Name

Type

Dir

Description

N1

Numeric

In

Number

N2

Numeric

In

Number

BOR

Numeric

Out N1 | N2
Returns bitwise OR of N1 and N2.

71

Forth Reference Guide

|| (Logical Or)
Name
Logical OR
Description
Performs a logical OR of the two top stack items.
Signature
[ N1 N2 a LOR ]
Parameters
Name

Type

Dir

Description

N1

Numeric

In

Number

N2

Numeric

In

Number

LOR

Numeric

Out N1 || N2
Returns logical OR of N1 and N2.

72

Mathematical Functions

NOT
Name
Negation
Description
Performs a logical negation of the top stack item.
Signature
[NaM]
Parameters
Name

Type

Dir

Description

N

Numeric

In

Integer value

M

Numeric

Out !N

73

Forth Reference Guide

74

Chapter 6
Stack Functions
This chapter provides descriptions of Forth's stack functions.
Functions described in this chapter include the following:
o
o
o
o
o
o
o
o
o
o
o
o
o
o
o
o
o
o
o

Return Stack Push
Print
Print Hex
Stack Print
Stack Clear
Remove Number
Duplicate Number
Skip and Duplicate
Input Word
Input Byte
Pick Item
Output Word
Output Byte
Push Error Message
Pop Return Stack
Reverse
Pick String Item
Values of Stacks as HTML
Swap Stack Items

75

Forth Reference Guide

& gt; R (Return Stack Push)
Name
Return Stack Push
Description
Pushes a value onto the return stack.
Signature
[Na]
Parameters
Name

Dir

Description

N

76

Type
Numeric

In

Value to push onto the top of the
return stack.

Stack Functions

. (Print)
Name
Print
Description
Pops value from the stack and prints it to the console.
Signature
[Na]
Parameters
Name

Type

Dir

Description

N

Numeric

In

Value to be printed.

77

Forth Reference Guide

.H (Print Hex)
Name
Print Hex
Description
Pops value from the stack and prints it to the console as a
hexadecimal number.
Signature
[Na]
Parameters
Name

Dir

Description

N

78

Type
Numeric

In

Value to be printed.

Stack Functions

.S (Stack Print)
Name
Stack Print
Description
Print the stack contents to the console. This operator does not
alter the stack contents.
Signature
[a]
Parameters
None

79

Forth Reference Guide

# (Stack Clear)
Name
Stack Clear
Description
Clears the stack.
Signature
[a]
Parameters
None

80

Stack Functions

DROP
Name
Remove Number
Description
Removes the top stack item.

NOTE: Use DROP for numbers only. Use FREE for strings.

Signature
[ N a]
Parameters
Name

Type

Dir

Description

N

Numeric

In

Value

81

Forth Reference Guide

DUP
Name
Duplicate Number
Description
Duplicates the top stack item.

NOTE: Use DUP for numbers only. Use SDUP for strings.

Signature
[NaNN]
Parameters
Name

Dir

Description

N

Numeric

In

Value

N

Numeric

Out Value

N

82

Type

Numeric

Out Value

Stack Functions

Over
Name
Skip and Duplicate
Description
Duplicates the second item down in the stack. The duplicate is
placed on top of the stack.
Signature
[NMaNMN]
Parameters
Name

Type

Dir

Description

N

Numeric

In

Value

M

Numeric

In

Value

N

Numeric

Out Value

M

Numeric

Out Value

N

Numeric

Out Value

83

Forth Reference Guide

Peek
Name
Input Word
Description
Inputs a word from a specified address.
Signature
[ inaddress a value ]
Parameters
Name

Dir

Description

inaddress

Numeric

In

I/O address to be read.

value

84

Type
Numeric

Out Value read as an 16-bit word.

Stack Functions

Peekb
Name
Input Byte
Description
Inputs a byte from a specified address.
Signature
[ inaddress a bvalue ]
Parameters
Name

Type

Dir

Description

inaddress

Numeric

In

I/O address to be read.

bvalue

Numeric

Out Value read as an 8-bit byte.

85

Forth Reference Guide

Pick
Name
Pick Item
Description
Selects the Nth item from the stack and places it on top of the
stack.
Pick numbering begins with 1.
1 Pick is the same as DUP.
2 Pick is the same as OVER.
Signature
[ N a copy ]

Parameters
Name

Dir

Description

N

Numeric

In

Stack position.

copy

86

Type
Numeric

Out Copy of number.

Stack Functions

Poke
Name
Output Word
Description
Outputs a word to a specified address.
Signature
[ value outaddress a ]
Parameters
Name

Type

Dir

Description

bvalue

Numeric

In

Word value to write.

outaddress

Numeric

In

I/O address to be written.

87

Forth Reference Guide

Pokeb
Name
Output Byte
Description
Outputs a byte to a specified address..
Signature
[ bvalue outaddress a ]
Parameters
Name

Dir

Description

bvalue

Numeric

In

Byte value to write.

outaddress

88

Type
Numeric

In

I/O address to be written.

Stack Functions

PushErrorMessage
Name
Push Error Message
Description
Add to the list of error messages.
Signature
[ "Message" a ]
Parameters
Name

Type

Dir

Description

Message

String

In

Message text.

89

Forth Reference Guide

R & gt; (Pop Return Stack)
Name
Pop Return Stack
Description
Pops a value off of the return stack.
Signature
[aN]
Parameters
Name

Dir

N

90

Type

Description

Numeric

Out Value on top of the stack.

Stack Functions

Reverse
Name
Reverse
Description
Reverses the order of the top N items on the stack.
Signature
[Na]
Parameters
Name

Type

Dir

Description

N

Numeric

In

Number of items to be reversed.

91

Forth Reference Guide

SPick
Name
Pick String Item
Description
Selects the Nth string item from the stack and places it on top of
the stack.
Pick numbering begins with 1.
1 SPick is the same as SDUP.
2 SPick is the same as OVER.
Signature
[ N a "copy" ]

Parameters
Name

Dir

Description

N

Numeric

In

Stack position (base 1 indexing).

copy

92

Type
String

Out Copy of string.

Stack Functions

StacksAsHTML
Name
Values of Stacks as HTML
Description

Values of the stack as HTML. Does not remove the items on
the stack, only adds a value to the top of the string stack that
is all the stack values formatted as html table rows.
Signature
[ a "FormattedHTML" ]
Parameters
Name

Type

FormattedHTML String

Dir

Description

Out Value of the stack formatted as an
HTML table with two columns.
First column has value and the
second column has value as a
string, if appropriate.

93

Forth Reference Guide

Swap
Name
Swap Stack Items
Description
Swaps the top two stack items.
Signature
[NMaMN]
Parameters
Name

Dir

Description

N

Numeric

In

Value

M

Numeric

In

Value

M

Numeric

Out Value

N

94

Type

Numeric

Out Value

Chapter 7
Conversion Functions
This chapter provides descriptions of Forth's conversion
functions. Functions described in this chapter include the
following:
o

Get Hex Byte

o

Integer to 2-Character Hex String

o

Integer to Hex String

o

String to Integer

o

Integer to String

95

Forth Reference Guide

GetHexByte
Name
Get Hex Byte
Description
Returns a byte out of a hex string.
For example, "0a0b0c0d0e0f" 2 a 12.
Signature
[ "HexString" N a ByteN ]
Parameters
Name

Dir

Description

HexString

String

In

String of hex characters.

N

Numeric

In

Index of byte to pull.

ByteN

96

Type

Numeric

Out Byte found at character index N*2
and N*2+1.

Conversion Functions

ByteToHex
Name
Integer to 2-Character Hex String
Description
Converts an integer to a two (2) character string in hexadecimal
format. Pads with 0s if necessary.
Signature
[ Int a "Str" ]
Parameters
Name

Type

Dir

Description

Int

Numeric

In

Integer number.

Str

String

Out String conversion in hexadecimal.

97

Forth Reference Guide

ToHexStr
Name
Integer to Hex String
Description
Converts an integer on the stack to a Hex formatted string.
Signature
[ Int a "Str" ]
Parameters
Name

Dir

Description

Int

Numeric

In

Number.

Str

98

Type
String

Out Number converted to a Hex
formatted string.

Conversion Functions

ToInt
Name
String to Integer
Description
Converts a string on the stack to an integer.
Signature
[ "Str" a Int ]
Parameters
Name

Type

Dir

Description

Str

String

In

String to be converted.

Int

Numeric

Out String converted to an integer.

.

99

Forth Reference Guide

ToStr
Name
Integer to String
Description
Converts an integer on the stack to a string.
Signature
[ Int a "Str" ]
Parameters
Name

Dir

Description

Int

Numeric

In

Number.

Str

100

Type
String

Out Number converted to a string.

Chapter 8
Dictionary Functions
This chapter provides descriptions of Forth's dictionary
functions. Functions described in this chapter include the
following:
o

Dictionary Definition Counter

o

Dictionary Entry Index

o

Dictionary Entry Name

o

List Definitions

101

Forth Reference Guide

DictionaryCount
Name
Dictionary Definition Counter
Description
Returns the number of definitions in the dictionary.
Signature
[ a Count ]
Parameters
Name

Dir

Count

102

Type

Description

Numeric

Out Number of definitions in the
dictionary.

Dictionary Functions

DictionaryEntry
Name
Dictionary Entry Index
Description
Returns the index of a dictionary entry.
Signature
[ "Name" a Index ]
Parameters
Name

Type

Dir

Description

Name

String

In

Function or variable entry name to
search.

Index

Numeric

Out Returned index.
0 returned if no entry.

103

Forth Reference Guide

EntryName
Name
Dictionary Entry Name
Description
The name of a dictionary entry at a specified index.
Signature
[ Index a "Name" ]
Parameters
Name

Dir

Description

Index

Numeric

In

Index of entry in the dictionary.

Name

104

Type
String

Out Name of the entry.

Dictionary Functions

Words
Name
List Definitions
Description
Outputs a list of all definitions in the dictionary to the console.
Signature
[a]
Parameters
None

105

Forth Reference Guide

106

Chapter 9
Digital I/O Functions
This chapter provides descriptions of Forth's digital input and
output port control functions. Functions described in this chapter
include the following:
o

Digital I/O Get

o

Digital I/O Get Number of Ports

o

Digital I/O Get Port Configuration

o

Digital I/O Get Port Size

o

Digital I/O Port Get

o

Digital I/O Port Get Direction

o

Digital I/O Port Set

o

Digital I/O Port Set Direction

o

Digital I/O Set

107

Forth Reference Guide

DIOGet
Name
Digital I/O Get
Description
Returns the value of a single digital input or output pin.
Signature
[ "Address" Pin a Value ]
Parameters
Name

Dir

Description

Address

String

In

Address of the reader.

Pin

Numeric

In

Pin number (0 based index).

Value

108

Type

Numeric

Out Pin value (0 or 1).

Digital I/O Functions

DIOGetNumPorts
Name
Digital I/O Get Number of Ports
Description
Returns the number of digital I/O ports on the reader.
Signature
[ "Address" a Num ]
Parameters
Name

Type

Dir

Description

Address

String

In

Reader address.

Number

Numeric

Out Number of ports.

109

Forth Reference Guide

DIOGetPortConfig
Name
Digital I/O Get Port Configuration
Description
Get the configuration of a port, which includes the direction of
the port and how the port can be changed.
Signature
[ "Address" Port a "Dir" "Setting" ]
Parameters
Name

Type

Dir

Description

Address

String

In

Reader address.

Port

Numeric

In

Port to query.

Dir

String

Out Direction of port.
1 = Input.
0 = Output.
? = Unknown.

Setting

String

Out How is digital I/O port set?
"Software", "DIP", or "Fixed".

110

Digital I/O Functions

DIOGetPortSize
Name
Digital I/O Get Port Size
Description
Returns the number of bits in each port.
Signature
[ "Address" a Size ]
Parameters
Name

Type

Dir

Description

Address

String

In

Reader address.

Size

Numeric

Out Number of bits in each port.

111

Forth Reference Guide

DIOPortGet
Name
Digital I/O Port Get
Description
Returns the integer value of all the digital input and output pins
on a single port.
Signature
[ "Address" Port a Value ]
Parameters
Name

Type

Dir

Description

Address

String

In

Address of the reader.

Port

Numeric

In

Port number (0...n).

Value

Numeric

Out Port value.
Integer values depend on the
number of pins.

112

Digital I/O Functions

DIOPortGetDirection
Name
Digital I/O Port Get Direction
Description
Returns the direction (input or output) of the port.
Signature
[ "Address" Port a Direction ]
Parameters
Name

Type

Dir

Description

Address

String

In

Reader address.

Port

Numeric

In

Port number (0...n).

Direction

Numeric

Out Direction of the port.
1 = Input.
0 = Output.

113

Forth Reference Guide

DIOPortSet
Name
Digital I/O Port Set
Description
Sets all the digital input and output pins on a single port.
Signature
[ "Address" Port Value a ]
Parameters
Name

Type

Dir

Description

Address

String

In

Address of the reader.

Port

Numeric

In

Port number (0...n).

Value

Numeric

Out Integer value to write to the port.
Integer values depend on the
number of pins.

114

Digital I/O Functions

DIOPortSetDirection
Name
Digital I/O Port Set Direction
Description
Sets all the direction (input or output) of the digital I/O port.
Signature
[ "Address" Port Direction a ]
Parameters
Name

Type

Dir

Description

Address

String

In

Reader address.

Port

Numeric

In

Port number (0...n)

Value

Numeric

In

Direction to set port.
1 = Input.
0 = Output.

115

Forth Reference Guide

DIOSet
Name
Digital I/O Set
Description
Sets the value of a single output pin.
Signature
[ "Address" Pin Value a ]
Parameters
Name

Dir

Description

Address

String

In

Reader address.

Pin

Numeric

In

Pin number (0...n)

Value

116

Type

Numeric

In

Pin value (0 or 1).

Chapter 10
Tag Functions
This chapter provides descriptions of Forth's tag control
functions. Functions described in this chapter include the
following:
o
o
o
o
o
o
o
o
o
o
o
o
o
o
o
o
o
o
o
o
o

Get Chump Tag Element
Get Tag Format Info
Tag Get Lock Block Status
Tag Get Sys Info
Tag Halt
Tag Last Read
Tag Last Write
Tag Lock AFI
Tag Lock Block
Tag Lock DSFID
Tag Read
Tag Read Detect Init Round All
Tag Read Detect New Round
Tag Read Stats
Tag Read Unselect
Tag Read User Data
Tag Reset
Tag Select
Tag Stack Arrival
Tag Stack Arrival?
Tag Stack Clear

o
o
o
o
o
o
o
o
o
o
o
o
o
o
o
o
o
o
o
o

Tag Stack Clear All
Tag Stack Departure?
Tag Stack Find
Tag Stack Peek
Tag Stack Pop
Tag Stack Pull
Tag Stack Push
Tag Stack Read
Tag Stack Size
Tag Stack Write
Tag Wakeup
Tag Write
Tag Write AFI
Tag Write DSFID
Tag Write Inc
Tag Write Inc End
Tag Write Stats
Tag Write User Data
Time From String
Time To String

117

Forth Reference Guide

GetChumpTagElement
Name
Get Chump Tag Element
Description
Returns a part of the Chump tag.
Signature
[ "TagData" "ElementName" a "TagData"
"ElementValue"]
Parameters
Name

Type

Dir

Description

TagData

String

In

Tag data in Chump format.

ElementName

String

In

Name of element to retrieve (for
example "d:").

TagData

String

Out Original tag data unchanged.

ElementValue

String

Out The value of the element with the
given name.
The name (for example, " d: " ) and
following ',' are stripped off.
The empty string '''' is returned if
the element does not exist in the
tag.

118

Tag Functions

GetTagFormatInfo
Name
Get Tag Format Info
Description
Returns the format information of the tag.
Signature
[ "TagType" a IDlen NumBlocks Size
StartOfEditable "SpecialBlocks"]
Parameters
Name

Type

Dir

Description

TagType

String

In

Tag type to look up.

IDlen

Numeric

Out Length of tags ID in bytes.

NumBlocks

Numeric

Out Number of blocks of editable data.

Size

Numeric

Out Size of each block in bytes.

StartOfEditable Numeric

Out Offset where editable data begins.

SpecialBlocks

Out The special blocks in the editable
area (passwords, private data, or
configuration bits).

String

The string returned is a list of
integers separated by |.

119

Forth Reference Guide

TagGetLockBlockStatus
Name
Tag Get Lock Block Status
Description
Returns the lock block status of the tag.
Signature
[ "Address" "TagID" a "TagID" "lockStatus"]
Parameters
Name

Type

Dir

Description

Address

String

In

Reader address

TagID

String

In

ID of tag to lock DSFID on.
'''' for all tags.

TagID

Out ID of tag found.

lockStatus

120

String
String

Out Lock status of the blocks.

Tag Functions

TagGetSysInfo
Name
Tag Get System Information
Description
Returns the system information of the tag
Signature
[ "Address" "TagID" a "TagID" "tagInfo"]
Parameters
Name

Type

Dir

Description

Address

String

In

Reader address

TagID

String

In

ID of tag to set.
'''' for all tags.

TagID

String

Out ID of tag.

tagInfo

String

Out Tag system information

121

Forth Reference Guide

TagHalt
Name
Tag Halt
Description
Halts the given tag.
Signature
[ "Address" "TagID" a ]
Parameters
Name

Dir

Description

Address

String

In

Reader Address

TagID

122

Type
String

In

ID of tag to halt

Tag Functions

TagLastRead
Name
Tag Last Read
Description
Returns the read statistics for the last tag on a specific reader.
Signature
[ "Address" a "last_read_time"
"last_read_data"]
Parameters
Name

Type

Dir

Description

Address

String

In

Reader address

last_read_time Numeric

Out Time tag was last read.

last_read_data String

Out Data of last tag read (in CHUMP
format)

123

Forth Reference Guide

TagLastWrite
Name
Tag Last Write
Description
Returns the write statistics for the last tag on a specific reader.
Signature
[ "Address" a "last_write_time"
"last_write_data"]
Parameters
Name

Dir

Description

Address

String

In

Reader address.

last_write_time

Numeric

Out Time tag was last written.

last_write_data

124

Type

String

Out Data of last tag write (in
CHUMP format).

Tag Functions

TagLockAFI
Name
Tag Lock AFI
Description
Locks the AFI on for the specific tag.
Signature
[ "Address" "TagID" a ]
Parameters
Name

Type

Dir

Description

Address

String

In

Reader address.

TagID

String

In

ID of the tag to lock the AFI on.
'''' for all tags.

125

Forth Reference Guide

TagLockBlock
Name
Tag Lock Block
Description
Locks a specific block on a specific tag.
Signature
[ "Address" "TagID" block a ]
Parameters
Name

Type

Dir

Description

Address

String

In

Reader address.

TagID

String

In

ID of the tag to set.
'''' for all tags.

block

126

Numeric

In

Index of the block to lock.

Tag Functions

TagLockDSFID
Name
Tag Lock DSFID
Description
Locks the DSFID on for a specific tag.
Signature
[ "Address" "TagID" a ]
Parameters
Name

Type

Dir

Description

Address

String

In

Reader address.

TagID

String

In

ID of the tag to lock DSFID on.
'''' for all tags.

127

Forth Reference Guide

TagRead
Name
Tag Read
Description
Reads a tag from the specified reader.
Signature
[ "Address" a "TagData" Time "TagType"]
Parameters
Name

Type

Dir

Description

Address

String

In

Reader address.
Same reader registered with
Register Reader command.

TagData

String

Out Tag data in CHUMP format

Time

Numeric

Out Time in UNIX format.
Same format as that returned with
the GetTime command

TagType

128

String

Out Type of tag.

Tag Functions

TagReadDetectInitRoundAll
Name
Tag Read Detect Initialize Round All
Description
Reads a tag from the specified reader. This is an ISO 18000-6A
specific read command.

Signature
[ "Address" a "TagData" Time "TagType"]
Parameters
Name

Type

Dir

Description

Address

String

In

Reader address.
Same reader registered with
Register Reader command.

TagData

String

Out Tag data in CHUMP format.

Time

Numeric

Out Time in UNIX format.
Same format as that returned with
the GetTime command

TagType

String

Out Type of tag.

129

Forth Reference Guide

TagReadDetectNewRound
Name
Tag Read Detect New Round
Description
Reads a tag from the specified reader. This is an ISO 18000-6A
specific read command.
Signature
[ "Address" a "TagData" Time "TagType"]
Parameters
Name

Type

Dir

Description

Address

String

In

Address of reader to use.

TagData

String

Out Tag data in CHUMP format

Time

Numeric

Out Time in UNIX format.
Same format as that returned with
the GetTime command

TagType

130

String

Out Type of tag.

Tag Functions

TagReadStats
Name
Tag Read Statistics
Description
Returns the read statistics for the specific reader.
Signature
[ "Address" a "read_count" "read_time"]
Parameters
Name

Type

Dir

Description

Address

String

In

Reader address.
Same reader registered with
Register Reader command.

read_count

String

Out Number of tags read.

read_time

String

Out Last time ReadCount was
incremented (reader responded
with tag read).

131

Forth Reference Guide

TagReadUnselect
Name
Tag Read Unselect
Description
Reads a tag from the specified reader.
Signature
[ "Address" a "TagData" Time "TagType"]
Parameters
Name

Dir

Description

Address

String

In

Address of reader to use.

TagData

String

Out Tag data in CHUMP format.

Time

Numeric

Out Time in UNIX format that tag was
read.

TagType

132

Type

String

Out Type of tag read.

Tag Functions

TagReadUserData
Name
Tag Read User Data
Description
Returns the user data from a specific block on a specific tag.
Signature
[ "Address" "TagID" "TagType" blockAddr
length a "TagID" "TagData" "TagType"
"TagType" status ]
Parameters
Name

Type

Dir

Description

Address

String

In

Reader address.

TagID

String

In

ID of tag to read.

TagType

String

In

Type of tag.

blockAddr

Numeric

In

Address of block to read.

length

Numeric

In

Number of blocks to read.

TagID

String

Out ID of tag read.

TagData

String

Out User data from the tag.

TagType

String

Out Type of tag.

TagType

String

Out Type of tag.

status

Numeric

Out 1 = Success.
0 = Failure.

133

Forth Reference Guide

TagReset
Name
Tag Reset
Description
Resets the tag.
Signature
[ "Address" a ]
Parameters
Name

Dir

Description

Address

134

Type
String

In

Reader address.

Tag Functions

TagSelect
Name
Tag Select
Description
Selects a tag on a specific reader.
Signature
[ "Address" "TagID" a ]
Parameters
Name

Type

Dir

Description

Address

String

In

Reader address

TagID

String

In

ID of the tag to select.

135

Forth Reference Guide

TagStackArrival
Name
Tag Stack Arrival
Description
Call to indicate that an arrival has been sent to the tag.
Signature
[ Index a ]
Parameters
Name

Type

Dir

Description

Index

Numeric

In

Index of the stack element to set.
0 = bottom of the stack.
TagStackSize-1 = top of stack

136

Tag Functions

TagStackArrival?
Name
Tag Stack Arrival Query
Description
Indicates if the arrival message has been sent to the tag.
Signature
[ Index a b ]
Parameters
Name

Type

Dir

Description

Index

Numeric

In

Index of the stack element to set.
0 = bottom of the stack.
TagStackSize-1 = top of stack

b

Numeric

Out 1 = Arrival has been sent.
0 = Arrival has not been sent

137

Forth Reference Guide

TagStackClear
Name
Tag Stack Clear
Description
Removes all tags from the tag stack.
Signature
[a]
Parameters
None

138

Tag Functions

TagStackClearAll
Name
Tag Stack Clear All
Description
Clears all tags from the tag stack and also clears the ICCM
screen.
Signature
[a]
Parameters
None

139

Forth Reference Guide

TagStackDeparture?
Name
Tag Stack Departure Query
Description
Indicates if the bucket has leaked down to zero (tag has left the
field).
Signature
[ Index a b ]
Parameters
Name

Type

Dir

Description

Index

Numeric

In

Index of the stack element to set.
0 = bottom of the stack.
TagStackSize-1 = top of stack.

b

Numeric

Out 1 = Bucket is empty.
0 = Bucket is not empty.

140

Tag Functions

TagStackFind
Name
Tag Stack Query
Description
Indicates if the tag stack contains a tag with the given ID.
Signature
[ "Data" a Exists ]
Parameters
Name

Type

Dir

Description

Data

String

In

Tag ID

Exists

Numeric

Out Index+1 if the tag is on the stack.
0 if the tag is not on the stack.

141

Forth Reference Guide

TagStackPeek
Name
Tag Stack Peek
Description
Returns a copy of the tag on the stack (non-destructive).
Signature
[ Index a "Source" "Data" Time ]
Parameters
Name

Type

Dir

Description

Index

Numeric

In

Index of the stack element to copy.
0 = bottom of the stack.
TagStackSize-1 = top of stack.

Source

String

Out Name of the data source
For example, "COM1".

Data

String

Out Tag data in CHUMP format.

Time

Numeric

Out Time in UNIX format.
Same format as that returned with
the GetTime command.

142

Tag Functions

TagStackPop
Name
Tag Stack Pop
Description
Pops a tag from the tag stack.
Signature
[ a "Source" "Data" Time ]
Parameters
Name

Type

Dir

Description

Source

String

Out Name of the data source.
For example, "COM1".

Data

String

Out Tag data in CHUMP format.

Time

Numeric

Out Time in UNIX format.
Same format as that returned with
the GetTime command.

143

Forth Reference Guide

TagStackPull
Name
Tag Stack Pull
Description
Removes a tag on the stack at the specified location.
Signature
[ Index a "Source" "Data" Time ]
Parameters
Name

Type

Dir

Description

Index

Numeric

In

Index of the stack element to copy.
0 = bottom of the stack.
TagStackSize-1 = top of stack.

Source

String

Out Name of the data source
For example, "COM1".

Data

String

Out Tag data in CHUMP format.

Time

Numeric

Out Time in UNIX format.
Same format as that returned with
the GetTime command.

144

Tag Functions

TagStackPush
Name
Tag Stack Push
Description
Push a tag onto the stack. Ignores duplicates.
Signature
[ "Source" "Data" Time

a Unique ]

Parameters
Name

Type

Dir

Description

Source

String

In

Name of the data source.
For example, "COM1".

Data

String

In

Tag data in CHUMP format.

Time

Numeric

In

Time in UNIX format.
Same format as that returned with
the GetTime command.

Unique

Numeric

Out 1 = tag is actually pushed.
0 = ignored because it was already
on the stack.

145

Forth Reference Guide

TagStackRead
Name
Tag Stack Read
Description
Read data from file and push it onto the tag stack. Clears the tag
stack and resizes the stack to its maximum capacity.
Signature
[ "Filename" a b ]
Parameters
Name

Type

Dir

Description

Filename

String

In

Name of the file to obtain data.
Format should be one tag per line
(tag data only).

b

Numeric

Out 1 = Success.
0 = Failure.

146

Tag Functions

TagStackSize
Name
Tag Stack Size
Description
Returns the number of tags on the tag stack.
Signature
[ a Size ]
Parameters
Name

Type

Dir

Description

Size

Numeric

Out Number of tags on the tag stack.

147

Forth Reference Guide

TagStackWrite
Name
Tag Stack Write
Description
Writes the entire tag stack out to a file.
Signature
[ "Filename" a b ]
Parameters
Name

Type

Dir

Description

Filename

String

In

Name of the file to write data.
Format should be one tag per line
(tag data only).

b

Numeric

Out 1 = Success.
0 = Failure.

148

Tag Functions

TagWakeup
Name
Tag Wakeup
Description
Wakes the tag.
Signature
[ "Address" a ]
Parameters
Name

Type

Dir

Description

Address

String

In

Reader address.

149

Forth Reference Guide

TagWrite
Name
Tag Write
Description
Sets the data on the tag.
Signature
[ "Address" "TagData" a b ]
Parameters
Name

Type

Dir

Description

Address

String

In

Reader address.

TagData

String

In

Data to appear on the tag.

b

Numeric

Out 1 = Success.
0 = Failure.
Success indicates message
accepted for sending to the reader.
To verify if write was successful,
check the value status on
ReaderPoll.

150

Tag Functions

TagWriteAFI
Name
Tag Write AFI
Description
Sets a new value for the tag AFI.
Signature
[ "Address" "TagID" AFI a ]
Parameters
Name

Type

Dir

Description

Address

String

In

Reader address.

TagID

String

In

ID of the tag to set.

AFI

Numeric

In

New value of the AFI.

151

Forth Reference Guide

TagWriteDSFID
Name
Tag Write DSFID
Description
Sets a new value for the tag DSFID.
Signature
[ "Address" "TagID" DSFID a ]
Parameters
Name

Dir

Description

Address

String

In

Reader address.

TagID

String

In

ID of the tag to set.

DSFID

152

Type

Numeric

In

New value of the DSFID.

Tag Functions

TagWriteInc
Name
Tag Write Increment
Description
Writes data to the tag. Increments after each write.
Signature
[ "Address" "TagData" a b ]
Parameters
Name

Type

Dir

Description

Address

String

In

Reader address.

TagData

String

In

First tag data to appear on the tag.
Incremented after each write.

b

Numeric

Out 1 = Success.
0 = Failure.
Success indicates message
accepted for sending to the reader.
To verify if write was successful,
check the value status on
ReaderPoll.

153

Forth Reference Guide

TagWriteIncEnd
Name
Tag Write Increment End
Description
Exits the write increment mode.
Signature
[ "Address" "TagData" a b ]
Parameters
Name

Type

Dir

Description

Address

String

In

Reader address.

TagData

String

In

First tag data to appear on the tag.
Incremented after each write.

b

Numeric

Out 1 = Success.
0 =Failure.
Success indicates message
accepted for sending to the reader.
To verify if write was successful,
check the value status on
ReaderPoll.

154

Tag Functions

TagWriteStats
Name
Tag Read Statistics
Description
Returns the write statistics for the specific reader.
Signature
[ "Address" a "write_count" "write_time"]
Parameters
Name

Type

Dir

Description

Address

String

In

Reader address.
Same reader registered with
Register Reader command.

write_count

String

Out Number of tags written.

write_time

String

Out Last time WriteCount was cleared.

155

Forth Reference Guide

TagWriteUserData
Name
Tag Write User Data
Description
Writes the user data fields out to a specific tag.
Signature
[ "Address" "TagID" "TagType" blockAddr
length "TagData" a status ]
Parameters
Name

Type

Dir

Description

Address

String

In

Reader address.

TagID

String

In

ID of tag to write.

TagType

String

In

Type of tag.

blockAddr

Numeric

In

Address of block to write.

length

Numeric

In

Number of blocks to write.

TagData

String

In

User data for the tag.

status

Numeric

Out 1 = Success.
0 = Failure.

156

Tag Functions

TimeFromStr
Name
Time From String
Description
Set the system time from string input.
Signature
[ "Time" a ]
Parameters
Name

Type

Dir

Description

Time

String

In

Time formatted as:
"mm-dd-yyyy hh:ss"
Note: Format is strict.

157

Forth Reference Guide

TimeToStr
Name
Time To String
Description
Convert a numeric time to a string.
Signature
[ Time a "Time" ]
Parameters
Name

Type

Dir

Description

Time

Numeric

In

Time as a numeric quantity
Same format as that returned
with the GetTime command

Time

String

out

The current time formatted as:
"mm-dd-yyyy hh:ss"

158

Chapter 11
Reader Functions
This chapter provides descriptions of the Forth Reader functions.
Functions described in this chapter include the following:
o

Attach Reader

o

Configuration Variable Get

o

Configuration Variable Set

o

Get Reader Address

o

Get Reader Information

o

Get Reader Polled Mode

o

Number of Readers

o

Reader Address

o

Reader Poll

o

Reader Version

o

Register Reader

o

Set Reader Information

o

Set Reader Polled Mode

159

Forth Reference Guide

AttachReader
Name
Attach Reader
Description
Ties a reader to a specific port.
Signature
[ "InitString" "Type" a ]
Parameters
Name

Type

Dir

Description

InitString

String

In

The initialization string.
For example:
" Com1 " for serial device.
" Com2:0x0a " for RS-485 device.
InitString becomes the reader
address to be used for calls to
TagRead and ReaderPoll.

Type

160

String

In

Type of reader (CHUMP, TIRIS,
DEMO, or other).

Reader Functions

ConfigurationVarGet
Name
Configuration Variable Get
Description
Returns the value of the named reader configuration variable.
Signature
[ "Name" a value ]
Parameters
Name

Type

Dir

Description

Name

String

In

Name of the variable.

value

Numeric

Out Value of the variable.

161

Forth Reference Guide

ConfigurationVarSet
Name
Configuration Variable Set
Description
Sets the value of the named reader configuration variable.
Signature
[ "Name" value a

]

Parameters
Name

Dir

Description

Name

String

In

Name of the variable.

value

162

Type
Numeric

In

Value of the variable.

Reader Functions

GetRdrAddr
Name
Get Reader Address
Description
Returns the reader addresses for multidrop systems. The format is
"comX:nn" where "nn" is the RS-485 address of the reader. This
function takes "comX:nn" as an argument and returns "nn".
Signature
[ "FullAddress" a "485Address" ]
Parameters
Name

Type

Dir

Description

FullAddress

String

In

The full reader port address.

485Address

String

Out RS-485 address of reader.

163

Forth Reference Guide

GetReaderInfo
Name
Get Reader Information
Description
Returns the extra information stored for a specific reader. This is
extra per-reader data that can be used for application specific
storage.
Signature
[ Index a Value ]
Parameters
Name

Dir

Description

Index

Numeric

In

Reader index.

Value

164

Type
Numeric

Out Value stored for reader.

Reader Functions

GetReaderPolledMode
Name
Get Reader Polled Mode
Description
Returns reader polling mode.
Signature
[ "Address" a N ]
Parameters
Name

Type

Dir

Description

Address

String

In

Reader address

N

Numeric

Out 1 = Polled mode.
0 = Continuous mode.

165

Forth Reference Guide

NumReaders
Name
Number of Readers
Description
Returns the number of readers attached.
Signature
[ a Num ]
Parameters
Name

Dir

Num

166

Type

Description

Numeric

Out Number of readers.

Reader Functions

ReaderAddress
Name
Reader Address
Description
Returns the string address of a reader from the reader index.
Signature
[ Index a "Address" ]
Parameters
Name

Type

Dir

Description

Index

Numeric

In

Reader index (0-based).

Address

String

Out Address as a string.
Suitable for passing to ReaderPoll
or TagRead functions.

167

Forth Reference Guide

ReaderPoll
Name
Reader Poll
Description
Returns the number of tags processed by the reader.
Signature
[ "Address" a Status ]
Parameters
Name

Type

Dir

Description

Address

String

In

Address of the reader to poll.
Same address passed to
RegisterReader.

Status

Numeric

Out Number of tags arrived.
0 if none available.

168

Reader Functions

ReaderVersion
Name
Reader Version
Description
Returns the reader version string.
Signature
[ "Address" a "Version" ]
Parameters
Name

Type

Dir

Description

Address

String

In

Reader address.

Version

String

Out Version information.

169

Forth Reference Guide

RegisterReader
Name
Register Reader
Description
Adds a reader so it can be manipulated by Forth functions.
Signature
[ Context FunctionMap "Address" a ]
Parameters
Name

Dir

Description

Context

Numeric

In

Reader context.

FunctionMap

Numeric

In

Function map.

Address

170

Type

String

In

Address to identify reader.

Reader Functions

SetReaderInfo
Name
Set Reader Information
Description
Sets the extra information stored for a specific reader. This is
extra per-reader data that can be used for application specific
storage.
Signature
[ Index Value a ]
Parameters
Name

Type

Dir

Description

Index

Numeric

In

Reader index.

Value

Numeric

In

Value to store for reader.

171

Forth Reference Guide

SetReaderPolledMode
Name
Set Reader Polled Mode
Description
Sets the reader polling mode (polled or continuous).
Signature
[ "Address" N a ]
Parameters
Name

Type

Dir

Description

Address

String

In

Reader address.

N

Numeric

In

1 = Polled mode.
0 = Continuous mode.

172

Chapter 12
ICCM Functions
This chapter provides descriptions of the Forth Interrogator
Control and Concentrator Module functions. Functions described
in this chapter include the following:
o

ICCM Beep

o

ICCM Clear Screen

o

ICCM Load

o

ICCM Load CGI

o

ICCM Write Text

o

ICCM Open

o

LC Get Screen

o

LC Set Screen

o

LC Write Text

o

Redirect String

o

Serial Initialize

173

Forth Reference Guide

ICMBeep
Name
ICCM Beep
Description
Activate the ICCM beeper for the specified time.
Signature
[ Ticks a ]
Parameters
Name

Type

Dir

Description

Ticks

Numeric

In

Number of ticks to sound beeper.
0 = Off.
1000 = 1 second.

174

ICCM Functions

ICMClearScreen
Name
ICCM Clear Screen
Description
Clears the ICCM text screen.
Signature
[a]
Parameters
None

175

Forth Reference Guide

ICMLoad
Name
ICCM Load
Description
Load a HEX file from the concentrator to the ICCM.
Signature
[ "Filename" a ]
Parameters
Name

Dir

Description

Filename

176

Type
String

In

Name of file to load.

ICCM Functions

ICMLoadCGI
Name
ICCM Load CGI
Description
Load an HTML file to the ICCM.
Signature
[ a "Index.htm" ]
Parameters
Name

Type

Dir

Description

Index.htm

String

In

Name of HTML file to load.

177

Forth Reference Guide

ICMWriteText
Name
ICCM Write Text
Description
Write a text string on the ICCM screen.
Signature
[ Line "String" a ]
Parameters
Name

Dir

Description

Line

Numeric

In

ICCM line to place text (1-25).

String

178

Type
String

In

Text string (not to exceed 40
characters).

ICCM Functions

ICMOpen
Name
ICCM Open
Description
Open an ICCM on the specified port.
Signature
[ "InitString" a Context FunctionMap ]
Parameters
Name

Type

Dir

Description

InitString

String

In

The initialization string (for
example, "Com2:0x20").

Context

Numeric

Out A pointer to the reader context.

FunctionMap

Numeric

Out A pointer to the reader function
map.

179

Forth Reference Guide

LCGetScreen
Name
LC Get Screen
Description
Returns the active screen for the ICCM.
Signature
[ a Active screen ]
Parameters
Name

Dir

Active screen

180

Type

Description

Numeric

Out Screen number (0 - 5).

ICCM Functions

LCSetScreen
Name
LC Set Screen
Description
Sets the active screen for the ICCM.
Signature
[ Screen a ]
Parameters
Name

Type

Dir

Description

Screen

Numeric

In

Screen number (0 - 5).

181

Forth Reference Guide

LCWriteText
Name
LC Write Text
Description
Write text to LCD screen on ICCM.
Signature
[ Screen Line Column Magfact "Text" a ]
Parameters
Name

Type

Dir

Description

Screen

Numeric

In

Screen number (0-5).

Line

Numeric

In

Line number to place text (1-25).

Column

Numeric

In

Column to place text (0-52).

Magfact

Numeric

In

Magnification factor text size (1-3).

Text

String

In

Text string to write to screen.

NOTE: Line and column numbers are based on a magnifcation
factor of 1.

182

ICCM Functions

RedirectString
Name
Redirect String
Description
Returns the status string to be displayed from redirect.html.
Signature
[a]
Parameters
None

183

Forth Reference Guide

SerialInit
Name
Serial Initialize
Description
Initializes a serial COM port on the ICCM.
Signature
[ Comm "SerialInitString" a ]
Parameters
Name

Type

Dir

Description

Comm

Numeric

In

Serial COM port to initialize.
1 = COM1.
2 = COM2.

SerialInitString String

In

Config parameters in string format.
SerialInitString = " b, p, d, s, e, r " where:
b = 9600, 19200, 38400, 57600, 115200 baudrate.
p = n, e, o (none, even, odd) parity.
d = 8, 5-7 databits.
s = 1, 2 stopbits.
e = 0 (disable), 1 (enable) RS-485.
r = 0, 1-2048 RxBufferSize for Rx interrupt. (0
disables Rx interrupts).

NOTE: All parameters are optional. If not included, parameter will
be default. Default values listed first.

184

Chapter 13
Utility Functions
This chapter provides descriptions of Forth's utility functions.
Functions described in this chapter include the following:
o
o
o
o
o
o
o
o
o
o
o
o
o
o
o
o
o
o
o
o

Carriage Return
Carriage Return Delimiter
Change Mod
Core Left
Do Evaluate
Evaluate If Not Defined
End of Line
File Get Line
File Time
Current Time
Get Time
Quit
Save File
Set Time
Sleep (Delay in Seconds)
Sleep (Delay in Milliseconds)
Unlink File
Web Pick File
Web Pick Reader
Version

185

Forth Reference Guide

CR
Name
Carriage Return
Description
Prints a new line.
Signature
[a]
Parameters
None

186

Utility Functions

CRDelim
Name
Carriage Return Delimiter
Description
Changes the output format to use the carriage return (CR) as a
delimiter. The default behavior is the ANS standard.
Signature
[a]
Parameters
None

187

Forth Reference Guide

Chmod
Name
Change Mod
Description
Change the DOS file attributes for the specified file.
Signature
[Attrib "Filename" a ]
Parameters
Name

Type

Dir

Description

Attrib

Numeric

In

file attrib (from dos.h).
FA_NORMAL=0x00.
FA_RDONLY=0x00.
FA_HIDDEN=0x02.
FA_SYSTEM=0x04.

Filename

188

String

In

Name of file.

Utility Functions

Coreleft
Name
Core Left
Description
Return the amount of core memory available to malloc.
Signature
[aN]
Parameters
Name

Type

Dir

Description

N

Numeric

Out Number of bytes available.

189

Forth Reference Guide

DoEval
Name
Do Evaluate
Description
Repeatedly evaluate a section of code.
Signature
[ M N "Code" a ]
Parameters
Name

Dir

Description

M

Numeric

In

Do loop end.

N

Numeric

In

Do loop begin.

Code

190

Type

String

In

Code to execute.

Utility Functions

EvalIfNotDefined
Name
Evaluate If Not Defined
Description
Evaluates the word definition if the function is not defined.
Signature
[ "Colondefinition" "Name" a ]
Parameters
Name

Type

Dir

Description

Colondefinition

String

In

The colon definition as a string.

Name

String

In

Name of the function in
"colondefinition" to look for before
evaluating.

191

Forth Reference Guide

Endl
Name
End of Line
Description
Put an end-of-line string on the stack.
Signature
[ a "\n" ]
Parameters
Name

Dir

\n

192

Type

Description

String

Out End of line string.

Utility Functions

FGetLine
Name
File Get Line
Description
Read a line from the specified file.
Signature
[ "Filename" Linenumber a "ReadString"
Success ]
Parameters
Name

Type

Dir

Description

Filename

String

In

File to read.

Linenumber

Numeric

In

Line number to read (1 based).

ReadString

String

Out String that was read.
(NULL if nothing read).

Success

Numeric

Out 1 = Success.
0 = Failure (EOF or bad filename).

193

Forth Reference Guide

FileTime
Name
File Time
Description
Returns the UNIX time of the specified file.
Signature
[ "Filename" a Ftime] ]
Parameters
Name

Dir

Description

Filename

String

In

File name.

Ftime]

194

Type
Numeric

Out UNIX time from the OS timestamp
(last time file was written).

Utility Functions

CTime
Name
Current Time
Description
Returns the current time as a string.
Signature
[ a "Time" ]
Parameters
Name

Type

Dir

Description

Time

String

Out The current time, formatted as DD
MM YYYY hh:mm:ss.

195

Forth Reference Guide

GetTime
Name
Get Time
Description
Returns the time in UNIX format.
Signature
[ a CurrentTime ]
Parameters
Name

Dir

CurrentTime

196

Type

Description

Numeric

Out The current time, in seconds
elapsed from 00:00:00 January 1,
1970.

Utility Functions

Quit
Name
Quit
Description
Exit Forth or reboot reader.
Signature
[ Exitcode a ]
Parameters
Name

Type

Dir

Description

Exitcode

Numeric

In

Exitcode 55 = reboot reader.
All others = exit Forth.

197

Forth Reference Guide

SaveFile
Name
Save File
Description
Writes the contents of the text file "Filename". Returns 1 if
successful and 0 if not successful.
Signature
[ "FileContents" "FileName" a b ]
Parameters
Name

Type

Dir

Description

FileContents

String

In

Contents of file as a single string.

FileName

String

In

Name of file to write.

b

Numeric

Out 1 = Success.
0 = Failure.

198

Utility Functions

SetTime
Name
Set Time
Description
Set the time in UNIX format.
Signature
[ Time a ]
Parameters
Name

Type

Dir

Description

Time

Numeric

In

The current time, in seconds
elapsed from 00:00:00 January 1,
1970.

199

Forth Reference Guide

Sleep
Name
Sleep (Delay in seconds)
Description
Delays program execution (seconds).
Signature
[ n_secs a ]
Parameters
Name

Dir

Description

n_secs

200

Type
Numeric

In

Number of seconds to delay.

Utility Functions

Sleep_ms
Name
Sleep (Delay in milliseconds)
Description
Delays program execution (milliseconds).
Signature
[ n_millisecs a ]
Parameters
Name

Type

Dir

Description

n_millisecs

Numeric

In

Number of milliseconds to delay.

201

Forth Reference Guide

UnLink
Name
Unlink File
Description
Deletes a file from the file system.
Signature
[ "FileName" a B ]
Parameters
Name

Type

Dir

Description

FileName

String

In

Name of file to delete.

b

Numeric

Out 1 = Success.
0 = Failure.

202

Utility Functions

WebPickFile
Name
Web Pick File
Description
Returns a list of filenames as an HTML select control.
Signature
[ "ControlName" "Filemask" a "Filelist" ]
Parameters
Name

Type

Dir

Description

ControlName

String

In

Name of the form select control.

Filemask

String

In

DOS filemask.

Filelist

String

Out List of files that match as an HTML select control.
For example, lines from *.htm:
{% " fileToEdit " " *.prm " WebPickFile%}.
{% " uploadFilename " " *.hex " WebPickFile%}.

203

Forth Reference Guide

WebPickReader
Name
Web Pick Reader
Description
Generates an HTML select control with all attched reader
addresses.
Signature
[ "ControlName" a "HTML" ]
Parameters
Name

Dir

Description

ControlName

String

In

Name of control to produce.

HTML

204

Type
String

Out Select control in HTML.

Utility Functions

Version
Name
Version
Description
Displays the reader software version.
Signature
[ a Version ]
Parameters
Name

Type

Dir

Description

Version

Numeric

Out String version.

205

Forth Reference Guide

206

SAMSys Technologies, Inc.

Part Number: HI471-FR-RF-V1.2
Printed in U.S.A.


All Legacy 9320.zip > SAMsys Web Password.txt

http://old.samsys.com/default.php?alpha=company

Username: Guest
Password: samsys1105


All Legacy 9320.zip > MP9320_2.7_Users_Guide_V6.0.pdf

User's
Guide
MP9320 2.7 EPC
UHF Long-Range Reader

THE POWER TO CHOOSE

TM

SAMSys
MP9320 UHF Long-Range Reader
User's Guide
Sixth Edition (February 28, 2005)
(C) Copyright 2005 SAMSys Technologies, Inc. All Rights Reserved.
Disclaimer and Limitation of Liability
The content of this manual is for information use only and is subject to change without notice. SAMSys assumes no responsibility or liability for any errors
or inaccuracies that may appear in this publication. No part of this manual may be reproduced in any form or by any means, electronic, mechanical,
recording, or otherwise, without the prior written permission of SAMSys.
SAMSys products are not designed, intended, authorized or warranted to be suitable for life support applications or any other life critical applications
which could involve potential risk of death, personal injury, property damage, or environmental damage.
About SAMSys
SAMSys Technologies, Inc. is a world-leading provider of RFID reader hardware solutions in the LF, HF, and UHF segments of the RFID marketplace.
SAMSys is a public company listed on the Toroto Stock Exchange under the symbol SMY.
SAMSys Technologies, Inc.
44 East Beaver Creek Rd., Unit 11
Richmond Hill, Ontario L4B 1G8 Canada
Phone: (905) 707-0404
Toll Free: (877) 463-6546
Fax: (905) 707-9944
E-mail: samsys@samsys.com
Web: www.samsys.com
Part Number: HI46932-01-OM-V6.1

Federal Communications Commission (FCC) Notice (Preliminary)
This device was tested and found to comply with the limits set forth in Part 15 of the FCC Rules. Operation is subject to the following conditions: (1) this
device may not cause harmful interference, and (2) this device must accept any interference received including interference that may cause undesired
operation. These limits are designed to provide reasonable protection against harmful interference when the equipment is operated in a commercial
environment.
This device generates, uses, and can radiate radio frequency energy. If not installed and used in accordance with the instruction manual, the product may
cause harmful interference to radio communications. Operation of this product in a residential area is likely to cause harmful interference, in which case,
the user is required to correct the interference at their own expense.
The authority to operate this product is conditioned by the requirements that no modifications be made to the equipment unless the changes or
modifications are expressly approved by SAMSys Technologies.
Trademarks
SAMSys is a trademark of SAMSys Technologies, Inc.
HyperTerminal(R) is a registered trademark of Hilgraeve, Inc.
EPC is a trademark of EPCglobal, Inc.
Other company, product or service names appearing in this manual may be trademarks or service marks of their respective owners.

MP9320 User's Guide

Contents
Chapter 1 - Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Unpacking the Reader . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
About the MP9320 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Physical Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

1
2
3
4

Chapter 2 - Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Antenna Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Reader Mechanical Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
RS-485/Ethernet Communication Selection . . . . . . . . . . . . . . . . . . . . . . .
Serial (RS-232) Communication Setup . . . . . . . . . . . . . . . . . . . . . . . . . . .
Ethernet LAN Communication Setup . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Installing the RF Command Suite Application . . . . . . . . . . . . . . . . . . . . .
Configuring the IP Address . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Digital (TTL) Input/Output Setup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Transmit Power Calibration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Connecting to an ICCM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

7
8
10
13
13
14
15
15
16
17
17

Chapter 3 - Operation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
MP9320 Power Up and Initialization . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Starting RF Command Suite . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Setting the RF Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Selecting the Number of Antennas . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Selecting Tag Protocols . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Enabling or Disabling Tag Protocols . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Reading Tags . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Writing Blank Tags . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Modifying Tags . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Operation with the ICCM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

19
20
21
21
21
22
22
23
25
26
27

Chapter 4 - Troubleshooting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
General Troubleshooting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
Contact Us . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
Chapter - Specifications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Reader Specifications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Environmental Specifications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Battery Specifications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Power Supply Specifications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
RS-232 Connector Specifications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
RS-485 Connector Specifications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
RS-485/Ethernet Jumper Setting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Ethernet LAN Connector Specifications . . . . . . . . . . . . . . . . . . . . . . . . . .
Digital I/O Connector Specifications . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Optional Communication Cable Specifications . . . . . . . . . . . . . . . . . . . .
Suitable Antenna Specifications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Regulatory Standards . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Emissions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Immunity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Safety . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

33
34
34
34
34
35
35
36
36
37
38
39
40
40
40
40
i

MP9320 User's Guide

Appendix A - Reader Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Operating Modes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Default Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configuring the Reader with RF Command Suite . . . . . . . . . . . . . . . . . .
Updating Reader Firmware with RF Command Suite . . . . . . . . . . . . . . .
Updating Reader Firmware using the ICCM . . . . . . . . . . . . . . . . . . . . . . .
Using CHUMP Commands to Configure the Reader . . . . . . . . . . . . . . . .

41
42
42
43
46
48
49

Appendix B - Tag Programming . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Overview of the Tag Writing Commands . . . . . . . . . . . . . . . . . . . . . . . . .
Programming the EPC1 Tag . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Programming the ISO18000-6A Tag . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Programming the ISO18000-6B Tag . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Programming the Impinj EPC0 Tag . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Programming the Matrics Class 0+ Tag . . . . . . . . . . . . . . . . . . . . . . . . . .

51
52
53
55
56
58
60

Appendix C - Configuring the IP Address . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65
Ethernet IP Address Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66
IP Address Setup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66

ii

MP9320 User's Guide

Figures
MP9320 Reader and Accessories . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
SAMSys Reader Network . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
MP9320 LED Status Indicators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
MP9320 Active Antenna LED Indicators . . . . . . . . . . . . . . . . . . . . . . . . .
MP9320 End-Panel Connectors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
MP9320 Antenna Configurations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
MP9320 Reader Installations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
MP9320 Base Plate with Mounting Keyholes . . . . . . . . . . . . . . . . . . . . . .
MP9320 Standalone RS-232 Communication Setup . . . . . . . . . . . . . . . .
MP9320 Ethernet LAN Communication Setup . . . . . . . . . . . . . . . . . . . . .
Digital Input/Output Port Configuration . . . . . . . . . . . . . . . . . . . . . . . . . .
MP9320 Standalone/ICCM Communication Setup . . . . . . . . . . . . . . . . .
LED Startup Sequence . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Active Antenna LED Indicators - Antenna 2 Transmitting . . . . . . . . . . . .
Protocol Selection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Reader Configuration Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
RF Command Suite Tag Summary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Select Tag Protocol . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Write Blank Tag . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Select Tag to Modify . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Modify Tag Option . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Interrogator Control and Concentrator Module . . . . . . . . . . . . . . . . . . . . .
RS-232 Connector . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
RS-485 Connector . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Ethernet LAN Connector . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Digital I/O Connector . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Optional Communication Cable Pinouts . . . . . . . . . . . . . . . . . . . . . . . . . .
Reader Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
RS-232 Serial Port Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Serial and RF Mode Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Protocol Parameter Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Firmware Upload System Configuration . . . . . . . . . . . . . . . . . . . . . . . . . .
Upload File Controls . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Digi Device Discovery Application Window . . . . . . . . . . . . . . . . . . . . . .
Digi Device Discovery Web Interface Window 6 . . . . . . . . . . . . . . . . . . .
Digi Device Discovery Serial Configuration Window . . . . . . . . . . . . . . .
Reader Serial Port Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

2
3
4
5
5
8
10
11
13
14
16
17
20
20
22
24
24
25
25
26
26
27
35
35
36
7
38
3
44
44
45
46
47
66
7
67
68

iii

MP9320 User's Guide

iv

Chapter 1
Introduction
This chapter provides a general description of the MP9320 EPC Reader. Topics discussed
in this chapter include the following:
o

Unpacking the Reader

o

About the MP9320

o

Physical Description

1

MP9320 2.7 User's Guide

Unpacking the Reader
After opening the shipping container perform the following:
1. Unpack the contents of the shipping container.
2. Inspect the shipping container for damage. If damaged, notify the carrier and SAMSys
Technologies. Keep the shipping materials for inspection by the carrier.
3. Verify your reader package includes the following items:
o
o
o
o
o
o
o
o

MP9320 UHF Reader
Power cord
15 Vdc power supply with cable
Sample RFID tags
RS-232 communication cable
Ethernet LAN Cable
System documentation CD
Antennas (optional)

E

TH

ER
W

PO
T
TO
SE

OO

CH

na

ten

An
tive2

4

3

Ac
1

ult

Fa

r

we

Po

nse

Se

it

sm

n
Tra

PCr
.7 Eeade
0 2 ge R
32 an
P9 Long-R
MF

2

-23

UH

RS
ax
pm
am
2.5 ital I/O
Vdc Dig
(15 &
er -485
ow RS

)

P

Figure 1-MP9320 Reader and Accessories

2

Introduction

About the MP9320
The MP9320 is one of the most advanced UHF readers in the industry. This multi-protocol
device currently supports many of today's most popular UHF tags including EPC and
ISO. This reader, recognizes multiple protocols simultaneously during operation. With
full-duplex capability, the device can read or write to any tag, depending on the tag
capabilities.
The MP9320 incorporates a scalable architecture that enables the reader to be
implemented as a stand-alone UHF solution or included in a networked reader
environment using the embedded TCP/IP device server and Ethernert LAN connection.
With its extended read range and high data rates, the MP9320 is especially suited for asset
management and logistics applications requiring the simultaneous reading of a large
number of tags at greater distances. Typical RFID applications supported by the MP9320
include the following:
o

Warehouse Logistics

o

Inventory Management

o

Asset Management

o

Pallet Tracking

o

Parking Lot Access

o

Aggregated Container Tracking

o

Loading Dock Portals

A

ct

iv

e

A

nt

en

na

4
3

2

er
S
sm

32

0

2.7

EP

C

Tr

an

it

en

se

P

ow

Fau

lt

1

ader

Re

32

P9

-2
S
R
er

RS (
-4 15
85 Vd
& c 2.
Di 5
git am
al p
I/O m

P

ow

ax

)

M

ange

ng-R

F Lo

UH

A

ct

iv

e

A

nt

en

na

4
3

2

er
S
sm

ader

Re

ng-R

32

F Lo

P9

R

S

-2

UH

er

RS (
-4 15
85 Vd
& c 2.
Di 5
git am
al p
I/O m

P

ow

ax

)

M

ange

M
UH P93
F 20
Re 2
ad .7
er EP
C

32

0

2.7

EP

C

Tr

an

it

en

se

P

ow

Fau

lt

1

A

ct

iv

e

A

nt

en

na

4
3

2

P

er

32

0

2.7

EP

C

S
en
Tr
se
an
sm
it

ow

Fau

lt

1

ader

Re

32

P9

-2
S
R
er

RS (
-4 15
85 Vd
& c 2.
Di 5
git am
al p
I/O m

P

ow

ax

)

M

ange

ng-R

F Lo

UH

b
Hu
net r erver
er o S
Eth
rk
two
Ne
Ba

y Ne

Eth
ern
et L
A

N

ks
twor

Figure 2-SAMSys Reader Network

3

MP9320 2.7 User's Guide

In addition to the scalable, multi-protocol architecture, the MP9320 includes the following
features:
o

LED indicators

o

(4) antenna ports

o

Multiple host interface connections (RS-232, RS-485, Ethernet LAN)

o

Digital input and output lines

o

Integrated real-time clock with battery backup (optional)

o

On-board temperature sensor (optional)

Physical Description

NOTE: The reader enclosure is designed for office, indoor warehouse, and light

manufacturing areas. If a sealed reader is required for wet or hazardous
environments, contact your SAMSys representative.

The digital board contains four LED indicators to provide the operational status of the
reader. The LEDs are visible on the front panel of the reader.

Fault
Power
Sense
Transmit

Figure 3-MP9320 LED Status Indicators

Indicator

Description

Fault

Red

Error condition exists

Power

Green

Power is applied to the reader and
processor initialization complete

Sense

Green

Reader has tag data to report.This LED
also flashes when the reader software
is being loaded.

Transmit

4

Color

Green

Transmitter is operating and RF power
is applied to one of the antennas

Introduction

In addition to the status LEDs, four Active Antenna LEDs provide indication that RF
power is being applied to one of the four antennas. Two LEDs (not shown) are also
provided on the Ethernet LAN connector to indicate network communication status.

Active Antennas
1

2

3

4

Figure 4-MP9320 Active Antenna LED Indicators

Four SMA type antenna ports are provided on the end panel. The reader also has one
power and four communication interface connectors on the opposite end panel.

Ethernet Port
RS-485 Port
Power

RS-232 Port

Digital I/O
Port

Antenna
RF Ports
Figure 5-MP9320 End-Panel Connectors

5

MP9320 2.7 User's Guide

6

Chapter 2
Installation
This chapter provides information for installing the MP9320 Reader. Topics
discussed in this chapter include the following:
o

Antenna Installation

o

Reader Mechanical Installation

o

RS-485/Ethernet Communication Selection

o

Serial (RS-232) Communication Setup

o

Ethernet LAN Communication Setup

o

Configuring the IP Address

o

Digital (TTL) Input/Output Setup

o

Transmit Power Calibration

o

Connecting to an ICCM

7

MP9320 2.7 User's Guide

Antenna Installation
The MP9320 supports from one to four external antennas in a variety of
configurations. One- and two-antenna configurations are typical for most conveyor
and container tracking. Four-antenna configurations are used for portals and
loading dock doorways.

Dual Antennas
(Stacked)
Single Antenna

Four Antennas
(Portal Configuration)
Dual Antennas
(Opposing)

Figure 6-MP9320 Antenna Configurations

Warning
The SAMSys MP9320 UHF Reader is equipped with four (4) RF ports. To prevent reader
damage, active RF ports must be properly terminated with a 50 ohm load or a functional
UHF RFID antenna before power up. UHF Readers are factory configured to operate on
RF port 1. As a result, port 1 must be properly terminated before initially powering on the
reader. Before activating any additional RF ports, they must also be properly terminated.
Never power up the reader unless the appropriate loads or antennas are connected.
Always power down the reader before removing an antenna or load from an RF port.
Activation of these RF ports is controlled by the internal MCW and MSW registers as
described in the MP9320 User's Guide, the MP9320 Field Installation Guide, and the
Comprehensive Heuristic Unified Messaging Protocol (CHUMP) Reference Guide.

8

Installation

The MP9320 is factory calibrated for operation with the following type of antenna
and cable:
Antenna Parameter

FCC

ETSI

Frequency

902-928 MHz

865-870 MHz

Polarization

Circular

Circular

Gain, dBic

9, max

6, max

VSWR, maximum

1.5:1

1.5:1

Cable Parameter

Value

Type

RG58C/U

Length

2 Meters

Connector

SMA type plug, reader side

It is highly recommended that the antenna mounting be adjustable in order to
obtain the best performance from the system. However, the antennas must be
installed on a solid surface or frame to prevent damage or later misalignment.
Perform the following to install the antennas.
NOTE: Use the existing mounting holes on the antenna flange. Drilling new holes in the flange is
not recommended.

1.

Determine the location of each antenna. Ensure the antenna(s) will not be
vulnerable to damage by moving inventory or equipment.

2.

Use the antenna as a template and mark the mounting holes.

3.

Drill and tap (if necessary) mounting holes for #10 or 1/4 inch mounting
screws. For drywall mounting, use drywall anchors or toggle screws.

4.

Mount each antenna and install the mounting screws. Do not overtighten the
screws. Damage to the antenna case may result.

5.

Route each antenna cable back to the reader location. For dual-opposing or
portal configurations, route the opposing cables so they can not be damaged
by equipment or personnel.

6.

Secure each antenna cable with wire ties or other restraint.

9

MP9320 2.7 User's Guide

Reader Mechanical Installation
The MP9320 is designed for easy installation. The following instructions provide
the information to install your UHF reader.
As shown in Figure 7, the reader is designed for horizontal or vertical installation.
Mounting keyholes are provided on each side of the base plate for easy, nonpermanent, installation and removal.
Caution
To ensure proper cooling of the reader, verify that the fan intakes and vents are free of
obstructions.

na

4

Anten
3
Active
2
1

Fault
r
Powe
Sense
mit
Trans

er

20 Read
93 ge
MPLong-Ran
UHF

2
RS-23
max)
Vdc

amp
2.5 I/O

r (15 & Digital
Powe
RS-485

na

tive
Ac 2

4

ten

An

3

1

ult

Fa

r

we

Po

nse

Se

t

nsmi
Tra

PC
.7 E er
0 2 Read
32 ange

P9 -R
MF Long
UH

2

-23

RS
p ma
am
2.5 I/O
Vdc ital

x)

r (15 & Dig
we -485
RS

enn

a
3

iv
2

lt
er

it

Pow
Sen

Tra

nsm

se

Fau

1

Act

e

Ant

4

Po

er

-23
RS

2

20 ge Read
93 -Ran
MP Long
UHF

er
Pow

max)
ampI/O

2.5
Vdc Digital
(15 &
RS-485

Figure 7-MP9320 Reader Installations

For horizontal or table table mounting, ensure the reader and all cabling is secured
to the surface or frame.
SAMSys recommends that the MP9320 be mounted on a horizontal surface.
However, if vertical surface installation is required, refer to the following sections
for the appropriate mounting. As shown in Figure 8, keyhole slots are provided for
easy installation and removal.

10

Installation

6.40 in (162.5 mm)

.359 in ?
(9 mm)
5.0 in
(127 mm)

Figure 8-MP9320 Base Plate with Mounting Keyholes

Hollow Concrete Block Wall Mounting
To temporarily mount the MP9320 to a hollow concrete block wall, SAMSys
recommends metal sleeve type concrete anchors that accept a #10 screw and flat
washer. To install the MP9320 on a hollow concrete block wall, perform the
following.
1.

Refer to Figure 8, and mark the location of the mounting screws. Do not
install the anchors into the mortar joint.

2.

Drill the appropriate size hole for a metal sleeve type anchor.

3.

Install the anchors.

4.

Install the washers and insert the screws.

5.

Tighten the screws to within .375" of the anchor.

6.

Install the reader and finish tightening the screws.
11

MP9320 2.7 User's Guide

Solid Concrete Wall Mounting
To temporarily mount the MP9320 to a solid concrete wall, SAMSys recommends
one-piece expansion type concrete anchors that accept a #10 screw and flat
washer. To install the reader on a concrete wall, perform the following.
1.

Refer to Figure 8, and mark the location of the mounting screws.

2.

Drill the appropriate size hole for a expansion type anchor and install the
anchors.

3.

Install the washers and insert the screws.

4.

Tighten the screws to within .375" of the anchor.

5.

Install the reader and finish tightening the screws.

Wood or Metal Wall Mounting
To temporarily mount the MP9320 to a wood or sheet metal wall, SAMSys
recommends either #10 x 1 inch wood screws or #10 x 3/4 inch sheet metal screws
and washers. To install the reader on a wood or metal wall, perform the following.
1.

Refer to Figure 8, and mark the location of the mounting screws.

2.

Drill the appropriate size hole for screws.

3.

Install the washers and insert the screws.

4.

Tighten the screws to within .375" of the surface.

5.

Install the reader and finish tightening the screws.

Drywall Mounting
To temporarily mount the MP9320 to drywall, SAMSys recommends either #10
toggle bolts or #10 drywall anchors.
NOTE: There are many types of screw-in, hammer-in, and predrill drywall anchors. Each one is
designed for specific applications and pull-out ratings. Ensure that the anchor you select
has a pull-out rating of at least 12 lbs.

To install the MP9320 on drywall, perform the following.
1.
2.

Refer to the anchor manufactureres instructions for installing the anchors.

3.

Install the washers and insert the screws.

4.

Tighten the screws to within .375" of the surface.

5.
12

Refer to Figure 8, and mark the location of the mounting screws.

Install the reader and finish tightening the screws.

Installation

RS-485/Ethernet Communication Selection
The MP9320 is equipped with both RS-485 and Ethernet communication ports.
However, only one can be selected at a time. The reader is typically shipped with
Ethernet communication enabled. To enable RS-485 communication, perform the
following:
Caution - ESD
The following procedures involve electrostatic discharge sensitive components. ESD
protection is required. Damage to the reader can occur if proper ESD equipment such as
grounded wrist straps and ESD protected work surfaces are not used.

1.
2.

Disconnect all power and communication cables from the reader.
Remove the outer reader cover by removing the 8 screws on each side and
carefully lifting the cover straight up.
Locate Jumper J4 on the connector end of the digital board (top circuit
board).
Move the jumper to Pins 1-2 (Pin 1 is closest to the end of the board).
To re-enable Ethernet communication, move the jumper to Pins 2-3.
Replace the cover and the 16 screws.

3.
4.
5.
6.

Serial (RS-232) Communication Setup
The reader is equipped with a 9-pin RS-232 communication port for
communication directly with a PC or other serial device. Refer to the
Specifications chapter for information on the port.

ct
A

3

S
nsm
Tra

it

en

se

P

ow

er

Fa

ul

t

1

2

iv

e

A

nte

nn

a

4

DB-9 Connector
C

er

EP

e

Re
ad

2.7

P

ow
er

RS (
-4 15
85 Vd
& c 2.
Di 5
gi am
ta
l I/O p

m

ax

)

R

UH

S

F

-2

32

Lo
n

g-R

an
g

20

93

MP

5

4
9

3
8

2
7

1
6

RS-232 Link

Pow

(
erRS-485
15

0ange
g-R
P932
MUHF Lon
Tra

max)
amp
2.5 al I/O
Vdc Digit
&

RS

-23

2

Read

er

nsm

it

Sen

se

Pow
Fau

er

lt

1

Act

2

ive

Ant

a
enn3

4

RS-232 Cable

Figure 9-MP9320 Standalone RS-232 Communication Setup

NOTE: A serial port adapter may be required if the device has a different connector type. For
example, some PCs may have 25-pin serial connectors.

13

MP9320 2.7 User's Guide

Every effort has been made to ensure the MP9320 is configured to match your
application. However, it is recommended that the reader configuration be verified
before placing the reader into service. If the system is to be used as a local,
standalone reader connected to a terminal or PC, perform the following:
1.

Verify all antennas, cabling and power supplies are secure.

2.

Verify the operator terminal or PC is connected to the reader and operational.

3.

Power up the reader.

4.

Launch RF Command Suite.

5.

Set the terminal serial port parameters to default values (9600, 8, 1, none).

6.

Introduce a test tag into the RF field.

7.

Verify the tag was read correctly.

8.

If the tag did not read correctly, use RF Command Suite to verify the reader
operating mode matches the application requirements (refer to Appendix A).
If necessary, reconfigure the reader operating modes.

NOTE: Refer to the RF Command Suite User's Guide and the Comprehensive Heuristic
Unified Messaging Protocol (CHUMP) Reference Guide for detailed information
on configuring the reader.

Ethernet LAN Communication Setup
The MP9320 can be networked with other readers on an enterprise 10/100 BaseT
Ethernet LAN. Each reader is equipped with an embedded IP device server that
allows the unit to be assigned an IP address. This address can then be accessed by
your network server or host computer.
Ethernet Link

Pow

(
erRS-485
15

Pow

Pow

(
erRS-485

(
erRS-485
15

0ange
g-R
P932
MUHF Lon

15

max)
amp
2.5 al I/O
Vdc Digit
&

RS

0ange
g-R
P932
MUHF Lon

-23

2

Read

er

max)
amp
2.5 al I/O
Vdc Digit
&

0ange
g-R
P932
MUHF Lon

RS

-23

2

max)
amp
2.5 al I/O
Vdc Digit
&

RS

-23

2

Read

er

Read

er
Tra

nsm

it

Sen
Tra

nsm

it

se

se

Pow

er

er

Fau

lt

1

Act

1

Act

2

ive

Ant

4

Ant

a
enn3

4

4

a
nn
3

P
ow

S
en
Tra
se
nsm
it

er

Fa

ul
t

1

2

iv
e

A
nte

4

32
S
-2
R
er
P
ow

Figure 10-MP9320 Ethernet LAN Communication Setup

Ba

y Ne

twork

s

a
enn3

a
enn3

2

ive

Ant

A
ct

2

RJ-45 Connector

ive

2.5
Vdc Dig
(15 5 &
-48
RS

Act

lt
x)

p ma
am I/O
ital

14

Pow
lt

1

er

Fau

PCer
.7 E ad
0 2 ge Re
32 -Ran
P9 ng
MUHF Lo

Fau

it

Sen

se

Pow

Tra

nsm

Sen

Ethernet LAN
Server or Hub

Installation

Installing the RF Command Suite Application
The SAMSys RF Command Suite is a Microsoft Windows application that
provides a Graphical User Interface (GUI) for SAMSys RFID Reader Products.
The application allows you to easily view tag data, configure the reader, and perform other
tag data functions. In addition, the RF Command Suite is the preferred method for sending
CHUMP commands to a reader. The RF Command Suite application is provided on the
CD shipped with your reader and can be installed on a personal computer. To install RF
Command Suite, refer to Chapter 1 - Introduction in the RF Command Suite User's
Guide.

Configuring the IP Address
The MP9320 is equipped with an optional TCP/IP Ethernet port and embedded IP
device server. This reader is configured for automatic IP address allocation using
the Dynamic Host Configuration Protocol (DHCP) Mode and the reader
automatically extracts the IP address from the DHCP server. This is the default
mode for the reader as it is shipped from the factory.
In the event that you need to manually configure the IP address and Baud rate,
refer to Appendix C for detailed instructions.

15

MP9320 2.7 User's Guide

Digital (TTL) Input/Output Setup
The MP9320 is equipped with a digital I/O port that provides four logic-level
(TTL) input signals and four output signals. Refer to the SAMSys Forth
Programming Language Reference Guide for programming information. The
digital inputs are optically isolated. The outputs are open collector.

Typical TTL
output circuit
(user supplied)

Digital Inputs

Digital Outputs

+5 Vdc

4.7K

Input
Common

DIN0

DOUT0

Filter

DOUT1

5-24 Vdc

Filter

DOUT2

Filter

DOUT3

Filter

4.7K

DIN1

4.7K

DIN2

4.7K

60 V max
500 mA max
Non-inductive

DIN3

4.7K
Output
Common

Typical input
drive circuit
(user supplied)

Typical Filter

Figure 11-Digital Input/Output Port Configuration

Signal Name

Description

DIN0
DIN1
DIN2
DIN3
Digital input common
DOUT0
DOUT1
DOUT2
DOUT3
Digital output common

16

Pin No.
7
14
13
5
8, 15
4
11
10
2
1,9,3,6,12

Digital Input 0 - optically isolated
Digital Input 1 - optically isolated
Digital Input 2 - optically isolated
Digital Input 3 - optically isolated
Input commmon
Digital Output 0 - open collector
Digital Output 1 - open collector
Digital Output 2 - open collector
Digital Output 3 - open collector
Output common

Installation

Transmit Power Calibration
The MP9320 can be operated with a variety of commercially available antennas
and coaxial cables. As a result, the output RF power of the reader must be
configured to optimize the read range for a given antenna configuration, while not
violating FCC or CE regulations.
Calibration of the reader transmit RF power must only be performed by SAMSys
authorized installation personnel or certified resellers.

Connecting to an ICCM
The MP9320 can be operated as a standalone reader with the Interrogator Control
and Concentrator Module (ICCM) using the RS-232 communication links. For
RS-485 communication setup, refer to Networked Reader Communication Setup
section.

ew lt
t Vi au
Se Def
as

Po

r (15 5 &
we RS-48

p ma
am I/O
2.5
Vdc Digital

x)

RS

20ange Re
P93 -R
MUHF Long

-23

2

2

m
ste
ork t Sy
en
or
nit s
Mo Tag

just st
Ad ntra
Co
t
Se lightff
ck O
Ba On/

t

00

tw
Ne pm
M
ICC evelo
D

nsmi

IC

us
Stat

Fault
r
we
Po
nse
Se

SD

Tra

C_

ader

c2
De
ys
MS M_12

SA

1

e An
Activ 2

ten

3

na

4

RS-232 Link

Ethernet LAN Cable

P5 DB25P

P3 DB9P

P1 DB9S
4

3
2

P6 DB25S

P4 DB9P

P2 DB9S

1

J8
RP34-4
DC+5V

Figure 12-MP9320 Standalone/ICCM Communication Setup

17

MP9320 2.7 User's Guide

After connecting the reader to the ICCM with the serial communication, perform
the following:
1.
2.

Power up the reader and ICCM and verify both are operational.

3.

Press the status button on the ICCM display to obtain the ICCM IP address.

4.

Launch your web browser and access the Web-Based Administration tool.
Refer to Chapter 5 in the Interrogator Control and Concentrator Module
User's Guide for information on using the Web Administration tool.

5.

Press Auto-Find Readers on the Main Menu of the administration tool.
Follow the instructions in the ICCM User's Guide to locate the reader.

6.

Introduce a test tag into the RF field.

7.

18

Verify all antennas, RS-232 cabling, Ethernet LAN cabling, and power
supplies are secure.

Click the Tag Inventory button on the Main Menu to verify the tag was read
correctly.

Chapter 3
Operation
This chapter provides general information to operate the MP9320 Reader. Topics
discussed in this chapter include the following:
o

MP9320 Power Up and Initialization

o

Setting the RF Mode

o

Selecting the Number of Antennas

o

Selecting Tag Protocols

o

Enabling or Disabling Tag Protocols

o

Reading Tags

o

Writing Blank Tags

o

Modifying Tags

o

Operation with the ICCM

19

MP9320 2.7 User's Guide

MP9320 Power Up and Initialization
When the power supply is connected, the reader starts an internal initialization sequence.
This sequence momentarily lights the LEDs as follows:
1. Transmit and Sense on momentarily, then off
2. Sense flashes
3. Power flashes
4. Fault flashes
5. All four flash
6. Transmit and Power flash
7. Beeper on
If the Fault LED illuminates during the intialization sequence, the reader has detected a
software load fault. Restart the reader to clear the fault.

Fault

Fault

Fault

Fault

Fault

Fault

Power

Power

Power

Power

Power

Power

Sense
Transmit

Sense
Transmit

Sense
Transmit

Sense
Transmit

Sense
Transmit

Sense
Transmit

Figure 13-LED Startup Sequence

The reader is operational when the Power LED remains on.
After the startup sequence, the RF multiplexer in the MP9320, alternately provides RF
power to each of the four antennas. The Active Antenna LEDs indicate which antenna is
transmitting.

Active Antennas
1

2

3

4

Figure 14-Active Antenna LED Indicators - Antenna 2 Transmitting

NOTE: The number of antennas and the antenna transmit sequence is user configurable
depending on the application. Refer to the following sections and Appendix A for more
information on reader configuration.

20

Operation

Starting RF Command Suite
In order to verify your installation, start RF Command Suite. This application provides the
ability to view your reader configuration and make any needed adjustments. You can also
use the application to view tag data read by the MP9320. For information on installing and
operating the RF Command Suite, refer to the RF Command Suite User's Guide.

Setting the RF Mode
The MP9320 is factory configured for continuous RF scanning or "auto-read" mode. This
mode is equivalent to mode selected by the Auto Read function key on the RF Command
Suite Command interface window.
If desired, you can reconfigure the reader for Polled RF mode (reader activates the
transmit carrier and waits for host to send a read command). Select the Polled Read
function key to activate Polled RF mode.
To halt the Auto Read or Polled Read mode, press the RF Off function key.

Selecting the Number of Antennas
The MP9320 is factory configured to operate with one antenna connected to Port 1.
However, the reader can operate with up to four (4) antennas. If additional antennas are to
be installed, use RF Command Suite to select the number of antennas:
From the RF Command Suite Command interface window, select function set four (4)
and then select one of the following function keys:

F1

1 Antenna (0)

Sets the reader to use antenna 0.

F2

1 Antenna (1)

Sets the reader to use antenna 1

F3

1 Antenna (2)

Sets the reader to use antenna 2.

F4

1 Antenna (3)

Sets the reader to use antenna 3.

F5

2 Antennas (0,1)

Sets the reader to use antennas 0, 1.

F6

3 Antennas (0,1,2)

Sets the reader to use antennas 0, 1, and 2.

F7

4 Antennas

Sets the reader to use all four antennas.

Warning
The SAMSys MP9320 UHF Reader is equipped with four (4) RF ports. To prevent reader
damage, active RF ports must be properly terminated with a 50 ohm load or a functional
UHF RFID antenna before power up. UHF Readers are factory configured to operate on
RF port 1. As a result, port 1 must be properly terminated before initially powering on the
reader. Before activating any additional RF ports, they must also be properly terminated.
Never power up the reader unless the appropriate loads or antennas are connected.
Always power down the reader before removing an antenna or load from an RF port.

21

MP9320 2.7 User's Guide

Selecting Tag Protocols
The MP9320 is factory configured with only those protocols selected by the user. Once
protocols are activated, the Command tab function keys can be used to select the protocol.
These function keys are programmed with specific command sequences required by the
reader to select a particular protocol. To select a specific protocol, perform the following:
1. Select the Command interface window.
2. Select Function Set 2 or 3 and locate the required protocol.
3. Press the function key to select the protocol.
4. To view the commands performed by this function, hold the mouse pointer over the
key or right click while holding the mouse pointer over the key and select Edit Macro.
5. Do not change the command sequnce unless you are experienced using SAMSys
CHUMP commands to configure readers.

Enabling or Disabling Tag Protocols
If you are experienced with SAMSys reader configuration, you can enable, disable, or
modify protocols to match specific requirements. To verify which protocols are activated
for your reader, navigate to the Reader Config interface window and select:
Reader Configuration
Protocol Select Mask

General Configuration

Operating Mode

Activated protocols will be listed and whether they are enabled or disabled. To enable or
disable a different protocol, perform the following:
1.

Select the Protocol Select Word (PSW) parameters as shown in the following:

Figure 15 - Protocol Selection

2.

Enable or disable a protocol by using the selectors on the right side of the display
and press Send Changes to Reader
. See the following note.

3. To modify the selected protocol, select the Protocol Configuration Word and
make any required changes.
NOTE: Only enable one protocol at a time. Enabling multiple protocols can result in reduced tag
reading performance.

For detailed information on reader configuration using RF Command Suite, refer to the
RF Command Suite Users Guide.
22

Operation

Reading Tags
Tag Reading Overview
When the reader completes the initialization sequence, the reader activates the RF field
and, depending on the configuration, begins transmitting read detect (Rd) commands at
the specified frequency. When a tag is placed within range, the reader activates the tag and
reads the data. The following example shows a typical Rd return message with ASCII tag
data that was returned by the reader:
{Rd,d:E016000000000D53,t:IS186A;C4

Reading Tags Using RF Command Suite
RF Command Suite is automatically configured to display tag data as the data is received
from the reader. However, tool settings can be changed to match your requirements. Refer
to the following sections and the RF Command Suite User's Guide to configure the
application.
To read tags, perform the following:
1.

Select the Reader Config Interface and verify the function keys are programmed
correctly for your reader.

2.

Verify your reader is enabled for the correct tag protocol. Select:
Reader Configuration General Configuration
Protocol Select Word
Reader Configuration General Configuration
Protocol Select Mask

3.

Operating Mode
Operating Mode

Verify the reader is configured for the correct operating mode. Select:
Reader Configuration General Configuration
General Configuration Word

4.

Operating Mode

To configure the reader to actively scan for tags, set the following General
Configuration Word parameters:
Serial Mode = Continuous
RF Mode = Continuous
RF Idle RF On when Idle

23

MP9320 2.7 User's Guide

Figure 16-Reader Configuration Parameters
5.

Select the Tag Summary interface. When tags are read, they are displayed in the
window and the statistics are updated.

Figure 17-RF Command Suite Tag Summary
24

Operation

Writing Blank Tags
RF Command Suite can be used to write unprogrammed or blank tags. To write blank
tags, perform the following:
1.

Select the Command Interface and verify the reader is connected and the correct
protocol is selected.

2.

Place the reader in Polled Read mode.

3.

Verify a single tag is in the RF field of the reader.

4.

Select the Tag Summary Interface.

5.

Select the protocol from the pull-down above the Write Blank Tag button.

Figure 18-Select Tag Protocol
6.

Press the Write Blank Tag
display the tag data box.

button to begin the operation and

Figure 19-Write Blank Tag
7.

Fill in the appropriate data (in Hex) and press the Write
the data to the tag.

button to write

NOTE: For detailed information on the various tag protocols and how each protocol is
programmed, refer to Appendix A -Tag Programming.

25

MP9320 2.7 User's Guide

Modifying Tags
RF Command Suite can be used to modify previously programmed tag data. To modify
tags, perform the following:
1.

Select the Tag Summary Interface and right-click on the tag.

Figure 20-Select Tag to Modify

2.

Select Modify Tag. The tag data window is displayed.

Figure 21-Modify Tag Option
3.
4.

Enter the data Length and actual Data for the specific address

5.

Select if ASCII data and whether or not there is a Single tag in field.

6.

After all data and parameters are entered, press Write

7.

26

Select the Address from the pull-down.

Repeat for each address.

.

Operation

Operation with the ICCM
The Interrogator Control and Concentrator Module (ICCM) provides greater flexibility for
accessing, configuring, and manage SAMSys readers. With the ICCM, you can access
your RFID data with your own client/server applications, perform administrative
functions from an easy-to-use Web interface, and remotely perform debug activities on
your readers.
The ICCM also has a 1/4 VGA touch screen LCD. The LCD can be used to provide an
operator interface for applications running directly on the ICCM. This allows for local
access to RFID data and applications in environments where a remote application server is
not available or required.

iew lt
tV u
Se s Defa
a

t
jus st
Ad ntra
Co

m
ste
k
or Sy
tw nt
Ne m e
r
M lop
ito
on ags
ICC eve
MT
D
2

0
20

t
t
Se kligh ff
c
Ba On/O

ec
s
Sy 12D
AM CM_

S

I

SD

C_

l
inae
d
Term o
M

tus
Sta

Figure 22-Interrogator Control and Concentrator Module

The ICCM includes an integrated 10baseT Ethernet LAN interface. You can use the
Ethernet connection to establish communication between your reader and a LAN-attached
application server.
Contact your SAMSys representative for more information on the ICCM product or visit
the SAMSys web site at www.samsys.com.

27

MP9320 2.7 User's Guide

28

Chapter 4
Troubleshooting
This chapter provides general information to troubleshoot the MP9320 Reader. Topics
discussed in this chapter include the following:
o

General Troubleshooting

o

Contact Us

29

MP9320 2.7 User's Guide

General Troubleshooting
SAMSys readers are designed, manufactured, and tested to provide many years of troublefree service. However, in the event of a reader malfunction or failure, refer to the
following troubleshooting instructions to help identify and correct the problem.

Warning - Electric Shock Hazard
The following procedures may involve AC voltage. Use extreme caution when measuring
voltage or installing cables and power supplies. Serious injury or death may occur if proper
precautions are not observed.

Caution - ESD
The following procedures involve electrostatic discharge sensitive components. ESD
protection is required. Damage to the reader can occur if proper ESD equipment such as
grounded wrist straps and ESD protected work surfaces are not used.

Symptom
No LEDs or buzzer
during power up.

Probable Cause
Power supply
malfunction.

Corrective Action
Ensure power supply is inserted into
wall outlet. Verify correct operating
voltage at outlet.
Replace Power Supply.

Reader software is
corrupt.

Replace reader.

Reader appears to
lock up.

Readers are vulnerable
to high ESD pulses. As a
result, the reader can
lock up.

Disconnect the power from the reader
and reconnect. The reader should
reset. If the reader does not function
normally after reset, replace the reader.

Any LED fails and
buzzer alarms during
power up.

Suspect LED bad.

Reader may operate normally with one
or more bad LEDs, but the reader
should be replaced as soon as
possible.

Reader board failure.

If reader does not read or write, replace
the reader.

Buzzer malfunction.

Reader may operate normally without
buzzer, but the reader should be
replaced as soon as possible.

Reader board failure.

If reader does not read or write, replace
the reader.

Reader software is
corrupt.

Replace reader.

No buzzer on power
up.

30

Troubleshooting

Symptom
No buzzer when
reading a tag.

Probable Cause

Corrective Action

Replace reader.

External RS-232 cable
malfunction

Check cable connectors for bent or
broken pins. Replace external RS-485
cable if necessary.

Reader board failure.

Replace reader.

External RS-485 cable
malfunction.

Check cable connectors for bent or
broken pins. Replace external RS-485
cable if necessary.

Wrong jumper setting.

Ensure RS-485/Ethernet Jumper J4 is
across Pins 1-2.

Reader board failure.
No Digital I/O signals
present.

If the reader does not read or write,
replace the reader.

Reader software is
corrupt.

No RS-485
Communication.

Reader may operate normally without
buzzer, but the reader should be
replaced as soon as possible.

Reader board failure.

No RS-232
Communication.

Buzzer malfunction.

Replace reader.

Reader board failure.

Replace reader.

Tag ID/data is different Reader software
from expected value. version.

Program reader with latest software
version release.

Electromagnetic
interference.

Reposition reader or tag.
Slow tag when within range of reader.

Faulty tag.
No Ethernet
connectivity

Read range exceeded.
Tag speed exceeded.

Tag read failure.

Shield or reposition reader

Verify reader operation with a known
good tag.

External Ethernet cable
faulty.

Check cable and replace if necessary.

Wrong jumper setting.

Ensure RS-485/Ethernet Jumper J4 is
across Pins 2-3.

Wrong Ethernet IP
address.

Use the Digi Device Discovery
application to reverify IP address.

Reader board failure.

Replace reader.

31

MP9320 2.7 User's Guide

Contact Us
For any questions regarding products and services, including returns, repairs, technical
support, training, and all other available services, contact your distributor or SAMSys
Customer Service at the following:

E-mail
Telephone
Fax

32

support@samsys.com

1-919-281-1551

1-877-367-4342 (toll free)
8:00am-6:00pm EST, Mon-Fri

Chapter 5
Specifications
This chapter describes the specifications for the MP9320 Reader. Information provided
includes the following:
o

Reader Specifications

o

Environmental Specifications

o

Battery Specifications

o

Power Supply Specifications

o

RS-232 Connector Specifications

o

RS-485 Connector Specifications

o

Ethernet LAN Connector Specifications

o

Digital I/O Connector Specifications

o

Optional Communication Cable Specifications

o

Antenna Specifications

o

Regulatory Standards

33

MP9320 2.7 User's Guide

Reader Specifications
Frequency

865-870 MHz (25 KHz steps)
902-928 MHz (200 KHz steps)
869.525 MHz single frequency

RF Power

16 mW - 3 W

Connections

RS-232, RS-485, Digital I/O (TTL), or Ethernet LAN

Input Voltage

15 Vdc +/-5%

Input Current

3A maximum

Environmental Specifications
Operating
Temperature

-4° F to 158° F (-20° C to 70° C)

Storage Temperature

-40° F to 185° F (-40° C to 85° C)

Maximum Shock

1 foot (0.3 meter) drop to any corner

Relative Humidity

5% to 95% non-condensing

Case Material

Aluminum

Case Dimensions

5.25 x 7.0 x 11.5 in (133 x 178 x 286 mm)

Weight

4 lbs (1.8 kg)

Battery Specifications (Optional)
Battery (optional)

Lithium/Manganese Dioxide

Designation

ANSI/NEDA 5012LC / IEC-CR1220

Voltage

3.0 volts

Average capacity

40 mAh to 2.0 volts

Caution - Risk of Explosion
Only replace battery with a battery of the same type and designation. There is a risk of explosion if
the battery is replaced with incorrect type. Dispose of old battery according to manufacturers
instructions and local regulations.

Power Supply Specifications
Input Voltage

100 - 240 VAC

Input Consumption 0.3 A, 31 - 45 VA
Input Frequency
Output Voltage

15 VDC

Output Current

34

50 - 60 Hz
3A

Specifications

RS-232 Connector Specifications

5

4
9

3
8

2
7

1
6

Figure 23-RS-232 Connector

Baud rate

9600 - 38400

Parity

None

Data bits

8

Stop bits

1

Pin 1

CNVSS (Normally low. High puts reader in
programming mode.)

Pin 2

TXD

Pin 3

RXD

Pin 4

DTR (shorted to pin 6)

Pin 5

GND

Pin 6

DSR (shorted to pin 4)

Pin 7

CTS

Pin 8

RTS

Pin 9

+3.3 Vdc

RS-485 Connector Specifications

1

2
3

Figure 24-RS-485 Connector

Baud rate
Parity
Data bits
Stop bits
Pin 1
Pin 2
Pin 3

9600 - 38400
None
8
1
RS-485 C (common)
RS-485 B
RS-485 A
35

MP9320 2.7 User's Guide

RS-485/Ethernet Jumper Setting
Jumper
J4
J1
J2

Pins
1-2
2-3
1-2
1-2

Action
RS-485 enabled.
Ethernet enabled.
High side termination active.
Low side termination active.

Ethernet LAN Connector Specifications
Pin 1

Network Activity
LED (green)

Pin 8

Network Link
LED (yellow)

Figure 25-Ethernet LAN Connector

Pin 1
Pin 2
Pin 3
Pin 4
Pin 5
Pin 6
Pin 7
Pin 8
Network Link
LED
Network Activity
LED

36

TXD+ (Transmit Data +)
TXD- (Transmit Data -)
RXD+ (Receive Data +)
EPWR+ (Power from switch +)
EPWR+ (Power from switch +)
RXD- (Receive Data -)
EPWR- (Power from switch -)
EPWR- (Power from switch -)
Yellow LED indicates network link is operational. On
continuously indicates Ethernet connection made.
Green LED indicates network traffic detected.

Specifications

Digital I/O Connector Specifications

4

5
10
15

3
8

9
14

2

13

1
7

12

6
11

Figure 26-Digital I/O Connector

Signal Name

Pin No.

Description

DIN0
DIN1
DIN2
DIN3
Digital input common
DOUT0
DOUT1
DOUT2
DOUT3
Digital output common

7
14
13
5
8, 15
4
11
10
2
1,9,3,6,12

Digital Input 0 - optically isolated
Digital Input 1 - optically isolated
Digital Input 2 - optically isolated
Digital Input 3 - optically isolated
Input commmon
Digital Output 0 - open collector
Digital Output 1 - open collector
Digital Output 2 - open collector
Digital Output 3 - open collector
Output common

37

MP9320 2.7 User's Guide

Optional Communication Cable Specifications

4

5
10
15

3

14

3 Pin Tini Q-G
1

3

2

Figure 27-Optional Communication Cable Pinouts

15 Pin D Sub (Digital Input/Output)
Pin No.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

Description
Output common
Output 3 - open collector
Output common
Output 0 - open collector
Input 3 - optically isolated
Output common
Input 0 - optically isolated
Input common
Output common
Output 2 - open collector
Output 1 - open collector
Output common
Input 2 - optically isolated
Input 1 - optically isolated
Input common

3 Pin Tini Q-G (RS-485)
Pin No.
1
2
3

38

Description
Common
B
A

2
8

9
13

1
7

12

6
11

Specifications

Suitable Antenna Specifications
Antenna Parameter

FCC

ETSI

Frequency

902-928 MHz

865-870 MHz

Polarization

Circular

Circular

Gain, dBic

8, max

6, max

VSWR, maximum

1.3:1

1.3:1

Caution
This device has been designed to operate with no more than 1 Watt into the antenna and an
antenna gain of no more than 9 dBic. Antenna having a higher gain is strictly prohibited per
regulations of Industry Canada, unless power into the antenna is decreased to compensate for the
increased antenna gain.The required antenna impedence is 50 ohms.
To reduce potential radio interference to other users, the antenna type and its gain should be so
chosen that the equivalent isotropically radiated power (EIRP) is not more than that required for
successful communication.
The installer of this radio equipment must ensure that the antenna is located or pointed such that it
does not emit an RF field in excess of Health Canada limits for the general population; consult
Sagfety Code 6, obtainable from Health Canada'a website at www.hc-sc.gc.ca/rpb

39

MP9320 2.7 User's Guide

Regulatory Standards
Emissions
Radiated Emissions (enclosure)

EN 55022 Class B
FCC Part 15

Conducted Emissions (AC port)

EN 55022
FCC Part 15

Harmonic Distortion (AC port)

EN 61000-3-2: 1999

Voltage Fluctuation (AC port)

EN 61000-3-3

RF Spectrum

EN 300 220-1
EN 300 220-2
FCC Part 15
Canada RSS-210

Immunity
Electrostatic Discharge Immunity (all ports)

EN 61000-4-2

Radiated Immunity (enclosure)

EN 61000-4-3

Magnetic Immunity (enclosure)

EN 61000-4-8

Electrical Fast Transient Immunity (all ports)

EN 61000-4-4

Lightning Surge Immunity (all ports)

EN 61000-4-5

Conducted Immunity (all ports)

EN 61000-4-6

Voltage Dips and Short Interruptions (AC port)

EN 61000-4-11

EMC

EN 301 489-1
EN 301 489-3

Safety
Electrical Safety
RFID Human Safety

40

EN 60950
EN 50364

Appendix A
Reader Configuration
This appendix describes how to change or update the MP9320 Reader
configuration using the RF Command Suite. Refer to the RF Command Suite
User's Guide for additional information.
Information provided in this appendix includes the following:
o

Operating Modes

o

Default Configuration

o

Configuring the Reader with RF Command Suite

- Changing the RS-232 Configuration
- Changing Reader Operation Modes
- Configuring Specific Protocols
o

Updating Reader Firmware with RF Command Suite

o

Updating the Reader Firmware using the ICCM

o

Using CHUMP Commands to Configure the Reader

41

MP9320 2.7 User's Guide

Operating Modes
SAMSys reader software is configurable to verify configuration parameters.
Typical reader parameters include the following:
o

RF communication mode (polled or continuous)

o

Serial communication mode (polled or continuous)

o

Multiplexer Configuration (# antennas, inventory rounds, and antenna hopping)

o

Serial multidrop addressing

o

Protocol configuration

o

Protocol selection

For detailed information on checking reader configuration, refer to the following
sections and the RF Command Suite User's Guide.

Default Configuration
The factory default configuration is as follows:
o

o

Serial Configuration
- 9600 Baud
- 8 Data Bits
- 1 Stop Bit
- No Parity

o

42

General Configuration
- RF Continuous
- Serial Continuous

Multiplexer Configuration
- 1 antenna
- Antenna hopping enabled
- 1 inventory round per antenna

Reader Configuration

Configuring the Reader with RF Command Suite
RF Command Suite can be used to easily configure your reader. The Reader
Config interface provides control over the reader configuration registers that set
communication parameters, change operating modes, and control the transmitter
and receiver. These configuration registers are located under General
Configuration.
In addition, individual protocol configurations can be modified. The protocol
configuration registers are located under Protocol Configuration.
NOTE: If reader configuration commands have been recently sent from the command line

or by pressing the function keys, the Reader Configuration window may not reflect
the updated settings. Refresh the Reader Configuration window by collapsing and
re-expanding the directories (see Figure 28). The updated settings should be
displayed.

1.

To configure the reader, select the Reader Config tab.

Figure 28 - Reader Configuration

2.

To modify the general configuration registers expand the directory under
General Configuration.

3.

To modify the protocol configuration registers expand the directory under
Protocol Configuration.

Caution
SAMSys readers use internal registers to provide a high degree of flexibility in
setting operational parameters. However, improper setting of these registers can
result in reader inoperability or permanent damage. For detailed information on
reader and protocol configuration registers, refer to the Comprehensive Heuristic
Uniform Messaging Protocol (CHUMP) Reference Guide and the Field Installation
Guide.

NOTE: To make any reader changes permanent, the changes must be written to non-

volatile memory (NVM). To make changes permanent, select the Persistence Flag
option
before sending the change to the reader.
43

MP9320 2.7 User's Guide

Changing the RS-232 Configuration
To confiure the reader's serial port parameters, perform the following:
1.

Select the RS-232 UART parameters as shown in the following:

Figure 29 - RS-232 Serial Port Configuration

2.

Make any changes using the pull-down menus and selectors on the right side
of the display and press Send Changes to Reader

.

Changing Reader Operation Modes
The reader's serial and RF modes can be configured for polled or continuous
operation. In addition, the RF On when Idle mode can be set. To change any of the
operating modes, perform the following:
1.

Select the specific General Configuration Word (GCW) parameters as shown
in the following:

Figure 30 - Serial and RF Mode Configuration

2.

Make any changes using the selectors on the right side of the display and
press Send Changes to Reader

44

.

Reader Configuration

Configuring Specific Protocols
Individual Protocol Configuration registers can be modified for specific tag types
and read modes. For specific protocol configuration register information, refer to
the Comprehensive Heuristic Uniform Messaging Protocol (CHUMP) Reference
Guide. To configure individual protocol registers, perform the following:
1.

Select the individual protocol configuration word parameters.

Figure 31 - Protocol Parameter Configuration

2.

Enable or disable a specific protocol parameter by using the selectors on the
.
right side of the display and press Send Changes to Reader

45

MP9320 2.7 User's Guide

Updating Reader Firmware with RF Command Suite
Periodically, SAMSys releases updated reader firmware that incorporates new
protocols, enhanced features, and updated FlashROM images. SAMSys readers
can be updated with new firmware using RF Command Suite. Refer to the RF
Command Suite Users Guide for detailed information on this application.

An
tive2

a
tenn3

4

Ac
1

UH P
F 93
Lo
ng 20
-R
an 2
g e .7
Re E
a d PC
er

ult
Fa
r
we
Po
nse
Se
it
sm
Tran

R (1
S5
-4
85 Vdc
& 2.
D5
ig am
ital
I/O p

m

ax

)

M

-232
RS

Po

we

r

Figure 32-Firmware Upload System Configuration

Receiving Updated Firmware from SAMSys
Updated firmware is available by contacting SAMSys customer support. The
firmware file has a .chp extension and is typically included in a zipped release file
such as "EPCReader_1.36.10.zip"
Copy the files to a PC or other host computer connected to the reader.
Uploading Firmware with RF Command Suite
When uploading a file, RF Command Suite sends one line at a time and waits for
the {a response from the reader before sending the next line. If an e: is received,
indicating an error, the upload aborts.
To upload firmware to a reader, perform the following:
1.
2.

Start RF Command Suite.

3.

Select the Command interface window and turn off the RF output by pressing
the RF Off function key.

4.

Select the Upload File tab.

5.

46

Connect the reader to the PC using the RS-232 or Ethernet port as required.

Browse to the file to upload. To use the directory navigator, press the Browse
button
.

Reader Configuration

Figure 33 - Upload File Controls

6.

When uploading FORTH files, insert a time delay between each line of the
file. Select the Send with delay option and enter a time delay in
milliseconds. A time delay is not necessary with .chp files.

7.

When you are ready to upload the file, press Start

8.

The file will be uploaded to the reader. During upload, a bar graph indicates
what percentage of the file has been sent.

9.

If the file cannot be sent, a File Transfer Timeout error is displayed.

.

47

MP9320 2.7 User's Guide

Updating Reader Firmware using the ICCM
To upgrade the reader firmware using the ICCM, verify that the ICCM is
connected to the reader via the RS-232 or RS-485 communication port and that a
PC or other host computer is connected to the ICCM via the RS-232 port. See
Figure 32.
Receiving Updated Firmware from SAMSys
Updated reader firmware is available on CD or via download from the SAMSys
website at www.samsys.com. The upgrade includes the reader application code
which has a .mot extension such as UHFrdr_1.30d.mot.
Copy the files to a PC or host computer connected to the ICCM.
Transferring the Files to the ICCM
Once the upgrade files are loaded to your PC, use the Transfer Files function on the
ICCM to transfer the files to the ICCM. For detailed information on the Transfer
Files function, refer to the Interrogator Control and Concentrator Module User's
Guide.
Uploading the File to the Reader
After transferring the files to the ICCM, use the Upload Reader Firmware function
to upload the reader application file to the reader. Use the Upload Reader
FlashROM function to upload the Forth word definitions file to the reader. For
detailed information on the Upload Reader functions, refer to the Interrogator
Control and Concentrator Module User's Guide.

48

Reader Configuration

Using CHUMP Commands to Configure the Reader
In addition to using RF Command Suite to reconfigure a reader, individual
CHUMP commands can be sent to the reader from RF Command Suite or a
terminal/command console. To setup a SAMSys reader, the Configuration Write
(Cw) command is used to write a three-letter configuration variable name and a
32-bit word to the reader. This word contains the individual setup parameters
required by the reader.
For specific syntax information on the Cw command, refer to Chapter 2 in the
Comprehensive Heuristic Unified Messaging Protocol Reference Guide.
Commonly used configuration variables include the following:
o

GCW - General Configuration Word

o

SCW - Serial Configuration Word (CHUMP 1.31 and above)

o

MCW - Multiplexer Configuration Word

o

SMA - Serial Multidrop Address

o

PCW - Protocol Configuration Word

o

PSW - Protocol Select Word

o

Pxx - Specific Protocol Configurations

o

CNR - Self Training Control

The following example shows the Cw command used to write the MCW to the
reader.
}Cw,d:MCW,b:00040200! & lt; CRLF & gt;
where:
00040200 = 4 antennas, 2 inventory round operations
per antenna.

If the Cw command was successful, the reader responds with:
{A7; & lt; FCS & gt; & lt; CRLF & gt;

Warning
The SAMSys MP9320 Reader uses internal registers to provide a high degree of flexibility
in setting operational parameters. The use of these registers is described in the MP9320
User's Guide, the MP9320 Field Installation Guide, and the Comprehensive Heuristic
Unified Messaging Protocol (CHUMP) Reference Guide. However, improper setting of
these registers can result in reader inoperability or permanent damage.
In particular, the TPC, TP0, TP1, TP2 and TP3 registers control the transmit power of the
reader. The user should not modify these registers unless specifically directed by SAMSys
personnel. Trained, professional installers should only modify them as part of the transmit
calibration procedure described in the Field Installation Guide.

49

MP9320 2.7 User's Guide

50

Appendix B
Tag Programming
This appendix describes how to program tags of varying protocols using CHUMP
commands sent from a terminal or console.
Information provided in this appendix includes the following:
o

Overview of the Tag Writing Command

o

Programming the EPC1 Tag

o

Programming the ISO 18000-6A Tag

o

Programming the ISO 18000-6B Tag

o

Programming the Impinj EPC0 Tag

o

Programming the Matrics Class 0+ Tag

51

MP9320 2.7 User's Guide

Overview of the Tag Writing Commands
Tag writing with SAMSys readers is performed using the Write Any (Wa)
command and the Write Tag (Wt) command. Wa must be used when writing to
blank tags. Wt is used when the tag already has a tag ID.
Typically, Wa is used whenever the write operation affects the tag ID. Wa can also
be used for write operations to any data on a tag. This command is executed with
a single tag in the RF field.
Wtcan only be used for write operations to a specific tag where the tag ID has
already been assigned. This command can be used for write operations to any data
on the tag, except the tag ID itself.
Both Wa and Wt have several different command parameters that can occur in any
order in the command string. In some cases, the parameters are optional. The
parameters include the following:
o

a: address block (in hex)

o

l: length

o

b: write data

o

f: control flags

Where:
a: address block refers to the particular piece of writeable memory in the tag. The
concept of a block size can vary from one tag type to another. The address block
may be optional if the specific tag type only contains a single piece of writeable
memory. This value is in hexadecimal.
l: length refers to the length of the data to be written. For some tags this length is
in bytes and for others this is in blocks.
b: write data is the data to write to the tag.
f: control flags dictate certain optional protocol specific behavior with the write
operation.
Some tags support the ability to have a portion or all of their internal memory
locked against further modification. Write operations to locked memory will not
be successful. The locked status of a piece of memory can be queried via the Yl
command. The Yl response is f:0 for unlocked or f:1 for locked.
Details of the syntax for any command found in this document can be obtained in
the CHUMP Reference Guide.
52

Tag Programming

Programming the EPC1 Tag
SAMSys MP9320 and MP9310 readers can be used to program 64-bit and 96-bit
EPC1 tags.
Use the Wa command to write EPC1 (Alien) tags. Do not use Wt since the tag does
not support singulated write operations. In addition, before writing to a 96-bit EPC
ID tag, you must send a Tag Reset (Tr) command prior to issuing the write
operation.
Prior to writing, EPC1 tags must be erased. If the command specified does not
erase the tag during the command execution then specify the erase operation
separately using the Tag Erase (Te) command.
Also, in order to calculate the CRC, the entire tag ID must be presented to the
reader in one command. EPC1 tags contain an internal CRC value which covers
the EPC ID and the kill passcode. The reader always calculates the CRC and
writes the correct value to the tag during the write operation. As a result, the
entire tag ID and passcode must be presented to the reader in one command. The
last byte is the lock password and must be always set to 00.
The Wa command has several different parameters that can occur in any order in
the command string. These parameters include the following:
o

a: address block (in Hex). This parameter is optional since there is only a
single writeable piece of memory. If specified, the parameter should use block
address 0x00.

o

l: length. This parameter reflects the number of bytes being written and must
be equal to 9 if writing a 64-bit EPC ID with the kill passcode or equal to d if
writing a 96-bit EPC ID with the kill passcode.

o

b: write data. This parameter must contain the entire EPC ID (64- or 96-bit),
followed by the one byte kill passcode.

o

f: control flags. This parameter controls operations related to writing a tag.
Set f:1 to verify the data in the tag following the write operation. Set f:2 to
erase the data prior to the write operation. For most applications, set both of
these bits with f:3.

The following is a typical command to write a 96-bit EPC1 ID tag:
}wa,a:0,b:80020304050607090a0b0c0e00,l:d,f:3!

The following is a typical command to write a 64-bit EPC1 ID tag:
}wa,a:0,b:800080042504600200,l:9,f:3!
53

MP9320 2.7 User's Guide

In addition to the Wa, Te, and Tr commands, SAMSys readers also support the
following EPC1 operations:
o

Lb Lock Block

o

Yl Query Lock Status (returns f:0 for unlocked or f:1 for locked)

o

Td Tag Destroy

The Lock Block and Query Lock Status operations can only be performed with a
single tag in the RF field and do not require any parameters. The Tag Destroy
operation requires the b: parameter to specify the particular kill passcode for this
tag.
For detailed information on these and other tag commands, refer to the
Comprehensive Heuristic Unified Messaging Protocol (CHUMP) Reference
Guide.

54

Tag Programming

Programming the ISO18000-6A Tag
Both the Wa and Wt command can be used with the ISO18000-6A tag. In addition
to Wa and Wt, two additional commands can modify specific data in the tag. The
Wd command modifies the DSFID and Wf modifies the AFI.
Typically, the Wt command is used to modify user data in the tag. The Wt, Wd, and
Wf commands require the tag ID to be in the d: parameter. Also, the tag must first
be put in the SELECT state using the Ts command with the tag ID specified in the
d: parameter.
NOTE:

Some varieties of ISO18000-6A tags are not writeable. Currently, only Atmel
markets a writeable ISO18000-6A tag.
The following parameters are used with the Wa or Wt commands.
o

a: address block (in Hex). In ISO18000-6A, only a single block can be written
at one time and this parameter represents the specific four byte block.

o

l: length. This parameter is optional since each write operation must contain
exactly four bytes.

o

b: write data. This parameter must contain four bytes of data.

The following is a typical command to write to an ISO18000-6A tag:
}wa,a:0,b:01020304!

For example, to write AABBCCDD to address 0x20 on a tag with ID
E00300001122334455667788, issue the following command:
}wt,d:E00300001122334455667788,a:20,b:AABBCCDD!

In addition to the Wa, Wt, Wd, and Wf commands, SAMSys readers also support
the following EPC1 operations:
o

Lb Lock Block

o

Yl Query Lock Status (returns f:0 for unlocked or f:1 for locked)

Each of these operations must specify a particular tag ID using the d: parameter or
first be put in the SELECT state using the Ts command with tag ID specified in
the d: parameter.

55

MP9320 2.7 User's Guide

Programming the ISO18000-6B Tag
General ISO18000-6B Programming
In ISO18000-6B, operations are controlled by a state machine within the tag. As a
result, the tag must be in the Data Exchange state for the write operation to
succeed. To guarantee the tag is in that state, the tag must be reset using the Tag
Reset Tr command followed by a Read Detect Rd command prior to performing
the first write operation.
The ISO18000-6B protocol does not provide any feedback on the write operation
since the reader always provides an Ack ({A) after the tag receives a command.
The only way to verify success is to read the data back from the tag.
An ISO18000-6B tag write operation can fail if any byte within the addressed
range is locked or if the power setting is not correct. It is not uncommon for
Philips and Rafsec ISO18000-6B tags to have some of the first eight bytes locked.
Confirm the status of the specific type of tag in use.
Both the Wa and Wt command can be used with the ISO18000-B tag. The Wt
command is used to modify data outside of the first 8 bytes in the tag and requires
specification of the tag ID using the d:parameter.
The following parameters are used with the Wa or Wt commands.
o

a: address block. In ISO18000-6B, this parameter provides the address of the
writeable memory block. The block size is one byte.

o

l: length. This parameter reflects the number of blocks being written (which
is equal to the number of bytes in this case).

o

b: write data. This parameter contains the actual data being written.

The following command example command writes AABBCCDD to user memory at
address 0x20 on a tag with ID EF04001122334455:
}wt,d:EF04001122334455,a:20,b:AABBCCDD,l:4!

In addition to the Wa and Wt commands, SAMSys readers also support the
following ISO18000-6B operations:
o

Lb Lock Block

o

Yl Query Lock Status (returns f:0 for unlocked or f:1 for locked)

Each of these operations must specify a particular tag ID with the d: parameter
and block address with the a: parameter.
56

Tag Programming

UCODE Programming
Writing multiple bytes anywhere in the first eight bytes of a UCODE tag requires
the use of the Wa command. Only a single tag should be present in the RF field for
a Wa operation. The Wa command can be used to modify any byte in the tag.
For single byte write operations, use the Wt command.
The ISO18000-6B UCODE tag can emulate a 96- or 64-bit EPC ID tag by writing
data to multiple locations in the tag and enabling the appropriate mode in the
reader. This capability is more fully described in the Implementation of EPC Tag
Data on UCODE EPC 1.19 Application Note from Philips Semiconductor. For
detailed information on reader configuration for this tag, refer to the P6B
Configuration Register description in the SAMSys Comprehensive Heuristic
Unified Messaging Protocol (CHUMP) Reference Guide.
To configure a UCODE tag for a 96-bit EPC ID of
3114F4DA34B2D05E01010101, send a Tag Reset Tr command followed by
a Read Detect Rd command. Then issue the Wa commands:
}Tr!
}Rd!
}wa,a:2,b:315E01010101,l:6!
}wa,a:10,b:14F4Da34B2D0,l:6!

To configure a UCODE tag for a 64-bit EPC ID of 4066771122334455, send a
Tag Reset Tr command followed by a Read Detect Rd command. Then issue the
Wa commands:
}Tr!
}Rd!
}wa,a:2,b:401122334455,l:6!
}wa,a:10,b:6677,l:2!

57

MP9320 2.7 User's Guide

Programming the Impinj EPC0 Tag
In EPC0, there is no single standard for performing write operations and there are
noteable differences between manufacturers. Consequently, some varieties of
EPC0 tags are not writeable. This section addresses the writable EPC0 tags
produces by Impinj.
Both the Wa and Wt command can be used with the EPC0 tag.
In Impinj EPC0 tags, the following command parameters are used:
o

a: address block (in Hex). This parameter provides the address of a writeable
memory block. The block size is one row which is two bytes.

o

l: length. Parameter reflects the number of blocks being written.

o

b: write data. Parameter must contain the data to be written. If the data
provided does not match the length specified, zeros are padded to the right of
the data.

Typically, the Wt command would be used to modify user data in the tag. The Wt
command requires specification of the tag ID using the d: parameter.
For example, to write data AABBCCDD to user memory at address 0x8 on a tag
with ID E00300001122334455667788, issue the following command:
}wt,d:E00300001122334455667788,a:8,b:AABBCCDD!

In addition to the Wt command, the reader also supports the following operations:
o

Lb Lock Block

o

Yl Query Lock Status (returns f:0 for unlocked or f:1 for locked)

o

Td Tag Destroy

The Lock Block and Query Lock Status operations must be performed with a
single tag in the RF field and do not require any parameters. The Tag Destroy
operation requires d: parameter to specify a particular tag ID and the b:
parameter to specify the particular kill passcode for this tag.
For detailed information on these and other tag commands, refer to the
Comprehensive Heuristic Unified Messaging Protocol (CHUMP) Reference
Guide.

58

Tag Programming

Program a 96-Bit EPC (Impinj Tags)
To write a 96-bit EPC on an Impinj Zuma EPC0 tag, enter the following:
}Wa,a:4,l:6,b:306c50fd76d803cf02f47f5f,f:3!
where:
a:4 is
l:6 is
b:xxxx
f:3 is

the start of the EPC
the length in rows
is the 96-bit EPC code
the command to calculate the CRC

The CRC is calculated and written to the row following the EPC code.

Program a 64-Bit EPC (Impinj Tags)
To write a 64-bit EPC and precalculated 16-bit CRC, enter the following:
}Wa, a:4,l:5,b:c80507a8009af9d71021!
where:
a:4 is the start of the EPC
l:5 is the length of the EPC and CRC in rows
b:xx is EPC and CRC

Program a 48-Bit Product Code (Impinj Tags)
In the following example, the 48-bit product code is written first and then the16-bit
serial number is written at a later time. To write the 48-bit product code, enter:
}Wa, a:4,l:3,b:c80507a8009a!

To write the 16-bit serial number, enter the following:
}Wa, a:7,l:2,b:fa6e7380!

Program the User Data (Impinj Tags)
To program user data on a 96-bit Impinj Zuma Tag, data is written to specific
rows. To write user data to User Row 11 (b hex), enter:
}Wa, a:b,b:1234!

Change the Passcode (Impinj Tags)
To change the Passcode on an Impinj Zuma Tag, enter the following:
}Wa,a:2,l:2,b:123456!
where:
l must equal 2
b must be 6 digits
59

MP9320 2.7 User's Guide

Programming the Matrics Class 0+ Tag
Matrics Class 0+ tags utilize a process called Singulation. This is a process of
uniquely identifying a tag in a population of tags and retieving its Electronic
Product Code (EPC). For detailed information on EPC Class 0 singulation, refer to
the EPC Global Class 0 specification.
When a tag is requested to identify itself, it responds with different data based on
its singulation mode. Class 0 and Class 0+ tags allow three modes of singulation:
o

ID2 - This mode responds directly with the EPC. ID2 is the fastest mode
(fewest bits transmitted), but requires the reader to echo the bits back to the
tag. This echo can create security issues. Also, this mode can not be read when
writing the EPC, since the echo will change the EPC as you write it.

o

ID0 - This mode returns packets of 12 random bits that are different every time
you singulate. When the reader has what it determine is the correct number, it
writes the EPC. This mode is the only reliable method of writing the tag EPC.

o

ID1 - This mode is the same as ID0, but every singulation returns the same bit
stream. The bits are random, but they are seeded from the EPC. Writing the
EPC changes these bits.

The singulation mode is controlled with the PE0 register and must be set prior to
writing tags.
Matrics Class 0+ tags contain three writable pages or memory blocks: These pages
are as follows:
o

Page 0 - Kill code (24 bits)

o

Page 2 - EPC code (64 or 96 bits)

o

Page 3 - User data (104 bits)

When Page 2 or Page 3 data is written, a 16-bit CRC is appended.
Both the Wa and Wt command can be used to write Matrics Class 0+ tags. The
following command parameters are used:
o

o

l: length. This parameter is required and is the number of bytes being written.

o

b: write data. This parameter is required and contains the data to write.

o

60

a: address block. This represents the memory page of the tag on which the
write operation will occur. Values can be 0, 2 or 3, as defined previously. If
this parameter is missing, it will default to 0.

d: tag ID. This parameter is required for the Wt command (optional for Wa)
and specifies the EPC code of the tag to which the write operation applies. The
16-bit CRC must be supplied along with the 64 or 96 bit EPC code.

Tag Programming

Writing Initial EPC Code to Blank Matrics EPC0+ Tags
To write the EPC code to blank tags, ID0 singulation must be used.
If ID2 traversal is to be inhibited on subsequent tags, set the traversal inhibit bit in
PE0 . Once written, those tags will not singulate using ID2 unless the EPC code is
erased and then rewritten with traversal inhibit cleared.
Once a valid EPC code is written to Page 2, it cannot be overwritten unless the tag
is first erased. Tag write operations using ID0 singulation cannot distinguish if a
tag has previously been singulated.
Each ID0 singulation will use a new random number. To prevent a single tag from
continually being selected for EPC code writing, an error code is returned if the tag
already has a valid EPC code and overwrtite is blocked.
As stated earlier, the mode must be set prior to writing tags. A typical value for the
PE0 register for writing blank tags is 0x12050180. This value sets PE0 for the
following:
o

Use ID0 singulation with 2 blocks of random bits

o

Retry count set to 5

o

Scroll first turned on

o

Autolength EPC enabled

To write the PE0 register, enter the following:
}Cw,d:PE0,b:12050180!

If traversal inhibit required, write 0x52050180 to the PE0 register.
To write a 96-bit EPC code to a blank tag, enter the following:
}Wa,a:2,b:220000000000000000000003,l:c!

61

MP9320 2.7 User's Guide

Writing a Kill Code and User Data
Kill codes and user data can be written to any tag in the field in the same manner as
the EPC code method described above, but typically a kill code and user data
would be associated with a specific EPC code. Once written, you cannot read back
the kill code.

To write a Kill Code, enter the following:
}Wa,a:0,b:112233,l:3!

To write User Data to any tag, enter the following:
}Wa,a:3,b:00112233445566778899aabbcc,l:d!

To write a specific tag, enter the EPC code and the 16-bit CRC. The following
write command singulates using ID2, so PE0 singulation bits are ignored:
}Wt,a:0,d:220000000000000000000003DCD0,b:112233,l:3
!

To write user data to any tag: (singulates using ID2, so PE0 singulation bits
ignored)
}Wt,a:3,d:220000000000000000000003DCD0,
b:00112233445566778899aabbcc,l:d!

62

Tag Programming

Tag Erase
To erase a Matrics 0+ tag, use the Tag Erase Te command. Only one tag should be
in the field when executing this command. All memory pages are filled with 0's
and a 16-bit CRC is appended.
After erasing, the EPC code page will be filled with 0's. Also, the user data page
will have all 0's with a 16 bit CRC appended at the end. This allows the user data
page to be read with the Ra command. However, the EPC code page will return an
error on Ra, since there is no valid CRC. If any page is locked, then the Te
command will fail and none of the pages will be erased.
To erase a tag, enter the following:
}Te!

Locking Tags
Individual memory pages can be locked with the Lb command. Once a page is
locked, it cannot be unlocked or written. The following are typical Lock
commands.
To lock Page 0 (Kill code of any tag singulated using PE0 bits), enter:
}Lb!

To lock Page 2 (Kill code of any tag singulated using PE0 bits), enter:
}Lb,a:2! (locks page 2, the EPC code of any tag singulated using PE0
bits)

To lock Page 3 (User data with specific EPC code), enter:
}Lb,a:3,d:220000000000000000000003DCD0!

63

MP9320 2.7 User's Guide

64

Appendix C
Configuring the IP Address
This appendix describes how to configure the IP address of the MP9320 Reader.
Topics discussed in this chapter include the following:

o

Ethernet IP Address Overview

o

IP Address Setup

65

MP9320 2.7 User's Guide

Ethernet IP Address Overview
The MP9320 can be networked with other readers on an enterprise 10/100 BaseT
Ethernet LAN. Each reader is equipped with an embedded IP device server that
allows the unit to be assigned an IP address. This address can then be accessed by
your network server or host computer.
When the MP9320 is installed on a TCP/IP network connected to the internet, the
reader must be assigned a unique IP address. The reader is configured for
automatic IP address allocation using the Dynamic Host Configuration Protocol
(DHCP) Mode. This is the default mode for the reader as it is shipped from the
factory. In this case, the reader automatically extracts the IP address from the
DHCP server.
If DHCP is not available or the reader is not setup for automatic IP address
allocation, the address can be manually assigned using the Digi Device Discovery
application.

IP Address Setup
To set up a reader for Ethernet communication, perform the following:
1.

Verify all cabling and power supplies are secure and power up the readers.

2.

Copy the Digi Discovery application from the UHF Reader system
distribution disk to your host system. This application has the filename:
dgdiscvr.zip.

3.

Copy the RF Command Suite application to your host system. This
application has the filename Setup_RFCommandSuite_10.exe.

4.

Unzip the Digi Discovery zip file and extract the dgdiscvr.exe
application. The application will be copied to your system inside a folder.

5.

Open the dgdiscvr.exe folder and double-click the dgdiscvr
application.

6.

If any readers are connected, the application will launch and the readers will
be displayed as follows:

Figure 34-Digi Device Discovery Application Window

66

Configuring the IP Address

7.

Select the IP address of the reader to configure.

NOTE: If the IP adress returns all zeros (0.0.0.0), configure the reader manually by
selecting Configure network settings.

8.

The following steps require loading a Java applet onto your computer. If your
computer will accept applets, follow Step 10 through Step 13.

9.

If your system cannot run Java applets, follow Step 14 through Step 17 to
complete the setup using a Telnet session to enter commands.

10. (For Java applet) Click on Open web interface to load a Java applet and open
a web browser window off the reader's device server.
11. (For Java applet) Click Yes if you get a security dialog box request when the
applet launches.

Figure 35-Digi Device Discovery Web Interface Window

12. (For Java applet) Select Serial Ports and verify the Baud Rate is set to 57600.

Figure 36-Digi Device Discovery Serial Configuration Window

13. (For Java applet) Press Save and go to Step 18.

67

MP9320 2.7 User's Guide

14. (For Telnet session only) Connect to the reader via a Telnet session. Use the
IP address returned by the Digi Discovery application and Port 23 for the
Telnet connection.
15. (For Telnet session only) Enter show serial and verify ther serial port
settings match the settings in the reader's SCW configuration register.
16. (For Telnet session only) To change the baud rate, enter set serial
baudrate = & lt; rate & gt; . For best performance, a baud rate of 57600 is
recommended.
17. Close the Telnet session.
18. Verify the serial port on the reader is connected to the serial port on your PC
or host system with a serial cable.
19. At this time, load RF Command Suite. This application is a SAMSys reader
management application supplied on your system CD. RF Command Suite
will be used to set the serial port speed on the reader to a Baud Rate of 57600.
20. If the reader's serial port Baud Rate is not correct, you can modify the rate by
selecting the Reader Config interface window.
21. Expand Reader Configuration
Communications

General Configuration
Serial Configuration Word (SCW).

Serial

Figure 37-Reader Serial Port Properties

22. Determine which UART is driving the serial port:
o UART-1 - unused
o UART-2 - RS-232
o UART-3 - Ethernet
23. Change any settings and click Send Changes to Reader
24. After setting the Baud Rate, close any ConnectMe and Digi Device
Discovery windows.
68

.

Configuring the IP Address

25. From RF Command Suite, select Reader Connection
disconnect any auto connected sessions.
26. Select Reader Connection

Connect via TCP/IP.

27. Select Reader Connection
connection.

AutoConnect to

Disconnect. This will

establish an Ethernet

28. Select the IP address of the reader from the popup list and press OK.
29. Select the Command interface tab and press the Version function key to verify
communication with the reader.

69

MP9320 2.7 User's Guide

70

THE POWER TO CHOOSE

SAMSys Technologies, Inc.

Part Number: HI46932-01-OM-V6.1
Printed in U.S.A.


All Legacy 9320.zip > MP9320_2.8_Users_Guide_V1.0.pdf

User's
Guide
MP9320 2.7 EPC
UHF Long-Range Reader

THE POWER TO CHOOSE

TM

SAMSys
MP9320 UHF Long-Range Reader
User's Guide
Sixth Edition (February 28, 2005)
(C) Copyright 2005 SAMSys Technologies, Inc. All Rights Reserved.
Disclaimer and Limitation of Liability
The content of this manual is for information use only and is subject to change without notice. SAMSys assumes no responsibility or liability for any errors
or inaccuracies that may appear in this publication. No part of this manual may be reproduced in any form or by any means, electronic, mechanical,
recording, or otherwise, without the prior written permission of SAMSys.
SAMSys products are not designed, intended, authorized or warranted to be suitable for life support applications or any other life critical applications
which could involve potential risk of death, personal injury, property damage, or environmental damage.
About SAMSys
SAMSys Technologies, Inc. is a world-leading provider of RFID reader hardware solutions in the LF, HF, and UHF segments of the RFID marketplace.
SAMSys is a public company listed on the Toroto Stock Exchange under the symbol SMY.
SAMSys Technologies, Inc.
44 East Beaver Creek Rd., Unit 11
Richmond Hill, Ontario L4B 1G8 Canada
Phone: (905) 707-0404
Toll Free: (877) 463-6546
Fax: (905) 707-9944
E-mail: samsys@samsys.com
Web: www.samsys.com
Part Number: HI46932-01-OM-V6.1

Federal Communications Commission (FCC) Notice (Preliminary)
This device was tested and found to comply with the limits set forth in Part 15 of the FCC Rules. Operation is subject to the following conditions: (1) this
device may not cause harmful interference, and (2) this device must accept any interference received including interference that may cause undesired
operation. These limits are designed to provide reasonable protection against harmful interference when the equipment is operated in a commercial
environment.
This device generates, uses, and can radiate radio frequency energy. If not installed and used in accordance with the instruction manual, the product may
cause harmful interference to radio communications. Operation of this product in a residential area is likely to cause harmful interference, in which case,
the user is required to correct the interference at their own expense.
The authority to operate this product is conditioned by the requirements that no modifications be made to the equipment unless the changes or
modifications are expressly approved by SAMSys Technologies.
Trademarks
SAMSys is a trademark of SAMSys Technologies, Inc.
HyperTerminal(R) is a registered trademark of Hilgraeve, Inc.
EPC is a trademark of EPCglobal, Inc.
Other company, product or service names appearing in this manual may be trademarks or service marks of their respective owners.

MP9320 User's Guide

Contents
Chapter 1 - Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Unpacking the Reader . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
About the MP9320 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Physical Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

1
2
3
4

Chapter 2 - Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Antenna Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Reader Mechanical Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
RS-485/Ethernet Communication Selection . . . . . . . . . . . . . . . . . . . . . . .
Serial (RS-232) Communication Setup . . . . . . . . . . . . . . . . . . . . . . . . . . .
Ethernet LAN Communication Setup . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Installing the RF Command Suite Application . . . . . . . . . . . . . . . . . . . . .
Configuring the IP Address . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Digital (TTL) Input/Output Setup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Transmit Power Calibration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Connecting to an ICCM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

7
8
10
13
13
14
15
15
16
17
17

Chapter 3 - Operation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
MP9320 Power Up and Initialization . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Starting RF Command Suite . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Setting the RF Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Selecting the Number of Antennas . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Selecting Tag Protocols . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Enabling or Disabling Tag Protocols . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Reading Tags . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Writing Blank Tags . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Modifying Tags . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Operation with the ICCM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

19
20
21
21
21
22
22
23
25
26
27

Chapter 4 - Troubleshooting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
General Troubleshooting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
Contact Us . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
Chapter - Specifications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Reader Specifications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Environmental Specifications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Battery Specifications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Power Supply Specifications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
RS-232 Connector Specifications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
RS-485 Connector Specifications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
RS-485/Ethernet Jumper Setting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Ethernet LAN Connector Specifications . . . . . . . . . . . . . . . . . . . . . . . . . .
Digital I/O Connector Specifications . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Optional Communication Cable Specifications . . . . . . . . . . . . . . . . . . . .
Suitable Antenna Specifications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Regulatory Standards . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Emissions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Immunity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Safety . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

33
34
34
34
34
35
35
36
36
37
38
39
40
40
40
40
i

MP9320 User's Guide

Appendix A - Reader Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Operating Modes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Default Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configuring the Reader with RF Command Suite . . . . . . . . . . . . . . . . . .
Updating Reader Firmware with RF Command Suite . . . . . . . . . . . . . . .
Updating Reader Firmware using the ICCM . . . . . . . . . . . . . . . . . . . . . . .
Using CHUMP Commands to Configure the Reader . . . . . . . . . . . . . . . .

41
42
42
43
46
48
49

Appendix B - Tag Programming . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Overview of the Tag Writing Commands . . . . . . . . . . . . . . . . . . . . . . . . .
Programming the EPC1 Tag . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Programming the ISO18000-6A Tag . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Programming the ISO18000-6B Tag . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Programming the Impinj EPC0 Tag . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Programming the Matrics Class 0+ Tag . . . . . . . . . . . . . . . . . . . . . . . . . .

51
52
53
55
56
58
60

Appendix C - Configuring the IP Address . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65
Ethernet IP Address Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66
IP Address Setup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66

ii

MP9320 User's Guide

Figures
MP9320 Reader and Accessories . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
SAMSys Reader Network . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
MP9320 LED Status Indicators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
MP9320 Active Antenna LED Indicators . . . . . . . . . . . . . . . . . . . . . . . . .
MP9320 End-Panel Connectors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
MP9320 Antenna Configurations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
MP9320 Reader Installations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
MP9320 Base Plate with Mounting Keyholes . . . . . . . . . . . . . . . . . . . . . .
MP9320 Standalone RS-232 Communication Setup . . . . . . . . . . . . . . . .
MP9320 Ethernet LAN Communication Setup . . . . . . . . . . . . . . . . . . . . .
Digital Input/Output Port Configuration . . . . . . . . . . . . . . . . . . . . . . . . . .
MP9320 Standalone/ICCM Communication Setup . . . . . . . . . . . . . . . . .
LED Startup Sequence . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Active Antenna LED Indicators - Antenna 2 Transmitting . . . . . . . . . . . .
Protocol Selection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Reader Configuration Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
RF Command Suite Tag Summary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Select Tag Protocol . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Write Blank Tag . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Select Tag to Modify . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Modify Tag Option . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Interrogator Control and Concentrator Module . . . . . . . . . . . . . . . . . . . . .
RS-232 Connector . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
RS-485 Connector . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Ethernet LAN Connector . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Digital I/O Connector . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Optional Communication Cable Pinouts . . . . . . . . . . . . . . . . . . . . . . . . . .
Reader Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
RS-232 Serial Port Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Serial and RF Mode Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Protocol Parameter Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Firmware Upload System Configuration . . . . . . . . . . . . . . . . . . . . . . . . . .
Upload File Controls . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Digi Device Discovery Application Window . . . . . . . . . . . . . . . . . . . . . .
Digi Device Discovery Web Interface Window 6 . . . . . . . . . . . . . . . . . . .
Digi Device Discovery Serial Configuration Window . . . . . . . . . . . . . . .
Reader Serial Port Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

2
3
4
5
5
8
10
11
13
14
16
17
20
20
22
24
24
25
25
26
26
27
35
35
36
7
38
3
44
44
45
46
47
66
7
67
68

iii

MP9320 User's Guide

iv

Chapter 1
Introduction
This chapter provides a general description of the MP9320 EPC Reader. Topics discussed
in this chapter include the following:
o

Unpacking the Reader

o

About the MP9320

o

Physical Description

1

MP9320 2.7 User's Guide

Unpacking the Reader
After opening the shipping container perform the following:
1. Unpack the contents of the shipping container.
2. Inspect the shipping container for damage. If damaged, notify the carrier and SAMSys
Technologies. Keep the shipping materials for inspection by the carrier.
3. Verify your reader package includes the following items:
o
o
o
o
o
o
o
o

MP9320 UHF Reader
Power cord
15 Vdc power supply with cable
Sample RFID tags
RS-232 communication cable
Ethernet LAN Cable
System documentation CD
Antennas (optional)

E

TH

ER
W

PO
T
TO
SE

OO

CH

na

ten

An
tive2

4

3

Ac
1

ult

Fa

r

we

Po

nse

Se

it

sm

n
Tra

PCr
.7 Eeade
0 2 ge R
32 an
P9 Long-R
MF

2

-23

UH

RS
ax
pm
am
2.5 ital I/O
Vdc Dig
(15 &
er -485
ow RS

)

P

Figure 1-MP9320 Reader and Accessories

2

Introduction

About the MP9320
The MP9320 is one of the most advanced UHF readers in the industry. This multi-protocol
device currently supports many of today's most popular UHF tags including EPC and
ISO. This reader, recognizes multiple protocols simultaneously during operation. With
full-duplex capability, the device can read or write to any tag, depending on the tag
capabilities.
The MP9320 incorporates a scalable architecture that enables the reader to be
implemented as a stand-alone UHF solution or included in a networked reader
environment using the embedded TCP/IP device server and Ethernert LAN connection.
With its extended read range and high data rates, the MP9320 is especially suited for asset
management and logistics applications requiring the simultaneous reading of a large
number of tags at greater distances. Typical RFID applications supported by the MP9320
include the following:
o

Warehouse Logistics

o

Inventory Management

o

Asset Management

o

Pallet Tracking

o

Parking Lot Access

o

Aggregated Container Tracking

o

Loading Dock Portals

A

ct

iv

e

A

nt

en

na

4
3

2

er
S
sm

32

0

2.7

EP

C

Tr

an

it

en

se

P

ow

Fau

lt

1

ader

Re

32

P9

-2
S
R
er

RS (
-4 15
85 Vd
& c 2.
Di 5
git am
al p
I/O m

P

ow

ax

)

M

ange

ng-R

F Lo

UH

A

ct

iv

e

A

nt

en

na

4
3

2

er
S
sm

ader

Re

ng-R

32

F Lo

P9

R

S

-2

UH

er

RS (
-4 15
85 Vd
& c 2.
Di 5
git am
al p
I/O m

P

ow

ax

)

M

ange

M
UH P93
F 20
Re 2
ad .7
er EP
C

32

0

2.7

EP

C

Tr

an

it

en

se

P

ow

Fau

lt

1

A

ct

iv

e

A

nt

en

na

4
3

2

P

er

32

0

2.7

EP

C

S
en
Tr
se
an
sm
it

ow

Fau

lt

1

ader

Re

32

P9

-2
S
R
er

RS (
-4 15
85 Vd
& c 2.
Di 5
git am
al p
I/O m

P

ow

ax

)

M

ange

ng-R

F Lo

UH

b
Hu
net r erver
er o S
Eth
rk
two
Ne
Ba

y Ne

Eth
ern
et L
A

N

ks
twor

Figure 2-SAMSys Reader Network

3

MP9320 2.7 User's Guide

In addition to the scalable, multi-protocol architecture, the MP9320 includes the following
features:
o

LED indicators

o

(4) antenna ports

o

Multiple host interface connections (RS-232, RS-485, Ethernet LAN)

o

Digital input and output lines

o

Integrated real-time clock with battery backup (optional)

o

On-board temperature sensor (optional)

Physical Description

NOTE: The reader enclosure is designed for office, indoor warehouse, and light

manufacturing areas. If a sealed reader is required for wet or hazardous
environments, contact your SAMSys representative.

The digital board contains four LED indicators to provide the operational status of the
reader. The LEDs are visible on the front panel of the reader.

Fault
Power
Sense
Transmit

Figure 3-MP9320 LED Status Indicators

Indicator

Description

Fault

Red

Error condition exists

Power

Green

Power is applied to the reader and
processor initialization complete

Sense

Green

Reader has tag data to report.This LED
also flashes when the reader software
is being loaded.

Transmit

4

Color

Green

Transmitter is operating and RF power
is applied to one of the antennas

Introduction

In addition to the status LEDs, four Active Antenna LEDs provide indication that RF
power is being applied to one of the four antennas. Two LEDs (not shown) are also
provided on the Ethernet LAN connector to indicate network communication status.

Active Antennas
1

2

3

4

Figure 4-MP9320 Active Antenna LED Indicators

Four SMA type antenna ports are provided on the end panel. The reader also has one
power and four communication interface connectors on the opposite end panel.

Ethernet Port
RS-485 Port
Power

RS-232 Port

Digital I/O
Port

Antenna
RF Ports
Figure 5-MP9320 End-Panel Connectors

5

MP9320 2.7 User's Guide

6

Chapter 2
Installation
This chapter provides information for installing the MP9320 Reader. Topics
discussed in this chapter include the following:
o

Antenna Installation

o

Reader Mechanical Installation

o

RS-485/Ethernet Communication Selection

o

Serial (RS-232) Communication Setup

o

Ethernet LAN Communication Setup

o

Configuring the IP Address

o

Digital (TTL) Input/Output Setup

o

Transmit Power Calibration

o

Connecting to an ICCM

7

MP9320 2.7 User's Guide

Antenna Installation
The MP9320 supports from one to four external antennas in a variety of
configurations. One- and two-antenna configurations are typical for most conveyor
and container tracking. Four-antenna configurations are used for portals and
loading dock doorways.

Dual Antennas
(Stacked)
Single Antenna

Four Antennas
(Portal Configuration)
Dual Antennas
(Opposing)

Figure 6-MP9320 Antenna Configurations

Warning
The SAMSys MP9320 UHF Reader is equipped with four (4) RF ports. To prevent reader
damage, active RF ports must be properly terminated with a 50 ohm load or a functional
UHF RFID antenna before power up. UHF Readers are factory configured to operate on
RF port 1. As a result, port 1 must be properly terminated before initially powering on the
reader. Before activating any additional RF ports, they must also be properly terminated.
Never power up the reader unless the appropriate loads or antennas are connected.
Always power down the reader before removing an antenna or load from an RF port.
Activation of these RF ports is controlled by the internal MCW and MSW registers as
described in the MP9320 User's Guide, the MP9320 Field Installation Guide, and the
Comprehensive Heuristic Unified Messaging Protocol (CHUMP) Reference Guide.

8

Installation

The MP9320 is factory calibrated for operation with the following type of antenna
and cable:
Antenna Parameter

FCC

ETSI

Frequency

902-928 MHz

865-870 MHz

Polarization

Circular

Circular

Gain, dBic

9, max

6, max

VSWR, maximum

1.5:1

1.5:1

Cable Parameter

Value

Type

RG58C/U

Length

2 Meters

Connector

SMA type plug, reader side

It is highly recommended that the antenna mounting be adjustable in order to
obtain the best performance from the system. However, the antennas must be
installed on a solid surface or frame to prevent damage or later misalignment.
Perform the following to install the antennas.
NOTE: Use the existing mounting holes on the antenna flange. Drilling new holes in the flange is
not recommended.

1.

Determine the location of each antenna. Ensure the antenna(s) will not be
vulnerable to damage by moving inventory or equipment.

2.

Use the antenna as a template and mark the mounting holes.

3.

Drill and tap (if necessary) mounting holes for #10 or 1/4 inch mounting
screws. For drywall mounting, use drywall anchors or toggle screws.

4.

Mount each antenna and install the mounting screws. Do not overtighten the
screws. Damage to the antenna case may result.

5.

Route each antenna cable back to the reader location. For dual-opposing or
portal configurations, route the opposing cables so they can not be damaged
by equipment or personnel.

6.

Secure each antenna cable with wire ties or other restraint.

9

MP9320 2.7 User's Guide

Reader Mechanical Installation
The MP9320 is designed for easy installation. The following instructions provide
the information to install your UHF reader.
As shown in Figure 7, the reader is designed for horizontal or vertical installation.
Mounting keyholes are provided on each side of the base plate for easy, nonpermanent, installation and removal.
Caution
To ensure proper cooling of the reader, verify that the fan intakes and vents are free of
obstructions.

na

4

Anten
3
Active
2
1

Fault
r
Powe
Sense
mit
Trans

er

20 Read
93 ge
MPLong-Ran
UHF

2
RS-23
max)
Vdc

amp
2.5 I/O

r (15 & Digital
Powe
RS-485

na

tive
Ac 2

4

ten

An

3

1

ult

Fa

r

we

Po

nse

Se

t

nsmi
Tra

PC
.7 E er
0 2 Read
32 ange

P9 -R
MF Long
UH

2

-23

RS
p ma
am
2.5 I/O
Vdc ital

x)

r (15 & Dig
we -485
RS

enn

a
3

iv
2

lt
er

it

Pow
Sen

Tra

nsm

se

Fau

1

Act

e

Ant

4

Po

er

-23
RS

2

20 ge Read
93 -Ran
MP Long
UHF

er
Pow

max)
ampI/O

2.5
Vdc Digital
(15 &
RS-485

Figure 7-MP9320 Reader Installations

For horizontal or table table mounting, ensure the reader and all cabling is secured
to the surface or frame.
SAMSys recommends that the MP9320 be mounted on a horizontal surface.
However, if vertical surface installation is required, refer to the following sections
for the appropriate mounting. As shown in Figure 8, keyhole slots are provided for
easy installation and removal.

10

Installation

6.40 in (162.5 mm)

.359 in ?
(9 mm)
5.0 in
(127 mm)

Figure 8-MP9320 Base Plate with Mounting Keyholes

Hollow Concrete Block Wall Mounting
To temporarily mount the MP9320 to a hollow concrete block wall, SAMSys
recommends metal sleeve type concrete anchors that accept a #10 screw and flat
washer. To install the MP9320 on a hollow concrete block wall, perform the
following.
1.

Refer to Figure 8, and mark the location of the mounting screws. Do not
install the anchors into the mortar joint.

2.

Drill the appropriate size hole for a metal sleeve type anchor.

3.

Install the anchors.

4.

Install the washers and insert the screws.

5.

Tighten the screws to within .375" of the anchor.

6.

Install the reader and finish tightening the screws.
11

MP9320 2.7 User's Guide

Solid Concrete Wall Mounting
To temporarily mount the MP9320 to a solid concrete wall, SAMSys recommends
one-piece expansion type concrete anchors that accept a #10 screw and flat
washer. To install the reader on a concrete wall, perform the following.
1.

Refer to Figure 8, and mark the location of the mounting screws.

2.

Drill the appropriate size hole for a expansion type anchor and install the
anchors.

3.

Install the washers and insert the screws.

4.

Tighten the screws to within .375" of the anchor.

5.

Install the reader and finish tightening the screws.

Wood or Metal Wall Mounting
To temporarily mount the MP9320 to a wood or sheet metal wall, SAMSys
recommends either #10 x 1 inch wood screws or #10 x 3/4 inch sheet metal screws
and washers. To install the reader on a wood or metal wall, perform the following.
1.

Refer to Figure 8, and mark the location of the mounting screws.

2.

Drill the appropriate size hole for screws.

3.

Install the washers and insert the screws.

4.

Tighten the screws to within .375" of the surface.

5.

Install the reader and finish tightening the screws.

Drywall Mounting
To temporarily mount the MP9320 to drywall, SAMSys recommends either #10
toggle bolts or #10 drywall anchors.
NOTE: There are many types of screw-in, hammer-in, and predrill drywall anchors. Each one is
designed for specific applications and pull-out ratings. Ensure that the anchor you select
has a pull-out rating of at least 12 lbs.

To install the MP9320 on drywall, perform the following.
1.
2.

Refer to the anchor manufactureres instructions for installing the anchors.

3.

Install the washers and insert the screws.

4.

Tighten the screws to within .375" of the surface.

5.
12

Refer to Figure 8, and mark the location of the mounting screws.

Install the reader and finish tightening the screws.

Installation

RS-485/Ethernet Communication Selection
The MP9320 is equipped with both RS-485 and Ethernet communication ports.
However, only one can be selected at a time. The reader is typically shipped with
Ethernet communication enabled. To enable RS-485 communication, perform the
following:
Caution - ESD
The following procedures involve electrostatic discharge sensitive components. ESD
protection is required. Damage to the reader can occur if proper ESD equipment such as
grounded wrist straps and ESD protected work surfaces are not used.

1.
2.

Disconnect all power and communication cables from the reader.
Remove the outer reader cover by removing the 8 screws on each side and
carefully lifting the cover straight up.
Locate Jumper J4 on the connector end of the digital board (top circuit
board).
Move the jumper to Pins 1-2 (Pin 1 is closest to the end of the board).
To re-enable Ethernet communication, move the jumper to Pins 2-3.
Replace the cover and the 16 screws.

3.
4.
5.
6.

Serial (RS-232) Communication Setup
The reader is equipped with a 9-pin RS-232 communication port for
communication directly with a PC or other serial device. Refer to the
Specifications chapter for information on the port.

ct
A

3

S
nsm
Tra

it

en

se

P

ow

er

Fa

ul

t

1

2

iv

e

A

nte

nn

a

4

DB-9 Connector
C

er

EP

e

Re
ad

2.7

P

ow
er

RS (
-4 15
85 Vd
& c 2.
Di 5
gi am
ta
l I/O p

m

ax

)

R

UH

S

F

-2

32

Lo
n

g-R

an
g

20

93

MP

5

4
9

3
8

2
7

1
6

RS-232 Link

Pow

(
erRS-485
15

0ange
g-R
P932
MUHF Lon
Tra

max)
amp
2.5 al I/O
Vdc Digit
&

RS

-23

2

Read

er

nsm

it

Sen

se

Pow
Fau

er

lt

1

Act

2

ive

Ant

a
enn3

4

RS-232 Cable

Figure 9-MP9320 Standalone RS-232 Communication Setup

NOTE: A serial port adapter may be required if the device has a different connector type. For
example, some PCs may have 25-pin serial connectors.

13

MP9320 2.7 User's Guide

Every effort has been made to ensure the MP9320 is configured to match your
application. However, it is recommended that the reader configuration be verified
before placing the reader into service. If the system is to be used as a local,
standalone reader connected to a terminal or PC, perform the following:
1.

Verify all antennas, cabling and power supplies are secure.

2.

Verify the operator terminal or PC is connected to the reader and operational.

3.

Power up the reader.

4.

Launch RF Command Suite.

5.

Set the terminal serial port parameters to default values (9600, 8, 1, none).

6.

Introduce a test tag into the RF field.

7.

Verify the tag was read correctly.

8.

If the tag did not read correctly, use RF Command Suite to verify the reader
operating mode matches the application requirements (refer to Appendix A).
If necessary, reconfigure the reader operating modes.

NOTE: Refer to the RF Command Suite User's Guide and the Comprehensive Heuristic
Unified Messaging Protocol (CHUMP) Reference Guide for detailed information
on configuring the reader.

Ethernet LAN Communication Setup
The MP9320 can be networked with other readers on an enterprise 10/100 BaseT
Ethernet LAN. Each reader is equipped with an embedded IP device server that
allows the unit to be assigned an IP address. This address can then be accessed by
your network server or host computer.
Ethernet Link

Pow

(
erRS-485
15

Pow

Pow

(
erRS-485

(
erRS-485
15

0ange
g-R
P932
MUHF Lon

15

max)
amp
2.5 al I/O
Vdc Digit
&

RS

0ange
g-R
P932
MUHF Lon

-23

2

Read

er

max)
amp
2.5 al I/O
Vdc Digit
&

0ange
g-R
P932
MUHF Lon

RS

-23

2

max)
amp
2.5 al I/O
Vdc Digit
&

RS

-23

2

Read

er

Read

er
Tra

nsm

it

Sen
Tra

nsm

it

se

se

Pow

er

er

Fau

lt

1

Act

1

Act

2

ive

Ant

4

Ant

a
enn3

4

4

a
nn
3

P
ow

S
en
Tra
se
nsm
it

er

Fa

ul
t

1

2

iv
e

A
nte

4

32
S
-2
R
er
P
ow

Figure 10-MP9320 Ethernet LAN Communication Setup

Ba

y Ne

twork

s

a
enn3

a
enn3

2

ive

Ant

A
ct

2

RJ-45 Connector

ive

2.5
Vdc Dig
(15 5 &
-48
RS

Act

lt
x)

p ma
am I/O
ital

14

Pow
lt

1

er

Fau

PCer
.7 E ad
0 2 ge Re
32 -Ran
P9 ng
MUHF Lo

Fau

it

Sen

se

Pow

Tra

nsm

Sen

Ethernet LAN
Server or Hub

Installation

Installing the RF Command Suite Application
The SAMSys RF Command Suite is a Microsoft Windows application that
provides a Graphical User Interface (GUI) for SAMSys RFID Reader Products.
The application allows you to easily view tag data, configure the reader, and perform other
tag data functions. In addition, the RF Command Suite is the preferred method for sending
CHUMP commands to a reader. The RF Command Suite application is provided on the
CD shipped with your reader and can be installed on a personal computer. To install RF
Command Suite, refer to Chapter 1 - Introduction in the RF Command Suite User's
Guide.

Configuring the IP Address
The MP9320 is equipped with an optional TCP/IP Ethernet port and embedded IP
device server. This reader is configured for automatic IP address allocation using
the Dynamic Host Configuration Protocol (DHCP) Mode and the reader
automatically extracts the IP address from the DHCP server. This is the default
mode for the reader as it is shipped from the factory.
In the event that you need to manually configure the IP address and Baud rate,
refer to Appendix C for detailed instructions.

15

MP9320 2.7 User's Guide

Digital (TTL) Input/Output Setup
The MP9320 is equipped with a digital I/O port that provides four logic-level
(TTL) input signals and four output signals. Refer to the SAMSys Forth
Programming Language Reference Guide for programming information. The
digital inputs are optically isolated. The outputs are open collector.

Typical TTL
output circuit
(user supplied)

Digital Inputs

Digital Outputs

+5 Vdc

4.7K

Input
Common

DIN0

DOUT0

Filter

DOUT1

5-24 Vdc

Filter

DOUT2

Filter

DOUT3

Filter

4.7K

DIN1

4.7K

DIN2

4.7K

60 V max
500 mA max
Non-inductive

DIN3

4.7K
Output
Common

Typical input
drive circuit
(user supplied)

Typical Filter

Figure 11-Digital Input/Output Port Configuration

Signal Name

Description

DIN0
DIN1
DIN2
DIN3
Digital input common
DOUT0
DOUT1
DOUT2
DOUT3
Digital output common

16

Pin No.
7
14
13
5
8, 15
4
11
10
2
1,9,3,6,12

Digital Input 0 - optically isolated
Digital Input 1 - optically isolated
Digital Input 2 - optically isolated
Digital Input 3 - optically isolated
Input commmon
Digital Output 0 - open collector
Digital Output 1 - open collector
Digital Output 2 - open collector
Digital Output 3 - open collector
Output common

Installation

Transmit Power Calibration
The MP9320 can be operated with a variety of commercially available antennas
and coaxial cables. As a result, the output RF power of the reader must be
configured to optimize the read range for a given antenna configuration, while not
violating FCC or CE regulations.
Calibration of the reader transmit RF power must only be performed by SAMSys
authorized installation personnel or certified resellers.

Connecting to an ICCM
The MP9320 can be operated as a standalone reader with the Interrogator Control
and Concentrator Module (ICCM) using the RS-232 communication links. For
RS-485 communication setup, refer to Networked Reader Communication Setup
section.

ew lt
t Vi au
Se Def
as

Po

r (15 5 &
we RS-48

p ma
am I/O
2.5
Vdc Digital

x)

RS

20ange Re
P93 -R
MUHF Long

-23

2

2

m
ste
ork t Sy
en
or
nit s
Mo Tag

just st
Ad ntra
Co
t
Se lightff
ck O
Ba On/

t

00

tw
Ne pm
M
ICC evelo
D

nsmi

IC

us
Stat

Fault
r
we
Po
nse
Se

SD

Tra

C_

ader

c2
De
ys
MS M_12

SA

1

e An
Activ 2

ten

3

na

4

RS-232 Link

Ethernet LAN Cable

P5 DB25P

P3 DB9P

P1 DB9S
4

3
2

P6 DB25S

P4 DB9P

P2 DB9S

1

J8
RP34-4
DC+5V

Figure 12-MP9320 Standalone/ICCM Communication Setup

17

MP9320 2.7 User's Guide

After connecting the reader to the ICCM with the serial communication, perform
the following:
1.
2.

Power up the reader and ICCM and verify both are operational.

3.

Press the status button on the ICCM display to obtain the ICCM IP address.

4.

Launch your web browser and access the Web-Based Administration tool.
Refer to Chapter 5 in the Interrogator Control and Concentrator Module
User's Guide for information on using the Web Administration tool.

5.

Press Auto-Find Readers on the Main Menu of the administration tool.
Follow the instructions in the ICCM User's Guide to locate the reader.

6.

Introduce a test tag into the RF field.

7.

18

Verify all antennas, RS-232 cabling, Ethernet LAN cabling, and power
supplies are secure.

Click the Tag Inventory button on the Main Menu to verify the tag was read
correctly.

Chapter 3
Operation
This chapter provides general information to operate the MP9320 Reader. Topics
discussed in this chapter include the following:
o

MP9320 Power Up and Initialization

o

Setting the RF Mode

o

Selecting the Number of Antennas

o

Selecting Tag Protocols

o

Enabling or Disabling Tag Protocols

o

Reading Tags

o

Writing Blank Tags

o

Modifying Tags

o

Operation with the ICCM

19

MP9320 2.7 User's Guide

MP9320 Power Up and Initialization
When the power supply is connected, the reader starts an internal initialization sequence.
This sequence momentarily lights the LEDs as follows:
1. Transmit and Sense on momentarily, then off
2. Sense flashes
3. Power flashes
4. Fault flashes
5. All four flash
6. Transmit and Power flash
7. Beeper on
If the Fault LED illuminates during the intialization sequence, the reader has detected a
software load fault. Restart the reader to clear the fault.

Fault

Fault

Fault

Fault

Fault

Fault

Power

Power

Power

Power

Power

Power

Sense
Transmit

Sense
Transmit

Sense
Transmit

Sense
Transmit

Sense
Transmit

Sense
Transmit

Figure 13-LED Startup Sequence

The reader is operational when the Power LED remains on.
After the startup sequence, the RF multiplexer in the MP9320, alternately provides RF
power to each of the four antennas. The Active Antenna LEDs indicate which antenna is
transmitting.

Active Antennas
1

2

3

4

Figure 14-Active Antenna LED Indicators - Antenna 2 Transmitting

NOTE: The number of antennas and the antenna transmit sequence is user configurable
depending on the application. Refer to the following sections and Appendix A for more
information on reader configuration.

20

Operation

Starting RF Command Suite
In order to verify your installation, start RF Command Suite. This application provides the
ability to view your reader configuration and make any needed adjustments. You can also
use the application to view tag data read by the MP9320. For information on installing and
operating the RF Command Suite, refer to the RF Command Suite User's Guide.

Setting the RF Mode
The MP9320 is factory configured for continuous RF scanning or "auto-read" mode. This
mode is equivalent to mode selected by the Auto Read function key on the RF Command
Suite Command interface window.
If desired, you can reconfigure the reader for Polled RF mode (reader activates the
transmit carrier and waits for host to send a read command). Select the Polled Read
function key to activate Polled RF mode.
To halt the Auto Read or Polled Read mode, press the RF Off function key.

Selecting the Number of Antennas
The MP9320 is factory configured to operate with one antenna connected to Port 1.
However, the reader can operate with up to four (4) antennas. If additional antennas are to
be installed, use RF Command Suite to select the number of antennas:
From the RF Command Suite Command interface window, select function set four (4)
and then select one of the following function keys:

F1

1 Antenna (0)

Sets the reader to use antenna 0.

F2

1 Antenna (1)

Sets the reader to use antenna 1

F3

1 Antenna (2)

Sets the reader to use antenna 2.

F4

1 Antenna (3)

Sets the reader to use antenna 3.

F5

2 Antennas (0,1)

Sets the reader to use antennas 0, 1.

F6

3 Antennas (0,1,2)

Sets the reader to use antennas 0, 1, and 2.

F7

4 Antennas

Sets the reader to use all four antennas.

Warning
The SAMSys MP9320 UHF Reader is equipped with four (4) RF ports. To prevent reader
damage, active RF ports must be properly terminated with a 50 ohm load or a functional
UHF RFID antenna before power up. UHF Readers are factory configured to operate on
RF port 1. As a result, port 1 must be properly terminated before initially powering on the
reader. Before activating any additional RF ports, they must also be properly terminated.
Never power up the reader unless the appropriate loads or antennas are connected.
Always power down the reader before removing an antenna or load from an RF port.

21

MP9320 2.7 User's Guide

Selecting Tag Protocols
The MP9320 is factory configured with only those protocols selected by the user. Once
protocols are activated, the Command tab function keys can be used to select the protocol.
These function keys are programmed with specific command sequences required by the
reader to select a particular protocol. To select a specific protocol, perform the following:
1. Select the Command interface window.
2. Select Function Set 2 or 3 and locate the required protocol.
3. Press the function key to select the protocol.
4. To view the commands performed by this function, hold the mouse pointer over the
key or right click while holding the mouse pointer over the key and select Edit Macro.
5. Do not change the command sequnce unless you are experienced using SAMSys
CHUMP commands to configure readers.

Enabling or Disabling Tag Protocols
If you are experienced with SAMSys reader configuration, you can enable, disable, or
modify protocols to match specific requirements. To verify which protocols are activated
for your reader, navigate to the Reader Config interface window and select:
Reader Configuration
Protocol Select Mask

General Configuration

Operating Mode

Activated protocols will be listed and whether they are enabled or disabled. To enable or
disable a different protocol, perform the following:
1.

Select the Protocol Select Word (PSW) parameters as shown in the following:

Figure 15 - Protocol Selection

2.

Enable or disable a protocol by using the selectors on the right side of the display
and press Send Changes to Reader
. See the following note.

3. To modify the selected protocol, select the Protocol Configuration Word and
make any required changes.
NOTE: Only enable one protocol at a time. Enabling multiple protocols can result in reduced tag
reading performance.

For detailed information on reader configuration using RF Command Suite, refer to the
RF Command Suite Users Guide.
22

Operation

Reading Tags
Tag Reading Overview
When the reader completes the initialization sequence, the reader activates the RF field
and, depending on the configuration, begins transmitting read detect (Rd) commands at
the specified frequency. When a tag is placed within range, the reader activates the tag and
reads the data. The following example shows a typical Rd return message with ASCII tag
data that was returned by the reader:
{Rd,d:E016000000000D53,t:IS186A;C4

Reading Tags Using RF Command Suite
RF Command Suite is automatically configured to display tag data as the data is received
from the reader. However, tool settings can be changed to match your requirements. Refer
to the following sections and the RF Command Suite User's Guide to configure the
application.
To read tags, perform the following:
1.

Select the Reader Config Interface and verify the function keys are programmed
correctly for your reader.

2.

Verify your reader is enabled for the correct tag protocol. Select:
Reader Configuration General Configuration
Protocol Select Word
Reader Configuration General Configuration
Protocol Select Mask

3.

Operating Mode
Operating Mode

Verify the reader is configured for the correct operating mode. Select:
Reader Configuration General Configuration
General Configuration Word

4.

Operating Mode

To configure the reader to actively scan for tags, set the following General
Configuration Word parameters:
Serial Mode = Continuous
RF Mode = Continuous
RF Idle RF On when Idle

23

MP9320 2.7 User's Guide

Figure 16-Reader Configuration Parameters
5.

Select the Tag Summary interface. When tags are read, they are displayed in the
window and the statistics are updated.

Figure 17-RF Command Suite Tag Summary
24

Operation

Writing Blank Tags
RF Command Suite can be used to write unprogrammed or blank tags. To write blank
tags, perform the following:
1.

Select the Command Interface and verify the reader is connected and the correct
protocol is selected.

2.

Place the reader in Polled Read mode.

3.

Verify a single tag is in the RF field of the reader.

4.

Select the Tag Summary Interface.

5.

Select the protocol from the pull-down above the Write Blank Tag button.

Figure 18-Select Tag Protocol
6.

Press the Write Blank Tag
display the tag data box.

button to begin the operation and

Figure 19-Write Blank Tag
7.

Fill in the appropriate data (in Hex) and press the Write
the data to the tag.

button to write

NOTE: For detailed information on the various tag protocols and how each protocol is
programmed, refer to Appendix A -Tag Programming.

25

MP9320 2.7 User's Guide

Modifying Tags
RF Command Suite can be used to modify previously programmed tag data. To modify
tags, perform the following:
1.

Select the Tag Summary Interface and right-click on the tag.

Figure 20-Select Tag to Modify

2.

Select Modify Tag. The tag data window is displayed.

Figure 21-Modify Tag Option
3.
4.

Enter the data Length and actual Data for the specific address

5.

Select if ASCII data and whether or not there is a Single tag in field.

6.

After all data and parameters are entered, press Write

7.

26

Select the Address from the pull-down.

Repeat for each address.

.

Operation

Operation with the ICCM
The Interrogator Control and Concentrator Module (ICCM) provides greater flexibility for
accessing, configuring, and manage SAMSys readers. With the ICCM, you can access
your RFID data with your own client/server applications, perform administrative
functions from an easy-to-use Web interface, and remotely perform debug activities on
your readers.
The ICCM also has a 1/4 VGA touch screen LCD. The LCD can be used to provide an
operator interface for applications running directly on the ICCM. This allows for local
access to RFID data and applications in environments where a remote application server is
not available or required.

iew lt
tV u
Se s Defa
a

t
jus st
Ad ntra
Co

m
ste
k
or Sy
tw nt
Ne m e
r
M lop
ito
on ags
ICC eve
MT
D
2

0
20

t
t
Se kligh ff
c
Ba On/O

ec
s
Sy 12D
AM CM_

S

I

SD

C_

l
inae
d
Term o
M

tus
Sta

Figure 22-Interrogator Control and Concentrator Module

The ICCM includes an integrated 10baseT Ethernet LAN interface. You can use the
Ethernet connection to establish communication between your reader and a LAN-attached
application server.
Contact your SAMSys representative for more information on the ICCM product or visit
the SAMSys web site at www.samsys.com.

27

MP9320 2.7 User's Guide

28

Chapter 4
Troubleshooting
This chapter provides general information to troubleshoot the MP9320 Reader. Topics
discussed in this chapter include the following:
o

General Troubleshooting

o

Contact Us

29

MP9320 2.7 User's Guide

General Troubleshooting
SAMSys readers are designed, manufactured, and tested to provide many years of troublefree service. However, in the event of a reader malfunction or failure, refer to the
following troubleshooting instructions to help identify and correct the problem.

Warning - Electric Shock Hazard
The following procedures may involve AC voltage. Use extreme caution when measuring
voltage or installing cables and power supplies. Serious injury or death may occur if proper
precautions are not observed.

Caution - ESD
The following procedures involve electrostatic discharge sensitive components. ESD
protection is required. Damage to the reader can occur if proper ESD equipment such as
grounded wrist straps and ESD protected work surfaces are not used.

Symptom
No LEDs or buzzer
during power up.

Probable Cause
Power supply
malfunction.

Corrective Action
Ensure power supply is inserted into
wall outlet. Verify correct operating
voltage at outlet.
Replace Power Supply.

Reader software is
corrupt.

Replace reader.

Reader appears to
lock up.

Readers are vulnerable
to high ESD pulses. As a
result, the reader can
lock up.

Disconnect the power from the reader
and reconnect. The reader should
reset. If the reader does not function
normally after reset, replace the reader.

Any LED fails and
buzzer alarms during
power up.

Suspect LED bad.

Reader may operate normally with one
or more bad LEDs, but the reader
should be replaced as soon as
possible.

Reader board failure.

If reader does not read or write, replace
the reader.

Buzzer malfunction.

Reader may operate normally without
buzzer, but the reader should be
replaced as soon as possible.

Reader board failure.

If reader does not read or write, replace
the reader.

Reader software is
corrupt.

Replace reader.

No buzzer on power
up.

30

Troubleshooting

Symptom
No buzzer when
reading a tag.

Probable Cause

Corrective Action

Replace reader.

External RS-232 cable
malfunction

Check cable connectors for bent or
broken pins. Replace external RS-485
cable if necessary.

Reader board failure.

Replace reader.

External RS-485 cable
malfunction.

Check cable connectors for bent or
broken pins. Replace external RS-485
cable if necessary.

Wrong jumper setting.

Ensure RS-485/Ethernet Jumper J4 is
across Pins 1-2.

Reader board failure.
No Digital I/O signals
present.

If the reader does not read or write,
replace the reader.

Reader software is
corrupt.

No RS-485
Communication.

Reader may operate normally without
buzzer, but the reader should be
replaced as soon as possible.

Reader board failure.

No RS-232
Communication.

Buzzer malfunction.

Replace reader.

Reader board failure.

Replace reader.

Tag ID/data is different Reader software
from expected value. version.

Program reader with latest software
version release.

Electromagnetic
interference.

Reposition reader or tag.
Slow tag when within range of reader.

Faulty tag.
No Ethernet
connectivity

Read range exceeded.
Tag speed exceeded.

Tag read failure.

Shield or reposition reader

Verify reader operation with a known
good tag.

External Ethernet cable
faulty.

Check cable and replace if necessary.

Wrong jumper setting.

Ensure RS-485/Ethernet Jumper J4 is
across Pins 2-3.

Wrong Ethernet IP
address.

Use the Digi Device Discovery
application to reverify IP address.

Reader board failure.

Replace reader.

31

MP9320 2.7 User's Guide

Contact Us
For any questions regarding products and services, including returns, repairs, technical
support, training, and all other available services, contact your distributor or SAMSys
Customer Service at the following:

E-mail
Telephone
Fax

32

support@samsys.com

1-919-281-1551

1-877-367-4342 (toll free)
8:00am-6:00pm EST, Mon-Fri

Chapter 5
Specifications
This chapter describes the specifications for the MP9320 Reader. Information provided
includes the following:
o

Reader Specifications

o

Environmental Specifications

o

Battery Specifications

o

Power Supply Specifications

o

RS-232 Connector Specifications

o

RS-485 Connector Specifications

o

Ethernet LAN Connector Specifications

o

Digital I/O Connector Specifications

o

Optional Communication Cable Specifications

o

Antenna Specifications

o

Regulatory Standards

33

MP9320 2.7 User's Guide

Reader Specifications
Frequency

865-870 MHz (25 KHz steps)
902-928 MHz (200 KHz steps)
869.525 MHz single frequency

RF Power

16 mW - 3 W

Connections

RS-232, RS-485, Digital I/O (TTL), or Ethernet LAN

Input Voltage

15 Vdc +/-5%

Input Current

3A maximum

Environmental Specifications
Operating
Temperature

-4° F to 158° F (-20° C to 70° C)

Storage Temperature

-40° F to 185° F (-40° C to 85° C)

Maximum Shock

1 foot (0.3 meter) drop to any corner

Relative Humidity

5% to 95% non-condensing

Case Material

Aluminum

Case Dimensions

5.25 x 7.0 x 11.5 in (133 x 178 x 286 mm)

Weight

4 lbs (1.8 kg)

Battery Specifications (Optional)
Battery (optional)

Lithium/Manganese Dioxide

Designation

ANSI/NEDA 5012LC / IEC-CR1220

Voltage

3.0 volts

Average capacity

40 mAh to 2.0 volts

Caution - Risk of Explosion
Only replace battery with a battery of the same type and designation. There is a risk of explosion if
the battery is replaced with incorrect type. Dispose of old battery according to manufacturers
instructions and local regulations.

Power Supply Specifications
Input Voltage

100 - 240 VAC

Input Consumption 0.3 A, 31 - 45 VA
Input Frequency
Output Voltage

15 VDC

Output Current

34

50 - 60 Hz
3A

Specifications

RS-232 Connector Specifications

5

4
9

3
8

2
7

1
6

Figure 23-RS-232 Connector

Baud rate

9600 - 38400

Parity

None

Data bits

8

Stop bits

1

Pin 1

CNVSS (Normally low. High puts reader in
programming mode.)

Pin 2

TXD

Pin 3

RXD

Pin 4

DTR (shorted to pin 6)

Pin 5

GND

Pin 6

DSR (shorted to pin 4)

Pin 7

CTS

Pin 8

RTS

Pin 9

+3.3 Vdc

RS-485 Connector Specifications

1

2
3

Figure 24-RS-485 Connector

Baud rate
Parity
Data bits
Stop bits
Pin 1
Pin 2
Pin 3

9600 - 38400
None
8
1
RS-485 C (common)
RS-485 B
RS-485 A
35

MP9320 2.7 User's Guide

RS-485/Ethernet Jumper Setting
Jumper
J4
J1
J2

Pins
1-2
2-3
1-2
1-2

Action
RS-485 enabled.
Ethernet enabled.
High side termination active.
Low side termination active.

Ethernet LAN Connector Specifications
Pin 1

Network Activity
LED (green)

Pin 8

Network Link
LED (yellow)

Figure 25-Ethernet LAN Connector

Pin 1
Pin 2
Pin 3
Pin 4
Pin 5
Pin 6
Pin 7
Pin 8
Network Link
LED
Network Activity
LED

36

TXD+ (Transmit Data +)
TXD- (Transmit Data -)
RXD+ (Receive Data +)
EPWR+ (Power from switch +)
EPWR+ (Power from switch +)
RXD- (Receive Data -)
EPWR- (Power from switch -)
EPWR- (Power from switch -)
Yellow LED indicates network link is operational. On
continuously indicates Ethernet connection made.
Green LED indicates network traffic detected.

Specifications

Digital I/O Connector Specifications

4

5
10
15

3
8

9
14

2

13

1
7

12

6
11

Figure 26-Digital I/O Connector

Signal Name

Pin No.

Description

DIN0
DIN1
DIN2
DIN3
Digital input common
DOUT0
DOUT1
DOUT2
DOUT3
Digital output common

7
14
13
5
8, 15
4
11
10
2
1,9,3,6,12

Digital Input 0 - optically isolated
Digital Input 1 - optically isolated
Digital Input 2 - optically isolated
Digital Input 3 - optically isolated
Input commmon
Digital Output 0 - open collector
Digital Output 1 - open collector
Digital Output 2 - open collector
Digital Output 3 - open collector
Output common

37

MP9320 2.7 User's Guide

Optional Communication Cable Specifications

4

5
10
15

3

14

3 Pin Tini Q-G
1

3

2

Figure 27-Optional Communication Cable Pinouts

15 Pin D Sub (Digital Input/Output)
Pin No.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

Description
Output common
Output 3 - open collector
Output common
Output 0 - open collector
Input 3 - optically isolated
Output common
Input 0 - optically isolated
Input common
Output common
Output 2 - open collector
Output 1 - open collector
Output common
Input 2 - optically isolated
Input 1 - optically isolated
Input common

3 Pin Tini Q-G (RS-485)
Pin No.
1
2
3

38

Description
Common
B
A

2
8

9
13

1
7

12

6
11

Specifications

Suitable Antenna Specifications
Antenna Parameter

FCC

ETSI

Frequency

902-928 MHz

865-870 MHz

Polarization

Circular

Circular

Gain, dBic

8, max

6, max

VSWR, maximum

1.3:1

1.3:1

Caution
This device has been designed to operate with no more than 1 Watt into the antenna and an
antenna gain of no more than 9 dBic. Antenna having a higher gain is strictly prohibited per
regulations of Industry Canada, unless power into the antenna is decreased to compensate for the
increased antenna gain.The required antenna impedence is 50 ohms.
To reduce potential radio interference to other users, the antenna type and its gain should be so
chosen that the equivalent isotropically radiated power (EIRP) is not more than that required for
successful communication.
The installer of this radio equipment must ensure that the antenna is located or pointed such that it
does not emit an RF field in excess of Health Canada limits for the general population; consult
Sagfety Code 6, obtainable from Health Canada'a website at www.hc-sc.gc.ca/rpb

39

MP9320 2.7 User's Guide

Regulatory Standards
Emissions
Radiated Emissions (enclosure)

EN 55022 Class B
FCC Part 15

Conducted Emissions (AC port)

EN 55022
FCC Part 15

Harmonic Distortion (AC port)

EN 61000-3-2: 1999

Voltage Fluctuation (AC port)

EN 61000-3-3

RF Spectrum

EN 300 220-1
EN 300 220-2
FCC Part 15
Canada RSS-210

Immunity
Electrostatic Discharge Immunity (all ports)

EN 61000-4-2

Radiated Immunity (enclosure)

EN 61000-4-3

Magnetic Immunity (enclosure)

EN 61000-4-8

Electrical Fast Transient Immunity (all ports)

EN 61000-4-4

Lightning Surge Immunity (all ports)

EN 61000-4-5

Conducted Immunity (all ports)

EN 61000-4-6

Voltage Dips and Short Interruptions (AC port)

EN 61000-4-11

EMC

EN 301 489-1
EN 301 489-3

Safety
Electrical Safety
RFID Human Safety

40

EN 60950
EN 50364

Appendix A
Reader Configuration
This appendix describes how to change or update the MP9320 Reader
configuration using the RF Command Suite. Refer to the RF Command Suite
User's Guide for additional information.
Information provided in this appendix includes the following:
o

Operating Modes

o

Default Configuration

o

Configuring the Reader with RF Command Suite

- Changing the RS-232 Configuration
- Changing Reader Operation Modes
- Configuring Specific Protocols
o

Updating Reader Firmware with RF Command Suite

o

Updating the Reader Firmware using the ICCM

o

Using CHUMP Commands to Configure the Reader

41

MP9320 2.7 User's Guide

Operating Modes
SAMSys reader software is configurable to verify configuration parameters.
Typical reader parameters include the following:
o

RF communication mode (polled or continuous)

o

Serial communication mode (polled or continuous)

o

Multiplexer Configuration (# antennas, inventory rounds, and antenna hopping)

o

Serial multidrop addressing

o

Protocol configuration

o

Protocol selection

For detailed information on checking reader configuration, refer to the following
sections and the RF Command Suite User's Guide.

Default Configuration
The factory default configuration is as follows:
o

o

Serial Configuration
- 9600 Baud
- 8 Data Bits
- 1 Stop Bit
- No Parity

o

42

General Configuration
- RF Continuous
- Serial Continuous

Multiplexer Configuration
- 1 antenna
- Antenna hopping enabled
- 1 inventory round per antenna

Reader Configuration

Configuring the Reader with RF Command Suite
RF Command Suite can be used to easily configure your reader. The Reader
Config interface provides control over the reader configuration registers that set
communication parameters, change operating modes, and control the transmitter
and receiver. These configuration registers are located under General
Configuration.
In addition, individual protocol configurations can be modified. The protocol
configuration registers are located under Protocol Configuration.
NOTE: If reader configuration commands have been recently sent from the command line

or by pressing the function keys, the Reader Configuration window may not reflect
the updated settings. Refresh the Reader Configuration window by collapsing and
re-expanding the directories (see Figure 28). The updated settings should be
displayed.

1.

To configure the reader, select the Reader Config tab.

Figure 28 - Reader Configuration

2.

To modify the general configuration registers expand the directory under
General Configuration.

3.

To modify the protocol configuration registers expand the directory under
Protocol Configuration.

Caution
SAMSys readers use internal registers to provide a high degree of flexibility in
setting operational parameters. However, improper setting of these registers can
result in reader inoperability or permanent damage. For detailed information on
reader and protocol configuration registers, refer to the Comprehensive Heuristic
Uniform Messaging Protocol (CHUMP) Reference Guide and the Field Installation
Guide.

NOTE: To make any reader changes permanent, the changes must be written to non-

volatile memory (NVM). To make changes permanent, select the Persistence Flag
option
before sending the change to the reader.
43

MP9320 2.7 User's Guide

Changing the RS-232 Configuration
To confiure the reader's serial port parameters, perform the following:
1.

Select the RS-232 UART parameters as shown in the following:

Figure 29 - RS-232 Serial Port Configuration

2.

Make any changes using the pull-down menus and selectors on the right side
of the display and press Send Changes to Reader

.

Changing Reader Operation Modes
The reader's serial and RF modes can be configured for polled or continuous
operation. In addition, the RF On when Idle mode can be set. To change any of the
operating modes, perform the following:
1.

Select the specific General Configuration Word (GCW) parameters as shown
in the following:

Figure 30 - Serial and RF Mode Configuration

2.

Make any changes using the selectors on the right side of the display and
press Send Changes to Reader

44

.

Reader Configuration

Configuring Specific Protocols
Individual Protocol Configuration registers can be modified for specific tag types
and read modes. For specific protocol configuration register information, refer to
the Comprehensive Heuristic Uniform Messaging Protocol (CHUMP) Reference
Guide. To configure individual protocol registers, perform the following:
1.

Select the individual protocol configuration word parameters.

Figure 31 - Protocol Parameter Configuration

2.

Enable or disable a specific protocol parameter by using the selectors on the
.
right side of the display and press Send Changes to Reader

45

MP9320 2.7 User's Guide

Updating Reader Firmware with RF Command Suite
Periodically, SAMSys releases updated reader firmware that incorporates new
protocols, enhanced features, and updated FlashROM images. SAMSys readers
can be updated with new firmware using RF Command Suite. Refer to the RF
Command Suite Users Guide for detailed information on this application.

An
tive2

a
tenn3

4

Ac
1

UH P
F 93
Lo
ng 20
-R
an 2
g e .7
Re E
a d PC
er

ult
Fa
r
we
Po
nse
Se
it
sm
Tran

R (1
S5
-4
85 Vdc
& 2.
D5
ig am
ital
I/O p

m

ax

)

M

-232
RS

Po

we

r

Figure 32-Firmware Upload System Configuration

Receiving Updated Firmware from SAMSys
Updated firmware is available by contacting SAMSys customer support. The
firmware file has a .chp extension and is typically included in a zipped release file
such as "EPCReader_1.36.10.zip"
Copy the files to a PC or other host computer connected to the reader.
Uploading Firmware with RF Command Suite
When uploading a file, RF Command Suite sends one line at a time and waits for
the {a response from the reader before sending the next line. If an e: is received,
indicating an error, the upload aborts.
To upload firmware to a reader, perform the following:
1.
2.

Start RF Command Suite.

3.

Select the Command interface window and turn off the RF output by pressing
the RF Off function key.

4.

Select the Upload File tab.

5.

46

Connect the reader to the PC using the RS-232 or Ethernet port as required.

Browse to the file to upload. To use the directory navigator, press the Browse
button
.

Reader Configuration

Figure 33 - Upload File Controls

6.

When uploading FORTH files, insert a time delay between each line of the
file. Select the Send with delay option and enter a time delay in
milliseconds. A time delay is not necessary with .chp files.

7.

When you are ready to upload the file, press Start

8.

The file will be uploaded to the reader. During upload, a bar graph indicates
what percentage of the file has been sent.

9.

If the file cannot be sent, a File Transfer Timeout error is displayed.

.

47

MP9320 2.7 User's Guide

Updating Reader Firmware using the ICCM
To upgrade the reader firmware using the ICCM, verify that the ICCM is
connected to the reader via the RS-232 or RS-485 communication port and that a
PC or other host computer is connected to the ICCM via the RS-232 port. See
Figure 32.
Receiving Updated Firmware from SAMSys
Updated reader firmware is available on CD or via download from the SAMSys
website at www.samsys.com. The upgrade includes the reader application code
which has a .mot extension such as UHFrdr_1.30d.mot.
Copy the files to a PC or host computer connected to the ICCM.
Transferring the Files to the ICCM
Once the upgrade files are loaded to your PC, use the Transfer Files function on the
ICCM to transfer the files to the ICCM. For detailed information on the Transfer
Files function, refer to the Interrogator Control and Concentrator Module User's
Guide.
Uploading the File to the Reader
After transferring the files to the ICCM, use the Upload Reader Firmware function
to upload the reader application file to the reader. Use the Upload Reader
FlashROM function to upload the Forth word definitions file to the reader. For
detailed information on the Upload Reader functions, refer to the Interrogator
Control and Concentrator Module User's Guide.

48

Reader Configuration

Using CHUMP Commands to Configure the Reader
In addition to using RF Command Suite to reconfigure a reader, individual
CHUMP commands can be sent to the reader from RF Command Suite or a
terminal/command console. To setup a SAMSys reader, the Configuration Write
(Cw) command is used to write a three-letter configuration variable name and a
32-bit word to the reader. This word contains the individual setup parameters
required by the reader.
For specific syntax information on the Cw command, refer to Chapter 2 in the
Comprehensive Heuristic Unified Messaging Protocol Reference Guide.
Commonly used configuration variables include the following:
o

GCW - General Configuration Word

o

SCW - Serial Configuration Word (CHUMP 1.31 and above)

o

MCW - Multiplexer Configuration Word

o

SMA - Serial Multidrop Address

o

PCW - Protocol Configuration Word

o

PSW - Protocol Select Word

o

Pxx - Specific Protocol Configurations

o

CNR - Self Training Control

The following example shows the Cw command used to write the MCW to the
reader.
}Cw,d:MCW,b:00040200! & lt; CRLF & gt;
where:
00040200 = 4 antennas, 2 inventory round operations
per antenna.

If the Cw command was successful, the reader responds with:
{A7; & lt; FCS & gt; & lt; CRLF & gt;

Warning
The SAMSys MP9320 Reader uses internal registers to provide a high degree of flexibility
in setting operational parameters. The use of these registers is described in the MP9320
User's Guide, the MP9320 Field Installation Guide, and the Comprehensive Heuristic
Unified Messaging Protocol (CHUMP) Reference Guide. However, improper setting of
these registers can result in reader inoperability or permanent damage.
In particular, the TPC, TP0, TP1, TP2 and TP3 registers control the transmit power of the
reader. The user should not modify these registers unless specifically directed by SAMSys
personnel. Trained, professional installers should only modify them as part of the transmit
calibration procedure described in the Field Installation Guide.

49

MP9320 2.7 User's Guide

50

Appendix B
Tag Programming
This appendix describes how to program tags of varying protocols using CHUMP
commands sent from a terminal or console.
Information provided in this appendix includes the following:
o

Overview of the Tag Writing Command

o

Programming the EPC1 Tag

o

Programming the ISO 18000-6A Tag

o

Programming the ISO 18000-6B Tag

o

Programming the Impinj EPC0 Tag

o

Programming the Matrics Class 0+ Tag

51

MP9320 2.7 User's Guide

Overview of the Tag Writing Commands
Tag writing with SAMSys readers is performed using the Write Any (Wa)
command and the Write Tag (Wt) command. Wa must be used when writing to
blank tags. Wt is used when the tag already has a tag ID.
Typically, Wa is used whenever the write operation affects the tag ID. Wa can also
be used for write operations to any data on a tag. This command is executed with
a single tag in the RF field.
Wtcan only be used for write operations to a specific tag where the tag ID has
already been assigned. This command can be used for write operations to any data
on the tag, except the tag ID itself.
Both Wa and Wt have several different command parameters that can occur in any
order in the command string. In some cases, the parameters are optional. The
parameters include the following:
o

a: address block (in hex)

o

l: length

o

b: write data

o

f: control flags

Where:
a: address block refers to the particular piece of writeable memory in the tag. The
concept of a block size can vary from one tag type to another. The address block
may be optional if the specific tag type only contains a single piece of writeable
memory. This value is in hexadecimal.
l: length refers to the length of the data to be written. For some tags this length is
in bytes and for others this is in blocks.
b: write data is the data to write to the tag.
f: control flags dictate certain optional protocol specific behavior with the write
operation.
Some tags support the ability to have a portion or all of their internal memory
locked against further modification. Write operations to locked memory will not
be successful. The locked status of a piece of memory can be queried via the Yl
command. The Yl response is f:0 for unlocked or f:1 for locked.
Details of the syntax for any command found in this document can be obtained in
the CHUMP Reference Guide.
52

Tag Programming

Programming the EPC1 Tag
SAMSys MP9320 and MP9310 readers can be used to program 64-bit and 96-bit
EPC1 tags.
Use the Wa command to write EPC1 (Alien) tags. Do not use Wt since the tag does
not support singulated write operations. In addition, before writing to a 96-bit EPC
ID tag, you must send a Tag Reset (Tr) command prior to issuing the write
operation.
Prior to writing, EPC1 tags must be erased. If the command specified does not
erase the tag during the command execution then specify the erase operation
separately using the Tag Erase (Te) command.
Also, in order to calculate the CRC, the entire tag ID must be presented to the
reader in one command. EPC1 tags contain an internal CRC value which covers
the EPC ID and the kill passcode. The reader always calculates the CRC and
writes the correct value to the tag during the write operation. As a result, the
entire tag ID and passcode must be presented to the reader in one command. The
last byte is the lock password and must be always set to 00.
The Wa command has several different parameters that can occur in any order in
the command string. These parameters include the following:
o

a: address block (in Hex). This parameter is optional since there is only a
single writeable piece of memory. If specified, the parameter should use block
address 0x00.

o

l: length. This parameter reflects the number of bytes being written and must
be equal to 9 if writing a 64-bit EPC ID with the kill passcode or equal to d if
writing a 96-bit EPC ID with the kill passcode.

o

b: write data. This parameter must contain the entire EPC ID (64- or 96-bit),
followed by the one byte kill passcode.

o

f: control flags. This parameter controls operations related to writing a tag.
Set f:1 to verify the data in the tag following the write operation. Set f:2 to
erase the data prior to the write operation. For most applications, set both of
these bits with f:3.

The following is a typical command to write a 96-bit EPC1 ID tag:
}wa,a:0,b:80020304050607090a0b0c0e00,l:d,f:3!

The following is a typical command to write a 64-bit EPC1 ID tag:
}wa,a:0,b:800080042504600200,l:9,f:3!
53

MP9320 2.7 User's Guide

In addition to the Wa, Te, and Tr commands, SAMSys readers also support the
following EPC1 operations:
o

Lb Lock Block

o

Yl Query Lock Status (returns f:0 for unlocked or f:1 for locked)

o

Td Tag Destroy

The Lock Block and Query Lock Status operations can only be performed with a
single tag in the RF field and do not require any parameters. The Tag Destroy
operation requires the b: parameter to specify the particular kill passcode for this
tag.
For detailed information on these and other tag commands, refer to the
Comprehensive Heuristic Unified Messaging Protocol (CHUMP) Reference
Guide.

54

Tag Programming

Programming the ISO18000-6A Tag
Both the Wa and Wt command can be used with the ISO18000-6A tag. In addition
to Wa and Wt, two additional commands can modify specific data in the tag. The
Wd command modifies the DSFID and Wf modifies the AFI.
Typically, the Wt command is used to modify user data in the tag. The Wt, Wd, and
Wf commands require the tag ID to be in the d: parameter. Also, the tag must first
be put in the SELECT state using the Ts command with the tag ID specified in the
d: parameter.
NOTE:

Some varieties of ISO18000-6A tags are not writeable. Currently, only Atmel
markets a writeable ISO18000-6A tag.
The following parameters are used with the Wa or Wt commands.
o

a: address block (in Hex). In ISO18000-6A, only a single block can be written
at one time and this parameter represents the specific four byte block.

o

l: length. This parameter is optional since each write operation must contain
exactly four bytes.

o

b: write data. This parameter must contain four bytes of data.

The following is a typical command to write to an ISO18000-6A tag:
}wa,a:0,b:01020304!

For example, to write AABBCCDD to address 0x20 on a tag with ID
E00300001122334455667788, issue the following command:
}wt,d:E00300001122334455667788,a:20,b:AABBCCDD!

In addition to the Wa, Wt, Wd, and Wf commands, SAMSys readers also support
the following EPC1 operations:
o

Lb Lock Block

o

Yl Query Lock Status (returns f:0 for unlocked or f:1 for locked)

Each of these operations must specify a particular tag ID using the d: parameter or
first be put in the SELECT state using the Ts command with tag ID specified in
the d: parameter.

55

MP9320 2.7 User's Guide

Programming the ISO18000-6B Tag
General ISO18000-6B Programming
In ISO18000-6B, operations are controlled by a state machine within the tag. As a
result, the tag must be in the Data Exchange state for the write operation to
succeed. To guarantee the tag is in that state, the tag must be reset using the Tag
Reset Tr command followed by a Read Detect Rd command prior to performing
the first write operation.
The ISO18000-6B protocol does not provide any feedback on the write operation
since the reader always provides an Ack ({A) after the tag receives a command.
The only way to verify success is to read the data back from the tag.
An ISO18000-6B tag write operation can fail if any byte within the addressed
range is locked or if the power setting is not correct. It is not uncommon for
Philips and Rafsec ISO18000-6B tags to have some of the first eight bytes locked.
Confirm the status of the specific type of tag in use.
Both the Wa and Wt command can be used with the ISO18000-B tag. The Wt
command is used to modify data outside of the first 8 bytes in the tag and requires
specification of the tag ID using the d:parameter.
The following parameters are used with the Wa or Wt commands.
o

a: address block. In ISO18000-6B, this parameter provides the address of the
writeable memory block. The block size is one byte.

o

l: length. This parameter reflects the number of blocks being written (which
is equal to the number of bytes in this case).

o

b: write data. This parameter contains the actual data being written.

The following command example command writes AABBCCDD to user memory at
address 0x20 on a tag with ID EF04001122334455:
}wt,d:EF04001122334455,a:20,b:AABBCCDD,l:4!

In addition to the Wa and Wt commands, SAMSys readers also support the
following ISO18000-6B operations:
o

Lb Lock Block

o

Yl Query Lock Status (returns f:0 for unlocked or f:1 for locked)

Each of these operations must specify a particular tag ID with the d: parameter
and block address with the a: parameter.
56

Tag Programming

UCODE Programming
Writing multiple bytes anywhere in the first eight bytes of a UCODE tag requires
the use of the Wa command. Only a single tag should be present in the RF field for
a Wa operation. The Wa command can be used to modify any byte in the tag.
For single byte write operations, use the Wt command.
The ISO18000-6B UCODE tag can emulate a 96- or 64-bit EPC ID tag by writing
data to multiple locations in the tag and enabling the appropriate mode in the
reader. This capability is more fully described in the Implementation of EPC Tag
Data on UCODE EPC 1.19 Application Note from Philips Semiconductor. For
detailed information on reader configuration for this tag, refer to the P6B
Configuration Register description in the SAMSys Comprehensive Heuristic
Unified Messaging Protocol (CHUMP) Reference Guide.
To configure a UCODE tag for a 96-bit EPC ID of
3114F4DA34B2D05E01010101, send a Tag Reset Tr command followed by
a Read Detect Rd command. Then issue the Wa commands:
}Tr!
}Rd!
}wa,a:2,b:315E01010101,l:6!
}wa,a:10,b:14F4Da34B2D0,l:6!

To configure a UCODE tag for a 64-bit EPC ID of 4066771122334455, send a
Tag Reset Tr command followed by a Read Detect Rd command. Then issue the
Wa commands:
}Tr!
}Rd!
}wa,a:2,b:401122334455,l:6!
}wa,a:10,b:6677,l:2!

57

MP9320 2.7 User's Guide

Programming the Impinj EPC0 Tag
In EPC0, there is no single standard for performing write operations and there are
noteable differences between manufacturers. Consequently, some varieties of
EPC0 tags are not writeable. This section addresses the writable EPC0 tags
produces by Impinj.
Both the Wa and Wt command can be used with the EPC0 tag.
In Impinj EPC0 tags, the following command parameters are used:
o

a: address block (in Hex). This parameter provides the address of a writeable
memory block. The block size is one row which is two bytes.

o

l: length. Parameter reflects the number of blocks being written.

o

b: write data. Parameter must contain the data to be written. If the data
provided does not match the length specified, zeros are padded to the right of
the data.

Typically, the Wt command would be used to modify user data in the tag. The Wt
command requires specification of the tag ID using the d: parameter.
For example, to write data AABBCCDD to user memory at address 0x8 on a tag
with ID E00300001122334455667788, issue the following command:
}wt,d:E00300001122334455667788,a:8,b:AABBCCDD!

In addition to the Wt command, the reader also supports the following operations:
o

Lb Lock Block

o

Yl Query Lock Status (returns f:0 for unlocked or f:1 for locked)

o

Td Tag Destroy

The Lock Block and Query Lock Status operations must be performed with a
single tag in the RF field and do not require any parameters. The Tag Destroy
operation requires d: parameter to specify a particular tag ID and the b:
parameter to specify the particular kill passcode for this tag.
For detailed information on these and other tag commands, refer to the
Comprehensive Heuristic Unified Messaging Protocol (CHUMP) Reference
Guide.

58

Tag Programming

Program a 96-Bit EPC (Impinj Tags)
To write a 96-bit EPC on an Impinj Zuma EPC0 tag, enter the following:
}Wa,a:4,l:6,b:306c50fd76d803cf02f47f5f,f:3!
where:
a:4 is
l:6 is
b:xxxx
f:3 is

the start of the EPC
the length in rows
is the 96-bit EPC code
the command to calculate the CRC

The CRC is calculated and written to the row following the EPC code.

Program a 64-Bit EPC (Impinj Tags)
To write a 64-bit EPC and precalculated 16-bit CRC, enter the following:
}Wa, a:4,l:5,b:c80507a8009af9d71021!
where:
a:4 is the start of the EPC
l:5 is the length of the EPC and CRC in rows
b:xx is EPC and CRC

Program a 48-Bit Product Code (Impinj Tags)
In the following example, the 48-bit product code is written first and then the16-bit
serial number is written at a later time. To write the 48-bit product code, enter:
}Wa, a:4,l:3,b:c80507a8009a!

To write the 16-bit serial number, enter the following:
}Wa, a:7,l:2,b:fa6e7380!

Program the User Data (Impinj Tags)
To program user data on a 96-bit Impinj Zuma Tag, data is written to specific
rows. To write user data to User Row 11 (b hex), enter:
}Wa, a:b,b:1234!

Change the Passcode (Impinj Tags)
To change the Passcode on an Impinj Zuma Tag, enter the following:
}Wa,a:2,l:2,b:123456!
where:
l must equal 2
b must be 6 digits
59

MP9320 2.7 User's Guide

Programming the Matrics Class 0+ Tag
Matrics Class 0+ tags utilize a process called Singulation. This is a process of
uniquely identifying a tag in a population of tags and retieving its Electronic
Product Code (EPC). For detailed information on EPC Class 0 singulation, refer to
the EPC Global Class 0 specification.
When a tag is requested to identify itself, it responds with different data based on
its singulation mode. Class 0 and Class 0+ tags allow three modes of singulation:
o

ID2 - This mode responds directly with the EPC. ID2 is the fastest mode
(fewest bits transmitted), but requires the reader to echo the bits back to the
tag. This echo can create security issues. Also, this mode can not be read when
writing the EPC, since the echo will change the EPC as you write it.

o

ID0 - This mode returns packets of 12 random bits that are different every time
you singulate. When the reader has what it determine is the correct number, it
writes the EPC. This mode is the only reliable method of writing the tag EPC.

o

ID1 - This mode is the same as ID0, but every singulation returns the same bit
stream. The bits are random, but they are seeded from the EPC. Writing the
EPC changes these bits.

The singulation mode is controlled with the PE0 register and must be set prior to
writing tags.
Matrics Class 0+ tags contain three writable pages or memory blocks: These pages
are as follows:
o

Page 0 - Kill code (24 bits)

o

Page 2 - EPC code (64 or 96 bits)

o

Page 3 - User data (104 bits)

When Page 2 or Page 3 data is written, a 16-bit CRC is appended.
Both the Wa and Wt command can be used to write Matrics Class 0+ tags. The
following command parameters are used:
o

o

l: length. This parameter is required and is the number of bytes being written.

o

b: write data. This parameter is required and contains the data to write.

o

60

a: address block. This represents the memory page of the tag on which the
write operation will occur. Values can be 0, 2 or 3, as defined previously. If
this parameter is missing, it will default to 0.

d: tag ID. This parameter is required for the Wt command (optional for Wa)
and specifies the EPC code of the tag to which the write operation applies. The
16-bit CRC must be supplied along with the 64 or 96 bit EPC code.

Tag Programming

Writing Initial EPC Code to Blank Matrics EPC0+ Tags
To write the EPC code to blank tags, ID0 singulation must be used.
If ID2 traversal is to be inhibited on subsequent tags, set the traversal inhibit bit in
PE0 . Once written, those tags will not singulate using ID2 unless the EPC code is
erased and then rewritten with traversal inhibit cleared.
Once a valid EPC code is written to Page 2, it cannot be overwritten unless the tag
is first erased. Tag write operations using ID0 singulation cannot distinguish if a
tag has previously been singulated.
Each ID0 singulation will use a new random number. To prevent a single tag from
continually being selected for EPC code writing, an error code is returned if the tag
already has a valid EPC code and overwrtite is blocked.
As stated earlier, the mode must be set prior to writing tags. A typical value for the
PE0 register for writing blank tags is 0x12050180. This value sets PE0 for the
following:
o

Use ID0 singulation with 2 blocks of random bits

o

Retry count set to 5

o

Scroll first turned on

o

Autolength EPC enabled

To write the PE0 register, enter the following:
}Cw,d:PE0,b:12050180!

If traversal inhibit required, write 0x52050180 to the PE0 register.
To write a 96-bit EPC code to a blank tag, enter the following:
}Wa,a:2,b:220000000000000000000003,l:c!

61

MP9320 2.7 User's Guide

Writing a Kill Code and User Data
Kill codes and user data can be written to any tag in the field in the same manner as
the EPC code method described above, but typically a kill code and user data
would be associated with a specific EPC code. Once written, you cannot read back
the kill code.

To write a Kill Code, enter the following:
}Wa,a:0,b:112233,l:3!

To write User Data to any tag, enter the following:
}Wa,a:3,b:00112233445566778899aabbcc,l:d!

To write a specific tag, enter the EPC code and the 16-bit CRC. The following
write command singulates using ID2, so PE0 singulation bits are ignored:
}Wt,a:0,d:220000000000000000000003DCD0,b:112233,l:3
!

To write user data to any tag: (singulates using ID2, so PE0 singulation bits
ignored)
}Wt,a:3,d:220000000000000000000003DCD0,
b:00112233445566778899aabbcc,l:d!

62

Tag Programming

Tag Erase
To erase a Matrics 0+ tag, use the Tag Erase Te command. Only one tag should be
in the field when executing this command. All memory pages are filled with 0's
and a 16-bit CRC is appended.
After erasing, the EPC code page will be filled with 0's. Also, the user data page
will have all 0's with a 16 bit CRC appended at the end. This allows the user data
page to be read with the Ra command. However, the EPC code page will return an
error on Ra, since there is no valid CRC. If any page is locked, then the Te
command will fail and none of the pages will be erased.
To erase a tag, enter the following:
}Te!

Locking Tags
Individual memory pages can be locked with the Lb command. Once a page is
locked, it cannot be unlocked or written. The following are typical Lock
commands.
To lock Page 0 (Kill code of any tag singulated using PE0 bits), enter:
}Lb!

To lock Page 2 (Kill code of any tag singulated using PE0 bits), enter:
}Lb,a:2! (locks page 2, the EPC code of any tag singulated using PE0
bits)

To lock Page 3 (User data with specific EPC code), enter:
}Lb,a:3,d:220000000000000000000003DCD0!

63

MP9320 2.7 User's Guide

64

Appendix C
Configuring the IP Address
This appendix describes how to configure the IP address of the MP9320 Reader.
Topics discussed in this chapter include the following:

o

Ethernet IP Address Overview

o

IP Address Setup

65

MP9320 2.7 User's Guide

Ethernet IP Address Overview
The MP9320 can be networked with other readers on an enterprise 10/100 BaseT
Ethernet LAN. Each reader is equipped with an embedded IP device server that
allows the unit to be assigned an IP address. This address can then be accessed by
your network server or host computer.
When the MP9320 is installed on a TCP/IP network connected to the internet, the
reader must be assigned a unique IP address. The reader is configured for
automatic IP address allocation using the Dynamic Host Configuration Protocol
(DHCP) Mode. This is the default mode for the reader as it is shipped from the
factory. In this case, the reader automatically extracts the IP address from the
DHCP server.
If DHCP is not available or the reader is not setup for automatic IP address
allocation, the address can be manually assigned using the Digi Device Discovery
application.

IP Address Setup
To set up a reader for Ethernet communication, perform the following:
1.

Verify all cabling and power supplies are secure and power up the readers.

2.

Copy the Digi Discovery application from the UHF Reader system
distribution disk to your host system. This application has the filename:
dgdiscvr.zip.

3.

Copy the RF Command Suite application to your host system. This
application has the filename Setup_RFCommandSuite_10.exe.

4.

Unzip the Digi Discovery zip file and extract the dgdiscvr.exe
application. The application will be copied to your system inside a folder.

5.

Open the dgdiscvr.exe folder and double-click the dgdiscvr
application.

6.

If any readers are connected, the application will launch and the readers will
be displayed as follows:

Figure 34-Digi Device Discovery Application Window

66

Configuring the IP Address

7.

Select the IP address of the reader to configure.

NOTE: If the IP adress returns all zeros (0.0.0.0), configure the reader manually by
selecting Configure network settings.

8.

The following steps require loading a Java applet onto your computer. If your
computer will accept applets, follow Step 10 through Step 13.

9.

If your system cannot run Java applets, follow Step 14 through Step 17 to
complete the setup using a Telnet session to enter commands.

10. (For Java applet) Click on Open web interface to load a Java applet and open
a web browser window off the reader's device server.
11. (For Java applet) Click Yes if you get a security dialog box request when the
applet launches.

Figure 35-Digi Device Discovery Web Interface Window

12. (For Java applet) Select Serial Ports and verify the Baud Rate is set to 57600.

Figure 36-Digi Device Discovery Serial Configuration Window

13. (For Java applet) Press Save and go to Step 18.

67

MP9320 2.7 User's Guide

14. (For Telnet session only) Connect to the reader via a Telnet session. Use the
IP address returned by the Digi Discovery application and Port 23 for the
Telnet connection.
15. (For Telnet session only) Enter show serial and verify ther serial port
settings match the settings in the reader's SCW configuration register.
16. (For Telnet session only) To change the baud rate, enter set serial
baudrate = & lt; rate & gt; . For best performance, a baud rate of 57600 is
recommended.
17. Close the Telnet session.
18. Verify the serial port on the reader is connected to the serial port on your PC
or host system with a serial cable.
19. At this time, load RF Command Suite. This application is a SAMSys reader
management application supplied on your system CD. RF Command Suite
will be used to set the serial port speed on the reader to a Baud Rate of 57600.
20. If the reader's serial port Baud Rate is not correct, you can modify the rate by
selecting the Reader Config interface window.
21. Expand Reader Configuration
Communications

General Configuration
Serial Configuration Word (SCW).

Serial

Figure 37-Reader Serial Port Properties

22. Determine which UART is driving the serial port:
o UART-1 - unused
o UART-2 - RS-232
o UART-3 - Ethernet
23. Change any settings and click Send Changes to Reader
24. After setting the Baud Rate, close any ConnectMe and Digi Device
Discovery windows.
68

.

Configuring the IP Address

25. From RF Command Suite, select Reader Connection
disconnect any auto connected sessions.
26. Select Reader Connection

Connect via TCP/IP.

27. Select Reader Connection
connection.

AutoConnect to

Disconnect. This will

establish an Ethernet

28. Select the IP address of the reader from the popup list and press OK.
29. Select the Command interface tab and press the Version function key to verify
communication with the reader.

69

MP9320 2.7 User's Guide

70

THE POWER TO CHOOSE

SAMSys Technologies, Inc.

Part Number: HI46932-01-OM-V6.1
Printed in U.S.A.


All Legacy 9320.zip > SOAP_Ref_Guide.pdf

Reference
Guide
Simple Object Access Protocol

S
O
A
P

SAMSys
Simple Object Access Protocol
Reference Guide
First Edition (November 2003)
(C) Copyright 2003 SAMSys Technologies, Inc. All Rights Reserved.
Disclaimer and Limitation of Liability
The content of this manual is for information use only and is subject to change without notice. SAMSys assumes
no responsibility or liability for any errors or inaccuracies that may appear in this publication. No part of this
manual may be reproduced in any form or by any means, electronic, mechanical, recording, or otherwise, without
the prior written permission of SAMSys.
SAMSys products are not designed, intended, authorized or warranted to be suitable for life support applications
or any other life critical applications which could involve potential risk of death, personal injury, property damage,
or environmental damage.
About SAMSys
SAMSys is the world leader in the design and supply of Radio Frequency Identification (RFID) hardware
solutions for high volume pallet and reusable container tracking applications in global logistics management,
materials handling, and supply chain industries. SAMSys is a public company listed on the Canadian Venture
Exchange under the symbol SMY.
SAMSys Technologies, Inc.
44 East Beaver Creek Rd., Unit 11
Richmond Hill, Ontario L4B 1G8 Canada
Phone: (905) 707-0404
Toll Free: (877) 463-6546
Fax: (905) 707-9944
E-mail: samsys@samsys.com
Web: www.samsys.com
Part Number: HI471-SP-RF-R1.1

Trademarks
SAMSys is a trademark of SAMSys Technologies, Inc.
HyperTerminal(R) is a registered trademark of Hilgraeve, Inc.
Other company, product or service names appearing in this manual may be trademarks or service marks of their
respective owners.
Trademarks
SAMSys is a trademark of SAMSys Technologies, Inc.
HyperTerminal(R) is a registered trademark of Hilgraeve, Inc.
Other company, product or service names appearing in this manual may be trademarks or service marks of their
respective owners.

SOAP Reference Guide

Contents
Chapter 1 - Introduction . . . . . . . . . . . . . . . . . . . . 1
What is SOAP? . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
Writing a Simple Soap Message . . . . . . . . . . . . . . 6
Function Definition . . . . . . . . . . . . . . . . . . . . . 6
Converting the Function to SOAP . . . . . . . . . . 7
Chapter 2 - SOAP Enabled Forth Functions . . . 11
Chmod . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
CreateIntVar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
CreateStrVar . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
DIOGet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
DIOGetNumPorts . . . . . . . . . . . . . . . . . . . . . . . . 16
DIOGetPortConfig . . . . . . . . . . . . . . . . . . . . . . . . 17
DIOGetPortSize . . . . . . . . . . . . . . . . . . . . . . . . . . 18
DIOPortGet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
DIOPortGetDirection . . . . . . . . . . . . . . . . . . . . . . 20
DIOPortSet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
DIOPortSetDirection . . . . . . . . . . . . . . . . . . . . . . 22
DIOSet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
Eval . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
FGetLine . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
FileTime . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
GetNumber . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
GetString . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
GetTagFormatInfo . . . . . . . . . . . . . . . . . . . . . . . . 29
GetTime . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
ICMBeep . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
LCGetScreen . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
LCSetScreen . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
LCWriteText . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
LoadBlock . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
i

SOAP Reference Guide

LoadFile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
SaveFile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
SetNumber . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
SetString . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
SetTime . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
TagReadUserData . . . . . . . . . . . . . . . . . . . . . . . . 41
TagStackClear . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
TagStackFind . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
TagStackPeek . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
TagStackPop . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
TagStackPull . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
TagStackPush . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
TagStackSize . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
TagWrite . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
TagWriteUserData . . . . . . . . . . . . . . . . . . . . . . . . 50
Chapter 3 - SOAP Client/Server . . . . . . . . . . . . . 51
ICCM SOAP Server . . . . . . . . . . . . . . . . . . . . . . . 52
ICCM SOAP Client . . . . . . . . . . . . . . . . . . . . . . . 53
Example SOAP Messages . . . . . . . . . . . . . . . . . . 54
Appendix A - SOAP Client Variables . . . . . . . . . 57
ServerAddr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58
ServerName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58
ServerPath . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59
ServerPort . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59
SOAPAction . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60
SOAPClientDebug . . . . . . . . . . . . . . . . . . . . . . . . 60
SOAPClientEnvelope . . . . . . . . . . . . . . . . . . . . . 61
SOAPClientFault . . . . . . . . . . . . . . . . . . . . . . . . . 61
SOAPClientIgnore . . . . . . . . . . . . . . . . . . . . . . . . 62
SOAPClientMethod . . . . . . . . . . . . . . . . . . . . . . . 62
SOAPClientStyle . . . . . . . . . . . . . . . . . . . . . . . . . 63
ii

SOAP Reference Guide

SOAPClientTimeout . . . . . . . . . . . . . . . . . . . . . . 63
SOAPHostDebug . . . . . . . . . . . . . . . . . . . . . . . . . 64
Appendix B - Fault Codes . . . . . . . . . . . . . . . . . . . 65
SOAP Fault Element . . . . . . . . . . . . . . . . . . . . . . 66
SOAP Fault Codes . . . . . . . . . . . . . . . . . . . . . . . . 67
Appendix C - Using SOAPDemo . . . . . . . . . . . . . 69
Overview of SOAPDemo . . . . . . . . . . . . . . . . . . 70
Configuring the Web Server . . . . . . . . . . . . . . . . 70
Configuring the ICCM . . . . . . . . . . . . . . . . . . . . 71
Running SOAPDemo . . . . . . . . . . . . . . . . . . . . . . 72

iii

SOAP Reference Guide

iv

Chapter 1
Introduction
This chapter provides a general overview of the Simple Object
Access Protocol (SOAP). Topics discussed in this chapter include
the following:
o What is SOAP?
o Writing a Simple Soap Message

1

SOAP Reference Guide

What is SOAP?
SOAP is an XML-based protocol that lets a client -based message
activate a server-based application across the Internet. In other
words, SOAP allows you to send a request from one computer to
an application on another computer.
As shown in , the client (your application) makes a call to a web
server and passes parameters to the server. The web server then
processes the parameters and provides a response to the client.
Both call and response are transported as XML documents.
SOAP defines the client-server interaction with the following
mechanisms:
o HTTP as the base transport
o XML documents for encoding of invocation requests and
responses

Figure 1 - SOAP Message Transmission

2

Introduction

The SOAP building blocks consist of the following parts:
o Envelope - element that identifies the XML document as a
SOAP message
o Header (optional) - element that contains header information
o Body - element that contains call and response information
o Fault (optional) - element that provides information about
errors that occurred while processing the message (see
Appendix B for more information).

Figure 2 - SOAP Message Envelope

All of these elements are declared in the default name-space for
the SOAP envelope located at following address:
http://schemas.xmlsoap.org/soap/envelope

The default name-space for SOAP encoding and data types is
located at the following address:
http://schemas.xmlsoap/soap/encoding

3

SOAP Reference Guide

The following example, is a simple addition message posted to a
remote calculator. This example posts the integers 3 and 7 for
adding.
& lt; ?xml version= " 1.0 " ? & gt;
& lt; SOAP-ENV:Envelope
xmlns:soap= " http://schemas.xmlsoap.org//soap/
envelope/" & gt;
soap:encodingStyle= " http://schemas.xmlsoap.org/soap/encoding/" & gt;
& lt; SOAP-ENV:Header & gt;
& lt; optional information & gt;
& lt; /SOAP-ENV:Header
& lt; SOAP-ENV:Body & gt;
& lt; m:Add xmlns:m="http://1.1.1.1/ calc.cgi" & gt;
& lt; n1 & gt; 3 & lt; /n1 & gt;
& lt; n2 & gt; 7 & lt; /N2 & gt;
& lt; /m:Add & gt;
& lt; /SOAP-ENV:Body & gt;
& lt; /SOAP-ENV:Envelope

4

Introduction

The remote calculator responds with the sum of 10.
& lt; ?xml version= " 1.0 " ? & gt;
& lt; SOAP-ENV:Envelope
xmlns:soap= " http://schemas.xmlsoap.org//soap/
envelope/" & gt;
soap:encodingStyle= " http://schemas.xmlsoap.org/soap/encoding/" & gt;

& lt; SOAP-ENV:Header & gt;
& lt; optional information & gt;
& lt; /SOAP-ENV:Header
& lt; SOAP-ENV:Body & gt;
& lt; m:Sum xml:m="http://1.1.1.1/calc.cgi" & gt;
& lt; result & gt; 10 & lt; /result & gt;
& lt; /m:Sum & gt;
& lt; /SOAP-ENV:Body & gt;
& lt; /SOAP-ENV:Envelope

5

SOAP Reference Guide

Writing a Simple Soap Message
SOAP messages can be developed for most any application. For
example, consider that a server contains an accounting system
that calculates sales tax on purchases. Also, consider that a client
system is the point-of-sale terminal. The purchase price is
transmitted to the server for tax calculation and the total is
returned to the client.

Function Definition
In the following example, a simple sales tax function is defined
(the tax is 4% of the purchase price):
FUNCTION:GetSalesTax(PurchaseTotal)
GetSalesTax = PurchaseTotal * 0.04
END FUNCTION

This code defines a function name (GetSalesTax), a parameter
(PurchaseTotal), and a return value. In standard programming
terms, PurchaseTotal is the IN parameter and GetSalesTax is the
OUT parameter.
SOAP services also function in terms of IN and OUT
parameters. The client system passes IN parameters to the server
and then receives the OUT parameters in return.
To create a SOAP service that calculates sales tax, the server must
listen for requests to GetSalesTax, accompanied by IN
parameters. The server must then respond with OUT parameters
indicating the correct tax amount.

6

Introduction

In traditional programming structures, the function call would
resemble the following:

retSalesTax = GetSalesTax(100)
where:
retSalesTax = $4.00

Converting the Function to SOAP
In a SOAP system, the function call is formatted as an XML
message, which is passed to the server. As shown in the following
example, the XML message contains information as a traditional
call.
& lt; GetSalesTax & gt;
& lt; PurchaseTotal & gt; 100 & lt; /PurchaseTotal & gt;
& lt; /GetSalesTax & gt;

To ensure the server can correctly identify the call, the message is
wrapped in a larger document called a SOAP envelope.

& lt; SOAP-ENV:Envelope & gt;
& lt; SOAP-ENV:Header & gt; & lt; /SOAP:Header & gt;
& lt; SOAP-ENV:Body & gt;
& lt; GetSalesTax & gt;
& lt; PurchaseTotal & gt; 100 & lt; /PurchaseTotal & gt;
& lt; /GetSalesTax & gt;
& lt; /SOAP-ENV:Body & gt;
& lt; /SOAP-ENV:Envelope & gt;

7

SOAP Reference Guide

Now, add the required name-space definitions and scoping.

& lt; ?xml version= " 1.0 " ? & gt;
& lt; SOAP-ENV:Envelope
xmlns:soap= " http://schemas.xmlsoap.org//soap/
envelope/" & gt;
soap:encodingStyle= " http://schemas.xmlsoap.org/soap/encoding/" & gt;
& lt; SOAP-ENV:Header & gt; & lt; /SOAP:Header & gt;
& lt; SOAP-ENV:Body & gt;
& lt; GetSalesTax xmlns:m="http://www.accountingsystem.com/salestax" & gt;
& lt; PurchaseTotal & gt; 100 & lt; /PurchaseTotal & gt;
& lt; /GetSalesTax & gt;
& lt; /SOAP-ENV:Body & gt;
& lt; /SOAP-ENV:Envelope & gt;

8

Introduction

Finally, add the HTTP binding information to the beginning.

POST /SalesTx HTTP/1.1
Host: www.accountingsystem.com
Content-Type: application/soap+xml; encoding=utf-8
Content-Length: nnn
& lt; ?xml version= " 1.0 " ? & gt;
& lt; SOAP-ENV:Envelope
xmlns:soap= " http://schemas.xmlsoap.org//soap/
envelope/" & gt;
soap:encodingStyle= " http://schemas.xmlsoap.org/soap/encoding/" & gt;
& lt; SOAP-ENV:Header & gt; & lt; /SOAP:Header & gt;
& lt; SOAP-ENV:Body & gt;
& lt; GetSalesTax xmlns:m="http://www.accountingsystem.com/salestax" & gt;
& lt; PurchaseTotal & gt; 100 & lt; /PurchaseTotal & gt;
& lt; /GetSalesTax & gt;
& lt; /SOAP-ENV:Body & gt;
& lt; /SOAP-ENV:Envelope & gt;

At this time, the SOAP message can be posted to the accounting
system server.

9

SOAP Reference Guide

The response from the server is as follows:

HTTP/1.1 200 OK
Host: www.accountingsystem.com
Content-Type: application/soap;
ing=utf-8

encod-

Content-Length: nnn
& lt; ?xml version= " 1.0 " ? & gt;
& lt; SOAP-ENV:Envelope
xmlns:soap= " http://schemas.xmlsoap.org//soap/
envelope/" & gt;
soap:encodingStyle= " http://schemas.xmlsoap.org/soap/encoding/" & gt;
& lt; SOAP-ENV:Header & gt; & lt; /SOAP:Header & gt;
& lt; SOAP-ENV:Body & gt;
& lt; SalesTax xmlns:m="http://www.accountingsystem.com/salestax" & gt;
& lt; Tax & gt; 4 & lt; /Tax & gt;
& lt; /SalesTax & gt;
& lt; /SOAP-ENV:Body & gt;
& lt; /SOAP-ENV:Envelope & gt;

10

Chapter 2
SOAP Enabled Forth
Functions
This chapter provides descriptions of the SOAP enabled Forth
functions. These functions include the following:
o Chmod

o LC Get Screen

o Create Integer Variable

o LC Set Screen

o Create String Variable

o LC Write Text

o Eval

o Load Block

o Digital I/O Get

o Load File

o Digital I/O Get Num Ports

o Save File

o Digital I/O Get Port Configuration o Set Number
o Digital I/O Get Port Size

o Set String

o Digital I/O Port Get

o Set Time

o Digital I/O Port Get Direction

o Tag Read User data

o Digital I/O Port Set

o Tag Stack Clear

o Digital I/O Port Set Direction

o Tag Stack Find

o Digital I/O Set

o Tag Stack Peek

o FGet Line

o Tag Stack Pop

o File Time

o Tag Stack Pull

o Get Number

o Tag Stack Push

o Get String

o Tag Stack Size

o Get Tag Format Info

o Tag Write

o Get Time

o Tag Write User Data

o ICM Beep
11

SOAP Reference Guide

Chmod
Name
Change mod
Description
Change the DOS file attributes for the specified file..
Signature
[Attrib "Filename" a ]
Parameters
Name

Dir

Description

Attrib

Numeric

In

file attrib (from dos.h)
FA_NORMAL=0x00,
FA_RDONLY=0x01,
FA_HIDDEN=0x02,
FA_SYSTEM=0x04.

Filename

12

Type

String

In

Name of file

SOAP Functions

CreateIntVar
Name
Create Integer Variable
Description
Creates a new integer variable on the stack.
Signature
[ "Name" a ]
Parameters
Name

Type

Dir

Description

Name

String

In

Name of the new integer variable
to create

13

SOAP Reference Guide

CreateStrVar
Name
Create String Variable
Description
Creates a new string variable on the stack.
Signature
[ "Name" a ]
Parameters
Name

Dir

Description

Name

14

Type
String

In

Name of the new string variable to
create

SOAP Functions

DIOGet
Name
Digital I/O get
Description
Returns the value of a single digital input or output pin.
Signature
[ "Address" Pin a Value ]
Parameters
Name

Type

Dir

Description

Address

String

In

Address of the reader

Pin

Numeric

In

Pin number (0 based index)

Value

Numeric

Out Pin value (0 or 1)

15

SOAP Reference Guide

DIOGetNumPorts
Name
Digital I/O get the number of ports
Description
Returns the number of digital I/O ports on the reader..
Signature
[ "Address" a Num ]
Parameters
Name

Dir

Description

Address

String

In

Reader address

Number

16

Type
Numeric

Out Number of ports

SOAP Functions

DIOGetPortConfig
Name
Get digital I/O port configuration
Description
Get the configuration of a port, which includes the direction of
the port and how the port can be changed.
Signature
[ "Address" Port a "Dir" "Setting" ]
Parameters
Name

Type

Dir

Description

Address

String

In

Reader address

Port

Numeric

In

Port to query

Dir

String

Out Direction of port.
0 = output
1 = input
? = unknown

Setting

String

Out How is digital I/O port set?
"Software"
"DIP"
"Fixed"

17

SOAP Reference Guide

DIOGetPortSize
Name
Get Digital I/O port size
Description
Returns the number of bits in each port.
Signature
[ "Address" a Size ]
Parameters
Name

Dir

Description

Address

String

In

Reader address.

Size

18

Type
Numeric

Out Number of bits in each port.

SOAP Functions

DIOPortGet
Name
Digital I/O port get
Description
Returns the integer value of all the digital input and output pins
on a single port.
Signature
[ "Address" Port a Value ]
Parameters
Name

Type

Dir

Description

Address

String

In

Address of the reader

Port

Numeric

In

Port number (0...n)

Value

Numeric

Out Port value. Integer values depends
on the number of pins.

19

SOAP Reference Guide

DIOPortGetDirection
Name
Digital I/O port direction
Description
Returns the direction (input or output) of the port.
Signature
[ "Address" Port a Direction ]
Parameters
Name

Dir

Description

Address

String

In

Reader address.

Port

Numeric

In

Port number (0...n).

Direction

20

Type

Numeric

Out Direction of the port.
1 = input.
0 = output.

SOAP Functions

DIOPortSet
Name
Digital I/O port set
Description
Sets all the digital input and output pins on a single port.
Signature
[ "Address" Port Value a ]
Parameters
Name

Type

Dir

Description

Address

String

In

Address of the reader

Port

Numeric

In

Port number (0...n)

Value

Numeric

Out Integer value to write to the port.
Values depend on the number of
pins.

21

SOAP Reference Guide

DIOPortSetDirection
Name
Digital I/O port set direction
Description
Sets all the direction (input or output) of the digital I/O port.
Signature
[ "Address" Port Direction a ]
Parameters
Name

Dir

Description

Address

String

In

Reader address.

Port

Numeric

In

Port number (0...n)

Value

22

Type

Numeric

In

Direction to set port.
1 = input.
0 = output.

SOAP Functions

DIOSet
Name
Digital I/O port pin set
Description
Sets the value of a single output pin.
Signature
[ "Address" Pin Value a ]
Parameters
Name

Type

Dir

Description

Address

String

In

Reader address.

Pin

Numeric

In

Pin number (0...n)

Value

Numeric

In

Pin value (0 or 1).

23

SOAP Reference Guide

Eval
Name
Evaluate string
Description
Evaluate the string on the top of the stack as Forth expression.
Signature
[ "Forth" a ]
Parameters
Name

Type

Dir

Description

Forth

String

In

Forth commands as a string

CAUTION
Any commands sent in the Eval function must not leave any
values on the stack. Stack overruns can occur. For
example, EVAL (2 3 +) will leave 5 on the stack.

24

SOAP Functions

FGetLine
Name
File Get Line
Description
Read a line from the specified file.
Signature
[ "Filename" Linenumber a "ReadString"
Success ]
Parameters
Name

Type

Dir

Description

Filename

String

In

File to read.

Linenumber

Numeric

In

Line number to read (1 based)

ReadString

String

Out String that was read. NULL if
nothing read.

Success

Numeric

Out 1 = success.
0 = failure (EOF or bad filename)

25

SOAP Reference Guide

FileTime
Name
File Time
Description
Returns the UNIX time of the specified file..
Signature
[ "Filename" a Ftime] ]
Parameters
Name

Dir

Description

Filename

String

In

File name.

Ftime]

26

Type
Numeric

In

Unix time from the OS timestamp
(last time file was written).

SOAP Functions

GetNumber
Name
Get number variable value
Description
Returns the value of a number variable.
Signature
[ "VariableName" a Value ]
Parameters
Name

Type

Dir

Description

VariableName String

In

Name of the number variable in the
dictionary

Value

Out Value of the number variable

Numeric

27

SOAP Reference Guide

GetString
Name
Get string variable value
Description
Returns the value of a string variable.
Signature
[ "VariableName" a "Value" ]
Parameters
Name

Dir

Description

VariableName String

In

Name of the string variable in the
dictionary

Value

28

Type

Out Value of the string variable

String

SOAP Functions

GetTagFormatInfo
Name
Get Tag Format Info
Description
Returns the format information of the tag.
Signature
[ "TagType" a IDlen NumBlocks Size
StartOfEditable "SpecialBlocks"]
Parameters
Name

Type

Dir

Description

TagType

String

In

Tag type to look up.

IDlen

Numeric

Out Length of tags ID in bytes.

NumBlocks

Numeric

Out Number of blocks of editable data.

Size

Numeric

Out Size of each block in bytes.

StartOfEditable Numeric

Out Offset where editable data begins.

SpecialBlocks

Out The special blocks in the editable
area (passwords, private data, or
configuration bits). The string
returned is a list of integers
separated by |.

String

29

SOAP Reference Guide

GetTime
Name
Get time
Description
Returns the time in Unix format.
Signature
[ a CurrentTime ]
Parameters
Name

Dir

CurrentTime

30

Type

Description

Numeric

Out The current time, in seconds
elapsed from 00:00:00 January 1,
1970

SOAP Functions

ICMBeep
Name
ICCM Beep
Description
Activate the ICCM beeper.
Signature
[ Tick a ]
Parameters
Name

Type

Dir

Description

Tick

Numeric

In

Number of ticks to sound beeper.
0 = off
1000 = 1 second

TagID

String

In

ID of tag to lock DSFID on.
"" for all tags.

TagID

String

Out ID of tag found.

lockStatus

String

Out Lock status of the blocks.

31

SOAP Reference Guide

LCGetScreen
Name
LC Get Screen
Description
Returns the active screen for the ICCM.
Signature
[ a active screen ]
Parameters
Name

Dir

Active screen

32

Type

Description

Numeric

Out Screen number (0 - 5)

SOAP Functions

LCSetScreen
Name
LC Set Screen
Description
Sets the active screen for the ICCM.
Signature
[ Screen a ]
Parameters
Name

Type

Dir

Description

Screen

Numeric

In

Screen number (0 - 5)

33

SOAP Reference Guide

LCWriteText
Name
LC Write Text
Description
Write text to LCD screen on ICCM.
Signature
[ Screen Line Column Magfact "Text" a ]
Parameters
Name

Type

Dir

Description

Screen

Numeric

In

Screen number (0 - 5)

Line

Numeric

In

Line number to place text (1 - 25)

Column

Numeric

In

Column to place text (0 - 52)

Magfact

Numeric

In

Magnification factor - text size (1 - 3)

Text

String

In

text string to write to screen

NOTE: Line and column numbers are based on a magnifcation
factor of 1.

34

SOAP Functions

LoadBlock
Name
Read 1000 byte block
Description
Reads the specified 1000 byte block of the text file "filename"
and pushes the contents as a single string onto the stack.
Signature
[ "filename" blocknumber a "blockContents"
success ]
Parameters
Name

Type

Dir

Description

filename

String

In

Name of the file to read.

blocknumber

Numeric

In

Index of 1000 byte block.

blockContents String

Out String that was read (NULL if
nothing read).

success

Out 1 = success.
0 = failure (EOF or bad filename)

Numeric

35

SOAP Reference Guide

LoadFile
Name
Read 1000 byte block
Description
Reads the specified 1000 byte block of the text file "filename"
and pushes the contents as a single string onto the stack.
Signature
[ "filename" a "fileContents" ]
Parameters
Name

Type

Dir

Description

filename

String

In

Name of the file to read.

blockContents String

36

Out Contents of the file as a single
string.

SOAP Functions

SaveFile
Name
Save File
Description
Writes the contents of the text file "Filename". Returns 1 if
successful and 0 if not successful.
Signature
[ "FileContents" "FileName" a b ]
Parameters
Name

Type

Dir

Description

FileContents

String

In

Contents of the file as a single
string.

FileName

String

In

Name of file to write.

b

Numeric

Out 1 = success.
0 = failure.

37

SOAP Reference Guide

SetNumber
Name
Set variable value
Description
Sets the value of a numeric variable.
Signature
[ Value "VariableName" a ]
Parameters
Name

Type

Dir

Description

Value

Numeric

In

New variable value

In

Variable index in dictionary

VariableName String

38

SOAP Functions

SetString
Name
Set variable value
Description
Sets the value of a numeric variable.
Signature
[ Value "VariableName" a ]
Parameters
Name

Type

Dir

Description

Value

Numeric

In

New variable value

In

Variable index in dictionary

VariableName String

39

SOAP Reference Guide

SetTime
Name
Set time
Description
Set the time in Unix format.
Signature
[ Time a ]
Parameters
Name

Dir

Description

Time

40

Type
Numeric

In

The current time, in seconds
elapsed from 00:00:00 January 1,
1970.

SOAP Functions

TagReadUserData
Name
Tag Read User Data
Description
Returns the user data from a specific block on a specific tag.
Signature
[ "Address" "TagID" "TagType" blockAddr
length a "TagID" "TagData" "TagType"
"TagType" status ]
Parameters
Name

Type

Dir

Description

Address

String

In

Reader address.

TagID

String

In

ID of tag to read

TagType

String

In

Type of tag.

blockAddr

Numeric

In

Address of block to read

length

Numeric

In

Number of blocks to read

TagID

String

Out ID of tag read

TagData

String

Out User data from the tag.

TagType

String

Out Type of tag.

TagType

String

Out Type of tag.

status

Numeric

Out 1 = success
0 = failure

41

SOAP Reference Guide

TagStackClear
Name
Tag Stack Clear
Description
Removes all tags from the tag stack.
Signature
[a]
Parameters
Not applicable

42

SOAP Functions

TagStackFind
Name
Tag Stack Query
Description
Indicates if the tag stack contains atag with the given ID.
Signature
[ "Data" a Exists ]
Parameters
Name

Type

Dir

Description

Data

String

In

Tag ID

Exists

Numeric

Out Index+1 if the tag is on the stack.
0 if the tag is not on the stack.

43

SOAP Reference Guide

TagStackPeek
Name
Tag Stack Peek
Description
Returns a copy of the tag on the stack (non-destructive).
Signature
[ Index a "Source" "Data" Time ]
Parameters
Name

Dir

Description

Index

Numeric

In

Index of the stack element to copy.
0 = bottom of the stack.
TagStackSize-1 = top of stack.

Source

String

Out Name of the data source
(for example, "COM1").

Data

String

Out Tag data in CHUMP format.

Time

44

Type

Numeric

Out Time in UNIX format. Same format
as that returned with the GetTime
command.

SOAP Functions

TagStackPop
Name
Tag Stack Pop
Description
Pops a tag from the tag stack
Signature
[ a "Source" "Data" Time ]
Parameters
Name

Type

Dir

Description

Source

String

Out Name of the data source
(for example, "COM1").

Data

String

Out Tag data in CHUMP format.

Time

Numeric

Out Time in UNIX format. Same format
as that returned with the GetTime
command.

45

SOAP Reference Guide

TagStackPull
Name
Tag Stack Pull
Description
Removes a tag on the stack at the specified location.
Signature
[ Index a "Source" "Data" Time ]
Parameters
Name

Dir

Description

Address

Numeric

In

Index of the stack element to copy.
0 = bottom of the stack.
TagStackSize-1 = top of stack.

Source

String

Out Name of the data source
(for example, "COM1").

Data

String

Out Tag data in CHUMP format.

Time

46

Type

Numeric

Out Time in UNIX format. Same format
as that returned with the GetTime
command.

SOAP Functions

TagStackPush
Name
Tag Stack Pull
Description
Push a tag onto the stack. Ignores duplicates.
Signature
[ "Source" "Data" Time

a Unique ]

Parameters
Name

Type

Dir

Description

Source

String

In

Name of the data source
(for example, "COM1").

Data

String

In

Tag data in CHUMP format.

Time

Numeric

In

Time in UNIX format. Same format
as that returned with the GetTime
command.

Unique

Numeric

Out 1 = tag is actually pushed.
0 = ignored because it was already
on the stack.

47

SOAP Reference Guide

TagStackSize
Name
Tag Stack Size
Description
Returns the number of tags on the tag stack.
Signature
[ a Size ]
Parameters
Name

Dir

Size

48

Type

Description

Numeric

Out Number of tags on the tag stack.

SOAP Functions

TagWrite
Name
Tag Write
Description
Sets the data on the tag.
Signature
[ "Address" "TagData" a b ]
Parameters
Name

Type

Dir

Description

Address

String

In

Reader address.

TagData

String

Out Data to appear on the tag.

b

Numeric

Out 1 = Success
0 = Failure
Success indicates message
accepted for sending to the reader.
To verify if write was successful,
check the value status on
ReaderPoll.

49

SOAP Reference Guide

TagWriteUserData
Name
Tag Write User Data
Description
Writes the user data fields out to a specific tag.
Signature
[ "Address" "TagID" "TagType" blockAddr
length "TagData" a "status ]
Parameters
Name

Dir

Description

Address

String

In

Reader address.

TagID

String

In

ID of tag to write

TagType

String

In

Type of tag.

blockAddr

Numeric

In

Address of block to write

length

Numeric

In

Number of blocks to write

TagData

String

In

User data for the tag.

status

50

Type

Numeric

Out 1 = success
0 = failure

Chapter 3
SOAP Client/Server
This chapter provides information on the SOAP client/server in
the Interrogator Control and Concentrator Module (ICCM).
Topics discussed in this chapter include the following:
o ICCM SOAP Server
o ICCM SOAP Client

51

SOAP Reference Guide

ICCM SOAP Server
The ICCM contains a SOAP server that allows the unit to be
remotely configured over a TCP/IP network. To process SOAP
calls, a script file called soap.cgi is loaded into the ICCM.
To access the ICCM SOAP.server, perform the following:
1. Launch your default web browser,
2. Enter the IP address into the Address line of the web
browser as follows and press Enter.
http://10.1.1.151/soap.cgi

NOTE: The actual ICCM IP address will be different, depending on
the DHCP server allocation. If you do not know the IP
address, press the Status button on the ICCM Main Menu.
Refer to the Operation chapter.

52

SOAP Client/Server

ICCM SOAP Client
The ICCM also contains a SOAP client that allows the unit to
send SOAP messages to a remote SOAP server.
The primary interface to the SOAP client is through the
SoapForward string variable.
If SoapForward is set to the body of a SOAP message, the client
will pick up that value and send it as a SOAP message to the
remote SOAP server.
In the following example, TestSoapClient retrieves the value of
SoapForward and compares it to "" (empty string). If the string is
not empty, a message is pending and the client needs to try again
later. If thestring is empty, then SoapForward is set to the
message to be sent to the server.
: TestSoapClient
SoapForward @ "" EQ IF
' & lt; m:TagMsg xmlns:m="'
SoapClientMethod @
"' & gt; Insert Tag Data Here & lt; /m:TagMsg & gt; '
CAT CAT SoapForward !
THEN
;

NOTE: The Envelope or Body elements are not included in the
code. The SOAP client adds those automatically before
sending the message to the SOAP server.
The SoapClientMethod variable is used to fill in the
namespace for TagMsg. The value is set in the
WATTCP.CFG file in the ICCM
53

SOAP Reference Guide

Example SOAP Messages
The following is an example of the ICCM sending a SOAP
message to a remote server.

& lt; ?xml version= " 1.0 " encoding= " UTF-8 " standalone= " no " ? & gt;
& lt; SOAP-ENV:Envelope SOAP-ENV:encodingStyle= " http://schemas.xmlsoap.org/soap/encoding/ " xmlns:SOAP-ENV= " http://schemas.xmlsoap.org/soap/envelope/ " & gt;
& lt; SOAP-ENV:Body & gt;
& lt; m:TagMsg xmlns:m= " http://samsys.com/stds/soap/ " & gt;
& lt; Source & gt; PMEvents:Com6:0x00 & lt; /Source & gt;
& lt; Data & gt; E0040100000329CC & lt; /Data & gt;
& lt; Temperature & gt; & lt; /Temperature & gt;
& lt; Time & gt; Thu May 22 14:11:46 2003 & lt; /Time & gt;
& lt; Type & gt; Departure & lt; /Type & gt;
& lt; /m:TagMsg & gt;
& lt; /SOAP-ENV:Body & gt; & lt; /SOAP-ENV:Envelope & gt;

The following is an example of a SOAP client calling the Eval
function on the ICCM causing it to evaluate the Forth code " 11
Quit " :

& lt; ?xml version= " 1.0 " encoding= " UTF-8 " standalone= " no " ? & gt;
& lt; SOAP-ENV:Envelope SOAP-ENV:encodingStyle= " http://schemas.xmlsoap.org/soap/encoding/ " xmlns:SOAP-ENV= " http://schemas.xmlsoap.org/soap/envelope/ " & gt;
& lt; SOAP-ENV:Body & gt;
& lt; SOAPSDK1:Eval xmlns:SOAPSDK1= " http://hdic.com/ netlib " & gt;
& lt; Forth & gt; 11 quit & lt; /Forth & gt;
& lt; /SOAPSDK1:Eval & gt;
& lt; /SOAP-ENV:Body & gt; & lt; /SOAP-ENV:Envelope & gt;
54

SOAP Client/Server

The following is the response:

& lt; SOAP-ENV:Envelope xmlns:SOAP-ENV= " http://schemas.xmlsoap.org/soap/envelope/ " SOAP-ENV:encodingStyle= " http://
schemas.xmlsoap.org/soap/encoding/ " xmlns:xsi= " http://
www.w3.org/1999/XMLSchema-instance " xmlns:xsd= " http://
www.w3.org/1999/XMLSchema " & gt;
& lt; SOAP-ENV:Body & gt;
& lt; EvalResp & gt; & lt; /EvalResp & gt;
& lt; /SOAP-ENV:Body & gt;
& lt; /SOAP-ENV:Envelope & gt;

55

SOAP Reference Guide

56

Appendix A
SOAP Client Variables
This appendix provides descriptions of the variables that control
the SOAP client. Variables described in this appendix include the
following:
o Server Address
o Server Name
o Server Path
o SOAP Action
o SOAP Client Debug
o SOAP Client Envelope
o SOAP Client Fault
o SOAP Client Ignore
o SOAP Client Method
o SOAP Client Style
o SOAP Client Timeout
o SOAP Host Debug

57

SOAP Reference Guide

ServerAddr
Name
Server Address
Type
String variable
Description
The IP address of the SOAP server.

ServerName
Name
Server Name
Type
String variable
Description
The name of the SOAP server.

58

SOAP Client Variables

ServerPath
Name
Server Path
Type
String variable
Description
The path of the file that processes the SOAP messages.

ServerPort
Name
Server Port
Type
String variable
Description
The port on the SOAP server that receives requests.

59

SOAP Reference Guide

SOAPAction
Name
SOAP Action
Type
String variable
Description
The value to use for SOAPAction in the HTTP header.

SOAPClientDebug
Name
SOAP Client Debug
Type
Numeric variable (0-9)
Description
Sets the amount of client debug information sent to the console.
0 = No debug
.
.
.
9 = Most debug

60

SOAP Client Variables

SOAPClientEnvelope
Name
SOAP Client Envelope
Type
String variable
Description
SOAP envelope namespace identifier to use for outgoing
messages.

SOAPClientFault
Name
SOAP Client Fault
Type
Numeric variable
Description
Indicates if fault occurred on SOAP client.

61

SOAP Reference Guide

SOAPClientIgnore
Name
SOAP Client Ignore
Type
Numeric variable
Description
Enable or disable sending SOAP messages.

SOAPClientMethod
Name
SOAP Client Method
Type
String variable
Description
Outgoing message namespace identifier.

62

SOAP Client Variables

SOAPClientStyle
Name
SOAP Client Style
Type
String variable
Description
Style namespace identifier for outgoing messages.

SOAPClientTimeout
Name
SOAP Client Timeout
Type
Numeric variable
Description
Time delay before the socket is dismantled asnd rebuilt.

63

SOAP Reference Guide

SOAPHostDebug
Name
SOAP Host Debug
Type
Numeric variable (0-9)
Description
Sets the amount of SOAPHost debug information sent to the
console.
0 = No debug
.
.
.
9 = Most debug

64

Appendix B
Fault Codes
This appendix provides descriptions of the Fault codes returned
by SOAP messages inside the fault element.

65

SOAP Reference Guide

SOAP Fault Element
An error message from a SOAP message is carried inside a Fault
element. If a Fault element is present, it must appear as a child
element of the Body element. A Fault element can only appear
once in a SOAP message.
The SOAP Fault element has the following subelements:

Subelement

Description

& lt; faultcode & gt;
& lt; faultstring & gt;

Human readable explanation of the fault.

& lt; faultactor & gt;

Information about who caused the fault.

& lt; detail & gt;

66

Code for identifying the fault.

Application specific error information related to
the body element.

Fault Codes

SOAP Fault Codes
The following values are used in the SOAP fault code element to
define the fault:

Error

Description

VersionMismatch

Found an invalid namespace for the SOAP
Envelope element.

MustUnderstand

An immediate child element of the Header
element, with the mustUnderstand attribute set
to 1, was not understood.

Client

The message was incorrectly formed or
contained incorrect information.

Server

There was a server problem and the message
could not proceed

67

SOAP Reference Guide

68

Appendix C
Using SOAPDemo
This appendix provides instructions for installing and using the
SOAPDemo application.

69

SOAP Reference Guide

Overview of SOAPDemo
SOAPDemo is an executable application that demonstrates the
SOAP capabilities of the SAMSys Interrogator Control and
Concentrator Module (ICCM). This application is a single
Microsoft Windows executable that runs as a CGI service under
the Apache web server or Microsoft's Internet Information Server
(IIS).
SOAPDemo operates as both a SOAP server to accept SOAP
messages from the ICCM and as a web page to display incoming
tags from the ICCM. An aggregate tag total is also displayed.

Configuring the Web Server
Apache Web Server
For the Apache web server, copy the soapdemo.exe file to the
Apache\cgi-bin directory. The following is a typical path to
the directory:
c:\Program Files\Apache Group\Apache\cgi-bin

Internet Information Server
For the IIS, copy the soapdemo.exe file to the Scripts
directory. The following is a typical path to the directory:
c:\Inetpub\Scripts

70

Using SOAPDemo

Configuring the ICCM
The ICCM contains a configuration file with setup parameters for
the SOAP client and server. The WATTCP.cfg file should be
edited to include the location of the soapdemo.exe file.
Use the Edit WATTCP.CFG function on the ICCM to modify
the server parameters to include the actual path of the
soapdemo.exe file.
ServerAddr=199.72.127.204
ServerPath="/cgi-bin/soapdemo.exe"
ServerPort=80
1. For Apache web servers, set ServerPath to /cgi-bin/
soapdemo.exe.
2. For IIS, set ServerPath to /Scripts/soapdemo.exe.
3. Set ServerAddr and ServerPort to the local
environment.
4. After all parameters are entered, restart the ICCM.

71

SOAP Reference Guide

Running SOAPDemo
To run the SOAPDemo application, launch a web browser and set
the address to the server address, directory, and file. For example:
http://199.72.127.204/cgi-bin/soapdemo.exe
The following Soap Demonstrator Module screen will appear:

Figure 1 - SOAP Demonstrator Module

After tags are successfully sent to the server, press Refresh to
update the SOAPDemo screen.

72

Using SOAPDemo

Figure 1 - SOAP Demonstrator Module Screen with Tags

73

SOAP Reference Guide

74

SAMSys Technologies, Inc.

Part Number: HI471-01-OM-V1
Printed in U.S.A.


All Legacy 9320.zip > RAPID_API_Dev_Guide_V1.0.1.pdf

RAPID
Developer's
Guide
RFID Application Programming Interface
for Developers

SAMSys
RAPID Developer's Guide
First Edition (September 1, 2005)
(C) Copyright 2005 SAMSys Technologies, Inc. All Rights Reserved.
Disclaimer and Limitation of Liability
The content of this manual is for information use only and is subject to change without notice. SAMSys assumes no responsibility or liability for any errors
or inaccuracies that may appear in this publication. No part of this manual may be reproduced in any form or by any means, electronic, mechanical,
recording, or otherwise, without the prior written permission of SAMSys.
SAMSys products are not designed, intended, authorized or warranted to be suitable for life support applications or any other life critical applications
which could involve potential risk of death, personal injury, property damage, or environmental damage.
About SAMSys
SAMSys Technologies, Inc. is a world-leading provider of RFID reader hardware solutions in the LF, HF, and UHF segments of the RFID marketplace.
SAMSys is a public company listed on the Toroto Stock Exchange under the symbol SMY.
SAMSys Technologies, Inc.
44 East Beaver Creek Rd., Unit 11
Richmond Hill, Ontario L4B 1G8 Canada
Phone: (905) 707-0404
Toll Free: (877) 463-6546
Fax: (905) 707-9944
E-mail: samsys@samsys.com
Web: www.samsys.com
Manual Part Number: HI471-API-V1.0

Trademarks
SAMSys is a trademark of SAMSys Technologies, Inc.
HyperTerminal(R) is a registered trademark of Hilgraeve, Inc.
WinZip(R) is a registered trademark of WinZip Computing, Inc.

Other company, product or service names appearing in this manual may be trademarks or service marks of their respective owners.

Contents

Contents
Chapter 1 - Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
Who Should Read This Guide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
What Is in This Guide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
RAPID Architecture . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
Connection Management Layer . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
Data Management Layer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
Mapping Layer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
Installing RAPID . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
System Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
API Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
Directory Structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
Where to Find Additional Help . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
Chapter 2 - Mapping Layer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
Overview of Mapping Layer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
Non-Type Safe Layer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
Type Safe Layer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
Reader Management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
Tag Management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
Chapter 3 - Data Management Layer . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
Overview of Data Management Layer . . . . . . . . . . . . . . . . . . . . . . . . . . 14
Data Manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
Tag Manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
Configuration Manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
Chapter 4 - Connection Management Layer . . . . . . . . . . . . . . . . . . . . . 23
Overview of Connection Management Layer . . . . . . . . . . . . . . . . . . . . 24
iConnection Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
Serial Connectivity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
Socket Connectivity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
Discovery Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
Appendix A - CHUMP Protocol . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
Overview of the CHUMP Protocol . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
CHUMP Frame . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
Message Head . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
Command Block . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
Message Tail . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
Appendix B - Reader Configuration File . . . . . . . . . . . . . . . . . . . . . . . . 31
Appendix C - Configuration Registers . . . . . . . . . . . . . . . . . . . . . . . . . . 39
i

RAPID Developer's Guide

ii

Chapter 1
Introduction
This chapter provides a general overview for the SAMSys RFID Application
Programming Interface for Developers (RAPID). Topics discussed in this chapter
include the following:
o

Overview

o

Who Should Read This Guide

o

What Is in This Guide

o

RAPID Architecture

o

Installing the Software API

o

Where to Find Additional Help

1

RAPID Developer's Guide

Overview
RAPID allows system developers to extend the functionality of SAMSys readers
by providing server-side access to the reader's configuration and control functions.
Currently, all SAMSys readers support the Comprehensive Heuristic Uniform
Messaging Protocol (CHUMP) which provides an interface to the reader's
connectivity layer. RAPID provides the application developer with a high level
interface to the reader's data layer.

Who Should Read This Guide
This guide is intended for application and RFID system developers who desire a simple,
easy-to-use, type safe interface for controlling and managing SAMSys readers.

Developers are also expected to have an understanding of the important concepts
of the object-oriented paradigm. RAPID supports both Java and .NET
programming environments and makes extensive use of object-oriented properties.
Therefore, developers wanting to interface SAMSys readers with RAPID should
be proficient with these programming environments. Also, the developer should
become familiar with the SAMSys CHUMP Reference Guide

What Is in This Guide
The RAPID Developer's Guide introduces developers to the process of developing
programs to interface with SAMSys readers. A brief overview of the architecture
is provided along with more detailed views of the Mapping, Data Management,
and Connection Management Layers. After each discussion, several example
programs are provided.
The appendices at the end of this guide provide a brief overview of CHUMP, a
sample configuration file, and listings of the reader configuration registers.
NOTE: This document is intended as an overview of RAPID. Specific functions are defined in the
online Help provided with the application. If you need additional information not provided
by this document, please refer to the online Help.

RAPID Architecture
The RAPID architecture is divided into three layers to componentize the software
and accomodate different interfacing requirements. Thes layers are as follows:
o
o

Data Management Layer

o
2

Mapping Layer
Connection Management Layer

Introduction

Connection Management Layer
For users who wish to use raw CHUMP commands, the Connection Management
layer handles all communication with the reader. SAMSys readers can
communicate via a serial port or Ethernet port using TCP/IP protocol. For more
information on this layer, refer to Chapter 7.

Data Management Layer
This layer provides a more type safe abstraction over the Connection Management
layer and allows you to see the entire interface from a data perspective. This layer
provides a mechanism to instantiate the reader and extract the data out of the
reader. This layer has two major components:
o

Configuration Management

o

Tag Management

Tag management provides notifications when a tag is added or removed from the
field of the reader. Configuration management provides functions for extracting
reader configurations. For more information on this layer, refer to Chapter 6.

Mapping Layer
The Mapping Layer provides a type safe interface for mapping CHUMP
commands to objects. For example, the ReadUserData object sends the Ra
command. For more information on this layer, refer to Chapter 5.
3

RAPID Developer's Guide

Installing RAPID
System Requirements
RAPID requires the following hardware and software:
Software Requirements
o
o

.NET Framework, Version 1.1 or higher
Java Runtime, Version 1.3.1 and higher

API Installation
RAPID is delivered on your Customer Documentation CD and consists of a
Windows Installer file named RAPID.msi. To install the API, perform the
following:
1. Double-click the RAPID icon

2. Press Next.

4

. The Installer window is displayed.

Introduction

3. Carefully read the license agreement and select I Agree. Press Next.

4. Verify the target directory is correct. If not, browse to the correct directory.
Press Next.

5

RAPID Developer's Guide

5. Press Next.

6. RAPID will be installed. After installation is complete, press Close.

6

Introduction

Directory Structure
The installation has both java and .Net libraries. The .NET library name is SAMSys
API 1.0.dll and the java library name is samsys.jar. Unless indicated otherwise, the
API is installed in the following directory structure:

Where to Find Additional Help
Throughout this document, you may be referred to the online help files that are
installed with the software. Help can be found at the following locations:.
o

.NET Help
- Documentation.chm
- Root/docs/index.htm

o

Java Help
- Root/java/docs

7

RAPID Developer's Guide

8

Chapter 2
Mapping Layer
This chapter provides general information on the Mapping Layer of RAPID.
Topics discussed in this chapter include the following:
o

Overview of the Mapping Layer

o

Non-Type Safe Layer

o

Type Safe Layer

9

RAPID Developer's Guide

Overview of Mapping Layer
The mapping layer provides a non-type safe and type safe layer for commands that
can be sent to the reader. This layer provides an abstraction layer on top of
CHUMP commands.
NOTE: If you need specific information not provided by this document, refer to the online Help.

Non-Type Safe Layer
The base class for all commands is BaseCommand which provides access to all
CHUMP commands used by the reader. BaseCommand is the implementation of the
base CHUMP command and all the type safe commands are derived from this
class. The following section describes the BaseCommand class.

BaseCommand Members
Public Instance Constructors
BaseCommand

Initializes a new instance of the BaseCommand..

ReceiveDataEvent

Event used to indicate incoming messages from reader.

ReceiveErrorEvent

Event used to indicate rrrors comming from reader.

Public Instance Properties
Command

Property to access the actual command (Rd, Wt, Ht, etc.)

IsSuccessfull

Returns if the operation was successfull.

Request

Property to access request to be sent to the reader

Response

Property to access response of command sent to the reader

Public Instance Methods
Equals
getChumpIdentifier

Implemented by all the type safe command objects

getErrorCode

Returns an error code. If error code is null, function call failed.

getErrorDescription

Returns the error description.

GetHashCode

Serves as a hash function for a particular type, suitable for use
in hashing algorithms and data structures like a hash table.

getRequest

Method to access request parameters such as the " d "
parameter in the in Rt command.

getResponse

Method to access reponse parameters.

GetType

Gets the type of the current instance

ToString
10

Determines whether specified Object is equal to current Object

Returns a string that represents the current object

Mapping Layer

Protected Instance Methods
Finalize

Allows an Object to attempt to free resources and perform
other cleanup operations before the Object is reclaimed by
garbage collection.

Memberwise Clone

Creates a shallow copy of the current Object.

Private Instance Methods
Initializes the Base command object with CHUMP Command.

Init

The most important attributes in this class are Request and Response. You can
assign any CHUMP command to these attributes and BaseCommand automatically
breaks it up into a queriable attribute list.
f_BaseCommand.Request = " }Rv! " ;
f_BaseCommand.Response= " {Rv,d: " EPCReader_1.36.16 007
EPC] Copyright (c) 2005 SAMSys Technologies Inc. " ,
s:8F00000B18EAB101,x:000D;C3 "

[MP9320

f_BaseCommand.getResponse( " d') // Returns reader version. i.e.
EPCReader_1.36.16...

Type Safe Layer
The Type Safe layer provides an abstraction over the non-type safe layer. This
layer provides access to the internal CHUMP commands using a type safe object
layer. The following provides a list of Reader Management and Tag Management
pbjucts and the corresponding CHUMP command.

Reader Management
Object Definition

CHUMP

NameSpace

ConfigurationRead

Cr

Samsys.Mapping.RM

ConfigurationWrite

Cw

Samsys.Mapping.RM

ManagementReset

Mr

Samsys.Mapping.RM

ReadDigitalIO

Ro

Samsys.Mapping.RM

Version

Rv

Samsys.Mapping.RM

WriteDigitalIO

Wo

Samsys.Mapping.RM

11

RAPID Developer's Guide

Tag Management
Object Definition

CHUMP

NameSpace

HaltTag

Ht

Samsys.Mapping.TM

LockBlock

Lb

Samsys.Mapping.TM

LockDSFID

Ld

Samsys.Mapping.TM

LockAFI

Lf

Samsys.Mapping.TM

ReadUserDataAnyTag

Ra

Samsys.Mapping.TM

ReadDetect

Rd

Samsys.Mapping.TM

ReadByAFI

Rf

Samsys.Mapping.TM

ReadDetectNewRound

Rn

Samsys.Mapping.TM

ReadUserData

Rt

Samsys.Mapping.TM

ReadUserData

Ru

Samsys.Mapping.TM

PerformanceTest

Pt

Samsys.Mapping.TM

TagErase

Te

Samsys.Mapping.TM

KillTag

Td

Samsys.Mapping.TM

TagMute

Tm

Samsys.Mapping.TM

TagReset

Tr

Samsys.Mapping.TM

TagSelect

Ts

Samsys.Mapping.TM

TagWake

Tw

Samsys.Mapping.TM

WriteUserDataAnyTag

Wa

Samsys.Mapping.TM

WriteDSFID

Wd

Samsys.Mapping.TM

WriteAFI

Wf

Samsys.Mapping.TM

WriteUserData

Wt

Samsys.Mapping.TM

QueryLockBlock

Yl

Samsys.Mapping.TM

QueryTagSystemInfo

Ys

Samsys.Mapping.TM

Like CHUMP commands, all objects have functions to access specific
information. For example the Version object has a function called getVersion().
The following shows the usage of the Version Class.
Version f_Version=new Version()
//...Call the code to send this object to the reader
// IConnection.send(f_Version);
// Now you can access the version details on response
String versionofreader=f_Version.getVersion();
String identifier=f_Version.getID();

12

Chapter 3
Data Management Layer
This chapter provides general information on the Data Management Layer of
RAPID. Topics discussed in this chapter include the following:
o

Overview of Data Management Layer

o

Data Manager

o

Tag Manager

o

Configuration Manager

13

RAPID Developer's Guide

Overview of Data Management Layer
The Data Management Layer is the application entry point for SAMSys readers.
Although you can directly access the connection interface using CHUMP
commands, the Data Layer provides an abstract method. The Data Management
Layer consists of three components:
o

Data Manager - This is the logical connection to the reader. You can form a
serial or socket reader connection.

o

Tag Manager - This provides an abstraction layer on top of Data manager and
can be used for Tag related reader activities.

o

Configuration Manager - This provides a mechanism to configure the reader.
With the Configuration Manager, you can read and write the internal reader
configuration registers.

NOTE: For specific function information, please refer to the online Help.

Data Manager
The Data Manager helps form the connection to a specific reader using either
serial or socket protocol implementations. Once the connection is formed, you can
send specific commands to the reader either in synchronous or asynchronous form.
The command can be formed using BaseCommand or with a type safe object.
The Data Manager also throws various events based on the data received from
reader. The possible events are as follows:
Public Instance Events
CommandReceived

Notifies each time a command is received from server.

ConfigurationReceived

Notifies each time a configuration information is
received. This is the Cr CHUMP command.

ErrorReceived

Notifies each time error information is received.

TagReceived

Notifies each time a tag is received. This is the Rd
CHUMP command.

Public Instance Fields
m_LastCommandSent

Last command sent.

Public Instance Properties
IsLive
LastCommand
14

Checks if connection is alive.
Last command sent to reader.

Data Layer

The Data Manager also provides the following functions for reader connect and
command:
Public Instance Methods
Close

Close the reader connection.

Dispose

IDisposable implementation

Equals (Inherited from
Object)

Determines whether the specified Object is equal to the
current Object.

GetHashCode(Inherited
from Object)

Serves as a hash function for a particular type, suitable
for use in hashing algorithms and data structures like a
hash table.

GetType (Inherited from
Object)

Gets the Type of the current instance

OpenConnection

Open the reader connection based on passed
parameters passed in the constructor.

sendCommand

Send a Sync command to the reader. Input is the
BaseCommand object.

sendNativeCommand

Send a Sync command to the reader. Input to this is a
native CHUMP command.
Note: The SendCommand is the preferred method of
sending CHUMP commands to a reader.

sendNativeCommandAsync

Send Async commands. Do Not Use if you are also using
Sync commands. May cause interference with Sync
commands.
Note: The SendCommand is the preferred method of
sending CHUMP commands to a reader.

The DataManager object can be instantiated using one of the following
constructors:
Constructors
public DataManager
(IConnection);

Creates DataManager with IConnection interface. For
this constructor to be used, the Calling application must
first build the Connection to the reader.

public DataManager
(Hashtable);

Creates DataManager with Hashtable of parameters.
Parameters are based on connection type.
For example, Serial connections pass name and
baudrate whereas for TCP/IP connections pass
ipaddress and portnumber.

As shown, one constructor uses Hashtable as input. All the attributes passed in the
Hashtable are based on the type of connection to be formed (serial or socket).
Internally, DataManager uses the Connection Factory to load the Connection.

15

RAPID Developer's Guide

.NET Example - Using Data Manager to Send Commands to Reader
// Create Hashtable with connection information to the reader
Hashtable fHash = new Hashtable();
fHash.Add( " type " , " socket " );
fHash.Add( " ipaddress " , " 10.1.1.65 " );
fHash.Add( " port " , " 2101 " );
//Instantiate the DataManager object
DataManager m_DataManager = new DataManager(fHash);
m_DataManager.OpenConnection();
//Use TagReceived event to receive the tag events.
m_DataManager.TagReceived += new TagReceived(CommandReceived);
//Following is the Event Handler for TagReceived Event
public void CommandReceived(object sender, BaseCommand e)
{
// Add your code here to handle event. Base command has
// functions to access the response from reader
txtResponse.AppendText( e.Response);
}

.NET Example - Using Data Manager to Send Type Safe Commands to Reader
//
//
//
//
//

Instantiate any of the typesafe objects from Samsys.Mapping.RM or
Samsys.Mapping.TM namespaces.
Use appropriate contstructor to create the object and then use
sendCommand method to send to reader.
Response is returned as the reponse to the sendCommand method.
Samsys.Mapping.RM.Version m_Version = new
Samsys.Mapping.RM.Version();
m_Version = (Samsys.Mapping.RM.Version)
m_DataManager.sendCommand(m_Version);

// Now use the type safe methods to access different information
// from the command.
Console.Write(m_Version.getVersion());
Console.Write(m_Version.getID());

16

Data Layer

Java Example - Using Data Manager to Send Commands to Reader
//Create object of the class which will receive events from data manager.
TestDataManager f_TestDataManager = new TestDataManager();
//Setup all properties in Hashtable to create object of type DataManager.
Hashtable f_Parameters = new Hashtable();
f_Parameters.put( " ipaddress " ,args[0]);
f_Parameters.put( " port " , " 2101 " );
f_Parameters.put( " type " , " socket " );
// Data Manager object is created and register...Listeners are called to
// register for various events.
DataManager f_Manager = new DataManager(f_Parameters);
f_Manager.OpenConnection();
f_Manager.registerConfigurationEventListeners(f_TestDataManager);
f_Manager.registerDataEventListeners(f_TestDataManager);
f_Manager.registerErrorEventListeners(f_TestDataManager);
f_Manager.registerTagEventListeners(f_TestDataManager);
//Perform all the tasks here...
//Unregistered the listeners
f_Managerun.registerConfigurationEventListeners(f_TestDataManager);
f_Manager.unregisterDataEventListeners(f_TestDataManager);
f_Manager.unregisterErrorEventListeners(f_TestDataManager);
f_Manager.unregisterTagEventListeners(f_TestDataManager);
//Destroy the DataManager object.
f_Manager.destroy();
// Implement following function to receive events from DataManager
public void tagRead(BaseCommand f_BaseCommand) {
System.out.println( " Tag Read: " +f_BaseCommand.getResponse());
}
public void configurationRead(BaseCommand f_BaseCommand) {
System.out.println( " ConfigurationRead: " +f_BaseCommand.getResponse());
}
public void errorReceived(ErrorObject f_BaseCommand) {
System.out.println( " Error Recived: " +f_BaseCommand.getErrorCode()
+ " ... " +f_BaseCommand.getErrorDescription());
}
public void commandReceived(BaseCommand f_BaseCommand) {
System.out.println( " Command Read: " +f_BaseCommand.getResponse());
}

Java Example - Using Data Manager to Send Type Safe Commands to Reader
// Create an type safe object of type Version
Version f_Version = new Version();
// Use the DataManager Object to send command to the reader.
f_Version = (Version)f_Manager.sendCommand(f_Version);
// Use the retuned object from sendcommand to extract
// all valuable information.
System.out.println( " Version: " +f_Version.getVersion());
System.out.println( " Serial: " +f_Version.getID());

17

RAPID Developer's Guide

Tag Manager
The Tag Manager manages and stores a tag list and the receive events related to the
tags. However, only the current tag list is stored.
The Tag Manager constructor takes Data Manager as a parameter. You must first
link TagManager to a DataManager which links to the reader. The Tag Manager
provides the following functions:

Public Instance Methods
addTag

Add tag to the taglist.

clearTagList

Clears the tag list.

Dispose

Disposes the object.

Equals
(Inherited from Object)

Determines whether the specified Object is equal to
the current Object.

GetHashCode
(Inherited from Object)

Serves as hash function for particular type, suitable
for algorithms and data structures like hash tables.

getTagIdList

Accesses the taglist.

gettagList

Get the tag list.

GetType
(Inherited from Object)

Gets the Type of the current instance.

init

Starts the timer thread to keep track of taglist.

removeTag

Removes the tag from the list.

startTagListHandlerTimer

Sets up a timer thread to track tags removed from
readers range.

ToString
(Inherited from Object)

Returns a string that represents the current object.

Protected Instance Eventss
Finalize
(Inherited from Object)

Allows an Object to attempt to free resources and
perform other cleanup operations before the Object is
reclaimed by garbage collection.

MemberwiseClone
(Inherited from Object)

Creates a shallow copy of the current Object.

Tag Manager also throws the following events when a tag is added to or removed
from the list:
Public Instance Eventss
TagAddedEvent
TagRemovedEvent

18

Notifies that a tag is being added to the taglist.
Notifies that a tag is being removed from the taglist.

Data Layer

.NET Example - Using Tag Manager for Tag List Related Functions
//Create object of Type TagManager and register for tag related events
TagManager f_TagManager = new TagManager(m_DataManager,30);
//Access the tag list or list of ids using one of the functions below.
Array f_Array = f_TagManager.getTagIdList();
String f_ID = (String)f_Array.GetValue(0);
Array f_Array = f_TagManager.getTagList();
TagEntry f_Tag = (TagEntry)f_Array.GetValue(0);
//Register for tag events.
f_TagManager.TagAddedEvent += new TagAdded(tagAdded);
f_TagManager.TagRemovedEvent += new TagRemoved(tagRemoved);
//Following are the functions for event handling.
public void tagAdded(object sender, TagInfoArgs e)
{
txtTagEvent.AppendText( e.TagName + " is Added.\n " );
}
public void tagRemoved(object sender, TagInfoArgs e)
{
txtTagEvent.AppendText( e.TagName + " is Removed.\n " );
}

Java Example - Using Tag Manager for Tag List Related Functions
//Create an object to handle events which implements TagEvents interface
TestTagManager f_TestTagManager = new TestTagManager();
//Create Hashtable with valuies to instantiate the DataManager
Hashtable f_Parameters = new Hashtable();
f_Parameters.put( " ipaddress " ,args[0]);
f_Parameters.put( " port " , " 2101 " );
f_Parameters.put( " type " , " socket " );
//Create DataManager Object
DataManager f_Manager = new DataManager(f_Parameters);
f_Manager.OpenConnection();
//Create TagManager Object
TagManager f_TagManager = new TagManager(f_Manager,3000);
//Register object to handle events.
f_TagManager.registerTagEventListener(f_TestTagManager);
//FUNCTIONS to handle events.
public void tagAdded(TagEntry f_TagEntry) {
System.out.println( " Added " +f_TagEntry.getTagID());
}
public void tagRemoved(TagEntry f_TagEntry) {
System.out.println( " Removed " +f_TagEntry.getTagID());
}
19

RAPID Developer's Guide

Configuration Manager
SAMSys readers have various configuration parameters that control reader
behavior and functionality. These parameters are stored in internal registers. The
Configuration Manager configures the reader. For a list of the configuration
registers and the parameters that can be set and retrieved, refer to Appendix C.
The Configuration Manager is instantiated by passing the DataManager object to
the constructor. Once the Configuration Manager is instantiated, you can also
access the reader identifier. The Configuration Manager provides the following
functions to get and set parameters:
Public Instance Methods
Dispose

Disposes the object.

Equals
Determines whether the specified Object is equal to the
(Inherited from Object) current Object.
GetAllProperties

Returns all properties from property group passed as
parameter.

GetAllRegisters

Return all the register values in form of Hashtable.

GetConfigurationXML

Returns all the configuration information in XML format.

getProperty

Return property value based on group and name.

GetPropertyDescription

Returns property description based on group and name.

getRegister

Returns configuration register based on name passe

GetType
Gets the type of the current instance.
(Inherited from Object)
ReceiveConfirmation

Called when a configuration information is received.

setConfigurationXML

Sets reader configuration reader using XML string. Input
string should be in the following format:
& lt; Configuration & gt;
& lt; Property name= " Name " value= " value " / & gt;
& lt; /Configuration & gt;

setProperty

Sets property value based on group, name and value
passed.

setPropertyDescription

Sets configuration based on the description provided.

ToString
Returns a string that represents the current object
(Inherited from Object)

Protected Instance Methods
Finalize
(Inherited from Object)

Allows an object to free resources and perform other
cleanup operations before the object is reclaimed by
garbage collection.

MemberwiseClone
Creates a shallow copy of the current object.
(Inherited from Object)
20

Data Layer

.NET Example - Using Configuration Manager to Update Reader Configuration
//Instantiate configuration Manager
ConfigurationManager m_ConfirationManager= new
ConfigurationManager(m_DataManager);
//Access the serial id of the reader
txtID.Text= " ID: " +m_ConfigrationManager.SerialID;
//Use following methods to access the value or description of the property
Console.WriteLine(m_ConfirationManager.getProperty
( " GeneralConfiguration.OperatingMode.
GeneralConfigurationWord.serialmode " ));
Console.WriteLine(m_ConfirationManager.getPropertyDescription
( " GeneralConfiguration.OperatingMode.
GeneralConfigurationWord.serialmode " ));
//Use following methods to set the value of a property.
//Value can be set using actual value or descriptive name of value.
m_ConfirationManager.setProperty
(( " GeneralConfiguration.OperatingMode.
GeneralConfigurationWord.serialmode " , " 1 " );
m_ConfirationManager.setPropertyDescription
(( " GeneralConfiguration.OperatingMode.
GeneralConfigurationWord.serialmode " , " Continuous " );
//Use XML functions for mass uploading of configuration.
String f_XML = " & lt; Configuration & gt;
& lt; Property name=\ " GeneralConfiguration.OperatingMode.
GeneralConfigurationWord.serialmode\ "
value=\ " Continous\ " / & gt; & lt; /Configuration & gt; " ;
m_ConfigurationManager.setConfigurationXML(f_XML);
String f_AllConfig=m_ConfigurationManager.getConfigurationXML();

21

RAPID Developer's Guide

Java Example - Using Configuration Manager to Update Reader Configuration
//Set values and create DataManager Object
TestDataManager f_TestDataManager = new TestDataManager();
Hashtable f_Parameters = new Hashtable();
f_Parameters.put( " ipaddress " ,str[0]);
f_Parameters.put( " port " , " 2101 " );
f_Parameters.put( " type " , " socket " );
DataManager f_Manager = new DataManager(f_Parameters);
f_Manager.OpenConnection()
//Create Object of type Configuration Manager;
ConfigurationManager m_Config = new
ConfigurationManager(f_Manager);
//You can access various function to get serial ID,
//Set properties and get properties
System.out.println(m_Config.getSerialID());
System.out.println( " Value: " +m_Config.getProperty
( " GeneralConfiguration.OperatingMode.
GeneralConfigurationWord.rfmode " ));
System.out.println( " Value: " +m_Config.getPropertyDescription
( " GeneralConfiguration.OperatingMode.
GeneralConfigurationWord.rfmode " ));
//XML functions help extract and set the reader configuration information
//GetConfigurationXMl returns an XML document of configuration
Document f_Document = m_Config.GetConfigurationXML();
System.out.println(DOMWriter.nodeToString(f_Document));
//Create XML document object with configuration XML and
//send it to the Manager to load it.
InputStream f_Stream1 = new FileInputStream( " c:\\temp\\sample.xml " );
DocumentBuilderFactory docBuilderFactory =
DocumentBuilderFactory.newInstance();
DocumentBuilder docBuilder = docBuilderFactory.newDocumentBuilder();
Document f_DocumentInput = docBuilder.parse(f_Stream1);
m_Config.setConfigurationXML(f_DocumentInput);
//Destroy the Manager at the end.
m_Config.destroy();

22

Chapter 4
Connection Management Layer
This chapter provides general information on the Connection Management Layer
of RAPID. Topics discussed in this chapter include the following:
o

Overview of Connection Management Layer
- iConnection Interface
- Serial Connection
- Socket Connection

o

Discovery Interface

23

RAPID Developer's Guide

Overview of Connection Management Layer
The Connection Management Layer is the layer that communicates with the
physical transport layer of the reader. This layer is based on the IConnection
interface which currently supports Serial and TCP/IP connectivity.
NOTE: For specific function information, please refer to the online Help.

iConnection Interface
The IConnection Interface defines the base interface for reader connectivity. Any
new connectivity should be implemenated with this interface. The iConnection
members are as follows:
Public Instance Methods
close

Close the connection to the reader.

destroy

Destoy the connection object.

init

Initialize reader connection.

open

Open the conneciton to the reader

send

Send a specific command to the reader.

The init function is the most critical function in this interface. The input to init is
Hashtable and the values in the hash table are specific to your Connection. This is
what defines the type of connection you want to form and also what are the
parameters for this connection.
:
Public Instance Events
ReceiveConnectionFailure Event

Event used to indicate Connection Failure
event from reader.

ReceiveDataEvent

Event used to indicate incoming messages
from reader.

ReceiveErrorEvent

Event used to indicate rrrors comming from
reader.

ReceiveDataEvent is the event thrown each time data is received from the reader.
Once send method is used to send a command to the reader, ReceiveDataEvent is

used to send notification about the response of the reader

24

Connectivity Layer

Serial Connectivity
Serial Connectivity is provided by the reader's RS-232 serial port. The
iConnection interface is used to implement the serial connection. The following
iConnection functions are used to establish serial connectivity::
SerialConnection Class Methods
init

Initializes serial port connection. Send the following attributes to
the init function to initialize the connection.

baudrate

Baud rate at which to connect to the reader

stopbit

Number of stop bits

parity

Parity

flowcontrol

Flow control on or off

open

Open the serial port connection

send

Send a the command to the reader over the serial port

close

Close the serial port connection

destoy

Destoys the connection

Socket Connectivity
Socket Connectivity is provided by the reader's TCP/IP Ethernet port. The reader
can either use DHCP enable IP allocations or static IP address. The following
functions are used to establish socket connectivity::
SocketConnection Class Methods
init

Initializes socket connection with the reader. Send the following
attributes to the init function to initialize the connection.

ipaddress

IP address of the reader

port

Port number where reader is listening. Typically 2001 or 2101.

open

Open the TCP/IP connection

send

Send a the command to the reader over the TCP socket

close

Close the TCP/IP connection

destoy

Destoys the connection

25

RAPID Developer's Guide

Discovery Interface
The Discovery Interface searches for all the readers and returns a list of all the
readers found. Once reader information is received, you can instantiate the Data
manager or user Connection Factory to build connection objects.
:
Public Instance Properties
ReaderList

Access to the reader list.

:
Public Instance Methods
findConnections

Finds connections. Sends specific information over the multicast
IP address and port. All the readers will reply back to the
message received.

To get a list of all readers, instantiate the ConnectionDiscovery class and then
call its findConnections function. The ReaderList attribute will return an array
of connections. Refer to the examples for more details.

26

Appendix A

CHUMP Protocol
This appendix provides an overview of the CHUMP protocol. For detailed information,
refer to the CHUMP Reference Guide.

27

RAPID Developer's Guide

Overview of the CHUMP Protocol
SAMSys RFID readers are programmed and configured using a human-readable
variation of the High-Level Data Link Control (HDLC) protocol. These commands
are called the Comprehensive Heuristic Unified Messaging Protocol (CHUMP).
CHUMP commands are issued to select reader operating modes as well as initiate
specific actions. Typical CHUMP commands that are issued to the reader include the
following:

o Read data from tag
o Write data to tag
o Halt/Quiet a tag
o Read the onboard I/O ports
Unlike most HDLC protocols, CHUMP uses ASCII characters for the Flag,
Address, Control, and FCS fields. Punctuation characters substitute for the more
common (but unprintable) STX and ETX characters, providing a human readable
message frame or packet.
Although not fully packetized, CHUMP can be described as operating between
Layer 2 (Data Link Layer) and Layer 3 (Network Layer).

CHUMP Frame
As shown in the following figure, each CHUMP frame consist of a Message Head,
Command Block, and a Message Tail.
Message
Head

} or {
Flag 1

[: & lt; Address & gt; ,]

Checksum

Command & lt; parameters & gt;

Address/
Control

Figure 2 - CHUMP Message Format

28

Data

End of
Message

;XX

CR and/or LF

FCS

Flag 2

Appendix A - CHUMP Protocol

Message Head
The message head contains a directional indicator and optional destination or
source address information. The format is as follows:
} [:dst_addr,] for commands (messages transmitted from the host)
{ [:src_addr,] for replies (messages received by the host)

Message heads that include address information are referred to as multidrop
message heads. Message heads without addresses are referred to as single-drop
message heads.
The following example shows a Read Version (Rv) command using destination
address parameters:
}:01, Rv! Command to read the version from a reader with address 01 on a typical

RS-485 network. The address is assigned by the SMA register.
}:00, Rv! Broadcast command to read the version from all readers on a typical RS-

485 network. The address "00" acts as a general broadcast and all readers on
an RS-485 multi-drop network should respond.

Command Block
The command block contains the CHUMP command and associated parameters.
The command part of the CHUMP specification is a tagged, extensible, human
readable protocol that directly implements OSI Layer 7 (Application Layer).
CHUMP command parameters and numeric data are expressed in Hexadecimal
(hex) format. Refer to the individual command descriptions for the specific
formats and syntax.

NOTE: Parameters in the CHUMP command block are not positional and can occur in
any order. Exercise care when parsing CHUMP responses to ensure that the
parsing routine extracts valid parameters from any position and ignores the
occurance of undefined parameters. This approach allows the program to be
tolerant of future CHUMP command syntax extensions.

29

RAPID Developer's Guide

Message Tail
The message tail contains a type indicator (; or !), an optional 8-bit Frame
Checksum (FCS), and an end-of-packet indicator (CR and/or LF). The format is as
follows:
; & lt; FCS & gt; & lt; CR and/or LF & gt; for message tails with a checksum
! & lt; CR and/or LF & gt; for message tails without a checksum

The FCS is expressed as two ASCII bytes and is a sum of the bytes of the rest of
the message. The FCS starts at the first character, "}" or "{", and ends at the
semicolon FCS delimiter ";". Many of the shorter commands explained in the
Command Description section include FCS values (refer to the Ro command).
NOTE: The FCS can be eliminated for debug purposes by using the "!" message tail.
However, installed systems should always use the FCS.

30

Appendix B

Reader Configuration File
This appendix provides a sample reader configuration file.

31

RAPID Developer's Guide

& lt; ?xml version= " 1.0 " encoding= " utf-8 " ? & gt;
- & lt; Configuration xmlns:xsi= " http://www.w3.org/2001/XMLSchema-instance " & gt;
& lt; Property name= " GeneralConfiguration.OperatingMode.GeneralConfigurationWord.rfmode " value= " Continuous "
/ & gt;
& lt; Property name= " GeneralConfiguration.OperatingMode.GeneralConfigurationWord.rfidle " value= " RFOnwhenidle "
/ & gt;
& lt; Property name= " GeneralConfiguration.OperatingMode.GeneralConfigurationWord.serialmode " value= " Continuous "
/ & gt;
& lt; Property name= " GeneralConfiguration.OperatingMode.ProtocolConfigurationWord. " value= " "
/ & gt;
& lt; Property name= " GeneralConfiguration.OperatingMode.ProtocolConfigurationWord.digi1onrfon " value= " DisableOutput "
/ & gt;
& lt; Property name= " GeneralConfiguration.OperatingMode.ProtocolConfigurationWord.digi0ontagactivity " value= " DisableOutput "
/ & gt;
& lt; Property name= " GeneralConfiguration.OperatingMode.ProtocolConfigurationWord.digi0ontagpresence " value= " EnableOutput "
/ & gt;
& lt; Property name= " GeneralConfiguration.OperatingMode.ProtocolConfigurationWord.antennareporting " value= " Disable "
/ & gt;
& lt; Property name= " GeneralConfiguration.OperatingMode.ProtocolConfigurationWord.tagalertenable " value= " DisableBeeper "
/ & gt;
& lt; Property name= " GeneralConfiguration.OperatingMode.ProtocolConfigurationWord.inventoryreportinterval " value= " 0 "
/ & gt;
& lt; Property name= " GeneralConfiguration.OperatingMode.ProtocolConfigurationWord.queuetaginventory " value= " Disable "
/ & gt;
& lt; Property name= " GeneralConfiguration.OperatingMode.ProtocolSelectWord.supertag " value= " Enable "
/ & gt;
& lt; Property name= " GeneralConfiguration.OperatingMode.ProtocolSelectWord.epc0 " value= " Enable "
/ & gt;
& lt; Property name= " GeneralConfiguration.OperatingMode.ProtocolSelectWord.epc1 " value= " Disable "
/ & gt;
& lt; Property name= " GeneralConfiguration.OperatingMode.ProtocolSelectWord.isob " value= " Disable "
/ & gt;
& lt; Property name= " GeneralConfiguration.OperatingMode.ProtocolSelectWord.isoa " value= " Enable "
/ & gt;
& lt; Property name= " GeneralConfiguration.OperatingMode.ProtocolSelectMask.supertag " value= " Disable "
/ & gt;
& lt; Property name= " GeneralConfiguration.OperatingMode.ProtocolSelectMask.epc0 " value= " Enable "
/ & gt;
& lt; Property name= " GeneralConfiguration.OperatingMode.ProtocolSelectMask.epc1 " value= " Disable "
/ & gt;
& lt; Property name= " GeneralConfiguration.OperatingMode.ProtocolSelectMask.isob " value= " Disable "
/ & gt;
& lt; Property name= " GeneralConfiguration.OperatingMode.ProtocolSelectMask.isoa " value= " Disable "
/ & gt;
& lt; Property name= " GeneralConfiguration.OperatingMode.ProtocolDigitalIOControl.pulselength " value= " "
/ & gt;
& lt; Property name= " GeneralConfiguration.SerialCommunications.SerialConfigurationWord.rs485.baud " value= " 57600 "
/ & gt;
& lt; Property name= " GeneralConfiguration.SerialCommunications.SerialConfigurationWord.rs232.databits " value= " 8DataBits "
/ & gt;
& lt; Property name= " GeneralConfiguration.SerialCommunications.SerialConfigurationWord.serial.stopbits " value= " 2StopBits "
/ & gt;
& lt; Property name= " GeneralConfiguration.SerialCommunications.SerialConfigurationWord.rs485.databits " value= " 8DataBits "
/ & gt;
& lt; Property name= " GeneralConfiguration.SerialCommunications.SerialConfigurationWord.rs232.stopbits " value= " 1StopBit "
/ & gt;

32

Sample Configuration File

& lt; Property name= " GeneralConfiguration.SerialCommunications.SerialConfigurationWord.rs232.baud " value= " 57600 "
/ & gt;
& lt; Property name= " GeneralConfiguration.SerialCommunications.SerialConfigurationWord.serial.echo " value= " Donotsuppress "
/ & gt;
& lt; Property name= " GeneralConfiguration.SerialCommunications.SerialConfigurationWord.rs485.stopbits " value= " 1StopBit "
/ & gt;
& lt; Property name= " GeneralConfiguration.SerialCommunications.SerialConfigurationWord.rs485.parity " value= " none "
/ & gt;
& lt; Property name= " GeneralConfiguration.SerialCommunications.SerialConfigurationWord.rs485.echo " value= " Donotsuppress "
/ & gt;
& lt; Property name= " GeneralConfiguration.SerialCommunications.SerialConfigurationWord.rs232.parity " value= " none " / & gt;
& lt; Property name= " GeneralConfiguration.SerialCommunications.SerialConfigurationWord.rs232.echo " value= " Donotsuppress "
/ & gt;
& lt; Property name= " GeneralConfiguration.SerialCommunications.SerialConfigurationWord.serial.databits " value= " 8DataBits "
/ & gt;
& lt; Property name= " GeneralConfiguration.SerialCommunications.SerialConfigurationWord.serial.parity " value= " even "
/ & gt;
& lt; Property name= " GeneralConfiguration.SerialCommunications.SerialConfigurationWord.serial.baud " value= " 57600 "
/ & gt;
& lt; Property name= " GeneralConfiguration.SerialCommunications.SerialMultidropAddress.serialmutidropaddress " value= " 0 "
/ & gt;
& lt; Property name= " GeneralConfiguration.Receiver.MultiplexorConfigurationWord.numofantennas " value= " 1 "
/ & gt;
& lt; Property name= " GeneralConfiguration.Receiver.MultiplexorConfigurationWord.antennamux " value= " Enabled "
/ & gt;
& lt; Property name= " GeneralConfiguration.Receiver.MultiplexorConfigurationWord.inventorycycle " value= " 1 "
/ & gt;
& lt; Property name= " GeneralConfiguration.Receiver.MultiplexorConfigurationWord.muxfailmsg " value= " Allowed "
/ & gt;
& lt; Property name= " GeneralConfiguration.Receiver.MultiplexorSelectWord.fourthantennanumber " value= " 0 "
/ & gt;
& lt; Property name= " GeneralConfiguration.Receiver.MultiplexorSelectWord.firstantennaselect " value= " invalid "
/ & gt;
& lt; Property name= " GeneralConfiguration.Receiver.MultiplexorSelectWord.thirdantennanumber " value= " 0 "
/ & gt;
& lt; Property name= " GeneralConfiguration.Receiver.MultiplexorSelectWord.fourthantennaselect " value= " Antenna valid "
/ & gt;
& lt; Property name= " GeneralConfiguration.Receiver.MultiplexorSelectWord.firstantennanumber " value= " 1 "
/ & gt;
& lt; Property name= " GeneralConfiguration.Receiver.MultiplexorSelectWord.secondantennanumber " value= " 0 "
/ & gt;
& lt; Property name= " GeneralConfiguration.Receiver.MultiplexorSelectWord.thirdantennaselect " value= " Antenna valid "
/ & gt;
& lt; Property name= " GeneralConfiguration.Receiver.MultiplexorSelectWord.secondantennaselect " value= " Antenna valid "
/ & gt;
& lt; Property name= " GeneralConfiguration.Receiver.SelfTrainingControl.trainingmode " value= " eachtime "
/ & gt;
& lt; Property name= " GeneralConfiguration.Receiver.ReceiverIChannelControl.preampgain " value= " 0 "
/ & gt;
& lt; Property name= " GeneralConfiguration.Receiver.ReceiverIChannelControl.Threshold " value= " 74 "
/ & gt;
& lt; Property name= " GeneralConfiguration.Receiver.ReceiverQChannelControl.threshold " value= " 74 "
/ & gt;
& lt; Property name= " GeneralConfiguration.Receiver.ReceiverQChannelControl.preampgain " value= " 0 "
/ & gt;
& lt; Property name= " GeneralConfiguration.Transmitter.TransmitPowerConfiguration.txdriftcompensation " value= " Enable "

33

RAPID Developer's Guide

/ & gt;
& lt; Property name= " GeneralConfiguration.Transmitter.TransmitPowerConfiguration.suppressrxderror " value= " Suppress "
/ & gt;
& lt; Property name= " GeneralConfiguration.Transmitter.TransmitPowerConfiguration.hopsequence " value= " Sequential "
/ & gt;
& lt; Property name= " GeneralConfiguration.Transmitter.TransmitPowerConfiguration.listenbeforetalk " value= " Enable "
/ & gt;
& lt; Property name= " GeneralConfiguration.Transmitter.TransmitPowerConfiguration.suppressrxdwarning " value= " Suppress "
/ & gt;
& lt; Property name= " GeneralConfiguration.Transmitter.TransmitPowerConfiguration.suppressantennacheck " value= " Suppress "
/ & gt;
& lt; Property name= " GeneralConfiguration.Transmitter.TransmitPowerConfiguration.etsiband " value= " 865.100-867.900MHz "
/ & gt;
& lt; Property name= " GeneralConfiguration.Transmitter.TransmitPowerAntenna0.powerlevelindex " value= " 48 "
/ & gt;
& lt; Property name= " GeneralConfiguration.Transmitter.TransmitPowerAntenna1.powerlevelindex " value= " 48 "
/ & gt;
& lt; Property name= " GeneralConfiguration.Transmitter.TransmitPowerAntenna2.powerlevelindex " value= " 16 "
/ & gt;
& lt; Property name= " GeneralConfiguration.Transmitter.TransmitPowerAntenna3.powerlevelindex " value= " 16 "
/ & gt;
& lt; Property name= " GeneralConfiguration.Transmitter.ValidFrequencySet0.mask0 " value= " "
/ & gt;
& lt; Property name= " GeneralConfiguration.Transmitter.ValidFrequencySet1.mask1 " value= " "
/ & gt;
& lt; Property name= " GeneralConfiguration.Transmitter.ValidFrequencySet2.mask2 " value= " "
/ & gt;
& lt; Property name= " GeneralConfiguration.Transmitter.ValidFrequencySet3.mask3 " value= " "
/ & gt;
& lt; Property name= " GeneralConfiguration.Transmitter.ValidFrequencySet4.mask4 " value= " "
/ & gt;
& lt; Property name= " GeneralConfiguration.Transmitter.TransmitterListenBeforeTalk.idlechannneldetectthreshold " value= " "
/ & gt;
& lt; Property name= " GeneralConfiguration.Transmitter.TransmitterListenBeforeTalk.verbositylevel " value= " "
/ & gt;
& lt; Property name= " GeneralConfiguration.ProductRevisions.ProductRevision.version " value= " "
/ & gt;
& lt; Property name= " GeneralConfiguration.ProductRevisions.ProductRevision.type " value= " "
/ & gt;
& lt; Property name= " GeneralConfiguration.ProductRevisions.ProcessorBoardRevision.version " value= " "
/ & gt;
& lt; Property name= " GeneralConfiguration.ProductRevisions.ProcessorBoardRevision.type " value= " "
/ & gt;
& lt; Property name= " GeneralConfiguration.ProductRevisions.TransmitterBoardRevision.version " value= " "
/ & gt;
& lt; Property name= " GeneralConfiguration.ProductRevisions.TransmitterBoardRevision.type " value= " "
/ & gt;
& lt; Property name= " GeneralConfiguration.ProductRevisions.ReceiverBoardRevision.version " value= " "
/ & gt;
& lt; Property name= " GeneralConfiguration.ProductRevisions.ReceiverBoardRevision.type " value= " "
/ & gt;
& lt; Property name= " GeneralConfiguration.ProductRevisions.MuxBoardRevision.version " value= " "
/ & gt;
& lt; Property name= " GeneralConfiguration.ProductRevisions.MuxBoardRevision.type " value= " "
/ & gt;
& lt; Property name= " GeneralConfiguration.ProductRevisions.FilterBoardRevision.version " value= " "

34

Sample Configuration File

/ & gt;
& lt; Property name= " GeneralConfiguration.ProductRevisions.FilterBoardRevision.type " value= " "
/ & gt;
& lt; Property name= " ProtocolConfiguration.ISO180006A.GeneralConfiguration.slotclosure " value= " UseCloseSlot "
/ & gt;
& lt; Property name= " ProtocolConfiguration.ISO180006A.GeneralConfiguration.sendmute " value= " Enable "
/ & gt;
& lt; Property name= " ProtocolConfiguration.ISO180006A.GeneralConfiguration.isoAautoquite " value= " Enable "
/ & gt;
& lt; Property name= " ProtocolConfiguration.ISO180006A.GeneralConfiguration.fstmode " value= " Enable "
/ & gt;
& lt; Property name= " ProtocolConfiguration.ISO180006A.GeneralConfiguration.enablefiltering " value= " Enable "
/ & gt;
& lt; Property name= " ProtocolConfiguration.ISO180006A.GeneralConfiguration.family " value= " 0 "
/ & gt;
& lt; Property name= " ProtocolConfiguration.ISO180006A.GeneralConfiguration.adaptiveroundsizing " value= " Enable "
/ & gt;
& lt; Property name= " ProtocolConfiguration.ISO180006A.GeneralConfiguration.slotsperround " value= " 16 "
/ & gt;
& lt; Property name= " ProtocolConfiguration.ISO180006A.GeneralConfiguration.userprime " value= " Disable "
/ & gt;
& lt; Property name= " ProtocolConfiguration.ISO180006A.GeneralConfiguration.sendsuid " value= " Disable "
/ & gt;
& lt; Property name= " ProtocolConfiguration.ISO180006A.GeneralConfiguration.em4223160 " value= " Enable "
/ & gt;
& lt; Property name= " ProtocolConfiguration.ISO180006A.TransmitModulation.modulationdepthpercentage " value= " 30 "
/ & gt;
& lt; Property name= " ProtocolConfiguration.ISO180006A.AdaptiveRoundSizing.roundsize " value= " initial8 "
/ & gt;
& lt; Property name= " ProtocolConfiguration.ISO180006A.AdaptiveRoundSizing.stepsize " value= " power2 "
/ & gt;
& lt; Property name= " ProtocolConfiguration.ISO180006A.AdaptiveRoundSizing.decreasethresholdvalidtags " value= " 0 "
/ & gt;
& lt; Property name= " ProtocolConfiguration.ISO180006A.AdaptiveRoundSizing.increasethresholdwhitespaces " value= " 1 "
/ & gt;
& lt; Property name= " ProtocolConfiguration.ISO180006A.AdaptiveRoundSizing.increasethresholdvalidtags " value= " 1 "
/ & gt;
& lt; Property name= " ProtocolConfiguration.ISO180006A.AdaptiveRoundSizing.nochangethreshold " value= " 3 "
/ & gt;
& lt; Property name= " ProtocolConfiguration.ISO180006A.AdaptiveRoundSizing.minroundsize " value= " min8 "
/ & gt;
& lt; Property name= " ProtocolConfiguration.ISO180006A.AdaptiveRoundSizing.decreasethresholdwhitespaces " value= " 4 "
/ & gt;
& lt; Property name= " ProtocolConfiguration.ISO180006A.FilterPatternLength.patternlength " value= " 0 "
/ & gt;
& lt; Property name= " ProtocolConfiguration.ISO180006A.FilterMatchPatternPart0.mask " value= " 0 "
/ & gt;
& lt; Property name= " ProtocolConfiguration.ISO180006A.FilterMatchPatternPart1.mask " value= " 0 "
/ & gt;
& lt; Property name= " ProtocolConfiguration.ISO180006A.FilterMatchPatternPart2.mask " value= " 0 "
/ & gt;
& lt; Property name= " ProtocolConfiguration.ISO180006A.FilterMatchPatternPart3.mask " value= " 0 "
/ & gt;
& lt; Property name= " ProtocolConfiguration.ISO180006A.FilterMatchPatternPart4.mask " value= " 0 "
/ & gt;
& lt; Property name= " ProtocolConfiguration.ISO180006A.FilterMatchPatternPart5.mask " value= " 0 "

35

RAPID Developer's Guide

/ & gt;
& lt; Property name= " ProtocolConfiguration.ISO180006A.FilterMatchPatternPart6.mask " value= " 0 "
/ & gt;
& lt; Property name= " ProtocolConfiguration.ISO180006A.FilterMatchPatternPart7.mask " value= " 0 "
/ & gt;
& lt; Property name= " ProtocolConfiguration.ISO180006B.GeneralConfiguration.epcidlength " value= " 96 bits "
/ & gt;
& lt; Property name= " ProtocolConfiguration.ISO180006B.GeneralConfiguration.pcmode " value= " Enable "
/ & gt;
& lt; Property name= " ProtocolConfiguration.ISO180006B.GeneralConfiguration.4Xreturnlink " value= " Disable "
/ & gt;
& lt; Property name= " ProtocolConfiguration.ISO180006B.SelectConfiguration.address " value= " 0 "
/ & gt;
& lt; Property name= " ProtocolConfiguration.ISO180006B.SelectConfiguration.isoBautoquite " value= " Enable "
/ & gt;
& lt; Property name= " ProtocolConfiguration.ISO180006B.SelectConfiguration.opcode " value= " 23 "
/ & gt;
& lt; Property name= " ProtocolConfiguration.ISO180006B.SelectConfiguration.mask " value= " 1 "
/ & gt;
& lt; Property name= " ProtocolConfiguration.ISO180006B.SelectDataHigh.address " value= " 0 "
/ & gt;
& lt; Property name= " ProtocolConfiguration.ISO180006B.SelectDataHigh.opcode " value= " 0 "
/ & gt;
& lt; Property name= " ProtocolConfiguration.ISO180006B.SelectDataHigh.mask " value= " 0 "
/ & gt;
& lt; Property name= " ProtocolConfiguration.ISO180006B.SelectDataLow.address " value= " 0 "
/ & gt;
& lt; Property name= " ProtocolConfiguration.ISO180006B.SelectDataLow.opcode " value= " 0 "
/ & gt;
& lt; Property name= " ProtocolConfiguration.ISO180006B.SelectDataLow.mask " value= " 0 "
/ & gt;
& lt; Property name= " ProtocolConfiguration.ISO180006B.UnselectionConfiguration.address " value= " 0 "
/ & gt;
& lt; Property name= " ProtocolConfiguration.ISO180006B.UnselectionConfiguration.opcode " value= " 0 "
/ & gt;
& lt; Property name= " ProtocolConfiguration.ISO180006B.UnselectionConfiguration.mask " value= " 0 "
/ & gt;
& lt; Property name= " ProtocolConfiguration.ISO180006B.UnselectionDataHigh.address " value= " 0 "
/ & gt;
& lt; Property name= " ProtocolConfiguration.ISO180006B.UnselectionDataHigh.opcode " value= " 0 "
/ & gt;
& lt; Property name= " ProtocolConfiguration.ISO180006B.UnselectionDataHigh.mask " value= " 0 "
/ & gt;
& lt; Property name= " ProtocolConfiguration.ISO180006B.UnselectionDataLow.address " value= " 0 "
/ & gt;
& lt; Property name= " ProtocolConfiguration.ISO180006B.UnselectionDataLow.opcode " value= " 0 "
/ & gt;
& lt; Property name= " ProtocolConfiguration.ISO180006B.UnselectionDataLow.mask " value= " 0 "
/ & gt;
& lt; Property name= " ProtocolConfiguration.ISO180006B.TransmitModulation.usefastshaper " value= " Enable "
/ & gt;
& lt; Property name= " ProtocolConfiguration.ISO180006B.TransmitModulation.modulationdepthpercentage " value= " 3 "
/ & gt;
& lt; Property name= " ProtocolConfiguration.EPCClass1.GeneralConfiguration.64bit " value= " Enable "
/ & gt;
& lt; Property name= " ProtocolConfiguration.EPCClass1.GeneralConfiguration.filtering " value= " Enable "

36

Sample Configuration File

/ & gt;
& lt; Property name= " ProtocolConfiguration.EPCClass1.GeneralConfiguration.airintattemptsbeforefailure " value= " 0 "
/ & gt;
& lt; Property name= " ProtocolConfiguration.EPCClass1.GeneralConfiguration.region " value= " ETSI "
/ & gt;
& lt; Property name= " ProtocolConfiguration.EPCClass1.GeneralConfiguration.softwarecrc " value= " Enable "
/ & gt;
& lt; Property name= " ProtocolConfiguration.EPCClass1.GeneralConfiguration.96bit " value= " Disable "
/ & gt;
& lt; Property name= " ProtocolConfiguration.EPCClass1.GeneralConfiguration.autodetect " value= " Enable "
/ & gt;
& lt; Property name= " ProtocolConfiguration.EPCClass1.GeneralConfiguration.autoquite " value= " Enable "
/ & gt;
& lt; Property name= " ProtocolConfiguration.EPCClass1.GeneralConfiguration.scrollfirst " value= " Disable "
/ & gt;
& lt; Property name= " ProtocolConfiguration.EPCClass1.TransmitModulation.modulationdepthpercentage " value= " "
/ & gt;
& lt; Property name= " ProtocolConfiguration.EPCClass1.FilterPatternLengthandOffset.patternlength " value= " 0 "
/ & gt;
& lt; Property name= " ProtocolConfiguration.EPCClass1.FilterPatternLengthandOffset.patternoffset " value= " 0 "
/ & gt;
& lt; Property name= " ProtocolConfiguration.EPCClass1.FilterMatchPatternPart0.mask " value= " 0 "
/ & gt;
& lt; Property name= " ProtocolConfiguration.EPCClass1.FilterMatchPatternPart1.mask " value= " 0 "
/ & gt;
& lt; Property name= " ProtocolConfiguration.EPCClass1.FilterMatchPatternPart2.mask " value= " 0 "
/ & gt;
& lt; Property name= " ProtocolConfiguration.EPCClass1.FilterMatchPatternPart3.mask " value= " 0 "
/ & gt;
& lt; Property name= " ProtocolConfiguration.EPCClass1.FilterMatchPatternPart4.mask " value= " 0 "
/ & gt;
& lt; Property name= " ProtocolConfiguration.EPCClass1.FilterMatchPatternPart5.mask " value= " 0 "
/ & gt;
& lt; Property name= " ProtocolConfiguration.EPCClass1.FilterMatchPatternPart6.mask " value= " 0 "
/ & gt;
& lt; Property name= " ProtocolConfiguration.EPCClass1.FilterMatchPatternPart7.mask " value= " 0 "
/ & gt;
& lt; Property name= " ProtocolConfiguration.EPCClass0.GeneralConfiguration.64bit " value= " Enable "
/ & gt;
& lt; Property name= " ProtocolConfiguration.EPCClass0.GeneralConfiguration.singulationmode " value= " ID2 "
/ & gt;
& lt; Property name= " ProtocolConfiguration.EPCClass0.GeneralConfiguration.tagcommandretrycount " value= " 1 "
/ & gt;
& lt; Property name= " ProtocolConfiguration.EPCClass0.GeneralConfiguration.autodetectlength " value= " Disable "
/ & gt;
& lt; Property name= " ProtocolConfiguration.EPCClass0.GeneralConfiguration.sendshortw3 " value= " Enable "
/ & gt;
& lt; Property name= " ProtocolConfiguration.EPCClass0.GeneralConfiguration.id01singulationblocks " value= " 0 "
/ & gt;
& lt; Property name= " ProtocolConfiguration.EPCClass0.GeneralConfiguration.16bit " value= " Enable "
/ & gt;
& lt; Property name= " ProtocolConfiguration.EPCClass0.GeneralConfiguration.96bit " value= " Enable "
/ & gt;
& lt; Property name= " ProtocolConfiguration.EPCClass0.GeneralConfiguration.crcintagid " value= " Enable "
/ & gt;
& lt; Property name= " ProtocolConfiguration.EPCClass0.GeneralConfiguration.proprietary " value= " Matrics "

37

RAPID Developer's Guide

/ & gt;
& lt; Property name= " ProtocolConfiguration.EPCClass0.GeneralConfiguration.filtering " value= " Enable "
/ & gt;
& lt; Property name= " ProtocolConfiguration.EPCClass0.GeneralConfiguration.scrollfirst " value= " Disable "
/ & gt;
& lt; Property name= " ProtocolConfiguration.EPCClass0.GeneralConfiguration.inhibitid2singulationonepcwrite " value= " Inhibit "
/ & gt;
& lt; Property name= " ProtocolConfiguration.EPCClass0.GeneralConfiguration.taginventoryretry " value= " 0 "
/ & gt;
& lt; Property name= " ProtocolConfiguration.EPCClass0.TransmitModulation.modulationdepthpercentage " value= " "
/ & gt;
& lt; Property name= " ProtocolConfiguration.EPCClass0.FilterMatchPatternPart0.patternmask0 " value= " 0 "
/ & gt;
& lt; Property name= " ProtocolConfiguration.EPCClass0.FilterMatchPatternPart1.patternmask1 " value= " 0 "
/ & gt;
& lt; Property name= " ProtocolConfiguration.EPCClass0.FilterMatchPatternPart2.patternmask2 " value= " 0 "
/ & gt;
& lt; Property name= " ProtocolConfiguration.EPCClass0.FilterMatchPatternPart3.patternmask3 " value= " 0 "
/ & gt;
& lt; Property name= " ProtocolConfiguration.EPCClass0.FilterMatchPatternPart4.patternmask4 " value= " 0 "
/ & gt;
& lt; Property name= " ProtocolConfiguration.EPCClass0.FilterMatchPatternPart5.patternmask5 " value= " 0 "
/ & gt;
& lt; Property name= " ProtocolConfiguration.EPCClass0.FilterMatchPatternPart6.patternmask6 " value= " 0 "
/ & gt;
& lt; Property name= " ProtocolConfiguration.EPCClass0.FilterMatchPatternPart7.patternmask7 " value= " 0 "
/ & gt;
& lt; Property name= " ProtocolConfiguration.SuperTag.GeneralConfiguration.ack " value= " "
/ & gt;
& lt; Property name= " ProtocolConfiguration.SuperTag.GeneralConfiguration.mute " value= " "
/ & gt;
.

38

Appendix C

Configuration Registers
This appendix provides a list of the reader configuration registers supported by
RAPID.

39

RAPID Developer's Guide

General Configuration Registers
General Configuration Register

Values

Operating Mode
GeneralConfiguration.OperatingMode.GeneralConfigurationWord.rfmode

Polled,Continuous

GeneralConfiguration.OperatingMode.GeneralConfigurationWord.rfidle

RFOFFwhenidle,
RFOnwhenidle

GeneralConfiguration.OperatingMode.GeneralConfigurationWord.serialmode

Polled,Continuous

GeneralConfiguration.OperatingMode.ProtocolConfigurationWord.digi1onrfon

DisableOutput,
EnableOutput

GeneralConfiguration.OperatingMode.ProtocolConfigurationWord.digi0ontagactivity

DisableOutput,
EnableOutput

GeneralConfiguration.OperatingMode.ProtocolConfigurationWord.digi0ontagpresence

DisableOutput,
EnableOutput

GeneralConfiguration.OperatingMode.ProtocolConfigurationWord.antennareporting

Enable,Disable

GeneralConfiguration.OperatingMode.ProtocolConfigurationWord.tagalertenable

DisableBeeper,
EnableBeeper

GeneralConfiguration.OperatingMode.ProtocolConfigurationWord.inventoryreportinterval

0-15

GeneralConfiguration.OperatingMode.ProtocolConfigurationWord.queuetaginventory

Enable,Disable

GeneralConfiguration.OperatingMode.ProtocolSelectWord.supertag

Enable,Disable

GeneralConfiguration.OperatingMode.ProtocolSelectWord.epc0

Enable,Disable

GeneralConfiguration.OperatingMode.ProtocolSelectWord.epc1

Enable,Disable

GeneralConfiguration.OperatingMode.ProtocolSelectWord.isob

Enable,Disable

GeneralConfiguration.OperatingMode.ProtocolSelectWord.isoa

Enable,Disable

GeneralConfiguration.OperatingMode.ProtocolSelectMask.supertag

Enable,Disable

GeneralConfiguration.OperatingMode.ProtocolSelectMask.epc0

Enable,Disable

GeneralConfiguration.OperatingMode.ProtocolSelectMask.epc1

Enable,Disable

GeneralConfiguration.OperatingMode.ProtocolSelectMask.isob

Enable,Disable

GeneralConfiguration.OperatingMode.ProtocolSelectMask.isoa

Enable,Disable

GeneralConfiguration.OperatingMode.ProtocolDigitalIOControl.pulselength

0-65535

Serial Communications
GeneralConfiguration.SerialCommunications.SerialConfigurationWord.rs485.baud

1200,2400,4800,9600,192
00,38400,57600

GeneralConfiguration.SerialCommunications.SerialConfigurationWord.rs232.databits

7DataBits,
8DataBits

GeneralConfiguration.SerialCommunications.SerialConfigurationWord.serial.stopbits

1StopBit,2StopBits

GeneralConfiguration.SerialCommunications.SerialConfigurationWord.rs485.databits

7DataBits,
8DataBits

GeneralConfiguration.SerialCommunications.SerialConfigurationWord.rs232.stopbits

1StopBit,2StopBits

GeneralConfiguration.SerialCommunications.SerialConfigurationWord.rs232.baud

1200,2400,4800,9600,192
00,38400,57600

GeneralConfiguration.SerialCommunications.SerialConfigurationWord.serial.echo

Donotsuppress,
Suppressecho

GeneralConfiguration.SerialCommunications.SerialConfigurationWord.rs485.stopbits

1StopBit,2StopBits

GeneralConfiguration.SerialCommunications.SerialConfigurationWord.rs485.parity

40

none,even,odd

GeneralConfiguration.SerialCommunications.SerialConfigurationWord.rs485.echo

Donotsuppress,
Suppressecho

Configuration Registers

General Configuration Register

Values

GeneralConfiguration.SerialCommunications.SerialConfigurationWord.rs232.parity

none,even,odd

GeneralConfiguration.SerialCommunications.SerialConfigurationWord.rs232.echo

Donotsuppress,
Suppressecho

GeneralConfiguration.SerialCommunications.SerialConfigurationWord.serial.databits

7DataBits,
8DataBits

GeneralConfiguration.SerialCommunications.SerialConfigurationWord.serial.parity

none,even,odd

GeneralConfiguration.SerialCommunications.SerialConfigurationWord.serial.baud

1200, 2400, 4800, 9600,
19200, 38400, 57600

GeneralConfiguration.SerialCommunications.SerialMultidropAddress.serialmutidropaddress

0-255

Receiver
GeneralConfiguration.Receiver.MultiplexorConfigurationWord.numofantennas

0,1,2,3,4

GeneralConfiguration.Receiver.MultiplexorConfigurationWord.antennamux

Enabled,Disabled

GeneralConfiguration.Receiver.MultiplexorConfigurationWord.inventorycycle

0-255

GeneralConfiguration.Receiver.MultiplexorConfigurationWord.muxfailmsg

Allowed,Suppressed

GeneralConfiguration.Receiver.MultiplexorSelectWord.fourthantennanumber

0,1,2,3

GeneralConfiguration.Receiver.MultiplexorSelectWord.firstantennaselect

valid,invalid

GeneralConfiguration.Receiver.MultiplexorSelectWord.thirdantennanumber

0,1,2,3

GeneralConfiguration.Receiver.MultiplexorSelectWord.fourthantennaselect

valid,invalid

GeneralConfiguration.Receiver.MultiplexorSelectWord.firstantennanumber

0,1,2,3

GeneralConfiguration.Receiver.MultiplexorSelectWord.secondantennanumber

0,1,2,3

GeneralConfiguration.Receiver.MultiplexorSelectWord.thirdantennaselect

valid,invalid

GeneralConfiguration.Receiver.MultiplexorSelectWord.secondantennaselect

valid,invalid

GeneralConfiguration.Receiver.SelfTrainingControl.trainingmode

disabled,
chumponly,
firstactivated,
eachtime

GeneralConfiguration.Receiver.ReceiverIChannelControl.preampgain

0-FF

GeneralConfiguration.Receiver.ReceiverIChannelControl.Threshold

0-FF

GeneralConfiguration.Receiver.ReceiverQChannelControl.threshold

0-FF

GeneralConfiguration.Receiver.ReceiverQChannelControl.preampgain

0-FF

Transmitter
GeneralConfiguration.Transmitter.TransmitPowerConfiguration.txdriftcompensation

Enable,Disable

GeneralConfiguration.Transmitter.TransmitPowerConfiguration.suppressrxderror

Suppress,
DoNotSuppress

GeneralConfiguration.Transmitter.TransmitPowerConfiguration.hopsequence

Sequential,
Random

GeneralConfiguration.Transmitter.TransmitPowerConfiguration.listenbeforetalk

Enable,Disable

GeneralConfiguration.Transmitter.TransmitPowerConfiguration.suppressrxdwarning

Suppress,
DoNotSuppress

GeneralConfiguration.Transmitter.TransmitPowerConfiguration.suppressantennacheck

Suppress,
DoNotSuppress

GeneralConfiguration.Transmitter.TransmitPowerConfiguration.etsiband

865.100-867.900MHz,
869.525MHz

GeneralConfiguration.Transmitter.TransmitPowerAntenna0.powerlevelindex

1w,500mw,
250mw,125mw

GeneralConfiguration.Transmitter.TransmitPowerAntenna1.powerlevelindex

1w,500mw,
250mw,125mw

41

RAPID Developer's Guide

General Configuration Register

Values

GeneralConfiguration.Transmitter.TransmitPowerAntenna2.powerlevelindex

1w, 500mw,
250mw, 125mw

GeneralConfiguration.Transmitter.TransmitPowerAntenna3.powerlevelindex

1w, 500mw,
250mw, 125mw

GeneralConfiguration.Transmitter.ValidFrequencySet0.mask0

0-FFFFFFFF

GeneralConfiguration.Transmitter.ValidFrequencySet1.mask1

0-FFFFFFFF

GeneralConfiguration.Transmitter.ValidFrequencySet2.mask2

0-FFFFFFFF

GeneralConfiguration.Transmitter.ValidFrequencySet3.mask3

0-FFFFFFFF

GeneralConfiguration.Transmitter.ValidFrequencySet4.mask4

0-FFFFFFFF

GeneralConfiguration.Transmitter.TransmitterListenBeforeTalk.idlechannneldetectthreshold

0-255

GeneralConfiguration.Transmitter.TransmitterListenBeforeTalk.verbositylevel

inhibitstatusmessage,
percategory, perchannel

Product Revisions
GeneralConfiguration.ProductRevisions.ProductRevision.version
GeneralConfiguration.ProductRevisions.ProductRevision.type

0-FFFF

GeneralConfiguration.ProductRevisions.ProcessorBoardRevision.version

0-FFFF

GeneralConfiguration.ProductRevisions.ProcessorBoardRevision.type

0-FFFF

GeneralConfiguration.ProductRevisions.TransmitterBoardRevision.version

0-FFFF

GeneralConfiguration.ProductRevisions.TransmitterBoardRevision.type

0-FFFF

GeneralConfiguration.ProductRevisions.ReceiverBoardRevision.version

0-FFFF

GeneralConfiguration.ProductRevisions.ReceiverBoardRevision.type

0-FFFF

GeneralConfiguration.ProductRevisions.MuxBoardRevision.version

0-FFFF

GeneralConfiguration.ProductRevisions.MuxBoardRevision.type

0-FFFF

GeneralConfiguration.ProductRevisions.FilterBoardRevision.version

0-FFFF

GeneralConfiguration.ProductRevisions.FilterBoardRevision.type

42

0-FFFF

0-FFFF

Configuration Registers

Protocol Configuration Registers
Protocol Configuration Register

Values

ISO 18000-6A
ProtocolConfiguration.ISO180006A.GeneralConfiguration.slotclosure

UseCloseSlot,
UseNextSlot

ProtocolConfiguration.ISO180006A.GeneralConfiguration.sendmute

Enable,Disable

ProtocolConfiguration.ISO180006A.GeneralConfiguration.isoAautoquite

Enable,Disable

ProtocolConfiguration.ISO180006A.GeneralConfiguration.fstmode

Enable,Disable

ProtocolConfiguration.ISO180006A.GeneralConfiguration.enablefiltering

Enable,Disable

ProtocolConfiguration.ISO180006A.GeneralConfiguration.family

0-255

ProtocolConfiguration.ISO180006A.GeneralConfiguration.adaptiveroundsizing

Enable,Disable

ProtocolConfiguration.ISO180006A.GeneralConfiguration.slotsperround

1,8,16,32,64,128,255

ProtocolConfiguration.ISO180006A.GeneralConfiguration.userprime

Enable,Disable

ProtocolConfiguration.ISO180006A.GeneralConfiguration.sendsuid

Enable,Disable

ProtocolConfiguration.ISO180006A.GeneralConfiguration.em4223160

Enable,Disable

ProtocolConfiguration.ISO180006A.TransmitModulation.modulationdepthpercentage

99,75,50,30,20,11

ProtocolConfiguration.ISO180006A.AdaptiveRoundSizing.roundsize

initial8, initial16, initial32,
initial64, initial128

ProtocolConfiguration.ISO180006A.AdaptiveRoundSizing.stepsize

none, power2, power4,
power8

ProtocolConfiguration.ISO180006A.AdaptiveRoundSizing.decreasethresholdvalidtags

0-15

ProtocolConfiguration.ISO180006A.AdaptiveRoundSizing.increasethresholdwhitespaces

0-15

ProtocolConfiguration.ISO180006A.AdaptiveRoundSizing.increasethresholdvalidtags

0-15

ProtocolConfiguration.ISO180006A.AdaptiveRoundSizing.nochangethreshold

0-15

ProtocolConfiguration.ISO180006A.AdaptiveRoundSizing.minroundsize

min8, min16, min32,
min64, min128

ProtocolConfiguration.ISO180006A.AdaptiveRoundSizing.decreasethresholdwhitespaces

0-15

ProtocolConfiguration.ISO180006A.FilterPatternLength.patternlength

0-255

ProtocolConfiguration.ISO180006A.FilterMatchPatternPart0.mask

0-FFFFFFFF

ProtocolConfiguration.ISO180006A.FilterMatchPatternPart1.mask

0-FFFFFFFF

ProtocolConfiguration.ISO180006A.FilterMatchPatternPart2.mask

0-FFFFFFFF

ProtocolConfiguration.ISO180006A.FilterMatchPatternPart3.mask

0-FFFFFFFF

ProtocolConfiguration.ISO180006A.FilterMatchPatternPart4.mask

0-FFFFFFFF

ProtocolConfiguration.ISO180006A.FilterMatchPatternPart5.mask

0-FFFFFFFF

ProtocolConfiguration.ISO180006A.FilterMatchPatternPart6.mask

0-FFFFFFFF

ProtocolConfiguration.ISO180006A.FilterMatchPatternPart7.mask

0-FFFFFFFF

ISO 18000-6B
ProtocolConfiguration.ISO180006B.GeneralConfiguration.epcidlength

96,64

ProtocolConfiguration.ISO180006B.GeneralConfiguration.pcmode

Enable,Disable

ProtocolConfiguration.ISO180006B.GeneralConfiguration.4Xreturnlink

Enable,Disable

ProtocolConfiguration.ISO180006B.SelectConfiguration.address

0-255

ProtocolConfiguration.ISO180006B.SelectConfiguration.isoBautoquite

Enable,Disable

43

RAPID Developer's Guide

Protocol Configuration Register

Values

ProtocolConfiguration.ISO180006B.SelectConfiguration.opcode

0-255

ProtocolConfiguration.ISO180006B.SelectConfiguration.mask

0-255

ProtocolConfiguration.ISO180006B.SelectDataHigh.address

0-255

ProtocolConfiguration.ISO180006B.SelectDataHigh.opcode

0-255

ProtocolConfiguration.ISO180006B.SelectDataHigh.mask

0-255

ProtocolConfiguration.ISO180006B.SelectDataLow.address

0-255

ProtocolConfiguration.ISO180006B.SelectDataLow.opcode

0-255

ProtocolConfiguration.ISO180006B.SelectDataLow.mask

0-255

ProtocolConfiguration.ISO180006B.UnselectionConfiguration.address

0-255

ProtocolConfiguration.ISO180006B.UnselectionConfiguration.opcode

0-255

ProtocolConfiguration.ISO180006B.UnselectionConfiguration.mask

0-255

ProtocolConfiguration.ISO180006B.UnselectionDataHigh.address

0-255

ProtocolConfiguration.ISO180006B.UnselectionDataHigh.opcode

0-255

ProtocolConfiguration.ISO180006B.UnselectionDataHigh.mask

0-255

ProtocolConfiguration.ISO180006B.UnselectionDataLow.address

0-255

ProtocolConfiguration.ISO180006B.UnselectionDataLow.opcode
ProtocolConfiguration.ISO180006B.UnselectionDataLow.mask

0-255

ProtocolConfiguration.ISO180006B.TransmitModulation.usefastshaper

Enable, Disable

ProtocolConfiguration.ISO180006B.TransmitModulation.modulationdepthpercentage

99, 75, 50, 30, 20, 11

EPC Class 1
ProtocolConfiguration.EPCClass1.GeneralConfiguration.64bit
ProtocolConfiguration.EPCClass1.GeneralConfiguration.filtering

Enable,Disable

ProtocolConfiguration.EPCClass1.GeneralConfiguration.airintattemptsbeforefailure

0-7

ProtocolConfiguration.EPCClass1.GeneralConfiguration.region

ETSI,FCC

ProtocolConfiguration.EPCClass1.GeneralConfiguration.softwarecrc

Enable,Disable

ProtocolConfiguration.EPCClass1.GeneralConfiguration.96bit

Enable,Disable

ProtocolConfiguration.EPCClass1.GeneralConfiguration.autodetect

Enable,Disable

ProtocolConfiguration.EPCClass1.GeneralConfiguration.autoquite

Enable,Disable

ProtocolConfiguration.EPCClass1.GeneralConfiguration.scrollfirst

Enable,Disable

ProtocolConfiguration.EPCClass1.TransmitModulation.modulationdepthpercentage

99, 75, 50, 30, 20, 11

ProtocolConfiguration.EPCClass1.FilterPatternLengthandOffset.patternlength

0-255

ProtocolConfiguration.EPCClass1.FilterPatternLengthandOffset.patternoffset

0-255

ProtocolConfiguration.EPCClass1.FilterMatchPatternPart0.mask

0-FFFFFFFF

ProtocolConfiguration.EPCClass1.FilterMatchPatternPart1.mask

0-FFFFFFFF

ProtocolConfiguration.EPCClass1.FilterMatchPatternPart2.mask

0-FFFFFFFF

ProtocolConfiguration.EPCClass1.FilterMatchPatternPart3.mask

0-FFFFFFFF

ProtocolConfiguration.EPCClass1.FilterMatchPatternPart4.mask

0-FFFFFFFF

ProtocolConfiguration.EPCClass1.FilterMatchPatternPart5.mask

0-FFFFFFFF

ProtocolConfiguration.EPCClass1.FilterMatchPatternPart6.mask

0-FFFFFFFF

ProtocolConfiguration.EPCClass1.FilterMatchPatternPart7.mask

44

Enable,Disable

0-FFFFFFFF

Configuration Registers

Protocol Configuration Register

Values

EPC Class 0
ProtocolConfiguration.EPCClass0.GeneralConfiguration.64bit

Enable,Disable

ProtocolConfiguration.EPCClass0.GeneralConfiguration.singulationmode

ID0,ID1,ID2

ProtocolConfiguration.EPCClass0.GeneralConfiguration.tagcommandretrycount

0-7

ProtocolConfiguration.EPCClass0.GeneralConfiguration.autodetectlength

Enable,Disable

ProtocolConfiguration.EPCClass0.GeneralConfiguration.sendshortw3

Enable,Disable

ProtocolConfiguration.EPCClass0.GeneralConfiguration.id01singulationblocks

0,1,2,3,4,5,6

ProtocolConfiguration.EPCClass0.GeneralConfiguration.16bit

Enable,Disable

ProtocolConfiguration.EPCClass0.GeneralConfiguration.96bit

Enable,Disable

ProtocolConfiguration.EPCClass0.GeneralConfiguration.crcintagid

Enable,Disable

ProtocolConfiguration.EPCClass0.GeneralConfiguration.proprietary

Matrics,Impinj

ProtocolConfiguration.EPCClass0.GeneralConfiguration.filtering

Enable,Disable

ProtocolConfiguration.EPCClass0.GeneralConfiguration.scrollfirst

Enable,Disable

ProtocolConfiguration.EPCClass0.GeneralConfiguration.inhibitid2singulationonepcwrite

Inhibit, Allow

ProtocolConfiguration.EPCClass0.GeneralConfiguration.taginventoryretry

0-7

ProtocolConfiguration.EPCClass0.TransmitModulation.modulationdepthpercentage

99,75,50,30,20,11

ProtocolConfiguration.EPCClass0.FilterMatchPatternPart0.patternmask0

0-FFFFFFFF

ProtocolConfiguration.EPCClass0.FilterMatchPatternPart0.patternmask1

0-FFFFFFFF

ProtocolConfiguration.EPCClass0.FilterMatchPatternPart0.patternmask2

0-FFFFFFFF

ProtocolConfiguration.EPCClass0.FilterMatchPatternPart0.patternmask3

0-FFFFFFFF

ProtocolConfiguration.EPCClass0.FilterMatchPatternPart0.patternmask4

0-FFFFFFFF

ProtocolConfiguration.EPCClass0.FilterMatchPatternPart0.patternmask5

0-FFFFFFFF

ProtocolConfiguration.EPCClass0.FilterMatchPatternPart0.patternmask6

0-FFFFFFFF

ProtocolConfiguration.EPCClass0.FilterMatchPatternPart0.patternmask7

0-FFFFFFFF

EPC Class 1, Generation 2
ProtocolConfiguration.EPCClass1Generation2.GeneralConfigurationPhysicalLayer.
TruncatedEPCResponse

Enable,Disable

ProtocolConfiguration.EPCClass1Generation2.GeneralConfigurationPhysicalLayer.
InterrogatorMode

0

ProtocolConfiguration.EPCClass1Generation2.GeneralConfigurationPhysicalLayer.
UseSoftwareCRC

Enable,Disable

ProtocolConfiguration.EPCClass1Generation2.GeneralConfigurationPhysicalLayer.PilotTone

Enable,Disable

ProtocolConfiguration.EPCClass1Generation2.GeneralConfigurationPhysicalLayer.
ReturnModulation

0

ProtocolConfiguration.EPCClass1Generation2.GeneralConfigurationPhysicalLayer.LinkRate

40-40FCC, 40-160FCC,
80-160FCC, 40-40ETSI,
40-160ETSI

ProtocolConfiguration.EPCClass1Generation2.GeneralConfigurationIdentificationLayer.
InitialTagInventoryTarget

InventoryFlagA,
InventoryFlagB

ProtocolConfiguration.EPCClass1Generation2.GeneralConfigurationIdentificationLayer.
EnableFiltering

Enable,Disable

ProtocolConfiguration.EPCClass1Generation2.GeneralConfigurationIdentificationLayer.
DisplayTagCRCinResponse

Enable,Disable

45

RAPID Developer's Guide

Protocol Configuration Register

Values

ProtocolConfiguration.EPCClass1Generation2.GeneralConfigurationIdentificationLayer.
NumerOfSlots

1, 2, 4, 8, 16, 32, 64, 128,
256, 512, 1024, 2048,
4096, 8192, 16384, 32768

ProtocolConfiguration.EPCClass1Generation2.GeneralConfigurationIdentificationLayer.
SessionID

0,1,2,3

ProtocolConfiguration.EPCClass1Generation2.GeneralConfigurationIdentificationLayer.
MemoryBankUsedForSelectionProcess

ReservedMemoryBank,
EPCMemoryBank,
TIDMemoryBank,
UserMemoryBank

ProtocolConfiguration.EPCClass1Generation2.GeneralConfigurationIdentificationLayer.
AirInterfaceCommandAttemptsBeforeFailure

0-7

ProtocolConfiguration.EPCClass1Generation2.GeneralConfigurationIdentificationLayer.
UserBlockWriteforWriteOpr

Enable,Disable

ProtocolConfiguration.EPCClass1Generation2.TransmitModulation.ModulationDepth

00,99-80,75,50,30,20,11

SuperTag
ProtocolConfiguration.SuperTag.GeneralConfiguration.ack
ProtocolConfiguration.SuperTag.GeneralConfiguration.mute

46

Enable,Disable
Enable,Disable

SAMSys Technologies, Inc.

Part Number: HI471-API-V1.0
Printed in U.S.A.


All Legacy 9320.zip > Digi Module 9320 Manual.pdf

Digi Connect Family(TM)
User's Guide

90000565_E

? Digi International Inc. 2005. All Rights Reserved.
The Digi Connect logo, the NetSilicon logo, and the Making Device Networking Easy logo
are registered trademarks of Digi International, Inc.
Connectware Manager, Digi Connect, Digi Connect EM, Digi Connect ME, Digi Connect SP,
Digi Connect Wi-SP, Digi Connect Wi-EM, Digi Connect Wi-ME, Digi Connect ES,
Digi Connect WAN, and Digi Connect RG are trademarks of Digi International, Inc.
NetSilicon, NET+Works, NET+OS, and NET+ are trademarks of NetSilicon, Inc.
All other trademarks mentioned in this document are the property of their respective owners.
Information in this document is subject to change without notice and does not represent a
commitment on the part of Digi International.
Digi provides this document "as is," without warranty of any kind, either expressed or implied,
including, but not limited to, the implied warranties of fitness or merchantability for a
particular purpose. Digi may make improvements and/or changes in this manual or in the
product(s) and/or the program(s) described in this manual at any time.
This product could include technical inaccuracies or typographical errors. Changes are
periodically made to the information herein; these changes may be incorporated in new
editions of the publication.

Contents

Contents
oooooooooooooooooooooooooooooooooooooooooooooooooooooooo

Contents..................................................................................................................................... 5
About this Guide..................................................................................................................... 11
Purpose ........................................................................................................................... 11
Audience......................................................................................................................... 11
Scope .............................................................................................................................. 11
Where to Find More Information ................................................................................... 11
General Release Documentation .......................................................................... 11
Integration Documentation................................................................................... 12
Additional Product Information on www.digi.com ............................................. 12
Digi Contact Information ............................................................................................... 12

Chapter 1: Introduction....................................................................................................... 15
The Digi Connect Family ............................................................................................... 15
Digi Connect SP(TM) ............................................................................................... 15
Digi Connect Wi-SP(TM) ......................................................................................... 16
Digi Connect ME(TM).............................................................................................. 16
Digi Connect Wi-ME(TM) ....................................................................................... 16
Digi Connect EM(TM).............................................................................................. 17
Digi Connect Wi-EM(TM) ....................................................................................... 17
Digi Connect(TM) WAN .......................................................................................... 18
Digi Connect(TM) RG .............................................................................................. 18
Digi Connect(TM) ES............................................................................................... 19
Features .......................................................................................................................... 19
Hardware Features................................................................................................ 19
Network Interface Features .................................................................................. 28
User Interfaces...................................................................................................... 31
Protocol Support................................................................................................... 32
IP Address Assignment ........................................................................................ 37

5

Contents

RealPort Software ................................................................................................ 38
Alarms.................................................................................................................. 39
Modem Emulation ............................................................................................... 39
Security Features.................................................................................................. 40
Configuration Management ................................................................................. 41
Customizing Features........................................................................................... 41
Supported Connections and Data Paths ......................................................................... 42
Configuring Devices: Overview .................................................................................... 45
Configuration Capabilities ................................................................................... 45
Configuration Interfaces ...................................................................................... 45
Monitoring Devices: Overview...................................................................................... 57
Monitoring Capabilities ....................................................................................... 57
Monitoring Interfaces........................................................................................... 57
Administering Devices: Overview................................................................................. 58
RF Exposure Statement.................................................................................................. 59
FCC Certifications for Digi Connect ES and Digi Connect RG.................................... 59
FCC Part 15 Class A ............................................................................................ 59
Radio Frequency Interference (RFI) (FCC 15.105)............................................. 60
Labeling Requirements (FCC 15.19) ................................................................... 60
Modifications (FCC 15.21) .................................................................................. 60
Cables (FCC 15.27) ............................................................................................. 60
Industry Canada ................................................................................................... 61
International EMC Standards............................................................................... 61
Safety Standards................................................................................................... 61
Important Safety Information......................................................................................... 62
Digi Connect ES Specifications..................................................................................... 63

Chapter 2: Configuring the Digi Connect Devices............................................................ 65
Assign an IP Address to the Device............................................................................... 69
Configuring the IP Address Using the Digi Device Setup Wizard...................... 69
Configuring the IP Address Using DHCP ........................................................... 70
Configuring the IP Address using Auto-IP .......................................................... 70
Configuring the IP Address from the Command-Line Interface ......................... 71
6

Contents

Connectware Manager.......................................................................................... 71
Testing the IP Address Configuration .................................................................. 71
Configuration through the Digi Device Setup Wizard ................................................... 72
Using Port Profiles to Configure Devices ............................................................ 72
RealPort Profile .................................................................................................... 73
Console Management Profile ............................................................................... 73
TCP Sockets Profile ............................................................................................. 74
UDP Sockets Profile............................................................................................. 74
Serial Bridge Profile............................................................................................. 75
Modem Emulation Profile .................................................................................... 76
Custom Profile...................................................................................................... 76
To Further Configure the Digi Connect Device................................................... 77
Configuration through the Default Web Interface ......................................................... 77
Open the Web Interface........................................................................................ 78
Organization of the Web Interface ....................................................................... 80
Change the IP Address, As Needed ..................................................................... 82
Configure Network Communications .................................................................. 83
Configure Mobile Settings ................................................................................... 85
Configure Serial Ports .......................................................................................... 85
Configure GPIO Pins ........................................................................................... 90
Configure Alarms ................................................................................................. 93
Configure Security Features................................................................................. 96
Configure Remote Management .......................................................................... 96
Configure System Settings ................................................................................... 97
Configuration through the Java Applet Interface ........................................................... 98
System Requirements for Using the Java Applet Interface.................................. 99
Accessing the Java Applet Interface .................................................................... 99
Organization of the Java Applet Interface.......................................................... 100
Configure Network Settings............................................................................... 102
Configure Serial Ports ........................................................................................ 103
Configure GPIO Pins ......................................................................................... 103
Configure Alarms ............................................................................................... 103
Configure Security Features............................................................................... 104

7

Contents

Configuration Through the Command Line................................................................. 104
What's Next?................................................................................................................ 106

Chapter 3: Monitoring Digi Connect Devices ................................................................. 107
About Monitoring ........................................................................................................ 107
Monitoring Capabilities from Web-Based and Java Applet Interfaces ....................... 107
View System Information .................................................................................. 108
General System Information .............................................................................. 108
GPIO Information .............................................................................................. 109
Serial Port Information ...................................................................................... 109
Network Statistics .............................................................................................. 110
Monitoring Capabilities from Connectware Manager ................................................. 115
Monitoring Capabilities from SNMP........................................................................... 115
Monitoring Devices from the Command Line............................................................. 116

Chapter 4: Administering Digi Connect Devices ............................................................ 119
Administration from the Default Web Interface .......................................................... 119
File Management ............................................................................................... 120
Backup/Restore Device Configurations............................................................. 121
Update Firmware and Boot/POST Code............................................................ 121
Restore Device Configuration to Factory Defaults............................................ 122
Display System Information .............................................................................. 125
Reboot the Device.............................................................................................. 126
Enable/Disable Access to Services .................................................................... 126
Administration from the Java Applet Interface............................................................ 126
Backup/Restore Device Configurations............................................................. 127
Restore Device Configuration to Factory Defaults............................................ 127
Display System Information .............................................................................. 128
Reboot the Device.............................................................................................. 128
Enable/Disable Access to Services .................................................................... 128
Administration from the Command-Line Interface ..................................................... 129
Customizing the User Interface.................................................................................... 130

8

Contents

Administration from the Connectware Manager.......................................................... 130
Glossary ................................................................................................................................. 133
Index ...................................................................................................................................... 145

9

Contents

10

About this Guide

About this Guide
oooooooooooooooooooooooooooooooooooooooooooooooooooooooo

Purpose
This guide introduces the features of Digi Connect(TM) devices, and shows you how to
configure, monitor, and administer Connect devices.

Audience
This guide is intended for those responsible for setting up a Digi Connect device. It
assumes that you are somewhat familiar with networking. A glossary is provided with
definitions for networking terms and features discussed in the content.

Scope
This guide focuses on configuration, monitoring, and administration of Digi Connect
devices. It does not cover hardware details beyond a certain level, application
development, or customization of Connect devices and interfaces to them.

W here to Find More Information
In addition to this guide, the following documents are part of the Digi Connect library.

G eneral Release Documentation
These documents are of interest to end users of Digi Connect devices:
Digi Connect User's Guide (this guide)

11

About this Guide

Online help and tutorials
Context-sensitive assistance available in the Web-based interface to Connect
devices.
Digi Connect Hardware Reference Guides
Quick Start Guides
RealPort(R) Installation Guide
Release Notes
Cabling Guides

Integration Documentation
These documents are of interest to customers who purchase the Digi Connect Integration
Kit for product customization. The Digi Connect Integration Kit includes such resources
as development board schematics for module products, firmware release notes, hardware
reference manuals, specifications, and documentation for the sample applications. For
more information, see the document Getting Started with Digi Connect included with the
Integration Kit and accessed from the Start menu (Start & gt; Digi Connect & gt; Getting
Started with Digi Connect).

Additional Product Information on www.digi.com
In addition to the previous documents, product information is available on the digi.com
web site, including:
Support Forums
Knowledge Base
Data sheets/product briefs
Application/solution guides

D igi Contact Information
To contact Digi International for more information about your Digi products, or for
customer service and technical support, use the following contact information:
12

Digi Connect Family User's Guide

About this Guide

To Contact Digi International by:

Use:

Mail

Digi International
11001 Bren Road East
Minnetonka, MN 55343
U.S.A.

World Wide Web:

http://www.digi.com/support/

email

http://www.digi.com/support/

Telephone (U.S.)

(952) 912-3200

Telephone (other locations)

+1 (952) 912-3444

13

About this Guide

14

Digi Connect Family User's Guide

Introduction

Introduction
C

H

A

P

T

E

R

1

This chapter introduces:
The devices in the Digi Connect Family
The features available in Digi Connect devices
The types of connections and data paths in which Digi Connect devices can be
used
The processes and interface options available for configuring, monitoring, and
administering Digi Connect devices
Basic safety considerations for using Digi Connect devices

The Digi Connect Family
Following is an overview of the devices in the Digi Connect Family.

Digi Connect SP(TM)
The Digi Connect SP (Single Port) device server is the ideal platform for your custom
web- and network-enabled embedded applications. Combining Digi and NetSilicon
technology, it eliminates the hardware design effort and delivers a true device networking
solution that is powerful enough to meet your future performance requirements.
Built on leading NetSilicon 32-bit NET+ARM technology, the Digi Connect SP device
server provides a powerful off-the-shelf hardware platform for embedded web- and
network applications with a seamless migration path to embedded modules and a fully

15

The Digi Connect Family

integrated NetSilicon system-on-chip solution using the award-winning family of
Ethernet-enabled NET+ARM microprocessors.

Digi Connect Wi-SP(TM)
The Digi Connect Wi-SP (Wireless Single Port) device server is a secure 802.11b wireless
network solution. Combining Digi and NetSilicon technology, configuration is simple
without complex integration tools. The compact hardware design delivers a powerful
networking solution to meet your performance requirements.
Built on leading NetSilicon 32-bit NET+ARM technology, the Digi Connect Wi-SP
device server provides a powerful off-the-shelf hardware platform for embedded web- and
network applications with a seamless migration path to embedded modules and a fully
integrated NetSilicon system-on-chip solution using the award-winning family of
Ethernet-enabled NET+ARM microprocessors.

Digi Connect ME(TM)
The Digi Connect ME (Micro Embedded) device server enables manufacturers to keep
pace with ever-evolving networking technology by easily adding web-enabled network
connectivity to existing products. This network connectivity is provided without the added
complexities of extensive hardware and software integration, and at a fraction of the time
and cost that would be required to develop a custom solution.
Built on leading 32-bit ARM technology using the network-attached NetSilicon NS7520
microprocessor, the Digi Connect ME combines true plug-and-play functionality with the
freedom and flexibility of complete product customization options. These options are
based on the NetSilicon NET+Works development platform. This platform offers a
seamless migration path to a fully integrated NetSilicon system-on-chip solution.
The Digi Connect ME Integration Kit is available to help you customize the look-and-feel
of the device interface.

D igi Connect Wi-ME(TM)
The Digi Connect Wi-ME (Wireless Micro Embedded) is a fully customizable and secure
802.11b wireless device server. It is based on the common platform design approach of the
Digi Connect family of embedded products, which minimizes design risk and reduces

16

Digi Connect Family User's Guide

Introduction

time to market by allowing customers to easily accommodate both wired and wireless
network functionality in a single future-proof product design.
The Digi Connect Wi-ME device server is pin-compatible with the Digi Connect ME, and
makes fully transparent 802.11b integration possible without the traditional complexities
of hardware and software integration work.
Built on leading NetSilicon 32-bit NET+ARM technology, the Digi Connect Wi-ME
embedded module offers a seamless migration path to a fully integrated NetSilicon
system-on-chip solution. It combines true plug-and-play functionality with the freedom
and flexibility of complete software customization using the proven NetSilicon
NET+Works development platform.
The Digi Connect Wi-ME Integration Kit is available to help you customize the look-andfeel of the device interface.

D igi Connect EM(TM)
The Digi Connect EM (Embedded Module) device server delivers true Web-enabled
device networking that is easy and cost-effective to implement, while being powerful
enough to meet future performance needs.
Built on leading 32-bit ARM technology using the network-attached NetSilicon NS7520
microprocessor and featuring a wide variety of connectivity options, the Digi Connect EM
provides the freedom and flexibility of complete custom product development.
The Digi Connect EM Integration Kit is available to help you customize the look-and-feel
of the device interface.

D igi Connect Wi-EM(TM)
The Digi Connect Wi-EM (Wireless Embedded Module) device server is a fully
customizable and secure 802.11b wireless embedded module that provides integration
flexibility in a variety of connection options. Based on the common platform design
approach of the Digi Connect family of embedded products, the Digi Connect Wi-EM
minimizes design risk and reduces time to market by allowing customers to easily
accommodate both wired and wireless network functionality in a single future-proof
product design.

17

The Digi Connect Family

The Digi Connect Wi-EM wireless embedded module is pin-compatible with the Digi
Connect EM, and makes fully transparent 802.11b integration possible without the
traditional complexities of hardware and software integration work.
Built on leading NetSilicon 32-bit NET+ARM technology, the Digi Connect Wi-EM
combines true plug-and-play functionality with the freedom and flexibility of complete
software customization using the proven NetSilicon NET+Works development platform,
and offers a seamless migration path to a fully integrated NetSilicon system-on-chip
solution.
The Digi Connect Wi-EM Integration Kit is available to help you customize the look-andfeel of the device interface.

D igi Connect(TM) WAN
The Digi Connect WAN (Wide Area Network) wireless device server is an alternative to
traditional wired TCP/IP WANs. The Digi Connect WAN uses GSM (Global System for
Mobile communication) to connect virtually any EIA-232 serial device to your network.
Wireless cellular connectivity can be used to create primary and backup network access
for uninterrupted communication.
The Digi Connect WAN device server uses auto-connect features to maintain connection
without any airtime or usage charges until the connection is actually used. Remote access
is easy, cost-effective, and continuous through standard TCP/IP protocols.
The Digi Connect WAN device server allows remote devices to easily and cost effectively
communicate back to a central office through standard TCP/IP communications.

D igi Connect(TM) RG
The Digi Connect RG (Remote Gateway) wireless cellular device provides high-speed
serial-to-serial conectivity to remote devices via wireless cellular networks. The Digi
Connect RG device employs wireless cellular networks to connect virtually any EIA-232/
422/485 serial device to TCP/IP networks. It allows remote devices to communicate easily
and cost-effectively to a central office through standard TCP/UDP communications. In
addition, Digi patented RealPort(R) COM port redirection software supports remote
connections to serial devices as if they were actually connected to local COM ports.
Wireless communications via Digi Connect RG device servers include instant
deployment, elimination of wiring costs and problems due to wire breaks, and the ability
18

Digi Connect Family User's Guide

Introduction

to move the connection virtually anywhere. Typical applications include utilities,
industrial automation, financial, retail/POS or any industry where remote or portable IP
connections are required.

Digi Connect(TM) ES
The Digi Connect ES (Extended Safety) provides sensitive serial over Ethernet
connectivity for applications. It is the first IEC 60601/EN60601 compliant device of its
kind and consists of four, eight, or 16 galvanically isolated RS-232 serial ports, with a 10/
100 Mbps network interface and Ethernet switch (eight- 16-port models). Common
applications include providing Ethernet connections from serial devices such as
ventilators, EKGs, patient monitoring systems, infusion pumps and glucose meters to the
central data management system.
Galvanical isolation provides extended electrical safety. There is no electrical path for
current to earth ground, ensuring no electrical shock when making physical contact with
the Digi Connect ES. There is no electrical path from port to port, ensuring a ground fault
will not affect the operation of the Digi Connect ES for the operation of any device
connected to it.

F eatures
Following is a discussion of key features in Digi Connect devices.

Hardware Features
Following are summaries of the hardware features for Digi Connect devices. For detailed
hardware specifications, see the Hardware Reference for your Digi Connect device.
Digi Connect SP
Memory: 4 MB Flash; 16 MB RAM
Serial Interface:
-

Switch-selectable EIA-232/422/485 interface (DB-9M).

-

Throughput up to 230,400 bps.

19

Features

-

5, 6, 7, 8 data bits.

-

1, 1.5, 2 stop bits.

-

Mark/space/even/odd parity.

-

Full signal support for TXD, RXD, RTS, CTS, DTR, DSR, and DCD.

-

Hardware and software flow control.

-

RTS Toggle

Power requirements: See " Power Requirements Digi Connect SP Digi Connect
Wi-SP, Digi Connect WAN, and Digi Connect RG " on page 26.
Digi Connect Wi-SP
Memory: 4 MB Flash; 16 MB RAM
Serial Interface:
-

Switch-selectable EIA-232/422/485 interface (DB-9M).

-

Throughput up to 230,400 bps.

-

5, 6, 7, 8 data bits.

-

1, 1.5, 2 stop bits.

-

Mark/space/even/odd parity.

-

Full signal support for TXD, RXD, RTS, CTS, DTR, DSR, and DCD.

-

Hardware and software flow control.

-

RTS Toggle

Power requirements: See " Power Requirements Digi Connect SP Digi Connect Wi-SP,
Digi Connect WAN, and Digi Connect RG " on page 26
Digi Connect ME
Memory: 2 MB Flash; 8 MB RAM
Serial interface:
-
-

Throughput up to 230,400 bps.

-

5, 6, 7, 8 data bits.

-

1, 1.5, 2 stop bits.

-
20

High-speed TTL serial interface.

Mark/space/even/odd parity.
Digi Connect Family User's Guide

Introduction

-

Full signal support for TXD, RXD, RTS, CTS, DTR, DSR, and DCD.

-

Hardware and software flow control.

-

RTS Toggle

Five configurable GPIO pins
Power requirements: See " DC Characteristics for Embedded Devices Digi
Connect ME, Digi Connect Wi-ME, Digi Connect EM, and Digi Connect WiEM " on page 26.
Digi Connect Wi-ME
Memory: 4 MB Flash; 8 MB RAM
Serial interface:
-

High-speed TTL serial interface.

-

Throughput up to 230,400 bps.

-

5, 6, 7, 8 data bits.

-

1, 1.5, 2 stop bits.

-

Mark/space/even/odd parity.

-

Full signal support for TXD, RXD, RTS, CTS, DTR, DSR and DCD.

-

Hardware and software flow control.

-

RTS Toggle

Five configurable GPIO pins
Power requirements: See " DC Characteristics for Embedded Devices Digi
Connect ME, Digi Connect Wi-ME, Digi Connect EM, and Digi Connect WiEM " on page 26.
Digi Connect EM
Memory: 4 MB Flash; 8 MB RAM
Serial interface:
-

Two high-speed TTL serial interfaces.

-

Throughput up to 230,400 bps.

-

5, 6, 7, 8 data bits.

-

1, 1.5, 2 stop bits.

21

Features

-

Mark/space/even/odd parity.

-

Full signal support for TXD, RXD, RTS, CTS, DTR, DSR and DCD on port 1

-

TXD / RXD signals support on port 2.

-

Hardware and software flow control on port 1.

-

RTS Toggle

Nine configurable GPIO pins
Power requirements: See " DC Characteristics for Embedded Devices Digi
Connect ME, Digi Connect Wi-ME, Digi Connect EM, and Digi Connect WiEM " on page 26.
Digi Connect Wi-EM
Memory: 4 MB Flash; 8 MB RAM
Serial interface:
-

Two high-speed TTL serial interfaces.

-

Throughput up to 230,400 bps.

-

5, 6, 7, 8 data bits.

-

1, 1.5, 2 stop bits.

-

Mark/space/even/odd parity.

-

Full signal support for TXD, RXD, RTS, CTS, DTR, DSR and DCD on port 1.

-

TXD / RXD signals support on port 2.

-

Hardware and software flow control on port 1.

-

RTS Toggle

Nine configurable GPIO pins
Power requirements: See " DC Characteristics for Embedded Devices Digi
Connect ME, Digi Connect Wi-ME, Digi Connect EM, and Digi Connect WiEM " on page 26.
Digi Connect ES
RS-232 Serial Ports (2.5 kV)
Connect to 10/100 Mbps Ethernet LAN
Surge protection on all ports

22

Digi Connect Family User's Guide

Introduction

Serial Interface
-

Intergrated 2-port Ethernet switch on 8 and 16-port models

-

HTTP for easy browser configuration

-

Up to 9 Telnet or Rlogin sessions per port

-

Password access

-

Firmware upgrades via TFTP

-

Save/Restore configuration to host

-

230 Kbps throughput on all ports

-

Full modem and hardware flow control

LEDs for serial Ethernet activity
Digi Connect WAN
Memory: 4MB Flash; 8 MB RAM
Serial interface:
-

Switch-selectable EIA-232 (DB-9M)

-

Throughput up to 230,400 bps

-

5, 6, 7, 8 data bits.

-

1, 1.5, 2 stop bits.

-

Mark/space/even/odd parity.

-

Full signal support for TXD, RXD, RTS, CTS, DTR, DSR, and DCD.

-

Hardware and software flow control.

DHCP Server (enabled by default)
Power requirements: See " Power Requirements Digi Connect SP Digi Connect
Wi-SP, Digi Connect WAN, and Digi Connect RG " on page 26.
Digi Connect RG
One EIA-232/422/485 serial port
10/100 Base-T Ethernet
GPRS with EDGE network for high speed wireless network connectivity
1900/850 MHz EDGE/GPRS modem for use in U.S. and other markets

23

Features

TCP/UDP socket service
Patented Digi RealPort(R) COM port redirector
Web and central console configuration
Supports static/dynamic and public/private IP addresses
Integrates with Digi Connectware(TM) Manager for easy device connectivity and
management
256-bit AES security provides encryption and authentication for data
communications
The following is a discussion of some of these key configurable hardware features.
Serial Interface Features and Options
The serial interface for Digi Connect devices includes the following features (except
where noted) and configurable options:
Full signal support for TXD, RXD, RTS, CTS, DTR, DSR, and DCD.
RTS Toggle: The RTS signal can be enabled or disabled on a given serial port.
This toggling of RTS can be used to raise RTS when sending data (not
supported in Digi Connect WAN).
Data bits 5 through 8 are supported.
Stop bits 1, 1.5, and 2 are supported.
RCI over Serial (DSR) can be enabled or disabled.
Hardware and software flow control.
Serial data over User Datagram Protocol (UDP) also known as udpserial (not
supported in Digi Connect WAN). Supported udpserial inlcudes the following
functionality:
-

controlling forwarding characteristics based on size, time, and patterns.

-

incoming datagrams from multiple destinations.

-

outgoing datagrams sent to multiple destinations.

Serial data over Transmission Control Protocol (TCP), also known as
autoconnect and tcpserial. Supported tcpserial includes the following
functionality:
-

24

controlling forwarding characteristics based on size, time, and pattern.

Digi Connect Family User's Guide

Introduction

-

creating an autoconnection from serial port to remote network destination
based on data and/or serial hardware signals.

-

allowing incoming raw, Telnet, and SSL (secure socket) connections

-

controlling serial port via Telnet also known as RFC 2217 (not supported in
Digi Connect WAN).

Alarms: Issuing of email triggers or SNMP traps based on patterns found in
serial data (alarms feature), also emails based on General Purpose Input/Output
(GPIO) signals. See " Alarms " on page 39 for more details.
Port buffering: Allows you to monitor incoming ASCII serial data in log form.
Session management (not supported in Digi Connect WAN):
-

You can connect to a device through Telnet or Rlogin.

-

You can make connections to serial ports and switch between them using
escape key sequences.

Modem emulation over Ethernet (see also " Modem Emulation " on page 39, not
supported in Digi Connect WAN):
-

Dial into serial port from network

-

Dial out of serial port to network

-

Dial-in modem pool

Line Printer Daemon (LPD): Allows network printing over a serial port (not
supported in Digi Connect WAN).
RealPort software (see also " RealPort Software " on page 38, not supported in
Digi Connect WAN):
-

Support network serial port on many popular operating systems.

-

Support encrypted RealPort over SSL on selected operating systems.

Configurable GPIO Pins
All devices in the Digi Connect Family except the Digi Connect SP, Digi Connect ES,
Digi Connect Wi-SP and the Digi Connect WAN have a set of General Purpose I/O
(GPIO) pins. In normal operation, the GPIO pins are used for the serial CTS, DCD, DSR,
DTR, and RTS signals. On Digi Connect EM and Wi-EM devices, both sets of RXD/TXD
signals are also configured. These GPIO pins can be configured for one of three modes:
serial, input, and output.

25

Features

Serial mode allows normal serial operation.
Input mode allows input of GPIO signals. Alarms can be issued when GPIO
pins change state. Input mode is used in conjunction with alarms to trigger
emails or SNMP traps when a particular signal change is detected (see
" Alarms " on page 39).
Output mode allows output of GPIO signals. This mode can be used to toggle
the output of GPIO signals between high and low.
The configuration and current state of GPIO pins can be easily viewed, through the Web
user interface or by issuing commands from the command line.
DHCP Server
The Digi Connect WAN device is running a DHCP server. The DHCP server is enabled by
default but can be disabled in the setup wizard. Configure the setup device to obtain IP
adresses automatically. This eliminates subnet errors.
Power Requirements
The power requirements for Digi Connect devices are as follows. See also the Hardware
Reference for your Digi Connect device for additional information.
Power Requirements Digi Connect SP Digi Connect Wi-SP, Digi Connect WAN, and
Digi Connect RG
The Digi Connect SP, Digi Connect Wi-SP, Digi Connect WAN, and Digi Connect RG
must be powered by a Listed LPS or Class II power supply rated 9-30 VDC, 0.37 A
minimum. The power supply shipped with the Digi Connect WAN provides surge
protection covering 4Kv burst (EFT) per -4-4 and 2Kv surge per EN61000-4-5 (noncondensing). See the Hardware Reference or the Quick Start guide for your Digi Connect
device for additional information.
DC Characteristics for Embedded Devices
Digi Connect ME, Digi Connect Wi-ME, Digi Connect EM, and Digi Connect Wi-EM
The following tables list DC characteristics for operating conditions, inputs, and outputs
for Digi Connect ME, Digi Connect Wi-ME, Dig Connect EM, and Digi Connect Wi-EM
devices.

26

Digi Connect Family User's Guide

Introduction

Operating Conditions
Symbol

Description

VCC

Supply Voltage

ICC

Min

Typ

Max

Unit

3.14

3.3

3.45

V

Supply Current for
Digi Connect ME & EM

--

--

270

mA

ICC

Supply Current for
Digi Connect Wi-ME & Wi-EM

--

--

400

mA

IIL

Input Current as "0"
(57K pull-up resistor)

--

--

IIH

Input Current "1"
(57K pull-up resistor)

-10

--

10

uA

IOZ

HighZ Leakage Current

-10

--

10

uA

IOD

Output Drive Strength

--

--

2

mA

CIO

Pin Capacitance (VO=0)

--

--

4

pF

uA

57

Note VCC absolute max rating is -.03V and max 3.9V
Warning The assertion of the 3.3V supply voltage must be stable within 140 ms. If

the rise time is greater than specified, it could lead to the 3-1-3 diagnostic
error.

GPIO Inputs
Symbol

Description

Min

Typ

Max

Unit

VIH

Input High Voltage

2

--

VCC+0.3

V

VIL

Input Low Voltage

VSS-0.3

--

0.2*VCC

V

27

Features

GPIO Outputs
Symbol

Description

Min

Typ

Max

Unit

VOH

Output High Voltage

2.4

--

3.45

V

VOL

Output Low Voltage

0

--

0.4

V

Note The Digi Connect ME and Digi Connect Wi-ME modules use a supervisor

circuit with a 2.88 reset threshold and an internal 5k pull-up resistor. When
VCC falls to the threshold voltage, a reset pulse is issued, holding the
output in active state. When power rises above 2.88V, the reset remains for
approximately 250 ms to allow the system clock and other circuits to
stabilize.
Note The Digi Connect EM and Digi Connect Wi-EM modules use a supervisory

circuit with a 2.93V reset threshold. When VCC falls to the threshold
voltage, a reset pulse is issued, holding the output in active state. When
power rises above 2.93V, the reset remains for approximately 200 ms to
allow the system clock and other circuits to stabilize.

Network Interface Features
Key features of the network interface for Digi Connect products are as follows:
Standard:
-

IEEE 802.3 for Digi Connect SP, Digi Connect ME, Digi Connect EM, Digi
Connect WAN, and Digi Connect RG.

-

IEEE 802.11b for Digi Connect Wi-SP, Digi Connect Wi-ME and Wi-EM.

Physical layer: 10/100 Mbit Base-T for Digi Connect SP, Digi Connect ME,
Digi Connect EM, Digi Connect WAN, and Digi Connect RG.
Network data rate:
-
-

28

10 Mbps/100 Mbps, with auto-sensing of speed for Digi Connect SP, Digi
Connect ME, Digi Connect EM, Digi Connect WAN, and Digi Connect RG.
Up to 11 Mbps with automatic fallback for Digi Connect Wi-SP Digi Connect
Wi-ME and Wi-EM.

Digi Connect Family User's Guide

Introduction

Ethernet duplex mode: full-duplex, half-duplex, with auto-sensing of duplex
mode for Digi Connect SP, Digi Connect ME, Digi Connect EM, Digi Connect
WAN, and Digi Connect RG.
Ethernet connector: RJ-45 for Digi Connect SP, Digi Connect ME, Digi
Connect WAN, and Digi Connect RG.
RJ-45 or pin header for Digi Connect EM.
Serial connector: DB-9M for Digi Connect SP, Digi Connect Wi-SP,Digi
Connect WAN, and Digi Connect RG. TTL-level pins for Digi Connect ME,
Wi-ME, Digi Connect EM, and Wi-EM.
Wireless Devices Digi Connect Wi-ME, Wi-EM, Wi-SP, and Digi Connect WAN (see
also " Wireless Networking Features " on page 30):
-
Wireless Modulation: CCK (11/5 Mbps), DQPSK (2 Mbps), DBPSK (1 Mbps)
-

Wireless Transmit Power: 16 dBm

-

Wireless Receive Sensitivity: -82 dBm at 11 Mbps

-

Wireless Antenna Connector: 1 x RP-SMA for Digi Connect Wi-ME, Wi-SP,
and Digi Connect WAN; 2 x RP-SMA for Digi Connect Wi-EM

-

Wireless Security: Wi-Fi Protected Access (WPA/WPA2/802.11i), Wired
Equivalent Privacy (WEP)
Full-duplex
Half-duplex
Auto-sensing of duplex mode

Configurable Network Services
Access to network services can be enabled and disabled. This means that you can restrict a
device's use of services to only those strictly needed by the device. To improve device
security, you can also turn off any non-secure services, such as Telnet. Network services
that can be enabled or disabled include:
Advanced Digi Discovery Protocol (ADDP)
RealPort (not supported in Digi Connect WAN)
Encrypted RealPort (not supported in Digi Connect WAN)
HTTP/HTTPS
Line Printer Daemon (LPD) (not supported in Digi Connect WAN)
Remote Login (rlogin) (not supported in Digi Connect WAN)
29

Features

Remote Shell (rsh) (not supported in Digi Connect WAN)
Simple Network Management Protocol (SNMP)
Telnet
In the default web interface, access to network services is enabled and disabled on the
Network Services page of Network Configuration. For more information, see " Enable or
Disable Network Services " on page 84. In the Command-Line Interface, network services
are enabled and disabled through the set service command. See the Digi Connect Family
Command Reference for the set service command description.
Wireless Networking Features
The following table summarizes key wireless-networking features in the Digi Connect
wireless devices (Digi Connect Wi-ME and Digi Connect Wi-EM). For more details on
support of these features, see the readme file for this release. The following features can
be configured in wireless Digi Connect devices.
Feature

Description

Country Code

Specifies the country in which the product is used.

Network Mode

-- Infrastructure Mode
-- Ad-Hoc Mode

Channel

Can use automatic channel search-and-select or a user-configurable
channel number.

Data Rate

Auto, 1Mbps, 2Mbps, 5.5Mbps, 11Mbps

Service Set
Identifier (SSID)

A user-configurable SSID string or auto-connect option.

Authentication
Options

-- Open
-- Shared
-- Wi-Fi Protected Access (WPA2/802.11i)
-- WPA/WPA2 with pre-shared key (WPA-PSK)

802.1x
(WPA2/802.11i)
Authentication

Encryption

30

-- Protected Extensible Authentication Protocol (PEAP) with EAP- MS
See " Supported WPA Authentication Methods " on page 40
-- Temporal Key Integrity Protocol (TKIP)
--Counter mode CBC MAC Protocol (CCMP)
-- Wired Equivalent Privacy (WEP)
-- Use of encryption can be disabled.

Digi Connect Family User's Guide

Introduction

Feature

Description

Network Key

A shared key (ASCII or Hexadecimal) to be used for WEP or WPA-PSK.

Username

A username to be specified when 802.1x -based authentication (WPA) is used.

Password

A password to be specified when 802.1x based authentication (WPA) is used.

Wireless Networking
Status Features:

You can display the following status information for Wireless Digi Connect
devices. For more detailed descriptions, see " Wireless Statistics " on page 113.

Connection Status

The status of the wireless network connection.

Network Mode

The network mode currently in use:
-- Infrastructure Mode
--Ad-Hoc Mode

Data Transfer Rate

The data transfer rate of the current connection.

Channel

The wireless network channel currently in use.

SSID

The selected SSID of the wireless network.
The status of the WEP/WPA/WPA2 security features, including:

WEP / WPA security
and encryption

-- The Authentication Method currently in use
-- Whether authentication is enabled or disabled

Signal Strength

A statistic that indicates the strength of the radio signal between 0 and 100
percent.

User Interfaces
Digi Connect devices support a variety of user interfaces for configuring and monitoring
tasks, including:
The Digi Device Setup Wizard
A default web-based interface
An optional Java-applet interface
Telnet Command-Line Interface
Configuration via Remote Command Interface (RCI) over the serial port
Simple Network Management Protocol (SNMP)
Connectware Manager Console

31

Features

Some of these user interfaces may be customized. For additional details on these user
interfaces, see " Configuration Interfaces " on page 45 and " Monitoring Interfaces " on page
57.

Protocol Support
All the devices in the Digi Connect Family include a Robust on-board TCP/IP stack with a
built-in web server. The protocols supported in each Digi Connect device (unless noted
otherwise) include:
Transmission Control Protocol (TCP)
User Datagram Protocol (UDP) (not supported in Digi Connect WAN)
Dynamic Host Configuration Protocol (DHCP)
Simple Network Management Protocol (SNMP)
Secure Sockets Layer (SSL)/Transport Layer Security (TLS)
Telnet Com Port Control Option (Telnet) including support of RFC 2217
(ability to control serial port via Telnet -however, Digi Connect WAN does not
support the additional extension of RFC 2217. See " Serial Data
Communication over TCP and UDP " on page 33 for additional information
Remote Login (rlogin) (not supported in Digi Connect WAN)
Line Printer Daemon (LPD) (not supported in Digi Connect WAN)
HyperText Transfer Protocol (HTTP)/HyperText Transfer Protocol over Secure
Socket Layer (HTTPS)
Simple Mail Transfer Protocol (SMTP)
Internet Control Message Protocol (ICMP)
Internet Group Management Protocol (IGMP)
Address Resolution Protocol (ARP)
Advanced Digi Discovery Protocol (ADDP)
Point to Point Protocol (PPP) with Network Address Technology (NAT) (Only
supported in Digi Connect WAN and Digi Connect RG)
Secure Shell (SSHv2) (Only supported in Digi Connect WAN and Digi
Connect RG)

32

Digi Connect Family User's Guide

Introduction

Global System for Mobile communication (GSM) (Only supported in Digi
Connect WAN and Digi Connect RG)
General Packet Radio Service (GPRS) (Only supported in Digi Connect WAN
and Digi Connect RG)
Enhanced Data Rates for Global Evolution (EDGE) (Only supported in Digi
Connect WAN and Digi Connect RG)
Following is an overview of some of the services provided by these protocols.
S erial Data Communication over TCP and UDP
The Digi Connect family supports serial data communication over TCP and UDP. The
only exception is the Digi Connect WAN which does not support UDP. Key features
include:
Serial data communication over TCP, also known as autoconnect and tcpserial
can automatically perform the following functions:
-

Establish bidirectional TCP connections, known as autoconnections, between
the serial device and a server or other network device. Autoconnections can be
made based on data and or serial hardware signals.

-

Control forwarding characteristics based on size, time, and pattern

-

Allow incoming raw, Telnet, and SSL/TLS (secure-socket) connections

-

Support RFC 2217 (an extension of the Telnet protocol not supported in Digi
Connect WAN)

Serial data communication over UDP, also known as udpserial (not supported
in Digi Connect WAN) can automatically perform the following functions:
-

Digi Connect devices can automatically send serial data to one or more devices
or systems on the network using UDP sockets. Options for sending data include
whether specific data is on the serial line, a specific time period has elapsed, or
after the specified number of bytes has been received on the serial port.

-

Control forwarding characteristics based on size, time, and patterns.

-

Support incoming datagrams from multiple destinations.

-

Support outgoing datagrams sent to multiple destinations.

TCP/UDP forwarding characteristics.
Extended communication control on TCP/UDP data paths.

33

Features

-

Timeout

-

Hangup

-

User-configurable Socket ID string (text string identifier on autoconnect only)

Dynamic Host Configuration Protocol (DHCP)
Dynamic Host Configuration Protocol (DHCP) can be used to automatically assign IP
addresses, to deliver TCP/IP stack configuration parameters such as the subnet mask and
default router, and to provide other configuration information. For further details, see " IP
Address Assignment " on page 37.
Simple Network Management Protocol (SNMP)
Simple Network Management Protocol (SNMP) is a protocol that can be used to manage
and monitor network devices. The SNMP architecture enables a network administrator to
manage nodes--servers, workstations, routers, switches, hubs, etc.--on an IP network;
manage network performance, find and solve network problems, and plan for network
growth. Digi devices support SNMP Version 1. For more information about using SNMP
as an interface to manage devices, see " Simple Network Management Protocol (SNMP) "
on page 55.
Supported RFCs and MIBs
The following SNMP-related Request for Comments (RFCs) and Management
Information Bases (MIBs) are supported:
RFC 1213 - Management Information Base (MIB) II
RFC 1215 - Generic Traps (coldStart, linkUp, authenticationFailure only)
RFC 1316 - Character MIB
RFC 1317 - RS-232 MIB
DIGI-DEVICE-INFO.mib - A Digi enterprise MIB for the Digi Connect
Family
DIGI-SERIAL-ALARM-TRAPS.mib - A Digi enterprise MIB for sending
alarms as SNMP traps
Supported SNMP Traps
SNMP traps can be enabled or disabled. Supported SNMP traps include:
Authentication failure

34

Digi Connect Family User's Guide

Introduction

Login
Cold start
Link up
Alarms can be issued in the form of SNMP traps
S ecure Sockets Layer (SSL)/Transport Layer Security (TLS)
Secure Sockets Layer (SSL)/Transport Layer Security (TLS) are used to provide
authentication and encryption for Digi Connect devices. For more information, see
" Security Features " on page 40.
Telnet
Digi Connect devices support the following types of Telnet connections:
Telnet Client
Telnet Server
Reverse Telnet, often used for console management or device management
Telnet Autoconnect
RFC 2217 (Telnet Com Port Control Option and extension of the Telnet
protocol is not supported in Digi Connect WAN)
For more information on these connections, see " Supported Connections and Data Paths "
on page 42. Access to Telnet network services can be enabled or disabled.
Remote Login (rlogin)
Users can perform logins to remote systems (rlogin). Remote Login is not supported in
Dig Connect WAN. Access to rlogin service can be enabled or disabled.
Line Printer Daemon (LPD)
The Line Printer Daemon (LPD) allows network printing over a serial port. The Line
Printer Daemon is not supported in the Digi Connect WAN. Each serial port has a
dedicated LPD server that is independently configurable. Access to LPD service can be
enabled or disabled.

35

Features

HyperText Transfer Protocol (HTTP)/Hypertext Transfer Protocol over
Secure Socket Layer (HTTPS)
Digi Connect devices provide web pages for configuration that can be secured by
requiring a user login.
Internet Control Message Protocol (ICMP)
ICMP statistics can be displayed, including the number of messages received, bad
messages received, and destination unreachable messages received.
Point-to-Point Protocol (PPP)
The Point-to-Point Protocol (PPP) transports multi-protocol packets over point-to-point
links. PPP encapsulates the data packet, allows the server to inform the dial-up client of its
IP address (or client to request the IP address), authenticates the exchange, negotiates
multiple protocols, and reassembles the data packet for network communication. Digi
Connect WAN supports PPP with NAT (Network Address Technology). NAT reduces the
need for a large amount of publicly known IP addresses by creating a separation between
publicly known and privately known IP addresses.
A dvanced Digi Discovery Protocol (ADDP)
The Advanced Digi Discovery Protocol (ADDP) runs on any operating system capable of
sending multicast IP packets on a network. ADDP allows the system to identify all
ADDP-enabled Digi devices attached to a network by sending out a multicast packet. The
Digi devices respond to the multicast packet and identify themselves to the client sending
the multicast.
ADDP needs to communicate with the TCP/IP stack using UDP. The TCP/IP stack should
be able to receive multicast packets and transmit datagrams on a network.
Not all Digi devices support ADDP.
Access to ADDP service can be enabled or disabled.

36

Digi Connect Family User's Guide

Introduction

Global System for Mobile communication (GSM) (Only supported in Digi
Connect WAN and Digi Connect RG)
The GSM protocol is a digital mobile telephone system used in Europe and other parts of
the world. There are three major types of digital mobile systems and GSM is the most
widely used. GSM compresses and digitizes data and sends it down a channel along with
two other streams of user data - each in its own time slot.
General Packet Radio Service (GPRS) (Only supported in Digi Connect WAN
and Digi Connect RG)
GPRS is based on Global System for Mobile (GSM) communication. GPRS is a packetbased wireless communication service that transports data rates from 56 up to 114 Kbps
and continuous connection to the Internet for mobile phone and computer users. Higher
data rates allow users more flexibility in the media they transmit. In theory, GPRS packetbased service costs users less than circuit-switched services since communication
channels are being used on a shared-use, as-packets-are-needed basis rather than
dedicated only to one user at a time. It should also be easier to make applications available
to mobile users because the faster data rate means that middleware currently needed to
adapt applications to the slower speed of wireless systems will no longer be needed.
E nhanced Data Rates for Global Evolution (EDGE) (Only supported in Digi
Connect WAN and Digi Connect RG)
EDGE is a faster version of the GSM wireless service and designed to deliver data at rates
up to 384 Kbps and enable the delivery of multimedia and other broadband applications to
mobile phone and computer users. The EDGE standard is built on the existing GSM
standard, using the same time-division multiple access frame structure and existing cell
arrangements.

I P Address Assignment
There are several ways to assign an IP address to a Digi Connect device:
Static IP: Assign a specific IP address to a device, through the Digi Device
Setup Wizard, the default web interface, or the Command-Line Interface.
Using Dynamic Host Configuration Protocol (DHCP). The device server's
default configuration is as a DHCP client. Dynamic Host Configuration

37

Features

Protocol (DHCP) is an Internet protocol for automating the configuration of
computers that use TCP/IP. DHCP can be used to automatically assign IP
addresses, to deliver TCP/IP stack configuration parameters such as the subnet
mask and default router, and to provide other configuration information.
Auto Private IP Addressing (APIPA), also known as Auto-IP: A standard
protocol that will automatically assign an IP address from a reserved pool of
standard Auto-IP addresses to the computer on which it is installed. The device
is set to obtain its IP address automatically from a DHCP server. But if the
DHCP server is unavailable or nonexistent, Auto-IP will assign the device an
IP. If DHCP is enabled or responds later or you use ADDP, both will override
the Auto-IP address previously assigned.
For more details, see " Assign an IP Address to the Device " on page 69.

RealPort Software
Digi Connect devices use the patented RealPort COM/TTY port redirection for Microsoft
Windows, UNIX, and Linux environments (not supported in Digi Connect WAN).
RealPort software provides a virtual connection to serial devices, no matter where they
reside on the network. The software is installed directly on the host and allows
applications to talk to devices across a network as though the devices were directly
attached to the host. Actually, the devices are connected to a Digi device server or terminal
server somewhere on the network.
RealPort is unique among COM port re-directors because it is the only implementation
that allows multiple connections to multiple ports over a single TCP/IP connection. Other
implementations require a separate TCP/IP connection for each serial port. Unique
features also include full hardware and software flow control, as well as tunable latency
and throughput.
Access to RealPort services can be enabled or disabled.
Encrypted RealPort
Digi Connect devices support the patent-pending RealPort software with encryption. The
Digi Connect WAN does not support Encrypted RealPort. Encrypted RealPort offers a
secure Ethernet connection between the COM or TTY port and a device server or terminal
server. Encryption prevents internal and external snooping of data across the network by
encapsulating the TCP/IP packets in a Secure Sockets Layer (SSL) connection and

38

Digi Connect Family User's Guide

Introduction

encrypting the data using Advanced Encryption Standard (AES), one of the latest, most
efficient security algorithms.
Digi's RealPort with encryption driver has earned Microsoft's Windows Hardware
Quality Lab (WHQL) certification.
Drivers are available for a wide range of operating systems, including Microsoft Windows
Server 2003, Windows XP, Windows 2000, Windows NT, Windows 98, Windows ME;
SCO Open Server; Linux; AIX; Sun Solaris SPARC; Intel; and HP-UX. It is ideal for
financial, retail/point-of-sale, government or any application requiring enhanced security
to protect sensitive information.
Access to Encrypted RealPort services can be enabled or disabled.

Alarms
Digi Connect devices can be configured to issue alarms, in the form of email message or
SNMP traps, when certain device events occur. These events include changes in GPIO pin
status, and data patterns in the serial stream. Receiving alarms about these conditions
provides you with the advantage of being notified when events occur, rather than having
to monitor the device on an ongoing basis to determine whether these events have
occurred.
For more information on configuring alarms, see " Configure Alarms " on page 93.

Modem Emulation
Digi Connect devices include a configuration profile that allows the device to emulate a
modem (not supported in Digi Connect WAN). Modem emulation sends and receives
modem responses to the serial device over the Ethernet instead of Public Switched
Telephone Network (PSTN). The modem emulation profile allows you maintain your
current software application but use it over the less expensive Ethernet network. In
addition, Telnet processing can be enabled or disabled on the incoming and outgoing
modem-emulation connections.
The modem-emulation commands supported in Digi Connect devices are documented in
the Digi Connect Family Command Reference.

39

Features

Security Features
Security-related features in Digi Connect devices include:
Secure access and authentication:
-

One password, one permission level.

-

Can issue passwords to device users.

-

Can selectively enable and disable IP services: network services such as ADDP,
RealPort, Encrypted RealPort, HTTP/HTTPS, LPD, Remote Login, Remote
Shell, SNMP, and Telnet, can be enabled and disabled.

-

Can control access to inbound ports.

-

Secure sites for configuration: HTML pages for configuration have appropriate
security.

-

Can control access to specific devices, IP addresses, or networds through IP
filtering.

Encryption:
-

Digi Connect devices include strong Secure Sockets Layer (SSL) V3.0/
Transport Layer Security (TLS) V1.0-based encryption: DES (56-bit), 3DES
(168-bit), AES (128-/156-bit).

-

Encrypted RealPort offers encryption for the Ethernet connection between the
COM/TTY port and the Digi Connect device. (Not supported in Digi Connect
WAN)

-

Wireless Digi Connect devices provide Wi-Fi Protected Access
(WPA/WPA2/802.11i) and Wired Equivalent Privacy (WEP) encryption
(64-/128-bit). The following table shows the supported WPA/WPA2/802.11i
authentication methods.
Supported WPA Authentication Methods

EAP-TLS

PEAP

EAP/TTLS

LEAP (WEP only)

EAP-PEAP/MSCHAPv2 (both PEAPv0 and PEAPv1)

EAP-TTLS/EAP-MD5-Challenge

EAP-PEAP/TLS (both PEAPv0 and PEAPv1)

EAP-TTLS/EAP-GTC

EAP-PEAP/GTC (both PEAPv0 and PEAPv1)

EAP-TTLS/EAP-OTP

EAP-PEAP/OTP (both PEAPv0 and PEAPv1)

EAP-TTLS/EAP-MSCHAPv2

40

Digi Connect Family User's Guide

Introduction

Supported WPA Authentication Methods
EAP-TLS

PEAP

EAP/TTLS

EAP-PEAP/MD5-Challenge (both PEAPv0 and PEAPv1)

EAP-TTLS/EAP-TLS
EAP-TTLS/MSCHAPv2
EAP-TTLS/MSCHAP
EAP-TTLS/PAP
EAP-TTLS/CHAP

SNMP security:
-

Authorization: Changing public and private community names is
recommended to prevent unauthorized access to the device.

-

You can disable SNMP set commands to make use of SNMP read-only.

Configuration Management
Once Digi Connect devices are configured and running, configuration-management tasks
need to be periodically performed, such as:
Upgrading firmware
Copying configurations to and from a remote host
Software and factory resets
Rebooting the device
Memory management
File management
For more information on these configuration-management tasks, see Chapter 4,
" Administering Digi Connect Devices " .

Customizing Features
Several aspects of using Digi Connect devices can be customized. For example:
The look-and-feel of the device interface for Connect devices can be
customized, to use a different company logo or screen colors.
41

Supported Connections and Data Paths

Custom Java applets can be created, using the Java configuration applet as a
sample for further development.
Redefined Custom Factory Defaults -allows you to define a new set of factory
defaults so when you revert back to factory default it will be your settings and
not the Digi default settings.
The Digi Connect Integration Kit provides a platform for evaluation, rapid prototyping,
and integration of Digi Connect embedded modules with plug-and-play firmware. It
includes tools, sample code, and documentation to help with your product integration and
web-based customization efforts. Contact Digi International for more information on the
Integration Kit and for assistance with your customization efforts.

Supported Connections and Data Paths
Digi Connect devices allow for several kinds of connections and paths for data flow
between the device and other entities. These connections can be grouped into two main
categories:
Network services, in which a remote entity initiates a connection to a Digi
Connect device.
Network/serial clients, in which a Digi Connect device initiates a network
connection or opens a serial port for communication.
Following is a discussion of these connections. The intent of this information is to
illustrate how the connections are made and data is passed. This in turn may help you
better understand the effects of enabling certain features and choosing certain settings
when configuring Digi Connect devices.
Network Services
A network service connection is one in which a remote entity initiates a connection to a
Digi Connect device. There are several categories of network services:
Network services associated with specific serial ports
Network services associated with serial ports in general
Network services associated with the Command-Line Interface (CLI)

42

Digi Connect Family User's Guide

Introduction

Network Services Associated with Specific Serial Ports
Network service connections associated with specific serial ports include:
Reverse Telnet: A telnet connection is made to a Digi Connect device, in which
data is passed transparently between the telnet connection and a named serial
port.
Reverse raw socket: A raw TCP socket connection is made to a Digi Connect
device, in which data is passed transparently between the socket and a named
serial port.
Reverse TLS socket: An encrypted raw TCP socket is made to a Digi Connect
device, in which data is passed transparently to and from a named serial port.
LPD: A TCP connection is made to a named serial port, in which the Digi
Connect device interprets the LPD protocol and sends a print job out of the
serial port. (Not supported in Digi Connect WAN.)
Modem emulation, also known as Pseudo-modem (pmodem) (not supported in
Digi Connect WAN): A TCP connection is made to a named serial port, and the
connection will be "interpreted" as an incoming call to the pseudo-modem.
Network Services Associated with Serial Ports in General
The Digi Connect WAN does not support the following features: RealPort, Modem
emulation, and rsh. Network service connections associated with serial ports in general
include:
RealPort: A single TCP connection manages (potentially) multiple serial ports.
Modem emulation, also known as pseudo-modem (pool): A TCP connection to
the " pool " port is interpreted as an incoming call to an available pseudo-modem
in the " pool " of available port numbers.
rsh: Digi Connect devices support a limited implementation of the Remote
Shell (rsh) protocol, in that a single service listens to connections and allows a
command to be executed. Only one class of commands is allowed: a single
integer that specifies which serial port to connect to. Otherwise, the resulting
connection is somewhat similar to a reverse telnet or reverse socket connection.
Network Services Associated with the Command-Line Interface (CLI)
Network service connections associated with the Command-Line Interface (CLI) include:
Telnet: A user can Telnet directly to a Digi Connect device's CLI.

43

Supported Connections and Data Paths

rlogin: A user can perform a remote login (rlogin) to a Digi Connect device's
CLI. The Digi Connect WAN does not support rlogin.
Network/Serial Clients
A network/serial client connection is one in which a Digi Connect device initiates a
network connection or opens a serial port for communication. There are several categories
of network/serial client connections:
Autoconnect behavior client connections
Command-Line Interface (CLI)-based clients
Modem emulation (pseudo-modem) client connections (not supported in Digi
Connect WAN.)
Autoconnect Behavior Client Connections
In client connections that involve autoconnect behaviors, a Digi Connect device initiates a
network connection based on timing, serial activity, or serial modem signals.
Autoconnect-related client connections include:
Raw TCP connection: The Dig Connect device initiates a raw TCP socket
connection to a remote entity.
Telnet connection: The Dig Connect device initiates a TCP connection using
the Telnet protocol to a remote entity.
Raw TLS encrypted connection: The Dig Connect device initiates an encrypted
raw TCP socket connection to a remote entity.
Rlogin connection: The Dig Connect device initiates a TCP connection using
the rlogin protocol to a remote entity. (Not supported in Digi Connect WAN.)
Command-Line Interface (CLI)-based Client Connections
CLI-based client connections are available for use once a user has established a session
with the Digi Connect device's Command-Line Interface. CLI-based client connections
include:
telnet: A connection is made to a remote entity using the Telnet protocol.
rlogin: A connection is made to a remote entity using the Rlogin protocol. (Not
supported in Digi Connect WAN.)
connect: Begin communicating with a local serial port.

44

Digi Connect Family User's Guide

Introduction

Modem Emulation (Pseudo-Modem) Client Connections
When a port is in the modem-emulation or pseudo-modem mode, it can initiate network
connections based on AT command strings received on the serial port. (Not supported in
Digi Connect WAN.) The AT commands for modem emulation are documented in the
Digi Connect Family Command Reference.

C onfiguring Devices: Overview
Following is an overview of the configuration capabilities and interfaces for Digi Connect
devices. Chapter 2, " Configuring the Digi Connect Devices " covers these capabilities and
interfaces in more detail.

Configuration Capabilities
Device configuration involves setting values and enabling features for such areas as:
Network configuration: Specifying the device's IP address and IP settings,
network-service settings, and advanced network settings.
Serial port configuration: Specifying the serial port characteristics for the
device.
GPIO pin configuration (for all devices except Digi Connect SP, Digi Connect
Wi-SP, and Digi Connect WAN): Specifying how the various GPIO pins for the
device will be used.
Alarms: Defining whether alarms should be issued, the conditions that trigger
alarms, and how the alarms should be delivered.
Security configuration: Configuring security features, such as whether
password authentication is required for device users.
System configuration: Specifying system-identifying information, such as a
device description, contact person, and physical location.

Configuration Interfaces
There are several interfaces available for configuring devices, including:

45

Configuring Devices: Overview

The Digi Device Setup Wizard, which helps you set up an IP address for the
device and quickly configure features.
A default web-based interface embedded with the product. This interface also
provides device configuration profiles.
An optional Java applet that can be used for web-based device configuration,
and as a sample application for customization and further application
development.
A Command-Line Interface (CLI).
Connectware Manager, a configuration interface to fine tune or monitor the
Connectware devices. Connectware Manager cannot assign an IP address but it
can change one.
Remote Command-line Interface (RCI) protocol.
Simple Network Management Protocol (SNMP).
Following is more information about each type of interface, the advantages of each
interface, how to access the interface, and where to find more information.
The Digi Device Setup Wizard
A wizard for configuring Connect devices, called the Digi Device Setup Wizard, is
provided on the CD shipped with each device. The Digi Device Setup Wizard is available
in Microsoft Windows or UNIX platforms. Using the Digi Device Setup Wizard is the
recommended and preferred method for configuration. It assigns an IP address for the
device, configures the device based on your description of the device environment, and
determines whether you need to install RealPort.

46

Digi Connect Family User's Guide

Introduction

Advantages
Using the Digi Device Setup Wizard to configure devices provides several advantages:
The Digi Device Setup Wizard is the preferred approach for initial
configuration. For most users, the Digi Device Setup Wizard interface will
provide adequate device configuration.
Device configuration is made easier by providing a set of port profiles which
configure a serial port based on the way the port will be used. Each port profile
displays the relevant settings for the configuration. There are several profile
choices, including RealPort, Console Management, TCP Sockets, UDP
Sockets, Serial Bridging, Modem Emulation, and a Custom profile.
The Digi Device Setup Wizard is intended to be run only once, and is not
installed on a user's PC.
Disadvantages
While the Digi Device Setup Wizard provides for easy configuration, it presents some
disadvantages:
The Digi Device Setup Wizard requires Microsoft Windows for full support,
and the PC running Windows usually needs to be on same network segment as
the Digi device. The Unix version of the Wizard does not include all the
features of the Windows version. The Unix version is limited to network

47

Configuring Devices: Overview

configuration settings, and does not allow you to configure or choose a scenario
through port profiles.
Some sites disallow users from running wizards, which would prevent users at
such sites from using this interface.
While the configuration capabilities of the Digi Device Setup Wizard are
acceptable for most Connect device users, it only provides for the most
common configuration scenarios, and is not as flexible as configuring through
the default web interface Interface or the command line.
How to access the Digi Device Setup Wizard
To access the Digi Device Setup Wizard, insert the Software and Documentation CD that
accompanies your Digi Connect device in a PC's CD drive. The Digi Device Setup
Wizard will automatically start.
Where to find more information
See " Configuration through the Digi Device Setup Wizard " on page 72 for details on
running the wizard. The Digi Device Setup Wizard also has online help, accessed from the
Help button on wizard screens. In addition, the Getting Started Guide for the Digi Connect
Family Integration Kit provides discussions of the various communications models from
which you can choose.
The Default Web Interface
A default web interface is provided as an easy way to configure and monitor Digi Connect
devices. Configurable features are grouped into several categories: Network, Serial Port,
GPIO (for all devices except Digi Connect SP, Digi Connect Wi-SP, and Digi Connect
WAN), Alarms, Security, and System. Most of the configurable features are arranged by
most basic settings on a page, with associated and advanced settings accessible from that
page. As in the Digi Device Setup Wizard, serial-port configurations are classified into port
profiles, or configuration scenarios that allow you to select the scenario that best represents
the environment and set up the appropriate parameters that are needed.
When configuring some features, you may want to establish a basic configuration using
the Digi Device Setup Wizard, and then fine-tune the configuration using the default web
interface.

48

Digi Connect Family User's Guide

Introduction

Digi Connect WAN Configuration and Management

WAN

192.168.2.1

Advantages
Using the default web interface to configure devices provides the following advantages:
Ease of use, including point-and-click functionality and wizards that make
configuration quick and complete.
Secure access to devices.
No need for programming experience.
Port profiles simplify the configuration process.
Disadvantages
You must have Internet access.
This method requires that you configure the IP address before you can access
the configuration from the web interface, however, some features cannot be
configured this way.
Accessing the Default Web Interface
To access the default web interface, enter the Digi Connect device's IP address or host
name in a browser's URL window. The main menu of the web interface is displayed.

49

Configuring Devices: Overview

Where to find more information
For more information, see " Configuration through the Default Web Interface " on page 77.
The default web interface has a tutorial, accessed from the Home page, and online help,
accessed from the Help link on each page. In addition, the Getting Started Guide for the
Digi Connect Family Integration Kit provides discussions of the various communications
models from which you can choose.
Java Applet Interface
An alternative configuration interface is provided with Digi Connect devices, in the form
of a Java applet. This interface provides many, but not all, of the configuration choices
available through the default web interface.
The Java applet is primarily intended as a sample alternative interface for embedded
products. Embedded product manufacturers can use the applet as a base for their custom
user interface. Because the interface is customizable, embedded product manufacturers
can use it to provide a totally unique user interface that represents the kind of device the
Digi Connect device is being embedded into. For example, the configuration interface for
a printer would look nothing like the default web interface. Today, the only way to create a
totally custom interface to the device is through an applet or other Remote Command
Interface (RCI) application. The applet can be slightly modified using a configuration file,
or it can be changed extensively. In addition, it can be used as a sample by those
customers who choose to writer their custom configuration user interface from scratch.

50

Digi Connect Family User's Guide

Introduction

Advantages
Using the Java applet interface to configure devices provides the following advantages:
A completely customizable interface. For example, you can change the look of
the web interface by adding your company logo or changing the colors used in
the interface workspace.
The Java applet can also be used as a basis for further interface development.
That is, if the Java applet is adequate for most of your configuration needs, but
needs some modifications, then you can customize the applet's operation. If
you want a totally unique user interface, you can use the Java applet as a
sample program that illustrates how this can be done. The applet can be used as
a starting point from which to build new interfaces. It illustrates such concepts
as configuring various aspects of the device using the RCI, applet packaging,
and Swing user interface. You can write custom management applications in
other languages that run on a separate system in the network and talk to the
device using RCI. For example, a printer manufacturer might have a

51

Configuring Devices: Overview

configuration utility written in C++ that is installed on the PC along with the
print driver.
Disadvantages
The Java applet requires that the Sun Java Runtime environment be loaded.
The Java applet does not allow for configuration of as many features as the
default web interface.
The Java applet interface is essentially frozen, and will not be updated with
additional configurable features or values in future releases.
There is limited online help for the Java applet configuration screens. If you
need more information on configurable areas, fields, and selectable values, it is
recommended that you familiarize yourself with these areas by reviewing the
online help for the default web interface.
Accessing the Java applet configuration interface
You can access the Java applet interface from the User Interface section of the Home page
of the default web interface. You can either click the Launch button next to the Custom
Interface option to launch the Java applet, or click the Set as Default to set the Java applet
as the default device interface. In some cases, your device's default device interface may
have already been preset to the Java applet by a system administrator.
Where to find more information
See Chapter 2 for more information on using the Java applet to configure devices. While
that chapter primarily focuses on configuring Connect devices from the default web
interface, it also covers configuration from the Java applet, primarily the differences from
the default Web interface. In addition, the Getting Started Guide for the Digi Connect
Family Integration Kit provides discussions of the various communications models from
which you can choose.
For details on customizing the applet, See the Getting Started Guide for the Digi Connect
Family Integration Kit.
The Command-Line Interface
Connect devices can be configured by issuing commands from the command line. The
Command-Line Interface allows communication directly without a graphical interface. For
example, the following is a command issued from the command line to set general serial
configuration options:

52

Digi Connect Family User's Guide

Introduction

set serial baudrate=9600 flowcontrol=hardware

Advantages
Using the command-line interface to configure devices provides the following
advantages:
Flexibility. Although the Command-Line Interface is for experienced users and
considered complex, it allows flexibility for precise configuration alterations.
Direct communication to device or system.
Can be used in UNIX or Linux environments.
Disadvantages
Users must have experience issuing commands.
This interface is not intended for Windows environments.
Command documentation is required.
The command line allows you the greatest flexibility to configure your device,
but is also considered complex.
Accessing the command line
Users access the command line via a Telnet connection or through Hyperterm to set up the
configuration. To access the device, specify the device IP address as the IP address of the
Telnet server. Depending on the serial port profile used for a Digi Connect device, you can
Telnet directly to the device using the telnet command, or perform a remote login using the
rlogin command.
Where to find more information
See the Digi Connect Family Command Reference for command descriptions and
examples of entering configuration commands from the command-line interface. In
addition, online help is available for the commands, through the help and '?' commands.
The Connectware Manager Interface
In the Connectware Manager interface, devices can be managed from the Devices menu.
Tasks such as configuring, rebooting, disconnecting, and redirecting devices are available.
You can also backup/restore device configuration properties, and import or export the
device configuration properties.

The server itself can also be managed from the Server menu of the
Connectware Manager Console. From this menu, you can shut down the
53

Configuring Devices: Overview

server, stop and restart it, and reconfigure the server as needed. You can also
display reports and logs on server activity.
Advantages
Allows multiple devices to be managed (configured and monitored) from one
source.
Server can also be managed from same location.
Logs and reports can be generated and reviewed. Summaries or totals can be
linked back to the original devices for more thorough investigations.
Disadvantages
Devices must be provisioned (assigned an IP address) before they can be
accessed on Connectware Manager (use the Digi Connect Wizard to provision
devices.)
Must have Internet access.
The Remote Command Interface (RCI)
Remote Command Interface (RCI) is a programmatic interface for configuring and
controlling Connect family devices. RCI is an XML-based request/response protocol that
allows a caller to query and modify device configurations, access statistics, reboot the
device, and reset the device to factory defaults.
Unlike other configuration interfaces that are designed for a user, such as the commandline or browser interfaces, RCI is designed to be used by a program. A typical use of RCI
is in a Java applet that can be stored on the Connect device to replace the default web
interface with a custom browser interface. Another example is a custom application
running on a PC that monitors and controls an installation of many Connect devices.
Advantages
As RCI is designed to be used by a program, it is useful when creating a custom
configuration user interface, or if you want to create utilities to configure or
initialize devices through external programs or scripts.
Disadvantages
Using RCI as a device configuration interface presents these disadvantages:

54

Digi Connect Family User's Guide

Introduction

RCI uses HTTP as the underlying transport protocol. Depending on the
network configuration, use of HTTP as a transport protocol could be blocked
by some firewalls.
RCI is quite complex to use, requiring users to phrase configuration requests in
Extensible Markup Language (XML) format. It is a " power-user" option,
intended more for users developing their own user interfaces, or for users
implementing embedded control (and thus potentially using RCI over serial)
than for end-users with limited knowledge of device programming.
Not all actions taken through the default web interface have direct equivalents
in RCI. Therefore, it may not be easy for some end-users to determine what
needs to be sent via XML for a particular style of request.
Accessing the Remote Command Interface
RCI access consists of program calls.
Where to find more information
See the Digi Connect Integration Kit for more details on RCI.
Simple Network Management Protocol (SNMP)
Simple Network Management Protocol (SNMP) is a protocol for managing and
monitoring network devices. The SNMP architecture enables a network administrator to
manage nodes--servers, workstations, routers, switches, hubs, etc.--on an IP network;
manage network performance, find and solve network problems, and plan for network
growth. Digi devices support SNMP Version 1.
Advantages
SNMP is easy to implement in extensive networks.
Programming new variables is easy.
SNMP is widely used. SNMP is a standard interface that integrates well with
network management stations in an enterprise environment. While its
capabilities are limited to device monitoring and display of statistics in Connect
devices, read/write capabilities are expected to be added to Connect devices in
future releases.
It is easy to 'drop in' new devices.

55

Configuring Devices: Overview

Disadvantages
As device communication is UDP-based, the communication is not secure. If
you require more secure communications with a device, you will need to use an
alternate interface.
Using SNMP, you cannot do as many tasks as you can from the default web
interface, such as file management, uploading firmware, or backing up/
restoring configurations.
Compared to the default web interface or the command-line interface, SNMP is
limited in its ability to set specific parameters, such as set port profile, is not
possible.
Accessing the SNMP Interface
Accessing the SNMP interface requires a tool, such as a network management station. The
management station relies on an agent at a device to retrieve or update the information at
the device, including Device configuration, status, and statistical information. This
information is viewed as a logical database, called a Management Information Base
(MIB). MIB modules describe MIB variables for a variety of device types and computer
hardware and software components.
The MIB for managing a TCP/IP network, called MIB-II, is an update on the original
MIB, now called MIB-I. MIB-II contains variable definitions that describe the most basic
information needed to manage a TCP/IP network. These variable definitions are organized
into several groups, such as groups for managing the system, network interfaces, address
translation, transmission media, and various protocols, including IP, ICMP, TCP, UDP,
EGP, and SNMP.
In addition to the standard MIBs, Digi Connect devices use several Digi enterprise MIBs,
including MIB DIGI-DEVICE-INFO.mib for handling device information, and
DIGI-SERIAL-ALARM-TRAPS.mib for handling alarms sent as SNMP traps.
Where to find more information
A variety of resources about SNMP are available, including reference books, and
overviews and other files on the Internet. For an overview of the SNMP interface and the
components of MIB-II, point your Internet browser to the address www.rfceditor.org, and
enter "MIB-II." From the results, you can display a text file describing the SNMP
interface, titled "Management Information Base for Network Management of TCP/IPbased internets: MIB-II." You can also view the text of the Digi enterprise MIBs.

56

Digi Connect Family User's Guide

Introduction

For additional discussion of using SNMP as a device monitoring interface, see
" Monitoring Capabilities from SNMP " on page 115.

Monitoring Devices: Overview
Following is an overview of the capabilities and interfaces for monitoring Digi Connect
devices. Chapter 3, " Monitoring Digi Connect Devices " covers these capabilities and
interfaces in more detail.

Monitoring Capabilities
Monitoring Digi Connect devices includes such tasks as checking device status, viewing
information on a device's GPIO pins, checking runtime state, viewing serial port
operations, and reviewing network statistics.

M onitoring Interfaces
As with device configuration, there are several interfaces available for configuring
devices, including:
The default web interface embedded with the product
The optional Java applet
SNMP
The Command-Line Interface
Connectware Manager
Following is more information about each type of interface, the advantages of each
interface, how to access the interfaces, and where to find more information.
Default Web and Java Applet Interfaces
The default web interface provides several screens for monitoring devices, including:
Serial Port Management: for each port, the port's description, current profile,
and current serial configuration.
Connections Management: A display of all active system connections.
57

Administering Devices: Overview

System Information:
-

General device information

-

Current GPIO pin states

-

Serial port information: for each port, the port's description, current profile, and
current serial configuration. This is the same information displayed by
choosing Serial Port Management.

-

Network statistics: statistics for IP, TCP, UDP, and ICMP

SNMP
The monitoring capabilities of SNMP include managing network performance, gathering
device statistics, and finding and solving network problems. For more information on
using SNMP for device-monitoring purposes, see " Monitoring Capabilities from SNMP "
on page 115.
Command-Line Interface
Several commands that can be issued from the command line to monitor devices. For a
review of these commands and what they can provide from a device-monitoring
perspective, see " Monitoring Devices from the Command Line " on page 116.
Connectware Manager
The monitoring capabilities can be sorted by the server and the devices managed by the
server. The information is available in logs and can be generated into reports. When
available, the reports post linked totals that can be drilled back to the original devices that
make up the activity of the report.

Administering Devices: Overview
Periodically, you will need to perform administrative tasks on Digi Connect devices, such
as:
Uploading and managing files
Changing the password for logging onto the device
Backing up and restoring the configuration
58

Digi Connect Family User's Guide

Introduction

Updating firmware
Restoring the configuration to factory defaults
Rebooting the module
Chapter 4, " Administering Digi Connect Devices " covers device administration in more
detail.

RF Exposure Statement
Digi Connect Wi-SP, Digi Connect Wi-EM, and Digi Connect Wi-ME
The Digi Connect Wi-EM and Wi-ME embedded modules comply with the RF exposure
limits for humans as called out in RSS-102.
These devices are exempt from RF evaluation based on its operating frequency of 2400
MHz, and effective radiated power of 100 milliwatts. This would be less than the 3 watt
requirement for a mobile device ( & gt; 20 cm separation) operating at 2400 MHz.
Digi Connect WAN and Digi Connect RG
In order to comply with RF exposure limits established in the ANSI C95.1 standards, the
distance between the antenna(s) and the user should not be less than 20 cm.

FCC Certifications for Digi Connect ES and Digi Connect RG
For FCC certification for other Digi Connect devices, see the Hardware Reference.

FCC Part 15 Class A
These devices comply with part 15 of the FCC rules. Operation is subject to the following
two conditions: (1) These devices may not cause harmful interference, and (2) These
devices must accept any interference received, including interference that may cause
harmful operation.

59

FCC Certifications for Digi Connect ES and Digi Connect RG

Radio Frequency Interference (RFI) (FCC 15.105)
This equipment has been tested and found to comply with the limits for Class A digital
devices pursuant to Part 15 of the FCC Rules. These limits are designed to provide
reasonable protection against harmful interference in a residential environment. This
equipment generates, uses, and can radiate radio frequency energy, and if not installed and
used in accordance with the instruction manual, may cause harmful interference to radio
communications. However, there is no guarantee that interference will not occur in a
particular installation. If this equipment does cause harmful interference to radio or
television reception, which can be determined by turning the equipment off and on, the user
is encouraged to try and correct the interference by one or more of the following measures:
Reorient or relocate the receiving antenna.
Increase the separation between the equipment and the receiver.
Connect the equipment into an outlet on a circuit different from that to which
the receiver is connected.
Consult the dealer or an experienced radio/TV technician for help.

Labeling Requirements (FCC 15.19)
This device complies with Part 15 of FCC rules. Operation is subject to the following two
conditions: (1) this device may not cause harmful interference, and (2) this device must
accept any interference received, including interference that may cause undesired
operation.

M odifications (FCC 15.21)
Changes or modifications to this equipment not expressly approved by Digi may void the
user's authority to operate this equipment.

C ables (FCC 15.27)
Shielded cables must be used to remain within the Class A limitations.

60

Digi Connect Family User's Guide

Introduction

Industry Canada
This digital apparatus does not exceed the Class B limits for radio noise emissions from
digital apparatus set out in the Radio Interference Regulations of the Canadian Department
of Communications.
Le present appareil numerique n'emet pas de bruits radioelectriques depassant les limites
applicables aux appareils numeriques de la class B prescrites dans le Reglement sur le
brouillage radioelectrique edicte par le ministere des Communications du Canada.

International EMC Standards
:
Electromagnetic Emissions Standards
Digi Connect RG

Digi Connect ES

EN55022

EN55022

EN55024

EN55024

VCCI

EN60601-1-2
IEC/UL/EN 60601-1
EN55011

AS 3548

AS/NZS 3548
AS/NZS CISPR -22
CAN/CSA 22.2 60950-1-3
ICES-003
IEC/UL/EN 60950-1

Safety Standards
There are no user serviceable parts inside the Digi Connect ES. Contact your Digi
representative through " Digi Contact Information " on page 12 for repair information.

61

Important Safety Information

Safety Standards
Digi Connect RG

Digi Connect ES

UL 60950

UL 60950-1

CSA 22.2 No. 60950

CSA 22.2 No. 60950
EN60950

EN60950

IEC/EN 60601-1
UL/CUL 60601-1

Important Safety Information
To avoid contact with electrical current:
Never install electrical wiring during an electrical storm.
Never install an Ethernet connection in wet locations unless that connector is
specifically designed for wet locations.
Use caution when installing or modifying Ethernet lines.
Use a screwdriver and other tools with insulated handles.
You and those around you should wear safety glasses or goggles.
Do not place Ethernet wiring or connections in any conduit, outlet or junction
box containing electrical wiring.
Installation of inside wire may bring you close to electrical wire, conduit,
terminals and other electrical facilities. Extreme caution must be used to avoid
electrical shock from such facilities. You must avoid contact with all such
facilities.
Ethernet wiring must be at least 6 feet from bare power wiring or lightning rods
and associated wires, and at least 6 inches from other wire (antenna wires,
doorbell wires, wires from transformers to neon signs), steam or hot water
pipes, and heating ducts.

62

Digi Connect Family User's Guide

Introduction

Do not place an Ethernet connection where it would allow a person to use an
Ethernet device while in a bathtub, shower, swimming pool, or similar
hazardous location.
Protectors and grounding wire placed by the service provider must not be
connected to, removed, or modified by the customer.
Do not touch uninsulated Ethernet wiring if lightning is likely!
External Wiring: Any external communications wiring you may install needs to
be constructed to all relevant electrical codes. In the United States this is the
National Electrical Code Article 800. Contact a licensed electrician for details.
Do not touch or move the antenna(s) while the unit is transmitting or receiving.
Do not hold any component containing a radio such that the antenna is very
close to or touching any exposed parts of the body, especially the face or eyes,
while transmitting.
Do not operate a portable transmitter near unshielded blasting caps or in an
explosive environment unless it is a type especially qualified for such use.
Antenna use:
-

Warning for laptop users: In order to comply with the FCC RF exposure limits,
it is recommended when using a laptop with a PC client adapter, that the
adapter's integrated antenna should not be positioned closer than 2 inches (5
cm) from your body or nearby persons for extended periods of time while it is
transmitting (or operating). If the antenna is positioned less than 2 inches (5
cm) from the user, it is recommended that the user limit exposure time.

D igi Connect ES Specifications
Environmental
Ambient Temperature - 0o - 55oC (32o to 130o F)
Relative Humidty - 5 to 95% (non-condensing)
Storage and Transport Temperature - 30o to 85o C (-122o to 185o F)
Altitude - 3657.6 meters (12000 feet)
Serial Port Protection (ESD): +15 kV human body model
63

Digi Connect ES Specifications

Power Requirements
Internal 100-240V
Input frequency 50-60 Hz
Input current protection - 2.0 A / 250 V(Time Lag) rated fuse
UL certified
Surge protection
4 kV burst (EFT) per EN61000-4-4
4 kV isolation input to output
2 kV surge per EN61000-4-5
Mechanical
Length - 23.5 cm (9.3 in)
Width - 26.9 cm (10.6 in)
Depth - 4.2 cm (2.1 in)

64

Digi Connect Family User's Guide

Configuring the Digi
Connect Devices
C

H

A

P

T

E

R

2

This chapter describes how to configure Digi Connect devices. It covers the following
topics:
Alternative configuration options for the Digi Connect Wi-SP
Assign an IP address to the device, using one of the several alternative methods
-

Configuration through the Digi Device Setup Wizard

-

Configuration through the default web interface

-

Configuration through the Java applet

-

Configuration through the Command-Line Interface

-

Customization through the Connectware Manager interface

The primary focus of this chapter is on configuring devices through the default web
interface. Configuration through the Java applet interface is mentioned, but not at the
same level as the default web interface. Connectware Manager interface cannot set the IP.
To use Connectware Manager you must set up the Digi device with the Digi Device Setup
Wizard and then install Connectware Manager. For more information, see the
Connectware Manager User's Guide.
Alternative Configuration Options for Digi Connect Wi-SP
If you prefer to configure the Digi Connect Wi-SP with a serial connection, you have
several alternative options.

65

Configure with an Access Point - Infrastructure Mode
1

Configure your network using an access point with the SSID - Connect and all
encryption disabled (such as WEP & WPA).

2

Power up the device.

3

Launch the Discovery program and proceed with the configuration.

Configure without an Access Point - Laptop with a Wireless Card Ad-Hoc Mode
1

Configure the wireless card to operate in Ad-Hoc mode with the SSID - Connect.

2

Power up the device.

3

Launch the Discovery application on the laptop and proceed with the configuration.

Command Line Access
1

Connect the Digi Connect Wi-SP to a PC with a serial cable.

2

Set the Digi Connect Wi-SP DIP switches in the On or up position.
ON

12 34
DIP Switch settings for Command Line access
for both the Digi Connect Wi-SP and the Digi Connect SP.

3

Access a terminal emulation program such as HyperTerm
Start & gt; Accessories & gt; Communication & gt; Hyperterm and enter a name for
the connection.

4

Select COM1 and click OK

5

Set the port settings to 9600, 8, None, 1, None (default settings) click Apply then
OK.

6

Enter the login username - root
and the default password -dbps

7

66

Go to the Digi Connect Family Command Reference on the enclosed CD for the
command descriptions. See the set wlan command for all parameters.

Digi Connect Family User's Guide

Configuring the Digi Connect Devices

67

login: root
password: dbps
# & gt;

8

After you have configured the Digi Connect Wi-SP parameters to function within
your network, disconnect the power supply and the serial cable from your Digi
Connect Wi-SP

9

Reset your DIP switch settings according to your serial device requirements (EIA232/422/485).

EIA-232

Switch
Settings

EIA-485
EIA-422/485
Full-Duplex Half-Duplex

Up/On

*

Down/Off

DB-9
Pinouts

1
2
3
4
5
6
7
8
9
Shell

DCD
RxD
TxD
DTR
GND
DSR
RTS
CTS
RI
GND

CTSRxD+
TxD+
RTSGND
RxDRTS+
CTS+
TxD-

*
*
Not Used
RxD+
TxD+
Not Used
GND
RxDNot Used
Not Used
TxD-

*If switch 4 is up, termination resistor connected
If down, termination resistor not connected.

10

Connect the antenna and the power supply to the Digi Connect Wi-SP.

11

Insert the Software & Documentation CD and follow the wizard to discover and the
configure your Digi Connect Wi-SP for your network.

Note You may also use the Digi support site http://www.digi.com/support/ for

additional command resources.

68

Digi Connect Family User's Guide

Configuring the Digi Connect Devices

Assign an IP Address to the Device
There are several ways to assign an IP address to a device:
Using the Digi Device Setup Wizard.
Using Dynamic Host Configuration Protocol (DHCP) from the default web
interface (only for changing the IP address once it has been assigned).
Using the Command-Line Interface.
Using Automatic Private IP Addressing (APIPA), also known as Auto-IP.

Configuring the IP Address Using the Digi Device Setup Wizard
Using the Digi Device Setup Wizard is the preferred method of assigning an IP address
and initially configuring your Digi Connect device. The Digi Device Setup Wizard is
supplied on the CD that accompanies your Digi Connect device.
The Digi Device Setup Wizard "discovers" the device, and then provides a method for
assigning an IP address as well as configuring your device for your needs. It can be used
in conjunction with the web interface to 'tweak' the specific environment. Setup is
specially designed for the Windows environments, and is quick, automated, and complete.
P rerequisites
This procedure assumes the following:
The device server is connected to the network and powered up.
The CD will be used on a system running Microsoft Windows operating system
or a Unix operating system.
That you have located the device server's MAC address, located on the label on
the bottom of the product, and recorded it for later use in assigning an IP
address.
Procedure
1

Insert the Digi CD in the CD drive.

2

If the CD does not start automatically, double-click My Computer & gt; CD ROM
Drive & gt; setup.exe

69

Assign an IP Address to the Device

3

The Digi Device Setup Wizard will automatically pop up. Select your platform and
click Next.
The Digi application finds and lists all of the Digi devices on your network.

4

Locate your device server by its MAC address.

5

Select the device server and then click Next.

Follow the instructions in the wizard to configure your Digi Connect device. Use the
online help supplied with the wizard if you need more information about values the
wizard prompts you to supply and select.

Configuring the IP Address Using DHCP
Using DHCP from the default web interface to configure an IP address works only for
changing the IP address of a device server that has already been assigned an IP address.
However, once an IP address is assigned, any configuration changes can be made from the
Web interface.
P rerequisite
This procedure assumes the following:
That the device server is configured as a DHCP client. Since this is the default
configuration, this will be the case unless the configuration has been changed.
That the device server is not powered on
Procedure
1

Set up a permanent entry for the device server on a DHCP server.

2

Connect the device server to the network and power it on. The IP address
configured in step 1 is assigned automatically.

C onfiguring the IP Address using Auto-IP
The standard protocol Automatic Private IP Addressing (APIPA or Auto-IP) assigns the
IP address from the reserved IP addresses in Auto-IP. Use ADDP or DHCP to find the
device and assign it a new IP address that is compatible with your network. Once the unit
is plugged in, Auto-IP automatically assigns the IP address.

70

Digi Connect Family User's Guide

Configuring the Digi Connect Devices

Configuring the IP Address from the Command-Line Interface
The set network command is used to configure an IP address from the command line. To
configure the Digi Connect SP through the command line, the DIP switches must be
changed. See " Command Line Access " on page 66 for an illustration of the DIP switch
settings. On the set network command, include the following parameters:
ip=device ip: The IP address for the device.
gateway=gateway: The network gateway IP address.
submask=device submask: The device submask.
dhcp=off: Turns off use of the Dynamic Host Configuration Protocol (DHCP),
so that the IP address assigned is permanent.
static=on: Specifies that the IP address is static, and will remain as the specified
IP address, gateway, and submask.
For example:
set network ip=10.0.0.1 gateway=255.255.255.0
submask=255.255.255.0 dhcp=off static=on

C onnectware Manager
The IP address cannot be set in Connectware Manager but it can be changed.
Open the browser based on the IP address the device has and go to Configuration & gt;
Network & gt; IP Settings and enter the new IP address, subnet mask, and gateway.

Testing the IP Address Configuration
Once the IP address is assigned, you should test the IP address configuration to be sure it
works as configured.
P rerequisite
This procedure assumes that you have configured the device server with an IP address.
Procedure
1

Access the command line of a PC or other networked device.

2

Issue the following command:

71

Configuration through the Digi Device Setup Wizard

ping ip-address

where ip-address is the address you assigned to the device server.
Example
ping 192.168.2.2

A reply should be returned.

Configuration through the Digi Device Setup Wizard
The Digi Device Setup Wizard helps you configure the device according to one of several
port profiles, or configuration scenarios that characterize the manner in which the device
will be used.

U sing Port Profiles to Configure Devices
The Digi Device Setup Wizard allows you to configure a serial port based on the way the
port will be used. Each port profile displays the relevant settings for the configuration.
There are several port profile choices for the Connect Family but if you see a profile listed
that is not available in your brower, it means your device does not support the feature. The
profiles are described in more detail on the following pages:
RealPort: Allows you to map a COM or TTY port to the serial port. (Not
supported in Digi Connect WAN)
Console Management: Allows you to access a device's console port over a
network connection.
TCP Sockets: Allows a serial device to communicate over a TCP network.
UDP Sockets: Allows a serial device to communicate using UDP.(Not
supported in Digi Connect WAN)
Serial Bridge: Configures one side of a serial bridge. A bridge connects two
serial devices over the network, as if they were connected with a serial cable.
Modem Emulation: Allows you to configure the serial port to act as a modem.
(Not supported in Digi Connect WAN.)

72

Digi Connect Family User's Guide

Configuring the Digi Connect Devices

Custom: An advanced option to allow full configuration of the serial port. This
profile allows you to view all settings associated with the serial port.

RealPort Profile
The RealPort Profile allows you to configure your device to create a virtual COM port on
your PC, known as COM Port Redirection. (Not supported in Digi Connect WAN.) The
PC applications send data to this virtual COM port and RealPort sends the data across the
network to the Digi device server. The data is routed to the serial device connected to the
Digi device server's serial port. The network is transparent to both the application and the
serial device (not supported in Digi Connect WAN).
RealPort software (from the Software and Documentation CD) must be
installed and configured on each PC that will use RealPort ports. Enter the IP
address of the Digi device server and the RealPort TCP port number 771.

C onsole Management Profile
The Console Management Profile allows access to a device's console port over a network
connection. Most network devices such as routers, switches, and servers offer serial
port(s) for management. Instead of connecting a terminal to the console port, cable the
console port to the serial port of your Digi device. Then using Telnet features, network
administrators can access these consoled serial ports from the LAN by addressing the
appropriate TCP port.

73

Configuration through the Digi Device Setup Wizard

TCP Sockets Profile
The TCP Sockets profile allows serial devices to communicate over a TCP network. The
TCP Server allows other network devices to initiate a TCP connection to the serial device
attached to the serial port of the Digi device server. The TCP Client allows the Digi device
server to automatically establish a TCP connection to an application or a network.

RFC 2217 Support
Digi Connect devices -except Digi Connect WAN support RFC 2217, an extension of the
Telnet protocol used to access serial devices over the network. RFC 2217 implementations
enable applications to set the parameters of remote serial ports (baud rate, flow control,
etc.), detect line signal changes, as well as receive and transmit data. The configuration
information provided in this section applies to Digi Connect devices functioning as RFC
2217 servers.
If using the RFC 2217 protocol, do not modify the port settings from the defaults. If you
have altered the device server, restore the factory default settings (see " Restore Device
Configuration to Factory Defaults " on page 127). No additional configuration is required.

U DP Sockets Profile
The UDP Sockets profile allows serial devices to communicate using UDP. (Not
supported in the Digi Connect WAN.) The UDP Server configuration allows the serial
port to receive data from one or more systems or devices on the network. The UDP Client
configuration allows the automatic distribution of serial data from one host to many
devices at the same time using UDP sockets.

74

Digi Connect Family User's Guide

Configuring the Digi Connect Devices

About TCP and UDP Port Numbers
Digi Connect devices use the following default TCP and UDP port numbering
conventions described in the following table:
For this connection type...

Use this Port

Telnet to the serial port

2001 (TCP only)

Raw connection to the serial port

2101(TCP and UDP)

You must ensure that the application or device that initiates communication with the Digi
Connect device uses these ports. If they cannot be configured to use these ports, you can
change the individual network port on the Digi Connect device, which allows you to use
different port numbers to designate a Telnet or raw connection to the serial port.

S erial Bridge Profile
The Serial Bridge profile allows users to create a serial bridge. A serial bridge is a network
connection between two serial devices, each of which uses a Digi Connect device. The
serial devices "think" they are communicating with each other across a serial cable using
serial communication techniques. There is no need to reconfigure the server or the serial
device. Neither is aware of the intervening network.
This profile configures each side of the bridge separately. Repeat the configuration for the
second Digi device server of the bridge specifying the IP address of the first Digi device
server.

75

Configuration through the Digi Device Setup Wizard

Modem Emulation Profile
The Modem Emulation profile allows the Digi Connect family (except Digi Connect
WAN) to emulate a modem. It sends and receives modem responses to the serial device
over the Ethernet instead of PSTN (Public Switched Telephone Network). This profile
allows you maintain your current software application but use it over the less expensive
Ethernet network.

The commands that can be issued in a modem-emulation configuration are described in
the Digi Connect Family Command Reference.

Custom Profile
This profile allows you to see all serial-port settings and set them accordingly. Use this
profile only if your application does not fit into any of the predefined port profiles. For
example, if your network connections will involve a mix of TCP and UDP sockets, you
would need to select the Custom Profile.

76

Digi Connect Family User's Guide

Configuring the Digi Connect Devices

To Further Configure the Digi Connect Device
Once a Digi Connect device is configured through the Digi Device Setup Wizard, if any
configuration values need to be viewed or changed, you can use one of the other device
interfaces to view and change the configuration, such as the default web interface, Java
applet interface, or Command-Line Interface. See " Configuration through the Default
Web Interface " on page 77, " Configuration through the Java Applet Interface " on page 98,
and " Configuration Through the Command Line " on page 104 for more information.

Configuration through the Default Web Interface
This section describes using the default web interface to configure your Digi Connect
device. The interface is recommended for use if the Digi Device Setup Wizard is
unavailable, if your application requires specific alterations not accessible on the Wizard,
or if you wish to modify the device configuration from the values that were setup through
the Digi Device Setup Wizard.
Configuring Connect devices through the default web interface involves these tasks:
Change the IP address, (must be configured. See page 82.
Configure network communications. See page 83
Configure mobile settings See " Configure Mobile Settings " on page 85.
Configure the serial ports. See page 85.
Configure GPIO pins (except Digi Connect SP, Digi Connect Wi-SP, and Digi
Connect WAN). See page 90.
Configure alarms. See page 93.
Configure security features. See page 96.
Configure system settings. See page 97.
Configure remote management. See " Configure Remote Management " on page
96
At any point in the configuration process, if you need to restore the device configuration
to factory defaults at any point in the configuration process, see " Restore Device
Configuration to Factory Defaults " on page 122.

77

Configuration through the Default Web Interface

Open the Web Interface
To open the default web interface, you can either:
Enter the Digi Connect device's URL in a Web browser and log on to the
device, if required.
Use the Digi Device Discovery utility to locate the device and open the Web
interface.
By Entering the Device's URL in a Web Browser
1

In the URL address bar of a Web browser, enter the IP address of the device.

2

If security has been enabled for the device, a login dialog will be displayed. Enter
the user name and password for the device. If you do not know the user name and
password for the device, contact the system administrator who initially set up the
device.

.

3

After you log on, the Home page of the default web interface is displayed. See
" Organization of the Web Interface " on page 80 for an overview of using the Home
page and other linked pages.
Note The idle timeout will automatically log the user out of the device after 5

minutes.
By Using the Digi Device Discovery Utility
Alternatively, you can use the Digi Device Discovery Utility to locate your Digi Connect
device and open the default web interface.
1
2

Locate the device in the list of devices, and double-click it, or select the device
from the list and select Open web interface in the Device Tasks list.

3

78

From the start menu, select Start & gt; Programs & gt; Digi Connect & gt; Digi Device
Discovery. The Digi Device Discovery utility is displayed.

Depending on whether a system administrator has configured password
authentication for the device, you may need to log on to the device. If a login dialog
is displayed, enter the user name and password for the device. If you do not know
the user name and password for the device, contact the system administrator who
initially set up the device.

Digi Connect Family User's Guide

Configuring the Digi Connect Devices

Now you can configure the device, as described on the following pages.

79

Configuration through the Default Web Interface

Organization of the Web Interface
When you open the default web interface, the Home page is displayed.

T he Home Page
The Home page of the default web interface displays the following:
On the left is a menu of choices that display pages for configuration,
management, and administration tasks, and to log out of the default web
interface. This chapter focuses on the choices under Configuration. For details
on using the choices under Management and Administration, see Chapter 3,
" Monitoring Digi Connect Devices " and Chapter 4, " Administering Digi
Connect Devices " .
Clicking Logout logs you out of a configuration and management session with
a Digi Connect device. It does not close the browser window, but takes you to a
logout window. To finish logging out of the default web interface and prevent
access by other users, you must close the browser window. Or, you can log
back on to the device by clicking the link on the screen. After 5 minutes, the
idle timeout will also automatically log you out.

80

Digi Connect Family User's Guide

Configuring the Digi Connect Devices

The Getting Started section provides a link to a tutorial on configuration and
management of your Digi Connect device.
The System Summary section notes all available device-description
information.
Configuration Pages
The choices under Configuration in the menu display pages for configuring various
features, including:
Network: For configuring network communications. See " Configure Network
Communications " on page 83.
Mobile Settings: For configuring mobile settings. See " Configure Mobile
Settings " on page 85
Serial Ports: For configuring serial ports. See " Configure Serial Ports " on page
85.
GPIO: For configuring the GPIO pins. See " Configure GPIO Pins " on page 90.
Not supported in Digi Connect SP, Digi Connect Wi-SP, and Digi Connect
WAN.
Alarms: for configuring alarms. See " Configure Alarms " on page 93
Security: For configuring security features. See " Configure Security Features "
on page 96.
System: For configuring system-identifying information and SNMP. See
" Configure System Settings " on page 97.
Some of the configuration pages organize the configuration settings on different sets of
linked screens. For example, the Network Configuration screen initially displays the IP
Settings, and provides links to the Network Services Settings and Advanced Settings.
Applying and Saving Changes
The default web interface runs locally on the device, which means that the interface
always maintains and displays the latest settings in the device.
On each screen, the Apply button is used to save any changes to the configuration settings
to the device.

81

Configuration through the Default Web Interface

Canceling Changes
To cancel changes you have made on a configuration change, click the Refresh or Reload
button on the Web browser. This will cause the browser to reload the page. Any changes
made since the last time you clicked the Apply button are reset.
Online Help
Online help is available for all screens of the default web interface, and for common
configuration and administration tasks. If you are new to device configuration, you might
also want to review the tutorial that is available on the Home page.

Change the IP Address, As Needed
Normally, IP address assignment is done through the Setup Wizard, and is the
recommended method. However, some organizations will not allow users to run wizards.
If you are unable to run the Setup Wizard, then you must assign an IP address to the
device using one of the alternative methods.
Changing an IP Address from a Web Browser
Prerequisite

This procedure assumes that the device server already has an IP address and you simply
want to change it.
Procedure
1
2

If security is enabled for the device, a login prompt is displayed. Enter the user
name and password for the device. If you do not know the user name and password,
contact the system administrator who initially set up the device.

3

Click Network to access the Network Configuration page.

4

On the IP Settings page, select "Use the following IP address."

5

82

Open a web browser and enter the device server's current IP address in the URL
address bar.

Enter an IP address (and other network-related parameters) and then click Apply to
save the configuration.

Digi Connect Family User's Guide

Configuring the Digi Connect Devices

Configure Network Communications
The Network configuration pages include the following:
IP Settings: Allow you to change the IP address.
Network Services: Allow you to enable and disable access to various network
services, such as ADDP, RealPort and Encrypted RealPort (not supported in
Digi Connect WAN), Telnet, HTTP/HTTPS, and other services.
Advanced Network Settings allow you alter the Ethernet Interface speed and
mode, TCP/IP settings, TCP keepalive settings, or DHCP settings.
A lternatives for Configuring Network Communications
There are three ways a Digi device server can be configured on the network.
Using dynamic settings: All network settings will be assigned automatically by
the network, using a protocol called DHCP. Contact your network administrator
to find out if a DHCP server is available.
Using static settings: All network settings are set manually and will not change.
The IP address and Subnet Mask are mandatory. The rest are not mandatory,
but may be needed for some functions. Contact your network administrator for
the values you need.
Using Auto-IP: Auto-IP will assign your device an IP address immediately
after it is plugged in. If you are running DHCP or ADDP, the Auto-IP address
will be overridden and a network compatible IP address will be assigned or you
can assign the device a static IP address.
Additional Considerations
Even if a DHCP server is available, your configuration may work better with static
settings. Once set, static settings will not change, so you and other network devices can
always find the Digi device server by the IP address. With dynamic settings, the DHCP
server can change the IP address. This can happen frequently or infrequently depending
on how it has been configured by your network administrator.
When the IP address does change, you and other network devices configured to talk to it
will no longer be able to. You will then need to find the Digi device server again using the
setup wizard on your CD. You must also reconfigure other network devices that wish to
talk to this Digi device server.

83

Configuration through the Default Web Interface

View and Change IP Settings, as Needed
The IP Settings page shows how the device's IP address is obtained, either by DHCP or by
using a static IP address, subnet mask, and default gateway. If you do not know what these
settings mean, or when you may be asked to supply these values for a device, contact your
network administrator. In addition, you can see the online help for the page for
descriptions of these settings.
E nable or Disable Network Services
The Network Services page shows a set of common network services that are available for
devices, and the port on which the service is running.
You can enable or disable several common network services and configure the TCP port
they listen on. Disabling services may be done for security purposes. That is, you can
disable certain services so that a device is running only those services specifically needed
by the device. As needed, you can also disable any non-secure services, such as Telnet.
Network Services that Can Be Enabled or Disabled

Following are the network services which can be enabled or disabled:
ADDP: This service controls use of Advanced Digi Device Discovery Protocol.
If it is disabled, you can no longer use the Digi Device Setup Wizard, or Digi
Device Discovery utility to locate the device.
HTTP & HTTPS: These services control the use of the Web interface. If you
disable them, device users cannot use the default web interface or Java applet to
configure, monitor, and administer the device.
RealPort or Encrypted RealPort: (Not supported in Digi Connect WAN) These
services control use of COM port redirection. If disabled, COM port redirection
cannot be used for the device.
Rlogin: (Not supported in Digi Connect WAN) Enables or disables the remote
login (rlogin) service. If disabled, users cannot perform a remote login to the
device.
Rsh: (Not supported in Digi Connect WAN) Enables or disables the remote
shell (rsh) service.
SNMP: Enables or disables the use of SNMP. If disabled, SNMP services such
as traps and device information are not used.

84

Digi Connect Family User's Guide

Configuring the Digi Connect Devices

Telnet: Enables or disables the Telnet service. If disabled, users cannot Telnet to
the to the device.
Port Numbers for Network Services

For each network service, the Port field shows the port on which the service is running.It
is usually best to use the default TCP port numbers for these services because they are
well known by most applications.
C onfigure Advanced Network Settings
The Advanced Network Settings are used to further define the network interface,
including:
Whether Auto-IP address assignment is enabled or disabled.
The Ethernet Interface speed and duplex mode (Auto, Half-Duplex, or Full
Duplex).
For wireless products only, there is an advanced network setting of maximum
transmission rate.

Configure Mobile Settings
The Mobile Settings identify the provider, service plan, and connection settings to connect
to the mobile network.
The Service plan can be proxy, public, internet, or custom
Connection settings can be set up for both continuous sending and receiving
data.

Configure Serial Ports
Use the Serial Port Configuration page to establish a port profile for the Connect device's
serial port. The Serial Port Configuration page includes the following information:
The currently selected port profile for the serial port.
Detailed configuration settings for the serial port, dependent on the port profile
selected.
Links to Basic Serial Settings and Advanced Serial Settings.

85

Configuration through the Default Web Interface

Port Profiles
Port profiles allow you to easily configure serial ports by displaying only those items that
are relevant to the currently selected profile. The port profiles you can select include the
following. If you used the Digi Device Setup Wizard to initially configure your device,
you were prompted to select a port profile. These port profiles are described in more detail
on " Using Port Profiles to Configure Devices " on page 72, and are as follows: RealPort
Profile: Allows you to map a COM or TTY port to the serial port. (Not supported in Digi
Connect WAN)
Console Management Profile: Allows access to a device's console port over a
network connection.
TCP Sockets: Allows a serial device to communicate over a TCP network.
UDP Sockets: Allows a serial device to communicate using UDP.
Serial Bridge: Configures one side of a serial bridge. A bridge connects two
serial devices over the network, as if they were connected with a serial cable.
Modem Emulation: Allows you to configure the serial port to act as a modem.
(Not supported in Digi Connect WAN)
Custom: An advanced option to allow full configuration of the serial port. This
profile allows you to view all settings associated with the serial port.
If a port profile has already been selected for the Digi Connect device, for example, if it
has already had an initial configuration set through the Digi Device Setup Wizard, the
currently selected port profile is shown at the top of the screen. You can change the port
profile to another one, or keep the profile but adjust individual settings.
Everything on the Serial Port Configuration screen between the Port Profile Settings and
the links to the Basic and Advanced Serial Settings is dependent on the port profile
selected.Selecting a port profile displays the relevant information for your profile.
S electing and Configuring a Port Profile
1
2

Click the port to be configured.

3

Click Change Profile.

4

86

To configure any profile select Serial Ports.

Select the appropriate profile and Click Apply.

Digi Connect Family User's Guide

Configuring the Digi Connect Devices

5

Enter the appropriate parameters for each profile. Refer to the online help for the
configuration screens for more details about settings and values. Click Apply to
save the settings.

C onfigure Basic Serial Settings
After you select your port profile, the profile settings will appear. Click the appropriate
features for your environment. The following information is a brief description of the
fields within the Basic Serial Settings. See the online help for detailed information about
each setting.
Description -Specifies an optional character string for the port which can be
used to identify the device connected to the port.
Basic Serial Settings include Baud Rate, Data Bits, Parity, Stop Bits, and Flow
Control. The basic serial port settings must match the serial settings of the
connected device. If you do not know these settings, consult the documentation
that came with your serial device. These serial settings may be documented as
9600 8N1, which means that the device is using a baud rate of 9600 bits per
second, 8 data bits, no parity, and 1 stop bit.
When using RealPort (COM port redirection) or RFC 2217, these settings are
supplied by applications running on the PC or server, and the default values on
your Digi device server do not need to be changed. (Not supported in Digi
Connect WAN.)
Configure Advanced Serial Settings
The advanced serial settings allow you to further define the serial interface, including
whether port buffering (also known as port logging), RTS Toggle, and RCI over Serial are
enabled as general serial interface options. You can also define how specific aspects of
TCP and UDP serial communications should operate, including timeouts and whether a
socket ID is sent.
Serial Settings

The Serial Settings part of the page includes these options:
Enable Port Logging: Enables the port-buffering feature, which allows you to
monitor incoming ASCII serial data in log form. The Log Size field specifies
the size of the buffer that contains the log of ASCII serial data.

87

Configuration through the Default Web Interface

Enable RTS Toggle: When enabled, the RTS (Request To Send) signal is forced
high (on) when sending data on the serial port.
Enable RCI over Serial (DSR): This choice allows the Digi device to be
configured through the serial port using the RCI protocol. See the RCI
specification in the Integration Kit for further details.
RCI over Serial uses the DSR (Data Set Ready) serial signal. Verify that the
serial port is not configured for autoconnect, modem emulation, or any other
application which is dependent on DSR state changes.
TCP Settings

The TCP Settings are displayed only when the current port is configured with the TCP
Sockets or the Custom Profile.
Send Socket ID: Include an optional identifier string with the data sent over the
network. The Socket ID can be 1 to 256 ASCII characters. Non-printable
characters can be entered as follows:
C haracter

Key
Sequence

backspace

\b

formfeed

\f

tab

\t

new line

\n

return

\r

backslash

\\

hexadecimal
values

\xhh

Send data only under any of the following circumstances: Enable if you need to
specify the conditions when the Digi device server will send the data read from
the serial port to the TCP destination.
Send when data is present on the serial line: Send the data to the network
destinations when a specific string of characters is detected in the serial data.

88

Digi Connect Family User's Guide

Configuring the Digi Connect Devices

Enter the string 1 to 4 characters in the Match String field. Non-printable
characters can be entered as follows:
Character
hexadecimal
values

K ey
Sequence
\xhh

tab

\t

line feed

\n

backslash

\\

Check Strip: Match string before sending to strip the string from the data before
it is sent to the destination.
Send after the following number of idle milliseconds: Send the data after the
specified number of milliseconds has passed with no additional data received
on the serial port. This can be 1 to 65,535 milliseconds.
Send after the following number of bytes: Send the data after the specified
number of bytes has been received on the serial port. This can be 1 to 65,535
bytes.
Close connection after the following number of idle seconds: Enable to close an
idle connection. Use the Timeout field to enter the number of seconds that the
connection will be idle before it is closed. This can be 1 to 65000 seconds.
Close connection when DCD goes low: When selected, the connection will be
closed when the DCD (Data Carrier Detected) signal goes low.
Close connection when DSR goes low: When selected, the connection will be
closed when the DSR (Data Set Ready) signal goes low.
UDP Settings

The UDP Settings are displayed only when the current port is configured with the UDP
Sockets or the Custom Profile. Not supported in Digi Connect WAN.

89

Configuration through the Default Web Interface

Send Socket ID: Include an optional identifier string with the data sent over the
network. The Socket ID can be 1 to 256 ASCII characters. Non-printable
characters can be entered as follows:
Character

Key
Sequence

backspace

\b

formfeed

\f

tab

\t

new line

\n

return

\r

backslash

\\

hexadecimal
values

\xhh

Configure GPIO Pins
All Digi Connect devices except the Digi Connect SP, Digi Connect Wi-SP, and Digi
Connect WAN devices have several General Purpose IO (GPIO) pins that can be used for
either standard serial communication signalling or for a user-defined purpose, such as
when a significant event occurs within the device. In the latter case, the Digi Connect
device can be configured so that when an event occurs, an alarm can be sent in the form of
an email message to an administrator or technician, or in the form of an SNMP trap.
The number of GPIO pins varies by device. Digi Connect ME and Wi-ME devices have
five GPIO pins, while Digi Connect EM and Wi-EM devices have nine GPIO pins.
The GPIO Configuration page configures the settings for the GPIO pins on your Digi
Connect device. The settings on this page apply only to those devices that support
configurable GPIO pins: Digi Connect ME, Digi Connect Wi-ME, Digi Connect EM, and
Digi Connect Wi-EM. For a discussion of the possible uses of configurable GPIO pins,
see " Configurable GPIO Pins " on page 25.
GPIO Pin Settings
The GPIO pins on a Digi Connect device can be set to one of three states:

90

Digi Connect Family User's Guide

Configuring the Digi Connect Devices

Serial: The GPIO pin is used for standard serial communication signalling.
Each pin maps to a different serial signal as listed in parentheses next to the pin.
(DCD, CTS, DSR, ...). This is the default setting for all GPIO pins. The default
serial settings for the GPIO pins on a Digi Connect device are as follows.
Depending on the device, there are five or nine pins.
Pin Number

Default Serial Signal

Signal Direction

GPIO 1

DCD

Input

GPIO 2

CTS

Input

GPIO 3

DSR

Input

GPIO 4

RTS

Output

GPIO 5

DTR

Output

GPIO 6

TXD

Output

GPIO 7

RXD

Input

GPIO 8

TXD for port 2

Output

GPIO 9

RXD for port 2

Input

In: The GPIO pin is used for user-defined signal input from the connected
device to the Digi Connect device. An email notification can be sent when an
input event is signalled, as discussed in " Configure Alarms " on page 93.
Out: The GPIO pin is used for user-defined signal output from the Digi
Connect device to the connected device.
Additional Implementation Required for Input and Output Choices
Changing the GPIO pin settings from Serial to Input or Output means that you are
completely responsible for implementing how the pins and signals will work, including
developing any applications, signal-handling, and hardware.

91

Configuration through the Default Web Interface

Set Alarms for GPIO Pin Changes, as Needed
If you want alarms to be issued in the form of email notifications or SNMP traps when a
GPIO pin signals that an event has occurred on the Digi Connect device, go to the Alarms
page and configure those alarms. See " Configure Alarms " on page 93.
Exercise GPIO Pins
Once the GPIO pins and any alarms associated with them have been configured, you
should exercise the GPIO pins to test their configuration.
Exercise GPIO Input

Typically, you will use input signals on GPIO pins to trigger an email alarm, which tells an
administrator or technician that a significant event has occurred within the device. The
process for testing GPIO input is as follows:
1

On the SW2 bank of switches on the development board, ensure that one of the
GPIO pins is set to high.

2

On the SW1 bank of switches, set the same GPIO pin to IO.

3

Configure the GPIO pin for input. See " Configure GPIO Pins " on page 103.

4

Configure an email alarm for the GPIO pin. See " Configure Alarms " on page 103.

5

Toggle the SW2 switch several times to generate several email alarms.

Exercise GPIO Output

The process for testing GPIO output is as follows. In this process, raising a GPIO signal
from the configuration application causes an LED on the development board to turn on.
1

On the SW2 bank of switches on the development board, ensure that one of the
GPIO pins is set to High.

2

On the SW1 bank of switches, set the same GPIO pin to IO.

3

In the default web interface for the Digi Connect device, click the GPIO link. On
the GPIO page, configure one or more GPIO pins for output. See " Configure GPIO
Pins " on page 103 for details.

4

Under Administration, click the System Information link. On the System
Information page, click the GPIO link.

5

Choose Asserted to raise the signal, and then click Set Pins.
An LED on the development board is turned on.

92

Digi Connect Family User's Guide

Configuring the Digi Connect Devices

Note that this process does not configure the Digi Connect device. Settings are
not saved. If the module reboots, you will have to perform steps 2 and 3 again.

Configure Alarms
Use the Alarms page to configure device alarms or display current alarms settings. Device
alarms are used to send email messages or SNMP traps when certain device events occur.
These events include changes in GPIO signals and certain data patterns being detected in
the data stream.
C onfigure Alarm Notification Settings
On the Alarms page, the Alarm Notification Settings control the following:
The "Enable alarm notifications" checkbox enables or disables all alarm
processing for the Digi Connect device.
The Mail Server Address (SMTP) field specifies the IP address of your SMTP
mail server. Ask your network administrator for this IP address.
The From field specifies the text that will be used in the "From:" field for all
alarms that are sent as emails.
Configure Alarm Conditions
The Alarm Conditions part of the Alarms page shows a list of all of the alarms. Up to 32
alarms can be configured for a Digi Connect device, and they can be enabled and disabled
individually.
Alarm List

The list of alarms displays the current status of each alarm. If there are any alarms already
configured for the device, and after you have configured any new alarms, you can use this
list to view alarm status at a glance, then view more details for each alarm as needed.
Enable: Checkbox indicates whether the alarm is currently enabled or disabled.
Alarm: The number of the alarm.
Status: The current status of the alarm, which is either enabled or disabled.
Type: Specifies whether the alarm is based on GPIO pin state changes or serial
data pattern matching.
Trigger: The conditions that trigger the alarm.

93

Configuration through the Default Web Interface

SNMP Trap: Indicates whether the alarm is sent as an SNMP trap.
-

If the SNMP Trap field is disabled, and the Send To field has a value, then the
alarm is sent as an email message only.

-

If the SNMP trap field is enabled and the Send To field is blank, then the alarm
is sent as an SNMP trap only.

-

If the SNMP Trap field is enabled, and a value is specified in the Send to field,
then that means the alarm is sent both as an email and as an SNMP trap.

Send To: The email address to which the alarm is sent.
Email Subject: The text to be included in the "Subject:" line of any alarms sent
as email messages.
A larm Conditions
To configure an alarm, click on it. The configuration page for individual alarms has two
sections:
Alarm Conditions: For specifying the conditions on which the alarm is based,
whether on GPIO pin state changes or serial data pattern matching.
Alarm Destinations: For specifying how the alarm is sent, either as an email
message or an SNMP trap, or both, and where the alarm is sent.
Alarm Conditions

The Alarm Conditions part of the page is for specifying the conditions on which the alarm
is based. Alarm conditions include:
Send alarms based on GPIO pin states: Click this radio button to specify that
this alarm is sent when the specified GPIO pin states are detected. Then specify
the following:
-

Pins: An alarm is sent when the specified combination of pin states is detected.
High - pin is asserted.
Low - pin is not asserted.
?gnore - pin state is ignored.

-

-

94

Alarm recurrence time: Defines how often a new alarm can be sent. For
example, if the alarm recurrence time is 10 seconds then even if the pin states
are detected 5 times within a 10 second period only one alarm will be sent.
Send reminders while GPIO pins remain in this state: If enabled, reminders will
be sent if the pins remain in the defined state for an extended period of time.

Digi Connect Family User's Guide

Configuring the Digi Connect Devices

-

Every: The number of seconds the pins must remain in the defined state for a
reminder to be sent.

Send alarms based on serial data pattern matching: Click this radio button to
specify that this alarm is sent when the specified serial data pattern is detected.
Then specify the following:
-

Serial Port: The serial port to monitor for the data pattern. This field is
displayed for devices where more than one serial port is available.

-

Pattern: An alarm is sent when the serial port receives this data pattern. You can
include special characters such as carriage return carriage return (\r) and new
line (\n) in the data pattern.

Alarm Destinations

The Alarm Destination part of the page defines how alarm notifications are sent--either
as an email message or an SNMP trap, or both--and where the alarm notification is sent.
Send E-mail to the following recipients when alarm occurs: Select the
checkbox to specify that the alarm should be sent as an email message. Then
specify the following information:
-

To: The email address to which this alarm notification email message will be
sent.

-

CC: The email address to which a copy of this alarm notification email
message will be sent (optional).

-

Priority: The priority of the alarm notification email message.

-

Subject: The text to be included in the Subject: line of the alarm-notification
email message.

Send SNMP trap to the following destination when alarm occurs: Select the
checkbox to specify that the alarm should be sent as an SNMP trap.
For alarms to be sent as SNMP traps, the IP address of the destination for the
SNMP traps must be specified in the SNMP settings. This is done on the
System Configuration pages of the default web interface. See " Configure
SNMP " on page 97. That destination IP address is then displayed below the
"Send alarm to SNMP destination" checkbox.
To configure an alarm notification to be sent as both an email message and an
SNMP trap, select both "Send E-Mail" and "Send SNMP trap" checkboxes.
Click Apply to apply changes for the alarm and return to the Alarms
Configuration page.

95

Configuration through the Default Web Interface

Enable and Disable Alarms
Once alarm conditions are configured, you can enable and disable individual alarms by
selecting or deselecting the Enable checkbox for each alarm.

Configure Security Features
The Security page allows you to change your password from the default password.
To increase security for your device, change the password.
To further secure your Digi Connect device, you might want to disable those network
services not necessary to the device, or turn off any non-secure network services, such as
Telnet. See " Enable or Disable Network Services " on page 84.

Configure Remote Management
.The Remote Management configuration page sets up the connection to the Connectware
server so the device knows how to connect to the server.
The Connections page sets up the IP address of the host, the mobile and
Ethernet settings.
Connection Methods include Automatic, TCP, HTTP, HTTP over Proxy, or
None (which will disable the current interface and disable it from
communicating with the server.)
The HTTP over Proxy settings (available only with Automatic and HTTP over
Proxy) identifies the server and user access through identifying server,
username, TCP port, password and the option to enable persistent proxy
connections.
The Security settings control the security processes used in communicating
with the Connectware server.
Security can be simple authentication or an encrypted connection to
communicate with the server.
Encryption methods include: Discovery/Facility Encryption or Message
Passing Encryption. These settings should correspond to the server.
Encryption Key size can be either 128-, 192-, or 256-bits

96

Digi Connect Family User's Guide

Configuring the Digi Connect Devices

Additional encryption choices include: Generate device encryption key from
the following master encryption key and Use the following device encryption
key are both administrator defined.
Advanced
The default settings usually work for most situations, however you can fine tune the
connection between the Connectware server and the device. Be sure to try the default
settings before altering the advanced settings. The settings allow you adjust the setting
intervals for HTTP and TCP keep-alive, receive and transmit intervals, and interval for
connection lost.

Configure System Settings
Configuring system settings is done on the System Configuration page. On this page, you
can:
Configure device description information, including the device name, contact,
and location.
Configure SNMP, including whether SNMP is enabled or disabled, and the
types of SNMP traps to be enabled.
Configure Device Description Information
A device description is a system description of the device's name, contact, and location.
This device description can be useful for identifying a specific device when you are
working with a large number of devices in multiple locations.
Configure SNMP
Simple Network Management Protocol (SNMP) is a protocol that can be used to manage
and monitor network devices. You can configure your Digi Connect device to use SNMP
features, or disable its use entirely for security reasons. To configure SNMP settings, click
the Simple Network Management Protocol link at the bottom of the System Configuration
page. SNMP settings include:
Enable Simple Network Management Protocol (SNMP): This checkbox
enables or disables use of SNMP.

97

Configuration through the Java Applet Interface

The Public community and Private community fields specify passwords
required to get or set SNMP-managed objects. Changing public and private
community names from their defaults is recommended to prevent unauthorized
access to the device.
-

Public community: The password required to get SNMP-managed objects. The
default is "public."

-

Private community: The password required to set SNMP-managed objects. The
default is "private."

Allow SNMP clients to set device settings through SNMP: This checkbox
enables or disables the capability for users to issue SNMP set commands uses
use of SNMP read-only for the Digi Connect device.
Enable Simple Network Management Protocol (SNMP) traps: Enables or
disables the generation of SNMP traps.
Destination IP: The IP address of the system to which traps are sent. In order to
enable any of the traps, a non-zero value must be specified. This field is
required in order for alarms to be sent in the form of SNMP traps. See
" Configure Alarms " on page 93.
At the bottom of the page are checkboxes for the SNMP traps that can be used:
authentication failure, login, cold start, and link up traps.

C onfiguration through the Java Applet Interface
The Java applet interface for configuring devices is similar to the default web interface,
but has these differences:
While the default web interface runs directly on the device, the Java applet runs
remotely. This means that when you start the Java applet, all the device settings
are updated from the device and stored in memory. These are the settings that
are shown when you click on a configuration choice or click Cancel.
Because the Java applet runs remotely, it is not always aware when settings
have been changed by other users. Therefore, it is sometimes necessary to
refresh the applet to retrieve those settings.

98

Digi Connect Family User's Guide

Configuring the Digi Connect Devices

There are fewer configuration options under "Configuration:" Network, Serial
Ports, GPIO, and Security. Alarm configuration is organized under
"Management," and there is no System configuration option.
Some configuration categories have limited choices compared to the default
web interface. areas have limited choices. For example, the port profiles used
for configuring serial ports in the default web interface are not available in the
Java applet.
The button used to save configuration settings is labeled Save rather than
Apply, and there are additional buttons, Cancel and Apply.
A status pane logs all activities in your session.
There is limited online help available for the applet screens. To familiarize
yourself with the configurable fields, you might want to switch to the default
web interface and review the online help for the screens in that interface.

System Requirements for Using the Java Applet Interface
Using the Java applet interface requires that the Sun Java Runtime environment be loaded
on the computer used to configure, monitor, and administer the Digi Connect device.

Accessing the Java Applet Interface
You can temporarily launch the Java Applet interface or use it as the default device
interface. In some cases, a system administrator may have already set the Java applet as
the default device interface. In that case, when you access the device, the Java applet
interface will automatically be displayed. To access the Java Applet Interface:
1

Go to the Home page of the default web interface.

2

Under User Interface, click the Launch button to launch the Java applet.
OR
Click the Set as Default button to use the Java applet as the default device
interface.

99

Configuration through the Java Applet Interface

Organization of the Java Applet Interface
When you open the Java applet interface for a Digi Connect device, the Home page is
displayed.

T he Home Page
The Home page of the Java applet interface displays the following:
On the left is a menu of choices that link to pages for configuration,
management, and administration tasks.
-

This chapter focuses on the links under Configuration and Management.

-

For details on using the links under Administration, see Chapter 4,
" Administering Digi Connect Devices " .

The System Summary section notes all currently available device-description
information.

100

Digi Connect Family User's Guide

Configuring the Digi Connect Devices

Configuration Pages
In the menu on the left side of the screen, the choices under Configuration display pages
for configuring various features, including:
Network: For configuring network communications. See " Configure Network
Settings " on page 102.
Serial Ports: For configuring serial ports. See " Configure Serial Ports " on page
103.
GPIO: For configuring the GPIO pins. See " Configure GPIO Pins " on page
103.
Security: For configuring security features. See " Configure Security Features "
on page 104.
In addition, to configure alarms, you use the Alarms link under Management.
See " Configure Alarms " on page 103
Some of the configuration pages organize the configuration settings into tabs. For
example, the Serial Ports Configuration screen has tabs for Basic, Port Services, Network
Services, and Advanced settings.
Saving, Canceling, and Refreshing Configuration Settings
The configuration screens in the Java applet interface contain several buttons: Save,
Cancel, and Refresh.
Save: Saves the values you have entered or changed to the Digi Connect
device.
Cancel: Only changes that have been made prior to clicking Save are reset to
the initial values when you first arrived on that particular page. For example,
Cancel would be useful in the following sequence:
1

Suppose you click on the Network choice, and on the Network page,
DHCP is currently selected.

2

Instead, you select to manually assign a static IP.

3

Next, you enter an IP address and Subnet Mask.

4

Then, you realize that you do not want to use those settings, and click
Cancel.

101

Configuration through the Java Applet Interface

5

The Network configuration pages are returned to their initial settings, in
which DHCP was selected.

Refresh: Because the Java applet runs remotely, it is not always aware when
device settings have been changed by other users. Therefore, it is sometimes
necessary to refresh the applet to retrieve those settings. When you start the
Java applet interface, all the device settings are updated and stored in memory.
These are the settings that are shown when you click on a configuration page or
click Cancel. Clicking Refresh updates all the stored settings with the settings
from the Digi Connect device (that is, if someone else had made a change while
you were navigating around the applet).
Restoring Settings
There is no way in the Applet or Web UI to restore a certain group of settings to factory
defaults. Once you save the settings, they are in the device. If you want to restore the
device to its true default settings, you must completely reset the device to factory defaults.
See " Restore Device Configuration to Factory Defaults " on page 122.

Configure Network Settings
To configure network settings, click the Network link. Network Settings are organized on
three tabs:
Basic: The Basic tab shows how the device's IP address is obtained, either by
DHCP or by using a static IP address, subnet mask, and default gateway. If you
do not know what these settings mean, or when you may be asked to supply
these values for a device, contact your network administrator.
Network Services: The Network Services tab shows a set of common network
services that are available for devices, and the port on which the service is
running. You can enable or disable several common network services and
configure the TCP port they listen on. Disabling services may be done for
security purposes. That is, you can disable certain services so that a device is
running only those services specifically needed by the device. As needed, you
can also disable any non-secure services, such as Telnet. For a discussion of the
effects of disabling these network services, see " Network Services that Can Be
Enabled or Disabled " on page 84
Advanced: The Advanced tab sets the Ethernet Interface speed and duplex
mode (Auto, Half-Duplex, or Full Duplex).
102

Digi Connect Family User's Guide

Configuring the Digi Connect Devices

Configure Serial Ports
To configure serial ports, click the Serial Ports link. In contrast to the default web
interface, the Java applet interface does not make use of port profiles to configure serial
port settings. The serial port information displayed is similar to that shown when
configuring serial ports using a Custom Profile in the default web interface. The Serial
Configuration page involves several groups of settings arranged on tabs:
The Basic tab shows basic serial configuration settings, such as baud rate, data
bits, parity, stop bits, and flow control.
The Port Services tab is for configuring TCP and UDP client services.
The Network Services tab is for configuring services that monitor data on the
network and relay it to the serial port.
The Advanced tab shows: Advanced serial configuration settings for TCP and
UDP client services, including whether a socket ID is sent, and whether a
connection should be closed after a certain number of idle seconds or if the
DCD or DSR signals go low.

C onfigure GPIO Pins
To configure GPIO pins, click the GPIO link. The GPIO pin configuration is very similar
to screen in the default web interface. It shows the current settings for all GPIO pins in the
device, and allows you to change the settings.
As in the default web interface, once you have configured GPIO pins, you can then define
alarms to send notifications in the event of any changes to GPIO pin states.

Configure Alarms
To configure alarms, click the Alarms link under "Management."
On the Alarm Configuration screen:
The checkbox at the top of the screen shows whether alarms are currently
enabled or disabled
The Email Server Information fields show the IP address of the email server
used to send emails when conditions that trigger an alarm occur, and the text to
be included in the "from" field of an alarm-triggered email.

103

Configuration Through the Command Line

The Alarm List shows all the alarms that are currently defined for a device.
Differences for alarm configuration in the Java applet include:
Alarms can be configured to be sent as email messages only. They cannot be
sent as SNMP traps. You would need to override the alarm configuration either
by toggling to the default Web UI or issuing a followup set alarm command
from the Command-Line Interface.
The method for specifying trigger conditions is different from those in the
default web interface. There, each trigger condition has a combo box for
selecting the condition. In the Java applet, conditions are defined by specifying
one of the following values:
-

X: Ignore

-

1: High

-

0: Low

Configure Security Features
To configure security features, click the Security link. Currently, configurable security
features are limited to specifying whether password authentication is required for the Digi
Connect device, and the user name and password required for logging on to the Digi
Connect device.

Configuration Through the Command Line
Configuring Connect devices through the command line consists of entering a series of
commands to set values in the device. For example:
To Configure:
system-identifying information

set system

general serial port options

set serial

serial TCP and serial UDP

104

Use This Command:

set tcpserial and set udpserial

Digi Connect Family User's Guide

Configuring the Digi Connect Devices

To Configure:

Use This Command:

autoconnection behaviors for serial port
connections

set autoconnect

RTS toggle

set rtstoggle

Ethernet communications parameters

set ethernet

SNMP

set snmp

network options

set network

network services

set service

GPIO pins

set gpio

alarms

set alarms

modem emulation

set pmodem

port buffering

set buffer

users, user groups, and user permissions

set user, set group, set permissions, newpass

wireless devices

set wlan

operating options for Telnet

mode

send Telnet control command to last active
Telnet session

send

limit network access to device

set accesscontrol

Connectware Device Protocol device security
settings

set devicesecurity

create or establish group attributes, also update or
remove groups or group attributes

set group

105

What's Next?

To Configure:

Use This Command:

create or modify custom menus

set menu

Connectware Device Protocol connection
settings

set mgmtconnection

Connectware Device Protocol global settings

set mgmtglobal

Connectware Device Protocol network settings

set mgmtnetwork

router and Network Address Translation settings

set nat

permissions as various services and command
line interface commands

set permissions

Point-to-Point (PPP) outbound connecitons

set pppoutbound

mobile statistics

display mobile

forwarding IP settings

set forward

For a more complete summary of configurable features and the commands used to
configure them, and descriptions of the commands and their fields, see the Digi Connect
Family Command Reference.

What's Next?
Now that your Digi Connect device is configured, it is ready for use. For more
information on using Digi Connect devices, see these chapters:
Chapter 3, " Monitoring Digi Connect Devices " provides details on monitoring
Digi Connect devices, including viewing system information and device
statistics.
Chapter 4, " Administering Digi Connect Devices " describes common
administrative tasks such as file management, updating firmware, and restoring
the configuration to factory defaults.

106

Digi Connect Family User's Guide

Monitoring Digi Connect
Devices
C

H

A

P

T

E

R

3

This chapter discusses the monitoring capabilities in Digi Connect devices, and
monitoring tasks that can be performed from various interfaces. It covers these main
topics:
About monitoring
Monitoring capabilities from Web-based and Java applet interfaces
Monitoring capabilities from SNMP
Monitoring devices from the command line

About Monitoring
With Digi Connect devices, you have the ability to monitor port, device, system, and
network activities. Changes in data flow may indicate problems or activities that may
require immediate attention.

M onitoring Capabilities from Web-Based and Java Applet Interfaces
Following is an overview of the monitoring capabilities from the default web interface
and the Java applet interface.

107

Monitoring Capabilities from Web-Based and Java Applet Interfaces

View System Information
The System Information page, organized under Administration on the default web
interface home page, displays information about your Digi Connect device. It is typically
used by technical support to troubleshoot problems. The System Information page
includes:
General system information
GPIO pin information, including the current state of GPIO pins
Serial port information
Network statistics

General System Information
The General page displays the following information about a Digi Connect device, which
can be useful in device monitoring and troubleshooting.
Model

The model of the Digi Connect device.
MAC Address

A unique network identifier. All network devices are required to have their own unique
MAC address. The MAC address is on a sticker on your Digi Connect device. The number
is displayed as 12 hexadecimal digits, usually starting with 00:40:9D.
Firmware Version

The current firmware version. This information may be used to help locate and download
new firmware.
Firmware updates may be downloaded from http://support.digi.com/support/firmware.
CPU Utilization

The amount of CPU resources being used by the Digi Connect device.
Up Time

The amount of time the Digi Connect device has been running since it was last powered
on or rebooted.
Total/Used/Free Memory

The amount of memory (RAM) available, currently in use, and currently not being used.

108

Digi Connect Family User's Guide

Monitoring Digi Connect Devices

GPIO Information
The GPIO page displays the current state of the General Purpose I/O pins on the Digi
Connect device. The state of pins configured for output can be changed, as discussed in
" Configure GPIO Pins " on page 90. Alarms can be issued when GPIO pins change state,
as discussed in " Configure Alarms " on page 93.

Serial Port Information
The serial port information provides details that may aid in troubleshooting serial
communication problems. Click on a port to view more detailed serial port information.

Configuration
The Configuration section of serial port information includes the electrical interface (Port
Type) and basic serial settings.
Signals
The serial port signals are green when asserted (on) and gray when not asserted (off).
These signals are defined as follows:
RTS: Request To Send
CTS: Clear To Send
DTR: Data Terminal Ready
DSR: Data Set Ready
DCD: Data Carrier Detected
IFC: Input Flow Control
OFC: Output Flow Control
Serial Statistics
The Statistics section of serial port information includes data counters and error tracking
that will help determine the quality of data that is being sent or received. If the error
counters are accumulating, you may have a problem with your Digi device server.

109

Monitoring Capabilities from Web-Based and Java Applet Interfaces

Total Data In

Total number of data bytes received.
Total Data Out

Total number of data bytes transmitted.
Overrun Errors

Number of overrun errors - the next data character arrived before the hardware could
move the previous character.
Overflow Errors

Number of overflow errors - the receive buffer was full when additional data was
received.
Framing Errors

Number of framing errors received - the received data did not have a valid stop bit.
Parity Errors

Number of parity errors - the received data did not have the correct parity setting.
Breaks

Number of break signals received.

N etwork Statistics
The Network Statistics information is used to view more detailed network statistics that
may aid in troubleshooting network communication problems. The statistics displayed are
those gathered since the tables containing the statistics were last cleared. Descriptions of
the network statistics follow. If any error counter is accumulating at an unexpected rate for
that type of counter, you may have a problem with your Digi Connect device.
I P Statistics
Datagrams Received
Datagrams Forwarded

Number of datagrams received or forwarded.
Forwarding

Displays whether forwarding is enabled or disabled.
No Routes

Number of outgoing datagrams for which no route to the destination IP could be found.
110

Digi Connect Family User's Guide

Monitoring Digi Connect Devices

Routing Discards

Number of outgoing datagrams which have been discarded.
Default Time-To-Live

Number of routers an IP packet can pass through before being discarded.
T CP Statistics
Segments Received
Segments Sent

Number of segments received or sent.
Active Opens

Number of active opens. In an active open, the Digi device server is initiating a
connection request with a server.
Passive Opens

Number of passive opens. In a passive open, the Digi device server is listening for a
connection request from a client.
Bad Segments Received

Number of segments received with errors.
Attempt Fails

Number of failed connection attempts.
Segments Retransmitted

Number of segments retransmitted. Segments are retransmitted when the server doesn't
respond to a packet sent by the client. This is to handle packets that might get lost or
discarded somewhere in the network.
Established Resets

Number of established connections that have been reset.
M obile Statistics
Mobile Connection Statistics

Connection statistics include the interface status, bytes received and sent, baud rate,
modem resets, and inactivity timer.

111

Monitoring Capabilities from Web-Based and Java Applet Interfaces

Registration Status

A binary/integer value, indicating the status of the modem's connection to the cellular
network. Values are described in the following list:
Not Registered - Device is not currently searching a new operator to register to
Registered - Home Network
Not Registered - Device is currently searching a new operator to register to "
Registration Denied
Unknown
Registered - Roaming
Cell ID

The modem reports this as a 4-hex-digit string. In the mobile statistics it is displayed both
as hex and decimal representations. For example: " 00C3 (195) "
Location Area Code (aka " LAC " )

Just as for the cell ID, the modem reports this as a 4-hex-digit string. In the mobile
statistics it is displayed both as hex and decimal representations. For example:
" 00C3 (195) "
Signal Strength (RSSI)

Returned as a signed integer value. 0 (zero) indicates no signal. Signal strength is
indicated as a negative value in units of dBm. The following scale indicates the signal
strength LEDs ( " bars " of signal strength):
* -101 or less dBm == Unacceptable (0 LEDs)
* -100 to -91 dBm == Weak (1 LED)
* -90 to -81 dBm == Moderate (2 LEDs)
* -80 to -75 dBm == Good (3 LEDs)
* -74 or better dBm == Excellent (4 LEDs)
* 0 is not known or not detectable (0 LEDs)
IP Address

The IP address of the PPP connection provided by the mobile service.
IMSI

A character string, null-terminated, up to 16 bytes in length. This is the subscriber's code
to access the cellular network, and it is used by the network to admit the device/user to its
provisioned services.

112

Digi Connect Family User's Guide

Monitoring Digi Connect Devices

Manufacturer ID

A character string, null-terminated describing the modem module.
Model ID

A character string, null-terminated describing the modem module.
Revision ID:

A character string, null-terminated describing the modem module's firmware version.
Serial Number:

A character string, null-terminated used as a unique ID per modem module.
UDP Statistics
Datagrams Received
Datagrams Sent

Number of datagrams received or sent.
Bad Datagrams Received

Number of bad datagrams that were received. This number does not include the value
contained by " No Ports. "
No Ports

Number of received datagrams that were discarded because the specified port was invalid.
I CMP Statistics
Messages Received

Number of messages received.
Bad Messages Received

Number of received messages with errors.
Destination Unreachable Messages Received

Number of destination unreachable messages received. A destination unreachable
message is sent to the originator when a datagram fails to reach its intended destination.
W ireless Statistics
This section is used to view more detailed wireless statistics that may aid in
troubleshooting network communication problems with your wireless network.

113

Monitoring Capabilities from Web-Based and Java Applet Interfaces

Status

The current status of the wireless device, which may include:
Not Connected -not associated or connected w/ any access point - may be
because it has not fully initialized, you are out of range, or the wireless
interface is disconnected because the ethernet interface is enabled
Searching for Network -searching for a wireless network or access point for
connection
Associated with Network -successfully associated with the network w/ the
proper network settings and encryption
Authenticated with Network -successfully authenticated a username/password
with the network when WPA is enabled.
Joined Ad Hoc Network-successfully connected to and joined an ad-hoc
network.
Started Ad Hoc Network -successfully created, started, and joined an ad-hoc
network.
Network Name

The name of the wireless network to which the device is connected.
Network ID

The ID of the wireless network to which the device is connected and communicating.
Channel

The frequency channel used by the wireless Ethernet radio for the Connect device.
Transmit Rate

The current transmission rate for the wireless Ethernet radio.
Signal Strength

The current receive signal strength as reported by the wireless Ethernet radio. Ranges are
from 0 to 100.
Mobile Statistics
Mobile Connection

Registration Status, Cell ID, and Location Area Code are identifying details of the
connection.
Signal Strength indicates the quality of the signal in dBms.
114

Digi Connect Family User's Guide

Monitoring Digi Connect Devices

Mobile Statistics

IP Address, Data Received, Data Sent, Modem Resets, and Inactivity Timer are the
activities of the modem.
Mobile Information

IMSI, Modem Manufacturer, Model Number, Modem Serial Number, Modem Revision
are identifying details of the modem.

Monitoring Capabilities from Connectware Manager
Statistics available through Connectware Manager can be collected by servers or groups
of servers. Server activities include:
current connections
session counts
connection times
Statistics can also be collected through device reports. Device reports are a high level
view of activity of any device that is on the server and has activity. Device type lists are
useful for managing firmware updates.
Error reports show major, minor, and informational errors and can be linked back to
specific devices.
Console logging allows you to determine the types of messages to appear in the logs or
displayed.

Monitoring Capabilities from SNMP
Device monitoring capabilities from SNMP include, among other things:
Network statistics, defined in RFC 1213, MIB-II
Port statistics, defined in RFCs 1316 and 1317
Device information, defined in Digi enterprise MIB DIGI-DEVICE-INFO.mib

115

Monitoring Devices from the Command Line

For more information on the statistics available through the standard RFCs listed above,
refer to the RFCs available on the IETF web site (www.ietf.org). For enterprise MIBs,
refer to the description fields in the MIB text.

M onitoring Devices from the Command Line
There are several commands that can be issued from the command line to monitor
devices:
display: The "display" command displays real-time information about a device,
including:
-

General product information, including the product name, MAC address, boot,
post, and firmware versions, memory usage, utilization, and uptime, or the
amount of time since the device was booted.

-

GPIO signals.

-

Memory usage information.

-

Serial modem signals (DTR, RTS, CTS, DSR, DCD, TXD, RXD).

-

Uptime information.

info: The "info" command displays statistical information about a device over
time. There are several variations of the "info" command.The statistics
displayed are those gathered since the tables containing the statistics were last
cleared. The "info" command displays the following types of statistics:
-

-

Ethernet statistics. The "info ethernet" command displays statistics regarding
the Ethernet interface, including the number of bytes and packets sent and
received, the number of incoming and outgoing bytes that were discarded or
that contained errors, the number of Rx overruns, the number of times the
transmitter has been reset, and the number of incoming bytes when the protocol
was unknown.

-

116

Device statistics. The "info device" command displays such details as product,
MAC address, boot, post, and firmware versions, memory usage, utilization,
and uptime.

ICMP statistics. The "info icmp" command displays the number of messages,
bad messages, and destination unreachable messages received.

Digi Connect Family User's Guide

Monitoring Digi Connect Devices

-

Serial statistics. The "info serial" command displays the number of bytes
received and transmitted, signal changes, FIFO and buffer overruns, framing
and parity errors, and breaks detected.

-

TCP statistics. The "info tcp" command displays the number of segments
received or sent, the number of active and passive opens, the number of bad
segments received, the number of failed connection attempts, the number of
segments retransmitted, and the number of established connections that have
been reset.

-

UDP statistics. The "info udp" command displays the number of datagrams
received or sent, bad datagrams received, and the number of received
datagrams that were discarded because the specified port was invalid.

-

Wireless statistics. The "info wlan" command displays detailed statistics for
wireless devices that may aid in troubleshooting network communication
problems with a wireless network.

set alarm: The "set alarm" command displays current alarm settings, including
the conditions which trigger alarms, and how the alarms are sent, either as an
email message, an SNMP trap, or both. The alarms can be reconfigured as
needed.
set gpio: The "set gpio" command displays current GPIO pin settings. The pin
settings can be reconfigured as needed.
set buffer and display buffers: These commands can be used to display portbuffering-related information. The "set buffer" command both configures
buffering parameters on a port and displays the current port buffer
configuration. The "display buffers" command displays the contents of a port
buffer, or transfers the port-buffer contents to a server running Trivial File
Transfer Protocol (TFTP).
set snmp: Configures SNMP, including SNMP traps, such as authentication
failure, cold start, link up, and login traps. This command also displays current
SNMP settings.
status: Displays a list of sessions, or outgoing connections made by connect,
rlogin, or telnet commands for a device. Typically, the status command is used
to determine which of the current sessions to close.
who: The who command provides a global list of connections. Currently, this
list of connections includes those associated with a serial port or the command117

Monitoring Devices from the Command Line

line interface. The who command is particularly useful in conjunction with the
kill command. The who command can be used to determine any connections
that are no longer needed, which can then be ended by the kill command.
For descriptions of these commands, see the Digi Connect Family Command Reference.

118

Digi Connect Family User's Guide

Administering Digi Connect Devices

Administering Digi Connect
Devices
C

H

A

P

T

E

R

4

This chapter discusses the administration tasks that need to be performed on Digi Connect
devices periodically, such as file management, changing the password used for logging
onto the device, backing up and restoring device configurations, updating firmware and
Boot/POST code, restoring the device configuration to factory defaults, and rebooting the
device. As with device configuration and monitoring, it covers performing administrative
tasks through a variety of device interfaces. It covers the following main topics:
Administration from the default Web interface
Administration from the Java applet interface
Administration from the command-line interface
Administration from Connectware Manager

Administration from the Default Web Interface
The Administration section of the web interface main menu provides the following
choices:
File Management: For uploading and managing files, such as custom web
pages, applet files, and initialization files. See " File Management " on page 120.
Backup/Restore: For backing up or restoring a device's configuration settings.
See " Backup/Restore Device Configurations " on page 121.
Update Firmware: For updating firmware, including Boot and POST code. See
" Update Firmware and Boot/POST Code " on page 121.

119

Administration from the Default Web Interface

Factory Default Settings: For restoring a device to factory default settings. See
" Restore Device Configuration to Factory Defaults " on page 122.
System Information: For displaying general system information for the device
and device statistics. See " Display System Information " on page 125.
Reboot: For rebooting the device. See " Reboot the Device " on page 126.
In addition to these choices, you may also need to perform these administrative tasks,
which are organized elsewhere in the web interface:
Enable and disable network services. See " Enable or Disable Network
Services " on page 84.
Enable security for the device by creating a username and password for logging
on to it. See " Configure Security Features " on page 96.

File Management
The File Management page of the default web interface allows you to upload a custom
applet index to HML as well as the respective applet files. Custom applets give you the
flexibility to alter the interface either by adding your logo, changing colors, or moving
information to different locations. If you do not use a custom applet or the sample applet,
you do not need this feature.
Upload Files
Click Browse to select a file to upload to your Digi device server and then click Upload.
Delete Files
Select any files you would like to delete from your Digi device server and click Delete.
Custom Files Are Not Deleted By Device Reset
Any files uploaded to the device's file system via the File Management page are not
deleted by restoring the device configuration to factory defaults, or by pressing the Reset
button on the device (see " Restore Device Configuration to Factory Defaults " on page
122) This deletion is prevented so that customers with custom applets and factory defaults

120

Digi Connect Family User's Guide

Administering Digi Connect Devices

can retain them on the device and not have them deleted by a reset. Such files can only be
deleted by the Delete operation, as described above.

Backup/Restore Device Configurations
Once you have a device configured, you should back it up. Backup/Restore will save your
configuration in case you have problems later if you upgrade your firmware or add
additional hardware. If you have multiple devices to configure, you can backup the first
device then download the configuration onto the other devices.
This procedure shows you how to backup or restore the configuration to a server and to
download a configuration from a server to a file or TFTP.
P rerequisite
If you intend to use TFTP, ensure that the TFTP program is running on a server before you
begin this procedure.
P rocedure
1

Open a web browser and enter the Digi Connect device's IP address in the URL
window.

2

If security is enabled for the device, a login prompt is displayed. Enter the user
name and password for the device. If you do not know the user name and password,
contact the system administrator who initially set up the device.

3

Click Backup/Restore from the main menu.

4

Choose the appropriate option (Backup or Restore) and select your file.

Update Firmware and Boot/POST Code
The following procedures shows how to update the device server's firmware and/or boot/
POST code from a file on your PC or through TFTP. The recommended method is to
download the firmware to your local hard drive. TFTP is supported for those using UNIX
systems. Both the firmware and the boot/POST code are updated using the same set of
steps. The device server will automatically determine what type of image you are
uploading.

121

Administration from the Default Web Interface

Before uploading the firmware or the boot/POST code, it is very important to read the
Release Notes that are supplied with the firmware to check if the boot/POST code must be
updated before updating the firmware.
Prerequisites
These procedure assume that:
You have already downloaded the firmware file from the Digi web site.
If you are using the TFTP option, that TFTP is running.
Update Firmware from a File on Your PC
1

Open a web browser and enter the device server's IP address in the URL window.

2

If security is enabled for the device, a login prompt is displayed. Enter the user
name and password for the device. If you do not know the user name and password,
contact the system administrator who initially set up the device.

3

Click Upgrade Firmware from the main menu.

4

Select Firmware.

5

Click Browse to select the file.

6

Click Update.
Important: DO NOT close your browser until the update is complete and you have
been prompted to reboot.

Update Firmware from a TFTP Server
Updating firmware from a TFTP server is done from the Command-Line Interface using
the boot command. It cannot be done from the default web interface. For details, see
" Administration from the Command-Line Interface " on page 129.

Restore Device Configuration to Factory Defaults
There are two ways to restore the device configuration to the factory default settings:
Restore the configuration from a web browser which will clear all current
settings except the IP address settings and administrator password. This is the
best way to reset the configuration because you can also back up the settings
(which provides a means for restoring it after you have worked through
122

Digi Connect Family User's Guide

Administering Digi Connect Devices

configuration issues). See " Backup/Restore Device Configurations " on page
121 for more information.
Restore the configuration using the reset button on the device server. Use this
method if you cannot access the device from a web browser.
Restoring a Digi Connect device to its factory default settings will clear all
current configuration settings except the IP address settings and the
administrator password. Any files such as custom-interface files and applet files
that were loaded into the device through the File Management page are
retained. See " File Management " on page 120 for information on loading and
deleting files.
Restore the Configuration from a Browser
1

Open a web browser and enter the device server's IP address in the URL window.

2

If security is enabled for the device, a login prompt is displayed. Enter the user
name and password for the device. If you do not know the user name and password,
contact the system administrator who initially set up the device.

3

Click Factory Default Settings from the main menu.

4

Click Restore.

Restore the Configuration Using the Reset Button on the Digi Connect SP
and Digi Connect Wi-SP
1

Power off the device server by unplugging the power.

2

Use a non-conducive, small diameter tool (such as wood or plastic) with a blunt end
(NOT SHARP or the button could be damaged) to press gently and hold down the
reset button. The flashing sequence of LEDs may take several seconds. The
following figures help you locate the reset button.

123

Administration from the Default Web Interface

3

While holding the reset button, power up the unit.

4

Hold the button for 20 seconds and then release it.

The default configuration is restored. When the restoration is complete, the device flashes
a code (1-5-1).
Restore the Configuration by Resetting the Digi Connect ME and Digi
Connect Wi-ME
To restore the configuration on a Digi Connect ME or Digi Connect Wi-ME, perform a
hard or soft reset. See the Digi Connect ME Hardware Reference for details on hard and
soft resets.
Restore the Configuration Using the Reset Button on the Digi Connect EM
or Digi Connect Wi-EM
1

Power off the device server.

2

Locate the reset switch between P3 and CR1.

3

Power on the device while holding the reset switch down. (Hold it down for about
20 seconds.)

Restore the Configuration Using the Reset Button on the Digi Connect WAN
or Digi Connect RG
1

124

Power off the device by unplugging the power supply.

Digi Connect Family User's Guide

Administering Digi Connect Devices

Reset Switch

2

Press the rest button gently (shown in the illustration below) with a non-conducive,
small diameter tool (such as wood or plastic) with a blunt end (NOT SHARP or the
button could be damaged) to hold down the reset button.

3

Power on the device while holding the rest switch down (about 20 -40 seconds.)

WAN
RESET

Display System Information
Display system information gives the model, MAC address, firmware version, boot
version, and POST version of your Digi Connect device. You can also check your memory
available -total, used, and free. It also tracks CPU percent utilization and the uptime.
Under Administration click System Administration. and select General, GPIO, Serial or
Network for the appropriate information.

125

Administration from the Java Applet Interface

Reboot the Device
Some changes require you to save and reboot. Click Reboot and the Reboot button and
wait approximately 1 minute for the reboot to complete.

Enable/Disable Access to Services
As needed, you can enable and disable access to various network services, such as ADDP,
RealPort, SNMP, and Telnet. For example, you may want to disable those services that are
not necessary for running or interfacing with the Digi Connect device. In the default web
interface, enabling and disabling network services is done on the Network Configuration
page for a device. See " Enable or Disable Network Services " on page 84.

Administration from the Java Applet Interface
In the Java applet device interface, administration tasks are also organized under
Administration in the main menu. There are fewer choices than in the default Web
interface:
Backup/Restore: For backing up or restoring a device configuration.
Restore Factory Defaults: For restoring a device's configuration to factory
defaults.
System Information: For displaying system information for the device,
including general device information, current GPIO pin settings, serial line
signals and statistics, and network statistics.
Reboot: For rebooting the device.
You cannot perform file management tasks or update firmware from the Java applet
interface. If you need to perform such tasks, switch the device interface to the default Web
interface.
Additionally, over time, you may need to enable and disable device access to network
services. See " Enable or Disable Network Services " on page 84.

126

Digi Connect Family User's Guide

Administering Digi Connect Devices

Backup/Restore Device Configurations
Prerequisite
If you intend to use TFTP, ensure that the TFTP program is running on a server before you
begin this procedure.
P rocedure
1

Open a web browser and enter the Digi Connect device's IP address in the URL
window.

2

If security is enabled for the device, a login prompt is displayed. Enter the user
name and password for the device. If you do not know the user name and password,
contact the system administrator who initially set up the device.

3

Click Backup/Restore from the main menu.

4

Choose the appropriate option (Backup or Restore) and select your file.

Restore Device Configuration to Factory Defaults
There are two ways to restore the device configuration to the factory default settings:
Reset the configuration from a web browser which will clear all current settings
except the IP address settings and administrator password. This is the best way
to reset the configuration because you can also back up the settings (which
provides a means for restoring it after you have worked through configuration
issues). See " This procedure shows you how to backup or restore the
configuration to a server and to download a configuration from a server to a file
or TFTP. " on page 121 for more information.
Reset the configuration using the reset button on the device server. Use this
method if you cannot access the device from a web browser.
Restoring the Digi Connect device to its factory default settings will clear all
current settings except the IP address settings and the administrator password.
Any files such as custom-interface files and applet files that were loaded into the
device through the File Management page are retained. See " File Management "
on page 120 for information on loading and deleting files.

127

Administration from the Java Applet Interface

Restore the Configuration from a Browser
1

Open a web browser and enter the device server's IP address in the URL window.

2

If security is enabled for the device, a login prompt is displayed. Enter the user
name and password for the device. If you do not know the user name and password,
contact the system administrator who initially set up the device.

3

Click Factory Default Settings from the main menu.

4

Click Restore.

Display System Information
Display system information gives the model, MAC address, firmware version, boot
version, and POST version of your Digi Connect device. You can also check your memory
available-total, used, and free. It also tracks CPU percent utilization and the uptime.
Under Administration, click System Administration, and select General, GPIO, Serial or
Network for the appropriate information.

Reboot the Device
Some changes require you to save and reboot. Click Reboot and the Reboot button and
wait approximately 1 minute for the reboot to complete.

Enable/Disable Access to Services
As needed, you can enable and disable access to various network services, such as ADDP,
RealPort, SNMP, and Telnet. For example, you may want to disable those services that are
not necessary for running or interfacing with the Digi Connect device. In the Java applet
interface, enabling and disabling network services is done on the Network Services tab of
the Network Configuration page for a device. See " Configure Network Settings " on page
102.

128

Digi Connect Family User's Guide

Administering Digi Connect Devices

Administration from the Command-Line Interface
Administration of Digi Connect devices can also be performed from the command line.
The following table summarizes device-administration tasks and the commands used to
perform them. For descriptions of these commands, see the Digi Connect Family
Command Reference.

Administrative Task

Command

Backup/restore a configuration from a
TFTP server on the network

backup
boot
1

Telnet to the device server's
command line interface using a
telnet application or hyperterm.

2

If security is enabled for the device, a
login prompt is displayed. If you do not
know the user name and password,
contact the system administrator who
initially set up the device.

3

Issue the command:

Update firmware

# & gt; boot load= & lt; tftp-serverip & gt; : & lt; filename.bin & gt;
where & lt; tftp-server-ip & gt; is the IP address of
the TFTP server that contains the
firmware and where & lt; filename.bin & gt; is the
name of the filename to upload.

Reset configuration to factory defaults

revert
or
boot action=factory

Display system information and statistics

info

Reboot the device

boot

129

Customizing the User Interface

Administrative Task

Command

Enable/disable network services

set service

Customizing the User Interface
To customize the user interface, enter ipaddress/admin/customization.htm to access a
hidden page for customizing the interface. Launch a tutorial from the Help button for
more information.

Administration from the Connectware Manager
On the Devices home page, you can delete or edit a device or filter for specific device
types.
You can search by Device ID, Device Type, Last Used Dates, or Status.
You can also restrict, unrestrict, redirect, reboot, backup or restore, import or export
device configurations.

Refresh view - . Refreshes the Servers page.
Restart - . Re-starts the server. This is required for some configuration changes. This is
shown in the 'Restart' column, when necessary.

Stop - . Stop the server from providing service without shutting down the entire service.
Start - . Starts the server.
Shutdown - . Shuts down the web server and the running services.
Warning: After a managed server is shut down, it cannot be started from the DMS. It
must be started from the managed server's host machine

Port Config - . Allows setting of the ports that server uses.
Server Info - . Lists which plugins are running on a server. These fields cannot be
changed and are for information only.

130

Digi Connect Family User's Guide

Administering Digi Connect Devices

SMTP Server - . Allows a SMTP (Simple Mail Transfer Protocol) server to be
specified. Web Server -Allows setting of the parameters used by the web server.
Console Logging - . Settings for determining if log messages are shown on the
console, and which ones you want displayed.

Database Logging - . Settings for determining if your server logs messages to the
database. You can choose what severity and the type of messages to log.

Email Logging Alerts - . Settings for determining if a list of users are emailed server
log messages. You can choose the severity level and the type of messages to log. All
associated email addresses will receive the same messages. You will be required to set up
your mail server properties.
Database -. Controls database settings. The updated settings will be effective after the
server is shutdown and started up again.

Device Protocol Security -. Settings for device security.
Warning: Setting these parameters incorrectly may make it impossible for devices to
connect with the server. Make sure that your device security settings match the server's
security settings.

MDH Server - . These settings control the MDH ((Message Over Device-Initiated
HTTP) Server.

Server Statistics - . These settings control the timing and intervals for collecting server
statistics.

System Performance - . These settings control how many devices may be connected,
the overload threshold, and report generation.

131

Administration from the Connectware Manager

132

Digi Connect Family User's Guide

Glossary

Glossary
oooooooooooooooooooooooooooooooooooooooooooooooooooooooo

802.11
The IEEE standard for wireless Local Area Networks. It uses three different physical
layers, 802.11a, 802.11b and 802.11g.
alarms
In Digi Connect devices, alarms are used to send emails or issue SNMP traps when
certain device events occur. These events include changes in General Purpose I/O
(GPIO) signals, and particular data patterns detected in the serial stream.
ADDP
See Advanced Device Discovery Protocol.
Address Resolution Protocol (ARP)
A protocol for mapping an Internet Protocol address (IP address) to a physical machine
address that is recognized in the local network.
Advanced Digi Discovery Protocol (ADDP)
A protocol that runs on any operating system capable of sending multicast IP packets
on a network. ADDP allows the system to identify all ADDP-enabled Digi devices
attached to a network by sending out a multicast packet. The Digi devices respond to
the multicast packet and identify themselves to the client sending the multicast.
ARP
See Address Resolution Protocol.
autoconnection
A network connection initiated from a Digi device that is based on timing, serial
activity, or serial modem signals.
Automatic Private IP Addressing (APIPA)
A standard protocol that automatically assigns an IP address from a reserved pool of
standard Auto-IP addresses to the computer on which it is installed. The device is set to
obtain its IP address automatically from a Dynamic Host Configuration Protocol
(DHCP) server. But if the DHCP server is unavailable or nonexistent, Auto-IP will
assign the device an IP. If DHCP is enabled or responds later or you use ADDP, both
will override the Auto-IP address previously assigned. Also referred to as Auto-IP.

133

Glossary

Auto-IP
See Automatic Private IP Addressing (APIPA).
CDMA
CDMA (Code-Division Multiple Access) protocols used in wireless communications.
CDMA is a form of multiplexing, which allows numerous signals to occupy a single
transmission channel, optimizing the use of available bandwidth. The technology is
used in ultra-high-frequency (UHF) cellular telephone systems in the 800-MHz and 1.9GHZ bands and through an analog-to digital conversion enhances privacy and makes
cloning difficult..
CLI
Command-line interface.
COM port redirection
The process of establishing a connection between the host and networked serial devices
by creating a local COM or TTY port on the host. See also RealPort.
configuration applet
See Java applet interface.
configuration management
For Digi Connect devices, configuration management involves managing the files and
settings that contain device configuration information. Configuration management
tasks include copying device configuration files to and from a remote host, upgrading
device firmware, and resetting the device configuration to factory defaults.
CTS
Clear to Send.
default web interface
The Web-based interface for configuring, monitoring, and administering Digi Connect
devices that is provided for Digi Connect devices by default.
device server
A one- or two-port intelligent network device that converts serial data into network
data.
DHCP
See Dynamic Host Configuration Protocol.

134

Digi Connect Family User's Guide

Glossary

Digi Device Setup Wizard
A wizard for configuring Connect devices that is provided on the CD shipped with each
device. The Digi Device Setup Wizard is available in Microsoft Windows or UNIX
platforms. It assigns an IP address for the device, configures the device based on your
description of the device environment, and determines whether you need to install
RealPort. Using the Digi Device Setup Wizard is the recommended and preferred
method for configuration.
DSR
Data Set Ready.
DTR
Data Terminal Ready.
Dynamic Host Configuration Protocol (DHCP)
An Internet protocol for automating the configuration of computers that use TCP/IP.
DHCP can be used to automatically assign IP addresses, to deliver TCP/IP stack
configuration parameters such as the subnet mask and default router, and to provide
other configuration information.
EIA
See Electronics Industry Association.
Electronics Industry Association (EIA) and Electronics Industries Alliance (EIA)
1) The Electronic Industries Association (EIA) comprises individual organizations that
together have agreed on certain data transmission standards such as EIA/TIA-232
(formerly known as RS-232).
2) The Electronics Industries Alliance (EIA) is an alliance of trade organizations that
lobby in the interest of companies engaged in the manufacture of electronics-related
products.
encryption
The conversion of data into a form, called a ciphertext, that cannot be easily understood
by unauthorized people. Decryption is the process of converting encrypted data back
into its original form, so it can be understood.
Encryption/decryption is especially important in wireless communications. This is
because wireless circuits are easier to tap than their hard-wired counterparts.
factory defaults
The default configuration values that are set in a device at the factory.
135

Glossary

File Transfer Protocol (FTP)
A standard Internet protocol that specifies the simplest way to exchange files between
computers on the Internet.
FTP
See File Transfer Protocol.
General Purpose I/O (GPIO)
On Digi Connect devices, pins that are used for serial communications. In normal
operation, the GPIO pins are used for the serial CTS, DCD, DSR, DTR, and RTS. For
Digi Connect EM and Wi-EM devices, there are GPIO pins for the TXD and RXD
signals. GPIO pins can be configured for different purposes, and alarms can be
configured to alert users of a change in GPIO pin state.
GPIO
See General Purpose I/O.
GSM
GSM (Global System for Mobile communication) is a digital mobile telephone system
that digitizes and compresses data, then sends it down a channel with two other streams
of user data, each in its own time slot. It operates at either the 900 MHz or 1800 MHz
frequency band.
GSM together with other technologies is part of an evolution of wireless mobile
telemmunication that includes High-Speed Circuit-Switched Data (HCSD), General
Packet Radio System (GPRS), Enhanced Data GSM Environment (EDGE), and
Universal Mobile Telecommunications Service (UMTS).
HTTP
See HyperText Transfer Protocol.
HTTPS
See HyperText Transfer Protocol over Secure Socket Layer.
HyperText Transfer Protocol (HTTP)
An application protocol in the TCP/IP suite that defines the rules for transferring files
(text, graphic images, sound, video, and other multimedia files) on the World Wide
Web (WWW).
Hypertext Transfer Protocol over Secure Socket Layer (HTTPS)
A secure message-oriented communications protocol designed for use in conjunction

136

Digi Connect Family User's Guide

Glossary

with HTTP. HTTPS encrypts and decrypts user page requests as well as the pages that
are returned by the Web server. HTTPS uses the Secure Socket Layer (SSL) as a
sublayer.
ICMP
See Internet Control Message Protocol.
IGMP
See Internet Group Management Protocol.
Internet Control Message Protocol (ICMP)
A message control and error-reporting protocol between a host server and a gateway to
the Internet. ICMP uses Internet Protocol (IP) datagrams, but the messages are
processed by the IP software and are not directly apparent to the application user.
Internet Group Management Protocol (IGMP)
Internet Group Management Protocol (IGMP) provides a way for an Internet computer
to report its multicast group membership to adjacent routers. Multicasting allows one
computer on the Internet to send content to multiple other computers that have
identified themselves as interested in receiving the originating computer's content.
Multicasting can be used for such applications as updating the address books of mobile
computer users in the field, sending out company newsletters to a distribution list, and
" broadcasting " high-bandwidth programs of streaming media to an audience that has
" tuned in " by setting up a multicast group membership.
I/O
Input/Output.
IP filtering

A network configuration that can be enabled to establish rules allowing
devices to permit or deny specific IP addresses, networks, or devices from
connection access.
Java applet interface
An optional Java-applet based Web interface for configuring, monitoring, and
administering Connect devices.
MAC address
A unique network identifier. All network devices are required to have their own unique
MAC address. The MAC address is on a sticker on your Digi device server. The number
is displayed as 12 hexadecimal digits, usually starting with 00:40:9D.

137

Glossary

Management Information Base (MIB)
A formal description of a set of network objects that can be managed using the Simple
Network Management Protocol (SNMP).
MIB
See Management Information Base.
modem emulation
A serial port configuration where the port acts as a modem. The Digi device emulates
modem responses to a serial device and seamlessly sends and receives data over an
Ethernet network instead of a Public Switched Telephone Network (PSTN). The
advantage for a user is the ability to retain legacy software applications without
modification and use a less expensive Ethernet network in place of public telephone
lines. Also known as pseudo-modem or pmodem.
NAT
NAT (Network Address Translation) is the translation of an Internet Protocol address
(IP address) used within one network to a different IP address known within another
network through a NAT table that does the global-to-local and local-to-global IP
address mapping.This increases security since each outgoing or incoming request must
go through a translation process that also authenticates the request or matches it to a
previous request. NAT can be statically defined or it can be set up to dynamically
translate from and to a pool of IP addresses. NAT also conserves on the number of
global IP addresses needed and it uses a single IP address in its communication with the
world.
PEAP
See Protected Extensible Authentication Protocol.
port forwarding
A serial port configuration that sends data directly to a specific port instead of the path
determined by the router based on traffic.
POST
See Power-On Self Test.
Power-On Self Test (POST)
When power is turned on, POST (Power-On Self-Test) is the diagnostic testing
sequence that a computer's basic input/output system (or " starting program " ) runs to
determine if the computer keyboard, random access memory, disk drives, and other

138

Digi Connect Family User's Guide

Glossary

hardware are working correctly.
If the necessary hardware is detected and found to be operating properly, the computer
begins to boot. If the hardware is not detected or is found not to be operating properly,
the BIOS issues an error message which may be text on the display screen and/or a
series of coded beeps, depending on the nature of the problem.
Protected Extensible Authentication Protocol (PEAP)
A protocol proposed for securely transporting authentication data, including passwords,
over 802.11 wireless networks. PEAP makes it possible to authenticate wireless LAN
clients without requiring them to have certificates, simplifying the architecture of
secure wireless LANs.
RCI
See Remote Command Interface.
RealPort
RealPort is patented Digi software for COM port redirection. RealPort makes it possible
to establish a connection between the host and networked serial devices by creating a
local COM or TTY port on the host. The COM/TTY port appears and behaves as
a local port to the PC or server. This process of COM port redirection allows
existing software applications like DNP3 and Modbus to work without modification.
Unlike other COM port redirectors, RealPort offers full hardware and software flow
control, as well as tunable latency and throughput. These features ensure optimum
performance, since data transfer is adjusted according to specific application
requirements.
Remote Command Interface (RCI)
A programmatic interface for configuring and controlling Connect family devices. RCI
is an XML-based request/response protocol that allows a caller to query and modify
device configurations, access statistics, reboot the device, and reset the device to factory
defaults.
Unlike other configuration interfaces that are designed for a user, such as the commandline or browser interfaces, RCI is designed to be used by a program. A typical use of
RCI is in a Java applet that can be stored on the Connect device to replace the browse
interface with a custom browser interface. Another example is a custom application
running on a PC that monitors and controls an installation of many Connect devices.

139

Glossary

remote login (rlogin)
A remote login to a Digi Connect device's Command-Line Interface (CLI). rlogin is a
Unix command that allows an authorized user to login to other UNIX machines (hosts)
on a network and to interact as if the user were physically at the host computer. Once
logged in to the host, the user can do anything that the host has given permission for,
such as read, edit, or delete files.
remote shell (rsh)
A Berkeley Unix networking command to execute a given command on a remote host,
passing it input and receiving its output. Rsh communicates with a daemon on the
remote host.
rlogin
See remote login.
RSH
See remote shell.
RTS
Ready to Send.
RXD
Receiving Data.
Secure Sockets Layer (SSL)
A commonly-used protocol for managing the security of a message transmission on the
Internet. SSL has recently been succeeded by Transport Layer Security (TLS), which is
based on SSL.
serial bridge
A connection between two serial devices over a network that acts as if they were
connected over a serial cable. Also known as serial tunneling.
serial tunneling
See serial bridge.
Setup Wizard
See Digi Device Setup Wizard.
Simple Mail Transfer Protocol (SMTP)
A TCP/IP protocol used in sending and receiving e-mail. Since it is limited in its ability
to queue messages at the receiving end, it is usually used with one of two other

140

Digi Connect Family User's Guide

Glossary

protocols, POP3 or IMAP, that let the user save messages in a server mailbox and
download them periodically from the server.
SMTP usually is implemented to operate over Internet port 25. An alternative to SMTP
that is widely used in Europe is X.400. Many mail servers now support Extended
Simple Mail Transfer Protocol (ESMTP), which allows multimedia files to be delivered
as e-mail.
Simple Network Management Protocol (SNMP)
A protocol for managing and monitoring network devices. The SNMP architecture
enables a network administrator to manage nodes--servers, workstations, routers,
switches, hubs, etc.--on an IP network; manage network performance, find and solve
network problems, and plan for network growth. Digi devices support SNMP Version
1.
SNMP
See Simple Network Management Protocol.
SMTP
See Simple Mail Transfer Protocol.
SSL
See Secure Sockets Layer.
static IP address assignment
The process of assigning a specific IP address to a device. Contrast with assigning a
device through Dynamic Host Configuration Protocol (DHCP), or Automatic Private IP
Addressing (APIPA or Auto-IP).
TCP
See Transmission Control Protocol.
Telnet
A user command and an underlying TCP/IP protocol for accessing remote computers.
On the Web, HTTP and FTP protocols allow you to request specific files from remote
computers, but not to actually be logged on as a user of that computer. With Telnet, you
log on as a regular user with whatever privileges you may have been granted to the
specific application and data on that computer.
Temporal Key Integrity Protocol (TKIP)
Part of the IEEE 802.11i encryption standard for wireless LANs. TKIP is the next
generation of the Wired Equivalent Privacy (WEP), which is used to secure 802.11
141

Glossary

wireless LANs. TKIP provides per-packet key mixing, a message integrity check and a
re-keying mechanism, and addresses several design shortcomings of the original WEP.
TFTP
See Trivial File Transfer Protocol (TFTP).
TLS
See Transport Layer Security.
Transmission Control Protocol (TCP)
A set of rules (protocol) used along with the Internet Protocol (IP) to send data in the
form of message units between computers over the Internet. While IP handles the actual
delivery of the data, TCP handles keeping track of the individual units of data (called
packets) that a message is divided into for efficient routing through the Internet.
For example, when an HTML file is sent to you from a Web server, the Transmission
Control Protocol (TCP) program layer in that server divides the file into one or more
packets, numbers the packets, and then forwards them individually to the IP program
layer. Although each packet has the same destination IP address, it may get routed
differently through the network. At the other end (the client program in your computer),
TCP reassembles the individual packets and waits until they have arrived to forward
them to you as a single file.
TCP is known as a connection-oriented protocol, which means that a connection is
established and maintained until such time as the message or messages to be exchanged
by the application programs at each end have been exchanged. TCP is responsible for
ensuring that a message is divided into the packets that IP manages and for
reassembling the packets back into the complete message at the other end. In the Open
Systems Interconnection (OSI) communication model, TCP is in layer 4, the Transport
Layer.
Transport Layer Security (TLS)
A protocol that ensures privacy between communicating applications and their users on
the Internet. When a server and client communicate, TLS ensures that no third party
may eavesdrop or tamper with any message. TLS is the successor to the Secure Sockets
Layer (SSL).
Trivial File Transfer Protocol (TFTP)
An Internet software utility for transferring files that is simpler to use than the File
Transfer Protocol (FTP) but less capable. It is used where user authentication and

142

Digi Connect Family User's Guide

Glossary

directory visibility are not required. TFTP uses the User Datagram Protocol (UDP)
rather than the Transmission Control Protocol (TCP). TFTP is described formally in
Request for Comments (RFC) 1350.
TTY port redirection
The process of establishing a connection between the host and networked serial devices
by creating a local TTY port on the host. The TTY port appears and behaves as a

local port to the PC or server.
See also RealPort.
TXD
Transmit eXchange Data.
UDP
See User Datagram Protocol.
User Datagram Protocol (UDP)
A communications protocol that offers a limited amount of service when messages are
exchanged between computers in a network that uses the Internet Protocol (IP). UDP is
an alternative to the Transmission Control Protocol (TCP) and, together with IP, is
sometimes referred to as UDP/IP. Like the Transmission Control Protocol, UDP uses
the Internet Protocol to actually get a data unit (called a datagram) from one computer
to another. Unlike TCP, however, UDP does not provide the service of dividing a
message into packets (datagrams) and reassembling it at the other end. Specifically,
UDP does not provide sequencing of the packets in which the data arrives, nor does it
guarantee delivery of data. This means that the application program that uses UDP must
be able to make sure that the entire message has arrived and is in the right order.
Network applications that want to save processing time because they have very small
data units to exchange (and therefore very little message reassembling to do) may prefer
UDP to TCP. The Trivial File Transfer Protocol (TFTP) uses UDP instead of TCP.
UDP provides two services not provided by the IP layer. It provides port numbers to
help distinguish different user requests and, optionally, a checksum capability to verify
that the data arrived intact.
In the Open Systems Interconnection (OSI) communication model, UDP, like TCP, is
in layer 4, the Transport Layer.
WEP
See Wired Equivalent Privacy.

143

Glossary

Wired Equivalent Privacy (WEP)
A data encryption method used to protect the transmission between 802.11 wireless
clients and APs. See also Temporal Key Integrity Protocol (TKIP).
Wi-Fi Protected Access (WPA)
A data encryption/ user authentication method for 802.11 wireless LANs. WPA uses the
Temporal Key Integrity Protocol (TKIP).
WPA
See Wi-Fi Protected Access.
WPA2/802.11i
WPA with AES-based encryption (CCMP)

144

Digi Connect Family User's Guide

Index

Index

2 x RP-SMA connector 29

133
autoconnection
client connections 44
configuring 88, 105
definition 133
Auto-IP
See Auto Private IP Addressing (APIPA)
Automatic Private IP Addressing (APIPA) 133
auto-sensing of duplex mode 29
auto-sensing of speed 28

8

B

oooooooooooooooooooooooooooooooooo

1
1 x RP-SMA connector 29

2

802.11 133
802.1x (WPA) 30

A
A 42
active opens 111
ADDP
See Advanced Digi Discovery Protocol (ADDP)
Address Resolution Protocol (ARP) 32
Ad-Hoc Mode for wireless networks 30, 31
administration
from the command line interface 129
from the default web interface 119
from the Java applet interface 126
Advanced Digi Discovery Protocol (ADDP)
definition 133
description 36
enabling and disabling access to 29, 84
alarms
based on GPIO pin states 94
based on serial data pattern matching 95
configuring 93, 105
number supported per device 93
overview 39
antenna connector for wireless devices 29
attempt fails 111
authentication failure traps 34, 98, 117
authentication for Digi Connect devices 96
authentication options for wireless devices 30
Auto Private IP Addressing (APIPA) 38, 70, 83, 85,

backup command 129
backup/restore device configurations 121, 127, 129
bad datagrams received 113
bad messages received 113
bad segments received 111
boot code 121
boot command 129
boot status 116
breaks 110

C
certifications
Digi One IA 59
channel for wireless devices 30, 31, 114
cold start traps 35, 98, 117
COM port redirection 38, 73, 84, 87, 134, 139
Command-Line Interface (CLI)
administering devices from 129
as a device configuration interface 46, 52, 104
as a device interface 31
as a device-monitoring interface 58, 116
client connections 44
connections initiated by connect command 44
connections initiated by rlogin commands 44
connections initiated by telnet commands 44
configuration
assigning an IP address to the device 69
interfaces for 45
resetting to defaults 122
configuration applet

145

Index

See Java applet interface
configuration interfaces
Command-Line Interface 52
default web interface 48
Digi Device Setup Wizard 46
Java applet interface 50, 98
configuration management
definition 134
from the Command-Line Interface 129
from the default web interface 119
from the Java applet interface 126
overview 41
connect command 44
console management
port profile for 72
contact information for a device 97
country code 30
CTS 24, 91, 109, 116, 134
custom port profile 73
customization
custom Java applets 42
of Java applet interface 50
of user interfaces 32, 41
overview 41

D
data bits 20, 23, 24
data rate 28, 30
data transfer rate for wireless devices 31
datagrams forwarded 110
datagrams received 110, 113
datagrams sent 113
DB9 connector 29
DC characteristics for Digi Connect devices 26
DCD 24, 89, 91, 109, 116
default configuration, resetting 122
default time-to-live 111
default web interface
accessing 78
Alarms Configuration 93
applying and saving changes 81
as a device configuration interface 46, 48, 77

146

as a device interface 31
canceling changes 82
configuration pages 81
definition 134
GPIO Configuration 90
Home page 80
Network Configuration 83
online help 82
opening 78
Security Configuration 96
Serial Port Configuration 85
destination IP address for SNMP traps 98
destination unreachable messages received 113
device description 97
device location 97
device name 97
device server 134
device statistics 116
Digi Connect EM
alarms 39
configuration management 41
customization 41
hardware features 21
IP address assignment 37
modem emulation 39
product overview 17
protocols supported 32
RealPort Software 38
safety information 62
security features 40
supported connections and data paths 42
user interfaces for 31, 32
Digi Connect Integration Kit 12, 42
Digi Connect ME
alarms 39
configuration management 41
customization 41
hardware features 20
IP address assignment 37
modem emulation 39
power requirements 26
product overview 16

Digi Connect Family User's Guide

Index

protocols supported 32
RealPort Software 38
safety information 62
security features 40
supported connections and data paths 42
user interfaces for 31
Digi Connect SP
alarms 39
configuration management 41
customization 41
hardware features 19
IP address assignment 37
modem emulation 39
protocols supported 32
RealPort Software 38
safety information 62
security features 40
supported connections and data paths 42
user interfaces for 31
Digi Connect Wi-EM
alarms 39
configuration management 41
customization 41
hardware features 22
IP address assignment 37
modem emulation 39
product overview 17
protocols supported 32
RealPort Software 38
RF exposure limits 59
safety information 62
security features 40
supported connections and data paths 42
user interfaces for 31, 32
Digi Connect Wi-ME
alarms 39
configuration management 41
customization 41
hardware features 21
IP address assignment 37
modem emulation 39
power requirements 26

product overview 16
protocols supported 32
RealPort Software 38
RF exposure limits 59
safety information 62
security features 40
supported connections and data paths 42
user interfaces for 31, 32
Digi contact information 13
Digi Device Setup Wizard 46
as a device configuration interface 46, 72
as a device interface 31
definition 135
DIGI-DEVICE-INFO.mib 34, 56, 115
DIGI-SERIAL-ALARM-TRAPS.mib 34
display buffers command 117
display command 116
displaying system information 125, 128, 129
DSR 24, 88, 89, 91, 109, 116, 135
DTR 24, 91, 109, 116, 135
duplex mode 29
Dynamic Host Configuration Protocol (DHCP)
as an alternative for IP address assignment 37
changing an IP address with 69, 70
definition 135
description 34

E
EAP-MS-CHAPv2 authentication 30
email messages for alarms 25, 39, 93, 94, 95
Encrypted RealPort
description 38
enabling and disabling access to 29
encryption
definition 135
Encrypted RealPort 38, 40
for wireless devices 30
Raw TLS encrypted connection 44
SSL V3.0 40
TLS V1.0 40
Wired Equivalent Privacy (WEP) 29
established resets 111

147

Index

Ethernet
configuring parameters (set ethernet) 105
connector 29
duplex mode 29
speed 28
statistics 116
Extensible Markup Language (XML) 55

F
factory defaults 122, 135
file management 120
File Transfer Protocol (FTP) 136
firmware status 116
firmware updates 121, 129
Flash memory specifications 19, 20
flow control 20, 23, 24
forwarding, enabling and disabling 110
framing errors 110
full-duplex mode 29

G
General Purpose I/O (GPIO)
configuring alarms for GPIO pins 92, 94
configuring pins 90, 105
current state of 109
default serial settings for pins 91
definition 136
exercising GPIO pins 92
In (Input) state 91
Out (Output) state 91
overview 25
Serial state 91
status of signals 116
groups 105

H
half-duplex mode 29
hardware features 19
hardware flow control 24
HyperText Transfer Protocol (HTTP) 36, 136
Hypertext Transfer Protocol over Secure Socket
Layer (HTTPS) 36, 136

148

I
ICMP
See Internet Control Message Protocol (ICMP)
IEEE 802.3 28
IFC 109
IGMP
See Internet Group Management Protocol
info command 116, 129
Infrastructure Mode for wireless networks 30, 31
Integration Kit
See Digi Connect Integration Kit
interfaces
for configuring devices 45
for monitoring devices 57
Internet Control Message Protocol (ICMP)
definition 137
statistics for 36, 113, 116
Internet Group Management Protocol (IGMP) 137
Internet Protocol (IP)
statistics for 110
IP address assignment
from the Command-Line Interface 71
methods for 37
testing the configuration 71
using Auto IP 70
using Dynamic Host Configuration Protocol
(DHCP) 70
using the Digi Device Setup Wizard 69

J
Java applet interface
accessing 99
Alarms Configuration 103
as a device configuration interface 46, 50, 98
as a device interface 31
canceling changes 101
configuration pages 101
definition 137
developing custom applets 50
differences from default web interface 98
GPIO Configuration 103
Home page 100

Digi Connect Family User's Guide

Index

Network Configuration 102
refreshing settings 102
restoring settings 102
saving changes 101
Security Configuration 104
Serial Ports Configuration 103
system requirements 99

L
Line Printer Daemon (LPD) 25, 29, 35, 43
link up traps 35, 98, 117
location information for a device 97
login traps 35, 98, 117

M
MAC address 116, 137
Management Information Base (MIB)
Character MIB 34
definition 138
Digi enterprise MIBs supported 34
DIGI-DEVICE-INFO.mib 34, 115
DIGI-SERIAL-ALARM-TRAPS.mib 34
MIB-I 56
MIB-II 115
MIBs supported 34
RS-232 MIB 34
memory specifications for Digi Connect
devices 19, 20
memory usage 116
messages received 113
MIB-I 56
MIB-II 56, 115
modem emulation 25, 39, 43
configuring 105
definition 138
overview 39, 45
port profile for 72
modem signal status 116
modulation for wireless devices 29

N
network data rate 28

network ID 114
network interface features 28
network mode for wireless devices 30
network name 114
network options 105
network services
description 42
enabling and disabling 105, 126, 128, 130
newpass 105
no ports 113
no routes 110

O
OFC 109
overflow errors 110
overrun errors 110

P
parity 20, 23
parity errors 110
passive opens 111
PEAP
See Protected Extensible Authentication
Protocol
physical layer 28
pin header 29
ping command 72
port buffering
configuring 87, 105
description 25
port logging
Enable Port Logging setting 87
See also port buffering
port profiles
console management 73
custom 76
modem emulation 76
overview 72
RealPort 73
selecting and configuring 86
serial bridge 75
TCP sockets 74

149

Index

UDP sockets 74
POST
See Power-On Self Test
post status 116
power requirements
Digi Connect ME 26
Digi Connect SP 26
Digi Connect Wi-ME 26
Power-On Self Test (POST) 121, 138
pre-shared key (PSK) 30
printer profile 76
private community password for SNMP 98
product name 116
Protected Extensible Authentication Protocol
(PEAP) 30, 139
protocols
Address Resolution Protocol (ARP) 32
Advanced Digi Discovery Protocol (ADDP) 32
Dynamic Host Configuration Protocol
(DHCP) 32, 34
HyperText Transfer Protocol (HTTP) 32
Hypertext Transfer Protocol over Secure Socket
Layer (HTTPS) 32
Internet Control Message Protocol (ICMP) 32
Internet Group Management Protocol
(IGMP) 32
Line Printer Daemon (LPD) 32
overview of supported 32
Protected Extensible Authentication Protocol
(PEAP) 30
Remote Login (rlogin) 32
RFC 2217 32
Secure Sockets Layer (SSL) 32, 35
Simple Mail Transfer Protocol (SMTP) 32
Simple Network Management Protocol
(SNMP) 32, 34
Telnet 32
Temporal Key Integrity Protocol (TKIP) 30
Transport Layer Security (TLS) 32, 35
Trivial File Transfer Protocol (TFTP) 117
User Datagram Protocol (UDP) 32
Wi-Fi Protected Access (WPA) 40

150

Wired Equivalent Privacy (WEP) 40
pseudo-modem 43, 45
See also modem emulation
PSK
See pre-shared key
public community password for SNMP 98
Public Switched Telephone Network (PSTN) 39,
138

R
RAM specifications 19, 20
raw connections 25
RCI over Serial 24, 55, 87, 88
RealPort
and serial settings 87
connections 43
definition 139
enabling and disabling access to 29
overview 38
port profile for 72, 73
reboot device 126, 128, 129
receive sensitivity 29
Remote Command Interface (RCI)
as a device configuration interface 46, 54
as a device interface 31
definition 139
Remote login (rlogin) 25, 44
as an autoconnect client connection 44
definition 140
description 35
enabling and disabling access to 29
Remote Shell (rsh)
definition 140
enabling and disabling access to 30, 84
support in Digi Connect devices 43
reset button 123
restore configuration to factory defaults 122, 127,
129
reverse raw socket 43
Reverse Telnet 35
reverse TLS socket 43
revert command 129

Digi Connect Family User's Guide

Index

RF exposure statement 59
RFC 1213 34, 115
RFC 1215 34
RFC 1316 34, 115
RFC 1317 115
RFC 2217 25, 33, 74, 87
RJ-45 connector 29
rlogin command 44, 53
routing discards 111
RSH
See Remote shell
RTS 24, 88, 91, 109, 116, 140
RTS Toggle 20, 24, 87, 88, 105
RXD 24, 91, 116, 140

S
safety information 62
Secure Sockets Layer (SSL) 35, 40, 140
security
configuring features 96
encryption 40
for SNMP use 41
for web pages 36
for wireless devices 29
overview 40
secure access and authentication 40
Secure Sockets Layer (SSL) 35
Transport Layer Security (TLS) 35
segments received 111
segments retransmitted 111
segments sent 111
serial bridge 140
serial bridge port profile 72, 75
serial communication statistics 117
serial interface
configuration profiles for 72, 86
configuring 85, 103, 104
serial ports
advanced serial settings 87
basic serial settings 87
configuring 85, 103, 104
connector 29

current information for 109
port profiles 86
serial TCP 104
serial tunneling
See serial bridge
serial UDP 104
Service Set Identifier (SSID) 30
session management 25
set alarm 105, 117
set autoconnect 105
set buffer 105, 117
set commands for SNMP 41, 98
set ethernet 105
set gpio 105, 117
set group 105
set network 71, 105
set permissions 105
set pmodem 105
set rtstoggle 105
set serial 104
set service 105, 130
set snmp 105, 117
set system 104
set tcpserial 104
set udpserial 104
set user 105
set wlan 105
Setup Wizard
See Digi Device Setup Wizard
shared key 31
signal strength 31, 114
signal support 20, 23, 24
Simple Mail Transfer Protocol (SMTP) 93, 140
Simple Network Management Protocol
(SNMP) 34
as a device configuration interface 46, 55
as a device interface 31
as a device-monitoring interface 58, 115
configuring 97, 105
definition 141
destination IP address for traps 98
enabling and disabling 97

151

Index

enabling and disabling access to 30
enabling and disabling traps 98
monitoring capabilities 115
private community name 98
public community name 98
security 41
sending alarms as SNMP traps 94
set commands 41, 98
traps 34
Socket ID 88, 90
software flow control 24
SSID
See Service Set Identifier
SSL
See Secure Sockets Layer
SSL V3.0 40
static IP address assignment 37, 141
statistics
available through SNMP 115
device information 115
for wireless devices 113
network 110, 115
port 115
serial 109
status
command 117
firmware 116
modem signals 116
of wireless devices 114
status command 117
stop bits 20, 23, 24
Sun Java Runtime environment 99
support, Digi contact information 13
supported connections and data paths 42
system information 125, 128, 129
system settings 97

T
TCP
See Transmission Control Protocol (TCP)
TCP sockets port profile 72, 74
tcpserial communication 24, 33

152

Telnet
Autoconnect 35
Client 35
command 43
connections 25
definition 141
enabling and disabling access to 30, 35
protocol 44
Reverse 35, 43
RFC 2217 (Telnet Com Port Control Option) 35
Server 35
Telnet Com Port Control Option (RFC 2217) 25,
32, 33, 74, 87
Telnet Com Port Control Option 35
telnet command 44, 53, 117, 129
Temporal Key Integrity Protocol (TKIP) 30, 141,
144
TFTP
See Trivial File Transfer Protocol
time-to-live 111
TLS
See Transport Layer Security
TLS V1.0 40
total data in 110
total data out 110
Transmission Control Protocol (TCP)
configuration settings 88
definition 142
raw TCP connection 44
sending serial data over 24
statistics 117
statistics for 111
tcpserial communication 24, 33, 88
transmit power for wireless devices 29
transmit rate 114
Transport Layer Security (TLS) 35, 40, 142
traps
authentication failure 34
cold start 35
enabling and disabling 34
link up 35
login 35

Digi Connect Family User's Guide

Index

Trivial File Transfer Protocol (TFTP) 117, 121,
122, 127, 129, 142, 143
TTL-level pins 29
TTY port redirection 38, 143
TXD 24, 91, 116, 143

U
UDP
See User Datagram Protocol
UDP sockets port profile 72, 74
udpserial communication 24, 33
update firmware and boot/POST code 121, 129
upload files 120
uptime 116
User Datagram Protocol (UDP)
configuration settings 89
definition 143
sending serial data over 24
statistics 117
statistics for 111
udpserial communication 24, 33, 89
user groups 105
user permissions 105
users 105
utilization 116

W
web interface for devices
See default web interface, Java applet interface
WEP
See Wired Equivalent Privacy
WEP encryption 29
who command 117
Wi-Fi Protected Access (WPA) 29, 30, 31, 40, 144
Wired Equivalent Privacy (WEP) 29, 30, 31, 40,
144
wireless devices
802.1x (WPA) authentication 30
Ad-Hoc Mode 30, 31
antenna connector for 29
authentication options 30
channel for 31

configuring 105
connection status 31
country code for 30
data rate for 30
data transfer rate 31
encryption 31
encryption for 30
feature summary 29, 30
frequency channel for 114
Infrastructure Mode 30, 31
modulation 29
network ID 114
network key for 31
network mode 31
network name 114
password for authentication 31
receive sensitivity 29
RF exposure limits for 59
security 31
security for 29
Service Set Identifier (SSID) for 30, 31
signal strength 31, 114
statistics for 113, 117
status features 31
status of 114
transmission rate 114
transmit power 29
username for authentication 31
WPA
See Wi-Fi Protected Access
WPA encryption 29

X
XML
See Extensible Markup Language (XML)

153

Index

154

Digi Connect Family User's Guide

Digi International
11001 Bren Road East
Minnetonka, MN 55343
U.S.A
952-912-3444

PN:(1P) 90000565 E


All Legacy 9320.zip > MP9320_2.8e_Users_Guide_V1.0.pdf

User's
Guide
MP9320 v2.8e EPC
UHF Long-Range Reader

THE POWER TO CHOOSE

TM

SAMSys
MP9320 V2.8e UHF Long-Range Reader
User's Guide
First Edition (September 27, 2005)
(C) Copyright 2005 SAMSys Technologies, Inc. All Rights Reserved.
Disclaimer and Limitation of Liability
The content of this manual is for information use only and is subject to change without notice. SAMSys assumes no responsibility or liability for any errors
or inaccuracies that may appear in this publication. No part of this manual may be reproduced in any form or by any means, electronic, mechanical,
recording, or otherwise, without the prior written permission of SAMSys.
SAMSys products are not designed, intended, authorized or warranted to be suitable for life support applications or any other life critical applications
which could involve potential risk of death, personal injury, property damage, or environmental damage.
About SAMSys
SAMSys Technologies, Inc. is a world-leading provider of RFID reader hardware solutions in the LF, HF, and UHF segments of the RFID marketplace.
SAMSys is a public company listed on the Toroto Stock Exchange under the symbol SMY.
SAMSys Technologies, Inc.
44 East Beaver Creek Rd., Unit 11
Richmond Hill, Ontario L4B 1G8 Canada
Phone: (905) 707-0404
Toll Free: (877) 367-4342
Fax: (905) 707-9944
E-mail: samsys@samsys.com
Web: www.samsys.com
Part Number: MP9320-V28e-OM-V1.0

Trademarks
SAMSys is a trademark of SAMSys Technologies, Inc.
HyperTerminal(R) is a registered trademark of Hilgraeve, Inc.
EPC is a trademark of EPCglobal, Inc.
Other company, product or service names appearing in this manual may be trademarks or service marks of their respective owners.

The EU and EFTA member states restrict the use of certain frequency spectrum and the RFID operational characteristics. The labels below are copies of
the shipping labels which indicate member states where use is restricted for the MP9320 V2.8E models. It is illegal to operate a model in a member state
where that member state is crossed out. In some cases it may be possible to obtain site licenses limited to a particular member state but these must meet
the criteria of that member state in terms of specific operational and submission requirements.

For the MP9320 V2.8E-1:

Model MP9320 V2.8e-1
UHF Long-Range Reader

THE POWER TO CHOOSE

Important Notice:
This device is an RFID transceiver device intended
for commercial use in all EU and EFTA member
states except as crossed out where restrictive use
applies. Please refer to the user guide for further
details on restrictive use.

AT

EE

HU

LI

NO

ES

BE

FI

IS

LT

PL

SE

CY

FR

IE

LU

PT

CH

CZ

DE

IT

MT

SK

GB

DK

GR

LV

NL

SI

NOTE: EU Member states with restrictive use for this device are crossed out.

For the MP9320 V2.8E-2:

Model MP9320 V2.8e-2
UHF Long-Range Reader

THE POWER TO CHOOSE

Important Notice:
This device is an RFID transceiver device intended
for commercial use in all EU and EFTA member
states except as crossed out where restrictive use
applies. Please refer to the user guide for further
details on restrictive use.

AT

EE

HU

LI

NO

ES

BE

FI

IS

LT

PL

SE

CY

FR

IE

LU

PT

CH

CZ

DE

IT

MT

SK

GB

DK

GR

LV

NL

SI

NOTE: EU Member states with restrictive use for this device are crossed out.

MP9320 v2.8e User's Guide

Contents
Chapter 1 - Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Unpacking the Reader . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
About the MP9320 v2.8e . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Physical Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

1
2
3
4

Chapter 2 - Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Installation Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Step 1 - Connect Antenna(s) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Step 2 - Connect RS-232 Cable . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Step 3 - Connect Power . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Step 4 - Install RF Command Suite . . . . . . . . . . . . . . . . . . . . . . . . . .
Step 5 - Configure the Reader . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Step 6 - Reading Tags . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Antenna Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Reader Mechanical Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Hollow Concrete Block Wall Mounting . . . . . . . . . . . . . . . . . . . . . . .
Solid Concrete Wall Mounting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Wood or Metal Wall Mounting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Drywall Mounting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
RS-485/Ethernet Communication Selection . . . . . . . . . . . . . . . . . . . . . . .
Serial (RS-232) Communication Setup . . . . . . . . . . . . . . . . . . . . . . . . . . .
Ethernet LAN Communication Setup . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configuring the IP Address . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Digital (TTL) Input/Output Setup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configuring the MP9320 V2.8e for EN 302 208 (Listen Before Talk) . .
Setting Transmit Power -TDx . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Setting Antenna Gain -TGx . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Setting Transmit Power Configuration - TPC . . . . . . . . . . . . . . . . . .
Transmit, Listen Before - TLB . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Preferred Frequency Channels - VFC (optional) . . . . . . . . . . . . . . . .

7
8
8
9
9
9
10
11
12
14
15
16
16
16
17
17
18
18
19
20
20
21
22
22
22

Chapter 3 - Operation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Power Up and Initialization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Starting RF Command Suite . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Setting the RF Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Selecting the Number of Primary Antennas . . . . . . . . . . . . . . . . . . . . . . .
Selecting Tag Protocols . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Enabling or Disabling Tag Protocols . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Reading Tags . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Tag Reading Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Reading Tags Using RF Command Suite . . . . . . . . . . . . . . . . . . . . . .
Writing Blank Tags . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Modifying Tags . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

25
26
27
27
27
28
28
29
29
29
31
32

Chapter 4 - Troubleshooting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
General Troubleshooting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
Contact Us . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36

i

MP9320 v2.8e User's Guide

Chapter 5 - Specifications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Reader Specifications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Environmental Specifications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Battery Specifications (Optional) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Power Supply Specifications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
RS-232 Connector Specifications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
RS-485 Connector Specifications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
RS-485/Ethernet Jumper Setting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Ethernet LAN Connector Specifications . . . . . . . . . . . . . . . . . . . . . . . . . .
Digital I/O Connector Specifications . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Suitable Antenna Specifications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Regulatory Standards . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

37
38
38
38
38
39
39
40
40
41
41
42

Appendix A - Reader Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Operating Modes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Default Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
MP9320 V2.8e-1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
MP9320 V2.8e-2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Common Configurations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configuring the Reader with RF Command Suite . . . . . . . . . . . . . . . . . .
Changing the RS-232 Configuration . . . . . . . . . . . . . . . . . . . . . . . . .
Changing Reader Operation Modes . . . . . . . . . . . . . . . . . . . . . . . . . .
Configuring Specific Protocols . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Updating Reader Firmware with RF Command Suite . . . . . . . . . . . . . . .
Using CHUMP Commands to Configure the Reader . . . . . . . . . . . . . . . .

43
44
44
44
44
45
46
47
47
48
49
51

Appendix B - Tag Programming . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Overview of the Tag Writing Commands . . . . . . . . . . . . . . . . . . . . . . . . .
Programming the EPC1 Tag . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Programming the ISO18000-6A Tag . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Programming the ISO18000-6B Tag . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Programming the Impinj EPC0 Tag . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Programming the Matrics Class 0+ Tag . . . . . . . . . . . . . . . . . . . . . . . . . .
Programming the EPC1, Generation 2 Tag . . . . . . . . . . . . . . . . . . . . . . . .

53
54
55
57
58
61
64
68

Appendix C - Configuring the IP Address . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71
Ethernet IP Address Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72
IP Address Setup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72

ii

MP9320 v2.8e User's Guide

Figures
MP9320 v2.8e Reader and Accessories . . . . . . . . . . . . . . . . . . . . . . . . . . .2
SAMSys Reader Network . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4
MP9320 v2.8e LED Status Indicators . . . . . . . . . . . . . . . . . . . . . . . . . . . .5
MP9320 v2.8e Active Antenna LED Indicators . . . . . . . . . . . . . . . . . . . . .5
MP9320 v2.8e End-Panel Connectors . . . . . . . . . . . . . . . . . . . . . . . . . . . .6
Typical MP9320 V2.8e Power, Antenna, and Serial Connections . . . . . . .8
RF Command Suite Command Window . . . . . . . . . . . . . . . . . . . . . . . . . .10
RF Command Suite Tag Summary Window . . . . . . . . . . . . . . . . . . . . . . .11
MP9320 v2.8e Antenna Configurations . . . . . . . . . . . . . . . . . . . . . . . . . . .12
MP9320 v2.8e Reader Installations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .14
MP9320 v2.8e Base Plate with Mounting Keyholes . . . . . . . . . . . . . . . . .15
MP9320 v2.8e Standalone RS-232 Communication Setup . . . . . . . . . . . .17
MP9320 v2.8e Ethernet LAN Communication Setup . . . . . . . . . . . . . . . .18
Digital Input/Output Port Configuration . . . . . . . . . . . . . . . . . . . . . . . . . .20
LED Startup Sequence . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .26
Active Antenna LED Indicators - Antenna 2 Transmitting . . . . . . . . . . . .26
Protocol Selection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .28
Select Tag Protocol . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .31
Write Blank Tag . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .31
Select Tag to Modify . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .32
Modify Tag Option . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .32
RS-232 Connector . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .39
RS-485 Connector . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .39
Ethernet LAN Connector . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .40
Digital I/O Connector . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .41
Reader Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .46
RS-232 Serial Port Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .47
Serial and RF Mode Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .47
Protocol Parameter Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .48
Firmware Upload System Configuration . . . . . . . . . . . . . . . . . . . . . . . . . .49
Upload File Controls . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .50
Digi Device Discovery Application Window . . . . . . . . . . . . . . . . . . . . . . .72
Digi Device Discovery Web Interface Window . . . . . . . . . . . . . . . . . . . . .73
Digi Device Discovery Serial Configuration Window . . . . . . . . . . . . . . . .73
Reader Serial Port Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .74

iii

MP9320 v2.8e User's Guide

iv

Chapter 1
Introduction
This chapter provides a general description of the MP9320 v2.8e Reader. Topics discussed
in this chapter include the following:
o

Unpacking the Reader

o

About the MP9320 v2.8e

o

Physical Description

1

MP9320 v2.8e User's Guide

Unpacking the Reader
After opening the shipping container perform the following:
1. Unpack the contents of the shipping container.
2. Inspect the shipping container for damage. If damaged, notify the carrier and SAMSys
Technologies. Keep the shipping materials for inspection by the carrier.
3. Verify your reader package includes the following items:
o
o
o
o
o
o
o
o

MP9320 v2.8e Reader
Power cord
15 Vdc power supply with cable
Sample RFID tags
RS-232 communication cable
Ethernet LAN Cable
System documentation CD
Antennas (optional)

P

E
H

T

O
OW

ER

T

O

C

H
OO

L

a
n

A

n

te
n

B
T

SE

TM

T
ra

ns

m

it

S

en

se

P

ow

er

F

1

au
lt

A

ct

iv

e

A

nt

en

na

4
3

2

C

to

C

ho
o

se

E
(15

er

er
ow

P

th
e

rn

et
L

A

N

EP

P
ow

.0

c3

pm
am

)
ax

5

Vd

D

ig
it
I/O al

R

S

-2
3

2

R

S

-4
8

2
93ader
e
MPF R
UH

e

Th
e

2.8
0v

Figure 1-MP9320 v2.8e Reader and Accessories

2

Introduction

About the MP9320 v2.8e
The MP9320 V2.8e reader is the latest member of the SAMSys family of multi-protocol,
multi-regional, UHF RFID readers to offer built-in tag reading capability that conforms to
the new EPC Generation Two (Gen 2) standard. This reader supports the Listen Before
Talk (LBT) requirement of EN 302 208. The MP9320 V2.8e is available in the following
two models:
o

MP9320 V2.8e-1 - Supports only the EN 300 220 configuration.

o

MP9320 V2.8e-2 - Supports both EN 300 220 and EN 302 208 (LBT) configuration.

Utilizing a new DSP-based architecture, the MP9320 v2.8e reader supports all currently
available UHF protocols (including Gen 2) in the same reader. This allows you to select
from multiple RFID tag supply sources and to migrate to the new Gen 2 tag standard.
The SAMSys MP9320 v2.8e reader offers a number of feature, performance, and
configurability enhancements including:
o

Support for all protocols in one reader.

o

Improved read/write speed, data rates performance, and robustness.

o

A fifth LBT antenna port for improved performance in support of EN 302 208
regulatory requirements.

o

Label Applicator feature enhancements such as gated read/write operation,
configurable retries, and read verify delay.

o

Regulatory conformity for use in European Union and Asian markets.

o

Enhanced Microsoft Windows(TM) based RF Command Suite reader configuration
program

With its extended read range and high data rates, the MP9320 v2.8e is especially suited for
asset management and logistics applications requiring the simultaneous reading of a large
number of tags at greater distances. Typical RFID applications supported by the MP9320
v2.8e include the following:
o

Warehouse Logistics

o

Inventory Management

o

Asset Management

o

Pallet Tracking

o

Parking Lot Access

o

Aggregated Container Tracking

o

Loading Dock Portals
3

MP9320 v2.8e User's Guide

te
nn
a

T

4

An

LB

na

3

ten

1

2

e An
tiv
Ac

Fa

ult
Po

r
we
Se

e
ns
ns

t
mi
TM

Tra

C

th

er
P
ow

er
ne

t LA

N

EP

3.0

p ma
am

x)

e
2.8 er
0 v Read
932 F
MP PC UH
E

T

te
nn
a

E

.8e

e

93ader
MPF Re
UH

ho
os

v2
20

4

An

LB

ten

na

3

e An

2

tiv

1

Ac

Fa

ult
Po

we

r

Se

e
ns
ns

mi

t
TM

Tra

EP

C
N
t LA
th
er
ne

x)
p ma
am

P
ow
er

E

Ch
oo
se
Po
we

r

to

3.0
Vdc

Th

e

(15

R

S

-2
32

R

S

UH

.8e

v2

-4
85

20
93ader
MPF Re

ital
Dig I/O

yN

or k
et w

AN

Ba

L
et
rn
he
Et

ub
r
et H
ern or Serve
Eth
rk
two
Ne
s

Figure 2-SAMSys Reader Network

In addition to the scalable, multi-protocol architecture, the MP9320 v2.8e includes the
following features:
o

LED indicators

o

(4) standard UHF antenna ports

o

(1) dedicated LBT antenna [port

o

Multiple host interface connections (RS-232, RS-485, Ethernet LAN)

o

Digital input and output lines

o

Integrated real-time clock with battery backup (optional)

o

On-board temperature sensor (optional)

Physical Description

NOTE: The reader enclosure is designed for office, indoor warehouse, and light

manufacturing areas. If a sealed reader is required for wet or hazardous
environments, contact your SAMSys representative.

The digital board contains four LED indicators to provide the operational status of the
reader. The LEDs are visible on the front panel of the reader.
4

Introduction

Fault
Power
Sense
Transmit

Figure 3-MP9320 v2.8e LED Status Indicators

Indicator

Color

Description

Fault

Red

Error condition exists

Power

Green

Power is applied to the reader and
processor initialization complete

Sense

Green

Reader has tag data to report.This LED
also flashes when the reader software
is being loaded.

Transmit

Green

Transmitter is operating and RF power
is applied to one of the antennas

In addition to the status LEDs, four Active Antenna LEDs provide indication that RF
power is being applied to one of the four primamry antennas. Two LEDs (not shown) are
also provided on the Ethernet LAN connector to indicate network communication status.

Active Antennas
1

2

3

4

Figure 4-MP9320 v2.8e Active Antenna LED Indicators

Five SMA type antenna ports are provided on the end panel. Four ports are for the primary
antennas. The fifth port is for the dedicated LBT antenna. The reader also has one power
and four communication interface connectors on the opposite end panel.

5

MP9320 v2.8e User's Guide

Ethernet Port
RS-485 Port
Power

RS-232 Port

Digital I/O
Port

Primary
Antenna Ports

LBT Antenna
Port

Figure 5-MP9320 v2.8e End-Panel Connectors

6

Chapter 2
Installation
This chapter provides information for installing the MP9320 v2.8e Reader. Topics
discussed in this chapter include the following:
o

Installation Overview

o

Antenna Installation

o

Reader Mechanical Installation

o

RS-485/Ethernet Communication Selection

o

Serial (RS-232) Communication Setup

o

Ethernet LAN Communication Setup

o

Configuring the IP Address

o

Digital Input/Output Setup

o

Listen Before Talk (LBT) Configuration

7

MP9320 v2.8e User's Guide

Installation Overview
This seciton provides a basic overview for quickly configuring and operating the SAMSys
MP9320 V2.8-1 and -2 UHF readers. Detailed installation and operation instructions are
provided in the following sections.
The readers can be easily configured and operated by performing the following steps
(refer to Figure 2):
1.
2.

Connect the RS-232 cable to the reader and PC.

3.

Connect power to the reader.

4.

Install the RF Command Suite application

5.

Configure the reader.

6.

PC

Connect antenna(s) or loads to antenna ports

Read Tags

Serial
Cable

15 Vdc, 4A
Power Supply

Primary
Antenna

Control End

Antenna End

LBT
Antenna

Figure 6-Typical MP9320 V2.8e-2 Power, Antenna, and Serial Connections

Step 1 - Connect Antenna(s)
Caution
Prior to applying power to the MP9320 V2.8e reader, connect a suitable UHF antenna or
50 Ohm load such as an attenuator to Antenna Port 1. If being used, the remaining
antenna ports must also be terminated with either an antenna or load.

The MP9320 V2.8e reader is equipped with five SMA-type, female RF connections and is
designed to operate with 865-870 MHz antennas and 50 Ohm impedance RF cables.
Connect the primary antenna to Antenna Port 1 and the listen antenna to the LBT antenna
port (MP9320 V2.8e-2 only). The MP9320 V2.8e-1 supports only EN 300 220 (fixed
frequency) and does not utilize the LBT antenna.
8

Installation

Step 2 - Connect RS-232 Cable
Communication between the reader and computer is provided by an RS-232 serial
connection. A 9-pin (DB-9), female serial connection is provided on the reader.
Connect a serial cable equipped with a male DB-9 connector to the MP9320 serial port
and then to the COM port on the host computer.

Step 3 - Connect Power
A 15 Vdc, 4A power supply provides power to the reader. Connect the power supply to the
reader as shown in Figure 6 and then connect the power supply to your 100-240 Vac
power source.

Step 4 - Install RF Command Suite
The SAMSys RF Command Suite (RFCS) is a Microsoft Windows application
that provides a Graphical User Interface (GUI) for SAMSys RFID Reader
Products. The application allows you to easily view tag data, configure the reader, and
perform other tag data functions. In addition, the RFCS is the preferred method for
sending commands to a reader.
The RFCS application is provided on the CD shipped with your reader and can be installed
on a personal computer. To install RFCS and verify the reader connection, perform the
following:
1.

Insert the Product Documentation CD provided with the reader into the PC's CD
drive.

2.

Double click the Setup_RFCommandSuite_x_yy_zz.msi file where x_yy_zz is the
version number.

3.

Follow the on-screen instructions for installing the RF Command Suite application.

4.

To start RF Command suite, select:
Start & gt; Programs & gt; SAMSys & gt; SAMSys RF Command Suite

5.

Follow the system prompts or from the upper RFCS tool bar, select:
Reader Connection & gt; Auto Connect

6.

Look in the lower left corner of the window and verify the Connected to Reader
message is displayed.

9

MP9320 v2.8e User's Guide

Step 5 - Configure the Reader
After RF Command Suite is installed and communicating with the reader, use the
application to configure your reader. Perform the following:
NOTE: If you have the MP9320 V2.8e-2 reader which supports both EN 302 208 and EN 300 220
and you need to configure the reader for LBT operation, refer to the Configuring the MP9320
V2.8e-2 for EN 302 208 (LBT) section at the end of this chapter. The MP9320 V2.8e-1 reader only
supports EN 300 220 (fixed frequency).

1.

Select the Command window tab (see Figure 7) and select Function Set 1.

2.

Press the Version button to verify the reader connection.

3.

Alternately press the Auto Read button and the RF Off button and verify the
Transmit LED on the front of the reader illuminates.

4.

The MP9320 is enabled at the factory for the EPC1, Generation 2 protocol. To
enable another protocol, perform the following

a

Select Function Set 2 or 3 (click radio buttons as shown).

b. Press the appropriate protocol button.

Figure 7-RF Command Suite Command Window

10

Installation

Step 6 - Reading Tags
After reader configuration, you can read and display tag data. If you do not have Gen 2
tags, reconfigure the reader for one of the sample tags supplied with your reader. MP9320
readers are typically shipped with EPC1, Gen 2 or EPC1/96 tags.
To read tags, perform the following:
1.

On RF Command Suite, select the Command window tab and press Auto Read.

2.

Select the Tag Summary display (see Figure 8).

3.

Place a tag in the RF field.

4.

Verify the tag data appears in the display window.

Figure 8-RF Command Suite Tag Summary Window

11

MP9320 v2.8e User's Guide

Antenna Installation
The MP9320 v2.8e supports up to five external antennas in a variety of configurations.
Four antennas can be used for general portal, conveyor, or loading dock configurations.
The fifth antenna is a dedicated Listen-before-Talk (LBT) antenna (for use on the MP9320
V2.8e-2 only).
Antennas are configured by selecting the Command tab on RF Command Suite and then
selecting Function Set 4. Choose the appropriate antenna configuration to match your
application.Various antenna configurations are shown in the following figure.
LBT antenna
LBT antenna

1

Single Antenna

Dual Antennas
(Stacked)

2

LBT antenna
LBT antenna

1

1
3
Dual Antennas
(Opposing)

2

2
Four Antennas
(Portal Configuration)

4
NOTE: The LBT antenna should be positioned
for the maximum " listen " coverage.

Figure 9-MP9320 v2.8e Antenna Configurations

Warning
The SAMSys MP9320 v2.8e UHF Reader is equipped with five (5) RF ports. To prevent
reader damage, active RF ports must be properly terminated with a 50 ohm load or a
functional UHF RFID antenna before power up. UHF Readers are factory configured to
operate on RF port 1 with LBT on Port 4. As a result, port 1 and LBT port 4 must be
properly terminated before initially powering on the reader. Before activating any
additional RF ports, they must also be properly terminated. Never power up the reader
unless the appropriate loads or antennas are connected. Always power down the reader
before removing an antenna or load from an RF port.
12

Installation

The MP9320 v2.8e is factory calibrated for operation with the following type of antenna
and cable:
Antenna Parameter

Value

Frequency

865-870 MHz

Polarization

Circular

Gain, dBic

6, max

VSWR, maximum

1.5:1

Beam Width

less than or equal to 70 degrees

Cable Parameter

Value

Type

RG58C/U

Length

2 Meters

Connector

SMA type plug, reader side

It is highly recommended that the antenna mounting be adjustable in order to obtain the
best performance from the system. However, the antennas must be installed on a solid
surface or frame to prevent damage or later misalignment. Perform the following to install
the antennas.
NOTE: Use the existing mounting holes on the antenna flange. Drilling new holes in the flange is
not recommended.

1.

Determine the location of each antenna. Ensure the antenna(s) will not be vulnerable
to damage by moving inventory or equipment.

2.

Use the antenna as a template and mark the mounting holes.

3.

Drill and tap (if necessary) mounting holes for #10 or 1/4 inch mounting screws. For
drywall mounting, use drywall anchors or toggle screws.

4.

Mount each antenna and install the mounting screws. Do not overtighten the screws.
Damage to the antenna case may result.

5.

Route each antenna cable back to the reader location. For dual-opposing or portal
configurations, route the opposing cables so they can not be damaged by equipment
or personnel.

6.

Secure each antenna cable with wire ties or other restraint.

13

MP9320 v2.8e User's Guide

Reader Mechanical Installation
The MP9320 v2.8e is designed for easy installation. The following instructions provide
the information to install your UHF reader.
As shown in Figure 10, the reader is designed for horizontal or vertical installation.
Mounting keyholes are provided on each side of the base plate for easy, non-permanent,
installation and removal.

Caution
To ensure proper cooling of the reader, verify that the fan intakes and vents are free of
obstructions.

LBT Antenna

Antenna 2

T

LB na
ten
An

tiv
Ac 2

e An

tenn

a

4

3

1

Fa

ult
r

Po
Se

we

ns

e

LBT a
Antenn

it
Active
2
1

Fault
r
Powe
e
Sens

TM

0v

2.8

e

4

na
3
Anten

sm

Tran

C
EP

mit
Trans

TM

20
93er
MPRead

v2

.8e

EP

C

UHF

M
UH

Antenna 1

Antenna 3

T

Di
I

te

3

Tr

an

sm
it

Po
w

er
Se
ns
e

Fa

1

ul

t

2

Ac

tiv

e

An

nn

a

4

LB

nna
Ante

et
ern
Eth

r

F

U
H

M

P
9

R
ea
de

3

2

0

v2

.8

e

EP

C

TM

The

Powe

r to

Choo

se

-48
RS
-23
RS
ital
Dig I/O

5

(15

LAN
er max
Pow
amp

)

3.0

Vdc

2

Antenna 4

Figure 10-MP9320 v2.8e Reader Installations

NOTE: Figure 10 shows a typical portal antenna configuration with the LBT antenna mounted on
top of the portal. Antenna placements vary and your configuration may be different.

For horizontal or table mounting, ensure the reader and all cabling is secured to the surface
or frame. SAMSys recommends that the MP9320 v2.8e be mounted on a horizontal
surface. However, if vertical surface installation is required, refer to the following sections
for the appropriate mounting. As shown in Figure 11, keyhole slots are provided for easy
installation and removal.
14

Installation

6.40 in (162.5 mm)

.359 in ?
(9 mm)
5.0 in
(127 mm)

Figure 11-MP9320 v2.8e Base Plate with Mounting Keyholes

Hollow Concrete Block Wall Mounting
To temporarily mount the MP9320 v2.8e to a hollow concrete block wall, SAMSys
recommends metal sleeve type concrete anchors that accept a #10 screw and flat washer.
To install the MP9320 v2.8e on a hollow concrete block wall, perform the following.
1.

Refer to Figure 11, and mark the location of the mounting screws. Do not install the
anchors into the mortar joint.

2.

Drill the appropriate size hole for a metal sleeve type anchor.

3.

Install the anchors.

4.

Install the washers and insert the screws.

5.

Tighten the screws to within .375" of the anchor.

6.

Install the reader and finish tightening the screws.

15

MP9320 v2.8e User's Guide

Solid Concrete Wall Mounting
To temporarily mount the MP9320 v2.8e to a solid concrete wall, SAMSys recommends
one-piece expansion type concrete anchors that accept a #10 screw and flat washer. To
install the reader on a concrete wall, perform the following.
1.

Refer to Figure 11, and mark the location of the mounting screws.

2.

Drill the appropriate size hole for a expansion type anchor and install the anchors.

3.

Install the washers and insert the screws.

4.

Tighten the screws to within .375" of the anchor.

5.

Install the reader and finish tightening the screws.

Wood or Metal Wall Mounting
To temporarily mount the MP9320 v2.8e to a wood or sheet metal wall, SAMSys
recommends either #10 x 1 inch wood screws or #10 x 3/4 inch sheet metal screws and
washers. To install the reader on a wood or metal wall, perform the following.
1.

Refer to Figure 11, and mark the location of the mounting screws.

2.

Drill the appropriate size hole for screws.

3.

Install the washers and insert the screws.

4.

Tighten the screws to within .375" of the surface.

5.

Install the reader and finish tightening the screws.

Drywall Mounting
To temporarily mount the MP9320 v2.8e to drywall, SAMSys recommends either #10
toggle bolts or #10 drywall anchors.
NOTE: There are many types of screw-in, hammer-in, and predrill drywall anchors. Each one is
designed for specific applications and pull-out ratings. Ensure that the anchor you select
has a pull-out rating of at least 12 lbs.

To install the MP9320 v2.8e on drywall, perform the following.
1.
2.

Refer to the anchor manufactureres instructions for installing the anchors.

3.

Install the washers and insert the screws.

4.

Tighten the screws to within .375" of the surface.

5.

16

Refer to Figure 11, and mark the location of the mounting screws.

Install the reader and finish tightening the screws.

Installation

RS-485/Ethernet Communication Selection
The MP9320 v2.8e is equipped with both RS-485 and Ethernet communication ports.
However, only one can be selected at a time. The reader is typically shipped with Ethernet
communication enabled. To enable RS-485 communication, perform the following:

Caution - ESD
The following procedures involve electrostatic discharge sensitive components. ESD
protection is required. Damage to the reader can occur if proper ESD equipment such as
grounded wrist straps and ESD protected work surfaces are not used.

1.

Disconnect all power and communication cables from the reader.

2.

Remove the outer reader cover by removing the 8 screws on each side and carefully
lifting the cover straight up.

3.

Locate Jumper J4 on the connector end of the digital board (top circuit board).

4.

Move the jumper to Pins 1-2 (Pin 1 is closest to the end of the board).

5.

To re-enable Ethernet communication, move the jumper to Pins 2-3.

6.

Replace the cover and the 16 screws.

Serial (RS-232) Communication Setup
The reader is equipped with a 9-pin RS-232 communication port for communication
directly with a PC or other serial device. Refer to the Specifications chapter for
information on the port.
T
LB tenna

3

au
lt

cti

T
ra

ns

m

it

S

en

se

P

ow

er

F

1

A

2

ve

A

nte

nn
a

4

An

TM

C

V

dc

3.

0

E

ose
Cho

5

to

(1

er

R

S

-2
32

R

S

Pow

-4
85

F

U
H

The

th

ern

)

et
LA

N

EP

o

.8e

P

v2

am we
pr
m
ax

20

de
r

93

R
ea

MP

al
Digit I/O

5

4
9

3
8

2
7

1
6

DB-9 Connector

RS-232 Cable

Figure 12-MP9320 v2.8e Standalone RS-232 Communication Setup

NOTE: A serial port adapter may be required if the device has a different connector type. For
example, some PCs may have 25-pin serial connectors.

17

MP9320 v2.8e User's Guide

Every effort has been made to ensure the MP9320 v2.8e is configured to match your
application. However, it is recommended that the reader configuration be verified before
placing the reader into service. If the system is to be used as a local, standalone reader
connected to a terminal or PC, perform the following:
1.

Verify all antennas, cabling and power supplies are secure.

2.

Verify the operator terminal or PC is connected to the reader and operational.

3.

Power up the reader.

4.

Use RF Command Suit to verify the reader connection.

Ethernet LAN Communication Setup
The MP9320 v2.8e can be networked with other readers on an enterprise 10/100 BaseT
Ethernet LAN. The reader is equipped with an embedded IP device server that allows the
unit to be assigned an IP address. This address can then be accessed by your server or host
computer. Refer to Appendix C IP address configuration.
Ethernet Link

ital
Dig I/O

ital
Dig I/O

ital
Dig I/O
RS

-23

RS

2
-23
RS

5
-48

Po
we

(15

r
to
Ch
oos
e

v2
20
93ader
MPF Re
UH

The

.8e

EP

Eth

Vdc
3.0

ern

et

er max
Pow
amp
LAN

)

C

TM

Tra

ult
Fa
r
we
Po
nse
Se
it
nsm

1

Ac

2

tive

An

ten

3

na
4

L
B

T

An LB
ten T
na

ten

na

An

Ac

e An
tiv 2

a
tenn3

4

1

Fa

ult
we

r

F

R
S

-2

3

U
H

M

P

9

R
ea
de

3

2

0

Po

al
Digit I/O

RJ-45 Connector

Ba

yN

or k
et w

s

Figure 13-MP9320 v2.8e Ethernet LAN Communication Setup

Configuring the IP Address
The MP9320 v2.8e is equipped with an optional TCP/IP Ethernet port and embedded IP
device server. This reader is configured for automatic IP address allocation using the
Dynamic Host Configuration Protocol (DHCP) Mode and the reader automatically
extracts the IP address from the DHCP server. This is the default mode for the reader as it
is shipped from the factory.
In the event that you need to manually configure the IP address and Baud rate, refer to
Appendix C for detailed instructions.

18

Installation

Digital Input/Output Setup
The MP9320 v2.8e is equipped with a digital I/O port that provides four logic-level input
signals and four output signals. Refer to the SAMSys Forth Programming Language
Reference Guide for programming information. The digital inputs are optically isolated.
The outputs are open collector.

Typical output circuit
(user supplied)
+5 Vdc

Digital Inputs
Input
Common
5-24 Vdc
DIN0

Digital Outputs

4.7K
DOUT0

4.7K
DOUT1

DIN1

DIN2

DIN3

4.7K

DOUT2

DOUT3

4.7K

4.7K
Output
Common

Typical input
drive circuit
(user supplied)

Figure 14-Digital Input/Output Port Configuration

Signal Name

Pin No.

Description

DIN0
DIN1
DIN2
DIN3
Digital input common
DOUT0
DOUT1
DOUT2
DOUT3
Digital output common

7
14
13
5
8, 15
4
11
10
2
1,9,3,6,12

Digital Input 0 - optically isolated
Digital Input 1 - optically isolated
Digital Input 2 - optically isolated
Digital Input 3 - optically isolated
Input commmon
Digital Output 0 - open collector
Digital Output 1 - open collector
Digital Output 2 - open collector
Digital Output 3 - open collector
Output common

19

MP9320 v2.8e User's Guide

Configuring the MP9320 V2.8e-2 for EN 302 208 (LBT)
For MP9320 V2.8e-2 Only. This section describes how to configure the MP9320
V2.8e-2 reader for compliance with EN 302 208. This standard is commonly referred to
as Listen Before Talk (LBT) since a major action described in this standard requires the
transmitter to listen for activity on a particular channel prior to transmitting on that
channel. The MP9320 V2.8e introduces a fifth antenna port for use as a dedicated Listen
antenna. This port is not enabled on the MP9320 V2.8e-1 reader.
In contrast to EN 300 220, utilization of EN 302 208 allows usage of an expanded
frequency band and higher transmit power levels.
Currently the MP9320 2.8e-2 provides the following modes of operation for EN 302 208:
o

Use of EN 302 208 frequencies from 865-868 MHz with LBT active and listen
activity performed on the dedicated, listen-only LBT Antenna port.

o

Use of EN 302 208 frequencies from 865-868 MHz with LBT active and listen
activity performed on Antenna Port 1, 2, 3, or 4. These ports may also be used for
normal operation such as reading tags.

o

Use of EN 302 208 frequencies from 865-868 MHz with no LBT performed.

NOTE: Use of this mode may not be valid in many countries or may require a site license.
In addition, local regulatory standards may place restrictions on specific channels
and power levels.

o

Fixed frequency mode at 869.525 MHz.

MP9320 V2.8e-2 LBT configuration is controlled by several internal registers. These
registers are initially configured at the factory. In the event that the factory configuration
does not match your requirements, reconfigure the reader by performing the following:
1.

Set the transmit power for antenna ports 1-4 by setting registers TD0, TD1, TD2, and
TD3. Port 5 is listen only and does not transmit.

2.

Set the gain for each antenna by setting registers TG0, TG1, TG2, TG3, and TG4.

3.

Set the transmit power configuration by setting register TPC.

4.

Set the designated listen antenna by setting register TLB.

5.

Set the preferred channel list by setting register VFC (Optional).

Setting Transmit Power -TDx
Transmit Power on the MP9320 V2.8e is set by configuring registers TD0-TD3. The
output power is entered in tenths (1/10) of dBm with steps of 1/10 dBm. All values are
in decimal.

20

Installation

TD0-TD3 specify the conducted transmit power for antenna ports 1 thru 4
respectively. The power setting is specified in units of tenths (1/10) of dBm for these
registers. To set the conducted transmit power to 30 dBm, set the register value to 300.
To set the MP9320 V2.8e output power of antenna port 1 to 12.1 dBm, issue the
following CHUMP command to the reader:
}Cw,d:TD0,b:121,f:1!

The valid range of values for TDx is from 0 (0 dBm) to 280 (28 dBm).
Previous reader versions utilized the TP0-TP3 registers. However, use of the TPx
registers is not recommended since they require an understanding of power indices.

Setting Antenna Gain -TGx
In order to comply with ERP and threshold limits according to EN 302 208, the
MP9320 V2.8e must be configured with the proper antenna gain. Antenna gain is set
by configuring registers TG0-TG4. Before operation, you must determine the actual
antenna gain used in the installation.
TG0-TG4 specify the overall gain or loss external to the reader in the antenna and
cabling system for antenna ports 1 thru 5 respectively. These register settings are used
to calculate the effective transmit ERP and determine the actual receive signal level
present in the RF environment. The effective transmit ERP automatically determines
the listen threshold level and the set of channels used in frequency hopping as dictated
by EN 302 208.
Many antennas have a gain specified in units of dBi. These units must be converted to
dB using the following equation:
gain_dB = gain_dBi - 2.1

The total gain of the transmission system is the gain of the antenna minus the loss of
the cabling. For example, if the antenna has 4 dB of gain and the coax cable has 2 db
of loss over its length, the total gain is 2 dB.
In the MP9320 V2.8e, the gain setting is specified in tenths (1/10) of dB with an offset
of 130 (0 dB = 130). In the previous example, the total gain is 2 dB. In tenths of a dB,
this value is 20. Therefore, the register setting is 150 (130 + 20).
To set the gain of antenna port 1 to 15 dB, issue the following CHUMP command to
the reader:
}Cw,d:TG0,b:150,f:1!

21

MP9320 v2.8e User's Guide

Setting Transmit Power Configuration - TPC
The TPC register controls the following:
o

ETSI frequency hopping in the 865-868 MHz band (bit 18)

o

Frequency selection (sequential or pseudo-random) (bit 21)

o

Listen Before Talk action after each frequency hop (bit 24)

o

ETSI regulatory mode (bit 16)

To configure the reader for EN 302 208 frequencies, LBT, pseudo random hop pattern,
select the Reader Config tab on RF Command Suite and set the Transmit Power
Configuration parameters as shown in Figure 15.

Figure 15-Configuring TPC Register with RF Command Suite

Transmit, Listen Before - TLB
This register configures the designated LBT antenna. The format is similar to the antenna
number and enable scheme used in the MSW register (but only one listen antenna can be
selected). Bit 7 indicates that the antenna designation is valid, and bits 2..0 are used to
indicate the antenna port (0 - 4).
To set antenna port 5 for listening, issue the following CHUMP command to the reader:
}cw,d:TLB,b:00000084!

Preferred Frequency Channels - VFC (optional)
The VFC register is optional and is used to specify a frequency plan for each reader. This
register is beneficial if operating in an environment with several readers in close
proximity. If this functionality is not required set the VFC register to 0 (default).

22

Installation

The VFC register is used with the VF0 register to configures up to four preferred channels
from the available channel set. The VF0 register represents the available channels in the
865-868 MHz region by using a single bit to represent each 200 kHz channel. For
example, bit 0 represents 865.1 MHz.
The channel number in the VFC register is the frequency bit index of the VF0 register plus
one. For example, the channel at 866.9 MHz is the tenth channel in the 865-868 MHz band
and is represented by VF0 register, bit 9. Therefore, the corresponding VFC channel
number is 0xA.
The VFC register is a 32-bit (4 byte) register with one byte representing a channel. Each
channel is specified as either primary, secondary, or unused (value of 0). Primary or
secondary is selected by setting the most significant bit of each byte.
For example, setting bit 7 to 1 indicates that the channel in bits 6-0 is considered a primary
channel. If bit 7 is set to 0, then the channel in bits 6-0 is considered a secondary channel.
If bits 6-0 are also 0, the field is considered unused.
o

Primary Channels - Reader uses the specified primary channels unless it detects that
the primary channels are occupied. Selecting a single primary channel will result in
the reader using only 1 channel. Specifying 2 channels as primary will result in
alternatively using each channel (ping-pong).

o

Secondary Channels - Behavior same as primary channels. However, secondary
channels are only used if all specified primary channels are occupied. If all secondary
channels are also in use, the reader selects the next available channel in the hop
sequence.

The VFC register is examined when performing a frequency hop with LBT enabled. The
frequency selection performs the following:
1.

Cycle to the next specified primary channel. Reader uses this channel if not occupied
(a 100ms off time is required if the new channel is equal to the last used channel).

2.

Cycle to the next specified secondary channel. Reader uses this channel if not
occupied (a 100ms off time is required if the new channel is equal to the last used
channel).

3.

Cycle through other allowable channels as specified by EN 302 208.

Example 1
Configure the frequency selection to ping-pong between two adjacent channels (5 and 6).
In the event both primary channels are unavailable, use another adjacent channel (7).
}cw,d:VFC,b:00078685!

23

MP9320 v2.8e User's Guide

Example 2
Configure to use one primary channel. In the event that the primary channel is busy, use a
far away channel.
}cw,d:VFC,b:0a090a82!

Example 3
Configure to use four primary channels (3, 4, 5, 6). In the event that all primary channels
are busy, try all available channels as allowed in EN 302 208.
}cw,d:VFC,b:83848586!

24

Chapter 3
Operation
This chapter provides general information to operate the MP9320 v2.8e Reader. Topics
discussed in this chapter include the following:
o

Power Up and Initialization

o

Setting the RF Mode

o

Selecting the Number of Antennas

o

Selecting Tag Protocols

o

Enabling or Disabling Tag Protocols

o

Reading Tags

o

Writing Blank Tags

o

Modifying Tags

25

MP9320 v2.8e User's Guide

Power Up and Initialization
When the power supply is connected, the reader starts an internal initialization sequence.
This sequence momentarily lights the LEDs as follows:
1. Transmit and Sense on momentarily, then off
2. Sense flashes
3. Power flashes
4. Fault flashes
5. All four flash
6. Transmit and Power flash
7. Beeper on
If the Fault LED illuminates during the intialization sequence, the reader has detected a
software load fault. Restart the reader to clear the fault.

Fault

Fault

Fault

Fault

Fault

Fault

Power

Power

Power

Power

Power

Power

Sense
Transmit

Sense
Transmit

Sense
Transmit

Sense
Transmit

Sense
Transmit

Sense
Transmit

Figure 16-LED Startup Sequence

The reader is operational when the Power LED remains on.
After the startup sequence, the RF multiplexer in the reader alternately provides RF power
to each of the four antennas. The Active Antenna LEDs indicate which antenna is
transmitting.

Active Antennas
1

2

3

4

Figure 17-Active Antenna LED Indicators - Antenna 2 Transmitting

NOTE: Antennas are labeled on the reader as 1, 2, 3, and 4. However, antennas are labeled in
software as 0, 1, 2, and 3. The number of antennas and the antenna transmit sequence is
user configurable depending on the application. Refer to the following sections and
Appendix A for more information on reader configuration.
26

Operation

Starting RF Command Suite
In order to verify your installation, start RF Command Suite. This application provides the
ability to view your reader configuration and make any needed adjustments. You can also
use the application to view tag data read by the reader. For information on installing and
operating the RF Command Suite, refer to the RF Command Suite User's Guide.

Setting the RF Mode
The MP9320 v2.8e is factory configured for continuous RF scanning or "auto-read" mode.
This mode is equivalent to mode selected by the Auto Read function key on the RF
Command Suite Command interface window.
If desired, you can reconfigure the reader for Polled RF mode (reader activates the
transmit carrier and waits for host to send a read command). Select the Polled Read
function key to activate Polled RF mode.
To halt the Auto Read or Polled Read mode, press the RF Off function key.

Selecting the Number of Primary Antennas
The MP9320 v2.8e is factory configured to operate with one primary antenna connected to
Port 1. However, the reader can operate with up to four (4) antennas. If additional
antennas are to be installed, use RF Command Suite to select the number of antennas.
NOTE: The LBT antenna also requires activation. Refer to Chapter 2 - Installation for more
information on LBT configuration.

From the RF Command Suite Command interface window, select function set four (4)
and then select one of the following function keys:
F1

1 Antenna (0)

Sets the reader to use antenna 1.

F2

1 Antenna (1)

Sets the reader to use antenna 2

F3

1 Antenna (2)

Sets the reader to use antenna 3.

F4

1 Antenna (3)

Sets the reader to use antenna 4.

F5

2 Antennas (0,1)

Sets the reader to use antennas 1 and 2.

F6

3 Antennas (0,1,2)

Sets the reader to use antennas 1, 2, and 3.

F7

4 Antennas

Sets the reader to use all four antennas.

Warning
The SAMSys MP9320 UHF Reader is equipped with four (4) RF ports. To prevent reader
damage, active RF ports must be properly terminated with a 50 ohm load or a functional
UHF RFID antenna before power up. UHF Readers are factory configured to operate on
RF port 1. As a result, port 1 must be properly terminated before initially powering on the
reader. Before activating any additional RF ports, they must also be properly terminated.
Never power up the reader unless the appropriate loads or antennas are connected.
Always power down the reader before removing an antenna or load from an RF port.

27

MP9320 v2.8e User's Guide

Selecting Tag Protocols
The MP9320 is factory configured with only those protocols selected by the user. Once
protocols are activated, the Command tab function keys can be used to select the protocol.
These function keys are programmed with specific command sequences required by the
reader to select a particular protocol. To select a specific protocol, perform the following:
1. Select the Command interface window.
2. Select Function Set 2 or 3 and locate the required protocol.
3. Press the function key to select the protocol.
4. To view the commands performed by this function, hold the mouse pointer over the
key or right click while holding the mouse pointer over the key and select Edit Macro.
5. Do not change the command sequnce unless you are experienced using SAMSys
CHUMP commands to configure readers.

Enabling or Disabling Tag Protocols
If you are experienced with SAMSys reader configuration, you can enable, disable, or
modify protocols to match specific requirements. To verify which protocols are activated
for your reader, navigate to the Reader Config interface window and select:
Reader Configuration
Protocol Select Mask

General Configuration

Operating Mode

Activated protocols will be listed and whether they are enabled or disabled. To enable or
disable a different protocol, perform the following:
1.

Select the Protocol Select Word (PSW) parameters as shown in the following:

Figure 18 - Protocol Selection

2.

Enable or disable a protocol by using the selectors on the right side of the display
and press Send Changes to Reader
. See the following note.

3. To modify the selected protocol, select the Protocol Configuration Word and
make any required changes.
NOTE: The best performance is obtained when only a single protocol is enabled at one time.

For detailed information on reader configuration using RF Command Suite, refer to the
RF Command Suite Users Guide.

28

Operation

Reading Tags
Tag Reading Overview
When the reader completes the initialization sequence, the reader activates the RF field
and, depending on the configuration, begins transmitting read detect (Rd) commands at
the specified frequency. When a tag is placed within range, the reader activates the tag and
reads the data. The following example shows a typical Rd return message with ASCII tag
data that was returned by the reader:
{Rd,d:E016000000000D53,t:IS186A;C4

Reading Tags Using RF Command Suite
RF Command Suite is automatically configured to display tag data as the data is
received from the reader. However, tool settings can be changed to match your
requirements. Refer to the following sections and the RF Command Suite User's
Guide to configure the application.
To configure the RF Command Suite for your reader, perform the following:
1.

From the tool bar pull-down menu, select File

Load Macro File.

2. Navigate to C:\Program Files\SAMSys\RFCS\Macro and select the
MP9320_28_Default.txt file and press Open. This will reconfigure the function keys
and other aspects of the RF Command Suite to match the MP9320 v2.8.
3. In addition to the macro file, load the correct XML configuration file. Select the
Reader Config Interface and verify the correct XML configuration file is shown in
the Path to XML Configuration Definition.

29

MP9320 v2.8e User's Guide

4. If the path does not show the MP9320_28.xml file, press the Browse
navidate to c:\Program Files\SAMSys\RFCS\XML Data and choose
MP9320_28.xml.

button and

5. After selecting the correct XML configuration file, press Open. The file path is
automatically saved.
6. Configure the reader for Auto Read. Select the Command interface and then select
Function Set 1.

7. Press Auto Read.
8. Verify the reader is configured for the correct protocol. Select the Command
interface and then select the radio button for Function Set 2 or 3.
9. After locating the protocol on the function key, press the key to activate the protocol.
10. The MP9320 is now ready to begin reading tags.

30

Operation

Writing Blank Tags
RF Command Suite can be used to write unprogrammed or blank tags. To write blank
tags, perform the following:
1.

Select the Command Interface and verify the reader is connected and the correct
protocol is selected.

2.

Place the reader in Polled Read mode.

3.

Verify a single tag is in the RF field of the reader.

4.

Select the Tag Summary Interface.

5.

Select the protocol from the pull-down above the Write Blank Tag button.

Figure 19-Select Tag Protocol
6.

Press the Write Blank Tag
display the tag data box.

button to begin the operation and

Figure 20-Write Blank Tag
7.

Fill in the appropriate data (in Hex) and press the Write
the data to the tag.

button to write

NOTE: For detailed information on the various tag protocols and how each protocol is
programmed, refer to Appendix A -Tag Programming.

31

MP9320 v2.8e User's Guide

Modifying Tags
RF Command Suite can be used to modify previously programmed tag data. To modify
tags, perform the following:
1.

Select the Tag Summary Interface and right-click on the tag.

Figure 21-Select Tag to Modify

2.

Select Modify Tag. The tag data window is displayed.

Figure 22-Modify Tag Option
3.
4.

Enter the data Length and actual Data for the specific address

5.

Select if ASCII data and whether or not there is a Single tag in field.

6.

After all data and parameters are entered, press Write

7.

32

Select the Address from the pull-down.

Repeat for each address.

.

Chapter 4
Troubleshooting
This chapter provides general information to troubleshoot the MP9320 v2.8e Reader.
Topics discussed in this chapter include the following:
o

General Troubleshooting

o

Contact Us

33

MP9320 v2.8e User's Guide

General Troubleshooting
SAMSys readers are designed, manufactured, and tested to provide many years of troublefree service. However, in the event of a reader malfunction or failure, refer to the
following troubleshooting instructions to help identify and correct the problem.

Warning - Electric Shock Hazard
The following procedures may involve AC voltage. Use extreme caution when measuring
voltage or installing cables and power supplies. Serious injury or death may occur if
proper precautions are not observed.

Caution - ESD
The following procedures involve electrostatic discharge sensitive components. ESD
protection is required. Damage to the reader can occur if proper ESD equipment such as
grounded wrist straps and ESD protected work surfaces are not used.

Symptom
No LEDs or buzzer
during power up.

Probable Cause
Power supply
malfunction.

Corrective Action
Ensure power supply is inserted into
wall outlet. Verify correct operating
voltage at outlet.
Replace Power Supply.

Reader software is
corrupt.

Replace reader.

Reader appears to
lock up.

Readers are vulnerable
to high ESD pulses. As a
result, the reader can
lock up.

Disconnect the power from the reader
and reconnect. The reader should
reset. If the reader does not function
normally after reset, replace the reader.

Any LED fails and
buzzer alarms during
power up.

Suspect LED bad.

Reader may operate normally with one
or more bad LEDs, but the reader
should be replaced as soon as
possible.

Reader board failure.

If reader does not read or write, replace
the reader.

Buzzer malfunction.

Reader may operate normally without
buzzer, but the reader should be
replaced as soon as possible.

Reader board failure.

If reader does not read or write, replace
the reader.

Reader software is
corrupt.

Replace reader.

No buzzer on power
up.

34

Troubleshooting

Symptom
No buzzer when
reading a tag.

Probable Cause

Corrective Action

Replace reader.

External RS-232 cable
malfunction

Check cable connectors for bent or
broken pins. Replace external RS-485
cable if necessary.

Reader board failure.

Replace reader.

External RS-485 cable
malfunction.

Check cable connectors for bent or
broken pins. Replace external RS-485
cable if necessary.

Wrong jumper setting.

Ensure RS-485/Ethernet Jumper J4 is
across Pins 1-2.

Reader board failure.
No Digital I/O signals
present.

If the reader does not read or write,
replace the reader.

Reader software is
corrupt.

No RS-485
Communication.

Reader may operate normally without
buzzer, but the reader should be
replaced as soon as possible.

Reader board failure.

No RS-232
Communication.

Buzzer malfunction.

Replace reader.

Reader board failure.

Replace reader.

Tag ID/data is different Reader software
from expected value. version.

Program reader with latest software
version release.

Electromagnetic
interference.

Reposition reader or tag.
Slow tag when within range of reader.

Faulty tag.
No Ethernet
connectivity

Read range exceeded.
Tag speed exceeded.

Tag read failure.

Shield or reposition reader

Verify reader operation with a known
good tag.

External Ethernet cable
faulty.

Check cable and replace if necessary.

Wrong jumper setting.

Ensure RS-485/Ethernet Jumper J4 is
across Pins 2-3.

Wrong Ethernet IP
address.

Use the Digi Device Discovery
application to reverify IP address.

Reader board failure.

Replace reader.

35

MP9320 v2.8e User's Guide

Contact Us
For any questions regarding products and services, including returns, repairs, technical
support, training, and all other available services, contact your distributor or SAMSys
Customer Service at the following:

E-mail
Telephone
Fax

36

support@samsys.com

1-919-281-1551

1-877-367-4342 (toll free)
8:00am-6:00pm EST, Mon-Fri

Chapter 5
Specifications
This chapter describes the specifications for the MP9320 v2.8e Reader. Information
provided includes the following:
o

Reader Specifications

o

Environmental Specifications

o

Battery Specifications

o

Power Supply Specifications

o

RS-232 Connector Specifications

o

RS-485 Connector Specifications

o

Ethernet LAN Connector Specifications

o

Digital I/O Connector Specifications

o

Antenna Specifications

o

Regulatory Standards

37

MP9320 v2.8e User's Guide

Reader Specifications
Frequency

865-870 MHz

RF Power

16 mW - 3 W

Connections

RS-232, RS-485, Digital I/O (TTL), or Ethernet LAN

Input Voltage

15 Vdc +/-5%

Input Current

3A maximum

Environmental Specifications
Operating
Temperature

-4° F to 158° F (-20° C to 70° C)

Storage Temperature

-40° F to 185° F (-40° C to 85° C)

Maximum Shock

1 foot (0.3 meter) drop to any corner

Relative Humidity

5% to 95% non-condensing

Case Material

Aluminum

Case Dimensions

5.25 x 7.0 x 11.5 in (133 x 178 x 286 mm)

Weight

4 lbs (1.8 kg)

Battery Specifications (Optional)
Battery (optional)

Lithium/Manganese Dioxide

Designation

ANSI/NEDA 5012LC / IEC-CR1220

Voltage

3.0 volts

Average capacity

40 mAh to 2.0 volts

Caution - Risk of Explosion
Only replace battery with a battery of the same type and designation. There is a risk of explosion if
the battery is replaced with incorrect type. Dispose of old battery according to manufacturers
instructions and local regulations.

Power Supply Specifications
Input Voltage

100 - 240 VAC

Input Consumption 0.3 A, 31 - 45 VA
Input Frequency
Output Voltage

15 VDC

Output Current

38

50 - 60 Hz
3A

Specifications

RS-232 Connector Specifications

5

4
9

3
8

2
7

1
6

Figure 23-RS-232 Connector

Baud rate

9600 - 38400

Parity

None

Data bits

8

Stop bits

1

Pin 1

CNVSS (Normally low. High puts reader in
programming mode.)

Pin 2

TXD

Pin 3

RXD

Pin 4

DTR (shorted to pin 6)

Pin 5

GND

Pin 6

DSR (shorted to pin 4)

Pin 7

CTS

Pin 8

RTS

Pin 9

+3.3 Vdc

RS-485 Connector Specifications

1

2
3

Figure 24-RS-485 Connector

Baud rate
Parity
Data bits
Stop bits
Pin 1
Pin 2
Pin 3

9600 - 38400
None
8
1
RS-485 C (common)
RS-485 B
RS-485 A
39

MP9320 v2.8e User's Guide

RS-485/Ethernet Jumper Setting
Jumper
J4
J1
J2

Pins
1-2
2-3
1-2
1-2

Action
RS-485 enabled.
Ethernet enabled.
High side termination active.
Low side termination active.

Ethernet LAN Connector Specifications
Pin 1

Network Activity
LED (green)

Pin 8

Network Link
LED (yellow)

Figure 25-Ethernet LAN Connector

Pin 1
Pin 2
Pin 3
Pin 4
Pin 5
Pin 6
Pin 7
Pin 8
Network Link
LED
Network Activity
LED

40

TXD+ (Transmit Data +)
TXD- (Transmit Data -)
RXD+ (Receive Data +)
EPWR+ (Power from switch +)
EPWR+ (Power from switch +)
RXD- (Receive Data -)
EPWR- (Power from switch -)
EPWR- (Power from switch -)
Yellow LED indicates network link is operational. On
continuously indicates Ethernet connection made.
Green LED indicates network traffic detected.

Specifications

Digital I/O Connector Specifications

4

5
10
15

3
8

9
14

2

13

1
7

12

6
11

Figure 26-Digital I/O Connector

Signal Name

Pin No.

Description

DIN0
DIN1
DIN2
DIN3
Digital input common
DOUT0
DOUT1
DOUT2
DOUT3
Digital output common

7
14
13
5
8, 15
4
11
10
2
1,9,3,6,12

Digital Input 0 - optically isolated
Digital Input 1 - optically isolated
Digital Input 2 - optically isolated
Digital Input 3 - optically isolated
Input commmon
Digital Output 0 - open collector
Digital Output 1 - open collector
Digital Output 2 - open collector
Digital Output 3 - open collector
Output common

Suitable Antenna Specifications
Frequency

865-870 MHz

Polarization

Circular

Gain, dBic

6, max

VSWR, maximum

1.3:1

Beam Width

less than or equal to 70°

41

MP9320 v2.8e User's Guide

Regulatory Standards
Emissions
Radiated Emissions (enclosure)

EN 55022 Class B

Conducted Emissions (AC port)

EN 55022

Harmonic Distortion (AC port)

EN 61000-3-2: 1999

Voltage Fluctuation (AC port)

EN 61000-3-3

RF Spectrum (MP9320 v2.8e-1)

EN 300 220-1
EN 300 220-2

RF Spectrum (MP9320 v2.8e-2)

EN 300 220-1
EN 300 220-2
EN 302 208-1
EN 302 208-2

Immunity
Electrostatic Discharge Immunity (all ports)

EN 61000-4-2

Radiated Immunity (enclosure)

EN 61000-4-3

Magnetic Immunity (enclosure)

EN 61000-4-8

Electrical Fast Transient Immunity (all ports)

EN 61000-4-4

Lightning Surge Immunity (all ports)

EN 61000-4-5

Conducted Immunity (all ports)

EN 61000-4-6

Voltage Dips and Short Interruptions (AC port)

EN 61000-4-11

EMC

EN 301 489-1
EN 301 489-3

Safety
Electrical Safety
RFID Human Safety

42

EN 60950
EN 50364

Appendix A
Reader Configuration
This appendix describes how to change or update the MP9320 v2.8e Reader configuration
using the RF Command Suite. Refer to the RF Command Suite User's Guide for
additional information.
Information provided in this appendix includes the following:
o

Operating Modes

o

Default Configuration
- MP9320 V2.8e-1
- MP9320 V2.8e-2
- Common Configuration

o

Configuring the Reader with RF Command Suite
- Changing the RS-232 Configuration
- Changing Reader Operation Modes
- Configuring Specific Protocols

o

Updating Reader Firmware with RF Command Suite

o

Using CHUMP Commands to Configure the Reader

43

MP9320 v2.8e User's Guide

Operating Modes
SAMSys reader software is configurable to verify configuration parameters. Typical
reader parameters include the following:
o

RF communication mode (polled or continuous)

o

Serial communication mode (polled or continuous)

o

Multiplexer Configuration (# antennas, inventory rounds, and antenna hopping)

o

Serial multidrop addressing

o

Protocol configuration

o

Protocol selection

For detailed information on checking reader configuration, refer to the following sections
and the RF Command Suite User's Guide.

Default Configuration
The model specific and common factory default configurations are as follows:

MP9320 V2.8e-1
o

Fixed frequency mode at 869.525 MHz

o

Transmit power level = 0.5W/+27 dBm conducted (must be customized by installer
for each antenna port such that the combination of conducted power, antenna gain and
cable loss does not exceed +27dBm ERP)

MP9320 V2.8e-2
o
o

Transmit power level = 0.5 W/+27 dBm conducted (must be customized by installer
for each antenna port such that the combination of conducted power, antenna gain and
cable loss does not exceed +33 dBm ERP)

o

44

Use of EN 302 208 frequencies from 865 - 868 MHz with LBT active and listen
activity performed on the dedicated, listen-only LBT antenna port

Total antenna/cable gain is initially set to 0 dB (this value be customized by the
installer to reflect combined antenna/cable gain for each antenna port, including the
LBT port). For additional information on calculating antenna/cable gain, refer to the
Setting Antenna Gain -TGx section in Chapter 2 - Installation.

Reader Configuration

Common Configurations
o

RF Scanning = Continuous

o

Serial Reporting = Continuous

o

Serial Configuration
-
-
-
-

o

57600 Baud
8 data Bits
1 Stop bit
No Parity

Multiplexer Configuration
- Single antenna usage
- Antenna port 1
- 1 inventory round per antenna

o

Protocol = EPC Class1 Generation 2 (Gen2)
-
-
-
-
-
-
-
-
-

Forward Link Rate of approximately 40 kbps
Return Link Rate of approximately 160 kbps
ETSI pulse shaping
Pilot tone enabled
Modulation depth = 80%
Adaptive Round Sizing enabled
Base number of slots = 16
Automatic command retries on failure = 4
Selection process target = EPC ID memory bank

45

MP9320 v2.8e User's Guide

Configuring the Reader with RF Command Suite
RF Command Suite can be used to easily configure your reader. The Reader Config
interface provides control over the reader configuration registers that set communication
parameters, change operating modes, and control the transmitter and receiver. These
configuration registers are located under General Configuration.
In addition, individual protocol configurations can be modified. The protocol
configuration registers are located under Protocol Configuration.
NOTE: If reader configuration commands have been recently sent from the command line

or by pressing the function keys, the Reader Configuration window may not reflect
the updated settings. Refresh the Reader Configuration window by collapsing and
re-expanding the directories (see Figure 27). The updated settings should be
displayed.
1.

To configure the reader, select the Reader Config tab.

Figure 27 - Reader Configuration

2.

To modify the general configuration registers expand the directory under General
Configuration.

3.

To modify the protocol configuration registers expand the directory under Protocol
Configuration.

Caution
SAMSys readers use internal registers to provide a high degree of flexibility in
setting operational parameters. However, improper setting of these registers can
result in reader inoperability or permanent damage. For detailed information on
reader and protocol configuration registers, refer to the Comprehensive Heuristic
Uniform Messaging Protocol (CHUMP) Reference Guide and the Field Installation
Guide.

NOTE: To make any reader changes permanent, the changes must be written to non-

volatile memory (NVM). To make changes permanent, select the Persistence Flag
option
before sending the change to the reader.

46

Reader Configuration

Changing the RS-232 Configuration
To confiure the reader's serial port parameters, perform the following:
1.

Select the RS-232 UART parameters as shown in the following:

Figure 28 - RS-232 Serial Port Configuration

2.

Make any changes using the pull-down menus and selectors on the right side of the
display and press Send Changes to Reader

.

NOTE: The operating parameters for each RS-232 UART should be the same. Ensure that the
values for baud rate, stop bits, data bits, parity, and echo are the same for UARTS 1, 2,
and 3.

Changing Reader Operation Modes
The reader's serial and RF modes can be configured for polled or continuous operation. In
addition, the RF On when Idle mode can be set. To change any of the operating modes,
perform the following:
1.

Select the specific General Configuration Word (GCW) parameters as shown in the
following:

Figure 29 - Serial and RF Mode Configuration

2.

Make any changes using the selectors on the right side of the display and press
Send Changes to Reader

.
47

MP9320 v2.8e User's Guide

Configuring Specific Protocols
Individual Protocol Configuration registers can be modified for specific tag types and read
modes. For specific protocol configuration register information, refer to the
Comprehensive Heuristic Uniform Messaging Protocol (CHUMP) Reference Guide. To
configure individual protocol registers, perform the following:
1.

Select the individual protocol configuration word parameters.

Figure 30 - Protocol Parameter Configuration

2.

48

Enable or disable a specific protocol parameter by using the selectors on the right
side of the display and press Send Changes to Reader
.

Reader Configuration

Updating Reader Firmware with RF Command Suite
Periodically, SAMSys releases updated reader firmware that incorporates new protocols,
enhanced features, and updated FlashROM images. SAMSys readers can be updated with
new firmware using RF Command Suite. Refer to the RF Command Suite Users Guide for
detailed information on this application.

An
tive2

a
tenn3

4

Ac
1

M

UH P
F 93
Lo
ng 20
-R
an 2
g e .7
Re E
a d PC
er

ult
Fa
r
we
Po
nse
Se
it
sm
Tran

-232

R (1
S5
-4
85 Vdc
& 2.
D5
ig am
ital
I/O p

m

ax

)

RS

we
Po

r

Figure 31-Firmware Upload System Configuration

Receiving Updated Firmware from SAMSys
Updated firmware is available by contacting SAMSys customer support. The firmware
file has a .chp extension and is typically included in a zipped release file such as
"EPCReader_1.36.10.zip"
Copy the files to a PC or other host computer connected to the reader.

Uploading Firmware with RF Command Suite
When uploading a file, RF Command Suite sends one line at a time and waits for the {a
response from the reader before sending the next line. If an e: is received, indicating an
error, the upload aborts.
To upload firmware to a reader, perform the following:
1.

Connect the reader to the PC using the RS-232 or Ethernet port as required.

2.

Start RF Command Suite.

3.

Select the Command interface window and turn off the RF output by pressing the
RF Off function key.

4.

Select the Upload File tab.

5.

Browse to the file to upload. To use the directory navigator, press the Browse button
.

49

MP9320 v2.8e User's Guide

Figure 32 - Upload File Controls

6.

7.

When you are ready to upload the file, press Start

8.

The file will be uploaded to the reader. During upload, a bar graph indicates what
percentage of the file has been sent.

9.

50

When uploading FORTH files, insert a time delay between each line of the file.
Select the Send with delay option and enter a time delay in milliseconds. A time
delay is not necessary with .chp files.

If the file cannot be sent, a File Transfer Timeout error is displayed.

.

Reader Configuration

Using CHUMP Commands to Configure the Reader
In addition to using RF Command Suite to reconfigure a reader, individual CHUMP
commands can be sent to the reader from RF Command Suite or a terminal/command
console. To setup a SAMSys reader, the Configuration Write (Cw) command is used to
write a three-letter configuration variable name and a 32-bit word to the reader. This word
contains the individual setup parameters required by the reader.
For specific syntax information on the Cw command, refer to Chapter 2 in the
Comprehensive Heuristic Unified Messaging Protocol Reference Guide.
Commonly used configuration variables include the following:
o

GCW - General Configuration Word

o

SCW - Serial Configuration Word (CHUMP 1.31 and above)

o

MCW - Multiplexer Configuration Word

o

SMA - Serial Multidrop Address

o

PCW - Protocol Configuration Word

o

PSW - Protocol Select Word

o

Pxx - Specific Protocol Configurations

o

CNR - Self Training Control

The following example shows the Cw command used to write the MCW to the reader.
}Cw,d:MCW,b:00040200! & lt; CRLF & gt;
where:
00040200 = 4 antennas, 2 inventory round operations
per antenna.
If the Cw command was successful, the reader responds with:
{A7; & lt; FCS & gt; & lt; CRLF & gt;

Warning
The SAMSys MP9320 v2.8e Reader uses internal registers to provide a high degree of
flexibility in setting operational parameters. The use of these registers is described in the
MP9320 User's Guide, the MP9320 UHF Reader Field Installation and Calibration Guide,
and the Comprehensive Heuristic Unified Messaging Protocol (CHUMP) Reference
Guide. However, improper setting of these registers can result in reader inoperability or
permanent damage.
In particular, the TPC, TD0, TD1, TD2 and TD3 registers control the transmit power of the
reader. The user should not modify these registers unless specifically directed by SAMSys
personnel. Trained, professional installers should only modify them as part of the transmit
calibration procedure described in the Field Installation Guide.

51

MP9320 v2.8e User's Guide

52

Appendix B
Tag Programming
This appendix describes how to program tags of varying protocols using CHUMP
commands sent from a terminal or console.
Information provided in this appendix includes the following:
o

Overview of the Tag Writing Command

o

Programming the EPC1 Tag

o

Programming the ISO 18000-6A Tag

o

Programming the ISO 18000-6B Tag

o

Programming the Impinj EPC0 Tag

o

Programming the Matrics Class 0+ Tag

o

Programming the EPC1, Generation 2 Tag

53

MP9320 V2.8e User's Guide

Overview of the Tag Writing Commands
Tag writing with SAMSys readers is performed using the Write Any (Wa), Write Tag
(Wt), and Write Verify (Wv) commands Wa must be used when writing to blank tags. Wt
is used when the tag already has a tag ID. Wv is a multifunction command that performs
any erase, write, and verification needed to program a tag in a specific protocol. This
command can also lock the data. A general guideline for using each write command is as
follows:
Wa is used whenever the write operation affects the tag ID. Wa can also be used for write
operations to any data on a tag. This command is executed with a single tag in the RF
field.
Wt can only be used for write operations to a specific tag where the tag ID has already
been assigned. This command can be used for write operations to any data on the tag,
except the tag ID itself.
Wv can be used for most protocols. However, it is typically used for EPC protocols that
require multiple actions such as erasing the tag prior to writing and then locking the data.
Some tags support the ability to have a portion or all of their internal memory locked
against further modification. Write operations to locked memory will not be successful.
The locked status of a piece of memory can be queried via the Yl command. The Yl
response is f:0 for unlocked or f:1 for locked.
Details of the syntax for any command found in this document can be obtained in the
CHUMP Reference Guide.

54

Tag Programming

Programming the EPC1 Tag
SAMSys UHF readers can be used to program 64-bit and 96-bit EPC1 tags.
Both the Wa and Wv command can be used with the EPC1 (Alien) tags. The Wv command
is discussed at the end of this section.
Do not use Wt since the tag does not support singulated write operations.
Prior to writing, EPC1 tags must be erased. The Wv command and the Wa with the f:3
option will perform the erase action during command execution. If the command specified
does not erase the tag during the command execution, then specify the erase operation
separately using the Tag Erase (Te) command.
Also, in order to calculate the CRC, the entire tag ID must be presented to the reader in
one command. EPC1 tags contain an internal CRC value which covers the EPC ID and the
kill passcode. The reader always calculates the CRC and writes the correct value to the
tag during the write operation. As a result, the entire tag ID and passcode must be
presented to the reader in one command. The last byte of the blk data passed in the Wa
command is the kill passcode. In the examples that follow, this passcode is set to 00.
The format of the Wa command is as follows:
}Wa,a: & lt; blk addr & gt; ,b: & lt; blk data & gt; [,l: & lt; # blks & gt; ]
[,f: & lt; control flag & gt; ]!
where:
a: & lt; blk addr & gt; . This parameter is optional since there is only a single writeable
piece of memory. If specified, the parameter should use block address 0x00.
l: & lt; # blks & gt; . This parameter reflects the number of bytes being written and should
be equal to 9 if writing a 64-bit EPC ID with the kill passcode or equal to d if writing
a 96-bit EPC ID with the kill passcode. If you are not specifying the kill code, the
values should be 8 and C, respectively.
b: & lt; blk data & gt; . This parameter must contain the entire EPC ID (64- or 96-bit),
followed by the one byte kill passcode.
f: & lt; control flag & gt; . This parameter controls operations related to writing a tag.
Set f:1 to verify the data in the tag following the write operation. Set f:2 to erase
the data prior to the write operation. For most applications, set both of these bits with
f:3.
The following is a typical command to write a 96-bit EPC1 ID tag:
}wa,a:0,b:80020304050607090a0b0c0e00,l:d,f:3!
The following is a typical command to write a 64-bit EPC1 ID tag:
}wa,a:0,b:800080042504600200,l:9,f:3!

55

MP9320 V2.8e User's Guide

In addition to the Wa, Te, and Tr commands, SAMSys readers also support the following
EPC1 operations:
o

Lb Lock Block

o

Yl Query Lock Status (returns f:0 for unlocked or f:1 for locked)

o

Td Tag Destroy

The Lock Block and Query Lock Status operations can only be performed with a single
tag in the RF field and do not require any parameters. The Tag Destroy operation requires
the b: parameter to specify the particular kill passcode for this tag.
For detailed information on these and other tag commands, refer to the Comprehensive
Heuristic Unified Messaging Protocol (CHUMP) Reference Guide.

Using the Wv Command
The Wv command is a multifunction command that performs any erase, write, and
verification needed to program a tag in a specific protocol. The command can also lock the
data.
The format of the Wv command is as follows:
}Wv,b: & lt; EPC data & gt; ,m: & lt; lock mask & gt; ,k: & lt; kill code & gt;
where:
b: & lt; EPC data & gt; is the EPC ID to write to the tag.
k: & lt; kill code & gt; is the kill code to be written to the reader.
m: & lt; lock mask & gt; is the lock mask to indicate which tag field to lock. Each 4-bit
nibble in the mask indicates the lock state to apply to a specific part of the tag. A mask
nibble value of 1 locks the specific part of the tag. A mask nibble value of 0 indicates
no lock is applied.
For the EPC1 protocol, the mask nibbles apply to the following fields:
Mask Nibble

4

3

2

1

0

Tag Field

Unused

Unused

Unused

Kill code

EPC data

To write an EPC ID value of 332233445566778899aabbcc and verify the write, enter:
}wv,b:332233445566778899aabbcc!
To write the EPC ID data and lock the data, enter:
}wv,b:332233445566778899aabbcc,m:1!

56

Tag Programming

Programming the ISO18000-6A Tag
Both the Wa and Wt command can be used with the ISO18000-6A tag. In addition to Wa
and Wt, two additional commands can modify specific data in the tag. The Wd command
modifies the DSFID and Wf modifies the AFI.
Typically, the Wt command is used to modify user data in the tag. The Wt, Wd, and Wf
commands require the tag ID to be in the d: parameter. Also, the tag must first be put in
the SELECT state using the Ts command with the tag ID specified in the d: parameter.
NOTE:

Some varieties of ISO18000-6A tags are not writeable. Check with your tag vendor
to verify if your tag supports write operations.
The format of the Wa command is as follows:
}Wa,a: & lt; blk addr & gt; ,b: & lt; blk data & gt; [,l: & lt; # blks & gt; ]!
where:
a: & lt; blk addr & gt; . In ISO18000-6A, only a single block can be written at one time
and this parameter represents the specific four byte block.
l: & lt; # blks & gt; . This parameter is optional since each write operation must contain
exactly four bytes.
b: & lt; blk data & gt; . This parameter must contain four bytes of data.
The following is a typical command to write to an ISO18000-6A tag:
}wa,a:0,b:01020304!
For example, to write AABBCCDD to address 0x20 on a tag with ID
E00300001122334455667788, issue the following command:
}wt,d:E00300001122334455667788,a:20,b:AABBCCDD!
In addition to the Wa, Wt, Wd, and Wf commands, SAMSys readers also support the
following EPC1 operations:
o

Lb Lock Block

o

Yl Query Lock Status (returns f:0 for unlocked or f:1 for locked)

Each of these operations must specify a particular tag ID using the d: parameter or first be
put in the SELECT state using the Ts command with tag ID specified in the d: parameter.

57

MP9320 V2.8e User's Guide

Programming the ISO18000-6B Tag
In ISO18000-6B, operations are controlled by a state machine within the tag. As a result,
the tag must be in the Data Exchange state for the write operation to succeed. To
guarantee the tag is in that state, the tag must be reset using the Tag Reset Tr command
followed by a Read Detect Rd command prior to performing the first write operation.
The ISO18000-6B protocol does not provide any feedback on a global write operation and
the reader always provides an Ack ({A) after the tag receives a Wa command. The only
way to verify success is to read the data back from the tag.
An ISO18000-6B tag write operation can fail if any byte within the addressed range is
locked or if the power setting is not correct. It is not uncommon for Philips and Rafsec
ISO18000-6B tags to have a portion of the first eight bytes locked. Confirm the status of
the specific type of tag in use.
The Wa, Wt and Wv commands can be used with the ISO18000-B tag. The Wt command
is used to modify data outside of the first 8 bytes in the tag and requires specification of
the tag ID using the d:parameter. The Wv command is discussed at the end of this section.
The format of the Wa command is as follows:
}Wa,a: & lt; blk addr & gt; ,b: & lt; blk data & gt; [,l: & lt; # blks & gt; ]!
where:
a: & lt; blk addr & gt; . In ISO18000-6B, this parameter provides the address of the
writeable memory block. The block size is one byte.
l: & lt; # blks & gt; . This parameter reflects the number of blocks being written (which is
equal to the number of bytes in this case).
b: & lt; blk data & gt; . This parameter contains the actual data being written.
The following command example command writes AABBCCDD to user memory at address
0x20 on a tag with ID EF04001122334455:
}wt,d:EF04001122334455,a:20,b:AABBCCDD,l:4!
In addition to the Wa and Wt commands, SAMSys readers also support the following
ISO18000-6B operations:
o

Lb Lock Block

o

Yl Query Lock Status (returns f:0 for unlocked or f:1 for locked)

Each of these operations must specify a particular tag ID with the d: parameter and block
address with the a: parameter.

58

Tag Programming

UCODE Programming
Writing multiple bytes anywhere in the first eight bytes of a UCODE tag requires the use
of the Wa command. Only a single tag should be present in the RF field for a Wa operation.
The Wa command can be used to modify any byte in the tag.
For single byte write operations, use the Wt command.
The ISO18000-6B UCODE tag can emulate a 96- or 64-bit EPC ID tag by writing data to
multiple locations in the tag and enabling the appropriate mode in the reader. This
capability is more fully described in the Implementation of EPC Tag Data on UCODE
EPC 1.19 Application Note from Philips Semiconductor. For detailed information on
reader configuration for this tag, refer to the P6B Configuration Register description in the
SAMSys Comprehensive Heuristic Unified Messaging Protocol (CHUMP) Reference
Guide.
To configure a UCODE tag for a 96-bit EPC ID of 3114F4DA34B2D05E01010101,
send a Tag Reset Tr command followed by a Read Detect Rd command. Then issue the
Wa commands:
}Tr!
}Rd!
}wa,a:2,b:315E01010101,l:6!
}wa,a:10,b:14F4Da34B2D0,l:6!
To configure a UCODE tag for a 64-bit EPC ID of 4066771122334455, send a Tag
Reset Tr command followed by a Read Detect Rd command. Then issue the Wa
commands:
}Tr!
}Rd!
}wa,a:2,b:401122334455,l:6!
}wa,a:10,b:6677,l:2!

59

MP9320 V2.8e User's Guide

Using the Wv Command
The Wv command is a multifunction command that performs any erase, write, and
verification needed to program a tag in a specific protocol. The command can also lock the
data.
The format of the Wv command is as follows:
}Wv,b: & lt; EPC data & gt; ,u: & lt; user memory & gt; ,m: & lt; lock mask & gt; !
where:
b: & lt; EPC data & gt; is the EPC ID to write to the tag.
u: & lt; user memory & gt; is the user data to be written to the tag. The number of bytes
varies depending on the tag.
m: & lt; lock mask & gt; is the lock mask to indicate which tag field to lock. Each 4-bit
nibble in the mask indicates the lock state to apply to a specific part of the tag. A mask
nibble value of 1 locks the specific part of the tag. A mask nibble value of 0 indicates
no lock is applied.
For the ISO18000-6B protocol, the mask nibbles apply to the following fields:
Mask Nibble

4

3

2

1

0

Tag Field

User Memory

Unused

Unused

Unused

EPC data

To write an EPC ID value of 332233445566778899aabbcc and verify the write, enter:
}wv,b:332233445566778899aabbcc!
To write the EPC ID data and lock the data, enter:
}wv,b:332233445566778899aabbcc,m:1!

60

Tag Programming

Programming the Impinj EPC0 Tag
In EPC0, there is no single standard for performing write operations and there are noteable
differences between manufacturers. Some varieties of EPC0 tags are not writeable. This
section addresses writable EPC0 tags produced by Impinj.
The Wa, Wt and Wv commands can be used to write EPC0 tags. The Wv command is
discussed at the end of this section.
The format of the Wa command is as follows:
}Wa,a: & lt; blk addr & gt; ,b: & lt; blk data & gt; [,l: & lt; # blks & gt; ]
[,d: & lt; tag ID & gt; ]!
where:
a: & lt; blk addr & gt; . This parameter provides the address of a writeable memory block.
The block size is one row which is two bytes. The Control Word (a:1) must be
written for the desired EPC ID length.
l: & lt; # blks & gt; . This parameter is required and is the number of bytes being written.
b: & lt; blk data & gt; . This parameter is required and contains the data to write.
d: & lt; tag ID & gt; . This parameter is required for the Wt command (optional for Wa) and
specifies the EPC code of the tag to which the write operation applies.
Typically, the Wt command would be used to modify user data in the tag. The Wt
command requires specification of the tag ID using the d: parameter.
In addition to the Wt command, the reader also supports the following operations:
o

Lb Lock Block

o

Yl Query Lock Status (returns f:0 for unlocked or f:1 for locked)

o

Td Tag Destroy

The Lock Block and Query Lock Status operations must be performed with a single tag in
the RF field and do not require any parameters. The Tag Destroy operation requires d:
parameter to specify a particular tag ID and the b:parameter to specify the particular kill
passcode for this tag.
For detailed information on these and other tag commands, refer to the Comprehensive
Heuristic Unified Messaging Protocol (CHUMP) Reference Guide.

61

MP9320 V2.8e User's Guide

Program a 96-Bit EPC (Impinj Zuma Tags)
To write a 96-bit EPC on an Impinj Zuma EPC0 tag, enter the following:
}te!
}wa,a:1,l:1,b:7!
Once the tag has been set to 96 bit, use a single Wa command for subsequent Tag ID
writes:
}Wa,a:4,l:6,b:306c50fd76d803cf02f47f5f,f:3!
where:
a:4 is the start of the EPC
l:6 is the length in rows
b:xxxx is the 96-bit EPC code
f:3 is the command to calculate the CRC. The CRC is calculated and written to the
row following the EPC code.

Program a 64-Bit EPC (Impinj Zuma Tags)
To write a 64-bit EPC on an Impinj Zuma EPC0 tag, enter the following:
}te!
}wa,a:1,l:1,b:5!
Once the tag has been set to 64 bit, use a single Wa command for subsequent Tag ID
writes:
}Wa, a:4,l:5,b:c80507a8009af9d71021!
where:
a:4 is the start of the EPC
l:5 is the length of the EPC and CRC in rows
b:xx is EPC and CRC

Program a 48-Bit Product Code (Impinj Zuma Tags)
In the following example, the 48-bit product code is written first and then the16-bit serial
number is written at a later time. To write the 48-bit product code, enter:
}te!
}wa,a:1,l:1,b:4!
Once the tag has been set to 48 bit, use a single Wa command for subsequent Tag ID
writes:
}Wa, a:4,l:3,b:c80507a8009a!
To write the 16-bit serial number, enter the following:
}Wa, a:7,l:2,b:fa6e7380!
62

Tag Programming

Program the User Data (Impinj Zuma Tags)
To program user data on a 96-bit Impinj Zuma Tag, data is written to specific Rows (must
not be locked). To write 2 rows of user data to User Row 11 and 12 (b hex), enter:
}Wa, a:b,b:1234abcd,l:2!

Change the Passcode (Impinj Zuma Tags)
To change the Passcode on an Impinj Zuma Tag, enter the following:
}Wa,a:2,l:2,b:123456!
where:
l must equal 2
b must be 6 digits

Using the Wv Command
The Wv command is a multifunction command that performs any erase, write, and
verification needed to program a tag in a specific protocol. The command can also lock the
data.
The format of the Wv command is as follows:
}Wv,b: & lt; EPC data & gt; ,k: & lt; kill code & gt; ,m: & lt; lock mask & gt; !
where:
b: & lt; EPC data & gt; is the EPC ID to write to the tag.
k: & lt; kill code & gt; is the kill code to be written to the reader.
m: & lt; lock mask & gt; is the lock mask to indicate which tag field to lock. Each 4-bit
nibble in the mask indicates the lock state to apply to a specific part of the tag. A mask
nibble value of 1 locks the specific part of the tag. A mask nibble value of 0 indicates
no lock is applied.
For the EPC0 protocol, the mask nibbles apply to the following fields:
Mask Nibble

4

3

2

1

0

Tag Field

User Memory

Unused

Unused

Kill code

EPC data

To write an EPC ID value of 332233445566778899aabbcc and verify the write, enter:
}wv,b:332233445566778899aabbcc!
To write the EPC ID data and lock the data, enter:
}wv,b:332233445566778899aabbcc,m:1!

63

MP9320 V2.8e User's Guide

Programming the Matrics Class 0+ Tag
Matrics Class 0+ tags utilize a process called Singulation. This is a process of uniquely
identifying a tag in a population of tags and retieving its Electronic Product Code (EPC).
For detailed information on EPC Class 0 singulation, refer to the EPC Global Class 0
specification.
When a tag is requested to identify itself, it responds with different data based on its
singulation mode. Class 0 and Class 0+ tags allow three modes of singulation:
o

ID2 - This mode responds directly with the EPC. ID2 is the fastest mode (fewest bits
transmitted), but requires the reader to echo the bits back to the tag. This echo can
create security issues. Also, this mode can not be read when writing the EPC, since the
echo will change the EPC as you write it.

o

ID0 - This mode returns packets of 12 random bits that are different every time you
singulate. When the reader has what it determine is the correct number, it writes the
EPC. This mode is the only reliable method of singulation during writing the tag EPC.

o

ID1 - This mode is the same as ID0, but every singulation returns the same bit stream.
The bits are random, but they are seeded from the EPC. Writing the EPC changes
these bits.

The singulation mode is controlled with the PE0 register and must be set prior to writing
tags.
Matrics Class 0+ tags contain three writable pages or memory blocks: These pages are as
follows:
o

Page 0 - Kill code (24 bits)

o

Page 2 - EPC code (64 or 96 bits)

o

Page 3 - User data (104 bits)

When Page 2 or Page 3 data is written, a 16-bit CRC is appended.
The Wa, Wt and Wv commands can be used to write Matrics Class 0+ tags. The Wv
command is discussed at the end of this section.
The format of the Wa command is as follows:
}Wa,a: & lt; blk addr & gt; ,b: & lt; blk data & gt; [,l: & lt; # blks & gt; ]
[,d: & lt; tag ID & gt; ]!
where:
a: & lt; blk addr & gt; . This represents the memory page of the tag on which the write
operation will occur. Values can be 0, 2 or 3, as defined previously. If this parameter
is missing, it will default to 0.
l: & lt; # blks & gt; . This parameter is required and is the number of bytes being written.
b: & lt; blk data & gt; . This parameter is required and contains the data to write.
d: & lt; tag ID & gt; . This parameter is required for the Wt command (optional for Wa) and
specifies the EPC code of the tag to which the write operation applies.
64

Tag Programming

Writing Initial EPC Code to Blank Matrics EPC0+ Tags
To write the EPC code to blank tags, ID0 singulation must be used.
If ID2 traversal is to be inhibited on subsequent tags, set the traversal inhibit bit in PE0.
Once written, those tags will not singulate using ID2 unless the EPC code is erased and
then rewritten with traversal inhibit cleared.
Once a valid EPC code is written to Page 2, it cannot be overwritten unless the tag is first
erased. Tag write operations using ID0 singulation cannot distinguish if a tag has
previously been singulated.
Each ID0 singulation will use a new random number. To prevent a single tag from
continually being selected for EPC code writing, an error code is returned if the tag
already has a valid EPC code and an overwrite is blocked.
As stated earlier, the mode must be set prior to writing tags. A typical value for the TM0
register is b:0. A typical value for the PE0 register for writing blank tags is b:12050180.
This value sets PE0 for the following:
o

Use ID0 singulation with 2 blocks of random bits

o

Retry count set to 5 (set to a 1 speeds up the write process with only 1 retry)

o

Scroll first turned on

o

Autolength EPC enabled (set the right most digits to 04 for a 64 bit and 08 for a 96 bit)

To write the PE0 register, enter the following: }Cw,d:PE0,b:12050180!
To sense a tag with a valid CRC and an EPC = all 00's, write b:1a050180 to the PE0
register. The last 4 digits displayed are the CRC. You should attempt to get good read rates
before trying to write to the tags.
Use the "f:2" so you don't get an e:55 for trying to overwrite a valid EPC (make sure there
is only 1 tag in the field). If you are only writing the EPC code, there is no need to do a
"te", since the write command process with the f:2 always erases the memory
To write a 96-bit EPC code to a blank tag you may need to set the PE0 register to
b:1a050108, and enter the following:
}Wa,a:2,b:312233445566778899aabbcc,l:c,f:2!

NOTE:

Writing to tags is very sensitive to the following:
-

RF power (Generally need more power to write than to read tags)

-

Tag spacing from the antenna (Need to get enough power coupled into the tag)

-

Orientation of the tags

65

MP9320 V2.8e User's Guide

Writing a Kill Code and User Data
Kill codes and user data can be written to any tag in the field in the same manner as the
EPC code method described above, but typically a kill code and user data would be
associated with a specific EPC code. Once written, you cannot read back the kill code.
To write a Kill Code, enter the following:
}Wa,a:0,b:112233,l:3!
To write to a specific tag, enter the EPC code as the d: parameter. The following write
command would write the Kill code and singulates using ID2, so PE0 singulation bits are
ignored:
}Wt,a:0,d:220000000000000000000003,b:112233,l:3!

Writing User Data
To write user data to Page 3 on any tag, enter the following(overwrites any current data):
}wa,a:3,d:112233445566778899AABBCC,l:c!
To write user data to page 3 of a specific tag, enter the EPC code as the d: parameter
(singulates using ID2, so PE0 singulation bits ignored):
}Wt,a:3,d:30112233445566778899aabb,b:00112233445566778899
aabbcc,l:d!

Tag Erase
To erase a Matrics 0+ tag, use the Tag Erase Te command. Only one tag should be in the
field when executing this command. All memory pages are filled with 0's and a 16-bit
CRC is appended.
After erasing, the EPC code page will be filled with 0's. Also, the user data page will have
all 0's with a 16 bit CRC appended at the end. This allows the user data page to be read
with the Ra command. However, the EPC code page will return an error on Ra, since
there is no valid CRC. If any page is locked, then the Te command will fail and none of
the pages will be erased.
To erase a tag, enter the following:
}Te!

66

Tag Programming

Locking Tags
Individual memory pages can be locked with the Lb command. Once a page is locked, it
cannot be unlocked or written. The following are typical Lock commands.
To lock Page 0 (Kill code of any tag singulated using PE0 bits), enter:
}Lb!
To lock Page 2 (Kill code of any tag singulated using PE0 bits), enter:
}Lb,a:2! (locks page 2, the EPC code of any tag singulated using PE0 bits)
To lock Page 3 (User data with specific EPC code), enter:
}Lb,a:3,d:220000000000000000000003!

Using the Wv Command
The Wv command is a multifunction command that performs any erase, write, and
verification needed to program a tag in a specific protocol. The command can also lock the
data.
The format of the Wv command is as follows:
}Wv,b: & lt; EPC data & gt; ,k: & lt; kill code & gt; ,m: & lt; lock mask & gt; !
where:
b: & lt; EPC data & gt; is the EPC ID to write to the tag.
k: & lt; kill code & gt; is the kill code to be written to the reader.
m: & lt; lock mask & gt; is the lock mask to indicate which tag field to lock. Each 4-bit
nibble in the mask indicates the lock state to apply to a specific part of the tag. A mask
nibble value of 1 locks the specific part of the tag. A mask nibble value of 0 indicates
no lock is applied.
For the EPC0 protocol, the mask nibbles apply to the following fields:
Mask Nibble

4

3

2

1

0

Tag Field

Unused

Unused

Unused

Kill code

EPC data

To write an EPC ID value of 332233445566778899aabbcc and verify the write, enter:
}wv,b:332233445566778899aabbcc!
To write the EPC ID data and lock the data, enter:
}wv,b:332233445566778899aabbcc,m:1!

67

MP9320 V2.8e User's Guide

Programming the EPC1, Generation 2 Tag
EPC Class1, Generation 2 (Gen2) tags can be programmed by the SAMSys UHF readers.
EPC1, Gen2 tags support 4 different writable memory banks with each memory bank
consisting of a series of 16 bit words. Each word can be written independently and one
word is the smallest size write operation supported. In most cases, these memory banks
have predefined contents and functions. The memory banks are as follows:
o

Access Memory (bank 0)

o

EPC Memory (bank 1)

o

TID Memory (bank 2)

o

User Memory (bank 3)

Access Memory
The Access Memory bank contains the 32 bit Kill Password and the 32 bit Access
Password. The Kill Password is at offset 0 and the Access Password is at offset 2.

EPC Memory
The EPC Memory bank contains a CRC-16, the Protocol Control bits, and the actual EPC
ID. The CRC-16 is at offset 0, the Procotol Control is at offset 1, and the EPC ID begins
at offset 2.
The Gen2 tag generates the CRC-16 at power up while the Protocol Control bits. The EPC
ID must be set by a RFID interrogator. The Protocol Control bits must be set initially on a
blank tag prior to, or in conjunction with, writing the EPC ID. Once these bits are set,
multiple writes can occur to the EPC ID.
NOTE:

After writing the EPC ID, a tag will respond but the CRC will be invalid since the
tag only generates the CRC on power up. Therefore, the tag must be reset via a
RF Off/On cycle following the write and prior to new tag inventory attempts. If the
reader is being operated with GCW = 0, this reset is not needed since the RF field
is automatically turned off at the completion of the write command.

TID Memory
The TID Memory bank contains an 8 bit ISO/IEC 15963 allocation class identifier (the
value of 111000010b is used for EPC Global). This identifier is located in the lower half
of the word at offset 0. A tag may contain manufacturer specific data at offset 2 and
above.

User Memory
The User Memory bank contains user specific data and its memory organization is user
defined.

68

Tag Programming

Writing the Tag
Three CHUMP commands can be used to write to an EPC1, Gen2 tag: Wa, Wt, and Wv.
Wa writes to any tag in the field and is typically used to write the EPC ID to tag. Wt writes
to a specific tag, as defined in the input parameter list, and is typically used to write to user
data on a tag. Wv is a multifunction command that erases, writes, and verifies a tag.

Using the Wa Command
The format of the Wa command is as follows:
}Wa,a: & lt; blk addr & gt; ,b: & lt; blk data & gt; [,l: & lt; # blks & gt; ][,s: & lt; offset & gt; ]
[,f: & lt; xxx & gt; ]!
where:
a: & lt; blk addr & gt; is the block address (0 by default). For EPC1, Gen2
0=Reserved,1=EPC, 2=TID, 3=USER memory bank
b: & lt; blk data & gt; is the block data to write. Must be 16-word multiple.
l: & lt; # blks & gt; is the length in 16-bit words. Defaults to length of data if missing.
s: & lt; offset & gt; is the offset to start the write (EPC1, Gen2 only). Defaults to 0 if.
f: & lt; xxx & gt; is protocol specific flag data. Set f=1 for read back/verify. EPC1, Gen2
tags provide SUCCESS/FAIL feedback. Defaults to 0.
To write an EPC ID value of 332233445566778899aabbcc onto a tag with the Protocol
Control field set for a 96 bit tag, enter:
}wa,a:1,s:2,b:332233445566778899aabbcc!
To add the length field, enter:
}wa,a:1,s:2,b:332233445566778899aabbcc,l:6!
To request a read/verify cycle following the write operation, enter:
}wa,a:1,s:2,b:332233445566778899aabbcc,l:6,f:1!
In order to write an EPC ID to a blank tag, the Protocol Control bits must also be set. This
can be accomplished in a single write command since the Protocol Control bits are
contained in the same memory bank as the EPC ID. Following the previous example, the
command would include setting the Protocol Control to 3000 as follows:
}wa,a:1,s:1,b:3000332233445566778899aabbcc!
The Kill and Access Passwords are contained in the Reserved Memory bank. Each
password can be written with separate Wa commands or a single command:
To write a 32-bit Access password at offset 2, enter:
}wa,a:0,s:2,b:55667788!
To write both Access passwords with a single command, enter:
}wa,a:0,b:3322334455667788!
69

MP9320 V2.8e User's Guide

Using the Wt Command
The Wt command can also be used to write the Kill and Access passwords and the TID
and User Memory banks. The Wt command requires the use of the EPC ID of the tag.
The format of the Wt command is as follows:
}Wt, b: & lt; data & gt; ,d: & lt; tag id & gt; a: & lt; block address & gt; [,l: & lt; length & gt; ]
[,s: & lt; offset & gt; ][, f: & lt; flags & gt; ]!
where:
a: & lt; block address & gt; is the block address (0 by default). For EPC1, Gen2
0=Reserved,1=EPC, 2=TID, 3=USER memory bank
b: & lt; blk data & gt; is the block data to write. Must be 16-word multiple.
d: & lt; tag ID & gt; is the tag identification.
l: & lt; # blks & gt; is the length in 16-bit words. Defaults to length of data if missing.
s: & lt; offset & gt; is the offset to start write (EPC1, Gen2 only). Defaults to 0 if missing.
f: & lt; xxx & gt; is protocol specific flag data. Set f=1 for read back/verify. EPC1, Gen2 tags
provide SUCCESS/FAIL feedback. Defaults to 0.
To write the Kill password to a tag with EPC ID= 332233445566778899aabbcc, enter:
}wt,d:332233445566778899aabbcc,a:0,b:33223344!

70

Tag Programming

Using the Wv Command
The Wv command is a multifunction command that performs any erase, write, and
verification needed to program a tag in a specific protocol. The command can also lock the
data.
The format of the Wv command is as follows:
}Wv,b: & lt; EPC data & gt; ,k: & lt; kill code & gt; ,c: & lt; access code & gt; ,
i: & lt; TID data & gt; ,u: & lt; user memory & gt; ,m: & lt; lock mask & gt; !
where:
b: & lt; EPC data & gt; is the EPC ID to write to the tag.
k: & lt; kill code & gt; is the kill code to be written to the reader.
c: & lt; access code & gt; is the access code to be written to the tag.
i: & lt; TID data & gt; is the TID data to be written tot he tag. The number of bytes varies
depending on the tag.\
u: & lt; user memory & gt; is the user data to be written to the tag. The number of bytes
varies depending on the tag.
m: & lt; lock mask & gt; is the lock mask to indicate which tag field to lock. Each 4-bit
nibble in the mask indicates the lock state to apply to a specific part of the tag. A mask
nibble value of 1 locks the specific part of the tag. A mask nibble value of 0 indicates
no lock is applied. For the EPC1-2, the low order bit of each nibble indicates if the
permalock bit should be set, and the next higher bit indicates if the pwd-write bit
should be set.
For the EPC1-2 protocol, the mask nibbles apply to the following fields:
Mask Nibble

4

3

2

1

0

Tag Field

User
memory

TID data

Access
code

Kill code

EPC data

To write an EPC ID value of 332233445566778899aabbcc and verify the write, enter:
}wv,b:332233445566778899aabbcc!
To write the EPC data, a kill code of A391742F, an access code of 73D97412, and lock
the EPC data and access code, enter:
}wv,b:30112233445566778899aabb,k:A391742F,c:73D97412,m:00202!

In this example, the lock mask of m:00202 = 0010 0000 0010b and indicates that
a pwd-lock is requested for nibble 2 (access code) and a pwd-lock is requested for
nibble 0 (EPC data).

71

MP9320 V2.8e User's Guide

72

Appendix C
Configuring the IP Address
This appendix describes how to configure the IP address of the MP9320 v2.8e Reader.
Topics discussed in this chapter include the following:

o

Ethernet IP Address Overview

o

IP Address Setup

71

MP9320 v2.8e User's Guide

Ethernet IP Address Overview
The MP9320 v2.8e can be networked with other readers on an enterprise 10/100 BaseT
Ethernet LAN. Each reader is equipped with an embedded IP device server that allows the
unit to be assigned an IP address. This address can then be accessed by your network
server or host computer.
When the reader is installed on a TCP/IP network connected to the internet, the reader
must be assigned a unique IP address. The reader is configured for automatic IP address
allocation using the Dynamic Host Configuration Protocol (DHCP) Mode. This is the
default mode for the reader as it is shipped from the factory. In this case, the reader
automatically extracts the IP address from the DHCP server.
If DHCP is not available or the reader is not setup for automatic IP address allocation, the
address can be manually assigned using the Digi Device Discovery application.

IP Address Setup
To set up a reader for Ethernet communication, perform the following:
1.

Verify all cabling and power supplies are secure and power up the readers.

2.

Copy the Digi Discovery application from the UHF Reader system distribution disk
to your host system. This application has the filename: dgdiscvr.zip.

3.

Verify the RF Command Suite application is installed on your host system. Refer to
Chapter 2 - Installation for information on installing this application.

4.

Unzip the Digi Discovery zip file and extract the dgdiscvr.exe application. The
application will be copied to your system inside a folder.

5.

Open the dgdiscvr.exe folder and double-click the dgdiscvr application.

6.

If any readers are connected, the application will launch and the readers will be
displayed as follows:

Figure 33-Digi Device Discovery Application Window

7.

Select the IP address of the reader to configure.

NOTE: If the IP adress returns all zeros (0.0.0.0), configure the reader manually by
selecting Configure network settings.

72

Configuring the IP Address

8.

The following steps require loading a Java applet onto your computer. If your
computer will accept applets, follow Step 10 through Step 13.

9.

If your system cannot run Java applets, follow Step 14 through Step 17 to complete
the setup using a Telnet session to enter commands.

10.

(For Java applet) Click on Open web interface to load a Java applet and open a web
browser window off the reader's device server.

11.

(For Java applet) Click Yes if you get a security dialog box request when the applet
launches.

Figure 34-Digi Device Discovery Web Interface Window

12.

(For Java applet) Select Serial Ports and verify the Baud Rate is set to 57600.

Figure 35-Digi Device Discovery Serial Configuration Window

13.

(For Java applet) Press Save and go to Step 18.

14.

(For Telnet session only) Connect to the reader via a Telnet session. Use the IP
address returned by the Digi Discovery application and Port 23 for the Telnet
connection.

15.

(For Telnet session only) Enter show serial and verify ther serial port settings
match the settings in the reader's SCW configuration register.

73

MP9320 v2.8e User's Guide

16.

(For Telnet session only) To change the baud rate, enter set serial baudrate
= & lt; rate & gt; . For best performance, a baud rate of 57600 is recommended.

17.

Close the Telnet session.

18.

Verify the serial port on the reader is connected to the serial port on your PC or host
system with a serial cable.

19.

At this time, load RF Command Suite. This application is a SAMSys reader
management application supplied on your system CD. RF Command Suite will be
used to set the serial port speed on the reader to a Baud Rate of 57600.

20.

If the reader's serial port Baud Rate is not correct, you can modify the rate by
selecting the Reader Config interface window.

21.

Expand Reader Configuration General Configuration
Communications Serial Configuration Word (SCW).

Serial

Figure 36-Reader Serial Port Properties
22.

Determine which UART is driving the serial port:

o UART-1 - unused
o UART-2 - RS-232
o UART-3 - Ethernet
23.
24.

After setting the Baud Rate, close any ConnectMe and Digi Device Discovery
windows.

25.

From RF Command Suite, select Reader Connection
disconnect any auto connected sessions.

26.

Select Reader Connection

Connect via TCP/IP.

27.

Select Reader Connection

AutoConnect to establish an Ethernet connection.

28.

74

Change any settings and click Send Changes to Reader

.

Select the IP address of the reader from the popup list and press OK.

Disconnect. This will

Configuring the IP Address

29.

Select the Command interface tab and press the Version function key to verify
communication with the reader.

75

MP9320 v2.8e User's Guide

76

THE POWER TO CHOOSE

SAMSys Technologies, Inc.

Part Number: HI469320-28E-UG-V1.0
Printed in U.S.A.


All Legacy 9320.zip > RFCommandSuite_Users_Guide_V1.1.pdf

User's
Guide
RF Command Suite 1.0
Reader Management for SAMSys Readers

SAMSys
RF Command Suite 1.0 User's Guide
First Edition (January 2005)
(C) Copyright 2005 SAMSys Technologies, Inc. All Rights Reserved.
Disclaimer and Limitation of Liability
The content of this manual is for information use only and is subject to change without notice. SAMSys assumes no responsibility or liability for any errors
or inaccuracies that may appear in this publication. No part of this manual may be reproduced in any form or by any means, electronic, mechanical,
recording, or otherwise, without the prior written permission of SAMSys.
SAMSys products are not designed, intended, authorized or warranted to be suitable for life support applications or any other life critical applications
which could involve potential risk of death, personal injury, property damage, or environmental damage.
About SAMSys
SAMSys Technologies, Inc. is a world-leading provider of RFID reader hardware solutions in the LF, HF, and UHF segments of the RFID marketplace.
SAMSys is a public company listed on the Toroto Stock Exchange under the symbol SMY.
SAMSys Technologies, Inc.
44 East Beaver Creek Rd., Unit 11
Richmond Hill, Ontario L4B 1G8 Canada
Phone: (905) 707-0404
Toll Free: (877) 463-6546
Fax: (905) 707-9944
E-mail: samsys@samsys.com
Web: www.samsys.com
Manual Part Number: HI471-RFCS-V1.1

Trademarks
SAMSys is a trademark of SAMSys Technologies, Inc.
HyperTerminal(R) is a registered trademark of Hilgraeve, Inc.
WinZip(R) is a registered trademark of WinZip Computing, Inc.

Other company, product or service names appearing in this manual may be trademarks or service marks of their respective owners.

Contents

Contents

Chapter 1 - Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
Purpose of this Document . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
Assumptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
Installing RF Command Suite . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
RF Command Suite Startup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
Configuring RF Command Suite for your Reader . . . . . . . . . . . . . . . . . 7
RS-232 Serial Communication Setup . . . . . . . . . . . . . . . . . . . . . . . . . . 8
RF Command Suite Serial Port Setup . . . . . . . . . . . . . . . . . . . . . . . 8
Modifying the Reader Serial Port . . . . . . . . . . . . . . . . . . . . . . . . . . 8
Ethernet Communication Setup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
RF Command Suite Version Identification . . . . . . . . . . . . . . . . . . . . . . 10
Chapter 2 - User Interfaces . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
Function Tabs and Pull-Down Menus . . . . . . . . . . . . . . . . . . . . . . . . . . 12
Command Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
Tag Summary Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
Upload File Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
Error Log Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
RFCS Configuration Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
Reader Configuration Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
Chapter 3 - RF Command Suite Operation . . . . . . . . . . . . . . . . . . . . . . 27
Reading Tags . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
Data Persistence . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
Fixed Time Test . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
Tag Read Count and Rate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
Reading Tag Data Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
Parsing Tag Data from an Incoming Data Stream . . . . . . . . . . . . . . 30
Writing Blank Tags . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
Modifying Tags . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
Sending CHUMP Commands to a Reader . . . . . . . . . . . . . . . . . . . . . . . 33
Uploading Firmware to a Reader . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
Configuring the Reader . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
Changing the RS-232 Configuration . . . . . . . . . . . . . . . . . . . . . . . . 36
Changing Reader Operation Modes . . . . . . . . . . . . . . . . . . . . . . . . . 36
Enabling Protocols . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
Configuring Specific Protocols . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37

i

RF Command Suite User's Guide

Chapter 4 - Function Keys and Macros . . . . . . . . . . . . . . . . . . . . . . . . . 39
Function Key Descriptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
MP9320 V2.7 EPC UHF Reader Function Keys . . . . . . . . . . . . . . . 40
MP9310 UHF Reader Module Function Keys . . . . . . . . . . . . . . . . 42
Modifying Function Keys . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
Creating a Function Key Macro File . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
Creating a Macro File with the On-Screen Key Editor . . . . . . . . . . 44
Creating a Macro File with a Text Editor . . . . . . . . . . . . . . . . . . . . 44
Chapter 5 - Troubleshooting and Support . . . . . . . . . . . . . . . . . . . . . . . 45
Troubleshooting Procedures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
SAMSys Technical Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
Appendix A - Common Procedures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
High Level Reader Startup and Configuration . . . . . . . . . . . . . . . . . . . 50
Appendix B - COM/ActiveX Compatibility . . . . . . . . . . . . . . . . . . . . . . 51
SSReader Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
SSTag Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54

ii

Contents

Figures
RF Command Suite Reader Configuration Screen . . . . . . . . . . . . . . . . 2
PC Serial Port Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
Reader Serial Port Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
Ethernet Port Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
RF Command Suite Version Information Window . . . . . . . . . . . . . . . . 10
Command Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
CHUMP Command Associated with Function Key . . . . . . . . . . . . . . . 14
Tag Summary Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
Upload File Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
Error Log Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
RF Command Suite Configuration Interface . . . . . . . . . . . . . . . . . . . . . 22
Reader Configuration Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
Reader Configureation Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
RF Command Suite Tag Summary . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
Select Tag Protocol . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
Tag Write Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
Select Tag to Modify . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
Modify Tag Option . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
CHUMP Command Upload . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
Upload File Controls . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
Reader Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
RS-232 Serial Port Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
Serial and RF Mode Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
Protocol Selection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
Protocol Parameter Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
Editing a Macro . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
RF Command Suite Connection Error Message . . . . . . . . . . . . . . . . . . 46

iii

RF Command Suite User's Guide

iv

Chapter 1
Introduction
This chapter provides a general overview for the SAMSys RF Command Suite
application. Topics discussed in this chapter include the following:
o

Purpose of this document

o

Assumptions

o

Overview

o

Installing RF Command Suite

o

RF Command Suite Startup

o

RS-232 Serial Communication Setup

o

Ethernet Communication Setup

o

RF Command Suite Version Identification

Purpose of this Document
This document provides RF Command Suite users and technicians with
instructions for installing and operating the RF Command Suite. The RF
Command Suite and associated documentation are provided as an aid for
configuring your SAMSys RFID system and is not intended as an engineering
design system. This tool is provided with no implied warranties.

Assumptions
This document is intended for technical personnel who are trained and experienced
with the setup and configuration of basic application software packages, serial
ports, and general SAMSys reader operation.

1

RF Command Suite User's Guide

Overview
The SAMSys RF Command Suite is a Microsoft Windows application that
provides a Graphical User Interface (GUI) for SAMSys RFID Reader Products.

Figure 1- RF Command Suite Reader Configuration Screen

Functions provided by the RF Command Suite include the following:
o
o

Parse tag data

o

Reset the reader

o

Configure the reader

o

Select tag protocols

o

2

View tag data

Submit control commands to the reader

Introduction

Installing RF Command Suite
RF Command Suite is delivered on your Customer Documentation CD and
consists of one (1) Windows Installer file named Setup_RFCommandSuite_10.
To install the tool, perform the following:
1. Copy the Setup_RFCommandSuite_10 file to your Windows desktop.
2. Double-click the Setup_RFCommandSuite_10 icon
window is displayed.

. The Installer

3. Press Next. The License Agreement window is displayed.

3

RF Command Suite User's Guide

4. Read the license agreement and if you agree with the conditions of the license,
select I Agree and press Next. The target directory window is displayed.

5. Verify the target directory is correct. If you are unsure if your system has
sufficient disk space press Disk Cost. The available drives and memory is
displayed. If the disk space is sufficient, press the OK and then press Next.

6. To begin the actual application installation press Next.

4

Introduction

7. The Windows Installer will install the RF Command Suite files.

8. When complete, press Close.

5

RF Command Suite User's Guide

RF Command Suite Startup
RF Command Suite can communicate with all SAMSys readers through the
Ethernet (TCP/IP) port or RS-232 serial port. Verify your reader is connected to
the correct port and powered up.
To start up RF Command Suite, perform the following:
1.

Select Start

2.

The application will attempt to connect to using the most recent configuration
settings.

3.

If RF Command Suite does not connect to the reader, try connecting using an
automated search for the correct setting. Select:

Programs

Reader Connection

4.

SAMSys

Samsys RF Command Suite 1.0.

Auto Connect

If the reader still does not connect, verify the communication connection by
selecting one of the following from the pull-down menus on the top of the
interface:
a. For serial port connections, select:
Reader Connection

Serial Port Settings (to verify the parameters)

Reader Connection

Connect via Serial Port

Reader Connection

Reconnect

b. For TCP/IP connections, select:
Reader Connection

TCP/IP Settings (to verify the parameters)

Reader Connection

Connect via TCP/IP

Reader Connection

Reconnect

NOTE: The default RS-232 settings for most SAMSys readers are COM1, 9600 Baud, 8
data bits, 1 stop bit, and no parity.

5.

If you are unable to establish a reader connection with the reader after
verifying the port parameters, try setting the reader back to its default
configuration. Select:
Reader Connection

Serial Port Recovery

6. Reverify the port settings and reconnect as necessary.

6

Introduction

Configuring RF Command Suite for your Reader
RF Command Suite can be used with several different SAMSys readers. As a result, macro and
XML configuration files are provided with the installation package. The macro
files are located in:
\Program Files\SAMSys\RFCS\Macros\

The XML configuration files are located in:
\Program Files\SAMSys\RFCS\XML Data\

To configure the RF Command Suite for your reader, perform the following:
1.

From the tool bar pull-down menu, select File

2.

Select the one of the following macro files that matches your reader:
o
o

Load Macro File.

MP9310_Default.txt
MP9320_27_Default.txt

3. After selecting the correct macro file, press Open.
4.

The selected macro file will reconfigure the function keys and other aspects
of the RF Command Suite to match the reader.

5.

Next, load the correct XML configuration file.

6.

Select the Reader Config Interface and verify the correct XML
configuration file is shown in the Path to XML Configuration Definition.

7.

Press the Browse
o
o

button and choose one of the following files:

MP9310.xml
MP9320_27.xml

8. After selecting the correct XML configuration file, press Open. The file path is
automatically saved.
7

RF Command Suite User's Guide

RS-232 Serial Communication Setup
RF Command Suite Serial Port Setup
The serial port on your PC can be configured using RF Command Suite. To set
your serial port parameters, perform the following:
1. From the tool bar pull-down menu, select Reader Connection

Serial Port

Settings.

2. The Serial Port Properties window is displayed.

Figure 2-PC Serial Port Properties

Modifying the Reader Serial Port
To verify the reader's serial port is set properly perform the following:
1. Select the Reader Config tab.
2. Expand Reader Configuration
Communications

8

General Configuration
Serial Configuration Word (SCW).

Serial

Introduction

Figure 3-Reader Serial Port Properties

3.

Determine which UART is driving the serial port:
o
o
o

4.

UART-1 - unused
UART-2 - RS-232
UART-3 - RS-485/Ethernet (jumper selectable on the reader)

Change any settings and click Send Changes to Reader

.

Ethernet Communication Setup
1.

If the tool fails to establish a connection over the Ethernet port, select Reader
TCP/IP Settings from the pull-down menu.

Connection

Figure 4-Ethernet Port Properties

2.

If necessary, change the Reader Address and Reader Port and click OK.

3. After verifying the appropriate port parameters, close the properties box and
select Reader Connection Reconnect.

9

RF Command Suite User's Guide

RF Command Suite Version Identification
To determine the current version of your RF Command Suite application, select
Help About from the pull-down menu.

Figure 5-RF Command Suite Version Information Window

10

Chapter 2
User Interfaces
This chapter provides a description of the user interface windows provided by RF
Command Suite. Topics discussed in this chapter include the following:
o

Function Tabs and Pull-Down Menus

o

Command Interface

o

Tag Summary Interface

o

Upload File Interface

o

Error Log Interface

o

RFCS Configuration Interface

o

Reader Configuration Interface

11

RF Command Suite User's Guide

Function Tabs and Pull-Down Menus
The RF Command Suite user interface is displayed when the tool is launched from
the desktop or Start menu. To simplify use, RF Command Suite operations are
divided into six functional interfaces selected by tabs at the top of the display. A
set of pull-down menus is also provided for basic file and reader operations.

Function

Description

Command

Selects Command Interface to send CHUMP
commands, execute macros, and view data logs.

Tag Summary

Selects Tag Summary Interface to display tag read
parameters including tag read totals, read rates, and
time intervals.

Upload File

Selects Upload File Interface to upload firmware or
image files to the reader.

Error Log

Selects on-screen Error Log Interface to display all
errors received from the reader.

RFCS Config

Selects the RF Command Suite Configuration
Interface to set display characteristics and
parameters.

Reader Config

Selects Reader Configuration Interface to set
communication parameters and other reader options.

File

Macros
Load Macro File

Loads a specific macro file to define function keys.

Create Macro File

Creates new macro file for defining function keys.

Save Macro File

Saves a new or modified macro file.

Save Macro As

Saves the macro file under a new name.

Reader Connection
Reset Reader

Sends serial reset to reader.

Reconnect

Attempts to reconnect reader using current settings.

Auto-Connect

Attempts to connect reader using all available baud
rates.

Disconnect

Disconnects reader from the system.

Connect via Serial Port Configures reader to communicate with serial port.
Connect via TCP/IP
Serial Port Settings

Sets serial port parameters.

TCP/IP Settings

12

Configures reader to communicate with Ethernet port.
Sets the TCP/IP connection parameters.

User Interfaces

Command Interface
After startup, the Command interface is displayed. As shown in Figure 6, this
interface provides a command line for sending CHUMP commands to a reader and
a log window to view all data received from the reader. In addition, 5 sets of 12
function keys are provided for executing predefined macros.

Figure 6 - Command Interface

Command Line
This field provides a location for entering and sending CHUMP commands to a
reader. Enter the command in the space provided and press the Send button
or the Enter key on the keyboard. The last 20 commands are retained in a history
list and can be recalled by pressing the History button

.

13

RF Command Suite User's Guide

Log Window
The log window provides a display for reader data. Up to 5000 of the last
communications from the reader are stored in the log and can be displayed by
sliding the elevator up and down. Each row contains the reader data and a time/
date stamp for each communication.

Clear Log
The button clears all data from the on-screen log.
Write Log to File
The Write Log to File selector is used to store the data from the on-screen log to a
file. Press the Browse/Save button
to open the Save Log File as... dialog box.

Function Key Sets
Five sets of programmable function keys are provided. There are 12 function keys
per set. Click a radio button above the function keys to load another set.
When pressed, the function keys transmit a predefined CHUMP command to the
reader. In most cases, the function keys are defined by macro files provided with
RF Command Suite. These macro files program the function keys based on a
specific reader type and include configuration and protocol selection functions.
In the event that a single function key needs programming, individual keys can be
programmed with a CHUMP command and assigned a unique key name. The keys
are programmed by right-clicking the key and selecting the Edit Macro function.
Quickly Viewing the Function Key Commands

To quickly view the CHUMP command associated with a function key, place the
mouse pointer over the key for three seconds. The CHUMP command is displayed
as follows:

Figure 7 - CHUMP Command Associated with Function Key

14

User Interfaces

Tag Summary Interface
The Tag Summary Interface displays information about tags being read by the
reader. This information includes the Tag ID, Tag Name, Type, Total Tags Read,
and the Date/Time. Read rates, rate mode, and tag counts are also provided.
In addition, individual tags shown in the display window can be read and written.
Right click the tag line in the display window and enter the tag specific data. For
more information on this function, refer to the Modify Tags section in Chapter 3 Operation.

Figure 8 - Tag Summary Interface

Total Unique Tags
This field displays the number of unique tags that have been read during the
session. Multiple reads on the same tag are ignored. To clear this counter, press the
Clear Tags button.

15

RF Command Suite User's Guide

Tag Read Count
This field displays the total tag reads since the last reset or program restart. This
value does not include tags that have leaked from the display (see Enable Leaks).

Rate
This field displays the tag read rate, in tags per second, as determined by the Rate
Mode selector.
Rate Mode
This pull-down menu selects the calculation mode. The Reader Effective Rate
mode is the number of tag reads per second for a given period. Anti-Collision
Rate is the number of tags per second minus the communication delay and reflects
the approximate read rate on the RF interface.
Interval
Entering a value in this field sets the time window for calculating the tag read rate.
For example: If the interval = 10, then the Rate = the total number of tags read in
10 seconds divided by 10.

Enable Leaks
This option instructs the system to remove tags from the display after a set period
of inactivity. When a tag has been inactive for the period, it is removed from the
display and the Total Unique Tags, Tag Read Count, and Rate fields are updated
to reflect the removal.
Fixed Time Test
This option sets RF Command Suite to read tags for a specific time period. When
selected, the display is cleared and the Total Unique Tags, Tag Read Count, and
Rate fields are reset. Tags are not read until the Start Fixed Time Read Test button
is pressed.

16

User Interfaces

Start Fixed Time Read Test
This button starts the Fixed Time Read Test. When pressed, tags are read for the
duration shown in the Fixed Time Test field. The button changes to Cancel Fixed
Time Read Test and a countdown timer is displayed (format is hh:mm:ss)
.
Reset Rate
This button resets the Tag Read Count, and Rate fields to zero. The Total and
Rate columns in the tag display window are also reset.
Write Blank Tags
After selecting the protocol from the pull-down menu, pressing this button calls up
a dialog box for entering data to write to a blank tag.
Clear Tags
This button clears all tag list data from the tag display window. The Total Unique
Tags, Tag Read Count, and Rate fields are reset to zero.
Tag Display
The main tag display window shows all tags currently tracked by RF Command
Suite. The tag data includes the following:
o

Tag ID - Tag serial number

o

Tag Name - Name assigned in an associated data file.

o

Type - Tag type such as EPC1, IS186B, or EPC0.

o

Total - Number of times the tag has been read.

o

Rate - Read rate (tag reads/second).

o

Rate Graph - Graphical representation of the tag read rate.

o

Date/Time - Last data and time the tag was read

NOTE: Press the column label button above each column to sort displayed tags in either
ascending or descending order.

17

RF Command Suite User's Guide

Use Tag Data File
This option indicates that a tag data file containing human readable tag names is
available and should be accessed by RF Command Suite. The tag name is shown in
the Tag Name column of the Tag Display.

18

User Interfaces

Upload File Interface
The Upload File Interface is used to upload a file to the reader. Reader files include
new protocols, enhanced features, default configurations, and updated FlashROM
images. SAMSys readers can be automatically updated with new firmware using
this interface.
When uploading a file, RF Command Suite sends one line at a time and waits for
the {a response from the reader before sending the next line. If an e: is received,
indicating an error, the upload aborts.

Figure 9 - Upload File Interface

NOTE: The RF Command Suite installation includes default reader configuration files that
can be used as a template to speed up reader configuration. The configuration
files are located at Program Files\SAMSys\RFCS\Config\.

19

RF Command Suite User's Guide

Local Path to Upload File
The location of the file to upload is entered in this field. To use the directory
navigator, press the Browse button
.

Send with delay
This option is used when uploading FORTH code to the reader. When enabled,
this option inserts a time delay (in milliseconds) between each line of the file to
upload. Each line is sent after the delay instead of waiting for a system response
between lines. If an e: is received, indicating an error, the transfer aborts.

Start
This button starts the file upload. A Transferring File - xx% message is displayed
along with a progress indicator bar. The Stop button is enabled when this button is
clicked.

Stop
This button stops the current upload. The progress indicator bar is disabled and the
Transferring File message is removed.

20

User Interfaces

Error Log Interface
The Error Log Interface displays errors received from the reader. the log contains
up to 5000 errors or any reader communication beginning with e:. The error code,
description, and date/time are provided. If an Errors.ini file is provided, a
description of the error will also be displayed. When an error is present, the View
Error Log for Errors message is displayed in the lower right corner of the
window.

Figure 10 - Error Log Interface

Write Error Log to File
This option writes all errors in the log to a text file. Press the Browse button
select the path and file.

to

Clear Error Log
This button clears all errors from the display and error log.

21

RF Command Suite User's Guide

RFCS Configuration Interface
The RFCS Configuration Interface provides options for setting RF Command
Suite interface border colors and visible/audible tag read alerts. This interface is
also used to configure the application to parse incoming data for tag reads.

Figure 11 - RF Command Suite Configuration Interface

Parse Received Data
This option configures RF Command Suite to parse incoming data for tag reads.
Data is parsed when it is received from the reader and tag data is displayed in the
Tag Summary interface.

Change Border Color
Pressing this button displays a color palette for setting the RF Command Suite
interface border color. The setting is stored in the application INI file. Pressing the
Reset button
sets the border color back to the default.

22

User Interfaces

Change Tag Read Alert Color
Pressing this button displays a color palette for setting the RF Command Suite
interface border color. The setting is stored in the application INI file. Pressing the
Reset button
sets the tag alert color back to the default.
Audio Tag Alert settings
This option activates the audible tag read alert.
Selecting this option activates the system beep on tag read.
Selecting this option plays a .wav file on tag read.
Pressing this button momentarily activates the selected sound.

Wav file to play when a tag is read
The path and name of the .wav file to play is entered in this field. To use the
directory navigator, press the Browse button
.

Current Macro File (.mac)
Macro files are provided for configuring the function keys to match your reader.
The path and name of the macro file is shown in this field. Currently two macro
files are provided:
o
o

MP9310_Default.txt
MP9320_27_Default.txt

In order for the RF Command Suite function keys to work with your reader, the
correct macro file must be loaded. Refer to the Introduction chapter for
instructions on configuring the application for your reader.
Log Settings
This option displays the newest log entries at the top of the
log file.

23

RF Command Suite User's Guide

This option displays the newest log entries at the bottom
of the log file.

24

User Interfaces

Reader Configuration Interface
The Reader Configuration Interface is used to configure the reader for different
operating modes, serial communication parameters, and tag protocol
configurations.
The installation package contains several default configuration files for varying
reader applications. Using one of these files can speed the initial configuration
process by providing the core settings for an application. Appendix A describes
how to utilize a default configuration file. Once a default configuration is loaded ,
additional configuration changes can be applied as described in the following
section. It is good practice to save the reader configuration to an external file once
all configuration settings are in place.
As shown in Figure 12, selecting a configuration area in the display will expand
the tree into the various control registers used to configure the reader. When a
single register is selected the individual register parameters are displayed. The
parameter options are then displayed on the right side of the interface. Once you
have modified the parameter settings, you can update the reader.

Figure 12 - Reader Configuration Interface

25

RF Command Suite User's Guide

When a specific register parameter is selected, an option menu is displayed on the
right side of the interface. The actual parameter values are selected from these
menus. After changing a value, the register and parameter name change color.
Add Persistence Flag
This is the flag to save the register setting permanently. Selecting this option adds
F:1 to the end of the Configuration Write (Cw) command to save the register
setting in non-volatile memory

Save Changes To Reader
Pressing this button sends the configuration changes to the reader. The
Configuration Write (Cw) command is used.

Save Current Configuration
Pressing this button saves the current configuration to an external file. After
pressing this button, a navigation window is displayed for selecting the directory
and filename for the configuration file.
Path to XML Configuration Definition

The reader configuration options are described in an XML data file. The path and
name of the XML file is entered in this field. Currently two XML configuration
files are provided:
o
o

MP9310.xml
MP9320_27.xml

In order for RF Command Suite to work properly, the correct XML configuration
file must be loaded. Refer to the Introduction chapter for instructions on
configuring the application for your reader.

26

Chapter 3
RF Command Suite Operation
This chapter provides general information to operate RF Command Suite. Topics
discussed in this chapter include the following:
o

Reading Tags

o

Writing Blank Tags

o

Modifying Tags

o

Sending CHUMP Commands to a Reader

o

Uploading Firmware to a Reader

o

Configuring the Reader

27

RF Command Suite User's Guide

Reading Tags
RF Command Suite is automatically configured to display tag data as the data is
received from the reader. However, tool settings can be changed to match your
requirements. Refer to the following sections to configure the RF Command Suite.
To read tags, perform the following:
1.

Select the Reader Config Interface and verify your reader is programmed
correctly.

2.

Verify your reader is enabled for the correct tag protocol. Select:
Reader Configuration
Protocol Select Word

Operating Mode

Reader Configuration
Protocol Select Mask

3.

General Configuration
General Configuration

Operating Mode

Verify the reader is configured for the correct operating mode. Select:
Reader Configuration General Configuration
General Configuration Word

4.

To configure the reader to actively scan for tags, set the following General
Configuration Word parameters:
Serial Mode = Continuous
RF Mode = Continuous
RF Idle RF On when Idle

Figure 13-Reader Configureation Parameters
28

Operating Mode

Operation

5.

Select the Tag Summary interface. When tags are read, they are displayed in
the window and the statistics are updated.

Figure 14-RF Command Suite Tag Summary

Data Persistence
Parsed tag data is removed from the lower window at a rate specified by the Enable
Leaks delay value. If tag data disappears from the window faster than required,
deselect Enable Leaks or increase the delay.

Fixed Time Test
RF Command Suite can be configured to read tags for a fixed time period. Enable
the Fixed Time Test and enter a time interval. Press the Start Fixed Time Read
Test button to start the read cycle. Tags are only read for the specified time
interval.
29

RF Command Suite User's Guide

Tag Read Count and Rate
The Tag Read Count displayed in the lower window is the total tag read count
since the last reset. The Rate is the accumulative tag reads per second since the last
reset.
If tag read rate data is cleared too quickly from the Tag Summary display, increase
the Interval.

Reading Tag Data Files
Tag Data Files containing human readable tag names can be read by RF Command
Suite. In most cases, these files are created for demonstration purposes. To use
have RF Command Suite display human readable tag names from a file, select the
Use Tag Data File option and browse for the file name.

Parsing Tag Data from an Incoming Data Stream
Tag data can be parsed out of an incoming data stream and displayed in the Tag
Summary display window. Select the Parse Received Data
option on the RFCS Config interface.

30

Operation

Writing Blank Tags
RF Command Suite can be used to write unprogrammed or blank tags. To write
blank tags, perform the following:
1.

Select the Command Interface and verify the reader is connected and the
correct protocol is selected.

2.

Place the reader in Polled Read mode.

3.

Verify a single tag is in the RF field of the reader.

4.

Select the Tag Summary Interface.

5.

Select the protocol from the pulldown above the Write Blank Tag button.

Figure 15-Select Tag Protocol

6.

Press the Write Blank Tag

button to begin the operation and

display the tag data box.

Figure 16-Tag Write Data

7.

Fill in the appropriate data (in Hex) and press the Write

button to

write the data to the tag.

31

RF Command Suite User's Guide

Modifying Tags
RF Command Suite can be used to modify previously programmed tag data. To
modify tags, perform the following:
1.

Select the Tag Summary Interface and right-click on the tag.

Figure 17-Select Tag to Modify

2.

Select Modify Tag. The tag data window is displayed.

Figure 18-Modify Tag Option

3.
4.

Enter the data Length and actual Data for the specific address

5.

Select if ASCII data and whether or not there is a Single tag in field.

6.

After all data and parameters are entered, press Write

7.

32

Select the Address from the pull-down.

Repeat for each address.

.

Operation

Sending CHUMP Commands to a Reader
Should you desire to perform more sophisticated reader functions or select
additional configurations, RF Command Suite allows CHUMP commands to be
entered directly.
To send CHUMP commands to a reader, perform the following:
1.

Select the Command tab.

2.

Input the CHUMP command into the command line and press the Send
button
or the Enter key on the keyboard.

3.

The command is sent and the reader response is shown in the display
window.

Figure 19-CHUMP Command Upload

Caution
SAMSys readers are programmed using the Comprehensive Heuristic Uniform
Messaging Protocol (CHUMP). Some CHUMP commands can disable the reader
and should not be used unless directed by SAMSys technical personnel. Use
extreme caution when sending CHUMP commands to the reader.
For detailed information on using CHUMP commands, refer to the SAMSys
Comprehensive Heuristic Unified Messaging Protocol Reference Guide.

33

RF Command Suite User's Guide

Uploading Firmware to a Reader
Periodically, SAMSys releases updated reader firmware that incorporates new
protocols, enhanced features, and updated FlashROM images. SAMSys readers
can be updated with new firmware using the RF Command Suite.
When uploading a file, RF Command Suite sends one line at a time and waits for
the {a response from the reader before sending the next line. If an e: is received,
indicating an error, the upload aborts.
The firmware file has a ".chp" extension and is typically included in a zipped
release file such as "EPCReader_1.36.10.zip"
To upload firmware to a reader, perform the following:
1.

Connect the reader to the PC using the RS-232 or Ethernet port as required.

2.

Select the Upload File tab.

3.

Browse to the file to upload. To use the directory navigator, press the Browse
button
.

Figure 20 - Upload File Controls

4.

5.

When you are ready to upload the file, press Start

6.

The file will be uploaded to the reader. During upload, a bar graph indicates
what percentage of the file has been sent.

7.

34

When uploading FORTH files, a time delay must be inserted between each
line of the file. Select the Send with delay option and enter a time delay in
milliseconds. A time delay is not necessary with .chp or configuration files.

If the file cannot be sent, a File Transfer Timeout error is displayed.

.

Operation

Configuring the Reader
RF Command Suite can be used to easily configure your reader. However, before
you can change the reader configuration, the correct XML configuration file must
be loaded that matches your reader. Refer to Chapter 1 - Introduction for
instructions on configuring RF Command Suite to match your reader.
The Reader Config interface provides control over the reader configuration
registers that set communication parameters, change operating modes, and control
the transmitter and receiver. These configuration registers are located under
General Configuration.
In addition, individual protocol configurations can be modified. The protocol
configuration registers are located under Protocol Configuration.
NOTE: If reader configuration commands have been recently sent from the command line or by
pressing the function keys, the Reader Configuration window may not reflect the updated
settings. Refresh the Reader Configuration window by collapsing and re-expanding the
directories (see Figure 21). The updated settings should be displayed.

1.

To configure the reader, select the Reader Config tab.

Figure 21 - Reader Configuration

2.

To modify the general configuration registers expand the directory under
General Configuration.

3.

To modify the protocol configuration registers expand the directory under
Protocol Configuration.

Caution
SAMSys readers use internal registers to provide a high degree of flexibility in setting
operational parameters. However, improper setting of these registers can result in reader
inoperability or permanent damage. For detailed information on reader and protocol
configuration registers, refer to the Comprehensive Heuristic Uniform Messaging Protocol
(CHUMP) Reference Guide and the Field Installation Guide.
NOTE: To make any reader changes permanent, the changes must be written to non-volatile
memory (NVM). To make changes permanent, select the Persistence Flag option
before sending the change to the reader.

35

RF Command Suite User's Guide

Changing the RS-232 Configuration
To confiure the reader's serial port parameters, perform the following:
1.

Select the RS-232 UART parameters as shown in the following:

Figure 22 - RS-232 Serial Port Configuration

2.

Make any changes using the pull-down menus and selectors on the right side
of the display and press Send Changes to Reader

.

Changing Reader Operation Modes
The reader's serial and RF modes can be configured for polled or continuous
operation. In addition, the RF On when Idle mode can be set. To change any of the
operating modes, perform the following:
1.

Select the specific General Configuration Word (GCW) parameters as shown
in the following:

Figure 23 - Serial and RF Mode Configuration

2.

Make any changes using the selectors on the right side of the display and
press Send Changes to Reader

36

.

Operation

Enabling Protocols
SAMSys readers can be configured with different tag protocols. If your reader was
loaded with specific protocols at the time of purchase, these protocols can be
enabled or disabled as required. To verify which protocols are enabled for your
reader, select:
Reader Configuration
Protocol Select Mask

General Configuration

Operating Mode

To configure the reader for a specific protocol, perform the following:
1.

Select the Protocol Select Word (PSW) parameters as shown in the
following:

Figure 24 - Protocol Selection

2.

Enable or disable a protocol by using the selectors on the right side of the
.
display and press Send Changes to Reader

Configuring Specific Protocols
Individual Protocol Configuration registers can be modified for specific tag types
and read modes. For specific protocol configuration register information, refer to
the Comprehensive Heuristic Uniform Messaging Protocol (CHUMP) Reference
Guide. To configure individual protocol registers, perform the following:
1.

Select the individual protocol configuration word parameters.

Figure 25 - Protocol Parameter Configuration

2.

Enable or disable a specific protocol parameter by using the selectors on the
right side of the display and press Send Changes to Reader
.
37

RF Command Suite User's Guide

38

Chapter 4
Function Keys and Macros
This chapter provides descriptions of the RF Command Suite function keys and
function key macro files. Topics discussed in this chapter include the following:
o

Function Key Descriptions

o

Modifying Function Keys

o

Writing a Function Key Macro File

39

RF Command Suite User's Guide

Function Key Descriptions
Several function key macro files are provided with RF Command Suite to simplify
basic tasks performed with the application. The following tables describe the
function key definitions provided by the macro files.

MP9320 V2.7 EPC UHF Reader Function Keys
File Name: MP9320_27_Default.txt
Function Key Set 1
F1

Auto Read

Sets the reader to read tags continuously.

F2

Polled Read

Sets the reader to read tags only after a request from the
host.

F3

RF Off

Turns the reader RF off.

F4

Version

Returns the reader software version.

F5

Registers

Shows the current register configuration.

F6

not programmed

F7

not programmed

F8

not programmed

F9

not programmed

F10

FCC Mode

Configures the reader for FCC mode.

F11

ETSI Mode

Configures the reader for ETSI mode.

F12

ETSI Hop Mode

Configures the reader for ETSI frequencu hopping.

Function Key Set 2
F1

Selects the ISO 18000-6A protocol only.

F2

ISO-6A 4X Return

Selects ISO 18000-6A with 4X return link.

F3

ISO-6A/B

Selects both ISO 18000-A and -6B protocols.

F4

ISO-6B

Selects the 6B protocol only.

F5

ISO-6B 4X Return

Selects ISO 18000-6B with 4X return link.

F6

V1.19 EPC/96

Selects Philips UCODE V1.19 (96-bit tags)

F7

V1.19 EPC/64

Selects Philips UCODE V1.19 (64-bit tags)

F8

Intellitag

Selects the Intellitag protocol only.

F9

Supertag

Selects the Supertag protocol only.

F10

not programmed

F11

not programmed

F12

40

ISO-6A

not programmed

Function Keys and Macros

Function Key Set 3
F1

EPC 1/64

Selects the EPC 1 protocol (64 bit tags).

F2

EPC 1/96

Selects the EPC 1 protocol (96 bit tags).

F3

EPC 0/Impinj/96

Selects the Impinj EPC 0 protocol (96 bit tags).

F4

EPC 0/Impinj/64

Selects the Impinj EPC 0 protocol (64 bit tags).

F5

EPC 0/Impinj/Any

Selects any Impinj EPC 0 protocol

F6

EPC 0/Matrics/64

Selects the Matrics EPC 0 protocol (64 bit tags).

F7

EPC 0/Matrics/96

Selects the Matrics EPC 0 protocol (96 bit tags).

F8

EPC 0/Matrics/Any

Selects any Matrics EPC 0 protocol

F9

Matrics0+ Writing

Configures reader for writing Matrics0+ tags.

F10

not programmed

F11

not programmed

F12

not programmed

Function Key Set 4
F1

1 Antenna (0)

Sets the reader to use antenna 0.

F2

1 Antenna (1)

Sets the reader to use antenna 1

F3

1 Antenna (2)

Sets the reader to use antenna 2.

F4

1 Antenna (3)

Sets the reader to use antenna 3.

F5

2 Antennas (0,1)

Sets the reader to use antennas 0, 1.

F6

3 Antennas (0,1,2)

Sets the reader to use antennas 0, 1, and 2.

F7

4 Antennas

Sets the reader to use all four antennas.

F8

not programmed

F9

not programmed

F10

not programmed

F11

not programmed

F12

not programmed

Warning
The SAMSys MP9320 UHF Reader is equipped with four RF ports. To prevent reader
damage, RF ports must be properly terminated with a 50 ohm load or a functional UHF
RFID antenna before power up. UHF Readers are factory configured to operate on RF
port 1. As a result, port 1 must be properly terminated before initially powering on the
reader. Before activating any additional RF ports, they must also be properly terminated.
Never power up the reader unless the loads or antennas are connected. Always power
down the reader before removing an antenna or load from an RF port.

41

RF Command Suite User's Guide

MP9310 UHF Reader Module Function Keys
File Name: MP9310_Default.txt
Function Key Set 1
F1

Auto Read

Sets the reader to read tags continuously.

F2

Polled Read

Sets the reader to read tags only after a request from the
host.

F3

RF Off

Turns the reader RF off.

F4

Version

Returns the reader software version.

F5

Registers

Shows the current register configuration.

F6-F12

not programmed

Function Key Set 2
F1

ISO-6A

Selects the ISO 18000-6A protocol only.

F2

ISO-6A 4X Return

Selects ISO 18000-6A with 4X return link.

F3

ISO-6A/B

Selects both ISO 18000-A and -6B protocols.

F4

ISO-6B

Selects the 6B protocol only.

F5

ISO-6B 4X Return

Selects ISO 18000-6B with 4X return link.

F6

V1.19 EPC/96

Selects Philips UCODE V1.19 (96-bit tags)

F7

V1.19 EPC/64

Selects Philips UCODE V1.19 (64-bit tags)

F8

Intellitag

Selects the Intellitag protocol only.

F9

Supertag

Selects the Supertag protocol only.

F10-F12 not programmed

Function Key Set 3
F1

EPC 1/64

Selects the EPC 1 protocol (64 bit tags).

F2

EPC 1/96

Selects the EPC 1 protocol (96 bit tags).

F3

EPC 0/Impinj/96

Selects the Impinj EPC 0 protocol (96 bit tags).

F4

EPC 0/Impinj/64

Selects the Impinj EPC 0 protocol (64 bit tags).

F5

EPC 0/Impinj/Any

Selects any Impinj EPC 0 protocol

F6

EPC 0/Matrics/96

Selects the Matrics EPC 0 protocol (96 bit tags).

F7

EPC 0/Matrics/64

Selects the Matrics EPC 0 protocol (64 bit tags).

F8

EPC 0/Matrics/Any

Selects any Matrics EPC 0 protocol

F9

Matrics0+ Writing

Configures reader for writing Matrics0+ tags.

F10-F12 not programmed

42

Function Keys and Macros

Modifying Function Keys
RF Command Suite is designed to operate with any SAMSys reader. As a result,
macro files are provided to program the function keys for specific reader types. If
the RF Command Suite function keys have not been programmed or do not match
your reader, perform the following:
1.

From the pull-down menu, select File

Load Macro File.

2.

Browse to the RFCS directory and select the macro file that you wish to use
and press Open.

3.

Right-click the specific function key to program and select Edit Macro.

Figure 26 - Editing a Macro

4.

Enter a name for the function key into the Macro Name field. This name will
be displayed on the key.

5.

Enter the function key command in the Macro Command field. This can be
any valid CHUMP command to the reader.

6.

Save the function key definition by pressing the Update

button.

43

RF Command Suite User's Guide

Creating a Function Key Macro File
Creating a Macro File with the On-Screen Key Editor
To create a macro file with the on-screen key editor, perform the following:
1.

Start RF Command Suite.

2.

Select File

3.

Select Save.

4.

The function keys will be blank.

5.

Create Macro File

and enter a name for the text file.

Right click on each key and enter a name for the function key into the Macro
Name field. This name will be displayed on the key.

6.

Enter the function key command in the Macro Command field. This can be
any valid CHUMP command to the reader.

7.

Save the function key definition by pressing the Update

8.

After programming all the required function keys, select File

button.
Save Macro

File.

Creating a Macro File with a Text Editor
RF Command Suite function keys can be also be programmed by writing a simple
text (*.txt) file using a text editor. This file should be formatted as follows:
& lt; Function
& lt; Function
& lt; Function
& lt; Function
& lt; Function
& lt; Function
.
.
& lt; Function
& lt; Function
.
.
& lt; Function
& lt; Function

Key
Key
Key
Key
Key
Key

1
1
2
2
3
3

name & gt;
CHUMP command & gt;
name & gt;
CHUMP command & gt;
name & gt;
CHUMP command & gt;

Key 12 name & gt;
Key 12 CHUMP command & gt;

Key 60 name & gt;
Key 60 CHUMP command & gt;

To leave a function key blank, skip two (2) lines in your file. To program Function
Sets 2-5, continue adding key names and commands.
44

Chapter 5
Troubleshooting and Support
This chapter provides basic RF Command Suite troubleshooting procedures and
also how to obtain technical support. Topics discussed in this chapter include the
following:
o

Troubleshooting Procedures

o

SAMSys Technical Support

45

RF Command Suite User's Guide

Troubleshooting Procedures
Serial Connection Problem
Most problems with RF Command Suite can be easily solved by verifying your
reader connections and communication parameters. The following message occurs
when RF Command Suite is unable to connect to the reader with the last known
settings.

Figure 27-RF Command Suite Connection Error Message

If the baud rate is incorrect, press YES and the reader will search for the correct
speed. If you are connected on TCP/IP, press NO.
If the reader is unable to connect, check any serial or Ethernet cables and power
connections to your reader. If necessary, communication parameters can be
manually configured. Refer to Chapter 1 - Introduction for information on serial
and Ethernet communication setup.

46

Troubleshooting and Support

Other Common Problems

Symptom/Error Msg

Probable Cause

Tags or tag data disappears Leaks Enabled
too quickly from the display.
Rate Interval too short
Reader Configuration tree
in Reader Configuration
interface does not appear to
be accurate.

Corrective Action
Disable Leaks or increase Leak
Interval on Tag Summary interface.
Increase Rate Interval on Tag
Summary interface.

Reader configuration was Collapse and re-expand the Reader
Configuration directory tree to refresh
modified by sending
the information.
commands directly from
the Command interface
command line or from
another program.

47

RF Command Suite User's Guide

SAMSys Technical Support
For any questions regarding products and services, including returns, repairs,
technical support, training, and all other available services, contact your distributor
or SAMSys Customer Service at the following:
E-mail
Telephone
Fax

48

support@samsys.com

1-919-281-1551

1-877-367-4342 (toll free)
8:00am-6:00pm EST, Mon-Fri

Appendix A

Common Procedures
This appendix provides examples of commonly performed RF Command Suite
procedures. These examples are provided for general guidance only and are designed to
offer assistance in getting started with RF Command Suite. Specific applications may
require more detailed procedures not illustrated here. Contact SAMSys Technical Support
for more information.
Common procedures provided in this appendix include:
o High Level Reader Startup and Configuration

49

RF Command Suite User's Guide

High Level Reader Startup and Configuration
1.

Ensure all power and antenna cables are conencted to the reader.

2.

Power up the reader.

3.

Start RF Command Suite.

4.

Specify Connect via Serial Port or Connect via TCP/IP from the Reader
Connection pull-down menu.

5.

Select Auto Connect from the Reader Connection pull-down menu.

6.

Select the Upload File interface tab and browse to the Program
Files\SAMSys\RFCS\Config directory.

7.

Select the reader configuration file that best matches your application and
press Start.

8.

Select the Reader Config interface tab and review any reader configuration
parameters.

9.

Customize any configuration parameters required by your application.

10. Save the current configuration to an external file. This file can be used to
restore reader settings using the File Upload function.

50

Appendix B

COM/ActiveX Compatibility
RF Command Suite is being developed as an ActiveX executable (.exe application). This
will allow development packages compatible with COM/ActiveX to use the .exe file for
this application as a development library. The classes included in the application are
described in this appendix:
o SSReader Class
o SSTag Class

51

RF Command Suite User's Guide

SSReader Class
This class is used as the primary interface for controlling, communicating, and connecting
with the reader. The properties, collections, methods, and events for this class are
described in the following table:
Type

Name

Description

Property

Sets the connection mode for RF Command Suite to
communicate with the reader. The settings for this property
are, cmTCPIP = 0, cmRS232 = 1.

Property

CommSettings

Structure that holds all of the comm port settings. The items in
this structure include:
o Baud Rate - Sets the speed at which to transfer data
o Data Bits - Sets the number of data bits to use.
o Stop Bits - Sets the number of stop bits to use.
o Parity - Sets the parity to use.

Property

TCPIPSettings

Structure that holds the settings for communicating with the
reader via TCP/IP. The items in this structure are as follows:
o IPAddress - IP address of reader to connect to
o IPPort - TCP port to communicate with the reader

Property

ParseData

Boolean value that is used as a flag to determine if the
incoming data should be parsed to look for tag reads

Property

TotalTagReads

(Read-only). Used to return the total number of tag reads for
all tags being currently displayed.

Event

DataReceived

(InData As String). Triggered when data is received from the
reader. The parameter InData will contain the message from
the reader.

Event

CommError

(Number As Integer, Description As String). Triggered when
there is a communications error. The parameters for this
event include the number and description of the error that
occurred.

Event

TagAdded

(newTag As SSTag). Triggered whenever a new tag is added
to the tags collection. This occurs when a previously unread
tag is read by the reader. The newTag parameter will contain
the data for the new tag.

Event

TagRemoved

(OldTag As SSTag). Occurs when a tag is removed from the
tags collection. This is triggered by the TagRemoved event of
the tags collection. The OldTag parameter will contain the
data for the removed tag.

Event

TagChanged

(ModifiedTag As SSTag). Triggered whenever a tag is
modified in the tags collection. This occurs when a currently
displayed tag is read by the reader. The ModifiedTag
parameter will contain the data for the changed tag.

Method

52

Connection Mode

AutoConnect

Used to auto-connect to the reader. This method will attempt
to connect to the reader on all ports at all supported baud
rates with Parity = n, Stop Bits = 1, Data Bits = 8. This method
returns a Boolean value, True if the reader is connected,
False if not.

Common Procedures

Type

Name

Description

Method

ConnectToReader When called, this method will attempt to connect to the reader
using the stored settings. This method returns a Boolean
value: True if the reader is connected, False if not.

Method

DisconnectReader Closes the connection to the reader.

Method

ResetReader

Attempts a serial reset on the reader. This method sends a
series of carriage returns to the reader at the settings Baud =
9600, Parity = n, Stop Bits = 1, Data Bits = 8. This method will
run until it times out or connects to the reader.

Method

SendData

Used to submit data to the reader. This method appends a
carriage return to the data and sends it to the reader.

Method

TestPort

(PortNum as Integer). Attempts to open the port specified in
the parameter. Returns a Boolean value: True if the port is
valid, False if not.

Method

IsConnected

Tests the connection to the reader and returns whether or not
the reader is connected. Returns a Boolean value: True if the
reader is connected, False if not.

Tags Collection
The Tags collection of the SSReader class is a collection of SSTag objects based on the
SSTag class. This collection contains one tag object for each tag in the display. This
collection provides the following:
Type

Name

Description

Event

TagRemoved

(OldTag as SSTag) Occurs when a tag is removed from the
collection (when the Remove method is called). The parameter for
this event contains an SSTag object containing the data for the
removed tag.

Event

Property

Item (index or key). Returns the SSTag object matching the
specified index or key.

Property

Count

Returns the number of SSTag objects in the collection.

Property

NewEnum

This property is included to allow For Each looping to support
development languages.

Method

Clear

Removes all SSTag objects from the collection.

Method

Add

(TagID As String, Optional sKey As String) Creates a new SSTag
object and adds it to the collection.

Method

Remove

(index or key) Removes the SSTag object that matches the index/
key from the collection, and then trigger the TagRemo