Support for MPR121 Capacitive Touch Sensor

Author: user2684

.travis.yml

@@ -497,3 +497,10 @@ jobs:
        - sed -r -i 's/\/\/(#include <sensors\/SensorCCS811.h>)/\1/' $SKETCH
        - eval $OTA_CONFIGURATION
        - eval $COMPILE
+    - name: "SensorMPR121"
+      script: 
+       - arduino --install-library "Adafruit MPR121"
+       - sed -r -i 's/\/\/(SensorMPR121 .+)/\1/' $SKETCH
+       - sed -r -i 's/\/\/(#include <sensors\/SensorMPR121.h>)/\1/' $SKETCH
+       - eval $OTA_CONFIGURATION
+       - eval $COMPILE

README.md

@@ -150,6 +150,7 @@ SensorPca9685Rgbw        | 2     | Generic RGBW-dimmer sensor (S_RGBW_LIGHT) use
 SensorDSM501A            | 1     | Dust sensor module DSM501A for PM1.0 and PM2.5 particles                                          | -
 SensorPN532              | 1     | PN532 NFC RFID Module                                                                             | https://github.com/elechouse/PN532
 SensorCCS811             | 1     | CCS811 gas/Air Quality sensor. Measure VOC and eCO2                                               | https://github.com/adafruit/Adafruit_CCS811
+SensorMPR121             | 1     | MPR121-based capacitive touch control sensor                                                      | https://github.com/adafruit/Adafruit_MPR121
 
 Those sensors requiring a pin to operate would take it as an argument in the constructor. 
 NodeManager automatically creates all the child_ids, assigning an incremental counter. If you need to set your own child_id, pass it as the last argument to the constructor
@@ -964,6 +965,16 @@ Each sensor class may expose additional methods.
 	void setTemperatureSensor(bool value);
 ~~~	
 
+* SensorMPR121
+~~~c
+    // set the passcode length. Passcode will be sent to the controller only after this number of digits have been pressed (default: 4)
+	void setPasscodeLength(int value);
+	// [101] wait for a valid code for the given amount of seconds. Useful when battery powered (default: 0)
+	void setWaitCodeForSeconds(int value);
+	// return true if the code was recognized successfully, false otherwise. Useful when a hook function needs to act upon the result
+	bool getCodeIsValid();
+~~~	
+
 ### OTA Configuration
 
 When `NODEMANAGER_OTA_CONFIGURATION` is set to ON the API presented above can be also called remotely through `SensorConfiguration`, which is automatically added to NodeManager. SensorConfiguration exposes by default child id 200 that can be used to interact with the service by sending `V_CUSTOM` type of messages and commands within the payload. For each `REQ` message, the node will respond with a `SET` message if successful. 

keywords.txt

@@ -218,3 +218,4 @@ SensorPca9685W	KEYWORD1
 SensorDSM501A	KEYWORD1
 SensorPN532	KEYWORD1
 SensorCCS811	KEYWORD1
+SensorMPR121	KEYWORD1

sensors/SensorMPR121.h

@@ -0,0 +1,126 @@
+/*
+* The MySensors Arduino library handles the wireless radio link and protocol
+* between your home built sensors/actuators and HA controller of choice.
+* The sensors forms a self healing radio network with optional repeaters. Each
+* repeater and gateway builds a routing tables in EEPROM which keeps track of the
+* network topology allowing messages to be routed to nodes.
+*
+* Created by Henrik Ekblad <[email protected]>
+* Copyright (C) 2013-2017 Sensnology AB
+* Full contributor list: https://github.com/mysensors/Arduino/graphs/contributors
+*
+* Documentation: http://www.mysensors.org
+* Support Forum: http://forum.mysensors.org
+*
+* This program is free software; you can redistribute it and/or
+* modify it under the terms of the GNU General Public License
+* version 2 as published by the Free Software Foundation.
+*/
+#ifndef SensorMPR121_h
+#define SensorMPR121_h
+
+#include <Wire.h>
+#include "Adafruit_MPR121.h"
+
+#ifndef _BV
+#define _BV(bit) (1 << (bit)) 
+#endif
+
+/*
+SensorMPR121: capacitive Touch control sensor
+*/
+
+class SensorMPR121: public Sensor {
+protected:
+	Adafruit_MPR121 *_cap = new Adafruit_MPR121();
+	List<int> _passcode;
+	int _passcode_length = 4;
+	uint8_t _i2c_addr = 0x5A;
+	int _wait_code_for_seconds = 0;
+	bool _code_is_valid = false;
+	uint16_t _lasttouched = 0;
+	uint16_t _currtouched = 0;
+	
+public:
+	SensorMPR121(uint8_t child_id = 0): Sensor(-1) {
+		_name = "MPR121";
+		children.allocateBlocks(1);
+		new Child(this,INT,nodeManager.getAvailableChildId(child_id),S_INFO,V_TEXT,_name);
+	};
+
+	// set the passcode length. Passcode will be sent to the controller only after this number of digits have been pressed (default: 4)
+	void setPasscodeLength(int value) {
+		_passcode_length = value;
+	};
+	
+	// [101] wait for a valid code for the given amount of seconds. Useful when battery powered (default: 0)
+	void setWaitCodeForSeconds(int value) {
+		_wait_code_for_seconds = value;
+	};
+	
+	// return true if the code was recognized successfully, false otherwise. Useful when a hook function needs to act upon the result
+	bool getCodeIsValid() {
+		return _code_is_valid;
+	};
+
+	// define what to do during setup
+	void onSetup() {
+		// do not average the value
+		children.get()->setValueProcessing(NONE);
+		// report immediately
+		setReportTimerMode(IMMEDIATELY);		
+		if (!_cap->begin(_i2c_addr)) debug(PSTR(LOG_SENSOR "%s: KO\n"),_name);
+		// setup passcode array  
+		_passcode.allocateBlocks(_passcode_length);
+	};
+	
+	// define what to do during loop
+	void onLoop(Child* child) {
+		_code_is_valid = false;
+		// start the timer
+		long start_millis = millis();
+		while(true) {
+			// if a timer is set, leave the cycle if over
+			if (_wait_code_for_seconds > 0 && ((millis() - start_millis) > (unsigned long)_wait_code_for_seconds*1000)) break;
+
+			 // Get the currently touched pads
+			_currtouched = _cap->touched();
+			for (uint8_t i=0; i<12; i++) {
+				if ((_currtouched & _BV(i)) && !(_lasttouched & _BV(i)) ) {
+					// pad i touched
+					debug(PSTR(LOG_SENSOR "%s(%d):READ v=%d\n"),_name,child->getChildId(),i);
+					// add the value to the passcode array
+					_passcode.push(i);
+					// time to send the passcode back
+					if (_passcode.size() == _passcode_length) {
+						int passcode = 0;
+						// build up the passcode
+						for (int i = 1; i <= _passcode.size(); i++) {
+							passcode *= 10;
+							passcode += (int) _passcode.get(i);
+						}
+						// store it in the child so it will be sent back 
+						child->setValue(passcode);
+						// clear the passcode array
+						_passcode.clear();
+						break;
+					}
+				}
+			}
+			// reset state
+			_lasttouched = _currtouched;
+			wait(100);
+		}
+	};
+
+#if NODEMANAGER_OTA_CONFIGURATION == ON
+	// define what to do when receiving an OTA configuration request
+	void onOTAConfiguration(ConfigurationRequest* request) {
+		switch(request->getFunction()) {
+		case 101: setWaitCodeForSeconds(request->getValueInt()); break;
+		default: return;
+		}
+	};
+#endif
+};
+#endif