Component Macro Icon Properties

<sidebar>Sidebar: Icon Properties</sidebar>

→

→

Macros are split into Macros and Component/Simulation 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.

Simulation macros are simulation-only Component macros - they provide a similar purpose, although they can only be used in simulation and cannot be run on hardware.

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 then select the Component Macro icon.

Select the component from the list of attached components to expand the list group to reveal the available component macros to choose from.

Select the macro and 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 arrow 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.

Video instructions

See the Component Macro video to learn how to call component macros, this video features both the ADC Dial and LCD EB005 components and their associated Component Macros.

{{#ev:youtube|Xh68YXcTdoU|640}}