用于小型嵌入式的定时控制服务

　　　　　　在物联网中，定时控制服务可能是非常非常重要的一种服务，而服务器如何将控制信息，发送给设备，让设备在某时某分周几，每周的星期几，每月的几号开关或者进行其他的控制。下面详细的定义了控制命令的格式：

定时器1；    定时器2；    定时器3；    定时器4；    定时器5；…
每个定时器的格式如下：
秒 分 小时 日 月 周 年 执行命令

序号    说明    范围         允许的通配符      备注
1      秒      0-59         , - * /    
2      分      0-59         , - * /    
3      小时     0-23        , - * /    
4      日      1-31         , - * ? /    
5      月      1-12         , - * /    
6      周      0-6          , - * ? /     0表示星期日
7      年     2000-2099     , - * /    
8    执行命令          SwitchOn SwitchOff LeakTest

通配符说明:
*表示所有值。 例如:在分的字段上设置 "*",表示每一分钟都会触发。
? 表示不指定值。
使用的场景为不需要关心当前设置这个字段的值。例如:要在每月的10号触发一个操作，但不关心是周几，所以需要周位置的那个字段设置为"?" ，后面代码会根据周几和每月几号中的一个去判断是否到达某分时刻
- 表示区间。例如 在小时上设置 "10-12",表示 10,11,12点都会触发。
, 表示指定多个值。
例如在周字段上设置 "1,3,5" 表示周一，周三和周五触发
/用于递增触发。
例如在秒上面设置"5/15" 表示从5秒开始，每增15秒触发(5,20,35,50)。 

常用示例:
0 0 8 * * ? * SwitchOn               每天8点开启
0 0 17 * * ? * SwitchOff             每天17点关闭
0 0 8 ？ * 1-5 * SwitchOn            周一至周五8点开启
0 0 17 ？ * 1-5 * SwitchOff          周一至周五17点关闭
0 0 8 ？ 4-10 1-5 * SwitchOn         4至10月份周一至周五8点开启
0 0 17 ？ 4-10 1-5 * SwitchOff       4至10月份周一至周五17点关闭
0 0 0 1 * ？* LeakTest               每月1号00:00:00进行自测

我们实现以上方法就根据控制信息解析成时间结构体，然后填充，填充后将本地或者网络时间转换成同样的时间结构体，然后去对每一位进行对比（每一位代表一天或者一分，如60分就用8个字节存储，当月日时分秒都是置1时就认为到达了时间结构体），然后响应动作

具体查看已下代码：

　　注意几点写在前面：

1. 　 提供给上层用户的API其实就是几个，具体怎么使用请查看每个函数的作用

• 　　TimerTask（）        　                                                          需在绝对定时器1s调用一次
• 　　UpdateTimeConfigIinfo（）                                                 需在开机配置信息初始化和服务器下达命令时自主调用

__weak bool GetRealTime (struct tm *ptOutTime);                    需要自己根据实际情况填充，如RTC或者实时网络获取等等
__weak bool pTimerOverAction(ETimerActionType eAction);  这两个是虚函数，必须由调用定时模块的用户重新定义，

　　2.    可用于一个设备设置多个定时，当多个设备设置索格定时时，需要修改此代码

　　3. 全部存储方式位小端方式，大神写的大端的存储，算法由于本人实在太菜看不懂，就自己写的一个非常简单的处理方式，实现方法很简单，已下代码已测试，可直接使用

#ifndef __TIMER_MODULE_H
#define __TIMER_MODULE_H
#include <stdio.h>
#include <stdbool.h>
#include <time.h>
#include "tool.h"
#include "ModuleLibOpt.h"


#if   (TIME_MODULE == 1)
#define TIMERS_CONFIG_STR_MAX_LEN     200
#define TIME_STR_FRAME_LEN_MIN         8
#define TIMER_CONTROL_MOUDLE_MAX       4
#define TIMERS_CONIFG_STR_ONCE_LEN     40     /* 逗号字符数量 */



#define TIMER_BITS_NUM_DOW    7
#define TIMER_BITS_NUM_MONS   12
#define TIMER_BITS_NUM_HOURS  24
#define TIMER_BITS_NUM_DAYS   32
#define TIMER_BITS_NUM_MINS   60
#define TIMER_BITS_NUM_SECS   60
#define TIMER_BITS_NUM_YEARS  100

