diff --git a/zh-cn/device_api/hdi/light/light.type.h b/zh-cn/device_api/hdi/light/light.type.h index 9e9953b83b76cbf14954d058c15f40fb9eb3db67..e4a2ea7b6c361807ab78de73e2fec70fc14bce68 100644 --- a/zh-cn/device_api/hdi/light/light.type.h +++ b/zh-cn/device_api/hdi/light/light.type.h @@ -116,8 +116,8 @@ struct LightFlashEffect { */ struct LightEffect { /** - * 亮度值:Bits 24–31为扩展位,Bits 16–23为红色,bits 8–15为绿色,bits 0–7为蓝色。 - * 如果字节段不等于0,指示打开相应颜色的灯。 + * 亮度值:Bits 24–31为扩展位,Bits 16–23为红色,Bits 8–15为绿色,Bits 0–7为蓝色。 + * 如果相对应的字节段不等于0,表示打开相应颜色的灯。 */ int32_t lightBrightness; /** 闪烁模式。详见{@link LightFlashEffect}。 */ diff --git a/zh-cn/device_api/hdi/light/light_if.h b/zh-cn/device_api/hdi/light/light_if.h index 7185d22e3bef3fe95260adc6326b4b37532b17c6..463bba10b8c07eb894c46cf3910baafe8cf77fba 100644 --- a/zh-cn/device_api/hdi/light/light_if.h +++ b/zh-cn/device_api/hdi/light/light_if.h @@ -47,7 +47,7 @@ extern "C" { /** * @brief 定义可以在灯上执行的基本操作。 * - * 操作包括获取灯的信息、打开或关闭灯、设置灯的亮度或闪烁模式。 + * 操作包括获取灯的信息、打开或关闭灯、设置灯的亮度和闪烁模式。 */ struct LightInterface { @@ -74,7 +74,7 @@ struct LightInterface { * @return 如果操作成功,则返回0。 * @return 如果不支持灯ID,则返回-1。 * @return 如果不支持闪烁设置,则返回-2。 - * @return 如果不支持亮度设置,则返回3。 + * @return 如果不支持亮度设置,则返回-3。 * * @since 3.1 */ diff --git a/zh-cn/device_api/hdi/sensor/sensor_if.h b/zh-cn/device_api/hdi/sensor/sensor_if.h index 06296bdc7ef700df6d92fa8efd418c34ce8f9b7d..4e5a51c957338d0eb8eeced24b2e57ec34437c4e 100644 --- a/zh-cn/device_api/hdi/sensor/sensor_if.h +++ b/zh-cn/device_api/hdi/sensor/sensor_if.h @@ -19,7 +19,7 @@ * * @brief 传感器设备驱动对传感器服务提供通用的接口能力。 * - * 模块提供传感器服务对传感器驱动访问统一接口,服务获取驱动对象或者代理后,通过其提供的各类方法,实现获取传感器设备信息、订阅/去订阅传感器数据、 + * 模块提供传感器服务对传感器驱动访问统一接口,服务获取驱动对象或者代理后,通过其提供的各类方法,实现获取传感器设备信息、订阅/取消订阅传感器数据、 * 使能/去使能传感器、设置传感器模式、设置传感器精度、量程等可选配置等。 * * @since 2.2 @@ -28,7 +28,7 @@ /** * @file sensor_if.h * - * @brief Sensor模块对外通用的接口声明文件,提供获取传感器设备信息、订阅/去订阅传感器数据、 + * @brief Sensor模块对外通用的接口声明文件,提供获取传感器设备信息、订阅/取消订阅传感器数据、 * 使能/去使能传感器、设置传感器模式、设置传感器精度,量程等可选配置接口定义。 * * @since 2.2 @@ -49,7 +49,7 @@ extern "C" { /** * @brief 提供sensor设备基本控制操作接口。 * - * 结构体提供获取传感器设备信息、订阅/去订阅传感器数据、使能/去使能传感器、设置传感器模式、设置传感器精度、量程等可选配置接口定义。 + * 结构体提供获取传感器设备信息、订阅/取消订阅传感器数据、使能/去使能传感器、设置传感器模式、设置传感器精度、量程等可选配置接口定义。 */ struct SensorInterface { /** @@ -153,7 +153,7 @@ struct SensorInterface { int32_t (*Register)([in] int32_t groupId, [in] RecordDataCallback cb); /** - * @brief 订阅者去注册传感器数据回调函数。 + * @brief 订阅者取消注册传感器数据回调函数。 * * @param groupId 传感器组ID。 * sensorId枚举值范围为128-160,表示已订阅医疗传感器服务。只需成功取消订阅一次,无需重复取消订阅。 diff --git a/zh-cn/device_api/hdi/sensor/sensor_type.h b/zh-cn/device_api/hdi/sensor/sensor_type.h index f30154f6db252cc1b12d58131fce957de7116317..f014e966826e1316172917a44092e21433b7e9e0 100644 --- a/zh-cn/device_api/hdi/sensor/sensor_type.h +++ b/zh-cn/device_api/hdi/sensor/sensor_type.h @@ -20,7 +20,7 @@ * @brief 传感器设备驱动对传感器服务提供通用的接口能力。 * * 模块提供传感器服务对传感器驱动访问统一接口,服务获取驱动对象或者代理后, - * 通过其提供的各类方法,以传感器id区分访问不同类型传感器设备,实现获取传感器设备信息、订阅/去订阅传感器数据、 + * 通过其提供的各类方法,以传感器ID区分访问不同类型传感器设备,实现获取传感器设备信息、订阅/取消订阅传感器数据、 * 使能/去使能传感器、设置传感器模式、设置传感器精度、量程等可选配置等。 * * @version 1.0 @@ -46,9 +46,9 @@ extern "C" { #endif #endif /* __cplusplus */ -/**< 传感器名称的最大长度。 */ +/** 传感器名称的最大长度。 */ #define SENSOR_NAME_MAX_LEN 32 -/**< 传感器版本的最大长度。 */ +/** 传感器版本的最大长度。 */ #define SENSOR_VERSION_MAX_LEN 16 /** @@ -57,17 +57,17 @@ extern "C" { * @since 2.2 */ enum SensorStatus { - /**< 传感器执行成功。 */ + /** 传感器执行成功。 */ SENSOR_SUCCESS = 0, - /**< 传感器执行失败。 */ + /** 传感器执行失败。 */ SENSOR_FAILURE = -1, - /**< 传感器不支持。 */ + /** 传感器不支持。 */ SENSOR_NOT_SUPPORT = -2, - /**< 传感器无效参数。 */ + /** 传感器无效参数。 */ SENSOR_INVALID_PARAM = -3, - /**< 传感器无效服务。 */ + /** 传感器无效服务。 */ SENSOR_INVALID_SERVICE = -4, - /**< 传感器空指针。 */ + /** 传感器空指针。 */ SENSOR_NULL_PTR = -5, }; @@ -77,73 +77,73 @@ enum SensorStatus { * @since 2.2 */ enum SensorTypeTag { - /**< 空传感器类型,用于测试。 */ + /** 空传感器类型,用于测试。 */ SENSOR_TYPE_NONE = 0, - /**< 加速度传感器。 */ + /** 加速度传感器。 */ SENSOR_TYPE_ACCELEROMETER = 1, - /**< 陀螺仪传感器。 */ + /** 陀螺仪传感器。 */ SENSOR_TYPE_GYROSCOPE = 2, - /**< 心率传感器。 */ + /** 心率传感器。 */ SENSOR_TYPE_PHOTOPLETHYSMOGRAPH = 3, - /**< 心电传感器。 */ + /** 心电传感器。 */ SENSOR_TYPE_ELECTROCARDIOGRAPH = 4, - /**< 环境光传感器。 */ + /** 环境光传感器。 */ SENSOR_TYPE_AMBIENT_LIGHT = 5, - /**< 地磁传感器。 */ + /** 地磁传感器。 */ SENSOR_TYPE_MAGNETIC_FIELD = 6, - /**< 电容传感器。 */ + /** 电容传感器。 */ SENSOR_TYPE_CAPACITIVE = 7, - /**< 气压计传感器。 */ + /** 气压计传感器。 */ SENSOR_TYPE_BAROMETER = 8, - /**< 温度传感器。 */ + /** 温度传感器。 */ SENSOR_TYPE_TEMPERATURE = 9, - /**< 霍尔传感器。 */ + /** 霍尔传感器。 */ SENSOR_TYPE_HALL = 10, - /**< 手势传感器。 */ + /** 手势传感器。 */ SENSOR_TYPE_GESTURE = 11, - /**< 接近光传感器。 */ + /** 接近光传感器。 */ SENSOR_TYPE_PROXIMITY = 12, - /**< 湿度传感器。 */ + /** 湿度传感器。 */ SENSOR_TYPE_HUMIDITY = 13, - /**< 医疗传感器ID枚举值范围的开始。 */ + /** 医疗传感器ID枚举值范围的开始。 */ SENSOR_TYPE_MEDICAL_BEGIN = 128, - /**< 医疗传感器ID枚举值范围的结束。 */ + /** 医疗传感器ID枚举值范围的结束。 */ SENSOR_TYPE_MEDICAL_END = 160, - /**< 物理传感器最大类型。 */ + /** 物理传感器最大类型。 */ SENSOR_TYPE_PHYSICAL_MAX = 255, - /**< 方向传感器。 */ + /** 方向传感器。 */ SENSOR_TYPE_ORIENTATION = 256, - /**< 重力传感器。 */ + /** 重力传感器。 */ SENSOR_TYPE_GRAVITY = 257, - /**< 线性加速度传感器。 */ + /** 线性加速度传感器。 */ SENSOR_TYPE_LINEAR_ACCELERATION = 258, - /**< 旋转矢量传感器。 */ + /** 旋转矢量传感器。 */ SENSOR_TYPE_ROTATION_VECTOR = 259, - /**< 环境温度传感器 */ + /** 环境温度传感器。 */ SENSOR_TYPE_AMBIENT_TEMPERATURE = 260, - /**< 未校准磁场传感器。 */ + /** 未校准磁场传感器。 */ SENSOR_TYPE_MAGNETIC_FIELD_UNCALIBRATED = 261, - /**< 游戏旋转矢量传感器。 */ + /** 游戏旋转矢量传感器。 */ SENSOR_TYPE_GAME_ROTATION_VECTOR = 262, - /**< 未校准陀螺仪传感器。 */ + /** 未校准陀螺仪传感器。 */ SENSOR_TYPE_GYROSCOPE_UNCALIBRATED = 263, - /**< 大幅度动作传感器。 */ + /** 大幅度动作传感器。 */ SENSOR_TYPE_SIGNIFICANT_MOTION = 264, - /**< 计步器检测传感器。 */ + /** 计步器检测传感器。 */ SENSOR_TYPE_PEDOMETER_DETECTION = 265, - /**< 计步器传感器。 */ + /** 计步器传感器。 */ SENSOR_TYPE_PEDOMETER = 266, - /**< 地磁旋转矢量传感器。 */ + /** 地磁旋转矢量传感器。 */ SENSOR_TYPE_GEOMAGNETIC_ROTATION_VECTOR = 277, - /**< 心率传感器。 */ + /** 心率传感器。 */ SENSOR_TYPE_HEART_RATE = 278, - /**< 设备方向传感器。 */ + /** 设备方向传感器。 */ SENSOR_TYPE_DEVICE_ORIENTATION = 279, - /**< 佩戴检测传感器。 */ + /** 佩戴检测传感器。 */ SENSOR_TYPE_WEAR_DETECTION = 280, - /**< 未校准加速度传感器。 */ + /** 未校准加速度传感器。 */ SENSOR_TYPE_ACCELEROMETER_UNCALIBRATED = 281, - /**< 传感器类型最大个数标r。 */ + /** 传感器类型最大个数标识。 */ SENSOR_TYPE_MAX, }; @@ -153,15 +153,15 @@ enum SensorTypeTag { * @since 2.2 */ enum SensorAccuracyType { - /**< 无精度类型。 */ + /** 无精度类型。 */ SENSOR_NO_ACCURACY = 0, - /**< 低精度类型。 */ + /** 低精度类型。 */ SENSOR_LOW_ACCURACY = 1, - /**< 中等精度类型。 */ + /** 中等精度类型。 */ SENSOR_MEDIUM_ACCURACY = 2, - /**< 高精度类型。 */ + /** 高精度类型。 */ SENSOR_HIGH_ACCURACY = 3, - /**< 最大精度类型。 */ + /** 最大精度类型。 */ SENSOR_MAX_ACCURACY, }; @@ -171,13 +171,13 @@ enum SensorAccuracyType { * @since 2.2 */ enum SensorRangeType { - /**< 量程级别1。 */ + /** 量程级别1。 */ SENSOR_RANGE_LEVEL1 = 0, - /**< 量程级别2。 */ + /** 量程级别2。 */ SENSOR_RANGE_LEVEL2 = 1, - /**< 量程级别3。 */ + /** 量程级别3。 */ SENSOR_RANGE_LEVEL3 = 2, - /**< 量程最大级别。 */ + /** 量程最大级别。 */ SENSOR_RANGE_LEVEL_MAX, }; @@ -187,17 +187,17 @@ enum SensorRangeType { * @since 2.2 */ enum SensorModeType { - /**< 传感器默认工作模式状态。 */ + /** 传感器默认工作模式状态。 */ SENSOR_MODE_DEFAULT = 0, - /**< 传感器实时工作模式状态,一组数据上报一次。 */ + /** 传感器实时工作模式状态,一组数据上报一次。 */ SENSOR_MODE_REALTIME = 1, - /**< 传感器实时工作模式状态,状态变更上报一次。 */ + /** 传感器实时工作模式状态,状态变更上报一次。 */ SENSOR_MODE_ON_CHANGE = 2, - /**< 传感器实时工作模式状态,只上报一次。 */ + /** 传感器实时工作模式状态,只上报一次。 */ SENSOR_MODE_ONE_SHOT = 3, - /**< 传感器缓存工作模式状态,根据配置的缓存大小上报。 */ + /** 传感器缓存工作模式状态,根据配置的缓存大小上报。 */ SENSOR_MODE_FIFO_MODE = 4, - /**< 传感器最大类型标识。 */ + /** 传感器最大类型标识。 */ SENSOR_MODE_MAX, }; @@ -223,23 +223,23 @@ enum SensorGroupType { * @since 2.2 */ struct SensorInformation { - /**< 传感器名称。 */ + /** 传感器名称。 */ char sensorName[SENSOR_NAME_MAX_LEN]; - /**< 传感器设备厂商。*/ + /** 传感器设备厂商。*/ char vendorName[SENSOR_NAME_MAX_LEN]; - /**< 传感器固件版本号。 */ + /** 传感器固件版本号。 */ char firmwareVersion[SENSOR_VERSION_MAX_LEN]; - /**< 传感器硬件版本号 */ + /** 传感器硬件版本号 */ char hardwareVersion[SENSOR_VERSION_MAX_LEN]; - /**< 传感器类型编号,唯一标识一个传感器设备类型,详见{@link SensorTypeTag}。 */ + /** 传感器类型编号,唯一标识一个传感器设备类型,详见{@link SensorTypeTag}。 */ int32_t sensorTypeId; - /**< 传感器的标识号,有传感器驱动开发者定义。 */ + /** 传感器的标识号,由传感器驱动开发者定义。 */ int32_t sensorId; - /**< 传感器的最大量程。 */ + /** 传感器的最大量程。 */ float maxRange; - /**< 传感器的精度。 */ + /** 传感器的精度。 */ float accuracy; - /**< 传感器的功耗。 */ + /** 传感器的功耗。 */ float power; }; @@ -251,19 +251,19 @@ struct SensorInformation { * @since 2.2 */ struct SensorEvents { - /**< 传感器的标识号。 */ + /** 传感器的标识号。 */ int32_t sensorId; - /**< 传感器算法版本号。 */ + /** 传感器算法版本号。 */ int32_t version; - /**< 传感器数据生成时间。 */ + /** 传感器数据生成时间。 */ int64_t timestamp; - /**< 传感器量程精度可选配置。 */ + /** 传感器量程精度可选配置。 */ uint32_t option; - /**< 传感器工作模式。 */ + /** 传感器工作模式。 */ int32_t mode; - /**< 传感器数据地址。 */ + /** 传感器数据地址。 */ uint8_t *data; - /**< 传感器数据长度。 */ + /** 传感器数据长度。 */ uint32_t dataLen; }; diff --git a/zh-cn/device_api/hdi/vibrator/vibrator_if.h b/zh-cn/device_api/hdi/vibrator/vibrator_if.h index fc95c6b3ebe778dc4d98c20bfb8d3d87e95751d8..0b73cbb1c3ace1b576ce8fb7d98fd2fc3c223632 100644 --- a/zh-cn/device_api/hdi/vibrator/vibrator_if.h +++ b/zh-cn/device_api/hdi/vibrator/vibrator_if.h @@ -46,6 +46,12 @@ extern "C" { #endif #endif /* __cplusplus */ +/** + * @brief 提供vibrator设备基本控制操作接口。 + * + * 操作包括马达模式和效果振动、停止马达振动。 + */ + struct VibratorInterface { /** * @brief 控制马达以执行给定持续时间的一次性振动。 @@ -91,6 +97,35 @@ struct VibratorInterface { * @version 1.0 */ int32_t (*Stop)([in] enum VibratorMode mode); + + /** + * @brief 获取有关系统中支持设置振幅和频率的所有马达信息。 + * + * @param vibratorInfo 表示指向马达信息的指针,详见{@link VibratorInfo}。 + * + * @return 如果操作成功,则返回0。 + * @return 如果操作失败,则返回负值。 + * + * @since 3.2 + * @version 1.1 + */ + int32_t (*GetVibratorInfo)([out] struct VibratorInfo **vibratorInfo); + /** + * @brief 根据传入的振动效果启动马达。 + * + * @param duration 表示马达振动的持续时间,以毫秒为单位。 + * @param intensity 表示振动周期内的马达振幅。 + * @param frequency 表示振动周期内的马达频率。 + * + * @return 如果操作成功,则返回0。 + * @return 如果不支持振动周期设置,则返回-1。 + * @return 如果不支持振幅设置,则返回-2。 + * @return 如果不支持频率设置,则返回-3。 + * + * @since 3.2 + * @version 1.1 + */ + int32_t (*EnableVibratorModulation)(uint32_t duration, int32_t intensity, int32_t frequency); }; /** diff --git a/zh-cn/device_api/hdi/vibrator/vibrator_type.h b/zh-cn/device_api/hdi/vibrator/vibrator_type.h index f057470f3b9cfef1b0047d1884842a9fbb4b1845..a11dc32d45766f3a19e7d2149ea06d7a60044986 100644 --- a/zh-cn/device_api/hdi/vibrator/vibrator_type.h +++ b/zh-cn/device_api/hdi/vibrator/vibrator_type.h @@ -46,10 +46,28 @@ extern "C" { #endif /* __cplusplus */ /** - * @brief 枚举马达振动模式。 + * @brief 定义马达模块返回值。 * * @since 2.2 */ + +enum VibratorStatus { + /** 操作成功。 */ + VIBRATOR_SUCCESS = 0, + /** 不支持振动周期设置。 */ + VIBRATOR_NOT_PERIOD = -1, + /** 不支持振幅设置。 */ + VIBRATOR_NOT_INTENSITY = -2, + /** 不支持频率设置。 */ + VIBRATOR_NOT_FREQUENCY = -3, +}; + +/** + * @brief 定义马达振动模式。 + * + * @since 2.2 + */ + enum VibratorMode { /** 表示给定持续时间内的一次性振动。 */ VIBRATOR_MODE_ONCE = 0, @@ -59,6 +77,28 @@ enum VibratorMode { VIBRATOR_MODE_BUTT }; +/** + * @brief 定义马达参数。 + * + * 参数包括设置马达振幅和频率以及振幅和频率的范围。 + * + * @since 3.2 + */ +struct VibratorInfo { + /** 设置马达振幅。1表示支持,0表示不支持。 */ + int32_t isSupportIntensity; + /** 设置马达频率。1表示支持,0表示不支持。 */ + int32_t isSupportFrequency; + /** 最大振幅。 */ + int32_t intensityMaxValue; + /** 最小振幅。 */ + int32_t intensityMinValue; + /** 最大频率。 */ + int32_t frequencyMaxValue; + /** 最小频率。 */ + int32_t frequencyMinValue; +}; + #ifdef __cplusplus #if __cplusplus }