lteiot2.h

Go to the documentation of this file.

/*
 * MikroSDK - MikroE Software Development Kit
 * Copyright© 2020 MikroElektronika d.o.o.
 * 
 * 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 LTEIOT2_H
#define LTEIOT2_H
 
#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"
 
// -------------------------------------------------------------- PUBLIC MACROS 
#define LTEIOT2_MAP_MIKROBUS( cfg, mikrobus ) \
  cfg.tx_pin = MIKROBUS( mikrobus, MIKROBUS_TX ); \
  cfg.rx_pin = MIKROBUS( mikrobus, MIKROBUS_RX ); \
  cfg.sta    = MIKROBUS( mikrobus, MIKROBUS_AN ); \
  cfg.pwk    = MIKROBUS( mikrobus, MIKROBUS_RST ); \
  cfg.rts    = MIKROBUS( mikrobus, MIKROBUS_CS ); \
  cfg.ri     = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
  cfg.cts    = MIKROBUS( mikrobus, MIKROBUS_INT )
#define LTEIOT2_RETVAL  uint8_t
#define LTEIOT2_NMEA_GPGGA 1
#define LTEIOT2_NMEA_GPGGA_NUM_ELEMENT 15
#define LTEIOT2_GPGGA_TIME                      1 
#define LTEIOT2_GPGGA_LATITUDE                  2
#define LTEIOT2_GPGGA_LATITUDE_SIDE             3
#define LTEIOT2_GPGGA_LONGITUDE                 4
#define LTEIOT2_GPGGA_LONGITUDE_SIDE            5
#define LTEIOT2_GPGGA_QUALITY_INDICATOR         6
#define LTEIOT2_GPGGA_NUMBER_OF_SATELLITES      7
#define LTEIOT2_GPGGA_H_DILUTION_OF_POS         8
#define LTEIOT2_GPGGA_ALTITUDE                  9
#define LTEIOT2_GPGGA_ALTITUDE_UNIT             10
#define LTEIOT2_GPGGA_GEOIDAL_SEPARATION        11
#define LTEIOT2_GPGGA_GEOIDAL_SEPARATION_UNIT   12
#define LTEIOT2_GPGGA_TIME_SINCE_LAST_DGPS      13
#define LTEIOT2_GPGGA_DGPS_REFERENCE_STATION_ID 14
#define LTEIOT2_ERROR_COMMAND_OR_ELEMENT   0xFF
#define LTEIOT2_ERROR_START_OR_END_COMMAND 0x8F
#define LTEIOT2_ERROR_NEXT_ELEMENT         0x4F
#define LTEIOT2_ERROR_CURRENT_ELEMENT      0x2F
#define LTEIOT2_NO_ERROR                   0x00
#define LTEIOT2_MODULE_POWER_ON   1
#define LTEIOT2_MODULE_POWER_OFF  0
#define LTEIOT2_CMD_AT          "AT"
#define LTEIOT2_CMD_ATI         "ATI"
#define LTEIOT2_CMD_CGMR        "AT+CGMR"
 
#define LTEIOT2_CMD_CFUN        "AT+CFUN"
#define LTEIOT2_CMD_CREG        "AT+CREG"
#define LTEIOT2_CMD_CGDCONT     "AT+CGDCONT"
#define LTEIOT2_CMD_CIMI        "AT+CIMI"
#define LTEIOT2_CMD_CGATT       "AT+CGATT"
#define LTEIOT2_CMD_CSQ         "AT+CSQ"
#define LTEIOT2_CMD_COPS        "AT+COPS"
#define LTEIOT2_CMD_CMGS        "AT+CMGS"
#define LTEIOT2_CMD_CMGF        "AT+CMGF"
#define LTEIOT2_CMD_QGPS        "AT+QGPS"
#define LTEIOT2_CMD_QGPSCFG     "AT+QGPSCFG"
#define LTEIOT2_CMD_QGPSGNMEA   "AT+QGPSGNMEA"
#define LTEIOT2_CMD_QGPSLOC     "AT+QGPSLOC"
#define DRV_RX_BUFFER_SIZE 256
#define DRV_TX_BUFFER_SIZE 256
 // End group macro 
// --------------------------------------------------------------- PUBLIC TYPES
typedef struct
{
    // Output pins 
 
    digital_out_t pwk;
    digital_out_t rts;
 
 
    // Input pins 
 
    digital_in_t sta;
    digital_in_t ri;
    digital_in_t cts;
    
    // Modules 
 
    uart_t uart;
 
    char uart_rx_buffer[ DRV_RX_BUFFER_SIZE ];
    char uart_tx_buffer[ DRV_RX_BUFFER_SIZE ];
 
} lteiot2_t;
 
typedef struct
{
    // Communication gpio pins 
 
    pin_name_t rx_pin;
    pin_name_t tx_pin;
    
    // Additional gpio pins 
 
    pin_name_t sta;
    pin_name_t pwk;
    pin_name_t rts;
    pin_name_t ri;
    pin_name_t cts;
 
    // static variable 
 
    uint32_t          baud_rate;     // Clock speed.
    bool              uart_blocking;
    uart_data_bits_t  data_bit;      // Data bits.
    uart_parity_t     parity_bit;    // Parity bit.  
    uart_stop_bits_t  stop_bit;      // Stop bits.    
 
} lteiot2_cfg_t;
 
typedef enum
{
    LTEIOT2_OK = 0,
    LTEIOT2_ERROR = -1
 
} lteiot2_return_value_t;
 
typedef uint8_t lteiot2_error_t;
 
 // End types group
// ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
 
#ifdef __cplusplus
extern "C"{
#endif
 
void lteiot2_cfg_setup ( lteiot2_cfg_t *cfg );
 
LTEIOT2_RETVAL lteiot2_init ( lteiot2_t *ctx, lteiot2_cfg_t *cfg );
 
void lteiot2_module_power ( lteiot2_t *ctx, uint8_t state );
 
void lteiot2_generic_write ( lteiot2_t *ctx, char *data_buf, uint16_t len );
 
int32_t lteiot2_generic_read ( lteiot2_t *ctx, char *data_buf, uint16_t max_len );
 
void lteiot2_set_rts ( lteiot2_t *ctx, uint8_t state );
 
uint8_t lteiot2_get_cts ( lteiot2_t *ctx );
 
void lteiot2_send_cmd ( lteiot2_t *ctx, char *cmd );
 
void lteiot2_send_cmd_with_parameter ( lteiot2_t *ctx, char *at_cmd_buf, char *param_buf );
 
void lteiot2_send_cmd_check ( lteiot2_t *ctx, char *at_cmd_buf );
 
void lteiot2_send_cmd_parameter_check ( lteiot2_t *ctx, char *at_cmd_buf );
 
void lteiot2_set_sim_apn ( lteiot2_t *ctx, char *sim_apn );
 
void lteiot2_send_sms_text ( lteiot2_t *ctx, char *phone_number, char *sms_text );
 
err_t lteiot2_send_sms_pdu ( lteiot2_t *ctx, char *service_center_number, 
                                           char *phone_number, char *sms_text );
 
lteiot2_error_t lteiot2_generic_parser 
( 
    char *rsp,  uint8_t command, 
    uint8_t element, char *parser_buf 
);
 
#ifdef __cplusplus
}
#endif
#endif  // _LTEIOT2_H_
 
 // End public_function group
 
// ------------------------------------------------------------------------- END