qtouch: update tuning

* Lower the ADC/PTC frequency to 2Mhz
* Lower the analog gain as that introduces more noise
* Higher analog gain of edge sensors that are less sensitive
* Make filter 8x digital gain as per recommendation
* Reduce threshold for active to 12 (to be tweaked)
* Put sensor groups in AKS groups so that if one sensor is active no
  other sensor in the same group can become active.
* Reduce hysteris to 25% to make "untouch" quicker
* Speed up all calibration rates to 1 step per 200ms
* Set a maximum touch time of 10s to eventually abort in case someone
  puts the device on a table
* Remove force calibrate. The faster calibration rates should fix the
  sensors equally quick.
* Add all functions from templates that was missing to make future diffs
  with atmel start smaller.

Author: NickeZ

external/asf4-drivers/qtouch/include/touch_api_ptc.h

@@ -41,19 +41,23 @@ extern "C" {
  *----------------------------------------------------------------------------*/
 /* Application Helper API's */
 uint16_t qtouch_get_sensor_node_signal(uint16_t sensor_node);
-uint16_t qtouch_get_sensor_node_reference(uint16_t sensor_node);
+void qtouch_update_sensor_node_signal(uint16_t sensor_node, uint16_t new_signal);
 uint16_t qtouch_get_sensor_node_signal_filtered(uint16_t sensor_node);
+uint16_t qtouch_get_sensor_node_reference(uint16_t sensor_node);
+void qtouch_update_sensor_node_reference(uint16_t sensor_node, uint16_t new_reference);
 uint16_t qtouch_get_sensor_cc_val(uint16_t sensor_node);
+void qtouch_update_sensor_cc_val(uint16_t sensor_node, uint16_t new_cc_value);
 uint8_t qtouch_get_sensor_state(uint16_t sensor_node);
+void qtouch_update_sensor_state(uint16_t sensor_node, uint8_t new_state);
+void qtouch_calibrate_node(uint16_t sensor_node);
+uint8_t qtouch_get_scroller_state(uint16_t sensor_node);
 bool qtouch_is_scroller_active(uint16_t sensor_node);
 uint16_t qtouch_get_scroller_position(uint16_t sensor_node);
 
 void qtouch_timer_handler(void);
 void qtouch_init(void);
 void qtouch_process(void);
-void qtouch_force_calibrate(void);
 
-void qtimer_task_cb(const struct timer_task *const timer_task);
 void qtouch_timer_config(void);
 
 #ifdef __cplusplus

src/bootloader/bootloader.c

@@ -363,7 +363,6 @@ extern uint8_t bootloader_pairing_code_bytes[4];
 
 void bootloader_render_ble_confirm_screen(bool confirmed)
 {
-    qtouch_force_calibrate();
     bootloader_pairing_request = true;
     uint32_t pairing_code_int = (*(uint32_t*)&bootloader_pairing_code_bytes[0]) % 1000000;
     char code_str[10] = {0};

src/qtouch/qtouch.c

@@ -46,11 +46,11 @@ static void qtm_measure_complete_callback(void);
 
 /*! \brief Touch Error callback function prototype.
  */
-static void qtm_error_callback(uint8_t err);
+static void qtm_error_callback(uint8_t error);
 
-/*! \brief Calculate scroller positions based on custom filter.
+/* Update our scroller implementation
  */
-static void qtouch_process_scroller_positions(void);
+void qtouch_process_scroller_positions(void);
 
 /*----------------------------------------------------------------------------
  *     Global Variables
@@ -110,6 +110,9 @@ __extension__ static uint16_t scroller_position[] = {[0 ...(DEF_NUM_SCROLLERS -
 /* Whether or not scroller reading exceeds threshold for custom filter */
 __extension__ static bool scroller_active[DEF_NUM_SCROLLERS] = {[0 ...(DEF_NUM_SCROLLERS - 1)] = 0};
 
+/* Holds preceding unfiltered scroller positions */
+static uint16_t sensor_previous_filtered_reading[DEF_NUM_SENSORS][DEF_SENSOR_NUM_PREV_POS] = {0};
+
 /**********************************************************/
 /*********************** Keys Module **********************/
 /**********************************************************/
@@ -195,26 +198,6 @@ static touch_ret_t touch_sensors_config(void)
     return (touch_ret);
 }
 
-/*
- * Force calibrate
- *
- * Call this function when the user "probably" isn't touching the device to reset all the
- * calibration values. It will only reset inputs that are not considered to be in "touched" states
- */
-void qtouch_force_calibrate(void)
-{
-    qtm_touch_key_data_t* key;
-    for (uint16_t i = 0U; i < DEF_NUM_CHANNELS; i++) {
-        key = &qtlib_key_data_set1[i];
-        uint16_t value = key->node_data_struct_ptr->node_acq_signals;
-        uint16_t reference = key->channel_reference;
-        int32_t diff = (int32_t)reference - (int32_t)value;
-        if (!(key->sensor_state & KEY_TOUCHED_MASK) && diff > KEY_FORCE_CALIBRATE_THRESHOLD) {
-            key->channel_reference = key->node_data_struct_ptr->node_acq_signals;
-        }
-    }
-}
-
 /*============================================================================
 static void qtm_measure_complete_callback( void )
 ------------------------------------------------------------------------------
@@ -244,9 +227,9 @@ Derived Module_error_codes:
         ... and so on
 
 ============================================================================*/
-static void qtm_error_callback(uint8_t err)
+static void qtm_error_callback(uint8_t error)
 {
-    module_error_code = err + 1u;
+    module_error_code = error + 1u;
 }
 
 /*============================================================================
@@ -364,25 +347,40 @@ uint16_t qtouch_get_sensor_node_signal(uint16_t sensor_node)
     return (ptc_qtlib_node_stat1[sensor_node].node_acq_signals);
 }
 
+void qtouch_update_sensor_node_signal(uint16_t sensor_node, uint16_t new_signal)
+{
+    ptc_qtlib_node_stat1[sensor_node].node_acq_signals = new_signal;
+}
 uint16_t qtouch_get_sensor_node_reference(uint16_t sensor_node)
 {
     return (qtlib_key_data_set1[sensor_node].channel_reference);
 }
 
+void qtouch_update_sensor_node_reference(uint16_t sensor_node, uint16_t new_reference)
+{
+    qtlib_key_data_set1[sensor_node].channel_reference = new_reference;
+}
+
 uint16_t qtouch_get_sensor_cc_val(uint16_t sensor_node)
 {
     return (ptc_qtlib_node_stat1[sensor_node].node_comp_caps);
 }
 
+void qtouch_update_sensor_cc_val(uint16_t sensor_node, uint16_t new_cc_value)
+{
+    ptc_qtlib_node_stat1[sensor_node].node_comp_caps = new_cc_value;
+}
+
 uint8_t qtouch_get_sensor_state(uint16_t sensor_node)
 {
     return (qtlib_key_set1.qtm_touch_key_data[sensor_node].sensor_state);
 }
 
-/* Holds preceding unfiltered scroller positions */
-static uint16_t sensor_previous_filtered_reading[DEF_NUM_SENSORS][DEF_SENSOR_NUM_PREV_POS] = {0};
+void qtouch_update_sensor_state(uint16_t sensor_node, uint8_t new_state)
+{
+    qtlib_key_set1.qtm_touch_key_data[sensor_node].sensor_state = new_state;
+}
 
-/* Custom sensor signal filter. */
 uint16_t qtouch_get_sensor_node_signal_filtered(uint16_t sensor_node)
 {
     // Filter the sensor signal.
@@ -403,11 +401,11 @@ uint16_t qtouch_get_sensor_node_signal_filtered(uint16_t sensor_node)
     }
     X = sensor_raw < sensor_reference ? 0 : sensor_raw - sensor_reference;
     // Add more weight to edge buttons because they are physically smaller (smaller readings).
-    if ((sensor_node == DEF_SCROLLER_OFFSET_0) || (sensor_node == DEF_SCROLLER_OFFSET_1) ||
-        (sensor_node == DEF_SCROLLER_OFFSET_0 + DEF_SCROLLER_NUM_CHANNELS - 1) ||
-        (sensor_node == DEF_SCROLLER_OFFSET_1 + DEF_SCROLLER_NUM_CHANNELS - 1)) {
-        X = (uint16_t)((double)X * (1 + DEF_SENSOR_EDGE_WEIGHT));
-    }
+    // if ((sensor_node == DEF_SCROLLER_OFFSET_0) || (sensor_node == DEF_SCROLLER_OFFSET_1) ||
+    //    (sensor_node == DEF_SCROLLER_OFFSET_0 + DEF_SCROLLER_NUM_CHANNELS - 1) ||
+    //    (sensor_node == DEF_SCROLLER_OFFSET_1 + DEF_SCROLLER_NUM_CHANNELS - 1)) {
+    //    X = (uint16_t)((double)X * (1 + DEF_SENSOR_EDGE_WEIGHT));
+    //}
     // Saturate out-of-range readings.
     X = (X > DEF_SENSOR_CEILING) ? DEF_SENSOR_CEILING : X;
 
@@ -431,11 +429,10 @@ uint16_t qtouch_get_sensor_node_signal_filtered(uint16_t sensor_node)
     return X_ave;
 }
 
