nbiot5.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 NBIOT5_H
#define NBIOT5_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 NBIOT5_CMD_AT                           "AT"
#define NBIOT5_CMD_CFUN                         "AT+CFUN"
#define NBIOT5_CMD_CEREG                        "AT+CEREG"
#define NBIOT5_CMD_CGDCONT                      "AT+CGDCONT"
#define NBIOT5_CMD_CSQ                          "AT+CSQ"
#define NBIOT5_CMD_COPS                         "AT+COPS"
#define NBIOT5_CMD_CMGS                         "AT+CMGS"
#define NBIOT5_CMD_CMGF                         "AT+CMGF"
#define NBIOT5_CMD_ESOC                         "AT+ESOC"
#define NBIOT5_CMD_ESOCON                       "AT+ESOCON"
#define NBIOT5_CMD_ESOSEND                      "AT+ESOSEND"
#define NBIOT5_CMD_ESOCL                        "AT+ESOCL"
 
#define NBIOT5_RSP_OK                           "OK"
#define NBIOT5_RSP_ERROR                        "ERROR"
 
#define NBIOT5_RX_DRV_BUFFER_SIZE               256
#define NBIOT5_TX_DRV_BUFFER_SIZE               256
 
 // nbiot5_set
 
#define NBIOT5_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.tx_pin = MIKROBUS( mikrobus, MIKROBUS_TX ); \
    cfg.rx_pin = MIKROBUS( mikrobus, MIKROBUS_RX ); \
    cfg.wup    = MIKROBUS( mikrobus, MIKROBUS_AN ); \
    cfg.rst    = MIKROBUS( mikrobus, MIKROBUS_RST ); \
    cfg.cs     = MIKROBUS( mikrobus, MIKROBUS_CS ); \
    cfg.en     = MIKROBUS( mikrobus, MIKROBUS_PWM )
 
 // nbiot5_map
 // nbiot5
 
typedef struct
{
    // Output pins
    digital_out_t rst;      
    digital_out_t cs;       
    digital_out_t wup;      
    digital_out_t en;       
    // Modules
    uart_t uart;            
    // Buffers
    uint8_t uart_rx_buffer[ NBIOT5_RX_DRV_BUFFER_SIZE ];  
    uint8_t uart_tx_buffer[ NBIOT5_TX_DRV_BUFFER_SIZE ];  
} nbiot5_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 cs;          
    pin_name_t wup;         
    pin_name_t en;          
    // 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;         
} nbiot5_cfg_t;
 
typedef enum
{
    NBIOT5_OK = 0,
    NBIOT5_ERROR = -1,
    NBIOT5_ERROR_TIMEOUT = -2,
    NBIOT5_ERROR_CMD = -3,
    NBIOT5_ERROR_UNKNOWN = -4
 
} nbiot5_return_value_t;
 
void nbiot5_cfg_setup ( nbiot5_cfg_t *cfg );
 
err_t nbiot5_init ( nbiot5_t *ctx, nbiot5_cfg_t *cfg );
 
err_t nbiot5_generic_write ( nbiot5_t *ctx, uint8_t *data_in, uint16_t len );
 
err_t nbiot5_generic_read ( nbiot5_t *ctx, uint8_t *data_out, uint16_t len );
 
void nbiot5_set_rst_pin ( nbiot5_t *ctx, uint8_t state );
 
void nbiot5_set_cs_pin ( nbiot5_t *ctx, uint8_t state );
 
void nbiot5_set_wup_pin ( nbiot5_t *ctx, uint8_t state );
 
void nbiot5_set_en_pin ( nbiot5_t *ctx, uint8_t state );
 
void nbiot5_send_cmd ( nbiot5_t *ctx, uint8_t *cmd );
 
void nbiot5_send_cmd_with_par ( nbiot5_t *ctx, uint8_t *at_cmd_buf, uint8_t *param_buf );
 
void nbiot5_send_cmd_check ( nbiot5_t *ctx, uint8_t *at_cmd_buf );
 
void nbiot5_send_cmd_par_check ( nbiot5_t *ctx, uint8_t *at_cmd_buf );
 
void nbiot5_set_sim_apn ( nbiot5_t *ctx, uint8_t *sim_apn );
 
void nbiot5_send_sms_text ( nbiot5_t *ctx, uint8_t *phone_number, uint8_t *sms_text );
 
err_t nbiot5_send_sms_pdu ( nbiot5_t *ctx, uint8_t *service_center_number, uint8_t *phone_number, uint8_t *sms_text );
 
#ifdef __cplusplus
}
#endif
#endif // NBIOT5_H
 
 // nbiot5
 
// ------------------------------------------------------------------------ END