|
1 | 1 | ####################################### |
2 | | -# Syntax Coloring Map For AccelStepper |
| 2 | +# Syntax Coloring Map For FastAccelStepper |
3 | 3 | ####################################### |
4 | 4 |
|
5 | 5 | ####################################### |
6 | 6 | # Datatypes (KEYWORD1) |
7 | 7 | ####################################### |
8 | 8 |
|
9 | 9 | FastAccelStepper KEYWORD1 |
10 | | -Speed KEYWORD1 |
11 | | -Acceleration KEYWORD1 |
| 10 | +FastAccelStepperEngine KEYWORD1 |
12 | 11 |
|
13 | 12 | ####################################### |
14 | 13 | # Methods and Functions (KEYWORD2) |
15 | 14 | ####################################### |
16 | 15 |
|
17 | | -disableOutputs KEYWORD2 |
18 | | -enableOutputs KEYWORD2 |
| 16 | +# FastAccelStepperEngine |
| 17 | +init KEYWORD2 |
| 18 | +stepperConnectToPin KEYWORD2 |
| 19 | +setExternalCallForPin KEYWORD2 |
| 20 | +setDebugLed KEYWORD2 |
| 21 | +manageSteppers KEYWORD2 |
| 22 | +task_rate KEYWORD2 |
| 23 | +initI2sMux KEYWORD2 |
| 24 | +i2sMuxSetBit KEYWORD2 |
| 25 | +i2sMuxGetBit KEYWORD2 |
| 26 | + |
| 27 | +# FastAccelStepper - Pin configuration |
| 28 | +getStepPin KEYWORD2 |
| 29 | +setDirectionPin KEYWORD2 |
| 30 | +getDirectionPin KEYWORD2 |
| 31 | +directionPinHighCountsUp KEYWORD2 |
19 | 32 | setEnablePin KEYWORD2 |
| 33 | +getEnablePinHighActive KEYWORD2 |
| 34 | +getEnablePinLowActive KEYWORD2 |
| 35 | +enableOutputs KEYWORD2 |
| 36 | +disableOutputs KEYWORD2 |
| 37 | +setAutoEnable KEYWORD2 |
| 38 | +setDelayToEnable KEYWORD2 |
| 39 | +setDelayToDisable KEYWORD2 |
| 40 | + |
| 41 | +# FastAccelStepper - Position |
| 42 | +getCurrentPosition KEYWORD2 |
| 43 | +setCurrentPosition KEYWORD2 |
| 44 | + |
| 45 | +# FastAccelStepper - Status |
| 46 | +isRunning KEYWORD2 |
| 47 | +rampState KEYWORD2 |
| 48 | +isRampGeneratorActive KEYWORD2 |
| 49 | + |
| 50 | +# FastAccelStepper - Speed |
| 51 | +getMaxSpeedInUs KEYWORD2 |
| 52 | +getMaxSpeedInTicks KEYWORD2 |
| 53 | +getMaxSpeedInHz KEYWORD2 |
| 54 | +getMaxSpeedInMilliHz KEYWORD2 |
| 55 | +setAbsoluteSpeedLimit KEYWORD2 |
| 56 | +setSpeedInUs KEYWORD2 |
| 57 | +setSpeedInTicks KEYWORD2 |
| 58 | +setSpeedInHz KEYWORD2 |
| 59 | +setSpeedInMilliHz KEYWORD2 |
| 60 | +getSpeedInUs KEYWORD2 |
| 61 | +getSpeedInTicks KEYWORD2 |
| 62 | +getSpeedInMilliHz KEYWORD2 |
| 63 | +getCurrentSpeedInUs KEYWORD2 |
| 64 | +getCurrentSpeedInMilliHz KEYWORD2 |
| 65 | + |
| 66 | +# FastAccelStepper - Acceleration |
| 67 | +setAcceleration KEYWORD2 |
| 68 | +getAcceleration KEYWORD2 |
| 69 | +getCurrentAcceleration KEYWORD2 |
| 70 | +setLinearAcceleration KEYWORD2 |
| 71 | +setJumpStart KEYWORD2 |
| 72 | +applySpeedAcceleration KEYWORD2 |
| 73 | + |
| 74 | +# FastAccelStepper - Move commands |
| 75 | +move KEYWORD2 |
| 76 | +moveTo KEYWORD2 |
| 77 | +keepRunning KEYWORD2 |
| 78 | +isRunningContinuously KEYWORD2 |
| 79 | +runForward KEYWORD2 |
| 80 | +runBackward KEYWORD2 |
| 81 | +forwardStep KEYWORD2 |
| 82 | +backwardStep KEYWORD2 |
| 83 | +moveByAcceleration KEYWORD2 |
| 84 | +stopMove KEYWORD2 |
| 85 | +isStopping KEYWORD2 |
| 86 | +stepsToStop KEYWORD2 |
| 87 | +forceStop KEYWORD2 |
| 88 | +forceStopAndNewPosition KEYWORD2 |
| 89 | +targetPos KEYWORD2 |
| 90 | + |
| 91 | +# FastAccelStepper - Task planning |
| 92 | +setForwardPlanningTimeInMs KEYWORD2 |
| 93 | + |
| 94 | +# FastAccelStepper - Timed moves |
| 95 | +moveTimed KEYWORD2 |
| 96 | + |
| 97 | +# FastAccelStepper - Low level queue |
| 98 | +addQueueEntry KEYWORD2 |
| 99 | +isQueueEmpty KEYWORD2 |
| 100 | +isQueueFull KEYWORD2 |
| 101 | +isQueueRunning KEYWORD2 |
| 102 | +ticksInQueue KEYWORD2 |
| 103 | +hasTicksInQueue KEYWORD2 |
| 104 | +queueEntries KEYWORD2 |
| 105 | +getPositionAfterCommandsCompleted KEYWORD2 |
| 106 | +getPeriodInUsAfterCommandsCompleted KEYWORD2 |
| 107 | +getPeriodInTicksAfterCommandsCompleted KEYWORD2 |
| 108 | +setPositionAfterCommandsCompleted KEYWORD2 |
| 109 | + |
| 110 | +# FastAccelStepper - Pin detach/attach |
| 111 | +detachFromPin KEYWORD2 |
| 112 | +reAttachToPin KEYWORD2 |
| 113 | + |
| 114 | +# FastAccelStepper - ESP32 pulse counter |
| 115 | +attachToPulseCounter KEYWORD2 |
| 116 | +readPulseCounter KEYWORD2 |
| 117 | +clearPulseCounter KEYWORD2 |
| 118 | +pulseCounterAttached KEYWORD2 |
| 119 | + |
| 120 | +# FastAccelStepper - ESP32 driver type |
| 121 | +driverType KEYWORD2 |
| 122 | +driverTypeString KEYWORD2 |
20 | 123 |
|
21 | 124 | ####################################### |
22 | 125 | # Constants (LITERAL1) |
23 | 126 | ####################################### |
24 | | - |
| 127 | + |
| 128 | +# Pin constants |
| 129 | +PIN_UNDEFINED LITERAL1 |
| 130 | +PIN_EXTERNAL_FLAG LITERAL1 |
| 131 | +MAX_ON_DELAY_TICKS LITERAL1 |
| 132 | + |
| 133 | +# Ramp state constants |
| 134 | +RAMP_STATE_IDLE LITERAL1 |
| 135 | +RAMP_STATE_COAST LITERAL1 |
| 136 | +RAMP_STATE_ACCELERATE LITERAL1 |
| 137 | +RAMP_STATE_DECELERATE LITERAL1 |
| 138 | +RAMP_STATE_REVERSE LITERAL1 |
| 139 | +RAMP_STATE_ACCELERATING_FLAG LITERAL1 |
| 140 | +RAMP_STATE_DECELERATING_FLAG LITERAL1 |
| 141 | +RAMP_DIRECTION_COUNT_UP LITERAL1 |
| 142 | +RAMP_DIRECTION_COUNT_DOWN LITERAL1 |
| 143 | +RAMP_DIRECTION_MASK LITERAL1 |
| 144 | +RAMP_STATE_MASK LITERAL1 |
| 145 | + |
| 146 | +# Move result codes |
| 147 | +MOVE_OK LITERAL1 |
| 148 | +MOVE_ERR_NO_DIRECTION_PIN LITERAL1 |
| 149 | +MOVE_ERR_SPEED_IS_UNDEFINED LITERAL1 |
| 150 | +MOVE_ERR_ACCELERATION_IS_UNDEFINED LITERAL1 |
| 151 | + |
| 152 | +# MoveTimed result codes |
| 153 | +MOVE_TIMED_OK LITERAL1 |
| 154 | +MOVE_TIMED_BUSY LITERAL1 |
| 155 | +MOVE_TIMED_EMPTY LITERAL1 |
| 156 | +MOVE_TIMED_TOO_LARGE_ERROR LITERAL1 |
| 157 | + |
| 158 | +# AddQueueEntry result codes |
| 159 | +AQE_OK LITERAL1 |
| 160 | +AQE_QUEUE_FULL LITERAL1 |
| 161 | +AQE_DIR_PIN_IS_BUSY LITERAL1 |
| 162 | +AQE_DIR_PIN_2MS_PAUSE_ADDED LITERAL1 |
| 163 | +AQE_WAIT_FOR_ENABLE_PIN_ACTIVE LITERAL1 |
| 164 | +AQE_DEVICE_NOT_READY LITERAL1 |
| 165 | +AQE_ERROR_TICKS_TOO_LOW LITERAL1 |
| 166 | +AQE_ERROR_EMPTY_QUEUE_TO_START LITERAL1 |
| 167 | +AQE_ERROR_NO_DIR_PIN_TO_TOGGLE LITERAL1 |
| 168 | + |
| 169 | +# Delay result codes |
| 170 | +DELAY_OK LITERAL1 |
| 171 | +DELAY_TOO_LOW LITERAL1 |
| 172 | +DELAY_TOO_HIGH LITERAL1 |
| 173 | + |
| 174 | +# Driver type constants |
| 175 | +DRIVER_MCPWM_PCNT LITERAL1 |
| 176 | +DRIVER_RMT LITERAL1 |
| 177 | +DRIVER_I2S_DIRECT LITERAL1 |
| 178 | +DRIVER_I2S_MUX LITERAL1 |
| 179 | +DRIVER_DONT_CARE LITERAL1 |
0 commit comments