rs4853v3  2.0.0.0
rs4853v3.h
Go to the documentation of this file.
1 /****************************************************************************
2 ** Copyright (C) 2020 MikroElektronika d.o.o.
3 ** Contact: https://www.mikroe.com/contact
4 **
5 ** Permission is hereby granted, free of charge, to any person obtaining a copy
6 ** of this software and associated documentation files (the "Software"), to deal
7 ** in the Software without restriction, including without limitation the rights
8 ** to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9 ** copies of the Software, and to permit persons to whom the Software is
10 ** furnished to do so, subject to the following conditions:
11 ** The above copyright notice and this permission notice shall be
12 ** included in all copies or substantial portions of the Software.
13 **
14 ** THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
15 ** EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
16 ** OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
17 ** IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
18 ** DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
19 ** OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
20 ** USE OR OTHER DEALINGS IN THE SOFTWARE.
21 ****************************************************************************/
22 
28 #ifndef RS4853V3_H
29 #define RS4853V3_H
30 
31 #ifdef __cplusplus
32 extern "C"{
33 #endif
34 
39 #ifdef PREINIT_SUPPORTED
40 #include "preinit.h"
41 #endif
42 
43 #ifdef MikroCCoreVersion
44  #if MikroCCoreVersion >= 1
45  #include "delays.h"
46  #endif
47 #endif
48 
49 #include "drv_digital_out.h"
50 #include "drv_digital_in.h"
51 #include "drv_uart.h"
52 
74 #define DRV_BUFFER_SIZE 200
75  // rs4853v3_set
77 
92 #define RS4853V3_MAP_MIKROBUS( cfg, mikrobus ) \
93  cfg.tx_pin = MIKROBUS( mikrobus, MIKROBUS_TX ); \
94  cfg.rx_pin = MIKROBUS( mikrobus, MIKROBUS_RX ); \
95  cfg.rw = MIKROBUS( mikrobus, MIKROBUS_PWM )
96  // rs4853v3_map // rs4853v3
99 
104 typedef struct
105 {
106  // Output pins
107 
108  digital_out_t rw;
109 
110  // Modules
111 
112  uart_t uart;
114  // Buffers
115 
116  char uart_rx_buffer[ DRV_BUFFER_SIZE ];
117  char uart_tx_buffer[ DRV_BUFFER_SIZE ];
118 
119 } rs4853v3_t;
120 
125 typedef struct
126 {
127  // Communication gpio pins
128 
129  pin_name_t rx_pin;
130  pin_name_t tx_pin;
132  // Additional gpio pins
133 
134  pin_name_t rw;
135 
136  // Static variable
137 
138  uint32_t baud_rate;
140  uart_data_bits_t data_bit;
141  uart_parity_t parity_bit;
142  uart_stop_bits_t stop_bit;
145 
150 typedef enum
151 {
153  RS4853V3_ERROR = -1
154 
156 
173 
189 
200 void rs4853v3_generic_write ( rs4853v3_t *ctx, char *data_buf, uint16_t len );
201 
215 err_t rs4853v3_generic_read ( rs4853v3_t *ctx, char *data_buf, uint16_t max_len );
216 
223 void rs4853v3_send_command ( rs4853v3_t *ctx, char *command );
224 #ifdef __cplusplus
225 }
226 #endif
227 #endif // RS4853V3_H
228  // rs4853v3
230 
231 // ------------------------------------------------------------------------ END
rs4853v3_cfg_t::stop_bit
uart_stop_bits_t stop_bit
Definition: rs4853v3.h:142
rs4853v3_cfg_t::rx_pin
pin_name_t rx_pin
Definition: rs4853v3.h:129
rs4853v3_send_command
void rs4853v3_send_command(rs4853v3_t *ctx, char *command)
Send command.
rs4853v3_generic_read
err_t rs4853v3_generic_read(rs4853v3_t *ctx, char *data_buf, uint16_t max_len)
RS485 3V3 data reading function.
rs4853v3_cfg_t
RS485 3V3 Click configuration object.
Definition: rs4853v3.h:126
rs4853v3_cfg_t::data_bit
uart_data_bits_t data_bit
Definition: rs4853v3.h:140
rs4853v3_t
RS485 3V3 Click context object.
Definition: rs4853v3.h:105
rs4853v3_t::uart
uart_t uart
Definition: rs4853v3.h:112
rs4853v3_init
err_t rs4853v3_init(rs4853v3_t *ctx, rs4853v3_cfg_t *cfg)
RS485 3V3 initialization function.
rs4853v3_return_value_t
rs4853v3_return_value_t
RS485 3V3 Click return value data.
Definition: rs4853v3.h:151
rs4853v3_cfg_setup
void rs4853v3_cfg_setup(rs4853v3_cfg_t *cfg)
RS485 3V3 configuration object setup function.
rs4853v3_generic_write
void rs4853v3_generic_write(rs4853v3_t *ctx, char *data_buf, uint16_t len)
RS485 3V3 data writing function.
rs4853v3_cfg_t::baud_rate
uint32_t baud_rate
Definition: rs4853v3.h:138
rs4853v3_cfg_t::tx_pin
pin_name_t tx_pin
Definition: rs4853v3.h:130
rs4853v3_cfg_t::uart_blocking
bool uart_blocking
Definition: rs4853v3.h:139
rs4853v3_cfg_t::parity_bit
uart_parity_t parity_bit
Definition: rs4853v3.h:141
RS4853V3_OK
@ RS4853V3_OK
Definition: rs4853v3.h:152
RS4853V3_ERROR
@ RS4853V3_ERROR
Definition: rs4853v3.h:153
DRV_BUFFER_SIZE
#define DRV_BUFFER_SIZE
RS485 3V3 driver buffer size.
Definition: rs4853v3.h:74
rs4853v3_cfg_t::rw
pin_name_t rw
Definition: rs4853v3.h:134
rs4853v3_t::rw
digital_out_t rw
Definition: rs4853v3.h:108