mTouch Framework Documentation

v2.1

Introduction

Thank you for downloading the mTouch Framework v2.1, part of the mTouch Library v1.40.02 package in the MLA.

The mTouch Framework is a software package enabling designers to easily integrate touch technologies to their application. It combines high sensitivity with conducted and radiated noise immunity.

Simple configuration file allows for easy setup. Microchip also offers full source code access for more advanced touch designers.

Getting Started Basic mTouch Sensor Configuration Quick Start Guides New mTouch Project: MPLAB 8 or MPLAB X mTouch Evaluation Board Projects Integrating with Custom Hardware		mTouch Framework Features Keys / Buttons Sliders and Wheels Proximity Sensors Matrix Keypad Layouts Most-Pressed Algorithm Guard Rings / Shields Mutual Capacitance Scanning Modes
Optimizing Performance Increasing Sensitivity Faster Response Times mTouch CVD Waveform Tuning		Resource Requirements Supported PIC® Microcontrollers Hardware Module Usage ROM, RAM, and Processing Requirements Required Source Files
Troubleshooting PC Communications Backwards-compatible UART for prev. Profilab GUI		License Agreement Version Change Log

mTouch Framework File Tree

• /Microchip
  Contains the library, read-only source files for the mTouch Framework.
  • /Help
    Contains documentation for all the Microchip Application Libraries.
    • /mTouch CVD Help Content
      Contains the documentation for the mTouch Framework.
  • /mTouchCap
    • /PIC12F PIC16F Library
      Contains the C source (.c) and C header (.h) files for the mTouch Framework.
      IMPORTANT: The files in this directory should never be directly editted. Copy to a local application folder.
      • mTouch Source Files
        • main.c contains an example application implementation.
        • mTouch.c implements the basic initialization, filtering, and decoding functions for the framework.
        • mTouch_acquistion.c implements a custom mTouch Acquisition method specific to the PIC and configuration.
        • mTouch_slider.c implements the slider and wheel decoding, if enabled.
        • mTouch_proximity.c implements the proximity sensor decoding and state machine, if enabled.
        • mTouch_eeprom.c implements the mTouch EEPROM mapping and read/write functions, if enabled.
      • mTouch Configuration Files
        These are the files that should be tweaked for every application.
        • mTouch_config.h stores the configuration options for the framework.
        • mTouch_config_modes.h stores the configuration options for scanning modes.
        • mTouch_config_slider.h stores the configuration options for sliders and wheels.
        • mTouch_config_cvdAdvanced.h stores the advanced CVD acquisition options.
      • mTouch Header Files
        
        • mTouch.h is the only mTouch file you need to #include to use the API in your project. This is the master header file for the mTouch Framework that defines global variables and includes other files based on the current configuration.
        • mTouch_slider.h is the internal mTouch header file for generating the mTouch Framework's slider and wheel logic
        • mTouch_proximity.h is the internal mTouch header file for generating the mTouch Framework's proximity sensor logic
        • mTouch_eeprom.h is the internal mTouch header file for generating the mTouch Framework's EEPROM logic
        • mTouch_modes.h is the internal mTouch header file for generating the mTouch Framework's scanning mode logic
        • mTouch_optionsForConfig.h contains pre-defined labels for easier user configuration. Do not edit.
        • mTouch_macroLibrary_common.h contains many of the core-non-specific macros for the mTouch Framework.
        • mTouch_processConfiguration.h performs much of the pre-compiling work to confirm a valid configuration and then set up the flags and variables to aid the compiler in generating a custom mTouch application.
        • mTouchCVD_macroLibrary_PIC16F.h is one of several PIC-core-specific header files that contains macros for generating the acquisition module of the mTouch Framework.
        • mTouchCVD_macroLibrary_PIC16F1.h is one of several PIC-core-specific header files that contains macros for generating the acquisition module of the mTouch Framework.
        • mTouchCVD_macroLibrary_PIC18F.h is one of several PIC-core-specific header files that contains macros for generating the acquisition module of the mTouch Framework.
        • generic_processorConfigBits.h contains predefined config fuse statements for faster development.
        
        
      • mComm Source Files
        These files implement the mTouch communications module called 'mComm'.
        • mComm.c contains the basic logic for all supported communication types
        • mComm_opcodes.c implements the read/write actions for each opcode
        • mComm_custom.c implements a custom opcode and should be referenced when creating your own custom behavior.
      • mComm Header Files
        
        • mComm.h is the main header file for the module. Automatically included by mTouch.h.
        • mComm_config.h stores all the configuration options for the mComm module.
        • mComm_optionsForConfig.h contains pre-defined labels for easier user configuration. Do not edit.
        • mComm_processConfiguration.h performs much of the pre-compiling work to confirm a valid configuration and then set up the flags and variables to aid the compiler in generating a custom mComm application.
      • Alternative Configurations/
        • mTouch_HardwareProfile_12F61x.h is one of many PIC-family-specific header files that contains information such available hardware modules, analog channel-to-port mapping, and default register configurations.
        • See Your MLA Directory/Microchip/mTouchCap/PIC12F PIC16F CVD Library/Alternative Configurations/ for all available processor configuration files.
