ALIEN TECHNOLOGY 2450MHz Battery System v01.02.
COPYRIGHT ACKNOWLEDGEMENTS The contents of this document are the property of Alien Technology™ Corporation and are copyrighted. All rights reserved. Any reproduction, in whole or in part, is strictly prohibited. For additional copies if this document please contact: Alien Technology Corporation 18220 Butterfield Blvd. Morgan Hill, CA 95037 www.alientechnology.
TABLE OF CONTENTS Alien Technology Nanoscanner Reader User Guide Table of Contents CHAPTER 1 INTRODUCTION .............................................................................. 1 AUDIENCE ................................................................................................................ 1 NANOSCANNER READER OVERVIEW .......................................................................... 1 Requirements .................................................................................
TABLE OF CONTENTS CHAPTER 3 NANOSCANNER SYSTEM FUNDAMENTALS ............................ 17 INTRODUCTION ....................................................................................................... 17 COMMUNICATING WITH THE NANOSCANNER ............................................................. 17 Overview........................................................................................................ 17 Serial Communication ..............................................................
TABLE OF CONTENTS CHAPTER 5 READER HOST COMMUNICATIONS INSTALLATION ............ 37 INTRODUCTION ....................................................................................................... 37 Audience........................................................................................................ 37 Requirements ................................................................................................ 38 Conventions.................................................................
TABLE OF CONTENTS Get Gateway .......................................................................................................57 Set Gateway .......................................................................................................57 Get Netmask .......................................................................................................58 Set Netmask .......................................................................................................58 Get DNS..............
TABLE OF CONTENTS Get AutoModeStatus...........................................................................................79 AutoModeReset ..................................................................................................80 AutoModeTriggerNow .........................................................................................80 Autonomous Mode Commands – Web Based .............................................. 81 Commands/Operations on Web Autonomous Mode Tab.....................
TABLE OF CONTENTS OPTIMIZE READER SETTINGS .................................................................................. 98 Readometer Settings..................................................................................... 98 Tag List Settings............................................................................................ 98 Advanced Tag List Options ...........................................................................
CHAPTER 1 INTRODUCTION CHAPTER 1 Introduction The Nanoscanner Reader User Guide provides instructions for installing and operating the Nanoscanner reader. It also covers the reader firmware protocol in detail for use in configuring reader-host communications and developing application software. This book is designed for use by those who wish to develop software products and extended systems that take full advantage of the Nanoscanner reader’s capabilities.
CHAPTER 1 INTRODUCTION Requirements In order to fully interface with the Nanoscanner reader you will need the following: PC running Windows 98 or higher, with CD-ROM drive and one available RS-232 serial port. Standard 120 VAC power. Host software (Alien demo software or your own custom software).
CHAPTER 1 INTRODUCTION NANOSCANNER READER TRANSMIT AND RECEIVE ANTENNAS 3 dB Beamwidth Azimuth 55° Elevation 55° Frequency 2410 MHz – 2471.64 MHz Gain (dBi) ≤ 6 dBi Polarization Circular RF Connector Reverse-gender TNC VSWR 1.5:1 Dimensions (cm) 15.2 x 15.2 x 3.2 • (in) 6 x 6 x 1.25 Weight .27 kg • 0.
CHAPTER 1 INTRODUCTION OTHER COMPONENTS RS-232 Serial Cable DB-9 male/female serial Tag Overview Battery-powered backscatter tags are used exclusively in this Alien 2450 MHz system.
CHAPTER 1 INTRODUCTION BENEFITS OF BACKSCATTER TAGS OVER “ACTIVE” TRANSMITTER TAGS • Lower cost, simpler circuitry • Longer battery life • Stealthier (safer in sensitive environments, e.g., airplane) • No transmitter tags can be used worldwide due to licensing issues, spectral pollution, etc. TAG BLOCK DIAGRAM The following diagram illustrates the design of the battery-powered backscatter tag.
CHAPTER 1 INTRODUCTION Reader Block Diagrams 2450 MHz Reader Front End 2450 MHz Reader Logic Blocks NANOSCANNER READER USER GUIDE • DOC # 8101029-000 REV A © 2003 Alien Technology™ 6
CHAPTER 2 INSTALLATION AND OPERATION CHAPTER 2 Installation and Operation This chapter describes the Nanoscanner reader and provides installation and operation information. Later chapters detail networking and the Reader<–>Host protocol, which will allow you to create software that will interact with the reader and perform the desired processing functions.
CHAPTER 2 INSTALLATION AND OPERATION Nanoscanner Reader Features The Nanoscanner reader contains only two types of external user interface: connector ports and LEDs. One panel contains I/O connectors and LEDs.
CHAPTER 2 INSTALLATION AND OPERATION Reader LEDs Left Column LEDs Red Right Column LEDs RF on Red Comm TX Communications transmit to processor Yellow Sniff Yellow Detect tag signal Green Lock Comm RX Communications receive from processor Green Processor Running Lock on tag signal Network LEDs Green Link Red Active ANTENNA PANEL The antenna panel (perpendicular to the reader’s I/O panel) contains two coax antenna connector ports as shown below. These are reverse-gender connectors.
CHAPTER 2 INSTALLATION AND OPERATION System Assembly and Bench Test Assembling the Nanoscanner reader system is very easy. We recommend you set up the system and verify its operation in a bench test configuration before installing it in a live application. You will need two available 120 VAC wall outlets. Bench Test or Demo Connections 1. Situate the PC on a tabletop. Ensure the following conditions: • Two standard 120 VAC outlets are available nearby (one for reader, one for PC if needed).
CHAPTER 2 INSTALLATION AND OPERATION 3. Connect the RS-232 cable to the serial port on the PC. 4. Connect antenna coaxial cables to each antenna connectors. • Connect the antenna marked Tx to the Tx connector of the reader and connect the antenna marked Rx on the Rx connector. • Align the coax cable’s center pin and push into the port • Screw the fitting from the cable end onto the reader connector clockwise until finger tight to secure the cable to the reader.
CHAPTER 2 INSTALLATION AND OPERATION Bench Test Procedure 1. Access an operational mode suitable for bench testing. • Select a mode that will allow multiple consecutive reads of a single tag. • Refer to the applicable software application user guide for specific instructions. 2. Position the reader to you can see the LEDs. • You may also want to position the PC so you can view the monitor simultaneously for later tests. 3. Shield a tag in a metal enclosure or enclosed in your hand.
CHAPTER 2 INSTALLATION AND OPERATION System Design The following Installation section provides basic guidance for configuring components in your RFID system. You should consider the overall design of your specific system before permanently mounting the equipment. Installation Installation involves all the same connection steps required for bench test. However, instead of situating equipment on a tabletop, the reader and antenna and their accessories will mounted in your application environment.
CHAPTER 2 INSTALLATION AND OPERATION Requirements Before installing your Nanoscanner reader system you will need the following: PC running Windows 98 or higher, with CD-ROM drive (for demo system software) and one available RS-232 serial port Standard 120 VAC power for the reader location and PC location Host software Any additional RS-232 cables or connectorized antenna coax cables needed to accommodate routing requirements Standard grounded, three-pronged power cord of desired length Mounting hardware s
CHAPTER 2 INSTALLATION AND OPERATION 2. Select mounting position for reader. • Reader should be positioned close enough to the antenna to accommodate the cable length without putting strain on the connectors. • Be sure power is available to the selected reader location. 3. Select location for host PC. • Situate the host PC within 50 ft of the reader in a safe location away from vehicular and foot traffic. 4. Install reader.
CHAPTER 2 INSTALLATION AND OPERATION System Operation SOFTWARE DEVELOPERS If you are a software developer, the balance of this document provides the information you will need to install the reader on the host computer, communicate with it, and customize its performance via text commands to enable reader operation tailored to the desired application. CUSTOM SYSTEM USERS If you are a custom system user, please refer to your host software user guide for information regarding system and software operations.
CHAPTER 3 NANOSCANNER SYSTEM FUNDAMENTALS CHAPTER 3 Nanoscanner System Fundamentals This chapter provides an overview of the major features found in a Nanoscanner reader. Specific instructions for setting up a reader are provided in the chapter ReaderHost Communications Installation. Reader commands and their uses are covered in the chapter Reader-Host Protocol.
CHAPTER 3 NANOSCANNER SYSTEM FUNDAMENTALS SERIAL COMMUNICATION Commands can be issued to the Nanoscanner using a direct serial connection from a computer to the reader. The following settings are required for the serial communication: Baud Rate : 115200 Data Bits :8 Parity : None Stop Bits :1 Flow Control : None NETWORK COMMUNICATION Commands can be issued to the Nanoscanner over the Internet or Intranet.
CHAPTER 3 NANOSCANNER SYSTEM FUNDAMENTALS Serial Interrogation One of the simplest methods to find out the reader’s IP address is to connect via the serial connection and type the command “get IPaddress’” to return the IP address currently in use by the device. However, this requires a physical connection between a host computer and the reader—a connection that in many cases is simply impractical to set up.
CHAPTER 3 NANOSCANNER SYSTEM FUNDAMENTALS The Reader Type parameter details the specific type of reader sending out the heartbeat. This information is hard-coded into the reader’s firmware and is not user-configurable. The IP Address and Command Port parameters detail the location of the reader on the network. The IP address is simply the network address of the reader. The command port is the port number on which the reader is listening for incoming user commands.
CHAPTER 3 NANOSCANNER SYSTEM FUNDAMENTALS Tag List Concepts During normal operation the Nanoscanner maintains an internal list of the tags that are active. Active tags are those read by the reader at least once within a predefined time period. Any new tags presented to the reader are added to this list, and any tags that have not been seen for a while are removed from the list. At any time a programmatic call can be made to the reader to retrieve this list of tags.
CHAPTER 3 NANOSCANNER SYSTEM FUNDAMENTALS Tag List Size The Tag List is currently configured to hold up to 1000 unique tag IDs and their associated data. Reading Tags over the Network The Alien RFID reader provides two methods with which to read tags: interactive mode and autonomous mode. • In interactive mode, the controlling application must issue commands to the reader to read tags. This command will always return immediately with a list of tags in view of the reader.
CHAPTER 3 NANOSCANNER SYSTEM FUNDAMENTALS 1 0 Autonomous Mode Autonomous mode is a multi-stage configuration and operation mode that enables hands-free monitoring of tags. • The first stage requires you to issue a series of configuration commands to the reader. These commands detail how and when to read tags, and then when tags are found, who to tell. • Once configured, the reader can be left to operate on its own.
CHAPTER 3 NANOSCANNER SYSTEM FUNDAMENTALS START WORKING TRIGGER The receipt of a trigger pattern on the digital input lines will cause the reader to move from the Waiting state to the Working state. The start condition is set by the AutoStartTrigger command. The AutoStartTrigger command takes two parameters, a rising edge pattern and a falling edge pattern. Set AutoStartTrigger = 2,0 would cause the reader to enter the working state on receipt of a rising edge on pin 2.
CHAPTER 3 NANOSCANNER SYSTEM FUNDAMENTALS using the parameters set in the AcquireMode and PersistTime commands. The reader continues working until the Stop Working Trigger conditions are met. (See below) STOP WORKING TRIGGER Like the Start Working Trigger, the Stop Working Trigger can be a change on the digital input lines. Use the AutoStopTrigger command with a rising, falling edge pattern to set the trigger conditions.
CHAPTER 3 NANOSCANNER SYSTEM FUNDAMENTALS Set Set Set Set Set Set Set AutoStartTrigger=0,0 AutoStopTimer = 0 AutoTrueOutput =1 AutoTruePause =50 AutoFalseOutput = 2 AutoFalsePause = 50 AutoMode=On EXAMPLE 2. TRIGGERED READING Here a forklift will cause an electric eye to send a pulse to the reader. We want the reader to look for the rising edge on this pulse and look for tags for 1.8 seconds before going back to the Wait state. We wont make any changes to the output pins.
CHAPTER 3 NANOSCANNER SYSTEM FUNDAMENTALS Notification Mode The last stage in configuring the autonomous mode is to tell the reader under what conditions to notify listeners about tag lists. Listeners (network applications / people) will be notified only when preset conditions arise, such as when new tags are read, or tags disappear from view.
CHAPTER 3 NANOSCANNER SYSTEM FUNDAMENTALS Defining the Notification Address You must tell the reader where to send notification messages to when it is operating in autonomous mode. The Alien reader can be instructed to send out messages over the internet to a specified machine or over email to specified email address. This is configured using a single command: • Set NotifyAddress = address The format of the address indicates the method of delivery: NotifyAddress user@domain.
CHAPTER 3 NANOSCANNER SYSTEM FUNDAMENTALS • Text formatted tag lists take the form: #Alien RFID Reader Auto Notification Message #ReaderName: Spinner Reader #ReaderType: Alien RFID Tag Reader (Class 1 / 915Mhz) #IPAddress: 10.1.70.
CHAPTER 4 TAG READING FUNDAMENTALS CHAPTER 4 Tag Reading Fundamentals This chapter provides an overview of the major tag reading concepts found in all Alien RFID systems. A good understanding of this chapter is highly recommended to get the most of out this Nanoscanner system. Introduction RFID tag reading is not just about getting the tag ID from a tag into the reader.
CHAPTER 4 TAG READING FUNDAMENTALS There are many applications where global scroll is the best tag reading method to use. These applications typically expect just one or two tags in the field of view at any one time, such as conveyor belt applications or toll-booth application. For these systems, global scroll outperforms a full inventory by a factor of 3 as far as individual read rates are concerned.
CHAPTER 4 TAG READING FUNDAMENTALS Masks and Tag Memory Structure Many commands aimed at Alien RFID tags require the setting of a mask, which directs the commands only at the tags who’s ID matches the mask. This mechanism allows commands to be sent to one specific tag, a selective group of tags or the whole field of tags. However to understand the use of masks, a basic understanding of tag memory structure is first required.
CHAPTER 4 TAG READING FUNDAMENTALS EPC Code (or User ID Code) Byte Bit 0 1 2 3 4 5 6 7 8 9 10 11 0-7 8-15 16-23 24-31 32-39 40-47 48-55 56-63 64-71 72-79 80-87 88-95 Class BPT Tag Memory Structure MASK COMMAND FORMAT The Mask command is a simple get and set pair, where the parameters comprise three parts: • • • Bit Length of Mask, as a decimal number Bit Pointer of Mask, as a decimal number Array of Hex Bytes separated by white spaces ADDRESSING ALL TAGS The simplest mask setti
CHAPTER 4 TAG READING FUNDAMENTALS For example, the following mask command can be issued to address only tag IDs that start with the numbers ’8000 0040’: Set mask = 32, 0, 80 00 00 40 i.e., length = 32 bits, (4 x 8 bytes), starting at bit zero from left. Subsequent commands that use a mask will now only be replied to by a tag that starts with this tag ID. This can be useful if for example the reader is scanning food items, but is only interested in finding a certain brand of breakfast cereal.
CHAPTER 4 TAG READING FUNDAMENTALS Persistent Sleep and Wake Tags have the ability to be put to sleep and awakened on command. Once tags have been put to sleep they will ignore any subsequent commands, even if addressed directly to them. The only command that these slept tags will respond to is wake, which will bring them back to life and make them respond to all commands again. The Sleep and Wake commands can act together in a powerful way to help address multiple tags in the field.
CHAPTER 4 TAG READING FUNDAMENTALS SLEEP, WAKE AND MASKS The Sleep and Wake commands always work with the current Mask setting. Therefore it is possible to Sleep a subset of tags before performing an acquire, or to Sleep all tags, then Wake a subset before acquire. Combining Sleep, Wake, Masks and Acquire Modes offers up many interesting possibilities for tag reading that will virtually address all problems in the field.
CHAPTER 5 READER-HOST COMMUNICATIONS INSTALLATION CHAPTER 5 Reader Host Communications Installation The Nanoscanner reader is designed to be programmed using simple ASCII textbased commands from any programming language. Introduction The CD provided with your Nanoscanner Reader Developer’s Kit includes extensive examples of code developed by Alien for the Nanoscanner using Java and VisualBasic programming languages. These examples will serve as models for developing new software for the reader.
CHAPTER 5 READER-HOST COMMUNICATIONS INSTALLATION • Programmers are competent in at least one programming or scripting language and have the ability to issue ASCII-based commands with that language. Requirements Serial communication requires: • A text-based serial communications program (such as Windows HyperTerminal) running on any computer. Ethernet communication requires: • An Ethernet network.
CHAPTER 5 READER-HOST COMMUNICATIONS INSTALLATION This method enables real-time operation of the reader via a serial communications (“comm.”) port. Serial communication is the simplest means by which to connect the reader to the host and implement ASCII command protocol. Command Line Operation: Telnet Communication Telnet communication requires a network connection via the reader’s Ethernet port and allows the reader to operate like a Telnet server.
CHAPTER 5 READER-HOST COMMUNICATIONS INSTALLATION Once configured, the software should allow you to communicate with the Nanoscanner. • HyperTerminal example configuration screens are shown below: 5. At the command prompt, you may now type any command followed by the [ENTER] key to submit the command.
CHAPTER 5 READER-HOST COMMUNICATIONS INSTALLATION For a detailed explanation of all commands available, please refer to the chapter entitled Reader–Host Protocol. Network Installation (Optional) To configure the system for network operation, you will use the commands shown under the NETWORK heading. There are 5 NETWORK commands that may be used for network configuration: • Get | Set DHCP (On of Off) • Get | Set IP address • Get | Set Netmask • Get | Set Gateway • Get | Set DNS 1.
CHAPTER 5 READER-HOST COMMUNICATIONS INSTALLATION • If value is not accepted, reader will return “0.0.0.0”. 9. Type “Reboot” to reboot the reader and implement the commands. To verify your network connection to the reader: 10. Launch a browser. 11. Enter the reader’s assigned IP address into the web page location bar. • If the IP address is valid, the Alien reader portal will display. Web portal (above) Telnet portal (right) 12. For Web access, click the [ENTER] box.
CHAPTER 5 READER-HOST COMMUNICATIONS INSTALLATION • Password = password 14. You are now ready to interact with the reader via commands. • For Telnet operation, you will be using the text command lines in the same manner as in direct serial communication. The only difference is in the use of the “Q” command to quit the Telnet session. • For Web operation, you will be using the HTML screens as shown.
CHAPTER 6 READER-HOST PROTOCOL CHAPTER 6 Reader Host Protocol The Reader Host protocol is a text-based communications protocol for configuring and operating the Alien Nanoscanner RFID reader for enterprise host systems connectivity. Introduction This chapter describes the programming interface that links the Alien Nanoscanner RFID reader to the outside world. For a overview of the reader system, see the chapters entitled: Nanoscanner System Fundamentals and Tag Reading Fundamentals.
CHAPTER 6 READER-HOST PROTOCOL Text-Based Command Line Operation To interact with the reader via command line operation you must either be communicating directly with the reader via the serial port connection to the host, or via the Internet and a Telnet connection. In both cases the screens will look similar and will thus be considered identical for the purposes of the instructions that follow.
CHAPTER 6 READER-HOST PROTOCOL Most of the pages served up by the Web server are simple HTML pages. Web-based HTML screen showing general commands tab with username and password fields. However there also a number of simple Java Applets that are used to provide an interactive environment for reading tags in the field. These Java Applets are all Java 1.1 compliant applets and will work in standard Netscape and Internet Explorer browsers.
CHAPTER 6 READER-HOST PROTOCOL Commands Overview There are two distinct categories of reader-host command: those initiated by the enterprise host (interactive commands), and those initiated by the reader itself (autonomous commands). INTERACTIVE COMMANDS Interactive commands are initiated by a programmer, who creates and issues a command to the reader. The reader always responds to these commands with an immediate reply.
CHAPTER 6 READER-HOST PROTOCOL An example of a multiple line command / response is: >Get ReaderVersion[CR][LF] >ReaderVersion = 1.0[CR][LF] FirmwareVersion = 1.0[CR][LF] SoftwareVersion = 1.0[CR][LF][0] Commands are case insensitive, i.e., “set readername” is equivalent to “Set ReaderName.” Suppressing Command Prompts By default all commands are set up for interactive use over a serial console or telnet style interface.
CHAPTER 6 READER-HOST PROTOCOL Command List with Functions GENERAL COMMANDS Command Description Help (or “h”) List all reader commands available. Info (or (“i”) List all current reader settings. Get TagList Scan the field, read tags and report. (see Tag List Commands for details.) ! (exclamation mark) Repeats the last command issued. Q Quit session (TELNET ONLY) Get ReaderName Set ReaderName Allows an arbitrary name to be associated with and retrieved from the reader.
CHAPTER 6 READER-HOST PROTOCOL TIME COMMANDS Command Description Get Time Set Time Get and Set the real time clock on the reader in Local time. Get TimeZone Set TimeZone Get and Set the time zone offset from UTC for the real time clock. Get TimeServer Set TimeServer Get and Set the location of a network time server. EXTERNAL IO COMMANDS Command Description Get ExternalOutput Set ExternalOutput Get and Set the External Output pin values. Get ExternalInput Get the External Input pin values.
CHAPTER 6 READER-HOST PROTOCOL Get AutoStartTrigger Get AutoStartTrigger Get and Set the trigger that sends the auto mode state into working state. Set AutoWorkOutput Specify the value of the output pins while in work mode. Get AutoAction Get and Set the action to perform in auto mode.
CHAPTER 6 READER-HOST PROTOCOL Using the Commands This section describes each command, its use and the response formats. NOTE: Nanoscanner reader commands are case insensitive, that is, you can use upper or lower case, or any combination thereof, and the reader will understand the command. Capitalization of commands is used in this document and in actual command responses solely for the purpose of readability.
CHAPTER 6 READER-HOST PROTOCOL GET READERTYPE The reader type can be retrieved using this command. The resulting text will be a single-line reply describing the model number of the reader and related information. Example Command >Get ReaderType Response >ReaderType = Alien RFID Tag Reader (Class 1 / 915MHz) GET READERVERSION The reader version can be retrieved using this command. The resulting text is a multi-line reply. Each line of the reply describes the version number of a major reader component.
CHAPTER 6 READER-HOST PROTOCOL • A username/password pair is not required when operating the reader via serial connection. • The default password setting is “password” NOTE: The password is case sensitive and must be entered in all lowercase. Example Command >Get Password Response >Password = password Command >Set Password = 1234fab Response >Password = 1234fab GET ANTENNASEQUENCE SET ANTENNASEQUENCE The reader can support the use of multiple antennas.
CHAPTER 6 READER-HOST PROTOCOL REBOOT The Reboot command will immediately cause the reader to reboot itself. Example Command >Reboot Response >Reader is rebooting now ! FACTORYSETTINGS The FactorySettings command will reset all settings in the reader to their default values. Example Command >FactorySettings Response >All settings have been reset ! General Commands – Web Based General commands are issued via the Web page to manipulate reader and antenna functions and access information.
CHAPTER 6 READER-HOST PROTOCOL • Get | Set Username • Get | Set Password • Get | Set AntennaSequence • Reboot • Factory settings (see below) This screen lets you cancel or continue to reset reader to factory settings. When you click on the “Reset reader factory settings” option at the bottom of the General tab screen, you will have an opportunity to change your mind before the command is accepted.
CHAPTER 6 READER-HOST PROTOCOL Network Configuration Commands – Text Based These commands allow you to configure and retrieve settings related to reader communications with the network. GET DHCP SET DHCP The reader supports automatic network configuration using the widely available DHCP protocol. If DHCP is available at the reader installation site, this protocol can be switched on. If DHCP is not available or not desired the use of this protocol can be switched off.
CHAPTER 6 READER-HOST PROTOCOL Example Command >Get Gateway Response >Gateway=34.56.78.90 Command >Set Gateway=12.56.23.01 Response >Gateway=12.56.23.01 GET NETMASK SET NETMASK If DHCP is not used for automatic configuration, the reader must be manually configured for use on a network. The subnet mask command pair allow the subnet mask to be assigned and retrieved. • A subnet mask must be specified as a numerical IP address.
CHAPTER 6 READER-HOST PROTOCOL GET HEARTBEATPORT SET HEARTBEATPORT The reader can be configured to periodically send out a heartbeat message to the network. This heartbeat takes the form of a single UDP packet (Universal Datagram Packet) broadcast out to the entire subnet that the reader is configured for. The Set HeartbeatPort command allows you to configure the actual port number that this packet is sent out to.
CHAPTER 6 READER-HOST PROTOCOL Example Command >Get HeartbeatTime Response >HeartbeatTime=30 Command >Set HeartbeatTime=60 Response >HeartbeatTime=60 GET COMMANDPORT SET COMMANDPORT The reader can be configured and operated over the network using standard network sockets. The CommandPort settings are used to assign and retrieve the exact port number used by the reader for this network connectivity.
CHAPTER 6 READER-HOST PROTOCOL COMMANDS/OPERATIONS VIA WEB NETWORK TAB Command equivalents found on the Web-based “Network” tab are: • Get DHCP • Set DHCP (toggles DHCP On and OFF) • Get | Set IPaddress • Get | Set Gateway • Get | Set Netmask • Get | Set DNS • Get | Set HeartbeatPort • Get | Set HearbeatTime • Get | Set CommandPort NANOSCANNER READER USER GUIDE • DOC # 8101029-000 REV A © 2003 Alien Technology™ 61
CHAPTER 6 READER-HOST PROTOCOL Time Commands – Text Based The time at which tags are read by a reader is particularly important for many applications. For this reason, the reader has three time commands to ensure that the onboard real-time clock is always set accurately. GET TIME SET TIME These commands allow the current time to be assigned to or retrieved from the reader. • Times used by this command are always specified in local time, as defined by the TimeZone command.
CHAPTER 6 READER-HOST PROTOCOL Example Command >Get TimeZone Response >TimeZone = -8 >Set TimeZone = 3 >TimeZone = 3 GET TIMESERVER SET TIMESERVER The reader uses the Internet to accurately set its internal clock every time it is rebooted. The protocol it uses is called the Daytime Protocol (RFC-867) which typically returns the time in UTC format. In order to use this feature, a TimeServer must be specified. This is the network address of a machine that is constantly running the Daytime Protocol.
CHAPTER 6 READER-HOST PROTOCOL Boot> Boot Level 4 (System Settings) : Success Boot> Boot Level 5 (Network) : Success - IP Address is 10.1.60.4 Boot> Boot Level 6 (Telnet Interface) : Success - Port 23 Ready Boot> Boot Level 7 (Web Interface) : Success Boot> Boot Level 8 (Network Time Service) : Success - Time Set to 2002/08/23 16:50:24 Boot> Ready Time Commands – Web Based Time commands are issued via the Web page to set up and access reader time parameters.
CHAPTER 6 READER-HOST PROTOCOL External I/O Commands These commands allow you to configure and retrieve current data regarding the reader’s external output functions. SET EXTERNALOUTPUT GET EXTERNALOUTPUT The reader controls two external output pins, which can subsequently be used to control external devices such a doors/gates, security lights. etc. Please refer to Chapter 1, Specifications section in this document for pinout diagrams. With this command you can set the external output pin values.
CHAPTER 6 READER-HOST PROTOCOL External I/O Commands – Web Based External I/O commands are issued via the Web page to set up and access external input and output parameters. Web view I/O tab covers all Get and Set External I/O commands.
CHAPTER 6 READER-HOST PROTOCOL Tag List Commands – Command Line Tag list commands allow you to retrieve immediate listings of tags that have been read and saved by the reader, and to assign and retrieve tag list functional parameters. NOTE: Web versions of these operations are shown in the next section. GET TAGLIST (N) You can retrieve the reader’s stored tag list either a single time (Get TagList) or multiple times (Get TagList n). • The maximum number of tags that can be stored in the tag list is 1000.
CHAPTER 6 READER-HOST PROTOCOL TagListFormat • Description text Tag lists displayed as plain text messages, one tag ID per line. xml Tag lists are displayed in XML text format custom Tag lists are displayed in the format described by TagListCustomFormat.
CHAPTER 6 READER-HOST PROTOCOL SET TAGLISTCUSTOMFORMAT GET TAGLISTCUSTOMFORMAT The Get and Set TagListCustomFormat allows a customized tag list to be defined. Once the format has been defined it can be applied by issuing the command ‘set taglistFormat = custom’ The tagListCustomFormat command takes a single text line argument that defines how each tag should be represented on-screen. This argument can be made up of a mixture of text and tokens, where the tokens are defined in the table below.
CHAPTER 6 READER-HOST PROTOCOL SET ACQUIREMODE GET ACQUIREMODE Whenever the reader is called upon to read a tag it does so using the current AcquireMode. Currently the allowable modes are as follows: AcquireMode Description Inventory Perform full inventory of multiple tags. Global Scroll Perform fast search for single tag. The default setting is Inventory.
CHAPTER 6 READER-HOST PROTOCOL If AcquireSleep is set to On, any tags read by auto mode or interactive mode will be put to sleep as they are found. Subsequent reads of the tag field will return no more tags, until Wake commands are issued to the tags. If AcquireSleep is set to Off, tags will be left awake once they have been read. Thus repeated reads will return the same tag IDs.
CHAPTER 6 READER-HOST PROTOCOL Bit Length of Mask, as a decimal number Bit Pointer of Mask, as a decimal number Array of Hex Bytes separated by white spaces Note: Class I tags IDs start at bit 16, not bit 0. The first 16 bits of a Class I tag are used to store the checksum for the tag. The Get Mask command takes no parameters but returns the three parameters described above. Note: Setting the mask to ‘All’ will address all tags currently in the RF field. i.e.
CHAPTER 6 READER-HOST PROTOCOL • A zero persist time (0) will guarantee that tags are not stored in the tag list. However issuing a get taglist command in interactive mode will return any tags immediately found even though they won’t be stored in the taglist. • Setting the persist time to –1 will cause the history to build indefinitely until a get taglist command is issued; at this point the tag list is returned, and then immediately cleared.
CHAPTER 6 READER-HOST PROTOCOL Tag List Commands – Web Based Tag List commands are issued via the Web page to set up and access tag information. Allows you to: Tag List displays: Get and Set Acquire Mode… • Tag ID • CRC • Discover time Get and Set Persist Time... • Reading Antenna Display TagList... • Read count and Clear TagList. COMMANDS/OPERATIONS ON WEB TAG LIST TAB NOTE : Every time the Tag List page is loaded / refreshed, it is the equivalent of issuing a Get Taglist command to the reader.
CHAPTER 6 READER-HOST PROTOCOL Autonomous Mode Commands Autonomous mode is a multi-stage configuration and operation mode that enables hands-free monitoring of tags. • The first stage requires you to issue a series of configuration commands to the reader. These commands detail how and when to read tags, and then when tags are found, who to tell. • Once configured, the reader can be left to operate on its own.
CHAPTER 6 READER-HOST PROTOCOL SET AUTOSTARTTRIGGER GET AUTOSTARTTRIGGER The AutoStartTrigger specifies the external input pins to monitor to cause the automode to jump from wait state to work state. Triggers can either be a pin going from low to high (rising edge) to high to low (falling edge). For each type of change, an integer bit mask must be provided to specify the pins to listen for changes on. The command takes two parameters, a rising edge bit mask and a falling edge bit mask.
CHAPTER 6 READER-HOST PROTOCOL • The default setting is Acquire NOTE: Changes made with this command will take effect immediately. Example Command >Get AutoAction Response > AutoAction = Acquire Command >Set AutoAction =Acquire Response > AutoAction = Acquire SET AUTOSTOPTRIGGER GET AUTOSTOPTRIGGER The AutoStopTrigger specifies the external input pins to monitor to cause the automode to jump from work state to evaluate state.
CHAPTER 6 READER-HOST PROTOCOL Example Command >Get AutoStopTimer Response > AutoStopTrimer (ms) = 0 Command >Set AutoStopTimer =1000 //Acquire for 1sec then evaluate Response > AutoStopTimer (ms)= 1000 SET AUTOTRUEOUTPUT GET AUTOTRUEOUTPUT The AutoTrueOutput specifies the output pin settings to effect if the evaluate mode of autonomous mode evaluates to true. The parameter is a bit mask for the two external output pins, where a ‘1’ sets a pin to high, and a ‘0’ sets a pin to low.
CHAPTER 6 READER-HOST PROTOCOL low. Pin 1 is specified by bit one in the mask, and Pin 0 is specified by bit zero in the mask. NOTE: Changes made with this command will take effect immediately. Example Command >Get AutoFalseOutput Response > AutoFalseOutput =0 Command >Set AutoFalseOutput =3 //Turn pins 0 and 1 to high Response > AutoFalseOutput =3 SET AUTOFALSEPAUSE GET AUTOFALSEPAUSE The AutoFalsePause specifies a millisecond pause to effect if the autonomous evaluation mode evaluates to false.
CHAPTER 6 READER-HOST PROTOCOL . Example Command >Get AutoModeStatus Response > AutoModeStatus =0 //Auto Mode is off Command > Get AutoModeStatus Response > AutoModeStatus =30 * //Auto is starting its AutoAction but the asterisk also indicates that a complete auto mode cycle has completed since we last enquired. AUTOMODERESET The AutoModeReset command will reset all auto mode parameters to their default values, including setting the auto mode to off.
CHAPTER 6 READER-HOST PROTOCOL Autonomous Mode Commands – Web Based Autonomous Mode commands are issued via the Web page to set up and access autonomous mode parameters. Web view Autonomous Mode tab covers all Get and Set autonomous mode commands.
CHAPTER 6 READER-HOST PROTOCOL Notify Mode Commands The Notify Mode commands are used to set up automated event notification when the reader is running in Auto Mode. SET NOTIFYMODE GET NOTIFYMODE The NotifyMode command turns on or off the notify mode. • Valid command parameters are ON and OFF • The default setting is OFF NOTE: Changes made with this command will take effect immediately.
CHAPTER 6 READER-HOST PROTOCOL Example Command >Get NotifyAddress Response >NotifyAddress=10.1.0.12:4000 Command >Set NotifyAddress=user@msn.com Response >NotifyAddress=user@msn.com GET NOTIFYTIME SET NOTIFYTIME The Notify Time commands assign and retrieve the time interval for automatic tag list pushing to a listening machine. • The time is specified in seconds. • The minimum allowed time is 30 seconds. • If set to zero or a negative number the time-based automatic notification is disabled.
CHAPTER 6 READER-HOST PROTOCOL TRUEFALSE Send messages when the evaluation task of the autonomous state loop evaluates to true or false NOTE: Changes made with this command will take effect immediately. Example Command >Get NotifyTrigger Response >NotifyTrigger= REMOVE Command >Set NotifyTrigger=ADD Response >NotifyTrigger=ADD GET NOTIFYFORMAT SET NOTIFYFORMAT The NotifyFormat parameter specifies the format of any notification message.
CHAPTER 6 READER-HOST PROTOCOL TEST MESSAGE 0102 0304 0506 0709 87B4 2003/01/17 11:37:01 0 1413726 2283 1668 ADC3 E804 9FD0 2003/01/19 07:01:19 0 1
CHAPTER 6 READER-HOST PROTOCOL Command >Get MailFrom Response >MailFrom = AlienRFIDReader Command >Set MailFrom = reader@mycompany.com Response MailFrom = reader@mycompany.com NOTIFYNOW The NotifyNow command instructs the reader to send out an immediate notification of its tag list to the address currently set by the NotifyAddress command. Example Where the reader is set to notify an internet address. Command >NotifyNow Response >Notification sent to 34.322.21.
CHAPTER 6 READER-HOST PROTOCOL Notify Mode Commands – Web Based Notify Mode commands are issued via the Web page to set up and access notify mode parameters. The commands are accessed at the bottom of the Autonomous Web Page section. Web view Notify Mode tab covers all Get and Set notify mode commands. This web page is located at the bottom of the Autonomous Mode web page.
CHAPTER 7 READER-HOST PROTOCOL EXTENSIONS FOR BATTERY POWERED BACKSCATTER TAGS CHAPTER 7 Reader Host Protocol Extensions for Battery Powered Backscatter Tags The Reader <–> Host protocol detailed in the previous chapter is a text-based communications protocol for configuring and operating the entire family of Alien Nanoscanner RFID readers. This chapter details extensions to this standard protocol that directly address the extended functionality of the Battery Powered Backscatter tags running at 2450Mhz.
CHAPTER 7 READER-HOST PROTOCOL EXTENSIONS FOR BATTERY POWERED BACKSCATTER TAGS Command List with Functions TAG COMMANDS Command Description Get TagID Get the ID of a tag. Get TagInfo Get information about a tag. Get TagVersion Get the tag firmware version. Get TagTime Get and Set the time and date on the tag’s built in clock. Set TagTime MEMORY COMMANDS Command Description Get Memory Set Memory Get and Set data from the tag memory.
CHAPTER 7 READER-HOST PROTOCOL EXTENSIONS FOR BATTERY POWERED BACKSCATTER TAGS Using the Commands This section describes each command, its use and the response formats. NOTE: Nanoscanner reader commands are case insensitive, that is, you can use upper or lower case, or any combination thereof, and the reader will understand the command. Capitalization of commands is used in this document and in actual command responses is solely for the purpose of readability.
CHAPTER 7 READER-HOST PROTOCOL EXTENSIONS FOR BATTERY POWERED BACKSCATTER TAGS GET TAGVERSION Get TagVersion command will return information about a the firmware running on a tag. Example Command >get tagversion Response Tag Firmware Version = 2.1.2 GET TAGTIME SET TAGTIME Each tag has an on-board real-time clock. The time represented by this clock can be obtained or set using these commands.
CHAPTER 7 READER-HOST PROTOCOL EXTENSIONS FOR BATTERY POWERED BACKSCATTER TAGS Memory Commands Each tag may have on-board memory that can be used for arbitrary user data storage, or for holding sensor logging data. These commands allow this memory to be interrogated and programmed. As always, use the ‘set mask’ command to identify the unique tag to communicate with. SET MEMORY GET MEMORY Set and Get Memory commands allow the direct manipulation and interrogation of the tag memory.
CHAPTER 7 READER-HOST PROTOCOL EXTENSIONS FOR BATTERY POWERED BACKSCATTER TAGS Example Command >Get Memory = 20, 0 Response Memory@0000 = AF 00 A5 17 59 01 01 01 01 01 A5 0A 00 00 A5 80 Memory@0010 = 16 80 16 80 Command >Set Memory = 0, 01 02 03 04 05 06 07 08 09 0A 0B Response Memory@0000 = Written and Verified SET MEMORYPACKETSIZE GET MEMORYPACKETSIZE Set and Get MemoryPacketSize commands determine the number of bytes to use in each memory related transmission packet to and from the tag.
CHAPTER 7 READER-HOST PROTOCOL EXTENSIONS FOR BATTERY POWERED BACKSCATTER TAGS Sensor Commands The sensor commands deal exclusively with a tag’s onboard sensor. GET SENSORVALUE Get SensorValue will return the sensor’s current value. If the sensor was already switched off, this command will start the sensor before returning a value, which may take up to 1 second. Sensors will automatically be switched off two seconds after this command has been completed in order to preserve the battery life of the tag.
CHAPTER 7 READER-HOST PROTOCOL EXTENSIONS FOR BATTERY POWERED BACKSCATTER TAGS Example Command >Get LoggingMode Response >LoggingMode =Off Command >Set LoggingMode = On Response >LoggingMode =On GET LOGGINGINTERVAL SET LOGGINGINTERVAL When automatic logging is active, the tag will retrieve a value from the sensor and store it in tag memory on a periodic basis until the memory is full. At this point logging will cease. The periodicity of this logging is controlled by the logging interval parameter.
CHAPTER 8 WEB BASED APPLICATION EXAMPLES CHAPTER 8 Web Based Application Examples As part of the standard functionality of the Nanoscanner reader, the built-in web server is able to serve up a simple web based application example. This application example can be found under the last tab on the Web pages, named “Applications.” Under this tab is a simple Applet running two applications that use reader commands. These provide an interactive environment for reading tags in the field.
CHAPTER 8 WEB BASED APPLICATION EXAMPLES Tag List The Tag List applet provides a graphical view of the reader’s current tag list.
CHAPTER 8 WEB BASED APPLICATION EXAMPLES Optimize Reader Settings On each of the Tag List and Readometer screens is a small checkbox option entitled ‘Optimize Reader Settings’, which by default is checked (a tick mark is present). When checked this tells the applet to optimize the reader settings the next time one of the two applications is started (i.e., the HAL eye turns to red).
CHAPTER 8 WEB BASED APPLICATION EXAMPLES (~every 250ms) issues a ‘get taglist’ command, forcing the full tag list to be returned and the reader to reset its internal tag list.
