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

This file contains API for LR 11 868MHz 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  lr11868mhz_t
 LR 11 868MHz Click context object. More...
 
struct  lr11868mhz_cfg_t
 LR 11 868MHz Click configuration object. More...
 

Macros

#define LR11868MHZ_CMD_AT   "AT"
 LR 11 868MHz control commands. More...
 
#define LR11868MHZ_CMD_FACTORY_RESET   "AT&F"
 
#define LR11868MHZ_CMD_SAVE_SETTINGS   "AT&W"
 
#define LR11868MHZ_CMD_WARM_RESET   "ATZ"
 
#define LR11868MHZ_CMD_GET_INFO   "ATI"
 
#define LR11868MHZ_CMD_PARAM_ACCESS_STR   "AT%S"
 
#define LR11868MHZ_CMD_PARAM_ACCESS_NUM   "ATS"
 
#define LR11868MHZ_CMD_I2C_READ   "AT+I2R"
 
#define LR11868MHZ_CMD_I2C_WRITE   "AT+I2W"
 
#define LR11868MHZ_CMD_NET_DROP   "AT+DROP"
 
#define LR11868MHZ_CMD_NET_JOIN   "AT+JOIN"
 
#define LR11868MHZ_CMD_NET_CHECK_LINK   "AT+LINKC"
 
#define LR11868MHZ_CMD_NET_SEND_DATA   "AT+SEND"
 
#define LR11868MHZ_CMD_NET_GET_TIME   "AT+TIME"
 
#define LR11868MHZ_CMD_GROUP_CREATE   "AT+MCGA"
 
#define LR11868MHZ_CMD_GROUP_REMOVE   "AT+MCGR"
 
#define LR11868MHZ_CMD_GROUP_START   "AT+MCGS"
 
#define LR11868MHZ_CMD_GROUP_END   "AT+MCGE"
 
#define LR11868MHZ_CMD_GROUP_LIST   "AT+MCGL"
 
#define LR11868MHZ_CMD_P2P_END_SESSION   "AT+P2PE"
 
#define LR11868MHZ_CMD_P2P_START_SESSION   "AT+P2PS"
 
#define LR11868MHZ_CMD_P2P_SEND_DATA   "AT+P2PT"
 
#define LR11868MHZ_CMD_SIO_CONFIG   "AT+SIOC"
 
#define LR11868MHZ_CMD_SIO_READ   "AT+SIOR"
 
#define LR11868MHZ_CMD_SIO_WRITE   "AT+SIOW"
 
#define LR11868MHZ_CMD_SPI_READ   "AT+SPR"
 
#define LR11868MHZ_CMD_SPI_WRITE   "AT+SPW"
 
#define LR11868MHZ_PARAM_DEVICE_TYPE   "0"
 LR 11 868MHz get info (ATI) command parameters. More...
 
#define LR11868MHZ_PARAM_APP_FW_VERSION   "3"
 
#define LR11868MHZ_PARAM_APP_STATE   "42"
 
#define LR11868MHZ_PARAM_MIN_BAUD_RATE   "1002"
 
#define LR11868MHZ_PARAM_MAX_BAUD_RATE   "1003"
 
#define LR11868MHZ_PARAM_RESET_REASON   "2000"
 
#define LR11868MHZ_PARAM_RESET_CAUSE   "2001"
 
#define LR11868MHZ_PARAM_TX_POWER   "2008"
 
#define LR11868MHZ_PARAM_RADIO_ACTIVITY   "2016"
 
#define LR11868MHZ_PARAM_BANDWIDTH   "3000"
 
#define LR11868MHZ_PARAM_CONNECTION_STATUS   "3001"
 
#define LR11868MHZ_PARAM_DEVICE_ADDRESS   "3002"
 
#define LR11868MHZ_PARAM_BOOTLOADER_VERSION   "3003"
 
#define LR11868MHZ_PARAM_MODULATION_TYPE   "3004"
 
#define LR11868MHZ_PARAM_MODULE_TYPE   "3005"
 
#define LR11868MHZ_PARAM_PACKETS_RXED   "3006"
 
#define LR11868MHZ_PARAM_PACKETS_TXED   "3007"
 
#define LR11868MHZ_PARAM_RSSI   "3008"
 
