c4gltegnss.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 C4GLTEGNSS_H
#define C4GLTEGNSS_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 C4GLTEGNSS_CMD_AT                           "AT"
#define C4GLTEGNSS_CMD_ATI                          "ATI"
#define C4GLTEGNSS_CMD_CGMR                         "AT+CGMR"
#define C4GLTEGNSS_CMD_CFUN                         "AT+CFUN"
#define C4GLTEGNSS_CMD_CREG                         "AT+CREG"
#define C4GLTEGNSS_CMD_CGREG                        "AT+CGREG"
#define C4GLTEGNSS_CMD_CGDCONT                      "AT+CGDCONT"
#define C4GLTEGNSS_CMD_CIMI                         "AT+CIMI"
#define C4GLTEGNSS_CMD_CMEE                         "AT+CMEE"
#define C4GLTEGNSS_CMD_CGATT                        "AT+CGATT"
#define C4GLTEGNSS_CMD_CSQ                          "AT+CSQ"
#define C4GLTEGNSS_CMD_COPS                         "AT+COPS"
#define C4GLTEGNSS_CMD_CMGS                         "AT+CMGS"
#define C4GLTEGNSS_CMD_CMGF                         "AT+CMGF"
#define C4GLTEGNSS_CMD_CGACT                        "AT+CGACT"
#define C4GLTEGNSS_CMD_UPSDA                        "AT+UPSDA"
#define C4GLTEGNSS_CMD_USOCR                        "AT+USOCR"
#define C4GLTEGNSS_CMD_USOCO                        "AT+USOCO"
#define C4GLTEGNSS_CMD_USOWR                        "AT+USOWR"
#define C4GLTEGNSS_CMD_USORD                        "AT+USORD"
#define C4GLTEGNSS_CMD_USORF                        "AT+USORF"
#define C4GLTEGNSS_CMD_USOCL                        "AT+USOCL"
#define C4GLTEGNSS_CMD_UGPS                         "AT+UGPS"
#define C4GLTEGNSS_CMD_UGGGA                        "AT+UGGGA"
 
#define C4GLTEGNSS_RSP_OK                           "OK"
#define C4GLTEGNSS_RSP_ERROR                        "ERROR"
 
#define C4GLTEGNSS_POWER_STATE_OFF                  0
#define C4GLTEGNSS_POWER_STATE_ON                   1
 
#define C4GLTEGNSS_RSP_START                        "$"
#define C4GLTEGNSS_RSP_DELIMITER                    ","
#define C4GLTEGNSS_RSP_END                          "\r\n"
#define C4GLTEGNSS_RSP_GGA                          "GGA"
 
#define C4GLTEGNSS_GGA_ELEMENT_SIZE                 15
#define C4GLTEGNSS_GGA_TIME                         1
#define C4GLTEGNSS_GGA_LATITUDE                     2
#define C4GLTEGNSS_GGA_LATITUDE_SIDE                3
#define C4GLTEGNSS_GGA_LONGITUDE                    4
#define C4GLTEGNSS_GGA_LONGITUDE_SIDE               5
#define C4GLTEGNSS_GGA_QUALITY_INDICATOR            6
#define C4GLTEGNSS_GGA_NUMBER_OF_SATELLITES         7
#define C4GLTEGNSS_GGA_H_DILUTION_OF_POS            8
#define C4GLTEGNSS_GGA_ALTITUDE                     9
#define C4GLTEGNSS_GGA_ALTITUDE_UNIT                10
#define C4GLTEGNSS_GGA_GEOIDAL_SEPARATION           11
#define C4GLTEGNSS_GGA_GEOIDAL_SEPARATION_UNIT      12
#define C4GLTEGNSS_GGA_TIME_SINCE_LAST_DGPS         13
#define C4GLTEGNSS_GGA_DGPS_REFERENCE_STATION_ID    14
 
#define C4GLTEGNSS_TX_DRV_BUFFER_SIZE               256
#define C4GLTEGNSS_RX_DRV_BUFFER_SIZE               256
 
 // c4gltegnss_cmd
 
