library updated for compatability with RGB backlight LCDs!

brentru · brentru · commit 058c626f8579 · 2017-08-17T16:50:57.000-04:00
diff --git a/adafruit_character_lcd_RGB.mpy b/adafruit_character_lcd_RGB.mpy
diff --git a/example code/rgb_hello_CircuitPython b/example code/rgb_hello_CircuitPython
@@ -0,0 +1,38 @@
+import time, math, digitalio
+import adafruit_character_lcd_RGB as LCD
+import pulseio
+from board import *
+
+#   Character LCD Config:
+#   modify this if you have a different sized charlcd
+lcd_columns = 16
+lcd_rows = 2
+
+#   Metro m0 Pin Config:
+lcd_rs = digitalio.DigitalInOut(D7)
+lcd_en = digitalio.DigitalInOut(D8)
+lcd_d7 = digitalio.DigitalInOut(D12)
+lcd_d6 = digitalio.DigitalInOut(D11)
+lcd_d5 = digitalio.DigitalInOut(D10)
+lcd_d4 = digitalio.DigitalInOut(D9)
+lcd_backlight = digitalio.DigitalInOut(D13)
+red = pulseio.PWMOut(D3)
+green = pulseio.PWMOut(D4)
+blue = pulseio.PWMOut(D5)
+
+#   Init the lcd class
+lcd = LCD.cirpyth_char_lcd_RGB(lcd_rs, lcd_en, lcd_d4, lcd_d5, lcd_d6, lcd_d7, lcd_columns, lcd_rows, red, green, blue, lcd_backlight)
+
+# only red
+RED     = [100, 0,   0]
+GREEN   = [0,   100, 0]
+BLUE    = [0,   0,   100]
+
+while True:
+    lcd.message('CircuitPython\nRGB Test')
+    lcd.setColor(RED)
+    time.sleep(1)
+    lcd.setColor(GREEN)
+    time.sleep(1)
+    lcd.setColor(BLUE)
+    time.sleep(1)
diff --git a/src/adafruit_character_lcd_RGB.py b/src/adafruit_character_lcd_RGB.py
@@ -0,0 +1,260 @@
+# The MIT License (MIT)
+#
+# Copyright (c) 2017 Brent Rubell for Adafruit Industries
+#
+# 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.
+"""
+`adafruit_CircuitPython_CharLCD`
+====================================================
+
+TODO(description)
+
+* Author(s):
+-Brent Rubell
+-Asher Lieber
+-Tony DiCola for the original python charLCD library
+"""
+
+"""
+`adafruit_character_lcd_RGB` - RGB character lcd module
+=================================================
+module for interfacing with RGB character lcds
+"""
+import time
+import math
+import digitalio
+import pulseio
+from board import *
+from micropython import const
+
+# Commands
+_LCD_CLEARDISPLAY        = const(0x01)
+_LCD_RETURNHOME          = const(0x02)
+_LCD_ENTRYMODESET        = const(0x04)
+_LCD_DISPLAYCONTROL      = const(0x08)
+_LCD_CURSORSHIFT         = const(0x10)
+_LCD_FUNCTIONSET         = const(0x20)
+_LCD_SETCGRAMADDR        = const(0x40)
+_LCD_SETDDRAMADDR        = const(0x80)
+
+# Entry flags
+_LCD_ENTRYRIGHT          = const(0x00)
+_LCD_ENTRYLEFT           = const(0x02)
+_LCD_ENTRYSHIFTINCREMENT = const(0x01)
+_LCD_ENTRYSHIFTDECREMENT = const(0x00)
+
+# Control flags
+_LCD_DISPLAYON           = const(0x04)
+_LCD_DISPLAYOFF          = const(0x00)
+LCD_CURSORON            = const(0x02)
+_LCD_CURSOROFF           = const(0x00)
+_LCD_BLINKON             = const(0x01)
+_LCD_BLINKOFF            = const(0x00)
+
+# Move flags
+_LCD_DISPLAYMOVE         = const(0x08)
+_LCD_CURSORMOVE          = const(0x00)
+_LCD_MOVERIGHT           = const(0x04)
+_LCD_MOVELEFT            = const(0x00)
+
+# Function set flags
+_LCD_8BITMODE            = const(0x10)
+_LCD_4BITMODE            = const(0x00)
+_LCD_2LINE               = const(0x08)
+_LCD_1LINE               = const(0x00)
+_LCD_5x10DOTS            = const(0x04)
+_LCD_5x8DOTS             = const(0x00)
+
+# Offset for up to 4 rows.
+LCD_ROW_OFFSETS         = (0x00, 0x40, 0x14, 0x54)
+
+class cirpyth_char_lcd_RGB(object):
+    """ Interfaces with a character LCD
+          :param ~microcontroller.Pin rs: The reset data line
+          :param ~microcontroller.Pin en: The enable data line
+          :param ~microcontroller.Pin d4, d5, d6, d7: The data lines 4 thru 7
+          :param ~microcontroller.Pin cols: The columns on the charLCD
+          :param ~microcontroller.Pin lines: The lines on the charLCD
+          :param ~microcontroller.Pin red: Red RGB Anode
+          :param ~microcontroller.Pin green: Green RGB Anode
+          :param ~microcontroller.Pin blue: Blue RGB Anode
+          :param ~microcontroller.Pin backlight: The backlight pin, usually the last pin. Consult the datasheet.
+          :param enable_pwm: PulseIO Control
+          :param initial_backlight: THE initial backlight status (on/off)
+      """
+    def __init__(self, rs, en, d4, d5, d6, d7, cols, lines,
+          red,
+          green,
+          blue,
+          backlight = None,
+          enable_pwm = False,
+          initial_backlight = 1.0):
+      #  define columns and lines
+      self.cols = cols
+      self.lines = lines
+      #  define pin params
+      self.rs = rs
+      self.en = en
+      self.d4 = d4
+      self.d5 = d5
+      self.d6 = d6
+      self.d7 = d7
+      #  define color params
+      self.red = red
+      self.green = green
+      self.blue = blue
+      #  define rgb led
+      self.RGBLED = [red, green, blue]
+      # define backlight pin
+      self.backlight = backlight
+      # save backlight state
+      self.backlight = backlight
+      self.pwn_enabled = enable_pwm
+      # set all pins as outputs
+      for pin in(rs, en, d4, d5, d6, d7):
+        pin.direction = digitalio.Direction.OUTPUT
+      #  setup backlight
+      if backlight is not None:
+        self.backlight.direction = digitalio.Direction.OUTPUT
+        self.backlight.value = 0 # turn backlight on
+      #  initialize the display
+      self._write8(0x33)
+      self._write8(0x32)
+      #  init. display control
+      self.displaycontrol = _LCD_DISPLAYON | _LCD_CURSOROFF | _LCD_BLINKOFF
+      #  init display function
+      self.displayfunction = _LCD_4BITMODE | _LCD_1LINE | _LCD_2LINE | _LCD_5x8DOTS
+      #  init display mode
+      self.displaymode = _LCD_ENTRYLEFT | _LCD_ENTRYSHIFTDECREMENT
+      #  write to display control
+      self._write8(_LCD_DISPLAYCONTROL | self.displaycontrol)
+      #  write displayfunction
+      self._write8(_LCD_FUNCTIONSET | self.displayfunction)
+      #  set the entry mode
+      self._write8(_LCD_ENTRYMODESET | self.displaymode)
+      self.clear()
+
+    def home(self):
+      """Moves the cursor back home pos(1,1)"""
+      self._write8(_LCD_RETURNHOME)
+      time.sleep(0.003)
+
+    def clear(self):
+      """Clears the LCD"""
+      self._write8(_LCD_CLEARDISPLAY)
+      time.sleep(0.003)
+
+    def show_cursor(self, show):
+      """Show or hide the cursor"""
+      if show:
+        self.displaycontrol |= LCD_CURSORON
+      else:
+        self.displaycontrol &= ~_LCD_DISPLAYON
+      self._write8(_LCD_DISPLAYCONTROL | self.displaycontrol)
+
+    def set_cursor(self, col, row):
+      """Sets the cursor to ``row`` and ``col``
+            :param col: column location
+            :param row: row location
+        """
+      # Clamp row to the last row of the display
+      if row > self.lines:
+        row = self.lines - 1
+      # Set location
+      self._write8(_LCD_SETDDRAMADDR | (col + LCD_ROW_OFFSETS[row]))
+
+    def enable_display(self, enable):
+        """Enable or disable the display.  Set enable to True to enable."""
+        if enable:
+          self.displaycontrol |= _LCD_DISPLAYON
+        else:
+          self.displaycontrol &= ~_LCD_DISPLAYON
+        self._write8(_LCD_DISPLAYCONTROL | self.displaycontrol)
+
+    def _write8(self,value, char_mode = False):
+      """Sends 8b ``value`` in ``char_mode``.
+        :param value: bytes
+        :param char_mode: character/data mode selector. False (default) for
+        data only, True for character bits.
+        """
+      #  one ms delay to prevent writing too quickly.
+      time.sleep(0.001)
+      #  set character/data bit. (charmode = False)
+      self.rs.value = char_mode
+      # WRITE upper 4 bits
+      self.d4.value = ((value >> 4) & 1) > 0
+      self.d5.value = ((value >> 5) & 1) > 0
+      self.d6.value = ((value >> 6) & 1) > 0
+      self.d7.value = ((value >> 7) & 1) > 0
+      #  send command
+      self._pulse_enable()
+      # WRITE lower 4 bits
+      self.d4.value = (value & 1) > 0
+      self.d5.value = ((value >> 1) & 1) > 0
+      self.d6.value = ((value >> 2) & 1) > 0
+      self.d7.value = ((value >> 3) & 1) > 0
+      self._pulse_enable()
+
+    def _pulse_enable(self):
+      """ Pulses (lo->hi->lo) to send commands. """
+      self.en.value = False
+      # 1microsec pause
+      time.sleep(0.0000001)
+      self.en.value = True
+      time.sleep(0.0000001)
+      self.en.value = False
+      time.sleep(0.0000001)
+
+    def set_backlight(self, lighton):
+      """ Set lighton to turn the charLCD backlight on. """
+      if lighton:
+        self.backlight.value = 0
+      else:
+        self.backlight.value = 1
+
+    def _map(self, x, in_min, in_max, out_min, out_max):
+        """ Affine transfer/map with constrained output. """
+        outrange = float(out_max - out_min)
+        inrange = float(in_max - in_min)
+        ret = (x - in_min) * (outrange / inrange) + out_min
+        if (out_max > out_min):
+            return max(min(ret, out_max), out_min)
+        else:
+            return max(min(ret, out_min), out_max)
+
+    def setColor(self, color):
+        """ Method to set the duty cycle of the RGB LED """
+        self.RGBLED[0].duty_cycle = int(self._map(color[0], 0, 100, 65535, 0))
+        self.RGBLED[1].duty_cycle = int(self._map(color[1], 0, 100, 65535, 0))
+        self.RGBLED[2].duty_cycle = int(self._map(color[2], 0, 100, 65535, 0))
+
+    def message(self, text):
+      """Write text to display, can include \n for newline"""
+      line = 0
+      #  iterate thru each char
+      for char in text:
+        # if character is \n, go to next line
+        if char == '\n':
+          line += 1
+          #  move to left/right depending on text direction
+          col = 0 if self.displaymode & _LCD_ENTRYLEFT > 0 else self.cols-1
+          self.set_cursor(col, line)
+        # Write character to display
+        else:
+          self._write8(ord(char), True)
