Do Things with the Channel - Revision history

Mparadis at 20:40, 19 April 2022

2022-04-19T20:40:54Z

← Older revision		Revision as of 20:40, 19 April 2022
Line 65:		Line 65:
	<syntaxhighlight lang=javascript>		<syntaxhighlight lang=javascript>
	// Set a DC Motor's velocity:		// Set a DC Motor's velocity:
	ch.~~setTargetVelocity(~~0.5)		ch.targetVelocity = 0.5
	</syntaxhighlight>		</syntaxhighlight>

	<syntaxhighlight lang=javascript>		<syntaxhighlight lang=javascript>
	// Get a Voltage Input's voltage:		// Get a Voltage Input's voltage:
	~~val~~ = ch.~~getVoltage()~~		let voltage = ch.voltage
	</syntaxhighlight>		</syntaxhighlight>

Line 135:		Line 135:
	\|-\|		\|-\|
	JavaScript=<syntaxhighlight lang=javascript>		JavaScript=<syntaxhighlight lang=javascript>
	// ~~Declare~~ the event ~~handler~~		const ch = new phidget22.VoltageInput()
	function ~~onVoltageChangeHandler~~ (voltage) {
	console.log('Voltage: ' + voltage)		// Assign the handler that will be called when the event occurs
			ch.onVoltageChange = function(voltage) {
			console.log('Voltage: ' + voltage)
	}		}
	~~...~~
	~~var ch = new phidget22.VoltageInput()~~
	~~...~~
	~~// Assign the handler that will be called when the event occurs~~
	~~ch.onVoltageChange = onVoltageChangeHandler~~
	</syntaxhighlight>		</syntaxhighlight>
	</tabber>		</tabber>

Mparadis at 16:58, 15 March 2021

2021-03-15T16:58:54Z

← Older revision		Revision as of 16:58, 15 March 2021
Line 1:		Line 1:
	{{Recommended_Flow_Links\|{{Flow Page Number\|{{PAGENAME}} }} }}		[[Category:Programming]]{{Recommended_Flow_Links\|{{Flow Page Number\|{{PAGENAME}} }} }}
	After a channel has been ''opened'' and ''attached'', software can control the Phidget through the functions available to its channel class.		After a channel has been ''opened'' and ''attached'', software can control the Phidget through the functions available to its channel class.

Mparadis at 16:09, 9 April 2019

2019-04-09T16:09:25Z

← Older revision		Revision as of 16:09, 9 April 2019
Line 135:		Line 135:
	\|-\|		\|-\|
	JavaScript=<syntaxhighlight lang=javascript>		JavaScript=<syntaxhighlight lang=javascript>
	~~var ch = new phidget22.VoltageInput()~~		// Declare the event handler
			function onVoltageChangeHandler (voltage) {
	// Declare ~~and assign~~ the event handler
	~~ch.onVoltageChange =~~ function (voltage) {
	console.log('Voltage: ' + voltage)		console.log('Voltage: ' + voltage)
	}		}
			...
			var ch = new phidget22.VoltageInput()
			...
			// Assign the handler that will be called when the event occurs
			ch.onVoltageChange = onVoltageChangeHandler
	</syntaxhighlight>		</syntaxhighlight>
	</tabber>		</tabber>

Mparadis at 18:42, 8 April 2019

2019-04-08T18:42:56Z

← Older revision		Revision as of 18:42, 8 April 2019
Line 12:		Line 12:
	<syntaxhighlight lang=python>		<syntaxhighlight lang=python>
	#Set a DC Motor's velocity:		#Set a DC Motor's velocity:
	ch.~~setVelocity~~(0.5)		ch.setTargetVelocity(0.5)
	</syntaxhighlight>		</syntaxhighlight>

Line 25:		Line 25:
	<syntaxhighlight lang=java>		<syntaxhighlight lang=java>
	//Set a DC Motor's velocity:		//Set a DC Motor's velocity:
	ch.~~setVelocity~~(0.5);		ch.setTargetVelocity(0.5);
	</syntaxhighlight>		</syntaxhighlight>

