annab412.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 ANNAB412_H
#define ANNAB412_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 ANNAB412_CMD_AT                   "AT"
#define ANNAB412_CMD_ECHO_OFF             "ATE0"
#define ANNAB412_CMD_ECHO_ON              "ATE1"
#define ANNAB412_CMD_DEV_NAME             "AT+UBTLN"
#define ANNAB412_CMD_CONN_MODE            "AT+UBTCM"
#define ANNAB412_CMD_DISCOVER_MODE        "AT+UBTDM"
#define ANNAB412_CMD_ENTER_MODE           "ATO"
 
#define ANNAB412_DELIMITER_TERMINATION    13
#define ANNAB412_DELIMITER_END_CMD        0
#define ANNAB412_DELIMITER_QUOTATION      0x22
#define ANNAB412_DELIMITER_EQUAL          0x3D
#define ANNAB412_ASCII_CHAR_0             48
 
#define ANNAB412_DEV_NAME_MIN             1
#define ANNAB412_DEV_NAME_MAX             38
 
#define ANNAB412_CONNECTABLE_MODE_OFF     1
#define ANNAB412_CONNECTABLE_MODE_ON      2
 
#define ANNAB412_DISCOVERABLE_MODE_OFF    1
#define ANNAB412_DISCOVERABLE_MODE_LIM    2
#define ANNAB412_DISCOVERABLE_MODE_ON     3
 
#define ANNAB412_ENTER_MODE_COMMAND       0
#define ANNAB412_ENTER_MODE_DATA          1
#define ANNAB412_ENTER_MODE_EXT_DATA      2
#define ANNAB412_ENTER_MODE_PPP           3
 
#define ANNAB412_PIN_STATE_LOW            0
#define ANNAB412_PIN_STATE_HIGH           1
 
#define ANNAB412_TX_DRV_BUFFER_SIZE       100
#define ANNAB412_RX_DRV_BUFFER_SIZE       300
 
 // annab412_cmd
 
#define ANNAB412_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.tx_pin  = MIKROBUS( mikrobus, MIKROBUS_TX ); \
    cfg.rx_pin  = MIKROBUS( mikrobus, MIKROBUS_RX ); \
    cfg.dtr = MIKROBUS( mikrobus, MIKROBUS_AN ); \
    cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
    cfg.cts = MIKROBUS( mikrobus, MIKROBUS_CS ); \
    cfg.dsr = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
    cfg.rts = MIKROBUS( mikrobus, MIKROBUS_INT );
 
 // annab412_map
 // annab412
 
typedef struct
{
    // Output pins
    digital_out_t rst;    
    digital_out_t cts;    
    digital_out_t dsr;    
    // Input pins
    digital_in_t dtr;     
    digital_in_t rts;     
    // Modules
    uart_t uart;          
    // Buffers
    uint8_t uart_rx_buffer[ ANNAB412_RX_DRV_BUFFER_SIZE ];  
    uint8_t uart_tx_buffer[ ANNAB412_TX_DRV_BUFFER_SIZE ];  
} annab412_t;
 
typedef struct
{
    // Communication gpio pins
    pin_name_t rx_pin;    
    pin_name_t tx_pin;    
    // Additional gpio pins
    pin_name_t dtr;    
    pin_name_t rst;    
    pin_name_t cts;    
    pin_name_t dsr;    
    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;         
} annab412_cfg_t;
 
typedef enum
{
    ANNAB412_OK = 0,
    ANNAB412_ERROR = -1
 
} annab412_return_value_t;
 
void annab412_cfg_setup ( annab412_cfg_t *cfg );
 
err_t annab412_init ( annab412_t *ctx, annab412_cfg_t *cfg );
 
err_t annab412_default_cfg ( annab412_t *ctx );
 
err_t annab412_generic_write ( annab412_t *ctx, uint8_t *data_in, uint16_t len );
 
err_t annab412_generic_read ( annab412_t *ctx, uint8_t *data_out, uint16_t len );
 
void annab412_set_rst_pin ( annab412_t *ctx, uint8_t state );
 
void annab412_set_dsr_pin ( annab412_t *ctx, uint8_t state );
 
void annab412_set_cts_pin ( annab412_t *ctx, uint8_t state );
 
uint8_t annab412_get_dtr_pin ( annab412_t *ctx );
 
uint8_t annab412_get_rts_pin ( annab412_t *ctx );
 
void annab412_hw_reset ( annab412_t *ctx );
 
err_t annab412_send_command ( annab412_t *ctx, char *command );
 
err_t annab412_set_cmd_echo_on ( annab412_t *ctx );
 
err_t annab412_set_cmd_echo_off ( annab412_t *ctx );
 
err_t annab412_set_cmd_device_name ( annab412_t *ctx, char *device_name );
 
err_t annab412_set_cmd_conn_mode ( annab412_t *ctx, uint8_t mode );
 
err_t annab412_set_cmd_discover_mode ( annab412_t *ctx, uint8_t mode );
 
err_t annab412_set_cmd_enter_mode ( annab412_t *ctx, uint8_t mode );
 
#ifdef __cplusplus
}
#endif
#endif // ANNAB412_H
 
 // annab412
 
// ------------------------------------------------------------------------ END