Simulation Macro Icon Properties - Revision history

SteveT at 11:06, 12 June 2026

2026-06-12T11:06:07Z

SteveT at 10:20, 12 June 2026

2026-06-12T10:20:24Z

SteveT at 15:55, 10 June 2026

2026-06-10T15:55:22Z

ReeceL at 14:59, 23 September 2013

2013-09-23T14:59:43Z

Can't load revision 11926

at 14:48, 23 September 2013

2013-09-23T14:48:33Z

Can't load revision 11925

at 14:48, 23 September 2013

2013-09-23T14:48:20Z

Can't load revision 11924

at 16:06, 5 September 2013

2013-09-05T16:06:18Z

Can't load revision 11602

at 16:04, 5 September 2013

2013-09-05T16:04:37Z

Can't load revision 11601

at 15:55, 5 September 2013

2013-09-05T15:55:03Z

Can't load revision 11600

at 15:56, 2 September 2013

2013-09-02T15:56:45Z

Can't load revision 11402

← Older revision		Revision as of 11:06, 12 June 2026
Line 2:		Line 2:

	Simulation-only macros for advanced Flowcode use such as component creation.		Simulation-only macros for advanced Flowcode use such as component creation.
		+
		+
		+	==Old Versions==
		+	This page is current for Flowcode v9 and later. Earlier versions can be found below:
		+	{\| class="wikitable"
		+	\|+
		+	\|-
		+	\| [[Special:PermanentLink/11926\|Flowcode v8]]
		+	\|}

@@ Line 1: / Line 1: @@
 [[File:IconBuiltinFunction.png|border]]
@@ Line 10: / Line 11: @@
 |[[File:Gen_Simulation_Macro_Flowchart_Icon_01.png]]
 |width="50px" |&rarr;
-|[[File:Gen_Simulation_Macro_Icon_Properties_01.png]]
+|[[File:Properties_ApiMacro.png]]
 |}
-As well as calling simulation-only [[Component Macro Icon Properties|Component macros]], Simulation Macros can also call [[API Overview|Simulation Functions]] which provide enhanced software simulation although do not download code or compile to hardware.
+Built-in functions (sometimes called API or Simulation Macros) consist of a wide range of [[API Overview|Simulation Functions]] that provide enhanced features for software simulation of your Flowcode project. This means that no code is produced when a project is built (with the exception of a few Web Developer functions).
-These simulation functions are used to produce advanced systems on software to accurately replicate and simulate existing systems and even demonstrate new concepts by creating simulation-only programs to test the capabilities of potential systems.
+These internal functions are used to produce advanced systems on software to accurately replicate and simulate existing systems and even demonstrate new concepts by creating simulation-only programs to test the capabilities of potential systems. They are used mainly in the creation of Flowcode components and are rarely suitable for general Flowcode projects.
-'''Adding a simulation macro'''
+'''Adding a call to a Built-in Function'''
-Select the component and then [[Selecting Component Macros|select the Simulation Macro icon.]]
+The functions are listed under various categories. Expand each category to manually locate the required function, or right-click near the top of the list and select "Search" to enter a search term.
 Select the macro and fill in the parameters required and select a return value if required.
@@ Line 38: / Line 29: @@
 '''Parameters'''
-If the device macro requires any parameters then these can be entered in this field. They can be numeric values or existing variables. Clicking on the down arrow [[File:Btn_Arrow.png]] brings up the variables dialog window allowing you to select an existing variable or to [[Creating Variables|create a new one]].
+If the device macro requires any parameters then these can be entered in this field. Each can be a literal value or an existing variable. Clicking on the down arrow [[File:Btn_Arrow.png]] brings up the variables dialog window allowing you to select an existing variable or to [[Creating Variables|create a new one]].
-The parameter details will list the parameter type. Parameters must be of the required type to be accepted.
+The parameter details will list the parameter type. Parameters must be of a compatible type to be accepted.
 Note that a full set of parameters must be provided.
@@ Line 49: / Line 40: @@
 If the device macro returns a value then you can assign that value to an existing variable for use later in the flowchart. If the function returns a value but you do not wish to retrieve it then leave this field empty.
-The [[Variable Types|variable type]] of the return value will be listed. A variable of the specified type must be used to accept the return value.
+The [[Variable Types|variable type]] of the return value will be listed. A variable of compatible type must be used to accept the return value.
-==Other macro types==
+==Macro types==
-Macros are split into (user) Macros, Component macros and Built-in Functions.
+Macros are 3 types of macro that can be called using this command icon:
+{| class="wikitable"
-[[Component_Macro_Icon_Properties|Component macros]] are pre-defined macros supplied with the components. For example LCD macros are used to display numbers and characters on the LCD display.
+|+
+|-
-Component macros are only available for use with that particular component.
+| [[Macro_Icon_Properties|Macros]]
+| Macros designed and created by the user that are created as part of this project.
-Component macros have hatched outer bands on the icon.
+|-
+| [[Component_Macro_Icon_Properties|Components]]
+| Pre-defined macros supplied with the components. Only components that have been added to this project are available.
-Built-in Functions are simulation-only macros for advanced Flowcode use.
+|-
+| [[Simulation_Macro_Icon_Properties|Built-in Functions]]
+| Simulation-only macros for advanced Flowcode use such as component creation.
-[[Macro_Icon_Properties|User Macros]] are those designed and created by the user.
+|}

@@ Line 1: / Line 1: @@
-<sidebar>Sidebar: Icon Properties</sidebar>
+[[File:IconBuiltinFunction.png|border]]
-{| style="margin:auto; text-align:center;"
 |-
-|[[File:Btn_Simulation_Macro.gif|border]]
+|[[File:IconBuiltinFunction.png|border]]
 | width="50px" |&rarr;
 |[[File:Gen_Simulation_Macro_Flowchart_Icon_01.png]]
@@ Line 8: / Line 12: @@
 |[[File:Gen_Simulation_Macro_Icon_Properties_01.png]]
 |}
@@ Line 67: / Line 52: @@
-====Video instructions====
+==Other macro types==
 Watch the [http://www.youtube.com/watch?v=LSz0p0NqMBw&list=PLQDWBb7bxuCgg6aJgPJcfXBMzZdLILceQ Download and Simulation code] video for a demonstration, example and explanation of downloadable and simulation only code and the difference between the two.