Qwiic_Alphanumeric_Py

Python module for the [SparkFun Qwiic Alphanumeric Display].

It is compatible with the following products:

• SparkFun Qwiic Alphanumeric Display - Pink

• SparkFun Qwiic Alphanumeric Display - Red

• SparkFun Qwiic Alphanumeric Display - Purple

• SparkFun Qwiic Alphanumeric Display - Blue

• SparkFun Qwiic Alphanumeric Display - Green

• SparkFun Qwiic Alphanumeric Display - White

This python package is a port of the existing SparkFun Qwiic Alphanumeric 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.

Contents

• Supported Platforms

• Dependencies

• Installation

• Documentation

• Example Use

Supported Platforms

The Qwiic LED Stick Python package currently supports the following platforms:

• Raspberry Pi

Dependencies

This driver package depends on the qwiic I2C driver: Qwiic_I2C_Py

Documentation

The SparkFun Qwiic LED Stick module documentation is hosted at ReadTheDocs

Installation

PyPi Installation

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

For the current user:

pip install sparkfun-qwiic-alphanumeric

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

Example Use

See the examples directory for more detailed use examples.

from __future__ import print_function
import qwiic_alphanumeric
import time
import sys

def run_example():

    print("\nSparkFun Qwiic Alphanumeric - Example 4: Print String")
    my_display = qwiic_alphanumeric.QwiicAlphanumeric()

    if my_display.begin() == False:
        print("\nThe Qwiic Alphanumeric isn't connected to the system. Please check your connection.", \
            file=sys.stderr)
        return

    print("\nQwiic Alphanumeric ready!")

    my_display.print("Milk")

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

Table of Contents

API Reference

qwiic_alphanumeric

Python module for the SparkFun Qwiic Alphanumeric displays.

