initial coding of module

Author: michaellee1019

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Michael Lee
+
+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.

meta.json

@@ -0,0 +1,18 @@
+{
+  "module_id": "michaellee1019:mpr121",
+  "visibility": "private",
+  "url": "https://github.com/michaellee1019/mpr121",
+  "description": "A Viam module that returns sensor values from a capacitive touch sensor with the MPR121 chip.",
+  "models": [
+    {
+	"api": "rdk:builtin:sensor",
+      "model": "michaellee1019:mpr121:mpr121"
+    }
+  ],
+  "entrypoint": "run.sh",
+  "build": {
+    "build": "sh run.sh",
+    "path": "dist/archive.tar.gz",
+    "arch" : ["linux/arm64", "linux/amd64"]
+  }
+}

models.py

@@ -0,0 +1,31 @@
+import viam_wrap
+from viam.components.sensor import Sensor
+from viam.proto.app.robot import ComponentConfig
+from typing import Mapping, Self
+from viam.proto.common import ResourceName
+from viam.resource.base import ResourceBase
+import time
+import board
+import busio
+import adafruit_mpr121
+
+class MPR121(Sensor):
+    MODEL = "michaellee1019:mpr121:mpr121"
+    # Create MPR121 object.
+    mpr121: adafruit_mpr121.MPR121 = None
+
+    @classmethod
+    def new(self, config: ComponentConfig, dependencies: Mapping[ResourceName, ResourceBase]) -> Self:
+        output = self(config.name)
+        output.reconfigure(config, dependencies)
+        return output
+
+    def reconfigure(self,
+                    config: ComponentConfig,
+                    dependencies: Mapping[ResourceName, ResourceBase]):
+        i2c = busio.I2C(board.SCL, board.SDA)
+        self.mpr121 = adafruit_mpr121.MPR121(i2c)
+
+    async def get_readings(self, **kwargs):
+        return self.mpr121
+

requirements.txt

@@ -0,0 +1,4 @@
+viam-sdk
+pyinstaller
+git+https://github.com/viam-labs/1liner
+adafruit-circuitpython-mpr121

run.sh

@@ -0,0 +1,12 @@
+#!/usr/bin/env bash
+cd `dirname $0`
+set -eux
+
+sudo apt-get update
+sudo apt-get install -y python3-pip python3-venv i2c-tools
+sudo pip install -r requirements.txt
+sudo raspi-config nonint do_i2c 0
+
+# Be sure to use `exec` so that termination signals reach the python process,
+# or handle forwarding termination signals manually
+exec python3 src/main.py $@

test.py

@@ -0,0 +1,36 @@
+# be sure to run first:
+# sudo pip3 install adafruit-circuitpython-mpr121 --break-system-packages
+# sudo raspi-config nonint do_i2c 0
+
+# SPDX-FileCopyrightText: 2017 Tony DiCola for Adafruit Industries
+# SPDX-License-Identifier: MIT
+
+# 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 board
+import busio
+
+# Import MPR121 module.
+import adafruit_mpr121
+
+# Create I2C bus.
+i2c = busio.I2C(board.SCL, board.SDA)
+
+# Create MPR121 object.
+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[i].value:
+            print("Input {} touched!".format(i))
+    time.sleep(0.25)  # Small delay to keep from spamming output messages.