pynq.iop.pmod_oled — Python productivity for Zynq (Pynq) v1.0

# Source code for pynq.iop.pmod_oled

    #   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.

    __author__      = "Graham Schelle, Giuseppe Natale, Yun Rock Qu"
    __copyright__   = "Copyright 2016, Xilinx"
    __email__       = "pynq_support@xilinx.com"

    from pynq import MMIO
    from pynq.iop import request_iop
    from pynq.iop import iop_const
    from pynq.iop import PMODA
    from pynq.iop import PMODB

    PMOD_OLED_PROGRAM = "pmod_oled.bin"

    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
        ----------
        iop : _IOP
            I/O processor instance used by the OLED
        mmio : MMIO
            Memory-mapped I/O instance to read and write instructions and data.

        """

        def __init__(self, if_id, text=None):
            """Return a new instance of an OLED object.

            Parameters
            ----------
            if_id : int
                The interface ID (1, 2) corresponding to (PMODA, PMODB).
            text: str
                The text to be displayed after initialization.

            """
            if not if_id in [PMODA, PMODB]:
                raise ValueError("No such IOP for Pmod device.")

            self.iop = request_iop(if_id, PMOD_OLED_PROGRAM)
            self.mmio = self.iop.mmio

            self.iop.start()
            self.clear()

            if text:
                self.write(text)

        def clear(self):
            """Clear the OLED screen.

            This is done by sending the clear command to the IOP.

            Parameters
            ----------
            None

            Returns
            -------
            None

            """
            # Write the clear command
            self.mmio.write(iop_const.MAILBOX_OFFSET +
                            iop_const.MAILBOX_PY2IOP_CMD_OFFSET, 0x1)

            # Wait for the command to be cleared
            while not (self.mmio.read(iop_const.MAILBOX_OFFSET +
                            iop_const.MAILBOX_PY2IOP_CMD_OFFSET) == 0x0):
                pass

        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
            self.mmio.write(iop_const.MAILBOX_OFFSET, len(text))
            self.mmio.write(iop_const.MAILBOX_OFFSET + 0x4, x)
            self.mmio.write(iop_const.MAILBOX_OFFSET + 0x8, y)

            # Then write rest of string
            for i in range(len(text)):
                self.mmio.write(iop_const.MAILBOX_OFFSET + 0xC + i*4,
                                ord(text[i]))

            # Finally write the print string command
            self.mmio.write(iop_const.MAILBOX_OFFSET +
                            iop_const.MAILBOX_PY2IOP_CMD_OFFSET, 0x3)

            # Wait for the command to be cleared
            while not (self.mmio.read(iop_const.MAILBOX_OFFSET +
                            iop_const.MAILBOX_PY2IOP_CMD_OFFSET) == 0x0):
                pass

        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.mmio.write(iop_const.MAILBOX_OFFSET, x1)
            self.mmio.write(iop_const.MAILBOX_OFFSET + 0x4, y1)
            self.mmio.write(iop_const.MAILBOX_OFFSET + 0x8, x2)
            self.mmio.write(iop_const.MAILBOX_OFFSET + 0xC, y2)

            self.mmio.write(iop_const.MAILBOX_OFFSET +
                            iop_const.MAILBOX_PY2IOP_CMD_OFFSET, 0x5)

            while not (self.mmio.read(iop_const.MAILBOX_OFFSET +
                            iop_const.MAILBOX_PY2IOP_CMD_OFFSET) == 0x0):
                pass

        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.mmio.write(iop_const.MAILBOX_OFFSET, x1)
            self.mmio.write(iop_const.MAILBOX_OFFSET + 0x4, y1)
            self.mmio.write(iop_const.MAILBOX_OFFSET + 0x8, x2)
            self.mmio.write(iop_const.MAILBOX_OFFSET + 0xC, y2)

            self.mmio.write(iop_const.MAILBOX_OFFSET +
                            iop_const.MAILBOX_PY2IOP_CMD_OFFSET, 0x7)

            while not (self.mmio.read(iop_const.MAILBOX_OFFSET +
                            iop_const.MAILBOX_PY2IOP_CMD_OFFSET) == 0x0):
                pass