Flowcode Help - User contributions [en]

Exit State Icon Properties

2026-06-12T14:41:24Z

SteveT:

[[File:iconExitState.png|border]]

An Exit State icon is used within a [[State_diagrams|State Diagram macro]] to represent a special [[State_Icon_Properties|State icon]] that exits this macro and returns program control to the macro that originally called this macro.

A State Diagram can include zero, one or several Exit State icons.

==Details==
{| style="margin:0px; text-align:center;"
|-
|[[File:iconExitState.png|border]]
|width="50px" |→
|[[File:Properties_ExitState.png]]
|}

Like a normal State icon, an Exit State icon has a display name (i.e. the text displayed on the state within the diagram) and an optional function.
In addition, an Exit State may pass back a specific return value (if this State Diagram specifies a return type).

'''Display Name'''

The name of the icon that appears in the Exit State icon in the State Diagram.

This can be optionally displayed or hidden on the icon itself when the "Show" tick-box is unticked.

'''Function'''

The function is code that is executed when the program flow enters this Exit State icon.

This can be to call a macro, perform a calculation, delay program execution or execute some custom code.

States will perform their optional function when program flow enters that state through a transition from another state.

The function can be optionally displayed or hidden on the icon itself when the "Show" tick-box is unticked.

'''Edit...'''

Click the "Edit..." button to change the details of the selected function. This button will be hidden if the function is set to "Do nothing" and will be labelled "Choose macro..." if the "Call Macro" function is chosen.

This will open another property window that is specific to the selected function. More details are here:

{| class="wikitable"
|+
|-
| [[Macro_Icon_Properties|Call macro]]
|-
| [[Calculation_Icon_Properties|Calculation]]
|-
| [[Delay_Icon_Properties|Delay]]
|-
| [[Code_Icon_Properties|Code]]
|}

'''Set return value'''

State Diagrams that specify a return type will enable this tick-box, which allows the Exit State to set the return value when it is executed and passed program control to the calling macro.

When ticked, this box will allow a value or variable to be specified in the "Return Value" box.

If left unticked, the return value will be the value of the local "Return" variable (assuming this macro specifies a return) in the same way that a normal macro can set its return value.

'''Return Value'''

The return value passed to the calling macro can be set here.
This can be a literal value, an expression, or a variable of a compatible type to this macro's return type.

Clicking the down arrow to the right of the box will allow a global or local variable to be chosen from those available.

==Example of a State Diagram==

[[File:State0.png|State Diagram Overview]]

Transition Icon Properties

2026-06-12T14:18:38Z

SteveT:

[[File:IconTransitionStraight.png|border|link=Transition_Icon_Properties]] [[File:IconTransitionCurved.png|border|link=Transition_Icon_Properties]]

A Transition icon is used within a [[State_diagrams|State Diagram macro]] to represent a transition from one States icon to another. Each Transition icon has a condition that determines the logical flow of the user's program and optional functionality that is executed when the Transition has been activated.

==Details==
{| style="margin:0px; text-align:center;"
|-
|[[File:IconTransitionStraight.png|border|link=Transition_Icon_Properties]] / [[File:IconTransitionCurved.png|border|link=Transition_Icon_Properties]]
|width="50px" |→
|[[File:Properties_Transition.png]]
|}

Transitions are lines that connect two states in a state diagram.

These lines have an arrow at one end signifying the direction of program flow through the transition.

'''Display Name'''

The name of the icon that appears in the State icon in the State Diagram.

This can be optionally displayed or hidden on the icon itself when the "Show" tick-box is unticked.

'''Condition'''

Transitions have a condition which is an expression that evaluates to true (non-zero) or false (zero).

The condition is used during program execution to determine if the program flow should proceed along that transition. When the condition is true, the function of the Transition is executed and program control passes to the attached State icon.

Each transition leaving that state has its condition tested in turn to see which path the program flow should continue along. The order that these are checked is set in the State icon's property page.

The condition expression can be optionally displayed or hidden on the icon itself when the "Show" tick-box is unticked.

'''Function'''

The function is code that is executed when the program flow enters (or remains in) that state icon.

This can be to call a macro, perform a calculation, delay program execution or execute some custom C code.

States will perform their optional function when program flow enters that state through a transition from another state.

This function can be optionally displayed or hidden on the icon itself when the "Show" tick-box is unticked.

'''Edit...'''

Click the "Edit..." button to change the details of the selected function. This button will be hidden if the function is set to "Do nothing" and will be labelled "Choose macro..." if the "Call Macro" function is chosen.

This will open another property window that is specific to the selected function. More details are here:

{| class="wikitable"
|+
|-
| [[Macro_Icon_Properties|Call macro]]
|-
| [[Calculation_Icon_Properties|Calculation]]
|-
| [[Delay_Icon_Properties|Delay]]
|-
| [[Code_Icon_Properties|Code]]
|}

==Transition label==
Transitions have an optional label which can display the name of the transition, its condition, or its function.

The colour of a transition can be changed by right-clicking the transition and selecting "Set shape colour".
This sets the colour of its label. The colour of the transition line and arrow cannot be altered.

==Entry State Transition==
The entry state icon includes a special transition leaving it which should point to the first state to be executed in the state diagram (after the entry state itself).

This transition is always connected to the enter state and cannot be deleted.

Also, it has no properties and so cannot have a label or code.

It is always executed as if its transition condition is true.

==Simulation==
During program execution (simulation or ICD), the colour of the transition line changes to blue or orange when its condition is being evaluated – blue signifies the condition is false and the transition will be ignored, and orange signifies that the transition is true and the program flow with execute along this transition.

When the transition is executing, it changes to a thick orange line.

==Example of a State Diagram==

[[File:State0.png|State Diagram Overview]]

State Icon Properties

2026-06-12T14:10:03Z

SteveT:

[[File:iconState.png|border]]

A State icon is used within a [[State_diagrams|State Diagram macro]] to represent one of the states. Each State icon will have optional functionality that is executed when the State is entered.

==Details==
{| style="margin:0px; text-align:center;"
|-
|[[File:iconState.png|border]]
|width="50px" |→
|[[File:Properties_State.png]]
|}

A State Diagram consists of several state icons interconnected with transitions. Like a transition, a state icon has a display name (i.e. the text displayed on the state within the diagram) and an optional function.

'''Display Name'''

The name of the icon that appears in the State icon in the State Diagram.

This can be optionally displayed or hidden on the icon itself when the "Show" tick-box is unticked.

'''Function'''

The function is code that is executed when the program flow enters (or remains in) that state icon.

This can be to call a macro, perform a calculation, delay program execution or execute some custom C code.

States will perform their optional function when program flow enters that state through a transition from another state.

This can be optionally displayed or hidden on the icon itself when the "Show" tick-box is unticked.

'''Edit...'''

Click the "Edit..." button to change the details of the selected function. This button will be hidden if the function is set to "Do nothing" and will be labelled "Choose macro..." if the "Call Macro" function is chosen.

This will open another property window that is specific to the selected function. More details are here:

{| class="wikitable"
|+
|-
| [[Macro_Icon_Properties|Call macro]]
|-
| [[Calculation_Icon_Properties|Calculation]]
|-
| [[Delay_Icon_Properties|Delay]]
|-
| [[Code_Icon_Properties|Code]]
|}

'''Set transition order'''

States usually have one or more exit transitions: arrows that flow out of the state icon with optional conditions that must be true for program execution to ‘flow’ along that Transition.

These exit Transitions are evaluated in turn until one is found to be true. The evaluation order of these transitions can be set by clicking “Set transition order” or by reconnecting the start end of the transition to the state.

==Editing the order of transitions==
[[File:TransitionOrder.png]]

The order in which transitions are evaluated can be set in this window. Click the required transition to select it and set its position in the list using the up and down arrows.

The transitions can be listed here by their Display Name, their specified Condition, or the Function that they perform.

==Special States==

A state without an exit transition will force program execution to remain in that state until the program is stopped by the user.

Each state diagram must contain a single “Entry State” icon which contains the code to be executed when the program enters that macro.

Only one transition can exit this entry state and neither this transition nor the entry state can be deleted from the state diagram.

State Diagrams can may have one or more [[Exit_State_Icon_Properties|Exit State icons]], which cause the State Diagram to return to its calling macro.

These may have a return value if this State Diagram macro specifies a return type.

==Example of a State Diagram==

[[File:State0.png|State Diagram Overview]]

State Icon Properties

2026-06-12T14:06:29Z

SteveT:

State Icon Properties

2026-06-12T11:55:33Z

SteveT:

[[File:iconState.png|border]]

A State icon is used within a [[State_diagrams|State Diagram macro]] to represent one of the states. Each State icon will have optional functionality that is executed when the State is entered.

==Details==
{| style="margin:0px; text-align:center;"
|-
|[[File:iconState.png|border]]
|width="50px" |→
|[[File:Properties_State.png]]
|}

A State Diagram consists of several state icons interconnected with transitions. Like a transition, a state icon has a display name (i.e. the text displayed on the state within the diagram) and an optional function.

'''Display Name'''

The name of the icon that appears in the State icon in the State Diagram.

This can be optionally displayed or hidden on the icon itself when the "Show" tick-box is unticked.

'''Function'''

The function is code that is executed when the program flow enters (or remains in) that state icon.

This can be to call a macro, perform a calculation, delay program execution or execute some custom C code.

States will perform their optional function when program flow enters that state through a transition from another state.

This can be optionally displayed or hidden on the icon itself when the "Show" tick-box is unticked.

'''Edit...'''

Click the "Edit..." button to change the details of the selected function.

This will open another property window that is specific to the selected function. More details are here:

{| class="wikitable"
|+
|-
| [[Macro_Icon_Properties|Call macro]]
|-
| [[Calculation_Icon_Properties|Calculation]]
|-
| [[Delay_Icon_Properties|Delay]]
|-
| [[Code_Icon_Properties|Code]]
|}

'''Set transition order'''

States usually have one or more exit transitions: arrows that flow out of the state icon with optional conditions that must be true for program execution to ‘flow’ along that Transition.

These exit Transitions are evaluated in turn until one is found to be true. The evaluation order of these transitions can be set by clicking “Set transition order” or by reconnecting the start end of the transition to the state.

==Editing the order of transitions==
[[File:TransitionOrder.png]]

The order in which transitions are evaluated can be set in this window. Click the required transition to select it and set its position in the list using the up and down arrows.

The transitions can be listed here by their Display Name, their specified Condition, or the Function that they perform.

==Special States==

A state without an exit transition will force program execution to remain in that state until the program is stopped by the user.

Each state diagram must contain a single “Entry State” icon which contains the code to be executed when the program enters that macro.

Only one transition can exit this entry state and neither this transition nor the entry state can be deleted from the state diagram.

State Diagrams can may have one or more [[Exit_State_Icon_Properties|Exit State icons]], which cause the State Diagram to return to its calling macro.

These may have a return value if this State Diagram macro specifies a return type.

Macro Icon Properties

2026-06-12T11:54:21Z

SteveT: /* Details */

[[File:iconUserMacro.png|border]]

Macros are sections of code that can be used and reused in projects.

==Old Versions==
This page is current for Flowcode v9 and later. Earlier versions can be found below:
{| class="wikitable"
|+
|-
| [[Special:PermanentLink/10821|Flowcode v8]]
|}

==Details==
{| style="margin:0px; text-align:center;"
|-
|[[File:iconUserMacro.png|border]]
| width="50px" |→
|[[File:Gen_Macro_Flowchart_Icon_01.png]]
|width="50px" |→
|[[File:Properties_Macro.png]]
|}

'''Macros'''

Macros (explained here) 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.

On Macros the outer bands are clear and not hatched.

The macro properties dialog allows users to select and create macros.

'''Adding a Macro'''

Select the Macro to use from the list, or click on Create new macro to begin [[Creating a New Macro|creating a new macro]] to add to the list.

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

Clicking on the OK button completes the process and closes the dialog.

Clicking on the OK and edit button completes the process, closes the dialog and opens the selected macro for editing.

