lteiot3.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 LTEIOT3_H
#define LTEIOT3_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 LTEIOT3_CMD_AT                              "AT"
#define LTEIOT3_CMD_ATI                             "ATI"
#define LTEIOT3_CMD_CFUN                            "AT+CFUN"
#define LTEIOT3_CMD_CREG                            "AT+CREG"
#define LTEIOT3_CMD_CGDCONT                         "AT+CGDCONT"
#define LTEIOT3_CMD_CESQ                            "AT+CESQ"
#define LTEIOT3_CMD_COPS                            "AT+COPS"
#define LTEIOT3_CMD_CMGS                            "AT+CMGS"
#define LTEIOT3_CMD_CMGF                            "AT+CMGF"
#define LTEIOT3_CMD_CGPADDR                         "AT+CGPADDR"
#define LTEIOT3_CMD_SICA                            "AT^SICA"
#define LTEIOT3_CMD_SISS                            "AT^SISS"
#define LTEIOT3_CMD_SISO                            "AT^SISO"
#define LTEIOT3_CMD_SISW                            "AT^SISW"
#define LTEIOT3_CMD_SISR                            "AT^SISR"
#define LTEIOT3_CMD_SISC                            "AT^SISC"
#define LTEIOT3_CMD_SGPSC                           "AT^SGPSC"
 
#define LTEIOT3_RSP_OK                              "OK"
#define LTEIOT3_RSP_ERROR                           "ERROR"
#define LTEIOT3_RSP_SYSSTART                        "^SYSSTART"
 
#define LTEIOT3_POWER_STATE_SWITCH                  0
#define LTEIOT3_POWER_STATE_ON                      1
#define LTEIOT3_POWER_STATE_REBOOT                  2
 
#define LTEIOT3_RSP_START                           "$"
#define LTEIOT3_RSP_DELIMITER                       ","
#define LTEIOT3_RSP_END                             "\r\n"
#define LTEIOT3_RSP_GGA                             "GGA"
 
#define LTEIOT3_GGA_ELEMENT_SIZE                    15
#define LTEIOT3_GGA_TIME                            1
#define LTEIOT3_GGA_LATITUDE                        2
#define LTEIOT3_GGA_LATITUDE_SIDE                   3
#define LTEIOT3_GGA_LONGITUDE                       4
#define LTEIOT3_GGA_LONGITUDE_SIDE                  5
#define LTEIOT3_GGA_QUALITY_INDICATOR               6
#define LTEIOT3_GGA_NUMBER_OF_SATELLITES            7
#define LTEIOT3_GGA_H_DILUTION_OF_POS               8
#define LTEIOT3_GGA_ALTITUDE                        9
#define LTEIOT3_GGA_ALTITUDE_UNIT                   10
#define LTEIOT3_GGA_GEOIDAL_SEPARATION              11
#define LTEIOT3_GGA_GEOIDAL_SEPARATION_UNIT         12
#define LTEIOT3_GGA_TIME_SINCE_LAST_DGPS            13
#define LTEIOT3_GGA_DGPS_REFERENCE_STATION_ID       14
 
#define LTEIOT3_RX_DRV_BUFFER_SIZE                  256
#define LTEIOT3_TX_DRV_BUFFER_SIZE                  256
 
 // lteiot3_cmd
 
#define LTEIOT3_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.cs = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
    cfg.rts = MIKROBUS( mikrobus, MIKROBUS_INT );
 
 // lteiot3_map
 // lteiot3
 
typedef struct
{
    // Output pins
    digital_out_t on;           
    digital_out_t cs;           
    digital_out_t rts;          
    // Input pins
    digital_in_t smi;           
    digital_in_t cts;           
    // Modules
    uart_t uart;                
    // Buffers
    uint8_t uart_rx_buffer[ LTEIOT3_RX_DRV_BUFFER_SIZE ];      
    uint8_t uart_tx_buffer[ LTEIOT3_TX_DRV_BUFFER_SIZE ];      
} lteiot3_t;
 
typedef struct
{
    // Communication gpio pins
    pin_name_t rx_pin;          
    pin_name_t tx_pin;          
    // Additional gpio pins
    pin_name_t on;             
    pin_name_t cs;             
    pin_name_t cts;            
    pin_name_t smi;            
    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;         
} lteiot3_cfg_t;
 
typedef enum
{
    LTEIOT3_OK = 0,
    LTEIOT3_ERROR = -1,
    LTEIOT3_ERROR_TIMEOUT = -2,
    LTEIOT3_ERROR_CMD = -3,
    LTEIOT3_ERROR_UNKNOWN = -4
 
} lteiot3_return_value_t;
 
void lteiot3_cfg_setup ( lteiot3_cfg_t *cfg );
 
err_t lteiot3_init ( lteiot3_t *ctx, lteiot3_cfg_t *cfg );
 
err_t lteiot3_generic_write ( lteiot3_t *ctx, uint8_t *data_in, uint16_t len );
 
err_t lteiot3_generic_read ( lteiot3_t *ctx, uint8_t *data_out, uint16_t len );
 
void lteiot3_set_on_pin ( lteiot3_t *ctx, uint8_t state );
 
void lteiot3_set_rts_pin ( lteiot3_t *ctx, uint8_t state );
 
void lteiot3_set_cs_pin ( lteiot3_t *ctx, uint8_t state );
 
uint8_t lteiot3_get_smi_pin ( lteiot3_t *ctx );
 
uint8_t lteiot3_get_cts_pin ( lteiot3_t *ctx );
 
void lteiot3_send_cmd ( lteiot3_t *ctx, uint8_t *cmd );
 
void lteiot3_send_cmd_with_parameter ( lteiot3_t *ctx, uint8_t *at_cmd_buf, uint8_t *param_buf );
 
void lteiot3_send_cmd_check ( lteiot3_t *ctx, uint8_t *at_cmd_buf );
 
void lteiot3_send_cmd_parameter_check ( lteiot3_t *ctx, uint8_t *at_cmd_buf );
 
void lteiot3_set_sim_apn ( lteiot3_t *ctx, uint8_t *sim_apn );
 
void lteiot3_send_sms_text ( lteiot3_t *ctx, uint8_t *phone_number, uint8_t *sms_text );
 
err_t lteiot3_send_sms_pdu ( lteiot3_t *ctx, uint8_t *service_center_number, uint8_t *phone_number, uint8_t *sms_text );
 
err_t lteiot3_parse_gga ( uint8_t *rsp_buf, uint8_t gga_element, uint8_t *element_data );
 
#ifdef __cplusplus
}
#endif
#endif // LTEIOT3_H
 
 // lteiot3
 
// ------------------------------------------------------------------------ END