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 
38 #include "drv_digital_out.h"
39 #include "drv_digital_in.h"
40 #include "drv_uart.h"
41 
42 // -------------------------------------------------------------- PUBLIC MACROS
52 #define BARCODE2_MAP_MIKROBUS( cfg, mikrobus ) \
53  cfg.tx_pin = MIKROBUS( mikrobus, MIKROBUS_TX ); \
54  cfg.rx_pin = MIKROBUS( mikrobus, MIKROBUS_RX ); \
55  cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
56  cfg.trg = MIKROBUS( mikrobus, MIKROBUS_PWM )
57 
63 #define BARCODE2_RETVAL uint8_t
64 
65 #define BARCODE2_OK 0x00
66 #define BARCODE2_INIT_ERROR 0xFF
67 
73 #define BARCODE2_DISABLE 0x01
74 #define BARCODE2_ENABLE 0x00
75 
81 #define DRV_RX_BUFFER_SIZE 600
82 #define DRV_TX_BUFFER_SIZE 50
83  // End group macro
86 // --------------------------------------------------------------- PUBLIC TYPES
94 typedef struct
95 {
96  // Output pins
97 
98  digital_out_t rst;
99  digital_out_t trg;
100 
101  // Modules
102 
103  uart_t uart;
104 
105  char uart_rx_buffer[ DRV_RX_BUFFER_SIZE ];
106  char uart_tx_buffer[ DRV_TX_BUFFER_SIZE ];
107 
108 } barcode2_t;
109 
113 typedef struct
114 {
115  // Communication gpio pins
116 
117  pin_name_t rx_pin;
118  pin_name_t tx_pin;
119 
120  // Additional gpio pins
121 
122  pin_name_t rst;
123  pin_name_t trg;
124 
125  // static variable
126 
127  uint32_t baud_rate; // Clock speed.
129  uart_data_bits_t data_bit; // Data bits.
130  uart_parity_t parity_bit; // Parity bit.
131  uart_stop_bits_t stop_bit; // Stop bits.
132 
134 
138 typedef uint8_t barcode2_error_t;
139  // End types group
141 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
142 
148 #ifdef __cplusplus
149 extern "C"{
150 #endif
151 
161 
171 
181 void barcode2_generic_write ( barcode2_t *ctx, char *data_buf, uint16_t len );
182 
193 int32_t barcode2_generic_read ( barcode2_t *ctx, char *data_buf, uint16_t max_len );
194 
208 void barcode2_enable_scaning ( barcode2_t *ctx, uint8_t en_state );
209 
223 void barcode2_enable_reset ( barcode2_t *ctx, uint8_t en_state );
224 
225 
226 #ifdef __cplusplus
227 }
228 #endif
229 #endif // _BARCODE2_H_
230  // End public_function group
233 
234 // ------------------------------------------------------------------------- END
DRV_RX_BUFFER_SIZE
#define DRV_RX_BUFFER_SIZE
Definition: barcode2.h:81
barcode2_cfg_t::stop_bit
uart_stop_bits_t stop_bit
Definition: barcode2.h:131
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:95
barcode2_cfg_t::data_bit
uart_data_bits_t data_bit
Definition: barcode2.h:129
barcode2_cfg_t
Click configuration structure definition.
Definition: barcode2.h:114
barcode2_cfg_t::parity_bit
uart_parity_t parity_bit
Definition: barcode2.h:130
BARCODE2_RETVAL
#define BARCODE2_RETVAL
Definition: barcode2.h:63
barcode2_cfg_t::trg
pin_name_t trg
Definition: barcode2.h:123
barcode2_cfg_t::tx_pin
pin_name_t tx_pin
Definition: barcode2.h:118
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:99
barcode2_t::rst
digital_out_t rst
Definition: barcode2.h:98
barcode2_cfg_t::rx_pin
pin_name_t rx_pin
Definition: barcode2.h:117
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:122
barcode2_cfg_t::baud_rate
uint32_t baud_rate
Definition: barcode2.h:127
barcode2_cfg_t::uart_blocking
bool uart_blocking
Definition: barcode2.h:128
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:103
DRV_TX_BUFFER_SIZE
#define DRV_TX_BUFFER_SIZE
Definition: barcode2.h:82
barcode2_error_t
uint8_t barcode2_error_t
Error type.
Definition: barcode2.h:138
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.