annab412  2.1.0.0
annab412.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 ANNAB412_H
29 #define ANNAB412_H
30 
31 #ifdef __cplusplus
32 extern "C"{
33 #endif
34 
35 #include "mikrosdk_version.h"
36 
37 #ifdef __GNUC__
38 #if mikroSDK_GET_VERSION < 20800ul
39 #include "rcu_delays.h"
40 #else
41 #include "delays.h"
42 #endif
43 #endif
44 
45 #include "drv_digital_out.h"
46 #include "drv_digital_in.h"
47 #include "drv_uart.h"
48 
69 #define ANNAB412_CMD_AT "AT"
70 #define ANNAB412_CMD_ECHO_OFF "ATE0"
71 #define ANNAB412_CMD_ECHO_ON "ATE1"
72 #define ANNAB412_CMD_DEV_NAME "AT+UBTLN"
73 #define ANNAB412_CMD_CONN_MODE "AT+UBTCM"
74 #define ANNAB412_CMD_DISCOVER_MODE "AT+UBTDM"
75 #define ANNAB412_CMD_ENTER_MODE "ATO"
76 
81 #define ANNAB412_DELIMITER_TERMINATION 13
82 #define ANNAB412_DELIMITER_END_CMD 0
83 #define ANNAB412_DELIMITER_QUOTATION 0x22
84 #define ANNAB412_DELIMITER_EQUAL 0x3D
85 #define ANNAB412_ASCII_CHAR_0 48
86 
91 #define ANNAB412_DEV_NAME_MIN 1
92 #define ANNAB412_DEV_NAME_MAX 38
93 
98 #define ANNAB412_CONNECTABLE_MODE_OFF 1
99 #define ANNAB412_CONNECTABLE_MODE_ON 2
100 
105 #define ANNAB412_DISCOVERABLE_MODE_OFF 1
106 #define ANNAB412_DISCOVERABLE_MODE_LIM 2
107 #define ANNAB412_DISCOVERABLE_MODE_ON 3
108 
113 #define ANNAB412_ENTER_MODE_COMMAND 0
114 #define ANNAB412_ENTER_MODE_DATA 1
115 #define ANNAB412_ENTER_MODE_EXT_DATA 2
116 #define ANNAB412_ENTER_MODE_PPP 3
117 
122 #define ANNAB412_PIN_STATE_LOW 0
123 #define ANNAB412_PIN_STATE_HIGH 1
124 
130 #define ANNAB412_TX_DRV_BUFFER_SIZE 100
131 #define ANNAB412_RX_DRV_BUFFER_SIZE 300
132  // annab412_cmd
134 
149 #define ANNAB412_MAP_MIKROBUS( cfg, mikrobus ) \
150  cfg.tx_pin = MIKROBUS( mikrobus, MIKROBUS_TX ); \
151  cfg.rx_pin = MIKROBUS( mikrobus, MIKROBUS_RX ); \
152  cfg.dtr = MIKROBUS( mikrobus, MIKROBUS_AN ); \
153  cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
154  cfg.cts = MIKROBUS( mikrobus, MIKROBUS_CS ); \
155  cfg.dsr = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
156  cfg.rts = MIKROBUS( mikrobus, MIKROBUS_INT );
157  // annab412_map // annab412
160 
165 typedef struct
166 {
167  // Output pins
168  digital_out_t rst;
169  digital_out_t cts;
170  digital_out_t dsr;
172  // Input pins
173  digital_in_t dtr;
174  digital_in_t rts;
176  // Modules
177  uart_t uart;
179  // Buffers
180  uint8_t uart_rx_buffer[ ANNAB412_RX_DRV_BUFFER_SIZE ];
181  uint8_t uart_tx_buffer[ ANNAB412_TX_DRV_BUFFER_SIZE ];
183 } annab412_t;
184 
189 typedef struct
190 {
191  // Communication gpio pins
192  pin_name_t rx_pin;
193  pin_name_t tx_pin;
195  // Additional gpio pins
196  pin_name_t dtr;
197  pin_name_t rst;
198  pin_name_t cts;
199  pin_name_t dsr;
200  pin_name_t rts;
202  // Static variable
203  uint32_t baud_rate;
205  uart_data_bits_t data_bit;
206  uart_parity_t parity_bit;
207  uart_stop_bits_t stop_bit;
210 
215 typedef enum
216 {
218  ANNAB412_ERROR = -1
219 
221 
238 
253 
267 
280 err_t annab412_generic_write ( annab412_t *ctx, uint8_t *data_in, uint16_t len );
281 
294 err_t annab412_generic_read ( annab412_t *ctx, uint8_t *data_out, uint16_t len );
295 
305 void annab412_set_rst_pin ( annab412_t *ctx, uint8_t state );
306 
316 void annab412_set_dsr_pin ( annab412_t *ctx, uint8_t state );
317 
327 void annab412_set_cts_pin ( annab412_t *ctx, uint8_t state );
328 
339 
350 
360 
374 err_t annab412_send_command ( annab412_t *ctx, char *command );
375 
389 
403 
417 err_t annab412_set_cmd_device_name ( annab412_t *ctx, char *device_name );
418 
432 err_t annab412_set_cmd_conn_mode ( annab412_t *ctx, uint8_t mode );
433 
447 err_t annab412_set_cmd_discover_mode ( annab412_t *ctx, uint8_t mode );
448 
462 err_t annab412_set_cmd_enter_mode ( annab412_t *ctx, uint8_t mode );
463 
464 #ifdef __cplusplus
465 }
466 #endif
467 #endif // ANNAB412_H
468  // annab412
470 
471 // ------------------------------------------------------------------------ END
annab412_t::rts
digital_in_t rts
Definition: annab412.h:174
annab412_cfg_t::tx_pin
pin_name_t tx_pin
Definition: annab412.h:193
annab412_set_cmd_enter_mode
err_t annab412_set_cmd_enter_mode(annab412_t *ctx, uint8_t mode)
ANNA-B412 set enter mode function.
annab412_set_dsr_pin
void annab412_set_dsr_pin(annab412_t *ctx, uint8_t state)
ANNA-B412 set data set ready pin function.
annab412_set_cmd_device_name
err_t annab412_set_cmd_device_name(annab412_t *ctx, char *device_name)
ANNA-B412 set device name function.
annab412_cfg_t::baud_rate
uint32_t baud_rate
Definition: annab412.h:203
annab412_init
err_t annab412_init(annab412_t *ctx, annab412_cfg_t *cfg)
ANNA-B412 initialization function.
annab412_cfg_t::rts
pin_name_t rts
Definition: annab412.h:200
ANNAB412_TX_DRV_BUFFER_SIZE
#define ANNAB412_TX_DRV_BUFFER_SIZE
ANNA-B412 driver buffer size.
Definition: annab412.h:130
annab412_t::cts
digital_out_t cts
Definition: annab412.h:169
annab412_cfg_t::data_bit
uart_data_bits_t data_bit
Definition: annab412.h:205
annab412_set_cmd_echo_off
err_t annab412_set_cmd_echo_off(annab412_t *ctx)
ANNA-B412 set command echo on function.
annab412_get_dtr_pin
uint8_t annab412_get_dtr_pin(annab412_t *ctx)
ANNA-B412 get data terminal ready pin function.
annab412_cfg_t::parity_bit
uart_parity_t parity_bit
Definition: annab412.h:206
annab412_cfg_t::cts
pin_name_t cts
Definition: annab412.h:198
annab412_set_cmd_discover_mode
err_t annab412_set_cmd_discover_mode(annab412_t *ctx, uint8_t mode)
ANNA-B412 set discoverability mode function.
annab412_cfg_t::dtr
pin_name_t dtr
Definition: annab412.h:196
annab412_cfg_t::uart_blocking
bool uart_blocking
Definition: annab412.h:204
annab412_hw_reset
void annab412_hw_reset(annab412_t *ctx)
ANNA-B412 hw reset function.
ANNAB412_RX_DRV_BUFFER_SIZE
#define ANNAB412_RX_DRV_BUFFER_SIZE
Definition: annab412.h:131
annab412_t::dtr
digital_in_t dtr
Definition: annab412.h:173
annab412_t::uart
uart_t uart
Definition: annab412.h:177
ANNAB412_ERROR
@ ANNAB412_ERROR
Definition: annab412.h:218
annab412_cfg_t
ANNA-B412 Click configuration object.
Definition: annab412.h:190
annab412_set_rst_pin
void annab412_set_rst_pin(annab412_t *ctx, uint8_t state)
ANNA-B412 set reset pin function.
annab412_generic_read
err_t annab412_generic_read(annab412_t *ctx, uint8_t *data_out, uint16_t len)
ANNA-B412 data reading function.
annab412_default_cfg
err_t annab412_default_cfg(annab412_t *ctx)
ANNA-B412 default configuration function.
annab412_t::dsr
digital_out_t dsr
Definition: annab412.h:170
annab412_send_command
err_t annab412_send_command(annab412_t *ctx, char *command)
ANNA-B412 send command function.
annab412_cfg_t::rx_pin
pin_name_t rx_pin
Definition: annab412.h:192
ANNAB412_OK
@ ANNAB412_OK
Definition: annab412.h:217
annab412_t::rst
digital_out_t rst
Definition: annab412.h:168
annab412_set_cts_pin
void annab412_set_cts_pin(annab412_t *ctx, uint8_t state)
ANNA-B412 set clear to send pin function.
annab412_set_cmd_echo_on
err_t annab412_set_cmd_echo_on(annab412_t *ctx)
ANNA-B412 set command echo on function.
annab412_get_rts_pin
uint8_t annab412_get_rts_pin(annab412_t *ctx)
ANNA-B412 get request to send pin function.
annab412_cfg_t::stop_bit
uart_stop_bits_t stop_bit
Definition: annab412.h:207
annab412_return_value_t
annab412_return_value_t
ANNA-B412 Click return value data.
Definition: annab412.h:216
annab412_cfg_setup
void annab412_cfg_setup(annab412_cfg_t *cfg)
ANNA-B412 configuration object setup function.
annab412_generic_write
err_t annab412_generic_write(annab412_t *ctx, uint8_t *data_in, uint16_t len)
ANNA-B412 data writing function.
annab412_cfg_t::rst
pin_name_t rst
Definition: annab412.h:197
annab412_cfg_t::dsr
pin_name_t dsr
Definition: annab412.h:199
annab412_set_cmd_conn_mode
err_t annab412_set_cmd_conn_mode(annab412_t *ctx, uint8_t mode)
ANNA-B412 set connectability mode function.
annab412_t
ANNA-B412 Click context object.
Definition: annab412.h:166