-bool qtouch_is_scroller_active(uint16_t scroller)
+bool qtouch_is_scroller_active(uint16_t sensor_node)
 {
-    return scroller_active[scroller];
+    return scroller_active[sensor_node];
 }
-
 uint16_t qtouch_get_scroller_position(uint16_t sensor_node)
 {
     return scroller_position[sensor_node];

src/qtouch/qtouch.h

@@ -17,8 +17,8 @@ Copyright (c) 2017 Microchip. All rights reserved.
 ------------------------------------------------------------------------------
 ============================================================================*/
 
-#ifndef TOUCH_H
-#define TOUCH_H
+#ifndef QTOUCH_H
+#define QTOUCH_H
 
 #ifdef __cplusplus
 extern "C" {
@@ -65,7 +65,7 @@ extern "C" {
  * Range: FREQ_SEL_0 - FREQ_SEL_15 , FREQ_SEL_SPREAD
  * Default value: FREQ_SEL_0.
  */
-#define DEF_SEL_FREQ_INIT FREQ_SEL_8
+#define DEF_SEL_FREQ_INIT FREQ_SEL_0
 
 /*----------------------------------------------------------------------------
  *     defines
@@ -86,63 +86,23 @@ extern "C" {
  * Gain , Digital Gain), filter level}
  */
 // Slider 1 buttons
-#define NODE_0_PARAMS                             \
-    {X_NONE,                                      \
-     Y_LINE(26),                                  \
-     0,                                           \
-     NODE_RSEL_PRSC(RSEL_VAL_20, PRSC_DIV_SEL_1), \
-     NODE_GAIN(GAIN_4, GAIN_4),                   \
-     FILTER_LEVEL_512}
-#define NODE_1_PARAMS                             \
-    {X_NONE,                                      \
-     Y_LINE(27),                                  \
-     0,                                           \
-     NODE_RSEL_PRSC(RSEL_VAL_20, PRSC_DIV_SEL_1), \
-     NODE_GAIN(GAIN_4, GAIN_4),                   \
-     FILTER_LEVEL_512}
-#define NODE_2_PARAMS                             \
-    {X_NONE,                                      \
-     Y_LINE(28),                                  \
-     0,                                           \
-     NODE_RSEL_PRSC(RSEL_VAL_20, PRSC_DIV_SEL_1), \
-     NODE_GAIN(GAIN_4, GAIN_4),                   \
-     FILTER_LEVEL_512}
-#define NODE_3_PARAMS                             \
-    {X_NONE,                                      \
-     Y_LINE(29),                                  \
-     0,                                           \
-     NODE_RSEL_PRSC(RSEL_VAL_20, PRSC_DIV_SEL_1), \
-     NODE_GAIN(GAIN_4, GAIN_4),                   \
-     FILTER_LEVEL_512}
+#define NODE_0_PARAMS \
+    {X_NONE, Y_LINE(26), 0, PRSC_DIV_SEL_4, NODE_GAIN(GAIN_2, GAIN_8), FILTER_LEVEL_64}
+#define NODE_1_PARAMS \
+    {X_NONE, Y_LINE(27), 0, PRSC_DIV_SEL_4, NODE_GAIN(GAIN_1, GAIN_8), FILTER_LEVEL_64}
+#define NODE_2_PARAMS \
+    {X_NONE, Y_LINE(28), 0, PRSC_DIV_SEL_4, NODE_GAIN(GAIN_1, GAIN_8), FILTER_LEVEL_64}
+#define NODE_3_PARAMS \
+    {X_NONE, Y_LINE(29), 0, PRSC_DIV_SEL_4, NODE_GAIN(GAIN_2, GAIN_8), FILTER_LEVEL_64}
 // Slider 0 buttons
-#define NODE_4_PARAMS                             \
-    {X_NONE,                                      \
-     Y_LINE(30),                                  \
-     0,                                           \
-     NODE_RSEL_PRSC(RSEL_VAL_20, PRSC_DIV_SEL_1), \
-     NODE_GAIN(GAIN_4, GAIN_4),                   \
-     FILTER_LEVEL_512}
-#define NODE_5_PARAMS                             \
-    {X_NONE,                                      \
-     Y_LINE(31),                                  \
-     0,                                           \
-     NODE_RSEL_PRSC(RSEL_VAL_20, PRSC_DIV_SEL_1), \
-     NODE_GAIN(GAIN_4, GAIN_4),                   \
-     FILTER_LEVEL_512}
-#define NODE_6_PARAMS                             \
-    {X_NONE,                                      \
-     Y_LINE(20),                                  \
-     0,                                           \
-     NODE_RSEL_PRSC(RSEL_VAL_20, PRSC_DIV_SEL_1), \
-     NODE_GAIN(GAIN_4, GAIN_4),                   \
-     FILTER_LEVEL_512}
-#define NODE_7_PARAMS                             \
-    {X_NONE,                                      \
-     Y_LINE(21),                                  \
-     0,                                           \
-     NODE_RSEL_PRSC(RSEL_VAL_20, PRSC_DIV_SEL_1), \
-     NODE_GAIN(GAIN_4, GAIN_4),                   \
-     FILTER_LEVEL_512}
+#define NODE_4_PARAMS \
+    {X_NONE, Y_LINE(30), 0, PRSC_DIV_SEL_4, NODE_GAIN(GAIN_2, GAIN_8), FILTER_LEVEL_64}
+#define NODE_5_PARAMS \
+    {X_NONE, Y_LINE(31), 0, PRSC_DIV_SEL_4, NODE_GAIN(GAIN_1, GAIN_8), FILTER_LEVEL_64}
+#define NODE_6_PARAMS \
+    {X_NONE, Y_LINE(20), 0, PRSC_DIV_SEL_4, NODE_GAIN(GAIN_1, GAIN_8), FILTER_LEVEL_64}
+#define NODE_7_PARAMS \
+    {X_NONE, Y_LINE(21), 0, PRSC_DIV_SEL_4, NODE_GAIN(GAIN_2, GAIN_8), FILTER_LEVEL_64}
 
 /**********************************************************/
 /***************** Key Params   ******************/
@@ -157,75 +117,68 @@ extern "C" {
  * {Sensor Threshold, Sensor Hysterisis, Sensor AKS}
  */
 // 0..3 higher Slider left to right 4..7 lower Slider right to left
-#define KEY_0_PARAMS {16, HYST_50, NO_AKS_GROUP}
-#define KEY_1_PARAMS {16, HYST_50, NO_AKS_GROUP}
-#define KEY_2_PARAMS {16, HYST_50, NO_AKS_GROUP}
-#define KEY_3_PARAMS {16, HYST_50, NO_AKS_GROUP}
-#define KEY_4_PARAMS {16, HYST_50, NO_AKS_GROUP}
-#define KEY_5_PARAMS {16, HYST_50, NO_AKS_GROUP}
-#define KEY_6_PARAMS {16, HYST_50, NO_AKS_GROUP}
-#define KEY_7_PARAMS {16, HYST_50, NO_AKS_GROUP}
+#define KEY_0_PARAMS {12, HYST_25, AKS_GROUP_1}
+#define KEY_1_PARAMS {12, HYST_25, AKS_GROUP_1}
+#define KEY_2_PARAMS {12, HYST_25, AKS_GROUP_1}
+#define KEY_3_PARAMS {12, HYST_25, AKS_GROUP_1}
+#define KEY_4_PARAMS {12, HYST_25, AKS_GROUP_2}
+#define KEY_5_PARAMS {12, HYST_25, AKS_GROUP_2}
+#define KEY_6_PARAMS {12, HYST_25, AKS_GROUP_2}
+#define KEY_7_PARAMS {12, HYST_25, AKS_GROUP_2}
 
 /* De-bounce counter for additional measurements to confirm touch detection
  * Range: 0 to 255.
  * Default value: 4.
  */
-#define DEF_TOUCH_DET_INT 0
+#define DEF_TOUCH_DET_INT 1
 
 /* De-bounce counter for additional measurements to confirm away from touch signal
  * to initiate Away from touch re-calibration.
  * Range: 0 to 255.
  * Default value: 5.
  */
-#define DEF_ANTI_TCH_DET_INT 0
+#define DEF_ANTI_TCH_DET_INT 1
 
 /* Threshold beyond with automatic sensor recalibration is initiated.
  * Range: RECAL_100/ RECAL_50 / RECAL_25 / RECAL_12_5 / RECAL_6_25 / MAX_RECAL
  * Default value: RECAL_100.
  */
-#define DEF_ANTI_TCH_RECAL_THRSHLD RECAL_50
+#define DEF_ANTI_TCH_RECAL_THRSHLD RECAL_100
 
 /* Rate at which sensor reference value is adjusted towards sensor signal value
  * when signal value is greater than reference.
  * Units: 200ms
  * Range: 0-255
  * Default value: 20u = 4 seconds.
  */
-#define DEF_TCH_DRIFT_RATE 20
+#define DEF_TCH_DRIFT_RATE 1
 
 /* Rate at which sensor reference value is adjusted towards sensor signal value
  * when signal value is less than reference.
  * Units: 200ms
  * Range: 0-255
  * Default value: 5u = 1 second.
  */
-#define DEF_ANTI_TCH_DRIFT_RATE 5
+#define DEF_ANTI_TCH_DRIFT_RATE 1
 
 /* Time to restrict drift on all sensor when one or more sensors are activated.
  * Units: 200ms
  * Range: 0-255
  * Default value: 20u = 4 seconds.
  */
-#define DEF_DRIFT_HOLD_TIME 20
+#define DEF_DRIFT_HOLD_TIME 1
 
 /* Set mode for additional sensor measurements based on touch activity.
  * Range: REBURST_NONE / REBURST_UNRESOLVED / REBURST_ALL
  * Default value: REBURST_UNRESOLVED
  */
-#define DEF_REBURST_MODE REBURST_ALL
+#define DEF_REBURST_MODE REBURST_NONE
 
 /* Sensor maximum ON duration upon touch.
  * Range: 0-255
  * Default value: 0
  */
-#define DEF_MAX_ON_DURATION 0
-
-/*
- * The count that the reference value must be above the measured value to
- * allow the force calibrate procedure to overwrite the reference to the
- * current measured value.
- */
-#define KEY_FORCE_CALIBRATE_THRESHOLD 10
+#define DEF_MAX_ON_DURATION 50
 
 /**********************************************************/
 /***************** Slider/Wheel Parameters ****************/
@@ -237,21 +190,24 @@ extern "C" {
  * This allows low noise button readings while keeping
  * fast responsiveness.
  */
+
 #define DEF_NUM_SCROLLERS 2 // Number of scrollers (sliders or wheels)
 #define DEF_SCROLLER_NUM_CHANNELS 4 // Number of channels per scroller
 #define DEF_SCROLLER_OFFSET_0 4 // Index of first button in scroller
 #define DEF_SCROLLER_OFFSET_1 0 // Index of first button in scroller
 #define DEF_SCROLLER_RESOLUTION 256 // Scroller resolution in bits
-#define DEF_SCROLLER_DET_THRESHOLD 25 // Scroller detect threshold
-#define DEF_SCROLLER_TOUCH_THRESHOLD 25 // Scroller active threshold
-#define DEF_SCROLLER_UNTOUCH_THRESHOLD 20 // Scroller active threshold
+#define DEF_SCROLLER_DET_THRESHOLD 12 // Scroller detect threshold
+#define DEF_SCROLLER_TOUCH_THRESHOLD 12 // Scroller active threshold
+#define DEF_SCROLLER_UNTOUCH_THRESHOLD 9 // Scroller active threshold
 #define DEF_SCROLLER_DEADBAND 13 // 13 bits = 5% of 256-bit range
 #define DEF_SCROLLER_NUM_PREV_POS \
     4 // Number of previous scroller positions to remember; used in a simple filter
 #define DEF_SCROLLER_OFF \
     0xFFFF // Marker for indicating scroller reading does not exceed detection threshold
+/*
 #define DEF_SENSOR_EDGE_WEIGHT \
     0.15 // Percent added weight to edge sensors, which are physically smaller
+*/
 #define DEF_SENSOR_NUM_PREV_POS \
     4 // Number of previous sensor positions to remember; used in a simple filter
 #define DEF_SENSOR_CEILING \
@@ -261,4 +217,4 @@ extern "C" {
 #ifdef __cplusplus
 }
 #endif // __cplusplus
-#endif // TOUCH_C
+#endif // QTOUCH_H