Using CAL Components - Revision history

BenR at 10:43, 1 August 2018

2018-08-01T10:43:12Z

2018-08-01T10:29:31Z

2018-07-23T21:00:27Z

2018-07-23T20:59:53Z

2018-07-23T11:11:08Z

Creating a Macro

2018-07-23T11:10:01Z

Creating a Macro

2018-07-23T11:01:16Z

2018-07-23T11:00:57Z

2018-07-23T10:58:13Z

2018-07-23T10:49:29Z

Using the component

@@ Line 4: / Line 4: @@
 When creating a component for a specific sensor or other external IC you will often need to include some form of communications to talk to the device.
-Communications and other key peripherals are wrapped up in a CAL (Code Abstraction Layer) component so we can simply use this in our component using the tricks listed below.
+Communications and other key peripherals are wrapped up in a [[CAL_Components|CAL (Code Abstraction Layer)]] component so we can simply use this in our component using the tricks listed below.
 As an example we will go through creating an I2C based component using the I2C(CAL) component as the basis for communication.

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

@@ Line 64: / Line 64: @@
 To move dynamic hidden properties into a category you have to make them available (writeable and visible), the easiest way is to select a chip with the available functionality.
-Use the Build -> Project Options menu to select a different target device. The PIC 16F18877 is a good choice as it has all kinds of remappable peripherals supported as standand. PIC32 and STARM devices are also a good choice.
+Use the Build -> Project Options menu to select a different target device. The PIC 16F18877 is a good choice as it has all kinds of remappable peripherals supported as standard. PIC32 and ST-ARM devices are also a good choice.
 Then make sure you set the channel to a hardware channel that supports the remappable functionality and the properties will become available to move.

@@ Line 39: / Line 39: @@
 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:CALCOMP3.jpg]]
 You may want to add categories to allow the properties to be tidied up. Properties can simply be dragged into the category you have created.
 [[File:CALCOMP4.jpg]]
@@ Line 55: / Line 61: @@
 [[File:CALCOMP15.jpg]]
 Note. Remember to untick the Expose full component tree checkbox when you're done exposing properties to avoid incorrectly accessing hidden properties and to clean up the component interface.

@@ Line 80: / Line 80: @@
 [[File:CALCOMP6.jpg]]
-Give each of your parameters a helpful tooltip description to make it easier for the user of your component to know what is expected. The range of acceptable values can also be helpful.
+Give each of your parameters a helpful tooltip description to make it easier for the user of your component to know what is expected. The range of acceptable values can also be helpful. Also remember to add information about the return variable (if you're using one) in the macro's description field.
 [[File:CALCOMP16.jpg]]

@@ Line 79: / Line 79: @@
 [[File:CALCOMP6.jpg]]
 Inside the macro add the code to perform the functionality you require. Refer to the device datasheet for your sensor or IC to get the specifics of what is required. Example code can also be useful as you can follow the code, converting it into Flowcode icons as you go.
@@ Line 87: / Line 92: @@
 Add as many macros as you require. It's often best to start small e.g. being able to read or write a register on the device. Once you can do this you can confirm communications are working and then build up your component from there.
 ==Initialise Macro==

← Older revision		Revision as of 11:01, 23 July 2018
Line 56:		Line 56:
	[[File:CALCOMP15.jpg]]		[[File:CALCOMP15.jpg]]

−	Note. Remember to untick the Expose full component tree checkbox when you're done exposing properties to avoid incorrectly accessing hidden properties and to clean up component ~~the~~ interface.	+	Note. Remember to untick the Expose full component tree checkbox when you're done exposing properties to avoid incorrectly accessing hidden properties and to clean up the component interface.

@@ Line 47: / Line 47: @@
 Note properties need to be writeable and visible to be moved. In the example above I changed the Channel to Software to allow the pins to be moved and set the Baud to Custom to allow the Custom Baud property to be moved.
 Some properties of the CAL component may be hidden by default. For example remappable pins are only shown when they are available on the selected target microcontroller.
@@ Line 53: / Line 55: @@
 [[File:CALCOMP15.jpg]]

← Older revision		Revision as of 10:58, 23 July 2018
Line 47:		Line 47:

	Note properties need to be writeable and visible to be moved. In the example above I changed the Channel to Software to allow the pins to be moved and set the Baud to Custom to allow the Custom Baud property to be moved.		Note properties need to be writeable and visible to be moved. In the example above I changed the Channel to Software to allow the pins to be moved and set the Baud to Custom to allow the Custom Baud property to be moved.
		+
		+	Some properties of the CAL component may be hidden by default. For example remappable pins are only shown when they are available on the selected target microcontroller.
		+
		+	To see all of the CAL components hidden properties use the View -> Component Debugger menu and tick the Expose full component tree check box. Then re-select the CAL component on the panel or using the drop down list at the top of the Properties window.
		+
		+	[[File:CALCOMP15.jpg]]

← Older revision		Revision as of 10:49, 23 July 2018
Line 169:		Line 169:

	[[File:CALCOMP14.jpg]]		[[File:CALCOMP14.jpg]]
		+
		+	You can always re-export your component from source if you need to make a change, add a new macro or fix a bug. Be sure to look after your component source files to allow you to re-export as required in future.