gpio - GPIO操作
Kimi AI整理版
一、常量
GPIO 模块中定义了一些常量，用于指定管脚的工作模式、中断触发类型以及上拉/下拉配置等。这些常量在使用相关 API 时作为参数传递，具体含义如下：
- 工作模式常量 ：如
gpio.INPUT（输入模式）、gpio.OUTPUT（输出模式）等，用于确定管脚的基本功能。 - 中断触发类型常量 ：包括
gpio.RISING（上升沿触发）、gpio.FALLING（下降沿触发）、gpio.BOTH（双向触发）等，用于配置中断的触发条件。 - 上拉 / 下拉配置常量 ：像
gpio.PULLUP（上拉）、gpio.PULLDOWN（下拉）等，用于设置管脚的电气特性。
二、函数
（一）管脚功能设置与关闭
-
gpio.setup(pin, mode, pull, irq, alt) ：用于设置管脚功能，参数灵活多样。
-
pin ：指定要设置的管脚编号。
- mode ：定义管脚的工作模式，可为输入、输出、中断等不同类型。例如，将 mode 设为
nil可将管脚设为输入；设为0则是输出模式且初始化电平为低。 - pull ：配置上拉或下拉电阻，如
gpio.PULLUP表示启用上拉。 - irq ：当中断触发时，可传入回调函数来处理中断事件。回调函数参数中，
val是中断发生时管脚的电平值，io_num是管脚编号。 - alt ：用于部分平台，调整 GPIO 复用功能。
- gpio.close(pin) ：关闭管脚功能，使其处于高阻输入态，并且会关掉中断。
（二）电平操作
- gpio.set(pin, value) ：设置指定管脚的电平，value 为 0 或 1，分别对应低电平和高电平。
- gpio.get(pin) ：获取管脚的当前电平值，返回 0 或 1。需要注意的是，只有当管脚处于输入模式或中断模式时才能获取到有效电平；若管脚为输出模式，此函数返回值恒为 0。
- gpio.toggle(pin) ：切换 GPIO 脚的输出电平，仅在输出模式下可用。例如，若当前电平为低，则调用后变为高，反之亦然。
（三）其他功能
- gpio.caplevel(pin, level, func) ：捕获管脚在特定电平下的持续时长，单位为微秒（us）。当管脚电平与指定 level 相符且持续一段时间后，会触发回调函数 func，并将捕获到的时长作为参数传入。
- gpio.pulse(pin, level, len, delay) ：在同一个 GPIO 输出一组脉冲。其中，level 指定脉冲的电平序列，len 表示脉冲长度（单位为 bit，高位在前），delay 是延迟时间。
-
gpio.debounce(pin, ms, mode) ：对管脚进行防抖设置，基于硬件 ticks 实现。ms 为防抖时间，mode 决定防抖的具体行为：
-
mode=0 ：触发中断后，立即上报一次，随后进入冷却期，在 ms 毫秒内不再接受新的中断。
- mode=1 ：触发中断后，延迟 ms 毫秒，若期间没有新中断且电平未变化，则上报一次。
- gpio.count(pin) ：获取 gpio 中断数量，并清空累计值，类似于某些模块的脉冲计数功能。
三、全局设置
gpio.setDefaultPull(val) ：设置 GPIO 脚的默认上拉 / 下拉配置，val 的取值会影响后续 gpio.setup 中 pull 参数的默认行为。默认情况下，平台自定义（一般为开漏）。
四、注意事项
- 中断相关 ：当中断回调函数中的 val 参数仅代表中断发生时管脚的电平，并非触发方向。对于 Cat.1 模块，EC618 系列仅有 AONGPIO 支持双向触发，其他系列则所有 GPIO 均可双向触发，具体需参考硬件手册。默认设置下中断无防抖时间，可通过
gpio.set_debounce(pin, 50)等类似函数设置防抖。 - 上拉 / 下拉配置 ：部分 BSP（板级支持包）仅支持
gpio.PULLUP或gpio.PULLDOWN，但有些 BSP 支持开漏模式。对于支持开漏的 BSP，pull 参数传 0 才能开启开漏模式，而不是传 nil。例如，EC618 系列、EC718 系列以及 XT804 系列等部分模块支持此特性。 - 管脚状态与操作对应关系 ：只有管脚处于输入模式或中断模式时，才能通过
gpio.get()获取到有效电平；仅当管脚为输出模式时，才能通过gpio.set()设置电平。
合宙同学整理版
常量
| 常量 | 类型 | 解释 |
|---|---|---|
| gpio.NONE | number | 无效引脚,一般用于告诉底层某功能引脚不指定 |
| gpio.LOW | number | 低电平 |
| gpio.HIGH | number | 高电平 |
| gpio.PULLUP | number | 上拉 |
| gpio.PULLDOWN | number | 下拉 |
| gpio.RISING | number | 上升沿触发 |
| gpio.FALLING | number | 下降沿触发 |
| gpio.BOTH | number | 双向触发,部分设备支持 |
| gpio.HIGH_IRQ | number | 高电平触发,部分设备支持 |
| gpio.LOW_IRQ | number | 低电平触发,部分设备支持 |
| gpio.WAKEUP0 | number | WAKEUP_PAD |
| gpio.WAKEUP1 | number | WAKEUP_PAD |
| gpio.WAKEUP2 | number | WAKEUP_PAD |
| gpio.WAKEUP3 | number | WAKEUP_PAD |
| gpio.WAKEUP4 | number | WAKEUP_PAD |
| gpio.WAKEUP5 | number | WAKEUP_PAD |
| gpio.CHG_DET | number | WAKEUP_PAD |
| gpio.PWR_KEY | number | WAKEUP_PAD |
gpio.setup(pin, mode, pull, irq, alt)
设置管脚功能
参数
| 传入值类型 | 解释 |
|---|---|
| int | pin gpio编号,必须是数值 |
| any | mode 输入输出模式： 数字0/1代表输出模式 nil代表输入模式 function代表中断模式，如果填gpio.count，则为中断计数功能，中断时不回调 |
| int | pull 上拉下拉模式, 可以是上拉模式 gpio.PULLUP 或下拉模式 gpio.PULLDOWN, 或者开漏模式 0. 需要根据实际硬件选用 |
| int | irq 中断触发模式,默认gpio.BOTH。中断触发模式 上升沿gpio.RISING 下降沿gpio.FALLING 上升和下降都触发gpio.BOTH |
| int | alt 复用选项，目前只有EC618平台需要这个参数，有些GPIO可以复用到不同引脚上，可以选择复用选项（0或者4）从而复用到对应的引脚上 |
返回值
| 返回值类型 | 解释 |
|---|---|
| any | 输出模式返回设置电平的闭包, 输入模式和中断模式返回获取电平的闭包 |
例子
-- 设置gpio17为输入
gpio.setup(17, nil)
-- 设置gpio17为输出,且初始化电平为低,使用硬件默认上下拉配置
gpio.setup(17, 0)
-- 设置gpio17为输出,且初始化电平为高,且启用内部上拉
gpio.setup(17, 1, gpio.PULLUP)
-- 设置gpio27为中断, 默认双向触发
gpio.setup(27, function(val,io_num)
print("io",io_num,val) -- 提醒, val并不代表触发方向, 仅代表中断后某个时间点的电平, io_num是IO序号
end, gpio.PULLUP)
-- 设置gpio27为中断, 仅上升沿触发
gpio.setup(27, function(val)
print("IRQ_27",val) -- 提醒, val并不代表触发方向, 仅代表中断后某个时间点的电平
end, gpio.PULLUP, gpio.RISING)
-- 中断计数 于2024.5.8新增
-- 设置gpio7为中断计数，详细demo见gpio/gpio_irq_count
gpio.setup(7, gpio.count)
-- alt_func 于2023.7.2新增
-- 本功能仅对部分平台有效, 且仅用于调整GPIO复用,其他复用方式请使用muc.iomux函数
-- 以下示例代码, 将I2S_DOUT复用成gpio18
-- AIR780E的PIN33(模块管脚序号), 对应paddr 38, 默认功能是I2S_DOUT, 复用成gpio18
-- 方向输出,且初始化电平为低,使用硬件默认上下拉配置
-- Air780E(EC618系列的GPIO复用请查阅 https://air780e.cn 首页硬件资料表格中的Air780E&Air780EG&Air780EX&Air700E_GPIO_table_20231227.pdf)
-- Air780EP(EC718P系列的GPIO复用请查阅 https://air780ep.cn 首页硬件资料表格中的Air780E&Air780EG&Air780EX&Air700E_GPIO_table_20231227.pdf)
gpio.setup(18, 0, nil, nil, 4)
-- 提醒:
-- 当管脚为输入模式或中断,才能通过gpio.get()获取到电平
-- 当管脚为输出模式,才能通过gpio.set()设置电平
-- 当管脚为输出模式,通过gpio.get()总会得到0
-- 中断回调的val参数不代表触发方向, 仅代表中断后某个时间点的电平
-- 对Cat.1模块,EC618系列只有AONGPIO才能双向触发，其他系列所有GPIO都能双向触发，具体看硬件手册
-- 默认设置下,中断是没有防抖时间的,可以通过gpio.set_debounce(pin, 50)来设置防抖时间
-- pull参数的额外说明, 上拉/下拉配置
-- 对于部分的BSP来说, 只支持 gpio.PULLUP 或 gpio.PULLDOWN, 但有部分BSP支持开漏模式
-- 对于支持开漏的bsp, pull参数要传 0 才能开启开漏模式, 不是传nil
-- 例如:
-- EC618系列(Air780E/Air780EG/Air780EX/Air700E等)
-- EC718系列(Air780EP/Air780EPV等)
-- XT804系列(Air101/Air103/Air601)
gpio.caplevel(pin, level,func)
捕获管脚电平持续时长，单位us
参数
| 传入值类型 | 解释 |
|---|---|
| int | pin GPIO编号,必须是数值 |
| int | level 需要捕获的电平, 可以是 高电平gpio.HIGH, 低电平gpio.LOW, 或者直接写数值1或0，即管脚上正常时间处于level的反，捕获设定的level持续时间 |
| function | func 完成捕获后的回调函数，仅一个参数，参数为捕获到的时间长度number型数值，单位us |
返回值
| 返回值类型 | 解释 |
|---|---|
| any | 返回获取电平的闭包 |
例子
-- 捕获pin.PA07为高电平的持续时间
gpio.caplevel(pin.PA07,1,function(val) print(val) end)
gpio.set(pin, value)
设置管脚电平
参数
| 传入值类型 | 解释 |
|---|---|
| int | pin GPIO编号,必须是数值 |
| int | value 电平, 可以是 高电平gpio.HIGH, 低电平gpio.LOW, 或者直接写数值1或0 |
返回值
| 返回值类型 | 解释 |
|---|---|
| nil | 无返回值 |
例子
-- 设置gpio17为低电平
gpio.set(17, 0)
gpio.get(pin)
获取管脚电平
参数
| 传入值类型 | 解释 |
|---|---|
| int | pin GPIO编号,必须是数值 |
返回值
| 返回值类型 | 解释 |
|---|---|
| value | 电平, 高电平gpio.HIGH, 低电平gpio.LOW, 对应数值1和0 |
例子
-- 获取gpio17的当前电平
gpio.get(17)
gpio.close(pin)
关闭管脚功能(高阻输入态),关掉中断
参数
| 传入值类型 | 解释 |
|---|---|
| int | pin GPIO编号,必须是数值 |
返回值
| 返回值类型 | 解释 |
|---|---|
| nil | 无返回值,总是执行成功 |
例子
-- 关闭gpio17
gpio.close(17)
gpio.setDefaultPull(val)
设置GPIO脚的默认上拉/下拉设置, 默认是平台自定义(一般为开漏).
参数
| 传入值类型 | 解释 |
|---|---|
| int | val 0平台自定义,1上拉, 2下拉 |
返回值
| 返回值类型 | 解释 |
|---|---|
| boolean | 传值正确返回true,否则返回false |
例子
-- 设置gpio.setup的pull默认值为上拉
gpio.setDefaultPull(1)
gpio.toggle(pin)
变换GPIO脚输出电平,仅输出模式可用
参数
| 传入值类型 | 解释 |
|---|---|
| int | 管脚的GPIO号 |
返回值
| 返回值类型 | 解释 |
|---|---|
| nil | 无返回值 |
例子
-- 本API于 2022.05.17 添加
-- 假设GPIO16上有LED, 每500ms切换一次开关
gpio.setup(16, 0)
sys.timerLoopStart(function()
gpio.toggle(16)
end, 500)
gpio.pulse(pin,level,len,delay)
在同一个GPIO输出一组脉冲, 注意, len的单位是bit, 高位在前.
参数
| 传入值类型 | 解释 |
|---|---|
| int | gpio号 |
| int/string | 数值或者字符串. |
| int | len 长度 单位是bit, 高位在前. |
| int | delay 延迟,当前无固定时间单位 |
返回值
| 返回值类型 | 解释 |
|---|---|
| nil | 无返回值 |
例子
-- 通过PB06脚输出输出8个电平变化.
gpio.pulse(pin.PB06,0xA9, 8, 0)
gpio.debounce(pin, ms, mode)
防抖设置, 根据硬件ticks进行防抖
参数
| 传入值类型 | 解释 |
|---|---|
| int | gpio号, 0~127, 与硬件相关 |
| int | 防抖时长,单位毫秒, 最大 65555 ms, 设置为0则关闭 |
| int | 模式, 0冷却模式, 1延时模式. 默认是0 |
返回值
| 返回值类型 | 解释 |
|---|---|
| nil | 无返回值 |
例子
-- 消抖模式, 当前支持2种, 2022.12.16开始支持mode=1
-- 0 触发中断后,马上上报一次, 然后冷却N个毫秒后,重新接受中断
-- 1 触发中断后,延迟N个毫秒,期间没有新中断且电平没有变化,上报一次
-- 开启防抖, 模式0-冷却, 中断后马上上报, 但100ms内只上报一次
gpio.debounce(7, 100) -- 若芯片支持pin库, 可用pin.PA7代替数字7
-- 开启防抖, 模式1-延时, 中断后等待100ms,期间若保持该电平了,时间到之后上报一次
-- 对应的,如果输入的是一个 50hz的方波,那么不会触发任何上报
gpio.debounce(7, 100, 1)
-- 关闭防抖,时间设置为0就关闭
gpio.debounce(7, 0)
gpio.count(pin)
获取gpio中断数量，并清空累计值，类似air724的脉冲计数
参数
| 传入值类型 | 解释 |
|---|---|
| int | gpio号, 0~127, 与硬件相关 |
返回值
| 返回值类型 | 解释 |
|---|---|
| int | 返回从上次获取中断数量后到当前的中断计数 |
例子
log.info("irq cnt", gpio.count(10))