Simatic Rf660r en en-us

8/8/2019 Simatic Rf660r en en-us

1/176

SIMATIC Sensors RFID Systems SIMATIC RF660R XML Interface

Answers for industry.

SIMATIC Sensors

RFID SYSTEMS

SIMATIC RF660R XML Interface

Function Manual 12/2009


2/176


3/176

Introduction 1

Quick Reference 2

Description 3

Messaging Overview 4

Connection Set UpProcedure and Messages 5

Service ProvisioningMessages 6

Standard ConfigurationMessages 7

Smart Reader Configuration 8

Control Messages 9

Smart Reader Tag InventoryManagement 10

Smart Reader DataExchange Messages 11

General Reader Information 12

Development Testing 13

Firmware Update 14

Appendix A

Appendix B

SIMATIC SensorsRFID SystemsSIMATIC RF660R XML Interface

Function Manual

12/2009J31069-D0173-U001-A6-7618


4/176

egal information

Warning notice systemThis manual contains notices you have to observe in order to ensure your personal safety, as well as to preventdamage to property. The notices referring to your personal safety are highlighted in the manual by a safety alertsymbol, notices referring only to property damage have no safety alert symbol. These notices shown below aregraded according to the degree of danger.

DANGERindicates that death or severe personal injury will result if proper precautions are not taken.

WARNINGindicates that death or severe personal injury may result if proper precautions are not taken.

CAUTIONwith a safety alert symbol, indicates that minor personal injury can result if proper precautions are not taken.

CAUTIONwithout a safety alert symbol, indicates that property damage can result if proper precautions are not taken.

NOTICEindicates that an unintended result or situation can occur if the corresponding information is not taken intoaccount.

If more than one degree of danger is present, the warning notice representing the highest degree of danger willbe used. A notice warning of injury to persons with a safety alert symbol may also include a warning relating toproperty damage.

Qualified PersonnelThe product/system described in this documentation may be operated only by personnel qualified for the specifictask in accordance with the relevant documentation for the specific task, in particular its warning notices andsafety instructions. Qualified personnel are those who, based on their training and experience, are capable ofidentifying risks and avoiding potential hazards when working with these products/systems.

Proper use of Siemens productsNote the following:

WARNINGSiemens products may only be used for the applications described in the catalog and in the relevant technicaldocumentation. If products and components from other manufacturers are used, these must be recommendedor approved by Siemens. Proper transport, storage, installation, assembly, commissioning, operation andmaintenance are required to ensure that the products operate safely and without any problems. The permissibleambient conditions must be adhered to. The information in the relevant documentation must be observed.

TrademarksAll names identified by are registered trademarks of the Siemens AG. The remaining trademarks in thispublication may be trademarks whose use by third parties for their own purposes could violate the rights of theowner.

Disclaimer of LiabilityWe have reviewed the contents of this publication to ensure consistency with the hardware and softwaredescribed. Since variance cannot be precluded entirely, we cannot guarantee full consistency. However, theinformation in this publication is reviewed regularly and any necessary corrections are included in subsequenteditions.

Siemens AGIndustry SectorPostfach 48 4890026 NRNBERGGERMANY

J31069-D0173-U001-A6-7618 12/2009

Copyright Siemens AG 2006,2009.Technical data subject to change


5/176


Function Manual, 12/2009, J31069-D0173-U001-A6-7618 5

Table of contents1 Introduction................................................................................................................................................ 9

1.1 Introduction ....................................................................................................................................9

1.2 Typographical Convention ...........................................................................................................10

2 Quick Reference...................................................................................................................................... 113 Description............................................................................................................................................... 17

3.1 General Operation .......................................................................................................................17

3.2 Note on the Ethernet Usage ........................................................................................................18

4 Messaging Overview ............................................................................................................................... 194.1 Message Format ..........................................................................................................................20

4.2 General Format of Host Initiated Messages ................................................................................214.2.1 Messages with no Parameters.....................................................................................................214.2.2 Messages with Multiple Parameters ............................................................................................224.2.3 Messages with a Single Parameter .............................................................................................234.2.4 Retrieving a Single Parameter from the Reader..........................................................................234.2.5 Retrieving a Set of Parameters from the Reader.........................................................................24

4.3 General Format of Reader Responses........................................................................................254.3.1 Normal Responses ......................................................................................................................254.3.1.1 Responses without any Return Parameters ................................................................................254.3.1.2 Responses with a Single Return Parameter................................................................................264.3.1.3 Responses with Multiple Return Parameters...............................................................................264.3.2 Error Responses ..........................................................................................................................274.3.3 Notifications..................................................................................................................................27

4.4 Backward Compatibility Issues ....................................................................................................284.4.1 Overview of XML Changes with Firmware Version V1.3.............................................................294.4.1.1 HostGreetings Message (Host -> Reader) ..................................................................................294.4.1.2 Notification Channel.....................................................................................................................294.4.1.3 ETSI Frequency Switching Settings ............................................................................................294.4.1.4 Error Code Changes for Firmware Version V1.3 .........................................................................294.4.2 Overview of XML Changes with Firmware Version V1.2.............................................................304.4.2.1 tagIdType .....................................................................................................................................30

4.4.2.2 tagID.............................................................................................................................................304.4.2.3 tagProgramID...............................................................................................................................304.4.2.4 tagDataWrite ................................................................................................................................304.4.2.5 Ter................................................................................................................................................304.4.2.6 hostGreetings...............................................................................................................................314.4.2.7 channelConfig - CHINA Frequency Settings ...............................................................................314.4.2.8 SetReaderProfile CHINA Settings ...............................................................................................324.4.2.9 GetReaderProfile CHINA Settings...............................................................................................324.4.2.10 Get ETSI ChannelConfig .............................................................................................................324.4.2.11 setNotifyChannel..........................................................................................................................324.4.2.12 EPC GEN 2 tagSelectionRange ..................................................................................................334.4.2.13 resetConfig...................................................................................................................................334.4.2.14 Error Code Changes for firmware version V1.2...........................................................................33


6/176

Table of contents


6 Function Manual, 12/2009, J31069-D0173-U001-A6-7618

5 Connection Set Up Procedure and Messages ......................................................................................... 355.2 Connection Initiation from the Host............................................................................................. 37

5.3 Heart Beat Mechanism................................................................................................................ 405.4 Real Time Clock.......................................................................................................................... 425.4.1 Setting the Real Time Clock........................................................................................................ 425.4.2 Retrieve Current Clock Time....................................................................................................... 44

5.5 Goodbye Message from the Host ............................................................................................... 45

5.6 Notes on the Control Channel Connection ................................................................................. 45

6 Service Provisioning Messages............................................................................................................... 476.1 Serial Port Configuration............................................................................................................. 47

6.2 Ethernet Configuration................................................................................................................ 486.2.1 Retrieve Current Ethernet Connection........................................................................................ 49

6.3 DHCP Based Ethernet Setup...................................................................................................... 506.3.1 Setup Ethernet DHCP................................................................................................................. 50

6.4 Notification Channel .................................................................................................................... 526.4.1 Setting the Notification Channel.................................................................................................. 526.4.2 Retrieve Notification Channel Details ......................................................................................... 54

