anynet3gea.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 ANYNET3GEA_H
#define ANYNET3GEA_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 ANYNET3GEA_CMD_AT                           "AT"
#define ANYNET3GEA_CMD_QCCID                        "AT+QCCID"
#define ANYNET3GEA_CMD_GSN                          "AT+GSN"
#define ANYNET3GEA_CMD_AWSVER                       "AT+AWSVER"
#define ANYNET3GEA_CMD_AWSRESET                     "AT+AWSRESET"
#define ANYNET3GEA_CMD_AWSSTATE                     "AT+AWSSTATE"
#define ANYNET3GEA_CMD_AWSBUTTON                    "AT+AWSBUTTON"
#define ANYNET3GEA_CMD_AWSPUBOPEN                   "AT+AWSPUBOPEN"
#define ANYNET3GEA_CMD_AWSPUBLISH                   "AT+AWSPUBLISH"
#define ANYNET3GEA_CMD_AWSSUBOPEN                   "AT+AWSSUBOPEN"
#define ANYNET3GEA_CMD_AWSPUBCLOSE                  "AT+AWSPUBCLOSE"
 
#define ANYNET3GEA_RSP_OK                           "OK"
#define ANYNET3GEA_RSP_ERROR                        "ERROR"
#define ANYNET3GEA_RSP_READY_FOR_SEND               ">"
#define ANYNET3GEA_RSP_SEND_OK                      "SEND OK"
#define ANYNET3GEA_RSP_SEND_FAIL                    "SEND FAIL"
 
#define ANYNET3GEA_RX_DRV_BUFFER_SIZE               256
#define ANYNET3GEA_TX_DRV_BUFFER_SIZE               256
 
 // anynet3gea_set
 
#define ANYNET3GEA_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.tx_pin = MIKROBUS( mikrobus, MIKROBUS_TX ); \
    cfg.rx_pin = MIKROBUS( mikrobus, MIKROBUS_RX ); \
    cfg.slp = MIKROBUS( mikrobus, MIKROBUS_RST ); \
    cfg.dsr = MIKROBUS( mikrobus, MIKROBUS_CS ); \
    cfg.dtr = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
    cfg.iot = MIKROBUS( mikrobus, MIKROBUS_INT )
 
 // anynet3gea_map
 // anynet3gea
 
typedef struct
{
    // Output pins
    digital_out_t slp;      
    digital_out_t dtr;      
    digital_out_t iot;      
    // Input pins
    digital_in_t dsr;       
    // Modules
    uart_t uart;            
    // Buffers
    uint8_t uart_rx_buffer[ ANYNET3GEA_RX_DRV_BUFFER_SIZE ];    
    uint8_t uart_tx_buffer[ ANYNET3GEA_TX_DRV_BUFFER_SIZE ];    
} anynet3gea_t;
 
typedef struct
{
    // Communication gpio pins
    pin_name_t rx_pin;      
    pin_name_t tx_pin;      
    // Additional gpio pins
    pin_name_t slp;         
    pin_name_t dtr;         
    pin_name_t iot;         
    pin_name_t dsr;         
    // 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;         
} anynet3gea_cfg_t;
 
typedef enum
{
    ANYNET3GEA_OK = 0,
    ANYNET3GEA_ERROR = -1,
    ANYNET3GEA_ERROR_TIMEOUT = -2,
    ANYNET3GEA_ERROR_CMD = -3,
    ANYNET3GEA_ERROR_SEND = -4,
    ANYNET3GEA_ERROR_UNKNOWN = -5
 
} anynet3gea_return_value_t;
 
void anynet3gea_cfg_setup ( anynet3gea_cfg_t *cfg );
 
err_t anynet3gea_init ( anynet3gea_t *ctx, anynet3gea_cfg_t *cfg );
 
err_t anynet3gea_generic_write ( anynet3gea_t *ctx, uint8_t *data_in, uint16_t len );
 
err_t anynet3gea_generic_read ( anynet3gea_t *ctx, uint8_t *data_out, uint16_t len );
 
void anynet3gea_set_slp_pin ( anynet3gea_t *ctx, uint8_t state );
 
void anynet3gea_set_dtr_pin ( anynet3gea_t *ctx, uint8_t state );
 
void anynet3gea_set_iot_pin ( anynet3gea_t *ctx, uint8_t state );
 
uint8_t anynet3gea_get_dsr_pin ( anynet3gea_t *ctx );
 
void anynet3gea_send_cmd ( anynet3gea_t *ctx, uint8_t *cmd );
 
void anynet3gea_send_cmd_with_par ( anynet3gea_t *ctx, uint8_t *at_cmd_buf, uint8_t *param_buf );
 
void anynet3gea_send_cmd_check ( anynet3gea_t *ctx, uint8_t *at_cmd_buf );
 
void anynet3gea_send_cmd_par_check ( anynet3gea_t *ctx, uint8_t *at_cmd_buf );
 
#ifdef __cplusplus
}
#endif
#endif // ANYNET3GEA_H
 
 // anynet3gea
 
// ------------------------------------------------------------------------ END