lteiot4.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 LTEIOT4_H
#define LTEIOT4_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 LTEIOT4_CMD_AT                  "AT"
#define LTEIOT4_CMD_MODULE_VERSION      "AT+CGMM"
#define LTEIOT4_CMD_FW_VERSION          "AT+CGMR"
#define LTEIOT4_CMD_FLIGHT_MODE         "AT+CFUN=4"
#define LTEIOT4_CMD_NBIOT_MODE          "AT%XSYSTEMMODE=0,1,0,0"
#define LTEIOT4_CMD_ENABLE_NET_SMS      "AT+CIND=1,0,1"
#define LTEIOT4_CMD_FULL_FUNCTION       "AT+CFUN=1"
#define LTEIOT4_CMD_AUTO_NET_SRC        "AT+COPS=0"
#define LTEIOT4_CMD_SEARCH_NET          "AT+CEREG=2"
#define LTEIOT4_CMD_SIM_TEST            "AT+CIMI"
#define LTEIOT4_CMD_CHECK_CONNECTION    "AT+CGATT?"
#define LTEIOT4_CMD_CHECK_REGISTARTION  "AT+CEREG?"
#define LTEIOT4_CMD_SIGNAL_QUALITY      "AT+CESQ"
#define LTEIOT4_CMD_SET_DUMMY_CLOCK     "AT+CCLK=\"20/12/31,23:59:39+01\""
#define LTEIOT4_CMD_CHECK_TEMPERATURE   "AT%XTEMP?"
#define LTEIOT4_CMD_CHECK_CLOCK         "AT+CCLK?"
 
#define DRV_BUFFER_SIZE                       500
 
 // lteiot4_set
 
#define LTEIOT4_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.tx_pin  = MIKROBUS( mikrobus, MIKROBUS_TX ); \
    cfg.rx_pin  = MIKROBUS( mikrobus, MIKROBUS_RX ); \
    cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
 
 // lteiot4_map
 // lteiot4
 
typedef struct
{
    // Output pins
    digital_out_t rst;     
    // Modules
    uart_t uart;                                    
    // Buffers
    char uart_rx_buffer[ DRV_BUFFER_SIZE ];         
    char uart_tx_buffer[ DRV_BUFFER_SIZE ];         
} lteiot4_t;
 
typedef struct
{
    // Communication gpio pins
    pin_name_t rx_pin;                                  
    pin_name_t tx_pin;                                  
    // Additional gpio pins
    pin_name_t rst;        
    // 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;                         
} lteiot4_cfg_t;
 
void lteiot4_cfg_setup ( lteiot4_cfg_t *cfg );
 
err_t lteiot4_init ( lteiot4_t *ctx, lteiot4_cfg_t *cfg );
 
err_t lteiot4_default_cfg ( lteiot4_t *ctx );
 
err_t lteiot4_generic_write ( lteiot4_t *ctx, char *data_buf, uint16_t len );
 
err_t lteiot4_generic_read ( lteiot4_t *ctx, char *data_buf, uint16_t max_len );
 
void lteiot4_set_rst ( lteiot4_t *ctx, uint8_t state );
 
void lteiot4_send_cmd ( lteiot4_t *ctx, char *cmd );
 
void lteiot4_set_sim_apn ( lteiot4_t *ctx, char *sim_apn );
 
#ifdef __cplusplus
}
#endif
#endif // LTEIOT4_H
 
 // lteiot4
 
// ------------------------------------------------------------------------ END