“LED 闪烁控制软件模块”的版本间的差异

来自谷雨文档中心
跳转至： 导航、 搜索
（初版正在进行中）
第222行： 第222行：
 
#define LED_BLINK4_OFF_MS  (LED_BLINK4_PERIOD - LED_BLINK4_ON_MS)
 
#define LED_BLINK4_OFF_MS  (LED_BLINK4_PERIOD - LED_BLINK4_ON_MS)
 
</syntaxhighlight>
 
</syntaxhighlight>
 +
 +
===== 闪烁次数定义 =====
 +
在代码中，各个闪烁状态都有相应的次数限制。其中0表示此状态闪烁结束，将进行下一个状态，0xFF表示永久闪烁，直到当前状态被人为改变，即闪烁次数被置零，或改为其他数值；或被弹出。<syntaxhighlight lang="c" line="1">
 +
#define LED_BLINK_STOP      0
 +
#define LED_BLINK_FOREVER  0xFF
 +
</syntaxhighlight>
 +
 +
===== 应用函数声明 =====
 +
在用户层提供了两种方式。一种是普通模式，一种是栈模式。
 +
 +
普通模式中，开发者只需调用LED_Set函数，即可对当前led状态进行设置。状态结束后，led处在灭状态，等待用户进行下个状态设置。而在栈模式中，开发者调用LED_StackPush函数时，会将led状态压入栈中，并设置led状态。当led闪烁状态结束后，继续之前led状态，直到栈空为至。当然在这个过程中开发者也可以调用LED_Set函数，对当前led闪烁状态进行设置。只是led闪烁状态结束后会继续栈的上个led状态，而不会继续LED_Set函数调用前的状态。<syntaxhighlight lang="c" line="1">
 +
/*initial led module*/
 +
void LED_Init(void);
 +
/*set the led status*/
 +
void LED_Set(eLEDStatus,uint8_t times);
 +
 +
#ifdef LED_PRORITY_EN
 +
/*push the led status to ledstack.it will be placed at the top*/
 +
bool LED_StackPush(eLEDStatus,uint8_t times);
 +
 +
/*pop the top node from ledstack*/
 +
void LED_StackPop(void);
 +
 +
/*clear stack*/
 +
void LED_StackClear(void);
 +
#endif
 +
 +
</syntaxhighlight>其中与栈有关的函数是通过宏LED_PRORITY_EN来控制。
 +
 +
{| class="wikitable"
 +
|+
 +
!函数名
 +
!解释
 +
!
 +
|-
 +
|void LED_Init(void)
 +
|对LED闪烁模块进行初始化。在任何函数调用之前进行调用
 +
|
 +
|-
 +
|void LED_Set( eLEDStatus status，uint8_t times)
 +
|设置led闪烁状态
 +
status：设置的led状态
 +
 +
times：闪烁次数
 +
|
 +
|-
 +
|bool LED_StackPush(eLEDStatus status, uint8_t times)
 +
|设置led闪烁状态，并压入栈中
 +
status：设置的led状态
 +
 +
times：闪烁次数
 +
|
 +
|-
 +
|void LED_StackPop(void)
 +
|弹出栈顶状态
 +
|
 +
|-
 +
|void LED_StackClear(void)
 +
|清空栈里所有led状态，并将led设置灭状态
 +
|
 +
|}

2019年12月9日 (一) 16:22的版本

LED闪烁功能，作为常用需求。将其归纳为软件模块，与其他项目或工程共享原代码。

1 文件组成

功能模块由六个文件组成，分别承载不同作用。

文件名称 作用
bsp_status_led.c 对应用层函数进行定义
bsp_status_led.h 对应用层函数进行声明
ledConfig.c 对硬件操作接口进行抽象
ledConfig.h 对硬件操作接口进行声明
hal_led.c 对硬件接口进行定义
hal_led.h 对硬件接口进行声明

在LED闪烁功能模块中，用到硬件包括一个GPIO引脚，一个定时器。开发者需要根据自身硬件情况，自行选择相应的硬件。并将这些硬件按要求实现相应的函数。这些函数在hal_led.h与hal_led.c文件中进行声明与定义。

1.1 hal_led.h与hal_led.c

 1 /*定时器超时回调函数指针*/
 2 typedef void (*fnTimerTimeoutCb_t)(bool);
 3 
 4 //******************************************************************************
 5 // function declare
 6 /*Create a timer*/
 7 void HalLed_TimerInit(fnTimerTimeoutCb_t pFnTimeoutCb);
 8 
 9 /*Start timer*/
