Mercury API
RqlReader Class
Namespaces ► ThingMagic ► RqlReader
The RqlReader class is an implementation of a Reader object that communicates with a ThingMagic fixed RFID reader via the RQL network protocol. Instances of the RQL class are created with the Reader.create()method with a "rql" URI or a generic "tmr" URI that references a network device.
Declaration Syntax

C# | Visual Basic | Visual C++

    public class RqlReader : Reader

    Public Class RqlReader _
    	Inherits Reader

    public ref class RqlReader : public Reader

Members

All Members | Constructors | Methods | Fields | Events
Public Protected | Instance Static | Declared Inherited

Icon | Member | Description
--- | --- | ---
| RqlReader(String, Int32) | Connect to RQL reader on default port (8080)
| _exitNow | Internal flag to "close reader." If true, quit worker thread. (Inherited from Reader.)
| _isPseudoAsyncRead | Internal flag to Check "tag reading type." If true, pseudo async read enabled." (Inherited from Reader.)
| _runNow | Internal flag to enable "tag reading." If true, generate tag reads. If false, stop "reading tags." (Inherited from Reader.)
| CmdGetAvailableProtocols()()() | Get the list of RFID protocols supported by the device.
| CmdGetParam(String) | Get RQL parameter
| CmdSetParam(String, String) | Set RQL parameter
| CmdSetPowerMode(Reader..::.PowerMode) | Set the current power mode of the device.
| Connect()()() | Connect reader object to device. If object already connected, then do nothing. (Overrides Reader.Connect()()().)
| Destroy()()() | Shuts down the connection with the reader device. (Overrides Reader.Destroy()()().)
| DestroyGivenRead()()() | Clean up actions given a working Read method (Inherited from Reader.)
| Dispose(Boolean) | Dispose (Inherited from Reader.)
| Dispose()()() | Dispose (Inherited from Disposable.)
| DoWorkGivenRead()()() | Logic for asynchronous worker thread given a working Read method (Inherited from Reader.)
| Equals(Object) | Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
| ExecuteTagOp(TagOp, TagFilter) | execute a TagOp (Overrides Reader.ExecuteTagOp(TagOp, TagFilter).)
| Finalize()()() | Finalizer (Inherited from Disposable.)
| FirmwareLoad(Stream) | Loads firmware on the Reader. (Overrides Reader.FirmwareLoad(Stream).)
| FirmwareLoad(Stream, FirmwareLoadOptions) | Loads firmware on the Reader. (Overrides Reader.FirmwareLoad(Stream, FirmwareLoadOptions).)
| GetFirstConnectedAntenna()()() | Pick first available connected antenna (Inherited from Reader.)
| GetFirstSupportedProtocol()()() | Pick first available supported protocol (Inherited from Reader.)
| GetHashCode()()() | Serves as a hash function for a particular type. (Inherited from Object.)
| GetType()()() | Gets the Type of the current instance. (Inherited from Object.)
| GpiGet()()() | Get the state of all of the reader's GPI pins. (Overrides Reader.GpiGet()()().)
| GpoSet(ICollection<(Of <(GpioPin>)>)) | Set the state of some GPO pins. (Overrides Reader.GpoSet(ICollection<(Of <(GpioPin>)>)).)
| isDutyCycleFlag | To enable module duty cycle (Inherited from Reader.)
| isFastSearch | Fast search enable (Inherited from Reader.)
| Iso180006bLockTag(TagFilter, Byte) | Obsolete. Lock a byte of memory on an ISO180006B tag
| KillTag(TagFilter, TagAuthentication) | Kill a tag. The first tag seen is killed. (Overrides Reader.KillTag(TagFilter, TagAuthentication).)
| LoadConfig(String) | Loads the reader configuration parameters from file and applies to module (Inherited from Reader.)
| LockTag(TagFilter, TagLockAction) | Perform a lock or unlock operation on a tag. The first tag seen is operated on - the singulation parameter may be used to control this. Note that a tag without an access password set may not accept a lock operation or remain locked. (Overrides Reader.LockTag(TagFilter, TagLockAction).)
| Log | Occurs when debug log message is generated (Inherited from Reader.)
| MemberwiseClone()()() | Creates a shallow copy of the current Object. (Inherited from Object.)
| notifyExceptionListeners(ReaderException) | Convenience method for delivering reader exceptions to listeners (Inherited from Reader.)
| OnLog(String) | Generate a debug log message (Inherited from Reader.)
| OnReadAuthentication(TagReadData) | Reader Authentication message event. (Inherited from Reader.)
| OnStatsRead(ReaderStatsReport) | Reader Stats message event (Inherited from Reader.)
| OnStatusRead(array<StatusReport>[]()[]) | Reader Status message event (Inherited from Reader.)
| OnTagRead(TagReadData) | Internal accessor to TagRead event. Called by members of the Reader class to fire a TagRead event. (Inherited from Reader.)
| OnTransport(Boolean, array<Byte>[]()[], Int32) | Fire Transport message event (Inherited from Reader.)
| ParamAdd(Reader..::.Setting) | Register a new parameter handler (Inherited from Reader.)
| ParamClear()()() | Reset parameter table; e.g., to reprobe hardware afer firmware update (Inherited from Reader.)
| ParamGet(String) | Get the value of a Reader parameter. (Inherited from Reader.)

