Mercury API
SerialReader Class
NamespacesThingMagicSerialReader
The SerialReader class is an implementation of a Reader object that communicates with a ThingMagic embedded RFID module via the embedded module serial protocol. In addition to the Reader interface, direct access to the commands of the embedded module serial protocol is supported. Instances of the SerialReader class are created with the {@link #com.thingmagic.Reader.create} method with a "eapi" URI or a generic "tmr" URI that references a local serial port.
Declaration Syntax
C#Visual BasicVisual C++
public sealed class SerialReader : Reader
Public NotInheritable Class SerialReader _
	Inherits Reader
public ref class SerialReader sealed : public Reader
Members
All MembersConstructorsMethodsPropertiesFieldsEvents



IconMemberDescription
SerialReader(String)
Make a serial reader with default transport

SerialReader(String, SerialTransport)
Connect to a reader

_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.)
CmdAntennaDetect()()()
Enumerate the logical antenna ports and report the antenna detection status of each one.

CmdAuthReqResponse(UInt32)
Send new message to tag with secure accesspassword corresponding with tag epc

CmdBlockPermaLock(UInt16, Byte, Gen2..::.Bank, UInt32, Byte, array<UInt16>[]()[], UInt32, TagFilter) Obsolete.
BlockPermaLock

CmdBlockWrite(UInt16, Gen2..::.Bank, UInt32, Byte, array<UInt16>[]()[], UInt32, TagFilter) Obsolete.
BlockWrite command

CmdBootBootloader()()()
Quit running the application and execute the bootloader. Note that this changes the reader's baud rate to 9600; the user is responsible for changing the local serial sort speed.

CmdBootFirmware()()()
Tell the boot loader to verify the application firmware and execute it.

CmdClearTagBuffer()()() Obsolete.
Clear the tag buffer.

CmdEraseFlash(Byte, UInt32)
Erase a sector of the device's flash.

CmdGen2LockTag(UInt16, UInt16, UInt16, UInt32, TagFilter) Obsolete.
Lock a Gen2 tag

CmdGen2ReadTagData(UInt16, SerialReader..::.TagMetadataFlag, Gen2..::.Bank, UInt32, Byte, UInt32, TagFilter) Obsolete.
Read the memory of a Gen2 tag.

CmdGen2WriteTagData(UInt16, Gen2..::.Bank, UInt32, array<Byte>[]()[], UInt32, TagFilter) Obsolete.
Write data to a Gen2 tag.

CmdGetAntennaConfiguration()()()
Get the current Tx and Rx antenna port, the number of physical ports, and a list of ports where an antenna has been detected.

CmdGetAntennaPortPowers()()()
Gets the transmit powers of each antenna port.

CmdGetAntennaPortPowersAndSettlingTime()()()
Gets the transmit powers and settling time of each antenna port.

CmdGetAntennaReturnLoss()()()
Gets the antenna return loss of logical antenna ports.

CmdGetAntennaSearchList()()()
Gets the search list of logical antenna ports.

CmdGetAvailableProtocols()()()
Get the list of RFID protocols supported by the device.

CmdGetAvailableRegions()()()
Get the list of regulatory regions supported by the device.

CmdGetCurrentProgram()()()
Return the identity of the program currently running on the device (bootloader or application).

CmdGetFrequencyHopTable()()()
Gets the frequencies in the current hop table

CmdGetFrequencyHopTime()()()
Gets the interval between frequency hops.

CmdGetGen2WriteResponseWaitTime()()()
Parse get gen2 writeresponse wait time response

CmdGetGpio()()() Obsolete.
Gets the state of the device's GPIO pins.

CmdGetGPIODirection(Int32) Obsolete.
Get direction of a single GPIO pin

CmdGetHardwareVersion(Byte, Byte)
Get a block of hardware version information. This information is an opaque data block.

CmdGetMinimumFrequency()()()
Gets the interval between frequency hops.

CmdGetPowerMode()()()
Gets the current power mode of the device.

CmdGetProtocol()()()
Get the current RFID protocol the device is configured to use.

CmdGetProtocolConfiguration(TagProtocol, SerialReader..::.ProtocolConfiguration)
Gets the value of a protocol configuration setting.

CmdGetQuantizationStep()()()
Gets the interval between frequency hops.

CmdGetReadTxPower()()()
Get the current global Tx power setting for read operations.

CmdGetReadTxPowerWithLimits()()()
Get the current global Tx power setting for read operations, and the minimum and maximum power levels supported.

CmdGetRegion()()()
Gets the current region the device is configured to use.

CmdGetRegionConfiguration(SerialReader..::.RegionConfiguration)
Get the value of a region-specific configuration setting.

