GAP Application event decoders

GAP Application event decoders. More...

Functions
uint32_t	ble_gap_evt_auth_key_request_dec (uint8_t const *const p_buf, uint32_t packet_len, ble_evt_t *const p_event, uint32_t *const p_event_len)
	Decodes ble_gap_evt_auth_key_request event. More...
uint32_t	ble_gap_evt_auth_status_dec (uint8_t const *const p_buf, uint32_t packet_len, ble_evt_t *const p_event, uint32_t *const p_event_len)
	Decodes ble_gap_evt_auth_status event. More...
uint32_t	ble_gap_evt_conn_param_update_dec (uint8_t const *const p_buf, uint32_t packet_len, ble_evt_t *const p_event, uint32_t *const p_event_len)
	Decodes ble_gap_evt_conn_param_update event. More...
uint32_t	ble_gap_evt_conn_sec_update_dec (uint8_t const *const p_buf, uint32_t packet_len, ble_evt_t *const p_event, uint32_t *const p_event_len)
	Decodes ble_gap_evt_conn_sec_update event. More...
uint32_t	ble_gap_evt_connected_dec (uint8_t const *const p_buf, uint32_t packet_len, ble_evt_t *const p_event, uint32_t *const p_event_len)
	Decodes ble_gap_evt_connected event. More...
uint32_t	ble_gap_evt_disconnected_dec (uint8_t const *const p_buf, uint32_t packet_len, ble_evt_t *const p_event, uint32_t *const p_event_len)
	Decodes ble_gap_evt_disconnected event. More...
uint32_t	ble_gap_evt_passkey_display_dec (uint8_t const *const p_buf, uint32_t packet_len, ble_evt_t *const p_event, uint32_t *const p_event_len)
	Decodes ble_gap_evt_passkey_display event. More...
uint32_t	ble_gap_evt_rssi_changed_dec (uint8_t const *const p_buf, uint32_t packet_len, ble_evt_t *const p_event, uint32_t *const p_event_len)
	Decodes ble_gap_evt_rssi_changed event. More...
uint32_t	ble_gap_evt_sec_info_request_dec (uint8_t const *const p_buf, uint32_t packet_len, ble_evt_t *const p_event, uint32_t *const p_event_len)
	Decodes ble_gap_evt_sec_info_request event. More...
uint32_t	ble_gap_evt_sec_params_request_dec (uint8_t const *const p_buf, uint32_t packet_len, ble_evt_t *const p_event, uint32_t *const p_event_len)
	Decodes ble_gap_evt_sec_params_request event. More...
uint32_t	ble_gap_evt_timeout_dec (uint8_t const *const p_buf, uint32_t packet_len, ble_evt_t *const p_event, uint32_t *const p_event_len)
	Decodes ble_gap_evt_timeout event. More...
uint32_t	ble_gap_evt_sec_request_dec (uint8_t const *const p_buf, uint32_t packet_len, ble_evt_t *const p_event, uint32_t *const p_event_len)
	Decodes ble_gap_evt_sec_request event. More...
uint32_t	ble_gap_evt_conn_param_update_request_dec (uint8_t const *const p_buf, uint32_t packet_len, ble_evt_t *const p_event, uint32_t *const p_event_len)
	Decodes ble_gap_evt_conn_param_update_request event. More...
uint32_t	ble_gap_evt_adv_report_dec (uint8_t const *const p_buf, uint32_t packet_len, ble_evt_t *const p_event, uint32_t *const p_event_len)
	Decodes ble_gap_evt_adv_report event. More...
uint32_t	ble_gap_evt_scan_req_report_dec (uint8_t const *const p_buf, uint32_t packet_len, ble_evt_t *const p_event, uint32_t *const p_event_len)
	Decodes ble_gap_evt_scan_req_report event. More...

Detailed Description

GAP Application event decoders.

Function Documentation

uint32_t ble_gap_evt_adv_report_dec	(	uint8_t const *const	p_buf,
		uint32_t	packet_len,
		ble_evt_t *const	p_event,
		uint32_t *const	p_event_len
	)

Decodes ble_gap_evt_adv_report event.

See Also

0x1B - BLE_GAP_EVT_ADV_REPORT for packet format.

If p_event is null, the required length of p_event is returned in p_event_len.

