ipc_bt

BT Service. More...

Data Structures
struct	a_ipc_dyn_array_enum_bt_result
	Dynamic-length array of a_ipc_enum_bt_result. More...
struct	a_ipc_dyn_array_enum_bt_state
	Dynamic-length array of a_ipc_enum_bt_state. More...
struct	a_ipc_msg_bt_request_req
	Request BT service. More...
struct	a_ipc_msg_bt_request_rsp
	Request BT service request response. More...
struct	a_ipc_msg_bt_release_req_norsp
	Release BT service. More...
struct	a_ipc_msg_bt_publish_ind
	BT status publish event. More...
struct	a_ipc_msg_bt_subscribe_req
	Subscribe to updates for bt. More...
struct	a_ipc_msg_bt_subscribe_rsp
	Sent in response to a_ipc_msg_bt_subscribe_req. More...
struct	a_ipc_msg_bt_unsubscribe_req_norsp
	Unsubscribe from updates for bt. More...

Enumerations
enum	a_ipc_enum_bt_result { A_IPC_ENUM_BT_RESULT_OK , A_IPC_ENUM_BT_RESULT_ERROR }
	BT result codes. More...
enum	a_ipc_enum_bt_state {   A_IPC_ENUM_BT_STATE_UNKNOWN , A_IPC_ENUM_BT_STATE_STOP , A_IPC_ENUM_BT_STATE_RESET , A_IPC_ENUM_BT_STATE_STARTING ,   A_IPC_ENUM_BT_STATE_STARTED , A_IPC_ENUM_BT_STATE_ERROR }
	btmgr state More...

Functions
A_IPC_RESULT	a_ipc_init_bt_request_req (a_ipc_msg *msg)
	Initialize the message buffer to contain a_ipc_msg_bt_request_req. More...
A_IPC_RESULT	a_ipc_init_bt_request_rsp (a_ipc_msg *msg)
	Initialize the message buffer to contain a_ipc_msg_bt_request_rsp. More...
A_IPC_RESULT	a_ipc_init_bt_release_req_norsp (a_ipc_msg *msg)
	Initialize the message buffer to contain a_ipc_msg_bt_release_req_norsp. More...
A_IPC_RESULT	a_ipc_init_bt_publish_ind (a_ipc_msg *msg)
	Initialize the message buffer to contain a_ipc_msg_bt_publish_ind. More...
A_IPC_RESULT	a_ipc_init_bt_subscribe_req (a_ipc_msg *msg)
	Initialize the message buffer to contain a_ipc_msg_bt_subscribe_req. More...
A_IPC_RESULT	a_ipc_init_bt_subscribe_rsp (a_ipc_msg *msg)
	Initialize the message buffer to contain a_ipc_msg_bt_subscribe_rsp. More...
A_IPC_RESULT	a_ipc_init_bt_unsubscribe_req_norsp (a_ipc_msg *msg)
	Initialize the message buffer to contain a_ipc_msg_bt_unsubscribe_req_norsp. More...

Detailed Description

BT Service.

This page contains documentation of the bluetooth API.

---

Data Structure Documentation

a_ipc_dyn_array_enum_bt_result

struct a_ipc_dyn_array_enum_bt_result

Dynamic-length array of a_ipc_enum_bt_result.

Data Fields
uint32_t	length	Length of the array (number of elements)
a_ipc_enum_bt_result *	value	The contents of the array.

a_ipc_dyn_array_enum_bt_state

struct a_ipc_dyn_array_enum_bt_state

Dynamic-length array of a_ipc_enum_bt_state.

Data Fields
uint32_t	length	Length of the array (number of elements)
a_ipc_enum_bt_state *	value	The contents of the array.

a_ipc_msg_bt_request_req

struct a_ipc_msg_bt_request_req

Request BT service.

Response is delivered in a_ipc_msg_bt_request_rsp.

Create using a_ipc_init_bt_request_req().

Message type is A_IPC_MSG_BT_REQUEST_REQ.

a_ipc_msg_bt_request_rsp

struct a_ipc_msg_bt_request_rsp

Request BT service request response.

Sent in response to a_ipc_msg_bt_request_req.

Create using a_ipc_init_bt_request_rsp().

Message type is A_IPC_MSG_BT_REQUEST_RSP.

Data Fields
a_ipc_enum_bt_result	result	Result of the operation.

a_ipc_msg_bt_release_req_norsp

struct a_ipc_msg_bt_release_req_norsp

Release BT service.

Create using a_ipc_init_bt_release_req_norsp().

Message type is A_IPC_MSG_BT_RELEASE_REQ_NORSP.

a_ipc_msg_bt_publish_ind

struct a_ipc_msg_bt_publish_ind

BT status publish event.

This status message is sent periodically.

Subscribe using a_ipc_msg_bt_subscribe_req and unsubscribe using a_ipc_msg_bt_unsubscribe_req_norsp.

Create using a_ipc_init_bt_publish_ind().

Message type is A_IPC_MSG_BT_PUBLISH_IND.

Data Fields
a_ipc_enum_bt_state	state	Current state of the service.

a_ipc_msg_bt_subscribe_req

struct a_ipc_msg_bt_subscribe_req

Subscribe to updates for bt.

a_ipc_msg_bt_publish_ind will be received until a_ipc_msg_bt_unsubscribe_req_norsp is sent.

