Pkt WMbus Exported Functions

Macros
#define	S2LPPktWMbusSetPreambleLength(xPreambleLength)   S2LPPktCommonSetPreambleLength((PktPreambleLength)xPreambleLength)
	Sets the PREAMBLE field length for S2LP Basic packets. More...
#define	S2LPPktWMbusGetPreambleLength()   S2LPPktCommonGetPreambleLength()
	Returns the PREAMBLE field length mode for S2LP Basic packets. More...

Functions
void	S2LPPktWMbusInit (PktWMbusInit *pxPktWMbusInit)
	Initialize the S2LP WMBUS packet according to the specified parameters in the PktWMbusInit struct. More...
void	S2LPPktWMbusGetInfo (PktWMbusInit *pxPktWMbusInit)
	Return the S2LP WMBUS packet structure according to the specified parameters in the registers. More...
void	S2LPPktWMbusSetFormat (void)
	Configure the WMBUS packet format as the one used by S2LP. More...
void	S2LPPktWMbusSetPostamble (uint8_t cPostamble)
	Set how many chips will be used in postamble. More...
uint8_t	S2LPPktWMbusGetPostamble (void)
	Returns how many chips are used in the postamble. More...
void	S2LPPktWMbusSetPostamblePattern (uint8_t cPostamble)
	Set the pattern of the postamble. More...
uint8_t	S2LPPktWMbusGetPostamblePattern (void)
	Returns the pattern of the postamble. More...
void	S2LPPktWMbusSetSubmode (WMbusSubmode xWMbusSubmode)
	Set the W-MBus submode. More...
WMbusSubmode	S2LPPktWMbusGetSubmode (void)
	Return the WMBUS submode used. More...
void	S2LPPktWMbusSetPayloadLength (uint16_t nPayloadLength)
	Sets the payload length for S2LP WMBUS packets. More...
uint16_t	S2LPPktWMbusGetPayloadLength (void)
	Return the payload length for WMBUS packets. More...

Detailed Description

Macro Definition Documentation

S2LPPktWMbusGetPreambleLength

#define S2LPPktWMbusGetPreambleLength

(

)

S2LPPktCommonGetPreambleLength()

Parameters

None.

Return values

uint8_t

Preamble field length in bytes.

Definition at line 135 of file S2LP_PktWMbus.h.

S2LPPktWMbusSetPreambleLength

#define S2LPPktWMbusSetPreambleLength

(

xPreambleLength

)

S2LPPktCommonSetPreambleLength((PktPreambleLength)xPreambleLength)

Parameters

xPreambleLength

length of PREAMBLE field in bytes. This parameter can be any value of BasicPreambleLength.

Return values

None.

Definition at line 127 of file S2LP_PktWMbus.h.

Function Documentation

S2LPPktWMbusGetInfo()

void S2LPPktWMbusGetInfo

(

PktWMbusInit *

pxPktWMbusInit

)

Parameters

pxPktWMbusInit

WMBUS packet init structure. This parameter is a pointer to PktWMbusInit.

Return values

None.

Definition at line 178 of file S2LP_PktWMbus.c.

References S2LPGetPreambleLength().

S2LPPktWMbusGetPayloadLength()

uint16_t S2LPPktWMbusGetPayloadLength

(

void

)

Parameters

None.

Return values

uint16_t

Payload length in bytes.

Definition at line 325 of file S2LP_PktWMbus.c.

References g_xStatus.

S2LPPktWMbusGetPostamble()

uint8_t S2LPPktWMbusGetPostamble

(

void

)

Parameters

None.

Return values

uint8_t

Postamble in number chip sequences.

Definition at line 261 of file S2LP_PktWMbus.c.

References g_xStatus.

S2LPPktWMbusGetPostamblePattern()

uint8_t S2LPPktWMbusGetPostamblePattern

(

void

)

Parameters

None.

Return values

uint8_t

Postamble in chips.

Definition at line 274 of file S2LP_PktWMbus.c.

References g_xStatus.

S2LPPktWMbusGetSubmode()

WMbusSubmode S2LPPktWMbusGetSubmode

(

void

)

Parameters

None.

Return values

WMbusSubmode

WMBUS submode.

Definition at line 298 of file S2LP_PktWMbus.c.

S2LPPktWMbusInit()

void S2LPPktWMbusInit

(

PktWMbusInit *

pxPktWMbusInit

)

Parameters

pxPktWMbusInit

pointer to a PktWMbusInit structure that contains the configuration information for the specified S2LP WMBUS PACKET FORMAT. This parameter is a pointer to PktWMbusInit.

Return values

None.

Definition at line 108 of file S2LP_PktWMbus.c.

S2LPPktWMbusSetFormat()

void S2LPPktWMbusSetFormat

(

void

)

Parameters

None.

Return values

None.

Definition at line 213 of file S2LP_PktWMbus.c.

S2LPPktWMbusSetPayloadLength()

void S2LPPktWMbusSetPayloadLength

(

uint16_t

nPayloadLength

)

Parameters

nPayloadLength

payload length in bytes. This parameter is an uint16_t.

Return values

None.

Definition at line 310 of file S2LP_PktWMbus.c.

References g_xStatus.

S2LPPktWMbusSetPostamble()

void S2LPPktWMbusSetPostamble

(

uint8_t

cPostamble

)

Parameters

cPostamble

the number of chip sequence. This parameter is an uint8_t.

Return values

None.

Definition at line 231 of file S2LP_PktWMbus.c.

References g_xStatus.

S2LPPktWMbusSetPostamblePattern()

void S2LPPktWMbusSetPostamblePattern

(

uint8_t

cPostamble

)

Parameters

cPostamble

id the preamble pattern: This parameter can be '00','01','10' or '11'. This parameter is an uint8_t.

Return values

None.

Definition at line 247 of file S2LP_PktWMbus.c.

References g_xStatus.

S2LPPktWMbusSetSubmode()

void S2LPPktWMbusSetSubmode

(

WMbusSubmode

xWMbusSubmode

)

Parameters

xWMbusSubmode

This parameter of WMbusSubmode .

Return values

None.

Definition at line 287 of file S2LP_PktWMbus.c.