From 396d3fd604e812448a6866e0e480a490f1e9232d Mon Sep 17 00:00:00 2001 From: aqxyjay Date: Wed, 1 Jun 2022 15:17:25 +0800 Subject: [PATCH 1/3] docs: add battery hdi api docs Signed-off-by: aqxyjay --- battery/v1_0/IBatteryCallback.idl | 30 ++++++ battery/v1_0/IBatteryInterface.idl | 150 +++++++++++++++++++++++++++++ battery/v1_0/Types.idl | 66 +++++++++++++ 3 files changed, 246 insertions(+) diff --git a/battery/v1_0/IBatteryCallback.idl b/battery/v1_0/IBatteryCallback.idl index cb7d5bec..5f1eed9c 100755 --- a/battery/v1_0/IBatteryCallback.idl +++ b/battery/v1_0/IBatteryCallback.idl @@ -13,10 +13,40 @@ * limitations under the License. */ +/** + * @addtogroup battery + * @{ + * + * @brief 提供获取、订阅电池信息的接口。 + * + * @since 3.1 + * @version 1.0 + */ + +/** + * @file IBatteryCallback.idl + * + * @brief 订阅电池信息的回调接口。 + * + * @since 3.1 + * @version 1.0 + */ + package ohos.hdi.battery.v1_0; import ohos.hdi.battery.v1_0.Types; +/** + * @brief 订阅电池信息的回调。 + */ [callback] interface IBatteryCallback { + + /** + * @brief 订阅电池信息回调方法。 + * + * @param event 电池信息，如电量，电压，健康状态等。 + * @see BatteryInfo + */ Update([in] struct BatteryInfo event); } +/** @} */ diff --git a/battery/v1_0/IBatteryInterface.idl b/battery/v1_0/IBatteryInterface.idl index ff69810b..356552a7 100755 --- a/battery/v1_0/IBatteryInterface.idl +++ b/battery/v1_0/IBatteryInterface.idl @@ -13,26 +13,176 @@ * limitations under the License. */ +/** + * @addtogroup battery + * @{ + * + * @brief 提供获取、订阅电池信息的接口。 + * + * @since 3.1 + * @version 1.0 + */ + +/** + * @file IBatteryInterface.idl + * + * @brief 获取、订阅电池信息的接口。 + * + * @since 3.1 + * @version 1.0 + */ package ohos.hdi.battery.v1_0; import ohos.hdi.battery.v1_0.Types; import ohos.hdi.battery.v1_0.IBatteryCallback; +/** + * @brief 获取、订阅电池信息的接口。 + */ interface IBatteryInterface { + /** + * @brief 订阅电池信息变化。 + * + * @param event 输入参数, 注册回调类型{@link IBatteryCallback}。 + * + * @return HDF_SUCCESS 表示注册成功。 + */ Register([in] IBatteryCallback event); + + /** + * @brief 取消订阅电池信息变化。 + * + * @return HDF_SUCCESS 表示取消订阅成功。 + */ UnRegister(); + + /** + * @brief 设置电池信息节点的路径。 + * + * @param path 输入参数, 电池信息节点的路径。 + * + * @return HDF_SUCCESS 表示路径设置成功。 + */ ChangePath([in] String path); + + /** + * @brief 获取电池的电量百分比。 + * + * @param capacity 输出参数, 表示电量的百分比值。 + * + * @return HDF_SUCCESS 表示获取成功。 + */ GetCapacity([out] int capacity); + + /** + * @brief 获取电池的电压，单位微伏。 + * + * @param voltage 输出参数, 表示电池的电压。 + * + * @return HDF_SUCCESS 表示获取成功。 + */ GetVoltage([out] int voltage); + + /** + * @brief 获取电池的充电温度，单位0.1摄氏度。 + * + * @param temperature 输出参数, 表示电池温度。 + * + * @return HDF_SUCCESS 表示获取成功。 + */ GetTemperature([out] int temperature); + + /** + * @brief 获取电池的健康状态。 + * + * @param healthState 输出参数, 表示电池健康状态。 + * + * @return HDF_SUCCESS 表示获取成功。 + * @see BatteryHealthState + */ GetHealthState([out] enum BatteryHealthState healthState); + + /** + * @brief 获取充电设备类型。 + * + * @param pluggedType 输出参数, 表示充电设备类型。 + * + * @return HDF_SUCCESS 表示获取成功。 + * @see BatteryPluggedType + */ GetPluggedType([out] enum BatteryPluggedType pluggedType); + + /** + * @brief 获取充电状态。 + * + * @param chargeState 输出参数, 表示充电状态。 + * + * @return HDF_SUCCESS 表示获取成功。 + * @see BatteryChargeState + */ GetChargeState([out] enum BatteryChargeState chargeState); + + /** + * @brief 获取是否支持电池或者电池是否在位。 + * + * @param present 输出参数, 表示是否支持电池或者电池是否在位。true表示支持或在位，false表示不支持或不在位。 + * + * @return HDF_SUCCESS 表示获取成功。 + */ GetPresent([out] boolean present); + + /** + * @brief 获取当前电池的技术型号。 + * + * @param technology 输出参数, 当前电池技术型号。 + * + * @return HDF_SUCCESS 表示获取成功。 + */ GetTechnology([out] String technology); + + /** + * @brief 获取当前电池的总容量，单位毫安时。 + * + * @param totalEnergy 输出参数，表示电池的总容量。 + * + * @return HDF_SUCCESS 表示获取成功。 + */ GetTotalEnergy([out] int totalEnergy); + + /** + * @brief 获取当前电池的平均电流，单位毫安。 + * + * @param totalEnergy 输出参数，表示电池的平均电流。 + * + * @return HDF_SUCCESS 表示获取成功。 + */ GetCurrentAverage([out] int curAverage); + + /** + * @brief 获取当前电池的电流，单位毫安。 + * + * @param curNow 输出参数，表示电池的实时电流。 + * + * @return HDF_SUCCESS 表示获取成功。 + */ GetCurrentNow([out] int curNow); + + /** + * @brief 获取当前电池的剩余容量，单位毫安时。 + * + * @param remainEnergy 输出参数，表示电池的剩余容量。 + * + * @return HDF_SUCCESS 表示获取成功。 + */ GetRemainEnergy([out] int remainEnergy); + + /** + * @brief 获取当前电池的全部信息。 + * + * @param info 输出参数，电池的全部信息。 + * + * @return HDF_SUCCESS 表示获取成功。 + */ GetBatteryInfo([out] struct BatteryInfo info); } +/** @} */ diff --git a/battery/v1_0/Types.idl b/battery/v1_0/Types.idl index d4627347..1ae95aab 100755 --- a/battery/v1_0/Types.idl +++ b/battery/v1_0/Types.idl @@ -13,51 +13,117 @@ * limitations under the License. */ +/** + * @addtogroup battery + * @{ + * + * @brief 提供获取、订阅电池信息的接口。 + * + * @since 3.1 + * @version 1.0 + */ + +/** + * @file Types.idl + * + * @brief 电池信息相关数据类型。 + * + * 电池信息中使用的数据类型, 包括健康状态，充电状态，充电设备类型和电池信息结构。 + * + * @since 3.1 + * @version 1.0 + */ package ohos.hdi.battery.v1_0; + +/** + * @brief 电池的健康状态 + */ enum BatteryHealthState { + /** 表示电池健康状态未知 */ BATTERY_HEALTH_UNKNOWN = 0, + /** 表示电池健康状态为正常 */ BATTERY_HEALTH_GOOD, + /** 表示电池健康状态为过热 */ BATTERY_HEALTH_OVERHEAT, + /** 表示电池健康状态为过压 */ BATTERY_HEALTH_OVERVOLTAGE, + /** 表示电池健康状态为低温 */ BATTERY_HEALTH_COLD, + /** 表示电池健康状态为僵死 */ BATTERY_HEALTH_DEAD, + /** 保留位 */ BATTERY_HEALTH_RESERVED, }; +/** + * @brief 电池的充电状态 + */ enum BatteryChargeState { + /** 表示电池充电状态未知 */ CHARGE_STATE_NONE = 0, + /** 表示电池充电状态为使能状态 */ CHARGE_STATE_ENABLE, + /** 表示电池充电状态为停止状态 */ CHARGE_STATE_DISABLE, + /** 表示电池充电状态为已充满状态 */ CHARGE_STATE_FULL, + /** 保留位 */ CHARGE_STATE_RESERVED, }; +/** + * @brief 电池的充电设备类型 + */ enum BatteryPluggedType { + /** 表示连接充电器类型未知 */ PLUGGED_TYPE_NONE = 0, + /** 表示连接的充电器类型为交流充电器 */ PLUGGED_TYPE_AC, + /** 表示连接的充电器类型为USB */ PLUGGED_TYPE_USB, + /** 表示连接的充电器类型为无线充电器 */ PLUGGED_TYPE_WIRELESS, + /** 截止位 */ PLUGGED_TYPE_BUTT }; +/** + * @brief 电池相关信息 + */ struct BatteryInfo { + /** 表示电池的电量百分比 */ int capacity; + /** 表示电池的电压 */ int voltage; + /** 表示电池的温度 */ int temperature; + /** 表示电池的健康状态 */ int healthState; + /** 表示电池的充电设备类型 */ int pluggedType; + /** 表示电池的最大充电电流 */ int pluggedMaxCurrent; + /** 表示电池的最大充电电压 */ int pluggedMaxVoltage; + /** 表示电池的充电状态 */ int chargeState; + /** 表示电池的充电次数 */ int chargeCounter; + /** 表示电池的总容量 */ int totalEnergy; + /** 表示电池的平均电流 */ int curAverage; + /** 表示电池的实时电流 */ int curNow; + /** 表示电池的剩余容量 */ int remainEnergy; + /** 表示是否支持电池或者电池是否在位 */ byte present; + /** 表示电池的技术型号 */ String technology; }; +/** @} */ -- Gitee From 7e1dc3c25e714323891485a841dd470bf0d98ba0 Mon Sep 17 00:00:00 2001 From: aqxyjay Date: Wed, 1 Jun 2022 17:30:06 +0800 Subject: [PATCH 2/3] docs: add power hdi api docs Signed-off-by: aqxyjay --- power/v1_0/IPowerHdiCallback.idl | 30 +++++++++++++ power/v1_0/IPowerInterface.idl | 74 ++++++++++++++++++++++++++++++++ power/v1_0/PowerTypes.idl | 43 +++++++++++++++++++ 3 files changed, 147 insertions(+) diff --git a/power/v1_0/IPowerHdiCallback.idl b/power/v1_0/IPowerHdiCallback.idl index 0e63fb67..4a2ce13a 100755 --- a/power/v1_0/IPowerHdiCallback.idl +++ b/power/v1_0/IPowerHdiCallback.idl @@ -13,9 +13,39 @@ * limitations under the License. */ +/** + * @addtogroup power + * @{ + * + * @brief 提供休眠唤醒操作、订阅休眠唤醒状态、运行锁管理的接口。 + * + * @since 3.1 + * @version 1.0 + */ + + /** + * @file IPowerHdiCallback.idl + * + * @brief 订阅休眠唤醒状态的回调。 + * + * @since 3.1 + * @version 1.0 + */ + package ohos.hdi.power.v1_0; +/** + * @brief 订阅休眠唤醒状态的回调。 + */ [callback] interface IPowerHdiCallback { + /** + * @brief 休眠状态的回调接口。 + */ OnSuspend(); + + /** + * @brief 唤醒状态的回调接口。 + */ OnWakeup(); } +/** @} */ diff --git a/power/v1_0/IPowerInterface.idl b/power/v1_0/IPowerInterface.idl index 272d5bff..406d2ab9 100755 --- a/power/v1_0/IPowerInterface.idl +++ b/power/v1_0/IPowerInterface.idl @@ -13,16 +13,90 @@ * limitations under the License. */ +/** + * @addtogroup power + * @{ + * + * @brief 提供休眠唤醒操作、订阅休眠唤醒状态、运行锁管理的接口。 + * + * @since 3.1 + * @version 1.0 + */ + + /** + * @file IPowerInterface.idl + * + * @brief 休眠唤醒操作、订阅休眠唤醒状态、运行锁管理的接口。 + * + * @since 3.1 + * @version 1.0 + */ + package ohos.hdi.power.v1_0; + import ohos.hdi.power.v1_0.IPowerHdiCallback; import ohos.hdi.power.v1_0.PowerTypes; +/** + * @brief 休眠唤醒操作、订阅休眠唤醒状态、运行锁管理的接口。 + */ interface IPowerInterface { + /** + * @brief 订阅休眠唤醒状态。 + * + * @param ipowerHdiCallback 输入参数, 注册的回调。 + * + * @return HDF_SUCCESS 表示注册成功。 + * @see IPowerHdiCallback + */ RegisterCallback([in] IPowerHdiCallback ipowerHdiCallback); + + /** + * @brief 执行设备休眠操作。 + * + * @return HDF_SUCCESS 表示操作成功。 + */ StartSuspend(); + + /** + * @brief 执行设备唤醒操作。 + * + * @return HDF_SUCCESS 表示操作成功。 + */ StopSuspend(); + + /** + * @brief 执行设备强制休眠操作。 + * + * @return HDF_SUCCESS 表示操作成功。 + */ ForceSuspend(); + + /** + * @brief 打开运行锁，阻止休眠。 + * + * @param name 输入参数, 运行锁的名称。 + * + * @return HDF_SUCCESS 表示操作成功。 + */ SuspendBlock([in] String name); + + /** + * @brief 关闭运行锁，取消阻止休眠。 + * + * @param name 输入参数, 运行锁的名称。 + * + * @return HDF_SUCCESS 表示操作成功。 + */ SuspendUnblock([in] String name); + + /** + * @brief 获取电源的Dump信息。 + * + * @param info 输出参数, 电源的Dump信息。 + * + * @return HDF_SUCCESS 表示操作成功。 + */ PowerDump([out] String info); } +/** @} */ diff --git a/power/v1_0/PowerTypes.idl b/power/v1_0/PowerTypes.idl index a23fa1ea..841916e9 100755 --- a/power/v1_0/PowerTypes.idl +++ b/power/v1_0/PowerTypes.idl @@ -13,25 +13,68 @@ * limitations under the License. */ +/** + * @addtogroup power + * @{ + * + * @brief 提供休眠唤醒操作、订阅休眠唤醒状态、运行锁管理的接口。 + * + * @since 3.1 + * @version 1.0 + */ + +/** + * @file PowerTypes.idl + * + * @brief 电源相关的数据类型。 + * + * 电源管理中使用的数据类型, 包括命令参数、回调参数和系统状态。 + * + * @since 3.1 + * @version 1.0 + */ + package ohos.hdi.power.v1_0; +/** + * @brief 电源的枚举命令参数。 + */ enum PowerHdfCmd { + /** 订阅状态的命令参数 */ CMD_REGISTER_CALLBCK = 0, + /** 休眠的命令参数 */ CMD_START_SUSPEND, + /** 唤醒的命令参数 */ CMD_STOP_SUSPEND, + /** 强制休眠的命令参数 */ CMD_FORCE_SUSPEND, + /** 打开运行锁的命令参数 */ CMD_SUSPEND_BLOCK, + /** 关闭运行锁的命令参数 */ CMD_SUSPEND_UNBLOCK, + /** Dump的命令参数 */ CMD_DUMP, }; +/** + * @brief 电源状态回调的枚举参数。 + */ enum PowerHdfCallbackCmd { + /** 休眠回调的命令参数 */ CMD_ON_SUSPEND = 0, + /** 唤醒回调的命令参数 */ CMD_ON_WAKEUP, }; +/** + * @brief 电源的状态。 + */ enum PowerHdfState { + /** 唤醒状态 */ AWAKE = 0, + /** 非活动状态 */ INACTIVE, + /** 休眠状态 */ SLEEP, }; +/** @} */ -- Gitee From 83561fa928cff73247c3ba027318250368e60d80 Mon Sep 17 00:00:00 2001 From: aqxyjay Date: Wed, 1 Jun 2022 17:45:51 +0800 Subject: [PATCH 3/3] docs: add thermal hdi api docs Signed-off-by: aqxyjay --- thermal/v1_0/IThermalCallback.idl | 31 ++++++++++++- thermal/v1_0/IThermalInterface.idl | 72 +++++++++++++++++++++++++++++- thermal/v1_0/ThermalTypes.idl | 31 ++++++++++++- 3 files changed, 131 insertions(+), 3 deletions(-) diff --git a/thermal/v1_0/IThermalCallback.idl b/thermal/v1_0/IThermalCallback.idl index dabc30c9..0f9c5d4a 100755 --- a/thermal/v1_0/IThermalCallback.idl +++ b/thermal/v1_0/IThermalCallback.idl @@ -13,10 +13,39 @@ * limitations under the License. */ +/** + * @addtogroup thermal + * @{ + * + * @brief 提供设备温度管理、控制及订阅接口。 + * + * @since 3.1 + * @version 1.0 + */ + + /** + * @file IThermalCallback.idl + * + * @brief 订阅设备发热状态的回调。 + * + * @since 3.1 + * @version 1.0 + */ + package ohos.hdi.thermal.v1_0; import ohos.hdi.thermal.v1_0.ThermalTypes; +/** + * @brief 订阅设备发热状态的回调。 + */ [callback] interface IThermalCallback { + /** + * @brief 设备发热状态变化的回调接口。 + * + * @param event 输入参数, 设备发热信息。 + * @see HdfThermalCallbackInfo + */ OnThermalDataEvent([in] struct HdfThermalCallbackInfo event); -} \ No newline at end of file +} +/** @} */ diff --git a/thermal/v1_0/IThermalInterface.idl b/thermal/v1_0/IThermalInterface.idl index 30e6942a..e2395513 100755 --- a/thermal/v1_0/IThermalInterface.idl +++ b/thermal/v1_0/IThermalInterface.idl @@ -13,16 +13,86 @@ * limitations under the License. */ +/** + * @addtogroup thermal + * @{ + * + * @brief 提供设备温度管理、控制及订阅接口。 + * + * @since 3.1 + * @version 1.0 + */ + +/** + * @file IThermalInterface.idl + * + * @brief 温度管理、控制及订阅接口。 + * + * @since 3.1 + * @version 1.0 + */ + package ohos.hdi.thermal.v1_0; import ohos.hdi.thermal.v1_0.ThermalTypes; import ohos.hdi.thermal.v1_0.IThermalCallback; +/** + * @brief 温度管理、控制及订阅接口。 + */ interface IThermalInterface { + /** + * @brief 设置CPU频率。 + * + * @param freq 输入参数，设置CPU频率的值。 + * + * @return HDF_SUCCESS 表示设置成功。 + */ SetCpuFreq([in] int freq); + + /** + * @brief 设置GPU频率。 + * + * @param freq 输入参数，设置GPU频率的值。 + * + * @return HDF_SUCCESS 表示设置成功。 + */ SetGpuFreq([in] int freq); + + /** + * @brief 设置充电电流，单位毫安。 + * + * @param current 输入参数，充电电流。 + * + * @return HDF_SUCCESS 表示设置成功 + */ SetBatteryCurrent([in] int current); + + /** + * @brief 获取设备发热的信息。 + * + * @param event 输出参数, 设备发热信息。 + * + * @return HDF_SUCCESS 表示获取成功。 + * @see HdfThermalCallbackInfo + */ GetThermalZoneInfo([out] struct HdfThermalCallbackInfo event); + + /** + * @brief 订阅设备发热状态。 + * + * @param callbackObj 输入参数, 发热状态回调。 + * + * @return HDF_SUCCESS 表示注册成功。 + * @see IThermalCallback + */ Register([in] IThermalCallback callbackObj); + + /** + * @brief 取消订阅设备发热状态。 + * + * @return HDF_SUCCESS 表示取消成功 + */ Unregister(); -} \ No newline at end of file +} +/** @} */ diff --git a/thermal/v1_0/ThermalTypes.idl b/thermal/v1_0/ThermalTypes.idl index 21cd989a..a151c68d 100755 --- a/thermal/v1_0/ThermalTypes.idl +++ b/thermal/v1_0/ThermalTypes.idl @@ -13,13 +13,42 @@ * limitations under the License. */ +/** + * @addtogroup thermal + * @{ + * + * @brief 提供设备温度管理、控制及订阅接口。 + * + * @since 3.1 + * @version 1.0 + */ + + /** + * @file ThermalTypes.idl + * + * @brief 设备发热状态相关的数据类型。 + * + * @since 3.1 + * @version 1.0 + */ + package ohos.hdi.thermal.v1_0; +/** + * @brief 设备发热的信息。 + */ struct ThermalZoneInfo { + /** 发热器件的类型 */ String type; + /** 期间的温度值 */ int temp; }; +/** + * @brief 设备发热的信息列表。 + */ struct HdfThermalCallbackInfo { + /** 设备发热的信息列表 */ List info; -}; \ No newline at end of file +}; +/** @} */ -- Gitee