From e19733a533424a40cfff658d2ce50fd05ad97f74 Mon Sep 17 00:00:00 2001 From: sunxuejiao Date: Thu, 15 Sep 2022 15:08:18 +0800 Subject: [PATCH 1/2] docs:new light interface chinese notes Signed-off-by: sunxuejiao --- zh-cn/device_api/hdi/light/light.type.h | 85 ++++++++++++++++++- zh-cn/device_api/hdi/light/light_if.h | 26 +++++- .../hdi/light/v1_0/ILightInterface.idl | 17 +++- .../device_api/hdi/light/v1_0/LightTypes.idl | 58 +++++++++++++ 4 files changed, 182 insertions(+), 4 deletions(-) diff --git a/zh-cn/device_api/hdi/light/light.type.h b/zh-cn/device_api/hdi/light/light.type.h index e4a2ea7b..3c600fb6 100644 --- a/zh-cn/device_api/hdi/light/light.type.h +++ b/zh-cn/device_api/hdi/light/light.type.h @@ -23,13 +23,16 @@ * 服务获取灯驱动对象或代理后，可以调用相关的APIs接口获取灯信息、打开或关闭灯，并根据灯ID设置灯闪烁模式。 * * @since 3.1 + * @version 1.0 */ /** * @file Light_if.h * * @brief 定义灯的数据结构，包括灯ID、灯的模式、灯的闪烁模式和持续时间、灯的状态、灯的效果。 + * * @since 3.1 + * @version 1.0 */ #ifndef LIGHT_TYPE_H @@ -45,9 +48,10 @@ extern "C" { /** * @brief 枚举灯模块的状态值。 + * * @since 3.1 + * @version 1.0 */ - enum LightStatus { /** 操作成功。 */ LIGHT_SUCCESS = 0, @@ -63,6 +67,7 @@ enum LightStatus { * @brief 枚举灯类型 * * @since 3.1 + * @version 1.0 */ enum LightId { /** 未知ID。 */ @@ -81,14 +86,17 @@ enum LightId { * @brief 枚举灯的模式 * * @since 3.1 + * @version 1.0 */ enum LightFlashMode { /** 常亮。 */ LIGHT_FLASH_NONE = 0, /** 闪烁。 */ LIGHT_FLASH_TIMED = 1, + /** 渐变。 */ + HDF_LIGHT_FLASH_GRADIENT = 2, /** 无效模式。 */ - LIGHT_FLASH_BUTT = 2, + LIGHT_FLASH_BUTT = 3, }; /** @@ -97,6 +105,7 @@ enum LightFlashMode { * 这些参数包括闪烁模式以及闪烁期间指示灯的打开和关闭时间。 * * @since 3.1 + * @version 1.0 */ struct LightFlashEffect { /** 闪烁模式，详见{@link LightFlashMode}。 */ @@ -107,12 +116,79 @@ struct LightFlashEffect { int32_t offTime; }; +/** + * @brief 定义灯的RGB模式。 + * + * 这些参数包括红色、绿色、蓝色值和亮度值。 + * + * @since 3.2 + * @version 1.0 + */ +struct RGBColor { + /** 亮度值为0-255。 */ + int brightness; + /** 红色值范围为0-255。 */ + int r; + /** 绿色值范围为0-255。 */ + int g; + /** 绿色值范围为0-255。 */ + int b; +}; + +/** + * @brief 定义灯的WRGB模式。 + * + * 这些参数包括红色、绿色、蓝色和白色值。 + * + * @since 3.2 + * @version 1.0 + */ +struct WRGBColor { + /** 白色值范围为0-255。 */ + int w; + /** 红色值范围为0-255。 */ + int r; + /** 绿色值范围为0-255。 */ + int g; + /** 蓝色值范围为0-255。 */ + int b; +}; + +/** + * @brief 定义设置灯的两种模式。 + * + * 参数包括RGB模式和WRGB模式。 + * + * @since 3.2 + * @version 1.0 + */ +union ColorValue { + /** WRGB模式, 详见{@link WRGBColor}。 */ + struct WRGBColor wrgbColor; + /** RGB模式, 详见{@link RGBColor}。 */ + struct RGBColor rgbColor; +}; + +/** + * @brief 定义亮灯参数。 + * + * 参数包括灯的模式设置。 + * + * @since 3.2 + * @version 1.0 + */ +struct LightColor { + /** 设置灯的模式, 详见{@link ColorValue}。 */ + union ColorValue colorValue; +}; + /** * @brief 定义灯的效果参数。 * * 参数包括亮度和闪烁模式。 * * @since 3.1 + * @version 1.0 */ struct LightEffect { /** @@ -130,10 +206,15 @@ struct LightEffect { * 基本的灯信息包括灯ID和自定义扩展信息。 * * @since 3.1 + * @version 1.0 */ struct LightInfo { /** 灯ID，详见{@link LightId}。 */ uint32_t lightId; + /** 逻辑控制器中的物理灯的数量。 */ + uint32_t lightNumber; + /** 逻辑控制器中灯名称。*/ + char lightName[NAME_MAX_LEN]; /** 自定义扩展信息。 */ int32_t reserved; }; diff --git a/zh-cn/device_api/hdi/light/light_if.h b/zh-cn/device_api/hdi/light/light_if.h index 463bba10..38863718 100644 --- a/zh-cn/device_api/hdi/light/light_if.h +++ b/zh-cn/device_api/hdi/light/light_if.h @@ -23,13 +23,16 @@ * 服务获取灯驱动对象或代理后，可以调用相关的APIs接口获取灯信息、打开或关闭灯，并根据灯ID设置灯闪烁模式。 * * @since 3.1 + * @version 1.0 */ /** * @file Light_if.h * * @brief 声明light模块的通用API，可用于获取灯ID、打开或关闭灯、并设置灯光亮度和闪烁模式。 + * * @since 3.1 + * @version 1.0 */ #ifndef LIGHT_IF_H @@ -48,8 +51,10 @@ extern "C" { * @brief 定义可以在灯上执行的基本操作。 * * 操作包括获取灯的信息、打开或关闭灯、设置灯的亮度和闪烁模式。 + * + * @since 3.1 + * @version 1.0 */ - struct LightInterface { /** * @brief 获取当前系统中所有类型的灯信息。 @@ -61,6 +66,7 @@ struct LightInterface { * @return 如果操作失败，则返回负值。 * * @since 3.1 + * @version 1.0 */ int32_t (*GetLightInfo)([out] struct LightInfo **lightInfo, [out] uint32_t *count); @@ -77,9 +83,24 @@ struct LightInterface { * @return 如果不支持亮度设置，则返回-3。 * * @since 3.1 + * @version 1.0 */ int32_t (*TurnOnLight)([in] uint32_t lightId, [in] struct LightEffect *effect); + /** + * @brief 根据指定的灯ID打开相应灯中包含的多个子灯。 + * + * @param lightId 表示灯ID，详见{@link LightId}。 + * @param colors 多个子灯对应的颜色和亮度, 详见{@link LightColor}。 + * + * @return 如果操作成功，则返回0。 + * @return 如果操作失败，则返回负值。 + * + * @since 3.2 + * @version 1.0 + */ + int32_t (*TurnOnMultiLights)(uint32_t lightId, const struct LightColor *colors, const uint32_t count); + /** * @brief 根据指定的灯ID关闭列表中的可用灯。 * @@ -89,6 +110,7 @@ struct LightInterface { * @return 如果操作失败，则返回负值。 * * @since 3.1 + * @version 1.0 */ int32_t (*TurnOffLight)([in] uint32_t lightId); }; @@ -102,6 +124,7 @@ struct LightInterface { * @return 如果操作失败，则返回负值。 * * @since 3.1 + * @version 1.0 */ const struct LightInterface *NewLightInterfaceInstance(void); @@ -112,6 +135,7 @@ const struct LightInterface *NewLightInterfaceInstance(void); * @return 如果操作失败，则返回负值。 * * @since 3.1 + * @version 1.0 */ int32_t FreeLightInterfaceInstance(void); diff --git a/zh-cn/device_api/hdi/light/v1_0/ILightInterface.idl b/zh-cn/device_api/hdi/light/v1_0/ILightInterface.idl index 731d96e7..6d23f61c 100755 --- a/zh-cn/device_api/hdi/light/v1_0/ILightInterface.idl +++ b/zh-cn/device_api/hdi/light/v1_0/ILightInterface.idl @@ -83,10 +83,25 @@ interface ILightInterface { */ TurnOnLight([in] int lightId, [in] struct HdfLightEffect effect); + /** + * @brief 根据指定的灯ID打开相应灯中包含的多个子灯。 + * + * @param lightId 表示灯ID，详见{@link LightId}。 + * + * @param colors 多个子灯对应的颜色和亮度, 详见{@link LightColor}。 + * + * @return 如果操作成功，则返回0。 + * @return 如果操作失败，则返回负值。 + * + * @since 3.2 + * @version 1.0 + */ + TurnOnMultiLights([in] int lightId, [in] struct HdfLightColor[] colors); + /** * @brief 根据指定的灯ID关闭列表中的可用灯。 * - * @param lightId 表示灯ID。详见{@link HdfLightId}。 + * @param lightId 表示灯ID，详见{@link LightId}。 * * @return 如果操作成功，则返回0。 * @return 如果操作失败，则返回负值。 diff --git a/zh-cn/device_api/hdi/light/v1_0/LightTypes.idl b/zh-cn/device_api/hdi/light/v1_0/LightTypes.idl index 734269c4..bebf8b43 100755 --- a/zh-cn/device_api/hdi/light/v1_0/LightTypes.idl +++ b/zh-cn/device_api/hdi/light/v1_0/LightTypes.idl @@ -65,7 +65,9 @@ enum HdfLightId { * @version 1.0 */ struct HdfLightInfo { + String lightName; /**< 逻辑控制器中灯名称。 */ int lightId; /**< 灯ID。详见{@link HdfLightId}。 */ + int lightNumber; /**< 逻辑控制器中的物理灯的数量。 */ int reserved; /**< 自定义扩展信息。 */ }; @@ -95,6 +97,62 @@ struct HdfLightFlashEffect { int offTime; /**< 表示在一个闪烁周期内灯持续熄灭的时间，单位毫秒。 */ }; +/** + * @brief 定义灯的RGB模式。 + * + * 这些参数包括红色、绿色、蓝色值和亮度值。 + * + * @since 3.2 + * @version 1.0 + */ +struct RGBColor { + int brightness; /**< 亮度值为0-255。 */ + int r; /**< 红色值范围为0-255。 */ + int g; /**< 绿色值范围为0-255。 */ + int b; /**< 蓝色值范围为0-255。 */ +}; + +/** + * @brief 定义灯的WRGB模式。 + * + * 这些参数包括红色、绿色、蓝色和白色值。 + * + * @since 3.2 + * @version 1.0 + */ +struct WRGBColor { + int w; /**< 白色值范围为0-255。 */ + int r; /**< 红色值范围为0-255。 */ + int g; /**< 绿色值范围为0-255。 */ + int b; /**< 蓝色值范围为0-255。 */ +}; + +/** + * @brief 定义设置灯的两种模式。 + * + * 参数包括RGB模式和WRGB模式。 + * + * @since 3.2 + * @version 1.0 + */ +union ColorValue +{ + struct WRGBColor wrgbColor; /**< WRGB模式, 详见{@link WRGBColor}。 */ + struct RGBColor rgbColor; /**< RGB模式, 详见{@link RGBColor}。 */ +}; + +/** + * @brief 定义亮灯参数。 + * + * 参数包括灯的模式设置。 + * + * @since 3.2 + * @version 1.0 + */ +struct HdfLightColor { + union ColorValue colorValue; /**< 设置灯的模式, 详见{@link ColorValue}。 */ +}; + /** * @brief 定义灯的效果参数。 * -- Gitee From 66335c3ebc0a88d20ff9b56dee260c2d5c78d5b7 Mon Sep 17 00:00:00 2001 From: sunxuejiao Date: Sat, 17 Sep 2022 12:26:09 +0800 Subject: [PATCH 2/2] docs:new light interface chinese notes Signed-off-by: sunxuejiao --- zh-cn/device_api/hdi/light/light.type.h | 36 +++++++++---------- zh-cn/device_api/hdi/light/light_if.h | 21 +++++------ .../hdi/light/v1_0/ILightInterface.idl | 21 ++++++----- .../device_api/hdi/light/v1_0/LightTypes.idl | 35 +++++++++--------- 4 files changed, 53 insertions(+), 60 deletions(-) diff --git a/zh-cn/device_api/hdi/light/light.type.h b/zh-cn/device_api/hdi/light/light.type.h index 3c600fb6..df4a06b7 100644 --- a/zh-cn/device_api/hdi/light/light.type.h +++ b/zh-cn/device_api/hdi/light/light.type.h @@ -20,7 +20,7 @@ * @brief 灯模块对灯服务提供通用的接口能力。 * * 灯模块为灯服务提供通用的接口去访问灯驱动。 - * 服务获取灯驱动对象或代理后，可以调用相关的APIs接口获取灯信息、打开或关闭灯，并根据灯ID设置灯闪烁模式。 + * 服务获取灯驱动对象或代理后，可以调用相关的APIs接口获取灯信息、打开或关闭灯，并根据灯类型ID设置灯闪烁模式。 * * @since 3.1 * @version 1.0 @@ -29,7 +29,7 @@ /** * @file Light_if.h * - * @brief 定义灯的数据结构，包括灯ID、灯的模式、灯的闪烁模式和持续时间、灯的状态、灯的效果。 + * @brief 定义灯的数据结构，包括灯类型ID、灯的模式、灯的闪烁模式和持续时间、灯的状态、灯的效果。 * * @since 3.1 * @version 1.0 @@ -55,7 +55,7 @@ extern "C" { enum LightStatus { /** 操作成功。 */ LIGHT_SUCCESS = 0, - /** 灯ID不支持。 */ + /** 灯类型ID不支持。 */ LIGHT_NOT_SUPPORT = -1, /** 设置闪烁不支持。 */ LIGHT_NOT_FLASH = -2, @@ -94,7 +94,7 @@ enum LightFlashMode { /** 闪烁。 */ LIGHT_FLASH_TIMED = 1, /** 渐变。 */ - HDF_LIGHT_FLASH_GRADIENT = 2, + LIGHT_FLASH_GRADIENT = 2, /** 无效模式。 */ LIGHT_FLASH_BUTT = 3, }; @@ -119,43 +119,39 @@ struct LightFlashEffect { /** * @brief 定义灯的RGB模式。 * - * 这些参数包括红色、绿色、蓝色值和亮度值。 - * * @since 3.2 * @version 1.0 */ struct RGBColor { - /** 亮度值为0-255。 */ + /** 亮度值，范围为0-255。 */ int brightness; - /** 红色值范围为0-255。 */ + /** 红色值，范围为0-255。 */ int r; - /** 绿色值范围为0-255。 */ + /** 绿色值，范围为0-255。 */ int g; - /** 绿色值范围为0-255。 */ + /** 蓝色值，范围为0-255。 */ int b; }; /** * @brief 定义灯的WRGB模式。 * - * 这些参数包括红色、绿色、蓝色和白色值。 - * * @since 3.2 * @version 1.0 */ struct WRGBColor { - /** 白色值范围为0-255。 */ + /** 白色值，范围为0-255。 */ int w; - /** 红色值范围为0-255。 */ + /** 红色值，范围为0-255。 */ int r; - /** 绿色值范围为0-255。 */ + /** 绿色值，范围为0-255。 */ int g; - /** 蓝色值范围为0-255。 */ + /** 蓝色值，范围为0-255。 */ int b; }; /** - * @brief 定义设置灯的两种模式。 + * @brief 定义设置灯的颜色模式。 * * 参数包括RGB模式和WRGB模式。 * @@ -203,17 +199,17 @@ struct LightEffect { /** * @brief 定义灯的基本信息。 * - * 基本的灯信息包括灯ID和自定义扩展信息。 + * 基本的灯信息包括灯类型ID和自定义扩展信息。 * * @since 3.1 * @version 1.0 */ struct LightInfo { - /** 灯ID，详见{@link LightId}。 */ + /** 灯类型ID，详见{@link LightId}。 */ uint32_t lightId; /** 逻辑控制器中的物理灯的数量。 */ uint32_t lightNumber; - /** 逻辑控制器中灯名称。*/ + /** 逻辑控制器中物理灯名称。*/ char lightName[NAME_MAX_LEN]; /** 自定义扩展信息。 */ int32_t reserved; diff --git a/zh-cn/device_api/hdi/light/light_if.h b/zh-cn/device_api/hdi/light/light_if.h index 38863718..55475817 100644 --- a/zh-cn/device_api/hdi/light/light_if.h +++ b/zh-cn/device_api/hdi/light/light_if.h @@ -20,7 +20,7 @@ * @brief 灯模块对灯服务提供通用的接口能力。 * * 灯模块为灯服务提供通用的接口去访问灯驱动。 - * 服务获取灯驱动对象或代理后，可以调用相关的APIs接口获取灯信息、打开或关闭灯，并根据灯ID设置灯闪烁模式。 + * 服务获取灯驱动对象或代理后，可以调用相关的APIs接口获取灯信息、打开或关闭灯，并根据灯类型ID设置灯闪烁模式。 * * @since 3.1 * @version 1.0 @@ -29,7 +29,7 @@ /** * @file Light_if.h * - * @brief 声明light模块的通用API，可用于获取灯ID、打开或关闭灯、并设置灯光亮度和闪烁模式。 + * @brief 声明light模块的通用API，可用于获取灯类型ID、打开或关闭灯、并设置灯光亮度和闪烁模式。 * * @since 3.1 * @version 1.0 @@ -71,14 +71,14 @@ struct LightInterface { int32_t (*GetLightInfo)([out] struct LightInfo **lightInfo, [out] uint32_t *count); /** - * @brief 根据指定的灯ID打开列表中的可用灯。 + * @brief 根据指定的灯类型ID打开列表中的可用灯。 * - * @param lightId 表示灯ID，详见{@link LightId}。 + * @param lightId 表示灯类型ID，详见{@link LightId}。 * @param effect 表示指向灯效果的指针，如果lightbrightness字段为0时， * 灯的亮度根据HCS配置的默认亮度进行设置，详见{@link LightEffect}。 * * @return 如果操作成功，则返回0。 - * @return 如果不支持灯ID，则返回-1。 + * @return 如果不支持灯类型ID，则返回-1。 * @return 如果不支持闪烁设置，则返回-2。 * @return 如果不支持亮度设置，则返回-3。 * @@ -88,10 +88,11 @@ struct LightInterface { int32_t (*TurnOnLight)([in] uint32_t lightId, [in] struct LightEffect *effect); /** - * @brief 根据指定的灯ID打开相应灯中包含的多个子灯。 + * @brief 根据指定的灯类型ID打开相应灯中包含的多个子灯。 * - * @param lightId 表示灯ID，详见{@link LightId}。 + * @param lightId 表示灯类型ID，详见{@link LightId}。 * @param colors 多个子灯对应的颜色和亮度, 详见{@link LightColor}。 + * @param count 表示子灯的数量。 * * @return 如果操作成功，则返回0。 * @return 如果操作失败，则返回负值。 @@ -99,12 +100,12 @@ struct LightInterface { * @since 3.2 * @version 1.0 */ - int32_t (*TurnOnMultiLights)(uint32_t lightId, const struct LightColor *colors, const uint32_t count); + int32_t (*TurnOnMultiLights)([in] uint32_t lightId, [in] const struct LightColor *colors, [out] const uint32_t count); /** - * @brief 根据指定的灯ID关闭列表中的可用灯。 + * @brief 根据指定的灯类型ID关闭列表中的可用灯。 * - * @param lightId 表示灯ID，详见{@link LightId}。 + * @param lightId 表示灯类型ID，详见{@link LightId}。 * * @return 如果操作成功，则返回0。 * @return 如果操作失败，则返回负值。 diff --git a/zh-cn/device_api/hdi/light/v1_0/ILightInterface.idl b/zh-cn/device_api/hdi/light/v1_0/ILightInterface.idl index 6d23f61c..9d994bf0 100755 --- a/zh-cn/device_api/hdi/light/v1_0/ILightInterface.idl +++ b/zh-cn/device_api/hdi/light/v1_0/ILightInterface.idl @@ -20,7 +20,7 @@ * @brief 灯驱动对灯服务提供通用的接口能力。 * * 灯模块为灯服务提供通用的接口去访问灯驱动，服务获取灯驱动对象或代理后，可以通过调用的APIs接口获取相关的灯信息。 - * 例如打开或关闭灯、根据灯ID设置灯闪烁模式。 + * 例如打开或关闭灯、根据灯类型ID设置灯闪烁模式。 * * @since 3.1 * @version 1.0 @@ -29,7 +29,7 @@ /** * @file ILightInterface.idl * - * @brief 定义灯模块的通用接口能力，包括获取灯ID，打开或关闭灯光，设置灯的亮度和闪烁模式。 + * @brief 定义灯模块的通用接口能力，包括获取灯类型ID，打开或关闭灯光，设置灯的亮度和闪烁模式。 * * @since 3.1 * @version 1.0 @@ -67,14 +67,14 @@ interface ILightInterface { GetLightInfo([out] struct HdfLightInfo[] info); /** - * @brief 根据指定的灯ID打开列表中的可用灯。 + * @brief 根据指定的灯类型ID打开列表中的可用灯。 * - * @param lightId 表示灯ID。详见{@link HdfLightId}。 + * @param lightId 表示灯类型ID。详见{@link HdfLightId}。 * @param effect 表示指向灯效果的指针，如果lightbrightness字段为0时， * 灯的亮度根据HCS配置的默认亮度进行设置。详见{@link HdfLightEffect}。 * * @return 如果操作成功，则返回0。 - * @return 如果不支持灯ID，则返回-1。 + * @return 如果不支持灯类型ID，则返回-1。 * @return 如果不支持闪烁设置，则返回-2。 * @return 如果不支持亮度设置，则返回-3。 * @@ -84,11 +84,10 @@ interface ILightInterface { TurnOnLight([in] int lightId, [in] struct HdfLightEffect effect); /** - * @brief 根据指定的灯ID打开相应灯中包含的多个子灯。 + * @brief 根据指定的灯类型ID打开相应灯中包含的多个子灯。 * - * @param lightId 表示灯ID，详见{@link LightId}。 - * - * @param colors 多个子灯对应的颜色和亮度, 详见{@link LightColor}。 + * @param lightId 表示灯类型ID，详见{@link HdfLightId}。 + * @param colors 多个子灯对应的颜色和亮度, 详见{@link HdfLightColor}。 * * @return 如果操作成功，则返回0。 * @return 如果操作失败，则返回负值。 @@ -99,9 +98,9 @@ interface ILightInterface { TurnOnMultiLights([in] int lightId, [in] struct HdfLightColor[] colors); /** - * @brief 根据指定的灯ID关闭列表中的可用灯。 + * @brief 根据指定的灯类型ID关闭列表中的可用灯。 * - * @param lightId 表示灯ID，详见{@link LightId}。 + * @param lightId 表示灯类型ID，详见{@link HdfLightId}。 * * @return 如果操作成功，则返回0。 * @return 如果操作失败，则返回负值。 diff --git a/zh-cn/device_api/hdi/light/v1_0/LightTypes.idl b/zh-cn/device_api/hdi/light/v1_0/LightTypes.idl index bebf8b43..80dc47a9 100755 --- a/zh-cn/device_api/hdi/light/v1_0/LightTypes.idl +++ b/zh-cn/device_api/hdi/light/v1_0/LightTypes.idl @@ -21,7 +21,7 @@ * * 灯模块为灯服务提供通用的接口去访问灯驱动。 * 服务获取灯驱动对象或代理后，可以调用相关的APIs接口获取灯信息。 - * 打开或关闭灯，并根据灯ID设置灯闪烁模式 + * 打开或关闭灯，并根据灯类型ID设置灯闪烁模式 * @since 3.1 * @version 1.0 */ @@ -29,7 +29,7 @@ /** * @file LightTypes.idl * - * @brief 定义灯的数据结构，包括灯ID，灯的模式，灯的闪烁模式和持续时间，返回值，灯的效果。 + * @brief 定义灯的数据结构，包括灯类型ID，灯的模式，灯的闪烁模式和持续时间，返回值，灯的效果。 * * @since 3.1 * @version 1.0 @@ -59,14 +59,14 @@ enum HdfLightId { /** * @brief 定义灯基本信息。 * - * 基本灯信息包括灯ID和自定义扩展信息。 + * 基本灯信息包括灯类型ID和自定义扩展信息。 * * @since 3.1 * @version 1.0 */ struct HdfLightInfo { - String lightName; /**< 逻辑控制器中灯名称。 */ - int lightId; /**< 灯ID。详见{@link HdfLightId}。 */ + String lightName; /**< 逻辑控制器中物理灯名称。 */ + int lightId; /**< 灯类型ID。详见{@link HdfLightId}。 */ int lightNumber; /**< 逻辑控制器中的物理灯的数量。 */ int reserved; /**< 自定义扩展信息。 */ }; @@ -80,6 +80,7 @@ struct HdfLightInfo { enum HdfLightFlashMode { HDF_LIGHT_FLASH_NONE = 0, /**< 常亮模式。 */ HDF_LIGHT_FLASH_TIMED = 1, /**< 闪烁模式。 */ + HDF_LIGHT_FLASH_GRADIENT = 2, /**< 渐变。 */ HDF_LIGHT_FLASH_BUTT = 2, /**< 无效模式。 */ }; @@ -100,35 +101,31 @@ struct HdfLightFlashEffect { /** * @brief 定义灯的RGB模式。 * - * 这些参数包括红色、绿色、蓝色值和亮度值。 - * * @since 3.2 * @version 1.0 */ struct RGBColor { - int brightness; /**< 亮度值为0-255。 */ - int r; /**< 红色值范围为0-255。 */ - int g; /**< 绿色值范围为0-255。 */ - int b; /**< 蓝色值范围为0-255。 */ + int brightness; /**< 亮度值，为0-255。 */ + int r; /**< 红色值，范围为0-255。 */ + int g; /**< 绿色值，范围为0-255。 */ + int b; /**< 蓝色值，范围为0-255。 */ }; /** * @brief 定义灯的WRGB模式。 * - * 这些参数包括红色、绿色、蓝色和白色值。 - * * @since 3.2 * @version 1.0 */ struct WRGBColor { - int w; /**< 白色值范围为0-255。 */ - int r; /**< 红色值范围为0-255。 */ - int g; /**< 绿色值范围为0-255。 */ - int b; /**< 蓝色值范围为0-255。 */ + int w; /**< 白色值，范围为0-255。 */ + int r; /**< 红色值，范围为0-255。 */ + int g; /**< 绿色值，范围为0-255。 */ + int b; /**< 蓝色值，范围为0-255。 */ }; /** - * @brief 定义设置灯的两种模式。 + * @brief 定义设置灯的颜色模式。 * * 参数包括RGB模式和WRGB模式。 * @@ -137,7 +134,7 @@ struct WRGBColor { */ union ColorValue { - struct WRGBColor wrgbColor; /**< WRGB模式, 详见{@link WRGBColor}。 */ + struct WRGBColor wrgbColor; /**< RGBW模式, 详见{@link WRGBColor}。 */ struct RGBColor rgbColor; /**< RGB模式, 详见{@link RGBColor}。 */ }; -- Gitee