Merge pull request #1019 from MX682X/master

Adding PTC! (Beta)

megaavr/libraries/PTC/README.md

@@ -0,0 +1,135 @@
+# PTC Library
+An Arduino compatible C library to support the PTC in the AtTiny 1-Series
+
+## Features
+As this is library can be considered an Alpha version, things might change in the future, so nothing is set in stone yet.
+* Ready to use with minimal knowledge of the peripheral, but can still be well configured (options are similar to the "official" library)
+* Supports Mutual-cap and Self-cap (+Shield) sensing technology
+* Supports event-based triggering of conversions, as well as window-compared wake-up from Stand-by sleep
+* Can be suspended to allow the polled use of ADC0 (ADC0 ISRs are used by the library)
+* Reduced memory footprint due to CPU specific optimizations compared to the "official" implementation (needs about 3.5k Flash)
+
+
+## Installation
+
+Not needed, comes with the core.
+
+For the non-Arduino people: all you need is inside the src folder.
+
+## How to use this library
+
+### Overview
+
+#### Step 1: Memory Initialization
+Allocate memory for every single sensing node. The easiest way is to have an array with `cap_sensor_t` elements, e.g. `cap_sensor_t nodes[3];`. Even though it allows you to access the data stored in this structures directly, it is not allowed to change the contents directly. Always use the provided setter functions for this.
+
+#### Step 2: Node registration
+Initialize the node to be either a mutual-cap node with `uint8_t ptc_add_mutualcap_node(cap_sensor_t* node, ptc_ch_bm_t yCh, ptc_ch_bm_t xCh);` or to a self-cap node with `uint8_t ptc_add_selfcap_node(cap_sensor_t* node, ptc_ch_bm_t yCh, ptc_ch_bm_t xCh);`. When everything went without problems, the functions will return the enum `PTC_LIB_SUCCESS`. While mutual-cap requires yCh and xCh not to be 0 (otherwise `PTC_LIB_BAD_ARGUMENT` will be returned), the self-cap requires only the yCh not to be 0. If the xCh is zero, the node will be a normal self-cap node, otherwise it will be of the self-cap with shield type. This becomes relevant when you change between the types, but that will be explained later. This function will also disable the pullup and digital input function of the specified pins. The order, in which this function is called determines the conversion order. The nodes will be also numbered for easier identification. Up to 255 nodes are supported for devices with 16 or less PTC pins. 65k for bigger devices. The nodes are enabled by default, so, in case an added node should be disabled, you can call `uint8_t ptc_disable_node(cap_sensor_t* node);`, and for `re-enabling uint8_t ptc_enable_node(cap_sensor_t* node);`.
+Here are some examples:
+- `ptc_add_mutualcap_node(&nodes[0], PIN_TO_PTC(PIN_PA4), PIN_TO_PTC(PIN_PA7));`
+  - PA4 will be sensing, PA7 will be driving
+- `ptc_add_selfcap_node(&nodes[1], PIN_TO_PTC(PIN_PA4), 0);`
+  - No Driving pin, only sensing on PA4
+- `ptc_add_selfcap_node(&nodes[2], (PIN_TO_PTC(PIN_PA4) | PIN_TO_PTC(PIN_PA5)), PIN_TO_PTC(PIN_PA7));`
+  - useful for wakeups, all "buttons" work as one, no matter on which you press, plus driven shield pin.
+
+
+#### Step 3: Acquisition and Processing
+This library requires a regular call to the function `void ptc_process(uint16_t currTime)`. This function handles all background functionality of the library and calls the callback `extern void ptc_event_callback(const uint8_t eventType, cap_sensor_t* node)` when appropriate. First, the function checks if an acquisition was completed (all nodes of the selected type converted). If that's the case, it proceeds to handle the gathered data to handle the respective state machine of each node whose conversion was completed. The more nodes you have, the more time it might take.
+The exact workings of this function will exceed the scope of this document.
+This function takes an argument, `uint16_t currTime`, to decide when to start the next acquisition. This, compared to having a, as an example, `millis()` inside the library, offers the user significant flexibility on choosing the time source (e.g. TCB.CNT). The Period can be set by `void ptc_set_acqusition_period(uint16_t period)`. Whenever the currTime minus the currTime when the last acquisition trigger happened is greater or equal the period, a new acquisition is started.
+However, if there was a successful call to `uint8_t ptc_suspend(void)`, only the timestamp is updated, but no acquisition is started. This also applies when the library was put into low-power mode, except that conversions can still be triggered by events.
+Even though this library can handle three different node types, only one type can be acquired at a time. By default, the type of the first node in the list is used. But the user can use the function `ptc_set_next_conversion_type(uint8_t type)` to change this behavior.
+
+#### Step 4: Callback
+In order to provide an efficient way of notification, the library provides a couple of extern callbacks, listed below with the type of events that are passed to those functions. In a previous version, all callback-events would have called `void ptc_event_callback(const ptc_cb_event_t eventType, cap_sensor_t* node) {`, however, I realized that a single function would end up too complex.
+All (sub-)callbacks are provided with the `weak` and `alias(ptc_event_callback)` attributes, meaning that if you do not provide a definition in your files, the callbacks will be redirected to the standard callback function, but never to both. The standard callback has also a default version that literally does nothing, meaning that your sketch will compile, even if you don't define any of the callbacks (not recommended though).
+
+
+There are following callbacks:
+- `ptc_event_cb_touch` With following Events:
+  - `PTC_CB_EVENT_TOUCH_DETECT`     (0x11): Whenever a node changes to the pressed state
+  - `PTC_CB_EVENT_TOUCH_RELEASE`    (0x12): Whenever a node changes to the un-pressed state
+- `ptc_event_cb_wake` Only when low-power is enabled, called from ptc_process:
+  - `PTC_CB_EVENT_WAKE_TOUCH`       (0x15): When the Window-Comparator detected a touch
+  - `PTC_CB_EVENT_WAKE_NO_TOUCH`    (0x16): opposite of above
+- `ptc_event_cb_conversion`:
+  - `PTC_CB_EVENT_CONV_CMPL`        (0x20): Anytime a node has finished it's conversion and the state-machine was updated
+  - `PTC_CB_EVENT_CONV_MUTUAL_CMPL` (0x21). Useful to select the next type of conversions, if you have a mix of types
+  - `PTC_CB_EVENT_CONV_SELF_CMPL`   (0x24). You can AND the values with NODE_MUTUAL_bm, NODE_SELFCAP_bm,
+  - `PTC_CB_EVENT_CONV_SHIELD_CMPL` (0x28). NODE_SELFCAP_SHIELD_bm.
+  - `PTC_CB_EVENT_CONV_TYPE_CMPL_MSK`(0x0D): Can be used with bitwise AND to differentiate between node and type conversions.
+- `ptc_event_cb_calibration`:
+  - `PTC_CB_EVENT_CONV_CALIB`       (0x40): When ever a calibration was finished.
+  - `PTC_CB_EVENT_ERR_CALIB_MSK`    (0x07): Can be used with bitwise AND to to differentiate between success and Error.
+  - `PTC_CB_EVENT_ERR_CALIB_LOW`    (0x41): If the Capacitor compensation ended up too low.
+  - `PTC_CB_EVENT_ERR_CALIB_HIGH`   (0x42): As above, but too high.
+  - `PTC_CB_EVENT_ERR_CALIB_TO`     (0x44): If the calibration timed out.
+- `ptc_event_cb_error':
+  - Currently unused, but might be in the future.
+The hexa-decimal values are there for orientation and might change in the future.
+
+
+### Low Power operation
+This library also provides a so-called low power mode. This mode changes the operation of the library and the ADC. It will be set up to wait for Events, however it is up to the user to set up the Event-Routing network. The low power mode also sets up the window-comparator to detect touch events. It should be also noted, that it is not possible to use `ptc_suspend` while the library is in low-power mode. the low-power mode has to be disabled first before being able to suspend the library.
+
+In order to initialize the low-power mode, just call `uint8_t ptc_lp_init(cap_sensor_t* node)` (to disable: `uint8_t ptc_lp_disable(void)`) with the node you want to have automatically converted. The node must be enabled and must have been calibrated beforehand to work correctly, meaning it had to have a couple finished conversions.
+
+To check, if the window-comparator was triggered outside of the WAKE events, you can use the function `uint8_t ptc_lp_was_waken(void)` that returns either `PTC_LIB_WAS_WAKEN` or `PTC_LIB_ASLEEP`, at least while the low-power mode is active or use the callback.
+
+### Pins and how to use the ptc_add_* functions
+
+The ptc_add_* functions require a bitmap (ptc_ch_bm_t yCh; ptc_ch_bm_t xCh) of pins, that will be connected to the PTC internals upon the beginning of a conversion. The bitposition equals to the PTC pin numbering, that you can find in the PTC column in the datasheet. It is different from the usual numbering, for example PA4 on the 1614 is X0/Y0, resulting in a bitmap of 0x01.
+
+However, to make it easier, a compile-time look-up-table with a macro to access it is provided, `PIN_TO_PTC(PIN_Pnx)`. If the pin is valid, the corresponding bit-map is returned, otherwise null. But this requires the megaTinyCore from Spence Konde, as the PIN_Pnx naming is defined there.
+
+The reason, why a bit-map is used, is to provide a way to connect the electrodes of multiple pins to act as one big electrode. In order to create a node with multiple pins connected, a simple OR operation is enough.
+
+The ptc_ch_bm_t is a typedef that depends on the pincount of the device and ranges from uint8_t to uint16_t (and up to uint64_t on the DAs). Up to 8 PTC-Pins, uint8_t, up to 16 PTC pins, uint16_t, and so on.
+
+### PTC Operation
+![PTC_InnerWorkings](https://github.com/MX682X/ptc_touch/assets/58419867/823c487c-0633-4031-b381-45e7a32867fb)
+(Source: [Microchip's PTC Subsystem Firmware User's Guide](<https://web.archive.org/web/20221225142000/https://www.mouser.com/pdfdocs/SAMA5D2_PTC_Firmware_UG.pdf>))
+This schematic was made for a different chip, but it is likely to look similar on the AVRs.
+
+Most of the following is a hypothesis based on the publicly available documentation and observation.
+The PTC is using a charge transfer between a variable and a fixed capacitance to measure a difference between those two. The variable capacitance in this case is the sensor electrode and the fixed one is the internal Cc. The neat thing about having a dedicated hardware for this, is that Cc is not really fixed, compared to the Sample-and-Hold capacitor of the normal ADC, it can be calibrated to be about the same as the electrode we want to measure (See below).
+
+In order to measure the capacitance of the node, the PTC performs following Steps:
+  1. Charge the electrode to Vdd
+  2. Wait for charge to complete
+  3. Disconnect node from Vdd and instead connect it to Cc
+  4. Measure voltage of Cc
+  5. Connect node and Cc to GND to discharge them
+
+The measured voltage depends on what happens around the electrode. In an idle state, 50% of the charge of the node (and thus voltage) is transferred to Cc, however when something conductive is moved towards the electrode, the capacitance will increase slightly. With a higher capacitance, the node will have a higher charge, meaning less then 50% of the charge can be transferred to Cc until they reach an equal Voltage, which means the overall voltage will be higher, which can be measured by the ADC.
+
+If you have trouble understanding: Imagine two equally sized volumes connected through a valve. You fill the first up with water, open the valve and look on the second, how high the water has risen. After marking the "idle" level, when you put a finger in the water and see the water rise. This new level is the increase in voltage due to an interference.
+
+### Calibration / Compensation
+
+Based on the documentation found online, the PTC has an internal, tunable capacitor connected after the series resistance to ground that is used to compensate the parasitic capacitance of the electrodes. Every node starts with a default compensation value. As soon as the node is enabled, the library attempts to find a compensation setting that will result in an ADC value of about 512 counts (1/2 of ADC resolution). Based on oscilloscope readings, it can also be said that the PTC tries to have a charge of 50% VCC on the electrode when being acquired. This is the also the reason, why the digital input function of the pins is disabled.
+
+The maximum compensation is about 30pF for Mutual-cap and about 50pF for Self-cap. It is possible to get the compensation capacitance with uint16_t ptc_get_node_cc_femto(cap_sensor_t* node); - however this function has to do a lot of calculations and is thus a bit bloat-y. It will also return the value in femto farrads, to avoid floats. Read more here: https://www.microchipdeveloper.com/touch:guide-to-interpret-cc-calibration-value
+
+Different pins have a different parasitic capacitance. I suspect this is depends on the internal circuitry and alternative functions, so it's normal to see some difference with pins next to each other.
+
+### Tuning of nodes
+
+In order to ease the use of the PTC module, the ptc_add_* functions will initialize the cap_sensor_t struct with some default values, like the CC value mentioned above. That values can be easily changed and will be applied the next time a conversion of said node starts. Here is a list:
+- Analog Gain. Increases the sensitivity of the electrode by adjusting a capacitor on a integrator (I think) (1x Gain)
+- Digital Gain. Defines the amount of ADC Oversampling. Will not affect the count value, as it is internally right-shifted. (16x Oversampled)
+- Charge Share Delay. Affects the Sample length of the ADC. (0 extra clocks)
+- Prescaler. It is possible to slow down the ADC clock by adjusting the Prescaler. (Depends on CPU clock, targeted: 1MHz +/- 25%)
+- Serial Resistor. Allows to change the serial resistor between the Cc and the node. Fixed at 100k for Self-Cap. Creates RC-low-pass filter.
+
+If a node is not sensitive enough, you can increase the Analog Gain (if it becomes too sensitive, an increase of the thresholds might be needed). However it is better to have a bigger node to begin with because the bigger the area, the higher is the capacitance delta.
+
+### Global settings of the State-maschine
+The state-machine, which changes the node's state between Calibration, touch, no touch, etc. uses some variables that are valid for all nodes, those are:
+- `uint16_t force_recal_delta`. Each node has a threshold value that is used to calculate the delta. This Threshold value is drifting over time to adjust for environmental changes. If the threshold value drifts 512 +/- this value, a recalibration of CC is performed. Default: 150
+- `uint8_t  touched_detect_nom`. Number of consecutive Measurements (Conversions) that are above the touch threshold until the node becomes "touched". Default: 3
+- `uint8_t  untouched_detect_nom`. Number of consecutive measurements that are below the no-touch threshold until the node is fully untouched. Default: 3
+- `uint8_t  touched_max_nom`. Number of consecutive measurements plus one in the touched state until a recalibration is forced. Can be disabled by writing 255 to it. Default: 200
+- `uint8_t  drift_up_nom`. If the delta is higher then the reference, but lower then the threshold, the amount of consecutive measurements plus one, until the reference is incremented. Can be disabled with 255. Default: 20.
+- `uint8_t  drift_down_nom`. If the delta is below the reference, the amount of consecutive measurements plus one until the reference is decremented. Can be disabled with 255. Default: 20.

megaavr/libraries/PTC/examples/mutualcap/mutualcap.ino

@@ -0,0 +1,60 @@
+#include <ptc.h>
+/*
+ * This example creates two different sensing nodes.
+ * PA4 and PA5 are on the Y-Lines, PA6 is the X-Line.
+ * PTC_CB_EVENT_TOUCH_DETECT and PTC_CB_EVENT_TOUCH_RELEASE can
+ * be used for quick actions, like switching a pin or variable,
+ * but it is recommended to use PTC_CB_EVENT_CONV_MUTUAL_CMPL, as
+ * otherwise the handling of the successive nodes would be delayed.
+ */
+#define MySerial Serial
+
+cap_sensor_t nodes[2];
+
+void setup() {
+  MySerial.begin(115200);
+
+  // this puts the node on the list and initializes to default values
+  ptc_add_mutualcap_node(&nodes[0], PIN_TO_PTC(PIN_PA4), PIN_TO_PTC(PIN_PA7));
+  ptc_add_mutualcap_node(&nodes[1], PIN_TO_PTC(PIN_PA5), PIN_TO_PTC(PIN_PA7));
+
+
+  // Make sure Serial works
+  MySerial.println("Hello World!");
+}
+
+void loop() {
+  ptc_process(millis());    // main ptc task, requires regular calls
+}
+
+// callbacks that are called by ptc_process at different points to ease user interaction
+void ptc_event_cb_touch(const ptc_cb_event_t eventType, cap_sensor_t* node) {
+  if (PTC_CB_EVENT_TOUCH_DETECT == eventType) {
+    MySerial.print("node touched:");
+    MySerial.println(ptc_get_node_id(node));
+  } else if (PTC_CB_EVENT_TOUCH_RELEASE == eventType) {
+    MySerial.print("node released:");
+    MySerial.println(ptc_get_node_id(node));
+  }
+}
+
+void ptc_event_cb_conversion(const ptc_cb_event_t eventType, cap_sensor_t* node) {
+  if (PTC_CB_EVENT_CONV_TYPE_CMPL_MSK & eventType) {
+    // Do more complex things here
+  }
+  (void)node;   // remove unused warning
+}
+
+void ptc_event_cb_calibration(const ptc_cb_event_t eventType, cap_sensor_t* node)  {
+  if (PTC_CB_EVENT_ERR_CALIB_LOW == eventType) {
+    MySerial.print("Calib error, Cc too low.");
+  } else if (PTC_CB_EVENT_ERR_CALIB_HIGH == eventType) {
+    MySerial.print("Calib error, Cc too high.");
+  } else if (PTC_CB_EVENT_ERR_CALIB_TO == eventType) {
+    MySerial.print("Calib error, calculation timeout.");
+  } else {
+    MySerial.print("Calib Successful.");
+  }
+  MySerial.print(" Node: ");
+  MySerial.println(ptc_get_node_id(node));
+}

megaavr/libraries/PTC/examples/self_and_mutual_mix/self_and_mutual_mix.ino

@@ -0,0 +1,67 @@
+#include <ptc.h>
+/*
+ * This example creates four different sensing nodes. of two different types.
+ * PA4 and PA5 are the self-cap lines with PB0 acting as shield pin.
+ * PA6 and PA7 are the Y-Lines with PB1 acting as the X-line.
+ * PTC_CB_EVENT_CONV_MUTUAL_CMPL and 
+ * PTC_CB_EVENT_CONV_SHIELD_CMPL can be used to change the type that is converted.
+ * This will create an interlaced conversion, but it is not mandatory to do so.
+ */
+
+
+#define MySerial Serial
+cap_sensor_t nodes[4];
+
+
+void setup() {
+  // put your setup code here, to run once:
+  ptc_add_selfcap_node(&nodes[0], PIN_TO_PTC(PIN_PA4), PIN_TO_PTC(PIN_PB0));
+  ptc_add_selfcap_node(&nodes[1], PIN_TO_PTC(PIN_PA5), PIN_TO_PTC(PIN_PB0));
+
+  ptc_add_mutualcap_node(&nodes[2], PIN_TO_PTC(PIN_PA6), PIN_TO_PTC(PIN_PB1));
+  ptc_add_mutualcap_node(&nodes[3], PIN_TO_PTC(PIN_PA7), PIN_TO_PTC(PIN_PB1));
+
+  MySerial.begin(115200);
+  MySerial.println("Hello World!");
+}
+
+void loop() {
+  // put your main code here, to run repeatedly:
+  ptc_process(millis());    // main ptc task, requires regular calls
+}
+
+
+
+// callbacks that are called by ptc_process at different points to ease user interaction
+void ptc_event_cb_touch(const ptc_cb_event_t eventType, cap_sensor_t* node) {
+  if (PTC_CB_EVENT_TOUCH_DETECT == eventType) {
+    MySerial.print("node touched:");
+    MySerial.println(ptc_get_node_id(node));
+  } else if (PTC_CB_EVENT_TOUCH_RELEASE == eventType) {
+    MySerial.print("node released:");
+    MySerial.println(ptc_get_node_id(node));
+  }
+}
+
+void ptc_event_cb_conversion(const ptc_cb_event_t eventType, cap_sensor_t* node) {
+  if (PTC_CB_EVENT_CONV_MUTUAL_CMPL == eventType) {
+    ptc_set_next_conversion_type(NODE_SELFCAP_SHIELD_bm);
+  } else if (PTC_CB_EVENT_CONV_SHIELD_CMPL == eventType) {
+    ptc_set_next_conversion_type(NODE_MUTUAL_bm);
+  }
+  (void)node;   // remove unused warning
+}
+
+void ptc_event_cb_calibration(const ptc_cb_event_t eventType, cap_sensor_t* node)  {
+  if (PTC_CB_EVENT_ERR_CALIB_LOW == eventType) {
+    MySerial.print("Calib error, Cc too low.");
+  } else if (PTC_CB_EVENT_ERR_CALIB_HIGH == eventType) {
+    MySerial.print("Calib error, Cc too high.");
+  } else if (PTC_CB_EVENT_ERR_CALIB_TO == eventType) {
+    MySerial.print("Calib error, calculation timeout.");
+  } else {
+    MySerial.print("Calib Successful.");
+  }
+  MySerial.print(" Node: ");
+  MySerial.println(ptc_get_node_id(node));
+}