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 
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_uart.h"
54 
55 // -------------------------------------------------------------- PUBLIC MACROS
65 #define BARCODE_MAP_MIKROBUS( cfg, mikrobus ) \
66  cfg.tx_pin = MIKROBUS( mikrobus, MIKROBUS_TX ); \
67  cfg.rx_pin = MIKROBUS( mikrobus, MIKROBUS_RX ); \
68  cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
69  cfg.trg = MIKROBUS( mikrobus, MIKROBUS_PWM )
70 
76 #define BARCODE_RETVAL int8_t
77 
78 #define BARCODE_OK 0
79 #define BARCODE_INIT_ERROR (-1)
80 
86 #define BARCODE_LOGIC_ON 0x00
87 #define BARCODE_LOGIC_OFF 0x01
88  // End group macro
91 // --------------------------------------------------------------- PUBLIC TYPES
99 typedef struct
100 {
101  // Output pins
102 
103  digital_out_t rst;
104  digital_out_t trg;
105 
106  // Modules
107 
108  uart_t uart;
109 
110  char uart_rx_buffer[ 300 ];
111  char uart_tx_buffer[ 300 ];
112 
113 } barcode_t;
114 
118 typedef struct
119 {
120  // Communication gpio pins
121 
122  pin_name_t rx_pin;
123  pin_name_t tx_pin;
124 
125  // Additional gpio pins
126 
127  pin_name_t rst;
128  pin_name_t trg;
129 
130  // static variable
131 
132  uint32_t baud_rate; // Clock speed.
134  uart_data_bits_t data_bit; // Data bits.
135  uart_parity_t parity_bit; // Parity bit.
136  uart_stop_bits_t stop_bit; // Stop bits.
137 
138 } barcode_cfg_t;
139  // End types group
141 
142 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
143 
149 #ifdef __cplusplus
150 extern "C"{
151 #endif
152 
162 
171 
177 void barcode_enable_scaning ( barcode_t *ctx, uint8_t state );
178 
185 void barcode_generic_write ( barcode_t *ctx, char *data_buf, uint16_t len );
186 
194 uint16_t barcode_generic_read ( barcode_t *ctx, char *data_buf, uint16_t max_len );
195 
196 #ifdef __cplusplus
197 }
198 #endif
199 #endif // BARCODE_H
200  // End public_function group // End click Driver group
203 
204 // ------------------------------------------------------------------------ END
barcode_t
Click ctx object definition.
Definition: barcode.h:100
barcode_cfg_t::parity_bit
uart_parity_t parity_bit
Definition: barcode.h:135
barcode_cfg_t::uart_blocking
bool uart_blocking
Definition: barcode.h:133
barcode_cfg_setup
void barcode_cfg_setup(barcode_cfg_t *cfg)
Config Object Initialization function.
barcode_t::uart
uart_t uart
Definition: barcode.h:108
barcode_t::rst
digital_out_t rst
Definition: barcode.h:103
barcode_cfg_t::rst
pin_name_t rst
Definition: barcode.h:127
barcode_t::trg
digital_out_t trg
Definition: barcode.h:104
barcode_cfg_t
Click configuration structure definition.
Definition: barcode.h:119
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:123
barcode_cfg_t::data_bit
uart_data_bits_t data_bit
Definition: barcode.h:134
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:128
barcode_cfg_t::baud_rate
uint32_t baud_rate
Definition: barcode.h:132
BARCODE_RETVAL
#define BARCODE_RETVAL
Definition: barcode.h:76
barcode_cfg_t::stop_bit
uart_stop_bits_t stop_bit
Definition: barcode.h:136
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:122