rn4871  2.0.0.0
rn4871.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 RN4871_H
36 #define RN4871_H
37 
38 #include "mikrosdk_version.h"
39 
40 #ifdef __GNUC__
41 #if mikroSDK_GET_VERSION < 20800ul
42 #include "rcu_delays.h"
43 #else
44 #include "delays.h"
45 #endif
46 #endif
47 
48 #include "drv_digital_out.h"
49 #include "drv_digital_in.h"
50 #include "drv_uart.h"
51 
52 // -------------------------------------------------------------- PUBLIC MACROS
62 #define RN4871_MAP_MIKROBUS( cfg, mikrobus ) \
63  cfg.tx_pin = MIKROBUS( mikrobus, MIKROBUS_TX ); \
64  cfg.rx_pin = MIKROBUS( mikrobus, MIKROBUS_RX ); \
65  cfg.rst_n = MIKROBUS( mikrobus, MIKROBUS_RST ); \
66  cfg.uart_rts = MIKROBUS( mikrobus, MIKROBUS_CS ); \
67  cfg.uart_cts = MIKROBUS( mikrobus, MIKROBUS_INT )
68 
74 #define RN4871_RETVAL uint8_t
75 
76 #define RN4871_OK 0x00
77 #define RN4871_INIT_ERROR 0xFF
78 
84 #define RN4871_DEVICETYPE_MASTER 0x02
85 #define RN4871_DEVICETYPE_SLAVE 0x03
86 
88 #define RN4871_ID_MASTER 0x35
89 #define RN4871_ID_SLAVE 0x32
90 #define RN4871_MTYPE_MSG 'M'
91 #define RN4871_DTYPE_STRING 0x5331
92 
93 
98 #define DRV_RX_BUFFER_SIZE 500
99  // End group macro
102 // --------------------------------------------------------------- PUBLIC TYPES
110 typedef struct
111 {
112  // Output pins
113 
114  digital_out_t rst_n;
115  digital_out_t uart_rts;
116 
117  // Input pins
118 
119  digital_in_t uart_cts;
120 
121  // Modules
122 
123  uart_t uart;
124 
125  char uart_rx_buffer[ DRV_RX_BUFFER_SIZE ];
126  char uart_tx_buffer[ DRV_RX_BUFFER_SIZE ];
127 
128  uint8_t end_flag;
129  uint8_t sentence_flag;
130 
131  char device_buffer[ 255 ];
133 
134 } rn4871_t;
135 
139 typedef struct
140 {
141  // Communication gpio pins
142 
143  pin_name_t rx_pin;
144  pin_name_t tx_pin;
145 
146  // Additional gpio pins
147 
148  pin_name_t rst_n;
149  pin_name_t uart_rts;
150  pin_name_t uart_cts;
151 
152  // static variable
153 
154  uint32_t baud_rate; // Clock speed.
156  uart_data_bits_t data_bit; // Data bits.
157  uart_parity_t parity_bit; // Parity bit.
158  uart_stop_bits_t stop_bit; // Stop bits.
159 
160 } rn4871_cfg_t;
161  // End types group
163 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
164 
170 #ifdef __cplusplus
171 extern "C"{
172 #endif
173 
183 
193 
205 void rn4871_reset ( rn4871_t *ctx );
206 
216 void rn4871_generic_write ( rn4871_t *ctx, char *data_buf, uint16_t len );
217 
229 int32_t rn4871_generic_read ( rn4871_t *ctx, char *data_buf, uint16_t max_len );
230 
240 uint8_t rn4871_int_get ( rn4871_t *ctx );
241 
250 void rn4871_rst_set ( rn4871_t *ctx, uint8_t pin_state );
251 
260 void rn4871_cs_set ( rn4871_t *ctx, uint8_t pin_state );
261 
270 void rn4871_uart_write ( rn4871_t *ctx, uint8_t * wr_buf );
271 
283 void rn4871_initialize ( rn4871_t *ctx, char *p_addr );
284 
294 void rn4871_connect ( rn4871_t *ctx, char *p_addr );
295 
307 void rn4871_send( rn4871_t *ctx, uint8_t msg_type, uint16_t data_type, uint8_t id, uint8_t *payload );
308 
318 
330 void rn4871_receive ( rn4871_t *ctx, char tmp );
331 
344 uint8_t rn4871_read ( rn4871_t *ctx, uint8_t *process_buffer );
345 
346 #ifdef __cplusplus
347 }
348 #endif
349 #endif // _RN4871_H_
350  // End public_function group
353 
354 // ------------------------------------------------------------------------- END
DRV_RX_BUFFER_SIZE
#define DRV_RX_BUFFER_SIZE
Definition: rn4871.h:98
rn4871_disconnect
void rn4871_disconnect(rn4871_t *ctx)
Disconnecting from slave device.
rn4871_read
uint8_t rn4871_read(rn4871_t *ctx, uint8_t *process_buffer)
Reading received message.
rn4871_reset
void rn4871_reset(rn4871_t *ctx)
Hardware reset function.
rn4871_int_get
uint8_t rn4871_int_get(rn4871_t *ctx)
Get interrupt state function.
rn4871_connect
void rn4871_connect(rn4871_t *ctx, char *p_addr)
Connecting to slave device.
rn4871_cfg_t::uart_blocking
bool uart_blocking
Definition: rn4871.h:155
rn4871_receive
void rn4871_receive(rn4871_t *ctx, char tmp)
Receiving character function.
rn4871_cfg_t::data_bit
uart_data_bits_t data_bit
Definition: rn4871.h:156
rn4871_initialize
void rn4871_initialize(rn4871_t *ctx, char *p_addr)
Initialization RN4871 module.
rn4871_uart_write
void rn4871_uart_write(rn4871_t *ctx, uint8_t *wr_buf)
UART write function.
RN4871_RETVAL
#define RN4871_RETVAL
Definition: rn4871.h:74
rn4871_cfg_t::uart_rts
pin_name_t uart_rts
Definition: rn4871.h:149
rn4871_t::rst_n
digital_out_t rst_n
Definition: rn4871.h:114
rn4871_t::sentence_flag
uint8_t sentence_flag
Definition: rn4871.h:129
rn4871_cfg_t::uart_cts
pin_name_t uart_cts
Definition: rn4871.h:150
rn4871_t::uart
uart_t uart
Definition: rn4871.h:123
rn4871_cfg_t
Click configuration structure definition.
Definition: rn4871.h:140
rn4871_generic_read
int32_t rn4871_generic_read(rn4871_t *ctx, char *data_buf, uint16_t max_len)
Generic read function.
rn4871_init
RN4871_RETVAL rn4871_init(rn4871_t *ctx, rn4871_cfg_t *cfg)
Initialization function.
rn4871_t
Click ctx object definition.
Definition: rn4871.h:111
rn4871_t::end_flag
uint8_t end_flag
Definition: rn4871.h:128
rn4871_t::uart_cts
digital_in_t uart_cts
Definition: rn4871.h:119
rn4871_cfg_t::tx_pin
pin_name_t tx_pin
Definition: rn4871.h:144
rn4871_t::uart_rts
digital_out_t uart_rts
Definition: rn4871.h:115
rn4871_cfg_t::baud_rate
uint32_t baud_rate
Definition: rn4871.h:154
rn4871_cfg_setup
void rn4871_cfg_setup(rn4871_cfg_t *cfg)
Config Object Initialization function.
rn4871_generic_write
void rn4871_generic_write(rn4871_t *ctx, char *data_buf, uint16_t len)
Generic write function.
rn4871_cfg_t::rst_n
pin_name_t rst_n
Definition: rn4871.h:148
rn4871_cfg_t::stop_bit
uart_stop_bits_t stop_bit
Definition: rn4871.h:158
rn4871_cfg_t::rx_pin
pin_name_t rx_pin
Definition: rn4871.h:143
rn4871_rst_set
void rn4871_rst_set(rn4871_t *ctx, uint8_t pin_state)
Set states of RST pin to desired state.
rn4871_send
void rn4871_send(rn4871_t *ctx, uint8_t msg_type, uint16_t data_type, uint8_t id, uint8_t *payload)
Send message function.
rn4871_cs_set
void rn4871_cs_set(rn4871_t *ctx, uint8_t pin_state)
Set states of CS pin to desired state.
rn4871_t::buffer_position
uint8_t buffer_position
Definition: rn4871.h:132
rn4871_cfg_t::parity_bit
uart_parity_t parity_bit
Definition: rn4871.h:157