10 void HalLed_TimerStart(uint32_t ms, void *pContext);
11 /*Stop timer*/
12 void HalLed_TimerStop(void);
13 /*Pin init*/
14 void HalLed_PinInit(void);
15 /*Pin set */
16 void HalLed_PinSet(bool level);

各函数功能及形参解释说明，如下表所示。

函数名 解释
HalLed_TimerInit(fnTimerTimeoutCb_t pFnTimeoutCb) 创建一个定时器，且定时器能达到秒级的周期。

pFnTimeoutCb：是定时器超时回调函数指针

HalLed_Timerstart(uint32_t ms, void *pContext) 启动定时器。

ms：是定时周期

pContext：传入的参数指针，会在超时回调函数中使用

HalLed_Timerstop(void) 停止定时器
HalLed_PinInit(void) 初始化与LED相连的GPIO引脚，并保持LED灭状态
HalLed_PinSet(void) 设置GPIO的高低电平，即控制LED亮灭。

level：true ->LED亮

false -> LED灭 

 1 //******************************************************************************
 2 // fn : HalLed_TimerInit
 3 //
 4 // brief: Create a time object for blink led
 5 //
 6 // param : pFnTimeoutCb -> the timeout cb
 7 //
 8 // return : none
 9 void HalLed_TimerInit(fnTimerTimeoutCb_t pFnTimeoutCb)
10 {
11 
12 }
13 
14 //******************************************************************************
15 // fn : HalLed_TimerStart
16 //
17 // brief: Start timer
18 //
19 // param : ms -> the timeout ,unit = ms
20 //
21 // return : none
22 void HalLed_TimerStart(uint32_t ms,void *pContext)
23 {
24   
25 }
26 
27 //******************************************************************************
28 // fn : HalLed_TimerStop
29 //
30 // brief: Stop timer
31 //
32 // param : ms -> the timeout ,unit = ms
33 //
34 // return : none
35 void HalLed_TimerStop(void)
36 {
37 
38 }
39 
40 //******************************************************************************
41 // fn : HalLed_PinInit
42 //
43 // brief: Pin init
44 //
45 // param : none
46 //
47 // return : none
48 void HalLed_PinInit(void)
49 {
50 
51 }
52 
53 //******************************************************************************
54 // fn : HalLed_PinInit
55 //
56 // brief: Pin set 
57 //
58 // param : level -> true -> open,false -> off
59 //
60 // return : none
61 void HalLed_PinSet(bool level)
62 {
63   
64 }

1.2 ledConfig.h与ledConfig.c

ledConfig.h与ledConfig.c是对LED闪烁模块的硬件进行抽象，即hal_led.h与hal_led.c中定义的功能函数。 

 1 /*定时器初始化函数指针*/
 2 typedef void (*fnTimerInit_t)(fnTimerTimeoutCb_t);
 3 /*定时器启动函数指针*/
 4 typedef void (*fnTimerStart_t)(uint32_t ms,void*pContext);
 5 
 6 /*定时器停止函数指针*/
 7 typedef void (*fnTimerStop_t)(void);
 8 
 9 /*Led 引脚初始化函数指针*/
10 typedef void (*fnPinInit_t)(void);
11 /*Led 引脚高低电平设置函数指针*/
12 typedef void (*fnPinLevelSet_t)(bool level);
13 
14 //******************************************************************************
15 // Name : ledBlinkCfg_t
16 //
17 // Brief : 描述LED闪烁控制接口函数
18 typedef struct
19 {
20   fnTimerInit_t    fnTimerInit;
21   fnTimerStart_t   fnTimerStart;
22   fnTimerStop_t    fnTimerStop;
23   fnPinInit_t      fnPinInit;
24   fnPinLevelSet_t  fnPinLevelSet;
25   
26 }ledModuleCfg_t;
27   
28 extern ledModuleCfg_t  ledModule;

hal_led.h就是根据ledConfig.h声明函数接口进行定义的。

其中结构体ledModuleCfg_t就是对硬件层进行抽象。其中包括定时器定义，定时器启动，定时器停止，引脚gpio初始化，引脚高低电平设置。 

1 /*led operate interface*/
2 ledModuleCfg_t  ledModule = {
3   .fnTimerInit   = HalLed_TimerInit,
4   .fnTimerStart  = HalLed_TimerStart,
5   .fnTimerStop   = HalLed_TimerStop,
6   .fnPinInit     = HalLed_PinInit,
7   .fnPinLevelSet = HalLed_PinSet
8 };

1.3 bsp_status_led.h 与bsp_status_led.c

