Difference between revisions of "Component: PIC32 Core Timer (Storage)"

From Flowcode Help
Jump to navigationJump to search
(XML import)
 
 
(6 intermediate revisions 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
 
| MatrixTSL
 
| MatrixTSL
 
|-
 
|-
−
| width="20%" style="color: gray;" | Version
+
| width="20%" style="color:gray;" | Version
−
| 1.0 (Release)
+
| 1.0
 
|-
 
|-
−
| width="20%" style="color: gray;" | Category
+
| width="20%" style="color:gray;" | Category
 
| Storage
 
| Storage
 
|}
 
|}
  
  
−
 
+
==PIC32 Core Timer component==
−
==[[File:Component Icon ec64c307_3099_485b_bd55_052a5da95128.png|Image]] PIC32 Core Timer component==
 
 
Allows for easy and accurate timings using the built in Core timer on the PIC32 devices.
 
Allows for easy and accurate timings using the built in Core timer on the PIC32 devices.
  
−
==Examples==
+
==Component Pack==
−
''<span style="color:red;">No additional examples</span>''
 
  
 +
STORAGE
  
−
==Downloadable macro reference==
+
==Detailed description==
  
−
===<span style="font-weight: normal;"><u><tt>Start_S</tt></u></span>===
 
−
A none blocking function that allows for accurate delays to be specified in seconds using the core timer.
 
  
−
'''Parameters'''
 
  
−
:[[Variable Types|ULONG]] ''Delay''
 
  
  
−
'''Return value'''
 
  
−
:''This call does not return a value''
 
  
  
−
===<span style="font-weight: normal;"><u><tt>Start_InstructionCount</tt></u></span>===
 
−
A none blocking function that allows for accurate delays to be specified in FOSC instructions using the core timer.
 
  
−
'''Parameters'''
 
  
−
:[[Variable Types|ULONG]] ''Delay''
 
  
  
−
'''Return value'''
 
  
−
:''This call does not return a value''
+
''No detailed description exists yet for this component''
  
 +
==Examples==
  
−
===<span style="font-weight: normal;"><u><tt>Delay_S</tt></u></span>===
 
−
A blocking function that allows for accurate delays to be specified in seconds using the core timer.
 
  
−
'''Parameters'''
 
  
−
:[[Variable Types|ULONG]] ''Delay''
 
  
  
−
'''Return value'''
 
  
−
:''This call does not return a value''
 
  
  
−
===<span style="font-weight: normal;"><u><tt>Start_Ms</tt></u></span>===
 
−
A none blocking function that allows for accurate delays to be specified in milliseconds using the core timer.
 
  
−
'''Parameters'''
 
  
−
:[[Variable Types|ULONG]] ''Delay''
 
  
  
−
'''Return value'''
 
  
−
:''This call does not return a value''
 
  
 +
''<span style="color:red;">No additional examples</span>''
  
−
===<span style="font-weight: normal;"><u><tt>Start_Us</tt></u></span>===
 
−
A none blocking function that allows for accurate delays to be specified in micro seconds using the core timer.
 
  
−
'''Parameters'''
+
==Downloadable macro reference==
  
−
:[[Variable Types|ULONG]] ''Delay''
+
{| 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;" | '''Start_S'''
 +
|-
 +
| colspan="2" | A none blocking function that allows for accurate delays to be specified in seconds using the core timer.&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u32-icon.png]] - ULONG
 +
| width="90%" | Delay
 +
|-
 +
| colspan="2" | &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;" | '''Start_InstructionCount'''
 +
|-
 +
| colspan="2" | A none blocking function that allows for accurate delays to be specified in FOSC instructions using the core timer.&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u32-icon.png]] - ULONG
 +
| width="90%" | Delay
 +
|-
 +
| colspan="2" | &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''
 
  
 +
{| 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;" | '''Delay_S'''
 +
|-
 +
| colspan="2" | A blocking function that allows for accurate delays to be specified in seconds using the core timer.&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u32-icon.png]] - ULONG
 +
