Initial import
This commit is contained in:
@@ -0,0 +1,127 @@
|
||||
/******************************************************************************
|
||||
* @file led.h
|
||||
* @brief LED 事件框架:按通道掩码独立开关,红绿可同时亮
|
||||
* @author cyWu <1917507415@qq.com>
|
||||
* @date 2026.08.25
|
||||
* @version V1.1.0
|
||||
* @history
|
||||
* - V1.0.0, 2026.08.25, cyWu, 首次发布,实现按通道掩码独立开关的 LED 事件框架
|
||||
* - V1.1.0, 2026.08.27, cyWu, 新增 LED_EVENT_BOOT_REJECT(拒绝开机低电闪),
|
||||
* 与运行时 LED_EVENT_EMPTY 参数解耦,各自独立可调
|
||||
******************************************************************************/
|
||||
|
||||
#ifndef __LED_H__
|
||||
#define __LED_H__
|
||||
|
||||
#include <stdint.h>
|
||||
#include <string.h>
|
||||
|
||||
/*============================================================================*/
|
||||
/* 宏定义 */
|
||||
/*============================================================================*/
|
||||
|
||||
#define BLINK_ENABLE 1
|
||||
#define ALTERNATING_BLINK_ENABLE 1
|
||||
#define BREATH_ENABLE 0
|
||||
#define RUNNING_ENABLE 0
|
||||
#define MARQUEE_ENABLE 0
|
||||
|
||||
#define LED_ON 1
|
||||
#define LED_OFF 0
|
||||
|
||||
#define LED_CHANNEL(user_led) (1u << (user_led))
|
||||
|
||||
#define ledPrintf(level, fmt, ...) ((void)0)
|
||||
|
||||
/*============================================================================*/
|
||||
/* 类型 */
|
||||
/*============================================================================*/
|
||||
|
||||
typedef enum {
|
||||
LED_LIGHT = 0, /**< 常亮 */
|
||||
LED_BLINKING, /**< 闪烁 */
|
||||
LED_ALTERNATING_BLINK /**< 红绿交替 */
|
||||
} LED_State_t;
|
||||
|
||||
typedef enum {
|
||||
LED_EVENT_NONE = 0,
|
||||
LED_EVENT_STANDBY, /**< 待机绿灯常亮 */
|
||||
LED_EVENT_CHARGE, /**< 充电红灯常亮 */
|
||||
LED_EVENT_CHARGE_FULL, /**< 充满绿灯常亮 */
|
||||
LED_EVENT_LOWBAT, /**< 低电红闪 */
|
||||
LED_EVENT_PAIRING, /**< 配对绿快闪 */
|
||||
LED_EVENT_MODE, /**< 切模式绿闪两下 */
|
||||
LED_EVENT_PAIR_OK, /**< 配对成功常绿若干秒 */
|
||||
LED_EVENT_PAIR_FAIL, /**< 配对失败红绿交替 */
|
||||
LED_EVENT_OTA, /**< OTA:红绿交替闪,直到升级结束/复位 */
|
||||
LED_EVENT_EMPTY, /**< 电量 5% 关机:关绿灯,红灯闪 5 下 */
|
||||
LED_EVENT_BOOT_REJECT, /**< 拒绝开机:电量过低,红灯闪 N 下后继续深睡 */
|
||||
LED_EVENT_MAX
|
||||
} LED_Event_t;
|
||||
|
||||
/**
|
||||
* 同优先级会互相覆盖;红绿要共存必须放在不同优先级,且 handler 返回 0
|
||||
*/
|
||||
typedef enum {
|
||||
PRIORITY_1 = 0, /**< 待机绿灯 */
|
||||
PRIORITY_2, /**< 低电红闪 */
|
||||
PRIORITY_3, /**< 充电红 / 充满绿 */
|
||||
PRIORITY_4, /**< 配对 / 切模式 / 配对结果 / OTA / 5% 关机红闪 */
|
||||
PRIORITY_MAX
|
||||
} LED_EventPriority_t;
|
||||
|
||||
#if (BLINK_ENABLE)
|
||||
typedef struct {
|
||||
uint8_t orDer; /**< 1=先灭后亮,0=先亮后灭 */
|
||||
uint32_t onTime; /**< 亮时间 ms */
|
||||
uint32_t offTime; /**< 灭时间 ms */
|
||||
} LED_BlinkParams_t;
|
||||
#endif
|
||||
|
||||
#if (ALTERNATING_BLINK_ENABLE)
|
||||
#define ALTERNAT_GROUP 2
|
||||
typedef struct {
|
||||
uint16_t Group[ALTERNAT_GROUP]; /**< 交替两组的通道掩码 */
|
||||
uint32_t Cycle; /**< 一整轮交替周期 ms */
|
||||
} LED_AlternatingBlinkParams_t;
|
||||
#endif
|
||||
|
||||
typedef struct {
|
||||
LED_State_t state;
|
||||
uint16_t ledMask; /**< 本事件只动这些通道,其它灯不受影响 */
|
||||
uint16_t runNum; /**< 0=无限;常亮按秒计,闪烁按周期计 */
|
||||
uint32_t currentTime;
|
||||
#if (BLINK_ENABLE)
|
||||
LED_BlinkParams_t blinkParams;
|
||||
#endif
|
||||
#if (ALTERNATING_BLINK_ENABLE)
|
||||
LED_AlternatingBlinkParams_t alternatingBlinkParams;
|
||||
#endif
|
||||
} LED_Config_t;
|
||||
|
||||
typedef struct {
|
||||
LED_Event_t event;
|
||||
LED_EventPriority_t priority;
|
||||
LED_Config_t config;
|
||||
uint8_t (*ledEventHandler)(LED_Config_t *config);
|
||||
} LED_EventTableItem_t;
|
||||
|
||||
typedef void (*LED_SetState_t)(uint16_t led, uint8_t state);
|
||||
typedef uint32_t (*TIME_Get_t)(void);
|
||||
|
||||
/*============================================================================*/
|
||||
/* 外部接口 */
|
||||
/*============================================================================*/
|
||||
|
||||
void LED_SetStateInit(LED_SetState_t setState);
|
||||
void SET_TimeGetInit(TIME_Get_t getTime);
|
||||
void LED_EventTableInit(LED_EventTableItem_t ledEvent[]);
|
||||
void LED_EventAdd(LED_Event_t ledEvent);
|
||||
void LED_EventDelete(LED_Event_t ledEvent);
|
||||
void LED_EventAllDelete(void);
|
||||
void LED_EventHandle(void);
|
||||
uint8_t LED_IsEventActive(void);
|
||||
uint8_t LED_IsEventExist(LED_Event_t ledEvent);
|
||||
uint8_t LED_Update(LED_Config_t *led);
|
||||
|
||||
#endif /* __LED_H__ */
|
||||
Reference in New Issue
Block a user