Refactor to CircuitPython library conventions.

Author: tdicola

.travis.yml

@@ -0,0 +1,59 @@
+# Travis CI configuration for automated .mpy file generation.
+# Version: 2.0 (support for both .mpy and packages)
+# Author: Tony DiCola
+# License: Public Domain
+# This configuration will work with Travis CI (travis-ci.org) to automacially
+# build .mpy files and packages for MicroPython when a new tagged release is
+# created.  This file is relatively generic and can be shared across multiple
+# repositories by following these steps:
+#   1. Copy this file into a .travis.yml file in the root of the repository.
+#   2. Change the deploy > file section below to list each of the .mpy files or
+#      package .zip files that should be generated.
+#      For each .mpy file listed the config will automatically look for .py files
+#      with the same name as the source for generating the .mpy files.  Note that
+#      the .mpy extension should be lower case!
+#      For each .zip file listed the config will assume a folder with the same
+#      name exists (minus the .zip extension) and will recursively walk the folder
+#      to generate .mpy versions of all .py files EXCEPT __init__.py (not supported
+#      right now because of a bug).  Then a zip of the directory will be generated
+#      with just the .mpy and __init__.py files.
+#   3. Commit the .travis.yml file and push it to GitHub.
+#   4. Go to travis-ci.org and find the repository (it needs to be setup to access
+#      your github account, and your github account needs access to write to the
+#      repo).  Flip the 'ON' switch on for Travis and the repo, see the Travis
+#      docs for more details: https://docs.travis-ci.com/user/getting-started/
+#   5. Get a GitHub 'personal access token' which has at least 'public_repo' or
+#      'repo' scope: https://help.github.com/articles/creating-an-access-token-for-command-line-use/
+#      Keep this token safe and secure!  Anyone with the token will be able to
+#      access and write to your GitHub repositories.  Travis will use the token
+#      to attach the .mpy files to the release.
+#   6. In the Travis CI settings for the repository that was enabled find the
+#      environment variable editing page: https://docs.travis-ci.com/user/environment-variables/#Defining-Variables-in-Repository-Settings
+#      Add an environment variable named GITHUB_TOKEN and set it to the value
+#      of the GitHub personal access token above.  Keep 'Display value in build
+#      log' flipped off.
+#   7. That's it!  Tag a release and Travis should go to work to add .mpy files
+#      to the release.  It takes about a 2-3 minutes for a worker to spin up,
+#      build mpy-cross, and add the binaries to the release.
+language: generic
+
+sudo: true
+
+deploy:
+  provider: releases
+  api_key: $GITHUB_TOKEN
+  file:
+  - adafruit_character_lcd.zip
+  skip_cleanup: true
+  on:
+    tags: true
+
+before_install:
+  - wget https://raw.githubusercontent.com/adafruit/MicroPython_TravisCI_Deploy/master/install_dependencies.sh
+  - chmod +x install_dependencies.sh
+  - source install_dependencies.sh
+
+before_deploy:
+  - wget https://raw.githubusercontent.com/adafruit/MicroPython_TravisCI_Deploy/master/build_release.sh
+  - chmod +x build_release.sh
+  - ./build_release.sh

adafruit_character_lcd.mpy

@@ -0,0 +1,2 @@
+from adafruit_character_lcd.character_lcd import Character_LCD
+from adafruit_character_lcd.character_lcd_RGB import Character_LCD_RGB

adafruit_character_lcd/__init__.py

@@ -25,18 +25,18 @@
 
 TODO(description)
 
-* Author(s): 
+* Author(s):
 -Brent Rubell
--Asher Lieber 
--Tony DiCola for the original python charLCD library 
+-Asher Lieber
+-Tony DiCola for the original python charLCD library
 """
 
 """
-`adafruit_character_lcd` - character lcd module 
+`adafruit_character_lcd` - character lcd module
 =================================================
 module for interfacing with character lcds
-""" 
-import time 
+"""
+import time
 import math
 import digitalio
 from board import *
@@ -82,7 +82,7 @@
 # Offset for up to 4 rows.
 LCD_ROW_OFFSETS         = (0x00, 0x40, 0x14, 0x54)
 
