Client

GATT Profile Client Functions. More...

Modules
	Header Operations
	OBEX Header Operations.

Functions
wiced_bt_gatt_status_t	wiced_bt_gatt_configure_mtu (uint16_t conn_id, uint16_t mtu)
	Function wiced_bt_gatt_configure_mtu. More...
wiced_bt_gatt_status_t	wiced_bt_gatt_send_discover (uint16_t conn_id, wiced_bt_gatt_discovery_type_t discovery_type, wiced_bt_gatt_discovery_param_t *p_discovery_param)
	Function wiced_bt_gatt_send_discover. More...
wiced_bt_gatt_status_t	wiced_bt_gatt_send_read (uint16_t conn_id, wiced_bt_gatt_read_type_t type, wiced_bt_gatt_read_param_t *p_read)
	Function wiced_bt_gatt_send_read. More...
wiced_bt_gatt_status_t	wiced_bt_gatt_send_write (uint16_t conn_id, wiced_bt_gatt_write_type_t type, wiced_bt_gatt_value_t *p_write)
	Function wiced_bt_gatt_send_write. More...
wiced_bt_gatt_status_t	wiced_bt_gatt_send_execute_write (uint16_t conn_id, wiced_bool_t is_execute)
	Function wiced_bt_gatt_send_execute_write. More...
wiced_bt_gatt_status_t	wiced_bt_gatt_send_indication_confirm (uint16_t conn_id, uint16_t handle)
	Function wiced_bt_gatt_send_indication_confirm. More...
wiced_bt_obex_status_t	wiced_bt_obex_connect (wiced_bt_device_address_t bd_addr, uint8_t scn, uint16_t mtu, wiced_bt_obex_client_cback_t *p_cback, wiced_bt_obex_handle_t *p_handle, uint8_t *p_pkt)
	Function wiced_bt_obex_connect. More...
wiced_bt_obex_status_t	wiced_bt_obex_disconnect (wiced_bt_obex_handle_t handle, uint8_t *p_pkt)
	Function wiced_bt_obex_disconnect. More...
wiced_bt_obex_status_t	wiced_bt_obex_send_request (wiced_bt_obex_handle_t handle, wiced_bt_obex_req_code_t req_code, wiced_bt_obex_req_param_t *p_param, uint8_t *p_pkt)
	Function wiced_bt_obex_send_request. More...

Detailed Description

GATT Profile Client Functions.

OBEX Client Functions.

Client API Functions sub module for OBEX.

Function Documentation

wiced_bt_gatt_status_t wiced_bt_gatt_configure_mtu	(	uint16_t	conn_id,
		uint16_t	mtu
	)

Function wiced_bt_gatt_configure_mtu.

Configure the ATT MTU size for a connection on an LE transport. Allowed mtu range is 23 to max_mtu_size configured in wiced_bt_cfg_settings_t

Parameters

[in]	conn_id	: GATT connection handle
[in]	mtu	: New MTU size

Returns

wiced_bt_gatt_status_t

wiced_bt_gatt_status_t wiced_bt_gatt_send_discover	(	uint16_t	conn_id,
		wiced_bt_gatt_discovery_type_t	discovery_type,
		wiced_bt_gatt_discovery_param_t *	p_discovery_param
	)

Function wiced_bt_gatt_send_discover.

Start an attribute discovery on an ATT server. Discovery results are notified using GATT_DISCOVERY_RESULT_EVT ; completion is notified using GATT_DISCOVERY_CPLT_EVT of wiced_bt_gatt_cback_t.

Parameters

[in]	conn_id	: GATT connection handle
[in]	discovery_type	: Discover type
[in]	p_discovery_param	: Discover parameter

Returns

wiced_bt_gatt_status_t

wiced_bt_gatt_status_t wiced_bt_gatt_send_execute_write	(	uint16_t	conn_id,
		wiced_bool_t	is_execute
	)

Function wiced_bt_gatt_send_execute_write.

Send Execute Write request to remote ATT server.

Parameters

[in]	conn_id	: Connection handle
[in]	is_execute	: WICED_BT_TRUE to execute, WICED_BT_FALSE to cancel

Returns

wiced_bt_gatt_status_t

wiced_bt_gatt_status_t wiced_bt_gatt_send_indication_confirm	(	uint16_t	conn_id,
		uint16_t	handle
	)

Function wiced_bt_gatt_send_indication_confirm.

Send a handle value confirmation to remote ATT server. (in response to GATTC_OPTYPE_INDICATION of wiced_bt_gatt_cback_t)

Parameters

[in]	conn_id	: Connection handle
[in]	handle	: Attribute handle

Returns

wiced_bt_gatt_status_t

wiced_bt_gatt_status_t wiced_bt_gatt_send_read	(	uint16_t	conn_id,
		wiced_bt_gatt_read_type_t	type,
		wiced_bt_gatt_read_param_t *	p_read
	)

Function wiced_bt_gatt_send_read.

Read from remote ATT server. Result is notified using GATT_OPERATION_CPLT_EVT of wiced_bt_gatt_cback_t.

Parameters

[in]	conn_id	: Connection handle
[in]	type	: Type of the read
[in]	p_read	: Pointer to the read request parameters

Returns

wiced_bt_gatt_status_t

wiced_bt_gatt_status_t wiced_bt_gatt_send_write	(	uint16_t	conn_id,
		wiced_bt_gatt_write_type_t	type,
		wiced_bt_gatt_value_t *	p_write
	)

Function wiced_bt_gatt_send_write.

Write to remote ATT server. Result is notified using GATT_OPERATION_CPLT_EVT of wiced_bt_gatt_cback_t.

Parameters

[in]	conn_id	: Connection handle
[in]	type	: Type of write
[in]	p_write	: Pointer to the write parameters

Returns

wiced_bt_gatt_status_t

wiced_bt_obex_status_t wiced_bt_obex_connect	(	wiced_bt_device_address_t	bd_addr,
		uint8_t	scn,
		uint16_t	mtu,
		wiced_bt_obex_client_cback_t *	p_cback,
		wiced_bt_obex_handle_t *	p_handle,
		uint8_t *	p_pkt
	)

Function wiced_bt_obex_connect.

This function registers a client entity to OBEX and sends a CONNECT request to the server

Parameters

[in]	bd_addr	: Remote server BD address
[in]	scn	: Remote server SCN
[in]	mtu	: MTU
[in]	p_cback	: Pointer to client event callback function
[out]	p_handle	: Pointer to return client connection handle
[in]	p_pkt	: Connect request packet

Returns

wiced_bt_obex_status_t

wiced_bt_obex_status_t wiced_bt_obex_disconnect	(	wiced_bt_obex_handle_t	handle,
		uint8_t *	p_pkt
	)

Function wiced_bt_obex_disconnect.

This function disconnects the server and unregister the client entity.

Parameters

[in]	handle	: Client connection handle
[in]	p_pkt	: Disconnect request packet

Returns

wiced_bt_obex_status_t

wiced_bt_obex_status_t wiced_bt_obex_send_request	(	wiced_bt_obex_handle_t	handle,
		wiced_bt_obex_req_code_t	req_code,
		wiced_bt_obex_req_param_t *	p_param,
		uint8_t *	p_pkt
	)

Function wiced_bt_obex_send_request.

This function sends a request to the connected server.

Parameters

[in]	handle	: Client connection handle
[in]	req_code	: Request code
[in]	p_param	: Request parameters
[in]	p_pkt	: Request packet

Returns

wiced_bt_obex_status_t