Difference between revisions of "Component: Timed Interval (Storage)"

From Flowcode Help
Jump to navigationJump to search
(XML import)
 
 
(One intermediate revision by the same user not shown)
Line 1: Line 1:
−
 
+
{| style="width:50%"
−
 
 
−
{| width="50%"
 
 
|-
 
|-
−
| width="20%" style="color: gray;" | Author
+
| width="20%" style="color:gray;" | Author
 
| Matrix TSL
 
| Matrix TSL
 
|-
 
|-
−
| width="20%" style="color: gray;" | Version
+
| width="20%" style="color:gray;" | Version
−
| 1.1 (Release)
+
| 1.1
 
|-
 
|-
−
| width="20%" style="color: gray;" | Category
+
| width="20%" style="color:gray;" | Category
 
| Storage
 
| Storage
 
|}
 
|}
  
  
 +
==Timed Interval component==
 +
Allows you to setup a specific timed interval via the use of a hardware timer peripheral. Useful for regular time accurate periodic polling and sampling.
  
−
==[[File:Component Icon d7633558_54a4_47ff_8c00_95170632c57e.png|Image]] Timed Interval component==
+
==Component Pack==
−
Allows you to setup a specific timed interval via the use of a hardware timer peripheral.
 
−
Useful for regular time accurate periodic polling and sampling.
 
  
−
==Examples==
+
STORAGE
−
''<span style="color:red;">No additional examples</span>''
 
  
 +
==Detailed description==
  
−
==Downloadable macro reference==
 
  
−
===<span style="font-weight: normal;"><u><tt>StartTimerInterval</tt></u></span>===
 
−
Starts the timer interval.
 
  
−
'''Parameters'''
+
''No detailed description exists yet for this component''
  
−
:''This macro has no parameters''
+
==Examples==
  
  
−
'''Return value'''
 
  
−
:''This call does not return a value''
 
  
 +
''<span style="color:red;">No additional examples</span>''
  
−
===<span style="font-weight: normal;"><u><tt>StopTimerInterval</tt></u></span>===
 
−
Stops the timer interval.
 
  
−
'''Parameters'''
+
==Downloadable macro reference==
  
−
:''This macro has no parameters''
+
{| 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;" | '''StartTimerInterval'''
 +
|-
 +
| colspan="2" | Starts the timer interval.&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''
 +
|}
  
  
−
'''Return value'''
+
{| 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;" | '''StopTimerInterval'''
 +
|-
 +
| colspan="2" | Stops the timer interval.&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''
 +
|}
  
−
:''This call does not return a value''
 
  
−
 
−
 
−
==Simulation macro reference==
 
−
 
−
''This component does not contain any simulation macros''
 
  
  
 
==Property reference==
 
==Property reference==
−
<span style="font-weight: normal;"><u>Time Unit</u></span>
 
  
−
This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''TimeUnit''.
+
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
−
 