| width="90%" | Delay
 +
|-
 +
| colspan="2" | &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''
 +
|}
  
−
===<span style="font-weight: normal;"><u><tt>Delay_InstructionCount</tt></u></span>===
 
−
A blocking function that allows for accurate delays to be specified in FOSC instructions using the core timer.
 
  
−
'''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;" | '''Start_Ms'''
 +
|-
 +
| colspan="2" | A none blocking function that allows for accurate delays to be specified in milliseconds using the core timer.&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u32-icon.png]] - ULONG
 +
| width="90%" | Delay
 +
|-
 +
| colspan="2" | &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''
 +
|}
  
−
:[[Variable Types|ULONG]] ''Delay''
 
  
 +
{| 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;" | '''Start_Us'''
 +
|-
 +
| colspan="2" | A none blocking function that allows for accurate delays to be specified in micro seconds using the core timer.&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u32-icon.png]] - ULONG
 +
| width="90%" | Delay
 +
|-
 +
| colspan="2" | &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'''
 
  
−
:''This call does not return a 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;" | '''Delay_Ms'''
 +
|-
 +
| colspan="2" | A blocking function that allows for accurate delays to be specified in milliseconds using the core timer.&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u32-icon.png]] - ULONG
 +
| width="90%" | Delay
 +
|-
 +
| colspan="2" | &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''
 +
|}
  
  
−
===<span style="font-weight: normal;"><u><tt>Delay_Ms</tt></u></span>===
+
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
−
A blocking function that allows for accurate delays to be specified in milliseconds using the core timer.
+
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Delay_InstructionCount'''
 +
|-
 +
| colspan="2" | A blocking function that allows for accurate delays to be specified in FOSC instructions using the core timer.&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u32-icon.png]] - ULONG
 +
| width="90%" | Delay
 +
|-
 +
| colspan="2" | &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''
 +
|}
  
−
'''Parameters'''
 
  
−
:[[Variable Types|ULONG]] ''Delay''
+
{| 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;" | '''Start_Ns'''
 +
|-
 +
| colspan="2" | A none blocking function that allows for accurate delays to be specified in nano seconds using the core timer.&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u32-icon.png]] - ULONG
 +
| width="90%" | Delay
 +
|-
 +
| colspan="2" | &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;" | '''Delay_Us'''
 +
|-
 +
| colspan="2" | A blocking function that allows for accurate delays to be specified in micro seconds using the core timer.&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u32-icon.png]] - ULONG
 +
| width="90%" | Delay
 +
|-
 +
| colspan="2" | &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''
 
  
 +
{| 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;" | '''Delay_Ns'''
 +
|-
 +
| colspan="2" | A blocking function that allows for accurate delays to be specified in nano seconds using the core timer.&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u32-icon.png]] - ULONG
 +
| width="90%" | Delay
 +
|-
 +
| colspan="2" | &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''
 +
|}
  
−
===<span style="font-weight: normal;"><u><tt>Start_Ns</tt></u></span>===
 
−
A none blocking function that allows for accurate delays to be specified in nano seconds using the core timer.
 
  
−
'''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;" | '''Check_Counter'''
 +
|-
 +
| colspan="2" | Checks to see if the counter time is elapsed. Used in conjunction with the Start_ component macros. Returns 1 if complete or 0 if still counting.&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-bool-icon.png]] - BOOL
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
  
−
:[[Variable Types|ULONG]] ''Delay''
 
  
  
−
'''Return value'''
 
  
−
:''This call does not return a value''
+
==Property reference==
  
−
 
