bluetooth: BAS: add battery level status char to bas service

Added the battery level status char to bas service
as per bas_1.1 spec. Added BSIM test for BAS service
to test the NTF/INDs of BAS characteristics.

Signed-off-by: Nithin Ramesh Myliattil <[email protected]>

Author: niym-ot

include/zephyr/bluetooth/services/bas.h

@@ -1,4 +1,5 @@
 /*
+ * Copyright (c) 2024 Demant A/S
  * Copyright (c) 2018 Nordic Semiconductor ASA
  * Copyright (c) 2016 Intel Corporation
  *
@@ -19,11 +20,173 @@
  */
 
 #include <stdint.h>
+#include <zephyr/sys/util.h>
 
 #ifdef __cplusplus
 extern "C" {
 #endif
 
+/**
+ * @brief Battery Level Status Characteristic flags.
+ *
+ * Enumeration for the flags indicating the presence
+ * of various fields in the Battery Level Status characteristic.
+ */
+enum bt_bas_bls_flags {
+	/** Bit indicating that the Battery Level Status identifier is present. */
+	BT_BAS_BLS_FLAG_IDENTIFIER_PRESENT = BIT(0),
+
+	/** Bit indicating that the Battery Level is present. */
+	BT_BAS_BLS_FLAG_BATTERY_LEVEL_PRESENT = BIT(1),
+
+	/** Bit indicating that additional status information is present. */
+	BT_BAS_BLS_FLAG_ADDITIONAL_STATUS_PRESENT = BIT(2),
+};
+
+/** @brief Battery Present Status
+ *
+ * Enumeration for the presence of the battery.
+ */
+enum bt_bas_bls_battery_present {
+	/** Battery is not present. */
+	BT_BAS_BLS_BATTERY_NOT_PRESENT = 0,
+
+	/** Battery is present. */
+	BT_BAS_BLS_BATTERY_PRESENT = 1
+};
+
+/** @brief Wired External Power Source Status
+ *
+ * Enumeration for the status of the wired external power source.
+ */
+enum bt_bas_bls_wired_power_source {
+	/** Wired external power source is not connected. */
+	BT_BAS_BLS_WIRED_POWER_NOT_CONNECTED = 0,
+
+	/** Wired external power source is connected. */
+	BT_BAS_BLS_WIRED_POWER_CONNECTED = 1,
+
+	/** Wired external power source status is unknown. */
+	BT_BAS_BLS_WIRED_POWER_UNKNOWN = 2
+};
+
+/** @brief Wireless External Power Source Status
+ *
+ * Enumeration for the status of the wireless external power source.
+ */
+enum bt_bas_bls_wireless_power_source {
+	/** Wireless external power source is not connected. */
+	BT_BAS_BLS_WIRELESS_POWER_NOT_CONNECTED = 0,
+
+	/** Wireless external power source is connected. */
+	BT_BAS_BLS_WIRELESS_POWER_CONNECTED = 1,
+
+	/** Wireless external power source status is unknown. */
+	BT_BAS_BLS_WIRELESS_POWER_UNKNOWN = 2
+};
+
+/** @brief Battery Charge State
+ *
+ * Enumeration for the charge state of the battery.
+ */
+enum bt_bas_bls_battery_charge_state {
+	/** Battery charge state is unknown. */
+	BT_BAS_BLS_CHARGE_STATE_UNKNOWN = 0,
+
+	/** Battery is currently charging. */
+	BT_BAS_BLS_CHARGE_STATE_CHARGING = 1,
+
+	/** Battery is discharging actively. */
+	BT_BAS_BLS_CHARGE_STATE_DISCHARGING_ACTIVE = 2,
+
+	/** Battery is discharging but inactive. */
+	BT_BAS_BLS_CHARGE_STATE_DISCHARGING_INACTIVE = 3
+};
+
+/** @brief Battery Charge Level
+ *
+ * Enumeration for the level of charge in the battery.
+ */
+enum bt_bas_bls_battery_charge_level {
+	/** Battery charge level is unknown. */
+	BT_BAS_BLS_CHARGE_LEVEL_UNKNOWN = 0,
+
+	/** Battery charge level is good. */
+	BT_BAS_BLS_CHARGE_LEVEL_GOOD = 1,
+
+	/** Battery charge level is low. */
+	BT_BAS_BLS_CHARGE_LEVEL_LOW = 2,
+
+	/** Battery charge level is critical. */
+	BT_BAS_BLS_CHARGE_LEVEL_CRITICAL = 3
+};
+
+/** @brief Battery Charge Type
+ *
+ * Enumeration for the type of charging applied to the battery.
+ */
+enum bt_bas_bls_battery_charge_type {
+	/** Battery charge type is unknown or not charging. */
+	BT_BAS_BLS_CHARGE_TYPE_UNKNOWN = 0,
+
+	/** Battery is charged using constant current. */
+	BT_BAS_BLS_CHARGE_TYPE_CONSTANT_CURRENT = 1,
+
+	/** Battery is charged using constant voltage. */
+	BT_BAS_BLS_CHARGE_TYPE_CONSTANT_VOLTAGE = 2,
+
+	/** Battery is charged using trickle charge. */
+	BT_BAS_BLS_CHARGE_TYPE_TRICKLE = 3,
+
+	/** Battery is charged using float charge. */
+	BT_BAS_BLS_CHARGE_TYPE_FLOAT = 4
+};
+
+/** @brief Charging Fault Reason
+ *
+ * Enumeration for the reasons of charging faults.
+ */
+enum bt_bas_bls_charging_fault_reason {
+	/** No charging fault. */
+	BT_BAS_BLS_FAULT_REASON_NONE = 0,
+
+	/** Charging fault due to battery issue. */
+	BT_BAS_BLS_FAULT_REASON_BATTERY = BIT(0),
+
+	/** Charging fault due to external power source issue. */
+	BT_BAS_BLS_FAULT_REASON_EXTERNAL_POWER = BIT(1),
+
+	/** Charging fault for other reasons. */
+	BT_BAS_BLS_FAULT_REASON_OTHER = BIT(2)
+};
+
+/** @brief Service Required Status
+ *
+ * Enumeration for whether the service is required.
+ */
+enum bt_bas_bls_service_required {
+	/** Service is not required. */
+	BT_BAS_BLS_SERVICE_REQUIRED_FALSE = 0,
+
+	/** Service is required. */
+	BT_BAS_BLS_SERVICE_REQUIRED_TRUE = 1,
+
+	/** Service requirement is unknown. */
+	BT_BAS_BLS_SERVICE_REQUIRED_UNKNOWN = 2
+};
+
+/** @brief Battery Fault Status
+ *
+ * Enumeration for the fault status of the battery.
+ */
+enum bt_bas_bls_battery_fault {
+	/** No battery fault. */
+	BT_BAS_BLS_BATTERY_FAULT_NO = 0,
+
+	/** Battery fault present. */
+	BT_BAS_BLS_BATTERY_FAULT_YES = 1
+};
+
 /** @brief Read battery level value.
  *
  * Read the characteristic value of the battery level
@@ -43,6 +206,81 @@ uint8_t bt_bas_get_battery_level(void);
  */
 int bt_bas_set_battery_level(uint8_t level);
 
+/**
+ * @brief Set the battery present status.
+ *
+ * @param present The battery present status to set.
+ */
+void bt_bas_bls_set_battery_present(enum bt_bas_bls_battery_present present);
+
+/**
+ * @brief Set the wired external power source status.
+ *
+ * @param source The wired external power source status to set.
+ */
+void bt_bas_bls_set_wired_external_power_source(enum bt_bas_bls_wired_power_source source);
+
+/**
+ * @brief Set the wireless external power source status.
+ *
+ * @param source The wireless external power source status to set.
+ */
+void bt_bas_bls_set_wireless_external_power_source(enum bt_bas_bls_wireless_power_source source);
+
+/**
+ * @brief Set the battery charge state.
+ *
+ * @param state The battery charge state to set.
+ */
+void bt_bas_bls_set_battery_charge_state(enum bt_bas_bls_battery_charge_state state);
+
+/**
+ * @brief Set the battery charge level.
+ *
+ * @param level The battery charge level to set.
+ */
+void bt_bas_bls_set_battery_charge_level(enum bt_bas_bls_battery_charge_level level);
+
+/**
+ * @brief Set the battery charge type.
+ *
+ * @param type The battery charge type to set.
+ */
+void bt_bas_bls_set_battery_charge_type(enum bt_bas_bls_battery_charge_type type);
+
+/**
+ * @brief Set the charging fault reason.
+ *
+ * @param reason The charging fault reason to set.
+ */
+void bt_bas_bls_set_charging_fault_reason(enum bt_bas_bls_charging_fault_reason reason);
+
+/**
+ * @brief Set the identifier of the battery.
+ *
+ * kconfig_dep{CONFIG_BT_BAS_BLS_IDENTIFIER_PRESENT}
+ *
+ * @param identifier Identifier to set.
+ */
+void bt_bas_bls_set_identifier(uint16_t identifier);
+
+/**
+ * @brief Set the service required status.
+ *
+ * kconfig_dep{CONFIG_BT_BAS_BLS_ADDITIONAL_STATUS_PRESENT}
+ *
+ * @param value Service required status to set.
+ */
+void bt_bas_bls_set_service_required(enum bt_bas_bls_service_required value);
+
+/**
+ * @brief Set the battery fault status.
+ *
+ * kconfig_dep{CONFIG_BT_BAS_BLS_ADDITIONAL_STATUS_PRESENT}
+ *
+ * @param value Battery fault status to set.
+ */
+void bt_bas_bls_set_battery_fault(enum bt_bas_bls_battery_fault value);
 
 #ifdef __cplusplus
 }

