Top_pHAT_Button_Py¶
Python module for the buttons aboard the SparkFun Top pHAT
This package can be used in conjunction with the overall SparkFun qwiic Python Package
New to qwiic? Take a look at the entire SparkFun qwiic ecosystem.
Supported Platforms¶
The Top pHAT Button Python package current supports the following platforms:
Dependencies¶
This driver package depends on the qwiic I2C driver: Qwiic_I2C_Py
Documentation¶
The SparkFun Top pHAT Button module documentation is hosted at ReadTheDocs
Installation¶
PyPi Installation¶
This repository is hosted on PyPi as the sparkfun-top-phat-button package. On systems that support PyPi installation via pip, this library is installed using the following commands
For all users (note: the user must have sudo privileges):
sudo pip install sparkfun-top-phat-button
For the current user:
pip install sparkfun-top-phat-button
Local Installation¶
To install, make sure the setuptools package is installed on the system.
Direct installation at the command line:
python setup.py install
To build a package for use with pip:
python setup.py sdist
A package file is built and placed in a subdirectory called dist. This package file can be installed using pip.
cd dist
pip install sparkfun_top_phat_button-<version>.tar.gz
Example Use¶
See the examples directory for more detailed use examples.
from __future__ import print_function
import top_phat_button
import time
import sys
myButtons = top_phat_button.ToppHATButton()
def runExample():
print("\nSparkFun Top pHAT Button Example 1\n")
if myButtons.is_connected() == False:
print("The Top pHAT Button device isn't connected to the system. Please check your connection", \
file=sys.stderr)
return
myButtons.pressed_interrupt_enable = False
myButtons.clicked_interrupt_enable = False
while True:
myButtons.button_pressed #These functions must be called to update button variables to their latest setting
myButtons.button_clicked #These functions must be called to update button variables to their latest setting
if myButtons.a_pressed == True:
print("A Pressed")
if myButtons.a_clicked == True:
print("A Released")
if myButtons.b_pressed == True:
print("B Pressed")
if myButtons.b_clicked == True:
print("B Released")
if myButtons.up_pressed == True:
print("Up Pressed")
if myButtons.up_clicked == True:
print("Up Released")
if myButtons.down_pressed == True:
print("Down Pressed")
if myButtons.down_clicked == True:
print("Down Released")
if myButtons.left_pressed == True:
print("Left Pressed")
if myButtons.left_clicked == True:
print("Left Released")
if myButtons.right_pressed == True:
print("Right Pressed")
if myButtons.right_clicked == True:
print("Right Released")
if myButtons.center_pressed == True:
print("Center Pressed")
if myButtons.center_clicked == True:
print("Center Released")
time.sleep(.1)
if __name__ == '__main__':
try:
runExample()
except (KeyboardInterrupt, SystemExit) as exErr:
print("\nEnding Example 1")
sys.exit(0)
Table of Contents¶
API Reference¶
top_phat_button¶
Python module for the[SparkFun Qwiic Joystick](https://www.sparkfun.com/products/15168)
This python package is a port of the existing [SparkFun Qwiic Joystick Arduino Library](https://github.com/sparkfun/SparkFun_Qwiic_Joystick_Arduino_Library)
This package can be used in conjunction with the overall [SparkFun qwiic Python Package](https://github.com/sparkfun/Qwiic_Py)
New to qwiic? Take a look at the entire [SparkFun qwiic ecosystem](https://www.sparkfun.com/qwiic).
Parameters: - address – The I2C address to use for the device. If not provided, the default address is used.
- i2c_driver – An existing i2c driver object. If not provided a driver object is created.
Returns: The ToppHATButton device object.
Return type: Object
Initialize the operation of the button module
Returns: Returns true of the initializtion was successful, otherwise False. Return type: bool
Returns 1 when a button has received a full click cycle (press and release). The interrupt must be cleared by the user. 7(MSB) 6 5 4 3 2 1 0(LSB)
INT CTR RGT LFT DWN UP B AReturns: Clicked status of all buttons in a byte Return type: integer
Updates and returns buffer for all buttons and whether or not they are pressed as well as the pressed interrupt flag Reading this register also clears it. 7(MSB) 6 5 4 3 2 1 0(LSB)
INT CTR RGT LFT DWN UP B AReturns: button status Return type: integer
Returns the status of the clicked interrupt enable
Returns: The clicked interrupt enable bit Return type: bool
Determine if the Top pHAT Buttons are connected to the system..
Returns: True if the device is connected, otherwise False. Return type: bool
Returns 1 when a button has received a full click cycle (press and release). The interrupt must be cleared by the user. 7(MSB) 6 5 4 3 2 1 0(LSB)
INT CTR RGT LFT DWN UP B AReturns: Clicked status of all buttons in a byte Return type: integer
Updates and returns buffer for all buttons and whether or not they are pressed as well as the pressed interrupt flag Reading this register also clears it. 7(MSB) 6 5 4 3 2 1 0(LSB)
INT CTR RGT LFT DWN UP B AReturns: button status Return type: integer
Returns the status of the clicked interrupt enable
Returns: The clicked interrupt enable bit Return type: bool
Returns the status of the pressed interrupt enable
Returns: The pressed interrupt enable bit Return type: bool
Returns a string of the firmware version number
Returns: The firmware version Return type: string
Determine if the Top pHAT Buttons are connected to the system..
Returns: True if the device is connected, otherwise False. Return type: bool
Returns the status of the pressed interrupt enable
Returns: The pressed interrupt enable bit Return type: bool
Sets the status of the clicked interrupt enable bit
Param: The clicked interrupt enable bit Returns: The status of the I2C transaction Return type: bool
Sets the status of the pressed interrupt enable bit
Param: The pressed interrupt enable bit Returns: The status of the I2C transaction Return type: bool
Returns a string of the firmware version number
Returns: The firmware version Return type: string
Example 1¶
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 | #!/usr/bin/env python
#-----------------------------------------------------------------------------
# top_phat_button_ex1.py
#
# Polling example for the Top pHAT Buttons
#------------------------------------------------------------------------
#
# Written by SparkFun Electronics, April 2020
#
# This python library supports the SparkFun Electroncis qwiic
# qwiic sensor/board ecosystem on a Raspberry Pi (and compatable) single
# board computers.
#
# More information on qwiic is at https://www.sparkfun.com/qwiic
#
# Do you like this library? Help support SparkFun. Buy a board!
#
#==================================================================================
# Copyright (c) 2019 SparkFun Electronics
#
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to deal
# in the Software without restriction, including without limitation the rights
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in all
# copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
# SOFTWARE.
#==================================================================================
# Example 1
#
from __future__ import print_function
import top_phat_button
import time
import sys
myButtons = top_phat_button.ToppHATButton()
def runExample():
print("\nSparkFun Top pHAT Button Example 1\n")
if myButtons.is_connected() == False:
print("The Top pHAT Button device isn't connected to the system. Please check your connection", \
file=sys.stderr)
return
myButtons.pressed_interrupt_enable = False
myButtons.clicked_interrupt_enable = False
while True:
myButtons.button_pressed #These functions must be called to update button variables to their latest setting
myButtons.button_clicked #These functions must be called to update button variables to their latest setting
if myButtons.a_pressed == True:
print("A Pressed")
if myButtons.a_clicked == True:
print("A Released")
if myButtons.b_pressed == True:
print("B Pressed")
if myButtons.b_clicked == True:
print("B Released")
if myButtons.up_pressed == True:
print("Up Pressed")
if myButtons.up_clicked == True:
print("Up Released")
if myButtons.down_pressed == True:
print("Down Pressed")
if myButtons.down_clicked == True:
print("Down Released")
if myButtons.left_pressed == True:
print("Left Pressed")
if myButtons.left_clicked == True:
print("Left Released")
if myButtons.right_pressed == True:
print("Right Pressed")
if myButtons.right_clicked == True:
print("Right Released")
if myButtons.center_pressed == True:
print("Center Pressed")
if myButtons.center_clicked == True:
print("Center Released")
time.sleep(.1)
if __name__ == '__main__':
try:
runExample()
except (KeyboardInterrupt, SystemExit) as exErr:
print("\nEnding Example 1")
sys.exit(0)
|
Example 2¶
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 | #!/usr/bin/env python
#-----------------------------------------------------------------------------
# top_phat_button_ex2.py
#
# Interrupt example for the Top pHAT Buttons
#------------------------------------------------------------------------
#
# Written by SparkFun Electronics, April 2020
#
# This python library supports the SparkFun Electroncis qwiic
# qwiic sensor/board ecosystem on a Raspberry Pi (and compatable) single
# board computers.
#
# More information on qwiic is at https://www.sparkfun.com/qwiic
#
# Do you like this library? Help support SparkFun. Buy a board!
#
#==================================================================================
# Copyright (c) 2019 SparkFun Electronics
#
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to deal
# in the Software without restriction, including without limitation the rights
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in all
# copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
# SOFTWARE.
#==================================================================================
# Example 2
#
from __future__ import print_function
import top_phat_button
import time
import sys
import RPi.GPIO as GPIO
INTERRUPT_PIN = 25
GPIO.setmode(GPIO.BCM)
GPIO.setup(INTERRUPT_PIN, GPIO.IN)
myButtons = top_phat_button.ToppHATButton()
def interruptCallback(channel):
myButtons.button_pressed
myButtons.button_clicked #Both interrupts are configured, so we need to read both registers to clear the interrupt and update our button data.
if myButtons.a_pressed == True:
print("A Pressed")
if myButtons.a_clicked == True:
print("A Released")
if myButtons.b_pressed == True:
print("B Pressed")
if myButtons.b_clicked == True:
print("B Released")
if myButtons.up_pressed == True:
print("Up Pressed")
if myButtons.up_clicked == True:
print("Up Released")
if myButtons.down_pressed == True:
print("Down Pressed")
if myButtons.down_clicked == True:
print("Down Released")
if myButtons.left_pressed == True:
print("Left Pressed")
if myButtons.left_clicked == True:
print("Left Released")
if myButtons.right_pressed == True:
print("Right Pressed")
if myButtons.right_clicked == True:
print("Right Released")
if myButtons.center_pressed == True:
print("Center Pressed")
if myButtons.center_clicked == True:
print("Center Released")
GPIO.add_event_detect(INTERRUPT_PIN, GPIO.FALLING, callback=interruptCallback, bouncetime=5)
def runExample():
print("\nSparkFun Top pHAT Button Example 1\n")
if myButtons.is_connected() == False:
print("The Top pHAT Button device isn't connected to the system. Please check your connection", \
file=sys.stderr)
return
myButtons.pressed_interrupt_enable = True
myButtons.clicked_interrupt_enable = True #Enable both hardware interrupts
while True:
time.sleep(.1)
if __name__ == '__main__':
try:
runExample()
except (KeyboardInterrupt, SystemExit) as exErr:
print("\nEnding Example 1")
sys.exit(0)
|