ipc_bub

Back-up Battery Service. More...

Data Structures
struct	a_ipc_dyn_array_enum_bub_result
	Dynamic-length array of a_ipc_enum_bub_result. More...
struct	a_ipc_msg_bub_request_req
	Request a BUB interface. More...
struct	a_ipc_msg_bub_request_rsp
	BUB interface request result. More...
struct	a_ipc_msg_bub_release_req_norsp
	Release a BUB interface. More...
struct	a_ipc_msg_bub_status_req
	Check the state of the BUB interface. More...
struct	a_ipc_msg_bub_status_rsp
	BUB status. More...
struct	a_ipc_msg_bub_battery_temperature_req
	Request to read the battery temperature. More...
struct	a_ipc_msg_bub_battery_temperature_rsp
	Sent in response to bub_battery_temperature_req message. More...
struct	a_ipc_msg_bub_board_temperature_req
	Request to read the board temperature. More...
struct	a_ipc_msg_bub_board_temperature_rsp
	Sent in response to bub_board_temperature_req message. More...

Enumerations
enum	a_ipc_enum_bub_result { A_IPC_ENUM_BUB_RESULT_OK , A_IPC_ENUM_BUB_RESULT_NOT_AVAILABLE , A_IPC_ENUM_BUB_RESULT_ERROR_WRONG_STATE , A_IPC_ENUM_BUB_RESULT_ERROR_UNKNOWN }
	Result codes. More...

Functions
A_IPC_RESULT	a_ipc_init_bub_request_req (a_ipc_msg *msg, uint32_t user_maxlength)
	Initialize the message buffer to contain a_ipc_msg_bub_request_req. More...
A_IPC_RESULT	a_ipc_init_bub_request_rsp (a_ipc_msg *msg)
	Initialize the message buffer to contain a_ipc_msg_bub_request_rsp. More...
A_IPC_RESULT	a_ipc_init_bub_release_req_norsp (a_ipc_msg *msg, uint32_t user_maxlength)
	Initialize the message buffer to contain a_ipc_msg_bub_release_req_norsp. More...
A_IPC_RESULT	a_ipc_init_bub_status_req (a_ipc_msg *msg)
	Initialize the message buffer to contain a_ipc_msg_bub_status_req. More...
A_IPC_RESULT	a_ipc_init_bub_status_rsp (a_ipc_msg *msg)
	Initialize the message buffer to contain a_ipc_msg_bub_status_rsp. More...
A_IPC_RESULT	a_ipc_init_bub_battery_temperature_req (a_ipc_msg *msg)
	Initialize the message buffer to contain a_ipc_msg_bub_battery_temperature_req. More...
A_IPC_RESULT	a_ipc_init_bub_battery_temperature_rsp (a_ipc_msg *msg)
	Initialize the message buffer to contain a_ipc_msg_bub_battery_temperature_rsp. More...
A_IPC_RESULT	a_ipc_init_bub_board_temperature_req (a_ipc_msg *msg)
	Initialize the message buffer to contain a_ipc_msg_bub_board_temperature_req. More...
A_IPC_RESULT	a_ipc_init_bub_board_temperature_rsp (a_ipc_msg *msg)
	Initialize the message buffer to contain a_ipc_msg_bub_board_temperature_rsp. More...

Detailed Description

Back-up Battery Service.

This page contains documentation of the Back-up Battery Service API.

---

Data Structure Documentation

a_ipc_dyn_array_enum_bub_result

struct a_ipc_dyn_array_enum_bub_result

Dynamic-length array of a_ipc_enum_bub_result.

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

a_ipc_msg_bub_request_req

struct a_ipc_msg_bub_request_req

Request a BUB interface.

Response is delivered in a_ipc_msg_bub_request_rsp.

Create using a_ipc_init_bub_request_req().

Message type is A_IPC_MSG_BUB_REQUEST_REQ.

Data Fields
a_ipc_dyn_string	user	User identifier, max 15 characters long.

a_ipc_msg_bub_request_rsp

struct a_ipc_msg_bub_request_rsp

BUB interface request result.

Sent in response to a_ipc_msg_bub_request_req.

Create using a_ipc_init_bub_request_rsp().

Message type is A_IPC_MSG_BUB_REQUEST_RSP.

Data Fields
a_ipc_enum_bub_result	result	Result of the operation.

