mpr dll.xml

WJ Communications RFID example code

        </member>
        <member name="P:WJ.MPR.Reader.MPRMsg.RxFrames">
            <summary>
            A list of Response Frames.
            A single response could be composed of multiple "InProgress" Frames,
            but always a single "Complete" Frame.
            </summary>
        </member>
        <member name="P:WJ.MPR.Reader.MPRMsg.Error">
            <summary>
            Any ErrorCode associated with this MPRMsg.
            If none, then ErrorCode.NoError.
            ErrorCodes are returned when the Status Byte
            of a response Frame = StatusCode.Error (0xFF).
            </summary>
        </member>
        <member name="P:WJ.MPR.Reader.MPRMsg.Status">
            <summary>
            The Response Status of this MPRMsg:
            NoStatus, MsgRcvd, OK, or the source of an error condition.
            <see cref="T:WJ.MPR.Reader.RspStatus"/>
            </summary>
        </member>
        <member name="P:WJ.MPR.Reader.MPRMsg.DataBytes">
            <summary>
            The accumulated bytes of all Response Frames.
            </summary>
        </member>
        <member name="P:WJ.MPR.Reader.MPRMsg.MsgID">
            <summary>
            A static running total of all MPRMsgs sent since the first 
            MPRMsg was instantiated.
            </summary>
        </member>
        <member name="T:WJ.MPR.Reader.MPRReader">
            <summary>
            	This is the main class instantiated by Applications.
            	- Manages a single WJ Multi-Protocol Reader.
            	- Provides properties and methods for accessing features of the MPR.
            	- Talks to the MPR via an MPRComm object.
            	- Generates request frame payloads for MPR API commands.
            	- Parses response frame payloads from MPR API commands.
            	- Fires events when MPR public properties change
            	- Manages an Inventory of Tags in the MPRs field of view.
            	- Inventory can consist of Class 0, Class 1 and/or Gen 2 tags.
            	- Periodically polls the MPR for its current Inventory to:
            		1) add new tags when found
            		2) expire old tags
            	- Old Tags are expired if they have not been seen for at least "PersistTime"
            	- InventoryUpdateGap is how long to wait between inventory requests to the MPR.
            	- Has methods to enable bootloading new FW to the MPR.
            	- Exposes MPR methods to Read/Program/Erase/Kill/Lock for 3 EPC Tag standards.
            </summary>
        </member>
        <member name="M:WJ.MPR.Reader.MPRReader.#ctor">
            <summary>
            Construct a new MPRReader.
            </summary>
        </member>
        <member name="M:WJ.MPR.Reader.MPRReader.Connect(System.String,System.String)">
            <summary>
            Destroys any existing connection, 
            then starts the attempt to connect to an MPR at the requested Serial Port and Baud Rate.
            </summary>
            <param name="SerialPortName">"COMx" style serial port name</param>
            <param name="BaudRate">The Baud Rate at which to connect (usually 57600)</param>
            <returns>Whether an MPR was found at requested Port and BaudRate</returns>
        </member>
        <member name="M:WJ.MPR.Reader.MPRReader.Connect">
            <summary>
            Connect using the last (or default) SerialPortName and BaudRate
            </summary>
            <returns>Whether an MPR was found at default Port and BaudRate</returns>
        </member>
        <member name="M:WJ.MPR.Reader.MPRReader.ConnectBL(System.String,System.String)">
            <summary>
            Destroys any existing connection, 
            then starts the attempt to connect to an MPR at the requested Serial Port and Baud Rate.
            </summary>
            <param name="SerialPortName">"COMx" style serial port name</param>
            <param name="BaudRate">The Baud Rate at which to connect (usually 57600)</param>
            <returns>Whether an MPR was found at requested Port and BaudRate</returns>
        </member>
        <member name="M:WJ.MPR.Reader.MPRReader.ConnectBL">
            <summary>
            Connect to the MPR's bootloader, using the current serial port, 
            and default (115200) baud rate.
            </summary>
            <returns></returns>
        </member>
        <member name="M:WJ.MPR.Reader.MPRReader.Disconnect">
            <summary>
            Disable Inventory Timer and close MPRComm.
            </summary>
        </member>
        <member name="M:WJ.MPR.Reader.MPRReader.Suspend">
            <summary>
            Close MPRComm, but record that we should reconnect on Resume.
            </summary>
        </member>
        <member name="M:WJ.MPR.Reader.MPRReader.Resume">
            <summary>
            Re-connect to the MPR if we were supposed to (as recorded in Suspend())
            </summary>
        </member>
        <member name="M:WJ.MPR.Reader.MPRReader.Class0PlusRead(WJ.MPR.Reader.TagFilter,System.Byte,System.Byte,WJ.MPR.Util.byteList@)">
            <summary>
            Read bits from a Matrics Class 0+ Tag.
            </summary>
            <param name="filter">a TagFilter specifying the tags to read from.</param>
            <param name="ReadBitCount">How many bits to read.</param>
            <param name="ReadPage">The page to read from.</param>
            <param name="TagBits">A bytelist in which to return the bits read.</param>
            <returns></returns>
        </member>
        <member name="M:WJ.MPR.Reader.MPRReader.Class0PlusWrite(WJ.MPR.Reader.TagFilter,WJ.MPR.Reader.TagFilter,System.Byte,System.Byte,System.Boolean,System.Boolean,System.Boolean,System.Boolean)">
            <summary>
            Write a Row of data to a Matrics Class 0+ Tag.
            </summary>
            <param name="filter">A Filter to match the Tags to write.</param>
            <param name="programData">The bits to write to the Tags.</param>
            <param name="IDPage">The IDPage (ID0-ID15) to Write.</param>
            <param name="StartBit">The bit in the page at which to start writing.</param>
            <param name="eraseFirst">Whether to Erase the IDPage first.</param>
            <param name="lockAfter">Whether to Lock the IDPage after writing.</param>
            <param name="clearTIB">Clear the Traversal Inhibit Bit (ID2 only).</param>
            <param name="setTIB">Set the Traversal Inhibit Bit (ID2 only).</param>
            <returns>The Number of Tags written.</returns>
        </member>
        <member name="M:WJ.MPR.Reader.MPRReader.Class0PlusGlobalRead(System.Byte,System.Byte,WJ.MPR.Util.byteList@)">
            <summary>
            Read bits from a Matrics Class 0+ Tag in global mode.
            </summary>
            <param name="ReadBitCount">Number of bits to read.</param>
            <param name="ReadPage">Page to read from.</param>
            <param name="TagBits">The bits read from the tag.</param>
            <returns></returns>
        </member>
        <member name="M:WJ.MPR.Reader.MPRReader.Class0PlusProgram(WJ.MPR.Reader.TagFilter,System.Boolean,System.Boolean,System.Boolean,System.Boolean)">
            <summary>
            Program an EPC into a Matrics Class0+ tag.
            </summary>
            <param name="programData"></param>
            <param name="eraseFirst"></param>
            <param name="lockAfter"></param>
            <param name="clearTIB"></param>
            <param name="setTIB"></param>
            <returns>0 if error; otherwise # tags programmed.</returns>
        </member>
        <member name="M:WJ.MPR.Reader.MPRReader.Class0PlusErase(WJ.MPR.Reader.TagFilter,System.Byte)">
            <summary>
            Erase a page of a Matrics Class 0+ tag's Internal Tag Memory (ITM).
            </summary>
            <param name="filter">A filter to match the tag ID of the tag to Erase.</param>
            <param name="page">The page (0-15) to erase.</param>
            <returns>1 if successful; otherwise 0</returns>
        </member>
        <member name="M:WJ.MPR.Reader.MPRReader.Class0ZumaProgramEPC(WJ.MPR.Reader.ZumaProgramOptions,WJ.MPR.Util.byteList,WJ.MPR.Util.byteList)">
            <summary>
            Zuma subcommand to Program an EPC and KillPasscode into a tag.
            </summary>
            <param name="options"></param>
            <param name="tagID"></param>
            <param name="killPasscode"></param>
            <returns></returns>
        </member>
        <member name="M:WJ.MPR.Reader.MPRReader.Class0ZumaRowRead(WJ.MPR.Reader.ZumaRow@,WJ.MPR.Reader.TagFilter)">
            <summary>
            Zuma command to Read a row of data (or Tag ID).
            </summary>
            <param name="row"></param>
            <param name="filter"></param>
            <returns></returns>
        </member>
        <member name="M:WJ.MPR.Reader.MPRReader.Class0ZumaRowWrite(WJ.MPR.Reader.ZumaRow,WJ.MPR.Reader.TagFilter,System.Boolean)">
            <summary>
            Zuma command to Write a row of data (or Tag ID).
            </summary>
            <param name="row"></param>
            <param name="filter"></param>
            <param name="Ack"></param>
            <returns>int : # Tags written</returns>
        </member>
        <member name="M:WJ.MPR.Reader.MPRReader.Class0ZumaInit(WJ.MPR.Reader.TagFilter,System.Boolean)">
            <summary>
            Zuma command to Initialize a tag.
            </summary>
            <param name="filter"></param>
            <param name="SetLock">Whether or not to set the lock bit</param>
            <returns>The number of Tags the responded to the INIT</returns>
        </member>
        <member name="M:WJ.MPR.Reader.MPRReader.Class0Kill(WJ.MPR.Util.byteList,System.UInt32)">
            <summary>
            Kills a Class 0 Tag.
            </summary>
            <param name="TagIDBits">The TagID of the Class 0 tag to Kill.</param>
            <param name="KillPasscode">The 24-bit Passcode of the Class 0 tag to Kill.</param>
            <returns></returns>
        </member>
        <member name="M:WJ.MPR.Reader.MPRReader.Class0Kill(WJ.MPR.Util.byteList,WJ.MPR.Util.byteList)">
            <summary>
            Kill a Class 0 Tag
            </summary>
            <param name="TagIDBits">The 64 or 96 ID bits of a Class 0 tag to kill.</param>
            <param name="KillPasscode">24 bit Kill Passcode of tag to kill.</param>
            <returns></returns>
        </member>
        <member name="M:WJ.MPR.Reader.MPRReader.Class1Kill(WJ.MPR.Util.byteList,System.Byte)">
            <summary>
            Kill Class1 Tag.
            TagID represented as a byteList.
            </summary>
            <param name="TagIDBits">The bits to match to singulate the Tag to kill.</param>
            <param name="Passcode">The Kill Passcode of the Tag to kill.  Must be 8 or 12 bytes long.</param>
            <returns>true if MPR responds as expected; false if invalid TagIDBits.Length, or MPR responds oddly.</returns>
        </member>
        <member name="M:WJ.MPR.Reader.MPRReader.Class1ProgramID(WJ.MPR.Util.byteList,System.Byte,System.Byte)">
            <summary>
            Program Class1 Tag.
            TagID represented as a byteList.
            The kill Passcode is also programmed, and is 1 byte
            </summary>
            <param name="TagID"></param>
            <param name="killPasscode"></param>
            <param name="options"></param>
            <returns></returns>
        </member>
        <member name="M:WJ.MPR.Reader.MPRReader.Class1Write(System.Byte,System.UInt16)">
            <summary>
            Write 16 bits to a Class1 Tag.
            Word Addresses address 16 bits.
            </summary>
            <param name="WordAddress">The word Address.</param>
            <param name="Word">The 16-bit value with which to program the tag.</param>
            <returns>true if MPR responds properly; otherwise false.</returns>
        </member>
        <member name="M:WJ.MPR.Reader.MPRReader.Class1Write(System.Byte,System.Byte,System.Byte)">
            <summary>
            Write 16 bits to a Class1 Tag.
            Word Addresses address 16 bits.
            </summary>
            <param name="WordAddress">The word Address.</param>
            <param name="MSB">Most Significant byte to program the tag.</param>
            <param name="LSB">Least Significant byte to program the tag.</param>
            <returns>true if MPR responds properly; otherwise false.</returns>
        </member>
        <member name="M:WJ.MPR.Reader.MPRReader.Class1Verify">
            <summary>
            Read all bits of a Class1 tag's EPC and CRC.
            </summary>
            <returns>A Class 1 Tag with its data and CRC populated with the read data.  null if no tag read.</returns>
        </member>
        <member name="M:WJ.MPR.Reader.MPRReader.Class1Erase">
            <summary>
            Erase a Class1 Tag.
            Sets all bits of identifier, CRC and Passcode to all 0s.
            </summary>
            <returns>true if MPR Responded properly; otherwise false.</returns>
        </member>
        <member name="M:WJ.MPR.Reader.MPRReader.Gen2Read(System.Byte,System.Byte,System.Byte,System.Byte,System.UInt32,System.Byte,System.UInt16,System.Byte)">
            <summary>
            Read from Gen2 Tag Memory Bank.
            </summary>
            <param name="sel">SL bit set to: SL, Not SL or Either.</param>
            <param name="session">Which session to use for inventory.</param>
            <param name="target">Target tags with session inventoried bit set to A or B.</param>
            <param name="startingQ">Sets Q parameter for first inventory round.</param>
            <param name="accessPassword">32-bit access password.  If none in tag, set to 0x00000000.</param>
            <param name="memBank">Which memory bank to read from.</param>
            <param name="wordPointer">16-bit word address at which to start reading.</param>
            <param name="wordCount">Number of 16-bit words to read.</param>
            <returns>An Inventory of Tags, the Data section of which includes the data which was read.</returns>
        </member>
        <member name="M:WJ.MPR.Reader.MPRReader.Gen2Write(System.Byte,System.Byte,System.Byte,System.Byte,System.UInt32,System.Byte,System.Byte,System.Byte,System.UInt16,System.Byte,WJ.MPR.Util.byteList)">
            <summary>
            Inventory all Tags matching the Selection and Query criteria, and, to each, write data to the requested memory bank. 
            An option selects between using the (optional) Gen 2 Block Write command instead of Write.
            </summary>
            <param name="sel">SL bit set to: SL, Not SL or Either.</param>
            <param name="session">Which session to use for inventory.</param>
            <param name="target">Target tags with session inventoried bit set to A or B.</param>
            <param name="startingQ">Sets Q parameter for first inventory round.</param>
            <param name="accessPassword">32-bit access password.  If none in tag, set to 0x00000000.</param>
            <param name="options">Options specifying whether to use optional BlockWrite or BlockErase.</param>
            <param name="lockOptions">Options specifying whether to lock the memory bank being written.</param>
            <param name="memBank"