lr2  2.1.0.0
lr2.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 
28 #ifndef LR2_H
29 #define LR2_H
30 
31 #ifdef __cplusplus
32 extern "C"{
33 #endif
34 
35 #include "drv_digital_out.h"
36 #include "drv_digital_in.h"
37 #include "drv_uart.h"
38 
59 #define LR2_CMD_SYS_GET_VER "sys get ver"
60 #define LR2_CMD_MAC_PAUSE "mac pause"
61 #define LR2_CMD_RADIO_SET_WDT "radio set wdt 0"
62 #define LR2_ARG_0 "0"
63 
68 #define LR2_JM_OTAA "otaa"
69 #define LR2_JM_ABP "abp"
70 
75 #define LR2_PL_CNF "cnf "
76 #define LR2_PL_UNCNF "uncnf "
77 
82 #define LR2_INVALID_PARAM 1
83 #define LR2_NOT_JOINED 2
84 #define LR2_NO_FREE_CH 3
85 #define LR2_SILENT 4
86 #define LR2_ERR_REJOIN_NEEDED 5
87 #define LR2_BUSY 6
88 #define LR2_MAC_PAUSED 7
89 #define LR2_INVALID_PAR_DATA_LEN 8
90 #define LR2_KEYS_NOT_INIT 9
91 #define LR2_MAC_ERR 10
92 #define LR2_MAC_RX 12
93 #define LR2_INVALID_REPAR_DATA_LEN 13
94 #define LR2_RADIO_ERR 14
95 #define LR2_DENIED 18
96 
101 #define LR2_MAX_DATA_SIZE 256
102 #define LR2_MAX_TRANSFER_SIZE 384
103 
104 #define LR2_MAX_CMD_SIZE 64
105 
110 #define LR2_MAX_RSP_SIZE 20
111 
116 #define LR2_RESP_COUNT 100
117 
122 #define LR2_TIMER_EXPIRED 50000
123 
128 #define LR2_MAC_TX "mac tx "
129 #define LR2_JOIN "mac join "
130 #define LR2_RADIO_TX "radio tx "
131 #define LR2_RADIO_RX "radio rx "
132 
138 #define LR2_DRV_RX_BUFFER_SIZE 300
139 #define LR2_DRV_TX_BUFFER_SIZE 100
140  // lr2_set
142 
157 #define LR2_MAP_MIKROBUS( cfg, mikrobus ) \
158  cfg.tx_pin = MIKROBUS( mikrobus, MIKROBUS_TX ); \
159  cfg.rx_pin = MIKROBUS( mikrobus, MIKROBUS_RX ); \
160  cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
161  cfg.rts = MIKROBUS( mikrobus, MIKROBUS_CS ); \
162  cfg.cts = MIKROBUS( mikrobus, MIKROBUS_INT )
163  // lr2_map // lr2
166 
171 typedef struct
172 {
173  char tx_buffer[ LR2_MAX_TRANSFER_SIZE ];
174  char rx_buffer[ LR2_MAX_TRANSFER_SIZE ];
175  uint16_t rx_buffer_len;
176 
177 } lr2_buffers_t;
178 
183 typedef struct
184 {
185  bool timer_f;
186  bool timeout_f;
188  uint32_t ticker;
189  uint32_t timer_max;
190 
191 } lr2_timer_t;
192 
197 typedef struct
198 {
199  bool rsp_rdy_f;
200  bool lr2_rdy_f;
201 
203 
208 typedef struct
209 {
210  bool rsp_f;
211  char *rsp_buffer;
213  void ( *callback_resp )( char *response );
214 
216 
221 typedef struct
222 {
223  char *payload;
224  char *port_no;
225  char *buffer;
226  char *response;
227 
228 } lr2_mac_t;
229 
234 typedef struct
235 {
236  // Output pins
237  digital_out_t rst;
238  digital_out_t rts;
240  // Input pins
241  digital_in_t cts;
243  // Modules
244  uart_t uart;
246  // Buffers
247  char uart_rx_buffer[ LR2_DRV_RX_BUFFER_SIZE ];
248  char uart_tx_buffer[ LR2_DRV_TX_BUFFER_SIZE ];
254  char data_in;
255 
256 } lr2_t;
257 
262 typedef struct
263 {
264  // Communication gpio pins
265  pin_name_t rx_pin;
266  pin_name_t tx_pin;
268  // Additional gpio pins
269  pin_name_t rst;
270  pin_name_t rts;
271  pin_name_t cts;
273  // Static variable
274  uint32_t baud_rate;
276  uart_data_bits_t data_bit;
277  uart_parity_t parity_bit;
278  uart_stop_bits_t stop_bit;
280 } lr2_cfg_t;
281 
286 typedef enum
287 {
288  LR2_OK = 0,
289  LR2_ERROR = -1
290 
292 
308 void lr2_cfg_setup ( lr2_cfg_t *cfg );
309 
324 err_t lr2_init ( lr2_t *ctx, lr2_cfg_t *cfg );
325 
339 void lr2_default_cfg ( lr2_t *ctx, bool cb_default, void ( *response_p )( char *response ) );
340 
351 void lr2_generic_write ( lr2_t *ctx, char *data_buf, uint16_t len );
352 
364 int32_t lr2_generic_read ( lr2_t *ctx, char *data_buf, uint16_t max_len );
365 
377 void lr2_cmd ( lr2_t *ctx, char *cmd, char *response );
378 
388 uint8_t lr2_mac_tx ( lr2_t *ctx, lr2_mac_t *mac );
389 
400 uint8_t lr2_join ( lr2_t *ctx, char *join_mode, char *response );
401 
412 uint8_t lr2_rx ( lr2_t *ctx, char *window_size, char *response );
413 
423 uint8_t lr2_tx ( lr2_t *ctx, char *buffer );
424 
434 void lr2_rx_isr ( lr2_t *ctx, char rx_input );
435 
445 void lr2_tick_isr ( lr2_t *ctx );
446 
466 void lr2_tick_conf ( lr2_t *ctx, uint32_t timer_limit );
467 
476 void lr2_isr_process ( lr2_t *ctx );
477 
487 void lr2_put_char ( lr2_t *ctx, char data_in );
488 
489 #ifdef __cplusplus
490 }
491 #endif
492 #endif // LR2_H
493  // lr2
495 
496 // ------------------------------------------------------------------------ END
lr2_timer_t::timer_f
bool timer_f
Definition: lr2.h:185
lr2_procces_flags_t::lr2_rdy_f
bool lr2_rdy_f
Definition: lr2.h:200
lr2_isr_process
void lr2_isr_process(lr2_t *ctx)
Main Process.
lr2_cfg_t::rx_pin
pin_name_t rx_pin
Definition: lr2.h:265
lr2_buffers_t::rx_buffer_len
uint16_t rx_buffer_len
Definition: lr2.h:175
lr2_t::rts
digital_out_t rts
Definition: lr2.h:238
lr2_tick_isr
void lr2_tick_isr(lr2_t *ctx)
Timer.
lr2_cfg_t::data_bit
uart_data_bits_t data_bit
Definition: lr2.h:276
lr2_join
uint8_t lr2_join(lr2_t *ctx, char *join_mode, char *response)
Function for setting join mode.
lr2_mac_t::buffer
char * buffer
Definition: lr2.h:225
lr2_generic_read
int32_t lr2_generic_read(lr2_t *ctx, char *data_buf, uint16_t max_len)
LR 2 data reading function.
LR2_ERROR
@ LR2_ERROR
Definition: lr2.h:289
lr2_default_cfg
void lr2_default_cfg(lr2_t *ctx, bool cb_default, void(*response_p)(char *response))
LR 2 default configuration function.
lr2_response_t::rsp_buffer
char * rsp_buffer
Definition: lr2.h:211
lr2_init
err_t lr2_init(lr2_t *ctx, lr2_cfg_t *cfg)
LR 2 initialization function.
lr2_timer_t
Timer Flags and Counter object definition.
Definition: lr2.h:184
LR2_DRV_TX_BUFFER_SIZE
#define LR2_DRV_TX_BUFFER_SIZE
Definition: lr2.h:139
LR2_OK
@ LR2_OK
Definition: lr2.h:288
lr2_t::rst
digital_out_t rst
Definition: lr2.h:237
lr2_cfg_t::parity_bit
uart_parity_t parity_bit
Definition: lr2.h:277
lr2_procces_flags_t::rsp_rdy_f
bool rsp_rdy_f
Definition: lr2.h:199
lr2_timer_t::timeout_f
bool timeout_f
Definition: lr2.h:186
lr2_mac_tx
uint8_t lr2_mac_tx(lr2_t *ctx, lr2_mac_t *mac)
Function for writing mac parameters.
lr2_timer_t::ticker
uint32_t ticker
Definition: lr2.h:188
lr2_procces_flags_t
Process Flags object definition.
Definition: lr2.h:198
lr2_mac_t::port_no
char * port_no
Definition: lr2.h:224
lr2_t::uart
uart_t uart
Definition: lr2.h:244
lr2_cfg_t::uart_blocking
bool uart_blocking
Definition: lr2.h:275
lr2_cmd
void lr2_cmd(lr2_t *ctx, char *cmd, char *response)
Send command function.
lr2_t::buff
lr2_buffers_t buff
Definition: lr2.h:250
lr2_t::rsp
lr2_response_t rsp
Definition: lr2.h:253
lr2_t::flags
lr2_procces_flags_t flags
Definition: lr2.h:252
lr2_generic_write
void lr2_generic_write(lr2_t *ctx, char *data_buf, uint16_t len)
LR 2 data writing function.
lr2_t::tm
lr2_timer_t tm
Definition: lr2.h:251
lr2_cfg_setup
void lr2_cfg_setup(lr2_cfg_t *cfg)
LR 2 configuration object setup function.
lr2_return_value_t
lr2_return_value_t
LR 2 Click return value data.
Definition: lr2.h:287
lr2_tick_conf
void lr2_tick_conf(lr2_t *ctx, uint32_t timer_limit)
Timer Configuration.
lr2_cfg_t::stop_bit
uart_stop_bits_t stop_bit
Definition: lr2.h:278
lr2_cfg_t::rts
pin_name_t rts
Definition: lr2.h:270
lr2_mac_t::payload
char * payload
Definition: lr2.h:223
lr2_timer_t::timer_use_f
bool timer_use_f
Definition: lr2.h:187
lr2_put_char
void lr2_put_char(lr2_t *ctx, char data_in)
Function for write char.
lr2_mac_t
Mac object definition.
Definition: lr2.h:222
lr2_cfg_t::tx_pin
pin_name_t tx_pin
Definition: lr2.h:266
LR2_MAX_TRANSFER_SIZE
#define LR2_MAX_TRANSFER_SIZE
Definition: lr2.h:102
lr2_cfg_t::cts
pin_name_t cts
Definition: lr2.h:271
lr2_t::data_in
char data_in
Definition: lr2.h:254
lr2_response_t::callback_default
bool callback_default
Definition: lr2.h:212
lr2_timer_t::timer_max
uint32_t timer_max
Definition: lr2.h:189
lr2_t::cts
digital_in_t cts
Definition: lr2.h:241
lr2_mac_t::response
char * response
Definition: lr2.h:226
lr2_response_t
Response object definition.
Definition: lr2.h:209
lr2_buffers_t
Click buffers object definition.
Definition: lr2.h:172
lr2_rx_isr
void lr2_rx_isr(lr2_t *ctx, char rx_input)
Receiver.
lr2_cfg_t
LR 2 Click configuration object.
Definition: lr2.h:263
lr2_cfg_t::baud_rate
uint32_t baud_rate
Definition: lr2.h:274
lr2_cfg_t::rst
pin_name_t rst
Definition: lr2.h:269
LR2_DRV_RX_BUFFER_SIZE
#define LR2_DRV_RX_BUFFER_SIZE
LR 2 driver buffer size.
Definition: lr2.h:138
lr2_rx
uint8_t lr2_rx(lr2_t *ctx, char *window_size, char *response)
Main receiver function
lr2_response_t::rsp_f
bool rsp_f
Definition: lr2.h:210
lr2_tx
uint8_t lr2_tx(lr2_t *ctx, char *buffer)
Main tnanceiver function.
lr2_t
LR 2 Click context object.
Definition: lr2.h:235