# Copyright (c) 2016, Xilinx, Inc.
# All rights reserved.
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# 1. Redistributions of source code must retain the above copyright notice,
# this list of conditions and the following disclaimer.
#
# 2. Redistributions in binary form must reproduce the above copyright
# notice, this list of conditions and the following disclaimer in the
# documentation and/or other materials provided with the distribution.
#
# 3. Neither the name of the copyright holder nor the names of its
# contributors may be used to endorse or promote products derived from
# this software without specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
# THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
# PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
# CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
# EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
# PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
# OR BUSINESS INTERRUPTION). HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
# WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
# OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
# ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
from . import Pmod
__author__ = "Graham Schelle, Giuseppe Natale, Yun Rock Qu"
__copyright__ = "Copyright 2016, Xilinx"
__email__ = "pynq_support@xilinx.com"
PMOD_OLED_PROGRAM = "pmod_oled.bin"
CLEAR_DISPLAY = 0x1
PRINT_STRING = 0x3
DRAW_LINE = 0x5
DRAW_RECT = 0x7
[docs]class Pmod_OLED(object):
"""This class controls an OLED Pmod.
The Pmod OLED (PB 200-222) is 128x32 pixel monochrome organic LED (OLED)
panel powered by the Solomon Systech SSD1306.
Attributes
----------
microblaze : Pmod
Microblaze processor instance used by this module.
"""
def __init__(self, mb_info, text=None):
"""Return a new instance of an OLED object.
Parameters
----------
mb_info : dict
A dictionary storing Microblaze information, such as the
IP name and the reset name.
text: str
The text to be displayed after initialization.
"""
self.microblaze = Pmod(mb_info, PMOD_OLED_PROGRAM)
self.clear()
if text:
self.write(text)
[docs] def clear(self):
"""Clear the OLED screen.
This is done by sending the clear command to the IOP.
Returns
-------
None
"""
self.microblaze.write_blocking_command(CLEAR_DISPLAY)
[docs] def write(self, text, x=0, y=0):
"""Write a new text string on the OLED.
Parameters
----------
text : str
The text string to be displayed on the OLED screen.
x : int
The x-position of the display.
y : int
The y-position of the display.
Returns
-------
None
"""
if not 0 <= x <= 255:
raise ValueError("X-position should be in [0, 255]")
if not 0 <= y <= 255:
raise ValueError("Y-position should be in [0, 255]")
if len(text) >= 64:
raise ValueError("Text too long to be displayed.")
# First write length, x, y, then write rest of string
data = [len(text), x, y]
data += [ord(char) for char in text]
self.microblaze.write_mailbox(0, data)
# Finally write the print string command
self.microblaze.write_blocking_command(PRINT_STRING)
[docs] def draw_line(self, x1, y1, x2, y2):
"""Draw a straight line on the OLED.
Parameters
----------
x1 : int
The x-position of the starting point.
y1 : int
The y-position of the starting point.
x2 : int
The x-position of the ending point.
y2 : int
The y-position of the ending point.
Returns
-------
None
"""
if not 0 <= x1 <= 255:
raise ValueError("X-position should be in [0, 255]")
if not 0 <= x2 <= 255:
raise ValueError("X-position should be in [0, 255]")
if not 0 <= y1 <= 255:
raise ValueError("Y-position should be in [0, 255]")
if not 0 <= y2 <= 255:
raise ValueError("Y-position should be in [0, 255]")
self.microblaze.write_mailbox(0, [x1, y1, x2, y2])
self.microblaze.write_blocking_command(DRAW_LINE)
[docs] def draw_rect(self, x1, y1, x2, y2):
"""Draw a rectangle on the OLED.
Parameters
----------
x1 : int
The x-position of the starting point.
y1 : int
The y-position of the starting point.
x2 : int
The x-position of the ending point.
y2 : int
The y-position of the ending point.
Returns
-------
None
"""
if not 0 <= x1 <= 255:
raise ValueError("X-position should be in [0, 255]")
if not 0 <= x2 <= 255:
raise ValueError("X-position should be in [0, 255]")
if not 0 <= y1 <= 255:
raise ValueError("Y-position should be in [0, 255]")
if not 0 <= y2 <= 255:
raise ValueError("Y-position should be in [0, 255]")
self.microblaze.write_mailbox(0, [x1, y1, x2, y2])
self.microblaze.write_blocking_command(DRAW_RECT)