ryb080i 2.1.0.0
Loading...
Searching...
No Matches
ryb080i.h File Reference

This file contains API for RYB080I 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  ryb080i_t
 RYB080I Click context object. More...
 
struct  ryb080i_cfg_t
 RYB080I Click configuration object. More...
 

Macros

#define RYB080I_CMD_AT   "AT"
 RYB080I control commands.
 
#define RYB080I_CMD_SW_RESET   "AT+RESET"
 
#define RYB080I_CMD_BROADCAST_NAME   "AT+NAME"
 
#define RYB080I_CMD_DEVICE_NAME   "AT+ATTR"
 
#define RYB080I_CMD_OUTPUT_POWER   "AT+CPFOP"
 
#define RYB080I_CMD_CONNECTION_ENABLE   "AT+CNE"
 
#define RYB080I_CMD_BROADCAST_PERIOD   "AT+PERIOD"
 
#define RYB080I_CMD_POWER_MODE   "AT+PWMODE"
 
#define RYB080I_CMD_ADVERTISING_ENABLE   "AT+CFUN"
 
#define RYB080I_CMD_BAUD_RATE   "AT+IPR"
 
#define RYB080I_CMD_INQUIRE_MAC_ADDRESS   "AT+ADDR"
 
#define RYB080I_CMD_END_KEY_ENABLE   "AT+ENTER"
 
#define RYB080I_CMD_CONNECTION_STATUS   "AT+CONNECT"
 
#define RYB080I_CMD_CONNECT_MAC   "AT+CON"
 
#define RYB080I_CMD_CONNECT_NUM   "AT+CONT"
 
#define RYB080I_CMD_DISCONNECT   "AT+DCON"
 
#define RYB080I_CMD_GPIO_OUT   "AT+GPIO"
 
#define RYB080I_CMD_SW_VERSION   "AT+CGMS"
 
#define RYB080I_RSP_OK   "OK"
 RYB080I device response to AT commands.
 
#define RYB080I_RSP_FOUND   "Found"
 
#define RYB080I_RSP_READY   "READY"
 
#define RYB080I_RSP_GENERIC   "+"
 
#define RYB080I_RSP_CONNECTED   "+++++"
 
#define RYB080I_RSP_DISCONNECTED   "-----"
 
#define RYB080I_RSP_NO_CONNECTIONS   "CONNECT=0,0"
 
#define RYB080I_TX_DRV_BUFFER_SIZE   200
 RYB080I driver buffer size.
 
#define RYB080I_RX_DRV_BUFFER_SIZE   600
 
#define RYB080I_MAP_MIKROBUS(cfg, mikrobus)
 MikroBUS pin mapping.
 

Enumerations

enum  ryb080i_return_value_t { RYB080I_OK = 0 , RYB080I_ERROR = -1 , RYB080I_ERROR_TIMEOUT = -2 , RYB080I_ERROR_CMD = -3 }
 RYB080I Click return value data. More...
 

Functions

void ryb080i_cfg_setup (ryb080i_cfg_t *cfg)
 RYB080I configuration object setup function.
 
err_t ryb080i_init (ryb080i_t *ctx, ryb080i_cfg_t *cfg)
 RYB080I initialization function.
 
err_t ryb080i_generic_write (ryb080i_t *ctx, uint8_t *data_in, uint16_t len)
 RYB080I data writing function.
 
err_t ryb080i_generic_read (ryb080i_t *ctx, uint8_t *data_out, uint16_t len)
 RYB080I data reading function.
 
void ryb080i_set_rst_pin (ryb080i_t *ctx, uint8_t state)
 RYB080I set rst pin function.
 
void ryb080i_reset_device (ryb080i_t *ctx)
 RYB080I reset device function.
 
void ryb080i_cmd_run (ryb080i_t *ctx, uint8_t *cmd)
 RYB080I cmd run function.
 
void ryb080i_cmd_set (ryb080i_t *ctx, uint8_t *cmd, uint8_t *param)
 RYB080I cmd set function.
 
void ryb080i_cmd_get (ryb080i_t *ctx, uint8_t *cmd)
 RYB080I cmd get function.
 

Detailed Description

This file contains API for RYB080I Click Driver.

Enumeration Type Documentation

◆ ryb080i_return_value_t

RYB080I Click return value data.

Predefined enum values for driver return values.

Enumerator
RYB080I_OK 
RYB080I_ERROR 
RYB080I_ERROR_TIMEOUT 
RYB080I_ERROR_CMD