From: Hyotaek Shim Date: Tue, 26 Jul 2022 07:13:17 +0000 (+0900) Subject: doc: reorganize Battery Monitor under the System > Resource category X-Git-Tag: accepted/tizen/unified/20240924.153234~2 X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=5c24bb6ac106e907664fc3d29613fb2400c12eae;p=platform%2Fcore%2Fapi%2Fbatterymonitor.git doc: reorganize Battery Monitor under the System > Resource category Change-Id: I369f79cc2be60dbcb90a3f478eef6822172287eb Signed-off-by: Hyotaek Shim --- diff --git a/LICENSE b/LICENSE old mode 100755 new mode 100644 diff --git a/NOTICE b/NOTICE old mode 100755 new mode 100644 diff --git a/doc/battery-monitor-doc.h b/doc/battery-monitor-doc.h new file mode 100644 index 0000000..b94e55c --- /dev/null +++ b/doc/battery-monitor-doc.h @@ -0,0 +1,65 @@ +/* + * Copyright (c) 2019 Samsung Electronics Co., Ltd All Rights Reserved + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +#ifndef __TIZEN_SYSTEM_BATTERY_MONITOR_DOC_H__ +#define __TIZEN_SYSTEM_BATTERY_MONITOR_DOC_H__ + +/** + * @ingroup CAPI_SYSTEM_RESOURCE_MODULE + * @defgroup CAPI_SYSTEM_BATTERY_BATTERY_MONITOR_MODULE Battery Monitor + * + * @brief The Battery Monitor API provides per-resource battery consumption by the application. + * + * @section CAPI_SYSTEM_BATTERY_BATTERY_MONITOR_MODULE_HEADER Required Header + * \#include + * + * @section CAPI_SYSTEM_BATTERY_BATTERY_MONITOR_MODULE_OVERVIEW Overview + * Battery consumption by a device does not only comprises power consumed by CPU, + * but it also includes power consumed by other components like - WiFi, Bt, Display, Mobile radio etc. + * The user is normally unaware of power consumed by these components & hence when battery drains out, + * user treats it as abnormal behaviour of device. + * + * Under these circumstances, user takes immediate action like killing all power hungry applications, + * use minimal display brightness, enable night mode in day time, shutting down some sensors, disabling + * background data for applications to restrict power usage & in the worst case - uninstall the application. + * + * User's decision making at such time is greatly influenced by the accuracy of battery consumption estimation + * and statistics provided to him. + * + * With this battery-monitor framework, power consumed by each & every application is determined along with the + * power consumed by individual resources which are used by the application at the time of running. + * + * The API's provide the following functionality: + * Battery Power Usage in mAh (milli-Ampere-Hour) for, between a custom start & end time. + * - battery consumption in mAh for specific resource from available data. + * - battery consumption in mAh for all resources used by app_id. + * - battery consumption in mAh by an app-id for a specific resource. + * - total battery usage in mAh by an app-id for certain start & end time pair. + * - battery consumption in mAh by a resource for certain start & end time pair. + * + * @section CAPI_SYSTEM_BATTERY_BATTERY_MONITOR_MODULE_FEATURE Related Features + * The API's defined are related with the following features:\n + * - %http://tizen.org/feature/battery\n + * + * It is recommended to design applications with regard to features, for reliability.\n + * + * To ensure your application is only running on the device with specific features, please define the features in your manifest file using the manifest editor in the SDK.\n + * + * More details on using features in your application can be found in the Feature List. + * + */ + +#endif /* __TIZEN_SYSTEM_BATTERY_MONITOR_DOC_H__ */ diff --git a/doc/battery_doc.h b/doc/battery_doc.h deleted file mode 100755 index 29d51a8..0000000 --- a/doc/battery_doc.h +++ /dev/null @@ -1,74 +0,0 @@ -/* - * Copyright (c) 2019 Samsung Electronics Co., Ltd All Rights Reserved - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ - -#ifndef __TIZEN_SYSTEM_BATTERY_DOC_H__ -#define __TIZEN_SYSTEM_BATTERY_DOC_H__ - -/** - * @ingroup CAPI_SYSTEM_FRAMEWORK - * @defgroup CAPI_SYSTEM_BATTERY_MODULE Battery - * - * @brief The Battery API provides functions to get status of battery. - * - */ - -/** - * @ingroup CAPI_SYSTEM_BATTERY_MODULE - * @defgroup CAPI_SYSTEM_BATTERY_BATTERY_MONITOR_MODULE Battery Monitor - * - * @brief The API's provide per resource battery consumption by the application. - * - * @section CAPI_SYSTEM_BATTERY_BATTERY_MONITOR_MODULE_HEADER Required Header - * \#include - * - * @section CAPI_SYSTEM_BATTERY_BATTERY_MONITOR_MODULE_OVERVIEW Overview - * Battery consumption by a device does not only comprises power consumed by CPU, - * but it also includes power consumed by other components like - WiFi, Bt, Display, Mobile radio etc. - * The user is normally unaware of power consumed by these components & hence when battery drains out, - * user treats it as abnormal behaviour of device. - * - * Under these circumstances, user takes immediate action like killing all power hungry applications, - * use minimal display brightness, enable night mode in day time, shutting down some sensors, disabling - * background data for applications to restrict power usage & in the worst case - uninstall the application. - * - * User's decision making at such time is greatly influenced by the accuracy of battery consumption estimation - * and statistics provided to him. - * - * With this battery-monitor framework, power consumed by each & every application is determined along with the - * power consumed by individual resources which are used by the application at the time of running. - * - * The API's provide the following functionality: - * Battery Power Usage in mAh (milli-Ampere-Hour) for, between a custom start & end time. - * - battery consumption in mAh for specific resource from available data. - * - battery consumption in mAh for all resources used by app_id. - * - battery consumption in mAh by an app-id for a specific resource. - * - total battery usage in mAh by an app-id for certain start & end time pair. - * - battery consumption in mAh by a resource for certain start & end time pair. - * - * @section CAPI_SYSTEM_BATTERY_BATTERY_MONITOR_MODULE_FEATURE Related Features - * The API's defined are related with the following features:\n - * - %http://tizen.org/feature/battery\n - * - * It is recommended to design applications with regard to features, for reliability.\n - * - * To ensure your application is only running on the device with specific features, please define the features in your manifest file using the manifest editor in the SDK.\n - * - * More details on using features in your application can be found in the Feature List. - * - */ - -#endif /* __TIZEN_SYSTEM_BATTERY_DOC_H__ */ -