mcu - 封装mcu一些特殊操作#

已适配 Air780E/Air700E Air780EP/Air780EPV Air601 Air101/Air103 Air105 ESP32C3 ESP32S3

备注

本页文档由这个文件自动生成。如有错误,请提交issue或帮忙修改后pr,谢谢!

常量#

常量

类型

解释

mcu.UART

number

外设类型-串口

mcu.I2C

number

外设类型-I2C

mcu.SPI

number

外设类型-SPI

mcu.PWM

number

外设类型-PWM

mcu.GPIO

number

外设类型-GPIO

mcu.I2S

number

外设类型-I2S

mcu.LCD

number

外设类型-LCD

mcu.CAM

number

外设类型-CAM

mcu.setClk(mhz)#

设置主频,单位MHZ

参数

传入值类型

解释

int

主频,根据设备的不同有不同的有效值,请查阅手册

返回值

返回值类型

解释

bool

成功返回true,否则返回false

例子

-- 注意: 并非所有模块都支持主频调整,请查阅手册
-- Air101/Air103/Air601 支持设置成 2/40/80/160/240. 特别提醒, 设置到2M后, 如果要休眠, 必须先设置到80M
-- ESP32系列支持设置成 40/80/160/240 , 需要2024.1.1之后的固件
-- Air780系列, Air105, 不支持设置主频
-- Air780系列, 进入休眠模式时自动降频到24M

-- 设置到80MHZ
mcu.setClk(80)
sys.wait(1000)
-- 设置到240MHZ
mcu.setClk(240)
sys.wait(1000)
-- 设置到2MHZ
mcu.setClk(2)
sys.wait(1000)

mcu.getClk()#

获取主频,单位MHZ

参数

返回值

返回值类型

解释

int

若失败返回-1,否则返回主频数值,若等于0,可能处于32k晶振的省电模式

例子

local mhz = mcu.getClk()
print("Boom", mhz)

mcu.unique_id()#

获取设备唯一id. 注意,可能包含不可见字符,如需查看建议toHex()后打印

参数

返回值

返回值类型

解释

string

设备唯一id.若不支持, 会返回空字符串.

例子

local unique_id = mcu.unique_id()
print("unique_id", unique_id)

mcu.ticks()#

获取启动后的tick数,本身是无符号值,范围0~0xffffffff,lua是有符号计算,计算时超过0x7fffffff会变负数

参数

返回值

返回值类型

解释

int

当前tick值

例子

local tick = mcu.ticks()
print("ticks", tick)
-- 如需不会溢出的值, 可用mcu.ticks32(), 于2024.5.7新增

mcu.hz()#

获取每秒的tick数量

参数

返回值

返回值类型

解释

int

每秒的tick数量,通常为1000

例子

local hz = mcu.hz()
print("mcu.hz", hz)

mcu.reg32(address, value, mask)#

读写mcu的32bit寄存器或者ram,谨慎使用写功能,请熟悉mcu的寄存器使用方法后再使用

参数

传入值类型

解释

int

寄存器或者ram地址

int

写入的值,如果没有,则直接返回当前值

int

位掩码,可以对特定几个位置的bit做修改, 默认0xffffffff,修改全部32bit

返回值

返回值类型

解释

int

返回当前寄存的值

例子

local value = mcu.reg32(0x2009FFFC, 0x01, 0x01) --对0x2009FFFC地址上的值,修改bit0为1

mcu.x32(value)#

转换10进制数为16进制字符串输出

参数

传入值类型

解释

int

需要转换的值

返回值

返回值类型

解释

string

16进制字符串

例子

local value = mcu.x32(0x2009FFFC) --输出"0x2009fffc"

mcu.tick64()#

获取启动后的高精度tick,如果支持bit64库,可以直接输出转换好的bit64结构

参数

传入值类型

解释

boolean

是否输出bit64结构,true是,其他都是false,留空也是false,用于兼容旧的demo

返回值

返回值类型

解释

string

当前tick值,8个字节的uint64,如果支持64bit库,同时要求输出64bit结构的话,会输出9字节的string

int

1us有几个tick,0表示未知

例子

local tick_str, tick_per = mcu.tick64()
print("ticks", tick_str, tick_per)

mcu.dtick64(tick1, tick2, check_value)#

计算2个64bit tick的差值

参数

传入值类型

解释

string

64bit的string

string

64bit的string

int

参考值,可选项,如果为0,则返回结果中第一个项目为true

返回值

返回值类型

解释

boolean

与参考值比较,如果大于等于为true,反之为false

int

差值tick1 - tick2,如果超过了0x7fffffff,结果可能是错的

例子

local result, diff_tick = mcu.dtick64(tick1, tick2)
print("ticks", result, diff_tick)

mcu.setXTAL(source_main, source_32k, delay)#

选择时钟源,当前仅air105支持

参数

传入值类型

解释

boolean

