rn4678  2.0.0.0
rn4678.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 RN4678_H
36 #define RN4678_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 RN4678_MAP_MIKROBUS( cfg, mikrobus ) \
54  cfg.tx_pin = MIKROBUS( mikrobus, MIKROBUS_TX ); \
55  cfg.rx_pin = MIKROBUS( mikrobus, MIKROBUS_RX ); \
56  cfg.sw_btn = MIKROBUS( mikrobus, MIKROBUS_AN ); \
57  cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
58  cfg.rts = MIKROBUS( mikrobus, MIKROBUS_CS ); \
59  cfg.wkup = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
60  cfg.cts = MIKROBUS( mikrobus, MIKROBUS_INT )
61 
67 #define RN4678_RETVAL uint8_t
68 
69 #define RN4678_INIT_OK 0x00
70 #define RN4678_INIT_ERROR 0xFF
71 
77 #define RN4678_CMD 0x01
78 #define RN4678_AOK 0x02
79 #define RN4678_CONN 0x03
80 #define RN4678_DONE 0x04
81 #define RN4678_ERR 0x00
82 #define RN4678_OK 0x01
83 
89 #define DRV_RX_BUFFER_SIZE 500
90  // End group macro
93 // --------------------------------------------------------------- PUBLIC TYPES
101 typedef struct
102 {
103  // Output pins
104 
105  digital_out_t rst;
106  digital_out_t cts;
107  digital_out_t sw_btn;
108  digital_out_t wkup;
109 
110  // Modules
111  digital_in_t rts;
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 } rn4678_t;
119 
123 typedef struct
124 {
125  // Communication gpio pins
126 
127  pin_name_t rx_pin;
128  pin_name_t tx_pin;
129 
130  // Additional gpio pins
131 
132  pin_name_t rst;
133  pin_name_t wkup;
134  pin_name_t cts;
135  pin_name_t sw_btn;
136  pin_name_t rts;
137 
138  // static variable
139 
140  uint32_t baud_rate; // Clock speed.
142  uart_data_bits_t data_bit; // Data bits.
143  uart_parity_t parity_bit; // Parity bit.
144  uart_stop_bits_t stop_bit; // Stop bits.
145 
146 } rn4678_cfg_t;
147 
151 typedef uint8_t rn4678_error_t;
152  // End types group
154 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
155 
161 #ifdef __cplusplus
162 extern "C"{
163 #endif
164 
173 void rn4678_cfg_setup ( rn4678_cfg_t *cfg );
174 
183 
190 void rn4678_generic_write ( rn4678_t *ctx, char *data_buf, uint16_t len );
191 
199 int32_t rn4678_generic_read ( rn4678_t *ctx, char *data_buf, uint16_t max_len );
200 
207 void rn4678_write_command ( rn4678_t *ctx, char *data_buf, uint16_t len );
208 
220 void rn4678_set_cts_pin ( rn4678_t *ctx, uint8_t state );
221 
230 void rn4678_enable ( rn4678_t *ctx );
231 
241 void rn4678_hw_reset ( rn4678_t *ctx );
242 
251 void rn4678_enter_command_mode ( rn4678_t *ctx );
252 
261 void rn4678_exit_command_mode ( rn4678_t *ctx );
262 
271 void rn4678_toggle_echo ( rn4678_t *ctx );
272 
282 void rn4678_set_device_name ( rn4678_t *ctx, uint8_t *name );
283 
308 void rn4678_set_operating_mode ( rn4678_t *ctx, uint8_t op_mode );
309 
319 
329 
346 void rn4678_set_authentication ( rn4678_t *ctx, uint8_t auth_value );
347 
366 void rn4678_set_break ( rn4678_t *ctx, uint8_t break_signal );
367 
380 RN4678_RETVAL rn4678_set_cod ( rn4678_t *ctx, uint8_t *msw, uint8_t *lsw );
381 
391 
401 void rn4678_set_discoverability ( rn4678_t *ctx, uint8_t *d_hex_value );
402 
412 void rn4678_setConnectability ( rn4678_t *ctx, uint8_t *c_hex_value );
413 
431 RN4678_RETVAL rn4678_set_uart_parity ( rn4678_t *ctx, uint8_t character );
432 
444 void rn4678_set_extended_status_string ( rn4678_t *ctx, uint8_t *es_string );
445 
459 RN4678_RETVAL rn4678_set_security_pin_code ( rn4678_t *ctx, uint8_t *sp_code );
460 
482 RN4678_RETVAL rn4678_set_special_config ( rn4678_t *ctx, uint16_t special_config );
483 
495 void rn4678_set_remote_address ( rn4678_t *ctx, uint8_t *r_addr );
496 
518 RN4678_RETVAL rn4678_set_baud_rate ( rn4678_t *ctx, uint32_t baud_rate );
519 
528 void rn4678_enable_bonding ( rn4678_t *ctx );
529 
538 void rn4678_disable_bonding ( rn4678_t *ctx );
539 
548 void rn4678_reboot ( rn4678_t *ctx );
549 
573 RN4678_RETVAL rn4678_set_profile ( rn4678_t *ctx, uint8_t profile );
574 
583 void rn4678_enable_role_switch ( rn4678_t *ctx );
584 
594 
604 void rn4678_connect_to_remote_address ( rn4678_t *ctx, uint8_t *r_addr );
605 
615 void rn4678_connect_to_remote_address_fast_mode ( rn4678_t *ctx, uint8_t *r_addr );
616 
625 void rn4678_endspecial_config ( rn4678_t *ctx );
626 
635 void rn4678_get_help ( rn4678_t *ctx );
636 
645 void rn4678_get_basic_settings ( rn4678_t *ctx );
646 
656 
665 void rn4678_get_device_address ( rn4678_t *ctx );
666 
675 void rn4678_scans_device ( rn4678_t *ctx );
676 
685 void rn4678_get_signal_status ( rn4678_t *ctx );
686 
695 void rn4678_set_undiscoverable ( rn4678_t *ctx );
696 
714 RN4678_RETVAL rn4678_set_quiet_mode ( rn4678_t *ctx, uint8_t q_mode );
715 
725 
726 #ifdef __cplusplus
727 }
728 #endif
729 #endif // _RN4678_H_
730  // End public_function group
733 
734 // ------------------------------------------------------------------------- END
rn4678_disable_bonding
void rn4678_disable_bonding(rn4678_t *ctx)
Set bonding disable function.
DRV_RX_BUFFER_SIZE
#define DRV_RX_BUFFER_SIZE
Definition: rn4678.h:89
rn4678_t::rts
digital_in_t rts
Definition: rn4678.h:111
rn4678_cfg_t::tx_pin
pin_name_t tx_pin
Definition: rn4678.h:128
rn4678_connect_to_remote_address_fast_mode
void rn4678_connect_to_remote_address_fast_mode(rn4678_t *ctx, uint8_t *r_addr)
Connect the device to a remote address fast mode function.
rn4678_cfg_t::sw_btn
pin_name_t sw_btn
Definition: rn4678.h:135
rn4678_reboot
void rn4678_reboot(rn4678_t *ctx)
Reboot the module function.
rn4678_get_extended_settings
void rn4678_get_extended_settings(rn4678_t *ctx)
Get displays the device�s extended settings function.
rn4678_cfg_t::parity_bit
uart_parity_t parity_bit
Definition: rn4678.h:143
rn4678_set_extended_status_string
void rn4678_set_extended_status_string(rn4678_t *ctx, uint8_t *es_string)
Set extended status string function.
rn4678_set_authentication
void rn4678_set_authentication(rn4678_t *ctx, uint8_t auth_value)
Set the authentication function.
rn4678_set_uart_parity
RN4678_RETVAL rn4678_set_uart_parity(rn4678_t *ctx, uint8_t character)
Set UART parity function.
rn4678_scans_device
void rn4678_scans_device(rn4678_t *ctx)
Scans for Bluetooth devices in pairing mode function.
rn4678_set_device_name
void rn4678_set_device_name(rn4678_t *ctx, uint8_t *name)
Set the device name function.
rn4678_t::sw_btn
digital_out_t sw_btn
Definition: rn4678.h:107
rn4678_enable_bonding
void rn4678_enable_bonding(rn4678_t *ctx)
Set bonding enable function.
rn4678_set_security_pin_code
RN4678_RETVAL rn4678_set_security_pin_code(rn4678_t *ctx, uint8_t *sp_code)
Set security pin code function.
rn4678_set_quiet_mode
RN4678_RETVAL rn4678_set_quiet_mode(rn4678_t *ctx, uint8_t q_mode)
Set quiet mode function.
rn4678_init
RN4678_RETVAL rn4678_init(rn4678_t *ctx, rn4678_cfg_t *cfg)
Initialization function.
rn4678_disable_role_switch
void rn4678_disable_role_switch(rn4678_t *ctx)
Disables the role switch function.
rn4678_endspecial_config
void rn4678_endspecial_config(rn4678_t *ctx)
Ends configuration and puts the device into fast data mode function.
rn4678_get_basic_settings
void rn4678_get_basic_settings(rn4678_t *ctx)
Get displays basic settings function.
rn4678_enable_7_bit_data_mode
void rn4678_enable_7_bit_data_mode(rn4678_t *ctx)
Enable 7-Bit data mode function.
rn4678_set_discoverability
void rn4678_set_discoverability(rn4678_t *ctx, uint8_t *d_hex_value)
Set enable an inquiry scan function.
rn4678_cfg_t::uart_blocking
bool uart_blocking
Definition: rn4678.h:141
rn4678_generic_write
void rn4678_generic_write(rn4678_t *ctx, char *data_buf, uint16_t len)
Generic write function.
rn4678_exit_command_mode
void rn4678_exit_command_mode(rn4678_t *ctx)
Exit the command mode function.
rn4678_cfg_t::cts
pin_name_t cts
Definition: rn4678.h:134
rn4678_enter_command_mode
void rn4678_enter_command_mode(rn4678_t *ctx)
Enter the command mode function.
rn4678_t::cts
digital_out_t cts
Definition: rn4678.h:106
rn4678_generic_read
int32_t rn4678_generic_read(rn4678_t *ctx, char *data_buf, uint16_t max_len)
Generic read function.
rn4678_set_remote_address
void rn4678_set_remote_address(rn4678_t *ctx, uint8_t *r_addr)
Set the remote Bluetooth address function.
rn4678_get_firmware_version
void rn4678_get_firmware_version(rn4678_t *ctx)
Get firmware version function.
rn4678_set_special_config
RN4678_RETVAL rn4678_set_special_config(rn4678_t *ctx, uint16_t special_config)
Set special configuration settings function.
rn4678_t
Click ctx object definition.
Definition: rn4678.h:101
rn4678_cfg_t::wkup
pin_name_t wkup
Definition: rn4678.h:133
rn4678_error_t
uint8_t rn4678_error_t
Error type.
Definition: rn4678.h:151
rn4678_set_baud_rate
RN4678_RETVAL rn4678_set_baud_rate(rn4678_t *ctx, uint32_t baud_rate)
Set the baud rate function.
rn4678_cfg_t::baud_rate
uint32_t baud_rate
Definition: rn4678.h:140
rn4678_get_signal_status
void rn4678_get_signal_status(rn4678_t *ctx)
Displays the remote side modem signal status function.
rn4678_disable_7_bit_data_mode
void rn4678_disable_7_bit_data_mode(rn4678_t *ctx)
Disable 7-Bit data mode function.
rn4678_set_cts_pin
void rn4678_set_cts_pin(rn4678_t *ctx, uint8_t state)
CTS Pin Setting function.
rn4678_cfg_t::stop_bit
uart_stop_bits_t stop_bit
Definition: rn4678.h:144
rn4678_set_factory_defaults
void rn4678_set_factory_defaults(rn4678_t *ctx)
Set factory defaults settings function.
rn4678_cfg_t::rts
pin_name_t rts
Definition: rn4678.h:136
rn4678_connect_to_remote_address
void rn4678_connect_to_remote_address(rn4678_t *ctx, uint8_t *r_addr)
Connect the device to a remote address function.
rn4678_set_cod
RN4678_RETVAL rn4678_set_cod(rn4678_t *ctx, uint8_t *msw, uint8_t *lsw)
Sets the class of device (COD) function.
rn4678_enable
void rn4678_enable(rn4678_t *ctx)
Enable device function.
rn4678_cfg_t::rst
pin_name_t rst
Definition: rn4678.h:132
rn4678_cfg_t
Click configuration structure definition.
Definition: rn4678.h:123
rn4678_get_help
void rn4678_get_help(rn4678_t *ctx)
Get displays a list of help command function.
rn4678_toggle_echo
void rn4678_toggle_echo(rn4678_t *ctx)
Toggles echo function.
rn4678_cfg_t::rx_pin
pin_name_t rx_pin
Definition: rn4678.h:127
rn4678_t::wkup
digital_out_t wkup
Definition: rn4678.h:108
rn4678_t::uart
uart_t uart
Definition: rn4678.h:113
rn4678_hw_reset
void rn4678_hw_reset(rn4678_t *ctx)
Hardwere reset function.
rn4678_get_device_address
void rn4678_get_device_address(rn4678_t *ctx)
Get displays the device�s eBluetooth address function.
RN4678_RETVAL
#define RN4678_RETVAL
Definition: rn4678.h:67
rn4678_set_profile
RN4678_RETVAL rn4678_set_profile(rn4678_t *ctx, uint8_t profile)
Set the profile function.
rn4678_write_command
void rn4678_write_command(rn4678_t *ctx, char *data_buf, uint16_t len)
Write command function.
rn4678_cfg_setup
void rn4678_cfg_setup(rn4678_cfg_t *cfg)
Config Object Initialization function.
rn4678_set_operating_mode
void rn4678_set_operating_mode(rn4678_t *ctx, uint8_t op_mode)
Set the operating mode function.
rn4678_enable_role_switch
void rn4678_enable_role_switch(rn4678_t *ctx)
Enables the role switch function.
rn4678_set_undiscoverable
void rn4678_set_undiscoverable(rn4678_t *ctx)
Set undiscoverable mode function.
rn4678_cfg_t::data_bit
uart_data_bits_t data_bit
Definition: rn4678.h:142
rn4678_set_break
void rn4678_set_break(rn4678_t *ctx, uint8_t break_signal)
Set the break function.
rn4678_t::rst
digital_out_t rst
Definition: rn4678.h:105
rn4678_setConnectability
void rn4678_setConnectability(rn4678_t *ctx, uint8_t *c_hex_value)
Set enable page scanning function.