Document Outline

• Mercury API Programmer’s Guide
• Contents
• Introduction to the MercuryAPI
  • Language Specific Reference Guides
  • Supported Languages and Environments
    • Language Specific Build and Runtime Details
  • Example Code
  • Hardware Specific Guides
  • Hardware Abstraction
  • ThingMagic Mercury API Software License
• Level 1 API
  • Connecting to Readers
    • Reader Object
      • Create
        • SerialReader
        • RqlReader
        • LLRPReader
      • Connect
      • Destroy
      • URI Syntax
        • URI Examples
      • Region of Operation
  • Reading Tags - The Basics
    • Read Methods
      • Reader.read()
      • Reader.startReading()
        • Pseudo-Asynchronous Reading
        • Continuous Reading
      • Return on N Tags Found
      • Reading Tag Memory
    • ReadListener
    • ReadExceptionListener
  • Tags
    • TagReadData
    • TagData
  • Writing To Tags
  • Status Reporting
    • StatusListener
  • Exceptions
    • ReaderCommException
    • ReaderCodeException
    • ReaderParseException
    • ReaderFatalException
    • FeatureNotSupportedException
• Level 2 API
  • Advanced Reading
    • ReadPlan
      • SimpleReadPlan
      • StopTriggerReadPlan
      • MultiReadPlan
    • In-Module Multi-Protocol Read
  • Selecting Specific Tags
    • TagFilter Interface
      • MultiFilter
      • Gen2.Select
      • ISO180006B.Select
    • Tag Protocol
  • Advanced Tag Operations
    • TagOp Invocation
      • Direct Invocation
      • Embedded TagOp Invocation
        • Embedded TagOp Success/Failure Reporting
    • Gen2 Standard TagOps
      • Gen2.WriteTag
      • Gen2.ReadData
      • Gen2.WriteData
      • Gen2.Lock
        • Gen2.LockAction Class
        • Example:
      • Gen2.Kill
    • Gen2 Optional TagOps
      • Gen2.BlockWrite
      • Gen2.BlockPermaLock
    • Gen2 Tag Specific TagOps - Alien Higgs
      • Gen2.Alien.Higgs2.PartialLoadImage
      • Gen2.Alien.Higgs2.FullLoadImage
      • Gen2.Alien.Higgs3.FastLoadImage
      • Gen2.Alien.Higgs3.LoadImage
      • Gen2.Alien.Higgs3.BlockReadLock
    • Gen2 Tag Specific TagOps - NXP G2*
      • Gen2.NXP.G2I.SetReadProtect and Gen2.NXP.G2X.SetReadProtect
      • Gen2.NXP.G2I.ResetReadProtect and Gen2.NXP.G2X.ResetReadProtect
      • Gen2.NXP.G2I.ChangeEas and Gen2.NXP.G2X.ChangeEas
      • Gen2.NXP.G2I.EasAlarm and Gen2.NXP.G2X.EasAlarm
      • Gen2.NXP.G2I.Calibrate and Gen2.NXP.G2X.Calibrate
      • Gen2.NXP.G2I.ChangeConfig
    • Gen2 Tag Specific TagOps - Impinj Monza4
      • Gen2.Impinj.Monza4.QTReadWrite
    • Gen2 Tag Specific TagOps - IDS SL900A
      • Gen2.IDS.SL900A.AccessFifo
      • Gen2.IDS.SL900A.GetBatteryLevel
      • Gen2.IDS.SL900A.GetCalibrationData
      • Gen2.IDS.SL900A.GetLogState
      • Gen2.IDS.SL900A.GetMeasurementSetup
      • Gen2.IDS.SL900A.GetSensorValue
      • Gen2.IDS.SL900A.EndLog
      • Gen2.IDS.SL900A.Initialize
      • Gen2.IDS.SL900A.SetCalibrationData
      • Gen2.IDS.SL900A.SetLogLimit
      • Gen2.IDS.SL900A.SetLogMode
      • Gen2.IDS.SL900A.SetPassword
      • Gen2.IDS.SL900A.SetShelfLife
      • Gen2.IDS.SL900A.SetSFEParameters
      • Gen2.IDS.SL900A.StartLog
    • ISO18000-6B TagOps
      • Iso180006b.ReadData
      • Iso180006b.WriteData
      • Iso180006b.Lock
        • ISO180006B.LockAction class
  • Advanced Tag Operations [Deprecated]
    • Killing Tags
      • killTag()
    • Locking Tags
      • lockTag()
    • Tag Memory Access
      • readTagMemBytes()
      • readTagMemWords()
      • writeTagMemBytes()
      • writeTagMemWord()
  • Antenna Usage
    • Automatic Antenna Switching
    • Virtual Antenna Settings
      • Auto Configuration
      • Manual Configuration
      • Vega Reader Example
  • GPIO Support
    • Get/Set Value
    • GPIO Direction
  • Firmware Updates
  • Rebooting Readers
  • Protocol License Keys
    • Deprecated API
  • Debug Logging
    • TransportListener Interface
  • Configuring Readers
    • Reader Configuration Methods
      • paramGet()
      • paramSet()
      • paramList()
    • Save and Restore Configuration
    • Reader Configuration Parameters
      • /reader
        • /reader/baudRate
        • /reader/commandTimeout
        • /reader/licenseKey
        • /reader/powerMode
        • /reader/transportTimeout
        • /reader/userMode
        • /reader/uri
        • /reader/userConfig
      • /reader/antenna
        • /reader/antenna/checkPort
        • /reader/antenna/connectedPortList
        • /reader/antenna/portList
        • /reader/antenna/portSwitchGpos
        • /reader/antenna/settlingTimeList
        • /reader/antenna/txRxMap
      • /reader/gen2
        • /reader/gen2/accessPassword
        • /reader/gen2/writeMode
        • /reader/gen2/BLF
        • /reader/gen2/q
        • /reader/gen2/millerm [Deprecated]
        • /reader/gen2/tagEncoding
        • /reader/gen2/session
        • /reader/gen2/target
        • /reader/gen2/Tari
        • /reader/gen2/writeReplyTimeout
        • /reader/gen2/writeEarlyExit
      • /reader/gpio
        • /reader/gpio/inputList
        • /reader/gpio/outputList
      • /reader/iso18000-6b
        • /reader/iso18000-6b/BLF
        • /reader/iso18000-6b/modulationDepth
        • /reader/iso18000-6b/delimiter
      • /reader/radio
        • /reader/radio/enablePowerSave
        • /reader/radio/powerMax
        • /reader/radio/powerMin
        • /reader/radio/portReadPowerList
        • /reader/radio/portWritePowerList
        • /reader/radio/readPower
        • /reader/radio/writePower
        • /reader/radio/temperature
      • /reader/read
        • /reader/read/asyncOffTime
        • /reader/read/asyncOnTime
        • /reader/read/plan
      • /reader/region
        • /reader/region/id
        • /reader/region/supportedRegions
        • /reader/region/hopTable
        • /reader/region/hopTime
        • /reader/region/lbt/enable
      • /reader/status
        • /reader/status/antennaEnable
        • /reader/status/frequencyEnable
        • /reader/status/temperatureEnable
      • /reader/tagReadData
        • /reader/tagReadData/recordHighestRssi
        • /reader/tagReadData/reportRssiInDbm
        • /reader/tagReadData/uniqueByAntenna
        • /reader/tagReadData/uniqueByData
        • /reader/tagReadData/tagopSuccess
        • /reader/tagReadData/tagopFailures
      • /reader/tagop
        • /reader/tagop/antenna
        • /reader/tagop/protocol
      • /reader/version
        • /reader/version/hardware
        • /reader/version/model
        • /reader/version/productGroup
        • /reader/version/serial
        • /reader/version/software
        • /reader/version/supportedProtocols
