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 "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 BLE3_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  cfg.cts = MIKROBUS( mikrobus, MIKROBUS_CS ); \
68  cfg.rts = MIKROBUS( mikrobus, MIKROBUS_INT )
69 
75 #define BLE3_RETVAL uint8_t
76 
77 #define BLE3_OK 0x00
78 #define BLE3_INIT_ERROR 0xFF
79 
85 #define BLE3_PARSER_NO_ERROR 0x00
86 #define BLE3_PARSER_ERROR_REF 0x01
87 #define BLE3_PARSER_ERROR_CMD 0x02
88 #define BLE3_PARSER_ERROR_DATA 0x04
89 
95 #define BLE3_STATUS_DEVICE_READY 1
96 #define BLE3_STATUS_ACT_NETWORK_AND_BROKER 4
97 #define BLE3_STATUS_ACT_NETWORK 2
98 #define BLE3_STATUS_ACT_BROKER 3
99 #define BLE3_STATUS_DEVICE_BUSY 0
100 
106 #define BLE3_MODULE_POWER_ON 1
107 #define BLE3_MODULE_POWER_OFF 0
108 
114 #define BLE3_SINGLE_CMD_AT "AT"
115 #define BLE3_SINGLE_CMD_AT_W "AT+W"
116 #define BLE3_SINGLE_CMD_AT_R "AT+R"
117 #define BLE3_SINGLE_CMD_ATE0 "ATE0"
118 #define BLE3_SINGLE_CMD_ATE1 "ATE1"
119 #define BLE3_SINGLE_CMD_AT_RST "AT+RST"
120 #define BLE3_SINGLE_CMD_AT_CRST "AT+CRST"
121 #define BLE3_SINGLE_CMD_AT_GMR "AT+GMR"
122 #define BLE3_SINGLE_CMD_AT_GMSTA "AT+GMSTA"
123 #define BLE3_SINGLE_CMD_AT_PUB "AT+PUB"
124 
125 #define BLE3_SINGLE_CMD_SET_AT_LRSP_1 "AT+LRSP=1"
126 #define BLE3_SINGLE_CMD_SET_AT_LRSP_0 "AT+LRSP=0"
127 #define BLE3_SINGLE_CMD_SET_AT_CEN_1 "AT+CEN=1"
128 #define BLE3_SINGLE_CMD_SET_AT_CEN_0 "AT+CEN=0"
129 #define BLE3_SINGLE_CMD_SET_AT_NWC_1 "AT+NWC=1"
130 #define BLE3_SINGLE_CMD_SET_AT_NWC_0 "AT+NWC=0"
131 #define BLE3_SINGLE_CMD_SET_AT_BRC_1 "AT+BRC=1"
132 #define BLE3_SINGLE_CMD_SET_AT_BRC_0 "AT+BRC=0"
133 #define BLE3_SINGLE_CMD_SET_AT_GPEN_0 "AT+GPEN=0"
134 #define BLE3_SINGLE_CMD_SET_AT_GPEN_1 "AT+GPEN=1"
135 
136 #define BLE3_SINGLE_CMD_GET_AT_LRSP "AT+LRSP?"
137 #define BLE3_SINGLE_CMD_GET_AT_CEN "AT+CEN?"
138 #define BLE3_SINGLE_CMD_GET_AT_NWC "AT+NWC?"
139 #define BLE3_SINGLE_CMD_GET_AT_BRC "AT+BRC?"
140 #define BLE3_SINGLE_CMD_GET_AT_GPEN "AT+GPEN?"
141 #define BLE3_SINGLE_CMD_GET_AT_NWCR "AT+NWCR?"
142 #define BLE3_SINGLE_CMD_GET_AT_BRCR "AT+BRCR?"
143 #define BLE3_SINGLE_CMD_GET_AT_DSET "AT+DSET?"
144 
145 #define BLE3_SINGLE_CMD_TEST_AT_LRSP "AT+LRSP=?"
146 #define BLE3_SINGLE_CMD_TEST_AT_CEN "AT+CEN=?"
147 #define BLE3_SINGLE_CMD_TEST_AT_NWC "AT+NWC=?"
148 #define BLE3_SINGLE_CMD_TEST_AT_BRC "AT+BRC=?"
149 #define BLE3_SINGLE_CMD_TEST_AT_GPEN "AT+GPEN=?"
150 #define BLE3_SINGLE_CMD_TEST_AT_NWCR "AT+NWCR=?"
151 #define BLE3_SINGLE_CMD_TEST_AT_BRCR "AT+BRCR=?"
152 #define BLE3_SINGLE_CMD_TEST_AT_DSET "AT+DSET=?"
153 
154 #define BLE3_MULTI_CMD_AT_DSET "AT+DSET"
155 #define BLE3_MULTI_CMD_AT_BRCR "AT+BRCR"
156 #define BLE3_MULTI_CMD_AT_NWCR "AT+NWCR"
157 
163 #define DRV_RX_BUFFER_SIZE 100
164 #define DRV_TX_BUFFER_SIZE 100
165  // End group macro
168 // --------------------------------------------------------------- PUBLIC TYPES
176 typedef struct
177 {
178  // Output pins
179 
180  digital_out_t rst;
181  digital_out_t rts;
182 
183  // Input pins
184 
185  digital_in_t cts;
186 
187  // Modules
188 
189  uart_t uart;
190 
191  char uart_rx_buffer[ DRV_RX_BUFFER_SIZE ];
192  char uart_tx_buffer[ DRV_TX_BUFFER_SIZE ];
193 
194 } ble3_t;
195 
199 typedef struct
200 {
201  // Communication gpio pins
202 
203  pin_name_t rx_pin;
204  pin_name_t tx_pin;
205 
206  // Additional gpio pins
207 
208  pin_name_t rst;
209  pin_name_t cts;
210  pin_name_t rts;
211 
212  // static variable
213 
214  uint32_t baud_rate; // Clock speed.
216  uart_data_bits_t data_bit; // Data bits.
217  uart_parity_t parity_bit; // Parity bit.
218  uart_stop_bits_t stop_bit; // Stop bits.
219 
220 } ble3_cfg_t;
221  // End types group
223 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
224 
230 #ifdef __cplusplus
231 extern "C"{
232 #endif
233 
243 
253 
260 void ble3_generic_write ( ble3_t *ctx, char *data_buf, uint16_t len );
261 
269 int32_t ble3_generic_read ( ble3_t *ctx, char *data_buf, uint16_t max_len );
270 
271 
272 #ifdef __cplusplus
273 }
274 #endif
275 #endif // _BLE3_H_
276  // End public_function group
279 
280 // ------------------------------------------------------------------------- END
DRV_RX_BUFFER_SIZE
#define DRV_RX_BUFFER_SIZE
Definition: ble3.h:163
ble3_t::uart
uart_t uart
Definition: ble3.h:189
ble3_cfg_t::tx_pin
pin_name_t tx_pin
Definition: ble3.h:204
ble3_cfg_t::cts
pin_name_t cts
Definition: ble3.h:209
ble3_cfg_t::rx_pin
pin_name_t rx_pin
Definition: ble3.h:203
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:180
BLE3_RETVAL
#define BLE3_RETVAL
Definition: ble3.h:75
ble3_t::rts
digital_out_t rts
Definition: ble3.h:181
ble3_cfg_t::uart_blocking
bool uart_blocking
Definition: ble3.h:215
ble3_cfg_t
Click configuration structure definition.
Definition: ble3.h:200
ble3_t
Click ctx object definition.
Definition: ble3.h:177
ble3_cfg_t::data_bit
uart_data_bits_t data_bit
Definition: ble3.h:216
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:218
ble3_cfg_t::rts
pin_name_t rts
Definition: ble3.h:210
DRV_TX_BUFFER_SIZE
#define DRV_TX_BUFFER_SIZE
Definition: ble3.h:164
ble3_cfg_t::parity_bit
uart_parity_t parity_bit
Definition: ble3.h:217
ble3_t::cts
digital_in_t cts
Definition: ble3.h:185
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:214
ble3_cfg_t::rst
pin_name_t rst
Definition: ble3.h:208