ble4.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 BLE4_H
#define BLE4_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 BLE4_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 )
#define BLE4_RETVAL  uint8_t
 
#define BLE4_OK           0x00
#define BLE4_INIT_ERROR   0xFF
#define BLE4_END_BUFF                           0
#define BLE4_RSP_READY                          1
#define BLE4_RSP_NOT_READY                      0
#define BLE4_ECHO_ON                            1
#define BLE4_ECHO_OFF                           0
#define BLE4_COMMAND_MODE                       0
#define BLE4_DATA_MODE                          1
#define BLE4_EXT_DATA_MODE                      2
#define BLE4_PPP_MODE                           3
#define BLE4_DISABLED_ROLE                      0
#define BLE4_CENTRAL_ROLE                       1
#define BLE4_PERIPHERAL_ROLE                    2
#define BLE4_SIMULTANEOUS_ROLE                  3
#define BLE4_SEC_DISABLED                       1
#define BLE4_SEC_JUST_WORKS                     2
#define BLE4_SEC_DISPLAY_ONLY                   3
#define BLE4_SEC_DISPLAY_YES_NO                 4
#define BLE4_SEC_KEYBOARD_ONLY                  5
#define BLE4_SEC_OUT_OF_BAND                    6
#define BLE4_GAP_NON_PAIRING_MODE               1
#define BLE4_GAP_PAIRING_MODE                   2
#define BLE4_GAP_NON_CONNECTABLE_MODE           1
#define BLE4_GAP_CONNECTABLE_MODE               2
#define BLE4_GAP_NON_DISCOVERABLE_MODE          1
#define BLE4_GAP_LIMITED_DISCOVERABLE_MODE      2
#define BLE4_GAP_GENERAL_DISCOVERABLE_MODE      3
#define DRV_RX_BUFFER_SIZE 100
#define DRV_TX_BUFFER_SIZE 100
 // End group macro 
// --------------------------------------------------------------- PUBLIC TYPES
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;
 
    char uart_rx_buffer[ DRV_RX_BUFFER_SIZE ];
    char uart_tx_buffer[ DRV_TX_BUFFER_SIZE ];
 
    uint8_t rsp_rdy;
    uint8_t termination_char;
 
} ble4_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;     // 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.    
 
} ble4_cfg_t;
 
 // End types group
// ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
 
#ifdef __cplusplus
extern "C"{
#endif
 
void ble4_cfg_setup ( ble4_cfg_t *cfg );
 
BLE4_RETVAL ble4_init ( ble4_t *ctx, ble4_cfg_t *cfg );
 
void ble4_reset ( ble4_t *ctx );
 
void ble4_generic_write ( ble4_t *ctx, char *data_buf, uint16_t len );
 
int32_t ble4_generic_read ( ble4_t *ctx, char *data_buf, uint16_t max_len );
 
uint8_t ble4_response_ready( ble4_t *ctx );
 
void ble4_send_command ( ble4_t *ctx, char * command, uint8_t term_char );
 
void ble4_fact_rst_cmd ( ble4_t *ctx );
 
void ble4_store_cnfg_cmd ( ble4_t *ctx );
 
void ble4_get_local_addr_cmd ( ble4_t *ctx );
 
void ble4_set_start_mode_cmd ( ble4_t *ctx, uint8_t start_mode );
 
void ble4_get_start_mode_cmd ( ble4_t *ctx );
 
void ble4_enter_mode_cmd ( ble4_t *ctx, uint8_t mode );
 
void ble4_set_echo_cmd ( ble4_t *ctx, uint8_t echo_en );
 
void ble4_get_echo_cmd ( ble4_t *ctx );
 
void ble4_set_local_name_cmd ( ble4_t *ctx, char *local_name );
 
void ble4_get_local_name_cmd ( ble4_t *ctx );
 
void ble4_set_low_energy_role_cmd ( ble4_t *ctx, uint8_t le_role );
 
void ble4_get_low_energy_role_cmd ( ble4_t *ctx );
 
void ble4_get_list_peers_cmd ( ble4_t *ctx );
 
void ble4_get_server_cnfg_cmd ( ble4_t *ctx );
 
void ble4_set_default_cmd ( ble4_t *ctx );
 
void ble4_set_sec_mode_cmd ( ble4_t *ctx, uint8_t sec_mode );
 
void ble4_get_sec_mode_cmd ( ble4_t *ctx );
 
void ble4_pairing_en_cmd ( ble4_t *ctx, uint8_t pairing_mode );
 
void ble4_check_pairing_cmd ( ble4_t *ctx );
 
void ble4_connectability_en_cmd ( ble4_t *ctx, uint8_t conn_mode );
 
void ble4_check_connectability_cmd ( ble4_t *ctx );
 
void ble4_discoverability_en_cmd ( ble4_t *ctx, uint8_t discover_mode );
 
void ble4_check_discoverability_cmd ( ble4_t *ctx );
 
void ble4_get_info ( ble4_t *ctx );
 
uint8_t ble4_sps_central_pairing ( ble4_t *ctx, uint8_t *local_addr );
 
void ble4_sps_peripheral_pairing ( ble4_t *ctx );
 
void ble4_set_cts_pin ( ble4_t *ctx, uint8_t state );
 
void ble4_set_dsr_pin ( ble4_t *ctx, uint8_t state );
 
uint8_t ble4_get_dtr_pin ( ble4_t *ctx );
 
uint8_t ble4_get_rts_pin ( ble4_t *ctx );
 
#ifdef __cplusplus
}
#endif
#endif  // _BLE4_H_
 
 // End public_function group
 
// ------------------------------------------------------------------------- END