Language - Delphi - Revision history

Mparadis at 19:05, 6 June 2017

2017-06-06T19:05:01Z

← Older revision		Revision as of 19:05, 6 June 2017
Line 10:		Line 10:
	{{QuickDownloads\|Delphi\|		{{QuickDownloads\|Delphi\|
	{{APIQuickDownloads\|{{SERVER}}/documentation/COM_API_Manual.pdf COM}}\|		{{APIQuickDownloads\|{{SERVER}}/documentation/COM_API_Manual.pdf COM}}\|
	{{ExampleQuickDownloads\|{{SERVER}}/downloads/examples/Delphi.zip Delphi\|}}\|		{{ExampleQuickDownloads\|{{SERVER}}/downloads/phidget21/examples/com/Delphi.zip Delphi\|}}\|
	{{WindowsQuickDownloads}}		{{WindowsQuickDownloads}}
	}}		}}
Line 90:		Line 90:
	After you have installed the [[#Install ActiveX Objects\|Active X objects]], you can open our examples and run code to test your device. {{FindYourDevice}}		After you have installed the [[#Install ActiveX Objects\|Active X objects]], you can open our examples and run code to test your device. {{FindYourDevice}}

	First download the [{{SERVER}}/downloads/examples/Delphi.zip Delphi examples] and unpack them. Each project has its own folder. You can open an existing project and navigate to the project file itself to open it:		First download the [{{SERVER}}/downloads/phidget21/examples/com/Delphi.zip Delphi examples] and unpack them. Each project has its own folder. You can open an existing project and navigate to the project file itself to open it:

	[[Image:Delphi open project.png\|link=\|alt=]]		[[Image:Delphi open project.png\|link=\|alt=]]

Burley at 13:58, 17 June 2016

2016-06-17T13:58:09Z

← Older revision		Revision as of 13:58, 17 June 2016
Line 2:		Line 2:
	{{OSLang\|[[File:Icon-Delphi.png\|64px\|alt=\|link=]]\|'''[http://www.embarcadero.com/products/delphi Embarcadero Delphi]''' is an integrated development environment for console, desktop graphical, web application, and mobile applications.}}		{{OSLang\|[[File:Icon-Delphi.png\|64px\|alt=\|link=]]\|'''[http://www.embarcadero.com/products/delphi Embarcadero Delphi]''' is an integrated development environment for console, desktop graphical, web application, and mobile applications.}}
	__TOC__		__TOC__

	'''Delphi is used by such a small group of our users that we have decided to drop active support for Delphi. We will continue support until June 16th 2016. The libraries will still exist and be available for download and use though no further development will occur and official support will end. '''

	==Introduction==		==Introduction==

Burley at 16:22, 16 May 2016

2016-05-16T16:22:51Z

← Older revision		Revision as of 16:22, 16 May 2016
Line 2:		Line 2:
	{{OSLang\|[[File:Icon-Delphi.png\|64px\|alt=\|link=]]\|'''[http://www.embarcadero.com/products/delphi Embarcadero Delphi]''' is an integrated development environment for console, desktop graphical, web application, and mobile applications.}}		{{OSLang\|[[File:Icon-Delphi.png\|64px\|alt=\|link=]]\|'''[http://www.embarcadero.com/products/delphi Embarcadero Delphi]''' is an integrated development environment for console, desktop graphical, web application, and mobile applications.}}
	__TOC__		__TOC__

			'''Delphi is used by such a small group of our users that we have decided to drop active support for Delphi. We will continue support until June 16th 2016. The libraries will still exist and be available for download and use though no further development will occur and official support will end. '''

	==Introduction==		==Introduction==

Burley: /* Windows(2000/XP/Vista/7) */

2013-04-02T18:35:31Z

Windows(2000/XP/Vista/7)

← Older revision		Revision as of 18:35, 2 April 2013
Line 21:		Line 21:
	*[[#Windows(2000/XP/Vista/7)\|Windows 2000 / XP / Vista / 7]]		*[[#Windows(2000/XP/Vista/7)\|Windows 2000 / XP / Vista / 7]]

	==Windows(~~2000/~~XP/Vista/7)==		==Windows(XP/Vista/7/8)==

	===Borland Delphi===		===Borland Delphi===

Cora at 20:45, 28 June 2012

2012-06-28T20:45:48Z

← Older revision		Revision as of 20:45, 28 June 2012
Line 195:		Line 195:
	==Common Problems and Solutions/Workarounds==		==Common Problems and Solutions/Workarounds==

	===~~{{ProblemSolution\|~~Embarcadero XE2\|The Phidget Manager creates a runtime fault}}===		===Embarcadero XE2: The Phidget Manager creates a runtime fault===

	In Delphi XE2, you cannot use the Phidget Manager as an object directly. If you need to open multiple Phidgets of the same device type, use the serial number to distinguish between them.		In Delphi XE2, you cannot use the Phidget Manager as an object directly. If you need to open multiple Phidgets of the same device type, use the serial number to distinguish between them.

	===~~{{ProblemSolution\|~~Embarcadero XE2 under Windows in Oracle VirtualBox\|System Crash}}===		===Embarcadero XE2 under Windows in Oracle VirtualBox: System Crash===

	Embarcadero Delphi does ''not'' work under Windows running as a guest on Oracle's VirtualBox. Adding an ActiveX object on such a system will crash the system and appear to destroy it, although a hard power cycle will recover the system. VMWare does not suffer from this problem, and of course native Windows 7 works fine.		Embarcadero Delphi does ''not'' work under Windows running as a guest on Oracle's VirtualBox. Adding an ActiveX object on such a system will crash the system and appear to destroy it, although a hard power cycle will recover the system. VMWare does not suffer from this problem, and of course native Windows 7 works fine.

Cora at 20:43, 28 June 2012

2012-06-28T20:43:31Z

← Older revision		Revision as of 20:43, 28 June 2012
Line 9:		Line 9:
	==Quick Downloads==		==Quick Downloads==
	{{QuickDownloads\|Delphi\|		{{QuickDownloads\|Delphi\|
	{{APIQuickDownloads\|~~http://www.phidgets.com~~/documentation/COM_API_Manual.pdf COM}}\|		{{APIQuickDownloads\|{{SERVER}}/documentation/COM_API_Manual.pdf COM}}\|
	{{ExampleQuickDownloads\|~~http://www.phidgets.com~~/downloads/examples/Delphi.zip Delphi\|}}\|		{{ExampleQuickDownloads\|{{SERVER}}/downloads/examples/Delphi.zip Delphi\|}}\|
	{{WindowsQuickDownloads}}		{{WindowsQuickDownloads}}
	}}		}}
Line 90:		Line 90:
	After you have installed the [[#Install ActiveX Objects\|Active X objects]], you can open our examples and run code to test your device. {{FindYourDevice}}		After you have installed the [[#Install ActiveX Objects\|Active X objects]], you can open our examples and run code to test your device. {{FindYourDevice}}

	First download the [~~http://www.phidgets.com~~/downloads/examples/Delphi.zip Delphi examples] and unpack them. Each project has its own folder. You can open an existing project and navigate to the project file itself to open it:		First download the [{{SERVER}}/downloads/examples/Delphi.zip Delphi examples] and unpack them. Each project has its own folder. You can open an existing project and navigate to the project file itself to open it:

	[[Image:Delphi open project.png\|link=\|alt=]]		[[Image:Delphi open project.png\|link=\|alt=]]
Line 112:		Line 112:
	Your main reference for writing Delphi code will be our .COM API information, with syntax for all of our functions:		Your main reference for writing Delphi code will be our .COM API information, with syntax for all of our functions:

	{{UsingAPhidgetInCodeGeneral\|both of which are available in Delphi\|[~~http://www.phidgets.com~~/documentation/COM_API_Manual.pdf .COM API]}}		{{UsingAPhidgetInCodeGeneral\|both of which are available in Delphi\|[{{SERVER}}/documentation/COM_API_Manual.pdf .COM API]}}

	===Code Snippets===		===Code Snippets===

Cora: /* Follow The Examples */

2012-05-23T19:11:57Z

Follow The Examples

← Older revision		Revision as of 19:11, 23 May 2012
Line 126:		Line 126:

	Next, we need to tell the program to try and connect to the Phidget through a call to open().		Next, we need to tell the program to try and connect to the Phidget through a call to open().
	The open will tell the program to continuously try to connect to a Phidget, based on the parameters given, even trying to reconnect if it gets disconnected.		The open will tell the program to continuously try to connect to a Phidget, based on the parameters given, even trying to reconnect if it gets disconnected:

	<div class="source"><syntaxhighlight lang=delphi>		<div class="source"><syntaxhighlight lang=delphi>
Line 132:		Line 132:
	begin		begin
	PhidgetInterfaceKit1.Open(-1);		PhidgetInterfaceKit1.Open(-1);
	~~PhidgetInterfaceKit1.WaitForAttachment(3000);~~
	end;		end;
	</syntaxhighlight></div>		</syntaxhighlight></div>

	The parameters can also be used to open the first Phidget of a type it can find, open based on its serial number, or even open across the network. The API manual lists all of the available modes that open provides. One important thing to remember is that when working with Phidgets, a local connection will reserve the device until closed. This prevents any other instances from retrieving data from the Phidget, including other programs. The one connection per device limit does not apply when exclusively using the Phidget WebService. To open multiple Phidgets, they each need their own ActiveX object, and you can distinguish between them by serial number.		The parameters (here just a -1) can also be used to open the first Phidget of a type it can find, open based on its serial number, or even open across the network. The API manual lists all of the available modes that open provides.

			One important thing to remember is that when working with Phidgets, a local connection will reserve the device until closed. This prevents any other instances from retrieving data from the Phidget, including other programs. The one connection per device limit does not apply when exclusively using the Phidget WebService. To open multiple Phidgets, they each need their own ActiveX object, and you can distinguish between them by serial number.

	====Step Two: Wait for Attachment (plugging in) of the Phidget====		====Step Two: Wait for Attachment (plugging in) of the Phidget====

	~~This means that calling~~ open does not guarantee you can use the Phidget immediately.		Calling open does not guarantee you can use the Phidget immediately. To use the Phidget, it must be plugged in (attached). We can handle this by using event driven programming and tracking the AttachEvents and DetachEvents, or we can handle this by calling WaitForAttachment. You can put the wait function right after your open function. So we can modify our opening block to read:
	We can handle it by ~~either~~ using event driven programming and tracking the AttachEvents and DetachEvents, or by calling ~~waitForAttachment~~.
	~~WaitForAttachment will~~ block ~~indefinitely until a connection is made~~ to ~~the Phidget, or an optional timeout is exceeded.~~

			<div class="source"><syntaxhighlight lang=delphi>
			procedure TForm1.FormCreate(Sender: TObject);
			begin
			PhidgetInterfaceKit1.Open(-1);
			PhidgetInterfaceKit1.WaitForAttachment(3000);
			end;
			</syntaxhighlight></div>

			This function works for any Phidget. WaitForAttachment will block indefinitely until a connection is made to the Phidget, or an optional timeout is exceeded.

	====Step Three: Do Things with the Phidget====		====Step Three: Do Things with the Phidget====

	We recommend the use of event driven programming when working with Phidgets.		We recommend the use of [[General Phidget Programming#Event Driven Code\|event driven programming]] when working with Phidgets. This allows the program to execute other tasks until the Phidget fires a new event.
	This allows the program to execute other tasks until the Phidget fires a new event.

	In Delphi, when the event library was installed it added Phidget ActiveX components for each type of Phidget.		In Delphi, when the event library was installed as described in the [[#Use Our Examples\|Use Our Examples]] section, it added Phidget ActiveX components for each type of Phidget. These ActiveX components will show up in the toolbox under the ActiveX tab, usually in the lower right. The ActiveX object for your Phidget can be added to the form and then hooked to the event handlers you wish to use like any other control.
	These ActiveX components will show up in the toolbox under the ActiveX tab.
	The ActiveX object for your Phidget can be added to the form and then hooked to the event handlers you wish to use like any other control.		For example, for a Phidget21COMIPhidgetInterfaceKitEvents control, the event handler looks like the following:
	For a Phidget21COMIPhidgetInterfaceKitEvents control, the event handler looks like the following:

	<div class="source"><syntaxhighlight lang=delphi>		<div class="source"><syntaxhighlight lang=delphi>
			procedure TForm1.PhidgetInterfaceKit1SensorChange(ASender: TObject; Index, SensorValue: Integer);
	procedure TForm1.PhidgetInterfaceKit1SensorChange(ASender: TObject; Index,
	SensorValue: Integer);
	begin		begin
	Edit1.Text := IntToStr(Index) + ': ' + IntToStr(SensorValue);		Edit1.Text := IntToStr(Index) + ': ' + IntToStr(SensorValue);
	end;		end;
			</syntaxhighlight></div>

	~~</syntaxhighlight></div>~~		With this method, the code inside PhidgetInterfaceKit1SensorChange will get executed every time the PhidgetInterfaceKit reports a change on one of its analog inputs. Some events such as Attach and Detach belong to the base Phidget object and thus are common to all types of Phidgets. Other events, like this sensor change one, are specific to the type of Phidget. Please refer to the COM API manual for a full list of events and their general usage.
	With this method, the code inside PhidgetInterfaceKit1SensorChange will get executed every time the PhidgetInterfaceKit reports a change on one of its analog inputs.
	Some events such as Attach and Detach belong to the base Phidget object and thus are common to all types of Phidgets.
	Please refer to the COM API manual for a full list of events and their general usage.

	Some values can be directly read and set on the Phidget~~, and~~ inside polling ~~loops used~~ as an alternative to event driven programming.		Some values can be directly read and set on the Phidget. These functions can be used inside a polling loop as an alternative to event driven programming. Simply use the CallString such as SensorValue[Index] or OutputState[Index] for PhidgetInterfaceKits:
	Simply use the CallString such as SensorValue[Index] or OutputState[Index] for PhidgetInterfaceKits.

	<div class="source"><syntaxhighlight lang=delphi>		<div class="source"><syntaxhighlight lang=delphi>

	PhidgetInterfaceKit1.OutputState[0] := true;		PhidgetInterfaceKit1.OutputState[0] := true;

	</syntaxhighlight></div>		</syntaxhighlight></div>

Line 183:		Line 182:
	====Enabling Logging====		====Enabling Logging====

	Often it’s a good idea to enable logging during development for debugging purposes.		Often it’s a good idea to enable logging during development for debugging purposes. This log, depending on the level set, will record certain events and errors from Phidgets. In Delphi, this is accomplished by calling EnableLogging(logLevel, filename) on the Phidget object.
	This log, depending on the level set, will record certain events and errors from Phidgets.
	In Delphi, this is accomplished by calling EnableLogging(logLevel, filename) on the Phidget object.

	<div class="source"><syntaxhighlight lang=delphi>		<div class="source"><syntaxhighlight lang=delphi>

	PhidgetInterfaceKit1.EnableLogging(6, 'testlog.txt');		PhidgetInterfaceKit1.EnableLogging(6, 'testlog.txt');
			</syntaxhighlight></div>

	~~</syntaxhighlight></div>~~		Similarly, you can call DisableLogging() at the end of your program to shut it off. Should you need to contact Phidgets for support, including this log is very helpful for revealing the cause of the problem.
	Similarly, you can call DisableLogging() at the end of your program to shut it off.
	Should you need to contact Phidgets for support, including this log is very helpful for revealing the cause of the problem.
	Please see the Programming Manual for a general discussion on Phidget logging and the levels provided.		Please see the Programming Manual for a general discussion on Phidget logging and the levels provided.

Cora: /* Write Your Own Code */

2012-05-23T19:03:32Z

Write Your Own Code

← Older revision		Revision as of 19:03, 23 May 2012
Line 103:		Line 103:

	In Embarcadero, the lower right panel displays the available ActiveX objects for coding. You can create a new project and then simply drag the ActiveX object that matches your Phidget device into your project.		In Embarcadero, the lower right panel displays the available ActiveX objects for coding. You can create a new project and then simply drag the ActiveX object that matches your Phidget device into your project.

			We have a [[#Follow The Examples\|teaching section]] below which includes code snippets to augment the examples and help you compose your project.

	==Follow The Examples==		==Follow The Examples==

Cora: /* Follow The Examples */

2012-05-23T19:01:07Z

Follow The Examples

← Older revision		Revision as of 19:01, 23 May 2012
Line 105:		Line 105:

	==Follow The Examples==		==Follow The Examples==

			By following the instructions above, you probably now have a working example and want to understand it better so you can change it to do what you want. This teaching section has resources for you to learn from the examples and write your own.

			Your main reference for writing Delphi code will be our .COM API information, with syntax for all of our functions:

			{{UsingAPhidgetInCodeGeneral\|both of which are available in Delphi\|[http://www.phidgets.com/documentation/COM_API_Manual.pdf .COM API]}}

	===Code Snippets===		===Code Snippets===
Line 114:		Line 120:
	====Step One: Initialize and Open====		====Step One: Initialize and Open====

	~~====Coding For Your Phidget====~~		Before you can use the Phidget, you must declare and initialize its ActiveX object. The simplest method is to place the control from the ActiveX component tab on to your form. For this tutorial, we create a Phidget Interface Kit control (PhidgetInterfaceKit1) and then add a text edit field to the form for the purpose of capturing simple output. The object name for any type of Phidget is listed in the API manual.

	Before you can use the Phidget, you must declare and initialize its ActiveX object.
	The simplest method is to place the control from the ActiveX component tab on to your form.
	For this tutorial, create a ~~PhidgetInterfaceKit~~ control (PhidgetInterfaceKit1) and then add a text edit field to the form for the purpose of capturing simple output.
	The object name for any type of Phidget is listed in the API manual.
	Every type of Phidget also inherits functionality from the Phidget base class.		Every type of Phidget also inherits functionality from the Phidget base class.

	~~====Connecting to the Phidget====~~

	Next, we need to tell the program to try and connect to the Phidget through a call to open().		Next, we need to tell the program to try and connect to the Phidget through a call to open().
	The open will tell the program to continuously try to connect to a Phidget, based on the parameters given, even trying to reconnect if it gets disconnected.		The open will tell the program to continuously try to connect to a Phidget, based on the parameters given, even trying to reconnect if it gets disconnected.
	~~This means that calling open does not guarantee you can use the Phidget immediately.~~
	~~We can handle it by either using event driven programming and tracking the AttachEvents and DetachEvents, or by calling waitForAttachment.~~
	~~WaitForAttachment will block indefinitely until a connection is made to the Phidget, or an optional timeout is exceeded.~~

	<div class="source"><syntaxhighlight lang=delphi>		<div class="source"><syntaxhighlight lang=delphi>

	procedure TForm1.FormCreate(Sender: TObject);		procedure TForm1.FormCreate(Sender: TObject);
	begin		begin
Line 137:		Line 132:
	PhidgetInterfaceKit1.WaitForAttachment(3000);		PhidgetInterfaceKit1.WaitForAttachment(3000);
	end;		end;
			</syntaxhighlight></div>

			The parameters can also be used to open the first Phidget of a type it can find, open based on its serial number, or even open across the network. The API manual lists all of the available modes that open provides. One important thing to remember is that when working with Phidgets, a local connection will reserve the device until closed. This prevents any other instances from retrieving data from the Phidget, including other programs. The one connection per device limit does not apply when exclusively using the Phidget WebService. To open multiple Phidgets, they each need their own ActiveX object, and you can distinguish between them by serial number.

			====Step Two: Wait for Attachment (plugging in) of the Phidget====

			This means that calling open does not guarantee you can use the Phidget immediately.
			We can handle it by either using event driven programming and tracking the AttachEvents and DetachEvents, or by calling waitForAttachment.
			WaitForAttachment will block indefinitely until a connection is made to the Phidget, or an optional timeout is exceeded.

	~~</syntaxhighlight></div>~~
	~~The parameters can also be used to open the first Phidget of a type it can find, open based on its serial number, or even open across the network.~~
	~~The API manual lists all of the available modes that open provides.~~
	~~One important thing to remember is that when working with Phidgets, a local connection will reserve the device until closed.~~
	~~This prevents any other instances from retrieving data from the Phidget, including other programs.~~
	~~The one connection per device limit does not apply when exclusively using the Phidget Webservice.~~
	~~You can call Close any time outside of the Phidget’s own event handlers to end the connection.~~

	====~~Event Driven Programming~~====		====Step Three: Do Things with the Phidget====

	We recommend the use of event driven programming when working with Phidgets.		We recommend the use of event driven programming when working with Phidgets.
Line 168:		Line 165:
	Some events such as Attach and Detach belong to the base Phidget object and thus are common to all types of Phidgets.		Some events such as Attach and Detach belong to the base Phidget object and thus are common to all types of Phidgets.
	Please refer to the COM API manual for a full list of events and their general usage.		Please refer to the COM API manual for a full list of events and their general usage.

	~~====Working directly with the Phidget====~~

	Some values can be directly read and set on the Phidget, and inside polling loops used as an alternative to event driven programming.		Some values can be directly read and set on the Phidget, and inside polling loops used as an alternative to event driven programming.
Line 180:		Line 175:
	</syntaxhighlight></div>		</syntaxhighlight></div>

	====~~Working with multiple Phidgets~~====		====Step Four: Close and Delete====

	~~Multiple Phidgets of~~ the ~~same type can easily be run inside~~ the ~~same~~ program.		Remember that the Open call reserves the Phidget for sole use by your program. Close removes this lock. You can call Close any time outside of the Phidget's own event handlers to end the connection.
	~~In our case, it requires another PhidgetInterfaceKit ActiveX object to be added to the project~~.
	~~The new instance~~ can ~~then be set up, opened and used in~~ the ~~same fashion as the previous one.~~
	~~If the application needs~~ to ~~distinguish between the devices, open can be called with~~ the ~~serial number of a specific Phidget.~~

	~~====Other Phidgets====~~

	~~The design given in this document can also be followed for almost all Phidgets.~~
	~~For example, if you were using a PhidgetRFID instead of an PhidgetInterfacekit, you would place a PhidgetRFID ActiveX object instead of a PhidgetInterfaceKit.~~
	~~The methods and events available would change but they can be accessed in a similar manner~~.

	====Enabling Logging====		====Enabling Logging====
Line 207:		Line 193:
	Should you need to contact Phidgets for support, including this log is very helpful for revealing the cause of the problem.		Should you need to contact Phidgets for support, including this log is very helpful for revealing the cause of the problem.
	Please see the Programming Manual for a general discussion on Phidget logging and the levels provided.		Please see the Programming Manual for a general discussion on Phidget logging and the levels provided.

			{{MoreHowTos}}

	==Common Problems and Solutions/Workarounds==		==Common Problems and Solutions/Workarounds==

Cora: /* Follow The Examples */

2012-05-23T16:44:08Z

Follow The Examples

← Older revision		Revision as of 16:44, 23 May 2012
Line 107:		Line 107:

	===Code Snippets===		===Code Snippets===

			Specific calls in Delphi will differ in syntax from those on the [[General Phidget Programming]] page, but the concepts stay the same.

			It may help to have the [[General Phidget Programming]] page and this section open at the same time, because they parallel each other and you can refer to the Delphi syntax. However, ''many'' additional concepts are covered on the General Phidget Programming page on a high level, such as using multiple Phidgets, handling errors, and different styles of programming.

			====Step One: Initialize and Open====

	====Coding For Your Phidget====		====Coding For Your Phidget====