Parameters

[in]	p_buf	Pointer to the beginning of an event packet.
[in]	packet_len	Length (in bytes) of the event packet.
[in,out]	p_event	Pointer to a ble_evt_t buffer where the decoded event will be stored. If NULL, required length will be returned in p_event_len.
[in,out]	p_event_len	in: Size (in bytes) of p_event buffer. out: Length of decoded contents of p_event.

Return values

NRF_SUCCESS	Decoding success.
NRF_ERROR_NULL	Decoding failure. NULL pointer supplied.
NRF_ERROR_INVALID_LENGTH	Decoding failure. Incorrect buffer length.
NRF_ERROR_DATA_SIZE	Decoding failure. Length of p_event is too small to hold decoded event.

uint32_t ble_gap_evt_auth_key_request_dec	(	uint8_t const *const	p_buf,
		uint32_t	packet_len,
		ble_evt_t *const	p_event,
		uint32_t *const	p_event_len
	)

Decodes ble_gap_evt_auth_key_request event.

See Also

0x16 - BLE_GAP_EVT_AUTH_KEY_REQUEST for packet format.

If p_event is null, the required length of p_event is returned in p_event_len.

Parameters

[in]	p_buf	Pointer to the beginning of an event packet.
[in]	packet_len	Length (in bytes) of the event packet.
[in,out]	p_event	Pointer to a ble_evt_t buffer where the decoded event will be stored. If NULL, required length will be returned in p_event_len.
[in,out]	p_event_len	in: Size (in bytes) of p_event buffer. out: Length of decoded contents of p_event.

Return values

NRF_SUCCESS	Decoding success.
NRF_ERROR_NULL	Decoding failure. NULL pointer supplied.
NRF_ERROR_INVALID_LENGTH	Decoding failure. Incorrect buffer length.
NRF_ERROR_DATA_SIZE	Decoding failure. Length of p_event is too small to hold decoded event.

uint32_t ble_gap_evt_auth_status_dec	(	uint8_t const *const	p_buf,
		uint32_t	packet_len,
		ble_evt_t *const	p_event,
		uint32_t *const	p_event_len
	)

Decodes ble_gap_evt_auth_status event.

See Also

0x17 - BLE_GAP_EVT_AUTH_STATUS for packet format.

If p_event is null, the required length of p_event is returned in p_event_len.

Parameters

[in]	p_buf	Pointer to the beginning of an event packet.
[in]	packet_len	Length (in bytes) of the event packet.
[in,out]	p_event	Pointer to a ble_evt_t buffer where the decoded event will be stored. If NULL, required length will be returned in p_event_len.
[in,out]	p_event_len	in: Size (in bytes) of p_event buffer. out: Length of decoded contents of p_event.

Return values

NRF_SUCCESS	Decoding success.
NRF_ERROR_NULL	Decoding failure. NULL pointer supplied.
NRF_ERROR_INVALID_LENGTH	Decoding failure. Incorrect buffer length.
NRF_ERROR_DATA_SIZE	Decoding failure. Length of p_event is too small to hold decoded event.

uint32_t ble_gap_evt_conn_param_update_dec	(	uint8_t const *const	p_buf,
		uint32_t	packet_len,
		ble_evt_t *const	p_event,
		uint32_t *const	p_event_len
	)

Decodes ble_gap_evt_conn_param_update event.

See Also

0x12 - BLE_GAP_EVT_CONN_PARAM_UPDATE for packet format.

If p_event is null, the required length of p_event is returned in p_event_len.

Parameters

[in]	p_buf	Pointer to the beginning of an event packet.
[in]	packet_len	Length (in bytes) of the event packet.
[in,out]	p_event	Pointer to a ble_evt_t buffer where the decoded event will be stored. If NULL, required length will be returned in p_event_len.
[in,out]	p_event_len	in: Size (in bytes) of p_event buffer. out: Length of decoded contents of p_event.

Return values

NRF_SUCCESS	Decoding success.
NRF_ERROR_NULL	Decoding failure. NULL pointer supplied.
NRF_ERROR_INVALID_LENGTH	Decoding failure. Incorrect buffer length.
NRF_ERROR_DATA_SIZE	Decoding failure. Length of p_event is too small to hold decoded event.

