Mock.GPIO

Mock Library for RPI.GPIO python Library

Mock.GPIO is a python library that supports development of software/program and to debug them outside RPi (eg: ubuntu ). It can be intergrated along with any generic application/program/software.

It helps in making your programm/application run seamlessly, both outside and inside RPi by

• printing the intended actions (without GUI) for debugging, when executed outside RPi
• works exactly as intended in an actual RPi without a need for code change.

The easiest way to use this package is to install using pip3 for python3

$ sudo pip3 install Mock.GPIO

To import the Mock library at the beginning of your script, use

import Mock.GPIO as GPIO

To enable seamless switching between Mock library when you are outside RPi and the actual RPi.GPIO library when you are inside RPi, use

try:
    # checks if you have access to RPi.GPIO, which is available inside RPi
    import RPi.GPIO as GPIO
except:
    # In case of exception, you are executing your script outside of RPi, so import Mock.GPIO
    import Mock.GPIO as GPIO

Works with

• python 3.6.8

Simulation

This library simulates the following functions which are used in the RPi.GPIO library.

• GPIO.setmode()
• GPIO.getmode()
• GPIO.setwarnings()
• GPIO.setup()
• GPIO.output()
• GPIO.input()
• GPIO.wait_for_edge()
• GPIO.add_event_detect()
• GPIO.event_detected()
• GPIO.add_event_callback()
• GPIO.remove_event_detect()
• GPIO.gpio_function()
• GPIO.start()
• GPIO.ChangeFrequency()
• GPIO.ChangeDutyCycle()
• GPIO.stop()
• GPIO.cleanup()

Usage:

import Mock.GPIO as GPIO

Documentation

• Library Overview
• Examples

Example:

The following python example/test.py

try:
    import RPi.GPIO as GPIO
except:
    import Mock.GPIO as GPIO

import time

print ("set mode")
GPIO.setmode(GPIO.BCM)
print ("set warning false")
GPIO.setwarnings(False)
GPIO.setup(15,GPIO.OUT)
GPIO.output(15,GPIO.HIGH)
time.sleep(1)
GPIO.output(15,GPIO.LOW)

generates the following output

$ export LOG_LEVEL=Info
$ python examples/test.py
set mode
set warning false
2020-05-07 17:49:23,031:INFO: Set warnings as False
2020-05-07 17:49:23,031:INFO: Setup channel : 15 as 0 with initial :0 and pull_up_down 20
2020-05-07 17:49:23,032:INFO: Output channel : 15 with value : 1
2020-05-07 17:49:24,033:INFO: Output channel : 15 with value : 0

Develop

make the suitable changes and from the root directory of this repository, install the Mock.GPIO python package using the install.sh script

$ sudo ./scripts/install.sh

Contribute

• You've discovered a bug or something else you want to change - excellent! - feel free to raise a issue.
• You've worked out a way to fix it – even better! - submit your PR
• You want to tell us about it – best of all!

Start contributing !