Symbols

Files

Summary Syntax Arguments Examples References Call Tree Data Use

SourceVuESP-IDF Framework and ExamplesESP-IDFesp_bt_gap_set_pin()

esp_bt_gap_set_pin() function

Set pin type and default pin code for legacy pairing.

Syntax

Show:

Summary

Declaration

from esp_gap_bt_api.h:806

esp_err_t esp_bt_gap_set_pin(esp_bt_pin_type_t pin_type, uint8_t pin_code_len, esp_bt_pin_code_t pin_code);

Arguments

Argument

Description

pin_type

Use variable or fixed pin. If pin_type is ESP_BT_PIN_TYPE_VARIABLE, pin_code and pin_code_len will be ignored, and ESP_BT_GAP_PIN_REQ_EVT will come when control requests for pin code. Else, will use fixed pin code and not callback to users.

pin_code_len

Length of pin_code

pin_code

Pin_code

Return value

- ESP_OK : success - ESP_ERR_INVALID_STATE: if bluetooth stack is not yet enabled - other : failed

Examples

esp_bt_gap_set_pin() is referenced by 14 libraries and example projects:

esp_hid_device sample

esp_hid_host sample

a2dp_sink sample

a2dp_source sample

bt_hid_mouse_device sample

bt_l2cap_client sample

bt_l2cap_server sample

bt_spp_acceptor sample

bt_spp_initiator sample

bt_spp_vfs_acceptor sample

bt_spp_vfs_initiator sample

hfp_ag sample

hfp_hf sample

a2dp_gatts_coex sample

References

from 0/14 examples

Code

Location

esp_err_t esp_bt_gap_set_pin(esp_bt_pin_type_t pin_type, uint8_t pin_code_len, esp_bt_pin_code_t pin_code)

esp_gap_bt_api.c:269

esp_err_t esp_bt_gap_set_pin(esp_bt_pin_type_t pin_type, uint8_t pin_code_len, esp_bt_pin_code_t pin_code);

esp_gap_bt_api.h:806

Call Tree

from 0/14 examples

esp_bt_gap_set_pin() calls 2 functions:

esp_bt_gap_set_pin()

btc_transfer_context()

esp_bluedroid_get_status()

Data Use

from 0/14 examples

esp_bt_gap_set_pin() reads 10 variables and writes 5 variables:

btc_sig_t::BTC_SIG_API_CALL

btc_pid_t::BTC_PID_GAP_BT

esp_bluedroid_status_t::ESP_BLUEDROID_STATUS_ENABLED

bt_status_t::BT_STATUS_SUCCESS

esp_bt_pin_type_t::ESP_BT_PIN_TYPE_FIXED

btc_gap_bt_act_t::BTC_GAP_BT_ACT_SET_PIN_TYPE

set_pin_type_args::pin_code

btc_gap_bt_args_t::set_pin_type

btc_gap_bt_arg_deep_copy()

btc_gap_bt_arg_deep_free()

esp_bt_gap_set_pin()

btc_msg::sig

btc_msg::pid

btc_msg::act

set_pin_type_args::pin_type

set_pin_type_args::pin_code_len

Class Tree

from 0/14 examples

All items filtered out

Override Tree

from 0/14 examples

All items filtered out

Implementations

from 0/14 examples

All items filtered out

Instances

from 0/14 examples

Lifecycle

from 0/14 examples

All items filtered out