利用宏定义__DATE__和__TIME__做软件版本控制

jiangyy · 发表于 2020-5-27 17:20:57

本帖最后由 jiangyy 于 2020-12-2 17:39 编辑

大家可能在做项目的时候，遇到版本日期时间的问题，怎么知道我软件版本发布的具体时间和日期，可能有些人使用RTC时间/日期或flash固化时间/日期，每次上电将RTC时间/日期或flash固化时间/日期赋值到某些变量上面，然后通过协议将时间/日期传递给下位机来显示。可是在这里会面临一个问题，如果软件版本迭代比较多（比如隔日或隔月修改一次），那么可能会要手动去修改RTC时间/日期或flash固化时间/日期，而且有时候粗心大意会修改错误，感觉比较繁琐，怎样用一种好的办法，不需要手动去修改？答案肯定是有的，最近在百度搜索到一篇文章，发现MDK5编译器编译的时候，确实有时间/日期的打印信息。具体实现办法如下：

一、建立一个.c文件，.h文件

/*
* bsp_common.c
*
* Created on: 2020年11月10日
* Author: jiangyuanyuan
*/
#include "bsp_common.h"
#define YEAR ((((__DATE__[7] - '0') * 10 + (__DATE__[8] - '0')) * 10 \
+ (__DATE__[9] - '0')) * 10 + (__DATE__[10] - '0'))
#define MONTH ((__DATE__[1] == 'a' && __DATE__[2] == 'n') ? 1 \
: __DATE__[2] == 'b' ? 2 \
: __DATE__[2] == 'r' ? (__DATE__[0] == 'M' ? 3 : 4) \
: __DATE__[2] == 'y' ? 5 \
: __DATE__[2] == 'n' ? 6 \
: __DATE__[2] == 'l' ? 7 \
: __DATE__[2] == 'g' ? 8 \
: __DATE__[2] == 'p' ? 9 \
: __DATE__[2] == 't' ? 10 \
: __DATE__[2] == 'v' ? 11 : 12)
#define DAY ((__DATE__[4] == ' ' ? 0 : __DATE__[4] - '0') * 10 \
+ (__DATE__[5] - '0'))
#define HOUR ((__TIME__[0] == ' ' ? 0 : __TIME__[0] - '0') * 10 \
+ (__TIME__[1] - '0'))
#define MINUTE ((__TIME__[3] == ' ' ? 0 : __TIME__[3] - '0') * 10 \
+ (__TIME__[4] - '0'))
#define SECOND ((__TIME__[6] == ' ' ? 0 : __TIME__[6] - '0') * 10 \
+ (__TIME__[7] - '0'))
Soft_Ver sSoft_Ver;
u32 get_ver(void)
{
u32 ver;
sSoft_Ver.ucMany = VER_MANY;//Bit26~ Bit31:固件大量改动（主版本），默认值0
sSoft_Ver.ucLocal = VER_LOCAL;//Bit18~ Bit25:固件局部改动（次版本），默认值0
sSoft_Ver.ucCustom = VER_CUSTOM;//Bit14~ Bit17:固件细节改动（测试/定制版本），默认值0
sSoft_Ver.usYear = YEAR - 2019;//Bit10~ Bit13:年（2020 = 1，2034 = 15），默认值1
sSoft_Ver.ucMonth = MONTH;//Bit06~ Bit9:月（1~12）
sSoft_Ver.ucDay = DAY;//Bit00~ Bit05:日（1~31）
ver = sSoft_Ver.ucDay | (sSoft_Ver.ucMonth << 6) | (sSoft_Ver.usYear << 10) | (sSoft_Ver.ucCustom << 14) | (sSoft_Ver.ucLocal << 18) | (sSoft_Ver.ucMany << 26);
return ver;
// printf ("Date:%d-%d-%d\r\n", sRevision_Dat.usYear,sRevision_Dat.ucMonth,sRevision_Dat.ucDay);
// printf ("Time:%d:%d:%d\r\n", sRevision_Dat.ucHour,sRevision_Dat.ucMinute,sRevision_Dat.ucSecond);
}

复制代码

