mpr dll.xml

WJ Communications RFID example code

            </summary>
            <returns>Whether or not the port was successfully opened.</returns>
        </member>
        <member name="M:WJ.MPR.Reader.MPRComm.Close">
            <summary>
            Close the underlying serial port immediately...
            </summary>
        </member>
        <member name="M:WJ.MPR.Reader.MPRComm.Send(WJ.MPR.Reader.CmdCode,WJ.MPR.Util.byteList)">
            <summary>
            Build an MPRMsg using command and parameters, 
            send the request frame, and wait for and receive
            response packets.
            </summary>
            <param name="command">The command to send.</param>
            <param name="parameters">The parameters for the command to send.</param>
            <returns>The MPRMsg will contain the request and response frames for further processing.</returns>
        </member>
        <member name="M:WJ.MPR.Reader.MPRComm.SendFrame(WJ.MPR.Reader.MPRFrame)">
            <summary>
            Send a request frame to the MPR via the Serial Port
            Kicks the receiver timer after sending a frame
            </summary>
            <param name="txFrame">a Frame to send</param>
            <returns>true if port is still open at exit of function.
            false if port==null, or port isn't open.</returns>
        </member>
        <member name="M:WJ.MPR.Reader.MPRComm.SendBLLine(System.String)">
            <summary>
            Send one line of text
            </summary>
            <param name="line"></param>
            <returns>Whether the serial port is still open after sending the line.</returns>
        </member>
        <member name="M:WJ.MPR.Reader.MPRComm.SendBytes(System.Byte[])">
            <summary>
            Just send raw bytes out the serial port.
            </summary>
            <param name="payload"></param>
        </member>
        <member name="M:WJ.MPR.Reader.MPRComm.Dispose">
            <summary>
            Free resources:
            	Dispose the underlying Serial port.
            </summary>
        </member>
        <member name="M:WJ.MPR.Reader.MPRComm.SerialPort_TxDone">
            <summary>
            Not used:  Fired when the Serial Port is done transmitting the whole Input buffer.
            </summary>
        </member>
        <member name="M:WJ.MPR.Reader.MPRComm.SerialPort_OnError(System.String)">
            <summary>
            Fired when the Serial Port detects an error condition.
            </summary>
            <param name="Description">A string describing the error condition.</param>
        </member>
        <member name="M:WJ.MPR.Reader.MPRComm.SerialPort_IsOpenChanged(System.Boolean)">
            <summary>
            Just a thin wrapper around the underlying Port's
            IsOpenChanged event
            </summary>
            <param name="NewState">true if Serial Port is now open; otherwise false.</param>
        </member>
        <member name="M:WJ.MPR.Reader.MPRComm.blModeSetup">
            <summary>
            Setup Event Handlers and Port Settings for Bootloader communications mode.
            </summary>
        </member>
        <member name="M:WJ.MPR.Reader.MPRComm.appModeSetup">
            <summary>
            Setup Event Handlers and Port Settings for Application (normal) communications mode.
            </summary>
        </member>
        <member name="M:WJ.MPR.Reader.MPRComm.ResetMPR(System.Boolean)">
            <summary>
            Hard reboot the MPR's processor.
            Resetting can bring the MPR up in one of two programs.
            	If the Bootloader line is high, we enter the bootloader.
            	Else, the normal Application is started.
            The Application uses no Handshaking, 57600 baud, and communicates through MPRMsg Frames.
            The Bootloader uses XonXoff Handshaking, 115200 baud, and communicates through ASCII text.
            The two different types of message require different Message handlers 
            (SerialPort_DataRecevied and SerialPortBL_DataRecevied).
            
            This Method waits 100 msec after toggling the Reset Line, for the MPR to reboot.
            
            There are two ways of communicating with the MPR, serial mode and PC Card mode.
            
            In serial mode, the BOOTLOAD and RESET lines are brought out to the 68-pin connector,
            and must be toggled with dedicated hardware lines.
            
            In PC Card mode, the BOOTLOAD and RESET lines are internal to the MPR and are toggled
            by special commands.  These special commands are accessed by changing the serial port
            settings to {57600 BPS, 5 Data bits, 1.5 stop bits, no parity}.  
            The reset line is then accessed as bit 4 (0x10). 
            The BOOTLOAD line is then accessed as bit 0 (0x01).
            
            This MPRComm.ResetMPR Method only works in the PC Card Mode.
            
            </summary>
            <param name="BootLoader">Whether the MPR should start in the boot loader (true) 
            or the application (false).</param>
        </member>
        <member name="E:WJ.MPR.Reader.MPRComm.IsOpenChanged">
            <summary>
            Raised when the underlying serial port is opened or closed.
            </summary>
        </member>
        <member name="E:WJ.MPR.Reader.MPRComm.BLDataArrived">
            <summary>
            Fired when data is received from the MPR's bootloader.
            </summary>
        </member>
        <member name="P:WJ.MPR.Reader.MPRComm.IsOpen">
            <summary>
            Just map the underlying ports IsOpen property.
            </summary>
        </member>
        <member name="P:WJ.MPR.Reader.MPRComm.PortSetting">
            <summary>
            Returns a string with the serial port and baud rate : "COMx 57600".
            </summary>
        </member>
        <member name="T:WJ.MPR.Reader.MPRMsgEventHandler">
            <summary>
            Delegate for events with a MPRMsg argument.
            </summary>
        </member>
        <member name="T:WJ.MPR.Reader.TagEventHandler">
            <summary>
            For events that communicate events on Tags
            </summary>
        </member>
        <member name="T:WJ.MPR.Reader.MPRFrame">
            <summary>
            The basic unit of communications between the host and the MPR.
            	
            Request Frames are sent from Host to MPR, and Response Frames are received by the Host from the MPR.  
            
            Both Types of frames have a similar format:
            
            	[SOF][Payload]
            	[SOF] = 0x01
            
            For Request Frames:
            	[Payload] = [NodeAddress][Length][Command][Data][CRC]
            
            For Response Frames:
            	[Payload] = [NodeAddress][Length][Status][Data][CRC]
            </summary>
        </member>
        <member name="M:WJ.MPR.Reader.MPRFrame.ToHexString">
            <summary>
            Converts the Frame to a string of Hexadecimal digits
            </summary>
            <returns>string of HEX digits</returns>
        </member>
        <member name="M:WJ.MPR.Reader.MPRFrame.ToArray">
            <summary>
            Converts the Frame to an array of bytes
            </summary>
            <returns>the bytes in the Frame</returns>
        </member>
        <member name="F:WJ.MPR.Reader.MPRFrame.inFrame">
            <summary>
            Bytes are ignored (inFrame = false) until a SOF byte received
            then bytes are stored (inFrame = true)
            </summary>
        </member>
        <member name="F:WJ.MPR.Reader.MPRFrame.CompleteFrame">
            <summary>
            bytes are added (CompleteFrame = false),
            until a complete frame has been received (Count = Length + 1) and can be processed. (CompleteFrame = true)
            </summary>
        </member>
        <member name="F:WJ.MPR.Reader.MPRFrame.Processed">
            <summary>
            After a Complete Frame has been received it is processed.
            After processing, Processed is set to true
            </summary>
        </member>
        <member name="M:WJ.MPR.Reader.MPRFrame.Add(System.Byte)">
            <summary>
            Add a byte to the frame.
            bytes are ignored until SOF = true.
            when Count == Length + 1, A complete Frame has been received and is ready for processing
            </summary>
            <param name="b">the byte to add</param>
        </member>
        <member name="M:WJ.MPR.Reader.MPRFrame.#ctor">
            <summary>
            construct a new, empty, frame
            </summary>
        </member>
        <member name="M:WJ.MPR.Reader.MPRFrame.#ctor(WJ.MPR.Reader.CmdCode,WJ.MPR.Util.byteList)">
            <summary>
            Construct a new request frame with the given opcode (command) and parameters (parameters).
            </summary>
            <param name="command">The opcode for the new Request Frame.</param>
            <param name="parameters">The parameters for this Frame.</param>
        </member>
        <member name="F:WJ.MPR.Reader.MPRFrame.crctab">
            <summary>
            The Frame crc calculation uses a table lookup to generate CCITT CRC values.
            The CCITT polynomial is: x^16 + x^12 + x^5 + 1
            Forward direction table - i.e. msbit first
            </summary>
        </member>
        <member name="M:WJ.MPR.Reader.MPRFrame.CalculateFrameCRC(WJ.MPR.Util.byteList)">
            <summary>
            Compute the MPR crc for a byteList
            </summary>
            <param name="buffer">the buffer over which to perform the CRC</param>
            <returns>the 2-byte crc</returns>
        </member>
        <member name="P:WJ.MPR.Reader.MPRFrame.Data">
            <summary>
            Data Field, Frame[4] to Frame[Length-2]
            </summary>
        </member>
        <member name="P:WJ.MPR.Reader.MPRFrame.NodeAddress">
            <summary>
            Node Address Field, Frame[1]
            Should always be 0
            </summary>
        </member>
        <member name="P:WJ.MPR.Reader.MPRFrame.Length">
            <summary>
            Length Field, Frame[2].
            Length of all bytes in Frame except SOF
            </summary>
        </member>
        <member name="P:WJ.MPR.Reader.MPRFrame.Command">
            <summary>
            (Request Frames Only) Command Field, Frame[3] - see CmdCode Enumeration
            </summary>
        </member>
        <member name="P:WJ.MPR.Reader.MPRFrame.Status">
            <summary>
            (Response Frames Only) Status Field, Frame[3] - see StatusCode Enumeration
            </summary>
        </member>
        <member name="P:WJ.MPR.Reader.MPRFrame.crc">
            <summary>
            crc Field, Frame[Length-2] and Frame[Length-1]
            </summary>
        </member>
        <member name="P:WJ.MPR.Reader.MPRFrame.CRCValid">
            <summary>
            Whether or not the CRC of this Frame is valid: {crc == CalculateFrameCRC(Payload)}
            </summary>
        </member>
        <member name="T:WJ.MPR.Reader.MPRFrameList">
            <summary>
            A strongly-typed collection of MPRFrame objects.
            </summary>
        </member>
        <member name="M:WJ.MPR.Reader.MPRFrameList.Add(WJ.MPR.Reader.MPRFrame)">
            <summary>
            Add an MPRFrame to the list.
            </summary>
            <param name="aFrame">The frame to add.</param>
            <returns>Index of newly added frame.</returns>
        </member>
        <member name="M:WJ.MPR.Reader.MPRFrameList.IndexOf(WJ.MPR.Reader.MPRFrame)">
            <summary>
            Determines the index of a specific MPRFrame in the MPRFrameList.
            </summary>
            <param name="aFrame">The MPRFrame to locate in the MPRFrameList.</param>
            <returns>The index of aFrame if found in the MPRFrameList; otherwise, -1.</returns>
        </member>
        <member name="M:WJ.MPR.Reader.MPRFrameList.Insert(System.Int32,WJ.MPR.Reader.MPRFrame)">
            <summary>
            Inserts an MPRFrame to the MPRFrameList at the specified Index.
            </summary>
            <param name="Index">The zero-based index at which the value should be inserted. </param>
            <param name="aFrame">The MPRFrame to insert into the MPRFrameList.</param>
        </member>
        <member name="M:WJ.MPR.Reader.MPRFrameList.Remove(WJ.MPR.Reader.MPRFrame)">
            <summary>
            Removes the first occurrence of a specific MPRFrame from the MPRFrameList
            </summary>
            <param name="aFrame">The MPRFrame to remove from the MPRFrameList.</param>
        </member>
        <member name="M:WJ.MPR.Reader.MPRFrameList.Contains(WJ.MPR.Reader.MPRFrame)">