Flowcode Help - Recent changes [en]

State Icon Properties

SteveT — Thu, 23 Jul 2026 16:31:21 GMT

Editing the order of transitions

← Older revision		Revision as of 16:31, 23 July 2026
Line 65:		Line 65:

	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 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.		The transitions can be listed here by their Display Name, their specified Condition, or the Function that they perform.

			More details can be found [[Reorder_Transitions\|here]].

	==Special States==		==Special States==

FAQ

SteveT — Thu, 23 Jul 2026 16:27:26 GMT

Removed redirect to Frequently Asked Questions

← Older revision		Revision as of 16:27, 23 July 2026
Line 1:		Line 1:
	#REDIRECT [[Frequently Asked Questions]]		#REDIRECT [https://flowcode.co.uk/faq/ Frequently Asked Questions]

Event Reference

SteveT — Thu, 23 Jul 2026 16:21:07 GMT

Show changes

Auto Documentation

SteveT — Thu, 23 Jul 2026 16:19:09 GMT

← Older revision		Revision as of 16:19, 23 July 2026
Line 19:		Line 19:
	*[[Variable Types]]		*[[Variable Types]]
	*[[Components]]		*[[Components]]
	*[[~~Event Reference~~]]		*[[Simulation Events]]
	*[[Simulation Functionality]]		*[[Simulation Functionality]]

Simulation Macro Icon Properties

SteveT — Thu, 23 Jul 2026 16:13:54 GMT

Details

