Jump to main content

##

# 3.8.1 mcHalI_StartStopButtonState

## C

    /* Get start-stop button state */
    bool mcHalI_StartStopButtonState( void )

## Summary

Retrieve the state of the start-stop button.

## Description

This function is used to read the status of the start-stop button configured for motor control in the Harmony QSpin GUI.

## Precondition

None.

## Parameters

Param | Description
--- | ---
void | None.

## Returns

- True: Returns true if the button is pressed.
- False: Returns false if the button is not pressed.

## Example

    /* Get start-stop button state */
    mcHal_StartStopButtonState();

## Remarks

None.