typedef enum {
    TIMER_ACTION_TYPE_UNKNOWN = 0,
    TIMER_ACTION_TYPE_SWITCHON = 1,   /* 开启断路器 */
    TIMER_ACTION_TYPE_SWITCHOFF = 2,  /* 关闭断路器 */
    TIMER_ACTION_TYPE_LEAKTEST = 3,   /* 漏保自检 */
    TIMER_ACTION_TYPE_MAX
}ETimerActionType;

typedef struct TTimerCtl
{
    ETimerActionType m_eAction;
    
    /* orderd by bit */
    uint8_t m_byDow;                    /* 0-6 bit, beginning sunday */
    uint8_t m_abyMons[2];               /* 0-11 bit */
    uint8_t m_abyHrs[3];                /* 0-23 bit */
    uint8_t m_abyDays[4];               /* 1-31 bit */
    uint8_t m_abyMins[8];               /* 0-59 bit */
  uint8_t m_abySecs[8];               /* 0-59 bit */
#if 0 /* Not Support Now */
  uint8_t m_abyYears[13];             /* 0-99 bit, beginning 2000, */
#endif
}TTimerCtl;



typedef struct TIMER_Handle_t
{
    bool             m_TimeStatsus;
    uint8_t   m_byTimersCount;                               /* 定时控制数量 */
    uint8_t   m_abyTimerControl[TIMERS_CONFIG_STR_MAX_LEN];  /* 定时控制 */
    TTimerCtl m_atTimers[TIMER_CONTROL_MOUDLE_MAX];        /* 定时控制，TimerControl配置解析得到 */
}TIMER_Handle;


TIMER_Handle *TimerRegister(void);
bool PerseTimers(char * pbyTimerCtrl,TTimerCtl *ptTimers,uint8_t *pbycnt);
bool PerseField(char *arry,int dwlen,uint8_t bybitCnt,char *pbyBuff);
bool UpdateTimeConfigIinfo(const char *pbydata);
void TimerTask(void);
 
__weak bool GetRealTime (struct tm *ptOutTime);
__weak bool pTimerOverAction(ETimerActionType eAction);


#endif

#endif

TIMER_Handle g_tTimer = { 
        false,
        TIMER_CONTROL_MOUDLE_MAX,
        {0},
        {0}
};
/*====================================================================
  函数名：TimerRegister
  功  能：获取定时模块操作句柄
  输入参数说明:
  输出参数说明:
  返回值说明 ：当前任务操作句柄
  ====================================================================*/

TIMER_Handle *TimerRegister(void)
{
        return &g_tTimer;
}
/*====================================================================
  函数名：GetRealTime
  功  能：获取当前真实时间 
  输入参数说明:
    pbydata     ：控制命令 
  输出参数说明:
  返回值说明 ：
    备        注：需要用户在初始化的时候自己注册
  ====================================================================*/
__weak bool GetRealTime (struct tm *ptOutTime)    
{    
        return true;
}
/*====================================================================
  函数名：UpdateTimeConfigIinfo
  功  能：更新一下定时的命令，服务器下载的时候和从flash读取配置用  
  输入参数说明:
    pbydata     ：控制命令 
  输出参数说明:
  返回值说明 ：
  ====================================================================*/
bool UpdateTimeConfigIinfo(const char *pbydata)
{    
        u16 wRecvLen = 0;
        u8 byTimerCnt = 0;
        bool bRet = false;
        wRecvLen  = strlen((pbydata));
        if( wRecvLen >= TIME_STR_FRAME_LEN_MIN && wRecvLen <= TIMERS_CONFIG_STR_MAX_LEN)
        {    
                memset(g_tTimer.m_abyTimerControl,0,sizeof(g_tTimer.m_abyTimerControl));
                memset(g_tTimer.m_atTimers,0,sizeof(g_tTimer.m_atTimers));
                memcpy(g_tTimer.m_abyTimerControl,pbydata,wRecvLen);
                byTimerCnt = TIMER_CONTROL_MOUDLE_MAX;
                bRet = PerseTimers((char *)(g_tTimer.m_abyTimerControl),g_tTimer.m_atTimers, &byTimerCnt);
                if(bRet)
                {
                            g_tTimer.m_TimeStatsus = true;
                            g_tTimer.m_byTimersCount = byTimerCnt;
                }
        }    
        else
        {
                g_tTimer.m_TimeStatsus = false;
                memset(g_tTimer.m_abyTimerControl,0,sizeof(g_tTimer.m_abyTimerControl));
                memset(g_tTimer.m_atTimers,0,sizeof(g_tTimer.m_atTimers));
        }
}

