lteiot6.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 LTEIOT6_H
#define LTEIOT6_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"
 
 
#define LTEIOT6_CMD_AT          "AT"
#define LTEIOT6_CMD_ATI         "ATI"
#define LTEIOT6_CMD_CGMR        "AT+CGMR"
#define LTEIOT6_CMD_CFUN        "AT+CFUN"
#define LTEIOT6_CMD_CREG        "AT+CREG"
#define LTEIOT6_CMD_CEREG       "AT+CEREG"
#define LTEIOT6_CMD_CGDCONT     "AT+CGDCONT"
#define LTEIOT6_CMD_CIMI        "AT+CIMI"
#define LTEIOT6_CMD_CGATT       "AT+CGATT"
#define LTEIOT6_CMD_CSQ         "AT+CSQ"
#define LTEIOT6_CMD_CESQ        "AT+CESQ"
#define LTEIOT6_CMD_COPS        "AT+COPS"
#define LTEIOT6_CMD_CMGF        "AT+CMGF"
#define LTEIOT6_CMD_CMGS        "AT+CMGS"
#define LTEIOT6_CMD_CSCA        "AT+CSCA"
#define LTEIOT6_CMD_SQNLED      "AT+SQNLED"
 
 // lteiot6_cmd
 
#define LTEIOT6_RSP_OK          "OK"
#define LTEIOT6_RSP_ERROR       "ERROR"
#define LTEIOT6_RSP_SYSTART     "+SYSSTART"
 
#define DRV_BUFFER_SIZE                       400
 
 // lteiot6_set
 
#define LTEIOT6_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.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
  cfg.rts = MIKROBUS( mikrobus, MIKROBUS_CS ); \
  cfg.ri = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
  cfg.cts = MIKROBUS( mikrobus, MIKROBUS_INT );
 
 // lteiot6_map
 // lteiot6
 
typedef struct
{
    // Output pins 
    digital_out_t pwr;
    digital_out_t rst;
    digital_out_t rts;
 
    // Input pins 
    digital_in_t ri;
    digital_in_t cts;
    digital_in_t rx_pin;
    
    // Modules 
 
    uart_t uart;
 
    char uart_rx_buffer[ DRV_BUFFER_SIZE ];
    char uart_tx_buffer[ DRV_BUFFER_SIZE ];
 
} lteiot6_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 rst;
    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.    
 
} lteiot6_cfg_t;
 
typedef enum
{
   LTEIOT6_OK = 0,
   LTEIOT6_ERROR = -1,
   LTEIOT6_ERROR_TIMEOUT = -2,
   LTEIOT6_ERROR_CMD = -3,
   LTEIOT6_ERROR_UNKNOWN = -4
 
} lteiot8_return_value_t;
 
#ifdef __cplusplus
extern "C"{
#endif
 
void lteiot6_cfg_setup ( lteiot6_cfg_t *cfg );
 
err_t lteiot6_init ( lteiot6_t *ctx, lteiot6_cfg_t *cfg );
 
err_t lteiot6_generic_write ( lteiot6_t *ctx, char *data_buf, uint16_t len );
 
err_t lteiot6_generic_read ( lteiot6_t *ctx, char *data_buf, uint16_t max_len );
 
void lteiot6_power_on ( lteiot6_t *ctx );
 
void lteiot6_reset ( lteiot6_t *ctx );
 
void lteiot6_set_pwr ( lteiot6_t *ctx, uint8_t state );
 
void lteiot6_set_rst ( lteiot6_t *ctx, uint8_t state );
 
void lteiot6_set_rts ( lteiot6_t *ctx, uint8_t state );
 
uint8_t lteiot6_get_ri ( lteiot6_t *ctx );
 
uint8_t lteiot6_get_cts ( lteiot6_t *ctx );
 
void lteiot6_send_cmd ( lteiot6_t *ctx, char *cmd );
 
void lteiot6_send_cmd_with_parameter ( lteiot6_t *ctx, char *at_cmd_buf, char *param_buf );
 
void lteiot6_send_cmd_check ( lteiot6_t *ctx, char *at_cmd_buf );
 
void lteiot6_send_cmd_parameter_check ( lteiot6_t *ctx, char *at_cmd_buf );
 
void lteiot6_set_sim_apn ( lteiot6_t *ctx, char *sim_apn );
 
void lteiot6_send_text_message ( lteiot6_t *ctx, char *phone_number, char *message_content );
 
err_t lteiot6_send_sms_pdu ( lteiot6_t *ctx, char *service_center_number, char *phone_number, char *sms_text );
 
#ifdef __cplusplus
}
#endif
#endif // LTEIOT6_H
 
 // lteiot6
 
// ------------------------------------------------------------------------ END