Skip to content

Commit 21d3d5c

Browse files
ABOSTMfpistm
authored andcommitted
Add comment on refresh() function usage
By the way fixo typo in setPrescaleFactor() Fix #617
1 parent 026eb42 commit 21d3d5c

File tree

2 files changed

+6
-1
lines changed

2 files changed

+6
-1
lines changed

cores/arduino/HardwareTimer.cpp

+2
Original file line numberDiff line numberDiff line change
@@ -688,6 +688,8 @@ void HardwareTimer::detachInterrupt(uint32_t channel)
688688

689689
/**
690690
* @brief Generate an update event to force all registers (Autoreload, prescaler, compare) to be taken into account
691+
* @note Refresh() can only be called after a 1st call to resume() to be sure timer is initialised.
692+
* It is usefull while timer is running after some registers update
691693
* @retval None
692694
*/
693695
void HardwareTimer::refresh()

cores/arduino/HardwareTimer.h

+4-1
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,7 @@ class HardwareTimer {
9393
void pause(void); // Pause counter and all output channels
9494
void resume(void); // Resume counter and all output channels
9595

96-
void setPrescaleFactor(uint32_t format = TICK_FORMAT); // set prescaler register (which is factor value - 1)
96+
void setPrescaleFactor(uint32_t prescaler); // set prescaler register (which is factor value - 1)
9797
uint32_t getPrescaleFactor();
9898

9999
void setOverflow(uint32_t val, TimerFormat_t format = TICK_FORMAT); // set AutoReload register depending on format provided
@@ -122,8 +122,11 @@ class HardwareTimer {
122122

123123
void timerHandleDeinit(); // Timer deinitialization
124124

125+
// Refresh() can only be called after a 1st call to resume() to be sure timer is initialised.
126+
// It is usefull while timer is running after some registers update
125127
void refresh(void); // Generate update event to force all registers (Autoreload, prescaler, compare) to be taken into account
126128

129+
127130
uint32_t getTimerClkFreq(); // return timer clock frequency in Hz.
128131

129132
static void captureCompareCallback(TIM_HandleTypeDef *htim); // Generic Caputre and Compare callback which will call user callback

0 commit comments

Comments
 (0)