uint32_t ble_gap_evt_conn_param_update_request_dec	(	uint8_t const *const	p_buf,
		uint32_t	packet_len,
		ble_evt_t *const	p_event,
		uint32_t *const	p_event_len
	)

Decodes ble_gap_evt_conn_param_update_request event.

See Also

0x1D - BLE_GAP_EVT_CONN_PARAM_UPDATE_REQUEST for packet format.

If p_event is null, the required length of p_event is returned in p_event_len.

Parameters

[in]	p_buf	Pointer to the beginning of an event packet.
[in]	packet_len	Length (in bytes) of the event packet.
[in,out]	p_event	Pointer to a ble_evt_t buffer where the decoded event will be stored. If NULL, required length will be returned in p_event_len.
[in,out]	p_event_len	in: Size (in bytes) of p_event buffer. out: Length of decoded contents of p_event.

Return values

NRF_SUCCESS	Decoding success.
NRF_ERROR_NULL	Decoding failure. NULL pointer supplied.
NRF_ERROR_INVALID_LENGTH	Decoding failure. Incorrect buffer length.
NRF_ERROR_DATA_SIZE	Decoding failure. Length of p_event is too small to hold decoded event.

uint32_t ble_gap_evt_conn_sec_update_dec	(	uint8_t const *const	p_buf,
		uint32_t	packet_len,
		ble_evt_t *const	p_event,
		uint32_t *const	p_event_len
	)

Decodes ble_gap_evt_conn_sec_update event.

See Also

0x18 - BLE_GAP_EVT_CONN_SEC_UPDATE for packet format.

If p_event is null, the required length of p_event is returned in p_event_len.

Parameters

[in]	p_buf	Pointer to the beginning of an event packet.
[in]	packet_len	Length (in bytes) of the event packet.
[in,out]	p_event	Pointer to a ble_evt_t buffer where the decoded event will be stored. If NULL, required length will be returned in p_event_len.
[in,out]	p_event_len	in: Size (in bytes) of p_event buffer. out: Length of decoded contents of p_event.

Return values

NRF_SUCCESS	Decoding success.
NRF_ERROR_NULL	Decoding failure. NULL pointer supplied.
NRF_ERROR_INVALID_LENGTH	Decoding failure. Incorrect buffer length.
NRF_ERROR_DATA_SIZE	Decoding failure. Length of p_event is too small to hold decoded event.

uint32_t ble_gap_evt_connected_dec	(	uint8_t const *const	p_buf,
		uint32_t	packet_len,
		ble_evt_t *const	p_event,
		uint32_t *const	p_event_len
	)

Decodes ble_gap_evt_connected event.

See Also

0x10 - BLE_GAP_EVT_CONNECTED for packet format.

If p_event is null, the required length of p_event is returned in p_event_len.

Parameters

[in]	p_buf	Pointer to the beginning of an event packet.
[in]	packet_len	Length (in bytes) of the event packet.
[in,out]	p_event	Pointer to a ble_evt_t buffer where the decoded event will be stored. If NULL, required length will be returned in p_event_len.
[in,out]	p_event_len	in: Size (in bytes) of p_event buffer. out: Length of decoded contents of p_event.

Return values

NRF_SUCCESS	Decoding success.
NRF_ERROR_NULL	Decoding failure. NULL pointer supplied.
NRF_ERROR_INVALID_LENGTH	Decoding failure. Incorrect buffer length.
NRF_ERROR_DATA_SIZE	Decoding failure. Length of p_event is too small to hold decoded event.

uint32_t ble_gap_evt_disconnected_dec	(	uint8_t const *const	p_buf,
		uint32_t	packet_len,
		ble_evt_t *const	p_event,
		uint32_t *const	p_event_len
	)

Decodes ble_gap_evt_disconnected event.

See Also

0x11 - BLE_GAP_EVT_DISCONNECTED for packet format.

If p_event is null, the required length of p_event is returned in p_event_len.

Parameters

[in]	p_buf	Pointer to the beginning of an event packet.
[in]	packet_len	Length (in bytes) of the event packet.
[in,out]	p_event	Pointer to a ble_evt_t buffer where the decoded event will be stored. If NULL, required length will be returned in p_event_len.
[in,out]	p_event_len	in: Size (in bytes) of p_event buffer. out: Length of decoded contents of p_event.

