From efb7efd024b18319755fea81ea85037ce1f9a45d Mon Sep 17 00:00:00 2001 From: Simo Piiroinen Date: Fri, 20 Jan 2017 12:02:04 +0200 Subject: [PATCH] [mce] Expose battery/charging data on D-Bus. Contributes to JB#37422 Add names of D-Bus method calls and signals related to querying and tracking of battery/charging related information. Signed-off-by: Simo Piiroinen --- include/mce/dbus-names.h | 93 ++++++++++++++++++++++++++++++++++++++++ include/mce/mode-names.h | 64 +++++++++++++++++++++++++++ 2 files changed, 157 insertions(+) diff --git a/include/mce/dbus-names.h b/include/mce/dbus-names.h index 61d1043..707098b 100644 --- a/include/mce/dbus-names.h +++ b/include/mce/dbus-names.h @@ -510,6 +510,58 @@ * @return Number of changed settings as DBUS_TYPE_INT32; -1 on failure */ #define MCE_CONFIG_RESET "reset_config" + +/** Query current USB cable state + * + * Possible return values are: + * - #MCE_USB_CABLE_STATE_UNKNOWN + * - #MCE_USB_CABLE_STATE_CONNECTED + * - #MCE_USB_CABLE_STATE_DISCONNECTED + * + * @since v1.86.0 + * + * @return USB cable connection state as DBUS_TYPE_STRING + */ +#define MCE_USB_CABLE_STATE_GET "get_usb_cable_state" + +/** Query current charger state + * + * Possible return values are: + * - #MCE_CHARGER_STATE_UNKNOWN + * - #MCE_CHARGER_STATE_ON + * - #MCE_CHARGER_STATE_OFF + * + * @since v1.86.0 + * + * @return charger state as DBUS_TYPE_STRING + */ +#define MCE_CHARGER_STATE_GET "get_charger_state" + +/** Query current battery status + * + * Possible return values are: + * - #MCE_BATTERY_STATUS_UNKNOWN + * - #MCE_BATTERY_STATUS_FULL + * - #MCE_BATTERY_STATUS_OK + * - #MCE_BATTERY_STATUS_LOW + * - #MCE_BATTERY_STATUS_EMPTY + * + * @since v1.86.0 + * + * @return battery status as DBUS_TYPE_STRING + */ +#define MCE_BATTERY_STATUS_GET "get_battery_status" + +/** Query current battery level + * + * Return value is in range from 0 to 100 percent, + * or #MCE_BATTERY_LEVEL_UNKNOWN + * + * @since v1.86.0 + * + * @return battery level as DBUS_TYPE_INT32 + */ +#define MCE_BATTERY_LEVEL_GET "get_battery_level" /*@}*/ /** @@ -618,6 +670,47 @@ */ #define MCE_CONFIG_CHANGE_SIG "config_change_ind" +/** Signal that indicates that USB cable state has changed + * + * Possible arguments values are: + * See #MCE_USB_CABLE_STATE_GET for possible argument values + * + * @since v1.86.0 + * + * @param cable_state USB cable connection state as DBUS_TYPE_STRING + */ +#define MCE_USB_CABLE_STATE_SIG "usb_cable_state_ind" + +/** Signal that indicates that charger state has changed + * + * See #MCE_CHARGER_STATE_GET for possible argument values + * + * @since v1.86.0 + * + * @param charger_state charger state as DBUS_TYPE_STRING + */ +#define MCE_CHARGER_STATE_SIG "charger_state_ind" + +/** Signal that indicates that battery status has changed + * + * See #MCE_BATTERY_STATUS_GET for possible argument values + * + * @since v1.86.0 + * + * @param battery_status battery status as DBUS_TYPE_STRING + */ +#define MCE_BATTERY_STATUS_SIG "battery_status_ind" + +/** Signal that indicates that battery level has changed + * + * See #MCE_BATTERY_LEVEL_GET for possible argument values + * + * @since v1.86.0 + * + * @param battery_level battery level as DBUS_TYPE_INT32 + */ +#define MCE_BATTERY_LEVEL_SIG "battery_level_ind" + /*@}*/ /** diff --git a/include/mce/mode-names.h b/include/mce/mode-names.h index 26d3734..c748ea7 100644 --- a/include/mce/mode-names.h +++ b/include/mce/mode-names.h @@ -258,4 +258,68 @@ */ #define MCE_POWERKEY_EVENT_DOUBLE_PRESS (2u) +/** USB cable state is not known + * + * @since v1.86.0 + */ +#define MCE_USB_CABLE_STATE_UNKNOWN "unknown" +/** USB cable is connected + * + * @since v1.86.0 + */ +#define MCE_USB_CABLE_STATE_CONNECTED "connected" +/** USB cable is disconnected + * + * @since v1.86.0 + */ +#define MCE_USB_CABLE_STATE_DISCONNECTED "disconnected" + +/** Charger state is not known + * + * @since v1.86.0 + */ +#define MCE_CHARGER_STATE_UNKNOWN "unknown" +/** Charger is active + * + * @since v1.86.0 + */ +#define MCE_CHARGER_STATE_ON "on" +/** Charger is inactive + * + * @since v1.86.0 + */ +#define MCE_CHARGER_STATE_OFF "off" + +/** Battery status is not known + * + * @since v1.86.0 + */ +#define MCE_BATTERY_STATUS_UNKNOWN "unknown" +/** Battery is full + * + * @since v1.86.0 + */ +#define MCE_BATTERY_STATUS_FULL "full" +/** Battery is neither full nor empty + * + * @since v1.86.0 + */ +#define MCE_BATTERY_STATUS_OK "ok" +/** Battery is low on power + * + * @since v1.86.0 + */ +#define MCE_BATTERY_STATUS_LOW "low" +/** Battery is empty + * + * @since v1.86.0 + */ +#define MCE_BATTERY_STATUS_EMPTY "empty" + +/** Battery level percentage is not known + * + * @since v1.86.0 + */ +#define MCE_BATTERY_LEVEL_UNKNOWN (-1) + #endif /* _MCE_MODE_NAMES_H_ */