+
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
−
===<span style="font-weight: normal;"><u><tt>Delay_Us</tt></u></span>===
+
|-
−
A blocking function that allows for accurate delays to be specified in micro seconds using the core timer.
+
| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-prop-icon.png]]
−
 
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Properties'''  
−
'''Parameters'''
+
|-
−
 
+
|}
−
:[[Variable Types|ULONG]] ''Delay''
 
−
 
 
−
 
 
−
'''Return value'''
 
−
 
 
−
:''This call does not return a value''
 
−
 
 
−
 
 
−
===<span style="font-weight: normal;"><u><tt>Check_Counter</tt></u></span>===
 
−
Checks to see if the counter time is elapsed.
 
−
 
 
−
Used in conjunction with the Start_ component macros.
 
−
 
 
−
Returns 1 if complete or 0 if still counting.
 
−
 
 
−
'''Parameters'''
 
−
 
 
−
:''This macro has no parameters''
 
−
 
 
−
 
 
−
'''Return value'''
 
−
 
 
−
:[[Variable Types|BOOL]] : Returns true if the operation is a success, else false
 
−
 
 
−
 
 
−
===<span style="font-weight: normal;"><u><tt>Delay_Ns</tt></u></span>===
 
−
A blocking function that allows for accurate delays to be specified in nano seconds using the core timer.
 
−
 
 
−
'''Parameters'''
 
−
 
 
−
:[[Variable Types|ULONG]] ''Delay''
 
−
 
 
−
 
 
−
'''Return value'''
 
−
 
 
−
:''This call does not return a value''
 
−
 
 
−
 
 
−
 
 
−
==Simulation macro reference==
 
−
 
 
−
''This component does not contain any simulation macros''
 
−
 
 
−
 
 
−
==Property reference==
 
−
''This component does not contain any properties''
 

Latest revision as of 17:24, 9 November 2022

Author MatrixTSL
Version 1.0
Category Storage


PIC32 Core Timer component

Allows for easy and accurate timings using the built in Core timer on the PIC32 devices.

Component Pack

STORAGE

Detailed description

No detailed description exists yet for this component

Examples

No additional examples


Downloadable macro reference

Fc9-comp-macro.png Start_S
A none blocking function that allows for accurate delays to be specified in seconds using the core timer. 
Fc9-u32-icon.png - ULONG Delay
 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png Start_InstructionCount
A none blocking function that allows for accurate delays to be specified in FOSC instructions using the core timer. 
Fc9-u32-icon.png - ULONG Delay
 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png Delay_S
A blocking function that allows for accurate delays to be specified in seconds using the core timer. 
Fc9-u32-icon.png - ULONG Delay
 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png Start_Ms
A none blocking function that allows for accurate delays to be specified in milliseconds using the core timer. 
Fc9-u32-icon.png - ULONG Delay
 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png Start_Us
A none blocking function that allows for accurate delays to be specified in micro seconds using the core timer. 
Fc9-u32-icon.png - ULONG Delay
 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png Delay_Ms
A blocking function that allows for accurate delays to be specified in milliseconds using the core timer. 
Fc9-u32-icon.png - ULONG Delay
 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png Delay_InstructionCount
A blocking function that allows for accurate delays to be specified in FOSC instructions using the core timer. 
Fc9-u32-icon.png - ULONG Delay
 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png Start_Ns
A none blocking function that allows for accurate delays to be specified in nano seconds using the core timer. 
Fc9-u32-icon.png - ULONG Delay
 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png Delay_Us
A blocking function that allows for accurate delays to be specified in micro seconds using the core timer. 
Fc9-u32-icon.png - ULONG Delay
 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png Delay_Ns
A blocking function that allows for accurate delays to be specified in nano seconds using the core timer. 
Fc9-u32-icon.png - ULONG Delay
 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png Check_Counter
Checks to see if the counter time is elapsed. Used in conjunction with the Start_ component macros. Returns 1 if complete or 0 if still counting. 
Fc9-bool-icon.png - BOOL Return



Property reference

Fc9-prop-icon.png Properties
Retrieved from "https://www.flowcode.co.uk/wikiv9/index.php?title=Component:_PIC32_Core_Timer_(Storage)&oldid=28909"