mpr dll.xml

WJ Communications RFID example code

            with a Status Byte = 0xff (StatusCode.Error)
            <see cref="T:WJ.MPR.Reader.StatusCode"/>
            </summary>
        </member>
        <member name="F:WJ.MPR.Reader.ErrorCode.NoError">
            <summary>
            No error reported.  
            This is not received from the MPR, but inferred for Frames with non-Error statuses.
            </summary>
        </member>
        <member name="F:WJ.MPR.Reader.ErrorCode.Gen2SelectListFull">
            <summary>
            Another Select Record cannot be added to the Select List because it is full.
            </summary>
        </member>
        <member name="F:WJ.MPR.Reader.ErrorCode.Gen2UnknownSelectRecord">
            <summary>
            Cannot remove requested Select Record because an invalid Index was provided.
            </summary>
        </member>
        <member name="F:WJ.MPR.Reader.ErrorCode.PingMaskOverflow">
            <summary>
            Internal Error while Performing Class1 Tree Walk Algorithm.
            </summary>
        </member>
        <member name="F:WJ.MPR.Reader.ErrorCode.PingMaskNegativeShift">
            <summary>
            Internal Error while Performing Class1 Tree Walk Algorithm.
            </summary>
        </member>
        <member name="F:WJ.MPR.Reader.ErrorCode.PingJobOverflow">
            <summary>
            Internal Error while Performing Class1 Tree Walk Algorithm.
            </summary>
        </member>
        <member name="F:WJ.MPR.Reader.ErrorCode.CurrentOutOfRange">
            <summary>
            MPR Current Sense ADC reports out-of-range condition.
            </summary>
        </member>
        <member name="F:WJ.MPR.Reader.ErrorCode.VoltageOutOfRange">
            <summary>
            MPR Voltage Sense ADC reports out-of-range condition.
            </summary>
        </member>
        <member name="F:WJ.MPR.Reader.ErrorCode.AppHeaderAccessError">
            <summary>
            MPR Could not verify the CRC of the Application Header.
            </summary>
        </member>
        <member name="F:WJ.MPR.Reader.ErrorCode.Class0PlusErrorErasingPage">
            <summary>
            Error Programming page (EPC Class 0+ tags only)
            </summary>
        </member>
        <member name="F:WJ.MPR.Reader.ErrorCode.Class0PlusErrorProgrammingPage">
            <summary>
            Error Erasing page (EPC Class 0+ tags only)
            </summary>
        </member>
        <member name="F:WJ.MPR.Reader.ErrorCode.Class0PlusErrorProgrammingTIB">
            <summary>
            Error Programming Traversal Inhibit Bit (EPC Class 0+ tags only)
            </summary>
        </member>
        <member name="F:WJ.MPR.Reader.ErrorCode.Class0PlusErrorLockingPage">
            <summary>
            Error Locking page (EPC Class 0+ tags only)
            </summary>
        </member>
        <member name="F:WJ.MPR.Reader.ErrorCode.Class0PlusErrorPageLocked">
            <summary>
            Page cannot be accessed because it is already locked (EPC Class 0+ tags only)
            </summary>
        </member>
        <member name="F:WJ.MPR.Reader.ErrorCode.Class0PlusErrorVerifyFailed">
            <summary>
            Attempted to write to Class 0+ Tag, but could not verify what was written.
            </summary>
        </member>
        <member name="F:WJ.MPR.Reader.ErrorCode.Class0PlusErrorReadingPage">
            <summary>
            Error while attempting to read a page from a Class 0+ tag.
            </summary>
        </member>
        <member name="F:WJ.MPR.Reader.ErrorCode.Class0PlusErrorNoTagSingulated">
            <summary>
            Attempted to access Tag memory using a singulated command,
            but no tag was singulated.
            </summary>
        </member>
        <member name="F:WJ.MPR.Reader.ErrorCode.InvalidParams">
            <summary>
            A parameter is out of range for the issued command.
            </summary>
        </member>
        <member name="F:WJ.MPR.Reader.ErrorCode.InsufficientData">
            <summary>
            Based on the command issued and the message length, there is not enough data in the message to support the command.
            </summary>
        </member>
        <member name="F:WJ.MPR.Reader.ErrorCode.UnsupportedCommand">
            <summary>
            The command is not supported or is unable to be processed by the Reader at this time.
            </summary>
        </member>
        <member name="F:WJ.MPR.Reader.ErrorCode.UnsupportedPowerLevel">
            <summary>
            A command has been issued with an unsupported power level.
            </summary>
        </member>
        <member name="F:WJ.MPR.Reader.ErrorCode.PLLLockFail">
            <summary>
            On commanding the transmit frequency, the PLL which generates the RF up conversion failed to converge on the required frequency.
            </summary>
        </member>
        <member name="F:WJ.MPR.Reader.ErrorCode.AntennaFault">
            <summary>
            The antenna was either not present or shorted.
            </summary>
        </member>
        <member name="F:WJ.MPR.Reader.ErrorCode.UnsupportedSubcommand">
            <summary>
            The subcommand issued is not one of the subcommands that can be processed by the reader.
            </summary>
        </member>
        <member name="F:WJ.MPR.Reader.ErrorCode.InvalidSubCommandParameter">
            <summary>
            A subcommand parameter is out of range for the issued subcommand.
            </summary>
        </member>
        <member name="F:WJ.MPR.Reader.ErrorCode.InvalidNVSTable">
            <summary>
            The Non-Volatile Storage table CRC is invalid.
            </summary>
        </member>
        <member name="F:WJ.MPR.Reader.ErrorCode.NVSAlignError">
            <summary>
            The NVS address is not a word address.
            </summary>
        </member>
        <member name="F:WJ.MPR.Reader.ErrorCode.NVSProtectionViolation">
            <summary>
            An attempt was made to program(write) or erase a protect address in the flash.
            </summary>
        </member>
        <member name="F:WJ.MPR.Reader.ErrorCode.NVSAccessError">
            <summary>
            Indicates an illegal access to the flash during a program(write) or erase commands.
            </summary>
        </member>
        <member name="F:WJ.MPR.Reader.ErrorCode.NVSWriteVerifyFail">
            <summary>
            Indicates an unsuccessful write sequence; data written does not match data read back from flash.
            </summary>
        </member>
        <member name="F:WJ.MPR.Reader.ErrorCode.IncorrectPasscode">
            <summary>
            The Passcode to enter Maintenance Mode was incorrect.
            </summary>
        </member>
        <member name="F:WJ.MPR.Reader.ErrorCode.InvalidCommand">
            <summary>
            The command entered is not supported in the current mode, e.g., maintenance mode commands are only valid while in maintenance mode.
            </summary>
        </member>
        <member name="F:WJ.MPR.Reader.ErrorCode.UndefinedError">
            <summary>
            Some other, unspecified error occured.
            </summary>
        </member>
        <member name="T:WJ.MPR.Reader.RspStatus">
            <summary>
            Indicates the possible error sources for an MPRMsg.
            </summary>
        </member>
        <member name="F:WJ.MPR.Reader.RspStatus.NoStatus">
            <summary>
            The MPRMsg has no status (yet).
            </summary>
        </member>
        <member name="F:WJ.MPR.Reader.RspStatus.OK">
            <summary>
            No error associated with an MPRMsg.
            </summary>
        </member>
        <member name="F:WJ.MPR.Reader.RspStatus.ErrorRsp">
            <summary>
            An error reported in the status of a response frame.
            </summary>
        </member>
        <member name="F:WJ.MPR.Reader.RspStatus.ErrorComm">
            <summary>
            An error occured and was reported by the communication layer (serial port).
            </summary>
        </member>
        <member name="F:WJ.MPR.Reader.RspStatus.TimeOut">
            <summary>
            A timeout occured = no final response frame received for the MPRMsg.
            </summary>
        </member>
        <member name="F:WJ.MPR.Reader.RspStatus.MsgRcvd">
            <summary>
            A message was recevied, but has not been processed yet.
            </summary>
        </member>
        <member name="T:WJ.MPR.Reader.MPRMsg">
            <summary>
            The Message class bundles a host-to-reader request and the reader-to-host responses
            for a single command exchange.
            	- The Request Frame is stored as an MPRFrame, txFrame.
            	- The Response Frames are stored as an MPRFrameList, rxFrames.
            	- Stores various forms of Status Information
            		- MPR API status or errors
            		- Serial Communications errors
            		- Message Timeouts
            	- Does the work of waiting for a single "Complete" Request Frame to arrive.
            	- The .Receive method is where the thread blocks while waiting for the serial port
            		thread to wake it up via one of three methods:
            		1) .AddRxFrame()
            		2) .CommError()
            		3) .Timeout()
            
            </summary>
        </member>
        <member name="F:WJ.MPR.Reader.MPRMsg.MsgRcvd">
            <summary>
            A synchronization variable for signalling the end of
            response frame reception, either due to an error,
            a timeout, or the correct number of bytes received.
            </summary>
        </member>
        <member name="M:WJ.MPR.Reader.MPRMsg.#ctor(WJ.MPR.Reader.CmdCode,WJ.MPR.Util.byteList)">
            <summary>
            Construct a new MPRMsg with the given command and parameters.
            </summary>
            <param name="command">The command for the Request Frame.</param>
            <param name="parameters">The parameters of the Request Frame.</param>
        </member>
        <member name="M:WJ.MPR.Reader.MPRMsg.AddRxFrame(WJ.MPR.Reader.MPRFrame)">
            <summary>
            Called by MPRComm when a response frame has been received.
            </summary>
            <param name="aFrame">A response packet that has arrived successfully.</param>
        </member>
        <member name="F:WJ.MPR.Reader.MPRMsg.commErrorString">
            <summary>
            A string describing any communication errors that may have occured.
            </summary>
        </member>
        <member name="M:WJ.MPR.Reader.MPRMsg.CommError(System.String)">
            <summary>
            called by MPRComm when a comm error occurs
            </summary>
        </member>
        <member name="M:WJ.MPR.Reader.MPRMsg.Timeout">
            <summary>
            called by MPRComm when a message times out
            </summary>
        </member>
        <member name="M:WJ.MPR.Reader.MPRMsg.Receive">
            <summary>
            Response Frame Receiver.
            Waits on an AutoResetEvent until the end of a response frame reception.
            	- This can be either successfull completion of a frame.
            	- A Timeout while waiting for a response that never arrives.
            	- A communications error.
            If not an error,
            Process each received frame:
            	if CRC errors return RspStatus.ErrorComm
            	if StatusCode.Complete
            		Add rxFrame.Data to databytes
            		return RspStatus.OK
            	if StatusCode.Error
            		record error
            		return RspStatus.ErrorRsp
            	if StatusCode.InProgress
            		Add rxFrame.Data to databytes
            		and keep looking for more frames. 
            </summary>
            <returns></returns>
        </member>
        <member name="P:WJ.MPR.Reader.MPRMsg.TxFrame">
            <summary>
            The Request Frame.
            </summary>