Thingmagic M5e-Compact User Manual

875-0016-07 RevAMercury5e and M5e-CompactDeveloper’s GuideFor: Mercury5e and M5e-Compact (v1.7.1 and later) USB Reader and Vega Reader

10 Mercury Embedded Modules Developer’s GuidePower Units . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Application Tag Commands100 Command SetError Status Codes FAULT_MSG_WRONG_NUMBER_OF_DATA – 100h FAULT_MSG_INVALID_PARAMETER_VALUE - 105h FAULT_NO_P

Application Tag CommandsCommand Set 101Write Tag Data FieldsField Value DescriptionWrite Address 4 bytes The Address field is the offset in the specif

Application Tag Commands102 Command SetExamplesThe following example will attempt to write to Reserved Memory to set the Kill password=0x11112222. It

Application Tag CommandsCommand Set 103Note: Try reading back the value written in this example with the Read Tag Data Examples showing reading from

Application Tag Commands104 Command SetLock Tag FieldsThe values of the Mask and Action bits indicate how a tag is to be locked. The 10 Least Signific

Application Tag CommandsCommand Set 1050x0000 in the Action field unlocks all the memory banks as long as all memory banks exist and are lockable.Exam

Application Tag Commands106 Command SetExamplesThe following example shows an attempt to kill a tag whose EPC ID=0x112233445566778899AA and whose Kill

Application Tag CommandsCommand Set 107Read Tag Data (28h)For the deprecated version of this command see Appendix D: Read Tag Data (28h).The Read Tag

Application Tag Commands108 Command SetGet Tag DataExamplesThe following example will attempt to read the Kill Password (the first 2 words) from Reser

Application Tag CommandsCommand Set 109timeout of 1000 ms. Note the Options field, no metadata is requested unlike the previous example.EPC ID = 0x012

Mercury Embedded Modules Developer’s Guide 11Microprocessor ACK Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Application Tag Commands110 Command SetRead Tag Data Get Data and Metadata Request FieldsA response can contain the following information:Read Tag Dat

Application Tag CommandsCommand Set 111Status 2 bytes 0x0000 for success. Otherwise see Appendix C: Error MessagesOptions 1 byte As sent in requestMet

Application Tag Commands112 Command SetExamplesThe following example will attempt to read the Access Password (the first 2 words) from Reserved Memory

Application Tag CommandsCommand Set 113 FAULT_GEN2 PROTOCOL_MEMORY_LOCKED - 424h FAULT_ANTENNA_NOT_CONNECTED – 503h FAULT_TEMPERATURE_EXCEED_LIMITS

Application Tag Commands114 Command SetGet Tag EPCsWhen you want to get the tag EPCs out of the buffer and don’t care about the tag read metadata, the

Application Tag CommandsCommand Set 115 A 64-bit tag has the length set to 0x60 (16-bit PC + 64-bit tag EPC + 16-bit tag CRC), but only the first 12

Application Tag Commands116 Command Set In the event of a communication error the last Get EPC and Metadata request can be repeated.When data is requ

Application Tag CommandsCommand Set 117Metadata Flags = 0x0001 OR 0x0004 OR 0x0010 = 0x0015is as follows: A response contains the following informatio

Application Tag Commands118 Command SetHere is an example response to the example request specified above. The response contains two tags as specified

Application Tag CommandsCommand Set 119Error Status Codes FAULT_MSG_WRONG_NUMBER_OF_DATA – 100h FAULT_MSG_INVALID_PARAMETER_VALUE - 105h FAULT_TAG_

12 Mercury Embedded Modules Developer’s GuideTag Inventory with Select . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Application Tag Commands120 Command Set NXP G2X* Silicon (Chip Type=0x02) NXP G2i* Silicon (Chip Type=0x07) Impinj Monza 4 Silicon (Chip Type=0x08)

Application Tag CommandsCommand Set 121Partial Load Image Sub Command=0x01If the first bit of Sub Command is 1 (Sub Command=0x01), the Gen2 Tag Specif

Application Tag Commands122 Command SetCurrently, only the first six bits of this field are used. A value of zero in each bit field keeps the correspo

Application Tag CommandsCommand Set 123Password 0x01234567, the Access Password 0x89ABCDEF into the tag without changing the NSI bits of the tag and l

Application Tag Commands124 Command SetFastLoadImage Sub Command=0x0001This command writes all of the following data to the Higgs3 tags in a single co

Application Tag CommandsCommand Set 125FastLoadImage Command FieldsAn example FastLoadImage single tag command is:.The response to the FastLoadImage c

