lyra24p  2.1.0.0
Data Structures | Macros | Enumerations | Functions
lyra24p.h File Reference

This file contains API for LYRA 24P 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  lyra24p_t
 LYRA 24P Click context object. More...
 
struct  lyra24p_cfg_t
 LYRA 24P Click configuration object. More...
 

Macros

#define LYRA24P_CMD_AT   "AT"
 LYRA 24P parameter access commands. More...
 
#define LYRA24P_CMD_ATPS   "AT%S"
 
#define LYRA24P_CMD_ATF   "AT&F"
 
#define LYRA24P_CMD_ATW   "AT&W"
 
#define LYRA24P_CMD_ATI   "ATI"
 
#define LYRA24P_CMD_ATS   "ATS"
 
#define LYRA24P_CMD_ATBNDD   "AT+BNDD"
 LYRA 24P bond database commands. More...
 
#define LYRA24P_CMD_ATBNDT   "AT+BNDT"
 
#define LYRA24P_CMD_ATBNDX   "AT+BNDX"
 
#define LYRA24P_CMD_ATGCTM   "AT+GCTM"
 LYRA 24P GATT client commands. More...
 
#define LYRA24P_CMD_ATGCFA   "AT+GCFA"
 
#define LYRA24P_CMD_ATGCRD   "AT+GCRD"
 
#define LYRA24P_CMD_ATGCWA   "AT+GCWA"
 
#define LYRA24P_CMD_ATGCWC   "AT+GCWC"
 
#define LYRA24P_CMD_ATLMTU   "AT+LMTU"
 
#define LYRA24P_CMD_ATGSMD   "AT+GSMD"
 LYRA 24P GATT server commands. More...
 
#define LYRA24P_CMD_ATGSCB   "AT+GSCB"
 
#define LYRA24P_CMD_ATGSCE   "AT+GSCE"
 
#define LYRA24P_CMD_ATGSSB   "AT+GSSB"
 
#define LYRA24P_CMD_ATGSSE   "AT+GSSE"
 
#define LYRA24P_CMD_ATGSNO   "AT+GSNO"
 
#define LYRA24P_CMD_ATGSWC   "AT+GSWC"
 
#define LYRA24P_CMD_ATUUID   "AT+UUID"
 
#define LYRA24P_CMD_ATI2R   "AT+I2R"
 LYRA 24P I2C commands. More...
 
#define LYRA24P_CMD_ATI2W   "AT+I2W"
 
#define LYRA24P_CMD_ATAARA   "AT+AARA"
 LYRA 24P advertising commands. More...
 
#define LYRA24P_CMD_ATACMT   "AT+ACMT"
 
#define LYRA24P_CMD_ATADAD   "AT+ADAD"
 
#define LYRA24P_CMD_ATARST   "AT+ARST"
 
#define LYRA24P_CMD_ATASRA   "AT+ASRA"
 
#define LYRA24P_CMD_ATLADV   "AT+LADV"
 
#define LYRA24P_CMD_ATLADVX   "AT+LADVX"
 
#define LYRA24P_CMD_ATEADV   "AT+EADV"
 
#define LYRA24P_CMD_ATCSEC   "AT+CSEC"
 LYRA 24P connection commands. More...
 
#define LYRA24P_CMD_ATLCON   "AT+LCON"
 
#define LYRA24P_CMD_ATLDSC   "AT+LDSC"
 
#define LYRA24P_CMD_ATLENC   "AT+LENC"
 
#define LYRA24P_CMD_ATSFMT   "AT+SFMT"
 LYRA 24P scanning commands. More...
 
#define LYRA24P_CMD_ATLSCN   "AT+LSCN"
 
#define LYRA24P_CMD_ATLSCNX   "AT+LSCNX"
 
#define LYRA24P_CMD_LPHY   "AT+LPHY"
 LYRA 24P GAP commands. More...
 
#define LYRA24P_CMD_ATPAIR   "AT+PAIR"
 LYRA 24P pairing commands. More...
 
#define LYRA24P_CMD_ATPCFG   "AT+PCFG"
 
#define LYRA24P_CMD_ATPCNF   "AT+PCNF"
 
#define LYRA24P_CMD_ATPKEY   "AT+PKEY"
 
#define LYRA24P_CMD_ATPRSP   "AT+PRSP"
 
#define LYRA24P_CMD_ATOOBL   "AT+OOBL"
 
#define LYRA24P_CMD_ATOOBR   "AT+OOBR"
 
#define LYRA24P_CMD_ATSIOC   "AT+SIOC"
 
#define LYRA24P_CMD_ATSIOR   "AT+SIOR"
 
#define LYRA24P_CMD_ATSIOW   "AT+SIOW"
 
#define LYRA24P_CMD_ATSPR   "AT+SPR"
 LYRA 24P SPI commands. More...
 
#define LYRA24P_CMD_ATSPW   "AT+SPW"
 
#define LYRA24P_CMD_ATREG   "AT+REG"
 LYRA 24P transmit power commands. More...
 