这两个文件是开发者可以调用函数的声明与定义。开发者可以调用相应函数对LED闪烁状态进行设置。led支持如下6种状态。

 1 typedef enum
 2 {
 3   LED_STATUS_OFF,          //关闭
 4   LED_STATUS_ON,           //常亮
 5   LED_STATUS_BLINK1,       //闪烁1，周期200ms,占空比50：亮100，灭100
 6   LED_STATUS_BLINK2,       //闪烁2，周期1000，占空比10：亮100，灭900
 7   LED_STATUS_BLINK3,       //闪烁3，周期1000，占空比50：亮500，灭500
 8   LED_STATUS_BLINK4,       //闪烁4，周期2000，占空比5： 亮100，灭1900
 9   LED_STATUS_END
10 }eLEDStatus;

当然开发者也可以，根据自己的需求，对led闪烁状态进行修改。包括周期，占空比。具体修改的地方在bsp_status_led.c文件头部。各个闪烁状态由宏定义定义，如下。

 1 #define LED_BLINK1_PERIOD   200
 2 #define LED_BLINK1_DUTY     50
 3 #define LED_BLINK1_ON_MS    100
 4 #define LED_BLINK1_OFF_MS   (LED_BLINK1_PERIOD - LED_BLINK1_ON_MS)
 5 
 6 #define LED_BLINK2_PERIOD   1000
 7 #define LED_BLINK2_DUTY     10
 8 #define LED_BLINK2_ON_MS    100
 9 #define LED_BLINK2_OFF_MS   (LED_BLINK2_PERIOD - LED_BLINK2_ON_MS)
10 
11 #define LED_BLINK3_PERIOD   1000
12 #define LED_BLINK3_DUTY     50
13 #define LED_BLINK3_ON_MS    500
14 #define LED_BLINK3_OFF_MS   (LED_BLINK3_PERIOD - LED_BLINK3_ON_MS)
15 
16 #define LED_BLINK4_PERIOD   2000
17 #define LED_BLINK4_DUTY     5
18 #define LED_BLINK4_ON_MS    100
19 #define LED_BLINK4_OFF_MS   (LED_BLINK4_PERIOD - LED_BLINK4_ON_MS)
1.3.1 闪烁次数定义

在代码中，各个闪烁状态都有相应的次数限制。其中0表示此状态闪烁结束，将进行下一个状态，0xFF表示永久闪烁，直到当前状态被人为改变，即闪烁次数被置零，或改为其他数值；或被弹出。

1 #define LED_BLINK_STOP      0
2 #define LED_BLINK_FOREVER   0xFF
1.3.2 应用函数声明

在用户层提供了两种方式。一种是普通模式，一种是栈模式。

普通模式中，开发者只需调用LED_Set函数，即可对当前led状态进行设置。状态结束后，led处在灭状态，等待用户进行下个状态设置。而在栈模式中，开发者调用LED_StackPush函数时，会将led状态压入栈中，并设置led状态。当led闪烁状态结束后，继续之前led状态，直到栈空为至。当然在这个过程中开发者也可以调用LED_Set函数，对当前led闪烁状态进行设置。只是led闪烁状态结束后会继续栈的上个led状态，而不会继续LED_Set函数调用前的状态。

 1 /*initial led module*/
 2 void LED_Init(void);
 3 /*set the led status*/
 4 void LED_Set(eLEDStatus,uint8_t times);
 5 
 6 #ifdef LED_PRORITY_EN
 7 /*push the led status to ledstack.it will be placed at the top*/
 8 bool LED_StackPush(eLEDStatus,uint8_t times);
 9 
10 /*pop the top node from ledstack*/
11 void LED_StackPop(void);
12 
13 /*clear stack*/
14 void LED_StackClear(void);
15 #endif

其中与栈有关的函数是通过宏LED_PRORITY_EN来控制。

函数名 解释
void LED_Init(void) 对LED闪烁模块进行初始化。在任何函数调用之前进行调用
void LED_Set( eLEDStatus status，uint8_t times) 设置led闪烁状态

status：设置的led状态

times：闪烁次数

bool LED_StackPush(eLEDStatus status, uint8_t times) 设置led闪烁状态，并压入栈中

status：设置的led状态

times：闪烁次数

void LED_StackPop(void) 弹出栈顶状态
void LED_StackClear(void) 清空栈里所有led状态，并将led设置灭状态

本PDF由谷雨文档中心自动生成，点击下方链接阅读最新内容。

取自“http://doc.iotxx.com/index.php?title=LED_闪烁控制软件模块&oldid=2507”