Component: Timer Free (Timing) - Revision history

Wiki bot at 13:13, 7 February 2023

2023-02-07T13:13:14Z

Wiki bot at 12:22, 3 February 2023

2023-02-03T12:22:19Z

Wiki bot at 12:03, 3 February 2023

2023-02-03T12:03:33Z

Show changes

Wiki bot at 11:52, 3 February 2023

2023-02-03T11:52:46Z

Wiki bot at 16:50, 30 January 2023

2023-01-30T16:50:38Z

Show changes

Wiki bot at 10:00, 27 January 2023

2023-01-27T10:00:27Z

Show changes

Wiki bot at 15:25, 20 January 2023

2023-01-20T15:25:04Z

Show changes

Wiki bot at 15:17, 20 January 2023

2023-01-20T15:17:30Z

Show changes

Wiki bot at 14:13, 20 January 2023

2023-01-20T14:13:48Z

Wiki bot: Created page with "{| style="width:50%" |- | width="20%" style="color:gray;" | Author | Matrix TSL |- | width="20%" style="color:gray;" | Version | 1.1 |- | width="20%" style="color:gray..."

2023-01-16T14:43:21Z

Created page with "{| style="width:50%" |- | width="20%" style="color:gray;" | Author | Matrix TSL |- | width="20%" style="color:gray;" | Version | 1.1 |- | width="20%" style="color:gray..."

New page

{| style="width:50%"
|-
| width="20%" style="color:gray;" | Author
| Matrix TSL
|-
| width="20%" style="color:gray;" | Version
| 1.1
|-
| width="20%" style="color:gray;" | Category
| Timing
|}

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

==Component Source Code==

Please click here for the component source code: [https://www.flowcode.co.uk/wikicopy/componentsource/FC_Comp_Source_TimerComponentFree.fcfx FC_Comp_Source_TimerComponentFree.fcfx]

==Detailed description==

''No detailed description exists yet for this component''

==Examples==

Here is a basic example showing the operation of the timer component used to time a section of code or the duration of a specific event.

{{Fcfile|TimerExample.fcfx|Timer Example}}

==Downloadable macro reference==

{| 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'''
|-
| colspan="2" | Returns the count value as a number of whole seconds, rounded down to the nearest second 
|-
|-
| 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''
|}

{| 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'''
|-
| colspan="2" | Starts the timer counting. 
|-
|-
| 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 
|-
| 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''
|}

{| 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;" | '''GetCountString'''
|-
| colspan="2" | Returns the count value as a floating point string in seconds. 
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Precision
|-
| colspan="2" | Number of decimal places to display in string 
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-string-icon.png]] - STRING
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}

{| 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;" | '''GetCountMicroSeconds'''
|-
| colspan="2" | Returns the count value as a number of whole microseconds, rounded down to the nearest microsecond 
|-
|-
| 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''
|}

{| 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'''
|-
| colspan="2" | Returns the count value as a number of whole milliseconds, rounded down to the nearest millisecond 
|-
|-
| 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''
|}

{| 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. 
|-
|-
| 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''
|}

{| 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;" | '''ResetCounter'''
|-
| colspan="2" |  
|-
|-
| 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''
|}

{| 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'''
|-
| colspan="2" | Returns the count value as a floating point value in seconds. 
|-
|-
| 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''
|}

{| 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'''
|-
| colspan="2" |  
|-
|-
| 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''
|}

==Property reference==

{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
|-
| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-prop-icon.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Properties'''
|-
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | Timer
|-
| colspan="2" | Timer Peripheral to use to monitor the passage of time. 
|-
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
| width="90%" | Bit Depth
|-
| colspan="2" | Number of bits in the timer peripheral. 8-bit timers can count from 0-255 before overflowing. 16-bit timers can count from 0 to 65535 before overflowing. 
|-
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
| width="90%" | Instruction Rate
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
| width="90%" | Rollover Frequency
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
| width="90%" | Rollover Time
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
| width="90%" | Max Time Measurement
|-
| colspan="2" | Max time in seconds that we can measure before rolling over and starting again. 
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Simulation
|-
|-
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
| width="90%" | Timer Delay (ms)
|-
| colspan="2" | 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. 
|-
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
| width="90%" | Decimal Points
|-
| colspan="2" |  
|}

@@ 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_temp/TimerComponentFree.fcfx FC_Comp_Source_temp/TimerComponentFree.fcfx]
+Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_TimerComponentFree.fcfx FC_Comp_Source_TimerComponentFree.fcfx]
-Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_temp/TimerComponentFree.fcfx FC_Comp_Source_temp/TimerComponentFree.fcfx]
+Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_TimerComponentFree.fcfx FC_Comp_Source_TimerComponentFree.fcfx]
 ==Detailed description==
@@ Line 84: / Line 84: @@
 {{Fcfile|TimerExample.fcfx|Timer Example}}

@@ Line 84: / Line 84: @@
 {{Fcfile|TimerExample.fcfx|Timer Example}}
@@ Line 89: / Line 91: @@
 ==Macro reference==
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
@@ Line 102: / Line 105: @@
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
@@ Line 120: / Line 124: @@
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
@@ Line 138: / Line 143: @@
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
@@ Line 151: / Line 157: @@
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
@@ Line 164: / Line 171: @@
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
@@ Line 177: / Line 185: @@
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
@@ Line 190: / Line 199: @@
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
@@ Line 203: / Line 213: @@
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-

@@ Line 20: / Line 20: @@
 ==Detailed description==
@@ Line 40: / Line 42: @@
 ==Examples==
@@ Line 63: / Line 67: @@
 {{Fcfile|TimerExample.fcfx|Timer Example}}
-==Downloadable macro reference==
+==Macro reference==
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"