KETCube_uart2WAN

Data Structures
struct	ketCube_uart2WAN_moduleCfg_t
	KETCube module configuration. More...

Macros
#define	KETCUBE_UART2WAN_USART_INSTANCE   USART2
#define	KETCUBE_UART2WAN_USART_CHANNEL   KETCUBE_UART_CHANNEL_2
#define	KETCUBE_UART2WAN_USART_SET_CLK_SRC()   __HAL_RCC_USART2_CONFIG(RCC_USART2CLKSOURCE_HSI)
#define	KETCUBE_UART2WAN_USART_IRQ_NUMBER   USART2_IRQn
#define	KETCUBE_UART2WAN_USART_IRQ_PRIORITY   0x1
#define	KETCUBE_UART2WAN_USART_IRQ_SUBPRIORITY   1
#define	KETCUBE_UART2WAN_USART_CLK_ENABLE()   __USART2_CLK_ENABLE()
#define	KETCUBE_UART2WAN_USART_CLK_DISABLE()   __USART2_CLK_DISABLE()
#define	KETCUBE_UART2WAN_USART_RX_PIN   KETCUBE_GPIO_PIN_2
#define	KETCUBE_UART2WAN_USART_RX_PIN_AF   GPIO_AF4_USART2
#define	KETCUBE_UART2WAN_USART_RX_PIN_PORT   KETCUBE_GPIO_PA
#define	KETCUBE_UART2WAN_USART_TX_PIN   KETCUBE_GPIO_PIN_3
#define	KETCUBE_UART2WAN_USART_TX_PIN_AF   GPIO_AF4_USART2
#define	KETCUBE_UART2WAN_USART_TX_PIN_PORT   KETCUBE_GPIO_PA
#define	KETCUBE_UART2WAN_USART_BAUDRATE   9600 /*<! default baudrate */
#define	KETCUBE_UART2WAN_USART_DATA_BITS   UART_WORDLENGTH_8B /*<! default is 8. When parity is used, use 9 dta bits -- Oh, how uggly UART implementation */
#define	KETCUBE_UART2WAN_USART_STOP_BITS   UART_STOPBITS_1 /*<! default is one stop bit */
#define	KETCUBE_UART2WAN_USART_PARITY   UART_PARITY_NONE /*<! default is no parity */
#define	KETCUBE_UART2WAN_USART_HW_FLOW_CONTROL   UART_HWCONTROL_NONE /*<! default M-BUS HW control */
#define	KETCUBE_UART2WAN_USART_INIT_MODE   UART_MODE_TX_RX /*<! default USART startup mode for M-BUS */
#define	KETCUBE_UART2WAN_USART_TIMEOUT   5000 /*<! UART Timeout in ms */

Typedefs
typedef struct ketCube_uart2WAN_moduleCfg_t	ketCube_uart2WAN_moduleCfg_t
	KETCube module configuration. More...

Enumerations
enum	ketCube_uart2WAN_err_t { KETCUBE_UART2WAN_ERR_NOERR = 0x00, KETCUBE_UART2WAN_ERR_TIMEOUT = 0x01 }
	enumerator of M-BUS configuration options addresses More...

Functions
ketCube_cfg_ModError_t	ketCube_uart2WAN_Init (ketCube_InterModMsg_t ***msg)
ketCube_cfg_ModError_t	ketCube_uart2WAN_ReadData (uint8_t *buffer, uint8_t *len)
ketCube_cfg_ModError_t	ketCube_uart2WAN_ProcessData (ketCube_InterModMsg_t *msg)
ketCube_cfg_ModError_t	ketCube_uart2WAN_SleepEnter (void)
ketCube_cfg_ModError_t	ketCube_uart2WAN_SleepExit (void)

Variables
ketCube_uart2WAN_moduleCfg_t	ketCube_uart2WAN_moduleCfg

Detailed Description

Macro Definition Documentation

KETCUBE_UART2WAN_USART_BAUDRATE

#define KETCUBE_UART2WAN_USART_BAUDRATE   9600 /*<! default baudrate */

KETCUBE_UART2WAN_USART_CHANNEL

#define KETCUBE_UART2WAN_USART_CHANNEL   KETCUBE_UART_CHANNEL_2

KETCUBE_UART2WAN_USART_CLK_DISABLE

#define KETCUBE_UART2WAN_USART_CLK_DISABLE

(

)

__USART2_CLK_DISABLE()

KETCUBE_UART2WAN_USART_CLK_ENABLE

#define KETCUBE_UART2WAN_USART_CLK_ENABLE

(

)

__USART2_CLK_ENABLE()

KETCUBE_UART2WAN_USART_DATA_BITS

