Refactored, updated examples, appeased Sphinx.

Author: kattni

README.rst

@@ -19,8 +19,6 @@ This library is compatible with standard Character LCDs such as:
 * `Adafruit RGB backlight negative LCD 16x2 <https://www.adafruit.com/product/399>`_
 * `Adafruit RGB backlight negative LCD 20x4 <https://www.adafruit.com/product/498>`_
 
-Compatible with CircuitPython Versions: 2.x
-
 Dependencies
 =============
 This driver depends on:
@@ -42,20 +40,23 @@ The ``Character_LCD`` class interfaces a predefined Character LCD display with C
 
 .. code-block:: python
 
-    import adafruit_character_lcd
+    import board
+    import digitalio
+    import adafruit_character_lcd.character_lcd as character_lcd
 
 You must define the data pins (``RS``, ``EN``, ``D4``, ``D5``, ``D6``, ``D7``) in your code before using the ``Character_LCD`` class.
-If you want to have on/off ``backlight`` functionality, you can also define your backlight as ``lcd_backlight``. Otherwise, the backlight will always remain on. An example of this is below
+If you want to have on/off ``backlight`` functionality, you can also define your backlight as ``lcd_backlight``. Otherwise, the backlight
+will always remain on. The following is an example setup.
 
 .. code-block:: python
 
-    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)
+    lcd_rs = digitalio.DigitalInOut(board.D7)
+    lcd_en = digitalio.DigitalInOut(board.D8)
+    lcd_d7 = digitalio.DigitalInOut(board.D12)
+    lcd_d6 = digitalio.DigitalInOut(board.D11)
+    lcd_d5 = digitalio.DigitalInOut(board.D10)
+    lcd_d4 = digitalio.DigitalInOut(board.D9)
+    lcd_backlight = digitalio.DigitalInOut(board.D13)
 
 You must also define the size of the CharLCD by specifying its ``lcd_columns`` and ``lcd_rows``:
 
@@ -68,7 +69,7 @@ After you have set up your LCD, we can make the device by calling it
 
 .. code-block:: python
 
-    lcd = adafruit_character_lcd.Character_LCD(lcd_rs, lcd_en, lcd_d4, lcd_d5, lcd_d6, lcd_d7, lcd_columns, lcd_rows, lcd_backlight)
+    lcd = character_lcd.Character_LCD_Mono(lcd_rs, lcd_en, lcd_d4, lcd_d5, lcd_d6, lcd_d7, lcd_columns, lcd_rows, lcd_backlight)
 
 
 To verify that your pins are correct, print a hello message to the CharLCD:
@@ -78,7 +79,7 @@ To verify that your pins are correct, print a hello message to the CharLCD:
     lcd.message = "Hello\nCircuitPython"
 
 
-Custom character example with create_char() is provided within /examples/
+Custom character example with ``create_char()`` is provided within /examples/
 
 
 Contributing

adafruit_character_lcd/character_lcd.py

@@ -34,8 +34,7 @@
 
 **Hardware:**
 
-* Adafruit `Character LCDs
-  <http://www.adafruit.com/category/63_96>`_
+"* `Adafruit Character LCDs <http://www.adafruit.com/category/63_96>`_"
 
 **Software and Dependencies:**
 
@@ -117,11 +116,8 @@ def _map(xval, in_min, in_max, out_min, out_max):
 
 # pylint: disable-msg=too-many-instance-attributes
 class Character_LCD:
-    """Base class for character LCD."""
-    LEFT_TO_RIGHT = const(0)
-    RIGHT_TO_LEFT = const(1)
-    """
-    Interfaces with a character LCD
+    """Base class for character LCD.
+
     :param ~digitalio.DigitalInOut rs: The reset data line
     :param ~digitalio.DigitalInOut en: The enable data line
     :param ~digitalio.DigitalInOut d4: The data line 4
@@ -130,12 +126,11 @@ class Character_LCD:
     :param ~digitalio.DigitalInOut d7: The data line 7
     :param columns: The columns on the charLCD
     :param lines: The lines on the charLCD
