lteiot7.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 LTEIOT7_H
#define LTEIOT7_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 LTEIOT7_CMD_AT                              "AT"
#define LTEIOT7_CMD_ATI                             "ATI"
#define LTEIOT7_CMD_CGMR                            "AT+CGMR"
#define LTEIOT7_CMD_CFUN                            "AT+CFUN"
#define LTEIOT7_CMD_CREG                            "AT+CREG"
#define LTEIOT7_CMD_CGREG                           "AT+CGREG"
#define LTEIOT7_CMD_CGDCONT                         "AT+CGDCONT"
#define LTEIOT7_CMD_CIMI                            "AT+CIMI"
#define LTEIOT7_CMD_CMEE                            "AT+CMEE"
#define LTEIOT7_CMD_CGATT                           "AT+CGATT"
#define LTEIOT7_CMD_CSQ                             "AT+CSQ"
#define LTEIOT7_CMD_COPS                            "AT+COPS"
#define LTEIOT7_CMD_CMGS                            "AT+CMGS"
#define LTEIOT7_CMD_CMGF                            "AT+CMGF"
#define LTEIOT7_CMD_CGACT                           "AT+CGACT"
#define LTEIOT7_CMD_USOCR                           "AT+USOCR"
#define LTEIOT7_CMD_USOCO                           "AT+USOCO"
#define LTEIOT7_CMD_USOWR                           "AT+USOWR"
#define LTEIOT7_CMD_USORD                           "AT+USORD"
#define LTEIOT7_CMD_USORF                           "AT+USORF"
#define LTEIOT7_CMD_USOCL                           "AT+USOCL"
#define LTEIOT7_CMD_UGPS                            "AT+UGPS"
#define LTEIOT7_CMD_UGGGA                           "AT+UGGGA"
 
#define LTEIOT7_RSP_OK                              "OK"
#define LTEIOT7_RSP_ERROR                           "ERROR"
 
#define LTEIOT7_POWER_STATE_SWITCH                  0
#define LTEIOT7_POWER_STATE_ON                      1
#define LTEIOT7_POWER_STATE_REBOOT                  2
 
#define LTEIOT7_RSP_START                           "$"
#define LTEIOT7_RSP_DELIMITER                       ","
#define LTEIOT7_RSP_GPGGA                           "$GPGGA"
 
#define LTEIOT7_GPGGA_ELEMENT_SIZE                  15
#define LTEIOT7_GPGGA_TIME                          1
#define LTEIOT7_GPGGA_LATITUDE                      2
#define LTEIOT7_GPGGA_LATITUDE_SIDE                 3
#define LTEIOT7_GPGGA_LONGITUDE                     4
#define LTEIOT7_GPGGA_LONGITUDE_SIDE                5
#define LTEIOT7_GPGGA_QUALITY_INDICATOR             6
#define LTEIOT7_GPGGA_NUMBER_OF_SATELLITES          7
#define LTEIOT7_GPGGA_H_DILUTION_OF_POS             8
#define LTEIOT7_GPGGA_ALTITUDE                      9
#define LTEIOT7_GPGGA_ALTITUDE_UNIT                 10
#define LTEIOT7_GPGGA_GEOIDAL_SEPARATION            11
#define LTEIOT7_GPGGA_GEOIDAL_SEPARATION_UNIT       12
#define LTEIOT7_GPGGA_TIME_SINCE_LAST_DGPS          13
#define LTEIOT7_GPGGA_DGPS_REFERENCE_STATION_ID     14
 
#define DRV_BUFFER_SIZE                             256
 
 // lteiot7_cmd
 
#define LTEIOT7_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.ein = MIKROBUS( mikrobus, MIKROBUS_RST ); \
    cfg.rts = MIKROBUS( mikrobus, MIKROBUS_CS ); \
    cfg.ri = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
    cfg.cts = MIKROBUS( mikrobus, MIKROBUS_INT );
 
 // lteiot7_map
 // lteiot7
 
typedef struct
{
    // Output pins
    digital_out_t pwr;          
    digital_out_t ein;          
    digital_out_t rts;          
    // Input pins
    digital_in_t ri;            
    digital_in_t cts;           
    // Modules
    uart_t uart;                
    // Buffers
    char uart_rx_buffer[ DRV_BUFFER_SIZE ];     
    char uart_tx_buffer[ DRV_BUFFER_SIZE ];     
} lteiot7_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 ein;             
    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;                 
} lteiot7_cfg_t;
 
typedef enum
{
    LTEIOT7_OK = 0,
    LTEIOT7_ERROR = -1,
    LTEIOT7_ERROR_TIMEOUT = -2,
    LTEIOT7_ERROR_CMD = -3,
    LTEIOT7_ERROR_UNKNOWN = -4
 
} lteiot7_return_value_t;
 
void lteiot7_cfg_setup ( lteiot7_cfg_t *cfg );
 
err_t lteiot7_init ( lteiot7_t *ctx, lteiot7_cfg_t *cfg );
 
err_t lteiot7_generic_write ( lteiot7_t *ctx, char *data_in, uint16_t len );
 
err_t lteiot7_generic_read ( lteiot7_t *ctx, char *data_out, uint16_t len );
 
void lteiot7_set_pwr_pin ( lteiot7_t *ctx, uint8_t state );
 
void lteiot7_set_ein_pin ( lteiot7_t *ctx, uint8_t state );
 
void lteiot7_set_rts_pin ( lteiot7_t *ctx, uint8_t state );
 
uint8_t lteiot7_get_ri_pin ( lteiot7_t *ctx );
 
uint8_t lteiot7_get_cts_pin ( lteiot7_t *ctx );
 
void lteiot7_set_power_state ( lteiot7_t *ctx, uint8_t state );
 
void lteiot7_send_cmd ( lteiot7_t *ctx, char *cmd );
 
void lteiot7_send_cmd_with_parameter ( lteiot7_t *ctx, char *at_cmd_buf, char *param_buf );
 
void lteiot7_send_cmd_check ( lteiot7_t *ctx, char *at_cmd_buf );
 
void lteiot7_send_cmd_parameter_check ( lteiot7_t *ctx, char *at_cmd_buf );
 
void lteiot7_set_sim_apn ( lteiot7_t *ctx, char *sim_apn );
 
void lteiot7_send_sms_text ( lteiot7_t *ctx, char *phone_number, char *sms_text );
 
err_t lteiot7_send_sms_pdu ( lteiot7_t *ctx, char *service_center_number, char *phone_number, char *sms_text );
 
err_t lteiot7_parse_gpgga ( char *rsp_buf, uint8_t gpgga_element, char *element_data );
 
#ifdef __cplusplus
}
#endif
#endif // LTEIOT7_H
 
 // lteiot7
 
// ------------------------------------------------------------------------ END