7 Standard Configuration Messages........................................................................................................... 557.1 Reader Profile .............................................................................................................................567.1.1 Set Reader Profile....................................................................................................................... 567.1.2 Get Reader Profile ...................................................................................................................... 57

7.2 Reader Antenna Settings............................................................................................................ 58

7.2.1 Reader Mode Switching.............................................................................................................. 587.3 Reader Frequency Setting .......................................................................................................... 617.3.1 ETSI Frequency Switching Settings............................................................................................ 617.3.2 FCC Channel ID Settings............................................................................................................ 627.3.3 China Frequency Switching Settings .......................................................................................... 64

7.4 Protocol Configuration................................................................................................................. 667.4.1 Set the Protocol Configuration .................................................................................................... 667.4.2 Get Protocol Configuration.......................................................................................................... 69

7.5 Saving Configuration Changes ................................................................................................... 707.5.1 Saving Configuration................................................................................................................... 707.5.2 Get Current Configuration Version.............................................................................................. 717.5.3 Resetting Configuration to Factory Settings ............................................................................... 72

8 Smart Reader Configuration .................................................................................................................... 738.1 Read Trigger Options.................................................................................................................. 738.1.1 Set the Read Trigger................................................................................................................... 738.1.2 Get the Current Read Trigger ..................................................................................................... 75

8.2 Digital Input Configuration........................................................................................................... 768.2.1 Set the Digital Input Configuration .............................................................................................. 768.2.2 Get the Current State of the Digital Input.................................................................................... 78

9 Control Messages.................................................................................................................................... 799.1 Standard Control Messages........................................................................................................ 809.1.1 Resetting the Reader Configuration to its Factory Default ......................................................... 80


7/176

Table of contents



9.1.2 Resetting the Reader ...................................................................................................................819.1.3 Controlling Reader Mode .............................................................................................................82

9.2 Autonomous Mode.......................................................................................................................839.2.1 Autonomous Mode Behaviour......................................................................................................839.2.2 Application Requested Tag Reads ..............................................................................................85

9.3 Setting Digital Output ...................................................................................................................869.3.1 Setting Digital Output ...................................................................................................................86

10 Smart Reader Tag Inventory Management.............................................................................................. 8910.1 Smart Reader Tag Selection........................................................................................................9010.1.1 Tag Select Message ....................................................................................................................9010.1.2 ISO-B Tag Selection ....................................................................................................................9110.1.3 EPC Gen 1 Tag Selection............................................................................................................9410.1.4 EPC Gen 2 Tag Selection............................................................................................................9410.1.5 Retrieve Current Configuration ....................................................................................................97

10.1.6 A Review of Selecting all Tags in View........................................................................................9710.2 Smart Reader Tag ID Programming ............................................................................................99

10.3 Tag Killing ..................................................................................................................................104

11 Smart Reader Data Exchange Messages.............................................................................................. 10711.1 Smart Reader Tag Data Reading ..............................................................................................107

11.2 Smart Reader Tag Data Writing.................................................................................................112

11.3 Smart Reader Tag Locking ........................................................................................................116

11.4 EPC GLOBAL CLASS 1 GEN 1 SPECIFIC COMMANDS ........................................................12211.4.1 EPC1 Command ........................................................................................................................122

11.4.2 QUIET ........................................................................................................................................12411.4.3 TALK ..........................................................................................................................................12411.4.4 VERIFY ......................................................................................................................................12511.4.5 ERASE.......................................................................................................................................125

11.5 EPC GLOBAL CLASS 1 GEN 2 SPECIFIC COMMANDS ........................................................127

12 General Reader Information .................................................................................................................. 12912.1 Reading General Reader Information........................................................................................12912.1.1 Retrieve General Information about the Reader........................................................................12912.1.2 Set Reader Description..............................................................................................................130

13 Development Testing............................................................................................................................. 13113.1 Alerts from the Reader...............................................................................................................131

14 Firmware Update ................................................................................................................................... 13314.1 Firmware Update .......................................................................................................................13314.1.1 Initiating the Firmware Update Process.....................................................................................13514.1.2 Upload Firmware Message ........................................................................................................13614.1.3 Saving the Image to FLASH ......................................................................................................13714.1.4 Set the Reader to Boot from flashBank .....................................................................................13714.1.5 Get Firmware Version Number ..................................................................................................138

14.2 Configuration Information over Firmware Updates ....................................................................139

14.3 Updating the Reader Boot Loader .............................................................................................13914.3.1 Update the Reader Request Message ......................................................................................13914.3.2 Flash Firmware Message...........................................................................................................140


8/176

Table of contents



A Appendix................................................................................................................................................ 141A.1 FCC Sub Bands ........................................................................................................................ 141

A.2 ETSI Sub Bands........................................................................................................................ 142A.3 ETSI Sub Bands for Dedicated Zones in France...................................................................... 143

A.4 CHINA Sub Bands .................................................................................................................... 144

A.5 Reader To Tag Communications Schemes.............................................................................. 145

A.6 ReaderDefault Configuration.................................................................................................... 147

A.7 Discovering MAC / IP of Reader for DHCP............................................................................... 148

A.8 Error Codes From The Reader ................................................................................................. 155

A.9 Error Codes - Displayed by ERROR-LED................................................................................. 166

B Appendix................................................................................................................................................ 167B.1 Certificates and Approvals ........................................................................................................ 167

B.2 Service and support .................................................................................................................. 169

B.3 Contact partner ......................................................................................................................... 170

B.4 Training ..................................................................................................................................... 170

Index...................................................................................................................................................... 171


9/176



Introduction 11.1 IntroductionPurpose of this Documentation

This Manual is purposed for advanced users who may want to develop their own customapplications using the XML based messaging interface of the Portal Reader.The document describes the XML based messaging interface of RF660R Portal Reader. Thedocument also specifies the tag event notifications that the Portal Reader generates.

Scope of this documentationThis documentation is valid for the delivery version of SIMATIC RF660R firmware versionV1.3 and describes the delivery conditions from december 2009.

If you have a SIMATIC RF660R reader with a firmware version prior to V1.3, please refer toan earlier edition of this manual (listed below).

HistoryIssue Comment11/2005 First edition

03/2006 Second edition

Changes first edition -> second edition firmware version V1.1

Setting The Real Time Clock -> new feature Alerts from The Reader -> more info Reader to Tag Communications Schemes -> more features Reader Default Configuration -> more detailed info Serial Port Auto Baud-Rate Detection -> new feature Discovering MAC / IP of Reader for DHCP -> new feature More Error Codes -> more info

11/2006 Third editionMinor modifications

07/2008 Fourth edition / firmware version V1.2

12/2009 Fifth edition / firmware version V1.3

ConventionsWithin this documentation following terms are used synonym:

Reader, Portal Reader

Tag, Transponder, Smartlabel


10/176

Introduction

1.2 Typographical Convention



Common Terms Used in this Document:Config Application (SIMATIC RF660R Configuration Software) Control and ConfigurationSoftware. This is the software to configure the Portal Reader. This uses a configurationwizard to configure a single Portal Reader at one time.

Control Channel A logical channel to exchange control and configuration informationbetween the host and the reader

Host The workstation connected to the Portal Reader and running the ConfigurationSoftware or Manager.