#define LYRA24P_CMD_ATTXPO   "AT+TXPO"
 
#define LYRA24P_CMD_ATUFU   "AT+UFU"
 LYRA 24P user function commands. More...
 
#define LYRA24P_CMD_ATD   "ATD"
 LYRA 24P VSP commands. More...
 
#define LYRA24P_CMD_ATLVSP   "AT+LVSP"
 
#define LYRA24P_CMD_ATZ   "ATZ"
 LYRA 24P module management commands. More...
 
#define LYRA24P_ATI_ARG_DEV_NAME   "0"
 LYRA 24P ATI commands arguments. More...
 
#define LYRA24P_ATI_ARG_FW_VER   "3"
 
#define LYRA24P_ATI_ARG_BT_ADDR   "4"
 
#define LYRA24P_ATS_ARG_DEVNAME_FORMAT   "103"
 LYRA 24P ATS commands arguments. More...
 
#define LYRA24P_ATS_VAL_DEVNAME   "0"
 
#define LYRA24P_RSP_OK   "OK"
 LYRA 24P response arguments. More...
 
#define LYRA24P_RSP_ERROR   "ERROR"
 
#define LYRA24P_PREFIX_SYMBOL_END   "\r\n"
 LYRA 24P prefix symbols. More...
 
#define LYRA24P_PREFIX_SYMBOL_QUERY   "?"
 
#define LYRA24P_PREFIX_SYMBOL_SET_VAL   "="
 
#define LYRA24P_PREFIX_SYMBOL_PLUS   "+"
 
#define LYRA24P_PREFIX_SYMBOL_SEPARATOR   ","
 
#define LYRA24P_PREFIX_SYMBOL_SPACE   " "
 
#define LYRA24P_PREFIX_SYMBOL_PERCENT   "%"
 
#define LYRA24P_PREFIX_SYMBOL_NULL   ""
 
#define LYRA24P_PREFIX_SYMBOL_QUOTE   "\""
 
#define LYRA24P_PREFIX_SYMBOL_ZERO   "0"
 
#define LYRA24P_PIN_STATE_LOW   0
 LYRA 24P pin logic states. More...
 
#define LYRA24P_PIN_STATE_HIGH   1
 
#define LYRA24P_QUERY_DIS   0
 LYRA 24P pin logic states. More...
 
#define LYRA24P_QUERY_EN   1
 
#define LYRA24P_TX_DRV_BUFFER_SIZE   100
 LYRA 24P driver buffer size. More...
 
#define LYRA24P_RX_DRV_BUFFER_SIZE   300
 
#define LYRA24P_MAP_MIKROBUS(cfg, mikrobus)
 MikroBUS pin mapping. More...
 

Enumerations

enum  lyra24p_return_value_t { LYRA24P_OK = 0, LYRA24P_ERROR = -1 }
 LYRA 24P Click return value data. More...
 

Functions

void lyra24p_cfg_setup (lyra24p_cfg_t *cfg)
 LYRA 24P configuration object setup function. More...
 
err_t lyra24p_init (lyra24p_t *ctx, lyra24p_cfg_t *cfg)
 LYRA 24P initialization function. More...
 
void lyra24p_hw_reset (lyra24p_t *ctx)
 LYRA 24P HW reset function. More...
 
void lyra24p_set_bt_pin (lyra24p_t *ctx, uint8_t state)
 LYRA 24P set BT pin state function. More...
 
void lyra24p_request_to_send (lyra24p_t *ctx, uint8_t state)
 LYRA 24P set request to send pin state function. More...
 
uint8_t lyra24p_clear_to_send (lyra24p_t *ctx)
 LYRA 24P get clear to send pin state function. More...
 
err_t lyra24p_generic_write (lyra24p_t *ctx, uint8_t *data_in, uint16_t len)
 LYRA 24P data writing function. More...
 
err_t lyra24p_generic_read (lyra24p_t *ctx, uint8_t *data_out, uint16_t len)
 LYRA 24P data reading function. More...
 
err_t lyra24p_write_command (lyra24p_t *ctx, uint8_t *command)
 LYRA 24P command writing function. More...
 
err_t lyra24p_write_cmd_param (lyra24p_t *ctx, uint8_t *command, uint8_t *cmd_val, uint8_t *prefix, uint8_t *param)
 LYRA 24P command - command value - prefix - parameter writing function. More...
 
err_t lyra24p_set_device_name (lyra24p_t *ctx, uint8_t *device_name)
 LYRA 24P set device name function. More...
 
err_t lyra24p_inquire_command (lyra24p_t *ctx, uint8_t *command, uint8_t *cmd_val, uint8_t en_query)
 LYRA 24P inquire command function. More...
 

Detailed Description

This file contains API for LYRA 24P Click Driver.

Enumeration Type Documentation

◆ lyra24p_return_value_t

LYRA 24P Click return value data.

Predefined enum values for driver return values.

Enumerator
LYRA24P_OK 
LYRA24P_ERROR