Initial commit.

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

README.md

@@ -1,2 +1,7 @@
-# Adafruit_CircuitPython_MPR121
+# Adafruit CircuitPython MPR121
 Adafruit CircuitPython module for the MPR121 capacitive touch breakout board.
+Note this module is currently made to work with CircuitPython and not upstream
+MicroPython!
+
+This module depends on the Adafruit Bus Device module being installed on the
+board: https://github.com/adafruit/Adafruit_CircuitPython_BusDevice

adafruit_mpr121/__init__.py

@@ -0,0 +1 @@
+from adafruit_mpr121.mpr121 import MPR121

adafruit_mpr121/mpr121.py

@@ -0,0 +1,147 @@
+# MPR121 capacitive touch breakout driver.  Port of Raspberry Pi/BeagleBone Black
+# code from: https://github.com/adafruit/Adafruit_Python_MPR121/
+# Author: Tony DiCola
+# License: MIT License (https://opensource.org/licenses/MIT)
+import time
+
+import adafruit_bus_device.i2c_device as i2c_device
+
+
+# Register addresses.  Unused registers commented out to save memory.
+MPR121_I2CADDR_DEFAULT = const(0x5A)
+MPR121_TOUCHSTATUS_L   = const(0x00)
+#MPR121_TOUCHSTATUS_H   = const(0x01)
+MPR121_FILTDATA_0L     = const(0x04)
+#MPR121_FILTDATA_0H     = const(0x05)
+MPR121_BASELINE_0      = const(0x1E)
+MPR121_MHDR            = const(0x2B)
+MPR121_NHDR            = const(0x2C)
+MPR121_NCLR            = const(0x2D)
+MPR121_FDLR            = const(0x2E)
+MPR121_MHDF            = const(0x2F)
+MPR121_NHDF            = const(0x30)
+MPR121_NCLF            = const(0x31)
+MPR121_FDLF            = const(0x32)
+MPR121_NHDT            = const(0x33)
+MPR121_NCLT            = const(0x34)
+MPR121_FDLT            = const(0x35)
+MPR121_TOUCHTH_0       = const(0x41)
+MPR121_RELEASETH_0     = const(0x42)
+MPR121_DEBOUNCE        = const(0x5B)
+MPR121_CONFIG1         = const(0x5C)
+MPR121_CONFIG2         = const(0x5D)
+#MPR121_CHARGECURR_0    = const(0x5F)
+#MPR121_CHARGETIME_1    = const(0x6C)
+MPR121_ECR             = const(0x5E)
+#MPR121_AUTOCONFIG0     = const(0x7B)
+#MPR121_AUTOCONFIG1     = const(0x7C)
+#MPR121_UPLIMIT         = const(0x7D)
+#MPR121_LOWLIMIT        = const(0x7E)
+#MPR121_TARGETLIMIT     = const(0x7F)
+#MPR121_GPIODIR         = const(0x76)
+#MPR121_GPIOEN          = const(0x77)
+#MPR121_GPIOSET         = const(0x78)
+#MPR121_GPIOCLR         = const(0x79)
+#MPR121_GPIOTOGGLE      = const(0x7A)
+MPR121_SOFTRESET       = const(0x80)
+
+
+class MPR121:
+
+    def __init__(self, i2c, address=MPR121_I2CADDR_DEFAULT):
+        self._i2c = i2c_device.I2CDevice(i2c, address)
+        self._buffer = bytearray(2)
+        self.reset()
+
+    def _write_register_byte(self, register, value):
+        # Write a byte value to the specifier register address.
+        with self._i2c:
+            self._i2c.writeto(bytes([register, value]))
+
+    def _read_register_bytes(self, register, result, length=None):
+        # Read the specified register address and fill the specified result byte
+        # array with result bytes.  Make sure result buffer is the desired size
+        # of data to read.
+        if length is None:
+            length = len(result)
+        with self._i2c:
+            self._i2c.writeto(bytes([register]), stop=False)
+            self._i2c.readfrom_into(result, start=0, end=length)
+
+    def reset(self):
+        """Reset the MPR121 into a default state ready to detect touch inputs.
+        """
+        # Write to the reset register.
+        self._write_register_byte(MPR121_SOFTRESET, 0x63)
+        time.sleep(0.001) # This 1ms delay here probably isn't necessary but can't hurt.
+        # Set electrode configuration to default values.
+        self._write_register_byte(MPR121_ECR, 0x00)
+        # Check CDT, SFI, ESI configuration is at default values.
+        self._read_register_bytes(MPR121_CONFIG2, self._buffer, 1)
+        if self._buffer[0] != 0x24:
+           raise RuntimeError('Failed to find MPR121 in expected config state!')
+        self.set_thresholds(12, 6)
+        # Configure baseline filtering control registers.
+        self._write_register_byte(MPR121_MHDR, 0x01)
+        self._write_register_byte(MPR121_NHDR, 0x01)
+        self._write_register_byte(MPR121_NCLR, 0x0E)
+        self._write_register_byte(MPR121_FDLR, 0x00)
+        self._write_register_byte(MPR121_MHDF, 0x01)
+        self._write_register_byte(MPR121_NHDF, 0x05)
+        self._write_register_byte(MPR121_NCLF, 0x01)
+        self._write_register_byte(MPR121_FDLF, 0x00)
+        self._write_register_byte(MPR121_NHDT, 0x00)
+        self._write_register_byte(MPR121_NCLT, 0x00)
+        self._write_register_byte(MPR121_FDLT, 0x00)
+        # Set other configuration registers.
+        self._write_register_byte(MPR121_DEBOUNCE, 0)
+        self._write_register_byte(MPR121_CONFIG1, 0x10) # default, 16uA charge current
+        self._write_register_byte(MPR121_CONFIG2, 0x20) # 0.5uS encoding, 1ms period
+        # Enable all electrodes.
+        self._write_register_byte(MPR121_ECR, 0x8F) # start with first 5 bits of baseline tracking
+
+    def set_thresholds(self, touch, release):
+        """Set the touch and release threshold for all inputs to the provided
+        values.  Both touch and release should be a value between 0 to 255
+        (inclusive).
+        """
+        if touch < 0 or touch > 255 or release < 0 or release > 255:
+            raise ValueError('Touch/release must be a byte value 0-255.')
+        # Set the touch and release register value for all the inputs.
+        for i in range(12):
+            self._write_register_byte(MPR121_TOUCHTH_0 + 2*i, touch)
+            self._write_register_byte(MPR121_RELEASETH_0 + 2*i, release)
+
+    def filtered_data(self, pin):
+        """Return filtered data register value for the provided pin (0-11).
+        Useful for debugging.
+        """
+        if pin < 0 or pin > 11:
+            raise ValueError('Pin must be a value 0-11.')
+        self._read_register_bytes(MPR121_FILTDATA_0L + pin*2, self._buffer)
+        return ((self._buffer[1] << 8) | (self._buffer[0])) & 0xFFFF
+
+    def baseline_data(self, pin):
+        """Return baseline data register value for the provided pin (0-11).
+        Useful for debugging.
+        """
+        if pin < 0 or pin > 11:
+            raise ValueError('Pin must be a value 0-11.')
+        self._read_register_bytes(MPR121_BASELINE_0 + pin, self._buffer, 1)
+        return self._buffer[0] << 2
+
+    def touched(self):
+        """Return touch state of all pins as a 12-bit value where each bit
+        represents a pin, with a value of 1 being touched and 0 not being touched.
+        """
+        self._read_register_bytes(MPR121_TOUCHSTATUS_L, self._buffer)
+        return ((self._buffer[1] << 8) | (self._buffer[0])) & 0xFFFF
+
+    def is_touched(self, pin):
+        """Return True if the specified pin is being touched, otherwise returns
+        False.
+        """
+        if pin < 0 or pin > 11:
+            raise ValueError('Pin must be a value 0-11.')
+        t = self.touched()
+        return (t & (1 << pin)) > 0

