Difference between revisions of "Component: Timed Interval (Storage)"
From Flowcode Help
Jump to navigationJump to search| Line 20: | Line 20: | ||
==Detailed description== | ==Detailed description== | ||
| + | |||
| + | |||
''No detailed description exists yet for this component'' | ''No detailed description exists yet for this component'' | ||
==Examples== | ==Examples== | ||
| + | |||
| + | |||
| Line 65: | Line 69: | ||
| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-prop-icon.png]] | | width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-prop-icon.png]] | ||
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Properties''' | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Properties''' | ||
| + | |- | ||
| + | |- | ||
| + | | width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]] | ||
| + | | width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Interval Properties | ||
|- | |- | ||
|- | |- | ||
| Line 91: | Line 99: | ||
|- | |- | ||
| colspan="2" | User defined macro automatically called on a periodic basis. | | colspan="2" | User defined macro automatically called on a periodic basis. | ||
| + | |- | ||
| + | | width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]] | ||
| + | | width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Timer Properties | ||
| + | |- | ||
|- | |- | ||
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]] | | width="10%" align="center" | [[File:Fc9-type-16-icon.png]] | ||
| Line 112: | Line 124: | ||
| 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. | | 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. | ||
|- | |- | ||
| − | | width="10%" align="center" style="background-color:# | + | | width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]] |
| − | | width="90%" style="background-color:# | + | | width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Simulation |
| − | |||
| − | |||
| − | |||
| − | |||
|- | |- | ||
|- | |- | ||
Latest revision as of 17:24, 9 November 2022
| Author | Matrix TSL |
| Version | 1.1 |
| Category | Storage |
Contents
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
|
StartTimerInterval |
| Starts the timer interval. | |
 - VOID
|
Return |
|
|
StopTimerInterval |
| Stops the timer interval. | |
| - VOID
|
Return |
Property reference
|
Properties |
|
Interval Properties |
|
Time Unit |
| Unit of time used for the time period. For example you might want every 4 milliseconds or every 3 hours. | |
|
Time Period |
| Value of time used for the time period. For example you might want every 4 milliseconds or every 3 hours. | |
|
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. | |
|
|
Max Time Measurement |
| The maximum time we can do based on the current timer and scaler settings. | |
|
Callback Macro |
| User defined macro automatically called on a periodic basis. | |
|
|
Timer Properties |
|
|
Timer |
| Timer Peripheral to use to monitor the passage of time. | |
|
|
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. | |
|
|
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. | |
|
|
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. | |
|
|
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. | |