'''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 allows 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.

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

'''Create New Macro button'''

Select this button to [[Creating a New Macro|create a new macro]] within the flowchart.

'''OK & Edit Macro button'''

Clicking this button will open up the chosen macro to allow it to be viewed or edited.

==Macro types==
Macros are 3 types of macro that can be called using this command icon:

{| class="wikitable"
|+
|-
| [[Macro_Icon_Properties|Macros]]
| Macros designed and created by the user that are created as part of this project.
|-
| [[Component_Macro_Icon_Properties|Components]]
| Pre-defined macros supplied with the components. Only components that have been added to this project are available.
|-
| [[Simulation_Macro_Icon_Properties|Built-in Functions]]
| Simulation-only macros for advanced Flowcode use such as component creation.
|}

==Video==

See the [http://www.youtube.com/watch?v=SlWkK1mwyJQ&list=PLQDWBb7bxuCgg6aJgPJcfXBMzZdLILceQ Macros] video to learn how to call a macro from a selection of existing macros and input a macro parameter using the Macro icon.

<div align="center">
{{#ev:youtube|SlWkK1mwyJQ|640}}
</div>

State Icon Properties

2026-06-12T11:43:55Z

SteveT: /* Details */

[[File:iconState.png|border]]

A State icon is used within a [[State_diagrams|State Diagram macro]] to represent one of the states. Each State icon will have optional functionality that is executed when the State is entered.

==Details==
{| style="margin:0px; text-align:center;"
|-
|[[File:iconState.png|border]]
|width="50px" |→
|[[File:Properties_State.png]]
|}

A State Diagram consists of several state icons interconnected with transitions. Like a transition, a state icon has a display name (i.e. the text displayed on the state within the diagram) and an optional function.

'''Display Name'''

The name of the icon that appears in the State icon in the State Diagram.

This can be optionally displayed or hidden on the icon itself when the "Show" tick-box is unticked.

'''Function'''

The function is code that is executed when the program flow enters (or remains in) that state icon.

This can be to call a macro, perform a calculation, delay program execution or execute some custom C code.

States will perform their optional function when program flow enters that state through a transition from another state.

This can be optionally displayed or hidden on the icon itself when the "Show" tick-box is unticked.

'''Set transition order'''

States usually have one or more exit transitions: arrows that flow out of the state icon with optional conditions that must be true for program execution to ‘flow’ along that Transition.

These exit Transitions are evaluated in turn until one is found to be true. The evaluation order of these transitions can be set by clicking “Set transition order” or by reconnecting the start end of the transition to the state.

[[File:TransitionOrder.png]]

==Special States==

A state without an exit transition will force program execution to remain in that state until the program is stopped by the user.

Each state diagram must contain a single “Entry State” icon which contains the code to be executed when the program enters that macro.

Only one transition can exit this entry state and neither this transition nor the entry state can be deleted from the state diagram.

State Diagrams can may have one or more [[Exit_State_Icon_Properties|Exit State icons]], which cause the State Diagram to return to its calling macro.

These may have a return value if this State Diagram macro specifies a return type.

State Icon Properties

2026-06-12T11:42:27Z

SteveT:

[[File:iconState.png|border]]

A State icon is used within a [[State_diagrams|State Diagram macro]] to represent one of the states. Each State icon will have optional functionality that is executed when the State is entered.

==Details==
{| style="margin:0px; text-align:center;"
|-
|[[File:iconState.png|border]]
|width="50px" |→
|[[File:Properties_State.png]]
|}

A State Diagram consists of several state icons interconnected with transitions. Like a transition, a state icon has a display name (i.e. the text displayed on the state within the diagram) and an optional function.

'''Display Name'''

The name of the icon that appears in the State icon in the State Diagram.

This can be optionally displayed or hidden on the icon itself when the "Show" tick-box is unticked.

'''Function'''

The function is code that is executed when the program flow enters (or remains in) that state icon.

This can be to call a macro, perform a calculation, delay program execution or execute some custom C code.

States will perform their optional function when program flow enters that state through a transition from another state.

This can be optionally displayed or hidden on the icon itself when the "Show" tick-box is unticked.

'''Set transition order'''

States usually have one or more exit transitions: arrows that flow out of the state icon with optional conditions that must be true for program execution to ‘flow’ along that Transition.

These exit Transitions are evaluated in turn until one is found to be true. The evaluation order of these transitions can be set by clicking “Set transition order” or by reconnecting the start end of the transition to the state.

==Special States==

A state without an exit transition will force program execution to remain in that state until the program is stopped by the user.

Each state diagram must contain a single “Entry State” icon which contains the code to be executed when the program enters that macro.

Only one transition can exit this entry state and neither this transition nor the entry state can be deleted from the state diagram.

State Diagrams can may have one or more [[Exit_State_Icon_Properties|Exit State icons]], which cause the State Diagram to return to its calling macro.

These may have a return value if this State Diagram macro specifies a return type.

Group Icon Properties

2026-06-12T11:27:05Z

SteveT:

[[File:iconGroup.png|border]]

Group icons are a collection of consecutive command icons that are grouped together to make the program structure easier to view.

==Old Versions==
This page is current for Flowcode v11 and later. Earlier versions can be found below:
{| class="wikitable"
|+
|-
| [[Special:PermanentLink/38954|Flowcode v10]]
|-
| [[Special:PermanentLink/38954|Flowcode v9]]
|-
| [[Special:PermanentLink/38954|Flowcode v8]]
|}

==Details==

{| style="margin:0px; text-align:center;"
|-
|[[File:iconGroup.png|border]]
|width="50px" |→
|[[File:Properties_Group.png]]
|}

A group icon cannot be directly added to a macro. Instead, it is created by selecting a group of command icons and grouping them together as explained below.

Like other commands, group icons can be moved within the macro and copied to other macros.

'''Display Name'''

The name of the icon that appears on the flowchart.

'''View contents'''

The contents of the group icon can be viewed by clicking the "View contents" button in the property window, or by right-clicking the command icon and selecting the "Show macro" entry. The group's icons will be shown in a separate read-only macro window.

==Grouping commands==

Command and component icons can be grouped, if you would like to reduce the flowchart working area space.

For example, if you have several icons above the main loop, e.g.:

[[File:Group_Icons1.png]]

but you are only interested in simulation within the main loop then you can group the icons you are not interested in so the flowchart will look like this:

[[File:Group_Icons2.png]]

To group the icons, hold the left mouse button down and drag the icons you wish to group together.

Right-click on the selected group and select group Icons.

You can ungroup the icons by right-clicking on the selected group and selecting Ungroup Icons.

Note, the individual icons within the grouped icons will not be shown during the simulation. Therefore if you are single-stepping, the active simulation outline will remain on the grouped icons until all icons have been accessed.

Macro Icon Properties

2026-06-12T11:08:41Z

SteveT:

[[File:iconUserMacro.png|border]]

Macros are sections of code that can be used and reused in projects.

==Old Versions==
This page is current for Flowcode v9 and later. Earlier versions can be found below:
{| class="wikitable"
|+
|-
| [[Special:PermanentLink/10821|Flowcode v8]]
|}

==Details==
{| style="margin:0px; text-align:center;"
|-
|[[File:iconUserMacro.png|border]]
| width="50px" |→
|[[File:Gen_Macro_Flowchart_Icon_01.png]]
|width="50px" |→
|[[File:Gen_Macro_Icon_Properties_01.png]]
|}

'''Macros'''

Macros (explained here) 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.

On Macros the outer bands are clear and not hatched.

The macro properties dialog allows users to select and create macros.

'''Adding a Macro'''

Select the Macro to use from the list, or click on Create new macro to begin [[Creating a New Macro|creating a new macro]] to add to the list.

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

Clicking on the OK button completes the process and closes the dialog.

Clicking on the OK and edit button completes the process, closes the dialog and opens the selected macro for editing.

'''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 allows 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.

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

'''Create New Macro button'''

Select this button to [[Creating a New Macro|create a new macro]] within the flowchart.

'''OK & Edit Macro button'''

Clicking this button will open up the chosen macro to allow it to be viewed or edited.

==Macro types==
Macros are 3 types of macro that can be called using this command icon:

{| class="wikitable"
|+
|-
| [[Macro_Icon_Properties|Macros]]
| Macros designed and created by the user that are created as part of this project.
|-
| [[Component_Macro_Icon_Properties|Components]]
| Pre-defined macros supplied with the components. Only components that have been added to this project are available.
|-
| [[Simulation_Macro_Icon_Properties|Built-in Functions]]
| Simulation-only macros for advanced Flowcode use such as component creation.
|}

==Video==

See the [http://www.youtube.com/watch?v=SlWkK1mwyJQ&list=PLQDWBb7bxuCgg6aJgPJcfXBMzZdLILceQ Macros] video to learn how to call a macro from a selection of existing macros and input a macro parameter using the Macro icon.

<div align="center">
{{#ev:youtube|SlWkK1mwyJQ|640}}
</div>

Simulation Macro Icon Properties

2026-06-12T11:06:07Z

SteveT:

[[File:IconBuiltinFunction.png|border]]

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]]
|}

==Details==
{| style="margin:0px; text-align:center;"
|-
|[[File:IconBuiltinFunction.png|border]]
| width="50px" |→
|[[File:Gen_Simulation_Macro_Flowchart_Icon_01.png]]
|width="50px" |→
|[[File:Properties_ApiMacro.png]]
|}

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 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 call to a Built-in Function'''

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.

'''Parameters'''

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

==Macro types==
Macros are 3 types of macro that can be called using this command icon:

{| class="wikitable"
|+
|-
| [[Macro_Icon_Properties|Macros]]
| Macros designed and created by the user that are created as part of this project.
|-
| [[Component_Macro_Icon_Properties|Components]]
| Pre-defined macros supplied with the components. Only components that have been added to this project are available.
|-
| [[Simulation_Macro_Icon_Properties|Built-in Functions]]
| Simulation-only macros for advanced Flowcode use such as component creation.
|}

==Video==

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.

See the [http://www.youtube.com/watch?v=B_tOeSTeAbw&list=PLQDWBb7bxuCgg6aJgPJcfXBMzZdLILceQ Simulation Icon] video for information on the simulation functions available, the video highlights how they are organised and presented and how they can be used.

{| style="margin:auto;"
|-
|{{#ev:youtube|LSz0p0NqMBw}}
| width="100px" |
|{{#ev:youtube|B_tOeSTeAbw}}
|}

Component Macro Icon Properties

2026-06-12T11:02:56Z

SteveT:

[[File:iconComponentMacro.png|border]]

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.

==Old Versions==
This page is current for Flowcode v9 and later. Earlier versions can be found below:
{| class="wikitable"
|+
|-
| [[Special:PermanentLink/41380|Flowcode v8]]
|}

==Details==
{| style="margin:0px; text-align:center;"
|-
|[[File:iconComponentMacro.png|border]]
| width="50px" |→
|[[File:Gen_Component_Macro_Flowchart_Icon_01.png]]
|width="50px" |→
|[[File:Properties_CompMacro.png]]
|}

'''Adding a component macro'''

Components macros are listed in the properties window and are grouped by component.

Find the component from the list of attached components and click the "+" sign to its left to expand the list group to reveal the available component macros.

Select the macro and add in any parameters required, then optionally 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, strings 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 a compatible type to be accepted, and a full set of parameters must be provided.

Expressions can be used as parameters for example (5 + a) where a is a numeric variable. Expressions cannot contain string functions or other functions requiring the use of arrays.

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

==Macro types==
Macros are 3 types of macro that can be called using this command icon:

{| class="wikitable"
|+
|-
| [[Macro_Icon_Properties|Macros]]
| Macros designed and created by the user that are created as part of this project.
|-
| [[Component_Macro_Icon_Properties|Components]]
| Pre-defined macros supplied with the components. Only components that have been added to this project are available.
|-
| [[Simulation_Macro_Icon_Properties|Built-in Functions]]
| Simulation-only macros for advanced Flowcode use such as component creation.
|}

==Video==

See the [http://www.youtube.com/watch?v=Xh68YXcTdoU&list=PLQDWBb7bxuCgg6aJgPJcfXBMzZdLILceQ Component Macro] video to learn how to call component macros, this video features both the [[Component: ID 7aad74d6 b24e 4dab 91eb 5d72a973f12d|ADC]] Dial and [[Component: ID 0953aac0 9c23 4c2f 9843 88954a4191ea|LCD]] EB005 components and their associated Component Macros.

<div align="center">
{{#ev:youtube|Xh68YXcTdoU|640}}
</div>

Simulation Macro Icon Properties

2026-06-12T10:20:24Z

SteveT:

[[File:IconBuiltinFunction.png|border]]

Simulation-only macros for advanced Flowcode use such as component creation.

==Details==
{| style="margin:0px; text-align:center;"
|-
|[[File:IconBuiltinFunction.png|border]]
| width="50px" |→
|[[File:Gen_Simulation_Macro_Flowchart_Icon_01.png]]
|width="50px" |→
|[[File:Properties_ApiMacro.png]]
|}

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 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 call to a Built-in Function'''

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.

'''Parameters'''

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

==Macro types==
Macros are 3 types of macro that can be called using this command icon:

{| class="wikitable"
|+
|-
| [[Macro_Icon_Properties|Macros]]
| Macros designed and created by the user that are created as part of this project.
|-
| [[Component_Macro_Icon_Properties|Components]]
| Pre-defined macros supplied with the components. Only components that have been added to this project are available.
|-
| [[Simulation_Macro_Icon_Properties|Built-in Functions]]
| Simulation-only macros for advanced Flowcode use such as component creation.
|}

==Video==

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.