Application Tag Commands126 Command Setformat of the response is:FastLoadImage embedded in a Read Tag Multiple takes the following form:LoadImage Sub

Application Tag CommandsCommand Set 127LoadImage Command FieldsAn example LoadImage single tag command is:.Field Value DescriptionLength 0x5E Number o

Application Tag Commands128 Command SetThe response to the LoadImage command is an ACK with the written EPC data. The format of the response is:LoadIm

Application Tag CommandsCommand Set 129BlockReadLock Command FieldsAn example BlockReadLock single tag command is:.Field Value DescriptionLength 0x09

Mercury Embedded Modules Developer’s Guide 13Set Single Tag Operations Antennas . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Application Tag Commands130 Command SetThe response to the BlockReadLock command is an ACK. The format of the response is:BlockReadLock embedded in a

Application Tag CommandsCommand Set 131NXP Sub CommandsAll NXP-proprietary commands contain the following fields:Sub Command value NXP Command0x0001Se

Application Tag Commands132 Command SetNXP Common FieldsIn addition to the common fields some commands have additional required fields as indicated be

Application Tag CommandsCommand Set 133“Reset ReadProtect” is received. This command uses only the common fields and is invoked with the following com

Application Tag Commands134 Command SetNoteOnly the G2i command can be performed as an embedded operation in a Read Tag Multiple. The G2x version cann

Application Tag CommandsCommand Set 135 Change EAS (1 byte: 0x01=Set EAS; 0x02=Reset EAS) It is invoked with the following command:The response to th

Application Tag Commands136 Command Set TrExt as Per Gen2 (1 byte: Current fixed to 0x01, M5e and M5e-C only support extended Pilot Tone)It is invoke

Application Tag CommandsCommand Set 137CalibrateThe NXP command Calibrate causes the tag to return a random data pattern that is useful in some freque

