xt-sdk 文档 v1.0.3
xt-sdk 嵌入式 SDK API 参考
载入中...
搜索中...
未找到
xt_sdk_version(SDK 版本号)

XTINY SDK 版本定义与查询接口 更多...

宏定义

#define XT_SDK_VERSION_MAJOR   1
#define XT_SDK_VERSION_MINOR   0
#define XT_SDK_VERSION_PATCH   3
#define _SDK_STR(x)
#define XT_SDK_STR(x)
#define XT_SDK_VERSION_NUM   ((XT_SDK_VERSION_MAJOR << 16) + (XT_SDK_VERSION_MINOR << 8) + XT_SDK_VERSION_PATCH)
#define XT_SDK_VERSION   "v" XT_SDK_STR(XT_SDK_VERSION_MAJOR) "." XT_SDK_STR(XT_SDK_VERSION_MINOR) "." XT_SDK_STR(XT_SDK_VERSION_PATCH)

函数

uint32_t xt_sdk_get_version (void)
 获取SDK版本号(数值形式)
const char * xt_sdk_get_version_str (void)
 获取SDK版本号(字符串形式)
const char * xt_sdk_get_git_version (void)
 获取SDK Git版本信息
uint8_t xt_sdk_get_is_dirty (void)
 获取SDK仓库是否有未提交修改
const char * xt_sdk_get_platform_git_version (void)
 获取平台Git版本信息
uint8_t xt_sdk_get_platform_is_dirty (void)
 获取平台仓库是否有未提交修改

详细描述

XTINY SDK 版本定义与查询接口

宏定义说明

◆ _SDK_STR

#define _SDK_STR ( x)
值:
#x

在文件 xt_sdk_version.h 第 40 行定义.

◆ XT_SDK_STR

#define XT_SDK_STR ( x)
值:
#define _SDK_STR(x)

在文件 xt_sdk_version.h 第 44 行定义.

◆ XT_SDK_VERSION

在文件 xt_sdk_version.h 第 51 行定义.

◆ XT_SDK_VERSION_MAJOR

#define XT_SDK_VERSION_MAJOR   1

在文件 xt_sdk_version.h 第 34 行定义.

◆ XT_SDK_VERSION_MINOR

#define XT_SDK_VERSION_MINOR   0

在文件 xt_sdk_version.h 第 35 行定义.

◆ XT_SDK_VERSION_NUM

#define XT_SDK_VERSION_NUM   ((XT_SDK_VERSION_MAJOR << 16) + (XT_SDK_VERSION_MINOR << 8) + XT_SDK_VERSION_PATCH)

在文件 xt_sdk_version.h 第 48 行定义.

◆ XT_SDK_VERSION_PATCH

#define XT_SDK_VERSION_PATCH   3

在文件 xt_sdk_version.h 第 36 行定义.

函数说明

◆ xt_sdk_get_git_version()

const char * xt_sdk_get_git_version ( void )

获取SDK Git版本信息

返回
指向Git版本字符串的指针,格式为Git提交哈希值,若仓库有未提交修改则附加"-dirty"

◆ xt_sdk_get_is_dirty()

uint8_t xt_sdk_get_is_dirty ( void )

获取SDK仓库是否有未提交修改

返回
0表示仓库干净,1表示仓库有未提交修改

◆ xt_sdk_get_platform_git_version()

const char * xt_sdk_get_platform_git_version ( void )

获取平台Git版本信息

返回
指向平台Git版本字符串的指针,格式为Git提交哈希值,若仓库有未提交修改则附加"-dirty";若平台非独立仓库则返回与SDK相同的Git版本

◆ xt_sdk_get_platform_is_dirty()

uint8_t xt_sdk_get_platform_is_dirty ( void )

获取平台仓库是否有未提交修改

返回
0表示平台仓库干净,1表示平台仓库有未提交修改

◆ xt_sdk_get_version()

uint32_t xt_sdk_get_version ( void )

获取SDK版本号(数值形式)

返回
SDK版本号,格式为 MAJOR<<16 | MINOR<<8 | PATCH

◆ xt_sdk_get_version_str()

const char * xt_sdk_get_version_str ( void )

获取SDK版本号(字符串形式)

返回
指向版本号字符串的指针,格式为 "VMAJOR.MINOR.PATCH"