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

This file contains API for LR 2 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  lr2_buffers_t
 Click buffers object definition. More...
 
struct  lr2_timer_t
 Timer Flags and Counter object definition. More...
 
struct  lr2_procces_flags_t
 Process Flags object definition. More...
 
struct  lr2_response_t
 Response object definition. More...
 
struct  lr2_mac_t
 Mac object definition. More...
 
struct  lr2_t
 LR 2 Click context object. More...
 
struct  lr2_cfg_t
 LR 2 Click configuration object. More...
 

Macros

#define LR2_CMD_SYS_GET_VER   "sys get ver"
 LR 2 Click Commands. More...
 
#define LR2_CMD_MAC_PAUSE   "mac pause"
 
#define LR2_CMD_RADIO_SET_WDT   "radio set wdt 0"
 
#define LR2_ARG_0   "0"
 
#define LR2_JM_OTAA   "otaa"
 LR 2 Join mode. More...
 
#define LR2_JM_ABP   "abp"
 
#define LR2_PL_CNF   "cnf "
 LR 2 Payload. More...
 
#define LR2_PL_UNCNF   "uncnf "
 
#define LR2_MAX_DATA_SIZE   256
 LR 2 Command String Max Size. More...
 
#define LR2_MAX_TRANSFER_SIZE   384
 
#define LR2_MAX_CMD_SIZE   64
 
#define LR2_MAX_RSP_SIZE   20
 LR 2 Response String Max Size. More...
 
#define LR2_RESP_COUNT   100
 LR 2 Number of Response Indexes. More...
 
#define LR2_TIMER_EXPIRED   50000
 LR 2 Timer Limit. More...
 
#define LR2_MAC_TX   "mac tx "
 LR 2 Variables. More...
 
#define LR2_JOIN   "mac join "
 
#define LR2_RADIO_TX   "radio tx "
 
#define LR2_RADIO_RX   "radio rx "
 
#define DRV_RX_BUFFER_SIZE   300
 LR 2 driver buffer size. More...
 
#define LR2_MAP_MIKROBUS(cfg, mikrobus)
 MikroBUS pin mapping. More...
 

Enumerations

enum  lr2_return_value_t { LR2_OK = 0, LR2_ERROR = -1 }
 LR 2 Click return value data. More...
 

Functions

void lr2_cfg_setup (lr2_cfg_t *cfg)
 LR2 configuration object setup function. More...
 
err_t lr2_init (lr2_t *ctx, lr2_cfg_t *cfg)
 LR 2 initialization function. More...
 
void lr2_default_cfg (lr2_t *ctx, bool cb_default, void(*response_p)(char *response))
 LR 2 default configuration function. More...
 
void lr2_generic_write (lr2_t *ctx, char *data_buf, uint16_t len)
 LR 2 data writing function. More...
 
int32_t lr2_generic_read (lr2_t *ctx, char *data_buf, uint16_t max_len)
 LR 2 data reading function. More...
 
void lr2_cmd (lr2_t *ctx, char *cmd, char *response)
 Send command function. More...
 
uint8_t lr2_mac_tx (lr2_t *ctx, lr2_mac_t *mac)
 Function for writing mac parameters. More...
 
uint8_t lr2_join (lr2_t *ctx, char *join_mode, char *response)
 Function for setting join mode. More...
 
uint8_t lr2_rx (lr2_t *ctx, char *window_size, char *response)
 Main receiver function
More...
 
uint8_t lr2_tx (lr2_t *ctx, char *buffer)
 Main tnanceiver function. More...
 
void lr2_rx_isr (lr2_t *ctx, char rx_input)
 Receiver. More...
 
void lr2_tick_isr (lr2_t *ctx)
 Timer. More...
 
void lr2_tick_conf (lr2_t *ctx, uint32_t timer_limit)
 Timer Configuration. More...
 
void lr2_isr_process (lr2_t *ctx)
 Main Process. More...
 
void lr2_put_char (lr2_t *ctx, char data_in)
 Function for write char. More...
 

Detailed Description

This file contains API for LR 2 Click Driver.

Enumeration Type Documentation

◆ lr2_return_value_t

LR 2 Click return value data.

Predefined enum values for driver return values.

Enumerator
LR2_OK 
LR2_ERROR