-    :param ~digitalio.DigitalInOut backlight_pin: The backlight pin, usually
-    the last pin. Check with your datasheet
-    :param bool backlight_inverted: False if LCD is not inverted, i.e. backlight pin is connected
-    to common anode. True if LCD is inverted i.e. backlight pin is connected to common cathode.
 
     """
+    LEFT_TO_RIGHT = const(0)
+    RIGHT_TO_LEFT = const(1)
+
     # pylint: disable-msg=too-many-arguments
     def __init__(self, rs, en, d4, d5, d6, d7, columns, lines
                 ):
@@ -191,10 +186,9 @@ def clear(self):
             import time
             import board
             import busio
-            import adafruit_character_lcd.character_lcd_mono as character_lcd
+            import adafruit_character_lcd.character_lcd_i2c as character_lcd
 
             i2c = busio.I2C(board.SCL, board.SDA)
-
             lcd = character_lcd.Character_LCD_I2C(i2c, 16, 2)
 
             lcd.message = "Hello, world!"
@@ -215,10 +209,9 @@ def cursor(self):
             import time
             import board
             import busio
-            import adafruit_character_lcd.character_lcd_mono as character_lcd
+            import adafruit_character_lcd.character_lcd_i2c as character_lcd
 
             i2c = busio.I2C(board.SCL, board.SDA)
-
             lcd = character_lcd.Character_LCD_I2C(i2c, 16, 2)
 
             lcd.cursor = True
@@ -260,10 +253,9 @@ def blink(self):
             import time
             import board
             import busio
-            import adafruit_character_lcd.character_lcd_mono as character_lcd
+            import adafruit_character_lcd.character_lcd_i2c as character_lcd
 
             i2c = busio.I2C(board.SCL, board.SDA)
-
             lcd = character_lcd.Character_LCD_I2C(i2c, 16, 2)
 
             lcd.blink = True
@@ -293,10 +285,9 @@ def display(self):
             import time
             import board
             import busio
-            import adafruit_character_lcd.character_lcd_mono as character_lcd
+            import adafruit_character_lcd.character_lcd_i2c as character_lcd
 
             i2c = busio.I2C(board.SCL, board.SDA)
-
             lcd = character_lcd.Character_LCD_I2C(i2c, 16, 2)
 
             lcd.message = "Hello, world!"
@@ -324,10 +315,9 @@ def message(self):
             import time
             import board
             import busio
-            import adafruit_character_lcd.character_lcd_mono as character_lcd
+            import adafruit_character_lcd.character_lcd_i2c as character_lcd
 
             i2c = busio.I2C(board.SCL, board.SDA)
-
             lcd = character_lcd.Character_LCD_I2C(i2c, 16, 2)
 
             lcd.message = "Hello, world!"
@@ -371,10 +361,9 @@ def move_left(self):
             import time
             import board
             import busio
-            import adafruit_character_lcd.character_lcd_mono as character_lcd
+            import adafruit_character_lcd.character_lcd_i2c as character_lcd
 
             i2c = busio.I2C(board.SCL, board.SDA)
-
             lcd = character_lcd.Character_LCD_I2C(i2c, 16, 2)
 
             scroll_message = "<-- Scroll"
@@ -396,19 +385,15 @@ def move_right(self):
             import time
             import board
             import busio
-            import adafruit_character_lcd.character_lcd_mono as character_lcd
+            import adafruit_character_lcd.character_lcd_i2c as character_lcd
 
             i2c = busio.I2C(board.SCL, board.SDA)
-
-            lcd_columns = 16
-            lcd_rows = 2
-
-            lcd = character_lcd.Character_LCD_I2C(i2c, lcd_columns, lcd_rows)
+            lcd = character_lcd.Character_LCD_I2C(i2c, 16, 2)
 
             scroll_message = "Scroll -->"
             lcd.message = scroll_message
             time.sleep(2)
-            for i in range(len(scroll_message) + lcd_columns):
+            for i in range(len(scroll_message) + 16):
                 lcd.move_right()
                 time.sleep(0.5)
         """
@@ -428,10 +413,9 @@ def text_direction(self):
             import time
             import board
             import busio
-            import adafruit_character_lcd.character_lcd_mono as character_lcd
+            import adafruit_character_lcd.character_lcd_i2c as character_lcd
 
             i2c = busio.I2C(board.SCL, board.SDA)
-
             lcd = character_lcd.Character_LCD_I2C(i2c, 16, 2)
 
             lcd.text_direction = lcd.RIGHT_TO_LEFT
@@ -513,21 +497,20 @@ def _pulse_enable(self):
 
 # pylint: disable-msg=too-many-instance-attributes
 class Character_LCD_Mono(Character_LCD):
