IPC Module - Back-up Battery Service

This page contains documentation of the BUB (BackUp Battery) API.

Messages

message bub_request_req
Parameters:

user (string) – User identifier, max 15 characters long.

Return message:

bub_request_rsp

Request a BUB interface.

message bub_request_rsp
Parameters:

result (enum bub_result) – Result of the operation

BUB interface request result.

message bub_release_req_norsp
Parameters:

user (string) – User identifier, max 15 characters long.

Release a BUB interface.

message bub_status_req
Return message:

bub_status_rsp

Check the state of the BUB interface.

message bub_status_rsp
Parameters:

  • result (enum bub_result) – Result of the operation

  • present (uint8) – True if backup battery is present

  • functional (uint8) – True if backup battery is functional

  • requested (uint8) – True if backup battery service is requested

  • engaged (uint8) – True if backup battery is the current power source

  • soh (uint8) – Returns the State of Health in % of backup battery

  • soc (uint8) – Returns the relative State of Charge in % of backup battery

BUB status.

message bub_battery_temperature_req
Return message:

bub_battery_temperature_rsp

Request to read the battery temperature.

The result is received in a bub_battery_temperature_rsp message.

message bub_battery_temperature_rsp
Parameters:

  • result (enum bub_result) – Result of the operation

  • temperature (int16) – Measured temperature represented in C

Sent in response to bub_battery_temperature_req message.

message bub_board_temperature_req
Return message:

bub_board_temperature_rsp

Request to read the board temperature.

The result is received in a bub_board_temperature_rsp message.

message bub_board_temperature_rsp
Parameters:

  • result (enum bub_result) – Result of the operation

  • temperature (int16) – Measured temperature represented in C

Sent in response to bub_board_temperature_req message.

Enums

enum bub_result

Result codes

Constant

Value

Description

OK

0

No error

NOT_AVAILABLE

1

Not available

ERROR_WRONG_STATE

2

Wrong state.

For instance when trying to request bub when internal diagnostics is running.

Deprecated: This error can no longer be returned.

ERROR_UNKNOWN

3

Unknown error