Return values

NRF_SUCCESS	Decoding success.
NRF_ERROR_NULL	Decoding failure. NULL pointer supplied.
NRF_ERROR_INVALID_LENGTH	Decoding failure. Incorrect buffer length.
NRF_ERROR_DATA_SIZE	Decoding failure. Length of p_event is too small to hold decoded event.

uint32_t ble_gap_evt_passkey_display_dec	(	uint8_t const *const	p_buf,
		uint32_t	packet_len,
		ble_evt_t *const	p_event,
		uint32_t *const	p_event_len
	)

Decodes ble_gap_evt_passkey_display event.

See Also

0x15 - BLE_GAP_EVT_PASSKEY_DISPLAY for packet format.

If p_event is null, the required length of p_event is returned in p_event_len.

Parameters

[in]	p_buf	Pointer to the beginning of an event packet.
[in]	packet_len	Length (in bytes) of the event packet.
[in,out]	p_event	Pointer to a ble_evt_t buffer where the decoded event will be stored. If NULL, required length will be returned in p_event_len.
[in,out]	p_event_len	in: Size (in bytes) of p_event buffer. out: Length of decoded contents of p_event.

Return values

NRF_SUCCESS	Decoding success.
NRF_ERROR_NULL	Decoding failure. NULL pointer supplied.
NRF_ERROR_INVALID_LENGTH	Decoding failure. Incorrect buffer length.
NRF_ERROR_DATA_SIZE	Decoding failure. Length of p_event is too small to hold decoded event.

uint32_t ble_gap_evt_rssi_changed_dec	(	uint8_t const *const	p_buf,
		uint32_t	packet_len,
		ble_evt_t *const	p_event,
		uint32_t *const	p_event_len
	)

Decodes ble_gap_evt_rssi_changed event.

See Also

0x1A - BLE_GAP_EVT_RSSI_CHANGED for packet format.

If p_event is null, the required length of p_event is returned in p_event_len.

Parameters

[in]	p_buf	Pointer to the beginning of an event packet.
[in]	packet_len	Length (in bytes) of the event packet.
[in,out]	p_event	Pointer to a ble_evt_t buffer where the decoded event will be stored. If NULL, required length will be returned in p_event_len.
[in,out]	p_event_len	in: Size (in bytes) of p_event buffer. out: Length of decoded contents of p_event.

Return values

NRF_SUCCESS	Decoding success.
NRF_ERROR_NULL	Decoding failure. NULL pointer supplied.
NRF_ERROR_INVALID_LENGTH	Decoding failure. Incorrect buffer length.
NRF_ERROR_DATA_SIZE	Decoding failure. Length of p_event is too small to hold decoded event.

uint32_t ble_gap_evt_scan_req_report_dec	(	uint8_t const *const	p_buf,
		uint32_t	packet_len,
		ble_evt_t *const	p_event,
		uint32_t *const	p_event_len
	)

Decodes ble_gap_evt_scan_req_report event.

See Also

0x1E - BLE_GAP_EVT_SCAN_REQ_REPORT for packet format.

If p_event is null, the required length of p_event is returned in p_event_len.

Parameters

[in]	p_buf	Pointer to the beginning of an event packet.
[in]	packet_len	Length (in bytes) of the event packet.
[in,out]	p_event	Pointer to a ble_evt_t buffer where the decoded event will be stored. If NULL, required length will be returned in p_event_len.
[in,out]	p_event_len	in: Size (in bytes) of p_event buffer. out: Length of decoded contents of p_event.

Return values

NRF_SUCCESS	Decoding success.
NRF_ERROR_NULL	Decoding failure. NULL pointer supplied.
NRF_ERROR_INVALID_LENGTH	Decoding failure. Incorrect buffer length.
NRF_ERROR_DATA_SIZE	Decoding failure. Length of p_event is too small to hold decoded event.

uint32_t ble_gap_evt_sec_info_request_dec	(	uint8_t const *const	p_buf,
		uint32_t	packet_len,
		ble_evt_t *const	p_event,
		uint32_t *const	p_event_len
	)

Decodes ble_gap_evt_sec_info_request event.

See Also

0x14 - BLE_GAP_EVT_SEC_INFO_REQUEST for packet format.

