Demo HCI Implementation for WiMOD-LR Devices  V1.3.1
WiMODLRHCI.h File Reference

Common low level HCI message processing base. More...

#include "utils/WMDefs.h"
#include <string.h>
#include "utils/ComSLIP.h"
#include "Arduino.h"
Include dependency graph for WiMODLRHCI.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes

struct  TWiMODLR_HCIMessage
 basic low level HCI message structure used for all serial messages to/from WiMOD More...
 
class  TWiMODLRHCIClient
 Internal helper class for processing HCI frames. More...
 
class  TWiMODLRHCI
 Internal helper class for processing SLIP frames. More...
 

Macros

#define WIMODLR_SERIAL_BAUDRATE   115200
 
#define WIMODLR_RESPOMSE_TIMEOUT_MS   1000;
 

Typedefs

typedef struct TWiMODLR_HCIMessage TWiMODLR_HCIMessage
 basic low level HCI message structure used for all serial messages to/from WiMOD
 
typedef enum TWiMDLRResultCodes TWiMDLRResultCodes
 Result codes for the local serial communication itself.
 
typedef enum TWiMODStackError TWiMODStackError
 Internal error reasons; not to be used in user code.
 
typedef void(* TWiMODStackErrorClient) (TWiMODStackError)
 Type definition for indicator callback for stack (internal) error.
 

Enumerations

enum  TWiMDLRResultCodes {
  WiMODLR_RESULT_OK = 0, WiMODLR_RESULT_PAYLOAD_LENGTH_ERROR, WiMODLR_RESULT_PAYLOAD_PTR_ERROR, WiMODLR_RESULT_TRANMIT_ERROR,
  WiMODLR_RESULT_SLIP_ENCODER_ERROR, WiMODLR_RESULT_NO_RESPONSE
}
 Result codes for the local serial communication itself. More...
 
enum  TWiMODStackError { WIMOD_STACK_ERR_UNKNOWN_RX_MESSAGE, WIMOD_STACK_ERR_UNKNOWN_RX_SAP_ID, WIMOD_STACK_ERR_UNKNOWN_RX_CMD_ID }
 Internal error reasons; not to be used in user code. More...
 

Detailed Description

Common low level HCI message processing base.

Version
0.1
Author
(FB), IMST

Macro Definition Documentation

#define WIMODLR_RESPOMSE_TIMEOUT_MS   1000;

default timeout in ms for waiting for a response msg from WiMOD

#define WIMODLR_SERIAL_BAUDRATE   115200

default serial baudrate to communicate with a WiMOD module

Enumeration Type Documentation

Result codes for the local serial communication itself.

Enumerator
WiMODLR_RESULT_OK 

OK, no error

WiMODLR_RESULT_PAYLOAD_LENGTH_ERROR 

given payload is too big

WiMODLR_RESULT_PAYLOAD_PTR_ERROR 

wrong pointer to payload (NULL?)

WiMODLR_RESULT_TRANMIT_ERROR 

Error sending data to WiMOD via serial interface

WiMODLR_RESULT_SLIP_ENCODER_ERROR 

Error during SLIP encoding

WiMODLR_RESULT_NO_RESPONSE 

The WiMOD did not respond to a request command

Internal error reasons; not to be used in user code.

Enumerator
WIMOD_STACK_ERR_UNKNOWN_RX_MESSAGE 

rx message is not processed

WIMOD_STACK_ERR_UNKNOWN_RX_SAP_ID 

unknown SAP-ID

WIMOD_STACK_ERR_UNKNOWN_RX_CMD_ID 

unknown CMD-ID