This package is a port of the existing [SparkFun Alphanumeric Display Arduino Library](https://github.com/sparkfun/SparkFun_Alphanumeric_Display_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_alphanumeric.QwiicAlphanumeric(address=None, i2c_driver=None)

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 a driver is created.

Returns

The QwiicAlphanumeric device object.

Return type

Object

begin(address_display_one=112, address_display_two=255, address_display_three=255, address_display_four=255)

Initialize the operation of the Qwiic Alphanumeric. Assign addresses to displays and determine the number of displays connected to the bus. Run is_connected(). Initialize and clear displays.

Parameters

• address_display_one – I2C address of first display

• address_display_two – I2C address of the second display

• address_dispplay_three – I2C address of the third display

• address_display_four – I2C address of the fourth display

Returns

Returns true if a Qwiic Alphanumeric is connected to the system. False otherwise.

Return type

bool

clear()

Turn off all segments of all displays connected to bus

Returns

True if display was updated correctly, false otherwise

Return type

bool

colon_off()

Turn the colon off for all displays on the bus

Returns

true if all displays are successfully updated, false otherwise.

Return type

bool

colon_off_single(display_number)

Turn the colon off for a single display

Parameters

display_number – number of display to update.

Returns

true if display updated successfully, false otherwise.

Return type

bool

colon_on()

Turn the colon on for all displays on the bus

Returns

true if displays successfully updated, false otherwise.

Return type

bool

colon_on_single(display_number)

Turn the colon on for a single display

Parameters

display_number – number of display to update.

Returns

true if display updated successfully, false otherwise.

Return type

bool

decimal_off()

Turn the decimal point off for all displays on the bus

Returns

true if displays are updated successfully, false otherwise.

Return type

bool

decimal_off_single(display_number)

Turn the decimal point off for a single display

Parameters

display_number – the number of display to turn the decimal point off for.

Returns

true if decimal is successfully turned off, false otherwise.

Return type

bool

decimal_on()

Turn the decimal on for all displays on the bus

Returns

true if displays are updated successfully, false otherwise.

Return type

bool

decimal_on_single(display_number)

Turn the decimal point on for a single display

Parameters

display_number – the number of display to turn the decimal on for.

Returns

true if decimal is successfully turned on, false otherwise.

Return type

bool

disable_system_clock()

Turn off the system oscillator for all displays on the bus

Returns

True if all clocks successfully disabled, false otherwise.

Return type

bool

disable_system_clock_single(display_number)

Turn off the system oscillator for standby mode

Parameters

display_number – number of display on I2C bus to disable the system clock for.

Returns

True if setting updated successfully, false otherwise.

Return type

bool

display_off()

Turn off all displays on the I2C bus

Returns

True if all displays are successfully turned off, false otherwise.

Return type

bool

display_off_single(display_number)

Turn a single alphanumeric display off

Parameters

display_number – the number of display to be updated

Returns

True if display is successfully turned off, false otherwise

Return type

bool

display_on()

Turn on all displays on the I2C bus

Returns

True if displays are successfully turned on, false otherwise.

Return type

bool

display_on_single(display_number)

Turn a single alphanumeric display on

Parameters

display_number – the number of display to be updated

Returns

True if display is successfully turned on, false otherwise

Return type

bool

enable_system_clock()

Turn on the system oscillator for all displays on the I2C bus

Returns

True if all clocks successfully enabled, false otherwise.

Return type

bool

enable_system_clock_single(display_number)

Turn on the system oscillator for normal operation mode

Parameters

display_number – number of display on I2C bus to enable the system clock for.

Returns

True if setting updated successfully, false otherwise.

Return type

bool

illuminate_char(segments_to_turn_on, digit)

Fiven a binary set of segments and a digit, store this data into the RAM array

Parameters

• segments_to_turn_on – list of segments to illuminate which create an alphanumeric character

• digit – digit on which to illuminate this char (list of segments)

Returns

nothing

Return type

Void

illuminate_segment(segment, digit)

Given a segment and a digit, set the matching bit within the RAM of the Holtek RAM set

Parameters

• segment – the segment to illuminate. There are 14 segments available, so A-N

• digit – the digit on the display to turn the segment on. There are 4 digits per display

Returns

nothing

Return type

Void

initialize()

Run through initialization sequence for each display connected on the I2C bus Enable clocks, set brightness default to full brightness, turn off blinking, and turn all displays on

Returns

True if all function calls passed, False if there’s a failure somewhere

Return type

bool

is_connected(display_number)

Check that dispplays are responding on the I2C bus.

Parameters

display_number – The number of the display on the bus

Returns

True if the device is connected, false otherwise.

Return type

bool

look_up_display_address(display_number)

This function connects the display number to its coressponding address

Parameters

display_number – number of display on I2C bus. The left-most display is zero and display number increments by 1 with each additional display on bus.

Returns

The I2C address of given display. 0 if display_number is not valid

Return type

int

print(print_string)

Print a whole string to the alphanumeric display(s)

Parameters

print_string – string to be printed

Returns

true if update_display() is successful, false otherwise

Return type

bool

print_char(display_char, digit)

Print a character, for a given digit, on display

Parameters

• display_char – the character to be printed to display

• digit – the digit position where character should be printed

Returns

nothing

Return type

Void

set_blink_rate(rate)

Set the blink rate of all displays on the bus as defined by the datasheet.

Parameters

rate – Blink frequency in Hz. Valid options are defined by datasheet: 2.0, 1.0, or 0.5 Hz. Any other input to this function will result in steady alphanumeric display (no blink).

Returns

True if blink setting is successfully updated, false otherwise.

Return type

bool

set_blink_rate_single(display_number, rate)

Set the blink rate of a single display on the bus

Parameters

• display_number – the number of display to be updated

• rate – Blink frequency in Hz. Valid options are defined by datasheet: 2.0, 1.0, or 0.5 Hz. Any other input to this function will result in steady alphanumeric display (no blink).

Returns

True if blink setting is successfully updated, false otherwise.

Return type

bool

set_brightness(duty)

This function sets the brightness of all displays on the bus. Duty cycle over 16.

Parameters

duty – Valid between 0 (display off) and 15 (full brightness)

Returns

True if brightness is successfully updated, false otherwise.

Return type

bool

set_brightness_single(display_number, duty)

Set the brightness of a single display

Parameters

• display_number – The number of display on the I2C bus.

• duty – Over 16. Valid between 0 (display off) and 15 (full brightness)

Returns

True if brightness is successfully updated, false otherwise.

Return type

bool

set_colon_on_off(display_number, turn_on_colon)

Set or clear the colon on/off bit

Parameters

• display_number – number of display to update.

• turn_on_colon – boolean variable. If true, colon will turn on. If false, colon will turn off.

:return true if display updated successfully, false otherwise. :rtype: bool

set_decimal_on_off(display_number, turn_on_decimal)

Set or clear the decimal on/off bit

Parameters

• display_number – the number of display to update.

• turn_on_decimal – boolean variable. If true, will turn decimal on. If false, will turn decimal off.

Returns

true if the display is updated successfully, false otherwise.

Return type

bool

set_display_on_off(display_number, turn_on_display)

Set or clear the display on/off bit of a given display number

Parameters

• display_number – the number of display to be updated

• turn_on_display – boolean variable. If true, will turn display on. If false, will turn display off

Returns

True if display is successfully updated, false otherwise.

Return type

bool

shift_left(shift_amt=1)

Shift the display content to the left a number of digits

Parameters

shift_amt – the number of digits to shift the string

Returns

true if display updates successfully, false otherwise.

Return type

bool

shift_right(shift_amt=1)

Shift the display content to the right a number of digits

Parameters

shift_amt – the number of digits to shift the string

Returns

true if display updates successfully, false otherwise.

Return type

bool

update_display()

Push the contents of display_RAM out on to the various displays in 16 byte chunks

Returns

true if displays are updated successfully, false otherwise.

Return type

bool

write_RAM(address, reg, buff)

Write LED updates to the RAM of the LED driver IC

Parameters

• address – I2C address of the display

• reg – the location in RAM to write to

• buff – the bytes to be written

Returns

true if RAM has been written to successfully, false otherwise.

Return type

bool

Example One - Print String

examples/qwiic_alphanumeric_ex01_print_string.py

# !/usr/bin/env python
# ----------------------------------------------------------------------
# qwiic_alphanumeric_ex4_print_string.py
#
# This example shows how to use the print() function to illuminate strings
# on the alphanumeric display.
# ----------------------------------------------------------------------
#
# Written by Priyanka Makin @ SparkFun Electronics, September 2021
#
# This python library supports the SparkFun Electronics 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 by buying a board!
#
# ======================================================================
# Copyright (c) 2021 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 4

from __future__ import print_function
import qwiic_alphanumeric
import time
import sys

def run_example():

    print("\nSparkFun Qwiic Alphanumeric - Example 4: Print String")
    my_display = qwiic_alphanumeric.QwiicAlphanumeric()

    if my_display.begin() == False:
        print("\nThe Qwiic Alphanumeric isn't connected to the system. Please check your connection.", \
            file=sys.stderr)
        return
    
    print("\nQwiic Alphanumeric ready!")

    my_display.print("Milk")

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

Example Two - Turn on one Segment

examples/qwiic_alphanumeric_ex02_turn_on_one_segment.py

# !/usr/bin/env python
# ----------------------------------------------------------------------
# qwiic_alphanumeric_ex2_turn_on_one_segment.py
#
# This example tests illuminating individual segments of the display. Pass
# in the segment and digit you wish to illuminate into illuminate_segment().
# ----------------------------------------------------------------------
#
# Written by Priyanka Makin @ SparkFun Electronics, September 2021
#
# This python library supports the SparkFun Electronics 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 by buying a board!
#
# ======================================================================
# Copyright (c) 2021 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_alphanumeric
import time
import sys

def run_example():

    print("\nSparkFun Qwiic Alphanumeric - Example 2: Turn On One Segment")
    my_display = qwiic_alphanumeric.QwiicAlphanumeric()

    if my_display.begin() == False:
        print("\nThe Qwiic Alphanumeric isn't connected to the system. Please check your connection", \
            file=sys.stderr)
        return
    
    print("\nQwiic Alphanumeric ready!")
    
    my_display.illuminate_segment('A', 0)
    my_display.illuminate_segment('L', 1)
    my_display.illuminate_segment('I', 2)
    my_display.illuminate_segment('G', 3)

    my_display.update_display()

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

Example Three - Print Char

examples/qwiic_alphanumeric_ex03_print_char.py

# !/usr/bin/env python
# ----------------------------------------------------------------------
# qwiic_alphanumeric_ex3_print_char.py
#
# This example tests illuminating a whole character on the 14-segment display.
# ----------------------------------------------------------------------
#
# Written by Priyanka Makin @ SparkFun Electronics, September 2021
#
# This python library supports the SparkFun Electronics 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 by buying a board!
#
# ======================================================================
# Copyright (c) 2021 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_alphanumeric
import time
import sys

def run_example():

    print("\nSparkFun Qwiic Alphanumeric - Example 3: Print Char")
    my_display = qwiic_alphanumeric.QwiicAlphanumeric()

    if my_display.begin() == False:
        print("\nThe Qwiic Alphanumeric isn't connected to the system. Please check your connection.", \
            file=sys.stderr)
        return
    
    print("\nQwiic Alphanumeric ready!")
        
    my_display.print_char('W', 0)
    my_display.print_char('H', 1)
    my_display.print_char('A', 2)
    my_display.print_char('T', 3)

    my_display.update_display()
    
    # # Un comment these lines if you want to see all available characters
    # # Print to every digit of a given display
    # for digit_num in range(0, 4):
        # for i in range(ord(' '), ord('~')):
            # if i is not ord(':') or ord('.'):
                # my_display.print_char(chr(i), digit_num)
                # my_display.update_display()
                # time.sleep(1)
                # my_display.clear()

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

Example Four - Set Brightness

examples/qwiic_alphanumeric_ex04_set_brightness.py

# !/usr/bin/env python
# ----------------------------------------------------------------------
# qwiic_alphanumeric_ex5_set_brightness.py
#
# This example sets the brightness of the Qwiic Alphanumeric display.
# ----------------------------------------------------------------------
#
# Written by Priyanka Makin @ SparkFun Electronics, September 2021
#
# This python library supports the SparkFun Electronics 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 by buying a board!
#
# ======================================================================
# Copyright (c) 2021 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 5

from __future__ import print_function
import qwiic_alphanumeric
import time
import sys

def run_example():

    print("\nSparkFun Qwiic Alphanumeric - Example 5: Set Brightness")
    my_display = qwiic_alphanumeric.QwiicAlphanumeric()

    if my_display.begin() == False:
        print("\nThe Qwiic Alphanumeric isn't connected to the system. Please check your wiring.", \
            file=sys.stderr)
        return

    print("\nQwiic Alphanumeric Ready!")
    
    while True:
        for i in range(0, 16):
            # The input to set_brightness() is a duty cycle over 16
            # So, the acceptable inputs to this function are ints between 0 (display off)
            # and 15 (full brightness)
            my_display.set_brightness(i)
            my_display.display_print("Milk")
            time.sleep(1)
    
if __name__ == '__main__':
    try:
        run_example()
    except (KeyboardInterrupt, SystemExit) as exErr:
        print("\nEnding Example 5")
        sys.exit(0)

Example Five - Set Blink Rate

examples/qwiic_alphanumeric_ex05_set_blink_rate.py

# !/usr/bin/env python
# ----------------------------------------------------------------------
# qwiic_alphanumeric_ex6_set_blink_rate.py
#
# This example sets the blink rate of the display.
# ----------------------------------------------------------------------
#
# Written by Priyanka Makin @ SparkFun Electronics, September 2021
#
# This python library supports the SparkFun Electronics 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 by buying a board!
#
# ======================================================================
# Copyright (c) 2021 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 6

from __future__ import print_function
import qwiic_alphanumeric
import time
import sys

def run_example():

    print("\nSparkFun Qwiic Alphanumeric - Example 6: Set Blink Rate")
    my_display = qwiic_alphanumeric.QwiicAlphanumeric()

    if my_display.begin() == False:
        print("\nThe Qwiic Alphanumeric isn't connected to the system. Please check your connection.", \
            file=sys.stderr)
        return
    
    print("\nQwiic Alphanumeric ready!")

    # Blink rate in Hz
    # Acceptable options are defined by the HT16K33 datasheet and are 0.5, 1.0, or 2.0 Hz (float)
    my_display.set_blink_rate(0.5)

    my_display.print("Milk")

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

Example Six - Colon and Decimal

examples/qwiic_alphanumeric_ex06_colon_and_decimal.py

# !/usr/bin/env python
# ----------------------------------------------------------------------
# qwiic_alphanumeric_ex7_colon_and_decimal .py
#
# This example tests the library's response to printing colons or decimal points.
# ----------------------------------------------------------------------
#
# Written by Priyanka Makin @ SparkFun Electronics, September 2021
#
# This python library supports the SparkFun Electronics 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 by buying a board!
#
# ======================================================================
# Copyright (c) 2021 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 7

from __future__ import print_function
import qwiic_alphanumeric
import time
import sys

def run_example():

    print("\nSparkFun Qwiic Alphanumeric - Example 7: Colon and Decimal")
    my_display = qwiic_alphanumeric.QwiicAlphanumeric()

    if my_display.begin() == False:
        print("\nThe Qwiic Alphanumeric isn't connected to the system. Please check your connections.", \
            file=sys.stderr)
        return
    
    print("\nQwiic Alphanumeric ready!")

    # You can print colons and decimals
    # NOTE: they can only go in the character position deterined by the layout of the display
    my_display.print("12:3.4")
    
    # You can also turn decimals and colon on and off manually
    # my_display.decimal_on() # Turn all decimals on  
    # my_display.decimal_off()    # Turn all decimals off
    # my_display.decimal_on_single(1) # Turn decimal on for display one
    # my_display.decimal_off_single(1)    # Turn decimal off for display one
    # my_display.colon_on()  # Turn all colons on
    # my_display.colon_off()  # Turn all the colons off
    # my_display.colon_on_single(1)   # Turn colon on for display one
    # my_display.colon_off_single(1)  # Turn colon off for display one

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

Example Seven - Unknown Character

examples/qwiic_alphanumeric_ex07_unknown_char.py

# !/usr/bin/env python
# ----------------------------------------------------------------------
# qwiic_alphanumeric_ex8_unknown_char.py
#
# This example demonstrates what the library does when the user tries to 
# print an unknown character.
# ----------------------------------------------------------------------
#
# Written by Priyanka Makin @ SparkFun Electronics, September 2021
#
# This python library supports the SparkFun Electronics 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 by buying a board!
#
# ======================================================================
# Copyright (c) 2021 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 8

from __future__ import print_function
import qwiic_alphanumeric
import time
import sys

def run_example():

    print("\nSparkFun Qwiic Alphanumeric - Example 8: Unkown Char")
    my_display = qwiic_alphanumeric.QwiicAlphanumeric()

    if my_display.begin() == False:
        print("\nThe Qwiic Alphanumeric isn't connected to the system. Please check your connection.", \
            file=sys.stderr)
        return
    
    print("\nQwiic Alphanumeric ready!")
    
    # Because '\t' is a character unkown to the library, expect the display
    # to turn on all sefments for that unknown digit/character
    my_display.print("\t\t\t\t")   # Tabs are not printable characters

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

Example Eight - Multiple Displays

examples/qwiic_alphanumeric_ex08_multi_display.py

# !/usr/bin/env python
# ----------------------------------------------------------------------
# qwiic_alphanumeric_ex9_multi_display.py
#
# This example demonstrates how to connect multiple displays to the bus
# to print longer strings.
# ----------------------------------------------------------------------
#
# Written by Priyanka Makin @ SparkFun Electronics, September 2021
#
# This python library supports the SparkFun Electronics 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 by buying a board!
#
# ======================================================================
# Copyright (c) 2021 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_alphanumeric
import time
import sys

def run_example():

    print("\nSparkFun Qwiic Alphanumeric - Example 9: Multi Display")
    my_display = qwiic_alphanumeric.QwiicAlphanumeric()

    if my_display.begin(0x70, 0x71) == False:
        print("\nThe Qwiic Alhanumerics aren't connected to the system. Please check your connection", \
            file=sys.stderr)
        return

    print("\nQwiic Alphanumerics ready!")

    my_display.print("Get Milk")

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

Example Nine - Scrolling String

examples/qwiic_alphanumeric_ex09_scrolling_string.py

# !/usr/bin/env python
# ----------------------------------------------------------------------
# qwiic_alphanumeric_ex10_scrolling_string.py
#
# This example tests the scrolling functionality of the display.
# ----------------------------------------------------------------------
#
# Written by Priyanka Makin @ SparkFun Electronics, September 2021
#
# This python library supports the SparkFun Electronics 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 by buying a board!
#
# ======================================================================
# Copyright (c) 2021 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 10

from __future__ import print_function
import qwiic_alphanumeric
import time
import sys

def run_example():

    print("\nSparkFun Qwiic Alphanumeric - Example 10: Scrolling String")
    my_display = qwiic_alphanumeric.QwiicAlphanumeric()

    if my_display.begin(0x70, 0x71) == False:
        print("\nThe Qwiic Alhanumerics aren't connected to the system. Please check your connection", \
            file=sys.stderr)
        return

    print("\nQwiic Alphanumerics passed begin!")
    
    my_display.print("GET MILK")

    while 1:
        time.sleep(1)
        my_display.shift_left()
        # Alternatively - you could also shift the string to the right
        #my_display.shift_right()

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

Indices and tables

• Index

• Module Index

• Search Page