usbuart  2.0.0.0
Data Structures | Macros | Enumerations | Functions
usbuart.h File Reference

This file contains API for USB UART 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  usbuart_t
 USB UART Click context object. More...
 
struct  usbuart_cfg_t
 USB UART Click configuration object. More...
 

Macros

#define USBUART_MODE_SLEEP   1
 USB UART description setting. More...
 
#define USBUART_MODE_NORMAL   0
 
#define USBUART_CTS_ACTIVE   1
 
#define USBUART_CTS_NO_ACTIVE   0
 
#define USBUART_POWER_ON   1
 
#define USBUART_POWER_OFF   0
 
#define DRV_BUFFER_SIZE   500
 USB UART driver buffer size. More...
 
#define USBUART_MAP_MIKROBUS(cfg, mikrobus)
 MikroBUS pin mapping. More...
 

Enumerations

enum  usbuart_return_value_t { USBUART_OK = 0, USBUART_ERROR = -1 }
 USB UART Click return value data. More...
 

Functions

void usbuart_cfg_setup (usbuart_cfg_t *cfg)
 USB UART configuration object setup function. More...
 
err_t usbuart_init (usbuart_t *ctx, usbuart_cfg_t *cfg)
 USB UART initialization function. More...
 
void usbuart_generic_write (usbuart_t *ctx, char *data_buf, uint16_t len)
 USB UART data writing function. More...
 
uint32_t usbuart_generic_read (usbuart_t *ctx, char *data_buf, uint16_t max_len)
 USB UART data reading function. More...
 
void usbuart_pwr_ctrl (usbuart_t *ctx, uint8_t state)
 Power control. More...
 
void usbuart_set_cts (usbuart_t *ctx, uint8_t state)
 Set CTS (Clear to send) More...
 
void usbuart_set_mode (usbuart_t *ctx, uint8_t mode)
 Set device mode. More...
 
uint8_t usbuart_get_rts (usbuart_t *ctx)
 Set device mode. More...
 
void usbuart_send_command (usbuart_t *ctx, char *command)
 Function for send command. More...
 

Detailed Description

This file contains API for USB UART Click Driver.

Enumeration Type Documentation

◆ usbuart_return_value_t

USB UART Click return value data.

Predefined enum values for driver return values.

Enumerator
USBUART_OK 
USBUART_ERROR