Persons liking mTouch® Capacitive Sensing Library Module API
Last modified by Microchip on 2023/11/10 11:18
Menu
On This Page
- Sensor Module
- Public Types
- Properties
- Public Functions
- enum mtouch_sensor_error MTOUCH_Sensor_Initialize(enum mtouch_sensor_names sensor)
- void MTOUCH_Sensor_InitializeAll(void)
- void MTOUCH_Sensor_Scan_Initialize(void)
- Example
- void MTOUCH_Sensor_ADCC_Initialize(void)
- void MTOUCH_Sensor_SetSampledCallback(void (*callback)(enum mtouch_sensor_names sensor))
- Example
- bool MTOUCH_Sensor_SampleAll(void)
- bool MTOUCH_Sensor_isSampling(void)
- Example
- bool MTOUCH_Sensor_isActive(enum mtouch_sensor_names sensor)
- Example
- bool MTOUCH_Sensor_wasSampled(enum mtouch_sensor_names sensor)
- bool MTOUCH_Sensor_isCalibrated(enum mtouch_sensor_names sensor)
- bool MTOUCH_Sensor_isEnabled(enum mtouch_sensor_names sensor)
- void MTOUCH_Sensor_Sampled_ResetAll(void)
- Example
- void MTOUCH_Sensor_Disable (enum mtouch_sensor_names sensor)
- void MTOUCH_Sensor_Enable (enum mtouch_sensor_names sensor)
- void MTOUCH_Sensor_Calibrate (enum mtouch_sensor_names sensor)
- mtouch_sensor_sample_t MTOUCH_Sensor_RawSample_Get(enum mtouch_sensor_names sensor)
- Button Module
- Public Types
- Properties
- Public Functions
- void MTOUCH_Button_Initialize(enum mtouch_button_names button)
- void MTOUCH_Button_InitializeAll(void)
- void MTOUCH_Button_ServiceAll(void)
- void MTOUCH_Button_Tick(void)
- void MTOUCH_Button_SetPressedCallback(void (*callback)(enum mtouch_button_names button))
- void MTOUCH_Button_SetNotPressedCallback(void (*callback)(enum mtouch_button_names button))
- Example
- void MTOUCH_Button_Reburst_Request(enum mtouch_button_names button)
- bool MTOUCH_Button_Reburst_Service(void);
- bool MTOUCH_Button_isPressed(enum mtouch_button_names button)
- Example
- bool MTOUCH_Button_isInitialized(enum mtouch_button_names button)
- mtouch_buttonmask_t MTOUCH_Button_Buttonmask_Get(void)
- mtouch_button_deviation_t MTOUCH_Button_Deviation_Get(enum mtouch_button_names button)
- mtouch_button_reading_t MTOUCH_Button_Reading_Get(enum mtouch_button_names button)
- mtouch_button_reading_t MTOUCH_Button_Baseline_Get(enum mtouch_button_names button)
- mtouch_button_scaling_t MTOUCH_Button_Scaling_Get(enum mtouch_button_names button)
- mtouch_button_threshold_t MTOUCH_Button_Threshold_Get(enum mtouch_button_names button)
- void MTOUCH_Button_Scaling_Set(enum mtouch_button_names button,mtouch_button_scaling_t scaling)
- void MTOUCH_Button_Threshold_Set(enum mtouch_button_names button,mtouch_button_threshold_t threshold)
- void MTOUCH_Button_Disable(enum mtouch_button_names button)
- void MTOUCH_Button_Suspend(enum mtouch_button_names button)
- void MTOUCH_Button_Resume(enum mtouch_button_names button)
- Proximity Sensor Module
- Public Types
- Properties
- Public Functions
- void MTOUCH_Proximity_Initialize(enum mtouch_proximity_names prox)
- void MTOUCH_Proximity_InitializeAll(void)
- void MTOUCH_Proximity_ServiceAll(void)
- void MTOUCH_Proximity_Tick(void)
- void MTOUCH_Proximity_SetActivatedCallback(void (*callback)(enum mtouch_proximity_names prox))
- void MTOUCH_Proximity_SetNotActivatedCallback(void (*callback)(enum mtouch_proximity_names prox))
- Example
- void MTOUCH_Proximity_Reburst_Request(enum mtouch_proximity_names prox)
- bool MTOUCH_Proximity_Reburst_Service(void);
- bool MTOUCH_Proximity_isActivated(enum mtouch_proximity_names prox)
- bool MTOUCH_Proximity_isInitialized(enum mtouch_proximity_names prox)
- mtouch_proxmask_t MTOUCH_Proximity_Proximitymask_Get(void)
- mtouch_prox_deviation_t MTOUCH_Proximity_Deviation_Get(enum mtouch_proximity_names prox)
- mtouch_prox_reading_t MTOUCH_Proximity_Reading_Get(enum mtouch_proximity_names prox)
- mtouch_prox_reading_t MTOUCH_Proximity_Baseline_Get(enum mtouch_proximity_names prox)
- mtouch_prox_scaling_t MTOUCH_Proximity_Scaling_Get(enum mtouch_proximity_names prox)
- mtouch_prox_threshold_t MTOUCH_Proximity_Threshold_Get(enum mtouch_proximity_names prox)
- void MTOUCH_Proximity_Scaling_Set(enum mtouch_proximity_names prox,mtouch_prox_scaling_t scaling)
- void MTOUCH_Proximity_Threshold_Set(enum mtouch_proximity_names prox,mtouch_prox_threshold_t threshold)
- void MTOUCH_Proximity_Disable(enum mtouch_proximity_names prox)
- void MTOUCH_Proximity_Suspend(enum mtouch_proximity_names prox)
- void MTOUCH_Proximity_Resume(enum mtouch_proximity_names prox)
- Slider/Wheel Module
- Public Types
- enum mtouch_slider_names {Sliderxx,…}
- Properties
- Public Functions
- void MTOUCH_Slider_InitializeAll(void)
- void MTOUCH_Proximity_ServiceAll(void)
- bool MTOUCH_Slider_isInitialized(enum mtouch_slider_names sliderName
- uint8_t MTOUCH_Slider_Status_Get(void)
- bool MTOUCH_Slider_isPressed(enum mtouch_slider_names sliderName)
- bool MTOUCH_Slider_isReburstRequest(enum mtouch_slider_names sliderName)
- bool MTOUCH_Slider_Reburst_Service()
- bool MTOUCH_Slider_isPositionChanged(enum mtouch_slider_names sliderName)
- uint16_t MTOUCH_Slider_Position_Get(enum mtouch_slider_names sliderName)
- Example
- uint16_t MTOUCH_Slider_Threshold_Get(enum mtouch_slider_names sliderName)
- uint16_t MTOUCH_Slider_Deviation_Get(enum mtouch_slider_names sliderName)
- void MTOUCH_Slider_SetPositionChangedCallback(void (*callback)(enum mtouch_slider_names))
- Example
- void MTOUCH_Slider_SetPositionChangedCallback(void (*callback)(enum mtouch_slider_names))
- void MTOUCH_Slider_SetPressedCallback(void (*callback)(enum mtouch_slider_names))
- void MTOUCH_Slider_SetReleasedCallback(void (*callback)(enum mtouch_slider_names))
- Surface Module
- Public Functions
- void MTOUCH_Surface_InitializeAll(void)
- void MTOUCH_Surface_ServiceAll(void)
- uint8_t MTOUCH_Surface_Status_Get(void)
- uint8_t MTOUCH_Surface_Contact_Status_Get(uint8_t contact)
- uint16_t MTOUCH_Surface_Position_Get(uint8_t ver_or_hor)
- Example
- uint16_t MTOUCH_Surface_Position_Get(uint8_t ver_or_hor, uint8_t contact)
- uint8_t MTOUCH_Surface_Resolution_Get(void)
- uint8_t MTOUCH_Surface_Resolution_Get(void)
- uint8_t MTOUCH_Surface_Deadband_Get(void)
- uint8_t MTOUCH_Surface_Deadband_Set(void)
- Public Functions
- Surface Gesture Module
- Public Functions
- void MTOUCH_Gesture_Initialize(void)
- void MTOUCH_Gesture_Service(void)
- bool MTOUCH_Gesture_isGestureDetected(void)
- void MTOUCH_Gesture_clearGesture(void)
- uint8_t MTOUCH_Gesture_GestureID_Get(void)
- uint8_t MTOUCH_Gesture_GestureValue_Get(void)
- Example
- void MTOUCH_Gesture_update_timer(uint16_t time_elapsed_since_update)
- uint8_t MTOUCH_Gesture_GestureConfigAddress_Get(void)
- Public Functions
- Host Interface Module
- Low Power Module
Microchip Support
Query Microchip Forums and get your questions answered by our community:
Microchip Forums
AVR Freaks Forums
If you need to work with Microchip Support staff directly, you can submit a technical support case. Keep in mind that many questions can be answered through our self-help resources, so this may not be your speediest option.