Difference between revisions of "Component Macro Icon Properties"

From Flowcode Help
Jump to navigationJump to search
Line 14: Line 14:
  
 
[[Macro Icon Properties|Macros]] are those designed and created by the user.
 
[[Macro Icon Properties|Macros]] are those designed and created by the user.
 
+
Macros can be [[Exporting a Macro|exported]] and [[Importing a Macro|imported]] allowing users to build up macro libraries of common or important tasks.
[[Creating a New Macro|Macros]] can be [[Exporting a Macro|exported]] and [[Importing a Macro|imported]] allowing users to build up macro libraries of common or important tasks.
 
  
 
On Macros the outer bands are clear and not hatched.
 
On Macros the outer bands are clear and not hatched.
Line 21: Line 20:
  
 
'''Adding a component macro'''
 
'''Adding a component macro'''
 
+
[[Selecting Component Macros|Select the component and macro to use.]]
Select the component and macro to use.
 
  
 
Select the component from the list of attached components on the left, and select the macro to use from the list on the right.
 
Select the component from the list of attached components on the left, and select the macro to use from the list on the right.
Line 31: Line 29:
 
'''Parameters'''
 
'''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 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. 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]].
  
 
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 the required type to be accepted.

Revision as of 12:09, 9 July 2013

<sidebar>Sidebar: Icon Properties</sidebar> Btn Component Macro.gifFile:Gen Component Macro Icon Properties Macro Flowchart Icon.pngFile:Gen Component Macro Icon Properties Macro Properties.png


Macros are split into Macros and Component macros.


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.

Component macros have hatched outer bands on the icon.


Macros are those designed and created by the user. Macros can be exported and imported allowing users to build up macro libraries of common or important tasks.

On Macros the outer bands are clear and not hatched.


Adding a component macro Select the component and macro to use.

Select the component from the list of attached components on the left, and select the macro to use from the list on the right.

Add in any parameters required, and select a return value if required.


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 arrowBtn Arrow.png brings up the variables dialog window allowing you to select an existing variable or to create a new one.

The parameter details will list the parameter type. Parameters must be of the required type to be accepted.

Note that a full set of parameters must be provided.


Return value

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 type of the return value will be listed. A variable of the specified type must be used to accept the return value.