ble8  2.0.0.0
ble8.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 BLE8_H
36 #define BLE8_H
37 
42 #ifdef PREINIT_SUPPORTED
43 #include "preinit.h"
44 #endif
45 
46 #ifdef MikroCCoreVersion
47  #if MikroCCoreVersion >= 1
48  #include "delays.h"
49  #endif
50 #endif
51 
52 #include "drv_digital_out.h"
53 #include "drv_digital_in.h"
54 #include "drv_uart.h"
55 
56 // -------------------------------------------------------------- PUBLIC MACROS
66 #define BLE8_MAP_MIKROBUS( cfg, mikrobus ) \
67  cfg.tx_pin = MIKROBUS( mikrobus, MIKROBUS_TX ); \
68  cfg.rx_pin = MIKROBUS( mikrobus, MIKROBUS_RX ); \
69  cfg.dtr = MIKROBUS( mikrobus, MIKROBUS_AN ); \
70  cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
71  cfg.cts = MIKROBUS( mikrobus, MIKROBUS_CS ); \
72  cfg.dsr = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
73  cfg.rts = MIKROBUS( mikrobus, MIKROBUS_INT )
74 
80 #define BLE8_RETVAL uint8_t
81 
82 #define BLE8_OK 0x00
83 #define BLE8_INIT_ERROR 0xFF
84 
90 #define BLE8_END_BUFF 0
91 
97 #define BLE8_RSP_READY 1
98 #define BLE8_RSP_NOT_READY 0
99 
105 #define BLE8_ECHO_ON 1
106 #define BLE8_ECHO_OFF 0
107 
113 #define BLE8_COMMAND_MODE 0
114 #define BLE8_DATA_MODE 1
115 #define BLE8_EXT_DATA_MODE 2
116 #define BLE8_PPP_MODE 3
117 
123 #define BLE8_DISABLED_ROLE 0
124 #define BLE8_CENTRAL_ROLE 1
125 #define BLE8_PERIPHERAL_ROLE 2
126 #define BLE8_SIMULTANEOUS_ROLE 3
127 
133 #define BLE8_SEC_DISABLED 1
134 #define BLE8_SEC_JUST_WORKS 2
135 #define BLE8_SEC_DISPLAY_ONLY 3
136 #define BLE8_SEC_DISPLAY_YES_NO 4
137 #define BLE8_SEC_KEYBOARD_ONLY 5
138 #define BLE8_SEC_OUT_OF_BAND 6
139 
145 #define BLE8_GAP_NON_PAIRING_MODE 1
146 #define BLE8_GAP_PAIRING_MODE 2
147 
153 #define BLE8_GAP_NON_CONNECTABLE_MODE 1
154 #define BLE8_GAP_CONNECTABLE_MODE 2
155 
161 #define BLE8_GAP_NON_DISCOVERABLE_MODE 1
162 #define BLE8_GAP_LIMITED_DISCOVERABLE_MODE 2
163 #define BLE8_GAP_GENERAL_DISCOVERABLE_MODE 3
164 
170 #define DRV_RX_BUFFER_SIZE 100
171 #define DRV_TX_BUFFER_SIZE 100
172  // End group macro
175 // --------------------------------------------------------------- PUBLIC TYPES
184 typedef struct
185 {
186  // Output pins
187 
188  digital_out_t rst;
189  digital_out_t cts;
190  digital_out_t dsr;
191 
192  // Input pins
193 
194  digital_in_t dtr;
195  digital_in_t rts;
196 
197  // Modules
198 
199  uart_t uart;
200 
201  char uart_rx_buffer[ DRV_RX_BUFFER_SIZE ];
202  char uart_tx_buffer[ DRV_TX_BUFFER_SIZE ];
203 
204  uint8_t rsp_rdy;
206 
207 } ble8_t;
208 
212 typedef struct
213 {
214  // Communication gpio pins
215 
216  pin_name_t rx_pin;
217  pin_name_t tx_pin;
218 
219  // Additional gpio pins
220 
221  pin_name_t dtr;
222  pin_name_t rst;
223  pin_name_t cts;
224  pin_name_t dsr;
225  pin_name_t rts;
226 
227  // static variable
228 
229  uint32_t baud_rate; // Clock speed.
231  uart_data_bits_t data_bit; // Data bits.
232  uart_parity_t parity_bit; // Parity bit.
233  uart_stop_bits_t stop_bit; // Stop bits.
234 
235 } ble8_cfg_t;
236  // End types group
238 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
239 
245 #ifdef __cplusplus
246 extern "C"{
247 #endif
248 
258 
268 
276 void ble8_reset ( ble8_t *ctx );
277 
284 void ble8_generic_write ( ble8_t *ctx, char *data_buf, uint16_t len );
285 
293 int32_t ble8_generic_read ( ble8_t *ctx, char *data_buf, uint16_t max_len );
294 
304 uint8_t ble8_response_ready( ble8_t *ctx );
305 
318 void ble8_send_command ( ble8_t *ctx, char * command, uint8_t term_char );
319 
329 void ble8_fact_rst_cmd ( ble8_t *ctx );
330 
341 
348 
360 void ble8_set_start_mode_cmd ( ble8_t *ctx, uint8_t start_mode );
361 
370 
384 void ble8_enter_mode_cmd ( ble8_t *ctx, uint8_t mode );
385 
395 void ble8_set_echo_cmd ( ble8_t *ctx, uint8_t echo_en );
396 
404 void ble8_get_echo_cmd ( ble8_t *ctx );
405 
418 void ble8_set_local_name_cmd ( ble8_t *ctx, char *local_name );
419 
428 
445 void ble8_set_low_energy_role_cmd ( ble8_t *ctx, uint8_t le_role );
446 
455 
467 
483 
495 
518 void ble8_set_sec_mode_cmd ( ble8_t *ctx, uint8_t sec_mode );
519 
528 
537 void ble8_pairing_en_cmd ( ble8_t *ctx, uint8_t pairing_mode );
538 
547 
556 void ble8_connectability_en_cmd ( ble8_t *ctx, uint8_t conn_mode );
557 
566 
582 void ble8_discoverability_en_cmd ( ble8_t *ctx, uint8_t discover_mode );
583 
592 
600 void ble8_get_info ( ble8_t *ctx );
601 
614 uint8_t ble8_sps_central_pairing ( ble8_t *ctx, uint8_t *local_addr );
615 
627 
640 void ble8_set_cts_pin ( ble8_t *ctx, uint8_t state );
641 
653 void ble8_set_dsr_pin ( ble8_t *ctx, uint8_t state );
654 
667 uint8_t ble8_get_dtr_pin ( ble8_t *ctx );
668 
680 uint8_t ble8_get_rts_pin ( ble8_t *ctx );
681 
682 
683 #ifdef __cplusplus
684 }
685 #endif
686 #endif // _BLE8_H_
687  // End public_function group
690 
691 // ------------------------------------------------------------------------- END
DRV_RX_BUFFER_SIZE
#define DRV_RX_BUFFER_SIZE
Definition: ble8.h:170
ble8_set_low_energy_role_cmd
void ble8_set_low_energy_role_cmd(ble8_t *ctx, uint8_t le_role)
Bluetooth Low Energy Role Setting command.
ble8_get_sec_mode_cmd
void ble8_get_sec_mode_cmd(ble8_t *ctx)
Get Security Mode command.
ble8_check_connectability_cmd
void ble8_check_connectability_cmd(ble8_t *ctx)
Get Connectability Mode command.
ble8_check_pairing_cmd
void ble8_check_pairing_cmd(ble8_t *ctx)
Get Pairing Mode command.
ble8_cfg_t::cts
pin_name_t cts
Definition: ble8.h:223
ble8_discoverability_en_cmd
void ble8_discoverability_en_cmd(ble8_t *ctx, uint8_t discover_mode)
Discoverability Mode Setting command.
ble8_set_echo_cmd
void ble8_set_echo_cmd(ble8_t *ctx, uint8_t echo_en)
Echo On/Off command.
ble8_t::termination_char
uint8_t termination_char
Definition: ble8.h:205
ble8_get_info
void ble8_get_info(ble8_t *ctx)
Get Info command.
ble8_cfg_t::tx_pin
pin_name_t tx_pin
Definition: ble8.h:217
ble8_init
BLE8_RETVAL ble8_init(ble8_t *ctx, ble8_cfg_t *cfg)
Initialization function.
ble8_store_cnfg_cmd
void ble8_store_cnfg_cmd(ble8_t *ctx)
Store Current Configuration command.
ble8_cfg_t::dsr
pin_name_t dsr
Definition: ble8.h:224
ble8_cfg_t::rx_pin
pin_name_t rx_pin
Definition: ble8.h:216
ble8_get_local_addr_cmd
void ble8_get_local_addr_cmd(ble8_t *ctx)
Get Local Address command.
ble8_fact_rst_cmd
void ble8_fact_rst_cmd(ble8_t *ctx)
Factory Reset command.
ble8_cfg_t::parity_bit
uart_parity_t parity_bit
Definition: ble8.h:232
ble8_set_sec_mode_cmd
void ble8_set_sec_mode_cmd(ble8_t *ctx, uint8_t sec_mode)
Security Mode Setting command.
ble8_t::rsp_rdy
uint8_t rsp_rdy
Definition: ble8.h:204
ble8_generic_write
void ble8_generic_write(ble8_t *ctx, char *data_buf, uint16_t len)
Generic write function.
ble8_set_cts_pin
void ble8_set_cts_pin(ble8_t *ctx, uint8_t state)
CTS Pin Setting function.
ble8_cfg_t
Click configuration structure definition.
Definition: ble8.h:213
BLE8_RETVAL
#define BLE8_RETVAL
Definition: ble8.h:80
ble8_cfg_t::dtr
pin_name_t dtr
Definition: ble8.h:221
ble8_t::cts
digital_out_t cts
Definition: ble8.h:189
ble8_cfg_t::rst
pin_name_t rst
Definition: ble8.h:222
ble8_enter_mode_cmd
void ble8_enter_mode_cmd(ble8_t *ctx, uint8_t mode)
Enter Data Mode command.
ble8_cfg_t::baud_rate
uint32_t baud_rate
Definition: ble8.h:229
ble8_t
Click ctx object definition.
Definition: ble8.h:185
ble8_cfg_t::data_bit
uart_data_bits_t data_bit
Definition: ble8.h:231
ble8_cfg_t::stop_bit
uart_stop_bits_t stop_bit
Definition: ble8.h:233
ble8_set_start_mode_cmd
void ble8_set_start_mode_cmd(ble8_t *ctx, uint8_t start_mode)
Module Start Mode Setting command.
ble8_get_low_energy_role_cmd
void ble8_get_low_energy_role_cmd(ble8_t *ctx)
Get Bluetooth Low Energy Role command.
ble8_set_default_cmd
void ble8_set_default_cmd(ble8_t *ctx)
Default Configuration command.
ble8_pairing_en_cmd
void ble8_pairing_en_cmd(ble8_t *ctx, uint8_t pairing_mode)
Pairing Mode Setting command.
ble8_sps_peripheral_pairing
void ble8_sps_peripheral_pairing(ble8_t *ctx)
SPS Pairing As Peripheral Device command.
ble8_get_server_cnfg_cmd
void ble8_get_server_cnfg_cmd(ble8_t *ctx)
Get Server Configuration command.
ble8_get_dtr_pin
uint8_t ble8_get_dtr_pin(ble8_t *ctx)
Check DTR Pin function.
ble8_get_echo_cmd
void ble8_get_echo_cmd(ble8_t *ctx)
Get Echo Setting command.
ble8_t::dsr
digital_out_t dsr
Definition: ble8.h:190
ble8_response_ready
uint8_t ble8_response_ready(ble8_t *ctx)
Response Ready function.
ble8_t::uart
uart_t uart
Definition: ble8.h:199
ble8_connectability_en_cmd
void ble8_connectability_en_cmd(ble8_t *ctx, uint8_t conn_mode)
Connectability Mode Setting command.
ble8_t::dtr
digital_in_t dtr
Definition: ble8.h:194
ble8_t::rst
digital_out_t rst
Definition: ble8.h:188
ble8_set_local_name_cmd
void ble8_set_local_name_cmd(ble8_t *ctx, char *local_name)
Local Name Setting command.
ble8_get_local_name_cmd
void ble8_get_local_name_cmd(ble8_t *ctx)
Get Local Name command.
ble8_cfg_t::rts
pin_name_t rts
Definition: ble8.h:225
DRV_TX_BUFFER_SIZE
#define DRV_TX_BUFFER_SIZE
Definition: ble8.h:171
ble8_cfg_setup
void ble8_cfg_setup(ble8_cfg_t *cfg)
Config Object Initialization function.
ble8_sps_central_pairing
uint8_t ble8_sps_central_pairing(ble8_t *ctx, uint8_t *local_addr)
SPS Pairing As Central Device command.
ble8_get_list_peers_cmd
void ble8_get_list_peers_cmd(ble8_t *ctx)
Get Peer List command.
ble8_generic_read
int32_t ble8_generic_read(ble8_t *ctx, char *data_buf, uint16_t max_len)
Generic read function.
ble8_set_dsr_pin
void ble8_set_dsr_pin(ble8_t *ctx, uint8_t state)
Set DSR Pin function.
ble8_cfg_t::uart_blocking
bool uart_blocking
Definition: ble8.h:230
ble8_get_start_mode_cmd
void ble8_get_start_mode_cmd(ble8_t *ctx)
Get Module Start Mode command.
ble8_t::rts
digital_in_t rts
Definition: ble8.h:195
ble8_reset
void ble8_reset(ble8_t *ctx)
Reset function.
ble8_check_discoverability_cmd
void ble8_check_discoverability_cmd(ble8_t *ctx)
Get Discoverability Mode command.
ble8_get_rts_pin
uint8_t ble8_get_rts_pin(ble8_t *ctx)
Check RTS Pin function.
ble8_send_command
void ble8_send_command(ble8_t *ctx, char *command, uint8_t term_char)
Transmit function.