barcode  2.0.0.0
barcode.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 BARCODE_H
36 #define BARCODE_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 BARCODE_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 BARCODE_RETVAL uint8_t
64 
65 #define BARCODE_OK 0x00
66 #define BARCODE_INIT_ERROR 0xFF
67 
73 #define BARCODE_LOGIC_ON 0x00
74 #define BARCODE_LOGIC_OFF 0x01
75  // End group macro
78 // --------------------------------------------------------------- PUBLIC TYPES
86 typedef struct
87 {
88  // Output pins
89 
90  digital_out_t rst;
91  digital_out_t trg;
92 
93  // Modules
94 
95  uart_t uart;
96 
97  char uart_rx_buffer[ 500 ];
98  char uart_tx_buffer[ 500 ];
99 
100 } barcode_t;
101 
105 typedef struct
106 {
107  // Communication gpio pins
108 
109  pin_name_t rx_pin;
110  pin_name_t tx_pin;
111 
112  // Additional gpio pins
113 
114  pin_name_t rst;
115  pin_name_t trg;
116 
117  // static variable
118 
119  uint32_t baud_rate; // Clock speed.
121  uart_data_bits_t data_bit; // Data bits.
122  uart_parity_t parity_bit; // Parity bit.
123  uart_stop_bits_t stop_bit; // Stop bits.
124 
125 } barcode_cfg_t;
126 
130 typedef uint8_t barcode_error_t;
131  // End types group
133 
134 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
135 
141 #ifdef __cplusplus
142 extern "C"{
143 #endif
144 
153 void barcode_cfg_setup ( barcode_cfg_t *cfg );
154 
163 
169 void barcode_enable_scaning ( barcode_t *ctx, uint8_t state );
170 
177 void barcode_generic_write ( barcode_t *ctx, char *data_buf, uint16_t len );
178 
186 uint16_t barcode_generic_read ( barcode_t *ctx, char *data_buf, uint16_t max_len );
187 
188 #ifdef __cplusplus
189 }
190 #endif
191 #endif // _BARCODE_H_
192  // End public_function group
195 
196 // ------------------------------------------------------------------------ END
barcode_t
Click ctx object definition.
Definition: barcode.h:86
barcode_cfg_t::parity_bit
uart_parity_t parity_bit
Definition: barcode.h:122
barcode_cfg_t::uart_blocking
bool uart_blocking
Definition: barcode.h:120
barcode_cfg_setup
void barcode_cfg_setup(barcode_cfg_t *cfg)
Config Object Initialization function.
barcode_t::uart
uart_t uart
Definition: barcode.h:95
barcode_t::rst
digital_out_t rst
Definition: barcode.h:90
barcode_cfg_t::rst
pin_name_t rst
Definition: barcode.h:114
barcode_t::trg
digital_out_t trg
Definition: barcode.h:91
barcode_cfg_t
Click configuration structure definition.
Definition: barcode.h:105
barcode_init
BARCODE_RETVAL barcode_init(barcode_t *ctx, barcode_cfg_t *cfg)
Initialization function.
barcode_cfg_t::tx_pin
pin_name_t tx_pin
Definition: barcode.h:110
barcode_cfg_t::data_bit
uart_data_bits_t data_bit
Definition: barcode.h:121
barcode_enable_scaning
void barcode_enable_scaning(barcode_t *ctx, uint8_t state)
Set WKP ( wake-up ) pin state.
barcode_cfg_t::trg
pin_name_t trg
Definition: barcode.h:115
barcode_cfg_t::baud_rate
uint32_t baud_rate
Definition: barcode.h:119
BARCODE_RETVAL
#define BARCODE_RETVAL
Definition: barcode.h:63
barcode_cfg_t::stop_bit
uart_stop_bits_t stop_bit
Definition: barcode.h:123
barcode_error_t
uint8_t barcode_error_t
Error type.
Definition: barcode.h:130
barcode_generic_read
uint16_t barcode_generic_read(barcode_t *ctx, char *data_buf, uint16_t max_len)
Generic read function.
barcode_generic_write
void barcode_generic_write(barcode_t *ctx, char *data_buf, uint16_t len)
Generic write function.
barcode_cfg_t::rx_pin
pin_name_t rx_pin
Definition: barcode.h:109