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

Internal helper class for processing SLIP frames. More...

#include <HCI/WiMODLRHCI.h>

Inheritance diagram for TWiMODLRHCI:
Collaboration diagram for TWiMODLRHCI:

Public Member Functions

 TWiMODLRHCI (Stream &s)
 Constructor. More...
 
 ~TWiMODLRHCI (void)
 Destructor.
 
virtual void begin (void)
 Init function of the generic HCI message handler. More...
 
virtual void end (void)
 shutdown function
 
TWiMDLRResultCodes SendHCIMessage (UINT8 dstSapID, UINT8 msgID, UINT8 rxMsgID, UINT8 *payload, UINT16 length)
 Generic function for transferring a HCI message to the WiMOD module. More...
 
void Process (void)
 Handle the receiver path; process all incomming bytes from the WiMOD. More...
 
void SendWakeUpSequence (void)
 : Send a sequence of dummy chars to give the WiMOD some time to wake up
 
void RegisterStackErrorClient (TWiMODStackErrorClient cb)
 
const TWiMODLR_HCIMessageGetRxMessage (void)
 
- Public Member Functions inherited from TComSlipClient
virtual UINT8 * ProcessRxMessage (UINT8 *, UINT16)
 

Detailed Description

Internal helper class for processing SLIP frames.

Constructor & Destructor Documentation

TWiMODLRHCI::TWiMODLRHCI ( Stream &  s)

Constructor.

Parameters
sReference to the serial interface the the WiMOD. The interface must be initialized before any other function of this class can be used.

Member Function Documentation

void TWiMODLRHCI::begin ( void  )
virtual

Init function of the generic HCI message handler.

This function must be called once before any other service can be used.

Reimplemented in WiMODLRBASE, and WiMODLoRaWAN.

const TWiMODLR_HCIMessage & TWiMODLRHCI::GetRxMessage ( void  )

Here is the call graph for this function:

void TWiMODLRHCI::Process ( void  )

Handle the receiver path; process all incomming bytes from the WiMOD.

This function checks if there are any bytes from the WiMOD available and tries to start decoding the received data.

Note
this function must be called at regular base from the main loop.
void TWiMODLRHCI::RegisterStackErrorClient ( TWiMODStackErrorClient  cb)
TWiMDLRResultCodes TWiMODLRHCI::SendHCIMessage ( UINT8  dstSapID,
UINT8  msgID,
UINT8  rxMsgID,
UINT8 *  payload,
UINT16  length 
)

Generic function for transferring a HCI message to the WiMOD module.

Parameters
dstSapIDthe SAP endpoint to address
msgIDthe command ID to address within the SAP
rxMsgIDthe expected response ID according to the msgID
payloadpointer to the payload bytes to send
lengththe number of payload bytes to send
Return values
WiMODLR_RESULT_OKif everything was OK

Here is the call graph for this function:


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