ble10.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 BLE10_H
#define BLE10_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_analog_in.h"
#include "drv_uart.h"
 
#define BLE10_CMD_AT            "AT"        // Attention
#define BLE10_CMD_ATRST         "ATRST"     // Software Reset
#define BLE10_CMD_ATFRST        "ATFRST"    // Factory Reset
#define BLE10_CMD_ATSN          "ATSN"      // Set Device Name
#define BLE10_CMD_ATP           "ATP"       // List Pairings
#define BLE10_CMD_ATCP          "ATCP"      // Clear Pairings
#define BLE10_CMD_ATDI          "ATDI"      // Discover Nearby Devices
#define BLE10_CMD_ATT           "ATT"       // Get temperature
 
#define DRV_BUFFER_SIZE         500
 
 // ble10_cmd
 
#define BLE10_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.tx_pin  = MIKROBUS( mikrobus, MIKROBUS_TX ); \
    cfg.rx_pin  = MIKROBUS( mikrobus, MIKROBUS_RX ); \
    cfg.ain  = MIKROBUS( mikrobus, MIKROBUS_AN ); \
    cfg.rst  = MIKROBUS( mikrobus, MIKROBUS_RST ); \
    cfg.pio3 = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
    cfg.rts  = MIKROBUS( mikrobus, MIKROBUS_INT ); \
    cfg.cts  = MIKROBUS( mikrobus, MIKROBUS_CS );
 
 // ble10_map
 // ble10
 
typedef struct
{
    // Output pins
    digital_out_t rst;                      
    digital_out_t cts;                      
    // Input pins
    digital_in_t  rts;                      
    digital_in_t  pio3;                     
    // Modules
    uart_t        uart;                     
    analog_in_t   adc;                      
    // Buffers
    char uart_rx_buffer[ DRV_BUFFER_SIZE ]; 
    char uart_tx_buffer[ DRV_BUFFER_SIZE ]; 
} ble10_t;
 
typedef struct
{
    // Communication gpio pins
    pin_name_t rx_pin;                  
    pin_name_t tx_pin;                  
    pin_name_t ain;                     
    // Additional gpio pins
    pin_name_t rst;                     
    pin_name_t cts;                     
    pin_name_t rts;                     
    pin_name_t pio3;                    
    // 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;         
    analog_in_resolution_t  resolution; 
    float                   vref;       
} ble10_cfg_t;
 
typedef enum
{
    BLE10_OK = 0,
    BLE10_ERROR = -1
 
} ble10_return_value_t;
 
void ble10_cfg_setup ( ble10_cfg_t *cfg );
 
err_t ble10_init ( ble10_t *ctx, ble10_cfg_t *cfg );
 
void ble10_default_cfg ( ble10_t *ctx );
 
err_t ble10_generic_write ( ble10_t *ctx, char *data_buf, uint16_t len );
 
err_t ble10_generic_read ( ble10_t *ctx, char *data_buf, uint16_t max_len );
 
uint8_t ble10_get_rts_pin ( ble10_t *ctx );
 
uint8_t ble10_get_pio3_pin ( ble10_t *ctx );
 
void ble10_set_cts_pin ( ble10_t *ctx, uint8_t state ); 
 
void ble10_set_rst_pin ( ble10_t *ctx, uint8_t state );
 
void ble10_hw_reset ( ble10_t *ctx );
 
err_t ble10_sw_reset ( ble10_t *ctx );
 
err_t ble10_factory_reset ( ble10_t *ctx );
 
err_t ble10_send_cmd ( ble10_t *ctx, char *at_cmd_buf );
 
err_t ble10_send_cmd_with_parameter ( ble10_t *ctx, char *at_cmd_buf, char *param_buf );
 
err_t ble10_send_cmd_check ( ble10_t *ctx, char *at_cmd_buf );
 
err_t ble10_remove_pairings ( ble10_t *ctx );
 
err_t ble10_list_pairings ( ble10_t *ctx );
 
err_t ble10_set_device_name ( ble10_t *ctx, char *dev_name );
 
err_t ble10_discover_nearby_devices ( ble10_t *ctx );
 
err_t ble10_get_temperature ( ble10_t *ctx );
 
err_t ble10_read_an_pin_value ( ble10_t *ctx, uint16_t *data_out );
 
err_t ble10_read_an_pin_voltage ( ble10_t *ctx, float *data_out );
 
#ifdef __cplusplus
}
#endif
#endif // BLE10_H
 
 // ble10
 
// ------------------------------------------------------------------------ END