/*====================================================================
  函数名：pTimerOverAction
  功能：  到达延时，操作响应函数
  输入参数说明:
    ETimerActionType： 操作类型 开/关/自检
  输出参数说明:
  返回值说明 ：
    备        注：需要用户在初始化的时候自己注册
  ====================================================================*/
__weak  bool pTimerOverAction(ETimerActionType eAction)
{
        return true;
}

/*====================================================================
  函数名：TimerTask
  功能：  定时调用函数,绝对定时器中1s调用一次
  输入参数说明:
  输出参数说明:
  返回值说明：
  ====================================================================*/
void TimerTask(void)
{
    u8 byAddr = 0,  byTimerIndex = 0;
    TTimerCtl *ptTimer = NULL;
    struct tm ptm = {0};
    if(false == g_tTimer.m_TimeStatsus)
        return ;
    
    GetRealTime(&ptm);

    if(g_tTimer.m_TimeStatsus)
    {
            for(byTimerIndex = 0; byTimerIndex < g_tTimer.m_byTimersCount; byTimerIndex++)
            {
                ptTimer = &(g_tTimer.m_atTimers[byTimerIndex]);
                if(TestBit(ptTimer->m_abyMins, sizeof(ptTimer->m_abyMins), ptm.tm_min) == true &&
                 TestBit(ptTimer->m_abyHrs, sizeof(ptTimer->m_abyHrs), ptm.tm_hour) == true &&
                 (TestBit(ptTimer->m_abyDays, sizeof(ptTimer->m_abyDays), ptm.tm_mday) == true || TestBit(&(ptTimer->m_byDow), sizeof(ptTimer->m_byDow), ptm.tm_wday) == true) &&
                 TestBit(ptTimer->m_abyMons, sizeof(ptTimer->m_abyMons), ptm.tm_mon) == true)
                {
                        pTimerOverAction(ptTimer->m_eAction);
                }
            }
        }
}

/*====================================================================
  函数名：FixDayDow
  功  能：根据周/日调整，判断使用的是什么定时
  输入参数说明：
    ptTimer     ：时间控制结构体
  输出参数说明：

  返回值说明： 
  ====================================================================*/
static void FixDayDow(TTimerCtl *ptTimer)
{
    unsigned i;
    int weekUsed = 0;
    int daysUsed = 0;

    for (i = 0; i < TIMER_BITS_NUM_DOW; ++i) 
    {
        if (TestBit(&(ptTimer->m_byDow), sizeof(ptTimer->m_byDow), i) == false) 
        {
            weekUsed = 1;
            break;
        }
    }
    for (i = 0; i < TIMER_BITS_NUM_DAYS; ++i)
    {
        if (TestBit(ptTimer->m_abyDays, sizeof(ptTimer->m_abyDays), i) == false) 
        {
            daysUsed = 1;
            break;
        }
    }
    if (weekUsed != daysUsed) 
    {
        if (weekUsed)
            memset(ptTimer->m_abyDays, 0, sizeof(ptTimer->m_abyDays));
        else /* daysUsed */
            memset(&(ptTimer->m_byDow), 0, sizeof(ptTimer->m_byDow));
    }
}

/*====================================================================
  函数名：PerseField
  功  能：解析字段
  输入参数说明：
    dwlen   ：需要保存的数组的长度
    bybitCnt：一共有多少位
    pbyBuff ：待解析字段
  输出参数说明：
        arry ：需要保存的数组
  返回值说明：     解析成功/失败
  ====================================================================*/
