lr2.h

Go to the documentation of this file.

/****************************************************************************
** Copyright (C) 2020 MikroElektronika d.o.o.
** Contact: https://www.mikroe.com/contact
**
** Permission is hereby granted, free of charge, to any person obtaining a copy
** of this software and associated documentation files (the "Software"), to deal
** in the Software without restriction, including without limitation the rights
** to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
** copies of the Software, and to permit persons to whom the Software is
** furnished to do so, subject to the following conditions:
** The above copyright notice and this permission notice shall be
** included in all copies or substantial portions of the Software.
**
** THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
** EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
** OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
** IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
** DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
** OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
**  USE OR OTHER DEALINGS IN THE SOFTWARE.
****************************************************************************/
 
#ifndef LR2_H
#define LR2_H
 
#ifdef __cplusplus
extern "C"{
#endif
 
#ifdef PREINIT_SUPPORTED
#include "preinit.h"
#endif
 
#ifdef MikroCCoreVersion
    #if MikroCCoreVersion >= 1
        #include "delays.h"
    #endif
#endif
 
#include "drv_digital_out.h"
#include "drv_digital_in.h"
#include "drv_uart.h"
 
#define LR2_CMD_SYS_GET_VER          "sys get ver"
#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"
#define LR2_JM_ABP                   "abp"
 
#define LR2_PL_CNF                   "cnf "
#define LR2_PL_UNCNF                 "uncnf "
 
#define LR2_INVALID_PARAM            1
#define LR2_NOT_JOINED               2
#define LR2_NO_FREE_CH               3
#define LR2_SILENT                   4
#define LR2_ERR_REJOIN_NEEDED        5
#define LR2_BUSY                     6
#define LR2_MAC_PAUSED               7
#define LR2_INVALID_PAR_DATA_LEN     8
#define LR2_KEYS_NOT_INIT            9
#define LR2_MAC_ERR                  10
#define LR2_MAC_RX                   12
#define LR2_INVALID_REPAR_DATA_LEN   13
#define LR2_RADIO_ERR                14
#define LR2_DENIED                   18  
 
#define LR2_MAX_DATA_SIZE            256
#define LR2_MAX_TRANSFER_SIZE        384
 
#define LR2_MAX_CMD_SIZE             64
 
#define LR2_MAX_RSP_SIZE             20
 
#define LR2_RESP_COUNT               100
 
#define LR2_TIMER_EXPIRED            50000
 
#define LR2_MAC_TX                   "mac tx "
#define LR2_JOIN                     "mac join "
#define LR2_RADIO_TX                 "radio tx "
#define LR2_RADIO_RX                 "radio rx "
 
#define LR2_DRV_RX_BUFFER_SIZE       300
#define LR2_DRV_TX_BUFFER_SIZE       100
 
 // lr2_set
 
#define LR2_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.tx_pin  = MIKROBUS( mikrobus, MIKROBUS_TX ); \
    cfg.rx_pin  = MIKROBUS( mikrobus, MIKROBUS_RX ); \
    cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
    cfg.rts = MIKROBUS( mikrobus, MIKROBUS_CS ); \
    cfg.cts = MIKROBUS( mikrobus, MIKROBUS_INT )
 
 // lr2_map
 // lr2
 
typedef struct
{
    char     tx_buffer[ LR2_MAX_TRANSFER_SIZE ];
    char     rx_buffer[ LR2_MAX_TRANSFER_SIZE ];
    uint16_t rx_buffer_len;
 
} lr2_buffers_t;
 
typedef struct
{
    bool     timer_f;
    bool     timeout_f;
    bool     timer_use_f;
    uint32_t ticker;
    uint32_t timer_max;
    
} lr2_timer_t;
 
typedef struct
{
    bool rsp_rdy_f;
    bool lr2_rdy_f;
    
} lr2_procces_flags_t;
 
typedef struct
{
    bool  rsp_f;
    char  *rsp_buffer;
    bool  callback_default;
    void ( *callback_resp )( char *response );
    
} lr2_response_t;
 
typedef struct
{
    char *payload; 
    char *port_no; 
    char *buffer;
    char *response;
    
} lr2_mac_t;
 
typedef struct
{
    // Output pins
    digital_out_t rst;          
    digital_out_t rts;          
    // Input pins
    digital_in_t cts;           
    // Modules
    uart_t uart;                                    
    // Buffers
    char uart_rx_buffer[ LR2_DRV_RX_BUFFER_SIZE ];         
    char uart_tx_buffer[ LR2_DRV_TX_BUFFER_SIZE ];         
    lr2_buffers_t buff;
    lr2_timer_t tm;
    lr2_procces_flags_t flags;
    lr2_response_t rsp;
    char data_in;
    
} lr2_t;
 
typedef struct
{
    // Communication gpio pins
    pin_name_t rx_pin;                  
    pin_name_t tx_pin;                  
    // Additional gpio pins
    pin_name_t rst;                     
    pin_name_t rts;                     
    pin_name_t cts;                     
    // Static variable
    uint32_t          baud_rate;        
    bool              uart_blocking;    
    uart_data_bits_t  data_bit;         
    uart_parity_t     parity_bit;       
    uart_stop_bits_t  stop_bit;         
} lr2_cfg_t;
 
typedef enum
{
   LR2_OK = 0,
   LR2_ERROR = -1
 
} lr2_return_value_t;
 
void lr2_cfg_setup ( lr2_cfg_t *cfg );
 
err_t lr2_init ( lr2_t *ctx, lr2_cfg_t *cfg );
 
void lr2_default_cfg ( lr2_t *ctx, bool cb_default, void ( *response_p )( char *response ) );
 
void lr2_generic_write ( lr2_t *ctx, char *data_buf, uint16_t len );
 
int32_t lr2_generic_read ( lr2_t *ctx, char *data_buf, uint16_t max_len );
 
void lr2_cmd ( lr2_t *ctx, char *cmd,  char *response );
 
uint8_t lr2_mac_tx ( lr2_t *ctx, lr2_mac_t *mac );
 
uint8_t lr2_join ( lr2_t *ctx, char *join_mode, char *response );
 
uint8_t lr2_rx ( lr2_t *ctx, char *window_size, char *response );
 
uint8_t lr2_tx ( lr2_t *ctx, char *buffer );
 
void lr2_rx_isr ( lr2_t *ctx, char rx_input );
 
void lr2_tick_isr ( lr2_t *ctx );
 
void lr2_tick_conf ( lr2_t *ctx, uint32_t timer_limit );
 
void lr2_isr_process ( lr2_t *ctx );
 
void lr2_put_char ( lr2_t *ctx, char data_in );
 
#ifdef __cplusplus
}
#endif
#endif // LR2_H
 
 // lr2
 
// ------------------------------------------------------------------------ END