IO Properties - Revision history

MartinW at 09:13, 31 October 2023

2023-10-31T09:13:50Z

DavidA at 08:39, 2 July 2019

2019-07-02T08:39:55Z

BenR: /* Analog Inputs */

2018-08-07T21:06:09Z

Analog Inputs

BenR: /* Sampling the analogue input */

2018-08-07T21:05:01Z

Sampling the analogue input

BenR: /* Introduction */

2018-08-07T21:00:06Z

Introduction

BenR at 16:05, 6 August 2018

2018-08-06T16:05:19Z

BenR at 10:28, 6 August 2018

2018-08-06T10:28:59Z

BenR at 10:09, 6 August 2018

2018-08-06T10:09:59Z

BenR at 10:01, 6 August 2018

2018-08-06T10:01:59Z

BenR: /* Creating a property */

2018-08-06T09:59:30Z

Creating a property

@@ Line 129: / Line 129: @@
 There is a single analog pin property type to allow you to choose an analog input pin for use in a component. However this is not the best way to allow for a user selectable analogue input.
-The best way is to start by adding an ADC Template component to your project as this will allow you to select a pin and bring across the code to allow you to read the voltage present on the pin.
+The best way is to start by adding an ADC component e.g. Potentiometer to your project as this will allow you to select a pin and bring across the code to allow you to read the voltage present on the pin.
 [[File:Prop16.jpg]]
@@ Line 135: / Line 135: @@
 ===Exposing Properties===
-Select the ADC Template component on the panel or select the adc_base1 component from the drop down menu at the top of the properties window.
+Select the Potentiometer component on the panel or select the Potentiometer1 component from the drop down menu at the top of the properties window.
 Right click the properties you wish to expose to the user and select expose.
@@ Line 148: / Line 148: @@
 *Conversion speed - Controls the speed of the ADC conversion and is related to accuracy
 *Aquisition cycles - Amount of time to wait to pre-charge the ADC conversion capacitor to prevent channel bleed
 *Scope Traces - Allows the analogue voltages to be displayed on the data recorder window for simulation and displaying E-blocks Ghost ICT analog data.
@@ Line 155: / Line 156: @@
 ===Sampling the analogue input===
-The analogue input is then sampled the usual way by calling the adc_base1 component macros.
+The analogue input is then sampled the usual way by calling the Potentiometer1 component macros.
 You can either call the component macros directly in your component's macros or you can expose the adc_base1 component macros for the user to call.

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

@@ Line 151: / Line 151: @@
 *Aquisition cycles - Amount of time to wait to pre-charge the ADC conversion capacitor to prevent channel bleed
 *Scope Traces - Allows the analogue voltages to be displayed on the data recorder window for simulation and displaying E-blocks Ghost ICT analog data.
 ===Sampling the analogue input===
@@ Line 156: / Line 159: @@
 The analogue input is then sampled the usual way by calling the adc_base1 component macros.
-You can either call the component macros directly in your component's macros or you can expose the adc_base1 component macros for the user to call. See here for more info [[Customising_A_Component#Exposing_Macros]]
+You can either call the component macros directly in your component's macros or you can expose the adc_base1 component macros for the user to call.
 [[File:Prop18.jpg]]

@@ Line 156: / Line 156: @@
 The analogue input is then sampled the usual way by calling the adc_base1 component macros.
-You can either call the component macros directly in your component's macros or you can expose the adc_base1 component macros for the user to call.
+You can either call the component macros directly in your component's macros or you can expose the adc_base1 component macros for the user to call. See here for more info [[Customising_A_Component#Exposing_Macros]]
 [[File:Prop18.jpg]]

← Older revision		Revision as of 21:00, 7 August 2018
Line 11:		Line 11:
	This topic will deal with creating properties to allow your component macro code to interact with the microcontroller pins as specified by the user of the component.		This topic will deal with creating properties to allow your component macro code to interact with the microcontroller pins as specified by the user of the component.

		+	For input/output pins connected to a communications bus or peripheral (ADC, PWM, I2C, SPI, UART) please see the [[Using_CAL_Components]] topic instead.

	==Single Digital Pin==		==Single Digital Pin==

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