Device & Data Management A management station controlling multiple SIMATIC RF660RReaders.

Notifications Channel A logical channel to carry notification and trace/debug informationfrom the reader to the host.

Reader Refers to the Portal Reader hardware and the embedded software as a single unit.

1.2 Typographical ConventionThe typographical convention used in this specification follows the following rules:

Text/Letters Text/letters appearing in bold must be used literally when composingmessages. These normally represent the keywords when used aselement or attribute values.

italicText Sample text is displayed as italictext and is used for illustration only.

Element and attributes are also displayed as normal text. However,

these always appear within the symbols. However, anelement name when used as a value will appear in bold.

Be careful if you are going to copy and paste messages from this document into your codeas, the application used to write this specification may have used smart quotes or otherspecial characters that may make the XML syntax invalid.

For easier copy-and-pasting messages into your code, the use of the plain-text file 'XML-Protocol-commands-RF660R.txt' is recommended.

This text file contains all Set/Get configuration messages from host to reader/reader to hostwhich are covered by the Function Manual.

Besides, for many commands, various examples are given.


11/176



Quick Reference 2

Connection Establishment and Status MessagesMessage Direction Parameters/Group PurposehostGreetings host->reader hostGreetings Connection initiation from the host

hostGreetings (response) reader->host readerGreetings/error

Response from the reader

heartbeat host->reader none Heartbeat exchange initiated from the host

heartbeat (response) reader->host none Heartbeat response from the reader

hostGoodbye host->reader none Goodbye message from the host

hostGoodbye (response) reader ->host none Response to the above

set host->reader clock Time To set the RTC on the reader

set (response) reader->host *clock Time Responce from the reader

get host->reader *clock Time Get real time of the reader

Get (response) reader->host clock Time Response from the reader

Service Provisioning MessagesMessage Direction Parameters/Group Purposeset host->reader ethernetConfig Static ethernet configuration of the reader

set (response) reader->host *ethernetConfig Response to the above

get host->reader *ethernetConfig To retrieve current Ethernet configuration

get (response) reader->host ethernetConfig Result of the above.

setupEthernetDHCP host->reader none Request to set up Ethernet using the DHCPprocedure.

setupEthernetDHCP(response)

reader->host none Ack to the above request.

set host->reader notifyChannel configuration of the notification channel for tag

eventsset (response) reader->host *notifyChannel Successful response

get host->reader *notifyChannel Get configuration of the notification channel

get (response) reader->host notifyChannel/ error Successful response


12/176

Quick Reference



Configuration Messages

Message Direction Parameters/ Group Purposeset host->reader readerProfile Set the Radio Profile of the reader

set (response) reader->host *readerProfile Response

get host->reader *readerProfile get the Radio Profile of the reader

get(response) reader->host readerProfile Response with the reader profile value

set host->reader channelConfig Set the channel configuration

set (response) reader->host *channelConfig Response to the set request

get host->reader *channelConfig get the current channel configuration

get (response) reader->host channelConfig Response with the current channel config.

set host->reader antennaConfig Set the Antenna configuration

set (response) reader->host * antennaConfig Response to the set request

get host->reader * antennaConfig get the current antenna configuration

get (response) reader->host antennaConfig Response with the current antenna config.

set host->reader protocolConfig Set the protocol configuration

set (response) reader->host *protocolConfig Response to the set request

get host->reader *protocolConfig get the current protocol config

get (response) reader->host protocolConfig Response with the current protocol config

Saving Configuration ChangesMessage Direction Parameters/Group PurposesaveConfig host->reader none Save the current configuration and apply the

given label to it.

saveConfig (response) reader->host none Response to the above

get host->reader *configVersion Get the current config label

get (response) reader->host configVersion Result of the get operation

Read Trigger OptionsMessage Direction Parameters/Group Purposeset host->reader readTriggerConfig Set the read triggerset (response) reader->host *readTriggerConfig Response to the above

get host->reader *readTriggerConfig Get the current read trigger

get (response) reader->host readTriggerConfig Result of the get operation


13/176

Quick Reference



Digital Input Configuration

Message Direction Parameters/Group Purposeset host->reader digitalInputConfig Set the digital input config

set (response) reader->host *digitalInputConfig Response to the above

get host->reader *digitalInputConfig Get the current settings of the digital input mask

get (response) reader->host digitalInputConfig Result of the get operation

get host->reader *digitalInputState Get the current state of the digital input

get (response) reader->host digitalInputState Result of the get operation

digitalInputEvent reader->host digitalInputInfo Notification of digital input change for masked lines.

Control MessagesMessage Direction Parameters/Group PurposeresetReader host->reader none To reset the reader

resetReader (response) reader->host none Response to the reset request

set host->reader readerMode Set reader mode

set (response) reader->host *readerMode Response to the set request

readTags host->reader none Initiates an APP_REQUEST

readTags (response) reader->host notifyCount Response to the set request

set host->reader ditigatOuputState Set the digital output

set (response) reader->host *digitalOutputState Response to the above

Tag Reading Modes Of OperationReader Mode Trigger Tag ReadingAUTONOMOUS CONTINUOUS Reader will send tagEventReports automatically to the host.

AUTONOMOUS DIGITAL_INPUT Reader will send tagEventReport automatically to the host when thedigital input enters the required state.

AUTONOMOUS APP_REQUEST The host will send an explicit command to indicate the occurrence of atrigger.


14/176

Quick Reference



Smart Reader Tag Inventory Management

Message Direction Parameters/Group PurposetagEventReport(notification)

reader->host tagEventReport Reader reporting of Tag Ids.

tagSelect host->reader tagSelectionRange A data range at a given starting address and/ormemory bank to narrow the tags responding to theselection commands.

tagSelect (response) reader->host none/error Response to the above

tagProgramId host->reader tagIdSpec Request to program id on a single tag

tagProgramId (response) reader->host none/error Response to the above

tagKill host->reader tagKillSpec Request to kill a tag

tagKill (response) reader->host none/error Response to the above request

Smart Reader Data Exchange CommandsMessage Direction Parameters/Group PurposetagDataRead host->reader tagReadSpec Request Tag Data for a given tag specification.

tagDataRead (response) reader->host tagData/error Response to the above request

tagDataWrite host->reader tagWriteSpec To write data for a given tag specification

tagDataWrite (response) reader->host none/error Response to the above request

tagLock host->reader tagLockSpec Request to lock certain tag fields

tagLock (response) reader->host none/error Response to above command

EPC Global Generation 1 Specific CommandsMessage Direction Parameters/Group PurposeEPC1Command host->reader EPC1mdSpec Send EPC1 specific command

EPC1Command(response)

reader ->host *EPC1CmdSpec Response

EPC Global Generation 2 Specific CommandsMessage Direction Parameters/Group PurposetagBlockErase host->reader tagBlockEraseSpec Send the EPC Gen 2 block erase command

tagBlockErase(response)

reader->host *tagBlockEraseSpec Response


15/176

Quick Reference



General Enquiries

Message Direction Parameters/Group Purposeget host->reader readerInfo Retrieve general information about the reader

get host->reader readerInfo Retrieve general information about the reader

set reader->host readerDesc Set reader Description

set (response) reader->host *readerDesc Response to the set request