CmdGetSectorSize(Byte)
Return the size of a flash sector of the device.

CmdGetSerialNumber()()()
Get reader serial number

CmdGetTagBuffer(UInt16, Boolean, TagProtocol) Obsolete.
Get tag data of a number of tags from the tag buffer. This command moves a read index into the tag buffer, so that repeated calls will fetch all of the tags in the buffer.

CmdGetTagBuffer(UInt16, UInt16, Boolean, TagProtocol) Obsolete.
Get tag data of a tags from certain locations in the tag buffer, without updating the read index.

CmdGetTagBuffer(SerialReader..::.TagMetadataFlag, Boolean, TagProtocol) Obsolete.
Get tag data and associated read metadata from the tag buffer.

CmdGetTagsRemaining()()() Obsolete.
Get the number of tags stored in the tag buffer

CmdGetTemperature()()()
Get the current temperature of the device.

CmdGetTxRxPorts()()()
Get the currently set Tx and Rx antenna port.

CmdGetUserMode()()()
Gets the current user mode of the device.

cmdGetUserProfile(array<Byte>[]()[])
Get the configurations from flash.

CmdGetWriteTxPower()()()
Get the current global Tx power setting for write operations.

CmdGetWriteTxPowerWithLimits()()()
Get the current global Tx power setting for write operations, and the minimum and maximum power levels supported.

CmdHibikiBlockLock(UInt16, UInt32, Byte, UInt32, Byte, Byte) Obsolete.
Send the Hitachi Hibiki Block Lock command.

CmdHibikiBlockReadLock(UInt16, UInt32, Byte, UInt32, Byte, Byte) Obsolete.
Send the Hitachi Hibiki Block Read Lock command.

CmdHibikiGetSystemInformation(UInt16, UInt32) Obsolete.
Send the Hitachi Hibiki Get System Information command.

CmdHibikiReadLock(UInt16, UInt32, Byte, Byte) Obsolete.
Send the Hitachi Hibiki Read Lock command.

CmdHibikiSetAttenuate(UInt16, UInt32, Byte, Byte) Obsolete.
Send the Hitachi Hibiki Set Attenuate command.

CmdHibikiWriteMultipleWords(UInt16, UInt32, Gen2..::.Bank, UInt32, ICollection<(Of <(Byte>)>)) Obsolete.
Send the Hitachi Hibiki Write Multiple Words Lock command.

CmdIso180006bLockTag(UInt16, Byte, TagFilter) Obsolete.
Lock a byte of memory on an ISO180006B tag

CmdIso180006bReadTagData(UInt16, Byte, Byte, TagFilter) Obsolete.
Read the memory of an ISO180006B tag.

CmdIso180006bWriteTagData(UInt16, Byte, array<Byte>[]()[], TagFilter) Obsolete.
Write data to an ISO180006B tag.

CmdKillTag(UInt16, UInt32, TagFilter) Obsolete.
Kill a Gen2 tag.

CmdModifyFlash(Byte, UInt32, UInt32, Int32, array<Byte>[]()[], Int32)
Write data to the device's flash, erasing if necessary.

CmdMultiProtocolSearch(SerialReader..::.CmdOpcode, List<(Of <(SimpleReadPlan>)>), SerialReader..::.TagMetadataFlag, SerialReader..::.AntennaSelection, UInt16)
lv3 command supporting multiple protocol search

CmdRaw(Int32, array<Byte>[]()[])
Send a raw message to the serial reader.@throws ReaderCommException in the event of a timeout (failure to receive a complete message in the specified time) or a CRC error.Does not generate exceptions for non-zero status responses.This function not intended for general use.If you really need to use raw reader commands, see the source for further instructions.

CmdReadFlash(Byte, UInt32, Byte)
Read the contents of flash from the specified address in the specified flash sector.

CmdReadTagAndDataReadMultiple(UInt16, SerialReader..::.AntennaSelection, TagFilter, UInt32, Gen2..::.Bank, UInt32, Byte) Obsolete.
Search for tags for a specified amount of time and read data from each one.

CmdReadTagAndDataWriteMultiple(UInt16, SerialReader..::.AntennaSelection, TagFilter, UInt32, Gen2..::.Bank, UInt32, ICollection<(Of <(Byte>)>)) Obsolete.
Search for tags for a specified amount of time and write data to each one.

CmdReadTagAndKillMultiple(UInt16, SerialReader..::.AntennaSelection, TagFilter, UInt32, UInt32) Obsolete.
Search for tags for a specified amount of time and kill each one.