#define C4GLTEGNSS_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.tx_pin  = MIKROBUS( mikrobus, MIKROBUS_TX ); \
    cfg.rx_pin  = MIKROBUS( mikrobus, MIKROBUS_RX ); \
    cfg.pwr = MIKROBUS( mikrobus, MIKROBUS_AN ); \
    cfg.rts = MIKROBUS( mikrobus, MIKROBUS_CS ); \
    cfg.ri = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
    cfg.cts = MIKROBUS( mikrobus, MIKROBUS_INT );
 
 // c4gltegnss_map
 // c4gltegnss
 
typedef struct
{
    // Output pins
    digital_out_t pwr;                  
    digital_out_t rts;                  
    // Input pins
    digital_in_t ri;                    
    digital_in_t cts;                   
    // Modules
    uart_t uart;                        
    // Buffers
    uint8_t uart_rx_buffer[ C4GLTEGNSS_RX_DRV_BUFFER_SIZE ];    
    uint8_t uart_tx_buffer[ C4GLTEGNSS_TX_DRV_BUFFER_SIZE ];    
} c4gltegnss_t;
 
typedef struct
{
    // Communication gpio pins
    pin_name_t rx_pin;                  
    pin_name_t tx_pin;                  
    // Additional gpio pins
    pin_name_t pwr;                     
    pin_name_t rts;                     
    pin_name_t ri;                      
    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;          
} c4gltegnss_cfg_t;
 
typedef enum
{
    C4GLTEGNSS_OK = 0,
    C4GLTEGNSS_ERROR = -1,
    C4GLTEGNSS_ERROR_TIMEOUT = -2,
    C4GLTEGNSS_ERROR_CMD = -3,
    C4GLTEGNSS_ERROR_UNKNOWN = -4
 
} c4gltegnss_return_value_t;
 
void c4gltegnss_cfg_setup ( c4gltegnss_cfg_t *cfg );
 
err_t c4gltegnss_init ( c4gltegnss_t *ctx, c4gltegnss_cfg_t *cfg );
 
err_t c4gltegnss_generic_write ( c4gltegnss_t *ctx, uint8_t *data_in, uint16_t len );
 
err_t c4gltegnss_generic_read ( c4gltegnss_t *ctx, uint8_t *data_out, uint16_t len );
 
void c4gltegnss_set_pwr_pin ( c4gltegnss_t *ctx, uint8_t state );
 
void c4gltegnss_set_rts_pin ( c4gltegnss_t *ctx, uint8_t state );
 
uint8_t c4gltegnss_get_ri_pin ( c4gltegnss_t *ctx );
 
uint8_t c4gltegnss_get_cts_pin ( c4gltegnss_t *ctx );
 
void c4gltegnss_set_power_state ( c4gltegnss_t *ctx, uint8_t state );
 
void c4gltegnss_send_cmd ( c4gltegnss_t *ctx, uint8_t *cmd );
 
void c4gltegnss_send_cmd_with_par ( c4gltegnss_t *ctx, uint8_t *at_cmd_buf, uint8_t *param_buf );
 
void c4gltegnss_send_cmd_check ( c4gltegnss_t *ctx, uint8_t *at_cmd_buf );
 
void c4gltegnss_send_cmd_par_check ( c4gltegnss_t *ctx, uint8_t *at_cmd_buf );
 
void c4gltegnss_set_sim_apn ( c4gltegnss_t *ctx, uint8_t *sim_apn );
 
void c4gltegnss_send_sms_text ( c4gltegnss_t *ctx, uint8_t *phone_number, uint8_t *sms_text );
 
err_t c4gltegnss_send_sms_pdu ( c4gltegnss_t *ctx, uint8_t *service_center_number, uint8_t *phone_number, uint8_t *sms_text );
 
err_t c4gltegnss_parse_gga ( uint8_t *rsp_buf, uint8_t gga_element, uint8_t *element_data );
 
#ifdef __cplusplus
}
#endif
#endif // C4GLTEGNSS_H
 
 // c4gltegnss
 
// ------------------------------------------------------------------------ END