← Older revision		Revision as of 10:28, 6 August 2018
Line 122:		Line 122:

	[[File:Prop15.jpg]]		[[File:Prop15.jpg]]
		+
		+
		+	==Analog Inputs==
		+
		+	There is a single analog pin property type to allow you to choose an analog input pin for use in a component. However this is not the best way to allow for a user selectable analogue input.
		+
		+	The best way is to start by adding an ADC Template component to your project as this will allow you to select a pin and bring across the code to allow you to read the voltage present on the pin.
		+
		+	[[File:Prop16.jpg]]
		+
		+	===Exposing Properties===
		+
		+	Select the ADC Template component on the panel or select the adc_base1 component from the drop down menu at the top of the properties window.
		+
		+	Right click the properties you wish to expose to the user and select expose.
		+
		+	[[File:Prop17.jpg]]
		+
		+	For analog inputs it is a good idea to expose the following.
		+
		+	*Channel - Allows you to specify the analog input pin
		+	*VRef voltage - Allows you to specify the target microcontroller VCC or max ADC sample voltage
		+	*VRef option - Allows the ADC max reference to be set or adjusted by the component user
		+	*Conversion speed - Controls the speed of the ADC conversion and is related to accuracy
		+	*Aquisition cycles - Amount of time to wait to pre-charge the ADC conversion capacitor to prevent channel bleed
		+	*Scope Traces - Allows the analogue voltages to be displayed on the data recorder window for simulation and displaying E-blocks Ghost ICT analog data.
		+
		+	===Sampling the analogue input===
		+
		+	The analogue input is then sampled the usual way by calling the adc_base1 component macros.
		+
		+	You can either call the component macros directly in your component's macros or you can expose the adc_base1 component macros for the user to call.
		+
		+	[[File:Prop18.jpg]]

← Older revision		Revision as of 10:09, 6 August 2018
Line 65:		Line 65:

	[[File:Prop6.jpg]]		[[File:Prop6.jpg]]
		+
		+
		+	==Digital Port Byte==
		+
		+	The next type of pin connection we will look at is a digital port byte, this can be used for input or output purposes and allows 8 pins from the same port byte to be utilized in a single command.
		+
		+	===Creating a property===
		+
		+	First click on a blank area of the 2D or 3D panels to select the root "Panel" object. You can also use the drop down menu at the top of the Properties window.
		+
		+	Open up the properties window and click the drop down arrow next to the Properties item in the window.
		+
		+	[[File:Prop1.jpg]]
		+
		+	Select Add New from the menu.
		+
		+	Give the property a cosmetic name, we have used Port Connection
		+
		+	Select digital port byte from the drop down list
		+
		+	Give the property a property variable, we have used Port
		+
		+	[[File:Prop9.jpg]]
		+
		+	Next click the drop down arrow next to the cosmetic name.
		+
		+	[[File:Prop10.jpg]]
		+
		+	Enter a detailed description of what the port will be used for.
		+
		+	This defines the property tooltip that is shown to inform the user the purpose of the property.
		+
		+	[[File:Prop11.jpg]]
		+
		+	Click OK and OK again to close the Detailed Description and Edit Property windows.
		+
		+	You should now have a new port connection available on the properties window complete with tooltip.
		+
		+	[[File:Prop12.jpg]]
		+
		+	===Referencing the property===
		+
		+	To reference the property simply use the variable name inside a calculation icon.
		+
		+	To output a logic low to the port pins simply use an equals character to assign the value 0 to the port.
		+
		+	[[File:Prop13.jpg]]
		+
		+
		+	To output a logic high to the port pins simply use an equals character to assign 255 to the port.
		+
		+	[[File:Prop14.jpg]]
		+
		+
		+	To read the logic level of an input voltage connected to the port pins simply use an equals character to assign the port to a variable.
		+
		+	[[File:Prop15.jpg]]

← Older revision		Revision as of 10:01, 6 August 2018
Line 3:		Line 3:
	Most embedded components will require some form of connection to the real world. This is usually done via the standard input/output pins of the microcontroller.		Most embedded components will require some form of connection to the real world. This is usually done via the standard input/output pins of the microcontroller.

−	This topic will deal with creating properties to allow your component to interact with the microcontroller pins specified by the user of the component.	+	You could simply use Input and Output flowchart icons to do this but this fixes the functionality to specific pins.
		+
		+	To allow the pin connections to be changed by the user we need a way to dereference the input/output commands from the pin connections.
		+
		+	This topic will deal with creating properties to allow your component macro code to interact with the microcontroller pins as specified by the user of the component.

@@ Line 40: / Line 40: @@
 Click OK and OK again to close the Detailed Description and Edit Property windows.
-You now have a new pin connection available on the properties window.
+You should now have a new pin connection available on the properties window complete with tooltip.
 [[File:Prop3.jpg]]
 ===Referencing the property===