Framework Configuration! Main configuration file for the mTouch Framework. More...
#include "mTouch_optionsForConfig.h"#include "mTouch_config_slider.h"#include "mTouch_config_modes.h"#include "mTouch_config_cvdAdvanced.h"
Go to the source code of this file.
Defines | |
| #define | MTOUCH_EEPROM_START_ADR 0x02 |
| #define | MTOUCH_EEPROM_INIT_VALUE 0xBD |
| #define | MTOUCH_EEPROM_STORED_IN_RAM |
| #define | MTOUCH_SENSOR3_IS_PROX 0 |
| #define | MTOUCH_SENSOR1_IS_PROX 1 |
System Setup (mTouch_config.h) | |
These configuration options must be uniquely set for each application. They define the manner in which the framework will be implemented in the application. | |
| #define | _XTAL_FREQ |
| The oscillator frequency of your system in Hz. | |
| #define | MTOUCH_INTEGRATION_TYPE |
| Defines the manner in which the framework will integrate with the application. | |
| #define | MTOUCH_ISR_TIMER |
| If the mTouch scanning routine is called from the ISR, this defines which timer's interrupt flag is used. | |
| #define | MTOUCH_SCAN_FUNCTIONALITY |
| Determines how many sensors are scanned in a single 'scan' function call. | |
| #define | MTOUCH_ADC_CONTROL |
| Determines whether or not the framework controls the ADC at all times. | |
Non-critical Values | |
These values are used for tracking version numbers when communicating with a master. They have been provided for use by the EEPROM storage function so its easy to implement version tracking in your application. They are not required and do not have an impact on the generation of the firmware. | |
| #define | MTOUCH_BOARD_ID |
| No effect on framework behavior. | |
| #define | MTOUCH_HARDWARE_VERSION |
| No effect on framework behavior. | |
| #define | MTOUCH_FRAMEWORK_VERSION |
| No effect on framework behavior. | |
| #define | MTOUCH_SOFTWARE_VERSION |
| No effect on framework behavior. | |
Sensor Setup (mTouch_config.h) | |
These configuration options initialize the sensors in the framework by defining which analog pins are to be scanned and how much sensitivity is expected from them (thresholds). | |
| #define | MTOUCH_NUMBER_SENSORS |
| Number of active-mode mTouch sensor inputs to scan. | |
| #define | MTOUCH_SENSOR0 |
| Analog port assignment for the active-mode sensor with index 0. | |
| #define | THRESHOLD_PRESS_SENSOR0 |
| Defines the press threshold of the active-mode sensor with index 0. | |
| #define | MTOUCH_RELEASE_THRESH_FACTOR |
| Defines the hysteresis relationship between the press and release thresholds. | |
Filtering Setup (mTouch_config.h) | |
These configuration options define if and how the mTouch framework is to communicate with a PC. | |
| #define | MTOUCH_SAMPLES_PER_SCAN |
| Determines the degree of oversampling and the sample rate of your system. | |
| #define | MTOUCH_BASELINE_WEIGHT |
| Determines the weight given to the raw value when updating the baseline. | |
| #define | MTOUCH_BASELINE_RATE |
| Sets the update rate of the baseline when unpressed. | |
| #define | MTOUCH_DECIMATION_MAX_STEP |
| Maximum allowed change of the framework's latched mTouch result variable from a single mTouch sample. | |
| #define | MTOUCH_JITTER_BITS |
| Defines the number of bits to use to implement a random delay between mTouch scans. | |
| #define | MTOUCH_SCALING |
| mTouch post-scaler of reading value | |
Decoding Setup (mTouch_config.h) | |
These configuration options will adjust the decoding behavior of the mTouch Framework. Editting these values is optional but allows for a more highly customized final result. | |
| #define | MTOUCH_POWER_UP_SAMPLES |
| Number of times each sensor should be scanned and decoded before exitting the initialization state and entering the released state. | |
| #define | MTOUCH_BUTTON_TIMEOUT |
| Number of mTouch decode function calls where the sensor is consecutively pressed before resetting the sensor to its released state. | |
| #define | MTOUCH_DEBOUNCE_RELEASE |
| Number of consecutive scans a sensor must be decoded as released before changing states. | |
| #define | MTOUCH_DEBOUNCE_PRESS |
| Number of consecutive scans a sensor must be decoded as pressed before changing states. | |
| #define | MTOUCH_MOST_PRESSED_THRESHOLD |
| This configuration option determines how much more pressed the most-pressed sensor must be above all other sensors in order to allow activation. | |
| #define | MTOUCH_MATRIX_ROW_START |
| Defines which MTOUCH_SENSORx sensor is the start-index of the 'row' sensors. | |
| #define | MTOUCH_MATRIX_ROW_END |
| Defines which MTOUCH_SENSORx sensor is the final-index of the 'row' sensors. | |
| #define | MTOUCH_MATRIX_COLUMN_START |
| Defines which MTOUCH_SENSORx sensor is the start-index of the 'column' sensors. | |
| #define | MTOUCH_MATRIX_COLUMN_END |
| Defines which MTOUCH_SENSORx sensor is the final-index of the 'column' sensors. | |
Proximity Sensor Configuration | |
These options define which sensors are proximity sensors and how the framework is to implement the median filter. Read this guide for more information about proximity sensors and configuration. | |
| #define | MTOUCH_NUMBER_PROXIMITY |
| Defines how many proximity sensors are activated. | |
| #define | MTOUCH_PROX_BUFFER_SIZE |
| Determines the size of the buffer used in the proximity median filter. | |
| #define | MTOUCH_PROX_REMOVE_EXTREME |
| The median filter's N largest and N smallest values are not included in the filter's output value. Must be less than half the buffer size. | |
| #define | MTOUCH_PROX_USE_32BIT_ACCUM |
| If defined, the accumulator used during the decoding process of the proximity sensor will be implemented as a 32-bit value. | |
Detailed Description
Framework Configuration! Main configuration file for the mTouch Framework.
Definition in file mTouch_config.h.
Define Documentation
| #define MTOUCH_BOARD_ID |
No effect on framework behavior.
| #define MTOUCH_EEPROM_INIT_VALUE 0xBD |
Definition at line 183 of file mTouch_config.h.
| #define MTOUCH_EEPROM_START_ADR 0x02 |
Definition at line 161 of file mTouch_config.h.
| #define MTOUCH_EEPROM_STORED_IN_RAM |
Definition at line 200 of file mTouch_config.h.
| #define MTOUCH_FRAMEWORK_VERSION |
No effect on framework behavior.
| #define MTOUCH_HARDWARE_VERSION |
No effect on framework behavior.
| #define MTOUCH_SENSOR1_IS_PROX 1 |
Definition at line 525 of file mTouch_config.h.
| #define MTOUCH_SENSOR3_IS_PROX 0 |
Definition at line 524 of file mTouch_config.h.
| #define MTOUCH_SOFTWARE_VERSION |
No effect on framework behavior.