Firmware UpdateMessage Direction Parameters/ Group PurposeupdateFirmwareReq host->reader none Host request to initiate a firmware update

processupdateFirmwareReq(response)

reader->host none Response from the reader

updateFirmware host->reader none The actual transfer of data. See the detailsbelow.

updateFirmware (response) reader->host none/error Response to the above.

flashFirmware host->reader flashBank Saving the image to FLASH

flashFirmware (response) reader->host *flashBank/error Response after saving the image to FLASH

setFirmware host->reader flashBank Set the reader to boot from flashBank

setFirmware (response) reader->host *flashBank/error Response after changing the boot vector

get host->reader *firmwareInfo Retrieve firmware info

get (response) reader->host firmwareInfo Response to the above


16/176

Quick Reference




17/176



Description 33.1 General Operation

The reader can be configured using standard configuration commands. These commandsset up things such as power level, radio frequency profile, antenna switching characteristics,air interface modulation and encoding schemes. These are required by both the regulatorystandards and by the tag air interface standards.

A Smart Reader design is one where no host is required in order to operate the reader; thisis the AUTONOMOUS mode. All Generation 2 Readers need some form of smartness as thetimings on the air interface are such that an external host cannot respond in time.

A Smart Reader operates with triggers and outputs events. The Smart Reader configurationcommands listed herein allow for triggering by a digital input change (or level) or by atriggering command from a host application. Only two events are defined at present, thechanging of a digital input level, and the detection of a tag.

In the AUTONOMOUS mode the Reader will handle collision arbitration automatically basedon its configured tag selection parameters.

NOTICEReader reboot may be necessaryWhen there are many tags inside the antenna field and the tag reading mode of operationis such that the reader mode is AUTONOMOUS and the trigger is set to CONTINUOUS

then the air interface of the reader will be under heavy load. In these cases it is prohibitedthat re-configurations or other commands are sent from the host to the reader.

Reader configurations and other commands shall only be sent from the host to the readerwhen either no tags are in the field or the reader does not operate in the continuous readermode.

It is required, that the tag event buffer (tag event report list) of the reader will be clearedprior to any further communication from the host to the reader (no further tag events will bedisplayed).

NoteStrictly synchronous operation of the readerThe host shall only send a command to a reader after the response of the previouscommand has been received.


18/176

Description

3.2 Note on the Ethernet Usage



3.2 Note on the Ethernet UsageThe Reader permits only one Ethernet TCP connection at one time. This puts some

restrictions on the over all system architecture as described below: When only Ethernet is to be used as both Control and Notifications channels, the same

TCP connection must be used (notify ChannelId = NONE).. This means the sameapplication must handle both the control and configuration tasks and the notificationsfrom the Reader.

If it is desired to use a dedicated Event Management Server, the control andconfiguration tasks will have to be performed over RS232.

When using XML commands, the user is advised to avoid overload of the reader. In order toavoid malfunction, new xml commands shall be sent to the reader after the response of thecommand before is received.


19/176



Messaging Overview 4

The Control Application running on the Configuration PC and the reader will implement asynchronous message/response method of communications. The Application will send amessage and wait for the reader to respond. If the reader is not able to comply with theinstruction in the message, it will send an error response. The error response must containthe reason for failure.

If a reader does not respond to a command within 5 seconds, this may be seen as a timeoutcondition. If such condition occurs, the Config Application may take appropriate action suchas warn the user of a potential mal-function in the Reader.

Some commands like firmware update and Ethernet configuration may take more than 5

seconds to complete.

In addition to the normal command/response type messages, this specification definesasynchronous notifications. These will always be sent by the reader and will not require anyacknowledgments from the host.

Certain aspects of the reader configuration are quite independent of each other. However werecommend the following order should be used when preparing a reader for the first timeoperation.

Reader profile is a legal requirement to use the correct profile for the country ofoperation

Antenna configuration includes the Power settings for each antennaChannel configuration this has a dependency on the Power settings which determine the

range of the channel IDs for this configuration item

Protocol configuration configures the reader to handle tags from the three supportedprotocols. This configuration aspect is dependent on the choice ofthe profile when it comes to the allowed reader to tagcommunications schemes. This is also a reasonable stage to setany filter options

Trigger configuration defines the trigger to start the tag reading process.Reader mode Having performed the above steps, the reader can be activated to

start the tag reading process (which depends on the choice oftrigger configuration)


20/176

Messaging Overview

4.1 Message Format



4.1 Message FormatThe Tag Reader Protocol is based on a XML format.

The messages can be divided into the following categories:

Set/Get configuration messages.These are to set/get the various configurable parameters on the Reader. Thespecification supports the concept of a parameter group to keep logically relatedparameters together resulting in safe transactions. This eliminates the possibility of partialconfiguration changes for operations that require setting up of multiple parameters.

Operational messages.These are instructions from the Host to the Reader to perform a certain function. Thesewill have descriptive names and may take one or more parameters depending on thecontext.

Notifications from the reader.

One way messages from the Reader to the Host containing tag events information. Alerts from the reader.

These messages indicate some warning or error condition in the Reader. Likenotifications, these are one way messages.

As mentioned earlier, the Configuration and Operational messages from the Host will beacknowledged by the Reader. The notifications and alerts are not acknowledged by theHost.

If writing your own interface to the RF660R, you should always allow for the possibility ofcorruption on the XML messages being sent by the reader.


21/176

Messaging Overview

4.2 General Format of Host Initiated Messages




4.2.1 Messages with no ParametersA typical message with no parameters will follow the following general format:

Format

message name

Here the type indicates whether the message is a command, response or notification. Thisattribute has not been added to the message element itself to keep the parsing of suchdocuments simple.

Example

resetReader


22/176

Messaging Overview




4.2.2 Messages with Multiple ParametersA typical message with multiple parameters will use a paramGroup element to group such

logically related parameters.

Format

message name

parameter 1 value

parameter n value

Example

hostGreetings

messagingVersion appVersion

ParamGroup With Additional AttributesIn some cases a 'paramGroup' may use an additional attribute to further clarify its context.For example the protocol configuration messages use the same 'paramGroup' name but usea type attribute to indicate the tag protocol type. For example:

set numReadCycles


23/176

Messaging Overview




4.2.3 Messages with a Single ParameterA typical message with a single parameter will follow the following format:

Format

message name parameter value

Example

set 0

4.2.4 Retrieving a Single Parameter from the ReaderWhen retrieving a parameter from the Reader, the Host can specify just the parametername. This is achieved by using an empty tag with the parameter or parameter group nameas an attribute.

A typical message to get the value of a single param will be:

Format

get

Example

get

The 'param.name' attribute value must match the name of a valid element as defined in thisspecification.


24/176

Messaging Overview




4.2.5 Retrieving a Set of Parameters from the ReaderTo retrieve a set of parameters, the message containing a get command may use the

following form:

Formatget

ExampleThe 'paramGroup' name value must be a valid name that the reader recognises, for

example:

get

Or (when extra context is required):

get


25/176

Messaging Overview

4.3 General Format of Reader Responses



4.3 General Format of Reader ResponsesThe reader replies will be of different kinds:

- normal responses or acknowledgements

- failure responses