If p_event is null, the required length of p_event is returned in p_event_len.

Parameters

[in]	p_buf	Pointer to the beginning of an event packet.
[in]	packet_len	Length (in bytes) of the event packet.
[in,out]	p_event	Pointer to a ble_evt_t buffer where the decoded event will be stored. If NULL, required length will be returned in p_event_len.
[in,out]	p_event_len	in: Size (in bytes) of p_event buffer. out: Length of decoded contents of p_event.

Return values

NRF_SUCCESS	Decoding success.
NRF_ERROR_NULL	Decoding failure. NULL pointer supplied.
NRF_ERROR_INVALID_LENGTH	Decoding failure. Incorrect buffer length.
NRF_ERROR_DATA_SIZE	Decoding failure. Length of p_event is too small to hold decoded event.

uint32_t ble_gap_evt_sec_params_request_dec	(	uint8_t const *const	p_buf,
		uint32_t	packet_len,
		ble_evt_t *const	p_event,
		uint32_t *const	p_event_len
	)

Decodes ble_gap_evt_sec_params_request event.

See Also

0x13 - BLE_GAP_EVT_SEC_PARAMS_REQUEST for packet format.

If p_event is null, the required length of p_event is returned in p_event_len.

Parameters

[in]	p_buf	Pointer to the beginning of an event packet.
[in]	packet_len	Length (in bytes) of the event packet.
[in,out]	p_event	Pointer to a ble_evt_t buffer where the decoded event will be stored. If NULL, required length will be returned in p_event_len.
[in,out]	p_event_len	in: Size (in bytes) of p_event buffer. out: Length of decoded contents of p_event.

Return values

NRF_SUCCESS	Decoding success.
NRF_ERROR_NULL	Decoding failure. NULL pointer supplied.
NRF_ERROR_INVALID_LENGTH	Decoding failure. Incorrect buffer length.
NRF_ERROR_DATA_SIZE	Decoding failure. Length of p_event is too small to hold decoded event.

uint32_t ble_gap_evt_sec_request_dec	(	uint8_t const *const	p_buf,
		uint32_t	packet_len,
		ble_evt_t *const	p_event,
		uint32_t *const	p_event_len
	)

Decodes ble_gap_evt_sec_request event.

See Also

0x1C - BLE_GAP_EVT_SEC_REQUEST for packet format.

If p_event is null, the required length of p_event is returned in p_event_len.

Parameters

[in]	p_buf	Pointer to the beginning of an event packet.
[in]	packet_len	Length (in bytes) of the event packet.
[in,out]	p_event	Pointer to a ble_evt_t buffer where the decoded event will be stored. If NULL, required length will be returned in p_event_len.
[in,out]	p_event_len	in: Size (in bytes) of p_event buffer. out: Length of decoded contents of p_event.

Return values

NRF_SUCCESS	Decoding success.
NRF_ERROR_NULL	Decoding failure. NULL pointer supplied.
NRF_ERROR_INVALID_LENGTH	Decoding failure. Incorrect buffer length.
NRF_ERROR_DATA_SIZE	Decoding failure. Length of p_event is too small to hold decoded event.

uint32_t ble_gap_evt_timeout_dec	(	uint8_t const *const	p_buf,
		uint32_t	packet_len,
		ble_evt_t *const	p_event,
		uint32_t *const	p_event_len
	)

Decodes ble_gap_evt_timeout event.

See Also

0x19 - BLE_GAP_EVT_TIMEOUT for packet format.

If p_event is null, the required length of p_event is returned in p_event_len.

Parameters

[in]	p_buf	Pointer to the beginning of an event packet.
[in]	packet_len	Length (in bytes) of the event packet.
[in,out]	p_event	Pointer to a ble_evt_t buffer where the decoded event will be stored. If NULL, required length will be returned in p_event_len.
[in,out]	p_event_len	in: Size (in bytes) of p_event buffer. out: Length of decoded contents of p_event.

Return values

NRF_SUCCESS	Decoding success.
NRF_ERROR_NULL	Decoding failure. NULL pointer supplied.
NRF_ERROR_INVALID_LENGTH	Decoding failure. Incorrect buffer length.
NRF_ERROR_DATA_SIZE	Decoding failure. Length of p_event is too small to hold decoded event.