+
|-
−
Unit of time used for the time period.
+
| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-prop-icon.png]]
−
 
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Properties'''  
−
For example you might want every 4 milliseconds or every 3 hours.
+
|-
−
 
+
|-
−
<span style="font-weight: normal;"><u>Time Period</u></span>
+
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
−
 
+
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Interval Properties
−
This property is of type ''Unsigned integer'' and can be referenced with the variable name ''TimePeriod''.
+
|-
−
 
+
|-
−
Value of time used for the time period.
+
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
−
 
+
| width="90%" | Time Unit
−
For example you might want every 4 milliseconds or every 3 hours.
+
|-
−
 
+
| colspan="2" | Unit of time used for the time period. For example you might want every 4 milliseconds or every 3 hours.&nbsp;
−
<span style="font-weight: normal;"><u>Estimated Best Period</u></span>
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
−
This property is of type ''Floating point'' and can be referenced with the variable name ''EstBestPeriod''.
+
| width="90%" | Time Period
−
 
+
|-
−
The closest we can get to the required time period based on prescaler and postscaler settings.
+
| colspan="2" | Value of time used for the time period. For example you might want every 4 milliseconds or every 3 hours.&nbsp;
−
 
+
|-
−
Smaller scalers provide finer resolution but impose limits on the maximum delay.
+
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
−
 
+
| width="90%" | Estimated Best Period
−
<span style="font-weight: normal;"><u>Max Time Measurement</u></span>
+
|-
−
 
+
| colspan="2" | The closest we can get to the required time period based on prescaler and postscaler settings. Smaller scalers provide finer resolution but impose limits on the maximum delay.&nbsp;
−
This property is of type ''Floating point'' and can be referenced with the variable name ''MaxTimeMeasurement''.
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
−
The maximum time we can do based on the current timer and scaler settings.
+
| width="90%" | Max Time Measurement
−
 
+
|-
−
<span style="font-weight: normal;"><u>Callback Macro</u></span>
+
| colspan="2" | The maximum time we can do based on the current timer and scaler settings.&nbsp;
−
 
+
|-
−
This property is of type ''Macro call'' and can be referenced with the variable name ''CallbackMacro''.
+
| width="10%" align="center" | [[File:Fc9-type-22-icon.png]]
−
 
+
| width="90%" | Callback Macro
−
User defined macro automatically called on a periodic basis.
+
|-
−
 
+
| colspan="2" | User defined macro automatically called on a periodic basis.&nbsp;
−
<span style="font-weight: normal;"><u>Timer</u></span>
+
|-
−
 
+
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
−
This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''Timer''.
+
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Timer Properties
−
 
+
|-
−
Timer Peripheral to use to monitor the passage of time.
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
−
<span style="font-weight: normal;"><u>Bit Depth</u></span>
+
| width="90%" | Timer
−
 
+
|-
−
This property is of type ''Unsigned integer'' and can be referenced with the variable name ''BitDepth''.
+
| colspan="2" | Timer Peripheral to use to monitor the passage of time.&nbsp;
−
 
+
|-
−
Number of bits in the timer peripheral.
+
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
−
 
+
| width="90%" | Bit Depth
−
8-bit timers can count from 0-255 before overflowing.
+
|-
−
 
+
| 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.&nbsp;
−
16-bit timers can count from 0 to 65535 before overflowing.
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
−
<span style="font-weight: normal;"><u>Prescaler</u></span>
+
| width="90%" | Prescaler
−
 
+
|-
−
This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''PrescalerFilter''.
+
| colspan="2" | Scaler applied to the timer, Small scalers allow for finer resolution but will limit the max time and also put more load on the microcontroller. Recommended to use as large a setting as possible which still provides enough accuracy. &nbsp;
−
 
+
|-
−
Scaler applied to the timer,
+
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
−
 
+
| width="90%" | PostScaler
−
Small scalers allow for finer resolution but will limit the max time and also put more load on the microcontroller.
+
|-
−
 
+
| colspan="2" | Scaler applied to the timer, Small scalers allow for finer resolution but will limit the max time and also put more load on the microcontroller. Recommended to use as large a setting as possible which still provides enough accuracy. &nbsp;
−
Recommended to use as large a setting as possible which still provides enough accuracy.
+
|-
−
 
+
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
−
<span style="font-weight: normal;"><u>PostScaler</u></span>
+
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Simulation
−
 
+
|-
−
This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''PostscalerFilter''.
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
−
Scaler applied to the timer,
+
| width="90%" | Timer Delay (ms)
−
 
+
|-
−
Small scalers allow for finer resolution but will limit the max time and also put more load on the microcontroller.
+
| 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.&nbsp;
−
 
+
|}
−
Recommended to use as large a setting as possible which still provides enough accuracy.
 
−
 
 
−
<span style="font-weight: normal;"><u>Timer Delay (ms)</u></span>
 
−
 
 
−
This property is of type ''Unsigned integer'' and can be referenced with the variable name ''TimerDelay''.
 
−
 
 
−
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.
 

Latest revision as of 17:24, 9 November 2022

Author Matrix TSL
Version 1.1
Category Storage


Timed Interval component

Allows you to setup a specific timed interval via the use of a hardware timer peripheral. Useful for regular time accurate periodic polling and sampling.

Component Pack

STORAGE

Detailed description

No detailed description exists yet for this component

Examples

No additional examples


Downloadable macro reference

Fc9-comp-macro.png StartTimerInterval
Starts the timer interval. 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png StopTimerInterval
Stops the timer interval. 
Fc9-void-icon.png - VOID Return



Property reference

Fc9-prop-icon.png Properties
Fc9-conn-icon.png Interval Properties
Fc9-type-16-icon.png Time Unit
Unit of time used for the time period. For example you might want every 4 milliseconds or every 3 hours. 
Fc9-type-21-icon.png Time Period
Value of time used for the time period. For example you might want every 4 milliseconds or every 3 hours. 
Fc9-type-15-icon.png Estimated Best Period
The closest we can get to the required time period based on prescaler and postscaler settings. Smaller scalers provide finer resolution but impose limits on the maximum delay. 
Fc9-type-15-icon.png Max Time Measurement
The maximum time we can do based on the current timer and scaler settings. 
Fc9-type-22-icon.png Callback Macro
User defined macro automatically called on a periodic basis. 
Fc9-conn-icon.png Timer Properties
Fc9-type-16-icon.png Timer
Timer Peripheral to use to monitor the passage of time. 
Fc9-type-21-icon.png Bit Depth
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. 
Fc9-type-16-icon.png Prescaler
Scaler applied to the timer, Small scalers allow for finer resolution but will limit the max time and also put more load on the microcontroller. Recommended to use as large a setting as possible which still provides enough accuracy.  
Fc9-type-16-icon.png PostScaler
Scaler applied to the timer, Small scalers allow for finer resolution but will limit the max time and also put more load on the microcontroller. Recommended to use as large a setting as possible which still provides enough accuracy.  
Fc9-conn-icon.png Simulation
Fc9-type-21-icon.png 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. 
Retrieved from "https://www.flowcode.co.uk/wikiv9/index.php?title=Component:_Timed_Interval_(Storage)&oldid=28911"