• Level 3 API
• .NET Language Interface
  • .NET Development Requirements
    • Mercury API Library (desktop):
    • Mercury API CE Library (embedded Compact Framework)
    • RFID Searchlight:
    • Universal Reader Assistant 1.0
    • Universal Reader Assistant 2.0
  • USB Drivers
    • WinCE Driver Installation Procedure
    • WinCE Sample Application Installation Procedure
• C Language Interface
  • C Language Features
    • C Read Iterator
  • Build Considerations
    • API Changes Required for Different Hardware Platforms
    • C Conditional Compilation
      • Protocol-Specific C Compilation Options
  • IOS Support
    • Development Environment
    • Supported IOS Versions
    • Testing Environment
    • README File
• Java Language Interface
  • JNI Library
  • LLRP ToolKit (LTK) Support
    • Usage
  • Required Windows Runtime Libraries
  • Android Support
    • Development Environment
    • Testing Environment
    • Tested Android Versions
• Advanced Customization
  • Custom Serial Transport Naming
    • Implementation
    • Changes Required for C#/.NET
      • Example
    • Changes Required for C
      • Example:
    • Changes Required for Java
      • Example
• On Reader Applications
  • Building On-Reader Applications
    • Requirements
    • Instructions
    • Installing the Cross Compiler Environment
    • Compiling an Application
      • Troubleshooting
    • Installing the Application on the M6
      • Via NFS Mount
      • Via wget
    • Running an On-Reader Application
      • Default inittab
      • Modified inittab
    • Connecting the M6 to an NFS Mount
      • Exporting an NFS Mount Point
      • Mount the NFS Share on the M6
    • Telnet to the Reader
    • Saving the Program to the JFFS2 File System
• Performance Tuning
  • How UHF RFID Works (Gen2)
    • Transmit Power
    • Reader-to-Tag Settings
    • Tag-to-Reader Settings
    • Tag Contention Settings
  • Optimizing Gen2 settings