lteiot9.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 LTEIOT9_H
#define LTEIOT9_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 LTEIOT9_CMD_AT          "AT"
#define LTEIOT9_CMD_ATI         "ATI"
#define LTEIOT9_CMD_CGMR        "AT+CGMR"
#define LTEIOT9_CMD_CFUN        "AT+CFUN"
#define LTEIOT9_CMD_CREG        "AT+CREG"
#define LTEIOT9_CMD_CEREG       "AT+CEREG"
#define LTEIOT9_CMD_CGDCONT     "AT+CGDCONT"
#define LTEIOT9_CMD_CIMI        "AT+CIMI"
#define LTEIOT9_CMD_CGATT       "AT+CGATT"
#define LTEIOT9_CMD_CSQ         "AT+CSQ"
#define LTEIOT9_CMD_CESQ        "AT+CESQ"
#define LTEIOT9_CMD_COPS        "AT+COPS"
#define LTEIOT9_CMD_URAT        "AT+URAT"
#define LTEIOT9_CMD_UBANDMASK   "AT+UBANDMASK"
#define LTEIOT9_CMD_URATCONF    "AT+URATCONF"
#define LTEIOT9_CMD_UAUTHREQ    "AT+UAUTHREQ"
#define LTEIOT9_CMD_UUICC       "AT+UUICC"
#define LTEIOT9_CMD_UCGED       "AT+UCGED"
#define LTEIOT9_CMD_UCELLINFO   "AT+UCELLINFO"
#define LTEIOT9_CMD_UANTR       "AT+UANTR"
#define LTEIOT9_CMD_CMGF        "AT+CMGF"
 
 
 // lteiot9_reg
 
#define LTEIOT9_GNSS_GPGGA          "GPGGA"
#define LTEIOT9_GNSS_START          '$'
#define LTEIOT9_GNSS_SEPARATOR      ','
 
#define LTEIOT9_GPGGA_LATITUDE      2
#define LTEIOT9_GPGGA_LONGITUDE     4
#define LTEIOT9_GPGGA_ALTITUDE      9
 
#define LTEIOT9_SYSSTART            "^SYSSTART"
 
#define LTEIOT9_RSP_OK                              "OK"
#define LTEIOT9_RSP_ERROR                           "ERROR"
 
#define DRV_TX_BUFFER_SIZE          200
#define DRV_RX_BUFFER_SIZE          500
 
 // lteiot9_set
 
#define LTEIOT9_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.tx_pin  = MIKROBUS( mikrobus, MIKROBUS_TX ); \
    cfg.rx_pin  = MIKROBUS( mikrobus, MIKROBUS_RX ); \
    cfg.smi = MIKROBUS( mikrobus, MIKROBUS_AN ); \
    cfg.on = MIKROBUS( mikrobus, MIKROBUS_RST ); \
    cfg.cts = MIKROBUS( mikrobus, MIKROBUS_CS ); \
    cfg.rts = MIKROBUS( mikrobus, MIKROBUS_INT );
 
 // lteiot9_map
 // lteiot9
 
typedef struct
{
    // Output pins
    digital_out_t smi;       
    digital_out_t on;     
    digital_out_t rts;       
    // Input pins
    digital_in_t cts;       
    // Modules
    uart_t uart;                                    
    // Buffers
    char uart_rx_buffer[ DRV_RX_BUFFER_SIZE ];         
    char uart_tx_buffer[ DRV_TX_BUFFER_SIZE ];         
} lteiot9_t;
 
typedef struct
{
    // Communication gpio pins
    pin_name_t rx_pin;                                  
    pin_name_t tx_pin;                                  
    // Additional gpio pins
    pin_name_t smi;          
    pin_name_t on;        
    pin_name_t cts;          
    pin_name_t rts;        
    // 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;                         
} lteiot9_cfg_t;
 
typedef enum
{
    LTEIOT9_OK = 0,
    LTEIOT9_ERROR = -1,
    LTEIOT9_ERROR_OVERFLOW = -2,
    LTEIOT9_ERROR_TIMEOUT = -3
 
} lteiot9_return_value_t;
 
void lteiot9_cfg_setup ( lteiot9_cfg_t *cfg );
 
err_t lteiot9_init ( lteiot9_t *ctx, lteiot9_cfg_t *cfg );
 
err_t lteiot9_default_cfg ( lteiot9_t *ctx );
 
err_t lteiot9_generic_write ( lteiot9_t *ctx, char *data_buf, uint16_t len );
 
err_t lteiot9_generic_read ( lteiot9_t *ctx, char *data_buf, uint16_t max_len );
 
void lteiot9_set_pin_on ( lteiot9_t *ctx, uint8_t state );
 
void lteiot9_send_cmd ( lteiot9_t *ctx, char *cmd );
 
void lteiot9_send_cmd_with_parameter ( lteiot9_t *ctx, char *at_cmd_buf, char *param_buf );
 
void lteiot9_send_cmd_check ( lteiot9_t *ctx, char *at_cmd_buf );
 
void lteiot9_send_cmd_parameter_check ( lteiot9_t *ctx, char *at_cmd_buf );
 
void lteiot9_set_sim_apn ( lteiot9_t *ctx, char *sim_apn );
 
void lteiot9_send_text_message ( lteiot9_t *ctx, char *phone_number, char *message_context );
 
 
#ifdef __cplusplus
}
#endif
#endif // LTEIOT9_H
 
 // lteiot9
 
// ------------------------------------------------------------------------ END