Demo HCI Implementation for WiMOD-LR Devices  V1.3.1
TComSlip Class Reference

Class for handling SLIP encoding and decoding of HCI messages. More...

#include <utils/ComSLIP.h>

Public Member Functions

 TComSlip (Stream &s)
 Constructor. More...
 
void begin ()
 Init function that must be called once prior to any other function of this object.
 
void end (void)
 De-Init function.
 
void RegisterClient (TComSlipClient *client)
 register a client for processing More...
 
bool SendMessage (UINT8 *msg, UINT16 msgLength)
 Generic function to transfer a message from the host to the module. More...
 
bool SetRxBuffer (UINT8 *rxBuffer, UINT16 rxbufferSize)
 configure a rx-buffer and enable receiver/decoder More...
 
void DecodeData (UINT8 *rxData, UINT16 length)
 process received byte stream More...
 
void SendWakeUpSequence (UINT8 nbr)
 : Send a sequence of dummy chars to give the WiMOD some time to wake up More...
 

Detailed Description

Class for handling SLIP encoding and decoding of HCI messages.

Constructor & Destructor Documentation

TComSlip::TComSlip ( Stream &  s)

Constructor.

Parameters
sReference to the serial interface to use for communication

Member Function Documentation

void TComSlip::DecodeData ( UINT8 *  rxData,
UINT16  length 
)

process received byte stream

Parameters
rxDatapointer to received bytes
lengthnumber of bytes received
void TComSlip::RegisterClient ( TComSlipClient client)

register a client for processing

Parameters
clientpointer to client that should handle a received SLIP frame
bool TComSlip::SendMessage ( UINT8 *  msg,
UINT16  msgLength 
)

Generic function to transfer a message from the host to the module.

This is a generic function to send out a stream of bytes. The bytes are encoded into the SLIP format before transmission. Therefore a complete message has to be given.

Parameters
msgpointer to the bytes to encoded and send via serial interface
msgLengthnumber of bytes
void TComSlip::SendWakeUpSequence ( UINT8  nbr)

: Send a sequence of dummy chars to give the WiMOD some time to wake up

Parameters
nbrnumber of dummy bytes to send
bool TComSlip::SetRxBuffer ( UINT8 *  rxBuffer,
UINT16  rxBufferSize 
)

configure a rx-buffer and enable receiver/decoder

Parameters
rxBufferpointer to plain buffer
rxBufferSizesize of buffer in bytes

The documentation for this class was generated from the following files: