lr15 2.2.1
Loading...
Searching...
No Matches
lr15.h File Reference

This file contains API for LR 15 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  lr15_t
 LR 15 Click context object. More...
struct  lr15_cfg_t
 LR 15 Click configuration object. More...

Macros

#define LR15_CMD_AT   "AT"
 LR 15 control commands.
#define LR15_CMD_VER   "AT+VER"
#define LR15_CMD_ID   "AT+ID"
#define LR15_CMD_RESET   "AT+RESET"
#define LR15_CMD_MSG   "AT+MSG"
#define LR15_CMD_CMSG   "AT+CMSG"
#define LR15_CMD_MSGHEX   "AT+MSGHEX"
#define LR15_CMD_CMSGHEX   "AT+CMSGHEX"
#define LR15_CMD_PMSG   "AT+PMSG"
#define LR15_CMD_PMSGHEX   "AT+PMSGHEX"
#define LR15_CMD_PORT   "AT+PORT"
#define LR15_CMD_ADR   "AT+ADR"
#define LR15_CMD_DR   "AT+DR"
#define LR15_CMD_CH   "AT+CH"
#define LR15_CMD_POWER   "AT+POWER"
#define LR15_CMD_REPT   "AT+REPT"
#define LR15_CMD_RETRY   "AT+RETRY"
#define LR15_CMD_RXWIN2   "AT+RXWIN2"
#define LR15_CMD_RXWIN1   "AT+RXWIN1"
#define LR15_CMD_KEY   "AT+KEY"
#define LR15_CMD_FDEFAULT   "AT+FDEFAULT"
#define LR15_CMD_DFU   "AT+DFU"
#define LR15_CMD_MODE   "AT+MODE"
#define LR15_CMD_JOIN   "AT+JOIN"
#define LR15_CMD_BEACON   "AT+BEACON"
#define LR15_CMD_CLASS   "AT+CLASS"
#define LR15_CMD_DELAY   "AT+DELAY"
#define LR15_CMD_LW   "AT+LW"
#define LR15_CMD_WDT   "AT+WDT"
#define LR15_CMD_LOWPOWER   "AT+LOWPOWER"
#define LR15_CMD_VDD   "AT+VDD"
#define LR15_CMD_TEMP   "AT+TEMP"
#define LR15_CMD_RTC   "AT+RTC"
#define LR15_CMD_EEPROM   "AT+EEPROM"
#define LR15_CMD_UART   "AT+UART"
#define LR15_CMD_TEST   "AT+TEST"
#define LR15_CMD_LOG   "AT+LOG"
#define LR10_PARAM_ID_DEVADDR   "DEVADDR"
 LR 15 command parameters list.
