rs2323.h File Reference

This file contains API for RS232 3 Click Driver. More...

#include "drv_digital_out.h"
#include "drv_digital_in.h"
#include "drv_uart.h"

Go to the source code of this file.

Data Structures
struct	rs2323_t
	RS232 3 Click context object. More...
struct	rs2323_cfg_t
	RS232 3 Click configuration object. More...

Macros
#define	DRV_BUFFER_SIZE   200
	RS232 3 driver buffer size.
#define	RS2323_MAP_MIKROBUS(cfg, mikrobus)
	MikroBUS pin mapping.

Enumerations
enum	rs2323_return_value_t { RS2323_OK = 0 , RS2323_ERROR = -1 }
	RS232 3 Click return value data. More...

Functions
void	rs2323_cfg_setup (rs2323_cfg_t *cfg)
	RS232 3 configuration object setup function.
err_t	rs2323_init (rs2323_t *ctx, rs2323_cfg_t *cfg)
	RS232 3 initialization function.
err_t	rs2323_generic_write (rs2323_t *ctx, char *data_buf, uint16_t len)
	RS232 3 data writing function.
err_t	rs2323_generic_read (rs2323_t *ctx, char *data_buf, uint16_t max_len)
	RS232 3 data reading function.
void	rs2323_set_shutdown_pin (rs2323_t *ctx, uint8_t state)
	RS232 3 set shutdown pin function.
void	rs2323_set_enable_pin (rs2323_t *ctx, uint8_t state)
	RS232 3 set enable pin function.
void	rs2323_set_online_pin (rs2323_t *ctx, uint8_t state)
	RS232 3 set online pin function.
uint8_t	rs2323_get_status_pin (rs2323_t *ctx)
	RS232 3 get status pin function.

Detailed Description

This file contains API for RS232 3 Click Driver.

Enumeration Type Documentation

rs2323_return_value_t

enum rs2323_return_value_t

RS232 3 Click return value data.

Predefined enum values for driver return values.

Enumerator
RS2323_OK
RS2323_ERROR