Response is delivered in a_ipc_msg_bt_subscribe_rsp.

Create using a_ipc_init_bt_subscribe_req().

Message type is A_IPC_MSG_BT_SUBSCRIBE_REQ.

a_ipc_msg_bt_subscribe_rsp

struct a_ipc_msg_bt_subscribe_rsp

Sent in response to a_ipc_msg_bt_subscribe_req.

Create using a_ipc_init_bt_subscribe_rsp().

Message type is A_IPC_MSG_BT_SUBSCRIBE_RSP.

Data Fields
a_ipc_enum_ipc_subscribe_result	result	The result of the subscription request.

a_ipc_msg_bt_unsubscribe_req_norsp

struct a_ipc_msg_bt_unsubscribe_req_norsp

Unsubscribe from updates for bt.

a_ipc_msg_bt_publish_ind will no longer be received.

Create using a_ipc_init_bt_unsubscribe_req_norsp().

Message type is A_IPC_MSG_BT_UNSUBSCRIBE_REQ_NORSP.

Enumeration Type Documentation

a_ipc_enum_bt_result

enum a_ipc_enum_bt_result

BT result codes.

Enumerator
A_IPC_ENUM_BT_RESULT_OK	OK result.
A_IPC_ENUM_BT_RESULT_ERROR	Error result.

a_ipc_enum_bt_state

enum a_ipc_enum_bt_state

btmgr state

Enumerator
A_IPC_ENUM_BT_STATE_UNKNOWN	Unknown / Invalid state.
A_IPC_ENUM_BT_STATE_STOP	Service is stopped.
A_IPC_ENUM_BT_STATE_RESET	Service is resetting.
A_IPC_ENUM_BT_STATE_STARTING	Service is starting.
A_IPC_ENUM_BT_STATE_STARTED	Service is started and available.
A_IPC_ENUM_BT_STATE_ERROR	Service has reached an unrecoverable error state.

Function Documentation

a_ipc_init_bt_publish_ind()

A_IPC_RESULT a_ipc_init_bt_publish_ind

(

a_ipc_msg *

msg

)

Initialize the message buffer to contain a_ipc_msg_bt_publish_ind.

msg->info.type will be A_IPC_MSG_BT_PUBLISH_IND.

This function can be called on an already initialized message to change its type.

Parameters

msg	The message buffer to initialize

a_ipc_init_bt_release_req_norsp()

A_IPC_RESULT a_ipc_init_bt_release_req_norsp

(

a_ipc_msg *

msg

)

Initialize the message buffer to contain a_ipc_msg_bt_release_req_norsp.

msg->info.type will be A_IPC_MSG_BT_RELEASE_REQ_NORSP.

This function can be called on an already initialized message to change its type.

Parameters

msg	The message buffer to initialize

a_ipc_init_bt_request_req()

A_IPC_RESULT a_ipc_init_bt_request_req

(

a_ipc_msg *

msg

)

Initialize the message buffer to contain a_ipc_msg_bt_request_req.

msg->info.type will be A_IPC_MSG_BT_REQUEST_REQ.

This function can be called on an already initialized message to change its type.

Parameters

msg	The message buffer to initialize

a_ipc_init_bt_request_rsp()

A_IPC_RESULT a_ipc_init_bt_request_rsp

(

a_ipc_msg *

msg

)

Initialize the message buffer to contain a_ipc_msg_bt_request_rsp.

msg->info.type will be A_IPC_MSG_BT_REQUEST_RSP.

This function can be called on an already initialized message to change its type.

Parameters

msg	The message buffer to initialize

a_ipc_init_bt_subscribe_req()

A_IPC_RESULT a_ipc_init_bt_subscribe_req

(

a_ipc_msg *

msg

)

Initialize the message buffer to contain a_ipc_msg_bt_subscribe_req.

msg->info.type will be A_IPC_MSG_BT_SUBSCRIBE_REQ.

This function can be called on an already initialized message to change its type.

Parameters

msg	The message buffer to initialize

a_ipc_init_bt_subscribe_rsp()

A_IPC_RESULT a_ipc_init_bt_subscribe_rsp

(

a_ipc_msg *

msg

)

Initialize the message buffer to contain a_ipc_msg_bt_subscribe_rsp.

msg->info.type will be A_IPC_MSG_BT_SUBSCRIBE_RSP.

This function can be called on an already initialized message to change its type.

Parameters

msg	The message buffer to initialize

a_ipc_init_bt_unsubscribe_req_norsp()

A_IPC_RESULT a_ipc_init_bt_unsubscribe_req_norsp

(

a_ipc_msg *

msg

)

Initialize the message buffer to contain a_ipc_msg_bt_unsubscribe_req_norsp.

msg->info.type will be A_IPC_MSG_BT_UNSUBSCRIBE_REQ_NORSP.

This function can be called on an already initialized message to change its type.

Parameters

msg	The message buffer to initialize

Variable Documentation

result [1/2]

a_ipc_enum_bt_result a_ipc_msg_bt_request_rsp::result

Result of the operation.

result [2/2]

a_ipc_enum_ipc_subscribe_result a_ipc_msg_bt_subscribe_rsp::result

The result of the subscription request.

state

a_ipc_enum_bt_state a_ipc_msg_bt_publish_ind::state

Current state of the service.