samples/bluetooth/hap_ha/prj.conf

@@ -56,4 +56,9 @@ CONFIG_BT_TBS_CLIENT_GTBS=y
 CONFIG_BT_TBS_CLIENT_CCID=y
 CONFIG_BT_TBS_CLIENT_STATUS_FLAGS=y
 
+CONFIG_BT_BAS_BLS=y
+CONFIG_BT_BAS_BLS_IDENTIFIER_PRESENT=y
+CONFIG_BT_BAS_BLS_BATTERY_LEVEL_PRESENT=y
+CONFIG_BT_BAS_BLS_ADDITIONAL_STATUS_PRESENT=y
+
 CONFIG_LOG=y

subsys/bluetooth/services/CMakeLists.txt

@@ -3,12 +3,14 @@
 
 zephyr_sources_ifdef(CONFIG_BT_DIS dis.c)
 
-zephyr_sources_ifdef(CONFIG_BT_BAS bas.c)
-
 zephyr_sources_ifdef(CONFIG_BT_HRS hrs.c)
 
 zephyr_sources_ifdef(CONFIG_BT_TPS tps.c)
 
+if(CONFIG_BT_BAS)
+  add_subdirectory(bas)
+endif()
+
 if(CONFIG_BT_OTS OR CONFIG_BT_OTS_CLIENT)
   add_subdirectory(ots)
 endif()

subsys/bluetooth/services/Kconfig

@@ -8,8 +8,6 @@ menu "GATT Services"
 
 rsource "Kconfig.dis"
 
-rsource "Kconfig.bas"
-
 rsource "Kconfig.hrs"
 
 rsource "Kconfig.tps"
@@ -20,4 +18,6 @@ rsource "ias/Kconfig.ias"
 
 rsource "ots/Kconfig"
 
+rsource "bas/Kconfig.bas"
+
 endmenu