#define LR10_PARAM_ID_DEVEUI   "DEVEUI"
#define LR10_PARAM_ID_APPEUI   "APPEUI"
#define LR10_PARAM_CH_NUM   "NUM"
#define LR10_PARAM_KEY_NWKSKEY   "NWKSKEY"
#define LR10_PARAM_KEY_APPSKEY   "APPSKEY"
#define LR15_PARAM_MODE_TEST   "TEST"
#define LR15_PARAM_MODE_LWOTAA   "LWOTAA"
#define LR15_PARAM_MODE_LWABP   "LWABP"
#define LR15_PARAM_JOIN_FORCE   "FORCE"
#define LR15_PARAM_JOIN_AUTO   "AUTO"
#define LR15_PARAM_BEACON_DMMUL   "DMMUL"
#define LR15_PARAM_BEACON_INFO   "INFO"
#define LR15_PARAM_BEACON_GWGPS   "GWGPS"
#define LR15_PARAM_DELAY_RX1   "RX1"
#define LR15_PARAM_DELAY_RX2   "RX2"
#define LR15_PARAM_DELAY_JRX1   "JRX1"
#define LR15_PARAM_DELAY_JRX2   "JRX2"
#define LR15_PARAM_LW_CDR   "CDR"
#define LR15_PARAM_LW_ULDL   "ULDL"
#define LR15_PARAM_LW_DC   "DC"
#define LR15_PARAM_LW_NET   "NET"
#define LR15_PARAM_LW_MC   "MC"
#define LR15_PARAM_LW_THLD   "THLD"
#define LR15_PARAM_LW_BAT   "BAT"
#define LR15_PARAM_LW_TPS   "TPS"
#define LR15_PARAM_LW_SCR   "SCR"
#define LR15_PARAM_LW_JDC   "JDC"
#define LR15_PARAM_LW_CT   "CT"
#define LR15_PARAM_LW_LEN   "LEN"
#define LR15_PARAM_LW_VER   "VER"
#define LR15_PARAM_LW_DTR   "DTR"
#define LR15_PARAM_LW_LCR   "LCR"
#define LR15_PARAM_LW_LDRO   "LDRO"
#define LR15_PARAM_LW_DCMRX   "DCMRX"
#define LR15_PARAM_LW_DUMRX   "DUMRX"
#define LR15_PARAM_LW_AFPACK   "AFPACK"
#define LR15_PARAM_LW_CHRB   "CHRB"
#define LR15_PARAM_RTC_ZONE   "ZONE"
#define LR15_PARAM_RTC_FULL   "FULL"
#define LR15_PARAM_RTC_LEAPSEC   "LEAPSEC"
#define LR15_PARAM_RTC_UTCMS   "UTCMS"
#define LR15_PARAM_EEPROM_ADDR   "ADDR"
#define LR15_PARAM_UART_TIMEOUT   "TIMEOUT"
#define LR15_PARAM_UART_BR   "BR"
#define LR15_PARAM_TEST_STOP   "STOP"
#define LR15_PARAM_TEST_HELP   "HELP"
#define LR15_PARAM_TEST_TXCW   "TXCW"
#define LR15_PARAM_TEST_TXCLORA   "TXCLORA"
#define LR15_PARAM_TEST_RFCFG   "RFCFG"
#define LR15_PARAM_TEST_RXLRPKT   "RXLRPKT"
#define LR15_PARAM_TEST_TXLRPKT   "TXLRPKT"
#define LR15_PARAM_TEST_TXLRSTR   "TXLRSTR"
#define LR15_PARAM_TEST_RSSI   "RSSI"
#define LR15_PARAM_LOG_DEBUG   "DEBUG"
#define LR15_PARAM_LOG_QUIET   "QUIET"
#define LR15_RSP_ERROR   "ERROR"
 LR 15 device response for AT commands.
