ble3  2.0.0.0
ble3.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 BLE3_H
36 #define BLE3_H
37 
38 #include "drv_digital_out.h"
39 #include "drv_digital_in.h"
40 #include "drv_uart.h"
41 
42 
43 // -------------------------------------------------------------- PUBLIC MACROS
53 #define BLE3_MAP_MIKROBUS( cfg, mikrobus ) \
54  cfg.tx_pin = MIKROBUS( mikrobus, MIKROBUS_TX ); \
55  cfg.rx_pin = MIKROBUS( mikrobus, MIKROBUS_RX ); \
56  cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
57  cfg.cts = MIKROBUS( mikrobus, MIKROBUS_CS ); \
58  cfg.rts = MIKROBUS( mikrobus, MIKROBUS_INT )
59 
65 #define BLE3_RETVAL uint8_t
66 
67 #define BLE3_OK 0x00
68 #define BLE3_INIT_ERROR 0xFF
69 
75 #define BLE3_PARSER_NO_ERROR 0x00
76 #define BLE3_PARSER_ERROR_REF 0x01
77 #define BLE3_PARSER_ERROR_CMD 0x02
78 #define BLE3_PARSER_ERROR_DATA 0x04
79 
85 #define BLE3_STATUS_DEVICE_READY 1
86 #define BLE3_STATUS_ACT_NETWORK_AND_BROKER 4
87 #define BLE3_STATUS_ACT_NETWORK 2
88 #define BLE3_STATUS_ACT_BROKER 3
89 #define BLE3_STATUS_DEVICE_BUSY 0
90 
96 #define BLE3_MODULE_POWER_ON 1
97 #define BLE3_MODULE_POWER_OFF 0
98 
104 #define BLE3_SINGLE_CMD_AT "AT"
105 #define BLE3_SINGLE_CMD_AT_W "AT+W"
106 #define BLE3_SINGLE_CMD_AT_R "AT+R"
107 #define BLE3_SINGLE_CMD_ATE0 "ATE0"
108 #define BLE3_SINGLE_CMD_ATE1 "ATE1"
109 #define BLE3_SINGLE_CMD_AT_RST "AT+RST"
110 #define BLE3_SINGLE_CMD_AT_CRST "AT+CRST"
111 #define BLE3_SINGLE_CMD_AT_GMR "AT+GMR"
112 #define BLE3_SINGLE_CMD_AT_GMSTA "AT+GMSTA"
113 #define BLE3_SINGLE_CMD_AT_PUB "AT+PUB"
114 
115 #define BLE3_SINGLE_CMD_SET_AT_LRSP_1 "AT+LRSP=1"
116 #define BLE3_SINGLE_CMD_SET_AT_LRSP_0 "AT+LRSP=0"
117 #define BLE3_SINGLE_CMD_SET_AT_CEN_1 "AT+CEN=1"
118 #define BLE3_SINGLE_CMD_SET_AT_CEN_0 "AT+CEN=0"
119 #define BLE3_SINGLE_CMD_SET_AT_NWC_1 "AT+NWC=1"
120 #define BLE3_SINGLE_CMD_SET_AT_NWC_0 "AT+NWC=0"
121 #define BLE3_SINGLE_CMD_SET_AT_BRC_1 "AT+BRC=1"
122 #define BLE3_SINGLE_CMD_SET_AT_BRC_0 "AT+BRC=0"
123 #define BLE3_SINGLE_CMD_SET_AT_GPEN_0 "AT+GPEN=0"
124 #define BLE3_SINGLE_CMD_SET_AT_GPEN_1 "AT+GPEN=1"
125 
126 #define BLE3_SINGLE_CMD_GET_AT_LRSP "AT+LRSP?"
127 #define BLE3_SINGLE_CMD_GET_AT_CEN "AT+CEN?"
128 #define BLE3_SINGLE_CMD_GET_AT_NWC "AT+NWC?"
129 #define BLE3_SINGLE_CMD_GET_AT_BRC "AT+BRC?"
130 #define BLE3_SINGLE_CMD_GET_AT_GPEN "AT+GPEN?"
131 #define BLE3_SINGLE_CMD_GET_AT_NWCR "AT+NWCR?"
132 #define BLE3_SINGLE_CMD_GET_AT_BRCR "AT+BRCR?"
133 #define BLE3_SINGLE_CMD_GET_AT_DSET "AT+DSET?"
134 
135 #define BLE3_SINGLE_CMD_TEST_AT_LRSP "AT+LRSP=?"
136 #define BLE3_SINGLE_CMD_TEST_AT_CEN "AT+CEN=?"
137 #define BLE3_SINGLE_CMD_TEST_AT_NWC "AT+NWC=?"
138 #define BLE3_SINGLE_CMD_TEST_AT_BRC "AT+BRC=?"
139 #define BLE3_SINGLE_CMD_TEST_AT_GPEN "AT+GPEN=?"
140 #define BLE3_SINGLE_CMD_TEST_AT_NWCR "AT+NWCR=?"
141 #define BLE3_SINGLE_CMD_TEST_AT_BRCR "AT+BRCR=?"
142 #define BLE3_SINGLE_CMD_TEST_AT_DSET "AT+DSET=?"
143 
144 #define BLE3_MULTI_CMD_AT_DSET "AT+DSET"
145 #define BLE3_MULTI_CMD_AT_BRCR "AT+BRCR"
146 #define BLE3_MULTI_CMD_AT_NWCR "AT+NWCR"
147 
153 #define DRV_RX_BUFFER_SIZE 100
154 #define DRV_TX_BUFFER_SIZE 100
155  // End group macro
158 // --------------------------------------------------------------- PUBLIC TYPES
166 typedef struct
167 {
168  // Output pins
169 
170  digital_out_t rst;
171  digital_out_t rts;
172 
173  // Input pins
174 
175  digital_in_t cts;
176 
177  // Modules
178 
179  uart_t uart;
180 
181  char uart_rx_buffer[ DRV_RX_BUFFER_SIZE ];
182  char uart_tx_buffer[ DRV_TX_BUFFER_SIZE ];
183 
184 } ble3_t;
185 
189 typedef struct
190 {
191  // Communication gpio pins
192 
193  pin_name_t rx_pin;
194  pin_name_t tx_pin;
195 
196  // Additional gpio pins
197 
198  pin_name_t rst;
199  pin_name_t cts;
200  pin_name_t rts;
201 
202  // static variable
203 
204  uint32_t baud_rate; // Clock speed.
206  uart_data_bits_t data_bit; // Data bits.
207  uart_parity_t parity_bit; // Parity bit.
208  uart_stop_bits_t stop_bit; // Stop bits.
209 
210 } ble3_cfg_t;
211  // End types group
213 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
214 
220 #ifdef __cplusplus
221 extern "C"{
222 #endif
223 
232 void ble3_cfg_setup ( ble3_cfg_t *cfg );
233 
242 BLE3_RETVAL ble3_init ( ble3_t *ctx, ble3_cfg_t *cfg );
243 
250 void ble3_generic_write ( ble3_t *ctx, char *data_buf, uint16_t len );
251 
259 int32_t ble3_generic_read ( ble3_t *ctx, char *data_buf, uint16_t max_len );
260 
261 
262 #ifdef __cplusplus
263 }
264 #endif
265 #endif // _BLE3_H_
266  // End public_function group
269 
270 // ------------------------------------------------------------------------- END
DRV_RX_BUFFER_SIZE
#define DRV_RX_BUFFER_SIZE
Definition: ble3.h:153
ble3_t::uart
uart_t uart
Definition: ble3.h:179
ble3_cfg_t::tx_pin
pin_name_t tx_pin
Definition: ble3.h:194
ble3_cfg_t::cts
pin_name_t cts
Definition: ble3.h:199
ble3_cfg_t::rx_pin
pin_name_t rx_pin
Definition: ble3.h:193
ble3_generic_read
int32_t ble3_generic_read(ble3_t *ctx, char *data_buf, uint16_t max_len)
Generic read function.
ble3_t::rst
digital_out_t rst
Definition: ble3.h:170
BLE3_RETVAL
#define BLE3_RETVAL
Definition: ble3.h:65
ble3_t::rts
digital_out_t rts
Definition: ble3.h:171
ble3_cfg_t::uart_blocking
bool uart_blocking
Definition: ble3.h:205
ble3_cfg_t
Click configuration structure definition.
Definition: ble3.h:189
ble3_t
Click ctx object definition.
Definition: ble3.h:166
ble3_cfg_t::data_bit
uart_data_bits_t data_bit
Definition: ble3.h:206
ble3_generic_write
void ble3_generic_write(ble3_t *ctx, char *data_buf, uint16_t len)
Generic write function.
ble3_cfg_t::stop_bit
uart_stop_bits_t stop_bit
Definition: ble3.h:208
ble3_cfg_t::rts
pin_name_t rts
Definition: ble3.h:200
DRV_TX_BUFFER_SIZE
#define DRV_TX_BUFFER_SIZE
Definition: ble3.h:154
ble3_cfg_t::parity_bit
uart_parity_t parity_bit
Definition: ble3.h:207
ble3_t::cts
digital_in_t cts
Definition: ble3.h:175
ble3_cfg_setup
void ble3_cfg_setup(ble3_cfg_t *cfg)
Config Object Initialization function.
ble3_init
BLE3_RETVAL ble3_init(ble3_t *ctx, ble3_cfg_t *cfg)
Initialization function.
ble3_cfg_t::baud_rate
uint32_t baud_rate
Definition: ble3.h:204
ble3_cfg_t::rst
pin_name_t rst
Definition: ble3.h:198