Difference between revisions of "Component: Auto Version Identifier (Storage)"

From Flowcode Help
Jump to navigationJump to search
(XML import - Pre 8.0 release)
 
(2 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
 
| Matrix Ltd
 
| Matrix Ltd
 
|-
 
|-
−
| width="20%" style="color: gray;" | Version
+
| width="20%" style="color:gray;" | Version
−
| 1.2 (Release)
+
| 1.2
 
|-
 
|-
−
| width="20%" style="color: gray;" | Category
+
| width="20%" style="color:gray;" | Category
 
| Storage
 
| Storage
 
|}
 
|}
  
  
 +
==Auto Version Identifier component==
 +
Basic component designed to provide the program with the date and time of the build. Embedded assigns the time and date of compilation. Simulation assigns the time and date of the start of simulation.
  
−
==[[File:Component Icon 1911d96c_78dd_414a_b23c_6691fb19f63f.png|Image]] Auto Version Identifier component==
+
==Component Pack==
−
Basic component designed to provide the program with the date and time of the build.
 
−
Embedded assigns the time and date of compilation.
 
−
Simulation assigns the time and date of the start of simulation.
 
  
−
==Examples==
+
STORAGE
−
A simple example program that will show the build number and the time and date of compilation on an LCD for four seconds before going into your program to help keep track of the firmware version in your projects.
 
−
{{Fcfile|VersionExample.fcfx|Auto Version Example}}
 
  
−
==Downloadable macro reference==
+
==Detailed description==
  
−
===<span style="font-weight: normal;"><u><tt>GetTime</tt></u></span>===
 
−
Returns the build time as a string
 
  
−
'''Parameters'''
 
  
−
:''This macro has no parameters''
 
  
  
−
'''Return value'''
+
''No detailed description exists yet for this component''
  
−
:[[Variable Types|STRING]]
+
==Examples==
  
  
−
===<span style="font-weight: normal;"><u><tt>GetDate</tt></u></span>===
 
−
Returns the build date as a string
 
  
−
'''Parameters'''
 
  
−
:''This macro has no parameters''
 
  
  
−
'''Return value'''
+
A simple example program that will show the build number and the time and date of compilation on an LCD for four seconds before going into your program to help keep track of the firmware version in your projects.
 +
{{Fcfile|VersionExample.fcfx|Auto Version Example}}
  
−
:[[Variable Types|STRING]]
+
==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;" | '''GetTime'''
 +
|-
 +
| colspan="2" | Returns the build time as a string&nbsp;
 +
|-
 +
|-
 +
| 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''
 +
|}
  
−
===<span style="font-weight: normal;"><u><tt>GetBuildNumber</tt></u></span>===
 
−
Returns the current auto incremented built number property.
 
  
−
'''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;" | '''GetDate'''
 +
|-
 +
| colspan="2" | Returns the build date as a string&nbsp;
 +
|-
 +
|-
 +
| 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''
 +
|}
  
−
:''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;" | '''GetBuildNumber'''
 +
|-
 +
| colspan="2" | Returns the current auto incremented built number property.&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u16-icon.png]] - UINT
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
  
−
'''Return value'''
 
  
−
:[[Variable Types|UINT]]
 
−
 
−
 
−
 
−
==Simulation macro reference==
 
−
 
−
''This component does not contain any simulation macros''
 
  
  
 
==Property reference==
 
==Property reference==
−
<span style="font-weight: normal;"><u>Build Number</u></span>
 
  
−
This property is of type ''Unsigned integer'' and can be referenced with the variable name ''BuildNumber''.
+
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
−
 
+
|-
−
Current build number, automatically incremented before each compilation takes place.
+
| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-prop-icon.png]]
−
 
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Properties'''  
−
<span style="font-weight: normal;"><u>Date Divider</u></span>
+
|-
−
 
+
|-
−
This property is of type ''Line of text'' and can be referenced with the variable name ''DateDivider''.
+
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
−
 
+
| width="90%" | Build Number
−
''<span style="color:red;">No additional information</span>''
+
|-
−
 
+
| colspan="2" | Current build number, automatically incremented before each compilation takes place.&nbsp;
−
 
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-10-icon.png]]
−
<span style="font-weight: normal;"><u>Time Divider</u></span>
+
| width="90%" | Date Divider
−
 
+
|-
−
This property is of type ''Line of text'' and can be referenced with the variable name ''TimeDivider''.
+
| colspan="2" | &nbsp;
−
 
+
|-
−
''<span style="color:red;">No additional information</span>''
+
| width="10%" align="center" | [[File:Fc9-type-10-icon.png]]
−
 
+
| width="90%" | Time Divider
−
 
+
|-
−
 
+
| colspan="2" | &nbsp;
−
<span style="font-weight: normal;"><u>Date Format</u></span>
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
−
This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''DateFormat''.
+
| width="90%" | Date Format
−
 
+
|-
−
''<span style="color:red;">No additional information</span>''
+
| colspan="2" | &nbsp;
−
 
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-10-icon.png]]
−
 
+
| width="90%" | Last Build Date
−
<span style="font-weight: normal;"><u>Last Build Date</u></span>
+
|-
−
 
+
| colspan="2" | &nbsp;
−
This property is of type ''Line of text'' and can be referenced with the variable name ''LastBuildDate''.
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-10-icon.png]]
−
''<span style="color:red;">No additional information</span>''
+
| width="90%" | Last Build Time
−
 
+
|-
−
 
+
| colspan="2" | &nbsp;
−
 
+
|}
−
<span style="font-weight: normal;"><u>Last Build Time</u></span>
 
−
 
 
−
This property is of type ''Line of text'' and can be referenced with the variable name ''LastBuildTime''.
 
−
 
 
−
''<span style="color:red;">No additional information</span>''
 

Latest revision as of 17:19, 9 November 2022

Author Matrix Ltd
Version 1.2
Category Storage


Auto Version Identifier component

Basic component designed to provide the program with the date and time of the build. Embedded assigns the time and date of compilation. Simulation assigns the time and date of the start of simulation.

Component Pack

STORAGE

Detailed description

No detailed description exists yet for this component

Examples

A simple example program that will show the build number and the time and date of compilation on an LCD for four seconds before going into your program to help keep track of the firmware version in your projects. FC6 Icon.png Auto Version Example

Downloadable macro reference

Fc9-comp-macro.png GetTime
Returns the build time as a string 
Fc9-string-icon.png - STRING Return


Fc9-comp-macro.png GetDate
Returns the build date as a string 
Fc9-string-icon.png - STRING Return


Fc9-comp-macro.png GetBuildNumber
Returns the current auto incremented built number property. 
Fc9-u16-icon.png - UINT Return



Property reference

Fc9-prop-icon.png Properties
Fc9-type-21-icon.png Build Number
Current build number, automatically incremented before each compilation takes place. 
Fc9-type-10-icon.png Date Divider
 
Fc9-type-10-icon.png Time Divider
 
Fc9-type-16-icon.png Date Format
 
Fc9-type-10-icon.png Last Build Date
 
Fc9-type-10-icon.png Last Build Time
 
Retrieved from "https://www.flowcode.co.uk/wikiv9/index.php?title=Component:_Auto_Version_Identifier_(Storage)&oldid=28495"