bool PerseField(char *arry,int dwlen,uint8_t bybitCnt,char *pbyBuff)
{
        if(NULL == arry || NULL == pbyBuff || dwlen == 0 || bybitCnt == 0 || (bybitCnt / 8 > dwlen))
                return false;
        
        uint8_t i;
        int sta,end;
        char *pBase = pbyBuff;
        const char *delim_t = ",";
        char *token_t = NULL,*saveptr_t = NULL;
        char  byTemp[TIMERS_CONIFG_STR_ONCE_LEN] = {0};
        uint8_t bydiv = bybitCnt / 8; 
        uint8_t byred = bybitCnt % 8 - 1;
        
        if(*pBase == '*' || *pBase == '?')
        {
                for(i =0; i < bybitCnt; i ++ )
                        SetBit(arry,dwlen,i);
        }
        else if(isdigit(*pBase))
        {
                if(NULL != strstr(pBase,"-"))
                {
                    sscanf(pBase,"%d-%d",&sta,&end);
                    for(i =sta; i <= end; i ++ )
                        SetBit(arry,dwlen,i);    
                }
                else if(NULL != strstr(pBase,","))
                {
                     i = 0;
                     memcpy(byTemp,pBase,strlen(pBase));
                      pBase = byTemp;
                     while(NULL != (token_t = strtok_r(pBase,delim_t,&saveptr_t)))
                     {
                            SetBit(arry,dwlen,atoi(token_t));
                          pBase = NULL;
                     }
                }
                else if(NULL != strstr(pBase,"/"))
                {
                    sscanf(pBase,"%d/%d",&sta,&end);
                    for(i =sta; i <= bybitCnt; i += (end - 1))
                        SetBit(arry,dwlen,i);    
                }
                else
                {
                        sscanf(pBase,"%d",&sta);
                        SetBit(arry,dwlen,sta);
                }

        }
        else 
                return false;
    
        return  true;
        
}

/*====================================================================
  函数名：PerseTimers
  功  能：将服务器控制命令解析
  输入参数说明：
        pbyTimerCtrl ：服务下达的控制命令
  输出参数说明：
        TTimerCtl    ：解析成控制命令结构体
        pbycnt       ：解析成的第几个定时器
  返回值说明：     解析成功/失败
  ====================================================================*/