#define KETCUBE_UART2WAN_USART_DATA_BITS   UART_WORDLENGTH_8B /*<! default is 8. When parity is used, use 9 dta bits -- Oh, how uggly UART implementation */

KETCUBE_UART2WAN_USART_HW_FLOW_CONTROL

#define KETCUBE_UART2WAN_USART_HW_FLOW_CONTROL   UART_HWCONTROL_NONE /*<! default M-BUS HW control */

KETCUBE_UART2WAN_USART_INIT_MODE

#define KETCUBE_UART2WAN_USART_INIT_MODE   UART_MODE_TX_RX /*<! default USART startup mode for M-BUS */

KETCUBE_UART2WAN_USART_INSTANCE

#define KETCUBE_UART2WAN_USART_INSTANCE   USART2

KETCUBE_UART2WAN_USART_IRQ_NUMBER

#define KETCUBE_UART2WAN_USART_IRQ_NUMBER   USART2_IRQn

KETCUBE_UART2WAN_USART_IRQ_PRIORITY

#define KETCUBE_UART2WAN_USART_IRQ_PRIORITY   0x1

KETCUBE_UART2WAN_USART_IRQ_SUBPRIORITY

#define KETCUBE_UART2WAN_USART_IRQ_SUBPRIORITY   1

KETCUBE_UART2WAN_USART_PARITY

#define KETCUBE_UART2WAN_USART_PARITY   UART_PARITY_NONE /*<! default is no parity */

KETCUBE_UART2WAN_USART_RX_PIN

#define KETCUBE_UART2WAN_USART_RX_PIN   KETCUBE_GPIO_PIN_2

KETCUBE_UART2WAN_USART_RX_PIN_AF

#define KETCUBE_UART2WAN_USART_RX_PIN_AF   GPIO_AF4_USART2

KETCUBE_UART2WAN_USART_RX_PIN_PORT

#define KETCUBE_UART2WAN_USART_RX_PIN_PORT   KETCUBE_GPIO_PA

KETCUBE_UART2WAN_USART_SET_CLK_SRC

#define KETCUBE_UART2WAN_USART_SET_CLK_SRC

(

)

__HAL_RCC_USART2_CONFIG(RCC_USART2CLKSOURCE_HSI)

KETCUBE_UART2WAN_USART_STOP_BITS

#define KETCUBE_UART2WAN_USART_STOP_BITS   UART_STOPBITS_1 /*<! default is one stop bit */

KETCUBE_UART2WAN_USART_TIMEOUT

#define KETCUBE_UART2WAN_USART_TIMEOUT   5000 /*<! UART Timeout in ms */

KETCUBE_UART2WAN_USART_TX_PIN

#define KETCUBE_UART2WAN_USART_TX_PIN   KETCUBE_GPIO_PIN_3

KETCUBE_UART2WAN_USART_TX_PIN_AF

#define KETCUBE_UART2WAN_USART_TX_PIN_AF   GPIO_AF4_USART2

KETCUBE_UART2WAN_USART_TX_PIN_PORT

#define KETCUBE_UART2WAN_USART_TX_PIN_PORT   KETCUBE_GPIO_PA

Typedef Documentation

ketCube_uart2WAN_moduleCfg_t

typedef struct ketCube_uart2WAN_moduleCfg_t ketCube_uart2WAN_moduleCfg_t

KETCube module configuration.

Enumeration Type Documentation

ketCube_uart2WAN_err_t

enum ketCube_uart2WAN_err_t

enumerator of M-BUS configuration options addresses

Enumerator
KETCUBE_UART2WAN_ERR_NOERR
KETCUBE_UART2WAN_ERR_TIMEOUT

Function Documentation

ketCube_uart2WAN_Init()

ketCube_cfg_ModError_t ketCube_uart2WAN_Init

(

ketCube_InterModMsg_t ***

msg

)

ketCube_uart2WAN_ProcessData()

ketCube_cfg_ModError_t ketCube_uart2WAN_ProcessData

(

ketCube_InterModMsg_t *

msg

)

ketCube_uart2WAN_ReadData()

ketCube_cfg_ModError_t ketCube_uart2WAN_ReadData	(	uint8_t *	buffer,
		uint8_t *	len
	)

ketCube_uart2WAN_SleepEnter()

ketCube_cfg_ModError_t ketCube_uart2WAN_SleepEnter

(

void

)

ketCube_uart2WAN_SleepExit()

ketCube_cfg_ModError_t ketCube_uart2WAN_SleepExit

(

void

)

Variable Documentation

ketCube_uart2WAN_moduleCfg

ketCube_uart2WAN_moduleCfg_t ketCube_uart2WAN_moduleCfg

extern