Application Tag Commands138 Command SetChangeConfigThe ChangeConfig command is used to toggle the bits of the G2i* tag’s ConfigWord (see ConfigWord to

Application Tag CommandsCommand Set 1392 0x20D Read Protect EPC Bank (permanently stored in tag memory)1 0x20E Read Protect TID (permanently stored in

14 Mercury Embedded Modules Developer’s GuideTransmit CW Signal (C3h) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Application Tag Commands140 Command SetNXP G2i* Command FieldsAn example ChangeConfig single tag command is:.The response to the ChangeConfig command

Application Tag CommandsCommand Set 141response is:ChangeConfig embedded in a Read Tag Multiple takes the following form:Impinj Monza 4 Silicon (Chip

Application Tag Commands142 Command SetImpinj Monza 4QT Command FieldsField Value NotesLength [1 byte]OpCode 0x2DTimeout [2 bytes]Ignored when used as

Application Tag CommandsCommand Set 143An example QT Read/Write single tag command is:.The response to the QT Read/Write command contains the payload

Application Tag Commands144 Command SetError Status Codes FAULT_MSG_WRONG_NUMBER_OF_DATA – 100h FAULT_MSG_INVALID_PARAMETER_VALUE - 105h FAULT_NO_P

Application Tag CommandsCommand Set 145BlockWrite Command FieldsAn example BlockWrite single tag command is:.Field Value NotesLength [1 byte] Number o

Application Tag Commands146 Command SetThe response to the BlockWrite command is an ACK. The format of the response is:BlockWrite embedded in a Read T

Application Tag CommandsCommand Set 147BlockPermaLock Command FieldsField Value DescriptionLength [1 byte] Number of bytes in the command following th

Application Tag Commands148 Command SetAn example BlockPermaLock single tag command, locking Block 5, is:.The response to the BlockReadLock command co

Application Tag CommandsCommand Set 149BlockErase (2Eh)BlockErase is a Gen2 2.0 Optional command. On tags which support this command, it allows multip

Mercury Embedded Modules Developer’s Guide 15Solution . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Application Tag Commands150 Command SetBlockWrite Command FieldsAn example BlockErase single tag command is:.The response to the BlockErase command is

Application Tag CommandsCommand Set 151The same BlockErases embedded in a Read Tag Multiple takes the following form:Error Status Codes FAULT_MSG_WRO

Set Application Commands152 Command SetSet Application CommandsThe Set commands are used to set configurable values in the firmware. Since the values

Set Application CommandsCommand Set 153Set Antenna Port (91h)The Set Antenna Port command supports multiple options (Option=0x01 is not supported) eac

Set Application Commands154 Command SetSet Multi-Antenna Search ConfigurationOption = 0x02 allows the order antennas will be used during a multi-anten

Set Application CommandsCommand Set 155CAUTION!!!When the TX power for a logical antenna is defined using this commandthe power setting specified for

Set Application Commands156 Command SetSet Read TX Power (92h)The Set Read TX Power command sets the default, module-wide, power level to be used for

Set Application CommandsCommand Set 157Set Current Tag Protocol (93h)To select a protocol, send the Set Current Tag Protocol code to the reader. A tab

Set Application Commands158 Command SetSet Frequency Hop Table (95h)The Set Frequency Hop Table command sets the list of frequencies and, optionally,

Set Application CommandsCommand Set 159Set Regulatory Hop Time Command Fields (Option = 0x01)NoteOption=0x00 is reserved and not the same as when no o

16 Mercury Embedded Modules Developer’s GuideCause . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Set Application Commands160 Command SetThis example sets the GPIO Output #1 to ‘1’ (high). To get the current status of the GPIO output pins, send the

Set Application CommandsCommand Set 161NoteWhen LBT is disabled in the Open region the M5e/M5e-Compact will implement frequency hopping as implemented

Set Application Commands162 Command SetNoteSetting the parameters using Set User Mode will override the values set by a previous call to Set Protocol

Set Application CommandsCommand Set 163Available Configuration OptionsOption Key Value Reader Configuration setting0x00Indicates the deprecated format

Set Application Commands164 Command Set0x01 Use Antenna Port as Unique Identifier of Tag Buffer Entry= 0x000x00 Antenna port is a unique characteristi

Set Application CommandsCommand Set 165Send the following to enable the Low power transmit mode:NoteMultiple settings cannot be applied in a single co

Set Application Commands166 Command Setwhich can be set and the supported settings. Additional parameters will be supported in the future.Protocol Val

Set Application CommandsCommand Set 167NoteSetting the parameters using Set Protocol Configuration will override the implicit value set by a previous

Set Application Commands168 Command SetNoteFor details on the behavior of the Gen2 parameter settings see the EPCGlobal Gen2 RFID Air Interface Specif

Get Application CommandsCommand Set 169Get Application CommandsThe Get commands listed in the following table are used to get settable parameters from

Mercury Embedded Modules Developer’s Guide 17Solution . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Get Application Commands170 Command SetGet Hardware Version (10h)The Get Hardware Version command is used to get information about the module it is ex

Get Application CommandsCommand Set 171Non-Multiplexer Options For backward compatibility the following syntax(Option=0x00 and 0x01) is supported when

Get Application Commands172 Command SetLogical Antenna OptionsThe new Get Antenna Configuration options allow you to get the logical antenna configura

Get Application CommandsCommand Set 173Get Read TX Power (62h)For deprecated version of this command see Appendix D: Get Read TX Power (62h)The Get Re

Get Application Commands174 Command SetGet Current Tag Protocol (63h)The Get Current Tag Protocol command returns the currently set tag protocol(s). T

Get Application CommandsCommand Set 175Get Write TX Power (64h)For deprecated version of this command see Appendix D: Get Write TX Power (64h)The Get

Get Application Commands176 Command SetThe reply format is similar to the Set Frequency Hop Table command. The length must be set to a multiple of fou

Get Application CommandsCommand Set 177NoteOption=0x00 is reserved and not the same as when no option is specified.

Get Application Commands178 Command SetGet User GPIO Inputs (66h)The Get User GPIO Inputs command returns the status of the User Input GPIO lines:The

Get Application CommandsCommand Set 179Region codesTo get the current region send the following command:The command generates the following reply, whi

18 Mercury Embedded Modules Developer’s GuideFAULT_AHAL_TRANSMITTER_ON – 502h . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Get Application Commands180 Command SetAvailable power modesNoteMaximum Saving Mode only supports communications at 9600 baudThe command gets the curr

Get Application CommandsCommand Set 181Get Reader Configuration(6Ah)For the previous version of this command see Appendix D: Get Reader Configuration(

Get Application Commands182 Command SetaGet Reader Statistics (6Ch)The Get Reader Statistics command allows the user to get and reset various statisti

Get Application CommandsCommand Set 183Available StatisticsThe response to a Get Reader Statistics command contains the following information:Statisti

Get Application Commands184 Command SetGet Statistics Response FieldsTo request the Noise floor with TX on, including portID for all ports, send the f

Get Application CommandsCommand Set 185Get Available Protocols (70h)The Get Available Protocols command returns the list of protocols that the reader

Get Application Commands186 Command SetGet Current Temperature (72h) The Get Current Temperature command returns the current board component temperatu

FCC Test CommandsCommand Set 187FCC Test CommandsThe following OpCodes are used for test purposes including regulatory certification testing.NoteSet P

FCC Test Commands188 Command SetSet Operating Frequency (C1h)The Set Operating Frequency command takes a 32-bit frequency value, expressed in kHz. For

Appendix A: Hardware Details 189 Appendix A: Hardware DetailsThis Appendix details the mechanicals for the embedded modules and also provides pin 1 l

Mercury Embedded Modules Developer’s Guide 19Write Tag Data (24h) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Mechanicals190 Appendix A: Hardware DetailsM5e Mechanicals

MechanicalsAppendix A: Hardware Details 191M5e-Compact MechanicalAntenna ConnectorThe M5e has two MMCX connectors and the M5e-Compact has one MMCX con

Mechanicals192 Appendix A: Hardware DetailsCommunications ConnectorThe communications interface on the modules provides power, serial communications s

Appendix B: Getting Started - Devkit 193 Appendix B: Getting Started - DevkitDevkit HardwareIncluded ComponentsWith the devkit, you will receive the

Devkit Hardware194 Appendix B: Getting Started - DevkitConnecting the AntennaThingMagic supplies one antenna that can read tags from 20’ away with mos

Devkit HardwareAppendix B: Getting Started - Devkit 195Native USBNot applicable to the M5e.Devkit JumpersJ8Jumpers to connect M5e I/O lines to devkit.

Devkit Hardware196 Appendix B: Getting Started - DevkitJ17Jump pins 1 and 2 to use the 5V INPUT and GND inputs to provide power. Jump pins 2 and 3 to

Demo ApplicationAppendix B: Getting Started - Devkit 197Demo ApplicationA demo application which supports multi-protocol reading and writing is provid

Demo Application198 Appendix B: Getting Started - DevkitArbser Command Line UtilityThe ArbSer program is a simple terminal program with which you can

Demo ApplicationAppendix B: Getting Started - Devkit 199 -msg xx xx xx ... – Send properly formatted msg (appends SOH and CRC). -raw xx xx xx ... – Se

Government Limited Rights Notice: All documentation and manualswere developed at private expense and no part of it was developed usingGovernment funds

20 Mercury Embedded Modules Developer’s Guide

Demo Application200 Appendix B: Getting Started - DevkitGet Version CommandWhen the unit is first powered up, the boot loader is running. Verify that

Demo ApplicationAppendix B: Getting Started - Devkit 201 Data[017] = 00 Data[018] = 00 Data[019] = 07 CRC = 42EAThe module returns its version

Demo Application202 Appendix B: Getting Started - DevkitValid message received: Data Length = 14 OpCode = 04 Status = 00 00 Data[000] = 03 Data[0

Demo ApplicationAppendix B: Getting Started - Devkit 203This returns the same version information as the -ver command previously documented. Now that

Demo Application204 Appendix B: Getting Started - DevkitSet Current Tag Protocol CommandWhen the application FW first starts, there is no default prot

Demo ApplicationAppendix B: Getting Started - Devkit 205read tags. For example, to use a one-port configuration that uses only port 1, use the Set Ant

Demo Application206 Appendix B: Getting Started - DevkitC:\> ArbSer –msg 02 21 03 E8< Equivalent to: FF 02 21 03 E8 D5 09 >Valid message rece

Demo ApplicationAppendix B: Getting Started - Devkit 207Unexpected ResultsSometimes you do not get the results that you expected. The following sectio

Demo Application208 Appendix B: Getting Started - DevkitSend a Boot Firmware command to verify that the application FW is running. If the boot loader

Minimum Set of Serial CommandsAppendix B: Getting Started - Devkit 209Minimum Set of Serial CommandsThe minimum set of commands required to setup the

Introduction 21 IntroductionThe ThingMagic® Mercury® embedded modules are RFID engines that you can integrate with other systems to create RFID-enabl

Notice on Restricted Use of the DevKit210 Appendix B: Getting Started - DevkitNotice on Restricted Use of the DevKitThe Mercury5e Developers Kit (DevK

Appendix C: Error Messages 211 Appendix C: Error MessagesCommon Error MessagesThe following table lists the common faults discussed in this section.F

Common Error Messages212 Appendix C: Error MessagesSolutionMake sure the number of arguments matches the data length.FAULT_INVALID_OPCODE – 101hCauseT

Common Error MessagesAppendix C: Error Messages 213FAULT_MSG_POWER_TOO_HIGH – 103hCauseA message was sent to set the read or write power to a level th

Common Error Messages214 Appendix C: Error MessagesFAULT_MSG_POWER_TOO_LOW - 106hCauseA message was received to set the read or write power to a level

Common Error MessagesAppendix C: Error Messages 215FAULT_INVALID_REGION – 10BhCauseThe region code specified in Set Current Region (97h) is invalid or

Bootloader Faults216 Appendix C: Error MessagesBootloader FaultsThe following table lists the common faults discussed in this section.FAULT_BL_INVALID

Flash FaultsAppendix C: Error Messages 217Flash FaultsThe following table lists the common faults discussed in this section.FAULT_FLASH_BAD_ERASE_PASS

Flash Faults218 Appendix C: Error MessagesSolutionMake sure that you have the correct password for the flash sector. Check the Accessing the Flash for

Flash FaultsAppendix C: Error Messages 219FAULT_FLASH_WRITE_TO_ILLEGAL_SECTOR – 305hCauseThe module received a write flash command to write across a s

Product Line Overview22 IntroductionProduct Line OverviewThe embedded modules were designed to be incorporated into products requiring powerful RFID c

Protocol Faults220 Appendix C: Error MessagesProtocol FaultsThe following table lists the common faults discussed in this section.Fault Message CodeFA

Protocol FaultsAppendix C: Error Messages 221FAULT_NO_TAGS_FOUND – 400hCauseA command was received (such as like read, write, or lock) but the operati

Protocol Faults222 Appendix C: Error MessagesSolutionThis value is invalid or this version of SW does not support the protocol value. Check the docume

Protocol FaultsAppendix C: Error Messages 223FAULT_PROTOCOL_WRITE_FAILED – 406hCauseThis fault can occur when an operation such as write, lock, kill,

Protocol Faults224 Appendix C: Error MessagesSolutionMake sure that the address specified is within the scope of the tag data address space and availa

Protocol FaultsAppendix C: Error Messages 225FAULT_PROTOCOL_KILL_FAILED - 40EhCauseAttempt to kill a tag failed for an unknown reasonSolutionCheck tag

Protocol Faults226 Appendix C: Error MessagesSolutionCheck the data that is being passed in the command resulting in this error.FAULT_GEN2 PROTOCOL_OT

Analog Hardware Abstraction Layer FaultsAppendix C: Error Messages 227Analog Hardware Abstraction Layer FaultsFAULT_AHAL_INVALID_FREQ – 500hCauseA com

Analog Hardware Abstraction Layer Faults228 Appendix C: Error MessagesFAULT_ANTENNA_NOT_CONNECTED – 503hCauseAn attempt was made to transmit on an ant

Analog Hardware Abstraction Layer FaultsAppendix C: Error Messages 229 Check environment to ensure no occurrances of high signal reflection back at a

Hardware OverviewIntroduction 23WARNING!The M5e antenna ports may be susceptible to damage from Electrostatic Discharge (ESD). Equipment failure can r

Tag ID Buffer Faults230 Appendix C: Error MessagesTag ID Buffer FaultsThe following table lists the common faults discussed in this section.FAULT_TAG_

Tag ID Buffer FaultsAppendix C: Error Messages 231FAULT_TAG_ID_BUFFER_REPEATED_TAG_ID – 602hCauseThe module has an internal error. One of the protocol

System Errors232 Appendix C: Error MessagesSystem ErrorsFAULT_SYSTEM_UNKNOWN_ERROR – 7F00hCauseThe error is internal.SolutionMake note of the operatio

Appendix D: Deprecated and Modified Commands 233 Appendix D: Deprecated and Modified CommandsThe following contains the deprecated versions of Serial

Release Version 1.0.34234 Appendix D: Deprecated and Modified CommandsRelease Version 1.0.34Read Tag Single (21h)If a tag is read using the currently

Release Version 1.0.34Appendix D: Deprecated and Modified Commands 235Read Tag ID Multiple (22h)The Read Tag ID Multiple command performs a search for

Release Version 1.0.34236 Appendix D: Deprecated and Modified CommandsGEN2For Gen2, if Option=00, the write tag data is performed without the select o

Release Version 1.0.34Appendix D: Deprecated and Modified Commands 237For more information about the MemBank structure and the memory map of the Gen2

Release Version 1.0.34238 Appendix D: Deprecated and Modified CommandsWhere a Mask bit is specified as “L,” a “1” in that bit indicates that the corre

Release Version 1.0.34Appendix D: Deprecated and Modified Commands 239The kill password must correspond to the kill password programmed in the tag. No

Hardware Overview24 IntroductionRFID ASICAll base-band analog circuitry and PLL circuitry are contained within the Impinj Indy1000 RFID ASIC with Thin

Release Version 1.0.34240 Appendix D: Deprecated and Modified CommandsRead Tag Data (28h)The Read Tag Data command reads data from the tag. Because ea

Release Version 1.0.34Appendix D: Deprecated and Modified Commands 241The response to the Read Data command for the GEN2 protocol has the following fo

Release Version 1.0.34242 Appendix D: Deprecated and Modified CommandsMicroprocessor reply is similar to Set Write TX Power. The default Write TX powe

Release Version 1.0.34Appendix D: Deprecated and Modified Commands 243To get the current region, send the following command:The command generates the

Release Version 1.0.34244 Appendix D: Deprecated and Modified CommandsSet Current Region (97h)The Set Current Region command sets the current region f

Release Version 1.0.37.27Appendix D: Deprecated and Modified Commands 245Release Version 1.0.37.27Set Reader Configuration(9Ah)For the deprecated vers

Release Version 1.0.37.27246 Appendix D: Deprecated and Modified CommandsGet Reader Configuration(6Ah)For the deprecated version of this command see A

Appendix E: Environmental Considerations 247 Appendix E: Environmental ConsiderationsThis Appendix details environmental factors that should be consi

ElectroStatic Discharge (ESD) Considerations248 Appendix E: Environmental Considerationshas returned to the bootloader to prevent any further damage.

ElectroStatic Discharge (ESD) ConsiderationsAppendix E: Environmental Considerations 249What actually gets to the M5E is also strongly influenced by t

Hardware OverviewIntroduction 25Hardware RevisionsTable 2 lists the different Mercury Embedded hardware versions and their power output capabilities.M

ElectroStatic Discharge (ESD) Considerations250 Appendix E: Environmental ConsiderationsRaising the ESD ThresholdFor applications where full M5E power

Variables Affecting PerformanceAppendix E: Environmental Considerations 251Variables Affecting PerformanceReader performance may be affected by the fo

252 Appendix E: Environmental Considerations Tag Orientation: Reader performance is affected by the orientation of the tag in the antenna field. The

SW Overview26 IntroductionPin-out of 12-pin Digital Communications ConnectorSW OverviewThe software (SW) for the embedded products consists of two sep

SW OverviewIntroduction 27Boot Loader The boot loader provides low-level functionality. This program provides a customer interface for upgrading the a

SW Overview28 IntroductionAbout the Reader Assistant An easy-to-use user interface (Reader Assistant) can be installed to simplify reader communicatio

Functionality of the Embedded Modules 29 Functionality of the Embedded ModulesThis section highlights some of the functionality of the modules. The d

3Revision TableDate Version Description2/2008 Rev1 Separated out M4e content and Reader Assistant into standalone documents. Created new M5e Family De

Regional Support30 Functionality of the Embedded ModulesSupported RegionsThe regional functionality is set using a single serial command, Set Current

Regional SupportFunctionality of the Embedded Modules 31Regions Supporting LBT - Default SettingsNoteThe Open Region allows the module to be manually

Frequency Setting32 Functionality of the Embedded ModulesFrequency SettingThe modules have a PLL synthesizer that sets the modulation frequency to the

Frequency SettingFunctionality of the Embedded Modules 33Regional Frequency QuantizationWhen manually setting frequencies the module will round down f

Frequency Setting34 Functionality of the Embedded Modules Frequencies used in the order of entries in the table.If necessary for a region, the hop ta

RF Power SettingFunctionality of the Embedded Modules 35RF Power SettingThe power setting is calibrated at the factory and parameters are stored in fl

Antenna Ports36 Functionality of the Embedded Modules The default, module-wide, setting is specified using Set Read TX Power (92h). This setting is u

Antenna PortsFunctionality of the Embedded Modules 37NoteThe M5e-Compact has one antenna port and only supports monostatic operation.Monostatic ModeTo

Antenna Ports38 Functionality of the Embedded ModulesOutput lines. In order to enable automatic multiplexer port switching the module must be configur

Antenna PortsFunctionality of the Embedded Modules 39NoteJust as under non-Multiplexing operation, Physical Module Port #1 must be used for transmitti

46/2008 Rev3 • Fixed Arbser help info to include -l5a for loading M5e firmware• Fixed Get Tag Buffer Response Fields to show Read Count as condition

Power Management40 Functionality of the Embedded ModulesPower ManagementThe modules use different methods and levels of power management.Power ModesTh

Power ManagementFunctionality of the Embedded Modules 41Low Power ModeThis mode minimizes power consumption and optimizes thermal characteristics with

Tag Buffer42 Functionality of the Embedded ModulesPower Mode per Duty Cycle and Ambient TemperatureTag BufferThe Tag buffer stores tags, and their met

Tag BufferFunctionality of the Embedded Modules 43Tag Buffer EntryIn addition to the tag EPC data each entry contains meta data about how, where and w

Tag Buffer44 Functionality of the Embedded ModulesTag Read Meta DataWhenever a Tag entry is placed in the buffer, it uses up a single entry with the E

Tag OperationsFunctionality of the Embedded Modules 45In First Out (FIFO) — the first Tag found by the reader is the first one to be read out. See Get

Flash Memory46 Functionality of the Embedded ModulesFlash Memory Sector MappingAccessing the FlashThe flash is accessed only through the boot loader p

Flash MemoryFunctionality of the Embedded Modules 47M4e Direct Flash AddressingThis interface divides the flash into 11 different sectors of varying s

Flash Memory48 Functionality of the Embedded ModulesFlash memory mapNoteAddresses and sizes are shown in words (16-bits).The erase and write passwords

Serial PortFunctionality of the Embedded Modules 49Serial PortThe modules communicate to a host processor via the TTL logic level UART serial port, ac

Communication Regulation Information5Communication Regulation InformationEMC FCC 47 CFR, Part 15Industrie Canada RSS-210Federal Communication Commiss

General Purpose Inputs/Outputs (GPIO)50 Functionality of the Embedded ModulesM5e and M5e-Compact GPIOsThe M5e has two 3.3/5V serial input sensor ports

Default SettingsFunctionality of the Embedded Modules 51Default Settings Since default settings may change across release and be different across plat

Default Settings52 Functionality of the Embedded Modules

Overview of the Communication Protocol 53 Overview of the Communication ProtocolThe serial communication between a computer (host) and the reader is

Host-to-Reader Communication54 Overview of the Communication ProtocolThe fields are summarized in the following table.:Field Length DescriptionHeader

Reader-to-Host CommunicationOverview of the Communication Protocol 55Reader-to-Host CommunicationThe following diagram defines the format of the gener

Reader-to-Host Communication56 Overview of the Communication ProtocolCCITT CRC-16 CalculationThe same CRC calculation is performed on all serial commu

Reader-to-Host CommunicationOverview of the Communication Protocol 57An example implementation of CRC calculation, taken from the Arbser source CrcUti

Format for Microprocessor Reply to Host58 Overview of the Communication ProtocolFormat for Microprocessor Reply to HostThere are three different types

Format for Microprocessor Reply to HostOverview of the Communication Protocol 59The following shows an example of an ACK message to an Erase Flash com

Communication Regulation Information6any additional compliance requirements required with this module installed (for example, digital device emissions

Format for Microprocessor Reply to Host60 Overview of the Communication ProtocolHere is an example of a Reply message with Data Field Length not zero.

Command Set 61Command SetThe following list defines the OpCodes that are used in the embedded modules firmware. As these products grow, more OpCodes w

Format for Microprocessor Reply to Host62 Command SetFormat for Microprocessor Reply to HostThere are three different types of replies that the microp

Format for Microprocessor Reply to HostCommand Set 63The following shows an example of an ACK message to an Erase Flash command.The value in the OpCod

Boot Loader Commands64 Command SetHere is an example of a Reply message with Data Field Length not zero. This message happens to be a successful reply

Boot Loader CommandsCommand Set 65The following table shows which commands are supported by the Boot loader, the application, and the modules.Boot Loa

Boot Loader Commands66 Command SetRead Flash (02h)The Read Flash command reads the contents of flash from the specified address. Since the length of t

Boot Loader CommandsCommand Set 67Get Boot Loader/Firmware Version (03h)The Get Boot Loader command returns the Boot Loader, Hardware, and Application

Boot Loader Commands68 Command SetReturned Hardware Version TableThe following table provides a definition of each HW version returned by the Get Boot

Boot Loader CommandsCommand Set 69Boot Firmware (04h)The Boot Firmware command tells the boot loader to run the current firmware image stored in flash

Communication Regulation Information7or “Contains FCC ID: QV5MERCURY5E.” (Replace QV5MERCURY5E, for the Mercury5e, with QV5MERCURY5EC for the M5e-Comp

Boot Loader Commands70 Command SetCAUTION!!!When using the 921600 baud rate you must pass an extra byte of data(0x00) at the end of each message, afte

Boot Loader CommandsCommand Set 71checks. A failed CRC means that the application cannot run, and needs to be downloaded again.The boot loader runs th

Boot Loader Commands72 Command SetGet Current Program (0Ch)The Get Current Program command returns a code for the current program being executed in th

Boot Loader CommandsCommand Set 73Error Status Codes FAULT_MSG_WRONG_NUMBER_OF_DATA – 100h FAULT_FLASH_ILLEGAL_SECTOR – 303h FAULT_FLASH_BAD_WRITE_

Boot Loader Commands74 Command SetError Status Codes FAULT_MSG_WRONG_NUMBER_OF_DATA – 100h FAULT_FLASH_ILLEGAL_SECTOR – 303h FAULT_FLASH_BAD_ERASE_

Application Tag CommandsCommand Set 75Application Tag CommandsThe application commands are used to interact with RFID tags in the field. These command

Application Tag Commands76 Command Setparameters as defined by the EPCGlobal Gen2 v1.2 Specification. The current user controlled options are:Gen2 Ses

Application Tag CommandsCommand Set 77Gen2 Target (User Controlled)This setting determines which inventory flag or SL flag is going to have its state

Application Tag Commands78 Command Set– The SL flag must be asserted– The Session flag (Target setting) for session 0, 1, 2, or 3 (specific Sessio

Application Tag CommandsCommand Set 79Session 1 Keeps its state between 0.5 and 5 seconds, regardless of whether the tag is energized or not.The inte

Communication Regulation Information8

Application Tag Commands80 Command SetRelease Version 1.0.34. The command information in this section has been updated to only include the new format.

Application Tag CommandsCommand Set 81Example:The following EPC IDs (first 3 bits) are in the field:0xAAAA (101)0xCCCC (110)0x4444 (010)0x3000 (001)Se

Application Tag Commands82 Command SetGen2 Memory MapWhen performing a Tag Singulation/Select most of the criteria specifies values of data in certain

Application Tag CommandsCommand Set 83Read Tag Single (21h)For deprecated version (including non-Gen2 protocol specific syntax) of this command see Ap

Application Tag Commands84 Command SetIf Option=0x00 or 0x01 were used then the unused Tag Singulation Fields must be removed from the request.The res

Application Tag CommandsCommand Set 85Read Tag Single Get EPC and Metadata Request FieldsA response can contain the following information:Field Value

Application Tag Commands86 Command SetRead Tag Single Get EPC and Metadata Response FieldsExamplesAn example command requesting AntennaID and Timestam

Application Tag CommandsCommand Set 87Metadata Flags = 0x0004 OR 0x0010 = 0x0014with no tag singulation criteria, just return the first tag found, is

Application Tag Commands88 Command Setupdating the Option field to set the appropriate flag for the tag singulation based on EPC valueThe response con

Application Tag CommandsCommand Set 89Read Tag Multiple (22h)For deprecated version of this command see Appendix D: Read Tag ID Multiple (22h)The Read

Mercury Embedded Modules Developer’s Guide 9 ContentsCommunication Regulation Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Application Tag Commands90 Command SetRead Tag Multiple Search Flags2Flag ValueDescriptionAntenna Usage(bits 0, 1, 2)0x0000 Use single antenna as con

Application Tag CommandsCommand Set 91ExamplesFor example, the syntax for a Read Tag Multiple with automatic multi-antenna search starting with antenn

Application Tag Commands92 Command SetExamplesHere is an example request and response showing the use of Tag Singulation/Select Functionality to inven

Application Tag CommandsCommand Set 93Read Tag Multiple Embedded Command FieldsField Value DescriptionSelect Options [1 byte]The Options value of the

Application Tag Commands94 Command SetExample with Embedded Write Tag DataHere is an example request and response showing the use of Tag Singulation/S

Application Tag CommandsCommand Set 95Write Tag Data (24h) to write 0x12345678 into the Reserved Memory Bank starting at Word address 0x00000002 (Acce

Application Tag Commands96 Command SetExample with Embedded Read Tag DataWhen using Read Tag Multiple with an embedded Read Tag Data command an extra

Application Tag CommandsCommand Set 97Example with Embedded Kill TagThis command will inventory all tags with an EPC value with the first 88bits equal

Application Tag Commands98 Command SetError Status Codes FAULT_MSG_WRONG_NUMBER_OF_DATA – 100h FAULT_MSG_INVALID_PARAMETER_VALUE - 105h FAULT_NO_PR

Application Tag CommandsCommand Set 99Write Tag EPC Command FieldsThe reader sends a Fault Code / ACK response back to the host.An example of Write Ta