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 "mikrosdk_version.h"
36 
37 #ifdef __GNUC__
38 #if mikroSDK_GET_VERSION < 20800ul
39 #include "rcu_delays.h"
40 #else
41 #include "delays.h"
42 #endif
43 #endif
44 
45 #include "drv_digital_out.h"
46 #include "drv_digital_in.h"
47 #include "drv_uart.h"
48 
70 #define RS485ISOLATOR3_TX_DRV_BUFFER_SIZE 100
71 #define RS485ISOLATOR3_RX_DRV_BUFFER_SIZE 300
72  // rs485isolator3_cmd
74 
89 #define RS485ISOLATOR3_MAP_MIKROBUS( cfg, mikrobus ) \
90  cfg.tx_pin = MIKROBUS( mikrobus, MIKROBUS_TX ); \
91  cfg.rx_pin = MIKROBUS( mikrobus, MIKROBUS_RX ); \
92  cfg.re = MIKROBUS( mikrobus, MIKROBUS_RST ); \
93  cfg.de = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
94  cfg.inv = MIKROBUS( mikrobus, MIKROBUS_INT );
95  // rs485isolator3_map // rs485isolator3
98 
103 typedef struct
104 {
105  // Output pins
106  digital_out_t re;
107  digital_out_t de;
108  digital_out_t inv;
110  // Modules
111  uart_t uart;
113  // Buffers
114  char uart_rx_buffer[ RS485ISOLATOR3_RX_DRV_BUFFER_SIZE ];
115  char uart_tx_buffer[ RS485ISOLATOR3_TX_DRV_BUFFER_SIZE ];
118 
123 typedef struct
124 {
125  // Communication gpio pins
126  pin_name_t rx_pin;
127  pin_name_t tx_pin;
129  // Additional gpio pins
130  pin_name_t re;
131  pin_name_t de;
132  pin_name_t inv;
134  // Static variable
135  uint32_t baud_rate;
137  uart_data_bits_t data_bit;
138  uart_parity_t parity_bit;
139  uart_stop_bits_t stop_bit;
142 
147 typedef enum
148 {
151 
153 
170 
185 
197 
210 err_t rs485isolator3_generic_write ( rs485isolator3_t *ctx, char *data_in, uint16_t len );
211 
224 err_t rs485isolator3_generic_read ( rs485isolator3_t *ctx, char *data_out, uint16_t len );
225 
235 
245 
255 
265 
276 
286 
298 err_t rs485isolator3_send_bit_by_bit ( rs485isolator3_t *ctx, char *command );
299 
300 #ifdef __cplusplus
301 }
302 #endif
303 #endif // RS485ISOLATOR3_H
304  // rs485isolator3
306 
307 // ------------------------------------------------------------------------ END
rs485isolator3_cfg_t::data_bit
uart_data_bits_t data_bit
Definition: rs485isolator3.h:137
RS485ISOLATOR3_OK
@ RS485ISOLATOR3_OK
Definition: rs485isolator3.h:149
rs485isolator3_cfg_t
RS485 Isolator 3 Click configuration object.
Definition: rs485isolator3.h:124
rs485isolator3_return_value_t
rs485isolator3_return_value_t
RS485 Isolator 3 Click return value data.
Definition: rs485isolator3.h:148
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:135
RS485ISOLATOR3_RX_DRV_BUFFER_SIZE
#define RS485ISOLATOR3_RX_DRV_BUFFER_SIZE
Definition: rs485isolator3.h:71
rs485isolator3_cfg_t::de
pin_name_t de
Definition: rs485isolator3.h:131
rs485isolator3_t::uart
uart_t uart
Definition: rs485isolator3.h:111
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:136
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:139
rs485isolator3_cfg_t::re
pin_name_t re
Definition: rs485isolator3.h:130
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:127
rs485isolator3_t::inv
digital_out_t inv
Definition: rs485isolator3.h:108
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:70
RS485ISOLATOR3_ERROR
@ RS485ISOLATOR3_ERROR
Definition: rs485isolator3.h:150
rs485isolator3_cfg_t::inv
pin_name_t inv
Definition: rs485isolator3.h:132
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:107
rs485isolator3_cfg_t::rx_pin
pin_name_t rx_pin
Definition: rs485isolator3.h:126
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:106
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:104
rs485isolator3_cfg_t::parity_bit
uart_parity_t parity_bit
Definition: rs485isolator3.h:138