curious-ninja / tkgpio

A Python library to simulate electronic devices connected to the GPIO on a Raspberry Pi, using TkInter.

tkgpio

A Python library to simulate electronic devices connected to the GPIO on a Raspberry Pi, using TkInter.

About

Due to the Coronavirus outbreak in 2020, students enrolled in my Microcontroller course could not use the laboratory. So I decided to build a Raspberry Pi circuit simulator, to make remote class activities possible. And it works pretty well!

The main goal here is to enable students to use the same APIs that control physical devices connected to the GPIO, but interacting with a GUI instead. I'm not worried about creating a realistic electronic simulation.

Since we were already using Python to program on Raspberry Pi, I've built the interface with TkInter. Some libraries (like gpiozero) allowed me to easily mock the devices in the GUI. In other cases, I had to reimplement the API inside the library – but since I can temporaraly add folders to Python's PATH, import commands keep working exactly as the original ones.

TkGPIO currently supports the following devices:

• Some gpiozero components (more coming soon)
  • LED / PWMLED
  • (Active) Buzzer
  • Button
  • Distance Sensor (HC-SR04)
  • Light Sensor (LDR)
  • Motion Sensor (HC-SR501)
• LCD display (reimplementing Adafruit_CharLCD API)
  • Only message and clear methods are supported for now (more coming soon)
• Infrared emmitter (reimplementing py_irsend API)
• Infrared receiver (reimplementing python-lirc API)

Usage

This is a simple example to create and control 2 LEDs and 1 Button.

from tkgpio import TkCircuit

# initialize the circuit inside the 

configuration = {
    "width": 300,
    "height": 200,
    "leds": [
        {"x": 50, "y": 40, "name": "LED 1", "pin": 21},
        {"x": 100, "y": 40, "name": "LED 2", "pin": 22}
    ],
    "buttons": [
        {"x": 50, "y": 130, "name": "Press to toggle LED 2", "pin": 11},
    ]
}

circuit = TkCircuit(configuration)
@circuit.run
def main ():
    
    # now just write the code you would use on a real Raspberry Pi
    
    from gpiozero import LED, Button
    from time import sleep
    
    led1 = LED(21)
    led1.blink()
    
    def button_pressed():
        print("button pressed!")
        led2.toggle()
    
    led2 = LED(22)
    button = Button(11)
    button.when_pressed = button_pressed
    
    while True:
        sleep(0.1)

You could also initialize the circuit in a function inside a separate Python file, to hide it from students.

Check more sample code files in docs/examples.

Instalation

Download/clone this repository, open your Terminal, navigate to tkgpio's root folder, and use PyPI:

pip install .

I'll upload it to PyPI later on, after a few tweaks.