#define LR15_RSP_AT   "+AT"
#define LR15_RSP_VER   "+VER"
#define LR15_RSP_ID   "+ID"
#define LR15_RSP_RESET   "+RESET"
#define LR15_RSP_MSG   "+MSG"
#define LR15_RSP_CMSG   "+CMSG"
#define LR15_RSP_MSGHEX   "+MSGHEX"
#define LR15_RSP_CMSGHEX   "+CMSGHEX"
#define LR15_RSP_PMSG   "+PMSG"
#define LR15_RSP_PMSGHEX   "+PMSGHEX"
#define LR15_RSP_PORT   "+PORT"
#define LR15_RSP_ADR   "+ADR"
#define LR15_RSP_DR   "+DR"
#define LR15_RSP_CH   "+CH"
#define LR15_RSP_POWER   "+POWER"
#define LR15_RSP_REPT   "+REPT"
#define LR15_RSP_RETRY   "+RETRY"
#define LR15_RSP_RXWIN2   "+RXWIN2"
#define LR15_RSP_RXWIN1   "+RXWIN1"
#define LR15_RSP_KEY   "+KEY"
#define LR15_RSP_FDEFAULT   "+FDEFAULT"
#define LR15_RSP_DFU   "+DFU"
#define LR15_RSP_MODE   "+MODE"
#define LR15_RSP_JOIN   "+JOIN"
#define LR15_RSP_BEACON   "+BEACON"
#define LR15_RSP_CLASS   "+CLASS"
#define LR15_RSP_DELAY   "+DELAY"
#define LR15_RSP_LW   "+LW"
#define LR15_RSP_WDT   "+WDT"
#define LR15_RSP_LOWPOWER   "+LOWPOWER"
#define LR15_RSP_VDD   "+VDD"
#define LR15_RSP_TEMP   "+TEMP"
#define LR15_RSP_RTC   "+RTC"
#define LR15_RSP_EEPROM   "+EEPROM"
#define LR15_RSP_UART   "+UART"
#define LR15_RSP_TEST   "+TEST"
#define LR15_RSP_TEST_STOP   "+TEST: STOP"
#define LR15_RSP_TEST_HELP   "+TEST: HELP"
#define LR15_RSP_TEST_TXCW   "+TEST: TXCW"
#define LR15_RSP_TEST_TXCLORA   "+TEST: TXCLORA"
#define LR15_RSP_TEST_RFCFG   "+TEST: RFCFG"
#define LR15_RSP_TEST_RXLRPKT   "+TEST: RXLRPKT"
#define LR15_RSP_TEST_TXLRPKT   "+TEST: TXLRPKT"
#define LR15_RSP_TEST_TXLRSTR   "+TEST: TXLRSTR"
#define LR15_RSP_TEST_TX_DONE   "+TEST: TX DONE"
#define LR15_RSP_TEST_RXLEN   "+TEST: LEN:"
#define LR15_RSP_TEST_RX   "+TEST: RX "
#define LR15_RSP_LOG   "+LOG"
#define LR15_RSP_TIMEOUT_DEFAULT   2000
#define LR15_TX_DRV_BUFFER_SIZE   200
 LR 15 driver buffer size.
#define LR15_RX_DRV_BUFFER_SIZE   600
#define LR15_MAP_MIKROBUS(cfg, mikrobus)
 MikroBUS pin mapping.

Enumerations

enum  lr15_return_value_t { LR15_OK = 0 , LR15_ERROR = -1 , LR15_ERROR_TIMEOUT = -2 , LR15_ERROR_CMD = -3 }
 LR 15 Click return value data. More...

Functions

void lr15_cfg_setup (lr15_cfg_t *cfg)
 LR 15 configuration object setup function.
err_t lr15_init (lr15_t *ctx, lr15_cfg_t *cfg)
 LR 15 initialization function.
err_t lr15_generic_write (lr15_t *ctx, uint8_t *data_in, uint16_t len)
 LR 15 data writing function.
err_t lr15_generic_read (lr15_t *ctx, uint8_t *data_out, uint16_t len)
 LR 15 data reading function.
void lr15_set_rst_pin (lr15_t *ctx, uint8_t state)
 LR 15 set RST pin function.
void lr15_set_boot_pin (lr15_t *ctx, uint8_t state)
 LR 15 set BOOT pin function.
void lr15_reset_device (lr15_t *ctx)
 LR 15 reset device function.
void lr15_cmd_run (lr15_t *ctx, uint8_t *cmd)
 LR 15 cmd run function.
void lr15_cmd_set (lr15_t *ctx, uint8_t *cmd, uint8_t *value)
 LR 15 cmd set function.
void lr15_cmd_get (lr15_t *ctx, uint8_t *cmd)
 LR 15 cmd get function.
void lr15_cmd_param_set (lr15_t *ctx, uint8_t *cmd, uint8_t *param, uint8_t *value)
 LR 15 cmd param set function.
void lr15_cmd_param_get (lr15_t *ctx, uint8_t *cmd, uint8_t *param)
 LR 15 cmd param get function.

Detailed Description

This file contains API for LR 15 Click Driver.

Enumeration Type Documentation

◆ lr15_return_value_t

LR 15 Click return value data.

Predefined enum values for driver return values.

Enumerator
LR15_OK 
LR15_ERROR 
LR15_ERROR_TIMEOUT 
LR15_ERROR_CMD