bluetooth2 2.0.0.0
bluetooth2.h
Go to the documentation of this file.
1/****************************************************************************
2** Copyright (C) 2020 MikroElektronika d.o.o.
3** Contact: https://www.mikroe.com/contact
4**
5** Permission is hereby granted, free of charge, to any person obtaining a copy
6** of this software and associated documentation files (the "Software"), to deal
7** in the Software without restriction, including without limitation the rights
8** to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9** copies of the Software, and to permit persons to whom the Software is
10** furnished to do so, subject to the following conditions:
11** The above copyright notice and this permission notice shall be
12** included in all copies or substantial portions of the Software.
13**
14** THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
15** EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
16** OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
17** IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
18** DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
19** OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
20** USE OR OTHER DEALINGS IN THE SOFTWARE.
21****************************************************************************/
22
28#ifndef BLUETOOTH2_H
29#define BLUETOOTH2_H
30
31#ifdef __cplusplus
32extern "C"{
33#endif
34
35#include "drv_digital_out.h"
36#include "drv_digital_in.h"
37#include "drv_analog_in.h"
38#include "drv_uart.h"
39
60#define BLUETOOTH2_ESCAPE_SEQUENCE "+++"
61#define BLUETOOTH2_FACTORY_RESET "SET RESET"
62#define BLUETOOTH2_LIST_PAIRINGS "SET BT PAIR"
63#define BLUETOOTH2_REMOVE_PAIRINGS "SET BT PAIR *"
64#define BLUETOOTH2_SW_RESET "RESET"
65#define BLUETOOTH2_SET_DEVICE_NAME "SET BT NAME "
66#define BLUETOOTH2_FIND_OTHER_DEVICES "INQUIRY "
67#define BLUETOOTH2_PAIR "PAIR "
68#define BLUETOOTH2_SET_CONTROL_CONFIG "SET CONTROL CONFIG "
69#define BLUETOOTH2_ENABLE_OK_WITH_DEFAULT_VALUES "0040 1100"
70#define BLUETOOTH2_DEV_ADDRESS_FORMAT "xx:xx:xx:xx:xx:xx"
71
77#define DRV_BUFFER_SIZE 200
78 // bluetooth2_set
80
95#define BLUETOOTH2_MAP_MIKROBUS( cfg, mikrobus ) \
96 cfg.tx_pin = MIKROBUS( mikrobus, MIKROBUS_TX ); \
97 cfg.rx_pin = MIKROBUS( mikrobus, MIKROBUS_RX ); \
98 cfg.cts = MIKROBUS( mikrobus, MIKROBUS_CS ); \
99 cfg.aio = MIKROBUS( mikrobus, MIKROBUS_AN ); \
100 cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
101 cfg.io7 = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
102 cfg.rts = MIKROBUS( mikrobus, MIKROBUS_INT )
103 // bluetooth2_map // bluetooth2
110typedef struct bluetooth2_s
111{
112 digital_out_t rst;
113 digital_out_t io7;
114 digital_out_t cts;
115 digital_in_t rts;
117 uart_t uart;
118 analog_in_t adc;
124
129typedef struct
130{
131 pin_name_t rx_pin;
132 pin_name_t tx_pin;
133 pin_name_t cts;
134 pin_name_t aio;
135 pin_name_t rst;
136 pin_name_t io7;
137 pin_name_t rts;
139 analog_in_resolution_t resolution;
140 float vref;
142 uint32_t baud_rate;
144 uart_data_bits_t data_bit;
145 uart_parity_t parity_bit;
146 uart_stop_bits_t stop_bit;
149
154typedef enum
155{
158
160
177
193
205
219err_t bluetooth2_generic_write ( bluetooth2_t *ctx, char *data_buf, uint16_t len );
220
234err_t bluetooth2_generic_read ( bluetooth2_t *ctx, char *data_buf, uint16_t max_len );
235
248err_t bluetooth2_read_an_pin_value ( bluetooth2_t *ctx, uint16_t *data_out );
249
264err_t bluetooth2_read_an_pin_voltage ( bluetooth2_t *ctx, float *data_out );
265
275void bluetooth2_set_cts_pin ( bluetooth2_t *ctx, uint8_t state );
276
286void bluetooth2_set_rst_pin ( bluetooth2_t *ctx, uint8_t state );
287
297void bluetooth2_set_io7_pin ( bluetooth2_t *ctx, uint8_t state );
298
308
321err_t bluetooth2_write_command ( bluetooth2_t *ctx, char *data_buf );
322
332
346
359
372
385
398
411err_t bluetooth2_set_device_name ( bluetooth2_t *ctx, char *dev_name );
412
427err_t bluetooth2_find_other_devices ( bluetooth2_t *ctx, uint8_t timeout );
428
442err_t bluetooth2_pair ( bluetooth2_t *ctx, uint8_t *dev_addr );
443
457
458#ifdef __cplusplus
459}
460#endif
461#endif // BLUETOOTH2_H
462 // bluetooth2
464
465// ------------------------------------------------------------------------ END
bluetooth2_return_value_t
Bluetooth 2 Click return value data.
Definition: bluetooth2.h:155
@ BLUETOOTH2_ERROR
Definition: bluetooth2.h:157
@ BLUETOOTH2_OK
Definition: bluetooth2.h:156
struct bluetooth2_s bluetooth2_t
Bluetooth 2 Click context object.
#define DRV_BUFFER_SIZE
Bluetooth 2 driver buffer size.
Definition: bluetooth2.h:77
err_t bluetooth2_find_other_devices(bluetooth2_t *ctx, uint8_t timeout)
Bluetooth 2 find other devices function.
err_t bluetooth2_set_device_name(bluetooth2_t *ctx, char *dev_name)
Bluetooth 2 set local device name function.
void bluetooth2_default_cfg(bluetooth2_t *ctx)
Bluetooth 2 default configuration function.
err_t bluetooth2_remove_pairings(bluetooth2_t *ctx)
Bluetooth 2 remove pairings function.
err_t bluetooth2_generic_read(bluetooth2_t *ctx, char *data_buf, uint16_t max_len)
Bluetooth 2 data reading function.
err_t bluetooth2_sw_reset(bluetooth2_t *ctx)
Bluetooth 2 sw reset function.
err_t bluetooth2_factory_reset(bluetooth2_t *ctx)
Bluetooth 2 factory reset function.
err_t bluetooth2_init(bluetooth2_t *ctx, bluetooth2_cfg_t *cfg)
Bluetooth 2 initialization function.
void bluetooth2_set_io7_pin(bluetooth2_t *ctx, uint8_t state)
Bluetooth 2 set PIO7 pin function.
void bluetooth2_hw_reset(bluetooth2_t *ctx)
Bluetooth 2 hw reset function.
void bluetooth2_set_rst_pin(bluetooth2_t *ctx, uint8_t state)
Bluetooth 2 set reset pin function.
void bluetooth2_set_cts_pin(bluetooth2_t *ctx, uint8_t state)
Bluetooth 2 set clear to send pin function.
err_t bluetooth2_generic_write(bluetooth2_t *ctx, char *data_buf, uint16_t len)
Bluetooth 2 data writing function.
err_t bluetooth2_toggle_mode(bluetooth2_t *ctx)
Bluetooth 2 toggle mode function.
err_t bluetooth2_pair(bluetooth2_t *ctx, uint8_t *dev_addr)
Bluetooth 2 set local device name function.
err_t bluetooth2_write_command(bluetooth2_t *ctx, char *data_buf)
Bluetooth 2 write command function.
err_t bluetooth2_list_pairings(bluetooth2_t *ctx)
Bluetooth 2 list current pairings function.
err_t bluetooth2_read_an_pin_value(bluetooth2_t *ctx, uint16_t *data_out)
Bluetooth 2 read AN pin value function.
void bluetooth2_cfg_setup(bluetooth2_cfg_t *cfg)
Bluetooth 2 configuration object setup function.
uint8_t bluetooth2_get_rts_pin(bluetooth2_t *ctx)
Bluetooth 2 get request to send pin function.
err_t bluetooth2_read_an_pin_voltage(bluetooth2_t *ctx, float *data_out)
Bluetooth 2 read AN pin voltage level function.
err_t bluetooth2_enable_ok_response(bluetooth2_t *ctx)
Bluetooth 2 enable OK response function.
Bluetooth 2 Click configuration object.
Definition: bluetooth2.h:130
pin_name_t rts
Definition: bluetooth2.h:137
uint32_t baud_rate
Definition: bluetooth2.h:142
pin_name_t aio
Definition: bluetooth2.h:134
analog_in_resolution_t resolution
Definition: bluetooth2.h:139
float vref
Definition: bluetooth2.h:140
pin_name_t cts
Definition: bluetooth2.h:133
pin_name_t io7
Definition: bluetooth2.h:136
bool uart_blocking
Definition: bluetooth2.h:143
uart_data_bits_t data_bit
Definition: bluetooth2.h:144
pin_name_t tx_pin
Definition: bluetooth2.h:132
pin_name_t rx_pin
Definition: bluetooth2.h:131
uart_stop_bits_t stop_bit
Definition: bluetooth2.h:146
uart_parity_t parity_bit
Definition: bluetooth2.h:145
pin_name_t rst
Definition: bluetooth2.h:135
Bluetooth 2 Click context object.
Definition: bluetooth2.h:111
char uart_tx_buffer[DRV_BUFFER_SIZE]
Definition: bluetooth2.h:121
uart_t uart
Definition: bluetooth2.h:117
digital_in_t rts
Definition: bluetooth2.h:115
digital_out_t rst
Definition: bluetooth2.h:112
digital_out_t cts
Definition: bluetooth2.h:114
char uart_rx_buffer[DRV_BUFFER_SIZE]
Definition: bluetooth2.h:120
digital_out_t io7
Definition: bluetooth2.h:113
analog_in_t adc
Definition: bluetooth2.h:118