bluetooth.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 BLUETOOTH_H
#define BLUETOOTH_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 BLUETOOTH_MAP_MIKROBUS( cfg, mikrobus ) \
  cfg.tx_pin  = MIKROBUS( mikrobus, MIKROBUS_TX ); \
  cfg.rx_pin  = MIKROBUS( mikrobus, MIKROBUS_RX ); \
  cfg.rst     = MIKROBUS( mikrobus, MIKROBUS_RST )
#define BLUETOOTH_RETVAL  uint8_t
 
#define BLUETOOTH_INIT_OK      0x00
#define BLUETOOTH_INIT_ERROR   0xFF
#define BLUETOOTH_CMD           0x01
#define BLUETOOTH_AOK           0x02
#define BLUETOOTH_CONN          0x03
#define BLUETOOTH_DONE          0x04
#define BLUETOOTH_ERR           0x00
#define BLUETOOTH_OK            0x01
#define DRV_RX_BUFFER_SIZE 500
 // End group macro 
// --------------------------------------------------------------- PUBLIC TYPES
typedef struct
{
    // Output pins 
 
    digital_out_t rst;
 
    // Modules 
 
    uart_t uart;
 
    char uart_rx_buffer[ DRV_RX_BUFFER_SIZE ];
    char uart_tx_buffer[ DRV_RX_BUFFER_SIZE ];
 
} bluetooth_t;
 
typedef struct
{
    // Communication gpio pins 
 
    pin_name_t rx_pin;
    pin_name_t tx_pin;
    
    // Additional gpio pins 
 
    pin_name_t rst;
 
    // 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.    
 
} bluetooth_cfg_t;
 
typedef uint8_t bluetooth_error_t;
 
 // End types group
// ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
 
#ifdef __cplusplus
extern "C"{
#endif
 
void bluetooth_cfg_setup ( bluetooth_cfg_t *cfg );
 
BLUETOOTH_RETVAL bluetooth_init ( bluetooth_t *ctx, bluetooth_cfg_t *cfg );
 
void bluetooth_generic_write ( bluetooth_t *ctx, char *data_buf, uint16_t len );
 
int32_t bluetooth_generic_read ( bluetooth_t *ctx, char *data_buf, uint16_t max_len );
 
void bluetooth_write_command ( bluetooth_t *ctx, char *data_buf, uint16_t len );
 
void bluetooth_enable ( bluetooth_t *ctx );
 
void bluetooth_hw_reset ( bluetooth_t *ctx );
 
void bluetooth_enter_command_mode ( bluetooth_t *ctx );
 
void bluetooth_exit_command_mode ( bluetooth_t *ctx );
 
void bluetooth_toggle_echo ( bluetooth_t *ctx );
 
void bluetooth_set_device_name ( bluetooth_t *ctx, uint8_t *name );
 
void bluetooth_set_operating_mode ( bluetooth_t *ctx, uint8_t op_mode );
 
void bluetooth_enable_7_bit_data_mode ( bluetooth_t *ctx );
 
void bluetooth_disable_7_bit_data_mode ( bluetooth_t *ctx );
 
void bluetooth_set_authentication ( bluetooth_t *ctx, uint8_t auth_value );
 
void bluetooth_set_break ( bluetooth_t *ctx, uint8_t break_signal );
 
BLUETOOTH_RETVAL bluetooth_set_cod ( bluetooth_t *ctx, uint8_t *msw, uint8_t *lsw );
 
void bluetooth_set_factory_defaults ( bluetooth_t *ctx );
 
void bluetooth_set_discoverability ( bluetooth_t *ctx, uint8_t *d_hex_value );
 
void bluetooth_setConnectability ( bluetooth_t *ctx, uint8_t *c_hex_value );
 
BLUETOOTH_RETVAL bluetooth_set_uart_parity ( bluetooth_t *ctx, uint8_t character );
 
void bluetooth_set_extended_status_string ( bluetooth_t *ctx, uint8_t *es_string );
 
BLUETOOTH_RETVAL bluetooth_set_security_pin_code ( bluetooth_t *ctx, uint8_t *sp_code );
 
BLUETOOTH_RETVAL bluetooth_set_special_config ( bluetooth_t *ctx, uint16_t special_config );
 
void bluetooth_set_remote_address ( bluetooth_t *ctx, uint8_t *r_addr );
 
BLUETOOTH_RETVAL bluetooth_set_baud_rate ( bluetooth_t *ctx, uint32_t baud_rate );
 
void bluetooth_enable_bonding ( bluetooth_t *ctx );
 
void bluetooth_disable_bonding ( bluetooth_t *ctx );
 
void bluetooth_reboot ( bluetooth_t *ctx );
 
BLUETOOTH_RETVAL bluetooth_set_profile ( bluetooth_t *ctx, uint8_t profile );
 
void bluetooth_enable_role_switch ( bluetooth_t *ctx );
 
void bluetooth_disable_role_switch ( bluetooth_t *ctx );
 
void bluetooth_connect_to_remote_address ( bluetooth_t *ctx, uint8_t *r_addr );
 
void bluetooth_connect_to_remote_address_fast_mode ( bluetooth_t *ctx, uint8_t *r_addr );
 
void bluetooth_endspecial_config ( bluetooth_t *ctx );
 
void bluetooth_get_help ( bluetooth_t *ctx );
 
void bluetooth_get_basic_settings ( bluetooth_t *ctx );
 
void bluetooth_get_extended_settings ( bluetooth_t *ctx );
 
void bluetooth_get_device_address ( bluetooth_t *ctx );
 
void bluetooth_scans_device ( bluetooth_t *ctx );
 
void bluetooth_get_signal_status ( bluetooth_t *ctx );
 
void bluetooth_set_undiscoverable (  bluetooth_t *ctx );
 
BLUETOOTH_RETVAL bluetooth_set_quiet_mode ( bluetooth_t *ctx, uint8_t q_mode );
 
void bluetooth_get_firmware_version ( bluetooth_t *ctx );
 
#ifdef __cplusplus
}
#endif
#endif  // _BLUETOOTH_H_
 
 // End public_function group
 
// ------------------------------------------------------------------------- END