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 
38 #include "drv_digital_out.h"
39 #include "drv_digital_in.h"
40 #include "drv_uart.h"
41 
42 // -------------------------------------------------------------- PUBLIC MACROS
52 #define BLE8_MAP_MIKROBUS( cfg, mikrobus ) \
53  cfg.tx_pin = MIKROBUS( mikrobus, MIKROBUS_TX ); \
54  cfg.rx_pin = MIKROBUS( mikrobus, MIKROBUS_RX ); \
55  cfg.dtr = MIKROBUS( mikrobus, MIKROBUS_AN ); \
56  cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
57  cfg.cts = MIKROBUS( mikrobus, MIKROBUS_CS ); \
58  cfg.dsr = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
59  cfg.rts = MIKROBUS( mikrobus, MIKROBUS_INT )
60 
66 #define BLE8_RETVAL uint8_t
67 
68 #define BLE8_OK 0x00
69 #define BLE8_INIT_ERROR 0xFF
70 
76 #define BLE8_END_BUFF 0
77 
83 #define BLE8_RSP_READY 1
84 #define BLE8_RSP_NOT_READY 0
85 
91 #define BLE8_ECHO_ON 1
92 #define BLE8_ECHO_OFF 0
93 
99 #define BLE8_COMMAND_MODE 0
100 #define BLE8_DATA_MODE 1
101 #define BLE8_EXT_DATA_MODE 2
102 #define BLE8_PPP_MODE 3
103 
109 #define BLE8_DISABLED_ROLE 0
110 #define BLE8_CENTRAL_ROLE 1
111 #define BLE8_PERIPHERAL_ROLE 2
112 #define BLE8_SIMULTANEOUS_ROLE 3
113 
119 #define BLE8_SEC_DISABLED 1
120 #define BLE8_SEC_JUST_WORKS 2
121 #define BLE8_SEC_DISPLAY_ONLY 3
122 #define BLE8_SEC_DISPLAY_YES_NO 4
123 #define BLE8_SEC_KEYBOARD_ONLY 5
124 #define BLE8_SEC_OUT_OF_BAND 6
125 
131 #define BLE8_GAP_NON_PAIRING_MODE 1
132 #define BLE8_GAP_PAIRING_MODE 2
133 
139 #define BLE8_GAP_NON_CONNECTABLE_MODE 1
140 #define BLE8_GAP_CONNECTABLE_MODE 2
141 
147 #define BLE8_GAP_NON_DISCOVERABLE_MODE 1
148 #define BLE8_GAP_LIMITED_DISCOVERABLE_MODE 2
149 #define BLE8_GAP_GENERAL_DISCOVERABLE_MODE 3
150 
156 #define DRV_RX_BUFFER_SIZE 100
157 #define DRV_TX_BUFFER_SIZE 100
158  // End group macro
161 // --------------------------------------------------------------- PUBLIC TYPES
170 typedef struct
171 {
172  // Output pins
173 
174  digital_out_t rst;
175  digital_out_t cts;
176  digital_out_t dsr;
177 
178  // Input pins
179 
180  digital_in_t dtr;
181  digital_in_t rts;
182 
183  // Modules
184 
185  uart_t uart;
186 
187  char uart_rx_buffer[ DRV_RX_BUFFER_SIZE ];
188  char uart_tx_buffer[ DRV_TX_BUFFER_SIZE ];
189 
190  uint8_t rsp_rdy;
192 
193 } ble8_t;
194 
198 typedef struct
199 {
200  // Communication gpio pins
201 
202  pin_name_t rx_pin;
203  pin_name_t tx_pin;
204 
205  // Additional gpio pins
206 
207  pin_name_t dtr;
208  pin_name_t rst;
209  pin_name_t cts;
210  pin_name_t dsr;
211  pin_name_t rts;
212 
213  // static variable
214 
215  uint32_t baud_rate; // Clock speed.
217  uart_data_bits_t data_bit; // Data bits.
218  uart_parity_t parity_bit; // Parity bit.
219  uart_stop_bits_t stop_bit; // Stop bits.
220 
221 } ble8_cfg_t;
222  // End types group
224 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
225 
231 #ifdef __cplusplus
232 extern "C"{
233 #endif
234 
244 
254 
262 void ble8_reset ( ble8_t *ctx );
263 
270 void ble8_generic_write ( ble8_t *ctx, char *data_buf, uint16_t len );
271 
279 int32_t ble8_generic_read ( ble8_t *ctx, char *data_buf, uint16_t max_len );
280 
290 uint8_t ble8_response_ready( ble8_t *ctx );
291 
304 void ble8_send_command ( ble8_t *ctx, char *command );
305 
315 void ble8_fact_rst_cmd ( ble8_t *ctx );
316 
327 
334 
346 void ble8_set_start_mode_cmd ( ble8_t *ctx, uint8_t start_mode );
347 
356 
370 void ble8_enter_mode_cmd ( ble8_t *ctx, uint8_t mode );
371 
381 void ble8_set_echo_cmd ( ble8_t *ctx, uint8_t echo_en );
382 
390 void ble8_get_echo_cmd ( ble8_t *ctx );
391 
404 void ble8_set_local_name_cmd ( ble8_t *ctx, char *local_name );
405 
414 
431 void ble8_set_low_energy_role_cmd ( ble8_t *ctx, uint8_t le_role );
432 
441 
453 
469 
481 
504 void ble8_set_sec_mode_cmd ( ble8_t *ctx, uint8_t sec_mode );
505 
514 
523 void ble8_pairing_en_cmd ( ble8_t *ctx, uint8_t pairing_mode );
524 
533 
542 void ble8_connectability_en_cmd ( ble8_t *ctx, uint8_t conn_mode );
543 
552 
568 void ble8_discoverability_en_cmd ( ble8_t *ctx, uint8_t discover_mode );
569 
578 
586 void ble8_get_info ( ble8_t *ctx );
587 
600 uint8_t ble8_sps_central_pairing ( ble8_t *ctx, uint8_t *local_addr );
601 
613 
626 void ble8_set_cts_pin ( ble8_t *ctx, uint8_t state );
627 
639 void ble8_set_dsr_pin ( ble8_t *ctx, uint8_t state );
640 
653 uint8_t ble8_get_dtr_pin ( ble8_t *ctx );
654 
666 uint8_t ble8_get_rts_pin ( ble8_t *ctx );
667 
668 
669 #ifdef __cplusplus
670 }
671 #endif
672 #endif // _BLE8_H_
673  // End public_function group
676 
677 // ------------------------------------------------------------------------- END
DRV_RX_BUFFER_SIZE
#define DRV_RX_BUFFER_SIZE
Definition: ble8.h:156
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:209
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:191
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:203
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:210
ble8_cfg_t::rx_pin
pin_name_t rx_pin
Definition: ble8.h:202
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:218
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:190
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:199
BLE8_RETVAL
#define BLE8_RETVAL
Definition: ble8.h:66
ble8_cfg_t::dtr
pin_name_t dtr
Definition: ble8.h:207
ble8_t::cts
digital_out_t cts
Definition: ble8.h:175
ble8_cfg_t::rst
pin_name_t rst
Definition: ble8.h:208
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:215
ble8_t
Click ctx object definition.
Definition: ble8.h:171
ble8_cfg_t::data_bit
uart_data_bits_t data_bit
Definition: ble8.h:217
ble8_cfg_t::stop_bit
uart_stop_bits_t stop_bit
Definition: ble8.h:219
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:176
ble8_response_ready
uint8_t ble8_response_ready(ble8_t *ctx)
Response Ready function.
ble8_t::uart
uart_t uart
Definition: ble8.h:185
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:180
ble8_t::rst
digital_out_t rst
Definition: ble8.h:174
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:211
DRV_TX_BUFFER_SIZE
#define DRV_TX_BUFFER_SIZE
Definition: ble8.h:157
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:216
ble8_send_command
void ble8_send_command(ble8_t *ctx, char *command)
Transmit function.
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:181
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.