examples/simpletest.py

@@ -0,0 +1,33 @@
+# Simple test of the MPR121 capacitive touch sensor library.
+# Will print out a message when any of the 12 capacitive touch inputs of the
+# board are touched.  Open the serial REPL after running to see the output.
+# Author: Tony DiCola
+import time
+
+# Import MPR121 module.
+import adafruit_mpr121
+
+# Uncomment _one_ of the following lines depending on how your board supports I2C.
+# For hardare I2C (SAMD21/M0 boards):
+import nativeio as io
+# For software I2C (ESP8266):
+#import bitbangio as io
+
+# Create I2C bus.
+import board
+i2c = io.I2C(board.SCL, board.SDA)
+
+# Create MPR121 class.
+mpr121 = adafruit_mpr121.MPR121(i2c)
+# Note you can optionally change the address of the device:
+#mpr121 = adafruit_mpr121.MPR121(i2c, address=0x91)
+
+# Loop forever testing each input and printing when they're touched.
+while True:
+    # Loop through all 12 inputs (0-11).
+    for i in range(12):
+        # Call is_touched and pass it then number of the input.  If it's touched
+        # it will return True, otherwise it will return False.
+        if mpr121.is_touched(i):
+            print('Input {} touched!'.format(i))
+    time.sleep(0.25)  # Small delay to keep from spamming output messages.