mpr dll.xml

WJ Communications RFID example code

<?xml version="1.0"?>
<doc>
    <assembly>
        <name>MPR DLL</name>
    </assembly>
    <members>
        <member name="T:WJ.MPR.Reader.Gen2InventorySettingsStruct">
            <summary>
            Settings for Gen 2 Inventories, as a public struct.
            </summary>
        </member>
        <member name="F:WJ.MPR.Reader.Gen2InventorySettingsStruct.sel">
            <summary>
            Whether to inventory tags with SL bit set or unset or either.
            0x00: ignore SL
            0x01: SL NOT set
            0x02: SL SET
            </summary>
        </member>
        <member name="F:WJ.MPR.Reader.Gen2InventorySettingsStruct.session">
            <summary>
            Which session to use for inventory:
            0x00: S0
            0x01: S1
            0x02: S2
            0x03: S3
            </summary>
        </member>
        <member name="F:WJ.MPR.Reader.Gen2InventorySettingsStruct.target">
            <summary>
            0x00: Only inventory tags with inventoried bit set to A for session.
            0x01: Only inventory tags with inventoried bit set to B for session.
            </summary>
        </member>
        <member name="F:WJ.MPR.Reader.Gen2InventorySettingsStruct.startingQ">
            <summary>
            0-15: Sets the number of slots (=2Q) in the first Inventory Round of the Inventory Algorithm. 
            The starting Q should be chosen higher for a larger expected number of tags in the field.
            </summary>
        </member>
        <member name="M:WJ.MPR.Reader.Gen2InventorySettingsStruct.#ctor(System.Byte,System.Byte,System.Byte,System.Byte)">
            <summary>
            Construct the Gen2InventorySettingsStruct.
            </summary>
            <param name="sel">SL set or not?</param>
            <param name="session">Which session?</param>
            <param name="target">Inventoried flag set to A or B for session.</param>
            <param name="startingQ">Initial Q for first Inventory Round.</param>
        </member>
        <member name="T:WJ.MPR.Reader.TagLengthOptionEnum">
            <summary>
            Inventories can be configured in one of four ways by sending an optional
            TagLengthOption parameter.  If no parameter is required (and for backward compatibility),
            the EPC_NoParam value should be used.
            </summary>
        </member>
        <member name="F:WJ.MPR.Reader.TagLengthOptionEnum.EPC_NoParam">
            <summary>
            Do NOT send a Tag Length Option.
            MPR uses EPC header to determine Tag ID length.
            </summary>
        </member>
        <member name="F:WJ.MPR.Reader.TagLengthOptionEnum.EPC">
            <summary>
            MPR uses EPC header to determine Tag ID length.
            </summary>
        </member>
        <member name="F:WJ.MPR.Reader.TagLengthOptionEnum.Only64">
            <summary>
            MPR assumes all tag IDs are 64 bits (8 bytes).
            </summary>
        </member>
        <member name="F:WJ.MPR.Reader.TagLengthOptionEnum.Only96">
            <summary>
            MPR assumes all tag IDs are 96 bits (12 bytes).
            </summary>
        </member>
        <member name="F:WJ.MPR.Reader.TagLengthOptionEnum.Auto">
            <summary>
            MPR tries to determine length using returned signal and computing CRCs.
            </summary>
        </member>
        <member name="T:WJ.MPR.Reader.TagLengthStyleEnum">
            <summary>
            The Reader returns a Tag Length Style Delimiter before each
            tag if TagLengthOption = Only64, Only96 or Auto.
            This must be parsed to determine length of Tag ID that follows.
            </summary>
        </member>
        <member name="F:WJ.MPR.Reader.TagLengthStyleEnum.TagID64">
            <summary>
            The tag ID that follows is 64 bits = 8 bytes
            </summary>
        </member>
        <member name="F:WJ.MPR.Reader.TagLengthStyleEnum.TagID96">
            <summary>
            The tag ID that follows is 96 bits = 12 bytes
            </summary>
        </member>
        <member name="F:WJ.MPR.Reader.TagLengthStyleEnum.TagID96Ambig">
            <summary>
            The tag ID that follows is 96 bits = 12 bytes, but has an ambiguous CRC
            so it could also be 64 bits.
            </summary>
        </member>
        <member name="T:WJ.MPR.Reader.Inventory">
            <summary>
            A strongly-typed collection of RFIDTag objects.
            </summary>
        </member>
        <member name="M:WJ.MPR.Reader.Inventory.Add(WJ.MPR.Reader.RFIDTag)">
            <summary>
            Add a single value to the list.
            </summary>
            <param name="val">the value to add.</param>
            <returns>Index of newly added element.</returns>
        </member>
        <member name="M:WJ.MPR.Reader.Inventory.IndexOf(WJ.MPR.Reader.RFIDTag)">
            <summary>
            Determines the index of a specific element in the list.
            </summary>
            <param name="val">The element to locate in the list.</param>
            <returns>The index of val if found in the list; otherwise, -1.</returns>
        </member>
        <member name="M:WJ.MPR.Reader.Inventory.Insert(System.Int32,WJ.MPR.Reader.RFIDTag)">
            <summary>
            Inserts an element into the list at the specified Index.
            </summary>
            <param name="Index">The zero-based index at which the value should be inserted.</param>
            <param name="val">The value to insert into the list.</param>
        </member>
        <member name="M:WJ.MPR.Reader.Inventory.Remove(WJ.MPR.Reader.RFIDTag)">
            <summary>
            Removes the first occurrence of a specific value from the list.
            </summary>
            <param name="val">The value to remove from the list.</param>
        </member>
        <member name="M:WJ.MPR.Reader.Inventory.ToArray">
            <summary>
            Convert the list to an array.
            </summary>
            <returns>The values of this list, as an array.</returns>
        </member>
        <member name="M:WJ.MPR.Reader.Inventory.Contains(WJ.MPR.Reader.RFIDTag)">
            <summary>
            Determines whether the Inventory contains a specific RFIDTag.
            </summary>
            <param name="val">The value to locate in the list.</param>
            <returns>true if val is found in the list; otherwise, false.</returns>
        </member>
        <member name="M:WJ.MPR.Reader.Inventory.Contains(System.String)">
            <summary>
            Determines whether the Inventory contains a RFIDTag with a specific TagID.
            The TagID of each RFIDTag in the Inventory is compared to val.
            </summary>
            <param name="val">The value to locate in the list.</param>
            <returns>true if val is found in the list; otherwise, false.</returns>
        </member>
        <member name="M:WJ.MPR.Reader.Inventory.Find(System.String)">
            <summary>
            Determines whether the Inventory contains a RFIDTag with a specific TagID.
            The TagID of each Tag in the Inventory is compared to val.
            </summary>
            <param name="val">The value to locate in the list.</param>
            <returns>The matching RFIDTag if val is found in the list; otherwise, null.</returns>
        </member>
        <member name="M:WJ.MPR.Reader.Inventory.Merge(WJ.MPR.Reader.Inventory)">
            <summary>
            Combine two Inventories.
            If newTags is null, false is returned.
            Then newTags are added.  Lastly Old RFIDTags are Expired.
            If either adding or expiring changes this Inventory, true is returned.
            </summary>
            <param name="newTags">An Inventory containing RFIDTags to add to this Inventory.</param>
            <returns>Whether any new RFIDTags were added or deleted.</returns>
        </member>
        <member name="M:WJ.MPR.Reader.Inventory.Add(WJ.MPR.Reader.Inventory)">
            <summary>
            Add an Inventory's RFIDTags to this Inventory.
            This Inventory is searched for each RFIDTag in newTags,
            if it is found, its LastRead timestamp is updated.
            if it is not found, it is added.
            </summary>
            <param name="newTags">An Inventory of RFIDTags to add.</param>
            <returns>Whether any RFIDTags were added.</returns>
        </member>
        <member name="F:WJ.MPR.Reader.Inventory.persistTime">
            <summary>
            The length of time that a RFIDTag can live in an inventory, 
            without being reread, before it is removed by ExpireTags().
            If persistTime == TimeSpan.MaxValue, then RFIDTags are never removed.
            </summary>
        </member>
        <member name="M:WJ.MPR.Reader.Inventory.ExpireTags(System.DateTime)">
            <summary>
            The LastRead property of each RFIDTag in this Inventory 
            + the persistTime is compared against the "now" parameter.  
            If the sum is less, then the RFIDTag is removed from this Inventory.
            If persistTime == TimeSpan.MaxValue, then RFIDTags are never removed.
            </summary>
            <param name="now"></param>
            <returns></returns>
        </member>
        <member name="P:WJ.MPR.Reader.Inventory.Item(System.Int32)">
            <summary>
            Gets or sets the element at the specified index.
            This property is the indexer for the list.
            </summary>
            <param name="Index">The zero-based index of the element to get or set.</param>
            <value>The element at the specified index.</value>
            <exception cref="T:System.ArgumentOutOfRangeException">index is not a valid index in the list.</exception>
        </member>
        <member name="P:WJ.MPR.Reader.Inventory.CountClass">
            <summary>
            Returns the number of Class0 and Class1 RFIDTags in this Inventory.
            </summary>
            <value>5 element array, # of Tags read of each type: {Class 0, Class 1, Gen 2, 18000-6B, unknown}</value>
        </member>
        <member name="T:WJ.MPR.Reader.MPRComm">
            <summary>
            Responsible for handling messages bound for the MPR over a serial port.
            	- Manages an underlying Serial Port object
            	- Handles Serial Port Events
            	- Generates Request Frames and parses Response Frames, and stores all frames for
            		a single transaction in an MPRMsg.
            	- Handles and reports Serial Port or MPR API errors.
            	- Fires two events,
            		1) BLData, when data arrives (always asynchronously) from the bootloader.
            		2) IsOpenChanged, when the underlying serial port closes.
            	- Performs the twiddling needed for Reseting the MPR and entering the bootloader.
            </summary>
        </member>
        <member name="F:WJ.MPR.Reader.MPRComm.portSettings">
            <summary>
            create the port settings:
            	default has no Handshake
            	Bootloader uses XonXoff
            </summary>
        </member>
        <member name="F:WJ.MPR.Reader.MPRComm.SerialPort">
            <summary>
            The underlying Serial Port which we'll use to talk to the MPR
            </summary>
        </member>
        <member name="F:WJ.MPR.Reader.MPRComm.BaudRate">
            <summary>
            The Baud Rate of the underlying Serial Port (default = 57600)
            </summary>
        </member>
        <member name="M:WJ.MPR.Reader.MPRComm.KickTimer">
            <summary>
            Reset the TimeOutTimer, by changing it to expire, just once, in 750 milliseconds.
            </summary>
        </member>
        <member name="M:WJ.MPR.Reader.MPRComm.KillTimer">
            <summary>
            Kill the TimeOutTimer, by changing it to never expire.
            </summary>
        </member>
        <member name="M:WJ.MPR.Reader.MPRComm.TimeOutFunction(System.Object)">
            <summary>
            The timer callback function.  Notify the current Msg that a comm timeout has occurred.
            </summary>
            <param name="ignore">Not used. Use null.</param>
        </member>
        <member name="F:WJ.MPR.Reader.MPRComm.CurrentMessage">
            <summary>
            The currently active Message.
            </summary>
        </member>
        <member name="F:WJ.MPR.Reader.MPRComm.rxTmpFrame">
            <summary>
            A temporary frame within which to store arriving bytes.
            </summary>
        </member>
        <member name="M:WJ.MPR.Reader.MPRComm.#ctor(System.String,System.String)">
            <summary>
            Constructor that initializes, but doesn't open, the underlying serial port
            through which to communicate with an MPR.  
            </summary>
            <param name="SerialPortName">The "COMx" port to use.</param>
            <param name="BaudRate">The BaudRate to talk at, always 57600 for MPR series readers.</param>
        </member>
        <member name="M:WJ.MPR.Reader.MPRComm.Open">
            <summary>
            Try to open the underlying Serial Port.