bluetooth  2.0.0.0
bluetooth.h
Go to the documentation of this file.
1 /*
2  * MikroSDK - MikroE Software Development Kit
3  * Copyright© 2020 MikroElektronika d.o.o.
4  *
5  * Permission is hereby granted, free of charge, to any person
6  * obtaining a copy of this software and associated documentation
7  * files (the "Software"), to deal in the Software without restriction,
8  * including without limitation the rights to use, copy, modify, merge,
9  * publish, distribute, sublicense, and/or sell copies of the Software,
10  * and to permit persons to whom the Software is furnished to do so,
11  * subject to the following conditions:
12  *
13  * The above copyright notice and this permission notice shall be
14  * included in all copies or substantial portions of the Software.
15  *
16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
17  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
19  * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
20  * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
21  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE
22  * OR OTHER DEALINGS IN THE SOFTWARE.
23  */
24 
33 // ----------------------------------------------------------------------------
34 
35 #ifndef BLUETOOTH_H
36 #define BLUETOOTH_H
37 
38 #include "mikrosdk_version.h"
39 
40 #ifdef __GNUC__
41 #if mikroSDK_GET_VERSION < 20800ul
42 #include "rcu_delays.h"
43 #else
44 #include "delays.h"
45 #endif
46 #endif
47 
48 #include "drv_digital_out.h"
49 #include "drv_digital_in.h"
50 #include "drv_uart.h"
51 
52 
53 // -------------------------------------------------------------- PUBLIC MACROS
63 #define BLUETOOTH_MAP_MIKROBUS( cfg, mikrobus ) \
64  cfg.tx_pin = MIKROBUS( mikrobus, MIKROBUS_TX ); \
65  cfg.rx_pin = MIKROBUS( mikrobus, MIKROBUS_RX ); \
66  cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST )
67 
73 #define BLUETOOTH_RETVAL uint8_t
74 
75 #define BLUETOOTH_INIT_OK 0x00
76 #define BLUETOOTH_INIT_ERROR 0xFF
77 
83 #define BLUETOOTH_CMD 0x01
84 #define BLUETOOTH_AOK 0x02
85 #define BLUETOOTH_CONN 0x03
86 #define BLUETOOTH_DONE 0x04
87 #define BLUETOOTH_ERR 0x00
88 #define BLUETOOTH_OK 0x01
89 
95 #define DRV_RX_BUFFER_SIZE 500
96  // End group macro
99 // --------------------------------------------------------------- PUBLIC TYPES
107 typedef struct
108 {
109  // Output pins
110 
111  digital_out_t rst;
112 
113  // Modules
114 
115  uart_t uart;
116 
117  char uart_rx_buffer[ DRV_RX_BUFFER_SIZE ];
118  char uart_tx_buffer[ DRV_RX_BUFFER_SIZE ];
119 
120 } bluetooth_t;
121 
125 typedef struct
126 {
127  // Communication gpio pins
128 
129  pin_name_t rx_pin;
130  pin_name_t tx_pin;
131 
132  // Additional gpio pins
133 
134  pin_name_t rst;
135 
136  // static variable
137 
138  uint32_t baud_rate; // Clock speed.
140  uart_data_bits_t data_bit; // Data bits.
141  uart_parity_t parity_bit; // Parity bit.
142  uart_stop_bits_t stop_bit; // Stop bits.
143 
145 
149 typedef uint8_t bluetooth_error_t;
150  // End types group
152 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
153 
159 #ifdef __cplusplus
160 extern "C"{
161 #endif
162 
172 
181 
188 void bluetooth_generic_write ( bluetooth_t *ctx, char *data_buf, uint16_t len );
189 
197 int32_t bluetooth_generic_read ( bluetooth_t *ctx, char *data_buf, uint16_t max_len );
198 
205 void bluetooth_write_command ( bluetooth_t *ctx, char *data_buf, uint16_t len );
206 
216 
227 
237 
247 
257 
267 void bluetooth_set_device_name ( bluetooth_t *ctx, uint8_t *name );
268 
293 void bluetooth_set_operating_mode ( bluetooth_t *ctx, uint8_t op_mode );
294 
304 
314 
331 void bluetooth_set_authentication ( bluetooth_t *ctx, uint8_t auth_value );
332 
351 void bluetooth_set_break ( bluetooth_t *ctx, uint8_t break_signal );
352 
365 BLUETOOTH_RETVAL bluetooth_set_cod ( bluetooth_t *ctx, uint8_t *msw, uint8_t *lsw );
366 
376 
386 void bluetooth_set_discoverability ( bluetooth_t *ctx, uint8_t *d_hex_value );
387 
397 void bluetooth_setConnectability ( bluetooth_t *ctx, uint8_t *c_hex_value );
398 
417 
429 void bluetooth_set_extended_status_string ( bluetooth_t *ctx, uint8_t *es_string );
430 
445 
468 
480 void bluetooth_set_remote_address ( bluetooth_t *ctx, uint8_t *r_addr );
481 
504 
514 
524 
534 
559 
569 
579 
589 void bluetooth_connect_to_remote_address ( bluetooth_t *ctx, uint8_t *r_addr );
590 
601 
611 
621 
631 
641 
651 
661 
671 
681 
700 
710 
711 #ifdef __cplusplus
712 }
713 #endif
714 #endif // _BLUETOOTH_H_
715  // End public_function group
718 
719 // ------------------------------------------------------------------------- END
DRV_RX_BUFFER_SIZE
#define DRV_RX_BUFFER_SIZE
Definition: bluetooth.h:95
bluetooth_enable
void bluetooth_enable(bluetooth_t *ctx)
Enable device function.
bluetooth_cfg_t
Click configuration structure definition.
Definition: bluetooth.h:126
bluetooth_setConnectability
void bluetooth_setConnectability(bluetooth_t *ctx, uint8_t *c_hex_value)
Set enable page scanning function.
bluetooth_set_device_name
void bluetooth_set_device_name(bluetooth_t *ctx, uint8_t *name)
Set the device name function.
bluetooth_get_firmware_version
void bluetooth_get_firmware_version(bluetooth_t *ctx)
Get firmware version function.
bluetooth_set_quiet_mode
BLUETOOTH_RETVAL bluetooth_set_quiet_mode(bluetooth_t *ctx, uint8_t q_mode)
Set quiet mode function.
bluetooth_enable_role_switch
void bluetooth_enable_role_switch(bluetooth_t *ctx)
Enables the role switch function.
bluetooth_t::rst
digital_out_t rst
Definition: bluetooth.h:111
bluetooth_get_signal_status
void bluetooth_get_signal_status(bluetooth_t *ctx)
Displays the remote side modem signal status function.
bluetooth_get_device_address
void bluetooth_get_device_address(bluetooth_t *ctx)
Get displays the device�s eBluetooth address function.
bluetooth_toggle_echo
void bluetooth_toggle_echo(bluetooth_t *ctx)
Toggles echo function.
bluetooth_get_extended_settings
void bluetooth_get_extended_settings(bluetooth_t *ctx)
Get displays the device�s extended settings function.
bluetooth_cfg_t::data_bit
uart_data_bits_t data_bit
Definition: bluetooth.h:140
bluetooth_error_t
uint8_t bluetooth_error_t
Error type.
Definition: bluetooth.h:149
bluetooth_set_baud_rate
BLUETOOTH_RETVAL bluetooth_set_baud_rate(bluetooth_t *ctx, uint32_t baud_rate)
Set the baud rate function.
bluetooth_init
BLUETOOTH_RETVAL bluetooth_init(bluetooth_t *ctx, bluetooth_cfg_t *cfg)
Initialization function.
bluetooth_cfg_t::rst
pin_name_t rst
Definition: bluetooth.h:134
bluetooth_cfg_t::rx_pin
pin_name_t rx_pin
Definition: bluetooth.h:129
bluetooth_set_extended_status_string
void bluetooth_set_extended_status_string(bluetooth_t *ctx, uint8_t *es_string)
Set extended status string function.
bluetooth_cfg_t::uart_blocking
bool uart_blocking
Definition: bluetooth.h:139
bluetooth_cfg_t::parity_bit
uart_parity_t parity_bit
Definition: bluetooth.h:141
bluetooth_generic_read
int32_t bluetooth_generic_read(bluetooth_t *ctx, char *data_buf, uint16_t max_len)
Generic read function.
bluetooth_exit_command_mode
void bluetooth_exit_command_mode(bluetooth_t *ctx)
Exit the command mode function.
bluetooth_disable_bonding
void bluetooth_disable_bonding(bluetooth_t *ctx)
Set bonding disable function.
bluetooth_t
Click ctx object definition.
Definition: bluetooth.h:108
bluetooth_scans_device
void bluetooth_scans_device(bluetooth_t *ctx)
Scans for Bluetooth devices in pairing mode function.
bluetooth_set_uart_parity
BLUETOOTH_RETVAL bluetooth_set_uart_parity(bluetooth_t *ctx, uint8_t character)
Set UART parity function.
bluetooth_set_factory_defaults
void bluetooth_set_factory_defaults(bluetooth_t *ctx)
Set factory defaults settings function.
bluetooth_set_authentication
void bluetooth_set_authentication(bluetooth_t *ctx, uint8_t auth_value)
Set the authentication function.
bluetooth_set_discoverability
void bluetooth_set_discoverability(bluetooth_t *ctx, uint8_t *d_hex_value)
Set enable an inquiry scan function.
bluetooth_enable_bonding
void bluetooth_enable_bonding(bluetooth_t *ctx)
Set bonding enable function.
bluetooth_get_help
void bluetooth_get_help(bluetooth_t *ctx)
Get displays a list of help command function.
bluetooth_get_basic_settings
void bluetooth_get_basic_settings(bluetooth_t *ctx)
Get displays basic settings function.
bluetooth_reboot
void bluetooth_reboot(bluetooth_t *ctx)
Reboot the module function.
bluetooth_disable_role_switch
void bluetooth_disable_role_switch(bluetooth_t *ctx)
Disables the role switch function.
BLUETOOTH_RETVAL
#define BLUETOOTH_RETVAL
Definition: bluetooth.h:73
bluetooth_enter_command_mode
void bluetooth_enter_command_mode(bluetooth_t *ctx)
Enter the command mode function.
bluetooth_connect_to_remote_address_fast_mode
void bluetooth_connect_to_remote_address_fast_mode(bluetooth_t *ctx, uint8_t *r_addr)
Connect the device to a remote address fast mode function.
bluetooth_write_command
void bluetooth_write_command(bluetooth_t *ctx, char *data_buf, uint16_t len)
Write command function.
bluetooth_cfg_t::tx_pin
pin_name_t tx_pin
Definition: bluetooth.h:130
bluetooth_set_remote_address
void bluetooth_set_remote_address(bluetooth_t *ctx, uint8_t *r_addr)
Set the remote Bluetooth address function.
bluetooth_set_special_config
BLUETOOTH_RETVAL bluetooth_set_special_config(bluetooth_t *ctx, uint16_t special_config)
Set special configuration settings function.
bluetooth_cfg_t::stop_bit
uart_stop_bits_t stop_bit
Definition: bluetooth.h:142
bluetooth_set_security_pin_code
BLUETOOTH_RETVAL bluetooth_set_security_pin_code(bluetooth_t *ctx, uint8_t *sp_code)
Set security pin code function.
bluetooth_cfg_setup
void bluetooth_cfg_setup(bluetooth_cfg_t *cfg)
Config Object Initialization function.
bluetooth_connect_to_remote_address
void bluetooth_connect_to_remote_address(bluetooth_t *ctx, uint8_t *r_addr)
Connect the device to a remote address function.
bluetooth_endspecial_config
void bluetooth_endspecial_config(bluetooth_t *ctx)
Ends configuration and puts the device into fast data mode function.
bluetooth_set_operating_mode
void bluetooth_set_operating_mode(bluetooth_t *ctx, uint8_t op_mode)
Set the operating mode function.
bluetooth_disable_7_bit_data_mode
void bluetooth_disable_7_bit_data_mode(bluetooth_t *ctx)
Disable 7-Bit data mode function.
bluetooth_generic_write
void bluetooth_generic_write(bluetooth_t *ctx, char *data_buf, uint16_t len)
Generic write function.
bluetooth_enable_7_bit_data_mode
void bluetooth_enable_7_bit_data_mode(bluetooth_t *ctx)
Enable 7-Bit data mode function.
bluetooth_set_cod
BLUETOOTH_RETVAL bluetooth_set_cod(bluetooth_t *ctx, uint8_t *msw, uint8_t *lsw)
Sets the class of device (COD) function.
bluetooth_hw_reset
void bluetooth_hw_reset(bluetooth_t *ctx)
Hardwere reset function.
bluetooth_cfg_t::baud_rate
uint32_t baud_rate
Definition: bluetooth.h:138
bluetooth_set_break
void bluetooth_set_break(bluetooth_t *ctx, uint8_t break_signal)
Set the break function.
bluetooth_t::uart
uart_t uart
Definition: bluetooth.h:115
bluetooth_set_undiscoverable
void bluetooth_set_undiscoverable(bluetooth_t *ctx)
Set undiscoverable mode function.
bluetooth_set_profile
BLUETOOTH_RETVAL bluetooth_set_profile(bluetooth_t *ctx, uint8_t profile)
Set the profile function.