Skip to main content

Python library for the Pimoroni Fan Shim for Raspberry Pi

Project description

Fan Shim for Raspberry Pi

Build Status Coverage Status PyPi Package Python Versions

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

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.

Source Distribution

fanshim-0.0.5.tar.gz (5.1 kB view details)

Uploaded Source

Built Distributions

fanshim-0.0.5-py3-none-any.whl (4.8 kB view details)

Uploaded Python 3

fanshim-0.0.5-py2-none-any.whl (4.8 kB view details)

Uploaded Python 2

File details

Details for the file fanshim-0.0.5.tar.gz.

File metadata

  • Download URL: fanshim-0.0.5.tar.gz
  • Upload date:
  • Size: 5.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/49.2.0 requests-toolbelt/0.9.1 tqdm/4.48.0 CPython/3.7.3

File hashes

Hashes for fanshim-0.0.5.tar.gz
Algorithm Hash digest
SHA256 65a1b8004608a76f4baffa1c50a4305a4a1b412e5f9d47398286b2657af084da
MD5 0ce31dad1863e3a4e2cf7ddbd40ec023
BLAKE2b-256 5d252ef5204c16a1448236e7e243c4310313a6eb176177447015e189225d648d

See more details on using hashes here.

File details

Details for the file fanshim-0.0.5-py3-none-any.whl.

File metadata

  • Download URL: fanshim-0.0.5-py3-none-any.whl
  • Upload date:
  • Size: 4.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/49.2.0 requests-toolbelt/0.9.1 tqdm/4.48.0 CPython/3.7.3

File hashes

Hashes for fanshim-0.0.5-py3-none-any.whl
Algorithm Hash digest
SHA256 ebca51219a020f23f327ef3a88b13fe3501f3e6f84533500ed4be778c4522985
MD5 c3bb638e65e46fffbe0a5b2775c644b4
BLAKE2b-256 873a21742a58ef7bd1b5ada4031d40c67cb94c3a3630541749111337cb35d7b8

See more details on using hashes here.

File details

Details for the file fanshim-0.0.5-py2-none-any.whl.

File metadata

  • Download URL: fanshim-0.0.5-py2-none-any.whl
  • Upload date:
  • Size: 4.8 kB
  • Tags: Python 2
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/49.2.0 requests-toolbelt/0.9.1 tqdm/4.48.0 CPython/3.7.3

File hashes

Hashes for fanshim-0.0.5-py2-none-any.whl
Algorithm Hash digest
SHA256 c293251604a52436bd211956610100dbfd3d508d7b2f8b1defe50f17ffa6b7c5
MD5 2af4315e69793f07c9b62e6857f163e4
BLAKE2b-256 73a5ac458ddc4adda6ae46745659544ec7edf2f3fa244823fd52226472cfff38

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page