gsm5.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 GSM5_H
#define GSM5_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 GSM5_CMD_AT                 "AT"
#define GSM5_CMD_ATI                "ATI"
#define GSM5_CMD_CGMR               "AT+CGMR"
#define GSM5_CMD_CFUN               "AT+CFUN"
#define GSM5_CMD_CREG               "AT+CREG"
#define GSM5_CMD_CGREG              "AT+CGREG"
#define GSM5_CMD_CGDCONT            "AT+CGDCONT"
#define GSM5_CMD_CIMI               "AT+CIMI"
#define GSM5_CMD_CMEE               "AT+CMEE"
#define GSM5_CMD_CGATT              "AT+CGATT"
#define GSM5_CMD_CSQ                "AT+CSQ"
#define GSM5_CMD_COPS               "AT+COPS"
#define GSM5_CMD_CMGS               "AT+CMGS"
#define GSM5_CMD_CMGF               "AT+CMGF"
#define GSM5_CMD_CGACT              "AT+CGACT"
#define GSM5_CMD_UPSDA              "AT+UPSDA"
#define GSM5_CMD_USOCR              "AT+USOCR"
#define GSM5_CMD_USOCO              "AT+USOCO"
#define GSM5_CMD_USOWR              "AT+USOWR"
#define GSM5_CMD_USORD              "AT+USORD"
#define GSM5_CMD_USORF              "AT+USORF"
#define GSM5_CMD_USOCL              "AT+USOCL"
 
#define GSM5_RSP_OK                 "OK"
#define GSM5_RSP_ERROR              "ERROR"
 
#define DRV_BUFFER_SIZE             256
 
 // gsm5_cmd
 
#define GSM5_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.tx_pin  = MIKROBUS( mikrobus, MIKROBUS_TX ); \
    cfg.rx_pin  = MIKROBUS( mikrobus, MIKROBUS_RX ); \
    cfg.on = MIKROBUS( mikrobus, MIKROBUS_AN ); \
    cfg.off = MIKROBUS( mikrobus, MIKROBUS_RST ); \
    cfg.rts = MIKROBUS( mikrobus, MIKROBUS_CS ); \
    cfg.ring = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
    cfg.cts = MIKROBUS( mikrobus, MIKROBUS_INT );
 
 // gsm5_map
 // gsm5
 
typedef struct
{
    // Output pins
    digital_out_t on;           
    digital_out_t off;          
    digital_out_t rts;          
    // Input pins
    digital_in_t ring;          
    digital_in_t cts;           
    // Modules
    uart_t uart;                
    // Buffers
    char uart_rx_buffer[ DRV_BUFFER_SIZE ];     
    char uart_tx_buffer[ DRV_BUFFER_SIZE ];     
} gsm5_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 off;             
    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;         
} gsm5_cfg_t;
 
typedef enum
{
    GSM5_OK = 0,
    GSM5_ERROR = -1,
    GSM5_ERROR_TIMEOUT = -2,
    GSM5_ERROR_CMD = -3,
    GSM5_ERROR_UNKNOWN = -4
 
} gsm5_return_value_t;
 
void gsm5_cfg_setup ( gsm5_cfg_t *cfg );
 
err_t gsm5_init ( gsm5_t *ctx, gsm5_cfg_t *cfg );
 
err_t gsm5_generic_write ( gsm5_t *ctx, char *data_buf, uint16_t len );
 
err_t gsm5_generic_read ( gsm5_t *ctx, char *data_buf, uint16_t len );
 
void gsm5_set_on_pin ( gsm5_t *ctx, uint8_t state );
 
void gsm5_set_off_pin ( gsm5_t *ctx, uint8_t state );
 
void gsm5_set_rts_pin ( gsm5_t *ctx, uint8_t state );
 
uint8_t gsm5_get_ring_pin ( gsm5_t *ctx );
 
uint8_t gsm5_get_cts_pin ( gsm5_t *ctx );
 
void gsm5_module_power_on ( gsm5_t *ctx );
 
void gsm5_send_cmd ( gsm5_t *ctx, char *cmd );
 
void gsm5_send_cmd_with_parameter ( gsm5_t *ctx, char *at_cmd_buf, char *param_buf );
 
void gsm5_send_cmd_check ( gsm5_t *ctx, char *at_cmd_buf );
 
void gsm5_send_cmd_parameter_check ( gsm5_t *ctx, char *at_cmd_buf );
 
void gsm5_set_sim_apn ( gsm5_t *ctx, char *sim_apn );
 
void gsm5_send_sms_text ( gsm5_t *ctx, char *phone_number, char *sms_text );
 
err_t gsm5_send_sms_pdu ( gsm5_t *ctx, char *service_center_number, char *phone_number, char *sms_text );
 
#ifdef __cplusplus
}
#endif
#endif // GSM5_H
 
 // gsm5
 
// ------------------------------------------------------------------------ END