-class cirpyth_char_lcd(object):
+class Character_LCD(object):
     """ Interfaces with a character LCD
           :param rs: The reset data line
           :param en: The enable data line
@@ -93,13 +93,13 @@ class cirpyth_char_lcd(object):
           :param enable_pwm: The PWM CONTROL, TODO
           :param initial_backlight: THE initial backlight status (on/off)
       """
-    def __init__(self, rs, en, d4, d5, d6, d7, cols, lines, 
+    def __init__(self, rs, en, d4, d5, d6, d7, cols, lines,
           backlight = None,
           enable_pwm = False,
           initial_backlight = 1.0):
 
       self.cols = cols
-      self.lines = lines 
+      self.lines = lines
       #  save pin numbers
       self.rs = rs
       self.en = en
@@ -111,22 +111,22 @@ def __init__(self, rs, en, d4, d5, d6, d7, cols, lines,
       self.backlight = backlight
       # save backlight state
       self.backlight = backlight
-      self.pwn_enabled = enable_pwm 
+      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 
+      #  Setup backlight
       if backlight is not None:
         self.backlight.direction = digitalio.Direction.OUTPUT
         self.backlight.value = 0 # turn backlight on
-      #  initialize the display 
+      #  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 
+      #  init display mode
       self.displaymode = LCD_ENTRYLEFT | LCD_ENTRYSHIFTDECREMENT
       #  write to display control
       self._write8(LCD_DISPLAYCONTROL | self.displaycontrol)
@@ -157,11 +157,11 @@ def show_cursor(self, show):
     def set_cursor(self, col, row):
       """Sets the cursor to ``row`` and ``col``
             :param col: column location
-            :param row: row location 
+            :param row: row location
         """
       # Clamp row to the last row of the display
       if row > self.lines:
-        row = self.lines - 1 
+        row = self.lines - 1
       # Set location
       self._write8(LCD_SETDDRAMADDR | (col + LCD_ROW_OFFSETS[row]))
 
@@ -180,7 +180,7 @@ def move_left(self):
     def move_right(self):
       """Moves display right one position"""
       self._write8(LCD_CURSORSHIFT | LCD_DISPLAYMOVE | LCD_MOVERIGHT)
-    
+
     def set_left_to_right(self):
       """Set direction of text to read from left to right"""
       self.displaymode |= LCD_ENTRYLEFT
@@ -202,7 +202,7 @@ def enable_display(self, enable):
     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 
+        :param char_mode: character/data mode selector. False (default) for
         data only, True for character bits.
         """
       #  one ms delay to prevent writing too quickly.
@@ -216,7 +216,7 @@ def _write8(self,value, char_mode = False):
       self.d7.value = ((value >> 7) & 1) > 0
       #  send command
       self._pulse_enable()
-      # WRITE lower 4 bits 
+      # WRITE lower 4 bits
       self.d4.value = (value & 1) > 0
       self.d5.value = ((value >> 1) & 1) > 0
       self.d6.value = ((value >> 2) & 1) > 0
@@ -225,7 +225,7 @@ def _write8(self,value, char_mode = False):
 
     def _pulse_enable(self):
       """ Pulses (lo->hi->lo) to send commands. """
-      self.en.value = False 
+      self.en.value = False
       # 1microsec pause
       time.sleep(0.0000001)
       self.en.value = True
@@ -240,7 +240,7 @@ def set_backlight(self, lighton):
       else:
         self.backlight.value = 1
 
-   
+
     def message(self, text):
       """Write text to display, can include \n for newline"""
       line = 0
@@ -252,7 +252,7 @@ def message(self, text):
           #  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 
+        # Write character to display
         else:
           self._write8(ord(char), True)
 

adafruit_character_lcd/character_lcd.mpy

@@ -84,7 +84,7 @@
 # Offset for up to 4 rows.
 LCD_ROW_OFFSETS         = (0x00, 0x40, 0x14, 0x54)
 
-class cirpyth_char_lcd_RGB(object):
+class Character_LCD_RGB(object):
     """ Interfaces with a character LCD
           :param ~microcontroller.Pin rs: The reset data line
           :param ~microcontroller.Pin en: The enable data line