See the [http://www.youtube.com/watch?v=B_tOeSTeAbw&list=PLQDWBb7bxuCgg6aJgPJcfXBMzZdLILceQ Simulation Icon] video for information on the simulation functions available, the video highlights how they are organised and presented and how they can be used.

{| style="margin:auto;"
|-
|{{#ev:youtube|LSz0p0NqMBw}}
| width="100px" |
|{{#ev:youtube|B_tOeSTeAbw}}
|}

Icon Properties

2026-06-12T09:27:17Z

SteveT: /* Flowchart icons */

The properties of a command icon defines how it behaves when compiled/assembled and when simulated in Flowcode. As each icon has different properties that the user can edit: see the topic on the particular icon of interest.

To edit an icon's properties, either select the icon and the select the 'Properties' option from the 'Edit' menu (Edit > Properties) or simply double click on the icon in the macro view. The icon's properties can also be displayed by right clicking on the icon to display a context menu and then selecting properties from that menu.

==Old Versions==
This page is current for Flowcode v11 and later. Earlier versions can be found below:
{| class="wikitable"
|+
|-
| [[Special:PermanentLink/41775|Flowcode v10]]
|-
| [[Special:PermanentLink/23545|Flowcode v9]]
|-
| [[Special:PermanentLink/23545|Flowcode v8]]
|}

==Flowchart icons==

Flowchart icons are the commands used in most programming paradigms of Flowcode, i.e. Flowcharts, Code, Blocks and Pseudocode.

Click this link for more information on [[Editing Icon Properties]].

For information on specific icons then see the links below:

[[File:IconInput.png|border|link=Input Icon Properties]] [[Input Icon Properties]]

[[File:IconOutput.png|border|link=Output Icon Properties]] [[Output Icon Properties]]

[[File:IconDelay.png|border|link=Delay Icon Properties]] [[Delay Icon Properties]]

[[File:IconDecision.png|border|link=Decision Icon Properties]] [[Decision Icon Properties]]

[[File:IconSwitch.png|border|link=Switch Icon Properties]] [[Switch Icon Properties]]

[[File:IconLabel.png|border|link=Label Icon Properties]] [[Label Icon Properties]]

[[File:IconJump.png|border|link=Jump Icon Properties]] [[Jump Icon Properties]]

[[File:IconLoop.png|border|link=Loop Icon Properties]] [[Loop Icon Properties]]

[[File:IconUserMacro.png|border|link=Macro Icon Properties]] [[Macro_Icon_Properties|User Macro Icon Properties]]

[[File:IconComponentMacro.png|border|link=Component Macro Icon Properties]] [[Component Macro Icon Properties]]

[[File:IconBuiltinFunction.png|border|link=Simulation Macro Icon Properties]] [[Simulation_Macro_Icon_Properties|Built-in Functions Icon Properties]]

[[File:IconInterrupt.png|border|link=Interrupt Icon Properties]] [[Interrupt Icon Properties]]

[[File:IconCalculation.png|border|link=Calculation Icon Properties]] [[Calculation Icon Properties]]

[[File:IconCode.png|border|link=Code Icon Properties]] [[Code Icon Properties]]

[[File:IconComment.png|border|link=Comment Icon Properties]] [[Comment Icon Properties]]

[[File:IconGroup.png|border|link=Group Icon Properties]] [[Group Icon Properties]]

==State Diagram icons==

A different set of command icons are used for Flowcode's [[State_diagrams|State Diagram]] programming paradigm.

[[File:IconState.png|border|link=State_Icon_Properties]] [[State_Icon_Properties]]

[[File:IconExitState.png|border|link=Exit_State_Icon_Properties]] [[Exit_State_Icon_Properties]]

[[File:IconTransitionStraight.png|border|link=Transition_Icon_Properties]] [[File:IconTransitionCurved.png|border|link=Transition_Icon_Properties]] [[Transition_Icon_Properties]]

[[File:IconStateComment.png|border|link=Comment Icon Properties]] [[Comment Icon Properties]]

Output Icon Properties

2026-06-12T09:24:12Z

SteveT:

[[File:iconOutput.png|border]]

Output icon send the value or variable to the specified port and/or bits.

==Old Versions==
This page is current for Flowcode v11 and later. Earlier versions can be found below:
{| class="wikitable"
|+
|-
| [[Special:PermanentLink/23136|Flowcode v10]]
|-
| [[Special:PermanentLink/23136|Flowcode v9]]
|-
| [[Special:PermanentLink/10816|Flowcode v8]]
|}

==Details==
{| style="margin:0px; text-align:center;"
|-
|[[File:iconOutput.png|border]]
| width="50px" |→
|[[File:Gen_Output_Flowchart_Icon.png]]
|width="50px" |→
|[[File:Properties_Output1.png]]
|}

'''Display Name'''

The name of the icon that appears on the flowchart.

'''Port'''

Select from a list of the ports available on the target microcontroller

'''Variable or value'''

Select the name of the variable or a numeric value that you wish to output to the port. 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]].

Numeric values can be in decimal (unmarked), HEX (preceded by 0x) or binary format (preceded by 0b). e.g. 255, 0xFF, 0b11111111. Users can also use expressions inside the variable or value box, eg "x + 100".

==Advanced==

By selecting the 'Show advanced options' you can individual pins.

[[File:Properties_Output2.png]]

'''Single Bit'''

Use this option to write to a single bit of the port.

If a true (non zero) value is sent to the bit the bit is set (turned on), otherwise the bit is cleared (turned off).

'''Entire Port'''

Use this option to write the variable or value to the entire port.

'''Use Masking'''

When [[Using Masks|masking]] is used, it is possible to write to only certain bits of a port. This is useful when some bits of the port are configured as inputs and you wish to leave these bits unchanged.

With [[Using Masks|masking]] only the selected bits receive their value, all non selected bits are not affected.

'''Use chip references'''

When using target devices that have a mixture of a letter and a number or just a number, for example, on Arduino Uno - A2

If 'Use chip references' is unticked, you can select A2.

If 'Use chip references' is ticked, it will be PORT C2.

==Video==

See the [http://www.flowcode.co.uk/videos/videoview/?name=The+Output+icon&id=local&wiki=Output_Icon_Properties Output icon video] to see how this icon can be used in your Flowcode projects.

File:TransitionOrder.png

2026-06-12T09:18:58Z

SteveT: Transition Order Dialog

== Summary ==
Transition Order Dialog

File:Properties Transition.png

2026-06-12T09:18:40Z

SteveT: Transition Icon Properties Dialog

== Summary ==
Transition Icon Properties Dialog

File:Properties ExitState.png

2026-06-12T09:18:25Z

SteveT: Exit State Icon Properties Dialog

== Summary ==
Exit State Icon Properties Dialog

File:Properties State.png

2026-06-12T09:18:11Z

SteveT: State Icon Properties Dialog

== Summary ==
State Icon Properties Dialog

File:Properties Group.png

2026-06-12T09:17:57Z

SteveT: Group Icon Properties Dialog

== Summary ==
Group Icon Properties Dialog

File:Properties ApiMacro.png

2026-06-12T09:17:43Z

SteveT: Built-in Functions Macro Icon Properties Dialog

== Summary ==
Built-in Functions Macro Icon Properties Dialog

File:Properties CompMacro.png

2026-06-12T09:16:46Z

SteveT: Component Macro Icon Properties Dialog

== Summary ==
Component Macro Icon Properties Dialog

File:Properties Macro.png

2026-06-12T09:16:31Z

SteveT: User Macro Icon Properties Dialog

== Summary ==
User Macro Icon Properties Dialog

File:Properties Output2.png

2026-06-12T09:15:51Z

SteveT: Output Icon Properties Dialog (advanced)

== Summary ==
Output Icon Properties Dialog (advanced)

File:Properties Output1.png

2026-06-12T09:15:26Z

SteveT: Output Icon Properties Dialog

== Summary ==
Output Icon Properties Dialog

Loop Icon Properties

2026-06-11T16:28:52Z

SteveT:

[[File:iconLoop.png|border]]

Loop icons are used to repeat a task until specified conditions are fulfilled, or to perform the loop a set number of times.

==Old Versions==
This page is current for Flowcode v11 and later. Earlier versions can be found below:
{| class="wikitable"
|+
|-
| [[Special:PermanentLink/17609|Flowcode v10]]
|-
| [[Special:PermanentLink/17609|Flowcode v9]]
|-
| [[Special:PermanentLink/17609|Flowcode v8]]
|}

==Details==
{| style="margin:0px; text-align:center;"
|-
|[[File:iconLoop.png|border]]
| width="50px" |→
|[[File:Gen_Loop_Flowchart_Icon.png]]
|width="50px" |→
|[[File:Properties-loop.png]]
|}

==Loop types==
There are several types of loop as explained below.

===Loop forever===
Creates an infinite loop where the icons between the start and end of this loop icon are repeated forever. Many embedded programs require an infinite loop because the code running in the microcontroller will never stop. In versions of Flowcode prior to v11, a condition "While 1" would have been used instead to create an infinite loop.

===Loop while===
A "while" loop will repeat the icons if the test in the "expression" box is true. This expression can be tested at the start or at the end of the loop and it is at this point that the program decides to continue or abort the loop.

===Loop until===
An "until" loop is similar to the "while" loop, but this time the loop will repeat until the test in the "expression" box becomes true. Again, this can be tested at the beginning or the end of the loop.

===Loop count===
This allows a loop to be repeated a set number of times. The number of times to repeat is entered in the "count" box. Note that this value will usually be a constant or a literal value (e.g. "5").

An internal counter will be set to zero when the loop first begins and will be automatically incremented at the end of each loop iteration. At the beginning of each loop, this internal counter will be checked to see if it is less than the value of the "count", and if it is not then the loop will be aborted.

This internal counter can be set to an existing variable instead using the '''Count using a variable''' option. This will expose the number of iterations around the loop to the code within the loop start and end icons. This variable will show a value of "0" during the first loop iteration, "1" in the second loop iteration, etc.

==Properties==
'''Display Name'''

The name of the icon that appears on the flowchart.

'''Expression'''

The expression used to determine if the loop should continue or end. This is used by "while" and "until" versions of the loop command.

For a "while" loop, this loops the program while the specified condition is true.

For an "until" loop, this loops the program until the specified condition becomes true.

The expression is tested at the beginning or the end of the loop.

'''Variables Arrow'''

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]].

'''Test the loop at the:'''

Select whether you wish the loop's expression to be tested at the start or at the end of the loop. Testing at the end of the loop means that the code within the loop is guaranteed to execute at least once.

'''Loop count'''

Sets the loop to loop through a set number of iterations. The value should usually be a whole number between 1 and 99999999.

Note that a variable can be used for the "count" rather than a constant value. But be aware because changing the value of this variable within the loop could cause odd behaviour and make your program's execution difficult to predict.

'''Count using a variable'''

Allows an existing variable to be used as the count variable. When active, this resets the count variable to 0 when the loop first begins and automatically increments the variable at the end of each loop iteration. It is best that the value of this variable should not be altered within the loop by user code, otherwise the loop may behave unexpectedly.

==Video==
See the [http://www.flowcode.co.uk/videos/videoview/?name=The+Loop+icon&id=local&wiki=Loop_Icon_Properties Loop icon video] to see how this icon is used in a project.

MediaWiki:Sidebar

2026-06-10T16:22:51Z

SteveT:

Main Page

2026-06-10T16:11:55Z

SteveT:

{| cellpadding="4" style="border: 1px solid darkgray; float:right; width:300px"
|+ '''Flowcode'''
|-
| colspan="2"|[[File:fc-v9-thumb.png|center]]
|-
|width="40%"|'''Developer'''
|[http://matrixtsl.com Matrix TSL]
|-
|'''Website'''
|[http://www.flowcode.co.uk www.flowcode.co.uk]
|-
|'''Current version'''
|v11.0.1.14
|-
|'''Initial v11 release'''
|17/10/25
|-
|'''Previous versions'''
|
* v10 (2023)
* v9 (2020)
* v8 (2018)
* v7 (2016)
* v6 (2013)
* v5 (2011)
* v4 (2009)
* v3 (2006)
* v2 (2003)
* v1 (2001)
|-
|'''Operating system'''
|[http://en.wikipedia.org/wiki/Microsoft_Windows Windows 10,11]
|-
|'''Platform'''
| [http://en.wikipedia.org/wiki/IA-32 IA-32] and [http://en.wikipedia.org/wiki/X86-64 x86-64]
|-
|'''Available in'''
|English, French, German, Spanish, Italian, Chinese (Traditional)
|-
|'''Type'''
|Advanced graphical programming software
|-
|'''License'''
|[http://en.wikipedia.org/wiki/Proprietary_software Proprietary]
|}
__NOTOC__

[[File:fc-v9-mainlogo-01.png|center]]

[[File:Fc10 what is flowcode1.jpg]] &ensp;&ensp; [[File:Web Barometer Web App.jpg]]

<br><br>

==Old Versions==
This page is current for Flowcode v11 and later. Earlier versions can be found below:
{| class="wikitable"
|-
| [[Special:PermanentLink/41232|Flowcode v10]]
|-
| [[Special:PermanentLink/24519|Flowcode v9]]
|-
| [[Special:PermanentLink/23678|Flowcode v8]]
|}

<br>

==[[About_Flowcode|About Flowcode]]==

Flowcode is a graphical programming Integrated Development Environment (IDE) that allows you to develop highly functional electrical,<br>
electronic and electromechanical systems for microcontroller based systems and for Windows PCs and tablets.

==[[Flowcode Embedded]]==
Flowcode Embedded allows you to easily create highly functional programs for popular microcontrollers.

==[[App Developer|Flowcode App Developer]]==
Flowcode App Developer allows you to create great Human Machine Interfaces for PCs, tablets and mobile phones using low cost<br>
input output boards - locally (USB/Buetooth) or remotely (Wi-Fi, LAN, Internet) using Windows or web browsers.

==[[Flowcode Help Overview|Using Flowcode]]==
Detailed glossary style overview of the aspects of the Flowcode environment broken down into relevant sections to aid in finding the knowledge<br>you require to use Flowcode effectively.

==[[Icon Properties|Command Icons]]==
A list of the command icons used in Flowcode projects.

==[[Exercises|Examples and Tutorials]]==
This page contains structured exercises used throughout Flowcode Help section, and further exercises<br>
which are not featured in the Flowcode Help structure these additional exercises range from expanded exercises<br>
on camera control and panel navigation to creating, testing, exporting and importing components.

==[[Components|Component Library]]==
List of components which provide detailed information about individual components as well as examples of them in use.<br>
The information provided includes component and simulation macro references as well as property references and component functionality.

==[[Flowcode_Debugging|Flowcode Debugging]]==
Learn how Flowcode can help you debug your programs with a variety of tools and technologies designed to streamline the debugging process.

==[[Simulation_Functionality|Simulation Library]]==
Structured overview of the library of Simulation Event macros and Simulation Functions.<br>
The information provided includes simulation macro references as well as event triggers and functionality.

==[[Component_Creation|Component Creation]]==
Creating your own components in Flowcode gives you massive amounts of flexibility in your projects,<br>this section covers how to create your own components and has some working examples to help.

==[[What's New|What's New]]==
This page contains all the new exciting features introduced in this latest version of Flowcode.

==[[Glossary|Glossary]]==
This glossary helps general programmers understand Flowcode-specific terms and concepts.

Interrupt Icon Properties

2026-06-10T15:59:27Z

SteveT:

[[File:IconInterrupt.png|border]]

Interrupts are called to react to an event such as an external stimulus, or a timing event.

When an interrupt is activated it executes a Macro. The macro to be called is specified by the user when creating the interrupt.

==Details==
{| style="margin:0px; text-align:center;"
|-
|[[File:IconInterrupt.png|border]]
| width="50px" |→
|[[File:Gen_Interrupt_Flowchart_Icon_01.png]]
|width="50px" |→
|[[File:Gen_Interrupt_Icon_Properties_01.png]]
|}

The number and types of interrupts available are dependent on the device used. Some devices have a number of interrupts whereas other devices may only have a few.

The exact details, properties and operation of an interrupt vary from interrupt to interrupt. Users will need to refer to the interrupt dialogs for exact details of any particular Interrupt. However there are four main types that Flowcode uses:

*TMR<X> - overflow - reacts to the clocked overflow event from onboard timer X.
*INT - reacts to an input change on a specific external interrupt pin.
*IOC (Interrupt On Change) - reacts to any change on a specified collection of inputs
*Custom - defines a custom interrupt procedure.

[[Interrupts|Click here for some example programs using Interrupts.]]

Other interrupts may be available depending on the target chip, such as the "Receive" interrupt for chips with a UART available.

Details of the various interrupts can be found below, along with example of available properties.

==Creating an interrupt==

[[File:Gen_Interrupt_Icon_Properties_01.png]]

Add an Interrupt icon to the program.

Select Enable Interrupt or Disable Interrupt to turn the interrupt on or off respectively.

Select the desired interrupt from the drop down list of interrupts available from that particular device.

Set the properties for that event.

Set the macro to call, or [[Creating a New Macro|create a new macro]].

==Interrupt properties==

[[File:Gen_Interrupt_Icon_Properties_TMR0_Properties.png]]

==TMR Timer overflow Interrupt==

TMR0, for example, interrupts when the timer overflows. A count is made internally based on clock inputs and the pre-scaler property (see below for details).

When the count reaches a certain point it overflows back to 0 triggering an Overflow event. This event can then be used to call a macro. Timer overflow interrupts are called repeatedly at the Interrupt time interval making them very useful for time based events, or for frequently needed features such as display updates.

Note: Check that the clock speed setting is correct (via the [[Project Options#General Options|Project Options]]) as clock speed affects timer interrupt frequency settings.

The exact properties available for a timer interrupt are device and timer dependent. As such the timer overflow dialogs may vary from device to device and from timer to timer. The example below is intended to give an idea of the kind of properties available for a Timer overflow interrupt.

Specific details can be found in the Interrupt dialogs, and from Device datasheets.

TMR1 on the 16F877A, for instance, has a smaller set of pre-scaler options than the TMR0 interrupt, and also no source edge settings available unlike the TMR0 interrupt.

The TMR2 interrupt has an additional setting called the rollover value. This changes the rollover value in the timer register that is responsible for triggering the interrupt which allows for much better control over interrupt frequency. This advanced timeout functionality can be replicated with the other timers by writing to the timer count registers directly using C code.

'''Note:''' Certain Flowcode components such as the PWM and Servo consume some of the timer peripherals. For details on the hardware consumed by a component please refer to the specific [[Component Help Files|component help file]].

====Example of TMR0 properties:====

'''Clock source select'''

Select the clock source signal to use for the overflow timing.

Options available are device dependent.

Examples:

*Internal clock (CLK0)

*Transition on T0CKI

'''Source edge select'''

Select the transition edge used for clock signal timing.

*High-to-low transition on T0CKI

*Low-to-high transition on T0CKI

'''Prescaler rate'''

Select a pre-scaler rate for the clock signal.

A prescaler divides down the clock signals used for the timer giving reduced overflow rates.

The rate can be set to a number of possible values. The exact values are chip dependent.

E.g. for the PIC16F877A values area a number of values are available ranging from 1:1 to 1:256.

The prescaler value is used in conjunction with the clock speed to set an overflow frequency.

E.g.
*Clock speed:- 19660800
*Prescale value:- 1:256
*Interrupt frequency 75Hz
*Clock speed:- 19660800
*Prescale value:- 1:64
*Interrupt frequency 300Hz

'''INT'''

Triggered when an external stimulus is used on an external interrupt (INT) pin (e.g. a Button press)

The interrupt can be set to trigger on the:

Falling edge of INT

Rising edge of INT

INT interrupts can be useful in setting interrupts to occur on signal on or signal off events, such as an emergency shut off switch.

'''Port change'''

Interrupts when an input signal occurs on any of a selected group of port inputs.

The Port change interrupt may have properties allowing the interrupt I/O pins to be enabled or disabled as interrupt pins.

==Custom interrupts==

The Custom option allows the creation of custom interrupt code.

Many of the chips available in Flowcode support hardware driven interrupts that are not provided in the standard set of Flowcode interrupts. To allow users to add their own interrupts to suit their application Flowcode has the option to add your own custom interrupt.

'''Interrupt Property page'''

[[File:Gen_Interrupt_Icon_Properties_Custom.png]]

'''Custom Interrupt property page'''

[[File:Gen_Custom_Interrupt_Properties.png]]

A range of different custom interrupts are available for each chip:

* [[Custom Interrupts - PICmicro|PICmicro Custom Interrupts]]
* [[Custom Interrupts - AVR|AVR Custom Interrupts]]
* [[Custom Interrupts - ARM|ARM Custom Interrupts]]
* [[Custom Interrupts - dsPIC/PIC24|dsPIC/PIC24 Custom Interrupts]]

==Video==
See the [http://www.youtube.com/watch?v=2a1UUrfxGFE&list=PLQDWBb7bxuCgg6aJgPJcfXBMzZdLILceQ Adding an Interrupt] video for an introduction of interrupts, you can learn how to use interrupts as well as what they can be used for, this video also provides a brief overview of different types of interrupts and mentions that different interrupts are available on different devices.

<div align="center">
{{#ev:youtube|2a1UUrfxGFE|640}}
</div>

Simulation Macro Icon Properties

2026-06-10T15:55:22Z

SteveT:

[[File:IconBuiltinFunction.png|border]]

==Details==
{| style="margin:0px; text-align:center;"
|-
|[[File:IconBuiltinFunction.png|border]]
| width="50px" |→
|[[File:Gen_Simulation_Macro_Flowchart_Icon_01.png]]
|width="50px" |→
|[[File:Gen_Simulation_Macro_Icon_Properties_01.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.

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.

'''Adding a simulation macro'''

Select the component and then [[Selecting Component Macros|select the Simulation Macro icon.]]

Select the component name 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.

OR

Select the Simulation Macro icon and click the 'Functions' section.

Select filter through the categories and search through the list of all available functions.

Select the macro and fill in the 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 [[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.

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

==Other macro types==
Macros are split into (user) Macros, Component macros and Built-in Functions.

[[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.

Component macros have hatched outer bands on the icon.

Built-in Functions are simulation-only macros for advanced Flowcode use.

[[Macro_Icon_Properties|User 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.

On Macros the outer bands are clear and not hatched.

==Video==

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.

See the [http://www.youtube.com/watch?v=B_tOeSTeAbw&list=PLQDWBb7bxuCgg6aJgPJcfXBMzZdLILceQ Simulation Icon] video for information on the simulation functions available, the video highlights how they are organised and presented and how they can be used.

{| style="margin:auto;"
|-
|{{#ev:youtube|LSz0p0NqMBw}}
| width="100px" |
|{{#ev:youtube|B_tOeSTeAbw}}
|}

Component Macro Icon Properties

2026-06-10T15:49:42Z

SteveT:

[[File:iconComponentMacro.png|border]]

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.

==Details==
{| style="margin:0px; text-align:center;"
|-
|[[File:iconComponentMacro.png|border]]
| width="50px" |→
|[[File:Gen_Component_Macro_Flowchart_Icon_01.png]]
|width="50px" |→
|[[File:Gen_Component_Macro_Icon_Properties_01.png]]
|}

'''Adding a component macro'''

Select the component and then [[Selecting Component Macros|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, strings 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.

Note that a full set of parameters must be provided.

Expressions can be used as parameters for example (5 + a) where a is a numeric variable. Expressions cannot contain string functions or other functions requiring the use of arrays.

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

==Other macro types==

[[Creating a New Macro|User 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.

On Macros the outer bands are clear and not hatched.

[[Simulation Macro Icon Properties|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.

==Video==

See the [http://www.youtube.com/watch?v=Xh68YXcTdoU&list=PLQDWBb7bxuCgg6aJgPJcfXBMzZdLILceQ Component Macro] video to learn how to call component macros, this video features both the [[Component: ID 7aad74d6 b24e 4dab 91eb 5d72a973f12d|ADC]] Dial and [[Component: ID 0953aac0 9c23 4c2f 9843 88954a4191ea|LCD]] EB005 components and their associated Component Macros.

<div align="center">
{{#ev:youtube|Xh68YXcTdoU|640}}
</div>

Macro Icon Properties

2026-06-10T15:46:35Z

SteveT:

[[File:iconUserMacro.png|border]]

Macros are sections of code that can be used and reused in projects.

==Details==
{| style="margin:0px; text-align:center;"
|-
|[[File:iconUserMacro.png|border]]
| width="50px" |→
|[[File:Gen_Macro_Flowchart_Icon_01.png]]
|width="50px" |→
|[[File:Gen_Macro_Icon_Properties_01.png]]
|}

'''Macros'''

Macros (explained here) 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.

On Macros the outer bands are clear and not hatched.

The macro properties dialog allows users to select and create macros.

'''Adding a Macro'''

Select the Macro to use from the list, or click on Create new macro to begin [[Creating a New Macro|creating a new macro]] to add to the list.

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

Clicking on the OK button completes the process and closes the dialog.

Clicking on the OK and edit button completes the process, closes the dialog and opens the selected macro for editing.

'''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 allows 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.

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

'''Create New Macro button'''

Select this button to [[Creating a New Macro|create a new macro]] within the flowchart.

'''OK & Edit Macro button'''

Clicking this button will open up the chosen macro to allow it to be viewed or edited.

==Other macro types==
[[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.

Component macros have hatched outer bands on the icon.

[[Simulation Macro Icon Properties|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.

==Video==

See the [http://www.youtube.com/watch?v=SlWkK1mwyJQ&list=PLQDWBb7bxuCgg6aJgPJcfXBMzZdLILceQ Macros] video to learn how to call a macro from a selection of existing macros and input a macro parameter using the Macro icon.

<div align="center">
{{#ev:youtube|SlWkK1mwyJQ|640}}
</div>

Switch Icon Properties

2026-06-10T15:38:43Z

SteveT:

[[File:iconSwitch.png|border]]

Switch icons are similar to [[Decision Icon Properties|decision icons]] only instead of two possible outcome branches (Yes, No) there are up to eleven.

They are particularly useful for tailoring your program to react in different ways based on an input variable.

==Details==
{| style="margin:0px; text-align:center;"
|-
|[[File:iconSwitch.png|border]]
| width="50px" |→
|[[File:Gen_Switch_Flowchart_Icon_01.png]]
|width="50px" |→
|[[File:Gen_Switch_Icon_Properties_01.png]]
|}

'''Display Name'''

The name of the icon that appears on the flowchart.

'''Switch'''

This is the input parameter variable that is used to determine the branch of the switch that will be executed at run time.

'''Variables Arrow'''

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]].

'''Case options'''

Up to ten branches can be defined for the switch icon. The switch branches are enabled by ticking the tick boxes next to the values.

The value in the case box is the value that is used to trigger that particular branch of the switch icon. If none of the values match the input parameter variable then the default branch of the switch case is used.

Case values need to be contestants/literals i.e values that cannot be modified
Examples include '''5 'H' 0x23'''.

==Video==

See the [http://www.youtube.com/watch?v=Op-l1YntjqY&list=PLQDWBb7bxuCgg6aJgPJcfXBMzZdLILceQ Switch] video to learn how to use the Switch icon to create various paths with different outcomes which are executed depending on the value of a variable.

Decision Icon Properties

2026-06-10T15:20:14Z

SteveT:

[[File:iconDecision.png|border]]

Decision icons allow you to test a condition and redirect the flow according to the outcome.
Icons can be placed in either branch from the decision icon.

==Old Versions==
This page is current for Flowcode v11 and later. Earlier versions can be found below:
{| class="wikitable"
|+
|-
| [[Special:PermanentLink/13001|Flowcode v10]]
|-
| [[Special:PermanentLink/13001|Flowcode v9]]
|-
| [[Special:PermanentLink/13001|Flowcode v8]]
|}

==Details==
{| style="margin:0px; text-align:center;"
|-
|[[File:iconDecision.png|border]]
| width="50px" |→
|[[File:Gen_Decision_Flowchart_Icon.png]]
|width="50px" |→
|[[File:Gen_Decision_Icon_Properties.png]]
|}

'''Display Name'''

The name of the icon that appears on the flowchart.

'''Condition'''

The decision box tests this condition to see which branch to continue down. If the condition evaluates to 0 or false then the 'No' branch is chosen. If the condition evaluates to a non zero number or true then the 'Yes' branch is chosen. Conditions can be made up from numbers, variables and operators:

See [[Calculation Icon Properties]] for a list of valid operators.

Numeric values can be in decimal (unmarked) or in HEX format (preceded by 0x) or in Binary format (preceded by 0b) e.g. 255 or 0xFF or 0b01010101.

Assuming that the variables have been previously defined, all the following are valid conditions.

DELAY = DELAY + 1

DELAY = (MYVAR + 3) * 3

NEXTBIT = LASTBIT >> 2 & MASK

AANDB = PORT_A AND PORT_B

INVX = NOT X

To test for two or more conditions, write tests for the individual conditions and combine them with logical operators.

When both conditions must be true: condition1 && condition2

When one condition being true suffices: condition1 || condition2

Assuming that the variables have been previously defined, all the following are valid conditions.

(DELAY = 1) && (X = 0)

(DELAY = 1) || (DELAY = 4)

(DELAY = 1) || ( (DELAY = 3) && (X = 0) )

'''Variables Arrow'''

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]].

'''Swap Yes and No'''

Normally the 'Yes' path of execution goes off to the right of the decision icon and the 'No' path carries on down the flowchart. Select this option to swap the two branches around.

'''Boolean values'''

Flowcode treats zero as false and any non-zero value as true.

This allows the use of variables in a true or false context.

For example 'If TIMEUP' would execute the 'Yes' path if TIMEUP was non-zero.

==Video==

See the [http://www.flowcode.co.uk/videos/videoview/?name=The+Decision+icon&id=local&wiki=Decision_Icon_Properties Decision icon video] to see how this icon can be used in your Flowcode projects.

Delay Icon Properties

2026-06-10T15:16:14Z

SteveT:

[[File:iconDelay.png|border]]

Delay icons are used to slow down program execution and for program timing.

They are particularly useful in slowing program execution speed down to allow for human interaction.

==Old Versions==
This page is current for Flowcode v11 and later. Earlier versions can be found below:
{| class="wikitable"
|+
|-
| [[Special:PermanentLink/10817|Flowcode v10]]
|-
| [[Special:PermanentLink/10817|Flowcode v9]]
|-
| [[Special:PermanentLink/10817|Flowcode v8]]
|}

==Details==
{| style="margin:0px; text-align:center;"
|-
|[[File:iconDelay.png|border]]
| width="50px" |→
|[[File:Gen_Delay_Flowchart_Icon.png]]
|width="50px" |→
|[[File:Gen_Delay_Icon_Properties.png]]
|}

'''Display Name'''

The name of the icon that appears on the flowchart.

'''Delay value or variable'''

This is the length of the delay that you wish to create. 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]].

'''Microseconds/Milliseconds/Seconds options'''

Delays can be specified in units of microseconds, milliseconds or seconds. When simulating delays in seconds, a dialog box will appear showing how much of the delay has elapsed. A cancel button on the dialog allows the execution of the flowchart to continue before the entire delay has passed.

To allow Flowcode to correctly program your chip with the correct delay setting you will need to [[Changing the Speed of a Simulation|select a clock speed]] for your chip. The clock speed setting must correctly reflect the [[Configuring the Chip|settings and configuration]] of the hardware used. The dialog box for this can be seen by selecting Build > Project Options.

==Video==

See the [http://www.flowcode.co.uk/videos/videoview/?name=The+Delay+icon&id=local&wiki=Delay_Icon_Properties Delay icon video] to see how this icon can be used in your Flowcode projects.

Output Icon Properties

2026-06-10T15:12:55Z

SteveT:

[[File:iconOutput.png|border]]

Output icon send the value or variable to the specified port and/or bits.

==Old Versions==
This page is current for Flowcode v11 and later. Earlier versions can be found below:
{| class="wikitable"
|+
|-
| [[Special:PermanentLink/23136|Flowcode v10]]
|-
| [[Special:PermanentLink/23136|Flowcode v9]]
|-
| [[Special:PermanentLink/10816|Flowcode v8]]
|}

==Details==
{| style="margin:0px; text-align:center;"
|-
|[[File:iconOutput.png|border]]
| width="50px" |→
|[[File:Gen_Output_Flowchart_Icon.png]]
|width="50px" |→
|[[File:Gen_Output_Icon_Properties.png]]
|}

'''Display Name'''

The name of the icon that appears on the flowchart.

'''Variable or value'''

Select the name of the variable or a numeric value that you wish to output to the port. 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]].

Numeric values can be in decimal (unmarked), HEX (preceded by 0x) or binary format (preceded by 0b). e.g. 255, 0xFF, 0b11111111. Users can also use expressions inside the variable or value box, eg "x + 100".

'''Port'''

Select from a list of the ports available on the target microcontroller

'''Single Bit'''

Use this option to write to a single bit of the port.

If a true (non zero) value is sent to the bit the bit is set (turned on), otherwise the bit is cleared (turned off).

'''Entire Port'''

Use this option to write the variable or value to the entire port.

'''Use Masking'''

When [[Using Masks|masking]] is used, it is possible to write to only certain bits of a port. This is useful when some bits of the port are configured as inputs and you wish to leave these bits unchanged.

With [[Using Masks|masking]] only the selected bits receive their value, all non selected bits are not affected.

==Video==

See the [http://www.flowcode.co.uk/videos/videoview/?name=The+Output+icon&id=local&wiki=Output_Icon_Properties Output icon video] to see how this icon can be used in your Flowcode projects.

Input Icon Properties

2026-06-10T15:07:44Z

SteveT:

[[File:iconInput.png|border]]

Input icons check the specified port and/or bits for their value and then place the resulting value into the specified variable.

==Old Versions==
This page is current for Flowcode v11 and later. Earlier versions can be found below:
{| class="wikitable"
|+
|-
| [[Special:PermanentLink/29624|Flowcode v10]]
|-
| [[Special:PermanentLink/10815|Flowcode v9]]
|-
| [[Special:PermanentLink/10815|Flowcode v8]]
|}

==Details==

{| style="margin:0px; text-align:center;"
|-
|[[File:iconInput.png|border]]
| width="50px" |→
|[[File:Gen_Input_Flowchart_Icon.png]]
|width="50px" |→
|[[File:Gen_Input_Icon_Properties.png]]
|}

'''Display Name'''

The name of the icon that appears on the flowchart.

'''Port'''

Select from a list of the ports available on the target microcontroller.

'''Variable'''

Select the name of the variable that you wish to input the port state into. 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]].

==Advanced==

By selecting the 'Show advanced options' you can individual pins.

[[File:Gen_Input_Icon_Properties2.png]]

'''Single Bit'''

Use this option to read the state of a single bit of the port.

When the state of a single bit is true the value of that bit is passed as its value.

'''Entire Port'''

Use this option to read the value of the entire port into the variable.

'''Use Masking'''

When [[Using Masks|masking]] is used, it is possible to read only certain bits into a variable. This is useful when some bits of the port are configured as outputs.

When a [[Using Masks|mask]] is used only the values of the selected bits are read.

'''Use chip references'''

When using target devices that have a mixture of a letter and a number or just a number, for example, on Arduino Uno - A2

If 'Use chip references' is unticked, you can select A2.

If 'Use chip references' is ticked, it will be PORT C2.

==Video==

See the [http://www.flowcode.co.uk/videos/videoview/?name=The+Input+icon&id=local&wiki=Input_Icon_Properties Input icon video] to see how this icon can be used in your Flowcode projects.

Jump Icon Properties

2026-06-10T15:06:18Z

SteveT:

[[File:iconJump.png|border|link=]]

Jump icons are added to a Flowcode project macro to allow program execution to unconditionally jump to another location in the macro.

In earlier versions of Flowcode, these were called "Connection Points" and the only type of jump supported was the "Goto" jump. Since v11.0.2, Flowcode now supports other types of unconditional jump: "Break", "Continue" and "Return".

==Old Versions==
This page is current for Flowcode v11 and later. Earlier versions can be found below:
{| class="wikitable"
|+
|-
| [[Special:PermanentLink/10814|Flowcode v10]]
|-
| [[Special:PermanentLink/10814|Flowcode v9]]
|-
| [[Special:PermanentLink/10814|Flowcode v8]]
|}

Note that in previous versions of Flowcode, the Label/Jump icons were called "Connection Points".

==Details==

{| style="margin:0px; text-align:center;"
|-
|[[File:iconJump.png|border|link=]]
| width="50px" |→
|[[File:Gen_Goto_Connection_Point_Flowchart_Icon.png]]
| width="50px" |→
|[[File:Properties_Jump.png|link=]]
|}

'''Display Name'''

The name of the icon that appears on the flowchart.

'''Goto / Break / Continue / Return'''

The type of jump. More information on each jump type is below.

'''Jump to label'''

The label to jump to if using the "Goto" type of jump.

==Jump Types==

===Goto===

A "Goto" jump is used to link program flow from one part of a macro to another. To achieve this, the macro must already have a [[Label_Icon_Properties|Label]] command icon. When program execution reaches the Jump command, it will unconditionally jump to the corresponding Label command that is set in the "Jump to label" dropdown.

'''Note:''' Using Jump::Goto commands is generally seen as bad programming practice and they should be avoided where possible. It makes projects more difficult to debug, and most well written programs will usually not need to use this icon.

===Break===

A "Break" jump prematurely exits a [[Loop_Icon_Properties|Loop]] or [[Switch_Icon_Properties|Switch]] command. Program execution will continue with the command immediately after the end of the Loop or Switch that contains the "Break" jump command.

It must occur within a Loop or Switch command, otherwise an error will occur. If it is contained within multiple 'levels' of Loop or Switch commands, it will jump out of the inner-most command.

===Continue===

A "Continue" jump prematurely exits the current iteration of a [[Loop_Icon_Properties|Loop]]. If the Loop's test remains true, the next iteration of the Loop will be performed. Otherwise, program execution will exit the Loop and continue with the command directly following the end of the Loop.

===Return===

A 'Return' jump command can be located anywhere in a macro. When the program executes this command, it will immediately exit the current macro and will not execute any other code in the macro. If this macro returns a value, the current value of the return variable is returned.

== Video ==

See the [http://www.flowcode.co.uk/videos/videoview/?name=The+Jump+icon&id=local&wiki=Jump_Icon_Properties Jump icon video] to see how this icon can be used in your Flowcode projects.

Label Icon Properties

2026-06-10T15:04:54Z

SteveT: /* Details */

[[File:iconLabel.png|border]]

Label icons can be added anywhere in a Flowcode project and provide a way of identifying a particular location within the code.

Their main use is to link program flow from one part of a macro to another. This is achieved by using the [[Jump_Icon_Properties|Jump::Goto]] command icon, which performs an unconditional jump from the Jump command to an associates Label command.

'''Note:''' Using Jump::Goto commands is generally seen as bad programming practice and they should be avoided where possible. It makes projects more difficult to debug, and most well written programs will usually not need to use this icon.

==Old Versions==
This page is current for Flowcode v11 and later. Earlier versions can be found below:
{| class="wikitable"
|+
|-
| [[Special:PermanentLink/10814|Flowcode v10]]
|-
| [[Special:PermanentLink/10814|Flowcode v9]]
|-
| [[Special:PermanentLink/10814|Flowcode v8]]
|}

Note that in previous versions of Flowcode, the Label/Jump icons were called "Connection Points".

==Details==
When the program execution reaches the jump point, it jumps to the matching label and then continues execution.

Labels and Jump::Goto commands are used in pairs, part one is the Label icon - the point in the flowchart to jump to. Part two is the Jump::Goto icon - the point in the flowchart to jump from. Both parts share a connection letter - in this case 'A'. Several jump points can reference the same label.

=== Part one: the label icon ===

{| style="margin:0px; text-align:center;"
|-
|[[File:iconLabel.png|border]]
| width="50px" |→
|[[File:Gen_Connection_Point_Flowchart_Icon.png]]
| width="50px" |→
|[[File:Properties_Label.png]]
|}

'''Display Name'''

The name of the icon that appears on the flowchart.

'''Label'''

The text that will be displayed on the connection point allowing for meaningful labels to be created.

=== Part two: the jump icon ===

{| style="margin:0px; text-align:center;"
|-
|[[File:iconJump.png|border]]
| width="50px" |→
|[[File:Gen_Goto_Connection_Point_Flowchart_Icon.png]]
| width="50px" |→
|[[File:Properties_Jump.png]]
|}

'''Display Name'''

The name of the icon that appears on the flowchart.

'''Jump to Connection Point'''

Select the connection point definition that you wish to jump to. This option is not available if the icon is the definition of the connection point rather than a jump.

== Example ==
[[File:JumpToLabelExample.png|border]]

This simple example shows an infinite loop.

When the program execution reaches the Jump command, it will unconditionally jump to the "My Label" command.

Any command icons below the Jump icon will not be executed, unless there is another jump to those locations.

== Video ==

See the [http://www.flowcode.co.uk/videos/videoview/?name=The+Label+and+Jump-Goto+icons&id=local&wiki=Label_Icon_Properties Label and Jump::Goto video] to see how Labels and Jumps can be used in your Flowcode projects.
</div>

Label Icon Properties

2026-06-10T15:03:43Z

SteveT:

[[File:iconLabel.png|border]]

Label icons can be added anywhere in a Flowcode project and provide a way of identifying a particular location within the code.

Their main use is to link program flow from one part of a macro to another. This is achieved by using the [[Jump_Icon_Properties|Jump::Goto]] command icon, which performs an unconditional jump from the Jump command to an associates Label command.

'''Note:''' Using Jump::Goto commands is generally seen as bad programming practice and they should be avoided where possible. It makes projects more difficult to debug, and most well written programs will usually not need to use this icon.

==Old Versions==
This page is current for Flowcode v11 and later. Earlier versions can be found below:
{| class="wikitable"
|+
|-
| [[Special:PermanentLink/10814|Flowcode v10]]
|-
| [[Special:PermanentLink/10814|Flowcode v9]]
|-
| [[Special:PermanentLink/10814|Flowcode v8]]
|}

Note that in previous versions of Flowcode, the Label/Jump icons were called "Connection Points".

==Details==
When the program execution reaches the jump point, it jumps to the matching label and then continues execution.

Labels and Jump::Goto commands are used in pairs, part one is the Label icon - the point in the flowchart to jump to. Part two is the Jump::Goto icon - the point in the flowchart to jump from. Both parts share a connection letter - in this case 'A'. Several jump points can reference the same label.

=== Part one: the label icon ===

{| style="margin:0px; text-align:center;"
|-
|[[File:iconLabel.png|border]]
| width="50px" |→
|[[File:Properties_Label.png]]
|}

'''Display Name'''

The name of the icon that appears on the flowchart.

'''Label'''

The text that will be displayed on the connection point allowing for meaningful labels to be created.

=== Part two: the jump icon ===

{| style="margin:0px; text-align:center;"
|-
|[[File:iconJump.png|border]]
| width="50px" |→
|[[File:Properties_Jump.png]]
|}

'''Display Name'''

The name of the icon that appears on the flowchart.

'''Jump to Connection Point'''

Select the connection point definition that you wish to jump to. This option is not available if the icon is the definition of the connection point rather than a jump.

== Example ==
[[File:JumpToLabelExample.png|border]]

This simple example shows an infinite loop.

When the program execution reaches the Jump command, it will unconditionally jump to the "My Label" command.

Any command icons below the Jump icon will not be executed, unless there is another jump to those locations.

== Video ==

See the [http://www.flowcode.co.uk/videos/videoview/?name=The+Label+and+Jump-Goto+icons&id=local&wiki=Label_Icon_Properties Label and Jump::Goto video] to see how Labels and Jumps can be used in your Flowcode projects.
</div>

Calculation Icon Properties

2026-06-10T15:02:17Z

SteveT:

[[File:iconCalculation.png|border]]

Calculation icons allow the modification of variables. They can be used to check inputs and to create outputs.

==Old Versions==
This page is current for Flowcode v11 and later. Earlier versions can be found below:
{| class="wikitable"
|+
|-
| [[Special:PermanentLink/40298|Flowcode v10]]
|-
| [[Special:PermanentLink/15396|Flowcode v9]]
|-
| [[Special:PermanentLink/15396|Flowcode v8]]
|}

==Details==
{| style="margin:0px; text-align:center;"
|-
|[[File:iconCalculation.png|border]]
| width="50px" |→
|[[File:Gen_Calculation_Flowchart_Icon_01.png]]
|width="50px" |→
|[[File:Gen_Calculation_Icon_Properties_01.png]]
|}

===Display Name===

The name of the icon that appears on the flowchart.

===Calculations===

One or more lines of calculations can be entered into this box.

All calculations must consist of the name of an existing variable, and equals sign and an expression made up from numbers, variables and the following operators:

{| class="wikitable"
|+ Caption text
|-
! '''Operator''' !! '''Description'''
|-
| ( ) || Parentheses
|-
| = == || Equal to
|-
| <> != || Not equal to
|-
| + - * / || Addition, Subtraction, Multiplication, Division
|-
|MOD % || Modulus
|-
| < <= || Less than, Less than or equal to
|-
| > >= || Greater than, Greater than or equal to
|-
| >> << || Shift right, Shift left
|-
| NOT ~ || Bitwise NOT
|-
| AND & || Bitwise AND
|-
| OR <nowiki>|</nowiki> || Bitwise OR
|-
| XOR ^ || Bitwise Exclusive OR
|-
| && || Logical AND
|-
| <nowiki>||</nowiki> || Logical OR
|-
| ! || Logical NOT
|}

Flowcode generally uses the same basic operators as C, but also has English equivalents such as NOT, OR and MOD as shown in the table above. The other difference is a single '=' or a double '==' can be used to compare two values, whereas C always uses double '=='.

Numeric values can be in decimal (unmarked) or in HEX format (preceded by 0x) or in Binary format (preceded by 0b) e.g. 85 or 0x55 or 0b01010101.

===Examples===

Assuming that the variables have been previously defined, all the following are valid calculation lines.

DELAY = DELAY + 1

DELAY = (MYVAR + 3) * 3

NEXTBIT = LASTBIT >> 2 & MASK

AANDB = PORT_A AND PORT_B

INVX = NOT X

$PORTA = $PORTA + 1

$pin39 = $A2

$pin2 = 1

The $ donates a pin or a port that can now be used within calculations.

If any of the variables don't exist, then Flowcode will ask if you would like to create the missing variable.

[[File:Gen_Calculation_Flowchart_Icon_02.png]]

==Variable and Function Box==

This section is used to either select a variable or access a list of the available functions. You can reference ports directly or select from a list of available Global or Local variables.
You can also view the list of available functions for [[Mathematical Functions|mathematical]] and [[String Manipulation Functions|string]] functions.

===IO Ports===
Allows you to drirectly drag a poin or port for assigning a value or wihtin calulations.
For example:
$PORTA = 10
$PORTC.2 = 1
$C1 = 1
$PORTA.3 = $PORTB.1
From Flowcode V10 With Arduino that uses different pin references the following can be used:
$pin3 = 1

===Globals===
Globals will allow you to create and drag global ''constants'' or [[Variable_Types|variables]] into the calculation window.

As the variables are global, they can be seen within any [[Using_the_Project_Explorer#Macros|user macro's]]

===Locals===
Locals will allow you to create and drag local ''constants'' or [[Variable_Types|variables]] into the calculation window.

As the variables are ''local'', they will only be seen within the [[Using_the_Project_Explorer#Macros|user macro]] it was created in.

Outside the user macro, any local variables get destroyed.

===Macros===
Allows you to drag any [[Using_the_Project_Explorer#Macros|user macro]] into the calculation icon so they can be accessed from within it.

===Components===
Allows you to drag a component function to control it within a calculation icon.

For example, if using the 2D potentiometer with a variable called ReadADC, the integer value is required, then with a calculation icon:
ReadADC = Potentiometer1 :: GetInt ()
There might be component functions that require an input parameter, then the parameter/s are entered within the brackets.

For example, required the average value after 100 samples and using a 20-microsecond delay:
ReadADC = Potentiometer1 :: GetAverageInt (100,20)
It is easier to read the potentiometer via Components of the [[Using_the_Project_Explorer#Components|Project Explorer]] rather than the Calculation icon

===fx Built-in Functions===
This is where all the [[Mathematical_Functions|Mathematical Functions]] can be found for dragging on the calculation icon.

===f$ Built-in Functions===
This is where all the [[String_Manipulation_Functions|string manipulation functions]] can be found for dragging on the calculation icon.

==Video==
The [http://www.flowcode.co.uk/videos/videoview/?name=The+Calculation+icon&id=local&wiki=Calculation_Icon_Properties Calculation icon video] shows how this icon can be used.

Comment Icon Properties

2026-06-10T15:00:23Z

SteveT:

[[File:IconComment.png|border]]

Stand-alone comments can be added to macros with the Comment icon to make the code easier to understand.

==Old Versions==
This page is current for Flowcode v11 and later. Earlier versions can be found below:
{| class="wikitable"
|+
|-
| [[Special:PermanentLink/10810|Flowcode v10]]
|-
| [[Special:PermanentLink/10810|Flowcode v9]]
|-
| [[Special:PermanentLink/10810|Flowcode v8]]
|}

==Details==
{| style="margin:0px; text-align:center;"
|-
|[[File:IconComment.png|border]]
| width="50px" |→
|[[File:Gen_Comment_Flowchart_Icon.png]]
| width="50px" |→
|[[File:Gen_Comment_Icon_Properties.png]]
|}

Drag the icon to where you want it and add your comments in the icons property box.

Comments allow users to leave notes in their code explaining functions, explaining variable settings etc., or for any other documentation task that they feel is needed.

Leaving comments is a good idea as it helps others understand your code, but they should be accurate and up-to-date because otherwise the comments could be misleading.

==Further Info==
Each individual command icon in Flowcode can have its own comment (the "Display Name"), so this Comment icon is best used to provide additional detail for a section of code.

Comments that include "TODO:" will be automatically added to the [[Using_the_Icon_Lists_Pane#TODO_List|TODO List]], providing a convenient way method to list uncompleted parts of a project.

There is a separate comment icon - [[File:Icon_State_Diagram_Comment.png]] - that can be added to [[State_diagrams|State Diagrams]]

Commenting code is not essential, and the use of well-named variables and macros can be more important to make your program easy to understand.

==Video==

The [http://www.flowcode.co.uk/videos/videoview/?name=The+Comment+icon&id=local&wiki=Comment_Icon_Properties Comment icon video] shows how comments can be used in your programs.

C Code Icon Properties

2026-06-10T14:59:32Z

SteveT:

[[File:iconCode.png|border]]

The Code icon allows experienced users to add their own C or JavaScript code into their Flowcode projects.

==Old Versions==
This page is current for Flowcode v11 and later. Earlier versions can be found below:
{| class="wikitable"
|+
|-
| [[Special:PermanentLink/38600|Flowcode v10]]
|-
| [[Special:PermanentLink/38600|Flowcode v9]]
|-
| [[Special:PermanentLink/15269|Flowcode v8]]
|}

==Details==
{| style="margin:0px; text-align:center;"
|-
|[[File:iconCode.png|border]]
| width="50px" |→
|[[File:Gen_C_Code_Flowchart_Icon.png]]
|width="50px" |→
|[[File:Gen_C_Code_Icon_Properties.png]]
|}

Flowcode is designed to allow those new to microcontroller programming to design programs with little knowledge of other programming languages. However it is possible to embed code written in other languages into Flowcode programs. Programs written in C and Assembly code can be embedded in Flowcode using the Code icon. This means that it is possible to take complex programs (you will find lots of programs on the internet) written in C or assembly and embed them into your designs.

The code can not always be simulated by Flowcode, but is passed on to the microcontroller during compilation.

'''Display Name'''

The name of the icon that appears on the flowchart.

'''Variable Box'''

Quickly browse the variables defined in your project. You can reference ports directly or select from a list of available Global or Local variables. Dragging and dropping the variables into the C Code box will automatically add the correct Flowcode specific prefix.

'''Code'''

Enter any C code you wish to include in the flowchart. The code is not checked by Flowcode but is passed straight to the C compiler when the flowchart is compiled. It is important to verify that the code entered is correct, as syntax errors will cause the compilation of the whole flowchart to fail.

When creating a Web Developer project, the code entered into this box will be JavaScript rather than C code.

To access Flowcode global variables, local variables, macro functions and connection points, it is necessary to "colour" the variable in your C code with the prefixes FCV_, FCL_, FCM_ and FCC_MacroName_ respectively. Dragging the variable into your code will automatically add the appropriate prefix. Variables should also be written in uppercase in code.

For example, to use a global variable called "Delay" in your code, you must refer to it using "FCV_DELAY".

To call a Flowcode macro called Test in your C code, you must call FCM_Test();

Note that for Flowcode versions up to Flowcode 6, all Flowcode macro names are upper case.
For Flowcode v7 and above they are case-sensitive, meaning the case of the macro names much match.

To jump to a connection point called A, defined in a Flowcode macro called TEST, the users C code must be goto FCC_TEST_A;. Connection points defined in the main flowchart of a Flowcode file are prefixed FCC_Main_.

===Assembly Code===

For embedded projects, assembly code can be added into the code field in a C assembly code wrapper.

For a single line of code use the asm operator in front of each instruction and use all upper case, e.g.

asm("MOVLW 0x04");

or enclose several statements within an asm block, tow methods can be used for PIC8
Either
#asm
MOVLW 0x04
MOVWF TRISA
#endasm''

Or
asm("MOVLW 0x04");
asm("MOVWF TRISA");

==Video==

See the [http://www.flowcode.co.uk/videos/videoview/?name=Using+custom+code&id=local&wiki=C_Code_Icon_Properties Using custom code video] to see how to add code into your Flowcode projects.

Jump Icon Properties

2026-06-10T14:58:13Z

SteveT:

[[File:iconJump.png|border|link=]]

Jump icons are added to a Flowcode project macro to allow program execution to unconditionally jump to another location in the macro.

In earlier versions of Flowcode, these were called "Connection Points" and the only type of jump supported was the "Goto" jump. Since v11.0.2, Flowcode now supports other types of unconditional jump: "Break", "Continue" and "Return".

==Details==

{| style="margin:0px; text-align:center;"
|-
|[[File:iconJump.png|border|link=]]
| width="50px" |→
|[[File:Gen_Goto_Connection_Point_Flowchart_Icon.png]]
| width="50px" |→
|[[File:Properties_Jump.png|link=]]
|}

'''Display Name'''

The name of the icon that appears on the flowchart.

'''Goto / Break / Continue / Return'''

The type of jump. More information on each jump type is below.

'''Jump to label'''

The label to jump to if using the "Goto" type of jump.

==Jump Types==

===Goto===

A "Goto" jump is used to link program flow from one part of a macro to another. To achieve this, the macro must already have a [[Label_Icon_Properties|Label]] command icon. When program execution reaches the Jump command, it will unconditionally jump to the corresponding Label command that is set in the "Jump to label" dropdown.

'''Note:''' Using Jump::Goto commands is generally seen as bad programming practice and they should be avoided where possible. It makes projects more difficult to debug, and most well written programs will usually not need to use this icon.

===Break===

A "Break" jump prematurely exits a [[Loop_Icon_Properties|Loop]] or [[Switch_Icon_Properties|Switch]] command. Program execution will continue with the command immediately after the end of the Loop or Switch that contains the "Break" jump command.

It must occur within a Loop or Switch command, otherwise an error will occur. If it is contained within multiple 'levels' of Loop or Switch commands, it will jump out of the inner-most command.

===Continue===

A "Continue" jump prematurely exits the current iteration of a [[Loop_Icon_Properties|Loop]]. If the Loop's test remains true, the next iteration of the Loop will be performed. Otherwise, program execution will exit the Loop and continue with the command directly following the end of the Loop.

===Return===

A 'Return' jump command can be located anywhere in a macro. When the program executes this command, it will immediately exit the current macro and will not execute any other code in the macro. If this macro returns a value, the current value of the return variable is returned.

== Video ==

See the [http://www.flowcode.co.uk/videos/videoview/?name=The+Jump+icon&id=local&wiki=Jump_Icon_Properties Jump icon video] to see how this icon can be used in your Flowcode projects.

Loop Icon Properties

2026-06-10T14:55:08Z

SteveT:

{| style="margin:0px; text-align:center;"
|-
|[[File:iconLoop.png|border]]
| width="50px" |→
|[[File:Gen_Loop_Flowchart_Icon.png]]
|width="50px" |→
|[[File:Properties-loop.png]]
|}

==Old Versions==
This page is current for Flowcode v11 and later. Earlier versions can be found below:
{| class="wikitable"
|+
|-
| [[Special:PermanentLink/17609|Flowcode v10]]
|-
| [[Special:PermanentLink/17609|Flowcode v9]]
|-
| [[Special:PermanentLink/17609|Flowcode v8]]
|}

==Introduction==
Loop icons are used to repeat a task until specified conditions are fulfilled, or to perform the loop a set number of times.

==Loop types==
There are several types of loop as explained below.

===Loop forever===
Creates an infinite loop where the icons between the start and end of this loop icon are repeated forever. Many embedded programs require an infinite loop because the code running in the microcontroller will never stop. In versions of Flowcode prior to v11, a condition "While 1" would have been used instead to create an infinite loop.

===Loop while===
A "while" loop will repeat the icons if the test in the "expression" box is true. This expression can be tested at the start or at the end of the loop and it is at this point that the program decides to continue or abort the loop.

===Loop until===
An "until" loop is similar to the "while" loop, but this time the loop will repeat until the test in the "expression" box becomes true. Again, this can be tested at the beginning or the end of the loop.

===Loop count===
This allows a loop to be repeated a set number of times. The number of times to repeat is entered in the "count" box. Note that this value will usually be a constant or a literal value (e.g. "5").

An internal counter will be set to zero when the loop first begins and will be automatically incremented at the end of each loop iteration. At the beginning of each loop, this internal counter will be checked to see if it is less than the value of the "count", and if it is not then the loop will be aborted.

This internal counter can be set to an existing variable instead using the '''Count using a variable''' option. This will expose the number of iterations around the loop to the code within the loop start and end icons. This variable will show a value of "0" during the first loop iteration, "1" in the second loop iteration, etc.

==Details==
'''Display Name'''

The name of the icon that appears on the flowchart.

'''Expression'''

The expression used to determine if the loop should continue or end. This is used by "while" and "until" versions of the loop command.

For a "while" loop, this loops the program while the specified condition is true.

For an "until" loop, this loops the program until the specified condition becomes true.

The expression is tested at the beginning or the end of the loop.

'''Variables Arrow'''

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]].

'''Test the loop at the:'''

Select whether you wish the loop's expression to be tested at the start or at the end of the loop. Testing at the end of the loop means that the code within the loop is guaranteed to execute at least once.

'''Loop count'''

Sets the loop to loop through a set number of iterations. The value should usually be a whole number between 1 and 99999999.

Note that a variable can be used for the "count" rather than a constant value. But be aware because changing the value of this variable within the loop could cause odd behaviour and make your program's execution difficult to predict.

'''Count using a variable'''

Allows an existing variable to be used as the count variable. When active, this resets the count variable to 0 when the loop first begins and automatically increments the variable at the end of each loop iteration. It is best that the value of this variable should not be altered within the loop by user code, otherwise the loop may behave unexpectedly.

==Video==
See the [http://www.flowcode.co.uk/videos/videoview/?name=The+Loop+icon&id=local&wiki=Loop_Icon_Properties Loop icon video] to see how this icon is used in a project.

Comment Icon Properties

2026-06-10T14:04:40Z

SteveT:

{| style="margin:0px; text-align:center;"
|-
|[[File:IconComment.png|border]]
| width="50px" |→
|[[File:Gen_Comment_Flowchart_Icon.png]]
| width="50px" |→
|[[File:Gen_Comment_Icon_Properties.png]]
|}

Stand-alone comments can be added to macros with the Comment icon to make the code easier to understand.

<br>
==Old Versions==
This page is current for Flowcode v11 and later. Earlier versions can be found below:
{| class="wikitable"
|+
|-
| [[Special:PermanentLink/10810|Flowcode v10]]
|-
| [[Special:PermanentLink/10810|Flowcode v9]]
|-
| [[Special:PermanentLink/10810|Flowcode v8]]
|}

==Details==

Drag the icon to where you want it and add your comments in the icons property box.

Comments allow users to leave notes in their code explaining functions, explaining variable settings etc., or for any other documentation task that they feel is needed.

Leaving comments is a good idea as it helps others understand your code, but they should be accurate and up-to-date because otherwise the comments could be misleading.

==Further Info==
Each individual command icon in Flowcode can have its own comment (the "Display Name"), so this Comment icon is best used to provide additional detail for a section of code.

Comments that include "TODO:" will be automatically added to the [[Using_the_Icon_Lists_Pane#TODO_List|TODO List]], providing a convenient way method to list uncompleted parts of a project.

There is a separate comment icon - [[File:Icon_State_Diagram_Comment.png]] - that can be added to [[State_diagrams|State Diagrams]]

Commenting code is not essential, and the use of well-named variables and macros can be more important to make your program easy to understand.

==Video==

The [http://www.flowcode.co.uk/videos/videoview/?name=The+Comment+icon&id=local&wiki=Comment_Icon_Properties Comment icon video] shows how comments can be used in your programs.

Calculation Icon Properties

2026-06-10T14:03:36Z

SteveT:

{| style="margin:0px; text-align:center;"
|-
|[[File:iconCalculation.png|border]]
| width="50px" |→
|[[File:Gen_Calculation_Flowchart_Icon_01.png]]
|width="50px" |→
|[[File:Gen_Calculation_Icon_Properties_01.png]]
|}

Calculation icons allow the modification of variables. They can be used to check inputs and to create outputs.

==Old Versions==
This page is current for Flowcode v11 and later. Earlier versions can be found below:
{| class="wikitable"
|+
|-
| [[Special:PermanentLink/40298|Flowcode v10]]
|-
| [[Special:PermanentLink/15396|Flowcode v9]]
|-
| [[Special:PermanentLink/15396|Flowcode v8]]
|}

==Display Name==

The name of the icon that appears on the flowchart.

==Calculations==

One or more lines of calculations can be entered into this box.

All calculations must consist of the name of an existing variable, and equals sign and an expression made up from numbers, variables and the following operators:

{| class="wikitable"
|+ Caption text
|-
! '''Operator''' !! '''Description'''
|-
| ( ) || Parentheses
|-
| = == || Equal to
|-
| <> != || Not equal to
|-
| + - * / || Addition, Subtraction, Multiplication, Division
|-
|MOD % || Modulus
|-
| < <= || Less than, Less than or equal to
|-
| > >= || Greater than, Greater than or equal to
|-
| >> << || Shift right, Shift left
|-
| NOT ~ || Bitwise NOT
|-
| AND & || Bitwise AND
|-
| OR <nowiki>|</nowiki> || Bitwise OR
|-
| XOR ^ || Bitwise Exclusive OR
|-
| && || Logical AND
|-
| <nowiki>||</nowiki> || Logical OR
|-
| ! || Logical NOT
|}

Flowcode generally uses the same basic operators as C, but also has English equivalents such as NOT, OR and MOD as shown in the table above. The other difference is a single '=' or a double '==' can be used to compare two values, whereas C always uses double '=='.

Numeric values can be in decimal (unmarked) or in HEX format (preceded by 0x) or in Binary format (preceded by 0b) e.g. 85 or 0x55 or 0b01010101.

'''Examples'''

Assuming that the variables have been previously defined, all the following are valid calculation lines.

DELAY = DELAY + 1

DELAY = (MYVAR + 3) * 3

NEXTBIT = LASTBIT >> 2 & MASK

AANDB = PORT_A AND PORT_B

INVX = NOT X

$PORTA = $PORTA + 1

$pin39 = $A2

$pin2 = 1

The $ donates a pin or a port that can now be used within calculations.

If any of the variables don't exist, then Flowcode will ask if you would like to create the missing variable.

[[File:Gen_Calculation_Flowchart_Icon_02.png]]

==Variable and Function Box==

This section is used to either select a variable or access a list of the available functions. You can reference ports directly or select from a list of available Global or Local variables.
You can also view the list of available functions for [[Mathematical Functions|mathematical]] and [[String Manipulation Functions|string]] functions.

===IO Ports===
Allows you to drirectly drag a poin or port for assigning a value or wihtin calulations.
For example:
$PORTA = 10
$PORTC.2 = 1
$C1 = 1
$PORTA.3 = $PORTB.1
From Flowcode V10 With Arduino that uses different pin references the following can be used:
$pin3 = 1

===Globals===
Globals will allow you to create and drag global ''constants'' or [[Variable_Types|variables]] into the calculation window.

As the variables are global, they can be seen within any [[Using_the_Project_Explorer#Macros|user macro's]]

===Locals===
Locals will allow you to create and drag local ''constants'' or [[Variable_Types|variables]] into the calculation window.

As the variables are ''local'', they will only be seen within the [[Using_the_Project_Explorer#Macros|user macro]] it was created in.

Outside the user macro, any local variables get destroyed.

===Macros===
Allows you to drag any [[Using_the_Project_Explorer#Macros|user macro]] into the calculation icon so they can be accessed from within it.

===Components===
Allows you to drag a component function to control it within a calculation icon.

For example, if using the 2D potentiometer with a variable called ReadADC, the integer value is required, then with a calculation icon:
ReadADC = Potentiometer1 :: GetInt ()
There might be component functions that require an input parameter, then the parameter/s are entered within the brackets.

For example, required the average value after 100 samples and using a 20-microsecond delay:
ReadADC = Potentiometer1 :: GetAverageInt (100,20)
It is easier to read the potentiometer via Components of the [[Using_the_Project_Explorer#Components|Project Explorer]] rather than the Calculation icon

===fx Built-in Functions===
This is where all the [[Mathematical_Functions|Mathematical Functions]] can be found for dragging on the calculation icon.

===f$ Built-in Functions===
This is where all the [[String_Manipulation_Functions|string manipulation functions]] can be found for dragging on the calculation icon.

==Video==
The [http://www.flowcode.co.uk/videos/videoview/?name=The+Calculation+icon&id=local&wiki=Calculation_Icon_Properties Calculation icon video] shows how this icon can be used.

C Code Icon Properties

2026-06-10T14:03:03Z

SteveT:

{| style="margin:0px; text-align:center;"
|-
|[[File:iconCode.png|border]]
| width="50px" |→
|[[File:Gen_C_Code_Flowchart_Icon.png]]
|width="50px" |→
|[[File:Gen_C_Code_Icon_Properties.png]]
|}

The Code icon allows experienced users to add their own C or JavaScript code into their Flowcode projects.

==Old Versions==
This page is current for Flowcode v11 and later. Earlier versions can be found below:
{| class="wikitable"
|+
|-
| [[Special:PermanentLink/38600|Flowcode v10]]
|-
| [[Special:PermanentLink/38600|Flowcode v9]]
|-
| [[Special:PermanentLink/15269|Flowcode v8]]
|}

==Details==
Flowcode is designed to allow those new to microcontroller programming to design programs with little knowledge of other programming languages. However it is possible to embed code written in other languages into Flowcode programs. Programs written in C and Assembly code can be embedded in Flowcode using the Code icon. This means that it is possible to take complex programs (you will find lots of programs on the internet) written in C or assembly and embed them into your designs.

The code can not always be simulated by Flowcode, but is passed on to the microcontroller during compilation.

'''Display Name'''

The name of the icon that appears on the flowchart.

'''Variable Box'''

Quickly browse the variables defined in your project. You can reference ports directly or select from a list of available Global or Local variables. Dragging and dropping the variables into the C Code box will automatically add the correct Flowcode specific prefix.

'''Code'''

Enter any C code you wish to include in the flowchart. The code is not checked by Flowcode but is passed straight to the C compiler when the flowchart is compiled. It is important to verify that the code entered is correct, as syntax errors will cause the compilation of the whole flowchart to fail.

When creating a Web Developer project, the code entered into this box will be JavaScript rather than C code.

To access Flowcode global variables, local variables, macro functions and connection points, it is necessary to "colour" the variable in your C code with the prefixes FCV_, FCL_, FCM_ and FCC_MacroName_ respectively. Dragging the variable into your code will automatically add the appropriate prefix. Variables should also be written in uppercase in code.

For example, to use a global variable called "Delay" in your code, you must refer to it using "FCV_DELAY".

To call a Flowcode macro called Test in your C code, you must call FCM_Test();

Note that for Flowcode versions up to Flowcode 6, all Flowcode macro names are upper case.
For Flowcode v7 and above they are case-sensitive, meaning the case of the macro names much match.

To jump to a connection point called A, defined in a Flowcode macro called TEST, the users C code must be goto FCC_TEST_A;. Connection points defined in the main flowchart of a Flowcode file are prefixed FCC_Main_.

===Assembly Code===

For embedded projects, assembly code can be added into the code field in a C assembly code wrapper.

For a single line of code use the asm operator in front of each instruction and use all upper case, e.g.

asm("MOVLW 0x04");

or enclose several statements within an asm block, tow methods can be used for PIC8
Either
#asm
MOVLW 0x04
MOVWF TRISA
#endasm''

Or
asm("MOVLW 0x04");
asm("MOVWF TRISA");

==Video==

See the [http://www.flowcode.co.uk/videos/videoview/?name=Using+custom+code&id=local&wiki=C_Code_Icon_Properties Using custom code video] to see how to add code into your Flowcode projects.

Comment Icon Properties

2026-06-10T14:00:08Z

SteveT:

{| style="margin:0px; text-align:center;"
|-
|[[File:IconComment.png|border]]
| width="50px" |→
|[[File:Gen_Comment_Icon_Properties.png]]
|}

Stand-alone comments can be added to macros with the Comment icon to make the code easier to understand.

<br>
==Old Versions==
This page is current for Flowcode v11 and later. Earlier versions can be found below:
{| class="wikitable"
|+
|-
| [[Special:PermanentLink/10810|Flowcode v10]]
|-
| [[Special:PermanentLink/10810|Flowcode v9]]
|-
| [[Special:PermanentLink/10810|Flowcode v8]]
|}

==Details==

Drag the icon to where you want it and add your comments in the icons property box.

Comments allow users to leave notes in their code explaining functions, explaining variable settings etc., or for any other documentation task that they feel is needed.

Leaving comments is a good idea as it helps others understand your code, but they should be accurate and up-to-date because otherwise the comments could be misleading.

==Further Info==
Each individual command icon in Flowcode can have its own comment (the "Display Name"), so this Comment icon is best used to provide additional detail for a section of code.

Comments that include "TODO:" will be automatically added to the [[Using_the_Icon_Lists_Pane#TODO_List|TODO List]], providing a convenient way method to list uncompleted parts of a project.

There is a separate comment icon - [[File:Icon_State_Diagram_Comment.png]] - that can be added to [[State_diagrams|State Diagrams]]

Commenting code is not essential, and the use of well-named variables and macros can be more important to make your program easy to understand.

==Video==

The [http://www.flowcode.co.uk/videos/videoview/?name=The+Comment+icon&id=local&wiki=Comment_Icon_Properties Comment icon video] shows how comments can be used in your programs.

Calculation Icon Properties

2026-06-10T13:58:21Z

SteveT:

{| style="margin:0px; text-align:center;"
|-
|[[File:Btn_Calculation.gif|border]]
| width="50px" |→
|[[File:Gen_Calculation_Flowchart_Icon_01.png]]
|width="50px" |→
|[[File:Gen_Calculation_Icon_Properties_01.png]]
|}

Calculation icons allow the modification of variables. They can be used to check inputs and to create outputs.

==Old Versions==
This page is current for Flowcode v11 and later. Earlier versions can be found below:
{| class="wikitable"
|+
|-
| [[Special:PermanentLink/40298|Flowcode v10]]
|-
| [[Special:PermanentLink/15396|Flowcode v9]]
|-
| [[Special:PermanentLink/15396|Flowcode v8]]
|}

==Display Name==

The name of the icon that appears on the flowchart.

==Calculations==

One or more lines of calculations can be entered into this box.

All calculations must consist of the name of an existing variable, and equals sign and an expression made up from numbers, variables and the following operators:

{| class="wikitable"
|+ Caption text
|-
! '''Operator''' !! '''Description'''
|-
| ( ) || Parentheses
|-
| = == || Equal to
|-
| <> != || Not equal to
|-
| + - * / || Addition, Subtraction, Multiplication, Division
|-
|MOD % || Modulus
|-
| < <= || Less than, Less than or equal to
|-
| > >= || Greater than, Greater than or equal to
|-
| >> << || Shift right, Shift left
|-
| NOT ~ || Bitwise NOT
|-
| AND & || Bitwise AND
|-
| OR <nowiki>|</nowiki> || Bitwise OR
|-
| XOR ^ || Bitwise Exclusive OR
|-
| && || Logical AND
|-
| <nowiki>||</nowiki> || Logical OR
|-
| ! || Logical NOT
|}

Flowcode generally uses the same basic operators as C, but also has English equivalents such as NOT, OR and MOD as shown in the table above. The other difference is a single '=' or a double '==' can be used to compare two values, whereas C always uses double '=='.

Numeric values can be in decimal (unmarked) or in HEX format (preceded by 0x) or in Binary format (preceded by 0b) e.g. 85 or 0x55 or 0b01010101.

'''Examples'''

Assuming that the variables have been previously defined, all the following are valid calculation lines.

DELAY = DELAY + 1

DELAY = (MYVAR + 3) * 3

NEXTBIT = LASTBIT >> 2 & MASK

AANDB = PORT_A AND PORT_B

INVX = NOT X

$PORTA = $PORTA + 1

$pin39 = $A2

$pin2 = 1

The $ donates a pin or a port that can now be used within calculations.

If any of the variables don't exist, then Flowcode will ask if you would like to create the missing variable.

[[File:Gen_Calculation_Flowchart_Icon_02.png]]

==Variable and Function Box==

This section is used to either select a variable or access a list of the available functions. You can reference ports directly or select from a list of available Global or Local variables.
You can also view the list of available functions for [[Mathematical Functions|mathematical]] and [[String Manipulation Functions|string]] functions.

===IO Ports===
Allows you to drirectly drag a poin or port for assigning a value or wihtin calulations.
For example:
$PORTA = 10
$PORTC.2 = 1
$C1 = 1
$PORTA.3 = $PORTB.1
From Flowcode V10 With Arduino that uses different pin references the following can be used:
$pin3 = 1

===Globals===
Globals will allow you to create and drag global ''constants'' or [[Variable_Types|variables]] into the calculation window.

As the variables are global, they can be seen within any [[Using_the_Project_Explorer#Macros|user macro's]]

===Locals===
Locals will allow you to create and drag local ''constants'' or [[Variable_Types|variables]] into the calculation window.

As the variables are ''local'', they will only be seen within the [[Using_the_Project_Explorer#Macros|user macro]] it was created in.

Outside the user macro, any local variables get destroyed.

===Macros===
Allows you to drag any [[Using_the_Project_Explorer#Macros|user macro]] into the calculation icon so they can be accessed from within it.

===Components===
Allows you to drag a component function to control it within a calculation icon.

For example, if using the 2D potentiometer with a variable called ReadADC, the integer value is required, then with a calculation icon:
ReadADC = Potentiometer1 :: GetInt ()
There might be component functions that require an input parameter, then the parameter/s are entered within the brackets.

For example, required the average value after 100 samples and using a 20-microsecond delay:
ReadADC = Potentiometer1 :: GetAverageInt (100,20)
It is easier to read the potentiometer via Components of the [[Using_the_Project_Explorer#Components|Project Explorer]] rather than the Calculation icon

===fx Built-in Functions===
This is where all the [[Mathematical_Functions|Mathematical Functions]] can be found for dragging on the calculation icon.

===f$ Built-in Functions===
This is where all the [[String_Manipulation_Functions|string manipulation functions]] can be found for dragging on the calculation icon.

==Video==
The [http://www.flowcode.co.uk/videos/videoview/?name=The+Calculation+icon&id=local&wiki=Calculation_Icon_Properties Calculation icon video] shows how this icon can be used.