lr3.h

Go to the documentation of this file.

/*
 * MikroSDK - MikroE Software Development Kit
 * Copyright© 2020 MikroElektronika d.o.o.
 * 
 * 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 LR3_H
#define LR3_H
 
#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"
 
// -------------------------------------------------------------- PUBLIC MACROS 
#define LR3_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.wk = MIKROBUS( mikrobus, MIKROBUS_CS ); \
  cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
#define LR3_RETVAL  uint8_t
 
#define LR3_OK           0x00
#define LR3_INIT_ERROR   0xFF
#define FRAME_HEADER        0xAA
#define RESPONSE_BIT        0x80
#define LR3_CMD_RESET                       0x30
#define LR3_CMD_FACTORY_RESET               0x31
#define LR3_CMD_EEPROM_WRITE                0x32
#define LR3_CMD_EEPROM_READ                 0x33
#define LR3_CMD_GET_FW_VERSION              0x34
#define LR3_CMD_GET_SERIAL_NO               0x35
#define LR3_ENABLE_PAIRING                  0x40
#define LR3_GET_NETWORK_TABLE_SIZE          0x42
#define LR3_GET_NETWORK_TABLE_ROW           0x43
#define LR3_DEL_NET_TABLE_ROW               0x44
#define LR3_DEL_ALL_NETWORK_TABLE           0x45
#define LR3_GET_PAIRING_REQUEST             0x48
#define LR3_GET_ACTIVATION_STATUS           0x4A
#define LR3_TX_MESSAGE                      0x50
#define LR3_CHECK_LINK_REQUEST              0x56
#define LR3_SET_APP_KEY                     0x58
 
#define LR3_INDICATES_DEVICE_PAIRING        0x41
#define LR3_INDICATES_PAIRING_CONFIRM       0x49
#define LR3_INDICATES_TX_MSG_CONFIRMED      0x51
#define LR3_INDICATES_TX_MSG_UNCONFIRMED    0x52
#define LR3_INDICATES_RX_MSG                0x53
#define LR3_INDICATES_LINK_CHECK            0x57
#define LR3_INDICATES_TX_SESSION_ABORT      0x59
 
#define LR3_OK                              0x00
#define LR3_ERR_ADDR_RANGE                  0x01
#define LR3_ERR_NOT_IDLE                    0x02
 
#define LR3_ERR_PL_LEN                      0xFC
#define LR3_ERR_CHKSUM                      0xFD
#define LR3_ERR_RESPONSE                    0xFE
#define LR3_ERR_HEADER                      0xFF
 
#define LR3_UNCONFIRMED_DATA_TX             0x00
#define LR3_CONFIRMED_DATA_TX               0x01
 
#define LR3_BROADCAST_MESSAGE               0xFFFFFFFF
#define LR3_MODULE_POWER_ON   1
#define LR3_MODULE_POWER_OFF  0
#define DRV_RX_BUFFER_SIZE 500
 // End group macro 
// --------------------------------------------------------------- PUBLIC TYPES
typedef void ( *lr3_ind_hdl_t )( uint8_t *cmd, uint8_t* p_load_size, uint8_t *p_load );
 
typedef struct
{
    // Output pins 
 
    digital_out_t rst;
    digital_out_t wk;
 
    // Input pins 
 
    digital_in_t int_pin;
    
    // Modules 
 
    uart_t uart;
 
    char uart_rx_buffer[ DRV_RX_BUFFER_SIZE ];
    char uart_tx_buffer[ DRV_RX_BUFFER_SIZE ];
 
    lr3_ind_hdl_t ind_handler;
} lr3_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 wk;
    pin_name_t int_pin;
 
    // static variable 
 
    uint32_t          baud_rate;     // Clock speed.
    bool              uart_blocking;
    uart_data_bits_t  data_bit;      // Data bits.
    uart_parity_t     parity_bit;    // Parity bit.  
    uart_stop_bits_t  stop_bit;      // Stop bits.    
 
} lr3_cfg_t;
 
typedef struct {
 
    uint8_t command;
    uint8_t payload_size;
    uint8_t payload[ 255 ];
    
} lr3_message_t;
 
typedef struct {
 
    uint8_t *data_in;
    uint8_t n_bytes;
    uint32_t destination_id;
    uint8_t option;
    
} lr3_tx_msg_t;
 
 // End types group
// ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
 
#ifdef __cplusplus
extern "C"{
#endif
 
void lr3_cfg_setup ( lr3_cfg_t *cfg );
 
LR3_RETVAL lr3_init ( lr3_t *ctx, lr3_cfg_t *cfg );
 
uint8_t lr3_chk_sum ( lr3_message_t *cmd );
 
int32_t lr3_generic_read ( lr3_t *ctx, char *data_buf, uint16_t max_len );
 
void lr3_generic_write ( lr3_t *ctx, char *data_buf, uint16_t len );
 
void lr3_hard_reset ( lr3_t *ctx );
 
void lr3_wake_up ( lr3_t *ctx, uint8_t state );
 
void lr3_set_ind_handler ( lr3_t *ctx, lr3_ind_hdl_t hdl );
 
uint8_t lr3_command ( lr3_t *ctx, lr3_message_t *msg, lr3_message_t *rsp );
 
uint8_t lr3_read_message_process ( lr3_t *ctx );
 
LR3_RETVAL lr3_soft_reset ( lr3_t *ctx );
 
LR3_RETVAL lr3_factory_reset ( lr3_t *ctx );
 
LR3_RETVAL lr3_write_eeprom ( lr3_t *ctx, uint8_t address, uint8_t n_bytes, uint8_t *data_in );
 
LR3_RETVAL lr3_read_eeprom ( lr3_t *ctx, uint8_t address, uint8_t n_bytes, uint8_t *data_out );
 
LR3_RETVAL lr3_get_fw_version ( lr3_t *ctx, uint32_t *fw_version );
 
LR3_RETVAL lr3_get_serial_no ( lr3_t *ctx, uint32_t *serial_no );
 
LR3_RETVAL lr3_enable_pairing ( lr3_t *ctx, uint8_t state );
 
LR3_RETVAL lr3_get_network_table_size ( lr3_t *ctx );
 
LR3_RETVAL lr3_get_network_table_row( lr3_t *ctx, uint8_t index, uint8_t *data_out );
 
LR3_RETVAL lr3_delete_network_table_row ( lr3_t *ctx, uint8_t *device_id );
 
LR3_RETVAL lr3_delete_all_network_table ( lr3_t *ctx );
 
LR3_RETVAL lr3_tx_message ( lr3_t *ctx, lr3_tx_msg_t *tx_msg );
 
LR3_RETVAL lr3_get_pairing_request ( lr3_t *ctx );
 
LR3_RETVAL lr3_get_activation_status ( lr3_t *ctx, uint8_t *data_out );
 
LR3_RETVAL lr3_check_link_request ( lr3_t *ctx, uint8_t power, uint8_t message_num, uint8_t message_th );
 
LR3_RETVAL lr3_set_app_key ( lr3_t *ctx, uint8_t *app_key );
 
#ifdef __cplusplus
}
#endif
#endif  // _LR3_H_
 
 // End public_function group
 
// ------------------------------------------------------------------------- END