Qwiic_Keypad_Py

follow on Twitter

SparkFun Qwiic Keypad Breakout

Python module for the qwiic keypad, which is part of the SparkFun Qwiic Keypad - 12 Button

This python package is a port of the existing SparkFun Qwiic Keypad Arduino Library

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.

Dependencies

This driver package depends on the qwiic I2C driver: Qwiic_I2C_Py

Documentation

The SparkFun qwiic Keypad module documentation is hosted at ReadTheDocs

Installation

PyPi Installation

This repository is hosted on PyPi as the sparkfun-qwiic-keypad 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-qwiic-keypad

For the current user:

pip install sparkfun-qwiic-keypad

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_qwiic_keypad-<version>.tar.gz

Example Use

See the examples directory for more detailed use examples.

import qwiic_keypad
import time
import sys

def runExample():

    print("\nSparkFun qwiic Keypad   Example 1\n")
    myKeypad = qwiic_keypad.QwiicKeypad()

    if myKeypad.is_connected() == False:
        print("The Qwiic Keypad device isn't connected to the system. Please check your connection", \
            file=sys.stderr)
        return

    myKeypad.begin()

    button = 0
    while True:

        # necessary for keypad to pull button from stack to readable register
        myKeypad.update_fifo()
        button = myKeypad.get_button()

        if button == -1:
            print("No keypad detected")
            time.sleep(1)

        elif button != 0:

            # Get the character version of this char
            charButton = chr(button)
            if charButton == '#':
                print()
            elif charButton == '*':
                print(" ", end="")
            else:
                print(charButton, end="")

            # Flush the stdout buffer to give immediate user feedback
            sys.stdout.flush()

        time.sleep(.25)
        # Development in progress

SparkFun - Start Something

Table of Contents

API Reference

qwiic_keypad