a_ipc_msg_bub_release_req_norsp

struct a_ipc_msg_bub_release_req_norsp

Release a BUB interface.

Create using a_ipc_init_bub_release_req_norsp().

Message type is A_IPC_MSG_BUB_RELEASE_REQ_NORSP.

Data Fields
a_ipc_dyn_string	user	User identifier, max 15 characters long.

a_ipc_msg_bub_status_req

struct a_ipc_msg_bub_status_req

Check the state of the BUB interface.

Response is delivered in a_ipc_msg_bub_status_rsp.

Create using a_ipc_init_bub_status_req().

Message type is A_IPC_MSG_BUB_STATUS_REQ.

a_ipc_msg_bub_status_rsp

struct a_ipc_msg_bub_status_rsp

BUB status.

Sent in response to a_ipc_msg_bub_status_req.

Create using a_ipc_init_bub_status_rsp().

Message type is A_IPC_MSG_BUB_STATUS_RSP.

Data Fields
bool	engaged	True if backup battery is the current power source.
bool	functional	True if backup battery is functional.
bool	present	True if backup battery is present.
bool	requested	True if backup battery service is requested.
a_ipc_enum_bub_result	result	Result of the operation.
uint8_t	soc	Returns the relative State of Charge in % of backup battery.
uint8_t	soh	Returns the State of Health in % of backup battery.

a_ipc_msg_bub_battery_temperature_req

struct a_ipc_msg_bub_battery_temperature_req

Request to read the battery temperature.

The result is received in a bub_battery_temperature_rsp message.

Response is delivered in a_ipc_msg_bub_battery_temperature_rsp.

Create using a_ipc_init_bub_battery_temperature_req().

Message type is A_IPC_MSG_BUB_BATTERY_TEMPERATURE_REQ.

a_ipc_msg_bub_battery_temperature_rsp

struct a_ipc_msg_bub_battery_temperature_rsp

Sent in response to bub_battery_temperature_req message.

Sent in response to a_ipc_msg_bub_battery_temperature_req.

Create using a_ipc_init_bub_battery_temperature_rsp().

Message type is A_IPC_MSG_BUB_BATTERY_TEMPERATURE_RSP.

Data Fields
a_ipc_enum_bub_result	result	Result of the operation.
int16_t	temperature	Measured temperature represented in C.

a_ipc_msg_bub_board_temperature_req

struct a_ipc_msg_bub_board_temperature_req

Request to read the board temperature.

The result is received in a bub_board_temperature_rsp message.

Response is delivered in a_ipc_msg_bub_board_temperature_rsp.

Create using a_ipc_init_bub_board_temperature_req().

Message type is A_IPC_MSG_BUB_BOARD_TEMPERATURE_REQ.

a_ipc_msg_bub_board_temperature_rsp

struct a_ipc_msg_bub_board_temperature_rsp

Sent in response to bub_board_temperature_req message.

Sent in response to a_ipc_msg_bub_board_temperature_req.

Create using a_ipc_init_bub_board_temperature_rsp().

Message type is A_IPC_MSG_BUB_BOARD_TEMPERATURE_RSP.

Data Fields
a_ipc_enum_bub_result	result	Result of the operation.
int16_t	temperature	Measured temperature represented in C.

Enumeration Type Documentation

a_ipc_enum_bub_result

enum a_ipc_enum_bub_result

Result codes.

Enumerator
A_IPC_ENUM_BUB_RESULT_OK	No error.
A_IPC_ENUM_BUB_RESULT_NOT_AVAILABLE	Not available.
A_IPC_ENUM_BUB_RESULT_ERROR_WRONG_STATE	Wrong state. For instance when trying to request bub when internal diagnostics is running. Deprecated: This error can no longer be returned.
A_IPC_ENUM_BUB_RESULT_ERROR_UNKNOWN	Unknown error.

Function Documentation

a_ipc_init_bub_battery_temperature_req()

A_IPC_RESULT a_ipc_init_bub_battery_temperature_req

(

a_ipc_msg *

msg

)

Initialize the message buffer to contain a_ipc_msg_bub_battery_temperature_req.

msg->info.type will be A_IPC_MSG_BUB_BATTERY_TEMPERATURE_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_bub_battery_temperature_rsp()

A_IPC_RESULT a_ipc_init_bub_battery_temperature_rsp

(

a_ipc_msg *

msg

)