CmdReadTagAndLockMultiple(UInt16, SerialReader..::.AntennaSelection, TagFilter, UInt32, UInt16, UInt16) Obsolete.
Search for tags for a specified amount of time and lock each one.

CmdReadTagMultiple(UInt16, SerialReader..::.AntennaSelection, TagFilter, TagProtocol) Obsolete.
Search for tags for a specified amount of time.

CmdReadTagSingle(UInt16, SerialReader..::.TagMetadataFlag, TagFilter, TagProtocol) Obsolete.
Search for a single tag for up to a specified amount of time.

CmdResetReaderStatistics(SerialReader..::.ReaderStatisticsFlag) Obsolete.
Reset the per-port statistics.

CmdSetAntennaPortPowers(array<array<UInt16>[]()[]>[]()[])
Sets the transmit powers of each antenna port. Note that setting a power level to 0 will cause the corresponding global power level to be used. Port numbers range from 1-255; power levels range from 0-65535.

CmdSetAntennaPortPowersAndSettlingTime(array<array<Int16>[]()[]>[]()[])
Sets the transmit powers and settling times of each antenna port. Note that setting a power level to 0 will cause the corresponding global power level to be used. Port numbers range from 1-255; power levels range from 0-65535; settling time ranges from 0-65535.

CmdSetAntennaSearchList(array<array<Byte>[]()[]>[]()[])
Sets the search list of logical antenna ports. Port numbers range from 1-255.

CmdSetBaudRate(UInt32)
Tell the device to change the baud rate it uses for communication. Note that this does not affect the host side of the serial interface; it will need to be changed separately.

CmdSetFrequencyHopTable(array<UInt32>[]()[])
Set the frequency hop table.

CmdSetFrequencyHopTime(UInt32)
Set the interval between frequency hops. The valid range for this interval is region-dependent.

CmdSetGen2WriteResponseWaitTime(Object, Object)
Set gen2 writeresponse wait time

CmdSetGpio(Byte, Boolean) Obsolete.
Set the state of a single GPIO pin

CmdSetGPIODirection(Int32, Boolean) Obsolete.
Set direction of a single GPIO pin

CmdSetMinimumFrequency(UInt32)
Set Minimum frequency value.

CmdSetPowerMode(Reader..::.PowerMode)
Set the current power mode of the device.

CmdSetProtocol(TagProtocol)
Set the current RFID protocol for the device to use.

CmdSetProtocolConfiguration(TagProtocol, SerialReader..::.ProtocolConfiguration, Object)
Set Protocol Configuration.

CmdSetProtocolLicenseKey(ICollection<(Of <(Byte>)>))
set protocol license key

CmdSetProtocolLicenseKey(ICollection<(Of <(Byte>)>), Reader..::.LicenseOption)
set protocol license key

CmdSetQuantizationStep(UInt32)
Set Quantization step value.

CmdSetReaderConfiguration(SerialReader..::.Configuration, Object)
Sets the value of a device configuration setting.

CmdSetReadTxPower(Int16)
Set the current global Tx power setting for read operations.

CmdSetRegion(Reader..::.Region)
Set the current regulatory region for the device. Resets region-specific configuration, such as the frequency hop table.

CmdSetRegionLbt(Reader..::.Region, Boolean)
Set the current regulatory region for the device. Resets region-specific configuration, such as the frequency hop table.

CmdSetTxRxPorts(Int32, Int32)
Sets the Tx and Rx antenna port. Port numbers range from 1-255.

CmdSetUserMode(SerialReader..::.UserMode)
Set the current user mode of the device.

CmdSetUserProfile(SerialReader..::.UserConfigOperation, SerialReader..::.UserConfigCategory, SerialReader..::.UserConfigType)
Save/Restore/Verify/Clear the configurations.

CmdSetWriteTxPower(Int16)
Set the current global Tx power setting for write operations.

CmdTestSendCw(Boolean)
Turn CW transmission on or off. Testing command.

CmdTestSendPrbs(UInt16)
Turn on pseudo-random bit _stream transmission for a particular duration. Testing command.

CmdTestSetFrequency(UInt32)
Set the operating frequency of the device. Testing command.

CmdVerifyImage()()()
Verify that the application image in flash has a valid checksum. The device will report an invalid checksum with a error code response, which would normally generate a ReaderCodeException; this routine traps that particular exception and simply returns "false".

CmdVersion()()()
Get the version information about the device.

CmdWriteFlash(Byte, UInt32, UInt32, Int32, array<Byte>[]()[], Int32)
Write data to a previously erased region of the device's flash.

CmdWriteTagEpc(UInt16, array<Byte>[]()[], Boolean) Obsolete.
Write the EPC of a tag and update the PC bits. Behavior is unspecified if more than one tag can be found.

