ltecat1us.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 LTECAT1US_H
#define LTECAT1US_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 LTECAT1US_CMD_AT          "AT"
#define LTECAT1US_CMD_ATI         "ATI"
#define LTECAT1US_CMD_CGMR        "AT+CGMR"
 
#define LTECAT1US_CMD_CFUN        "AT+CFUN"
#define LTECAT1US_CMD_CREG        "AT+CREG"
#define LTECAT1US_CMD_CEREG       "AT+CEREG"
#define LTECAT1US_CMD_CGDCONT     "AT+CGDCONT"
#define LTECAT1US_CMD_CIMI        "AT+CIMI"
#define LTECAT1US_CMD_CGATT       "AT+CGATT"
#define LTECAT1US_CMD_CSQ         "AT+CSQ"
#define LTECAT1US_CMD_CESQ        "AT+CESQ"
#define LTECAT1US_CMD_COPS        "AT+COPS"
 
 
#define DRV_RX_BUFFER_SIZE 500
#define DRV_TX_BUFFER_SIZE 100
 
 // ltecat1us_set
 
#define LTECAT1US_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.tx_pin  = MIKROBUS( mikrobus, MIKROBUS_TX ); \
    cfg.rx_pin  = MIKROBUS( mikrobus, MIKROBUS_RX ); \
    cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
    cfg.cts = MIKROBUS( mikrobus, MIKROBUS_CS ); \
    cfg.cs = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
    cfg.rts = MIKROBUS( mikrobus, MIKROBUS_INT )
 
 // ltecat1us_map
 // ltecat1us
 
typedef struct
{
    // Output pins
    digital_out_t rst;   
    digital_out_t cs;    
    digital_out_t rts;  
 
    // Input pins
    digital_in_t cts;      
 
    // Modules
    uart_t uart;                                    
    // Buffers
    char uart_rx_buffer[ DRV_RX_BUFFER_SIZE ];         
    char uart_tx_buffer[ DRV_TX_BUFFER_SIZE ];         
} ltecat1us_t;
 
typedef struct
{
    // Communication gpio pins
    pin_name_t rx_pin;                                  
    pin_name_t tx_pin;                                  
    // Additional gpio pins
   //pin_name_t an;         
    pin_name_t rst;       
    pin_name_t cts;   
    pin_name_t cs;    
    pin_name_t rts;      
    
    // 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;                         
} ltecat1us_cfg_t;
 
typedef enum
{
   LTECAT1US_OK = 0,
   LTECAT1US_ERROR = -1
 
} ltecat1us_return_value_t;
 
void ltecat1us_cfg_setup ( ltecat1us_cfg_t *cfg );
 
err_t ltecat1us_init ( ltecat1us_t *ctx, ltecat1us_cfg_t *cfg );
 
void ltecat1us_generic_write ( ltecat1us_t *ctx, char *data_buf, uint16_t len );
 
err_t ltecat1us_generic_read ( ltecat1us_t *ctx, char *data_buf, uint16_t max_len );
 
 
void ltecat1us_power_on ( ltecat1us_t *ctx );
 
void ltecat1us_set_rst ( ltecat1us_t *ctx, uint8_t state );
 
void ltecat1us_set_rts ( ltecat1us_t *ctx, uint8_t state );
 
uint8_t ltecat1us_get_cts ( ltecat1us_t *ctx );
 
void ltecat1us_send_cmd ( ltecat1us_t *ctx, char *cmd );
 
void ltecat1us_send_cmd_with_parameter ( ltecat1us_t *ctx, char *at_cmd_buf, char *param_buf );
 
void ltecat1us_send_cmd_check ( ltecat1us_t *ctx, char *at_cmd_buf );
 
void ltecat1us_send_cmd_parameter_check ( ltecat1us_t *ctx, char *at_cmd_buf );
 
void ltecat1us_set_sim_apn ( ltecat1us_t *ctx, char *sim_apn );
 
void ltecat1us_send_text_message ( ltecat1us_t *ctx, char *phone_number, char *message_context );
 
#ifdef __cplusplus
}
#endif
#endif // LTECAT1US_H
 
 // ltecat1us
 
// ------------------------------------------------------------------------ END