Introducing the Python library SimulRPi

-
SimulRPi is a Python library that I wrote as part of my Darth-Vader-RPi project. It partly fakes RPi.GPIO and simulates some I/O devices connected to a Raspberry Pi (RPi):
  • push buttons by listening to pressed keyboard keys and
  • LEDs by displaying blinking red dots in the terminal along with their GPIO pin numbers.
The Python package pynput is used to monitor the keyboard for any pressed key. Thus, the SimulRPi library can be useful in the case that you want to try your RPi.GPIO-based script by running it on your computer when no RPi is available at the moment.

Example: terminal output

Simulating LEDs on an RPi via a terminal
Each dot represents a blinking LED connected to an RPi and the number between brackets is the associated GPIO channel number. Here the LED on channel 22 toggles between on and off when a key is pressed.

Dependencies

  • Platforms: Linux, macOS
  • Python: 3.5, 3.6, 3.7, 3.8 
  • pynput >=1.6.8: for monitoring the keyboard for any pressed key 

Installation instructions

  1. It is highly recommended to install SimulRPi in a virtual environment using for example venv or conda.
    Install the SimulRPi package with pip:
    $ pip install SimulRPi
    It will install the dependency pynput if it is not already found in your system.

  2. Test your installation by importing SimulRPi and printing its version: 
    $ python -c "import SimulRPi; print(SimulRPi.__version__)"
As part of the SimulRPi installation, you will get access to the run_examples script which allows you to run different code examples on your RPi or computer. If it is run on your computer, it will make use of the SimulRPi.GPIO module which partly fakes RPi.GPIO.

The run_examples script can be called from the terminal by providing some arguments. For example, to run the code example # 1 which turns on a LED using the simulation package SimulRPi:
$ run_examples -e 1 -s

Use the -h flag to get a list of options: 
$ run_examples -h

Also, check out the script's documentation.

Usage

You can try importing RPi.GPIO first and if it is not found, then fallback on the SimulRPi.GPIO module:
try:
    import RPi.GPIO as GPIO
except ImportError:
    import SimulRPi.GPIO as GPIO 

# Rest of your code

Examples

The following two examples are part of the suite of code examples that is included with SimulRPi.

Example 1: display 3 LEDs

This example consists in displaying three LEDs on channels 9, 10, and 11, respectively. Here is the code along with the output from the terminal:
import SimulRPi.GPIO as GPIO

led_channels = [9, 10, 11]
GPIO.setmode(GPIO.BCM)
GPIO.setup(led_channels, GPIO.OUT)
GPIO.output(led_channels, GPIO.HIGH)
GPIO.cleanup()
Output:

Example 2: blink a LED if a key is pressed

In this example, we will blink a LED on channel 10 for 3 seconds if the key shift_r is pressed. And then exiting from the program. The program can also be terminated at any time by pressing ctrl + c. Here is the code along with the output from the terminal:
import time
import SimulRPi.GPIO as GPIO

led_channel = 10
key_channel = 27
GPIO.setmode(GPIO.BCM)
GPIO.setup(led_channel, GPIO.OUT)
GPIO.setup(key_channel, GPIO.IN, pull_up_down=GPIO.PUD_UP)
print("Press the key 'shift_r' to turn on light ...\n")
while True:
    try:
        if not GPIO.input(key_channel):
            print("The key 'shift_r' was pressed!")
            start = time.time()
            while (time.time() - start) < 3:
                GPIO.output(led_channel, GPIO.HIGH)
                time.sleep(0.5)
                GPIO.output(led_channel, GPIO.LOW)
                time.sleep(0.5)
            break
    except KeyboardInterrupt:
        break
GPIO.cleanup()
Output:

Resources

References

  • pynput: a package to control and monitor input devices.
  • RPi.GPIO: a module to control RPi GPIO channels.
Image credit: "Raspberry Pi Closeup" by Gijs Peijs is licensed under CC BY 2.0

Comments

Post a Comment

Popular posts from this blog

Install the MAMP (Mac, Apache, MySQL, PHP) stack

-
Image
There are two ways that you could install ( freely ) the whole MAMP stack: installing the MAMP (version 4.5) software bundle is the easiest way since it is a one-click-solution for setting up a personal webserver install each components (Apache, MySQL, and PHP) separately. This second method consists in installing Apache and PHP with Homebrew, and MySQL with the  package Installer . It is the hardest method but it enables you more control over the installation process, e.g you can install specific versions of each components, or install extra PHP extensions. NOTE:  MAMP 4.5, Apache 2.4.33, MySQL 8.0.11, PHP 7.2.7, and phpMyAdmin 4.8.2 are installed in the following tutorial Contents 1. Method 1: install the MAMP software bundle 2. Method 2: install each components (Apache, MySQL, and PHP) separately      2.1 Apache+PHP           2.1.1 Install Apache+PHP           2.1.2  Change Apache's default ports           2.1.3  Start the Apache server           2.1
Read more

Deactivate conda's base environment on startup

-
Image
When opening a terminal session, conda activates the base environment by default. If you want to prevent this default behaviour, you have three ways: Trick #1  :  Set the auto_activate_base parameter to false Trick #2  : Add conda deactivate in your bash configuration file Trick #3  :  Comment out some part of the conda initialisation code block in your bash configuration file NOTES: I'm working with  conda version 4.7.5 and  miniconda3 (it should also work with anaconda ). These tricks also worked with  conda version 4.6.14 After installing conda 4.7, conda added this block of code in my ~/.bash_profile : This is the block of code that we will modify in the following tricks Trick #1: set auto_activate_base  to false Per conda's instructions, "if you'd prefer that conda's base environment not be activated on startup, set the auto_activate_base parameter to false". Thus, enter the following command in a terminal: conda config --set
Read more

Product review: SMONET wireless security camera system

-
Image
I bought a security camera system from SMONET which consists of 4 wireless [1] bullet IP cameras with night vision: each camera comes with its power adapter [2] . There is an optional Ethernet port on each camera. The camera has an image resolution of 1280*960P . An NVR (Network Video Recorder) system: it comes with its power adapter, a mouse, and an Ethernet cable to connect the NVR to a router. In the Amazon product page  (product description section), they talk about 2 USB2.0 Port but my NVR only has 1 USB2.0 Port in the back, and you can also see it in the user manual  (page 3) that there is only one USB2.0 Port in the back of the NVR. This NVR doesn't come with a hard drive; you have to buy it separately. It is important to stress that if you plan on having a robust security camera system that is very reliable and secure 24 hours a day, 7 days a week, you should opt for a wired security camera system. This wireless security camera system allows you to change the w
Read more