mirror of
https://gitee.com/openharmony/interface_sdk_c
synced 2024-11-23 23:00:30 +00:00
feat: add c-api of battery info module
Signed-off-by: z30053694 <zhangchen190@huawei.com> Change-Id: Id7af7ce9818f3bd7f831e10a7f600448b2987f2d
This commit is contained in:
parent
f1f56a9444
commit
242cb39333
@ -91,3 +91,17 @@ ohos_ndk_library("libcommonevent_ndk") {
|
||||
"BasicServicesKit/commonevent/oh_commonevent_support.h",
|
||||
]
|
||||
}
|
||||
|
||||
ohos_ndk_headers("ohbattery_info_header") {
|
||||
dest_dir = "$ndk_headers_out_dir/BasicServicesKit/"
|
||||
sources = [ "./ohbattery_info.h" ]
|
||||
}
|
||||
|
||||
ohos_ndk_library("libohbattery_info_ndk") {
|
||||
output_name = "ohbattery_info"
|
||||
output_extension = "so"
|
||||
ndk_description_file = "./ohbattery_info.ndk.json"
|
||||
min_compact_version = "12"
|
||||
system_capability = "SystemCapability.PowerManager.BatteryManager.Core"
|
||||
system_capability_headers = [ "BasicServicesKit/ohbattery_info.h" ]
|
||||
}
|
||||
|
111
BasicServicesKit/ohbattery_info.h
Normal file
111
BasicServicesKit/ohbattery_info.h
Normal file
@ -0,0 +1,111 @@
|
||||
/*
|
||||
* Copyright (c) 2024 Huawei Device Co., Ltd.
|
||||
* 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.
|
||||
*/
|
||||
|
||||
/**
|
||||
* @addtogroup OH_BatteryInfo
|
||||
* @{
|
||||
*
|
||||
* @brief Provides the definition of the C interface for the BatteryInfo module.
|
||||
*
|
||||
* @syscap SystemCapability.PowerManager.BatteryManager.Core
|
||||
* @since 12
|
||||
* @version 1.0
|
||||
*/
|
||||
/**
|
||||
* @file ohbattery_info.h
|
||||
*
|
||||
* @brief Declares the APIs to discover and connect printers, print files from a printer,
|
||||
* query the list of the added printers and the printer information within it, and so on.
|
||||
*
|
||||
* @library libohbattery_info.so
|
||||
* @kit BasicServicesKit
|
||||
* @syscap SystemCapability.PowerManager.BatteryManager.Core
|
||||
* @since 12
|
||||
* @version 1.0
|
||||
*/
|
||||
#ifndef OHBATTERY_INFO_HEADER
|
||||
#define OHBATTERY_INFO_HEADER
|
||||
|
||||
#include <stdint.h>
|
||||
|
||||
#ifdef __cplusplus
|
||||
extern "C" {
|
||||
#endif /* __cplusplus */
|
||||
|
||||
static const char* COMMON_EVENT_KEY_CAPACITY = "soc";
|
||||
static const char* COMMON_EVENT_KEY_CHARGE_STATE = "chargeState";
|
||||
static const char* COMMON_EVENT_KEY_PLUGGED_TYPE = "pluggedType";
|
||||
|
||||
/**
|
||||
* @brief Defines plugged types.
|
||||
*
|
||||
* @since 12
|
||||
* @version 1.0
|
||||
*/
|
||||
|
||||
typedef enum {
|
||||
/**
|
||||
* Power source is unplugged.
|
||||
*/
|
||||
PLUGGED_TYPE_NONE,
|
||||
|
||||
/**
|
||||
* Power source is an AC charger.
|
||||
*/
|
||||
PLUGGED_TYPE_AC,
|
||||
|
||||
/**
|
||||
* Power source is a USB DC charger.
|
||||
*/
|
||||
PLUGGED_TYPE_USB,
|
||||
|
||||
/**
|
||||
* Power source is wireless charger.
|
||||
*/
|
||||
PLUGGED_TYPE_WIRELESS,
|
||||
|
||||
/**
|
||||
* The bottom of the enum.
|
||||
*/
|
||||
PLUGGED_TYPE_BUTT
|
||||
} BatteryInfo_BatteryPluggedType;
|
||||
|
||||
/**
|
||||
* @brief This API returns the current battery capacity.
|
||||
*
|
||||
* @return Returns number betweem 0 and 100.
|
||||
* @syscap ystemCapability.PowerManager.BatteryManager.Core
|
||||
* @since 12
|
||||
*/
|
||||
int32_t OH_BatteryInfo_GetCapacity();
|
||||
|
||||
/**
|
||||
* @brief This API returns the current plugged type.
|
||||
*
|
||||
* @Return {@link BatteryInfo_BatteryPluggedType#PLUGGED_TYPE_NONE} if the power source is unplugged.
|
||||
* {@link PLUGGED_TYPE_AC} if the power source is an AC charger.
|
||||
* {@link PLUGGED_TYPE_USB} if the power source is an USB DC charger.
|
||||
* {@link PLUGGED_TYPE_WIRELESS} if the power source is wireless charger.
|
||||
* {@link PLUGGED_TYPE_BUTT} if the type is unknown.
|
||||
* @syscap ystemCapability.PowerManager.BatteryManager.Core
|
||||
* @since 12
|
||||
*/
|
||||
BatteryInfo_BatteryPluggedType OH_BatteryInfo_GetPluggedType();
|
||||
|
||||
#ifdef __cplusplus
|
||||
}
|
||||
/** @} */
|
||||
#endif /* __cplusplus */
|
||||
#endif /* OHBATTERY_INFO_HEADER */
|
8
BasicServicesKit/ohbattery_info.ndk.json
Normal file
8
BasicServicesKit/ohbattery_info.ndk.json
Normal file
@ -0,0 +1,8 @@
|
||||
[
|
||||
{ "first_introduced": "12",
|
||||
"name":"OH_BatteryInfo_GetCapacity"
|
||||
},
|
||||
{ "first_introduced": "12",
|
||||
"name":"OH_BatteryInfo_GetPluggedType"
|
||||
}
|
||||
]
|
Loading…
Reference in New Issue
Block a user