- asynchronous notifications

- asynchronous alerts

4.3.1 Normal ResponsesSince the XML messaging specified in this specification is synchronous, the Host andReader will always complete a single message/response exchange before starting the next.

This makes it possible to keep the responses from the reader quite simple in that they donthave to duplicate various details of the original request. For most cases it would be sufficientfor the Reader to indicate just the request name and include an empty element to indicatethe input parameter or parameter group.

4.3.1.1 Responses without any Return Parameters

Format

request message name< param name="parameter name"- />

Example

set

Another example of a response to a set message with a parameter group would be:

set


26/176

Messaging Overview




4.3.1.2 Responses with a Single Return Parameter

Format

request message name parameter value

Example

get FCC

4.3.1.3 Responses with Multiple Return Parameters

Format

request message name

parameter 1 value

parameter n value

ExampleA 'paramGroup' element will be included in responses to get requests from the host thathad asked for a named 'paramGroup'. For example when the host asks for the currentEthernet configuration, the normal response from the reader will be:

get192.168.0.2541000110.10.10.1255.255.255.0


27/176

Messaging Overview




4.3.2 Error ResponsesWhen the reader is unable to perform the operation requested by the host, it will send an

error response. The general format of this is:

Format

request message name error code

ExampleThe reason must indicate why the reader failed to comply with the request.

set invalid power level value

4.3.3 NotificationsThe reader will use a regular message format to send notifications to the host. For example

tag event reports may use the following format:

ter w,x,y,z,AABBCCDDEEFF,nnnn

Here the type attribute is set to 'n' to indicate a notification; 'ter' stands for tag event report.


28/176

Messaging Overview

4.4 Backward Compatibility Issues



4.4 Backward Compatibility IssuesIn order to allow for trouble free operation between customer written applications for previous

RF660R firmware versions and the current firmware version, special care has to be takenwith respect to performance changes and required modifications to XML commands. In orderto allow old applications to run with the new firmware version backward compatibility has tobe met.

The following section summarizes all changes which have been introduced since firmwareversion V1.1 whilst maintaining the backward compatibility of the new firmware to customerapplications which have been written for the previous version.

Combinations of messaging versions/firmware versionsThe following table gives an overview of possible combinations of messaging version fromhost to reader and firmware versions of RF660R reader. No entries indicate a combination of

messaging version from a host which implies an error response from the Reader to the host.

Please refer to ChapterConnection Initiation from the Host (Page 37) .

XML Messaging VersionReader firmwareversion GR_XML_2.0 GR_XML_2.1 GR_XML_3.0

V1.1 X - -V1.2 Limited functionality X -V1.3 x1) x1) X

1) If you have a special customer application, this application may access firmware version V1.3, aslong as you don't use any commands, which are no longer allowed in firmware version V1.3. If, for

example, the customer application is sending the specific channel 105, this command will berejected with an error message, because only channels of the Four-Channel Plan are still allowedwith firmware version V1.3.


29/176

Messaging Overview




4.4.1 Overview of XML Changes with Firmware Version V1.3This section captures changes to the XML communication with the RF660R Reader as a

result of firmware revision upgrades. These changes are described throughout the sectionsof this document, but are gathered together here to give an overview of the main featurechanges of this firmware revision from version V1.2 to version V1.3.

4.4.1.1 HostGreetings Message (Host -> Reader)To connect to the RF660R firmware version V1.3, GR_XML_3.0 should be the defaultmessaging version. The Reader will repsond with firmware Version V1.3(01.03.00.00_01.xx).

NoteExceptionIf you have a special customer application (using GR_XML_2.0 or GR_XML_2.1), thisapplication may access firmware version V1.3, as long as you don't use any commands,which are not allowed in firmware version V1.3.

4.4.1.2 Notification ChannelWhen setting the notification channel with Firmware Version 1.3, messaging versionGR_XML_3.0 should be the default messaging version.

NoteExceptionIf you have a special customer application (using GR_XML_2.0 or GR_XML_2.1), thisapplication may access firmware version V1.3, as long as you don't use any commands,which are not allowed in firmware version V1.3.

4.4.1.3 ETSI Frequency Switching SettingsWhen setting "channelConfig" of type "ETSI" with Firmware Version V1.3 only the followingparameters will be allowed:

channelList: Only one and up to four channels of channel IDs 103, 106, 109, 112 may beselected

lbtState: Listen before talking must be OFF

readerProfile: No ETSI_SRD may be selected

4.4.1.4 Error Code Changes for Firmware Version V1.3Since RF660R Firmware Version V1.3 no new error codes have been added.


30/176

Messaging Overview




4.4.2 Overview of XML Changes with Firmware Version V1.2This section captures changes to the XML communication with the RF660R reader as a

result of firmware revision upgrades. These changes are described throughout the sectionsof this document, but are gathered together here to give an overview of the main featureenhancements of this firmware revision from version V1.1 to V1.2.

As a result of the backward compatibility work, if the Host in the hostGreeting messagesends the firmware version V1.1 messagingVersion (GR_XML_2.0) then a V1.2 reader willrespond in a manner compatible with the V1.1 XML format.

Specifically, where the changes in behavior indicated below entail a response not compatiblewith firmware version V1.1, this functionality is inhibited when communicating with a V1.1Host. Where the notification channel is separate from the configuration channel, the formatmay be optionally controlled by a parameter in the set notifyChannel command (as describedin Section Setting the Notification Channel (Page 52)).

4.4.2.1 tagIdTypeFor EPC Global Gen 2, the "tagIdType" field is now ignored, and inferred from the number ofcharacters in the "tagId" field (which must be a multiple of 4).

4.4.2.2 tagIDThe "tagId" field may be omitted, indicating that the reader should perform the operation onthe first tag which responds.

4.4.2.3 tagProgramIDFor "tagProgramId", if "currTagId" is omitted the reader also checks to ensure that the tagoperated on is the only one in the field.

4.4.2.4 tagDataWriteThe "tagDataWrite" command can (optionally) take a field xxxxxxxx. Thismust be of the same length as the data field and is used for specifying which bits to set/clear.

The write command does not act on the fields "EPC2Mode" (WRITE/BLOCK_WRITE) and"verifyOn". Whilst it is intended ultimately to take account of these fields, currently it verifiesall writes (using the "assured_write" function) and uses write rather than blockwrite.

4.4.2.5 TerThe "ter" (tag event report) messages from the reader now report tags of all lengths. Tags of96 or 64 bits will be reported with "tagIdTypes" as before, but tags of other lengths will bereported with "tagIdType" 6. No alerts are sent in the event of encountering a blank tag (as itwill be reported ordinarily.)


31/176

Messaging Overview




4.4.2.6 hostGreetingsIf "hostGreetings" fails because the supplied "messagingVersion" is invalid, the returned

error now includes a field indicating which messaging version(s) would have been accepted.At firmware version V1.2 the valid "messagingVersions" are GR_XML_2.0 and GR_XML_2.1.This version (v1.22) of the Config Application passes this information on to the user.Obviously this functionality is not available with earlier versions of the Config Application, asthe presence of this new field in the returned error is simply ignored.

4.4.2.7 channelConfig - CHINA Frequency Settings

Format

set

ON | OFF

channelList

