lr15 2.2.1
Loading...
Searching...
No Matches
lr15.h
Go to the documentation of this file.
1/****************************************************************************
2** Copyright (C) 2020 MikroElektronika d.o.o.
3** Contact: https://www.mikroe.com/contact
4**
5** Permission is hereby granted, free of charge, to any person obtaining a copy
6** of this software and associated documentation files (the "Software"), to deal
7** in the Software without restriction, including without limitation the rights
8** to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9** copies of the Software, and to permit persons to whom the Software is
10** furnished to do so, subject to the following conditions:
11** The above copyright notice and this permission notice shall be
12** included in all copies or substantial portions of the Software.
13**
14** THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
15** EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
16** OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
17** IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
18** DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
19** OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
20** USE OR OTHER DEALINGS IN THE SOFTWARE.
21****************************************************************************/
22
27
28#ifndef LR15_H
29#define LR15_H
30
31#ifdef __cplusplus
32extern "C"{
33#endif
34
39#ifdef PREINIT_SUPPORTED
40#include "preinit.h"
41#endif
42
43#ifdef MikroCCoreVersion
44 #if MikroCCoreVersion >= 1
45 #include "delays.h"
46 #endif
47#endif
48
49#include "drv_digital_out.h"
50#include "drv_digital_in.h"
51#include "drv_uart.h"
52
58
63
68
73#define LR15_CMD_AT "AT"
74#define LR15_CMD_VER "AT+VER"
75#define LR15_CMD_ID "AT+ID"
76#define LR15_CMD_RESET "AT+RESET"
77#define LR15_CMD_MSG "AT+MSG"
78#define LR15_CMD_CMSG "AT+CMSG"
79#define LR15_CMD_MSGHEX "AT+MSGHEX"
80#define LR15_CMD_CMSGHEX "AT+CMSGHEX"
81#define LR15_CMD_PMSG "AT+PMSG"
82#define LR15_CMD_PMSGHEX "AT+PMSGHEX"
83#define LR15_CMD_PORT "AT+PORT"
84#define LR15_CMD_ADR "AT+ADR"
85#define LR15_CMD_DR "AT+DR"
86#define LR15_CMD_CH "AT+CH"
87#define LR15_CMD_POWER "AT+POWER"
88#define LR15_CMD_REPT "AT+REPT"
89#define LR15_CMD_RETRY "AT+RETRY"
90#define LR15_CMD_RXWIN2 "AT+RXWIN2"
91#define LR15_CMD_RXWIN1 "AT+RXWIN1"
92#define LR15_CMD_KEY "AT+KEY"
93#define LR15_CMD_FDEFAULT "AT+FDEFAULT"
94#define LR15_CMD_DFU "AT+DFU"
95#define LR15_CMD_MODE "AT+MODE"
96#define LR15_CMD_JOIN "AT+JOIN"
97#define LR15_CMD_BEACON "AT+BEACON"
98#define LR15_CMD_CLASS "AT+CLASS"
99#define LR15_CMD_DELAY "AT+DELAY"
100#define LR15_CMD_LW "AT+LW"
101#define LR15_CMD_WDT "AT+WDT"
102#define LR15_CMD_LOWPOWER "AT+LOWPOWER"
103#define LR15_CMD_VDD "AT+VDD"
104#define LR15_CMD_TEMP "AT+TEMP"
105#define LR15_CMD_RTC "AT+RTC"
106#define LR15_CMD_EEPROM "AT+EEPROM"
107#define LR15_CMD_UART "AT+UART"
108#define LR15_CMD_TEST "AT+TEST"
109#define LR15_CMD_LOG "AT+LOG"
110
115#define LR10_PARAM_ID_DEVADDR "DEVADDR"
116#define LR10_PARAM_ID_DEVEUI "DEVEUI"
117#define LR10_PARAM_ID_APPEUI "APPEUI"
118#define LR10_PARAM_CH_NUM "NUM"
119#define LR10_PARAM_KEY_NWKSKEY "NWKSKEY"
120#define LR10_PARAM_KEY_APPSKEY "APPSKEY"
121#define LR15_PARAM_MODE_TEST "TEST"
122#define LR15_PARAM_MODE_LWOTAA "LWOTAA"
123#define LR15_PARAM_MODE_LWABP "LWABP"
124#define LR15_PARAM_JOIN_FORCE "FORCE"
125#define LR15_PARAM_JOIN_AUTO "AUTO"
126#define LR15_PARAM_BEACON_DMMUL "DMMUL"
127#define LR15_PARAM_BEACON_INFO "INFO"
128#define LR15_PARAM_BEACON_GWGPS "GWGPS"
129#define LR15_PARAM_DELAY_RX1 "RX1"
130#define LR15_PARAM_DELAY_RX2 "RX2"
131#define LR15_PARAM_DELAY_JRX1 "JRX1"
132#define LR15_PARAM_DELAY_JRX2 "JRX2"
133#define LR15_PARAM_LW_CDR "CDR"
134#define LR15_PARAM_LW_ULDL "ULDL"
135#define LR15_PARAM_LW_DC "DC"
136#define LR15_PARAM_LW_NET "NET"
137#define LR15_PARAM_LW_MC "MC"
138#define LR15_PARAM_LW_THLD "THLD"
139#define LR15_PARAM_LW_BAT "BAT"
140#define LR15_PARAM_LW_TPS "TPS"
141#define LR15_PARAM_LW_SCR "SCR"
142#define LR15_PARAM_LW_JDC "JDC"
143#define LR15_PARAM_LW_CT "CT"
144#define LR15_PARAM_LW_LEN "LEN"
145#define LR15_PARAM_LW_VER "VER"
146#define LR15_PARAM_LW_DTR "DTR"
147#define LR15_PARAM_LW_LCR "LCR"
148#define LR15_PARAM_LW_LDRO "LDRO"
149#define LR15_PARAM_LW_DCMRX "DCMRX"
150#define LR15_PARAM_LW_DUMRX "DUMRX"
151#define LR15_PARAM_LW_AFPACK "AFPACK"
152#define LR15_PARAM_LW_CHRB "CHRB"
153#define LR15_PARAM_RTC_ZONE "ZONE"
154#define LR15_PARAM_RTC_FULL "FULL"
155#define LR15_PARAM_RTC_LEAPSEC "LEAPSEC"
156#define LR15_PARAM_RTC_UTCMS "UTCMS"
157#define LR15_PARAM_EEPROM_ADDR "ADDR"
158#define LR15_PARAM_UART_TIMEOUT "TIMEOUT"
159#define LR15_PARAM_UART_BR "BR"
160#define LR15_PARAM_TEST_STOP "STOP"
161#define LR15_PARAM_TEST_HELP "HELP"
162#define LR15_PARAM_TEST_TXCW "TXCW"
163#define LR15_PARAM_TEST_TXCLORA "TXCLORA"
164#define LR15_PARAM_TEST_RFCFG "RFCFG"
165#define LR15_PARAM_TEST_RXLRPKT "RXLRPKT"
166#define LR15_PARAM_TEST_TXLRPKT "TXLRPKT"
167#define LR15_PARAM_TEST_TXLRSTR "TXLRSTR"
168#define LR15_PARAM_TEST_RSSI "RSSI"
169#define LR15_PARAM_LOG_DEBUG "DEBUG"
170#define LR15_PARAM_LOG_QUIET "QUIET"
171
176#define LR15_RSP_ERROR "ERROR"
177#define LR15_RSP_AT "+AT"
178#define LR15_RSP_VER "+VER"
179#define LR15_RSP_ID "+ID"
180#define LR15_RSP_RESET "+RESET"
181#define LR15_RSP_MSG "+MSG"
182#define LR15_RSP_CMSG "+CMSG"
183#define LR15_RSP_MSGHEX "+MSGHEX"
184#define LR15_RSP_CMSGHEX "+CMSGHEX"
185#define LR15_RSP_PMSG "+PMSG"
186#define LR15_RSP_PMSGHEX "+PMSGHEX"
187#define LR15_RSP_PORT "+PORT"
188#define LR15_RSP_ADR "+ADR"
189#define LR15_RSP_DR "+DR"
190#define LR15_RSP_CH "+CH"
191#define LR15_RSP_POWER "+POWER"
192#define LR15_RSP_REPT "+REPT"
193#define LR15_RSP_RETRY "+RETRY"
194#define LR15_RSP_RXWIN2 "+RXWIN2"
195#define LR15_RSP_RXWIN1 "+RXWIN1"
196#define LR15_RSP_KEY "+KEY"
197#define LR15_RSP_FDEFAULT "+FDEFAULT"
198#define LR15_RSP_DFU "+DFU"
199#define LR15_RSP_MODE "+MODE"
200#define LR15_RSP_JOIN "+JOIN"
201#define LR15_RSP_BEACON "+BEACON"
202#define LR15_RSP_CLASS "+CLASS"
203#define LR15_RSP_DELAY "+DELAY"
204#define LR15_RSP_LW "+LW"
205#define LR15_RSP_WDT "+WDT"
206#define LR15_RSP_LOWPOWER "+LOWPOWER"
207#define LR15_RSP_VDD "+VDD"
208#define LR15_RSP_TEMP "+TEMP"
209#define LR15_RSP_RTC "+RTC"
210#define LR15_RSP_EEPROM "+EEPROM"
211#define LR15_RSP_UART "+UART"
212#define LR15_RSP_TEST "+TEST"
213#define LR15_RSP_TEST_STOP "+TEST: STOP"
214#define LR15_RSP_TEST_HELP "+TEST: HELP"
215#define LR15_RSP_TEST_TXCW "+TEST: TXCW"
216#define LR15_RSP_TEST_TXCLORA "+TEST: TXCLORA"
217#define LR15_RSP_TEST_RFCFG "+TEST: RFCFG"
218#define LR15_RSP_TEST_RXLRPKT "+TEST: RXLRPKT"
219#define LR15_RSP_TEST_TXLRPKT "+TEST: TXLRPKT"
220#define LR15_RSP_TEST_TXLRSTR "+TEST: TXLRSTR"
221#define LR15_RSP_TEST_TX_DONE "+TEST: TX DONE"
222#define LR15_RSP_TEST_RXLEN "+TEST: LEN:"
223#define LR15_RSP_TEST_RX "+TEST: RX "
224#define LR15_RSP_LOG "+LOG"
225#define LR15_RSP_TIMEOUT_DEFAULT 2000
226
232#define LR15_TX_DRV_BUFFER_SIZE 200
233#define LR15_RX_DRV_BUFFER_SIZE 600
234 // lr15_cmd
236
241
246
251#define LR15_MAP_MIKROBUS( cfg, mikrobus ) \
252 cfg.tx_pin = MIKROBUS( mikrobus, MIKROBUS_TX ); \
253 cfg.rx_pin = MIKROBUS( mikrobus, MIKROBUS_RX ); \
254 cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
255 cfg.boot = MIKROBUS( mikrobus, MIKROBUS_PWM );
256 // lr15_map // lr15
259
264typedef struct
265{
266 // Output pins
267 digital_out_t rst;
268 digital_out_t boot;
269
270 // Modules
271 uart_t uart;
272
273 // Buffers
277
278} lr15_t;
279
284typedef struct
285{
286 // Communication gpio pins
287 pin_name_t rx_pin;
288 pin_name_t tx_pin;
289
290 // Additional gpio pins
291 pin_name_t rst;
292 pin_name_t boot;
293
294 // Static variable
295 uint32_t baud_rate;
297 uart_data_bits_t data_bit;
298 uart_parity_t parity_bit;
299 uart_stop_bits_t stop_bit;
300
301} lr15_cfg_t;
302
315
321
332
346err_t lr15_init ( lr15_t *ctx, lr15_cfg_t *cfg );
347
360err_t lr15_generic_write ( lr15_t *ctx, uint8_t *data_in, uint16_t len );
361
374err_t lr15_generic_read ( lr15_t *ctx, uint8_t *data_out, uint16_t len );
375
385void lr15_set_rst_pin ( lr15_t *ctx, uint8_t state );
386
396void lr15_set_boot_pin ( lr15_t *ctx, uint8_t state );
397
407
417void lr15_cmd_run ( lr15_t *ctx, uint8_t *cmd );
418
429void lr15_cmd_set ( lr15_t *ctx, uint8_t *cmd, uint8_t *value );
430
440void lr15_cmd_get ( lr15_t *ctx, uint8_t *cmd );
441
453void lr15_cmd_param_set ( lr15_t *ctx, uint8_t *cmd, uint8_t *param, uint8_t *value );
454
465void lr15_cmd_param_get ( lr15_t *ctx, uint8_t *cmd, uint8_t *param );
466
467#ifdef __cplusplus
468}
469#endif
470#endif // LR15_H
471 // lr15
473
474// ------------------------------------------------------------------------ END
#define LR15_TX_DRV_BUFFER_SIZE
LR 15 driver buffer size.
Definition lr15.h:232
#define LR15_RX_DRV_BUFFER_SIZE
Definition lr15.h:233
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.
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.
err_t lr15_generic_write(lr15_t *ctx, uint8_t *data_in, uint16_t len)
LR 15 data writing function.
void lr15_set_rst_pin(lr15_t *ctx, uint8_t state)
LR 15 set RST pin function.
void lr15_cmd_param_set(lr15_t *ctx, uint8_t *cmd, uint8_t *param, uint8_t *value)
LR 15 cmd param set function.
err_t lr15_generic_read(lr15_t *ctx, uint8_t *data_out, uint16_t len)
LR 15 data reading function.
void lr15_cmd_get(lr15_t *ctx, uint8_t *cmd)
LR 15 cmd get function.
void lr15_set_boot_pin(lr15_t *ctx, uint8_t state)
LR 15 set BOOT pin function.
void lr15_cmd_set(lr15_t *ctx, uint8_t *cmd, uint8_t *value)
LR 15 cmd set function.
void lr15_cmd_param_get(lr15_t *ctx, uint8_t *cmd, uint8_t *param)
LR 15 cmd param get function.
lr15_return_value_t
LR 15 Click return value data.
Definition lr15.h:308
@ LR15_ERROR
Definition lr15.h:310
@ LR15_OK
Definition lr15.h:309
@ LR15_ERROR_TIMEOUT
Definition lr15.h:311
@ LR15_ERROR_CMD
Definition lr15.h:312
LR 15 Click configuration object.
Definition lr15.h:285
uint32_t baud_rate
Definition lr15.h:295
pin_name_t boot
Definition lr15.h:292
bool uart_blocking
Definition lr15.h:296
uart_data_bits_t data_bit
Definition lr15.h:297
pin_name_t tx_pin
Definition lr15.h:288
pin_name_t rx_pin
Definition lr15.h:287
uart_stop_bits_t stop_bit
Definition lr15.h:299
uart_parity_t parity_bit
Definition lr15.h:298
pin_name_t rst
Definition lr15.h:291
LR 15 Click context object.
Definition lr15.h:265
uint8_t uart_rx_buffer[LR15_RX_DRV_BUFFER_SIZE]
Definition lr15.h:274
uint8_t uart_tx_buffer[LR15_TX_DRV_BUFFER_SIZE]
Definition lr15.h:275
uart_t uart
Definition lr15.h:271
digital_out_t rst
Definition lr15.h:267
uint8_t cmd_buffer[LR15_TX_DRV_BUFFER_SIZE]
Definition lr15.h:276
digital_out_t boot
Definition lr15.h:268