rtc - 实时时钟#

已适配 Air101/Air103 Air105 ESP32C3 ESP32S3 Air780E

备注

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

小技巧

rtc.set(tab)#

设置时钟

参数

传入值类型	解释
table	or int 时钟参数,见示例

返回值

返回值类型	解释
bool	成功返回true,否则返回nil或false

例子

rtc.set({year=2021,mon=8,day=31,hour=17,min=8,sec=43})
--目前只有Air101/Air103/Air105/EC618系列支持时间戳方式
rtc.set(1652230554)

rtc.get()#

获取时钟

参数

无

返回值

返回值类型	解释
table	时钟参数,见示例

例子

local t = rtc.get()
-- {year=2021,mon=8,day=31,hour=17,min=8,sec=43}
log.info("rtc", json.encode(t))

rtc.timerStart(id, tab)#

设置RTC唤醒时间

参数

传入值类型	解释
int	时钟id,通常只支持0
table	时钟参数,见示例

返回值

返回值类型	解释
bool	成功返回true,否则返回nil或false

例子

-- 使用前建议先rtc.set设置为正确的时间
rtc.timerStart(0, {year=2021,mon=9,day=1,hour=17,min=8,sec=43})

rtc.timerStop(id)#

取消RTC唤醒时间

参数

传入值类型	解释
int	时钟id,通常只支持0

返回值

返回值类型	解释
bool	成功返回true,否则返回nil或false

例子

rtc.timerStop(0)

rtc.setBaseYear(Base_year)#

设置RTC基准年,不推荐

参数

传入值类型	解释
int	基准年Base_year,通常1900

返回值

无

例子

rtc.setBaseYear(1900)

rtc.timezone(tz)#

读取或设置时区

参数

传入值类型	解释
int	时区值,注意单位是1/4时区.例如东八区是 32,而非8. 可以不传
return	当前/设置后的时区值

返回值

无

例子

-- 设置为东8区
rtc.timezone(32)
-- 设置为东3区
rtc.timezone(12)
-- 设置为西4区
rtc.timezone(-16)
-- 注意: 无论设置时区是多少, rtc.get/set总是UTC时间
-- 时区影响的是 os.date/os.time 函数
-- 只有部分模块支持设置时区, 且默认值一般为32, 即东八区