rs485isolator3  2.1.0.0
rs485isolator3.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 RS485ISOLATOR3_H
29 #define RS485ISOLATOR3_H
30 
31 #ifdef __cplusplus
32 extern "C"{
33 #endif
34 
35 #include "drv_digital_out.h"
36 #include "drv_digital_in.h"
37 #include "drv_uart.h"
38 
60 #define RS485ISOLATOR3_TX_DRV_BUFFER_SIZE 100
61 #define RS485ISOLATOR3_RX_DRV_BUFFER_SIZE 300
62  // rs485isolator3_cmd
64 
79 #define RS485ISOLATOR3_MAP_MIKROBUS( cfg, mikrobus ) \
80  cfg.tx_pin = MIKROBUS( mikrobus, MIKROBUS_TX ); \
81  cfg.rx_pin = MIKROBUS( mikrobus, MIKROBUS_RX ); \
82  cfg.re = MIKROBUS( mikrobus, MIKROBUS_RST ); \
83  cfg.de = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
84  cfg.inv = MIKROBUS( mikrobus, MIKROBUS_INT );
85  // rs485isolator3_map // rs485isolator3
88 
93 typedef struct
94 {
95  // Output pins
96  digital_out_t re;
97  digital_out_t de;
98  digital_out_t inv;
100  // Modules
101  uart_t uart;
103  // Buffers
104  char uart_rx_buffer[ RS485ISOLATOR3_RX_DRV_BUFFER_SIZE ];
105  char uart_tx_buffer[ RS485ISOLATOR3_TX_DRV_BUFFER_SIZE ];
108 
113 typedef struct
114 {
115  // Communication gpio pins
116  pin_name_t rx_pin;
117  pin_name_t tx_pin;
119  // Additional gpio pins
120  pin_name_t re;
121  pin_name_t de;
122  pin_name_t inv;
124  // Static variable
125  uint32_t baud_rate;
127  uart_data_bits_t data_bit;
128  uart_parity_t parity_bit;
129  uart_stop_bits_t stop_bit;
132 
137 typedef enum
138 {
141 
143 
160 
175 
187 
200 err_t rs485isolator3_generic_write ( rs485isolator3_t *ctx, char *data_in, uint16_t len );
201 
214 err_t rs485isolator3_generic_read ( rs485isolator3_t *ctx, char *data_out, uint16_t len );
215 
225 
235 
245 
255 
266 
276 
288 err_t rs485isolator3_send_bit_by_bit ( rs485isolator3_t *ctx, char *command );
289 
290 #ifdef __cplusplus
291 }
292 #endif
293 #endif // RS485ISOLATOR3_H
294  // rs485isolator3
296 
297 // ------------------------------------------------------------------------ END
rs485isolator3_cfg_t::data_bit
uart_data_bits_t data_bit
Definition: rs485isolator3.h:127
RS485ISOLATOR3_OK
@ RS485ISOLATOR3_OK
Definition: rs485isolator3.h:139
rs485isolator3_cfg_t
RS485 Isolator 3 Click configuration object.
Definition: rs485isolator3.h:114
rs485isolator3_return_value_t
rs485isolator3_return_value_t
RS485 Isolator 3 Click return value data.
Definition: rs485isolator3.h:138
rs485isolator3_inverted_inputs
void rs485isolator3_inverted_inputs(rs485isolator3_t *ctx)
RS485 Isolator 3 invert output function.
rs485isolator3_cfg_t::baud_rate
uint32_t baud_rate
Definition: rs485isolator3.h:125
RS485ISOLATOR3_RX_DRV_BUFFER_SIZE
#define RS485ISOLATOR3_RX_DRV_BUFFER_SIZE
Definition: rs485isolator3.h:61
rs485isolator3_cfg_t::de
pin_name_t de
Definition: rs485isolator3.h:121
rs485isolator3_t::uart
uart_t uart
Definition: rs485isolator3.h:101
rs485isolator3_default_cfg
void rs485isolator3_default_cfg(rs485isolator3_t *ctx)
RS485 Isolator 3 default configuration function.
rs485isolator3_init
err_t rs485isolator3_init(rs485isolator3_t *ctx, rs485isolator3_cfg_t *cfg)
RS485 Isolator 3 initialization function.
rs485isolator3_send_bit_by_bit
err_t rs485isolator3_send_bit_by_bit(rs485isolator3_t *ctx, char *command)
RS485 Isolator 3 send data function.
rs485isolator3_cfg_t::uart_blocking
bool uart_blocking
Definition: rs485isolator3.h:126
rs485isolator3_cfg_setup
void rs485isolator3_cfg_setup(rs485isolator3_cfg_t *cfg)
RS485 Isolator 3 configuration object setup function.
rs485isolator3_disable_output
void rs485isolator3_disable_output(rs485isolator3_t *ctx)
RS485 Isolator 3 disable output function.
rs485isolator3_generic_read
err_t rs485isolator3_generic_read(rs485isolator3_t *ctx, char *data_out, uint16_t len)
RS485 Isolator 3 data reading function.
rs485isolator3_cfg_t::stop_bit
uart_stop_bits_t stop_bit
Definition: rs485isolator3.h:129
rs485isolator3_cfg_t::re
pin_name_t re
Definition: rs485isolator3.h:120
rs485isolator3_disable_receiver_input
void rs485isolator3_disable_receiver_input(rs485isolator3_t *ctx)
RS485 Isolator 3 disable receiver input function.
rs485isolator3_cfg_t::tx_pin
pin_name_t tx_pin
Definition: rs485isolator3.h:117
rs485isolator3_t::inv
digital_out_t inv
Definition: rs485isolator3.h:98
rs485isolator3_generic_write
err_t rs485isolator3_generic_write(rs485isolator3_t *ctx, char *data_in, uint16_t len)
RS485 Isolator 3 data writing function.
RS485ISOLATOR3_TX_DRV_BUFFER_SIZE
#define RS485ISOLATOR3_TX_DRV_BUFFER_SIZE
RS485 Isolator 3 driver buffer size.
Definition: rs485isolator3.h:60
RS485ISOLATOR3_ERROR
@ RS485ISOLATOR3_ERROR
Definition: rs485isolator3.h:140
rs485isolator3_cfg_t::inv
pin_name_t inv
Definition: rs485isolator3.h:122
rs485isolator3_not_inverted_inputs
void rs485isolator3_not_inverted_inputs(rs485isolator3_t *ctx)
RS485 Isolator 3 not invert output function.
rs485isolator3_t::de
digital_out_t de
Definition: rs485isolator3.h:97
rs485isolator3_cfg_t::rx_pin
pin_name_t rx_pin
Definition: rs485isolator3.h:116
rs485isolator3_enable_receiver_input
void rs485isolator3_enable_receiver_input(rs485isolator3_t *ctx)
RS485 Isolator 3 enable receiver input function.
rs485isolator3_t::re
digital_out_t re
Definition: rs485isolator3.h:96
rs485isolator3_enable_output
void rs485isolator3_enable_output(rs485isolator3_t *ctx)
RS485 Isolator 3 enable output function.
rs485isolator3_t
RS485 Isolator 3 Click context object.
Definition: rs485isolator3.h:94
rs485isolator3_cfg_t::parity_bit
uart_parity_t parity_bit
Definition: rs485isolator3.h:128