c5gnbiot.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 C5GNBIOT_H
#define C5GNBIOT_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 C5GNBIOT_MAP_MIKROBUS( cfg, mikrobus ) \
  cfg.tx_pin  = MIKROBUS( mikrobus, MIKROBUS_TX ); \
  cfg.rx_pin  = MIKROBUS( mikrobus, MIKROBUS_RX ); \
  cfg.on = MIKROBUS( mikrobus, MIKROBUS_RST ); \
  cfg.cts = MIKROBUS( mikrobus, MIKROBUS_CS ); \
  cfg.rts = MIKROBUS( mikrobus, MIKROBUS_INT )
#define C5GNBIOT_MODULE_POWER_ON   1
#define C5GNBIOT_MODULE_POWER_OFF  0
#define C5GNBIOT_CMD_AT          "AT"
#define C5GNBIOT_CMD_ATI         "ATI"
#define C5GNBIOT_CMD_CGMR        "AT+CGMR"
 
#define C5GNBIOT_CMD_CFUN        "AT+CFUN"
#define C5GNBIOT_CMD_CREG        "AT+CREG"
#define C5GNBIOT_CMD_CEREG       "AT+CEREG"
#define C5GNBIOT_CMD_CGDCONT     "AT+CGDCONT"
#define C5GNBIOT_CMD_CIMI        "AT+CIMI"
#define C5GNBIOT_CMD_CGATT       "AT+CGATT"
#define C5GNBIOT_CMD_CESQ        "AT+CESQ"
#define C5GNBIOT_CMD_COPS        "AT+COPS"
#define C5GNBIOT_CMD_CMGS        "AT+CMGS"
#define DRV_RX_BUFFER_SIZE 300
#define DRV_TX_BUFFER_SIZE 300
 // End group macro 
// --------------------------------------------------------------- PUBLIC TYPES
typedef struct
{
    // Output pins 
 
    digital_out_t on;
    digital_out_t rts;
    
    // Input pins 
    
    digital_in_t cts;
    
    // Modules 
 
    uart_t uart;
 
    char uart_rx_buffer[ DRV_RX_BUFFER_SIZE ];
    char uart_tx_buffer[ DRV_TX_BUFFER_SIZE ];
 
} c5gnbiot_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 cts;
    pin_name_t rts;
 
    // 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.    
 
} c5gnbiot_cfg_t;
 
typedef enum
{
    C5GNBIOT_OK = 0,
    C5GNBIOT_ERROR = -1
 
} c5gnbiot_return_value_t;
 
 // End types group
// ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
 
#ifdef __cplusplus
extern "C"{
#endif
 
void c5gnbiot_cfg_setup ( c5gnbiot_cfg_t *cfg );
 
err_t c5gnbiot_init ( c5gnbiot_t *ctx, c5gnbiot_cfg_t *cfg );
 
err_t c5gnbiot_generic_write ( c5gnbiot_t *ctx, char *data_buf, uint16_t len );
 
err_t c5gnbiot_generic_read ( c5gnbiot_t *ctx, char *data_buf, uint16_t max_len );
 
void c5gnbiot_power_on ( c5gnbiot_t *ctx );
 
void c5gnbiot_set_on ( c5gnbiot_t *ctx, uint8_t state );
 
void c5gnbiot_set_rts ( c5gnbiot_t *ctx, uint8_t state );
 
uint8_t c5gnbiot_get_cts ( c5gnbiot_t *ctx );
 
void c5gnbiot_send_cmd ( c5gnbiot_t *ctx, char *cmd );
 
void c5gnbiot_send_cmd_with_parameter ( c5gnbiot_t *ctx, char *at_cmd_buf, char *param_buf );
 
void c5gnbiot_send_cmd_check ( c5gnbiot_t *ctx, char *at_cmd_buf );
 
void c5gnbiot_send_cmd_parameter_check ( c5gnbiot_t *ctx, char *at_cmd_buf );
 
void c5gnbiot_set_sim_apn ( c5gnbiot_t *ctx, char *sim_apn );
 
err_t c5gnbiot_send_text_message ( c5gnbiot_t *ctx, char *service_center_number, 
                                                   char *phone_number, char *sms_text );
 
#ifdef __cplusplus
}
#endif
#endif  // _C5GNBIOT_H_
 
 // End public_function group
 
// ------------------------------------------------------------------------- END