CmdWriteTagEpc(UInt16, array<Byte>[]()[], Boolean, UInt32, TagFilter) Obsolete.
Write the EPC of a tag and update the PC bits. Behavior is unspecified if more than one tag can be found.

Connect()()()
Connect reader object to device. If object already connected, then do nothing.
(Overrides Reader.Connect()()().)
DebugMode(Int32)
Select debugging level

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.)
executeEmbeddedRead(List<(Of <(Byte>)>), UInt16)
Execute the embedded command

ExecuteTagOp(TagOp, TagFilter)
execute a TagOp
(Overrides Reader.ExecuteTagOp(TagOp, TagFilter).)
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.
(Overrides Reader.FirmwareLoad(Stream).)
FirmwareLoad(Stream, FirmwareLoadOptions)
Loads firmware on the Reader.
(Overrides Reader.FirmwareLoad(Stream, FirmwareLoadOptions).)
FromSL900aTime(UInt32)
Convert SL900A time to DateTime

GetFirstConnectedAntenna()()()
Pick first available connected antenna
(Inherited from Reader.)
GetFirstSupportedProtocol()()()
Pick first available supported protocol
(Inherited from Reader.)
getGPIODirection(Boolean)
Get directions of all GPIO pins

GetHashCode()()()
Serves as a hash function for a particular type.
(Inherited from Object.)
GetTagReads(Int32, TagProtocol)
Fetch tag reads from buffer using as many commands as necessary (not limited by capacity of a single command)

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.)
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.)
msgAddGEN2BlockPermaLock(List<(Of <(Byte>)>)%, UInt16, Byte, Gen2..::.Bank, UInt32, Byte, array<UInt16>[]()[], UInt32, TagFilter) Obsolete.
BlockPermaLock

msgAddGEN2BlockWrite(List<(Of <(Byte>)>)%, UInt16, Gen2..::.Bank, UInt32, array<UInt16>[]()[], UInt32, TagFilter) Obsolete.
assemble the embedded command for BlockWrite

msgAddGEN2DataRead(List<(Of <(Byte>)>)%, UInt16, Gen2..::.Bank, UInt32, Byte, Gen2..::.SecureTagType) Obsolete.
Assemble the embedded command for DataRead

msgAddGEN2DataWrite(List<(Of <(Byte>)>)%, UInt16, Gen2..::.Bank, UInt32, array<UInt16>[]()[]) Obsolete.
Assemble the embedded command for DataWrite

msgAddGEN2KillTag(List<(Of <(Byte>)>)%, UInt16, UInt32) Obsolete.
Assemble the embedded command for Kill

msgAddGEN2LockTag(List<(Of <(Byte>)>)%, UInt16, UInt32, UInt16, UInt16) Obsolete.
Assemble the embedded command for Lock

msgAddGEN2WriteTagEPC(List<(Of <(Byte>)>)%, UInt16, TagData)
WriteTagEpc

msgSetupmultiProtocolSearch(SerialReader..::.CmdOpcode, List<(Of <(SimpleReadPlan>)>), SerialReader..::.TagMetadataFlag, SerialReader..::.AntennaSelection, UInt16)
lv3 command supporting multiple protocol search

msgSetupReadTagMultiple(UInt16, SerialReader..::.AntennaSelection, TagFilter, TagProtocol, SerialReader..::.TagMetadataFlag, Int32) Obsolete.
Assembly ReadTagMultiple Cmd bytes

msgSetupReadTagSingle(SerialReader..::.TagMetadataFlag, TagFilter, UInt16) Obsolete.
Assembly ReadTagSignle Cmd bytes

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.)
OpenSerialPort(String, Int32%)
Initializes Reader Serial Port.

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.)
PortName
Name of serial port (for informational purposes only -- Do not expose to user unless absolutely necessary)

PrepForTagop()()()
Configure reader for synchronous tag operation (e.g., set appropriate protocol and antenna)

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.)
SetComPort(String)
Select serial port

setGPIODirection(Boolean, array<Int32>[]()[])
Set directions of all GPIO pins

SetSerialBaudRate(Int32)
Set the baud rate of the serial port in use. NOTE: This is a low-level command and should only be used in conjunction with CmdSetBaudRate() or CmdBootBootloader() below. For changing the rate used by the API in general, see the "/reader/baudRate" parameter.

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.)
ToSL900aTime(DateTime)
Convert DateTime to SL900A time

ToString()()()
Returns a String that represents the current Object.
(Inherited from Object.)
Transport
Transport message was sent or received
(Inherited from Reader.)
userMeta
Metadata flags

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
  SerialReader

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