/*
* bsp_common.h
*
* Created on: 2020年11月10日
* Author: jiangyuanyuan
*/
#ifndef INC_BSP_COMMON_H_
#define INC_BSP_COMMON_H_
#include "stdio.h"
#include "mytype.h"
#include "bsp_sys.h"
#ifdef COMMON_GLOBALS
#define COMMON_EXT
#else
#define COMMON_EXT extern
#endif
#ifdef __SINGLE_MODE_ //单模
#define VER_MANY 1 //固件大量改动（主版本）
#define VER_LOCAL 0 //固件局部改动（次版本）
#define VER_CUSTOM 0 //固件细节改动（测试/定制版本）
#else //多模
#define VER_MANY 2 //固件大量改动（主版本）
#define VER_LOCAL 0 //固件局部改动（次版本）
#define VER_CUSTOM 0 //固件细节改动（测试/定制版本）
#endif
typedef struct
{
u8 ucMany:6;
u8 ucLocal:8;
u8 ucCustom:4;
u8 usYear:4;
u8 ucMonth:4;
u8 ucDay:6;
}Soft_Ver;
extern Soft_Ver sSoft_Ver;
u32 get_ver(void);
#endif /* INC_BSP_COMMON_H_ */

复制代码

希望上面分享的信息能对你后期的项目有帮助，我在自己的项目用得到。赞一个或者留个小红花，谢谢，爱你么么哒~~

华山剑客 · 发表于 2020-5-27 17:20:57

帮顶，大家来帮忙解答一下。。

jiangyy · 发表于 2020-5-27 17:30:43

华山剑客发表于 2020-5-27 17:20
帮顶，大家来帮忙解答一下。。

我这是分享，不需要解答，谢谢

jiangyy · 发表于 2020-5-28 14:50:49

本帖最后由 jiangyy 于 2020-6-2 15:36 编辑

更新一下算法

jiangyy · 发表于 2020-6-2 15:36:14

jiangyy · 发表于 2020-12-2 17:35:15

已修复代码，已贴上分享给大家。

旮旯旭 · 发表于 2020-12-2 17:49:45

jiangyy 发表于 2020-12-2 17:35
已修复代码，已贴上分享给大家。

华丽花哨看不懂，这部分代码的意思是把编译器生成代码的时间记录到程序里面，
然后给的那个接口可以查询到生成的时间，作为版本信息吗？

jiangyy · 发表于 2020-12-2 18:07:28

旮旯旭发表于 2020-12-2 17:49
华丽花哨看不懂，这部分代码的意思是把编译器生成代码的时间记录到程序里面，
然后给的那个接口可以查询 ...

是的，项目一般用得到。

旮旯旭 · 发表于 2020-12-2 18:14:40

jiangyy 发表于 2020-12-2 18:07
是的，项目一般用得到。

试着打印了下是这个东西，今天学到了不少啊

可以安心的睡个好觉了，嘎嘎！

jiangyy · 发表于 2020-12-2 18:28:29

旮旯旭发表于 2020-12-2 18:14
试着打印了下是这个东西，今天学到了不少啊

可以安心的睡个好觉了，嘎嘎！

ufbycd · 发表于 2020-12-2 21:39:15

jiangyy 发表于 2020-12-2 18:28

用时间做软件版本其实作用不大。

真正的软件版本控制是要用git之类的软件版本控制系统，并且软件代码的版本号要有两个特性：

软件版本号能够要编译时自动生成；
软件版本号能够跟版本控制系统挂钩。

git版本控制系统在软件发布时，会对代码仓库用git tag命令打一个标签，如：V0.3，而用命令git describe可以获取代码仓库的直观的版本标记，如：V0.3-15-ga39d965。
于是，就可以要写一个脚本基于git describe命令生成软件版本号头文件，如：version.h，而在IDE的编译步骤中设置在编译工程前执行这个脚本，即可实现这两个特性。
获取生成软件版本号的脚本如下：

#!/usr/bin/python
import sys
import os
import time
version_file_fmt = '''#ifndef VERSION_H_
#define VERSION_H_
#define VERSION "{version}"
#define BUILD "{build}"
#define CONFIG "{config}"
#endif /* VERSION_H_ */
'''
filePath = sys.argv[1]
print("Generating: {}".format(filePath))
if len(sys.argv) > 2:
config = sys.argv[2]
else:
config = ""
cmd = "git describe --always --dirty"
output = os.popen(cmd)
describe = output.read()
lt = time.localtime()
if 'dirty' in describe:
dirty = time.strftime("%Y%m%d%H%M", lt)
version = describe.replace('dirty', dirty)
else:
version = describe
version = version.replace('\n', '')
build = time.strftime("%Y-%m-%d %H:%M:%S", lt)
version_file_string = version_file_fmt.format(version=version, build=build, config=config)
print("version: {}\nbuild : {}\nconfig : {}".format(version, build, config))
with open(filePath, 'w') as version_file:
version_file.write(version_file_string)