ParamList()()()

Get a list of the parameters available

Supported Parameters:

- /reader/antenna/checkPort
- /reader/antenna/checkport
- /reader/antenna/connectedPortList
- /reader/antenna/portList
- /reader/antenna/portSwitchGpos
- /reader/antenna/portSwitchGpos not supported
- /reader/antenna/portswitchgpos
- /reader/antenna/returnLoss
- /reader/antenna/settlingTimeList
- /reader/antenna/settlingtimelist
- /reader/antenna/txRxMap
- /reader/antenna/txrxmap
- /reader/antennaMode
- /reader/baudRate
- /reader/commandTimeout
- /reader/currentTime
- /reader/description
- /reader/extendedEpc
- /reader/extendedepc
- /reader/gen2/BLF
- /reader/gen2/accessPassword
- /reader/gen2/accesspassword
- /reader/gen2/bap
- /reader/gen2/blf
- /reader/gen2/protocolExtension
- /reader/gen2/protocolextension
- /reader/gen2/q
- /reader/gen2/session
- /reader/gen2/t4
- /reader/gen2/tagEncoding
- /reader/gen2/tagencoding
- /reader/gen2/target
- /reader/gen2/target not supported
- /reader/gen2/tari
- /reader/gen2/writeEarlyExit
- /reader/gen2/writeMode
- /reader/gen2/writeReplyTimeout
- /reader/gen2/writeearlyexit
- /reader/gen2/writemode
- /reader/gpio/inputList
- /reader/gpio/inputlist
- /reader/gpio/outputList
- /reader/gpio/outputlist
- /reader/hostname
- /reader/iso180006b/BLF
- /reader/iso180006b/blf
- /reader/iso180006b/delimiter
- /reader/iso180006b/modulationDepth
- /reader/iso180006b/modulationdepth
- /reader/licenseKey
- /reader/manageLicenseKey
- /reader/metadata
- /reader/metadata\
- /reader/powerMode
- /reader/powermode
- /reader/probeBaudRates
- /reader/probebaudrates
- /reader/radio/enablePowerSave
- /reader/radio/enableSJC
- /reader/radio/enablepowersave
- /reader/radio/enablesjc
- /reader/radio/portReadPowerList
- /reader/radio/portWritePowerList
- /reader/radio/portreadpowerlist
- /reader/radio/portwritepowerlist
- /reader/radio/powerMax
- /reader/radio/powerMin
- /reader/radio/readPower
- /reader/radio/temperature
- /reader/radio/writePower
- /reader/read/asyncOffTime
- /reader/read/asyncOnTime
- /reader/read/plan
- /reader/read/trigger/gpi
- /reader/region/hopTable
- /reader/region/hopTime
- /reader/region/hoptable
- /reader/region/id
- /reader/region/lbt/enable
- /reader/region/minimumFrequency
- /reader/region/quantizationStep
- /reader/region/supportedRegions
- /reader/statistics
- /reader/stats
- /reader/stats is not supported
- /reader/stats/enable
- /reader/stats/enable is not supported
- /reader/status/antennaEnable
- /reader/status/antennaenable
- /reader/status/frequencyEnable
- /reader/status/frequencyenable
- /reader/status/temperatureEnable
- /reader/status/temperatureenable
- /reader/tagReadData/enableReadFilter
- /reader/tagReadData/readFilterTimeout
- /reader/tagReadData/recordHighestRssi
- /reader/tagReadData/reportRssiInDbm
- /reader/tagReadData/tagopFailures
- /reader/tagReadData/tagopSuccesses
- /reader/tagReadData/uniqueByAntenna
- /reader/tagReadData/uniqueByData
- /reader/tagReadData/uniqueByProtocol
- /reader/tagop/antenna
- /reader/tagop/protocol
- /reader/tagreaddata/enablereadfilter
- /reader/tagreaddata/recordhighestrssi
- /reader/tagreaddata/reportrssiIndbm
- /reader/tagreaddata/reportrssiindbm
- /reader/tagreaddata/uniquebyantenna
- /reader/tagreaddata/uniquebydata
- /reader/tagreaddata/uniquebyprotocol
- /reader/transportTimeout
- /reader/uri
- /reader/userConfig
- /reader/userMode
- /reader/usermode
- /reader/version/hardware
- /reader/version/model
- /reader/version/productGroup
- /reader/version/productGroupID
- /reader/version/productID
- /reader/version/serial
- /reader/version/software
- /reader/version/supportedProtocols

