3.3.2 GPIO应用
开发板预置了 GPIO Python 库 Hobot.GPIO
,用户可以通过如下命令导入GPIO库。
sunrise@ubuntu:~$ sudo python3
Python 3.8.10 (default, Mar 15 2022, 12:22:08)
Type "help", "copyright", "credits" or "license" for more information.
>>> import Hobot.GPIO as GPIO
>>> GPIO.VERSION
'0.0.2'
>>> GPIO.model
'RDK_X5'
设置引脚编码方式
开发板的引脚编码有 4 种模式:
- BOARD:物理引脚序号,与开发板的丝印序号一一对应。
- BCM:根据博通SoC制定的GPIO命名规则。
- CVM: 使用字符串代替数字,对应于CVM / CVB连接器的信号名称。
- SOC: 对应的编号是芯片内部的 GPIO 管脚序号。
本文推荐用户使用BOARD
编码模式,设置编码的方式如下:
注意:编码每次只能设置一次,如果想要重新设置,需要GPIO.cleanup()
后重新设置
GPIO.setmode(GPIO.BOARD)
# or
GPIO.setmode(GPIO.BCM)
# or
GPIO.setmode(GPIO.CVM)
# or
GPIO.setmode(GPIO.SOC)
查询编码方式:
GPIO.getmode()
程序会输出 BOARD, BCM, CVM, SOC or None
其中的一种结果。
警告信息
以下几种情况下运行代码,会有警告日志输出,但并不会影响正常功能:
- 用户尝试使用的GPIO,已在其他应用程序中使用;
- 在设置模式和通道之前,尝试调用
GPIO.cleanup
清理管脚;
如要屏蔽警告信息,可通过如下命令实现:
GPIO.setwarnings(False)
管脚配置
GPIO管脚在使用之前,需要进行相应的配置,具体如下:
设置为输入的方式如下:
GPIO.setup(channel, GPIO.IN)
设置为输出的方式如下:
GPIO.setup(channel, GPIO.OUT)
也可以为输出通道指定一个初始值,例如:
GPIO.setup(channel, GPIO.OUT, initial=GPIO.HIGH)
另外,工具支持同时设置多个输出通道,例如:
# set gpio(18,12,13) to output
channels = [18, 12, 13]
GPIO.setup(channels, GPIO.OUT)
输入操作
要读取通道的值,请使用:
GPIO.input(channel)
命令返回值为 0 或者 1。 0 代表 GPIO.LOW, 1 代表 GPIO.HIGH。
输出操作
要设置通道的输出值,请使用:
GPIO.output(channel, state)
其中 state 可以是 GPIO.LOW 或 GPIO.HIGH。
清理管脚占用
在程序推出前,推荐进行通道清理动作,请使用:
GPIO.cleanup()
如果只想清理特定通道,请使用:
# 清除单个通道
GPIO.cleanup(channel)
# 清除一组通道
GPIO.cleanup( (channel1, channel2) )
GPIO.cleanup( [channel1, channel2] )
查看管脚状态
此功能允许您检查对应 GPIO 通道的功能:
GPIO.gpio_function(channel)
该函数返回 IN 或 OUT。
边沿检测与中断
边沿是电信号从低到高
(上升沿)或从高到低
(下降沿)的变化,这种改变可以看作是一种事件的发生,这种事件可以用来触发CPU中断信号。
在RDK Ultra
平台上,40pin
上只有特定几个管脚才能作为中断管脚使用,它们在BOARD
编码模式下的编号为:13、16、18、22、27、28、32、33、37
管脚定义请参考 管脚配置与定义
GPIO库提供了三种方法来检测输入事件:
wait_for_edge() 函数
此函数阻塞调用线程,直到检测到对应的边缘变化。函数调用如下:
GPIO.wait_for_edge(channel, GPIO.RISING)
其中,第二个参数指 定要检测的边沿,取值范围为GPIO.RISING、GPIO.FALLING 或 GPIO.BOTH
。如果要指定等待时间,可以选择设置超时:
# 超时以毫秒为单位
GPIO.wait_for_edge(channel, GPIO.RISING, timeout=500)
在超时时间内外部信号发生变化,函数返回检测的通道号;如果发生超时,函数返回None。
event_detected() 函数
此函数可用于定期检查自上次调用以来是否发生了事件。该函数可以按如下方式设置和调用:
# 在通道GPIO上设置上升沿检测
GPIO.add_event_detect(channel, GPIO.RISING)
if GPIO.event_detected(channel):
print("Rising edge event detected")
您可以检测 GPIO.RISING、GPIO.FALLING 或 GPIO.BOTH 的事件。
检测到边沿事件时运行回调函数
此功能可用于注册回调函数,回调函数运行在独立的处理线程中,使用说明如下:
# define callback function
def callback_fn(channel):
print("Callback called from channel %s" % channel)
# enable rising detection
GPIO.add_event_detect(channel, GPIO.RISING, callback=callback_fn)
如有需要,也可以添加多个回调,方法如下:
def callback_one(channel):
print("First Callback")
def callback_two(channel):
print("Second Callback")
GPIO.add_event_detect(channel, GPIO.RISING)
GPIO.add_event_callback(channel, callback_one)
GPIO.add_event_callback(channel, callback_two)
由于所有回调函数运行在同一线程上,因此不同的回调是按顺序运行的,而不是同时运行。
为了通过将多个事件合并为一个事件来防止多次调用回调函数,可以选择设置去抖动时间:
# bouncetime unit is ms
GPIO.add_event_detect(channel, GPIO.RISING, callback=callback_fn, bouncetime=200)
关闭中断
如果不再需要边沿检测,可以将其删除,如下所示:
GPIO.remove_event_detect(channel)
测试例程
在 /app/40pin_samples/
目录下提供主要的测试例程:
测试例程名 | 说明 |
---|---|
simple_out.py | 单个管脚输出 测试 |
simple_input.py | 单个管脚输入 测试 |
button_led.py | 一个管脚作为按键输入,一个管脚作为输出控制LED |
test_all_pins_input.py | 所有管脚的输入测试 代码 |
test_all_pins.py | 所有管脚的输出测试 代码 |
button_event.py | 捕获管脚的上升沿、下降沿事件 |
button_interrupt.py | 中断方式处理管脚的上升沿、下降沿事件 |
- GPIO 设置为
输出模式
,1秒钟切换输出电平,可以用于控制LED灯的循环亮灭, 测试代码simple_out.py
:
#!/usr/bin/env python3
import sys
import signal
import Hobot.GPIO as GPIO
import time
def signal_handler(signal, frame):
sys.exit(0)
# 定义使用的GPIO通道为37
output_pin = 37 # BOARD 编码 37
def main():
# 设置管脚编码模式为硬件编号 BOARD
GPIO.setmode(GPIO.BOARD)
# 设置为输出模式,并且初始化为高电平
GPIO.setup(output_pin, GPIO.OUT, initial=GPIO.HIGH)
# 记录当前管脚状态
curr_value = GPIO.HIGH
print("Starting demo now! Press CTRL+C to exit")
try:
# 间隔1秒时间,循环控制LED灯亮灭
while True:
time.sleep(1)
GPIO.output(output_pin, curr_value)
curr_value ^= GPIO.HIGH
finally:
GPIO.cleanup()
if __name__=='__main__':
signal.signal(signal.SIGINT, signal_handler)
main()
- GPIO 设置为
输入模式
,通过忙轮询方式读取管脚电平值,测试 代码simple_input.py
:
#!/usr/bin/env python3
import sys
import signal
import Hobot.GPIO as GPIO
import time
def signal_handler(signal, frame):
sys.exit(0)
# 定义使用的GPIO通道为37
input_pin = 37 # BOARD 编码 37
GPIO.setwarnings(False)
def main():
prev_value = None
# 设置管脚编码模式为硬件编号 BOARD
GPIO.setmode(GPIO.BOARD)
# 设置为输入模式
GPIO.setup(input_pin, GPIO.IN)
print("Starting demo now! Press CTRL+C to exit")
try:
while True:
# 读取管脚电平
value = GPIO.input(input_pin)
if value != prev_value:
if value == GPIO.HIGH:
value_str = "HIGH"
else:
value_str = "LOW"
print("Value read from pin {} : {}".format(input_pin, value_str))
prev_value = value
time.sleep(1)
finally:
GPIO.cleanup()
if __name__=='__main__':
signal.signal(signal.SIGINT, signal_handler)
main()
- GPIO 设置为输入模式,捕获管脚的上升沿、下降沿事件,测试代码
button_event.py
, 实现检测37号管脚的下降沿,然后控制31号管脚的输出:
#!/usr/bin/env python3
import sys
import signal
import Hobot.GPIO as GPIO
import time
def signal_handler(signal, frame):
sys.exit(0)
# 定义使用的GPIO通道:
# 31号作为输出,可以点亮一个LED
# 37号作为输入,可以接一个按钮
led_pin = 31 # BOARD 编码 31
but_pin = 37 # BOARD 编码 37
# 禁用警告信息
GPIO.setwarnings(False)
def main():
# 设置管脚编码模式为硬件编号 BOARD
GPIO.setmode(GPIO.BOARD)
GPIO.setup(led_pin, GPIO.OUT) # LED pin set as output
GPIO.setup(but_pin, GPIO.IN) # button pin set as input
# Initial state for LEDs:
GPIO.output(led_pin, GPIO.LOW)
print("Starting demo now! Press CTRL+C to exit")
try:
while True:
print("Waiting for button event")
GPIO.wait_for_edge(but_pin, GPIO.FALLING)
# event received when button pressed
print("Button Pressed!")
GPIO.output(led_pin, GPIO.HIGH)
time.sleep(1)
GPIO.output(led_pin, GPIO.LOW)
finally:
GPIO.cleanup() # cleanup all GPIOs
if __name__ == '__main__':
signal.signal(signal.SIGINT, signal_handler)
main()
- GPIO 设置为输入模式,启动gpio中断功能,响应管脚的上升沿、下降沿事件,测试代码
button_interrupt.py
, 实现检测 37 号管脚的下降沿,然后控制13号管脚快速切换高低电平 5 次:
#!/usr/bin/env python3
import sys
import signal
import Hobot.GPIO as GPIO
import time
def signal_handler(signal, frame):
sys.exit(0)
# 定义使用的GPIO通道:
# 15号作为输出,可以点亮一个LED
# 16号作为输出,可以点亮一个LED
# 37号作为输入,可以接一个按钮
led_pin_1 = 15 # BOARD 编码 15
led_pin_2 = 16 # BOARD 编码 16
but_pin = 37 # BOARD 编码 37
# 禁用警告信息
GPIO.setwarnings(False)
# 按下按钮时 LED 2 快速闪烁 5 次
def blink(channel):
print("Blink LED 2")
for i in range(5):
GPIO.output(led_pin_2, GPIO.HIGH)
time.sleep(0.5)
GPIO.output(led_pin_2, GPIO.LOW)
time.sleep(0.5)
def main():
# Pin Setup:
GPIO.setmode(GPIO.BOARD) # BOARD pin-numbering scheme
GPIO.setup([led_pin_1, led_pin_2], GPIO.OUT) # LED pins set as output
GPIO.setup(but_pin, GPIO.IN) # button pin set as input
# Initial state for LEDs:
GPIO.output(led_pin_1, GPIO.LOW)
GPIO.output(led_pin_2, GPIO.LOW)
# 把blink函数注册为按钮下降沿事件的中断处理函数
GPIO.add_event_detect(but_pin, GPIO.FALLING, callback=blink, bouncetime=10)
# 开始测试, Led1 缓慢闪烁
print("Starting demo now! Press CTRL+C to exit")
try:
while True:
# blink LED 1 slowly
GPIO.output(led_pin_1, GPIO.HIGH)
time.sleep(2)
GPIO.output(led_pin_1, GPIO.LOW)
time.sleep(2)
finally:
GPIO.cleanup() # cleanup all GPIOs
if __name__ == '__main__':
signal.signal(signal.SIGINT, signal_handler)
main()
hb_gpioinfo工具介绍
hb_gpioinfo 是适配X5的一个gpio帮助工具,可以查看当前开发板的的PinName和PinNum的对应关系
hb_gpioinfo组成
hb_gpioinfo工具由驱动和应用两部分组成,驱动负责解析pinmux-gpio.dtsi并将pinnode和pinname信息导出到debugfs系统中,hb_gpioinfo应用进行解析打印到终端上
驱动代码路径:kernel/drivers/gpio/hobot_gpio_debug.c
hb_gpioinfo使用实例
- PinName:指的是Soc上的管脚名字,原理图上X5 Soc管脚命名一致
- PinNode:指的是设备树中的PinNode信息
- PinNum:指的是X5实际的对应的管脚gpio编号
root@ubuntu:~# hb_gpioinfo
gpiochip0 - 8 lines: @platform/31000000.gpio: @GPIOs 498-505
[Number] [Mode] [Status] [GpioName] [PinName] [PinNode] [PinNum]
line 0: unnamed input AON_GPIO0_PIN0 aon_gpio_0 498
line 1: unnamed input AON_GPIO0_PIN1 aon_gpio_1 499
line 2: unnamed input active-low GPIO Key Power AON_GPIO0_PIN2 aon_gpio_2 500
line 3: unnamed input interrupt AON_GPIO0_PIN3 aon_gpio_3 501
line 4: unnamed input AON_GPIO0_PIN4 aon_gpio_4 502
line 5: unnamed input id AON_ENV_VDD aon_gpio_5 503
line 6: unnamed input id AON_ENV_CNN0 aon_gpio_6 504
line 7: unnamed input AON_ENV_CNN1 aon_gpio_7 505
gpiochip1 - 31 lines: @platform/35060000.gpio: @GPIOs 466-496
[Number] [Mode] [Status] [GpioName] [PinName] [PinNode] [PinNum]
line 0: unnamed input HSIO_ENET_MDC hsio_gpio0_0 466
line 1: unnamed input HSIO_ENET_MDIO hsio_gpio0_1 467
line 2: unnamed input HSIO_ENET_TXD_0 hsio_gpio0_2 468
line 3: unnamed input HSIO_ENET_TXD_1 hsio_gpio0_3 469
line 4: unnamed input HSIO_ENET_TXD_2 hsio_gpio0_4 470
line 5: unnamed input HSIO_ENET_TXD_3 hsio_gpio0_5 471
line 6: unnamed input HSIO_ENET_TXEN hsio_gpio0_6 472
line 7: unnamed input HSIO_ENET_TX_CLK hsio_gpio0_7 473
line 8: unnamed input HSIO_ENET_RX_CLK hsio_gpio0_8 474
....