BAS Exported Functions

group BAS_Exported_Functions

Functions

T_SERVER_ID bas_add_service(void *p_func)

Add battery service to the Bluetooth Host.

Example usage 

void profile_init()
{
    server_init(service_num);
    bas_id = bas_add_service(app_handle_profile_message);
}
Parameters:

p_func -- [in] Callback when service attribute is read, written or CCCD updated.

Return values:

  • 0xFF -- Operation failure.

  • Others -- Service ID assigned by Bluetooth Host.

Returns:

Service ID generated by the Bluetooth Host: T_SERVER_ID.

bool bas_set_parameter(T_BAS_PARAM_TYPE param_type, uint8_t length, uint8_t *p_value)

Set a battery service parameter.

This function can be called with a BAS parameter type T_BAS_PARAM_TYPE and it will set the BAS parameter. The 'p_value' field must point to an appropriate data type that meets the requirements for the corresponding parameter type. (For example, if required data length for parameter type is 1 octets, p_value should be cast to a pointer of uint8_t.)

Example usage 

void test(void)
{
    bool ret = bas_set_parameter(BAS_PARAM_BATTERY_LEVEL, 1, &battery_level);
}
Parameters:

  • param_type -- [in] Battery service parameter type: T_BAS_PARAM_TYPE.

  • length -- [in] Length of data to write.

  • p_value -- [in] Pointer to data to write.

Return values:

  • true -- Operation success.

  • false -- Operation failure.

Returns:

Operation result.

bool bas_battery_level_value_notify(uint8_t conn_id, T_SERVER_ID service_id, uint8_t battery_level)

Send notify battery level notification data.

Example usage 

void test(void)
{
    bool ret = bas_battery_level_value_notify(conn_id, bas_id, battery_level);
}
Parameters:

  • conn_id -- [in] Connection ID.

  • service_id -- [in] Service ID.

  • battery_level -- [in] The current charge level of a battery. Range is 0 to 100. Unit is org.bluetooth.unit.percentage. 0% represents fully discharged; 100% represents fully charged.

Return values:

  • true -- Operation success.

  • false -- Operation failure.

Returns:

Operation result.

bool bas_battery_level_value_read_confirm(uint8_t conn_id, T_SERVER_ID service_id, uint8_t battery_level)

Confirm read battery level value request.

Example usage 

void test(void)
{
    bool ret = bas_battery_level_value_read_confirm(conn_id, bas_id, battery_level);
}
Parameters:

  • conn_id -- [in] Connection ID.

  • service_id -- [in] Service ID.

  • battery_level -- [in] The current charge level of a battery. Range is 0 to 100. Unit is org.bluetooth.unit.percentage. 0% represents fully discharged; 100% represents fully charged.

Return values:

  • true -- Operation success.

  • false -- Operation failure.

Returns:

Operation result.