binhonova  2.1.0.0
binhonova.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 BINHONOVA_H
29 #define BINHONOVA_H
30 
31 #ifdef __cplusplus
32 extern "C"{
33 #endif
34 
39 #ifdef PREINIT_SUPPORTED
40 #include "preinit.h"
41 #endif
42 
43 #ifdef MikroCCoreVersion
44  #if MikroCCoreVersion >= 1
45  #include "delays.h"
46  #endif
47 #endif
48 
49 #include "drv_digital_out.h"
50 #include "drv_digital_in.h"
51 #include "drv_uart.h"
52 
74 #define BINHONOVA_TX_DRV_BUFFER_SIZE 100
75 #define BINHONOVA_RX_DRV_BUFFER_SIZE 300
76  // binhonova_cmd
78 
93 #define BINHONOVA_MAP_MIKROBUS( cfg, mikrobus ) \
94  cfg.tx_pin = MIKROBUS( mikrobus, MIKROBUS_TX ); \
95  cfg.rx_pin = MIKROBUS( mikrobus, MIKROBUS_RX );
96  // binhonova_map // binhonova
99 
104 typedef struct
105 {
106  // Modules
107  uart_t uart;
109  // Buffers
110  uint8_t uart_rx_buffer[ BINHONOVA_RX_DRV_BUFFER_SIZE ];
111  uint8_t uart_tx_buffer[ BINHONOVA_TX_DRV_BUFFER_SIZE ];
113 } binhonova_t;
114 
119 typedef struct
120 {
121  // Communication gpio pins
122  pin_name_t rx_pin;
123  pin_name_t tx_pin;
125  // Static variable
126  uint32_t baud_rate;
128  uart_data_bits_t data_bit;
129  uart_parity_t parity_bit;
130  uart_stop_bits_t stop_bit;
133 
138 typedef enum
139 {
141  BINHONOVA_ERROR = -1
142 
144 
161 
176 
189 err_t binhonova_generic_write ( binhonova_t *ctx, uint8_t *data_in, uint16_t len );
190 
203 err_t binhonova_generic_read ( binhonova_t *ctx, uint8_t *data_out, uint16_t len );
204 
205 #ifdef __cplusplus
206 }
207 #endif
208 #endif // BINHONOVA_H
209  // binhonova
211 
212 // ------------------------------------------------------------------------ END
binhonova_return_value_t
binhonova_return_value_t
Binho Nova Click return value data.
Definition: binhonova.h:139
binhonova_cfg_t::uart_blocking
bool uart_blocking
Definition: binhonova.h:127
binhonova_t::uart
uart_t uart
Definition: binhonova.h:107
BINHONOVA_TX_DRV_BUFFER_SIZE
#define BINHONOVA_TX_DRV_BUFFER_SIZE
Binho Nova driver buffer size.
Definition: binhonova.h:74
binhonova_cfg_t::data_bit
uart_data_bits_t data_bit
Definition: binhonova.h:128
binhonova_cfg_t::parity_bit
uart_parity_t parity_bit
Definition: binhonova.h:129
binhonova_cfg_t
Binho Nova Click configuration object.
Definition: binhonova.h:120
binhonova_generic_read
err_t binhonova_generic_read(binhonova_t *ctx, uint8_t *data_out, uint16_t len)
Binho Nova data reading function.
binhonova_t
Binho Nova Click context object.
Definition: binhonova.h:105
binhonova_cfg_setup
void binhonova_cfg_setup(binhonova_cfg_t *cfg)
Binho Nova configuration object setup function.
binhonova_cfg_t::tx_pin
pin_name_t tx_pin
Definition: binhonova.h:123
BINHONOVA_OK
@ BINHONOVA_OK
Definition: binhonova.h:140
binhonova_init
err_t binhonova_init(binhonova_t *ctx, binhonova_cfg_t *cfg)
Binho Nova initialization function.
binhonova_cfg_t::stop_bit
uart_stop_bits_t stop_bit
Definition: binhonova.h:130
BINHONOVA_RX_DRV_BUFFER_SIZE
#define BINHONOVA_RX_DRV_BUFFER_SIZE
Definition: binhonova.h:75
BINHONOVA_ERROR
@ BINHONOVA_ERROR
Definition: binhonova.h:141
binhonova_cfg_t::baud_rate
uint32_t baud_rate
Definition: binhonova.h:126
binhonova_cfg_t::rx_pin
pin_name_t rx_pin
Definition: binhonova.h:122
binhonova_generic_write
err_t binhonova_generic_write(binhonova_t *ctx, uint8_t *data_in, uint16_t len)
Binho Nova data writing function.