barcode2  2.0.0.0
barcode2.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 BARCODE2_H
36 #define BARCODE2_H
37 
42 #ifdef PREINIT_SUPPORTED
43 #include "preinit.h"
44 #endif
45 
46 #ifdef MikroCCoreVersion
47  #if MikroCCoreVersion >= 1
48  #include "delays.h"
49  #endif
50 #endif
51 
52 #include "drv_digital_out.h"
53 #include "drv_digital_in.h"
54 #include "drv_uart.h"
55 
56 // -------------------------------------------------------------- PUBLIC MACROS
66 #define BARCODE2_MAP_MIKROBUS( cfg, mikrobus ) \
67  cfg.tx_pin = MIKROBUS( mikrobus, MIKROBUS_TX ); \
68  cfg.rx_pin = MIKROBUS( mikrobus, MIKROBUS_RX ); \
69  cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
70  cfg.trg = MIKROBUS( mikrobus, MIKROBUS_PWM )
71 
77 #define BARCODE2_RETVAL uint8_t
78 
79 #define BARCODE2_OK 0x00
80 #define BARCODE2_INIT_ERROR 0xFF
81 
87 #define BARCODE2_DISABLE 0x01
88 #define BARCODE2_ENABLE 0x00
89 
95 #define DRV_RX_BUFFER_SIZE 600
96 #define DRV_TX_BUFFER_SIZE 50
97  // End group macro
100 // --------------------------------------------------------------- PUBLIC TYPES
108 typedef struct
109 {
110  // Output pins
111 
112  digital_out_t rst;
113  digital_out_t trg;
114 
115  // Modules
116 
117  uart_t uart;
118 
119  char uart_rx_buffer[ DRV_RX_BUFFER_SIZE ];
120  char uart_tx_buffer[ DRV_TX_BUFFER_SIZE ];
121 
122 } barcode2_t;
123 
127 typedef struct
128 {
129  // Communication gpio pins
130 
131  pin_name_t rx_pin;
132  pin_name_t tx_pin;
133 
134  // Additional gpio pins
135 
136  pin_name_t rst;
137  pin_name_t trg;
138 
139  // static variable
140 
141  uint32_t baud_rate; // Clock speed.
143  uart_data_bits_t data_bit; // Data bits.
144  uart_parity_t parity_bit; // Parity bit.
145  uart_stop_bits_t stop_bit; // Stop bits.
146 
148 
152 typedef uint8_t barcode2_error_t;
153  // End types group
155 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
156 
162 #ifdef __cplusplus
163 extern "C"{
164 #endif
165 
175 
185 
195 void barcode2_generic_write ( barcode2_t *ctx, char *data_buf, uint16_t len );
196 
207 int32_t barcode2_generic_read ( barcode2_t *ctx, char *data_buf, uint16_t max_len );
208 
222 void barcode2_enable_scaning ( barcode2_t *ctx, uint8_t en_state );
223 
237 void barcode2_enable_reset ( barcode2_t *ctx, uint8_t en_state );
238 
239 
240 #ifdef __cplusplus
241 }
242 #endif
243 #endif // _BARCODE2_H_
244  // End public_function group
247 
248 // ------------------------------------------------------------------------- END
DRV_RX_BUFFER_SIZE
#define DRV_RX_BUFFER_SIZE
Definition: barcode2.h:95
barcode2_cfg_t::stop_bit
uart_stop_bits_t stop_bit
Definition: barcode2.h:145
barcode2_generic_write
void barcode2_generic_write(barcode2_t *ctx, char *data_buf, uint16_t len)
Generic write function.
barcode2_t
Click ctx object definition.
Definition: barcode2.h:109
barcode2_cfg_t::data_bit
uart_data_bits_t data_bit
Definition: barcode2.h:143
barcode2_cfg_t
Click configuration structure definition.
Definition: barcode2.h:128
barcode2_cfg_t::parity_bit
uart_parity_t parity_bit
Definition: barcode2.h:144
BARCODE2_RETVAL
#define BARCODE2_RETVAL
Definition: barcode2.h:77
barcode2_cfg_t::trg
pin_name_t trg
Definition: barcode2.h:137
barcode2_cfg_t::tx_pin
pin_name_t tx_pin
Definition: barcode2.h:132
barcode2_init
BARCODE2_RETVAL barcode2_init(barcode2_t *ctx, barcode2_cfg_t *cfg)
Initialization function.
barcode2_t::trg
digital_out_t trg
Definition: barcode2.h:113
barcode2_t::rst
digital_out_t rst
Definition: barcode2.h:112
barcode2_cfg_t::rx_pin
pin_name_t rx_pin
Definition: barcode2.h:131
barcode2_cfg_setup
void barcode2_cfg_setup(barcode2_cfg_t *cfg)
Config Object Initialization function.
barcode2_cfg_t::rst
pin_name_t rst
Definition: barcode2.h:136
barcode2_cfg_t::baud_rate
uint32_t baud_rate
Definition: barcode2.h:141
barcode2_cfg_t::uart_blocking
bool uart_blocking
Definition: barcode2.h:142
barcode2_enable_reset
void barcode2_enable_reset(barcode2_t *ctx, uint8_t en_state)
Enable reset function.
barcode2_t::uart
uart_t uart
Definition: barcode2.h:117
DRV_TX_BUFFER_SIZE
#define DRV_TX_BUFFER_SIZE
Definition: barcode2.h:96
barcode2_error_t
uint8_t barcode2_error_t
Error type.
Definition: barcode2.h:152
barcode2_generic_read
int32_t barcode2_generic_read(barcode2_t *ctx, char *data_buf, uint16_t max_len)
Generic read function.
barcode2_enable_scaning
void barcode2_enable_scaning(barcode2_t *ctx, uint8_t en_state)
Enable scaning function.