Python library for the Pimoroni Fan Shim for Raspberry Pi
Project description
Fan Shim for Raspberry Pi
Installing
Stable library from PyPi:
- Just run
sudo pip install fanshim
Latest/development library from GitHub:
apt install git python3-pip
git clone https://github.com/pimoroni/fanshim-python
cd fanshim-python
sudo ./install.sh
Reference
You should first set up an instance of the FANShim
class, eg:
from fanshim import FanShim
fanshim = FanShim()
Fan
Turn the fan on with:
fanshim.set_fan(True)
Turn it off with:
fanshim.set_fan(False)
You can also toggle the fan with:
fanshim.toggle_fan()
You can check the status of the fan with:
fanshim.get_fan() # returns 1 for 'on', 0 for 'off'
LED
Fan Shim includes one RGB APA-102 LED.
Set it to any colour with:
fanshim.set_light(r, g, b)
Arguments r, g and b should be numbers between 0 and 255 that describe the colour you want.
For example, full red:
fanshim.set_light(255, 0, 0)
Button
Fan Shim includes a button, you can bind actions to press, release and hold events.
Do something when the button is pressed:
@fanshim.on_press()
def button_pressed():
print("The button has been pressed!")
Or when it has been released:
@fanshim.on_release()
def button_released(was_held):
print("The button has been pressed!")
Or when it's been pressed long enough to trigger a hold:
fanshim.set_hold_time(2.0)
@fanshim.on_hold()
def button_held():
print("The button was held for 2 seconds")
The function you bind to on_release()
is passed a was_held
parameter,
this lets you know if the button was held down for longer than the configured
hold time. If you want to bind an action to "press" and another to "hold" you
should check this flag and perform your action in the on_release()
handler:
@fanshim.on_release()
def button_released(was_held):
if was_held:
print("Long press!")
else:
print("Short press!")
To configure the amount of time the button should be held (in seconds), use:
fanshim.set_hold_time(number_of_seconds)
If you need to stop Fan Shim from polling the button, use:
fanshim.stop_polling()
You can start it again with:
fanshim.start_polling()
Alternate Software
- Fan SHIM in C, using WiringPi - https://github.com/flobernd/raspi-fanshim
- Fan SHIM in C++, using libgpiod - https://github.com/daviehh/fanshim-cpp
0.0.5
- Replace Plasma API with APA102 library
- Add support for setting LED global brightness
- Add support for disabling button and/or LED
- Move packages/requires to setup.config, minimum version now Python 2.7
0.0.4
- Prepare Fan SHIM to use legacy Plasma API
0.0.3
- Fix: lower polling frequency and make customisable, for PR #6
0.0.2
- Fix: Fix error on exit
0.0.1
- Initial Release
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.