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 "drv_digital_out.h"
36 #include "drv_digital_in.h"
37 #include "drv_uart.h"
38 
59 #define ANNAB412_CMD_AT "AT"
60 #define ANNAB412_CMD_ECHO_OFF "ATE0"
61 #define ANNAB412_CMD_ECHO_ON "ATE1"
62 #define ANNAB412_CMD_DEV_NAME "AT+UBTLN"
63 #define ANNAB412_CMD_CONN_MODE "AT+UBTCM"
64 #define ANNAB412_CMD_DISCOVER_MODE "AT+UBTDM"
65 #define ANNAB412_CMD_ENTER_MODE "ATO"
66 
71 #define ANNAB412_DELIMITER_TERMINATION 13
72 #define ANNAB412_DELIMITER_END_CMD 0
73 #define ANNAB412_DELIMITER_QUOTATION 0x22
74 #define ANNAB412_DELIMITER_EQUAL 0x3D
75 #define ANNAB412_ASCII_CHAR_0 48
76 
81 #define ANNAB412_DEV_NAME_MIN 1
82 #define ANNAB412_DEV_NAME_MAX 38
83 
88 #define ANNAB412_CONNECTABLE_MODE_OFF 1
89 #define ANNAB412_CONNECTABLE_MODE_ON 2
90 
95 #define ANNAB412_DISCOVERABLE_MODE_OFF 1
96 #define ANNAB412_DISCOVERABLE_MODE_LIM 2
97 #define ANNAB412_DISCOVERABLE_MODE_ON 3
98 
103 #define ANNAB412_ENTER_MODE_COMMAND 0
104 #define ANNAB412_ENTER_MODE_DATA 1
105 #define ANNAB412_ENTER_MODE_EXT_DATA 2
106 #define ANNAB412_ENTER_MODE_PPP 3
107 
112 #define ANNAB412_PIN_STATE_LOW 0
113 #define ANNAB412_PIN_STATE_HIGH 1
114 
120 #define ANNAB412_TX_DRV_BUFFER_SIZE 100
121 #define ANNAB412_RX_DRV_BUFFER_SIZE 300
122  // annab412_cmd
124 
139 #define ANNAB412_MAP_MIKROBUS( cfg, mikrobus ) \
140  cfg.tx_pin = MIKROBUS( mikrobus, MIKROBUS_TX ); \
141  cfg.rx_pin = MIKROBUS( mikrobus, MIKROBUS_RX ); \
142  cfg.dtr = MIKROBUS( mikrobus, MIKROBUS_AN ); \
143  cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
144  cfg.cts = MIKROBUS( mikrobus, MIKROBUS_CS ); \
145  cfg.dsr = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
146  cfg.rts = MIKROBUS( mikrobus, MIKROBUS_INT );
147  // annab412_map // annab412
150 
155 typedef struct
156 {
157  // Output pins
158  digital_out_t rst;
159  digital_out_t cts;
160  digital_out_t dsr;
162  // Input pins
163  digital_in_t dtr;
164  digital_in_t rts;
166  // Modules
167  uart_t uart;
169  // Buffers
170  uint8_t uart_rx_buffer[ ANNAB412_RX_DRV_BUFFER_SIZE ];
171  uint8_t uart_tx_buffer[ ANNAB412_TX_DRV_BUFFER_SIZE ];
173 } annab412_t;
174 
179 typedef struct
180 {
181  // Communication gpio pins
182  pin_name_t rx_pin;
183  pin_name_t tx_pin;
185  // Additional gpio pins
186  pin_name_t dtr;
187  pin_name_t rst;
188  pin_name_t cts;
189  pin_name_t dsr;
190  pin_name_t rts;
192  // Static variable
193  uint32_t baud_rate;
195  uart_data_bits_t data_bit;
196  uart_parity_t parity_bit;
197  uart_stop_bits_t stop_bit;
200 
205 typedef enum
206 {
208  ANNAB412_ERROR = -1
209 
211 
228 
243 
257 
270 err_t annab412_generic_write ( annab412_t *ctx, uint8_t *data_in, uint16_t len );
271 
284 err_t annab412_generic_read ( annab412_t *ctx, uint8_t *data_out, uint16_t len );
285 
295 void annab412_set_rst_pin ( annab412_t *ctx, uint8_t state );
296 
306 void annab412_set_dsr_pin ( annab412_t *ctx, uint8_t state );
307 
317 void annab412_set_cts_pin ( annab412_t *ctx, uint8_t state );
318 
329 
340 
350 
364 err_t annab412_send_command ( annab412_t *ctx, char *command );
365 
379 
393 
407 err_t annab412_set_cmd_device_name ( annab412_t *ctx, char *device_name );
408 
422 err_t annab412_set_cmd_conn_mode ( annab412_t *ctx, uint8_t mode );
423 
437 err_t annab412_set_cmd_discover_mode ( annab412_t *ctx, uint8_t mode );
438 
452 err_t annab412_set_cmd_enter_mode ( annab412_t *ctx, uint8_t mode );
453 
454 #ifdef __cplusplus
455 }
456 #endif
457 #endif // ANNAB412_H
458  // annab412
460 
461 // ------------------------------------------------------------------------ END
annab412_t::rts
digital_in_t rts
Definition: annab412.h:164
annab412_cfg_t::tx_pin
pin_name_t tx_pin
Definition: annab412.h:183
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:193
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:190
ANNAB412_TX_DRV_BUFFER_SIZE
#define ANNAB412_TX_DRV_BUFFER_SIZE
ANNA-B412 driver buffer size.
Definition: annab412.h:120
annab412_t::cts
digital_out_t cts
Definition: annab412.h:159
annab412_cfg_t::data_bit
uart_data_bits_t data_bit
Definition: annab412.h:195
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:196
annab412_cfg_t::cts
pin_name_t cts
Definition: annab412.h:188
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:186
annab412_cfg_t::uart_blocking
bool uart_blocking
Definition: annab412.h:194
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:121
annab412_t::dtr
digital_in_t dtr
Definition: annab412.h:163
annab412_t::uart
uart_t uart
Definition: annab412.h:167
ANNAB412_ERROR
@ ANNAB412_ERROR
Definition: annab412.h:208
annab412_cfg_t
ANNA-B412 Click configuration object.
Definition: annab412.h:180
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:160
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:182
ANNAB412_OK
@ ANNAB412_OK
Definition: annab412.h:207
annab412_t::rst
digital_out_t rst
Definition: annab412.h:158
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:197
annab412_return_value_t
annab412_return_value_t
ANNA-B412 Click return value data.
Definition: annab412.h:206
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:187
annab412_cfg_t::dsr
pin_name_t dsr
Definition: annab412.h:189
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:156