Is there documentation for RPi.GPIO

Raspberry Pi Asked by Milliways on October 15, 2020

Is there documentation for RPi.GPIO? I have searched the web and can’t find anything.

I know I can use pydoc or help() but this produces the following:-

    Wait for an edge.  Returns the channel number or None on timeout.
    channel      - either board pin number or BCM number depending on which mode is set.
    edge         - RISING, FALLING or BOTH
    [bouncetime] - time allowed between calls to allow for switchbounce
    [timeout]    - timeout in ms

This is OK, in as far as it goes, but doesn’t really explain.
I assume the function blocks until the interrupt, but this is not stated.
What are the limits/defaults for timeout?

I have the following code, which I start on boot. Pressing the button successfully shuts down, but I have noticed it also seems to shut down at other times.

I could add some code to verify the button push, or some circuitry to make it more robust, but though I would check the documentation first.

while True:
    # set an interrupt on a falling edge and wait for it to happen
    GPIO.wait_for_edge(INT, GPIO.FALLING)['poweroff'], shell=True, 
        stdout=subprocess.PIPE, stderr=subprocess.PIPE)

Edit 2016-01-03

I downloaded the source from SourceForge, which made things somewhat clearer, but the timeout parameter seems to be missing in action.

2 Answers

The official documentation is

It doesn't seem to have a traditional API style of documentation.

Correct answer by joan on October 15, 2020

I have finally found a Python library with documentation gpiozero

I recommend this to anyone attempting to manipulate GPIO with Python.

Just to clarify I also highly recommend the pigpio Python module which has more functionality.

Answered by Milliways on October 15, 2020

Add your own answers!

Related Questions

Raspberry Pi 3 high IO

3  Asked on December 28, 2021 by cx24


Run application with other user than root

2  Asked on December 28, 2021


Raspberry Pi Zero W Semi Freeze

0  Asked on December 26, 2021 by david-kester


How to change the Menu Icon in Raspbian

3  Asked on December 24, 2021 by yanko


LED matrix won’t light up properly

1  Asked on December 22, 2021 by maiki


How to autostart Kodi at boot?

7  Asked on December 21, 2021 by mario-serda


Resolution Issue

2  Asked on December 19, 2021 by matt-mas


How to disable wifi in Raspberry Pi 4

3  Asked on December 14, 2021 by jb


Booting up feh at launch

2  Asked on December 12, 2021 by simyo-paris


pigpio I2C reply value

2  Asked on December 12, 2021 by user3435167


Ask a Question

Get help from others!

© 2022 All rights reserved. Sites we Love: PCI Database, MenuIva, UKBizDB, Menu Kuliner, Sharing RPP