← Older revision		Revision as of 16:13, 23 July 2026
Line 24:		Line 24:


	Built-in functions (sometimes called API or Simulation Macros) consist of a wide range of [[Simulation_Functionality\|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).		[[API_Overview\|Built-in functions]] (sometimes called API or Simulation Macros) consist of a wide range of [[Simulation_Functionality\|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.		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.

API Overview

SteveT — Thu, 23 Jul 2026 16:12:44 GMT

← Older revision		Revision as of 16:12, 23 July 2026
Line 1:		Line 1:
	Flowcode provides an ''application programming interface'' to help writing simulation and PC-side programs.		Flowcode provides an ''application programming interface'' to help writing simulation and PC-side programs.

	This API is a list of macros built in to Flowcode with each group, or class, of macros dealing with a specific area of the system.		This API (also known as ''Built-in Functions'') is a list of macros built in to Flowcode with each group, or class, of macros dealing with a specific area of the system.

	Use of this API is limited to simulation only - when downloaded to the chip these calls will be omitted, so if need be they can be interleaved in downloadable code.		Use of this API is limited to simulation only - when downloaded to the chip these calls will be omitted, so if need be they can be interleaved in downloadable code.

	A reference to the classes and macros available can be found [[Simulation_Functionality#Built-in_functions\|here]].		A reference to the classes and macros available can be found [[Simulation_Functionality#Built-in_functions\|here]].

API Reference

SteveT — Thu, 23 Jul 2026 16:10:20 GMT

← Older revision		Revision as of 16:10, 23 July 2026
Line 5:		Line 5:
	Use of this API is limited to simulation only - when downloaded to the chip these calls will be omitted, so if need be they can be interleaved in downloadable code.		Use of this API is limited to simulation only - when downloaded to the chip these calls will be omitted, so if need be they can be interleaved in downloadable code.

	A reference to the classes and macros available can be found [[~~Simulation Functionality~~\|here]].		A reference to the classes and macros available can be found [[Simulation_Functionality#Built-in_functions\|here]].

API Overview

SteveT — Thu, 23 Jul 2026 16:09:44 GMT

← Older revision		Revision as of 16:09, 23 July 2026
Line 5:		Line 5:
	Use of this API is limited to simulation only - when downloaded to the chip these calls will be omitted, so if need be they can be interleaved in downloadable code.		Use of this API is limited to simulation only - when downloaded to the chip these calls will be omitted, so if need be they can be interleaved in downloadable code.

	A reference to the classes and macros available can be found [[~~Simulation Functionality~~\|here]].		A reference to the classes and macros available can be found [[Simulation_Functionality#Built-in_functions\|here]].

Simulation Functionality

SteveT — Thu, 23 Jul 2026 16:08:29 GMT

Built in functions

← Older revision		Revision as of 16:08, 23 July 2026
Line 15:		Line 15:


	==Built in functions==		==Built-in functions==
	Flowcode provides a set of built-in functions (also known as the API or ''application programming interface'') to help writing simulation and PC-side programs.		Flowcode provides a set of built-in functions (also known as the API or ''application programming interface'') to help writing simulation and PC-side programs.

Overview of Simulation

SteveT — Thu, 23 Jul 2026 16:07:33 GMT

← Older revision		Revision as of 16:07, 23 July 2026
Line 1:		Line 1:
	<sidebar>Sidebar: Flowcode Help Overview</sidebar>		<sidebar>Sidebar: Flowcode Help Overview</sidebar>
	Flowcode can simulate advanced systems and replicate applications by using the [[Dashboard Panel]] and [[System Panel]] in combination with [[Simulation Events]], [[Simulation Functions\|Functions]] ~~and [[API_Overview\|Macros]] (covered later)~~ in a flowchart project to instruct the simulation.		Flowcode can simulate advanced systems and replicate applications by using the [[Dashboard Panel]] and [[System Panel]] in combination with [[Simulation Events]] and [[Simulation Functions\|Built-in Simulation Functions]] in a flowchart project to instruct the simulation.

Simulation Functionality

SteveT — Thu, 23 Jul 2026 16:04:38 GMT

← Older revision		Revision as of 16:04, 23 July 2026
Line 13:		Line 13:

	__TOC__		__TOC__


	==Built in functions==		==Built in functions==
			Flowcode provides a set of built-in functions (also known as the API or ''application programming interface'') to help writing simulation and PC-side programs.

			This API is a list of macros built in to Flowcode with each group, or class, of macros dealing with a specific area of the system.

			Use of this API is limited to simulation only - when downloaded to the chip these calls will be omitted, so if need be they can be interleaved in downloadable code.

			A reference to the classes and macros available can be found here:

	<tabs>		<tabs>
Line 1,195:		Line 1,203:

	==Events==		==Events==

			A Flowcode simulation event is similar to an Interrupt but aimed at performing a specific job. The events will not be referenced at all for downloaded microcontroller code but may be used in the generation of such code.

			The events available in Flowcode are listed here:

	<tabs>		<tabs>

API Overview

SteveT — Thu, 23 Jul 2026 15:58:41 GMT

@@ Line 1: / Line 1: @@
 Flowcode provides an ''application programming interface'' to help writing simulation and PC-side programs.
@@ Line 6: / Line 5: @@
 Use of this API is limited to simulation only - when downloaded to the chip these calls will be omitted, so if need be they can be interleaved in downloadable code.
-Below is a reference to the classes available.
+A reference to the classes and macros available can be found [[Simulation Functionality|here]].

API Reference

SteveT — Thu, 23 Jul 2026 14:57:56 GMT

removed API table and provided a link instead

Show changes

Version Updates

SteveT — Thu, 23 Jul 2026 14:55:09 GMT

Updated API link

← Older revision		Revision as of 14:55, 23 July 2026
Line 193:		Line 193:
	*There are some new built-in functions available		*There are some new built-in functions available

	''[[~~API_Reference~~\|New API calls]]'' : GetPanel and GetPanelName, SetSimSpeed and GetBackgroundColour		''[[Simulation Functionality\|New API calls]]'' : GetPanel and GetPanelName, SetSimSpeed and GetBackgroundColour

API Overview

SteveT — Thu, 23 Jul 2026 14:53:49 GMT

← Older revision		Revision as of 14:53, 23 July 2026
Line 7:		Line 7:

	Below is a reference to the classes available.		Below is a reference to the classes available.
	A complete list of [[~~API Reference~~\|classes and macros]] is also available.		A complete list of [[Simulation Functionality\|classes and macros]] is also available.
	{\| class="wikitable" width="85%"		{\| class="wikitable" width="85%"
	\|-		\|-

Auto Documentation

SteveT — Thu, 23 Jul 2026 14:53:21 GMT

← Older revision		Revision as of 14:53, 23 July 2026
Line 1:		Line 1:
	[[File:Gen_Project_Report_Export_Wizard_01.png\|right]]		[[File:Gen_Project_Report_Export_Wizard_01.png\|right]]
	Auto-generated documentation consists of technical information taken directly from ~~within Flowcode, for example auto-generated documentation~~ consists of information ~~regarding~~ [[~~API Overview~~\|~~API Functions~~]], [[~~Component~~]] ~~macros~~, ~~properties~~ and ~~functions as well as information regarding~~ [[~~Editing Variables~~\|~~Variables~~]].		Auto-generated documentation consists of technical information taken directly from your project and consists of information such as its name and description, along with details of the [[Editing Variables\|variables]], [[Creating_a_New_Macro\|macros]], and [[Component\|components]] used within the project.


Line 20:		Line 20:
	*[[Components]]		*[[Components]]
	*[[Event Reference]]		*[[Event Reference]]
	*[[~~API Reference~~]]		*[[Simulation Functionality]]

Simulation Macro Icon Properties

SteveT — Thu, 23 Jul 2026 14:42:55 GMT

Updated API link

← Older revision		Revision as of 14:42, 23 July 2026
Line 24:		Line 24:


	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).		Built-in functions (sometimes called API or Simulation Macros) consist of a wide range of [[Simulation_Functionality\|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.		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.
Line 50:		Line 50:

	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.		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==		==Macro types==

Object Scale

SteveT — Thu, 23 Jul 2026 14:41:32 GMT

Flowcodes representation of scale

← Older revision		Revision as of 14:41, 23 July 2026
Line 6:		Line 6:
	Flowcode represents an objects [[Object Position\|position]] in terms of [[Object Coordinates\|coordinates]], '''scale''' and [[Object Rotation\|rotation]].		Flowcode represents an objects [[Object Position\|position]] in terms of [[Object Coordinates\|coordinates]], '''scale''' and [[Object Rotation\|rotation]].

	Internally an objects scale is kept as a ''scale factor'' in the X, Y and Z axis of the object. When accessing the [[~~API Overview~~\|SIM API]] this is the value that is altered, and relates to the diagonal of a transform matrix:		Internally an objects scale is kept as a ''scale factor'' in the X, Y and Z axis of the object. When accessing the [[Simulation_Functionality\|SIM API]] this is the value that is altered, and relates to the diagonal of a transform matrix:

	::[[File:Eg Object Scale.png]]		::[[File:Eg Object Scale.png]]
Line 13:		Line 13:

	All API functions deal with this scale - this is mainly because the calculations involved in converting to other representations and back every time scale needs to be set would slow the programs down, but also because conversion to other representations can result in rounding errors and inaccuracies when combined with rotation.		All API functions deal with this scale - this is mainly because the calculations involved in converting to other representations and back every time scale needs to be set would slow the programs down, but also because conversion to other representations can result in rounding errors and inaccuracies when combined with rotation.


	== Scale vs Size==		== Scale vs Size==

Handles

SteveT — Thu, 23 Jul 2026 14:39:45 GMT

Replaced link to API

← Older revision		Revision as of 14:39, 23 July 2026
Line 1:		Line 1:
	An object handle is used to reference a more complicated piece of data (such as a file, Flowcode component or block of text) whose internal format is not known. Flowcode provides many [[~~API Overview~~\|simulation macros]] that use handles to easily pass data around.		An object handle is used to reference a more complicated piece of data (such as a file, Flowcode component or block of text) whose internal format is not known. Flowcode provides many [[Simulation_Functionality\|simulation macros]] that use handles to easily pass data around.


Line 8:		Line 8:


	The handle [[Variable_Types\|variable type]] can be used with the tree [[~~API Overview~~\|simulation macros]] to allow things like stepping through the [[Component_Tree\|component tree]].		The handle [[Variable_Types\|variable type]] can be used with the tree [[Simulation_Functionality\|simulation macros]] to allow things like stepping through the [[Component_Tree\|component tree]].

File:Fc9-type-18-icon.png

SteveT — Mon, 13 Jul 2026 16:38:55 GMT

SteveT uploaded a new version of File:Fc9-type-18-icon.png

New page

File:Fc9-type-15-icon.png

SteveT — Mon, 13 Jul 2026 16:38:11 GMT

SteveT uploaded a new version of File:Fc9-type-15-icon.png

New page

File:Fc9-type-12-icon.png

SteveT — Mon, 13 Jul 2026 16:37:26 GMT

SteveT uploaded a new version of File:Fc9-type-12-icon.png

New page

File:Fc9-type-4-icon.png

SteveT — Mon, 13 Jul 2026 16:36:15 GMT

SteveT uploaded a new version of File:Fc9-type-4-icon.png

New page

File:Fc9-type-3-icon.png

SteveT — Mon, 13 Jul 2026 16:35:27 GMT

SteveT uploaded a new version of File:Fc9-type-3-icon.png

New page

File:Fc9-type-20-icon.png

SteveT — Mon, 13 Jul 2026 16:34:50 GMT

SteveT uploaded a new version of File:Fc9-type-20-icon.png

New page

File:Fc9-type-22-icon.png

SteveT — Mon, 13 Jul 2026 16:34:06 GMT

SteveT uploaded a new version of File:Fc9-type-22-icon.png

New page

File:Fc9-type-23-icon.png

SteveT — Mon, 13 Jul 2026 16:33:18 GMT

SteveT uploaded a new version of File:Fc9-type-23-icon.png

New page

File:Fc9-type-24-icon.png

SteveT — Mon, 13 Jul 2026 16:31:23 GMT

SteveT uploaded a new version of File:Fc9-type-24-icon.png

New page

File:Fc9-type-17-icon.png

SteveT — Mon, 13 Jul 2026 16:29:05 GMT

SteveT uploaded a new version of File:Fc9-type-17-icon.png

New page

File:Fc9-type-21-icon.png

SteveT — Mon, 13 Jul 2026 16:27:42 GMT

SteveT uploaded a new version of File:Fc9-type-21-icon.png

New page

File:Fc9-type-13-icon.png

SteveT — Mon, 13 Jul 2026 16:26:34 GMT

SteveT uploaded a new version of File:Fc9-type-13-icon.png

New page

File:Fc9-type-8-icon.png

SteveT — Mon, 13 Jul 2026 16:25:49 GMT

SteveT uploaded a new version of File:Fc9-type-8-icon.png

New page

File:Fc9-type-2-icon.png

SteveT — Mon, 13 Jul 2026 16:24:40 GMT

SteveT uploaded a new version of File:Fc9-type-2-icon.png

New page

File:Fc9-type-1-icon.png

SteveT — Mon, 13 Jul 2026 16:23:32 GMT

SteveT uploaded a new version of File:Fc9-type-1-icon.png

New page

File:Fc9-type-11-icon.png

SteveT — Mon, 13 Jul 2026 16:22:25 GMT

SteveT uploaded a new version of File:Fc9-type-11-icon.png

New page

File:Fc9-type-19-icon.png

SteveT — Mon, 13 Jul 2026 16:21:34 GMT

SteveT uploaded a new version of File:Fc9-type-19-icon.png

New page

File:Fc9-type-6-icon.png

SteveT — Mon, 13 Jul 2026 16:20:15 GMT

SteveT uploaded a new version of File:Fc9-type-6-icon.png

New page

File:Fc9-type-5-icon.png

SteveT — Mon, 13 Jul 2026 16:18:33 GMT

SteveT uploaded a new version of File:Fc9-type-5-icon.png

New page

File:Fc9-type-7-icon.png

SteveT — Mon, 13 Jul 2026 16:17:06 GMT

SteveT uploaded a new version of File:Fc9-type-7-icon.png

New page

File:Fc9-type-10-icon.png

SteveT — Mon, 13 Jul 2026 16:15:49 GMT

SteveT uploaded a new version of File:Fc9-type-10-icon.png

New page

File:Fc9-type-14-icon.png

SteveT — Mon, 13 Jul 2026 16:14:50 GMT

SteveT uploaded a new version of File:Fc9-type-14-icon.png

New page

File:Fc9-type-16-icon.png

SteveT — Mon, 13 Jul 2026 16:10:49 GMT

SteveT uploaded a new version of File:Fc9-type-16-icon.png

New page

File:Fc9-prop-icon.png

SteveT — Mon, 13 Jul 2026 15:48:42 GMT

SteveT uploaded a new version of File:Fc9-prop-icon.png

New page

File:Fc9-comp-macro.png

SteveT — Mon, 13 Jul 2026 15:46:56 GMT

SteveT uploaded a new version of File:Fc9-comp-macro.png

New page

File:Fc9-s16-icon.png

SteveT — Mon, 13 Jul 2026 15:40:51 GMT

SteveT uploaded a new version of File:Fc9-s16-icon.png

New page

Component: Port Matrix (Misc)

SteveT — Mon, 13 Jul 2026 15:38:29 GMT

Undid revision 48421 by SteveT (talk)

← Older revision		Revision as of 15:38, 13 July 2026
Line 257:		Line 257:
	\|-		\|-
	\|-		\|-
	\| width="10%" align="center" \| [[File:Fc9-type-19-icon.png]]		\| width="10%" align="center" \| [[File:Fc9-type-4-icon.png]]
	\| width="90%" \| Port		\| width="90%" \| Port
	\|-		\|-
	\| colspan="2" \| Choose a port to connect the matrix of objects to. Each will be assigned a single pin of the port automatically by the Port Matrix component.		\| colspan="2" \| Choose a port to connect the matrix of objects to. Each will be assigned a single pin of the port automatically by the Port Matrix component.
	\|}		\|}

Component: Output Port (DSP Outputs)

SteveT — Mon, 13 Jul 2026 15:37:28 GMT

Undid revision 48422 by SteveT (talk)

← Older revision	Revision as of 15:37, 13 July 2026
(One intermediate revision by the same user not shown)
(No difference)