Customising A Component - Revision history

MartinW at 10:59, 31 October 2023

2023-10-31T10:59:41Z

DavidA at 08:40, 2 July 2019

2019-07-02T08:40:12Z

BenR at 10:30, 1 August 2018

2018-08-01T10:30:13Z

BenR at 11:58, 23 July 2018

2018-07-23T11:58:45Z

BenR at 09:24, 23 July 2018

2018-07-23T09:24:21Z

BenR at 12:18, 18 July 2018

2018-07-18T12:18:21Z

BenR at 12:15, 18 July 2018

2018-07-18T12:15:29Z

BenR at 12:15, 18 July 2018

2018-07-18T12:15:09Z

BenR at 12:14, 18 July 2018

2018-07-18T12:14:10Z

BenR at 12:12, 18 July 2018

2018-07-18T12:12:52Z

@@ Line 8: / Line 8: @@
 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]]
@@ 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.
 [[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===
-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]]
@@ Line 67: / Line 69: @@
 ==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.
 ===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.
 ===Custom Location===
@@ Line 88: / Line 102: @@
 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]]

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

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

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

@@ 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.
@@ 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.
 ==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.
 ==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.
@@ Line 39: / Line 55: @@
 Give the component a Name, a Cosmetic Name, Assign a Category from the drop down menu.
@@ 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.
@@ 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.

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

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

@@ Line 30: / Line 30: @@
 ==Finishing Up==
-Before we export the component we need to do a number of small finishing steps to get the new component ready. First save your project with a meaningful name so you can go back and re-export the modified component in future.
+Before we export the component we need to do a number of small finishing steps to get the new component ready. First save your project in a meaningful location with a meaningful name so you can go back and re-export the modified component in future if needed.
 Next click on the File -> Component Configuration menu.

← Older revision		Revision as of 12:12, 18 July 2018
Line 25:		Line 25:
	==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 ~~use the Macros tab of the Properties Window to~~ see ~~the~~ macros ~~that~~ will be available ~~in your new~~ component.	+	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.