rn4870  2.0.0.0
rn4870.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 RN4870_H
36 #define RN4870_H
37 
38 #include "drv_digital_out.h"
39 #include "drv_digital_in.h"
40 #include "drv_uart.h"
41 
42 
43 // -------------------------------------------------------------- PUBLIC MACROS
53 #define RN4870_MAP_MIKROBUS( cfg, mikrobus ) \
54  cfg.tx_pin = MIKROBUS( mikrobus, MIKROBUS_TX ); \
55  cfg.rx_pin = MIKROBUS( mikrobus, MIKROBUS_RX ); \
56  cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
57  cfg.uart_rts = MIKROBUS( mikrobus, MIKROBUS_CS ); \
58  cfg.pwm = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
59  cfg.uart_cts = MIKROBUS( mikrobus, MIKROBUS_INT )
60 
66 #define RN4870_RETVAL uint8_t
67 
68 #define RN4870_OK 0x00
69 #define RN4870_INIT_ERROR 0xFF
70 
76 #define DRV_RX_BUFFER_SIZE 500
77 
83 #define RN4870_DEVICETYPE_MASTER 0x01
84 #define RN4870_DEVICETYPE_SLAVE 0x02
85 #define RN4870_ID_MASTER 0x35
86 #define RN4870_ID_SLAVE 0x32
87 #define RN4870_MTYPE_MSG 'M'
88 #define RN4870_DTYPE_STRING 0x5331
89  // End group macro
91 // --------------------------------------------------------------- PUBLIC TYPES
99 typedef struct
100 {
101  // Output pins
102 
103  digital_out_t rst;
104  digital_out_t uart_rts;
105  digital_out_t pwm;
106 
107  // Input pins
108 
109  digital_in_t uart_cts;
110 
111  // Modules
112 
113  uart_t uart;
114 
115  char uart_rx_buffer[ DRV_RX_BUFFER_SIZE ];
116  char uart_tx_buffer[ DRV_RX_BUFFER_SIZE ];
117 
118  char device_buffer[ 255 ];
119  uint8_t end_flag;
120  uint8_t sen_flag;
121  uint8_t tmp_pos;
122 
123 } rn4870_t;
124 
128 typedef struct
129 {
130  // Communication gpio pins
131 
132  pin_name_t rx_pin;
133  pin_name_t tx_pin;
134 
135  // Additional gpio pins
136 
137  pin_name_t rst;
138  pin_name_t uart_rts;
139  pin_name_t pwm;
140  pin_name_t uart_cts;
141 
142  // static variable
143 
144  uint32_t baud_rate; // Clock speed.
146  uart_data_bits_t data_bit; // Data bits.
147  uart_parity_t parity_bit; // Parity bit.
148  uart_stop_bits_t stop_bit; // Stop bits.
149 
150 } rn4870_cfg_t;
151  // End types group
153 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
154 
160 #ifdef __cplusplus
161 extern "C"{
162 #endif
163 
172 void rn4870_cfg_setup ( rn4870_cfg_t *cfg );
173 
183 
191 void rn4870_default_cfg ( rn4870_t *ctx );
192 
204 void rn4870_reset ( rn4870_t *ctx );
205 
215 void rn4870_generic_write ( rn4870_t *ctx, char *data_buf, uint16_t len );
216 
226 int16_t rn4870_generic_read ( rn4870_t *ctx, char *data_buf, uint16_t max_len );
227 
236 void rn4870_uart_write ( rn4870_t *ctx, uint8_t *tx_data );
237 
249 void rn4870_initialize ( rn4870_t *ctx, char *dev_addr );
250 
260 void rn4870_connect ( rn4870_t *ctx, char *dev_addr );
261 
270 void rn4870_disconnect ( rn4870_t *ctx );
271 
283 void rn4870_send ( rn4870_t *ctx, uint8_t msg_type, uint16_t data_type, uint8_t dev_id, uint8_t *tx_data );
284 
296 void rn4870_receive ( rn4870_t *ctx, char character );
297 
314 uint8_t rn4870_read ( rn4870_t *ctx, uint8_t *rx_data );
315 
325 uint8_t rn4870_get_interrupt ( rn4870_t *ctx );
326 
334 void rn4870_set_rst ( rn4870_t *ctx );
335 
343 void rn4870_clear_rst ( rn4870_t *ctx );
344 
352 void rn4870_set_rts ( rn4870_t *ctx );
353 
361 void rn4870_clear_rts ( rn4870_t *ctx );
362 
370 void rn4870_set_pwm ( rn4870_t *ctx );
371 
379 void rn4870_clear_pwm ( rn4870_t *ctx );
380 
381 #ifdef __cplusplus
382 }
383 #endif
384 #endif // _RN4870_H_
385  // End public_function group
388 
389 // ------------------------------------------------------------------------- END
rn4870_cfg_t::uart_cts
pin_name_t uart_cts
Definition: rn4870.h:140
DRV_RX_BUFFER_SIZE
#define DRV_RX_BUFFER_SIZE
Definition: rn4870.h:76
rn4870_generic_write
void rn4870_generic_write(rn4870_t *ctx, char *data_buf, uint16_t len)
Generic write function.
rn4870_clear_rst
void rn4870_clear_rst(rn4870_t *ctx)
Clear states of RST pin function.
rn4870_default_cfg
void rn4870_default_cfg(rn4870_t *ctx)
Click Default Configuration function.
rn4870_initialize
void rn4870_initialize(rn4870_t *ctx, char *dev_addr)
Initialization RN4870 module.
rn4870_set_rts
void rn4870_set_rts(rn4870_t *ctx)
Set states of RTS pin function.
rn4870_init
RN4870_RETVAL rn4870_init(rn4870_t *ctx, rn4870_cfg_t *cfg)
Initialization function.
rn4870_t::uart_cts
digital_in_t uart_cts
Definition: rn4870.h:109
rn4870_cfg_t::uart_blocking
bool uart_blocking
Definition: rn4870.h:145
rn4870_t::uart
uart_t uart
Definition: rn4870.h:113
rn4870_t::tmp_pos
uint8_t tmp_pos
Definition: rn4870.h:121
rn4870_t::uart_rts
digital_out_t uart_rts
Definition: rn4870.h:104
rn4870_cfg_t::tx_pin
pin_name_t tx_pin
Definition: rn4870.h:133
rn4870_receive
void rn4870_receive(rn4870_t *ctx, char character)
Receiving character function.
rn4870_t::end_flag
uint8_t end_flag
Definition: rn4870.h:119
rn4870_connect
void rn4870_connect(rn4870_t *ctx, char *dev_addr)
Connecting to slave device.
rn4870_cfg_t::stop_bit
uart_stop_bits_t stop_bit
Definition: rn4870.h:148
RN4870_RETVAL
#define RN4870_RETVAL
Definition: rn4870.h:66
rn4870_cfg_t::rst
pin_name_t rst
Definition: rn4870.h:137
rn4870_reset
void rn4870_reset(rn4870_t *ctx)
Hardware reset function.
rn4870_cfg_t::uart_rts
pin_name_t uart_rts
Definition: rn4870.h:138
rn4870_cfg_t::rx_pin
pin_name_t rx_pin
Definition: rn4870.h:132
rn4870_t::rst
digital_out_t rst
Definition: rn4870.h:103
rn4870_send
void rn4870_send(rn4870_t *ctx, uint8_t msg_type, uint16_t data_type, uint8_t dev_id, uint8_t *tx_data)
Send message function.
rn4870_cfg_t
Click configuration structure definition.
Definition: rn4870.h:128
rn4870_uart_write
void rn4870_uart_write(rn4870_t *ctx, uint8_t *tx_data)
UART write function.
rn4870_t
Click ctx object definition.
Definition: rn4870.h:99
rn4870_cfg_t::data_bit
uart_data_bits_t data_bit
Definition: rn4870.h:146
rn4870_get_interrupt
uint8_t rn4870_get_interrupt(rn4870_t *ctx)
Get interrupt state function.
rn4870_disconnect
void rn4870_disconnect(rn4870_t *ctx)
Disconnecting from slave device.
rn4870_read
uint8_t rn4870_read(rn4870_t *ctx, uint8_t *rx_data)
Read received message function.
rn4870_clear_rts
void rn4870_clear_rts(rn4870_t *ctx)
Clear states of RTS pin function.
rn4870_cfg_setup
void rn4870_cfg_setup(rn4870_cfg_t *cfg)
Config Object Initialization function.
rn4870_cfg_t::baud_rate
uint32_t baud_rate
Definition: rn4870.h:144
rn4870_cfg_t::parity_bit
uart_parity_t parity_bit
Definition: rn4870.h:147
rn4870_clear_pwm
void rn4870_clear_pwm(rn4870_t *ctx)
Clear states of PWM pin function.
rn4870_set_rst
void rn4870_set_rst(rn4870_t *ctx)
Set states of RST pin to high function.
rn4870_t::sen_flag
uint8_t sen_flag
Definition: rn4870.h:120
rn4870_cfg_t::pwm
pin_name_t pwm
Definition: rn4870.h:139
rn4870_generic_read
int16_t rn4870_generic_read(rn4870_t *ctx, char *data_buf, uint16_t max_len)
Generic read function.
rn4870_t::pwm
digital_out_t pwm
Definition: rn4870.h:105
rn4870_set_pwm
void rn4870_set_pwm(rn4870_t *ctx)
Set states of PWM pin function.