switchingInterval

When the "channelConfig" is set to the CHINA profile

"channelList" must be in the range 150 to 169. The list may only include the channelsdepending on the power level settings in the previous step (See 'antennaConfig').

"switchingInterval" must be in the range 100 to 2000. This is the minimum time interval inmilliseconds before switching to the next frequency.

For China, the recommended values are frequency switching on (fhState=ON), using the 16centre channels (channelList=152,153,154,155, to 167), with a switching interval of 1 second(switchingInterval=1000). The minimum China switching interval is 100 ms and the maximum2000 ms. This message uses the type attribute in the "paramGroup" to indicate thefrequency protocol, i.e. CHINA.


32/176

Messaging Overview




4.4.2.8 SetReaderProfile CHINA SettingsThe reader may be set to the CHINA profile with the set message:

Message

set

ETSI | ETSI_SRD | FCC | CHINA

NoteWith firmware version V1.3 ETSI_SRD radio profile is not longer available.

4.4.2.9 GetReaderProfile CHINA SettingsIf the CHINA profile is active when a "get" message is issued, the reader will reply with thefollowing message:

Message

get

ETSI | ETSI_SRD | FCC | CHINA

NoteWith firmware version V1.3 ETSI_SRD radio profile is not longer available.

4.4.2.10 Get ETSI ChannelConfigThe ETSI "ChannelConfig" now includes an "lbtState" parameter, indicating whether

LBT(Listen Before Talk) is to be used.

4.4.2.11 setNotifyChannelThe "notifyChannel" config now optionally includes a "messagingVersion" parameter, whichmay be used to override the default behavior, which is to set the notification channel formatto be the same as the format used by the Host when configuring the notify channel. Seesection Setting the Notification Channel (Page 52) .


33/176

Messaging Overview




4.4.2.12 EPC GEN 2 tagSelectionRangeSince firmware version V1.2, the usage of the SL target has been disallowed, as part of a

bug fix. The valid targets are S0, S1, S2 and S3.

4.4.2.13 resetConfigThe reader now supports a "resetConfig" command, which will reset the reader settings totheir factory defaults. See section Resetting Configuration to Factory Settings (Page 72) fordetails on this.

Also, the reader now automatically detects any invalid configuration when the config isloaded from flash at boot time. If any bad or corrupted config is found, the reader config isreset to the factory settings. When a Host subsequently connects, the alert message 10005is sent to inform the user of this.

4.4.2.14 Error Code Changes for firmware version V1.2Since RF660R firmware version V1.2 a number of error codes have been added. In SectionError Codes From The Reader(Page 155) a comprehensive list has been added to theprevious error codes.


34/176

Messaging Overview





35/176



Connection Set Up Procedure and Messages 5

These messages will be used to set up a reliable connection between the host and thereader.

The following table lists the messages used in this procedure. Empty elements that arepassed in get requests or set responses are prefixed with a *.

Table 5- 1 Connection Establishment and status messages

Message Direction Parameters/Group PurposehostGreetings Host->Reader hostGreetings Connection initiation from the Host

hostGreetings(response)

Reader->Host readerGreetings/error

Response from the Reader

heartbeat Host->Reader none Heartbeat exchange initiated fromthe host

heartbeat (response) Reader->Host none Heartbeat response from the reader

hostGoodbye Host->Reader none Goodbye message from the host

hostGoodbye(response)

Reader ->Host none Response to the above

set Host->Reader clockTime To set the RTC on the reader

set (response) Reader->Host *clockTime Response from the reader

get Host->Reader *clockTime Get real time of the reader

get (response) Reader->Host clockTime Response from the reader

The format of these messages and the expected responses is described here.

NoteThis procedure expects a physical connection (either Serial Port or Ethernet) between theHost and Reader to exist.

NoteClearing the reader bufferWhen the reader has been running in the continuous tag reading mode the buffer may befilled up with tag events.

Establishing or re-establishing the connection between host and reader initiates the reader tosend its tag events to its host. This process of the reader to empty its buffer will take,depending on the data rate and the number of accumulated tag events, up to a couple ofminutes.


36/176

Connection Set Up Procedure and Messages



Connection Establishment ProcedureA sequence diagram illustrates a successful Connection Establishment procedure is given

below:

Step Description1 Host sends hostGreetings message to the

Reader

2 The Reader will respond with a normal responseand send some information about itself

3 After the connection has been established, theHost initiates the heartbeat at regular intervals

Sequence diagram

4 The Reader will respond to the message bysending the heartbeat message back


37/176


5.1 Connection Initiation from the Host



5.1 Connection Initiation from the HostThe Host sends the following message to the Reader to initiate a Communication session:

HostGreetings Message (Host -> Reader)

hostGreetings

GR_XML_2.0 | GR_XML_2.1 | GR_XML_3.0 Name of your application

Parameter Type Value or Value Range Dependencies / NotesGR_XML_2.0,

GR_XML_2.1

Firmware Version V 1.2 or earlier versions:

The message contains the version of the interface messages

which shall be set to "GR_XML_2.0" for applications which have

been written for firmware version V 1.1 and which shall be set to

"GR_XML_2.1" for applications which already include additional

features as introduced with firmware version V1.2. If the Reader

firmware is expecting a different version which is not compatible

with this version then the Reader may respond with an error

response, which may include a list of "messagingVersion" strings

which the reader would have accepted.

This is to avoid issues that may arise due to messaging versions

mismatch between the Host and the Reader.

Firmware Version V 1.3:

Exception: If you have a special customer application (usingGR_XML_V2.0 or GR_XML_2.1), this application may access

firmware version V1.3, as long as you don't use any commands,

which are no longer allowed in firmware version V1.3.

messagingVersion String

GR_XML_3.0 Firmware Version V 1.3:

When connecting to the RF660R Reader with Firmware Version V

1.3 it is recommended to use GR_XML_3.0, to use the full

functionality of the new firmware.

This is to avoid issues that may arise due to radio standard

changes for ETSI since EN 302208 V1.2.1 has become mandatory

from 01.01.2010 onwards.

appVersion String e.g.

"MyApplication"

This element is to identify the Host application connected to the

Reader.

The format of the messages in the notification channel, if separate, is determined by the"messagingVersion" parameter in the set "notifyChannel" message sent when thenotification channel is configured (which if not specified defaults to the "messagingVersion"declared by the Host).

The messagingVersion field is very important. The RF660R Configuration Software will onlyoperate with RF660R Reader Software of the same messagingVersion. If a newmessagingVersion is issued, it will be issued with new versions of the RF660R ConfigurationSoftware and of the RF600R Reader Software.

In order to check the compatibility of messaging version and firmware version, please referto chapterBackward Compatibility Issues (Page 28) .


38/176





Response from the ReaderThe reader will respond with the following normal response and send some useful

information about itself:hostGreetings

SIMATIC RF660R Portal Reader firmwareVersion fpgaVersion USER | DEFAULT

Parameter Type Value or Value Range Dependencies / NotesreaderName String - Fixed parameter value.

firmwareVersion String e.g. V1.3(01.03.00.00_04.14) Shows the reader firmware version which is active onthe current reader.

fpgaVersion String e.g. V0.44.2 FPGA version of the reader.

