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
32extern "C"{
33#endif
34
35#include "drv_digital_out.h"
36#include "drv_digital_in.h"
37#include "drv_uart.h"
38
60#define DRV_BUFFER_SIZE 200
61 // rs4853v3_set
63
78#define RS4853V3_MAP_MIKROBUS( cfg, mikrobus ) \
79 cfg.tx_pin = MIKROBUS( mikrobus, MIKROBUS_TX ); \
80 cfg.rx_pin = MIKROBUS( mikrobus, MIKROBUS_RX ); \
81 cfg.rw = MIKROBUS( mikrobus, MIKROBUS_PWM )
82 // rs4853v3_map // rs4853v3
85
90typedef struct
91{
92 // Output pins
93
94 digital_out_t rw;
95
96 // Modules
97
98 uart_t uart;
100 // Buffers
101
102 char uart_rx_buffer[ DRV_BUFFER_SIZE ];
103 char uart_tx_buffer[ DRV_BUFFER_SIZE ];
104
105} rs4853v3_t;
106
111typedef struct
112{
113 // Communication gpio pins
114
115 pin_name_t rx_pin;
116 pin_name_t tx_pin;
118 // Additional gpio pins
119
120 pin_name_t rw;
121
122 // Static variable
123
124 uint32_t baud_rate;
126 uart_data_bits_t data_bit;
127 uart_parity_t parity_bit;
128 uart_stop_bits_t stop_bit;
131
136typedef enum
137{
139 RS4853V3_ERROR = -1
140
142
159
175
186void rs4853v3_generic_write ( rs4853v3_t *ctx, char *data_buf, uint16_t len );
187
201err_t rs4853v3_generic_read ( rs4853v3_t *ctx, char *data_buf, uint16_t max_len );
202
209void rs4853v3_send_command ( rs4853v3_t *ctx, char *command );
210#ifdef __cplusplus
211}
212#endif
213#endif // RS4853V3_H
214 // rs4853v3
216
217// ------------------------------------------------------------------------ END
#define DRV_BUFFER_SIZE
RS485 3V3 driver buffer size.
Definition: rs4853v3.h:60
err_t rs4853v3_init(rs4853v3_t *ctx, rs4853v3_cfg_t *cfg)
RS485 3V3 initialization function.
void rs4853v3_cfg_setup(rs4853v3_cfg_t *cfg)
RS485 3V3 configuration object setup function.
void rs4853v3_send_command(rs4853v3_t *ctx, char *command)
Send command.
void rs4853v3_generic_write(rs4853v3_t *ctx, char *data_buf, uint16_t len)
RS485 3V3 data writing function.
err_t rs4853v3_generic_read(rs4853v3_t *ctx, char *data_buf, uint16_t max_len)
RS485 3V3 data reading function.
rs4853v3_return_value_t
RS485 3V3 Click return value data.
Definition: rs4853v3.h:137
@ RS4853V3_OK
Definition: rs4853v3.h:138
@ RS4853V3_ERROR
Definition: rs4853v3.h:139
RS485 3V3 Click configuration object.
Definition: rs4853v3.h:112
uint32_t baud_rate
Definition: rs4853v3.h:124
bool uart_blocking
Definition: rs4853v3.h:125
uart_data_bits_t data_bit
Definition: rs4853v3.h:126
pin_name_t tx_pin
Definition: rs4853v3.h:116
pin_name_t rx_pin
Definition: rs4853v3.h:115
uart_stop_bits_t stop_bit
Definition: rs4853v3.h:128
uart_parity_t parity_bit
Definition: rs4853v3.h:127
pin_name_t rw
Definition: rs4853v3.h:120
RS485 3V3 Click context object.
Definition: rs4853v3.h:91
uart_t uart
Definition: rs4853v3.h:98
digital_out_t rw
Definition: rs4853v3.h:94