gsmgnss2.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 GSMGNSS2_H
#define GSMGNSS2_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 GSMGNSS2_CMD_AT                             "AT"
#define GSMGNSS2_CMD_ATI                            "ATI"
#define GSMGNSS2_CMD_CGMR                           "AT+CGMR"
#define GSMGNSS2_CMD_CFUN                           "AT+CFUN"
#define GSMGNSS2_CMD_CREG                           "AT+CREG"
#define GSMGNSS2_CMD_CGREG                          "AT+CGREG"
#define GSMGNSS2_CMD_CGDCONT                        "AT+CGDCONT"
#define GSMGNSS2_CMD_CIMI                           "AT+CIMI"
#define GSMGNSS2_CMD_CMEE                           "AT+CMEE"
#define GSMGNSS2_CMD_CGATT                          "AT+CGATT"
#define GSMGNSS2_CMD_CSQ                            "AT+CSQ"
#define GSMGNSS2_CMD_COPS                           "AT+COPS"
#define GSMGNSS2_CMD_CMGS                           "AT+CMGS"
#define GSMGNSS2_CMD_CMGF                           "AT+CMGF"
#define GSMGNSS2_CMD_CGNSPWR                        "AT+CGNSPWR"
#define GSMGNSS2_CMD_CGNSTST                        "AT+CGNSTST"
 
#define GSMGNSS2_RSP_START                          "$"
#define GSMGNSS2_RSP_DELIMITER                      ","
#define GSMGNSS2_RSP_GNGGA                          "$GNGGA"
 
#define GSMGNSS2_GNGGA_ELEMENT_SIZE                 15
#define GSMGNSS2_GNGGA_TIME                         1 
#define GSMGNSS2_GNGGA_LATITUDE                     2
#define GSMGNSS2_GNGGA_LATITUDE_SIDE                3
#define GSMGNSS2_GNGGA_LONGITUDE                    4
#define GSMGNSS2_GNGGA_LONGITUDE_SIDE               5
#define GSMGNSS2_GNGGA_QUALITY_INDICATOR            6
#define GSMGNSS2_GNGGA_NUMBER_OF_SATELLITES         7
#define GSMGNSS2_GNGGA_H_DILUTION_OF_POS            8
#define GSMGNSS2_GNGGA_ALTITUDE                     9
#define GSMGNSS2_GNGGA_ALTITUDE_UNIT                10
#define GSMGNSS2_GNGGA_GEOIDAL_SEPARATION           11
#define GSMGNSS2_GNGGA_GEOIDAL_SEPARATION_UNIT      12
#define GSMGNSS2_GNGGA_TIME_SINCE_LAST_DGPS         13
#define GSMGNSS2_GNGGA_DGPS_REFERENCE_STATION_ID    14
 
#define GSMGNSS2_MODULE_POWER_ON                    1
#define GSMGNSS2_MODULE_POWER_OFF                   0
 
#define DRV_BUFFER_SIZE_RX                          256
#define DRV_BUFFER_SIZE_TX                          256 
 
 // gsmgnss2_cmd
 
#define GSMGNSS2_MAP_MIKROBUS( cfg, mikrobus ) \
  cfg.tx_pin  = MIKROBUS( mikrobus, MIKROBUS_TX ); \
  cfg.rx_pin  = MIKROBUS( mikrobus, MIKROBUS_RX ); \
  cfg.det = MIKROBUS( mikrobus, MIKROBUS_AN ); \
  cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
  cfg.rts = MIKROBUS( mikrobus, MIKROBUS_CS ); \
  cfg.ring = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
  cfg.cts = MIKROBUS( mikrobus, MIKROBUS_INT )
 
 // gsmgnss2_map
 // gsmgnss2
 
typedef struct
{
    // Output pins 
 
    digital_out_t rst;
    digital_out_t rts;
 
    // Input pins 
 
    digital_in_t det;
    digital_in_t ring;
    digital_in_t cts;
    
    // Modules
    uart_t uart;                                    
    // Buffers
    char uart_rx_buffer[ DRV_BUFFER_SIZE_RX ];      
    char uart_tx_buffer[ DRV_BUFFER_SIZE_TX ];      
} gsmgnss2_t;
 
typedef struct
{
    // Communication gpio pins
    pin_name_t rx_pin;                              
    pin_name_t tx_pin;                              
    // Additional gpio pins 
 
    pin_name_t det;
    pin_name_t rst;
    pin_name_t rts;
    pin_name_t ring;
    pin_name_t cts;
 
    // 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;                     
} gsmgnss2_cfg_t;
 
typedef enum
{
    GSMGNSS2_OK = 0,
    GSMGNSS2_ERROR = -1
 
} gsmgnss2_return_value_t;
 
void gsmgnss2_cfg_setup ( gsmgnss2_cfg_t *cfg );
 
err_t gsmgnss2_init ( gsmgnss2_t *ctx, gsmgnss2_cfg_t *cfg );
 
void gsmgnss2_module_power ( gsmgnss2_t *ctx, uint8_t state );
 
err_t gsmgnss2_generic_write ( gsmgnss2_t *ctx, char *data_buf, uint16_t len );
 
err_t gsmgnss2_generic_read ( gsmgnss2_t *ctx, char *data_buf, uint16_t max_len );
 
void gsmgnss2_send_cmd ( gsmgnss2_t *ctx, char *cmd );
 
void gsmgnss2_send_cmd_with_parameter ( gsmgnss2_t *ctx, char *at_cmd_buf, char *param_buf );
 
void gsmgnss2_send_cmd_check ( gsmgnss2_t *ctx, char *at_cmd_buf );
 
void gsmgnss2_send_cmd_parameter_check ( gsmgnss2_t *ctx, char *at_cmd_buf );
 
void gsmgnss2_set_sim_apn ( gsmgnss2_t *ctx, char *sim_apn );
 
void gsmgnss2_send_sms_text ( gsmgnss2_t *ctx, char *phone_number, char *sms_text );
 
err_t gsmgnss2_send_sms_pdu ( gsmgnss2_t *ctx, char *service_center_number, 
                              char *phone_number, char *sms_text );
 
err_t gsmgnss2_parse_gngga ( char *rsp_buf, uint8_t gngga_element, char *element_data );
 
#ifdef __cplusplus
}
#endif
#endif // GSMGNSS2_H
 
 // gsmgnss2
 
// ------------------------------------------------------------------------ END