USER Any reader setting has been changed by the usercompared with the default factory settings.

configVersion String Literals

DEFAULT Default factory settings from within reader firmware areused.

NoteDuring the Reader Connect or Reader Disconnect procedure the reader may sendmalformed messages. Users are therefore advised to allow the reader to be connected'stable' prior to sending commands.


39/176





Error ResponsesIf for some reason the reader is unable to offer its service, it will send an error response:

< message >hostGreetings error code

The reason could be one of the following: Already connected to another Host application (e.g. when controlled by SIMATIC)

Authentication failure (for future use)

Hardware/software issues (e.g. firmware load issues)

Host messaging version not supported

NoteFrom V1.2 firmware revision onwards, if hostGreetings fails because the messagingversion is invalid, the returned error includes a field indicating which messagingversion(s) would have been accepted. From revision V1.2 (and later revisions) of theRF660R Configuration Software onwards the application passes this information on to theuser. Obviously this functionality is not available with earlier versions of the RF660RConfiguration Software, as the presence of this new field in the returned error is simplyignored.

NoteFor the unlikely event of users addressing the reader via SIMATIC RF660R ConfigurationSoftware and via XML interface during the same configuration session, users are

informed that the parameters displayed by the Configuration Software are those whichwere present at the time of connecting the reader to the host. If in the meantimeparameters have been changed using XML interface, the new values (changedparameters) are NOT displayed by the Configuration Software screens.


40/176


5.3 Heart Beat Mechanism



5.3 Heart Beat MechanismThe Heart beat Mechanism is optional and a client application should implement it in order to

keep an eye on the status of the connection. For client applications that want to implement it,it is recommended to send one such message at least once a minute. This way the readercan also stay aware of the presence of the client application.

After the connection has been established, the Host may initiate the heartbeats at regularintervals. The Config Application will be responsible for choosing a suitable interval. Note, asuccessful message/response exchange with the Reader may be seen as an implicitheartbeat and the Config Application may adjust the timing of the heartbeats during frequentmessage exchanges.

InstructionThe format of the message will be:

heartbeat

Normal ResponseThe reader will respond to the message by sending the heartbeat message back.

heartbeat


41/176


5.3 Heart Beat Mechanism



ExampleThe following diagram provides an overview of how two separate processes within an

application could be managed including the heartbeat mechanism.


42/176


5.4 Real Time Clock



5.4 Real Time Clock

5.4.1 Setting the Real Time ClockTo set the real time clock on the Reader, the Host may send the following message:

set clockTime

Parameter Type Value or Value Range Dependencies / NotesclockTime ASCII Timestamp e.g.

2005-07-16T19:20:30.456+00:00

The Timestamp format is:

YYYY-MM-DDThh:mm:ss.s+00:00

There are different standard ways to format timestamps. According to ISO 8601, atimestamp value should be formatted as:

YYYY -MM-DDThh:mm:ss.sTZD

where:

Parameter DescriptionYYYY four-digit year

MM two-digit month (01=January, etc.)

DD two-digit day of month (01 through 31)

hh two digits of hour (00 through 23) (am/pm NOT allowed)

mm two digits of minute (00 through 59)

ss two digits of second (00 through 59)

s one or more digits representing a decimal fraction of a second

TZD time zone designator (Z or +hh:mm or -hh:mm)

Example:

2006-04-01T12:23:05.81+01:00

NoteThe reader will follow the ISO 8601 format but will not use the TZD field. After a Powercyclethe clock will start from 2000-01-01T00:00:00.000+00:00. Remember also that the real timeclock is yet not used for timestamping any messages sent by the reader.


43/176


5.4 Real Time Clock



Example

set 2006-08-09T15:23:05.81+00:00

The components shown here must be present with exactly this punctuation. Note that the "T"appears literally in the string, to indicate the beginning of the time element.

The Reader will respond with a normal response:

Normal Response

set

Error ResponseAn error response is not defined for this operation.


44/176


5.4 Real Time Clock



5.4.2 Retrieve Current Clock TimeTo retrieve the current "clockTime", the Host will use the following message:

Message

get

The reader will use the following response:

Normal Response

get 2006-03-03T15:06:11.000+00:00

Parameter Type Value or Value Range Dependencies / NotesclockTime ASCII

Timestampe.g.2005-07-16T19:20:30.456+00:00

The Timestamp format is:YYYY-MM-DDThh:mm:ss.s+00:00

Error ResponseAn error response is not defined for this operation.


45/176


5.5 Goodbye Message from the Host



5.5 Goodbye Message from the HostTo indicate the end of a Communication session, the Config Application should send the

following message as a log out indication.

Message

hostGoodbye

Normal ResponseThe reader will response with a normal response using the general format.

Error ResponseAn error response is not defined.

5.6 Notes on the Control Channel ConnectionA Single Config Application to control the Reader

The Reader permits only a single Config Application to connect over the Control Channel at

one time. If a second application attempts to connect, the Reader will reject that connectionrequest.

For Serial Port based connections, this restriction is likely to be forced by the operatingsystem on the Host itself which may report the serial port being busy when a second ConfigApplication tries to connect to the Reader. For Ethernet, the Reader may refuse theconnection attempt at the TCP/IP socket connection level or send an explicit connectionrejection response.

The use of a single connection raises the question of dealing with the cases where the hostapplication may have crashed without releasing the connection (or sending the hostGoodbye

message). To prevent the Reader from getting stuck with a stale connection, the Readerwill make a decision about the state of the connection based on the absence of controlcommands (and heartbeats). If the Reader doesnt see any control commands or heartbeatsfor more than 2 minutes, it will go into a state where it will accept a new connection requestand (only then) close the old connection.

Physical link failuresIn the event of a broken communications link, the Host may attempt to re-establish theconnection by sending the hostGreetings message at regular intervals. The time betweenthese attempts should be greater than 2 minutes which is the amount of time that the Readerwaits for before dissolving an existing connection and allowing a new connection.


46/176


5.6 Notes on the Control Channel Connection




47/176



Service Provisioning Messages 6

The table lists initial service provisioning messages. Empty elements that are passed in getrequests or set responses are prefixed with a *.

Table 6- 1 Service Provisioning Messages

Message Direction Parameters/Group Purposeset Host->Reader ethernetConfig Static ethernet configuration of the Reader

set (response) Reader->Host *ethernetConfig Response to the above

get Host->Reader *ethernetConfig To retrieve current Ethernet configuration

get (response) Reader->Host ethernetConfig Result of the above.

setupEthernetDHCP Host->Reader none Request to set up Ethernet using the DHCP procedure.

setupEthernetDHCP(response)

Reader->Host none Ack to the above request.

set Host->Reader notifyChannel configuration of the notification channel for tag events

set (response) Reader->Host *notifyChannel Successful response

get Host->Reader *notifyChannel Get configuration of the notification channel

get (response) Reader->Host notifyChannel/ error Successful response

6.1 Serial Port ConfigurationHost and Reader should use the following serial port parametersBaud Rate: 115200 bps

Data bits: 8

Stop bits: 1

Parity: None

Flow Control: Xon/Xoff

Xon/XoffXon/Xoff is a protocol for controlling the flow of data between computers and other deviceson an asynchronous serial connection.