• /mTouchCapDemos
  • /PIC16F_CVD_Demos
    Provides some example, pre-configured projects for various PIC microcontrollers and setups.
    • /02-02091-R2 CSM-CVD Eval Board
      Example project implementing CVD on the mTouch CSM-CVD evaluation board.
      • /2-Ch Slider
        Implements a 2-channel slider connected to daughter board pin 0 and 1
      • /4-Ch Slider
        Implements a 4-channel slider connected to daughter board pin 0-3
      • /8 Buttons
        Implements an 8-button daughter board connected to pins 0-7
      • /12-Key Matrix
        Implements a 12-key 3x4 matrix daughter board on pins 0-6
      • /Metal-over-Capacitive Daughter Board (AC183026)
        Implements the 4-sensor MoC daught board connected to pins 2-5
    • /02-02091-R3 CVD Eval Board
      Example project implementing CVD on the mTouch CVD evaluation board.
      • /2-Ch Slider
        Implements a 2-channel slider connected to daughter board pin 0 and 1
      • /4-Ch Slider
        Implements a 4-channel slider connected to daughter board pin 0-3
      • /8 Buttons
        Implements an 8-button daughter board connected to pins 0-7
      • /12-Key Matrix
        Implements a 12-key 3x4 matrix daughter board on pins 0-6
      • /Metal-over-Capacitive Daughter Board (AC183026)
        Implements the 4-sensor MoC daught board connected to pins 2-5
    • /02-02091-RA CSM Eval Board
      Example project implementing CVD on the mTouch CSM evaluation board.
      • /2-Ch Slider
        Implements a 2-channel slider connected to daughter board pin 0 and 1
      • /4-Ch Slider
        Implements a 4-channel slider connected to daughter board pin 0-3
      • /8 Buttons
        Implements an 8-button daughter board connected to pins 0-7
      • /12-Key Matrix
        Implements a 12-key 3x4 matrix daughter board on pins 0-6
      • /Metal-over-Capacitive Daughter Board (AC183026)
        Implements the 4-sensor MoC daught board connected to pins 2-5
    • /233-04-1008 Rev F CSM Eval Board
      Example project implementing CVD on the mTouch CSM evaluation board.
      • /2-Ch Slider
        Implements a 2-channel slider connected to daughter board pin 0 and 1
      • /4-Ch Slider
        Implements a 4-channel slider connected to daughter board pin 0-3
      • /8 Buttons
        Implements an 8-button daughter board connected to pins 0-7
      • /12-Key Matrix
        Implements a 12-key 3x4 matrix daughter board on pins 0-6
      • /Metal-over-Capacitive Daughter Board (AC183026)
        Implements the 4-sensor MoC daught board connected to pins 2-5
    • /PIC16F615 - 1 sensor with UART
      Example project implementing oen CVD sensor on PIC12F615 with one-way UART communications out
    • /PIC16F615 - 2 sensors
      Example project implementing two CVD sensors on PIC12F615
    • /PIC16F1527 - 30 sensors
      Example project implementing the maximum number of supported sensors (30) on the PIC16F1527