ble_gap_disc

int
ble_gap_disc(
                             uint8_t  own_addr_type,
                             int32_t  duration_ms,
    const struct ble_gap_disc_params *disc_params,
                    ble_gap_event_fn *cb,
                                void *cb_arg
)

Description

Performs the Limited or General Discovery Procedures.

Parameters

ParameterDescription
own_addr_typeThe type of address the stack should use for itself when sending scan requests. Valid values are: BLE_ADDR_TYPE_PUBLIC BLE_ADDR_TYPE_RANDOM BLE_ADDR_TYPE_RPA_PUB_DEFAULT BLE_ADDR_TYPE_RPA_RND_DEFAULT This parameter is ignored unless active scanning is being used.
duration_msThe duration of the discovery procedure. On expiration, the procedure ends and a BLE_GAP_EVENT_DISC_COMPLETE event is reported. Units are milliseconds. Specify BLE_HS_FOREVER for no expiration.
disc_paramsAdditional arguments specifying the particulars of the discovery procedure.
cbThe callback to associate with this discovery procedure. Advertising reports and discovery termination events are reported through this callback.
cb_argThe optional argument to pass to the callback function.

Returned values

ValueCondition
0Success.
Core return codeUnexpected error.