Mercury API
Reader Class
Namespaces ► ThingMagic ► Reader
Abstract base class for ThingMagic RFID reader devices.
Declaration Syntax

C# | Visual Basic | Visual C++

    public abstract class Reader : Disposable

    Public MustInherit Class Reader _
    	Inherits Disposable

    public ref class Reader abstract : public Disposable

Members

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

Icon | Member | Description
--- | --- | ---
| Reader()()() | Initializes a new instance of the Reader class
| _exitNow | Internal flag to "close reader." If true, quit worker thread.
| _isPseudoAsyncRead | Internal flag to Check "tag reading type." If true, pseudo async read enabled."
| _runNow | Internal flag to enable "tag reading." If true, generate tag reads. If false, stop "reading tags."
| Connect()()() | Connect reader object to device. If object already connected, then do nothing.
| connectionErrors | string to append connect time network reader error messages
| Create(String) | Return an instance of a Reader class associated with a serial reader on a particular communication port.
| debug | Debug log object for Reader and subclasses
| Destroy()()() | Shuts down the connection with the reader device.
| DestroyGivenRead()()() | Clean up actions given a working Read method
| Dispose(Boolean) | Dispose (Overrides Disposable.Dispose(Boolean).)
| Dispose()()() | Dispose (Inherited from Disposable.)
| DoWorkGivenRead()()() | Logic for asynchronous worker thread given a working Read method
| Equals(Object) | Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
| ExecuteTagOp(TagOp, TagFilter) | execute a TagOp
| Finalize()()() | Finalizer (Inherited from Disposable.)
| FirmwareLoad(Stream) | Load a new firmware image into the device's nonvolatile memory. This installs the given image data onto the device and restarts it with that image. The firmware must be of an appropriate type for the device. Interrupting this operation may damage the reader.
| FirmwareLoad(Stream, FirmwareLoadOptions) | Load a new firmware image into the device's nonvolatile memory. This installs the given image data onto the device and restarts it with that image. The firmware must be of an appropriate type for the device. Interrupting this operation may damage the reader.
| GetFirstConnectedAntenna()()() | Pick first available connected antenna
| GetFirstSupportedProtocol()()() | Pick first available supported protocol
| 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.
| GpoSet(ICollection<(Of <(GpioPin>)>)) | Set the state of some GPO pins.
| isDutyCycleFlag | To enable module duty cycle
| isFastSearch | Fast search enable
| IsMember<(Of <(T>)>)(T, array<T>[]()[]) | Is requested value a valid value?
| KillTag(TagFilter, TagAuthentication) | Kill a tag. The first tag seen is killed.
| LoadConfig(String) | Loads the reader configuration parameters from file and applies to module
| 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.
| Log | Occurs when debug log message is generated
| MemberwiseClone()()() | Creates a shallow copy of the current Object. (Inherited from Object.)
| notifyExceptionListeners(ReaderException) | Convenience method for delivering reader exceptions to listeners
| OnLog(String) | Generate a debug log message
| OnReadAuthentication(TagReadData) | Reader Authentication message event.
| OnStatsRead(ReaderStatsReport) | Reader Stats message event
| OnStatusRead(array<StatusReport>[]()[]) | Reader Status message event
| OnTagRead(TagReadData) | Internal accessor to TagRead event. Called by members of the Reader class to fire a TagRead event.
| OnTransport(Boolean, array<Byte>[]()[], Int32) | Fire Transport message event
| ParamAdd(Reader..::.Setting) | Register a new parameter handler
| ParamClear()()() | Reset parameter table; e.g., to reprobe hardware afer firmware update
| ParamGet(String) | Get the value of a Reader parameter.

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

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

Inheritance Hierarchy

Object
| Disposable
|  | Reader
|  |  | LlrpReader
|  |  | RqlReader
|  |  | SerialReader

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