Slider/Wheel Application Programming Interfaces (APIs)

Last modified by Microchip on 2026/03/26 07:46

MTOUCH_Slider_InitializeAll

void MTOUCH_Slider_InitializeAll(void)

Description: This function initializes all sliders.

Parameter: None

Return: None

MTOUCH_Slider_ServiceAll

void MTOUCH_Slider_ServiceAll(void)

Description: This function services all sliders.

Parameter: None

Return: None

MTOUCH_Slider_isInitialized

bool MTOUCH_Slider_isInitialized(enum mtouch_slider_names sliderName)

Description: This function checks whether the specified slider has been initialized and returns true if it is initialized or false otherwise.

Parameter: None

Return: bool

MTOUCH_Slider_isPressed

bool MTOUCH_Slider_isPressed(enum mtouch_slider_names sliderName)

Description: This function checks whether the specified slider is currently pressed and returns true if it is pressed or false otherwise.

Parameter: None

Return: bool

MTOUCH_Slider_isReburstRequest

bool MTOUCH_Slider_isReburstRequest(enum mtouch_slider_names sliderName);

Description: This function checks whether the specified slider has requested a reburst and returns true if a reburst is requested or false otherwise.

Parameter: None

Return: bool

MTOUCH_Slider_isPositionChanged

bool MTOUCH_Slider_isPositionChanged(enum mtouch_slider_names sliderName);

Description: This function checks whether the position of the specified slider has changed.

Parameter: None

Return: bool

MTOUCH_Slider_Status_Get

uint8_t MTOUCH_Slider_Status_Get(enum mtouch_slider_names sliderName);

Description: This function returns the current status of the specified slider.

Parameter:

Type Description
enum mtouch_slider_names sliderNameEnumerator for the configured slider names

Return: 

Type Description
uint8_tbit 0-1: indicate slider touch state (0 > initializing, 1: released 2: pressed)
bit 2: indicate if position is changed
bit 7: indicate if slider needs reburst 

MTOUCH_Slider_Position_Get

uint16_t MTOUCH_Slider_Position_Get(enum mtouch_slider_names sliderName);

Description: This function returns the current position value of the specified slider.

Parameter:

Type Description
enum mtouch_slider_names sliderNameEnumerator for the configured slider names

Return: uint16_t

MTOUCH_Slider_Threshold_Get

uint16_t MTOUCH_Slider_Threshold_Get(enum mtouch_slider_names sliderName);

Description: This function returns the threshold value configured for the specified slider.

Parameter:

Type Description
enum mtouch_slider_names sliderNameEnumerator for the configured slider names

Return: uint16_t

MTOUCH_Slider_Threshold_Set

uint8_t MTOUCH_Slider_Threshold_Set(enum mtouch_slider_names sliderName, uint16_t threshold);

Description: This function sets the threshold value for the specified slider.

Parameter:

Type Description
enum mtouch_slider_names sliderNameEnumerator for the configured slider names

Return: uint8_t

MTOUCH_Slider_Deviation_Get

uint16_t MTOUCH_Slider_Deviation_Get(enum mtouch_slider_names sliderName);

Description: This function returns the slider deviation.

Parameter:

Type Description
enum mtouch_slider_names sliderNameEnumerator for the configured slider names

Return: uint16_t

MTOUCH_Slider_GroupStatus_Get

uint8_t MTOUCH_Slider_GroupStatus_Get(void);

Description: This function returns the ORed status for all sliders.

Parameter:

Type Description
enum mtouch_slider_names sliderNameEnumerator for the configured slider names

Return: 

Type Description
uint8_tbit0-1: indicate slider touch state (0 > initializing, 1: released 2: pressed)
bit 2: indicate if position is changed
bit 7: indicate if slider needs reburst

MTOUCH_Slider_Reburst_Service

bool MTOUCH_Slider_Reburst_Service(void);

Description: This function processes any pending reburst requests.

Parameter: None

Return: bool

MTOUCH_Slider_SetPositionChangedCallback

void MTOUCH_Slider_SetPositionChangedCallback(void (*callback)(enum mtouch_slider_names));

Description: This function sets the callback function for slider position changed event.

Parameter: Pointer of the callback function

Return: None

MTOUCH_Slider_SetPressedCallback

void MTOUCH_Slider_SetPressedCallback(void (*callback)(enum mtouch_slider_names));

Description: This function sets the callback function for slider pressed event.

Parameter: Pointer to the callback function

Return: None

MTOUCH_Slider_SetReleasedCallback

void MTOUCH_Slider_SetReleasedCallback(void (*callback)(enum mtouch_slider_names));

Description: This function sets the callback function for slider released event.

Parameter: Pointer to the callback function

Return: None

Back to Top