高速时钟是否使用外部时钟源,如果为空则不改变

boolean

低速32K是否使用外部时钟源,如果为空则不改变

int

PLL稳定时间,在切换高速时钟的时候,根据硬件环境,需要delay一段时间等待PLL稳定,默认是1200,建议不小于1024

返回值

例子

mcu.setXTAL(true, true, 1248)    --高速时钟使用外部时钟,低速32K使用外部晶振, delay1248

mcu.hardfault(mode)#

mcu死机时处理模式,目前只有EC618平台适用

参数

传入值类型

解释

int

处理模式,0死机停机,1死机后重启,2死机后尽量将错误信息提交给外部工具后重启

返回值

例子

mcu.hardfault(0)    --死机后停机,一般用于调试状态
mcu.hardfault(1)    --死机后重启,一般用于正式产品
mcu.hardfault(2)    --死机后尽量将错误信息提交给外部工具后重启,一般用于压力测试或者正式产品

mcu.iomux(type, channel, value)#

在外设打开前,将外设IO复用到非默认配置上,目前只支持Air780E的部分外设复用到其他配置,这是一个临时接口,如果后续有更合适的api,本接口将不再更新

参数

传入值类型

解释

int

外设类型,目前只有mcu.UART,mcu.I2C

int

总线序号,0~N,

int

新的配置,这个需要根据具体平台决定

返回值

例子

mcu.iomux(mcu.UART, 2, 1)    -- Air780E的UART2复用到gpio12和gpio13(Air780EG默认是这个复用,不要动)
mcu.iomux(mcu.UART, 2, 2)    -- Air780E的UART2复用到gpio6和gpio7
mcu.iomux(mcu.I2C, 0, 1)    -- Air780E的I2C0复用到gpio12和gpio13
mcu.iomux(mcu.I2C, 0, 2)    -- Air780E的I2C0复用到gpio16和gpio17
mcu.iomux(mcu.I2C, 1, 1)    -- Air780E的I2C1复用到gpio4和gpio5

mcu.altfun(type, sn, pad_index, alt_fun, is_input)#

IO外设功能复用选择,注意普通MCU是以GPIO号为序号,但是专用SOC,比如CAT1的,是以PAD号为序号。本函数不是所有平台适用

参数

传入值类型

解释

int

外设类型,目前有mcu.UART,mcu.I2C,mcu.SPI,mcu.PWM,mcu.GPIO,mcu.I2S,mcu.LCD,mcu.CAM,具体需要看平台

int

总线序号,0~N,如果是mcu.GPIO,则是GPIO号。具体看平台的IOMUX复用表

int

pad号,如果留空不写,则表示清除配置,使用平台的默认配置。具体看平台的IOMUX复用表

int

复用功能序号,0~N。具体看平台的IOMUX复用表

boolean

是否是输入功能,true是,留空是false

返回值

例子

-- 以 Air780EP 为例
-- 将GPIO46映射到paddr 32 alt 1
mcu.altfun(mcu.GPIO, 46, 32, 1, 0)
-- mcu.altfun(mcu.GPIO, 46) -- 还原成默认配置

-- UART2复用到paddr 25/26 alt 3
mcu.altfun(mcu.UART,2,  25, 3, 1)
mcu.altfun(mcu.UART,2,  26, 3, 0)

mcu.ticks2(mode)#

获取高精度的计数

参数

传入值类型

解释

int

模式, 看后面的用法说明

返回值

返回值类型

解释

int

根据mode的不同,返回值的含义不同

例子

-- 本函数于2024.5.7新增
-- 与mcu.ticks()的区别是,底层计数器是64bit的, 在可预计的将来不会溢出
-- 所以本函数返回的值总是递增的, 而且32bit固件也能处理

-- 模式可选值 及 对应的返回值
-- 0: 返回微秒数, 以秒为分割, 例如 1234567890us 返回2个值: 1234, 567890
-- 1: 返回毫秒数, 以千秒为分割, 例如 1234567890ms 返回2个值: 1234, 567890
-- 2: 返回秒数,   以百万秒为分割, 例如 1234567890s  返回2个值: 1234, 567890

local us_h, us_l = mcu.ticks2(0)
local ms_h, ms_l = mcu.ticks2(1)
local sec_h, sec_l = mcu.ticks2(2)
log.info("us_h", us_h, "us_l", us_l)
log.info("ms_h", ms_h, "ms_l", ms_l)
log.info("sec_h", sec_h, "sec_l", sec_l)

mcu.XTALRefOutput(source_main, source_32k)#

晶振参考时钟输出

参数

传入值类型

解释

boolean

高速晶振参考时钟是否输出

boolean

低速32K晶振参考时钟是否输出

返回值

例子

-- 本函数于2024.5.17新增
-- 当前仅Air780EP系列支持
mcu.XTALRefOutput(true, false)    --高速晶振参考时钟输出,低速32K不输出