48/176

Service Provisioning Messages

6.2 Ethernet Configuration



6.2 Ethernet ConfigurationTo set up the Ethernet configuration on the reader, the host application will send the

following message to the reader:

Setting

set

ipAddress portNumber gatewayAddress subnetMask

Parameter Type Value or Value RangeipAddress Dotted String e.g. 192.168.0.254

portNumber Integer 10000 - 65535

gatewayAddress Dotted String e.g. 192.118.194.1

subnetMask Dotted String e.g. 255.255.255.0

This procedure may take up to 30 seconds to complete. This should be kept in mind whenusing a timeout value when waiting for the response. The 'ethernetConfig' needs not to besaved with 'saveConfig' to FLASH.

NoteWhen utilizing the Ethernet configuration for more than one Reader and/or using theEthernet notification channel for a reader, a separate "portNumber" has to be chosen foreach connection configuration, i.e., when a "portNumber" is no longer in use it may be re-used.

The reader will respond with the following normal response:

Normal Response

set


49/176


6.2 Ethernet Configuration



6.2.1 Retrieve Current Ethernet ConnectionTo retrieve the current Ethernet configuration, the Host will use the following message:

Instruction

get

Normal ResponseThe reader will use the following response:

get ipAddress portNumber gatewayAddress subnetMask

macAddress

The reader will use the following response:

Parameter Type Value or Value RangeipAddress Dotted String e.g. 192.168.0.254

portNumber Integer 10000 - 65535

gatewayAddress Dotted String e.g. 192.118.194.1

subnetMask Dotted String e.g. 255.255.255.0

macAddress Hyphenated Hex String e.g. 00-20-4A-86-75-57

Error ResponseAn error response is not defined for the get operation in this case as the Reader is expectedto have a default set of these parameters.


50/176


6.3 DHCP Based Ethernet Setup




6.3.1 Setup Ethernet DHCPThe RF660R will work best in a DHCP environment where a list of Static IP addresses areassigned by a DHCP server. Users should create a list of static IP addresses and relatethese to the MAC address of the readers to be installed and used.

InstructionSince DHCP based Ethernet set up is a special procedure, the workstation will send anexplicit command to the reader:

setupEthernetDHCP

Normal Response

setupEthernetDHCP

NoteThe DHCP mode of operation is intended for making the Ethernet configuration process

automated. The Ethernet device on the Reader will try to contact a DHCP server to get anaddress. If it cannot find one, it will use the BOOTP protocol and if that doesn't work, it willuse AUTO-IP to assign itself an IP-address. Due to the automated nature of this procedure,the Ethernet device doesn't reveal the assigned IP-address, gateway address and subnetmask values to the Reader. Performing a 'get' on Ethernet configuration after a DHCP set upwill result in the following response from the reader:

When the Host and Reader are connected over the Configuration Interface RS232, theReader will send the response after completing the DHCP procedure.When the Host and Reader are connected over the System Interface (Ethernet), the Reader

will send the response before starting the DHCP procedure because the Reader will have todrop the existing Ethernet connection once it has been assigned a new IP-address. The Hostwill need to need to perform a network scan to discover the new address details of theReader.

Retrieve Current SetupAfter a DHCP based set up, retrieving address details by performing a get message willproduce a response in the following format:


51/176





Setting

getDHCP portNumberDHCPDHCP macAddress

Parameter Type Value or Value RangeipAddress String DHCP

portNumber Integer 10000 - 65535gatewayAddress String DHCP

subnetMask String DHCP

macAddress Hyphenated Hex String e.g. 00-20-4A-86-75-57

The Host may make use of the macAddress value following a port scan procedure todiscover the actual IP-address of the Reader.


52/176


6.4 Notification Channel



6.4 Notification ChannelThe host will send this message to the reader to set the address details of the channel that

the reader will use to send tag events and other notifications.

6.4.1 Setting the Notification ChannelSetting

set NONE | RS232 | ETHERNET ipAddress portNumber GR_XML_2.0 | GR_XML_2.1 | GR_XML_3.0

NoteOptional use of messagingVersion parameterThe "messagingVersion" parameter is optional, and new in Release 3. It indicates themessaging version with which the messages in the notification channel (when distinct fromthe configuration channel) should be compatible. As the value for this parameter when notspecified defaults to the "messagingVersion" declared by the Host in the hostGreetings

message, this parameter is only needed if different "messagingVersions" are to be used onthe configuration and notification channels.


53/176





Parameter Type Value or ValueRange Dependencies / NotesNONE (default) When the notification channel is set to NONE, the Reader will

send the notifications e.g. tag report events on the existingControl Channel itself (whether RS232 or Ethernet).Therefore, the Config Application should expect to handlethese notifications as asynchronous events.

RS232 Setting the notification channel to RS232 will cause the readerto send all notifications e.g. tag event reports over the serialport. The configuration and control messages must be sendover Ethernet to the reader.

notifyChannelId String Literals

ETHERNET When connected over Ethernet the Notification Channelshould not be set to ETHERNET as this violates the singleEthernet connection limitation described in chapter Fehler!Verweisquelle konnte nicht gefunden werden..

To output notifications on Ethernet either connect via RS232and set notifications up as Ethernet, or connect over Ethernetand set the Notification Channel to NONE.

ipAddress Dotted String e.g. 192.168.0.10 only applicable ifnotifyChannelId = ETHERNET

This IP address assigns the Host to which the reader will sendthe notifications. This is NOT the address of the reader.

portNumber Integer 10000 - 65535 only applicable ifnotifyChannelId = ETHERNET

This parameter assigns the port of the Host to which thereader will send the notifications.

messagingVersion String Literals GR_XML_2.0 |

GR_XML_2.1 |GR_XML_3.0

The "messagingVersion" field within the "notiyChannel"

command is optional: if it is omitted, the parameter will defaultto the "messagingVersion" declared by the Host in thehostGreetings message. This feature is new since Release 3(FW V 1.2).

NoteWhen utilizing the Ethernet configuration for more than one Reader and/or using theEthernet notification channel for a reader a separate "portNumber" has to be chosen foreach connection configuration, i.e., when a "portNumber" is no longer in use it may be re-used.

The response for this message may take up to 30 seconds if the notify channel is configuredto use Ethernet. For other cases it should be within the normal 5 sec duration. By default the'notifyChannelId' will be NONE, which is also the recommended setting.The reader will send the following response:

Normal Response set


54/176





6.4.2 Retrieve Notification Channel DetailsTo retrieve the notification channel details, the host may send this message:

Request

get

Normal ResponseThe normal response from the reader will be:

getnotifyChannelId> NONE | RS232 | ETHERNET

ipAddress portNumber GR_XML_2.0 | GR_XML_2.1 | GR_XML_3.0

Parameter Type Value or Value Range Dependencies / NotesNONE When the notification channel is set to NONE, the Reader

will send the notifications e.g. tag report events on theexisting Control Channel itself (whether RS232 orEthernet). Therefore, the Config Application should expectto handle these notifications as asynchronous events.

RS232 The configuration and control messages must be sent overEthernet to the reader.

notifyChannelId String

Literals

ET

Simatic Rf660r en en-us

Documents

Transcript of Simatic Rf660r en en-us