Difference between revisions of "Component: STM32 Timer (Timing)"

Revision as of 12:03, 3 February 2023

Author	Matrix TSL
Version	1.1
Category	Timing

STM32 Timer component

Allows you to measure the passage of time via the use of the STM hardware timer. Works like a stopwatch with macros to start, stop and reset the timer counter. Returns time as integer Seconds, Milliseconds and also Floating Point and String.

Component Source Code

Please click here to download the component source project: FC_Comp_Source_temp/TimerComponentSTM32.fcfx

Please click here to view the component source code (Beta): FC_Comp_Source_temp/TimerComponentSTM32.fcfx

Detailed description

No detailed description exists yet for this component

Examples

No additional examples

Macro reference

GetCountMilliseconds

	GetCountMilliseconds
Returns the count value as a number of milliseconds
- ULONG	Return

GetCountReal

	GetCountReal
Returns the count value as a floating point value in seconds.
- FLOAT	Return

GetCountSeconds

	GetCountSeconds
Returns the count value as a number of whole seconds, rounded down to the nearest second
- ULONG	Return

GetCountString

	GetCountString
Returns the count value as a floating point string in seconds.
- BYTE	Precision
Number of decimal places to display in string
- STRING	Return

GetRawCount

	GetRawCount
Returns the number of milliseconds elapsed since the timer was started.
- ULONG	Return

ResetCounter

	ResetCounter

- VOID	Return

StartCounter

	StartCounter
Starts the timer counting.
- BOOL	ResetCounters
Range: 0-1 where 0=Do Not Reset and 1=Reset
- VOID	Return

StopCounter

	StopCounter
Stops the timer counting.
- VOID	Return

Property reference

	Properties
	Simulation
	Timer Delay (ms)
Number of milliseconds between timer events which increment the simulated timer counter variable. 10ms will yield the highest resolution. Values less than this will likely just increase the error and making the timer run slow. Higher delays will yield greater accuracy.
	Decimal Points

@@ Line 17: / Line 17: @@
 ==Component Source Code==
-Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_TimerComponentSTM32.fcfx FC_Comp_Source_TimerComponentSTM32.fcfx]
+Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_temp/TimerComponentSTM32.fcfx FC_Comp_Source_temp/TimerComponentSTM32.fcfx]
-Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_TimerComponentSTM32.fcfx FC_Comp_Source_TimerComponentSTM32.fcfx]
+Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_temp/TimerComponentSTM32.fcfx FC_Comp_Source_temp/TimerComponentSTM32.fcfx]
 ==Detailed description==
@@ Line 77: / Line 77: @@
 ''<span style="color:red;">No additional examples</span>''
@@ Line 85: / Line 87: @@
 ==Macro reference==
-===GetCountSeconds===
+===GetCountMilliseconds===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
 | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetCountSeconds'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetCountMilliseconds'''
 |-
-| colspan="2" | Returns the count value as a number of whole seconds, rounded down to the nearest second&nbsp;
+| colspan="2" | Returns the count value as a number of milliseconds&nbsp;
 |-
 |-
@@ Line 99: / Line 101: @@
-===StartCounter===
+===GetCountReal===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
 | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''StartCounter'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetCountReal'''
+|-
+| colspan="2" | Returns the count value as a floating point value in seconds.&nbsp;
+|-
 |-
-| colspan="2" | Starts the timer counting.&nbsp;
+| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-f32-icon.png]] - FLOAT
+| width="90%" style="border-top: 2px solid #000;" | ''Return''
+|}
+===GetCountSeconds===
+{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
+| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetCountSeconds'''
 |-
-| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
+| colspan="2" | Returns the count value as a number of whole seconds, rounded down to the nearest second&nbsp;
-| width="90%" | ResetCounters
 |-
-| colspan="2" | Range: 0-1 where 0=Do Not Reset and 1=Reset&nbsp;
 |-
-| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
+| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u32-icon.png]] - ULONG
 | width="90%" style="border-top: 2px solid #000;" | ''Return''
 |}
@@ Line 137: / Line 148: @@
-===GetCountMilliseconds===
+===GetRawCount===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
 | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetCountMilliseconds'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetRawCount'''
 |-
-| colspan="2" | Returns the count value as a number of milliseconds&nbsp;
+| colspan="2" | Returns the number of milliseconds elapsed since the timer was started.&nbsp;
 |-
 |-
 | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u32-icon.png]] - ULONG
-| width="90%" style="border-top: 2px solid #000;" | ''Return''
-|}
-===StopCounter===
-{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
-|-
-| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''StopCounter'''
-|-
-| colspan="2" | Stops the timer counting.&nbsp;
-|-
-|-
-| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
 | width="90%" style="border-top: 2px solid #000;" | ''Return''
 |}
@@ Line 179: / Line 176: @@
-===GetCountReal===
+===StartCounter===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
 | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetCountReal'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''StartCounter'''
+|-
+| colspan="2" | Starts the timer counting.&nbsp;
+|-
 |-
-| colspan="2" | Returns the count value as a floating point value in seconds.&nbsp;
+| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
+| width="90%" | ResetCounters
 |-
+| colspan="2" | Range: 0-1 where 0=Do Not Reset and 1=Reset&nbsp;
 |-
-| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-f32-icon.png]] - FLOAT
+| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
 | width="90%" style="border-top: 2px solid #000;" | ''Return''
 |}
-===GetRawCount===
+===StopCounter===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
 | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetRawCount'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''StopCounter'''
 |-
-| colspan="2" | Returns the number of milliseconds elapsed since the timer was started.&nbsp;
+| colspan="2" | Stops the timer counting.&nbsp;
 |-
 |-
-| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u32-icon.png]] - ULONG
+| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
 | width="90%" style="border-top: 2px solid #000;" | ''Return''
 |}