Python module for the[SparkFun Qwiic Keypad - 12 Button Breakout](https://www.sparkfun.com/products/15290)

This python package is a port of the existing [SparkFun Qwiic Keypad Arduino Library](https://github.com/sparkfun/SparkFun_Qwiic_Keypad_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).

class qwiic_keypad.QwiicKeypad(address=None, i2c_driver=None)[source]
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 QwiicKeypad device object.
Return type:

Object
begin()[source]

Initialize the operation of the Keypad module

Returns:Returns true of the initializtion was successful, otherwise False.
Return type:bool
connected

Determine if a Keypad device is conntected to the system..

Returns:True if the device is connected, otherwise False.
Return type:bool
get_button()[source]

Returns the button at the top of the stack (aka the oldest button).

The return value is the ‘ascii’ value of th key pressed. To convert to a character, use the python char() function.

Returns:The next button value
Return type:byte as integer
get_version()[source]

Returns a string of the firmware version number

Returns:The firmware version
Return type:string
is_connected()[source]

Determine if a Keypad device is conntected to the system..

Returns:True if the device is connected, otherwise False.
Return type:bool
time_since_pressed()[source]

Returns the number of milliseconds since the current button in FIFO was pressed.

Returns:The elapsed time since button was pressed
Return type:integer
update_fifo()[source]

“commands” keypad to plug in the next button into the registerMap note, this actually sets the bit0 on the updateFIFO register

Returns:No return value
version

Returns a string of the firmware version number

Returns:The firmware version
Return type:string

Read a Key

examples/qwiic_keypad_ex1.py
 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
#!/usr/bin/env python
#-----------------------------------------------------------------------------
# qwiic_env_keypad_ex1.py
#
# Simple Example for the Qwiic Keypad Device
#------------------------------------------------------------------------
#
# Written by  SparkFun Electronics, May 2019
# 
# 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 qwiic_keypad
import time
import sys

def runExample():

	print("\nSparkFun qwiic Keypad   Example 1\n")
	myKeypad = qwiic_keypad.QwiicKeypad()

	if myKeypad.connected == False:
		print("The Qwiic Keypad device isn't connected to the system. Please check your connection", \
			file=sys.stderr)
		return

	myKeypad.begin()

	print("Initialized. Firmware Version: %s" % myKeypad.version)
	print("Press a button: * to do a space. # to go to next line.")

	button = 0
	while True:

		# necessary for keypad to pull button from stack to readable register
		myKeypad.update_fifo()  
		button = myKeypad.get_button()

		if button == -1:
			print("No keypad detected")
			time.sleep(1)

		elif button != 0:

			# Get the character version of this char
			charButton = chr(button)
			if charButton == '#':
				print()
			elif charButton == '*':
				print(" ", end="")
			else: 
				print(charButton, end="")

			# Flush the stdout buffer to give immediate user feedback
			sys.stdout.flush()

		time.sleep(.25)

if __name__ == '__main__':
	try:
		runExample()
	except (KeyboardInterrupt, SystemExit) as exErr:
		print("\nEnding Example 1")
		sys.exit(0)

Read a Key - Report Delay Time

examples/qwiic_keypad_ex2.py
 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
#!/usr/bin/env python
#-----------------------------------------------------------------------------
# qwiic_env_keypad_ex2.py
#
# Simple Example for the Qwiic Keypad Device including Time
#------------------------------------------------------------------------
#
# Written by  SparkFun Electronics, May 2019
# 
# 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 qwiic_keypad
import time
import sys

def runExample():

	print("\nSparkFun qwiic Keypad   Example 2\n")
	myKeypad = qwiic_keypad.QwiicKeypad()

	if myKeypad.connected == False:
		print("The Qwiic Keypad device isn't connected to the system. Please check your connection", \
			file=sys.stderr)
		return

	myKeypad.begin()

	print("Initialized. Firmware Version: %s" % myKeypad.version)


	button = 0
	while True:

		# necessary for keypad to pull button from stack to readable register
		myKeypad.update_fifo()  
		button = myKeypad.get_button()
		deltaT = myKeypad.time_since_pressed()

		if button == -1:
			print("No keypad detected")
			time.sleep(1)
			continue

		elif button != 0:
			print("Button %s was pressed, %d milliseconds ago." % (chr(button), deltaT))
		
		time.sleep(.25)
		

if __name__ == '__main__':
	try:
		runExample()
	except (KeyboardInterrupt, SystemExit) as exErr:
		print("\nEnding Example 2")
		sys.exit(0)

Validate a Key Code

examples/qwiic_keypad_ex3.py
  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
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
#!/usr/bin/env python
#-----------------------------------------------------------------------------
# qwiic_env_keypad_ex3.py
#
# Simple Example for the Qwiic Keypad Device
#------------------------------------------------------------------------
#
# Written by  SparkFun Electronics, May 2019
# 
# 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 3
#

from __future__ import print_function
import qwiic_keypad
import time
import sys


# the correct keyCode - change to your own unique set of keys if you like.
keyCode = ['1', '2', '3', '4'] 

def runExample():
	# used to store the presses coming in from user. init with blanks
	userEntry = [' ']*len(keyCode)
	# used to know when a user is active and therefore we want to engage timeout stuff
	userIsActive = False

	TIMEOUT=30  # in 100s of millisecs

	timeOutCounter = 0  # variable this is incremented to keep track of timeouts.
	userEntryIndex = 0 # used to keep track of where we are in the userEnt

	print("\nSparkFun qwiic Keypad   Example 3\n")
	myKeypad = qwiic_keypad.QwiicKeypad()

	if myKeypad.connected == False:
		print("The Qwiic Keypad device isn't connected to the system. Please check your connection", \
			file=sys.stderr)
		return

	myKeypad.begin()

	print("Initialized. Firmware Version: %s" % myKeypad.version)
	print("Please type in the correct 4 digit KeyCode:")


	button = 0
	while True:

		# necessary for keypad to pull button from stack to readable register
		myKeypad.update_fifo()  
		button = myKeypad.get_button()

		if button == -1:
			print("No keypad detected")
			time.sleep(1)

		elif button > 100:
			# At startup a series 127's come accoss -- way out of range
			# just noise
			# Skip
			pass
		elif button != 0:
			# store button into next spot in array, note, index is incremented later
			userEntry[userEntryIndex] = chr(button)

			printEntry(userEntry)
			userIsActive = True  # used to only timeout when user is active

			if checkEntry(userEntry):
				print("\n\nKeycode correct. Wahooooooooooo!")
				userIsActive = False # don't display timeout stuff.
				time.sleep(1)
		
			userEntryIndex += 1
			if userEntryIndex == len(keyCode):
				userEntryIndex = 0 # reset

				printEntry(userEntry)
				time.sleep(.3)
				clearEntry(userEntry)	
				printEntry(userEntry)			
			timeOutCounter = 0 #reset with any new presses.

		time.sleep(.2)
		timeOutCounter += 1

	# this means the user is actively inputing		
	if timeOutCounter == TIMEOUT  and userIsActive == True: 
		print("\n\nTimed out... try again.")
		timeOutCounter = 0
		userEntryIndex = 0
		clearEntry(userEntry)
		userIsActive = False # so we don't continuously timeout while inactive.

#  check user entry against keyCode array.
#  if they all match up, then respond with true.
def checkEntry(userEntry):

	for i in range(len(keyCode)):
		if userEntry[i] != keyCode[i]:
			return False

	return True 

#  "clear" entry with all spaces
def clearEntry(userEntry):

	userEntry[:] = [' ']*len(userEntry)

def printEntry(userEntry):

	print("\rUserEntry:%s" % (''.join(userEntry)), end="")
	sys.stdout.flush()


if __name__ == '__main__':
	try:
		runExample()
	except (KeyboardInterrupt, SystemExit) as exErr:
		print("\nEnding Example 1")
		sys.exit(0)

Indices and tables