├── .github ├── ISSUE_TEMPLATE.md └── PULL_REQUEST_TEMPLATE.md ├── .gitignore ├── Adafruit_Nokia_LCD ├── PCD8544.py └── __init__.py ├── LICENSE ├── README.md ├── examples ├── animate.py ├── happycat_lcd.ppm ├── image.py └── shapes.py ├── ez_setup.py ├── setup.py └── test └── test_PCD8544.py /.github/ISSUE_TEMPLATE.md: -------------------------------------------------------------------------------- 1 | Thank you for opening an issue on an Adafruit Python library repository. To 2 | improve the speed of resolution please review the following guidelines and 3 | common troubleshooting steps below before creating the issue: 4 | 5 | - **Do not use GitHub issues for troubleshooting projects and issues.** Instead use 6 | the forums at http://forums.adafruit.com to ask questions and troubleshoot why 7 | something isn't working as expected. In many cases the problem is a common issue 8 | that you will more quickly receive help from the forum community. GitHub issues 9 | are meant for known defects in the code. If you don't know if there is a defect 10 | in the code then start with troubleshooting on the forum first. 11 | 12 | - **If following a tutorial or guide be sure you didn't miss a step.** Carefully 13 | check all of the steps and commands to run have been followed. Consult the 14 | forum if you're unsure or have questions about steps in a guide/tutorial. 15 | 16 | - **For Python/Raspberry Pi projects check these very common issues to ensure they don't apply**: 17 | 18 | - If you are receiving an **ImportError: No module named...** error then a 19 | library the code depends on is not installed. Check the tutorial/guide or 20 | README to ensure you have installed the necessary libraries. Usually the 21 | missing library can be installed with the `pip` tool, but check the tutorial/guide 22 | for the exact command. 23 | 24 | - **Be sure you are supplying adequate power to the board.** Check the specs of 25 | your board and power in an external power supply. In many cases just 26 | plugging a board into your computer is not enough to power it and other 27 | peripherals. 28 | 29 | - **Double check all soldering joints and connections.** Flakey connections 30 | cause many mysterious problems. See the [guide to excellent soldering](https://learn.adafruit.com/adafruit-guide-excellent-soldering/tools) for examples of good solder joints. 31 | 32 | If you're sure this issue is a defect in the code and checked the steps above 33 | please fill in the following fields to provide enough troubleshooting information. 34 | You may delete the guideline and text above to just leave the following details: 35 | 36 | - Platform/operating system (i.e. Raspberry Pi with Raspbian operating system, 37 | Windows 32-bit, Windows 64-bit, Mac OSX 64-bit, etc.): **INSERT PLATFORM/OPERATING 38 | SYSTEM HERE** 39 | 40 | - Python version (run `python -version` or `python3 -version`): **INSERT PYTHON 41 | VERSION HERE** 42 | 43 | - Error message you are receiving, including any Python exception traces: **INSERT 44 | ERROR MESAGE/EXCEPTION TRACES HERE*** 45 | 46 | - List the steps to reproduce the problem below (if possible attach code or commands 47 | to run): **LIST REPRO STEPS BELOW** 48 | -------------------------------------------------------------------------------- /.github/PULL_REQUEST_TEMPLATE.md: -------------------------------------------------------------------------------- 1 | Thank you for creating a pull request to contribute to Adafruit's GitHub code! 2 | Before you open the request please review the following guidelines and tips to 3 | help it be more easily integrated: 4 | 5 | - **Describe the scope of your change--i.e. what the change does and what parts 6 | of the code were modified.** This will help us understand any risks of integrating 7 | the code. 8 | 9 | - **Describe any known limitations with your change.** For example if the change 10 | doesn't apply to a supported platform of the library please mention it. 11 | 12 | - **Please run any tests or examples that can exercise your modified code.** We 13 | strive to not break users of the code and running tests/examples helps with this 14 | process. 15 | 16 | Thank you again for contributing! We will try to test and integrate the change 17 | as soon as we can, but be aware we have many GitHub repositories to manage and 18 | can't immediately respond to every request. There is no need to bump or check in 19 | on a pull request (it will clutter the discussion of the request). 20 | 21 | Also don't be worried if the request is closed or not integrated--sometimes the 22 | priorities of Adafruit's GitHub code (education, ease of use) might not match the 23 | priorities of the pull request. Don't fret, the open source community thrives on 24 | forks and GitHub makes it easy to keep your changes in a forked repo. 25 | 26 | After reviewing the guidelines above you can delete this text from the pull request. 27 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | *.pyc 2 | *.egg-info 3 | 4 | -------------------------------------------------------------------------------- /Adafruit_Nokia_LCD/PCD8544.py: -------------------------------------------------------------------------------- 1 | # Copyright (c) 2014 Adafruit Industries 2 | # Author: Tony DiCola 3 | # 4 | # Permission is hereby granted, free of charge, to any person obtaining a copy 5 | # of this software and associated documentation files (the "Software"), to deal 6 | # in the Software without restriction, including without limitation the rights 7 | # to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 8 | # copies of the Software, and to permit persons to whom the Software is 9 | # furnished to do so, subject to the following conditions: 10 | # 11 | # The above copyright notice and this permission notice shall be included in 12 | # all copies or substantial portions of the Software. 13 | # 14 | # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 15 | # IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 16 | # FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 17 | # AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 18 | # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 19 | # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN 20 | # THE SOFTWARE. 21 | 22 | import time 23 | 24 | import Adafruit_GPIO as GPIO 25 | import Adafruit_GPIO.SPI as SPI 26 | 27 | 28 | LCDWIDTH = 84 29 | LCDHEIGHT = 48 30 | ROWPIXELS = LCDHEIGHT//6 31 | PCD8544_POWERDOWN = 0x04 32 | PCD8544_ENTRYMODE = 0x02 33 | PCD8544_EXTENDEDINSTRUCTION = 0x01 34 | PCD8544_DISPLAYBLANK = 0x0 35 | PCD8544_DISPLAYNORMAL = 0x4 36 | PCD8544_DISPLAYALLON = 0x1 37 | PCD8544_DISPLAYINVERTED = 0x5 38 | PCD8544_FUNCTIONSET = 0x20 39 | PCD8544_DISPLAYCONTROL = 0x08 40 | PCD8544_SETYADDR = 0x40 41 | PCD8544_SETXADDR = 0x80 42 | PCD8544_SETTEMP = 0x04 43 | PCD8544_SETBIAS = 0x10 44 | PCD8544_SETVOP = 0x80 45 | 46 | 47 | class PCD8544(object): 48 | """Nokia 5110/3310 PCD8544-based LCD display.""" 49 | 50 | def __init__(self, dc, rst, sclk=None, din=None, cs=None, gpio=None, spi=None): 51 | self._sclk = sclk 52 | self._din = din 53 | self._dc = dc 54 | self._cs = cs 55 | self._rst = rst 56 | self._gpio = gpio 57 | self._spi = spi 58 | # Default to detecting platform GPIO. 59 | if self._gpio is None: 60 | self._gpio = GPIO.get_platform_gpio() 61 | if self._rst is not None: 62 | self._gpio.setup(self._rst, GPIO.OUT) 63 | # Default to bit bang SPI. 64 | if self._spi is None: 65 | self._spi = SPI.BitBang(self._gpio, self._sclk, self._din, None, self._cs) 66 | # Set pin outputs. 67 | self._gpio.setup(self._dc, GPIO.OUT) 68 | # Initialize buffer to Adafruit logo. 69 | self._buffer = [0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0xC0, 0xE0, 0xF0, 0xF8, 0xFC, 0xFC, 0xFE, 0xFF, 0xFC, 0xE0, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0xF8, 0xF8, 0xF8, 0xF8, 0xF8, 0xF8, 0xF8, 0xF8, 0xF8, 0xF8, 0xF8, 0xF8, 0xF0, 0xF0, 0xE0, 0xE0, 0xC0, 0x80, 0xC0, 0xFC, 0xFF, 0xFF, 0xFF, 0xFF, 0x7F, 0x3F, 0x7F, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x0F, 0x1F, 0x3F, 0x7F, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xE7, 0xC7, 0xC7, 0x87, 0x8F, 0x9F, 0x9F, 0xFF, 0xFF, 0xFF, 0xC1, 0xC0, 0xE0, 0xFC, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFC, 0xFC, 0xFC, 0xFC, 0xFE, 0xFE, 0xFE, 0xFC, 0xFC, 0xF8, 0xF8, 0xF0, 0xE0, 0xC0, 0xC0, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x80, 0xC0, 0xE0, 0xF1, 0xFB, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0x7F, 0x1F, 0x0F, 0x0F, 0x87, 0xE7, 0xFF, 0xFF, 0xFF, 0x1F, 0x1F, 0x3F, 0xF9, 0xF8, 0xF8, 0xF8, 0xF8, 0xF8, 0xF8, 0xFD, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0x7F, 0x3F, 0x0F, 0x07, 0x01, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0xF0, 0xFE, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFE, 0x7E, 0x3F, 0x3F, 0x0F, 0x1F, 0xFF, 0xFF, 0xFF, 0xFC, 0xF0, 0xE0, 0xF1, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFC, 0xF0, 0x01, 0x01, 0x01, 0x01, 0x01, 0x01, 0x01, 0x01, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x03, 0x03, 0x03, 0x03, 0x03, 0x03, 0x03, 0x03, 0x01, 0x01, 0x01, 0x01, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x03, 0x0F, 0x1F, 0x3F, 0x7F, 0x7F, 0xFF, 0xFF, 0xFF, 0xFF, 0x7F, 0x7F, 0x1F, 0x03, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00 ] 70 | 71 | def command(self, c): 72 | """Send command byte to display.""" 73 | # DC pin low signals command byte. 74 | self._gpio.set_low(self._dc) 75 | self._spi.write([c]) 76 | 77 | def extended_command(self, c): 78 | """Send a command in extended mode""" 79 | # Set extended command mode 80 | self.command(PCD8544_FUNCTIONSET | PCD8544_EXTENDEDINSTRUCTION) 81 | self.command(c) 82 | # Set normal display mode. 83 | self.command(PCD8544_FUNCTIONSET) 84 | self.command(PCD8544_DISPLAYCONTROL | PCD8544_DISPLAYNORMAL) 85 | 86 | def data(self, c): 87 | """Send byte of data to display.""" 88 | # DC pin high signals data byte. 89 | self._gpio.set_high(self._dc) 90 | self._spi.write([c]) 91 | 92 | def begin(self, contrast=40, bias=4): 93 | """Initialize display.""" 94 | self.reset() 95 | # Set LCD bias. 96 | self.set_bias(bias) 97 | self.set_contrast(contrast) 98 | 99 | def reset(self): 100 | """Reset the display""" 101 | if self._rst is not None: 102 | # Toggle RST low to reset. 103 | self._gpio.set_low(self._rst) 104 | time.sleep(0.1) 105 | self._gpio.set_high(self._rst) 106 | 107 | def display(self): 108 | """Write display buffer to physical display.""" 109 | # TODO: Consider support for partial updates like Arduino library. 110 | # Reset to position zero. 111 | self.command(PCD8544_SETYADDR) 112 | self.command(PCD8544_SETXADDR) 113 | # Write the buffer. 114 | self._gpio.set_high(self._dc) 115 | self._spi.write(self._buffer) 116 | 117 | def image(self, image): 118 | """Set buffer to value of Python Imaging Library image. The image should 119 | be in 1 bit mode and have a size of 84x48 pixels.""" 120 | if image.mode != '1': 121 | raise ValueError('Image must be in mode 1.') 122 | index = 0 123 | # Iterate through the 6 y axis rows. 124 | # Grab all the pixels from the image, faster than getpixel. 125 | pix = image.load() 126 | for row in range(6): 127 | # Iterate through all 83 x axis columns. 128 | for x in range(84): 129 | # Set the bits for the column of pixels at the current position. 130 | bits = 0 131 | # Don't use range here as it's a bit slow 132 | for bit in [0, 1, 2, 3, 4, 5, 6, 7]: 133 | bits = bits << 1 134 | bits |= 1 if pix[(x, row*ROWPIXELS+7-bit)] == 0 else 0 135 | # Update buffer byte and increment to next byte. 136 | self._buffer[index] = bits 137 | index += 1 138 | 139 | def clear(self): 140 | """Clear contents of image buffer.""" 141 | self._buffer = [0] * (LCDWIDTH * LCDHEIGHT // 8) 142 | 143 | def set_contrast(self, contrast): 144 | """Set contrast to specified value (should be 0-127).""" 145 | contrast = max(0, min(contrast, 0x7f)) # Clamp to values 0-0x7f 146 | self.extended_command(PCD8544_SETVOP | contrast) 147 | 148 | def set_bias(self, bias): 149 | """Set bias""" 150 | self.extended_command(PCD8544_SETBIAS | bias) 151 | -------------------------------------------------------------------------------- /Adafruit_Nokia_LCD/__init__.py: -------------------------------------------------------------------------------- 1 | from Adafruit_Nokia_LCD.PCD8544 import * 2 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | The MIT License (MIT) 2 | 3 | Copyright (c) 2014 Adafruit Industries 4 | 5 | Permission is hereby granted, free of charge, to any person obtaining a copy 6 | of this software and associated documentation files (the "Software"), to deal 7 | in the Software without restriction, including without limitation the rights 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 9 | copies of the Software, and to permit persons to whom the Software is 10 | furnished to do so, subject to the following conditions: 11 | 12 | The above copyright notice and this permission notice shall be included in all 13 | copies or substantial portions of the Software. 14 | 15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 21 | SOFTWARE. -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | This library has been archived and replaced by a new library: 2 | 3 | https://github.com/adafruit/Adafruit_CircuitPython_PCD8544 4 | 5 | This library is no longer supported. Please use the new library. 6 | -------------------------------------------------------------------------------- /examples/animate.py: -------------------------------------------------------------------------------- 1 | # Copyright (c) 2014 Adafruit Industries 2 | # Author: Tony DiCola 3 | # 4 | # Permission is hereby granted, free of charge, to any person obtaining a copy 5 | # of this software and associated documentation files (the "Software"), to deal 6 | # in the Software without restriction, including without limitation the rights 7 | # to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 8 | # copies of the Software, and to permit persons to whom the Software is 9 | # furnished to do so, subject to the following conditions: 10 | # 11 | # The above copyright notice and this permission notice shall be included in 12 | # all copies or substantial portions of the Software. 13 | # 14 | # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 15 | # IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 16 | # FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 17 | # AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 18 | # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 19 | # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN 20 | # THE SOFTWARE. 21 | 22 | import math 23 | import time 24 | 25 | import Adafruit_Nokia_LCD as LCD 26 | import Adafruit_GPIO.SPI as SPI 27 | 28 | from PIL import Image 29 | from PIL import ImageFont 30 | from PIL import ImageDraw 31 | 32 | 33 | # Raspberry Pi hardware SPI config: 34 | DC = 23 35 | RST = 24 36 | SPI_PORT = 0 37 | SPI_DEVICE = 0 38 | 39 | # Beaglebone Black hardware SPI config: 40 | # DC = 'P9_15' 41 | # RST = 'P9_12' 42 | # SPI_PORT = 1 43 | # SPI_DEVICE = 0 44 | 45 | # Hardware SPI usage: 46 | disp = LCD.PCD8544(DC, RST, spi=SPI.SpiDev(SPI_PORT, SPI_DEVICE, max_speed_hz=4000000)) 47 | 48 | # Initialize library. 49 | disp.begin(contrast=60) 50 | 51 | # Clear display. 52 | disp.clear() 53 | disp.display() 54 | 55 | # Create image buffer. 56 | # Make sure to create image with mode '1' for 1-bit color. 57 | image = Image.new('1', (LCD.LCDWIDTH, LCD.LCDHEIGHT)) 58 | 59 | # Load default font. 60 | font = ImageFont.load_default() 61 | 62 | # Alternatively load a TTF font. 63 | # Some nice fonts to try: http://www.dafont.com/bitmap.php 64 | # font = ImageFont.truetype('Minecraftia.ttf', 8) 65 | 66 | # Create drawing object. 67 | draw = ImageDraw.Draw(image) 68 | 69 | # Define text and get total width. 70 | text = 'NOKIA 5110: NOT JUST FOR SNAKE ANYMORE. THIS IS AN OLD SCHOOL DEMO SCROLLER!! GREETZ TO: LADYADA & THE ADAFRUIT CREW, TRIXTER, FUTURE CREW, AND FARBRAUSCH' 71 | maxwidth, height = draw.textsize(text, font=font) 72 | 73 | # Set starting position. 74 | startpos = 83 75 | pos = startpos 76 | 77 | # Animate text moving in sine wave. 78 | print('Press Ctrl-C to quit.') 79 | while True: 80 | # Clear image buffer. 81 | draw.rectangle((0,0,83,47), outline=255, fill=255) 82 | # Enumerate characters and draw them offset vertically based on a sine wave. 83 | x = pos 84 | for i, c in enumerate(text): 85 | # Stop drawing if off the right side of screen. 86 | if x > 83: 87 | break 88 | # Calculate width but skip drawing if off the left side of screen. 89 | if x < -10: 90 | width, height = draw.textsize(c, font=font) 91 | x += width 92 | continue 93 | # Calculate offset from sine wave. 94 | y = (24-8)+math.floor(10.0*math.sin(x/83.0*2.0*math.pi)) 95 | # Draw text. 96 | draw.text((x, y), c, font=font, fill=0) 97 | # Increment x position based on chacacter width. 98 | width, height = draw.textsize(c, font=font) 99 | x += width 100 | # Draw the image buffer. 101 | disp.image(image) 102 | disp.display() 103 | # Move position for next frame. 104 | pos -= 2 105 | # Start over if text has scrolled completely off left side of screen. 106 | if pos < -maxwidth: 107 | pos = startpos 108 | # Pause briefly before drawing next frame. 109 | time.sleep(0.1) 110 | -------------------------------------------------------------------------------- /examples/happycat_lcd.ppm: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/adafruit/Adafruit_Nokia_LCD/e61b16335bdd929ae64c9fc038b2d002091ea000/examples/happycat_lcd.ppm -------------------------------------------------------------------------------- /examples/image.py: -------------------------------------------------------------------------------- 1 | # Copyright (c) 2014 Adafruit Industries 2 | # Author: Tony DiCola 3 | # 4 | # Permission is hereby granted, free of charge, to any person obtaining a copy 5 | # of this software and associated documentation files (the "Software"), to deal 6 | # in the Software without restriction, including without limitation the rights 7 | # to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 8 | # copies of the Software, and to permit persons to whom the Software is 9 | # furnished to do so, subject to the following conditions: 10 | # 11 | # The above copyright notice and this permission notice shall be included in 12 | # all copies or substantial portions of the Software. 13 | # 14 | # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 15 | # IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 16 | # FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 17 | # AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 18 | # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 19 | # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN 20 | # THE SOFTWARE. 21 | 22 | import time 23 | 24 | import Adafruit_Nokia_LCD as LCD 25 | import Adafruit_GPIO.SPI as SPI 26 | 27 | from PIL import Image 28 | 29 | 30 | # Raspberry Pi hardware SPI config: 31 | DC = 23 32 | RST = 24 33 | SPI_PORT = 0 34 | SPI_DEVICE = 0 35 | 36 | # Raspberry Pi software SPI config: 37 | # SCLK = 4 38 | # DIN = 17 39 | # DC = 23 40 | # RST = 24 41 | # CS = 8 42 | 43 | # Beaglebone Black hardware SPI config: 44 | # DC = 'P9_15' 45 | # RST = 'P9_12' 46 | # SPI_PORT = 1 47 | # SPI_DEVICE = 0 48 | 49 | # Beaglebone Black software SPI config: 50 | # DC = 'P9_15' 51 | # RST = 'P9_12' 52 | # SCLK = 'P8_7' 53 | # DIN = 'P8_9' 54 | # CS = 'P8_11' 55 | 56 | 57 | # Hardware SPI usage: 58 | disp = LCD.PCD8544(DC, RST, spi=SPI.SpiDev(SPI_PORT, SPI_DEVICE, max_speed_hz=4000000)) 59 | 60 | # Software SPI usage (defaults to bit-bang SPI interface): 61 | #disp = LCD.PCD8544(DC, RST, SCLK, DIN, CS) 62 | 63 | # Initialize library. 64 | disp.begin(contrast=60) 65 | 66 | # Clear display. 67 | disp.clear() 68 | disp.display() 69 | 70 | # Load image and convert to 1 bit color. 71 | image = Image.open('happycat_lcd.ppm').convert('1') 72 | 73 | # Alternatively load a different format image, resize it, and convert to 1 bit color. 74 | #image = Image.open('happycat.png').resize((LCD.LCDWIDTH, LCD.LCDHEIGHT), Image.ANTIALIAS).convert('1') 75 | 76 | # Display image. 77 | disp.image(image) 78 | disp.display() 79 | 80 | print('Press Ctrl-C to quit.') 81 | while True: 82 | time.sleep(1.0) 83 | -------------------------------------------------------------------------------- /examples/shapes.py: -------------------------------------------------------------------------------- 1 | # Copyright (c) 2014 Adafruit Industries 2 | # Author: Tony DiCola 3 | # 4 | # Permission is hereby granted, free of charge, to any person obtaining a copy 5 | # of this software and associated documentation files (the "Software"), to deal 6 | # in the Software without restriction, including without limitation the rights 7 | # to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 8 | # copies of the Software, and to permit persons to whom the Software is 9 | # furnished to do so, subject to the following conditions: 10 | # 11 | # The above copyright notice and this permission notice shall be included in 12 | # all copies or substantial portions of the Software. 13 | # 14 | # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 15 | # IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 16 | # FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 17 | # AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 18 | # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 19 | # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN 20 | # THE SOFTWARE. 21 | 22 | import time 23 | 24 | import Adafruit_Nokia_LCD as LCD 25 | import Adafruit_GPIO.SPI as SPI 26 | 27 | from PIL import Image 28 | from PIL import ImageDraw 29 | from PIL import ImageFont 30 | 31 | 32 | # Raspberry Pi hardware SPI config: 33 | DC = 23 34 | RST = 24 35 | SPI_PORT = 0 36 | SPI_DEVICE = 0 37 | 38 | # Raspberry Pi software SPI config: 39 | # SCLK = 4 40 | # DIN = 17 41 | # DC = 23 42 | # RST = 24 43 | # CS = 8 44 | 45 | # Beaglebone Black hardware SPI config: 46 | # DC = 'P9_15' 47 | # RST = 'P9_12' 48 | # SPI_PORT = 1 49 | # SPI_DEVICE = 0 50 | 51 | # Beaglebone Black software SPI config: 52 | # DC = 'P9_15' 53 | # RST = 'P9_12' 54 | # SCLK = 'P8_7' 55 | # DIN = 'P8_9' 56 | # CS = 'P8_11' 57 | 58 | 59 | # Hardware SPI usage: 60 | disp = LCD.PCD8544(DC, RST, spi=SPI.SpiDev(SPI_PORT, SPI_DEVICE, max_speed_hz=4000000)) 61 | 62 | # Software SPI usage (defaults to bit-bang SPI interface): 63 | #disp = LCD.PCD8544(DC, RST, SCLK, DIN, CS) 64 | 65 | # Initialize library. 66 | disp.begin(contrast=60) 67 | 68 | # Clear display. 69 | disp.clear() 70 | disp.display() 71 | 72 | # Create blank image for drawing. 73 | # Make sure to create image with mode '1' for 1-bit color. 74 | image = Image.new('1', (LCD.LCDWIDTH, LCD.LCDHEIGHT)) 75 | 76 | # Get drawing object to draw on image. 77 | draw = ImageDraw.Draw(image) 78 | 79 | # Draw a white filled box to clear the image. 80 | draw.rectangle((0,0,LCD.LCDWIDTH,LCD.LCDHEIGHT), outline=255, fill=255) 81 | 82 | # Draw some shapes. 83 | draw.ellipse((2,2,22,22), outline=0, fill=255) 84 | draw.rectangle((24,2,44,22), outline=0, fill=255) 85 | draw.polygon([(46,22), (56,2), (66,22)], outline=0, fill=255) 86 | draw.line((68,22,81,2), fill=0) 87 | draw.line((68,2,81,22), fill=0) 88 | 89 | # Load default font. 90 | font = ImageFont.load_default() 91 | 92 | # Alternatively load a TTF font. 93 | # Some nice fonts to try: http://www.dafont.com/bitmap.php 94 | # font = ImageFont.truetype('Minecraftia.ttf', 8) 95 | 96 | # Write some text. 97 | draw.text((8,30), 'Hello World!', font=font) 98 | 99 | # Display image. 100 | disp.image(image) 101 | disp.display() 102 | 103 | print('Press Ctrl-C to quit.') 104 | while True: 105 | time.sleep(1.0) 106 | -------------------------------------------------------------------------------- /ez_setup.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python 2 | """Bootstrap setuptools installation 3 | 4 | To use setuptools in your package's setup.py, include this 5 | file in the same directory and add this to the top of your setup.py:: 6 | 7 | from ez_setup import use_setuptools 8 | use_setuptools() 9 | 10 | To require a specific version of setuptools, set a download 11 | mirror, or use an alternate download directory, simply supply 12 | the appropriate options to ``use_setuptools()``. 13 | 14 | This file can also be run as a script to install or upgrade setuptools. 15 | """ 16 | import os 17 | import shutil 18 | import sys 19 | import tempfile 20 | import zipfile 21 | import optparse 22 | import subprocess 23 | import platform 24 | import textwrap 25 | import contextlib 26 | 27 | from distutils import log 28 | 29 | try: 30 | from site import USER_SITE 31 | except ImportError: 32 | USER_SITE = None 33 | 34 | DEFAULT_VERSION = "3.5.1" 35 | DEFAULT_URL = "https://pypi.python.org/packages/source/s/setuptools/" 36 | 37 | def _python_cmd(*args): 38 | """ 39 | Return True if the command succeeded. 40 | """ 41 | args = (sys.executable,) + args 42 | return subprocess.call(args) == 0 43 | 44 | 45 | def _install(archive_filename, install_args=()): 46 | with archive_context(archive_filename): 47 | # installing 48 | log.warn('Installing Setuptools') 49 | if not _python_cmd('setup.py', 'install', *install_args): 50 | log.warn('Something went wrong during the installation.') 51 | log.warn('See the error message above.') 52 | # exitcode will be 2 53 | return 2 54 | 55 | 56 | def _build_egg(egg, archive_filename, to_dir): 57 | with archive_context(archive_filename): 58 | # building an egg 59 | log.warn('Building a Setuptools egg in %s', to_dir) 60 | _python_cmd('setup.py', '-q', 'bdist_egg', '--dist-dir', to_dir) 61 | # returning the result 62 | log.warn(egg) 63 | if not os.path.exists(egg): 64 | raise IOError('Could not build the egg.') 65 | 66 | 67 | def get_zip_class(): 68 | """ 69 | Supplement ZipFile class to support context manager for Python 2.6 70 | """ 71 | class ContextualZipFile(zipfile.ZipFile): 72 | def __enter__(self): 73 | return self 74 | def __exit__(self, type, value, traceback): 75 | self.close 76 | return zipfile.ZipFile if hasattr(zipfile.ZipFile, '__exit__') else \ 77 | ContextualZipFile 78 | 79 | 80 | @contextlib.contextmanager 81 | def archive_context(filename): 82 | # extracting the archive 83 | tmpdir = tempfile.mkdtemp() 84 | log.warn('Extracting in %s', tmpdir) 85 | old_wd = os.getcwd() 86 | try: 87 | os.chdir(tmpdir) 88 | with get_zip_class()(filename) as archive: 89 | archive.extractall() 90 | 91 | # going in the directory 92 | subdir = os.path.join(tmpdir, os.listdir(tmpdir)[0]) 93 | os.chdir(subdir) 94 | log.warn('Now working in %s', subdir) 95 | yield 96 | 97 | finally: 98 | os.chdir(old_wd) 99 | shutil.rmtree(tmpdir) 100 | 101 | 102 | def _do_download(version, download_base, to_dir, download_delay): 103 | egg = os.path.join(to_dir, 'setuptools-%s-py%d.%d.egg' 104 | % (version, sys.version_info[0], sys.version_info[1])) 105 | if not os.path.exists(egg): 106 | archive = download_setuptools(version, download_base, 107 | to_dir, download_delay) 108 | _build_egg(egg, archive, to_dir) 109 | sys.path.insert(0, egg) 110 | 111 | # Remove previously-imported pkg_resources if present (see 112 | # https://bitbucket.org/pypa/setuptools/pull-request/7/ for details). 113 | if 'pkg_resources' in sys.modules: 114 | del sys.modules['pkg_resources'] 115 | 116 | import setuptools 117 | setuptools.bootstrap_install_from = egg 118 | 119 | 120 | def use_setuptools(version=DEFAULT_VERSION, download_base=DEFAULT_URL, 121 | to_dir=os.curdir, download_delay=15): 122 | to_dir = os.path.abspath(to_dir) 123 | rep_modules = 'pkg_resources', 'setuptools' 124 | imported = set(sys.modules).intersection(rep_modules) 125 | try: 126 | import pkg_resources 127 | except ImportError: 128 | return _do_download(version, download_base, to_dir, download_delay) 129 | try: 130 | pkg_resources.require("setuptools>=" + version) 131 | return 132 | except pkg_resources.DistributionNotFound: 133 | return _do_download(version, download_base, to_dir, download_delay) 134 | except pkg_resources.VersionConflict as VC_err: 135 | if imported: 136 | msg = textwrap.dedent(""" 137 | The required version of setuptools (>={version}) is not available, 138 | and can't be installed while this script is running. Please 139 | install a more recent version first, using 140 | 'easy_install -U setuptools'. 141 | 142 | (Currently using {VC_err.args[0]!r}) 143 | """).format(VC_err=VC_err, version=version) 144 | sys.stderr.write(msg) 145 | sys.exit(2) 146 | 147 | # otherwise, reload ok 148 | del pkg_resources, sys.modules['pkg_resources'] 149 | return _do_download(version, download_base, to_dir, download_delay) 150 | 151 | def _clean_check(cmd, target): 152 | """ 153 | Run the command to download target. If the command fails, clean up before 154 | re-raising the error. 155 | """ 156 | try: 157 | subprocess.check_call(cmd) 158 | except subprocess.CalledProcessError: 159 | if os.access(target, os.F_OK): 160 | os.unlink(target) 161 | raise 162 | 163 | def download_file_powershell(url, target): 164 | """ 165 | Download the file at url to target using Powershell (which will validate 166 | trust). Raise an exception if the command cannot complete. 167 | """ 168 | target = os.path.abspath(target) 169 | cmd = [ 170 | 'powershell', 171 | '-Command', 172 | "(new-object System.Net.WebClient).DownloadFile(%(url)r, %(target)r)" % vars(), 173 | ] 174 | _clean_check(cmd, target) 175 | 176 | def has_powershell(): 177 | if platform.system() != 'Windows': 178 | return False 179 | cmd = ['powershell', '-Command', 'echo test'] 180 | devnull = open(os.path.devnull, 'wb') 181 | try: 182 | try: 183 | subprocess.check_call(cmd, stdout=devnull, stderr=devnull) 184 | except Exception: 185 | return False 186 | finally: 187 | devnull.close() 188 | return True 189 | 190 | download_file_powershell.viable = has_powershell 191 | 192 | def download_file_curl(url, target): 193 | cmd = ['curl', url, '--silent', '--output', target] 194 | _clean_check(cmd, target) 195 | 196 | def has_curl(): 197 | cmd = ['curl', '--version'] 198 | devnull = open(os.path.devnull, 'wb') 199 | try: 200 | try: 201 | subprocess.check_call(cmd, stdout=devnull, stderr=devnull) 202 | except Exception: 203 | return False 204 | finally: 205 | devnull.close() 206 | return True 207 | 208 | download_file_curl.viable = has_curl 209 | 210 | def download_file_wget(url, target): 211 | cmd = ['wget', url, '--quiet', '--output-document', target] 212 | _clean_check(cmd, target) 213 | 214 | def has_wget(): 215 | cmd = ['wget', '--version'] 216 | devnull = open(os.path.devnull, 'wb') 217 | try: 218 | try: 219 | subprocess.check_call(cmd, stdout=devnull, stderr=devnull) 220 | except Exception: 221 | return False 222 | finally: 223 | devnull.close() 224 | return True 225 | 226 | download_file_wget.viable = has_wget 227 | 228 | def download_file_insecure(url, target): 229 | """ 230 | Use Python to download the file, even though it cannot authenticate the 231 | connection. 232 | """ 233 | try: 234 | from urllib.request import urlopen 235 | except ImportError: 236 | from urllib2 import urlopen 237 | src = dst = None 238 | try: 239 | src = urlopen(url) 240 | # Read/write all in one block, so we don't create a corrupt file 241 | # if the download is interrupted. 242 | data = src.read() 243 | dst = open(target, "wb") 244 | dst.write(data) 245 | finally: 246 | if src: 247 | src.close() 248 | if dst: 249 | dst.close() 250 | 251 | download_file_insecure.viable = lambda: True 252 | 253 | def get_best_downloader(): 254 | downloaders = [ 255 | download_file_powershell, 256 | download_file_curl, 257 | download_file_wget, 258 | download_file_insecure, 259 | ] 260 | 261 | for dl in downloaders: 262 | if dl.viable(): 263 | return dl 264 | 265 | def download_setuptools(version=DEFAULT_VERSION, download_base=DEFAULT_URL, 266 | to_dir=os.curdir, delay=15, downloader_factory=get_best_downloader): 267 | """ 268 | Download setuptools from a specified location and return its filename 269 | 270 | `version` should be a valid setuptools version number that is available 271 | as an egg for download under the `download_base` URL (which should end 272 | with a '/'). `to_dir` is the directory where the egg will be downloaded. 273 | `delay` is the number of seconds to pause before an actual download 274 | attempt. 275 | 276 | ``downloader_factory`` should be a function taking no arguments and 277 | returning a function for downloading a URL to a target. 278 | """ 279 | # making sure we use the absolute path 280 | to_dir = os.path.abspath(to_dir) 281 | zip_name = "setuptools-%s.zip" % version 282 | url = download_base + zip_name 283 | saveto = os.path.join(to_dir, zip_name) 284 | if not os.path.exists(saveto): # Avoid repeated downloads 285 | log.warn("Downloading %s", url) 286 | downloader = downloader_factory() 287 | downloader(url, saveto) 288 | return os.path.realpath(saveto) 289 | 290 | def _build_install_args(options): 291 | """ 292 | Build the arguments to 'python setup.py install' on the setuptools package 293 | """ 294 | return ['--user'] if options.user_install else [] 295 | 296 | def _parse_args(): 297 | """ 298 | Parse the command line for options 299 | """ 300 | parser = optparse.OptionParser() 301 | parser.add_option( 302 | '--user', dest='user_install', action='store_true', default=False, 303 | help='install in user site package (requires Python 2.6 or later)') 304 | parser.add_option( 305 | '--download-base', dest='download_base', metavar="URL", 306 | default=DEFAULT_URL, 307 | help='alternative URL from where to download the setuptools package') 308 | parser.add_option( 309 | '--insecure', dest='downloader_factory', action='store_const', 310 | const=lambda: download_file_insecure, default=get_best_downloader, 311 | help='Use internal, non-validating downloader' 312 | ) 313 | parser.add_option( 314 | '--version', help="Specify which version to download", 315 | default=DEFAULT_VERSION, 316 | ) 317 | options, args = parser.parse_args() 318 | # positional arguments are ignored 319 | return options 320 | 321 | def main(): 322 | """Install or upgrade setuptools and EasyInstall""" 323 | options = _parse_args() 324 | archive = download_setuptools( 325 | version=options.version, 326 | download_base=options.download_base, 327 | downloader_factory=options.downloader_factory, 328 | ) 329 | return _install(archive, _build_install_args(options)) 330 | 331 | if __name__ == '__main__': 332 | sys.exit(main()) 333 | -------------------------------------------------------------------------------- /setup.py: -------------------------------------------------------------------------------- 1 | try: 2 | # Try using ez_setup to install setuptools if not already installed. 3 | from ez_setup import use_setuptools 4 | use_setuptools() 5 | except ImportError: 6 | # Ignore import error and assume Python 3 which already has setuptools. 7 | pass 8 | 9 | from setuptools import setup, find_packages 10 | 11 | setup(name = 'Adafruit_Nokia_LCD', 12 | version = '0.2.0', 13 | author = 'Tony DiCola', 14 | author_email = 'tdicola@adafruit.com', 15 | description = 'Library to display images on the Nokia 5110/3110 LCD.', 16 | license = 'MIT', 17 | url = 'https://github.com/adafruit/Adafruit_Nokia_LCD/', 18 | dependency_links = ['https://github.com/adafruit/Adafruit_Python_GPIO/tarball/master#egg=Adafruit-GPIO-0.1.0'], 19 | install_requires = ['Adafruit-GPIO>=0.1.0'], 20 | packages = find_packages()) 21 | -------------------------------------------------------------------------------- /test/test_PCD8544.py: -------------------------------------------------------------------------------- 1 | # Copyright (c) 2014 Adafruit Industries 2 | # Author: Tony DiCola 3 | # 4 | # Permission is hereby granted, free of charge, to any person obtaining a copy 5 | # of this software and associated documentation files (the "Software"), to deal 6 | # in the Software without restriction, including without limitation the rights 7 | # to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 8 | # copies of the Software, and to permit persons to whom the Software is 9 | # furnished to do so, subject to the following conditions: 10 | # 11 | # The above copyright notice and this permission notice shall be included in 12 | # all copies or substantial portions of the Software. 13 | # 14 | # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 15 | # IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 16 | # FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 17 | # AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 18 | # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 19 | # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN 20 | # THE SOFTWARE. 21 | 22 | import unittest 23 | 24 | from mock import Mock, call 25 | 26 | import Adafruit_GPIO.SPI as SPI 27 | import Adafruit_Nokia_LCD as LCD 28 | 29 | 30 | class TestPCD8544(unittest.TestCase): 31 | def test_command_sets_dc_low(self): 32 | gpio = Mock() 33 | spi = Mock() 34 | lcd = LCD.PCD8544(1, 2, gpio=gpio, spi=spi) 35 | lcd.command(0xDE) 36 | gpio.set_low.assert_called_with(1) 37 | spi.write.assert_called_with([0xDE]) 38 | 39 | def test_data_sets_dc_high(self): 40 | gpio = Mock() 41 | spi = Mock() 42 | lcd = LCD.PCD8544(1, 2, gpio=gpio, spi=spi) 43 | lcd.data(0xDE) 44 | gpio.set_high.assert_called_with(1) 45 | spi.write.assert_called_with([0xDE]) 46 | 47 | def test_default_to_bitbang_spi(self): 48 | gpio = Mock() 49 | lcd = LCD.PCD8544(1, 2, 3, 4, 5, gpio=gpio) 50 | lcd.begin() 51 | self.assertIsInstance(lcd._spi, SPI.BitBang) 52 | 53 | def test_begin_initializes_lcd(self): 54 | gpio = Mock() 55 | spi = Mock() 56 | lcd = LCD.PCD8544(1, 2, gpio=gpio, spi=spi) 57 | lcd.begin(40) 58 | # Verify RST is set low then high. 59 | gpio.assert_has_calls([call.set_low(2), call.set_high(2)]) 60 | # Verify SPI calls. 61 | spi.assert_has_calls([call.write([0x21]), 62 | call.write([0x14]), 63 | call.write([0xA8]), 64 | call.write([0x20]), 65 | call.write([0x0c])]) 66 | --------------------------------------------------------------------------------