跳转至

hmeta - 硬件元数据

以下为关键点梳理

一、模块概述

hmeta 模块主要用于展示当前硬件的能力和获取硬件相关信息,帮助开发者了解底层硬件的特性与状态。目前,该库仍在开发中,但已具备一些实用功能。

二、功能与用法

(一)获取模组名称

  • 函数hmeta.model()
  • 参数 :无
  • 返回值 :返回当前模组的名称,用于区分不同的硬件模组。
  • 示例

  • 在任务初始化函数中,通过循环调用 hmeta.model(),每隔 3 秒打印一次模组名称,同时打印 bsp(板级支持包)信息,便于识别底层模组类型和对应的 bsp。

(二)获取模组的硬件版本号

  • 函数hmeta.hwver()
  • 参数 :无
  • 返回值 :返回模组的硬件版本号,帮助开发者了解硬件的具体版本情况。
  • 示例

  • 在任务初始化函数中,通过循环调用 hmeta.model()hmeta.hwver(),每隔 3 秒打印模组名称和硬件版本号,同时打印 bsp 信息,全面展示模组的硬件信息。

(三)获取原始芯片型号

  • 函数hmeta.chipid()
  • 参数 :无
  • 返回值 :返回原始芯片型号,若底层正确实现,该函数总会返回值。
  • 示例 :无明确示例,但可参考其他函数的调用方式,在需要获取芯片型号时直接调用该函数。

三、其他信息

  1. 开发状态 :hmeta 模块还在不断完善中,未来可能会新增更多功能。
  2. 示例说明 :示例代码展示了如何在任务中周期性地获取和打印模组信息,体现了该模块在实际开发中的应用场景,即帮助开发者快速了解和识别硬件环境。

以下为详细说明

hmeta.model()

获取模组名称

参数

返回值

返回值类型 解释
string 若能识别到,返回模组类型, 否则会是nil

例子

sys.taskInit(function()
    while 1 do
        sys.wait(3000)
        -- hmeta识别底层模组类型的
        -- 不同的模组可以使用相同的bsp,但根据封装的不同,根据内部数据仍可识别出具体模块
        log.info("hmeta", hmeta.model())
        log.info("bsp",   rtos.bsp())
    end
end)

hmeta.hwver()

获取模组的硬件版本号

参数

返回值

返回值类型 解释
string 若能识别到,返回模组类型, 否则会是nil

例子

sys.taskInit(function()
    while 1 do
        sys.wait(3000)
        -- hmeta识别底层模组类型的
        -- 不同的模组可以使用相同的bsp,但根据封装的不同,根据内部数据仍可识别出具体模块
        log.info("hmeta", hmeta.model(), hmeta.hwver())
        log.info("bsp",   rtos.bsp())
    end
end)

hmeta.chip()

获取原始芯片型号

参数

返回值

返回值类型 解释
string 若能识别到,返回芯片类型, 否则会是nil

例子

-- 若底层正确实现, 这个函数总会返回值
-- 本函数于 2024.12.5 新增