#define LR11868MHZ_PARAM_SNR   "3009"
 
#define LR11868MHZ_PARAM_SPREADING_FACTOR   "3010"
 
#define LR11868MHZ_PARAM_P2P_BEACON_TOA   "4000"
 
#define LR11868MHZ_PARAM_P2P_BEACON_SETTLE_TIME   "4001"
 
#define LR11868MHZ_PARAM_P2P_SLOT_TOA   "4002"
 
#define LR11868MHZ_PARAM_P2P_SLOT_PACKET_SIZE   "4003"
 
#define LR11868MHZ_PARAM_P2P_SLOT_DELAY   "4004"
 
#define LR11868MHZ_PARAM_P2P_MIN_WINDOW_LENGTH   "4005"
 
#define LR11868MHZ_PARAM_P2P_MAX_SLOTS_PER_WINDOW   "4006"
 
#define LR11868MHZ_PARAM_ID_DEVICE_NAME   "0"
 LR 11 868MHz param access string (ATS) command parameters ID. More...
 
#define LR11868MHZ_PARAM_ID_APP_KEY   "500"
 
#define LR11868MHZ_PARAM_ID_DEV_EUI   "501"
 
#define LR11868MHZ_PARAM_ID_JOIN_EUI   "502"
 
#define LR11868MHZ_PARAM_ID_ABP_P2P_ADDRESS   "635"
 
#define LR11868MHZ_PARAM_ID_ABP_P2P_NET_KEY   "636"
 
#define LR11868MHZ_PARAM_ID_ABP_P2P_APP_KEY   "637"
 
#define LR11868MHZ_PARAM_ID_START_FLAGS   "100"
 LR 11 868MHz param access numeric (ATS) command parameters ID. More...
 
#define LR11868MHZ_PARAM_ID_SIO_NET   "117"
 
#define LR11868MHZ_PARAM_ID_UART_IDLE_TIME   "213"
 
#define LR11868MHZ_PARAM_ID_CORE_VOLTAGE   "217"
 
#define LR11868MHZ_PARAM_ID_UART_BAUD_RATE   "302"
 
#define LR11868MHZ_PARAM_ID_ADR_ENABLED   "600"
 
#define LR11868MHZ_PARAM_ID_BEACON_FREQ   "601"
 
#define LR11868MHZ_PARAM_ID_ACTIVATION_MODE   "602"
 
#define LR11868MHZ_PARAM_ID_DEVICE_CLASS   "603"
 
#define LR11868MHZ_PARAM_ID_CONFIRMED_PACKETS   "604"
 
#define LR11868MHZ_PARAM_ID_CONFIRMED_RETRY_COUNT   "605"
 
#define LR11868MHZ_PARAM_ID_JOIN_DELAY   "606"
 
#define LR11868MHZ_PARAM_ID_JOIN_JITTER   "607"
 
#define LR11868MHZ_PARAM_ID_PING_SLOT_PERIODICITY   "609"
 
#define LR11868MHZ_PARAM_ID_REGION   "611"
 
#define LR11868MHZ_PARAM_ID_REQUEST_COUNT   "612"
 
#define LR11868MHZ_PARAM_ID_RX1_DELAY   "613"
 
#define LR11868MHZ_PARAM_ID_SUB_BAND   "617"
 
#define LR11868MHZ_PARAM_ID_APP_PORT   "629"
 
#define LR11868MHZ_PARAM_ID_CLASS_C_SCAN_TIME   "633"
 
#define LR11868MHZ_PARAM_ID_P2P_DEVICE_ADDRESS   "700"
 
#define LR11868MHZ_PARAM_ID_P2P_NET_SIZE   "701"
 
#define LR11868MHZ_PARAM_ID_P2P_WINDOW_LENGTH   "702"
 
#define LR11868MHZ_PARAM_ID_P2P_DATA_RATE   "703"
 
#define LR11868MHZ_PARAM_ID_P2P_LISTEN_DURATION   "704"
 
#define LR11868MHZ_PARAM_ID_P2P_LISTEN_INTERVAL   "705"
 
#define LR11868MHZ_PARAM_ID_P2P_BEACON_DATA_RATE   "706"
 