bool PerseTimers(char * pbyTimerCtrl,TTimerCtl *ptTimers,uint8_t *pbycnt)
{
            char  strbuf[TIMERS_CONFIG_STR_MAX_LEN];
            char *pbyPos = strbuf;
            char *token_t = NULL, *saveptr_t =NULL;
            char *token_f = NULL, *saveptr_f =NULL;
            char *delim_t = ";" , *delim_f = " ";
            char *savefield[8];
            uint8_t  byFieldCnt = 0;
            uint8_t  byTimeCnt  = 0;
            uint16_t dwLen = strlen(pbyTimerCtrl);
            TTimerCtl *timer = NULL;
    
            if(NULL == pbyTimerCtrl || NULL == ptTimers || NULL == pbycnt || dwLen > TIMERS_CONFIG_STR_MAX_LEN)
                    return false;
            
            memset(ptTimers,0,sizeof(TTimerCtl));
            memcpy(strbuf,pbyTimerCtrl,strlen(pbyTimerCtrl));
            printf("strbuf:%s
",strbuf);
            while(NULL != (token_t = strtok_r(pbyPos,delim_t,&saveptr_t)))
            {
                while(*token_t == ' ')
                {
                    token_t++;
                }
                printf("token_t:%s
",token_t);
                memset(savefield,0,sizeof(savefield));
                
                while(NULL != (token_f = strtok_r(token_t,delim_f,&saveptr_f)))
                {
                        while(*token_f == ' ')
                        {
                            token_t++;
                        }
                        savefield[byFieldCnt] = token_f;
                        printf("field[%d]:%s
",byFieldCnt,savefield[byFieldCnt]);
                        
                        byFieldCnt++;
                        token_t = NULL;
                }
                
                if(byFieldCnt >= 8)
                {
                        timer = &ptTimers[byTimeCnt];
                        
                        PerseField((char *)timer->m_abySecs,sizeof(timer->m_abySecs),TIMER_BITS_NUM_SECS,savefield[0]);
                        PerseField((char *)timer->m_abyMins,sizeof(timer->m_abyMins),TIMER_BITS_NUM_MINS,savefield[1]);
                        PerseField((char *)timer->m_abyHrs, sizeof(timer->m_abyHrs),TIMER_BITS_NUM_HOURS,savefield[2]);
                        PerseField((char *)timer->m_abyDays,sizeof(timer->m_abyDays),TIMER_BITS_NUM_DAYS,savefield[3]);
                        PerseField((char *)timer->m_abyMons,sizeof(timer->m_abyMons),TIMER_BITS_NUM_MONS,savefield[4]);
                        PerseField((char *)&(timer->m_byDow),sizeof(timer->m_byDow),  TIMER_BITS_NUM_DOW,savefield[5]);
                        /* year not surport now */
                }
                
                FixDayDow(timer);
                
                if(strcmp(savefield[7], "SwitchOn") == 0)
                {
                    timer->m_eAction = TIMER_ACTION_TYPE_SWITCHON;
                }
                else if(strcmp(savefield[7], "SwitchOff") == 0)
                {
                    timer->m_eAction = TIMER_ACTION_TYPE_SWITCHOFF;
                }
                else if(strcmp(savefield[7], "LeakTest") == 0)
                {
                    timer->m_eAction = TIMER_ACTION_TYPE_LEAKTEST;
                }
                else
                {
                    continue;
                }
                
                byTimeCnt++;
                byFieldCnt = 0;
                pbyPos = NULL;
            }
            *pbycnt = byTimeCnt;
            return true;
    
}

/*====================================================================
  函数名：SetBit
  功  能：将字符串的某一位置1
  输入参数说明：
             date ：传入的字符串
                byCnt:传入字节数
                byBit:第几位
  输出参数说明：
    
  返回值说明：   
  ====================================================================*/
void SetBit(char *date,uint8_t byCnt,uint8_t byBit)
{    
            if(byBit / 8 >= byCnt) return ;
            uint8_t bydiv = byBit / 8; 
            uint8_t byred = byBit % 8;
            
            *(date + bydiv) |= 1 << byred;
             printf("byBit:%d date:%02x
",byBit,*(date + bydiv));
}



/*====================================================================
  函数名：TestBit
  功  能：判断某位是否置1
  输入参数说明：
    pbydata   ：传入数组
    byCnt     ：传入数组长度
    byBit     ：待判断的位
  输出参数说明：

  返回值说明： 置1/置0
  ====================================================================*/
bool TestBit(uint8_t *pbydata,uint8_t byCnt,uint8_t byBit)
{
        if(byBit / 8 >= byCnt) return false;
    
        uint8_t *pBytePos  = NULL;
        uint8_t  pBitPos  =  byBit % 8;
    
        pBytePos  = pbydata + byBit / 8;
    
        if(*pBytePos & (1 << pBitPos))
        {
                return true;
        }
        else
        {
                return false;
        }
}

/*====================================================================
  函数名：SetBit
  功  能：将字符串的某一位置1
  输入参数说明：
             date ：传入的字符串
                byCnt:传入字节数
                byBit:第几位
  输出参数说明：
    
  返回值说明：   
  ====================================================================*/
void SetBit(char *date,uint8_t byCnt,uint8_t byBit)
{    
            if(byBit / 8 >= byCnt) return ;
            uint8_t bydiv = byBit / 8; 
            uint8_t byred = byBit % 8;
            
            *(date + bydiv) |= 1 << byred;
             printf("byBit:%d date:%02x
",byBit,*(date + bydiv));
}



/*====================================================================
  函数名：TestBit
  功  能：判断某位是否置1
  输入参数说明：
    pbydata   ：传入数组
    byCnt     ：传入数组长度
    byBit     ：待判断的位
  输出参数说明：

  返回值说明： 置1/置0
  ====================================================================*/
bool TestBit(uint8_t *pbydata,uint8_t byCnt,uint8_t byBit)
{
        if(byBit / 8 >= byCnt) return false;
    
        uint8_t *pBytePos  = NULL;
        uint8_t  pBitPos  =  byBit % 8;
    
        pBytePos  = pbydata + byBit / 8;
    
        if(*pBytePos & (1 << pBitPos))
        {
                return true;
        }
        else
        {
                return false;
        }
}