GMU:Functions and Classes (Arduino) - Revision history

Veja6203 at 14:02, 28 March 2017

2017-03-28T14:02:08Z

← Older revision		Revision as of 14:02, 28 March 2017
Line 4:		Line 4:

	* clarity: the bigger the program gets the harder it is to keep the general overview		* clarity: the bigger the program gets the harder it is to keep the general overview
	* decoupling: you only want to change a certain part of the program without influencing all the rest		* decoupling: you only want to change a certain part of the program without influencing all the rest of it
	* recyclability: there are several similar parts in your robot for which you would like to reuse particular sections of your code		* recyclability: there are several similar parts in your robot for which you would like to reuse particular sections of your code

Line 16:		Line 16:
	The [http://arduino.cc/de/Reference/FunctionDeclaration function] is an enormous useful tool that can help you structuring your code. Functions allow you to sum up several operations under the same command. This command can be called again and again without knowing about or duplicating the included code.		The [http://arduino.cc/de/Reference/FunctionDeclaration function] is an enormous useful tool that can help you structuring your code. Functions allow you to sum up several operations under the same command. This command can be called again and again without knowing about or duplicating the included code.

	Here is an example for a function ~~for setting~~ the speed of a motor ~~that~~ is connected to an H-bridge:		Here is an example for a function that sets the speed of a motor which is connected to an H-bridge:


Line 29:		Line 29:

	This already saves us a lot of typing –<br>		This already saves us a lot of typing –<br>
	But one thing still seems quite laborious: we have to know the exact pin numbers every time we want to change the speed.		But one thing still seems quite laborious: we have to know the exact pin numbers every time when we want to change the speed.

	Imagine a program in which similar function calls are distributed all over. <br>		Imagine a program in which similar function calls are distributed all over. <br>
Line 39:		Line 39:
	<br>		<br>

	==Possible ~~solution~~: Data and ~~code~~ in ~~one package~~ – ~~„Classes“~~ and ~~„Objects“~~==		==Possible Solution: Data and Code in One Package – "Classes" and "Objects"==

	C++ (and also Arduino) provides a specific feature that can solve our problem: Classes and Objects		C++ (and also Arduino) provides a specific feature that can solve our problem: Classes and Objects.

	A Class predefines common qualities of a group of Objects. <br>		A Class predefines common qualities of a group of Objects. <br>
Line 51:		Line 51:


	Now the computer knows that there is a class called ~~„Motor“~~.<br>		Now the computer knows that there is a class called "Motor".<br>
	This class (class) provides a function called ~~„setThrottle“~~ that is called as an argument by using a number (int) and that does not return anything (void).		This class (class) provides a function called "setThrottle" that is called as an argument by using a number (int) and that does not return anything (void).


	===Classes are Data~~-types~~===		===Classes are Data Types===

	We can use our ~~„Motor“~~ - class the same way we are using other data - types (int, long, float).<br>		We can use our "Motor" - class the same way we are using other data - types (int, long, float).<br>
	The following lines use that quality in order to implement two motors:		The following lines use that quality in order to implement two motors:
	<br>		<br>
Line 80:		Line 80:
	<br>		<br>

	===Classes can contain other variables that can only be accessed ~~„internally“~~===		===Classes can contain other variables that can only be accessed "internally"===


	How do the Objects ~~„leftMotor“~~ and ~~„rightMotor“~~ know which pins they want to switch on and off?		How do the Objects "leftMotor" and "rightMotor" know which pins they want to switch on and off?

	Until now our ~~„Motor“~~ class is quite abstract since it does not contain this information. <br>		Until now our "Motor" class is quite abstract since it does not contain this information. <br>
	A class that should conduct practical actions needs further variables (concrete pin numbers) and lines of code that describe what to do exactly.<br>		A class that should conduct practical actions needs further variables (concrete pin numbers) and lines of code that describe what to do exactly.<br>
	We can simply include both things in the class definition:		We can simply include both things in the class definition:
Line 94:		Line 94:

	How do we include the pin numbers into the Object if they are not visible from the outside?<br>		How do we include the pin numbers into the Object if they are not visible from the outside?<br>
	We simply write a ~~„setup“~~ Function for the class:		We simply write a "setup" Function for the class:


Line 102:		Line 102:
	<br>		<br>

	==A ~~complete example~~ ==		==A Complete Example ==


	In order to construct a complete example we only have to include the ~~„speed“~~-Function (see description above):		In order to construct a complete example we only have to include the "speed"-Function (see description above):


Line 113:		Line 113:
	<br>		<br>

	==Organizing ~~classes~~ in ~~separate files~~==		==Organizing Classes in Separate Files==


Line 120:		Line 120:
	1. <br>		1. <br>
	Click on the arrow in the right corner in order to add a new file.<br>		Click on the arrow in the right corner in order to add a new file.<br>
	Select ~~„new Tab“~~.		Select "new Tab".


Line 127:		Line 127:
	2.<br>		2.<br>
	Enter a filename at the bottom of the window. <br>		Enter a filename at the bottom of the window. <br>
	It must end with '.h' – In our case it could be 'motorControl.h'.		It must end with ".h" – In our case it could be "motorControl.h".

	3.<br>		3.<br>
Line 139:		Line 139:
	4.<br>		4.<br>
	Go back to your main file.<br>		Go back to your main file.<br>
	Now you have to 'link' the new file to your main file in order to use the features of our class.<br>		Now you have to "link" the new file to your main file in order to use the features of our class.<br>
	Include the following line in the top of your main file		Include the following line in the top of your main file

Line 153:		Line 153:

	In the beginning we promised that it is possible to replace different motor drivers without changing the rest of the program.<br>		In the beginning we promised that it is possible to replace different motor drivers without changing the rest of the program.<br>
	Classes can indeed include other Objects in the form of ~~„member variables“~~.		Classes can indeed include other Objects in the form of "[https://en.wikipedia.org/wiki/Member_variable member variables]".

	C++ allows class declarations and the code for included Functions to be be placed in different files. <br>		C++ allows class declarations and the code for included Functions to be be placed in different files. <br>

Veja6203: /* More Information */

2017-03-28T13:53:38Z

More Information

← Older revision		Revision as of 13:53, 28 March 2017
Line 152:		Line 152:
	Classes can build up on each other ("inheritance").		Classes can build up on each other ("inheritance").

	In the beginning we promised that it is possible to replace different motor drivers without changing the rest of the program.		In the beginning we promised that it is possible to replace different motor drivers without changing the rest of the program.<br>
	Classes can indeed include other Objects in the form of „member variables“.		Classes can indeed include other Objects in the form of „member variables“.

	C++ allows class declarations and the code for included Functions to be be placed in different files.		C++ allows class declarations and the code for included Functions to be be placed in different files. <br>
	If you want to know more about that you can read this article about creating libraries in Arduino: [http://arduino.cc/en/Hacking/LibraryTutorial http://arduino.cc/en/Hacking/LibraryTutorial ]		If you want to know more about that you can read this article about creating libraries in Arduino: <br>[http://arduino.cc/en/Hacking/LibraryTutorial http://arduino.cc/en/Hacking/LibraryTutorial ]

	<br>		<br>
	<br>		<br>
	<br>		<br>

Veja6203 at 13:53, 28 March 2017

2017-03-28T13:53:01Z

Veja6203: /* More Information */

2017-03-28T13:50:22Z

More Information

← Older revision		Revision as of 13:50, 28 March 2017
Line 150:		Line 150:
	==More Information==		==More Information==

	Classes can build up on each other (inheritance)		Classes can build up on each other ("inheritance").

	In the beginning we promised that it is possible to replace different motor drivers without changing the rest of the program.		In the beginning we promised that it is possible to replace different motor drivers without changing the rest of the program.

Veja6203: /* Organizing classes in separate files */

2017-03-28T13:50:06Z

Organizing classes in separate files

← Older revision		Revision as of 13:50, 28 March 2017
Line 145:		Line 145:

	and write the rest of your program as usual.		and write the rest of your program as usual.
			<br>
	<br>		<br>

Veja6203: /* Organizing classes in separate files */

2017-03-28T13:49:46Z

Organizing classes in separate files

← Older revision		Revision as of 13:49, 28 March 2017
Line 114:		Line 114:

	==Organizing classes in separate files==		==Organizing classes in separate files==


	We can improve our program structure by putting classes in separate files:		We can improve our program structure by putting classes in separate files:

			1. <br>
			Click on the arrow in the right corner in order to add a new file.<br>
			Select „new Tab“.

	1.
	~~Click on the arrow in the right corner in order to add a new file.~~
	~~Select „new Tab“.~~

	[[File:NewTabARDU.jpg]]		[[File:NewTabARDU.jpg]]
			<br>
			2.<br>
			Enter a filename at the bottom of the window. <br>
			It must end with '.h' – In our case it could be 'motorControl.h'.

	2.		3.<br>
	~~Enter a filename at the bottom of the window.~~
	~~It must end with .h – In our case it could be 'motorControl.h'.~~

	3.
	The first line of your code should be:		The first line of your code should be:

	'#include „Arduino.h“'		'#include „Arduino.h“'

	This line 'links' the file to the Arduino–specific features.		This line 'links' the file to the Arduino–specific features.<br>
	Now we can include the code of our class.		Now we can include the code of our class.

	4.		4.<br>
	Go back to your main file.		Go back to your main file.<br>
	Now you have to 'link' the new file to your main file in order to use the features of our class.		Now you have to 'link' the new file to your main file in order to use the features of our class.<br>
	Include the following line in the top of your main file		Include the following line in the top of your main file

Veja6203: /* Organizing classes in separate files */

2017-03-28T13:47:48Z

Organizing classes in separate files

← Older revision		Revision as of 13:47, 28 March 2017
Line 117:		Line 117:
	We can improve our program structure by putting classes in separate files:		We can improve our program structure by putting classes in separate files:

	~~:1.~~
	~~:Click on the arrow in the right corner in order to add a new file.~~
	~~:Select „new Tab“.~~

	~~:[[File:NewTabARDU~~.~~jpg]]~~		1.
			Click on the arrow in the right corner in order to add a new file.
			Select „new Tab“.

	:2.		[[File:NewTabARDU.jpg]]
	~~:Enter a filename at the bottom of the window.~~
	~~:It must end with .h – In our case it could be 'motorControl.h'~~.

	:3.		2.
	~~:The first line~~ of ~~your code should~~ be:		Enter a filename at the bottom of the window.
			It must end with .h – In our case it could be 'motorControl.h'.

	:~~'#include „Arduino.h“'~~		3.
			The first line of your code should be:

	~~:This line~~ '~~links' the file to the Arduino–specific features.~~		'#include „Arduino.h“'
	~~:Now we can~~ include ~~the code of our class~~.

	~~:4.~~		This line 'links' the file to the Arduino–specific features.
	~~:Go back to your main file.~~		Now we can include the code of our class.
	~~:Now you have to~~ '~~link~~' the ~~new~~ file to ~~your main file in order to use~~ the features of our class.
	~~:Include the following line in the top of your main file~~

	:'~~#include "MotorControl~~.~~h“'~~		4.
			Go back to your main file.
			Now you have to 'link' the new file to your main file in order to use the features of our class.
			Include the following line in the top of your main file

	:and write the rest of your program as usual.		'#include "MotorControl.h“'

			and write the rest of your program as usual.
	<br>		<br>

Veja6203: /* Organizing classes in separate files */

2017-03-28T13:46:38Z

Organizing classes in separate files

← Older revision		Revision as of 13:46, 28 March 2017
Line 116:		Line 116:

	We can improve our program structure by putting classes in separate files:		We can improve our program structure by putting classes in separate files:


	:1.		:1.

Veja6203: /* More details on the concept */

2017-03-28T13:45:40Z

More details on the concept

← Older revision		Revision as of 13:45, 28 March 2017
Line 146:		Line 146:
	<br>		<br>

	==More ~~details on the concept~~==		==More Information==

	Classes can build up on each other (inheritance)		Classes can build up on each other (inheritance)
Line 155:		Line 155:
	C++ allows class declarations and the code for included Functions to be be placed in different files.		C++ allows class declarations and the code for included Functions to be be placed in different files.
	If you want to know more about that you can read this article about creating libraries in Arduino: [http://arduino.cc/en/Hacking/LibraryTutorial http://arduino.cc/en/Hacking/LibraryTutorial ]		If you want to know more about that you can read this article about creating libraries in Arduino: [http://arduino.cc/en/Hacking/LibraryTutorial http://arduino.cc/en/Hacking/LibraryTutorial ]

			<br>
			<br>
			<br>

Veja6203: /* Organizing classes in separate files */

2017-03-28T13:45:17Z

Organizing classes in separate files

← Older revision		Revision as of 13:45, 28 March 2017
Line 144:		Line 144:

	:and write the rest of your program as usual.		:and write the rest of your program as usual.
	~~<br>~~
	<br>		<br>

← Older revision		Revision as of 13:53, 28 March 2017
Line 8:		Line 8:


	These problems reach back to the beginning of programming and their solution is an art and a science at the same time.		These problems reach back to the beginning of programming and their solution is an art and a science at the same time.<br>
	It generally helps a lot to separate your program into single subunits that are relatively independent from each other.		It generally helps a lot to separate your program into single subunits that are relatively independent from each other.

Line 28:		Line 28:


	This already saves us a lot of typing –		This already saves us a lot of typing –<br>
	But one thing still seems quite laborious: we have to know the exact pin numbers every time we want to change the speed.		But one thing still seems quite laborious: we have to know the exact pin numbers every time we want to change the speed.

	Imagine a program in which similar function calls are distributed all over.		Imagine a program in which similar function calls are distributed all over. <br>
	In case of a hardware update you would have to find every single function call and change the parameters manually.		In case of a hardware update you would have to find every single function call and change the parameters manually. <br>
	This effort could surely be spent for more useful things..		This effort could surely be spent for more useful things..

Line 43:		Line 43:
	C++ (and also Arduino) provides a specific feature that can solve our problem: Classes and Objects		C++ (and also Arduino) provides a specific feature that can solve our problem: Classes and Objects

	A Class predefines common qualities of a group of Objects.		A Class predefines common qualities of a group of Objects. <br>
	It for instance determines that every motor has the possibility to exert a certain amount of throttle.		It for instance determines that every motor has the possibility to exert a certain amount of throttle. <br>
	The corresponding program could look like this:		The corresponding program could look like this:

Line 51:		Line 51:


	Now the computer knows that there is a class called „Motor“.		Now the computer knows that there is a class called „Motor“.<br>
	This class (class) provides a function called „setThrottle“ that is called as an argument by using a number (int) and that does not return anything (void).		This class (class) provides a function called „setThrottle“ that is called as an argument by using a number (int) and that does not return anything (void).

Line 57:		Line 57:
	===Classes are Data-types===		===Classes are Data-types===

	We can use our „Motor“ - class the same way we are using other data - types (int, long, float).<p>		We can use our „Motor“ - class the same way we are using other data - types (int, long, float).<br>
	The following lines use that quality in order to implement two motors:		The following lines use that quality in order to implement two motors:
	<br>		<br>
Line 65:		Line 65:

	<br>		<br>
	~~<br>~~<br>		<br>

	===Calling inner functions of a class (Methods)===		===Calling inner functions of a class (Methods)===

	Imagine we want to drive the left motor with full throttle whereas the right motor should stop completely.		Imagine we want to drive the left motor with full throttle whereas the right motor should stop completely. <br>
	This can be expressed as follows:		This can be expressed as follows:

Line 85:		Line 85:
	How do the Objects „leftMotor“ and „rightMotor“ know which pins they want to switch on and off?		How do the Objects „leftMotor“ and „rightMotor“ know which pins they want to switch on and off?

	Until now our „Motor“ class is quite abstract since it does not contain this information.		Until now our „Motor“ class is quite abstract since it does not contain this information. <br>
	A class that should conduct practical actions needs further variables (concrete pin numbers) and lines of code that describe what to do exactly.		A class that should conduct practical actions needs further variables (concrete pin numbers) and lines of code that describe what to do exactly.<br>
	We can simply include both things in the class definition:		We can simply include both things in the class definition:

Line 93:		Line 93:


	How do we include the pin numbers into the Object if they are not visible from the outside?		How do we include the pin numbers into the Object if they are not visible from the outside?<br>
	We simply write a „setup“ Function for the class:		We simply write a „setup“ Function for the class: