rn4678
2.0.0.0
|
Functions | |
void | rn4678_cfg_setup (rn4678_cfg_t *cfg) |
Config Object Initialization function. More... | |
RN4678_RETVAL | rn4678_init (rn4678_t *ctx, rn4678_cfg_t *cfg) |
Initialization function. More... | |
void | rn4678_generic_write (rn4678_t *ctx, char *data_buf, uint16_t len) |
Generic write function. More... | |
int32_t | rn4678_generic_read (rn4678_t *ctx, char *data_buf, uint16_t max_len) |
Generic read function. More... | |
void | rn4678_write_command (rn4678_t *ctx, char *data_buf, uint16_t len) |
Write command function. More... | |
void | rn4678_set_cts_pin (rn4678_t *ctx, uint8_t state) |
CTS Pin Setting function. More... | |
void | rn4678_enable (rn4678_t *ctx) |
Enable device function. More... | |
void | rn4678_hw_reset (rn4678_t *ctx) |
Hardwere reset function. More... | |
void | rn4678_enter_command_mode (rn4678_t *ctx) |
Enter the command mode function. More... | |
void | rn4678_exit_command_mode (rn4678_t *ctx) |
Exit the command mode function. More... | |
void | rn4678_toggle_echo (rn4678_t *ctx) |
Toggles echo function. More... | |
void | rn4678_set_device_name (rn4678_t *ctx, uint8_t *name) |
Set the device name function. More... | |
void | rn4678_set_operating_mode (rn4678_t *ctx, uint8_t op_mode) |
Set the operating mode function. More... | |
void | rn4678_enable_7_bit_data_mode (rn4678_t *ctx) |
Enable 7-Bit data mode function. More... | |
void | rn4678_disable_7_bit_data_mode (rn4678_t *ctx) |
Disable 7-Bit data mode function. More... | |
void | rn4678_set_authentication (rn4678_t *ctx, uint8_t auth_value) |
Set the authentication function. More... | |
void | rn4678_set_break (rn4678_t *ctx, uint8_t break_signal) |
Set the break function. More... | |
RN4678_RETVAL | rn4678_set_cod (rn4678_t *ctx, uint8_t *msw, uint8_t *lsw) |
Sets the class of device (COD) function. More... | |
void | rn4678_set_factory_defaults (rn4678_t *ctx) |
Set factory defaults settings function. More... | |
void | rn4678_set_discoverability (rn4678_t *ctx, uint8_t *d_hex_value) |
Set enable an inquiry scan function. More... | |
void | rn4678_setConnectability (rn4678_t *ctx, uint8_t *c_hex_value) |
Set enable page scanning function. More... | |
RN4678_RETVAL | rn4678_set_uart_parity (rn4678_t *ctx, uint8_t character) |
Set UART parity function. More... | |
void | rn4678_set_extended_status_string (rn4678_t *ctx, uint8_t *es_string) |
Set extended status string function. More... | |
RN4678_RETVAL | rn4678_set_security_pin_code (rn4678_t *ctx, uint8_t *sp_code) |
Set security pin code function. More... | |
RN4678_RETVAL | rn4678_set_special_config (rn4678_t *ctx, uint16_t special_config) |
Set special configuration settings function. More... | |
void | rn4678_set_remote_address (rn4678_t *ctx, uint8_t *r_addr) |
Set the remote Bluetooth address function. More... | |
RN4678_RETVAL | rn4678_set_baud_rate (rn4678_t *ctx, uint32_t baud_rate) |
Set the baud rate function. More... | |
void | rn4678_enable_bonding (rn4678_t *ctx) |
Set bonding enable function. More... | |
void | rn4678_disable_bonding (rn4678_t *ctx) |
Set bonding disable function. More... | |
void | rn4678_reboot (rn4678_t *ctx) |
Reboot the module function. More... | |
RN4678_RETVAL | rn4678_set_profile (rn4678_t *ctx, uint8_t profile) |
Set the profile function. More... | |
void | rn4678_enable_role_switch (rn4678_t *ctx) |
Enables the role switch function. More... | |
void | rn4678_disable_role_switch (rn4678_t *ctx) |
Disables the role switch function. More... | |
void | rn4678_connect_to_remote_address (rn4678_t *ctx, uint8_t *r_addr) |
Connect the device to a remote address function. More... | |
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. More... | |
void | rn4678_endspecial_config (rn4678_t *ctx) |
Ends configuration and puts the device into fast data mode function. More... | |
void | rn4678_get_help (rn4678_t *ctx) |
Get displays a list of help command function. More... | |
void | rn4678_get_basic_settings (rn4678_t *ctx) |
Get displays basic settings function. More... | |
void | rn4678_get_extended_settings (rn4678_t *ctx) |
Get displays the device�s extended settings function. More... | |
void | rn4678_get_device_address (rn4678_t *ctx) |
Get displays the device�s eBluetooth address function. More... | |
void | rn4678_scans_device (rn4678_t *ctx) |
Scans for Bluetooth devices in pairing mode function. More... | |
void | rn4678_get_signal_status (rn4678_t *ctx) |
Displays the remote side modem signal status function. More... | |
void | rn4678_set_undiscoverable (rn4678_t *ctx) |
Set undiscoverable mode function. More... | |
RN4678_RETVAL | rn4678_set_quiet_mode (rn4678_t *ctx, uint8_t q_mode) |
Set quiet mode function. More... | |
void | rn4678_get_firmware_version (rn4678_t *ctx) |
Get firmware version function. More... | |
void rn4678_cfg_setup | ( | rn4678_cfg_t * | cfg | ) |
Config Object Initialization function.
cfg | Click configuration structure. |
@description This function initializes Click configuration structure to init state.
void rn4678_connect_to_remote_address | ( | rn4678_t * | ctx, |
uint8_t * | r_addr | ||
) |
Connect the device to a remote address function.
ctx | Click object. |
r_addr | Pointer to the memory location where the remote address string be stored |
@description The function connect the device to a remote address to the RN-4678 Bluetooth module on RN4678 Click board.
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.
ctx | Click object. |
r_addr | Pointer to the memory location where the remote address string be stored |
@description The function connect the device to a remote address fast mode to the RN-4678 Bluetooth module on RN4678 Click board.
void rn4678_disable_7_bit_data_mode | ( | rn4678_t * | ctx | ) |
Disable 7-Bit data mode function.
ctx | Click object. |
@description The function disable 7-Bit data mode of the RN-4678 Bluetooth module on RN4678 Click board.
void rn4678_disable_bonding | ( | rn4678_t * | ctx | ) |
Set bonding disable function.
ctx | Click object. |
@description The function set bonding disable of the RN-4678 Bluetooth module on RN4678 Click board.
void rn4678_disable_role_switch | ( | rn4678_t * | ctx | ) |
Disables the role switch function.
ctx | Click object. |
@description The function disables the role switch of the RN-4678 Bluetooth module on RN4678 Click board.
void rn4678_enable | ( | rn4678_t * | ctx | ) |
Enable device function.
ctx | Click object. |
@description The function enable RN-4678 Bluetooth module on RN4678 Click board by set to '1' state of RST pin.
void rn4678_enable_7_bit_data_mode | ( | rn4678_t * | ctx | ) |
Enable 7-Bit data mode function.
ctx | Click object. |
@description The function enable 7-Bit data mode of the RN-4678 Bluetooth module on RN4678 Click board.
void rn4678_enable_bonding | ( | rn4678_t * | ctx | ) |
Set bonding enable function.
ctx | Click object. |
@description The function set bonding enable of the RN-4678 Bluetooth module on RN4678 Click board.
void rn4678_enable_role_switch | ( | rn4678_t * | ctx | ) |
Enables the role switch function.
ctx | Click object. |
@description The function enables the role switch of the RN-4678 Bluetooth module on RN4678 Click board.
void rn4678_endspecial_config | ( | rn4678_t * | ctx | ) |
Ends configuration and puts the device into fast data mode function.
ctx | Click object. |
@description The function ends configuration and puts the device into fast data mode to the RN-4678 Bluetooth module on RN4678 Click board.
void rn4678_enter_command_mode | ( | rn4678_t * | ctx | ) |
Enter the command mode function.
ctx | Click object. |
@description The function enter the command mode of the RN-4678 Bluetooth module on RN4678 Click board.
void rn4678_exit_command_mode | ( | rn4678_t * | ctx | ) |
Exit the command mode function.
ctx | Click object. |
@description The function exit the command mode of the RN-4678 Bluetooth module on RN4678 Click board.
int32_t rn4678_generic_read | ( | rn4678_t * | ctx, |
char * | data_buf, | ||
uint16_t | max_len | ||
) |
Generic read function.
rn4678 | Click object. |
data_buf | Data buffer for read data. |
max_len | The maximum length of data that can be read. |
void rn4678_generic_write | ( | rn4678_t * | ctx, |
char * | data_buf, | ||
uint16_t | len | ||
) |
Generic write function.
rn4678 | Click object. |
data_buf | Data buffer for sends. |
len | Number of bytes for sends. |
void rn4678_get_basic_settings | ( | rn4678_t * | ctx | ) |
Get displays basic settings function.
ctx | Click object. |
@description The function get displays basic settings of the RN-4678 Bluetooth module on RN4678 Click board.
void rn4678_get_device_address | ( | rn4678_t * | ctx | ) |
Get displays the device�s eBluetooth address function.
ctx | Click object. |
@description The function get displays the Bluetooth address of the RN-4678 Bluetooth module on RN4678 Click board.
void rn4678_get_extended_settings | ( | rn4678_t * | ctx | ) |
Get displays the device�s extended settings function.
ctx | Click object. |
@description The function get displays the device�s extended settings of the RN-4678 Bluetooth module on RN4678 Click board.
void rn4678_get_firmware_version | ( | rn4678_t * | ctx | ) |
Get firmware version function.
ctx | Click object. |
@description The function get firmware version of the RN-4678 Bluetooth module on RN4678 Click board.
void rn4678_get_help | ( | rn4678_t * | ctx | ) |
Get displays a list of help command function.
ctx | Click object. |
@description The function get displays a list of help command of the RN-4678 Bluetooth module on RN4678 Click board.
void rn4678_get_signal_status | ( | rn4678_t * | ctx | ) |
Displays the remote side modem signal status function.
ctx | Click object. |
@description The function displays the remote side modem signal status of the RN-4678 Bluetooth module on RN4678 Click board.
void rn4678_hw_reset | ( | rn4678_t * | ctx | ) |
Hardwere reset function.
ctx | Click object. |
@description The function hardwere reset RN-4678 Bluetooth module on RN4678 Click board by cleared to '0' state of RST pin, weit 200 ms, set to '1' state of RST pin and weit 1 sec.
RN4678_RETVAL rn4678_init | ( | rn4678_t * | ctx, |
rn4678_cfg_t * | cfg | ||
) |
Initialization function.
rn4678 | Click object. |
cfg | Click configuration structure. |
@description This function initializes all necessary pins and peripherals used for this Click.
void rn4678_reboot | ( | rn4678_t * | ctx | ) |
Reboot the module function.
ctx | Click object. |
@description The function set bonding disable of the RN-4678 Bluetooth module on RN4678 Click board.
void rn4678_scans_device | ( | rn4678_t * | ctx | ) |
Scans for Bluetooth devices in pairing mode function.
ctx | Click object. |
@description The function scans for Bluetooth devices in pairing mode of the RN-4678 Bluetooth module on RN4678 Click board.
void rn4678_set_authentication | ( | rn4678_t * | ctx, |
uint8_t | auth_value | ||
) |
Set the authentication function.
ctx | Click object. |
auth_value |
|
@description The function set the authentication value to the RN-4678 Bluetooth module on RN4678 Click board.
RN4678_RETVAL rn4678_set_baud_rate | ( | rn4678_t * | ctx, |
uint32_t | baud_rate | ||
) |
Set the baud rate function.
ctx | Click object. |
baud_rate | Baud rate :
|
status | 0 - ERROR; 1 - OK; |
@description The function set the baud rate value to the RN-4678 Bluetooth module on RN4678 Click board.
void rn4678_set_break | ( | rn4678_t * | ctx, |
uint8_t | break_signal | ||
) |
Set the break function.
ctx | Click object. |
break_signal | Break Length :
|
@description The function set the break signal length to the RN-4678 Bluetooth module on RN4678 Click board.
RN4678_RETVAL rn4678_set_cod | ( | rn4678_t * | ctx, |
uint8_t * | msw, | ||
uint8_t * | lsw | ||
) |
Sets the class of device (COD) function.
ctx | Click object. |
msw | Pointer to the memory location where the msw hex value be stored |
lsw | Pointer to the memory location where the lsw hex value be stored |
status | 0 - ERROR; 1 - OK; |
@description The function set the bthe class of device (COD) to the RN-4678 Bluetooth module on RN4678 Click board.
void rn4678_set_cts_pin | ( | rn4678_t * | ctx, |
uint8_t | state | ||
) |
CTS Pin Setting function.
ctx | Click object. |
state | 0 - Low, 1 (or other value different from 0) - High |
@description This function sets the CTS pin to the desired state
( UART clear to send control signal ).
void rn4678_set_device_name | ( | rn4678_t * | ctx, |
uint8_t * | name | ||
) |
Set the device name function.
ctx | Click object. |
name | Pointer to the memory location where the name be stored |
@description The function set the device name of the RN-4678 Bluetooth module on RN4678 Click board.
void rn4678_set_discoverability | ( | rn4678_t * | ctx, |
uint8_t * | d_hex_value | ||
) |
Set enable an inquiry scan function.
ctx | Click object. |
d_hex_value | Pointer to the memory loc. where the discoverability hex value be stored |
@description The function set enable an inquiry scan to the RN-4678 Bluetooth module on RN4678 Click board.
void rn4678_set_extended_status_string | ( | rn4678_t * | ctx, |
uint8_t * | es_string | ||
) |
Set extended status string function.
ctx | Click object. |
es_string | Pointer to the memory location where the extended status string be stored |
@description The function set extended status string to the RN-4678 Bluetooth module on RN4678 Click board.
void rn4678_set_factory_defaults | ( | rn4678_t * | ctx | ) |
Set factory defaults settings function.
ctx | Click object. |
@description The function set factory defaults settings to the RN-4678 Bluetooth module on RN4678 Click board.
void rn4678_set_operating_mode | ( | rn4678_t * | ctx, |
uint8_t | op_mode | ||
) |
Set the operating mode function.
ctx | Click object. |
op_mode |
|
@description The function sets the operating mode of the RN-4678 Bluetooth module on RN4678 Click board.
RN4678_RETVAL rn4678_set_profile | ( | rn4678_t * | ctx, |
uint8_t | profile | ||
) |
Set the profile function.
ctx | Click object. |
profile | Profile :
|
status | 0 - ERROR; 1 - OK; |
@description The function set the profile of the RN-4678 Bluetooth module on RN4678 Click board.
RN4678_RETVAL rn4678_set_quiet_mode | ( | rn4678_t * | ctx, |
uint8_t | q_mode | ||
) |
Set quiet mode function.
ctx | Click object. |
q_mode |
|
status | 0 - ERROR; 1 - OK; |
@description The function set quiet mode of the RN-4678 Bluetooth module on RN4678 Click board.
void rn4678_set_remote_address | ( | rn4678_t * | ctx, |
uint8_t * | r_addr | ||
) |
Set the remote Bluetooth address function.
ctx | Click object. |
r_addr | Pointer to the memory location where the remote address string be stored |
@description The function stores the remote Bluetooth address to the RN-4678 Bluetooth module on RN4678 Click board.
RN4678_RETVAL rn4678_set_security_pin_code | ( | rn4678_t * | ctx, |
uint8_t * | sp_code | ||
) |
Set security pin code function.
ctx | Click object. |
sp_code | Pointer to the memory location where the security pin code string be stored |
status | 0 - ERROR; 1 - OK; |
@description The function set security pin code string to the RN-4678 Bluetooth module on RN4678 Click board.
RN4678_RETVAL rn4678_set_special_config | ( | rn4678_t * | ctx, |
uint16_t | special_config | ||
) |
Set special configuration settings function.
ctx | Click object. |
special_config |
|
status | 0 - ERROR; 1 - OK; |
@description The function set special configuration settings to the RN-4678 Bluetooth module on RN4678 Click board.
RN4678_RETVAL rn4678_set_uart_parity | ( | rn4678_t * | ctx, |
uint8_t | character | ||
) |
Set UART parity function.
ctx | Click object. |
character | UART parity values:
|
status | 0 - ERROR; 1 - OK; |
@description The function set UART parity to the RN-4678 Bluetooth module on RN4678 Click board.
void rn4678_set_undiscoverable | ( | rn4678_t * | ctx | ) |
Set undiscoverable mode function.
ctx | Click object. |
@description The function set undiscoverable mode of the RN-4678 Bluetooth module on RN4678 Click board.
void rn4678_setConnectability | ( | rn4678_t * | ctx, |
uint8_t * | c_hex_value | ||
) |
Set enable page scanning function.
ctx | Click object. |
c_hex_value | Pointer to the memory location where the connectability hex value be stored |
@description The function set enable page scanning to the RN-4678 Bluetooth module on RN4678 Click board.
void rn4678_toggle_echo | ( | rn4678_t * | ctx | ) |
Toggles echo function.
ctx | Click object. |
@description The function toggles the local echo ON and OFF of RN-4678 Bluetooth module on RN4678 Click board.
void rn4678_write_command | ( | rn4678_t * | ctx, |
char * | data_buf, | ||
uint16_t | len | ||
) |
Write command function.
rn4678 | Click object. |
data_buf | Data buffer for sends. |
len | Number of bytes for sends. |