Initialize the message buffer to contain a_ipc_msg_bub_battery_temperature_rsp.

msg->info.type will be A_IPC_MSG_BUB_BATTERY_TEMPERATURE_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_bub_board_temperature_req()

A_IPC_RESULT a_ipc_init_bub_board_temperature_req

(

a_ipc_msg *

msg

)

Initialize the message buffer to contain a_ipc_msg_bub_board_temperature_req.

msg->info.type will be A_IPC_MSG_BUB_BOARD_TEMPERATURE_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_bub_board_temperature_rsp()

A_IPC_RESULT a_ipc_init_bub_board_temperature_rsp

(

a_ipc_msg *

msg

)

Initialize the message buffer to contain a_ipc_msg_bub_board_temperature_rsp.

msg->info.type will be A_IPC_MSG_BUB_BOARD_TEMPERATURE_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_bub_release_req_norsp()

A_IPC_RESULT a_ipc_init_bub_release_req_norsp	(	a_ipc_msg *	msg,
		uint32_t	user_maxlength
	)

Initialize the message buffer to contain a_ipc_msg_bub_release_req_norsp.

msg->info.type will be A_IPC_MSG_BUB_RELEASE_REQ_NORSP.

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

Parameters

msg	The message buffer to initialize
user_maxlength	The maximum string length for user in the message.

a_ipc_init_bub_request_req()

A_IPC_RESULT a_ipc_init_bub_request_req	(	a_ipc_msg *	msg,
		uint32_t	user_maxlength
	)

Initialize the message buffer to contain a_ipc_msg_bub_request_req.

msg->info.type will be A_IPC_MSG_BUB_REQUEST_REQ.

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

Parameters

msg	The message buffer to initialize
user_maxlength	The maximum string length for user in the message.

a_ipc_init_bub_request_rsp()

A_IPC_RESULT a_ipc_init_bub_request_rsp

(

a_ipc_msg *

msg

)

Initialize the message buffer to contain a_ipc_msg_bub_request_rsp.

msg->info.type will be A_IPC_MSG_BUB_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_bub_status_req()

A_IPC_RESULT a_ipc_init_bub_status_req

(

a_ipc_msg *

msg

)

Initialize the message buffer to contain a_ipc_msg_bub_status_req.

msg->info.type will be A_IPC_MSG_BUB_STATUS_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_bub_status_rsp()

A_IPC_RESULT a_ipc_init_bub_status_rsp

(

a_ipc_msg *

msg

)

Initialize the message buffer to contain a_ipc_msg_bub_status_rsp.

msg->info.type will be A_IPC_MSG_BUB_STATUS_RSP.

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

Parameters

msg	The message buffer to initialize

Variable Documentation

engaged

bool a_ipc_msg_bub_status_rsp::engaged

True if backup battery is the current power source.

functional

bool a_ipc_msg_bub_status_rsp::functional

True if backup battery is functional.

present

bool a_ipc_msg_bub_status_rsp::present

True if backup battery is present.

requested

bool a_ipc_msg_bub_status_rsp::requested

True if backup battery service is requested.

result [1/4]

a_ipc_enum_bub_result a_ipc_msg_bub_request_rsp::result

Result of the operation.

result [2/4]

a_ipc_enum_bub_result a_ipc_msg_bub_status_rsp::result

Result of the operation.

result [3/4]

a_ipc_enum_bub_result a_ipc_msg_bub_battery_temperature_rsp::result

Result of the operation.

result [4/4]

a_ipc_enum_bub_result a_ipc_msg_bub_board_temperature_rsp::result

Result of the operation.

soc

uint8_t a_ipc_msg_bub_status_rsp::soc

Returns the relative State of Charge in % of backup battery.

soh

uint8_t a_ipc_msg_bub_status_rsp::soh

Returns the State of Health in % of backup battery.

temperature [1/2]

int16_t a_ipc_msg_bub_battery_temperature_rsp::temperature

Measured temperature represented in C.

temperature [2/2]

int16_t a_ipc_msg_bub_board_temperature_rsp::temperature

Measured temperature represented in C.

user [1/2]

a_ipc_dyn_string a_ipc_msg_bub_request_req::user

User identifier, max 15 characters long.

user [2/2]

a_ipc_dyn_string a_ipc_msg_bub_release_req_norsp::user

User identifier, max 15 characters long.