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 "mikrosdk_version.h"
39 
40 #ifdef __GNUC__
41 #if mikroSDK_GET_VERSION < 20800ul
42 #include "rcu_delays.h"
43 #else
44 #include "delays.h"
45 #endif
46 #endif
47 
48 #include "drv_digital_out.h"
49 #include "drv_uart.h"
50 
51 // -------------------------------------------------------------- PUBLIC MACROS
61 #define BARCODE_MAP_MIKROBUS( cfg, mikrobus ) \
62  cfg.tx_pin = MIKROBUS( mikrobus, MIKROBUS_TX ); \
63  cfg.rx_pin = MIKROBUS( mikrobus, MIKROBUS_RX ); \
64  cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
65  cfg.trg = MIKROBUS( mikrobus, MIKROBUS_PWM )
66 
72 #define BARCODE_RETVAL int8_t
73 
74 #define BARCODE_OK 0
75 #define BARCODE_INIT_ERROR (-1)
76 
82 #define BARCODE_LOGIC_ON 0x00
83 #define BARCODE_LOGIC_OFF 0x01
84  // End group macro
87 // --------------------------------------------------------------- PUBLIC TYPES
95 typedef struct
96 {
97  // Output pins
98 
99  digital_out_t rst;
100  digital_out_t trg;
101 
102  // Modules
103 
104  uart_t uart;
105 
106  char uart_rx_buffer[ 300 ];
107  char uart_tx_buffer[ 300 ];
108 
109 } barcode_t;
110 
114 typedef struct
115 {
116  // Communication gpio pins
117 
118  pin_name_t rx_pin;
119  pin_name_t tx_pin;
120 
121  // Additional gpio pins
122 
123  pin_name_t rst;
124  pin_name_t trg;
125 
126  // static variable
127 
128  uint32_t baud_rate; // Clock speed.
130  uart_data_bits_t data_bit; // Data bits.
131  uart_parity_t parity_bit; // Parity bit.
132  uart_stop_bits_t stop_bit; // Stop bits.
133 
134 } barcode_cfg_t;
135  // End types group
137 
138 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
139 
145 #ifdef __cplusplus
146 extern "C"{
147 #endif
148 
158 
167 
173 void barcode_enable_scaning ( barcode_t *ctx, uint8_t state );
174 
181 void barcode_generic_write ( barcode_t *ctx, char *data_buf, uint16_t len );
182 
190 uint16_t barcode_generic_read ( barcode_t *ctx, char *data_buf, uint16_t max_len );
191 
192 #ifdef __cplusplus
193 }
194 #endif
195 #endif // BARCODE_H
196  // End public_function group // End click Driver group
199 
200 // ------------------------------------------------------------------------ END
barcode_t
Click ctx object definition.
Definition: barcode.h:96
barcode_cfg_t::parity_bit
uart_parity_t parity_bit
Definition: barcode.h:131
barcode_cfg_t::uart_blocking
bool uart_blocking
Definition: barcode.h:129
barcode_cfg_setup
void barcode_cfg_setup(barcode_cfg_t *cfg)
Config Object Initialization function.
barcode_t::uart
uart_t uart
Definition: barcode.h:104
barcode_t::rst
digital_out_t rst
Definition: barcode.h:99
barcode_cfg_t::rst
pin_name_t rst
Definition: barcode.h:123
barcode_t::trg
digital_out_t trg
Definition: barcode.h:100
barcode_cfg_t
Click configuration structure definition.
Definition: barcode.h:115
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:119
barcode_cfg_t::data_bit
uart_data_bits_t data_bit
Definition: barcode.h:130
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:124
barcode_cfg_t::baud_rate
uint32_t baud_rate
Definition: barcode.h:128
BARCODE_RETVAL
#define BARCODE_RETVAL
Definition: barcode.h:72
barcode_cfg_t::stop_bit
uart_stop_bits_t stop_bit
Definition: barcode.h:132
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:118