Exercise - Documenting a Flowchart - Revision history

MartinW: Replaced content with "For an excellent introduction guide, we recommend [https://www.flowcode.co.uk/education/ Introduction to microcontroller programming]"

2023-04-25T13:21:40Z

Replaced content with "For an excellent introduction guide, we recommend [https://www.flowcode.co.uk/education/ Introduction to microcontroller programming]"

BenR at 14:29, 13 March 2014

2014-03-13T14:29:31Z

JonnyW: XML import

2014-01-16T15:59:06Z

XML import

ReeceL: /* What Next? */

2013-09-20T15:30:20Z

What Next?

ReeceL at 10:21, 20 September 2013

2013-09-20T10:21:42Z

ReeceL at 09:14, 19 September 2013

2013-09-19T09:14:25Z

ReeceL at 10:58, 2 September 2013

2013-09-02T10:58:56Z

JohnVerrill at 13:52, 1 September 2013

2013-09-01T13:52:09Z

ReeceL at 10:03, 13 August 2013

2013-08-13T10:03:40Z

ReeceL at 14:43, 23 July 2013

2013-07-23T14:43:01Z

← Older revision		Revision as of 13:21, 25 April 2023
Line 1:		Line 1:
−	~~<sidebar>Sidebar: Flowcode Exercises:Ex1</sidebar>~~	+	For an excellent introduction guide, we recommend [https://www.flowcode.co.uk/education/ Introduction to microcontroller programming]
−	~~This exercise assumes that you have created and tested the program described in exercise [[Exercise - Transferring a Program to the Microcontroller\|Transferring a Program to the Microcontroller]].~~
−
−	~~Documenting the flowchart is essential in some projects~~, ~~although~~ we ~~have properly labelled the icons, a few comment icons helps to further explain the program and the process in further detail to aid expansion and helps others understand the system.~~
−
−
−	~~__TOC__~~
−
−
−	~~==Load the Flowcode flowchart==~~
−	* [[Opening an Existing Flowchart\|Open the flowchart]] called 'Lamp1.fcf' which you tested further in the exercise [[Exercise - Transferring a Program to the Microcontroller\|Transferring a Program to the Microcontroller]].
−
−
−	~~==Benefits of documentation==~~
−
−	Documenting your flowchart is very useful - it allows other users to understand your flowchart and allows them to learn and even add to your flowchart to help produce the final program and increase efficiency throughout the system.
−
−	Adding comments to document your flowchart is extremely easy and very useful, using comments allows you to clarify the process, purpose and function of your program and allows others to understand it so they can see what is going on and learn from it and even help to develop the program, even by suggestion a more efficient method or directly editing a icon to function more effectively.
−
−
−	~~==Adding comments==~~
−	[~~[File~~:~~Exercise_Documenting_a_Flowchart_Final_Flowchart.png\|right]]~~
−	* Drag a [[Comment Icon Properties\|Comment icon]] onto the flowchart above the 'Loop' icon.
−	* Double click the 'Comment' icon to open up the [[Comment Icon Properties]] dialogue box.
−
−	~~:* Explain the purpose of the loop and how it is the base of the process.~~
−
−	~~:: The loop is the base of the program as it allows the program to continually check if the switch has been pressed by repeating the process of detecting the state of the switch.~~
−
−
−	* Add a comment above the 'Input' icon.
−
−	* Open the icon properties by double clicking on the 'Comment' icon.
−
−	~~:* Describe the use of the 'Input' icon and how it reads the state of the switch.~~
−
−	~~:: The 'Input' icon uses a variable to read and store the state of the switch, this allows the information contained in the variable to be used to see if the switch is being pressed or not.~~
−
−
−	* Comment and document the 'Decision' icon.
−
−	~~:* Describe how the 'Decision' icon detects the state of the switch and decides the next step to take.~~
−
−	:: The 'Decision' icon will read the information in the variable to see if the switch has been pressed, it then decides which process path to follow next, if it is not being pressed it will go straight through to the loop and continually check if the switch is being pressed or not. ~~If the switch is being pressed the following icons activate the LED and turns it off after 10 seconds~~.
−
−
−	* Comment and document the 'Output' icon.
−
−	~~:* Describe the function of the 'Output' icon~~.
−
−	~~:: Once the 'Decision' icon detects that the switch is being pressed, the 'Output' icon turns on~~ / ~~lights up the LED and indicates that the switch has been pressed.~~
−
−
−	* Comment and document the 'Delay' icon.
−
−	~~:* Describe the function and purpose of the icon.~~
−
−	:: This delays the program and stops it from continuing with another process, this allows the LED to stay lit up due to the previous command, this delay lasts 10 seconds until the program is then continued.
−
−
−	* Comment and document the second 'Output' icon.
−
−	~~:* Explain the function of this icon and the process afterwards.~~
−
−	:: After the 10 second delay, this icon will turn the LED off and then continue the process of the program, which in turn, will loop to check if the button is being pressed again, this is the completes the circuit and will continue to loop and repeat the process, until stopped.
−
−
−	~~==Save the Flowchart==~~
−	* Save the flowchart using the same name. The simplest way to do this is to click on the 'Save' icon. [[File:Btn Save.png\|border]]
−	~~: For more information, see [[Saving a Flowchart]].~~
−
−
−	~~==Download the exercise==~~
−	~~You can download the file created by this exercise and open it in Flowcode to identify errors in your program~~/~~file or you could also download the file~~ to ~~skip to the next exercise.~~
−
−	*To download the file, click on the link below and then either:
−	~~:*Click on the file name.~~
−	~~:*Right click the file name and select 'Save link as...' or 'Save target as...' (depending on your browser).~~
−
−	~~:::{{Fcfile\|Exercise - Documenting a Flowchart.fcfx\|Exercise - Documenting a Flowchart}}~~
−
−
−	~~==What next?==~~
−	~~Now that the flowchart is complete, and documented correctly, you can further expand and develop the flowchart in the next exercise [[Exercise - Expanding a Program\|Expanding a Program~~]].

← Older revision		Revision as of 14:29, 13 March 2014
Line 1:		Line 1:
−	<sidebar>Sidebar: ~~Adding Finishing Touches~~</sidebar>	+	<sidebar>Sidebar: Flowcode Exercises:Ex1</sidebar>
	This exercise assumes that you have created and tested the program described in exercise [[Exercise - Transferring a Program to the Microcontroller\|Transferring a Program to the Microcontroller]].		This exercise assumes that you have created and tested the program described in exercise [[Exercise - Transferring a Program to the Microcontroller\|Transferring a Program to the Microcontroller]].

@@ Line 78: / Line 78: @@
 :*Right click the file name and select 'Save link as...' or 'Save target as...' (depending on your browser).
-:::[[File:Exercise - Documenting a Flowchart.fcfx]]
+:::{{Fcfile|Exercise - Documenting a Flowchart.fcfx|Exercise - Documenting a Flowchart}}
 ==What next?==
 Now that the flowchart is complete, and documented correctly, you can further expand and develop the flowchart in the next exercise [[Exercise - Expanding a Program|Expanding a Program]].

← Older revision		Revision as of 15:30, 20 September 2013
Line 81:		Line 81:


−	==What ~~Next~~?==	+	==What next?==
	Now that the flowchart is complete, and documented correctly, you can further expand and develop the flowchart in the next exercise [[Exercise - Expanding a Program\|Expanding a Program]].		Now that the flowchart is complete, and documented correctly, you can further expand and develop the flowchart in the next exercise [[Exercise - Expanding a Program\|Expanding a Program]].

@@ Line 74: / Line 74: @@
 You can download the file created by this exercise and open it in Flowcode to identify errors in your program/file or you could also download the file to skip to the next exercise.
-Download the file by clicking on the file link below and then right clicking on the link and selecting 'Save link as...' or 'Save target as...' (depending on your browser).
+*To download the file, click on the link below and then either:
-:[[File:Exercise - Documenting a Flowchart.fcf]]
+:::[[File:Exercise - Documenting a Flowchart.fcfx]]
 ==What Next?==
 Now that the flowchart is complete, and documented correctly, you can further expand and develop the flowchart in the next exercise [[Exercise - Expanding a Program|Expanding a Program]].

@@ Line 69: / Line 69: @@
 * Save the flowchart using the same name. The simplest way to do this is to click on the 'Save' icon. [[File:Btn Save.png|border]]
 : For more information, see [[Saving a Flowchart]].
 ==What Next?==
 Now that the flowchart is complete, and documented correctly, you can further expand and develop the flowchart in the next exercise [[Exercise - Expanding a Program|Expanding a Program]].

← Older revision		Revision as of 10:58, 2 September 2013
Line 73:		Line 73:
	==What Next?==		==What Next?==
	Now that the flowchart is complete, and documented correctly, you can further expand and develop the flowchart in the next exercise [[Exercise - Expanding a Program\|Expanding a Program]].		Now that the flowchart is complete, and documented correctly, you can further expand and develop the flowchart in the next exercise [[Exercise - Expanding a Program\|Expanding a Program]].
−
−
−	~~==Link==~~
−	~~To download the Flowcode program for this exercise, click on the following link [[File:xxx\|xxx]]~~

← Older revision		Revision as of 13:52, 1 September 2013
Line 73:		Line 73:
	==What Next?==		==What Next?==
	Now that the flowchart is complete, and documented correctly, you can further expand and develop the flowchart in the next exercise [[Exercise - Expanding a Program\|Expanding a Program]].		Now that the flowchart is complete, and documented correctly, you can further expand and develop the flowchart in the next exercise [[Exercise - Expanding a Program\|Expanding a Program]].
		+
		+
		+	==Link==
		+	To download the Flowcode program for this exercise, click on the following link [[File:xxx\|xxx]]

@@ Line 67: / Line 67: @@
 ==Save the Flowchart==
-* Save the flowchart using the same name. The simplest way to do this is to click on the 'Save' icon. [[File:Btn Save.png|30px]]
+* Save the flowchart using the same name. The simplest way to do this is to click on the 'Save' icon. [[File:Btn Save.png|border]]
 : For more information, see [[Saving a Flowchart]].

@@ Line 23: / Line 23: @@
 * Drag a [[Comment Icon Properties|Comment icon]] onto the flowchart above the 'Loop' icon.
 * Double click the 'Comment' icon to open up the [[Comment Icon Properties]] dialogue box.
 :* Explain the purpose of the loop and how it is the base of the process.
 :: The loop is the base of the program as it allows the program to continually check if the switch has been pressed by repeating the process of detecting the state of the switch.
 * Add a comment above the 'Input' icon.
 * Open the icon properties by double clicking on the 'Comment' icon.
 :* Describe the use of the 'Input' icon and how it reads the state of the switch.
 :: The 'Input' icon uses a variable to read and store the state of the switch, this allows the information contained in the variable to be used to see if the switch is being pressed or not.
 * Comment and document the 'Decision' icon.
 :* Describe how the 'Decision' icon detects the state of the switch and decides the next step to take.
 :: The 'Decision' icon will read the information in the variable to see if the switch has been pressed, it then decides which process path to follow next, if it is not being pressed it will go straight through to the loop and continually check if the switch is being pressed or not. If the switch is being pressed the following icons activate the LED and turns it off after 10 seconds.
 * Comment and document the 'Output' icon.
 :* Describe the function of the 'Output' icon.
 :: Once the 'Decision' icon detects that the switch is being pressed, the 'Output' icon turns on / lights up the LED and indicates that the switch has been pressed.
 * Comment and document the 'Delay' icon.
 :* Describe the function and purpose of the icon.
 :: This delays the program and stops it from continuing with another process, this allows the LED to stay lit up due to the previous command, this delay lasts 10 seconds until the program is then continued.
 * Comment and document the second 'Output' icon.
 :* Explain the function of this icon and the process afterwards.
 :: After the 10 second delay, this icon will turn the LED off and then continue the process of the program, which in turn, will loop to check if the button is being pressed again, this is the completes the circuit and will continue to loop and repeat the process, until stopped.