Line 38:		Line 38:
	<syntaxhighlight lang=cSharp>		<syntaxhighlight lang=cSharp>
	//Set a DC Motor's velocity:		//Set a DC Motor's velocity:
	ch.~~Velocity~~ = 0.5;		ch.TargetVelocity = 0.5;
	</syntaxhighlight>		</syntaxhighlight>

Line 51:		Line 51:
	<syntaxhighlight lang=c>		<syntaxhighlight lang=c>
	//Set a DC Motor's velocity:		//Set a DC Motor's velocity:
	~~PhidgetDCMotor_setVelocity~~(ch, 0.5);		PhidgetDCMotor_setTargetVelocity(ch, 0.5);
	</syntaxhighlight>		</syntaxhighlight>

Line 61:		Line 61:

	'''Important Note:''' There will be a period of time between the attachment of a Phidget sensor and the availability of the first data from the device. Any attempts to get this data before it is ready will result in an error code, and a specific nonsensical result. See more information on this on our page for [[Unknown Values]].		'''Important Note:''' There will be a period of time between the attachment of a Phidget sensor and the availability of the first data from the device. Any attempts to get this data before it is ready will result in an error code, and a specific nonsensical result. See more information on this on our page for [[Unknown Values]].
			\|-\|
			JavaScript=
			<syntaxhighlight lang=javascript>
			// Set a DC Motor's velocity:
			ch.setTargetVelocity(0.5)
			</syntaxhighlight>

			<syntaxhighlight lang=javascript>
			// Get a Voltage Input's voltage:
			val = ch.getVoltage()
			</syntaxhighlight>

			'''Important Note:''' There will be a period of time between the attachment of a Phidget sensor and the availability of the first data from the device. Any attempts to get this data before it is ready will result in an exception.
	</tabber>		</tabber>

Line 119:		Line 132:
	//Assign the handler that will be called when the event occurs		//Assign the handler that will be called when the event occurs
	PhidgetVoltageInput_setOnVoltageChangeHandler(ch, onVoltageChangeHandler, NULL);		PhidgetVoltageInput_setOnVoltageChangeHandler(ch, onVoltageChangeHandler, NULL);
			</syntaxhighlight>
			\|-\|
			JavaScript=<syntaxhighlight lang=javascript>
			var ch = new phidget22.VoltageInput()

			// Declare and assign the event handler
			ch.onVoltageChange = function (voltage) {
			console.log('Voltage: ' + voltage)
			}
	</syntaxhighlight>		</syntaxhighlight>
	</tabber>		</tabber>
Line 196:		Line 218:
	<syntaxhighlight lang=C>		<syntaxhighlight lang=C>
	EPHIDGET_TIMEOUT		EPHIDGET_TIMEOUT
			</syntaxhighlight>
			\|-\|
			JavaScript=
			Enumerations with Phidgets in JavaScript will take the form of '''phidget22.EnumerationType.ENUMERATION_NAME'''.

			For example, specifying a SensorType to use the 1142 for a voltage input would look like:
			<syntaxhighlight lang=javascript>
			phidget22.VoltageSensorType.PN_1142
			</syntaxhighlight>
			and specifying a K-Type thermocouple for a temperature sensor would be:
			<syntaxhighlight lang=javascript>
			phidget22.ThermocoupleType.K
			</syntaxhighlight>
			The Phidget error code for timing out could be specified as:
			<syntaxhighlight lang=javascript>
			phidget22.ErrorCode.TIMEOUT
	</syntaxhighlight>		</syntaxhighlight>
	</tabber>		</tabber>

Jdecoux: Created page with "{{Recommended_Flow_Links|{{Flow Page Number|{{PAGENAME}} }} }} After a channel has been ''opened'' and ''attached'', software can control the Phidget through the functions ava..."

2019-02-28T20:05:08Z

Created page with "{{Recommended_Flow_Links|{{Flow Page Number|{{PAGENAME}} }} }} After a channel has been ''opened'' and ''attached'', software can control the Phidget through the functions ava..."

New page

{{Recommended_Flow_Links|{{Flow Page Number|{{PAGENAME}} }} }}
After a channel has been ''opened'' and ''attached'', software can control the Phidget through the functions available to its channel class.

This is the stage of your program where you can send commands to your channel, and handle the information it sends back.

==Calling Functions and Polling for Data==

The most basic way your program can interact with the Phidget channel is by interacting with the channel's functions and properties from the main body of the program.

<tabber>
Python=
<syntaxhighlight lang=python>
#Set a DC Motor's velocity:
ch.setVelocity(0.5)
</syntaxhighlight>

<syntaxhighlight lang=python>
#Get a Voltage Input's voltage:
val = ch.getVoltage()
</syntaxhighlight>

'''Important Note:''' There will be a period of time between the attachment of a Phidget sensor and the availability of the first data from the device. Any attempts to get this data before it is ready will result in an exception.
|-|
Java=
<syntaxhighlight lang=java>
//Set a DC Motor's velocity:
ch.setVelocity(0.5);
</syntaxhighlight>

<syntaxhighlight lang=java>
//Get a Voltage Input's voltage:
double val = ch.getVoltage();
</syntaxhighlight>

'''Important Note:''' There will be a period of time between the attachment of a Phidget sensor and the availability of the first data from the device. Any attempts to get this data before it is ready will result in an exception.
|-|
C#=
<syntaxhighlight lang=cSharp>
//Set a DC Motor's velocity:
ch.Velocity = 0.5;
</syntaxhighlight>

<syntaxhighlight lang=cSharp>
//Get a Voltage Input's voltage:
double val = ch.Voltage;
</syntaxhighlight>

'''Important Note:''' There will be a period of time between the attachment of a Phidget sensor and the availability of the first data from the device. Any attempts to get this data before it is ready will result in an exception.
|-|
C=
<syntaxhighlight lang=c>
//Set a DC Motor's velocity:
PhidgetDCMotor_setVelocity(ch, 0.5);
</syntaxhighlight>

<syntaxhighlight lang=c>
//Get a Voltage Input's voltage:
double voltage;
PhidgetVoltageInput_getVoltage(ch, &voltage);
</syntaxhighlight>

'''Important Note:''' There will be a period of time between the attachment of a Phidget sensor and the availability of the first data from the device. Any attempts to get this data before it is ready will result in an error code, and a specific nonsensical result. See more information on this on our page for [[Unknown Values]].
</tabber>

''The values returned by getting the values of these properties will be the same as the value from the latest event associated with the property.''

==Event Handlers==
The other, generally more recommended way of interacting with a Phidget channel is through event handlers. You can set up event handlers to react to status updates from channel, such as when a state change occurs, or when sensor data is received. Event handlers should be set up before opening the channel to avoid missing events, but they will begin executing during this phase of the program.

For example, with a Voltage Input channel, you could set up an event handler to process Voltage Change events.

<tabber>
Python=<syntaxhighlight lang=python>
#Declare the event handler
def onVoltageChangeHandler(self, voltage):
print("Voltage: " + str(voltage))
...
ch = VoltageInput()
...
#Assign the handler that will be called when the event occurs
ch.setOnVoltageChangeHandler(onVoltageChangeHandler)
</syntaxhighlight>
|-|
Java=<syntaxhighlight lang=java>
//Declare the event listener
public static VoltageInputVoltageChangeListener onVoltageChange = new VoltageInputVoltageChangeListener() {
@Override
public void onVoltageChange(VoltageInputVoltageChangeEvent e) {
System.out.println("Voltage: " + e.getVoltage());
}
};
...
VoltageInput ch;
...
//Assign the event listener that will be called when the event occurs
ch.addVoltageChangeListener(onVoltageChange);
</syntaxhighlight>
|-|
C#=<syntaxhighlight lang=cSharp>
//Declare the event handler
void voltageChange(object sender, Phidget22.Events.VoltageChangeEventArgs e) {
Console.WriteLine("Voltage: " + e.Voltage.ToString());
}
...
VoltageInput ch;
...
//Assign the handler that will be called when the event occurs
ch.VoltageChange += voltageChange;
</syntaxhighlight>
|-|
C=<syntaxhighlight lang=c>
//Declare the event handler
static void CCONV onVoltageChangeHandler(PhidgetVoltageInputHandle ph, void *ctx, double voltage) {
printf("Voltage: %lf\n", voltage);
}
...
PhidgetVoltageInputHandle ch;
...
//Assign the handler that will be called when the event occurs
PhidgetVoltageInput_setOnVoltageChangeHandler(ch, onVoltageChangeHandler, NULL);
</syntaxhighlight>
</tabber>

