Siemens SIMATIC RF310M Function Manual
  1. Manuals
  2. Brands
  3. Siemens Manuals
  4. Rfid Systems
  5. SIMATIC RF310M
  6. Function manual

Siemens SIMATIC RF310M Function Manual

Mobile readers
Hide thumbs Also See for SIMATIC RF310M:
Table of Contents

Advertisement

Quick Links

Download this manual
RFID SYSTEMS
Mobile Readers
Function Manual · 12/2010
Valid for the following products:
SIMATIC RF310M
SIMATIC RF610M
SIMATIC RF680M
SIMATIC Ident
Answers for industry.

Advertisement

Table of Contents
loading

Related Manuals for Siemens SIMATIC RF310M

Summary of Contents for Siemens SIMATIC RF310M

  • Page 1 RFID SYSTEMS Mobile Readers Function Manual · 12/2010 Valid for the following products: SIMATIC RF310M SIMATIC RF610M SIMATIC RF680M SIMATIC Ident Answers for industry.
  • Page 3 Introduction RFID Reader Interface User's Guide RFID Reader Interface Reference SIMATIC Ident RFID Systems Mobile Readers Function Manual Valid for the following products: SIMATIC RF310M SIMATIC RF610M SIMATIC RF680M 12/2010 J31069-D0198-U001-A2-7618...
  • Page 4 Note the following: WARNING Siemens products may only be used for the applications described in the catalog and in the relevant technical documentation. If products and components from other manufacturers are used, these must be recommended or approved by Siemens. Proper transport, storage, installation, assembly, commissioning, operation and maintenance are required to ensure that the products operate safely and without any problems.

  • Page 5: Table Of Contents

    Table of contents Introduction..............................7 RFID Reader Interface User's Guide ......................9 RFID Reader Interface........................9 How Do I Use the Reader Interface?...................10 2.2.1 Tools Needed..........................10 2.2.2 Creating the Application.......................11 2.2.3 Starting the RFID reader......................12 2.2.4 Compile and Run .........................15 2.2.5 I Want To See Tags…...
  • Page 6 Table of contents 3.4.17 GetTagStatus ..........................58 3.4.18 InitTagMemory ..........................60 3.4.19 KillTag ............................61 3.4.20 LockEPCGen2Tag ........................62 3.4.21 LockIsoTag..........................65 3.4.22 SetTrigger............................ 66 3.4.23 SubscribeForNotifications ......................67 3.4.24 UnsubscribeForNotifications ....................... 68 3.4.25 SetTagEvents..........................69 3.4.26 SubscribeForAlarms........................70 3.4.27 UnsubscribeForAlarms........................

  • Page 7: Introduction

    Introduction This document describes the RFID Reader Interface for the SIMATIC handheld systems RF680M, RF610M and RF310M and how this interface can be utilized. The document consists of two parts. The first part gives you an overview of how the RFID Reader Interface can be used and the second part contains a detailed reference description of the RFID Reader Interface.
  • Page 8 Introduction Mobile Readers Function Manual, 12/2010, J31069-D0198-U001-A2-7618...

  • Page 9: Rfid Reader Interface User's Guide

    RFID Reader Interface User's Guide RFID Reader Interface Simatic Handheld devices enable end users to acquire tag data from any place without the limitations of a cable-bound system. It provides the hardware as well as a software application to use the features of the mobile reader. Figure 2-1 Software system structure on a SIMATIC Handheld device.

  • Page 10: How Do I Use The Reader Interface

    Moreover, in order to utilize the RFID features you will also need to reference the RFID Reader Interface assembly within your applications. This assembly is available on your handheld device. You can retrieve the file Siemens.Simatic.RfReaderApi.dll via ActiveSync from the handheld device (\Flash Disk\SIMATIC xxx\Support\RFID_AP\RFID_API.ZIP) and store it to reference the assembly.

  • Page 11: Creating The Application

    RFID Reader Interface User's Guide 2.2 How Do I Use the Reader Interface? 2.2.2 Creating the Application To start a new application for a handheld device, create a new project of type 'Visual C#\Smart Device\Windows CE 5.0\DeviceApplication' since handheld devices currently run under Windows CE 5.0.

  • Page 12: Starting The Rfid Reader

    To simplify development, first add a reference to the RFID Reader Interface assembly and a directive for the namespace Siemens.Simatic.RfReader which enables you to use 'intelli- sense' on the types provided by the RFID Reader Interface. Figure 2-4 Adding a reference to the reader interface: Go to where you filed the interface assembly which you retrieved from the handheld device.
  • Page 13 RFID Reader Interface User's Guide 2.2 How Do I Use the Reader Interface? Another look at our code shows that only four lines of code are needed to start up the reader service. The code for starting the RFID Reader Interface: private void menuReaderStart_Click(object sender, EventArgs e) // We want to create and start an instance of the RFID // reader interface for a handheld device with a default name.
  • Page 14 RFID Reader Interface User's Guide 2.2 How Do I Use the Reader Interface? A last issue we have to consider is that the RFID reader service needs time to initialize his internal states. The good news is that after initialization the reader service will use its Alarm event mechanism to notify clients when it is ready to start work.

  • Page 15: Compile And Run

    RFID Reader Interface User's Guide 2.2 How Do I Use the Reader Interface? 2.2.4 Compile and Run Even if tags cannot be read yet, you can create an application to prove that it can at least start up and shut down. You can improve the visual appearance by indicating the status of the functions which you called in the results window of your application;...
  • Page 16 = this. textBoxInfo.Text + message; this. textBoxInfo.SelectionStart = this. textBoxInfo.Text.Length; this. textBoxInfo.ScrollToCaret(); Compilation should be successful unless you forgot to add the reference to the interface assembly and the corresponding directive using Siemens.Simatic.RfReader. Mobile Readers Function Manual, 12/2010, J31069-D0198-U001-A2-7618...
  • Page 17 ● Regardless of how you deploy your application, ensure that all needed system components are located beneath your application. This means you must provide the RFID Reader Interface assembly  Siemens.Simatic.RfReaderApi.dll and its configuration file Siemens.Simatic.RfReaderApi.dll.config. You also must provide the following Psion-specific files ...

  • Page 18: I Want To See Tags

    RFID Reader Interface User's Guide 2.2 How Do I Use the Reader Interface? 2.2.5 I Want To See Tags… You are able to start and stop the RFID reader service and would now like to see tags. Another look at the RfReaderApi interface reveals a member called GetTagIDs. Checking the return value’s type indicates that you will receive an array of strings containing the read tag IDs.

  • Page 19: Know More About The Tags

    RFID Reader Interface User's Guide 2.2 How Do I Use the Reader Interface? 2.2.6 Know More about the Tags … You can learn more about tags in the same way that you can access additional data on tags or write data to tags. Some additional data must be specified.

  • Page 20: Change The Tags' Data

    RFID Reader Interface User's Guide 2.2 How Do I Use the Reader Interface? 2.2.7 Change the Tags' Data When the data on a tag must be changed, the same restriction applies on EPC Gen2 tags as with obtaining additional data. The EPC Gen2 tag that you want to change must be specified by supplying its ID.

  • Page 21: Summary

    Summary Using the RFID Reader Interface is easy if you keep the few important points below in mind. ● Be sure to reference the Siemens.Simatic.RfReaderApi.dll assembly, use its namespace and place the assembly beneath your application on the target device.

  • Page 22: Extending The Reach

    RFID Reader Interface User's Guide 2.3 Extending the Reach Extending the Reach 2.3.1 Being Part of a Larger Family The last chapter discussed using the handheld RFID reader interface in a standalone scenario. However, even RFID reader are not always alone in this world but have to interact –...
  • Page 23 RFID Reader Interface User's Guide 2.3 Extending the Reach Now, Jerry – the guy working at the warehouse – wants to check if all the goods having been unloaded at the gate are still within the package now stored in aisle three of the warehouse. So he takes his RFxxxM device with him, walks up to the package in aisle three and scans the package again just for monitoring purposes.

  • Page 24: Entering The System

    RFID Reader Interface User's Guide 2.3 Extending the Reach 2.3.2 Entering the system How do we achieve to be part of a larger system with an RFxxxM? The good news is that starting with RF-MANAGER 2008 the RFxxxM can be configured within a project as just another reader.

  • Page 25: Wake Me Up Before You Go

    RFID Reader Interface User's Guide 2.3 Extending the Reach 2.3.3 Wake me up before you go… So far, so good – we will wait until the configuration has been finished. But how do we know it has finished? Luckily the RFID reader interface provides a notification mechanism which enables us as a client of the API to know what is going on.
  • Page 26 RFID Reader Interface User's Guide 2.3 Extending the Reach Nevertheless, this means, we can always rely on getting an event during startup – no matter what. Great, we now know when we are started. Normally, you start an underlying reader service during startup of your client via StartReader() and you stop it again during shutdown of your client with the StopReader() function of the RFID reader interface causing the reader service to terminate as well.
  • Page 27 RFID Reader Interface User's Guide 2.3 Extending the Reach On a connected host PC we start a RF-MANAGER runtime with an RFxxxM device configured as follows. Notice that the reader type and the application mode have to be set accordingly. Figure 2-9 RF610M Properties As a side node, please bear in mind to set the network address for your runtime under...
  • Page 28 RFID Reader Interface User's Guide 2.3 Extending the Reach Here is a skeleton alarm handler body that shows the different events: public void AlarmHandler(object sender, RfAlarmArgs alarmArgs) if (alarmArgs.IsConfigStart) // Reconfiguration has started // => disable UI else if (alarmArgs.InfoItems != null) // Reconfiguration has finished if (alarmArgs.InfoItems[0].Name == "Reconfiguration"...

  • Page 29: We Are Started: What To Make Out Of It

    RFID Reader Interface User's Guide 2.3 Extending the Reach 2.3.4 We are started: What to make out of it? Now the system is up and running and with the reconfiguration end event we got a list of changed configuration items. You missed them? No problem, because there is another possibility to query the configuration items.

  • Page 30: Jerry's Tag Monitoring Scenario Revisited

    RFID Reader Interface User's Guide 2.3 Extending the Reach Configuration Parameter Name Possible Values / Description Scan Key Top Information about the scan key button on top of the device Application Information about the virtual software trigger Checking the parameter values from our default RF-MANAGER configuration, we find the following setup: We are running in RF-MANAGER mode and we are only allowed to monitor tags but not to change them.

  • Page 31: I'm All Ears

    RFID Reader Interface User's Guide 2.3 Extending the Reach 2.3.6 I’m all ears Scanning the RFID reader interface members, the most promising one for our purpose is the TagEventNotifications event. We add a handler to this event when starting the reader private void menuReaderStartRfm_Click(object sender, EventArgs e) RfReaderApi.Current.TagEventNotifications += RfNotificationHandler(rfmIntegration.NotificationHandler);...
  • Page 32 RFID Reader Interface User's Guide 2.3 Extending the Reach OK, we know for sure, we need the data, so we add a subscribe menu item and as we are add it an unsubscribe item as well. private void menuItemSubscribeMonitor_Click( object sender, EventArgs e) // Subscribe is only valid if we run in RF-MANAGER mode if (this.fRfmIntegrated) // It does not make sense to subscribe twice...
  • Page 33 RFID Reader Interface User's Guide 2.3 Extending the Reach Most interesting here is the last constant which ensures that all available data sources are subscribed. Most often ‘NC_ALL’ is the safest option. Running the application again now gives us what we wanted. Whenever we are not subscribed, toggling the trigger will show tag events only at the RF-MANAGER runtime.

  • Page 34: Not Without My Approval

    RFID Reader Interface User's Guide 2.3 Extending the Reach 2.3.7 Not without my approval Now back to the office where Molly still wants to add the missing parcel to the original delivery. Using the device with an application such as that we created above doesn’t really help.
  • Page 35 RFID Reader Interface User's Guide 2.3 Extending the Reach We store incoming tag events in a list of tag events for later delivery public void NotificationHandler(object sender, RfNotificationArgs notificationArgs) if (null != notificationArgs.TagEvents) foreach (RfTagEvent tagEvent in notificationArgs.TagEvents) // Remember this tag event when filtering for later // confirmation this.bufferedTagEvents.Add(tagEvent);...

  • Page 36: Make It Fun: Working Keys

    RFID Reader Interface User's Guide 2.3 Extending the Reach 2.3.8 Make it fun: Working keys Finally, let’s get back to the trigger keys – remember your RFxxxM device has plenty of it, on the left on the right, a big one on top and a pistol grip trigger (if you have a device equipped with a barcode unit).
  • Page 37 RFID Reader Interface User's Guide 2.3 Extending the Reach Initially, all of the special keys produce the same keycode 0xEF or 239 decimal. So, whenever such a code arrives with a key down event, we set our trigger to active. And if the key is released again, we reset the trigger.
  • Page 38 RFID Reader Interface User's Guide 2.3 Extending the Reach These calls to PsionTeklogix.Keyboard.KeyRemapper select the key in question with the first parameter and provide new keycodes wih the last parameter. After this initialization we can rewrite our keyhandler as follows: protected void KeyDownHandler(object sender, KeyEventArgs e) switch (e.KeyValue) case (int)PsionTeklogix.Keyboard.VirtualKey.VK_F25:...

  • Page 39: Summary

    RFID Reader Interface User's Guide 2.3 Extending the Reach 2.3.9 Summary This chapter provided a short overview of the possibilities that the RFID reader interface offers when working in integrated scenarios where most of the configuration is done with RF- MANAGER and custom applications on a mobile device such as the RF610M need to tweak the system behavior a little.
  • Page 40 RFID Reader Interface User's Guide 2.3 Extending the Reach Mobile Readers Function Manual, 12/2010, J31069-D0198-U001-A2-7618...

  • Page 41: Rfid Reader Interface Reference

    The Interface The programming interface is contained in a .Net assembly with the name Siemens.Simatic.RfReaderApi.dll. Whenever clients want to use the interface, they must reference this assembly in their applications. This assembly contains the defining and implementing classes in a namespace Siemens.Simatic.RfReader.

  • Page 42: Rfreaderapi.current

    RFID Reader Interface Reference 3.2 RfReaderApi.Current RfReaderApi.Current RfReaderApi.Current : IRfReaderApi {get} Parameters: None (.Net Property) Return value(s): This function returns the current instance of an RFID Reader interface or null. Note: If no instance has been created before, a call for this function will create a new RFID Reader Interface instance.

  • Page 43: Irfreaderapi

    RFID Reader Interface Reference 3.4 IRfReaderApi IRfReaderApi 3.4.1 Version IRfReaderApiVersion : string {get} Parameters None (.Net Property) Return value(s) The current version of the interface and its implementation as a string formatted as 'V mj.mn.sp.hf_i1.i2.i3.i4' whereby mj and mn are the major and minor version of the product, sp specifies a service pack number and hf a hotfix number.

  • Page 44: Stopreader

    RFID Reader Interface Reference 3.4 IRfReaderApi RfReaderInitData Member Description Address Set the IP address for the device. This value defaults to 127.0.0.1 which is the local device. Port The port which is used for communication between the API and the underlying reader service.

  • Page 45: Readerstatus

    'RF610 EU' for the European version of RF610M 'RF610M US' for the American version. Of RF610M 'RF680M ETSI' for the European version of RF680M 'RF680M FCC' for the American version of RF680M ‘SIMATIC RF310M’ ComPort The communication port used ReaderFirmware...

  • Page 46: Airprotocol

    RFID Reader Interface Reference 3.4 IRfReaderApi ReaderHWVersion The hardware version of the RFID modul (RF310M only) ReaderLoaderVersion The version of the RFID modul (RF310M only) ErrorCounter The error counter of the RFID modul (RF310M only) AbortCounter The abort counter of the RFID modul (RF310M only) CodeErrorCounter The code error counter of the RFID modul (RF310M only) SignaturErrorCounter...

  • Page 47: Setairprotocol

    RFID Reader Interface Reference 3.4 IRfReaderApi 3.4.6 SetAirProtocol SetAirProtocol( protocolName : string, initialQ : int) : void Parameters ● protocolName A string specifying the air protocol to be set. ● initialQ An integer value that denotes the initialQ value used for collision detection with EPC Class1 Gen 2 tags.

  • Page 48: Getantennapower

    RFID Reader Interface Reference 3.4 IRfReaderApi Note The handheld devices have limited settings for the antenna power: Valid ranges for the RF680M are: 10, 25, 50, 100, 200, 300, 400 and 500 mW; Due to physical limitations, the device could also not set exactly the requested value, but choose the nearest possible value.

  • Page 49: Getcommunicationscheme

    RFID Reader Interface Reference 3.4 IRfReaderApi Parameters • communicationScheme The profile ID of the modulation schema. Return value(s) None Exceptions RfReaderApiException Error while starting the communication with the reader. Check the Error member for more information. Note The modulation scheme defines the data exchange rate between reader and tag. The possible modulation scheme depends on the used radio profile ETSI or FCC.

  • Page 50: Setchannellist

    RFID Reader Interface Reference 3.4 IRfReaderApi Exceptions RfReaderApiException Error while starting the communication with the reader. Check the Error member for more information. Note The modulation scheme defines the data exchange rate between reader and tag. The possible modulation scheme depends on the used radio profile ETSI or FCC. Valid ranges for the RF680M are: FCC : 2 = DSB-ASK 40kHz- FM0 40kHz...

  • Page 51: Getchannellist

    RFID Reader Interface Reference 3.4 IRfReaderApi Note ETSI channels are only relevant for reader with ETSI profile. While the RF680M supports no frequency hopping only one channel must be defined. Otherwise the function will rise a RfReaderApiException. Version information Supported in RFID Reader Interface since V1.3 3.4.12 GetChannelList GetChannelList ( ) : string...
  • Page 52 RFID Reader Interface Reference 3.4 IRfReaderApi Parameters ● currentTagID The ID of a tag to be written to given as a hexadecimal encoded string (i.e., each byte is represented by a two-letter hexadecimal number). ● newTagID The new ID to be written given as a hexadecimal encoded string (i.e., each byte is represented by a two-letter hexadecimal number).

  • Page 53: Gettagids

    RFID Reader Interface Reference 3.4 IRfReaderApi 3.4.14 GetTagIDs GetTagIDs() : string[] Parameters None Return value(s) Returns an array of strings that contains the read tag IDs. The tag IDs are returned in a plain hexadecimal encoded string (i.e., each byte is represented by a two-letter hexadecimal number).

  • Page 54: Gettagmemory

    RFID Reader Interface Reference 3.4 IRfReaderApi 3.4.15 GetTagMemory GetTagMemory(tagID : string, memoryBank : uint, startAddress : uint, dataLength : uint, password :string) : byte[] Parameters ● tagID The ID of a tag whose data are to be read, given as a hexadecimal encoded string. (i. e. each byte is represented by a two-letter hexadecimal number).
  • Page 55 RFID Reader Interface Reference 3.4 IRfReaderApi Note Reads tag data whereby both internal and user-specific areas may be accessed. A valid tag ID must be specified for a tag currently within the field before you can read data, or if no tag ID is specified, the first tag within the field will be read. Version information Supported in RFID Reader Interface: since V1.0 Mobile Readers...

  • Page 56: Settagmemory

    RFID Reader Interface Reference 3.4 IRfReaderApi 3.4.16 SetTagMemory SetTagMemory(tagID : string, memoryBank : uint, startAddress : uint, dataLength : uint, password :string, buffer : byte[]) : void Parameters ● tagID The ID of a tag whose data are to be modified, given as a hexadecimal encoded string. ●...
  • Page 57 RFID Reader Interface Reference 3.4 IRfReaderApi Note Writes tag data whereby both internal and user-specific areas may be accessed. RF310 specific banks UID and CONFIG Data are not writeable, and will return with error exception. A valid tag ID must be specified for a tag currently within the field before you can write data, or if no tag ID is specified, the first tag within the field will be written.

  • Page 58: Gettagstatus

    RFID Reader Interface Reference 3.4 IRfReaderApi 3.4.17 GetTagStatus GetTagStatus(tagID: string) : Hashtable {} Parameters ● tagID The ID of a tag whose status is to be read as a plain hexadecimal encoded string (i.e., each byte is represented by a two-letter hexadecimal number) Return value(s) A hash table that contains named values.
  • Page 59 RFID Reader Interface Reference 3.4 IRfReaderApi LockBit Register Returns a Byte: the LockBit Register value. Block: Schreibschutz-Status: 0 = Block nicht geschützt 1 = Block geschützt Adresszuordnung: Block 0 : FF80…FF83 Block 1 : FF84…FF87 Block 2 : FF88…FF8B Block 3 : FF8C…FF8F Block 4 : FF90…FF93 Block 5..7 reserviert ASICVersion...

  • Page 60: Inittagmemory

    RFID Reader Interface Reference 3.4 IRfReaderApi 3.4.18 InitTagMemory InitTagMemory(TagID : string, memorBank : uint, startAddress : uint, dataLength : uint, password : string, initData : byte) : void Parameters ● TagID The ID of a tag to be initialized, given as a hexadecimal encoded string (i.e., each byte is represented by a two-letter hexadecimal number).

  • Page 61: Killtag

    RFID Reader Interface Reference 3.4 IRfReaderApi 3.4.19 KillTag KillTag(tagID : string, password :string) : void Parameters ● tagID The ID of a tag which is to be killed, given as a plain hexadecimal encoded string. ● Password An access password if needed. If none needed use an empty string. A password is a hexadecimal encoded string of up to eight characters.

  • Page 62: Lockepcgen2Tag

    RFID Reader Interface Reference 3.4 IRfReaderApi 3.4.20 LockEPCGen2Tag LockEPCGen2Tag(tagID : string, epcGen2LockAction : string epcGen2LockMask : string password :string) : void Parameters ● tagID The ID of a tag which is to be locked, given as a plain hexadecimal encoded string. ●...
  • Page 63 RFID Reader Interface Reference 3.4 IRfReaderApi Note Use this command to lock an EPC class1 Gen2 tag on a logical reader. The tag is locked at the source in which the tag is currently located. If the given ID is an empty string, all RFID tags in the field of the logical reader will be locked. Below is a short description of the parameters epcGen2LockAction and epcGen2LockMask.
  • Page 64 RFID Reader Interface Reference 3.4 IRfReaderApi Example Bank Kill PWD Access TID Memory User Hex String Memory Memory Value Mask (00)1 Action (00)1 In the above example, the lockMask is 11 1111 0000 (hexadecimal 3F0). This means that you can only write action bits to the Kill, Access and EPC memory locations. The lockAction fields are 10 1010 0000 (hexadecimal 2A0) which results in the following: ●...

  • Page 65: Lockisotag

    RFID Reader Interface Reference 3.4 IRfReaderApi 3.4.21 LockIsoTag LockIsoTag(tagID : string, iso6BAddress : uint iso6BTagDataLength : uint) : void Parameters ● tagID The ID of a tag which is to be locked, given as a plain hexadecimal encoded string. ● iso6BAddress The ISO address is an offset at which to start the locking procedure.

  • Page 66: Settrigger

    RFID Reader Interface Reference 3.4 IRfReaderApi 3.4.22 SetTrigger SetTrigger(triggerType : RfTriggerType, triggerState : RfTriggerState) : void Parameters ● TriggerType This is the selected trigger to be changed which is one of the following enumeration values and is normally associated to a hardware key on your device. Trigger Description ScanLeft...

  • Page 67: Subscribefornotifications

    RFID Reader Interface Reference 3.4 IRfReaderApi 3.4.23 SubscribeForNotifications SubscribeForNotifications(notificationChannel : string, isFilter : bool) : bool Parameters ● notificationChannel The name of a notification channel that provides tag event data whereas a notification channel is – from the API’s perspective – the source of tag events. The following table contains the constants for default notification channel names that are available.

  • Page 68: Unsubscribefornotifications

    RFID Reader Interface Reference 3.4 IRfReaderApi 3.4.24 UnsubscribeForNotifications UnsubscribeForNotifications(notificationChannel : string) : void Parameters ● notificationChannel The name of a notification channel that provides tag event data whereas a notification channel is – from the API’s perspective – the source of tag events. The following table contains the constants for default notification channel names that are available.

  • Page 69: Settagevents

    RFID Reader Interface Reference 3.4 IRfReaderApi 3.4.25 SetTagEvents SetTagEvents(tagEventTarget : string, tagEvents : RfTagEvent[]) : void Parameters ● tagEventTarget The name of the component that created the tag events (i.e. the data’s source). The following table contains the constants for default event target names. RfReaderApi.NC_RFID This is the data source name if you want to target the RFID component...

  • Page 70: Subscribeforalarms

    RFID Reader Interface Reference 3.4 IRfReaderApi 3.4.26 SubscribeForAlarms SubscribeForAlarms(alarmChannel : string, isFilter : bool) : bool Parameters ● alarmChannel The name of an alarm channel that asynchronously provides alarms. RfReaderApi.AC_ALL This is a shortcut for all possible alarm channels. The current version of the API does only support the default alarm channel RfReaderApi.AC_DEFAULT This is the name of the default alarm channel available in every...

  • Page 71: Unsubscribeforalarms

    RFID Reader Interface Reference 3.4 IRfReaderApi 3.4.27 UnsubscribeForAlarms UnsubscribeForAlarms(alarmChannel : string) : void Parameters ● alarmChannel The name of an alarms channel that you want to unsubscribe Return value(s) None. Exceptions RfReaderApiException Error while communicating with the reader service. Check the Error member for more information. Note This function unregisters for asynchronous notifications of RFID alarms.

  • Page 72: Getconfigparameter

    RFID Reader Interface Reference 3.4 IRfReaderApi 3.4.28 GetConfigParameter GetConfigParameter(parameterName : string) : RfInfoItem Parameters ● parameterName The name of the configuration parameter whose value should be retrieved Return value(s) The value for the configuration parameter in an RfInfoItem structure. Exceptions Error while communicating with the reader service.
  • Page 73 RFID Reader Interface Reference 3.4 IRfReaderApi Other configuration parameters have an effect on how certain functions behave or whether a feature can be activated or not. Mostly this applies to the trigger configuration. Configuration Parameter Possible Values / Description Info vs. Config Name MobileOperatingMode This parameter tells you if the device is working in...

  • Page 74: Tageventnotification

    RFID Reader Interface Reference 3.4 IRfReaderApi 3.4.29 TagEventNotification TagEventNotifications Event RfNotificationHandler(sender : object, args : RfNotificationArgs) Exceptions RfReaderApiException Error while communicating with the reader service. Check the Error member for more information. Note This event provides notifications about tag events that the underlying reader service produced.
  • Page 75 RFID Reader Interface Reference 3.4 IRfReaderApi Take special care in providing correct event times and types as well as tag type, source and notification names because these values are heavily used in ordering, sorting and filtering events. RfTagEvent Member Possible Values / Description Mandatory TagID The read tag ID as a hexadecimal encoded string.

  • Page 76: Alarms

    RFID Reader Interface Reference 3.4 IRfReaderApi 3.4.30 Alarms Alarms Event RfAlarmHandler(sender : object, args : RfAlarmArgs) Exceptions RfReaderApiException Error while communicating with the reader service. Check the Error member for more information. Note This event provides notifications about alarms whereas an alarm is considered not only as a warning or error condition but also as a means of notification about changed system states.

  • Page 77: Information

    RFID Reader Interface Reference 3.4 IRfReaderApi Version Information Supported in RFID Reader Interface: since V1.1 3.4.31 Information Information Event InformationHandler(sender : object, args : InformationArgs) Exceptions RfReaderApiException Error while communicating with the reader service. Check the Error member for more information. Note Provides categorized information about internal actions and status changes.

  • Page 78: References

    RFID Reader Interface Reference 3.5 References References EPCglobal Tag Data Standards Version 1.3 Ratified Specification March 8, 2006 EPCglobal Tag Data Translation (TDT) 1.0 Ratified Standard Specification January 21, 2006 EPCglobal. EPC Radio Frequency Identity Protocols: Class-1 Generation-2 UHF RFID Protocol for Communications at 860 MHz - 960 MHz, Version 1.0.9 EPC Standard Specification December 2005...
  • Page 80 Get more information www.siemens.com/ident Siemens AG subject to change Industry Sector J31069-D0198-U001-A2-7618 Sensors and Communication © Siemens AG 2010 Postfach 48 48 90026 NÜRNBERG DEUTSCHLAND www.siemens.com/automation...

This manual is also suitable for:

Simatic rf610mSimatic rf680m

Table of Contents