MTI RFID ME™ .Net Software Development Kit User`s Manual
Contents
1. public partial class Form1 Form Declare RFID ME SDK public RFIDMEDevKit reader myReader private void Forml_Load object sender EventArgs e myReader Activation Demo new RFIDMEDevKit reader Page 17 of 172. getUSBHIDInfo Usage getUSBHIDInfo Description Get USB HID device path for use with detecting device insertion and removal Parameters None Returns String Device path name Comments None Page 7 of 17 RFIDMeDevKit SDK User Manual killTag Usage killTag string myPassword string myTaglD Description Attempts to permanently kill disable the tag This command assumes that only one tag will be in the reader s field If more than one tag is found an error will be returned Once done this tag will not respond to any reader again Parameters myPassword string The tag s current Kill password formatted as a single hex string without any spaces myTaglD string The EPC value of the tag that is to be killed Returns String Success or the specific reader error encountered If an invalid password is defined an error indicating such is returned Comments This is a permanent action It is suggested that a this command be used with extreme care and b that execution of the killTag be done inside of a loop that requires the user to positively confirm that the action is desired As of this version only the RFID ME is supported Support for the RU 824 and RU 861 should be available by early May 2012 Remember once a tag is killed it is basically scrap lockTag Usage lockTag string myTaglD string myPassWord string myLockAction string myLockltem Description Attempts to lock unlock the indica
3. m MR ke 10 SEPON T ee en ee eee ee ee ey d 11 didis M ae 11 VALE IAG P O 11 WV IOUS SF MOO MENTRE URINE 12 RU 824 RU 861 Specific Methods izuduitasdissdu ebisdatadabe 12 zwi Ngnuels ARR m T TT 12 BelsmsulatlomAIB FILIIS sd 12 getSingulationAlgorithmConTfIE 444000r nennen nnne nennen rns naar esent 13 RB IINE a PERRO UU s 13 CENTIEN Y a E 14 SECS IMS MU OA E OE RU escbedies oreet Uca ur Beda m beendet es EI Ol Dn Eu dU 14 setSingulationAlgorithmCOhTIg sudu dd side Sendo x DIS E P e rk YES ea noste Spe Eo ENTEPE SE n 14 TOUN NOON RER EE T T mrs 15 Code A Saas stmt eer EMEN MESE MINE m MM MEE MM MSN EM EE 17 Code Example Visual Basie NET 17 COGS ENDIE P O O O O 17 Page 2 of 17 RFIDMeDevKit SDK User Manual 02012 BAIT Consulting All rights reserved MTI Microsoft NET RFID ME and Visual Studio are the registered property of their respective owners Page 3 of 17 RFIDMeDevKit SDK User Manual Version Control version tects changes O Version Affects Changes ver 0 90 Ver 1 0 0 Ver 1 1 Ver 1 1 0 110 still use SDK Also fixed write functionality for RU 888 31 Aug 2012 All First production release of SDK Ver 2 0 1 Oct 2012 Added multi reader functionality for RU 888 and RU 824 861 Ver 2 1 Also got select functionality working for program and reads Note As of version 2 1 of the SDK
4. myTaglD string myPassWordField string myCurrentPwd string myNewPassWord Description Attempts to set reset the tag s passwords Access and Kill in the reserved memory bank 00 This command assumes that only one tag will be in the reader s field If more than one tag is found an error will be returned Parameters myTaglD string The EPC value of the tag that is to be programmed myPassWordField string The password field to be programmed The two options are Access and Kill myCurrentPassWord string The tag s current Access password formatted as a single hex string without any spaces myNewPassWord string The new password formatted as a single hex string without any spaces Returns String Success or the specific reader error encountered If an invalid password field is defined an error indicating such is returned Comments This method will select the desired tag read both current passwords from the reserved memory block MBOO generate a new overall reserved MBOO value and write that back As of this version only the RFID ME is supported Support for the RU 824 and RU 861 should be available by early May 2012 Page 10 of 17 RFIDMeDevKit SDK User Manual setPower Usage setPower int Power Description Set the power for the reader The RFID ME has a value range of 5 18 The RUI 824 has an implemented range of 5 24 Parameters Power integer The power level that is desired Returns String The s
5. the transfer dll file is no longer needed While it will not hurt if it is left in there is no functional reason 1 Nov 2012 All Changed activation demo functionality Added Activation Ver 2 1 1 method to pass in code when purchased Introduction This software development kit SDK has been developed in conjunction with MTI to allow NET developers an easier time in deploying solutions that are designed to work with the MTI RFID ME family of devices This SDK has been developed such that any programmer with a beginner to intermediate skill level should be able to create and deploy solutions that allow for the integration of the MTI hardware The SDK will support any Net programming language C Visual Basic etc Java is not currently supported There are two code examples included with the installed SDK one in Visual Basic and the other in C Finally this version of the SDK must be used with Visual Studio 2008 or higher At this time for the RFID ME only standard EPCGlobal compliant functionality and necessary hardware controls have been implemented into this SDK Advanced NXP functionality and additional hardware controls radio controls antenna port configuration etc that have been published in the MTI RU 888 RFID Module USB API Reference Manual v3 1 are not supported Should there be a need please contact us via email at autoid ohio edu and it will be determined at that time if the functionality is a necessary up
6. Kit SDK User Manual Show Spaces Boolean Show a space between each byte of the EPC value This function allows the SDK to display data similar to the MTI demo software Delimiter string The character s used to separate the returned EPC tag values if there is more than one tag in the field Returns String No tags found or a list of hex formatted EPC tag values separated by the user selected delimiter If there is a problem the reader specific error that was encountered will be returned Comments It is suggested that a space NOT be used as a delimiter Additionally non printable ASCII characters are not currently supported If the programmer is using CH it might be possible to use r n to force a new line but this has not been tested and it is possible that doing so might cause problems within the DLL readMemory Usage readMemory string myEPC string myMemoryBank string myPassword string myStartAddress string myDataLength Description Attempts to read the indicated section of an RFID tag This is a function that should be reserved for someone who understands how a tag s memory is configured This command assumes that only one tag will be in the reader s field If more than one tag is found an error will be returned Parameters myEPC string The EPC value of the tag that is to be read myPassword string The tag s current Access password formatted as a single hex string without any spaces myStartAddress st
7. MTI RFID ME Net Software Development Kit User s Manual Version 2 1 1 Search a C Sharp Demo 3 mscorlib V Connect Y Disconnect V killTag string string W lockTag string string string string W readEPC bool string reader J System Data 4 readMemory string string string string string Qj SystemDeploymd readUserMemory stning string string a System Drawing 4 setPassWord string string string string Power int jSvstemMWindows set s 4 em Xml writeEPC string stnnj string dd v writeMultipleEPC stnng string 4 writeUserMemory string string string blic class reader l po of FIDMEDexkit Nov 2012 RFIDMeDevKit SDK User Manual Contents Ver Or CONT O 4 WC OCCT R ecb eaensciodseneseaen 4 Gul 5 OOM E E E E E EE E 6 PO cates cers EE E E E E E E E E Gade coup A E M 6 CONNEC d 6 Biss R 7 PorU BRIO O z Msn MEME RS MEME EM M SN MUERE 7 SUD em 8 A E 8 fco eR 8 FIR RR O O O O ean 9 FC Se OY NER 10 EPI SV OM OP
8. NewEPC string myPassword Description Attempts to program ALL tags within range Parameters myNewEPC string The new data to be programmed formatted as a single hex string without any spaces myPassword string The tag s current Access password formatted as a single hex string without any spaces Returns String All tags programmed or the tag id s that failed to program The specific error message that was encountered will not be passed back in this method All tags that were not explicitly listed can be assumed to have successfully programmed Comments Due to the nature of RFID it is suggested that the writeUserMemory method be invoked within a loop that will iteratively attempt to program the tag for a finite number of times until it succeeds If a failure occurs it is suggested that the offending tag be removed which is why it s EPC value is reported back In addition to writing the EPC value the writeMultipleEPC method will reset Page 11 of 17 RFIDMeDevKit SDK User Manual the EPC length value leaving ALL other PC word data as it is currently encoded As of this version only the RFID ME is supported Support for the RU 824 and RU 861 will be made available in the next version of the SDK writeUserMemory Usage writeUserMemory string myTagID string myPassword string myNewData Description Attempts to write the user memory value MB11 to a tag This command assumes that only one tag will be in the reader s fiel
9. d If more than one tag is found an error will be returned Parameters myTaglD string The tag to be programmed myPassword string The tag s current Access password formatted as a single hex string without any spaces myNewData string The new data to be programmed formatted as a single hex string without any spaces Returns String Success or the error that was encountered while trying to write the value Comments Due to the nature of RFID it is suggested that the writeUserMemory method be invoked within a loop that will iteratively attempt to program the tag for a finite number of times until it succeeds As of this version only the RFID ME is supported Support for the RU 824 and RU 861 should be available by early May 2012 RU 824 RU 861 Specific Methods The following commands can only be used with the RU 824 or the RU 861 as the RFID ME chipset does not support them This is a limitation of the RFID ME USB Dongle and not the SDK getAntConfig Usage getAntConfig Description Returns the current antenna configuration from the reader Parameters None Returns String Antenna state as a hex value the specific reader error message or Reader does not support this function Comments None getAntState Usage getAntConfig string myAntPort Description Returns the current antenna configuration from the reader Parameters myAntPort string The antenna port number as a hex value to be turned on or
10. et power level or the specific error message returned from the reader If a power level that is outside of the range of the reader is attempted an error message indicating that the parameter is invalid will be returned writeEPC Usage writeEPC string myTaglD string myPassword string myNewData Description Attempts to write the EPC value MBO1 to a tag This function assumes only one tag exists in the field This command assumes that only one tag will be in the reader s field If more than one tag is found an error will be returned Parameters myTaglD string The tag to be programmed myPassword string The tag s current Access password formatted as a single hex string without any spaces myNewData string The new data to be programmed formatted as a single hex string without any spaces Returns String Success or the error that was encountered while trying to write the value Comments Due to the nature of RFID it is suggested that the writeEPC method be invoked within a loop that will iteratively attempt to program the tag for a finite number of times until it succeeds In addition to writing the EPC value the writeEPC method will reset the EPC length value leaving ALL other PC word data as it is currently encoded Additionally it should be noted that ALL tags in view will be programmed at this time on the RU 824 and RU 861 This will be changed in the next version writeMultipleEPC Usage writeMultipleEPC string my
11. grade or if separate SDK will be developed For the RU 824 and the RU 861 only the standard EPCGlobal compliant functionality and necessary hardware controls have been implemented into this SDK Advanced hardware controls firmware communications GPIO etc that have been published in the MTI RU 824 861 RFID Reader Module Command Reference Manual Version 1 0 are not supported Should there be a need please contact us via email at autoid ohio edu and it will be determined at that time if the functionality is a necessary upgrade or if separate SDK will be developed Page 4 of 17 RFIDMeDevKit SDK User Manual By purchasing this SDK you are entitled to basic upgrades and are encouraged to report any problems or bugs that are found If a major re write of the SDK is undertaken you will be alerted and provided with an opportunity to upgrade The sample programs included in the SDK distribution are fully functional and in theory one could use them as is They are there to a allow us to ensure that the SDK is working correctly b provide you with a framework from which to quickly develop an application and c to show you how we had intended to have the SDK used Feel free to use modify and play with the programs as desired If you have a need feel free to contact us We are happy to answer questions via email Overview The setup file will place all files in c Program Files BAIT RFIDMeDevkKit unless another location is selected at set
12. off This is only applicable on the RU 861 Returns String Antenna configuration as comma delimited string Power Dwell Inventory Cycles specific reader error message or Reader does not support this function Comments None Page 12 of 17 RFIDMeDevKit SDK User Manual getSingulationAlgorithm Usage getSingulationAlgorithm Description Reports the current singulation algorithm Parameters None Returns String The singulation algorithm value O fixed O or 12dynamic O the specific reader error message or Reader does not support this function Comments None getSingulationAlgorithmConfig Usage getSingulationAlgorithmConfig Description Returns the current singulation algorithm configuration Parameters None Returns String The singulation algorithm configuration as a comma separated string see the low level Command Reference Manual from MTI for the specific information the specific reader error message or Reader does not support this function Comments None ReaderReset Usage ReaderReset Description Forces a reader reset Parameters None Returns String Success the specific reader error message or Reader does not support this function Comments The calling software will need to reinitialize the connection to the reader after performing this function setAntennaPort Usage setAntennaPort string myAntPort bool myAntState Description Turns on or off the specified antenna p
13. onfig Usage setSingulationAlgorithmConfig string myNewConfig bool myDynamicQ Description Sets the singulation algorithm configuration Parameters myNewConfi string The singulation algorithm configuration values to be used as a comma delimited hexadecimal string See the low level Command Reference Manual from MTI for the specific information on what the values need to be myDynamicQ bool Whether or not a dynamic Q is currently set True use a dynamic Q False do not use a dynamic Q Returns String Success the specific reader error message or Reader does not support this function Comments None Page 14 of 17 RFIDMeDevKit SDK User Manual sendCommand Usage sendCommand string myCommand int myResponseLength Description Send a raw currently unsupported command to the reader Parameters myCommand string The command to be passed on to the reader The string has to be formatted as outlined in the reader s low level command set documentation including the header information myResponseLength int The length of the response assumes 16 or 64 bytes Returns String The response from the reader or the specific communications error that occurred Comments The programmer does not need to calculate the CRC for the command as the SDK will do that At this point the SDK is designed to only respond with a single returned response from the reader If the reader requires multiple responses such as for a write or get invento
14. ort Parameters myAntPort string The antenna port number as a hex value to be turned on or off This is only applicable on the RU 861 myAntState bool True on False off Returns String Success the specific reader error message or Reader does not support this function Comments None setDwellTime Usage setDwellTime int DwellTime Page 13 of 17 RFIDMeDevKit SDK User Manual Description Sets the antenna dwell time Parameters DwellTime int The amount of time to dwell on an antenna during the inventory process Returns String Success the specific reader error message or Reader does not support this function Comments None setNumInvCyc Usage setNumInvCycle int InvCycles Description Sets the antenna s number of inventory cycles Parameters InvCycles int The number of inventory cycles to perform during the inventory process Returns String Success the specific reader error message or Reader does not support this function Comments None setSingulationAlgorithm Usage setSingulationAlgorithm bool DynamicQ Description Sets the type of inventory O cycle to perform during the inventory process Parameters DynamicQ bool Whether or not to use a dynamic Q singulation algorithm True use a dynamic Q False do not use a dynamic Q Returns String Success the specific reader error message or Reader does not support this function Comments None setSingulationAlgorithmC
15. r Parameters None Returns String RFID ME SDK ver x x Current reader set to xxxx Comments None Activation Usage Activation string myActivationCode Description Activates the SDK or places it in demo mode Parameters None myActivationCode string The activation code you received when you purchased the SDK If you are running the SDK in demo mode pass Demo as a value Returns bool True for successful activation as either a demo or a paid version or false if an invalid activation code is entered Comments If you pass Demo you will be able to use the SDK until the beginning of the next quarter after it was downloaded 1 1 3 3 6 6 or 9 9 Connect Usage Connect string myReader Description Attempts to connect to the indicated RFID reader Page 6 of 17 RFIDMeDevKit SDK User Manual Parameters myReader string The type of reader that is to be connected to Options are RFIDME RU824 and RU861 Returns String Connected Reader not connected or the specific error message if the connection attempt fails Comments Once a connection has been made there is a basic assumption that all subsequent commands are to be made against the type of reader initially selected As such the SDK will remember during a given session what reader was connected and will determine the applicability of the subsequent commands based on the reader initially selected Should there be a need to send commands to a differen
16. r is not plugged in Make sure you are declaring the correct reader in your Connect string myReader method Page 16 of 17 RFIDMeDevKit SDK User Manual Code Examples The sample programs include one is CH and the other in Visual Basic were both developed in Microsoft Visual Studio 2010 If you need to open it in a previous version of VS you will probably have to create a new project and manually add the form into that project Both programs are the same with the programming language as the only difference n ud RFID Development Kit Visual Basic Demo Set Connect Power 11 Transaction Log Cear Log 1234 Tag 1234 failed to program Tag access failed Read Tags Curent Password 00000000 Succ l Selected tag was not found Write EPC value To write Passwords Set New Password Password to set Pass Access User Memory ee Words to read Read User I Memory n To write Write User Memoy j Other functions kem Ki Lock Unlock tag J Action Lock Code Example Visual Basic NET To include the RFIDMeDewvKit DLL you will need the following code added to your program Public Class Formi Declare RFID ME SDK L Public myReader As New RFIDMEDevKit reader private void Forml Load object sender EventArgs e myReader Activation Demo Code Example C To include the RFIDMeDevkKit DLL you will need the following code added to your program
17. ring The word location where the read is to begin myMemoryBank string The memory bank to be read formatted as a two digit string Valid options are 00 01 02 and 03 See Figure 1 above or refer to the UHF Class 1 Gen 2 Air Interface Protocol Specification for further information on the structure of the tag and where to look for information myDataLength string The number of words four digit hex values to be read from user memory See Figure 1 above or refer to the UHF Class 1 Gen 2 Air Interface Protocol Specification for further information on the structure of the tag and where to look for information Returns String The tag s indicated memory block in a single hex string that is of the indicated length If there is a problem the reader specific error that was encountered will be returned Comments This function is included for those that are looking to do more controlled reading from the RFID tag For the majority of the applications use of this method is unnecessary as the other methods in this SDK will provide a simpler interface for obtaining the desired results For example to read the EPC value of a tag using readEPC provides a simple way to get the information To use readMemory the programmer will need to ensure that they are a addressing the correct memory bank MBO1 b start reading from the correct memory address in the memory bank word 02 and c know to read the correct number of words which is obtained f
18. rom the first 5 bits of word 01 As of this version only the RFID ME is supported Support for the RU 824 and RU 861 should be available by early May 2012 Page 9 of 17 RFIDMeDevKit SDK User Manual readUserMemory Usage readUserMemory string myTaglD string myPassword string myDataLength Description Attempts to read the tag s user memory memory bank 11 from the selected tag This command assumes that only one tag will be in the reader s field If more than one tag is found an error will be returned Parameters myTaglD string The EPC value of the tag that is to be read myPassword string The tag s current Access password formatted as a single hex string without any spaces myDataLength string The number of words four digit hex values to be read from user memory Returns String The tag s User Memory in a single hex string that is of the indicated length If there is a problem the reader specific error that was encountered will be returned Comments If the tag does not have user memory enabled a message to that effect will be returned See the EPCGlobal Gen2 Air Interface Protocol or the tag s datasheet for information on the available memory size setLogging Usage setLogging bool myLogging Description Turns on and off the logging level for the SDK Parameters myLogging bool True turns on logging False turns off logging Returns Nothing Comments None setPassWord Usage setPassWord string
19. ry type command only the first response will be returned Should this functionality be needed please contact us via email at kevin bait consulting com Page 15 of 17 RFIDMeDevKit SDK User Manual Trouble Shooting SDK Demo has expired A problem occurred while communicating with the reader occurs despite the reader being plugged in Intermittent reading of tags A lot of errors occur when programming a tag the tag programs eventually but it takes multiple tries Reader not found error when trying to connect Make sure that you have added the Activation method to your code prior to trying to connect to the reader This only has to be done once in your code but must be done every time you run your program There is a known issue with some USB devices that results in an inability to correctly connect to the RFID reader Try switching out any USB mice being used Dell mice seem to cause a problem for a different brand This problem is being worked on and you will be notified when it is fixed Confirm that the RFID tag is not sitting directly on top of the reader It has been noticed that if a small gap 1 inch or so is maintained between the reader and the tag the system works much smoother Ensure that the power is not too low OR high Ensure the tag is not sitting directly on the reader see above Ensure that only one tag is in range If other tags are at the edge of the read envelope move them away Reade
20. t type of reader the SDK will have to be functionally disconnected and a new connection will need to be made Usage Connect string myReader string mySerialNumber Description Attempts to connect to the indicated RFID reader Parameters myReader string The type of reader that is to be connected to Options are RFIDME RU824 and RU861 mySerialNumber string The serial number of the reader to be connected to Please note that the serial number string is case sensitive Returns String Connected Reader not connected or the specific error message if the connection attempt fails Comments Once a connection has been made there is a basic assumption that all subsequent commands are to be made against the type of reader initially selected As such the SDK will remember during a given session what reader was connected and will determine the applicability of the subsequent commands based on the reader initially selected Should there be a need to send commands to a different type of reader the SDK will have to be functionally disconnected and a new connection will need to be made Disconnect Usage Disconnect Description Attempts to disconnect from the RFID ME reader Parameters None Returns String Disconnected or Problem disconnecting and the specific error message received while trying to disconnect Comments Disconnect is not actually required but is suggested to help control potential memory leaks
21. ted portion of the tag This command assumes that only one tag will be in the reader s field If more than one tag is found an error will be returned Parameters myTaglD string The EPC value of the tag that is to be read myPassword string The tag s current Access password formatted as a single hex string without any spaces myLockAction string The type of action to be taken The valid options are Unlock PermanentUnlock Lock and PermanentLock Lock and Unlock will allow the user to change the setting in the future PermanentLock and PermanentUnlock will permanently set the state of the tag and future attempts at locking or unlocking the tag will fail myLockltem string The section of the tag to be locked The valid options are Kill Access EPC TID and User Returns String Success or the specific reader error encountered If an invalid password field is defined an error indicating such is returned Comments Since the permanent lock unlock actions cannot be undone it is suggested that Lock and Unlock be used unless it is known that the settings will never need to be changed again As of this version only the RFID ME is supported Support for the RU 824 and RU 861 should be available by early May 2012 readEPC Format readEPC String ShowSpaces String myDelimiter Description Reads the EPC memory bank MBO1 from any tags that are in range Parameters Page 8 of 17 RFIDMeDev
22. up When adding the DLLs in your project you will need to reference them in this location The general process for using the SDK and the hardware are as follows 1 Plug the reader into the computer 2 n your project a Add RFIDMeDewvKit DLL as a project reference 3 From your program a Pass your registration code or Demo with the Activation method b Connectto the reader to ensure it is plugged in c Initiate a read to see what tags exist d Usethe results in a business process to solve your specific problem 4 When you deploy via Setup file or manually a Make sure RFIDMeDevkKit DLL is included in package b Make lots of money At times during the documentation references to the RFID tag s memory structure are made Figure 1 below is from the Class 1 Gen 2 air interface protocol and shows how the tag s memory is laid out Page 5 of 17 RFIDMeDevKit SDK User Manual MSB LSB Word 0 of Block 0 MSB LSB OF h MSB LSB Optional XPC_W2 15 0 Optional XPC_W1 15 0 EPC 15 0 TID 15 0 TID 31 16 Bank 11 Bank 10 Bank 01 RESERVED MSB LSB Figure 1 C1G2 logical memory map uhfc1g2 1 2 O standard 20080511 pdf downloaded from http www gs1 org gsmp kc epcglobal uhfc1g2 on 22 Oct 2011 Bank 00 EPC N N 15 StoredPC 15 0 StoredCRC 15 0 Common Methods About Usage About Description Reports current SDK version and identified reade
Download Pdf Manuals
Related Search