Customising A Component - Revision history

SteveT: /* Exporting the component */

2026-06-29T11:47:49Z

Exporting the component

← Older revision		Revision as of 11:47, 29 June 2026
Line 94:		Line 94:

	So for v11, the components location is typically: "C:\ProgramData\MatrixTSL\FlowcodeV11\Components".		So for v11, the components location is typically: "C:\ProgramData\MatrixTSL\FlowcodeV11\Components".


	===Custom Location===		===Custom Location===

SteveT: /* Flowcode 8 and later */

2026-06-29T11:47:28Z

Flowcode 8 and later

← Older revision		Revision as of 11:47, 29 June 2026
Line 84:		Line 84:

	It is recommended that user-generated components are saved into a [[Customising_A_Component#Custom_Location\|custom location]] and not saved to Flowcode's component folder. This is because Flowcode may modify its component folder following an update and any components saved there may be deleted.		It is recommended that user-generated components are saved into a [[Customising_A_Component#Custom_Location\|custom location]] and not saved to Flowcode's component folder. This is because Flowcode may modify its component folder following an update and any components saved there may be deleted.

			Since v11.0.2, Flowcode will warn you if you attempt to export a component into this area of %PROGRAMFILES%.

	However, it is still possibly to save your own components there. But make sure you have a back-up.		However, it is still possibly to save your own components there. But make sure you have a back-up.
Line 92:		Line 94:

	So for v11, the components location is typically: "C:\ProgramData\MatrixTSL\FlowcodeV11\Components".		So for v11, the components location is typically: "C:\ProgramData\MatrixTSL\FlowcodeV11\Components".

	~~Since v11.0.2, Flowcode will warn you if you attempt to export a component into this area of %PROGRAMFILES%.~~


	===Custom Location===		===Custom Location===

SteveT: /* Exporting the component */

2026-06-29T11:11:57Z

Exporting the component

← Older revision		Revision as of 11:11, 29 June 2026
Line 72:		Line 72:

	You might be prompted to save the project fcfx file first if there have been any changes.		You might be prompted to save the project fcfx file first if there have been any changes.


	===Flowcode 7===		===Flowcode 7===
Line 80:		Line 81:


	===Flowcode 8===		===Flowcode 8 and later===

	~~Components~~ location ~~: "C:\ProgramData\MatrixTSL\FlowcodeV8\Components"~~		It is recommended that user-generated components are saved into a [[Customising_A_Component#Custom_Location\|custom location]] and not saved to Flowcode's component folder. This is because Flowcode may modify its component folder following an update and any components saved there may be deleted.

	~~Export directly into the Components folder by copying and pasting the path into the filename field and hitting return~~.		However, it is still possibly to save your own components there. But make sure you have a back-up.

	~~===~~Flowcode ~~9===~~		Flowcode's components folder for versions v8 and older can be found in the following location : "%PROGRAMDATA%\MatrixTSL\FlowcodeVxx\Components", where "xx" is the version of Flowcode.

	~~Components~~ location : "C:\ProgramData\~~MatrixTSL\FlowcodeV9\Components~~"		%PROGRAMDATA% is a reference to a common location used by Windows-based apps. Typically this will be "C:\ProgramData\" but may be elsewhere if the OS is installed on a different drive or is in a non-English language.

	~~Export directly into~~ the Components ~~folder by copying and pasting the path into the filename field and hitting return~~.		So for v11, the components location is typically: "C:\ProgramData\MatrixTSL\FlowcodeV11\Components".

	~~===~~Flowcode ~~10===~~		Since v11.0.2, Flowcode will warn you if you attempt to export a component into this area of %PROGRAMFILES%.

	~~Components location : "C:\ProgramData\MatrixTSL\FlowcodeV10\Components"~~

	~~Export directly into the Components folder by copying and pasting the path into the filename field and hitting return.~~

	===Custom Location===		===Custom Location===
Line 105:		Line 103:

	[[File:CAC8.jpg]]		[[File:CAC8.jpg]]


	==Using the component==		==Using the component==

MartinW at 10:59, 31 October 2023

2023-10-31T10:59:41Z

← Older revision		Revision as of 10:59, 31 October 2023
Line 8:		Line 8:
	Begin by starting a new project and select the microcontroller you are going to be using.		Begin by starting a new project and select the microcontroller you are going to be using.

	Next add the component you wish to customise to ~~your favourite~~ panel. I am using the LCD which I want to assign with custom pre-set pins on PortD.		Next add the component you wish to customise to the apropreate panel e.g 2D for 2D components. I am using the generic customable LCD which I want to assign with custom pre-set pins on PortD.

	[[File:CAC1.jpg]]		[[File:CAC1.jpg]]
Line 16:		Line 16:

	Select the component on the panel and open the Properties window. Then adjust the properties to be as you want them to be. For example I'm going to change the pins from the default PortB 0-5 to PortD 2 - 7.		Select the component on the panel and open the Properties window. Then adjust the properties to be as you want them to be. For example I'm going to change the pins from the default PortB 0-5 to PortD 2 - 7.

			Tip: You can change the top pin then Right or left click and select '''Auto connect digital'''

	[[File:CAC2.jpg]]		[[File:CAC2.jpg]]
Line 47:		Line 49:


	Next click on the File -> ~~Component Configuration menu.~~		Next click on the '''File''' -> '''Export''' -> '''Edit the export settings for your component'''


	===Setup Tab - Standard===		===Setup Tab - Standard===

	Give the component a Name, a Cosmetic Name, Assign a Category from the drop down menu.		Give the component a Name, a Cosmetic Name, Assign pannel type, Assign a Category from the drop down menu.

	[[File:CAC7.jpg]]		[[File:CAC7.jpg]]
Line 67:		Line 69:
	==Exporting the component==		==Exporting the component==

	Next simply click the File -> Export ~~menu~~ to save the component as a .fcpx file. This file can be saved into the standard Flowcode components folder or you can create your own custom folder.		Next simply click the '''File''' -> '''Export''' -> '''Export this project as a component''' to save the component as a .fcpx file. This file can be saved into the standard Flowcode components folder or you can create your own custom folder.

			You might be prompted to save the project fcfx file first if there have been any changes.

	===Flowcode 7===		===Flowcode 7===
Line 83:		Line 86:
	Export directly into the Components folder by copying and pasting the path into the filename field and hitting return.		Export directly into the Components folder by copying and pasting the path into the filename field and hitting return.

			===Flowcode 9===

			Components location : "C:\ProgramData\MatrixTSL\FlowcodeV9\Components"

			Export directly into the Components folder by copying and pasting the path into the filename field and hitting return.

			===Flowcode 10===

			Components location : "C:\ProgramData\MatrixTSL\FlowcodeV10\Components"

			Export directly into the Components folder by copying and pasting the path into the filename field and hitting return.

	===Custom Location===		===Custom Location===
Line 88:		Line 102:
	Export directly to your own custom components folder.		Export directly to your own custom components folder.

	To use your own folder simply click on ~~the View~~ -> Global ~~Options~~ -> Locations Tab menu and add your custom folder location to the Look for components in... text field.		To use your own folder simply click on '''File''' -> Global Settings -> Locations Tab menu and add your custom folder location to the Look for components in... text field.

	[[File:CAC8.jpg]]		[[File:CAC8.jpg]]

DavidA at 08:40, 2 July 2019

2019-07-02T08:40:12Z

← Older revision		Revision as of 08:40, 2 July 2019
Line 1:		Line 1:
	~~<sidebar>Sidebar: Flowcode Help Overview:ComponentCreation</sidebar>~~
	==Introduction==		==Introduction==

BenR at 10:30, 1 August 2018

2018-08-01T10:30:13Z

← Older revision		Revision as of 10:30, 1 August 2018
Line 1:		Line 1:
			<sidebar>Sidebar: Flowcode Help Overview:ComponentCreation</sidebar>
	==Introduction==		==Introduction==

BenR at 11:58, 23 July 2018

2018-07-23T11:58:45Z

← Older revision		Revision as of 11:58, 23 July 2018
Line 2:		Line 2:

	Sometimes components may need to be customised, for example with specific default pin connections that are meaningful for your hardware.		Sometimes components may need to be customised, for example with specific default pin connections that are meaningful for your hardware.

	Note: Some component properties such as CAL type component channels and pins are dynamic and based on the selected target microcontroller and will not work with the method explained below, for these you will have to use the Initialise event and the Simulation API to force your custom property values in as the component is loaded.


Line 100:		Line 98:

	[[File:CAC9.jpg]]		[[File:CAC9.jpg]]


			==Advanced - Dynamic Properties==

			Note: Some component properties such as CAL type component channels and pins are dynamic and based on the selected target microcontroller and will not work with the method explained above, for these you will have to use something like the Initialise event and the Simulation API to force your custom property values in as the component is loaded.

BenR at 09:24, 23 July 2018

2018-07-23T09:24:21Z

← Older revision		Revision as of 09:24, 23 July 2018
Line 11:		Line 11:

	Next add the component you wish to customise to your favourite panel. I am using the LCD which I want to assign with custom pre-set pins on PortD.		Next add the component you wish to customise to your favourite panel. I am using the LCD which I want to assign with custom pre-set pins on PortD.

			[[File:CAC1.jpg]]


Line 16:		Line 18:

	Select the component on the panel and open the Properties window. Then adjust the properties to be as you want them to be. For example I'm going to change the pins from the default PortB 0-5 to PortD 2 - 7.		Select the component on the panel and open the Properties window. Then adjust the properties to be as you want them to be. For example I'm going to change the pins from the default PortB 0-5 to PortD 2 - 7.

			[[File:CAC2.jpg]]


	==Exposing Properties==		==Exposing Properties==

	While we are in the properties window there may be properties that you will still need to be available to the user when using your new customised component. Simply right click these properties and choose Expose from the menu to expose these properties to the user of the component. You can see which properties will be available to the user by clicking on a blank area of the component panel, or by choosing Panel from the drop down menu at the top of the Properties window.		While we are in the properties window there may be properties that you will still need to be available to the user when using your new customised component. Simply right click these properties and choose Expose from the menu to expose these properties to the user of the component.

			[[File:CAC3.jpg]]

			You can see which properties will be available to the user by clicking on a blank area of the component panel, or by choosing Panel from the drop down menu at the top of the Properties window.

			[[File:CAC4.jpg]]


	==Exposing Macros==		==Exposing Macros==

	As well as properties you will also need to expose the macros for the component that can be called. This could be all the components macros or could simply be a sub set if you only ever use a few macro calls from a component. Open the Project Explorer window and select the components tab, then right click any macros you want available and select Expose from the menu. You can see which macros will be available to the user by clicking on a blank area of the component panel, or by choosing Panel from the drop down menu at the top of the Properties window and then selecting the Macros tab.		As well as properties you will also need to expose the macros for the component that can be called. This could be all the components macros or could simply be a sub set if you only ever use a few macro calls from a component. Open the Project Explorer window and select the components tab, then right click any macros you want available and select Expose from the menu.

			[[File:CAC5.jpg]]

			You can see which macros will be available to the user by clicking on a blank area of the component panel, or by choosing Panel from the drop down menu at the top of the Properties window and then selecting the Macros tab.

			[[File:CAC6.jpg]]


Line 39:		Line 55:

	Give the component a Name, a Cosmetic Name, Assign a Category from the drop down menu.		Give the component a Name, a Cosmetic Name, Assign a Category from the drop down menu.

			[[File:CAC7.jpg]]


Line 73:		Line 91:

	To use your own folder simply click on the View -> Global Options -> Locations Tab menu and add your custom folder location to the Look for components in... text field.		To use your own folder simply click on the View -> Global Options -> Locations Tab menu and add your custom folder location to the Look for components in... text field.

			[[File:CAC8.jpg]]


Line 78:		Line 98:

	The new component should now appear in Flowcode in the category you selected. Simply use the component as you would any other component.		The new component should now appear in Flowcode in the category you selected. Simply use the component as you would any other component.

			[[File:CAC9.jpg]]

BenR at 12:18, 18 July 2018

2018-07-18T12:18:21Z

← Older revision		Revision as of 12:18, 18 July 2018
Line 3:		Line 3:
	Sometimes components may need to be customised, for example with specific default pin connections that are meaningful for your hardware.		Sometimes components may need to be customised, for example with specific default pin connections that are meaningful for your hardware.

	Note: ~~Anything~~ on the ~~panels~~ in ~~your project will be exported inside~~ the ~~new~~ component ~~so make sure you start with a clean project~~.		Note: Some component properties such as CAL type component channels and pins are dynamic and based on the selected target microcontroller and will not work with the method explained below, for these you will have to use the Initialise event and the Simulation API to force your custom property values in as the component is loaded.

BenR at 12:15, 18 July 2018

2018-07-18T12:15:29Z

← Older revision		Revision as of 12:15, 18 July 2018
Line 51:		Line 51:
	==Exporting the component==		==Exporting the component==

	Next simply click the File -> Export menu to save the component as a .fcpx file. This file can be saved into the standard Flowcode components folder or you can create your own folder.		Next simply click the File -> Export menu to save the component as a .fcpx file. This file can be saved into the standard Flowcode components folder or you can create your own custom folder.