https://github.com/pimoroni/button-shim
Python library and examples for the Pimoroni Button SHIM
https://github.com/pimoroni/button-shim
pypi-package
Last synced: 6 months ago
JSON representation
Python library and examples for the Pimoroni Button SHIM
- Host: GitHub
- URL: https://github.com/pimoroni/button-shim
- Owner: pimoroni
- License: mit
- Created: 2017-05-25T15:46:04.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2025-01-21T10:07:23.000Z (10 months ago)
- Last Synced: 2025-05-01T00:45:53.345Z (6 months ago)
- Topics: pypi-package
- Language: Python
- Homepage: https://shop.pimoroni.com/products/button-shim
- Size: 79.1 KB
- Stars: 34
- Watchers: 12
- Forks: 16
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
https://shop.pimoroni.com/products/button-shim
Five tactile push buttons and one super-bright RGB LED indicator, ideal for adding extra input and visual notifications to your Raspberry Pi alongside most other HATs and pHATs!
## Installing
### Full install (recommended):
We've created an easy installation script that will install all pre-requisites and get your Buttom SHIM.
up and running with minimal efforts. To run it, fire up Terminal which you'll find in Menu -> Accessories -> Terminal
on your Raspberry Pi desktop, as illustrated below:
In the new terminal window type the command exactly as it appears below (check for typos) and follow the on-screen instructions:
```bash
curl https://get.pimoroni.com/buttonshim | bash
```
Alternatively, on Raspbian, you can download the `pimoroni-dashboard` and install your product by browsing to the relevant entry:
```bash
sudo apt-get install pimoroni
```
(you will find the Dashboard under 'Accessories' too, in the Pi menu - or just run `pimoroni-dashboard` at the command line)
If you choose to download examples you'll find them in `/home/pi/Pimoroni/buttonshim/`.
### Manual install:
#### Library install for Python 3:
on Raspbian:
```bash
sudo apt-get install python3-buttonshim
```
other environments:
```bash
sudo pip3 install buttonshim
```
#### Library install for Python 2:
on Raspbian:
```bash
sudo apt-get install python-buttonshim
```
other environments:
```bash
sudo pip2 install buttonshim
```
### Development:
If you want to contribute, or like living on the edge of your seat by having the latest code, you should clone this repository, `cd` to the library directory, and run:
```bash
sudo python3 setup.py install
```
(or `sudo python setup.py install` whichever your primary Python environment may be)
## Documentation & Support
* Guides and tutorials - https://learn.pimoroni.com/button-shim
* Function reference - http://docs.pimoroni.com/buttonshim/
* GPIO Pinout - https://pinout.xyz/pinout/button_shim
* Get help - http://forums.pimoroni.com/c/support
## Unofficial / Third-party libraries
* Go library by Tom Mitchell - https://github.com/tomnz/button-shim-go