nbiot2.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 NBIOT2_H
#define NBIOT2_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 NBIOT2_CMD_AT               "AT"
#define NBIOT2_CMD_ATI              "ATI"
#define NBIOT2_CMD_CGMR             "AT+CGMR"
#define NBIOT2_CMD_CFUN             "AT+CFUN"
#define NBIOT2_CMD_CREG             "AT+CREG"
#define NBIOT2_CMD_CEREG            "AT+CEREG"
#define NBIOT2_CMD_CGDCONT          "AT+CGDCONT"
#define NBIOT2_CMD_CIMI             "AT+CIMI"
#define NBIOT2_CMD_CGATT            "AT+CGATT"
#define NBIOT2_CMD_CSQ              "AT+CSQ"
#define NBIOT2_CMD_CESQ             "AT+CESQ"
#define NBIOT2_CMD_COPS             "AT+COPS"
#define NBIOT2_CMD_CSCON            "AT+CSCON"
#define NBIOT2_CMD_CMEE             "AT+CMEE"
#define NBIOT2_CMD_CMGS             "AT+CMGS"
#define NBIOT2_CMD_CGACT            "AT+CGACT"
#define NBIOT2_CMD_URAT             "AT+URAT"
#define NBIOT2_CMD_UBANDMASK        "AT+UBANDMASK"
#define NBIOT2_CMD_URATCONF         "AT+URATCONF"
#define NBIOT2_CMD_UAUTHREQ         "AT+UAUTHREQ"
#define NBIOT2_CMD_UUICC            "AT+UUICC"
#define NBIOT2_CMD_UCGED            "AT+UCGED"
#define NBIOT2_CMD_UCELLINFO        "AT+UCELLINFO"
#define NBIOT2_CMD_UANTR            "AT+UANTR"
#define NBIOT2_CMD_CMGF             "AT+CMGF"
#define NBIOT2_CMD_QSPCHSC          "AT+QSPCHSC"
#define NBIOT2_CMD_CPSMS            "AT+CPSMS"
#define NBIOT2_CMD_QRST             "AT+QRST"
#define NBIOT2_CMD_QBAND            "AT+QBAND"
#define NBIOT2_CMD_QNBIOTEVENT      "AT+QNBIOTEVENT"
#define NBIOT2_CMD_SM               "AT+SM"
#define NBIOT2_CMD_QSCLK            "AT+QSCLK"
#define NBIOT2_CMD_QIOPEN           "AT+QIOPEN"
#define NBIOT2_CMD_QISEND           "AT+QISEND"
#define NBIOT2_CMD_QIRD             "AT+QIRD"
#define NBIOT2_CMD_QICLOSE          "AT+QICLOSE"
 
#define NBIOT2_PIN_STATE_HIGH       0x01
#define NBIOT2_PIN_STATE_LOW        0x00
 
#define NBIOT2_RSP_OK               "OK"
#define NBIOT2_RSP_ERROR            "ERROR"
 
#define NBIOT2_TX_DRV_BUFFER_SIZE    100
#define NBIOT2_RX_DRV_BUFFER_SIZE    300
 
 // nbiot2_cmd
 
#define NBIOT2_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.wup = MIKROBUS( mikrobus, MIKROBUS_INT );
 
 // nbiot2_map
 // nbiot2
 
typedef struct
{
    // Output pins
    digital_out_t rst;      
    digital_out_t wup;      
    // Modules
    uart_t uart;            
    // Buffers
    char uart_rx_buffer[ NBIOT2_RX_DRV_BUFFER_SIZE ];  
    char uart_tx_buffer[ NBIOT2_TX_DRV_BUFFER_SIZE ];  
} nbiot2_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 wup;                 
    // 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;      
} nbiot2_cfg_t;
 
typedef enum
{
    NBIOT2_OK = 0,
    NBIOT2_ERROR = -1,
    NBIOT2_ERROR_OVERFLOW = -2,
    NBIOT2_ERROR_TIMEOUT = -3
    
} nbiot2_return_value_t;
 
void nbiot2_cfg_setup ( nbiot2_cfg_t *cfg );
 
err_t nbiot2_init ( nbiot2_t *ctx, nbiot2_cfg_t *cfg );
 
err_t nbiot2_generic_write ( nbiot2_t *ctx, char *data_in, uint16_t len );
 
err_t nbiot2_generic_read ( nbiot2_t *ctx, char *data_out, uint16_t len );
 
void nbiot2_set_rst_pin_state ( nbiot2_t *ctx, uint8_t state );
 
void nbiot2_set_wup_pin_state ( nbiot2_t *ctx, uint8_t state );
 
void nbiot2_hw_reset ( nbiot2_t *ctx );
 
void nbiot2_send_cmd ( nbiot2_t *ctx, char *cmd );
 
void nbiot2_send_cmd_with_parameter ( nbiot2_t *ctx, char *at_cmd_buf, char *param_buf );
 
void nbiot2_send_cmd_check ( nbiot2_t *ctx, char *at_cmd_buf );
 
void nbiot2_send_cmd_parameter_check ( nbiot2_t *ctx, char *at_cmd_buf );
 
void nbiot2_set_apn( nbiot2_t *ctx, char *apn );
 
void nbiot2_send_sms_text_mode ( nbiot2_t *ctx, char *phone_number, char *message_context );
 
err_t nbiot2_send_sms_pdu ( nbiot2_t *ctx, char *service_center_number, char *phone_number, char *sms_text );
 
#ifdef __cplusplus
}
#endif
#endif // NBIOT2_H
 
 // nbiot2
 
// ------------------------------------------------------------------------ END