-    """Base class for character LCD."""
-    """
-    Interfaces with a character LCD
-    :param ~digitalio.DigitalInOut rs: The reset data line
-    :param ~digitalio.DigitalInOut en: The enable data line
-    :param ~digitalio.DigitalInOut d4: The data line 4
-    :param ~digitalio.DigitalInOut d5: The data line 5
-    :param ~digitalio.DigitalInOut d6: The data line 6
-    :param ~digitalio.DigitalInOut d7: The data line 7
-    :param columns: The columns on the charLCD
-    :param lines: The lines on the charLCD
-    :param ~digitalio.DigitalInOut backlight_pin: The backlight pin, usually
-    the last pin. Check with your datasheet
-    :param bool backlight_inverted: False if LCD is not inverted, i.e. backlight pin is connected
-    to common anode. True if LCD is inverted i.e. backlight pin is connected to common cathode.
+    """Interfaces with monochromatic character LCDs.
+
+        :param ~digitalio.DigitalInOut rs: The reset data line
+        :param ~digitalio.DigitalInOut en: The enable data line
+        :param ~digitalio.DigitalInOut d4: The data line 4
+        :param ~digitalio.DigitalInOut d5: The data line 5
+        :param ~digitalio.DigitalInOut d6: The data line 6
+        :param ~digitalio.DigitalInOut d7: The data line 7
+        :param columns: The columns on the charLCD
+        :param lines: The lines on the charLCD
+        :param ~digitalio.DigitalInOut backlight_pin: The backlight pin
+        :param bool backlight_inverted: ``False`` if LCD is not inverted, i.e. backlight pin is
+            connected to common anode. ``True`` if LCD is inverted i.e. backlight pin is connected
+            to common cathode.
 
     """
     # pylint: disable-msg=too-many-arguments
@@ -558,7 +541,7 @@ def backlight(self):
             import time
             import board
             import busio
-            import adafruit_character_lcd.character_lcd_mono as character_lcd
+            import adafruit_character_lcd.character_lcd_i2c as character_lcd
 
             i2c = busio.I2C(board.SCL, board.SDA)
 
@@ -577,22 +560,21 @@ def backlight(self):
     @backlight.setter
     def backlight(self, enable):
         self._enable = enable
-        if enable and not self.backlight_inverted or not enable and self.backlight_inverted:
-            self.backlight_pin.value = 1
-        if enable and self.backlight_inverted or not enable and not self.backlight_inverted:
-            self.backlight_pin.value = 0
+        if enable:
+            self.backlight_pin.value = not self.backlight_inverted
+        else:
+            self.backlight_pin.value = self.backlight_inverted
 
 
 class Character_LCD_RGB(Character_LCD):
-    """Base class for RGB character LCD."""
+    """Interfaces with RGB character LCDs.
 
-    """ Interfaces with an RGB character LCD
         :param ~digitalio.DigitalInOut rs: The reset data line
         :param ~digitalio.DigitalInOut en: The enable data line
-        :param ~digitalio.DigitalInOut d4: The data line 4
-        :param ~digitalio.DigitalInOut d5: The data line 5
-        :param ~digitalio.DigitalInOut d6: The data line 6
-        :param ~digitalio.DigitalInOut d7: The data line 7
+        :param ~digitalio.DigitalInOut db4: The data line 4
+        :param ~digitalio.DigitalInOut db5: The data line 5
+        :param ~digitalio.DigitalInOut db6: The data line 6
+        :param ~digitalio.DigitalInOut db7: The data line 7
         :param columns: The columns on the charLCD
         :param lines: The lines on the charLCD
         :param ~pulseio.PWMOut, ~digitalio.DigitalInOut red: Red RGB Anode
@@ -603,7 +585,8 @@ class Character_LCD_RGB(Character_LCD):
 
     """
     # pylint: disable-msg=too-many-arguments
-    def __init__(self, rs, en, db4, db5, db6, db7, columns, lines, red, green, blue, read_write=None):
+    def __init__(self, rs, en, db4, db5, db6, db7, columns, lines,
+                 red, green, blue, read_write=None):
 
         # Define read_write (rw) pin
         self.read_write = read_write
@@ -613,9 +596,6 @@ def __init__(self, rs, en, db4, db5, db6, db7, columns, lines, red, green, blue,
             self.read_write.direction = digitalio.Direction.OUTPUT
 
         # define color params
-        self.red = red
-        self.green = green
-        self.blue = blue
         self.rgb_led = [red, green, blue]
 
         for pin in self.rgb_led:
@@ -648,11 +628,11 @@ def color(self):
             import time
             import board
             import busio
-            import adafruit_character_lcd.character_lcd_rgb as character_lcd
+            import adafruit_character_lcd.character_lcd_rgb_i2c as character_lcd
 
             i2c = busio.I2C(board.SCL, board.SDA)
 
-            lcd = character_lcd.Character_LCD_I2C_RGB(i2c, 16, 2)
+            lcd = character_lcd.Character_LCD_RGB_I2C(i2c, 16, 2)
 
             lcd.color = [100, 0, 0]
             lcd.message = "Hello, world!"
@@ -671,5 +651,4 @@ def color(self, color):
                 # If we don't have a PWM interface, all we can do is turn each color
                 # on / off.  Assume a DigitalInOut (or compatible interface) and write
                 # 0 (on) to pin for any value greater than 0, or 1 (off) for 0:
-                pin.value = 0 if color[number] > 0 else 1
-
+                pin.value = not color[number] > 1