Example 9: Custom Character

examples/ex9_qwiic_serlcd_custom_character.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
154
155
156
157
158
159
160
161
162
163
#!/usr/bin/env python
#-----------------------------------------------------------------------------
# ex9_qwiic_serlcd_custom_character.py
#
# This example prints "I <heart> SerLCD!" and a little dancing man
# to the LCD.
#
# Custom characters are recorded to SerLCD and are remembered even after power is lost.
# There is a maximum of 8 custom characters that can be recorded.
#
#------------------------------------------------------------------------
#
# Written by SparkFun Electronics, August 2020
#
# Ported from Arduino Library code with many contributions from
# Gaston Williams - August 29, 2018
# 
# Based on Adafruit's example at
#  
# https://github.com/adafruit/SPI_VFD/blob/master/examples/createChar/createChar.pde
#
# This example code is in the public domain.
# http://www.arduino.cc/en/Tutorial/LiquidCrystalCustomCharacter
#
# Also useful:
# http://icontexto.com/charactercreator/
#
# 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) 2020 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 9
#

from __future__ import print_function
import qwiic_serlcd
import time
import sys

def runExample():

	print("\nSparkFun Qwiic SerLCD   Example 9\n")
	myLCD = qwiic_serlcd.QwiicSerlcd()

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

	myLCD.setBacklight(255, 255, 255) # Set backlight to bright white
	myLCD.setContrast(5) # set contrast. Lower to 0 for higher contrast.
	myLCD.begin() # call this for default settings (no
	myLCD.leftToRight()
	time.sleep(1) # give a sec for system messages to complete
	
	# make some custom characters:
	heart = [ 
	0b00000, 
	0b01010, 
	0b11111, 
	0b11111, 
	0b11111, 
	0b01110, 
	0b00100, 
	0b00000]

	smiley = [
	0b00000,
	0b00000,
	0b01010,
	0b00000,
	0b00000,
	0b10001,
	0b01110,
	0b00000]

	frownie = [
	0b00000,
	0b00000,
	0b01010,
	0b00000,
	0b00000,
	0b00000,
	0b01110,
	0b10001]

	armsDown = [
	0b00100,
	0b01010,
	0b00100,
	0b00100,
	0b01110,
	0b10101,
	0b00100,
	0b01010]

	armsUp = [
	0b00100,
	0b01010,
	0b00100,
	0b10101,
	0b01110,
	0b00100,
	0b00100,
	0b01010]

	myLCD.createChar(0, heart)
	myLCD.createChar(1, smiley)
	myLCD.createChar(2, frownie)
	myLCD.createChar(3, armsDown)
	myLCD.createChar(4, armsUp)

	myLCD.setCursor(0,0) # set cursor to the top left

	# Print a message to the LCD.
	myLCD.print("I ")
	myLCD.writeChar(0) # Print the heart character, stored in location 0
	myLCD.print(" SerLCD! ")
	myLCD.writeChar(1) # Print smiley

	while True:

		myLCD.setCursor(4,1) # column, row
		myLCD.writeChar(3) # print little man, arms down
		time.sleep(0.2)

		myLCD.setCursor(4,1) # column, row
		myLCD.writeChar(4) # print little man, arms up
		time.sleep(0.2)

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