(Inherited from Reader.)

| ParamSet(String, Object) | Set the value of a Reader parameter. (Inherited from Reader.)
| QueueTagReads(ICollection<(Of <(TagReadData>)>)) | Submit tag reads for read listener background processing (Inherited from Reader.)
| Read(Int32) | Read RFID tags for a fixed duration. (Overrides Reader.Read(Int32).)
| ReadAuthentication | Occurs when 0x604 error is received which indicates the api is waiting for the client to provide the accesspassword of tag. (Inherited from Reader.)
| ReadException | Occurs when asynchronous read throws an exception. (Inherited from Reader.)
| ReadGivenStartStop(Int32) | Utility function to implement Read given working StartReading and StopReading methods (Inherited from Reader.)
| ReadTagMemBytes(TagFilter, Int32, Int32, Int32) | Read data from the memory bank of a tag. (Overrides Reader.ReadTagMemBytes(TagFilter, Int32, Int32, Int32).)
| ReadTagMemWords(TagFilter, Int32, Int32, Int32) | Read data from the memory bank of a tag. (Overrides Reader.ReadTagMemWords(TagFilter, Int32, Int32, Int32).)
| ReadTagMemWordsGivenReadTagMemBytes(TagFilter, Int32, Int32, Int32) | Implement ReadTagMemWords in terms of ReadTagMemBytes (Inherited from Reader.)
| Reboot()()() | Reboots the reader device (Overrides Reader.Reboot()()().)
| ReceiveAutonomousReading()()() | Receives data from module continuously (Overrides Reader.ReceiveAutonomousReading()()().)
| SaveConfig(String) | Saves the current reader configuration parameters and its values to a file (Inherited from Reader.)
| SimpleTransportListener(Object, TransportListenerEventArgs) | Simple console-output transport listener (Overrides Reader.SimpleTransportListener(Object, TransportListenerEventArgs).)
| StartReading()()() | Start reading RFID tags in the background. The tags found will be passed to the registered read listeners, and any exceptions that occur during reading will be passed to the registered exception listeners. Reading will continue until stopReading() is called. (Overrides Reader.StartReading()()().)
| StartReadingGivenRead()()() | Utility function to implement StartReading given a working Read method (Inherited from Reader.)
| statFlag | Cache reader stats flag (Inherited from Reader.)
| StatsListener | Occurs when reader status parsing in continuous read (Inherited from Reader.)
| StatusListener | Occurs when reader status parsing in continuous read (Inherited from Reader.)
| StopReading()()() | Stop reading RFID tags in the background. (Overrides Reader.StopReading()()().)
| StopReadingGivenRead()()() | Utility function to implement StopReading given a working Read method (Inherited from Reader.)
| TagRead | Occurs when each tag is read. (Inherited from Reader.)
| timeEnd | Get the time elapsed for processing the tagread data (Inherited from Reader.)
| timeStart | Get the time elapsed for processing the tagread data (Inherited from Reader.)
| ToString()()() | Returns a String that represents the current Object. (Inherited from Object.)
| Transport | Transport message was sent or received (Inherited from Reader.)
| userTransportTimeoutEnable | In case user specified the timeout value for connect Enable the userTransportTimeoutEnable option (Inherited from Reader.)
| ValidateParameterKey(String) | Check for existence of parameter. Throw exception if parameter does not exist. (Inherited from Reader.)
| ValidateProtocol(TagProtocol) | Is requested protocol a valid protocol? (Inherited from Reader.)
| WriteTag(TagFilter, TagData) | Write a new ID to a tag. (Overrides Reader.WriteTag(TagFilter, TagData).)
| WriteTagMemBytes(TagFilter, Int32, Int32, ICollection<(Of <(Byte>)>)) | Write data to the memory bank of a tag. (Overrides Reader.WriteTagMemBytes(TagFilter, Int32, Int32, ICollection<(Of <(Byte>)>)).)
| WriteTagMemWords(TagFilter, Int32, Int32, ICollection<(Of <(UInt16>)>)) | Write data to the memory bank of a tag. (Overrides Reader.WriteTagMemWords(TagFilter, Int32, Int32, ICollection<(Of <(UInt16>)>)).)

Inheritance Hierarchy

Object
| Disposable
|  | Reader
|  |  | RqlReader

Assembly: MercuryAPI (Module: MercuryAPI) Version: 1.29.4.34 (1.29.4.34)