https://github.com/nosix/raspberry-gpio-emulator
RPi.GPIO emulator
https://github.com/nosix/raspberry-gpio-emulator
Last synced: 9 days ago
JSON representation
RPi.GPIO emulator
- Host: GitHub
- URL: https://github.com/nosix/raspberry-gpio-emulator
- Owner: nosix
- License: apache-2.0
- Created: 2016-12-19T09:05:32.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2022-11-19T01:06:48.000Z (over 2 years ago)
- Last Synced: 2025-04-24T03:08:42.730Z (9 days ago)
- Language: Python
- Size: 54.7 KB
- Stars: 75
- Watchers: 5
- Forks: 19
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# raspberry-gpio-emulator
RPi.GPIO emulator (tested by macOS 10.12)
# Docker image
https://hub.docker.com/r/nosix/raspberry-gpio-emulator/
# Require
- Python 3.5
# Install
```bash
$ pip install git+https://github.com/nosix/raspberry-gpio-emulator/
```
# API
```python
import RPi.GPIO as GPIO
```
GPIO:
- setmode(mode)
- mode : GPIO.BOARD or GPIO.BCP
- setwarnings(flag)
- flag : bool
- setup(channel, state, initial, pull_up_down)
- channel : int or Sequence[int]
- state : GPIO.OUT or GPIO.IN
- initial (option) : GPIO.LOW or GPIO.HIGH
- pull_up_down (option) : GPIO.PUD_OFF, GPIO.PUD_DOWN or GPIO.PUD_UP
- output(channel, outmode)
- channel : int or Sequence[int]
- outmode : GPIO.LOW, GPIO.HIGH or Sequence[GPIO.LOW or GPIO.HIGH]
- input(channel) : bool
- channel : int
- cleanup(channel)
- channel (option) : int or Sequence[int]
- wait_for_edge(channel, event, timeout) : int or None
- channel : int
- event : GPIO.RISING, GPIO.FALLING or GPIO.BOTH
- timeout (option) : int [millisecond]
- add_event_detect(channel, event, callback, bouncetime)
- channel : int
- event : GPIO.RISING, GPIO.FALLING or GPIO.BOTH
- callback (option) : function(channel)
- channel : int
- bouncetime (option) : int [millisecond]
- add_event_callback(channel, callback, bouncetime)
- channel : int
- callback : function(channel)
- channel : int
- bouncetime (option) : int [millisecond]
- remove_event_detect(channel)
- channel : int
- event_detected(channel) : bool
- channel : int
- gpio_function(channel) : GPIO.OUT, GPIO.IN, GPIO.SERIAL, GPIO.SPI, GPIO.I2C or GPIO.HARD_PWM
- channel : int
- PWM(channel, frequency) : GPIO.PWM
- channel : int
- frequency : float [Hz]
GPIO.PWM:
- start(duty_cycle)
- duty_cycle : float [0.0..100.0]
- stop()
- ChangeFrequency(frequency)
- frequency : float [Hz]
- ChangeDutyCycle(duty_cycle)
- duty_cycle : float [0.0..100.0]
# Usage
Documentation of raspberry-gpio-python:
- [RPi.GPIO module basics](https://sourceforge.net/p/raspberry-gpio-python/wiki/BasicUsage/)
- [Outputs](https://sourceforge.net/p/raspberry-gpio-python/wiki/Outputs/)
- [Inputs](https://sourceforge.net/p/raspberry-gpio-python/wiki/Inputs/)
- [Check function](https://sourceforge.net/p/raspberry-gpio-python/wiki/Checking%20function%20of%20GPIO%20channels/)
- [PWM](https://sourceforge.net/p/raspberry-gpio-python/wiki/PWM/)
Sample code:
- [sample_board.py](https://github.com/nosix/raspberry-gpio-emulator/blob/master/samples/sample_board.py)
- [sample_bcm.py](https://github.com/nosix/raspberry-gpio-emulator/blob/master/samples/sample_bcm.py)
- [sample_input.py](https://github.com/nosix/raspberry-gpio-emulator/blob/master/samples/sample_input.py)
- [sample_gpio_function.py](https://github.com/nosix/raspberry-gpio-emulator/blob/master/samples/sample_gpio_function.py)
- [sample_pwm.py](https://github.com/nosix/raspberry-gpio-emulator/blob/master/samples/sample_pwm.py)
# Custom UI
You can use custom user interface which you wrote.
`--ui` option enable custom user interface.
`--ui` option require user interface module which has create_ui() function.
```
$ python sample_custom_ui_launcher.py --ui sample_custom_ui
```
Sample code:
- [sample_custom_ui_launcher.py](https://github.com/nosix/raspberry-gpio-emulator/blob/master/samples/sample_custom_ui_launcher.py)
- [sample_custom_ui.py](https://github.com/nosix/raspberry-gpio-emulator/blob/master/samples/sample_custom_ui.py)
# Plugin
You can use plugins which you wrote.
List plugin modules which have create_plugin() function.
Plugin observe change event.
```
$ python sample_plugin.py sample_plugin_a sample_plugin_b
```
Sample code:
- [sample_plugin_launcher.py](https://github.com/nosix/raspberry-gpio-emulator/blob/master/samples/sample_plugin_launcher.py)
- [sample_plugin_a.py](https://github.com/nosix/raspberry-gpio-emulator/blob/master/samples/sample_plugin_a.py)
- [sample_plugin_b.py](https://github.com/nosix/raspberry-gpio-emulator/blob/master/samples/sample_plugin_b.py)
# Credit
This project based on [Pi GPIO Emulator](https://sourceforge.net/projects/pi-gpio-emulator/).
- [Roderick Vella](https://roderickvella.wordpress.com/2016/06/28/raspberry-pi-gpio-emulator/)
- 2016
- [Pi GPIO Emulator](https://sourceforge.net/projects/pi-gpio-emulator/)
- This project uses base design as reference, but it changes usage and implementation.