==Enumerations==

Some Phidget devices have functions that deal with specific predefined values called enumerations. Enumerations commonly provide readable names to a set of numbered options.

The form of these enumerations depends on your programming language, as shown below:

<tabber>
Python=
To include a specific enumeration in your Python script, first import it using:
<syntaxhighlight lang=python>
from Phidget22.EnumerationType import *
</syntaxhighlight>

Once imported, Phidgets enumerations in Python will take the form of '''EnumerationType.ENUMERATION_NAME'''.

For example, specifying a SensorType to use the 1142 for a voltage input would look like:
<syntaxhighlight lang=python>
VoltageSensorType.SENSOR_TYPE_1142
</syntaxhighlight>
and specifying a K-Type thermocouple for a temperature sensor would be:
<syntaxhighlight lang=python>
ThermocoupleType.THERMOCOUPLE_TYPE_K
</syntaxhighlight>
The Phidget error code for timing out could be specified as:
<syntaxhighlight lang=python>
ErrorCode.EPHIDGET_TIMEOUT
</syntaxhighlight>
|-|
Java=
Enumerations with Phidgets in Java will take the form of '''com.phidget22.EnumerationType.ENUMERATION_NAME'''.

For example, specifying a SensorType to use the 1142 for a voltage input would look like:
<syntaxhighlight lang=java>
com.phidget22.VoltageSensorType.PN_1142
</syntaxhighlight>
and specifying a K-Type thermocouple for a temperature sensor would be:
<syntaxhighlight lang=java>
com.phidget22.ThermocoupleType.K
</syntaxhighlight>
The Phidget error code for timing out could be specified as:
<syntaxhighlight lang=java>
com.phidget22.ErrorCode.TIMEOUT
</syntaxhighlight>
|-|
C#=
Enumerations with Phidgets in C# will take the form of '''Phidget22.EnumerationType.Enumeration_Name'''.

For example, specifying a SensorType to use the 1142 for a voltage input would look like:
<syntaxhighlight lang=cSharp>
Phidget22.VoltageSensorType.PN_1142
</syntaxhighlight>
and specifying a K-Type thermocouple for a temperature sensor would be:
<syntaxhighlight lang=cSharp>
Phidget22.ThermocoupleType.K
</syntaxhighlight>
The Phidget error code for timing out could be specified as:
<syntaxhighlight lang=cSharp>
Phidget22.ErrorCode.Timeout
</syntaxhighlight>
|-|
C=
Enumerations with Phidgets in C will take the form of '''ENUMERATION_NAME'''.

For example, specifying a SensorType to use the 1142 for a voltage input would look like:
<syntaxhighlight lang=C>
SENSOR_TYPE_1142
</syntaxhighlight>
and specifying a K-Type thermocouple for a temperature sensor would be:
<syntaxhighlight lang=C>
THERMOCOUPLE_TYPE_K
</syntaxhighlight>
The Phidget error code for timing out could be specified as:
<syntaxhighlight lang=C>
EPHIDGET_TIMEOUT
</syntaxhighlight>
</tabber>

You can find the Enumeration Type under the ''Enumerations'' section of the {{Phidget22API}} for your device, and the Enumeration Name in the drop-down list within.

{{Flow_Navigation_Buttons|{{Flow Page Number|{{PAGENAME}} }} }}