#define LR11868MHZ_PARAM_ID_P2P_PACKET_SIZE   "707"
 
#define LR11868MHZ_PARAM_ID_P2P_TX_POWER   "708"
 
#define LR11868MHZ_PARAM_ID_PUBLIC_MODE   "709"
 
#define LR11868MHZ_PARAM_ID_SLOTS_PER_WINDOW   "710"
 
#define LR11868MHZ_RSP_OK   "OK"
 LR 11 868MHz device response for AT commands. More...
 
#define LR11868MHZ_RSP_ERROR   "ERROR"
 
#define LR11868MHZ_EVT_CLASS   "CLASS "
 LR 11 868MHz device events settings. More...
 
#define LR11868MHZ_EVT_JOIN   "JOIN ["
 
#define LR11868MHZ_EVT_LINK_CHECK   "LC S:"
 
#define LR11868MHZ_EVT_RX_LNS   "RX: W:"
 
#define LR11868MHZ_EVT_RX_P2P   "RX: [P2P] S:"
 
#define LR11868MHZ_EVT_TIME   "TIME ["
 
#define LR11868MHZ_EVT_TX   "TX ["
 
#define LR11868MHZ_EVT_WAKE   "WAKE"
 
#define LR11868MHZ_TX_DRV_BUFFER_SIZE   200
 LR 11 868MHz driver buffer size. More...
 
#define LR11868MHZ_RX_DRV_BUFFER_SIZE   600
 
#define LR11868MHZ_MAP_MIKROBUS(cfg, mikrobus)
 MikroBUS pin mapping. More...
 

Enumerations

enum  lr11868mhz_return_value_t { LR11868MHZ_OK = 0, LR11868MHZ_ERROR = -1, LR11868MHZ_ERROR_TIMEOUT = -2, LR11868MHZ_ERROR_CMD = -3 }
 LR 11 868MHz Click return value data. More...
 

Functions

void lr11868mhz_cfg_setup (lr11868mhz_cfg_t *cfg)
 LR 11 868MHz configuration object setup function. More...
 
err_t lr11868mhz_init (lr11868mhz_t *ctx, lr11868mhz_cfg_t *cfg)
 LR 11 868MHz initialization function. More...
 
err_t lr11868mhz_generic_write (lr11868mhz_t *ctx, uint8_t *data_in, uint16_t len)
 LR 11 868MHz data writing function. More...
 
err_t lr11868mhz_generic_read (lr11868mhz_t *ctx, uint8_t *data_out, uint16_t len)
 LR 11 868MHz data reading function. More...
 
void lr11868mhz_set_rst_pin (lr11868mhz_t *ctx, uint8_t state)
 LR 11 868MHz set RST pin function. More...
 
void lr11868mhz_reset_device (lr11868mhz_t *ctx)
 LR 11 868MHz reset device function. More...
 
void lr11868mhz_set_cts_pin (lr11868mhz_t *ctx, uint8_t state)
 LR 11 868MHz set CTS pin function. More...
 
uint8_t lr11868mhz_get_rts_pin (lr11868mhz_t *ctx)
 LR 11 868MHz get RTS pin function. More...
 
void lr11868mhz_cmd_run (lr11868mhz_t *ctx, uint8_t *cmd, uint8_t *param)
 LR 11 868MHz cmd run function. More...
 
void lr11868mhz_cmd_set (lr11868mhz_t *ctx, uint8_t *cmd, uint8_t *param_id, uint8_t *value)
 LR 11 868MHz cmd set function. More...
 
void lr11868mhz_cmd_get (lr11868mhz_t *ctx, uint8_t *cmd, uint8_t *param_id)
 LR 11 868MHz cmd get function. More...
 
void lr11868mhz_cmd_help (lr11868mhz_t *ctx, uint8_t *cmd, uint8_t *param_id)
 LR 11 868MHz cmd help function. More...
 

Detailed Description

This file contains API for LR 11 868MHz Click Driver.

Enumeration Type Documentation

◆ lr11868mhz_return_value_t

LR 11 868MHz Click return value data.

Predefined enum values for driver return values.

Enumerator
LR11868MHZ_OK 
LR11868MHZ_ERROR 
LR11868MHZ_ERROR_TIMEOUT 
LR11868MHZ_ERROR_CMD