Phidgets

COM API Manual

Phidgets COM API Manual
Version 2.1.4
© Phidgets Inc. 2008

Last updated: June 2, 2008

Contents
Introduction
5 Overview
5 How to use Phidgets
5 Class Hierarchy

Phidget
6 Functions
8 Properties
10 Events

PhidgetAccelerometer
11 Properties
12 Events

PhidgetAdvancedServo
13 Properties

PhidgetEncoder
18 Properties
19 Events

PhidgetInterfaceKit
20 Properties
22 Events

PhidgetLED
23 Properties

PhidgetMotorControl
24 Properties
26 Events

PhidgetPHSensor
27 Properties
28 Events

PhidgetRFID
29 Properties
30 Events
PhidgetServo
31 Properties
32 Events

PhidgetStepper
33 Properties

PhidgetTemperatureSensor
40 Properties
42 Events

PhidgetTextLCD
43 Properties

PhidgetTextLED
45 Properties

PhidgetWeightSensor
46 Properties
46 Events

PhidgetManager
47 Functions
48 Properties
51 Events

PhidgetDictionary
53 Functions
55 Properties
55 Events

PhidgetKeyListener
57 Functions
57 Properties
58 Events
Introduction
Overview
This manual describes the Application Programming Interface (API) for each Phidget device,
as exposed by the COM library. This API can be used from a variety of languages; this manual
focuses on use within VB6.0, and therefore presents the COM interface as a VB6.0 user
sees it.

How to use Phidgets

Phidgets are an easy to use set of building blocks for low cost sensing and control from
your PC. Using the Universal Serial Bus (USB) as the basis for all Phidgets, the complexity is
managed behind this easy to use and robust Application Program Interface (API) library.

This library is written for a available on Windows only.

Languages that make use of the COM API and are supported by Phidgets include: VB6.0,
Labview, Delphi, VBA and VBScript. Each of these languages have their own way of exposing
functionality, but the base calls will be the same.

Refer to the Product manual for your Phidget and the Programming Manual for more
detailed, language unspecific API documentation. Also, there are a set of VB6.0 examples
available for download.

Class Hierarchy
• Phidget
• PhidgetAccelerometer
• PhidgetAdvancedServo
• PhidgetEncoder
• PhidgetInterfaceKit
• PhidgetLED
• PhidgetMotorControl
• PhidgetPHSensor
• PhidgetRFID
• PhidgetServo
• PhidgetStepper
• PhidgetTemperatureSensor
• PhidgetTextLCD
• PhidgetTextLED
• PhidgetWeightSensor
• PhidgetManager
• PhidgetDictionary
• PhidgetKeyListener

Introduction 5
Phidget
Class documentation for Phidget. This is the base class from which all other device classes
inherit. These calls are common to all Phidgets. See the programming manual for more
specific API details, supported functionality, units, etc.

Functions

Open
Opens a phidget.

Open(
SerialNumber as Long [optional]
);

Parameters:

SerialNumber [optional]
Serial number of the Phidget to open. Do not specify to open any.

OpenRemote
Opens a Phidget remotely using a server id.

OpenRemote(
ServerID as String [optional]
SerialNumber as Long [optional]
Password as String [optional]
);

Parameters:

ServerID
Server ID of the webservice to connect to. Not not specify to connect to any.

SerialNumber
Serial number of the Phidget to open. Do not specify to open any.

Password
Password of the webservice. Do not specify if the webservice does not have a password.

OpenRemoteIP
Opens a Phidget remotely using an address and port.

OpenRemote(
IPAddress as String
Post as Long
SerialNumber as Long [optional]
Password as String [optional]
);

Phidget 6
Parameters:

IPAddress
The address of the webservice to connect to.

Port
The port of the webservice to connect to.

SerialNumber
Serial number of the Phidget to open. Do not specify to open any.

Password
Password of the webservice. Do not specify if the webservice does not have a password.

Close
Closes a Phidget.

Close();

WaitForAttachment
Blocks until the Phidget has attached.

WaitForAttachment(
milliseconds as Long
};

Parameters:

milliseconds
The number of milliseconds to wait for an attachment. Specify 0 to wait forever.

EnableLogging
Enables logging in the C library. This is for debugging purposes.

EnableLogging(
level as Long,
file as String
);

Parameters:

level
The highest level of logs to report. This can be 1-6. See the Programming Manual for
more information.

file
The file to output logs to. Specify NULL to send logs to the console.

Phidget 7
DisableLogging
Disabled logging in the C library.

DisableLogging();

Log
Sends a log message to the log. Make sure to enable logging first.

Log(
level as Long,
ident as String,
log as String
);

Parameters:

level
The level to log at. There are 6 levels at 1-6.

ident
A user defined string to identify the log. This can be blank.

log
The message to log.

Properties

IsAttached
Gets the attached status of a Phidget.

IsAttached as Boolean [get]

DeviceType
Gets the device type of a Phidget.

DeviceType as String [get]

DeviceVersion
Gets the firmware version of a Phidget.

DeviceVersion as Long [get]

Phidget 8
Name
Gets the long name of a Phidget.

Name as String [get]

SerialNumber
Gets the unique serial number of a Phidget.

SerialNumber as Long [get]

Label
Gets / Sets the Label of a Phidget. Note that setting the label is not yet supported on
Windows.

Label as String [get,set]

IsAttachedToServer
Gets the attached to server state of a remotely opened Phidget.

IsAttachedToServer as Boolean [get]

Address
Gets the webservice address of a remotely opened Phidget.

Address as String [get]

Port
Gets the webservice port number of a remotely opened Phidget.

Port as Long [get]

ServerID
Gets the webservice Server ID of a remotely opened Phidget.

ServerID as String [get]

LibraryVersion
Gets the phidget library version. This returns both the C library and COM library versions as a
multi-line string.

LibraryVersion as String [get]

Phidget 9
Events
Note that these events are actually members of each Phidget device class rather then the
base class. However, since they are common to all Phidgets, they are documented here.

OnAttach
Fired when a Phidget is plugged in and ready to use.

event OnAttach

OnDetach
Fired when a Phidget is unplugged.

event OnDetach

OnError
Fired on an asynchronous error. These are mostly network related.

event OnError(
Description as String,
SCODE as Long
)

Parameters:

Description
A description of the error.

SCODE
An error code corresponding to the error. See the Programming Manual for a list of error
codes.

OnServerConnect
Fired when a connection to the webservice is made, when opening a Phidget remotely.

event OnServerConnect

OnServerDisconnect
Fired when a connection to the webservice is lost, when opening a Phidget remotely.

event OnServerDisconnect

Phidget 10
PhidgetAccelerometer
Class documentation for PhidgetAccelerometer. This class contains all calls specific to the
Phidget Accelerometer. See the product manual for more specific API details, supported
functionality, units, etc.

Properties

AxisCount
Gets the number of acceleration axes supported by this board.

AxisCount as Long [get]

Acceleration
Gets the current acceleration of a axis.

Acceleration(
Index as Long
) as Double [get]

Parameters:

Index
The acceleration axis.

AccelerationChangeTrigger
Gets / Sets the change trigger for an axis.

AccelerationChangeTrigger(
Index as Long
) as Double [get,set]

Parameters:

Index
The acceleration axis.

AccelerationMax
Gets the maximum acceleration that can be measured by as axis.

AccelerationMax(
Index as Long
) as Double [get]

Parameters:

Index
The acceleration axis.

PhidgetAccelerometer 11
AccelerationMin
Gets the minimum acceleration that can be measured by an axis.

AccelerationMin(
Index as Long
) as Double [get]

Parameters:

Index
The acceleration axis.

Events

OnAccelerationChange
Fired when the acceleration on an axis changes by more then the change trigger.

event OnAccelerationChange(
Index as Long,
Acceleration as Double
)

Parameters:

Index
The acceleration axis.

Acceleration
The acceleration.

PhidgetAccelerometer 12
PhidgetAdvancedServo
Class documentation for PhidgetAdvancedServo. This class contains all calls specific to the
Phidget Advanced Servo. See the product manual for more specific API details, supported
functionality, units, etc.

Properties

MotorCount
Gets the number of motors supported by this controller.

MotorCount as Long [get]

Acceleration
Gets / Sets the acceleration for a motor.

Acceleration(
Index as Long
) as Double [get,set]

Parameters:

Index
The motor index.

AccelerationMax
Gets the maximum acceleration supported by a motor.

AccelerationMax(
Index as Long
) as Double [get]

Parameters:

Index
The motor index.

AccelerationMin
Gets the minimum acceleration supported by a motor.

AccelerationMin(
Index as Long
) as Double [get]

Parameters:

Index
The motor index.

PhidgetAdvancedServo 13
Current
Gets the current current draw of a motor.

Current(
Index as Long
) as Double [get]

Parameters:

Index
The motor index.

Position
Gets / Sets the current / target position of a motor.

Position(
Index as Long
) as Double [get,set]

Parameters:

Index
The motor index.

PositionMax
Gets / Sets the maximum position supported by a motor.

PositionMax(
Index and Long
) as Double [get,set]

Parameters:

Index
The motor index.

PositionMin
Gets / Sets the minimum position supported by a motor.

PositionMin(
Index as Long
) as Double [get,set]

Parameters:

Index
The motor index.

PhidgetAdvancedServo 14
Velocity
Gets the current velocity of a motor.

Velocity(
Index as Long
) as Double [get]

Parameters:

Index
The motor index.

VelcityLimit
Gets / Set the velocity limit of a motor.

VelocityLimit(
Index as Long
) as Double [get,set]

Parameters:

Index
The motor index.

VelocityMax
Gets the maximum velocity limit supported by a motor.

VelocityMax(
Index as Long
) as Double [get]

Parameters:

Index
The motor index.

VelocityMin
Gets the minimum velocity limit supported by a motor.

VelocityMin(
Index as Long
) as Double [get]

Parameters:

Index
The motor index.

PhidgetAdvancedServo 15
Engaged
Gets / Sets the engaged state of a motor. This is whether a motor is powered or not.

Engaged(
Index as Long
) as Boolean [get,set]

Parameters:

Index
The motor index.

SpeedRampingOn
Gets / Sets the speed ramping state of a motor. This is whether or not the motor uses
velocity and acceleration to move.

SpeedRampingOn(
Index as Long
) as Boolean [get,set]

Parameters:

Index
The motor index.

Stopped
Gets the stopped state of a motor. If this is true, the motor is not moving and there are no
outstanding commands.

Stopped(
Index as Long
) as Boolean [get]

Parameters:

Index
The motor index.

PhidgetAdvancedServo 16
Events

OnCurrentChange
Fired when the current draw of a motor changes.

event OnCurrentChange(
Index as Long,
Current as Double
)

Parameters:

Index
The motor index.

Current
The current draw.

OnPositionChange
Fired when the position of a motor changes.

event OnPositionChange(
Index as Long,
Position as Double
)

Parameters:

Index
The motor index.

Position
The motor position.

OnVelocityChange
Fired when the velocity of a motor changes.

event OnVelocityChange(
Index as Long,
Velocity as Double
)

Parameters:

Index
The motor index.

Velocity
The current velocity.

PhidgetAdvancedServo 17
PhidgetEncoder
Class documentation for PhidgetEncoder. This class contains all calls specific to the Phidget
Encoder. See the product manual for more specific API details, supported functionality, units,
etc.

Properties

EncoderCount
Gets the number of encoder inputs supported by this board.

EncoderCount as Long [get]

Position
Gets / Sets the current position of an encoder.

Position(
Index as long
) as Long [get,set]

Parameters:

Index
The encoder index.

InputCount
Gets the number of digital inputs supported by this board.

InputCount as Long [get]

InputState
Gets the state of a digital input.

InputState(
Index as Long
) as Boolean [get]

Parameters:

Index
The digital input index.

PhidgetEncoder 18
Events

OnInputChange
Fired when a digital input changes.

event OnInputChange(
Index as Long,
NewState as Boolean
)

Parameters:

Index
The digital input index.

NewState
The state of the input

OnPositionChange
Fired when an encoder position changed.

event OnPositionChange(
Index as Long,
Time as Long,
EncoderDisplacement as Long
)

Parameters:

Index
The encoder index

Time
The time in milliseconds since the last position change event.

EncoderDisplacement
The amount the position changed since the last position change event.

PhidgetEncoder 19
PhidgetInterfaceKit
Class documentation for PhidgetInterfaceKit. This class contains all calls specific to the
Phidget Interface Kit. See the product manual for more specific API details, supported
functionality, units, etc.

Properties

InputCount
Gets the number of digital inputs supported by this board.

InputCount as Long [get]

InputState
Gets the state of a digital input.

InputState(
Index as Long
) as Boolean [get]

Parameters:

Index
The digital input index.

OutputCount
Gets the number of digital outputs supported by this board.

OutputCount as Long [get]

OutputState
Gets / Sets the state of a digital output.

OutputState(
Index as Long
) as Boolean [get,set]

Parameters:

Index
The digital output index.

SensorCount
Gets the number of sensors (analog inputs) supported by this board.

SensorCount as Long [get]

PhidgetInterfaceKit 20
SensorValue
Gets the value of a sensor (0-1000).

SensorValue(
Index as Long
) as Long [get]

Parameters:

Index
The sensor index.

SensorRawValue
Gets the raw value of a sensor (12-bit).

SensorRawValue(
Index as Long
) as Long [get]

Parameters:

Index
The sensor index.

SensorChangeTrigger
Gets / Sets the change trigger for a sensor.

SensorChangeTrigger(
Index as Long
) as Long [get,set]

Parameters:

Index
The sensor index.

Ratiometric
Gets / Sets the ratiometric state of a sensor.

Ratiometric(
Index as Long
) as Boolean [get,set]

Parameters:

Index
The sensor index.

PhidgetInterfaceKit 21
Events

OnInputChange
Fired when a digital input changes.

event OnInputChange(
Index as Long,
NewState as Boolean
)

Parameters:

Index
The digital inputs index.

NewState
The digital input state.

OnOutputChange
Fired when a digital output changes.

event OnOutputChange(
Index as Long,
NewState as Boolean
)

Parameters:

Index
The digital output index.

NewState
The digital output state.

OnSensorChange
Fired when a sensor value changes by more then the change trigger.

event OnSensorChange(
Index as long,
SensorValue as long
)

Parameters:

Index
The sensor index.

SensorValue
The sensor value.

PhidgetInterfaceKit 22
PhidgetLED
Class documentation for PhidgetLED. This class contains all calls specific to the Phidget LED.
See the product manual for more specific API details, supported functionality, units, etc.

Properties

LEDCount
Gets the number of LEDs supported by this controller.

LEDCount as Long [get]

DiscreteLED
Gets / Sets the brightness of an LED (0-100).

DiscreteLED(
Index as Long
) as Long [get,set]

Parameters:

Index
The LED index.

PhidgetLED 23
PhidgetMotorControl
Class documentation for PhidgetMotorControl. This class contains all calls specific to the
Phidget Motor Control. See the product manual for more specific API details, supported
functionality, units, etc.

Properties

InputCount
Gets the number of digital inputs supported by this controller.

InputCount as Long [get]

InputState
Gets the state of a digital input.

InputState(
Index as Long
) as Boolean [get]

Parameters:

Index
The digital input index.

MotorCount
Gets the number of motors supported by this controller.

MotorCount as Long [get]

Acceleration
Gets / Sets the acceleration for a motor.

Acceleration(
Index as Long
) as Double [get,set]

Parameters:

Index
The motor index.

PhidgetMotorControl 24
AccelerationMax
Gets the maximum acceleration supported by a motor.

AccelerationMax(
Index as Long
) as Double [get]

Parameters:

Index
The motor index.

AccelerationMin
Gets the minimum acceleration supported by a motor.

AccelerationMin(
Index as Long
) as Double [get]

Parameters:

Index
The motor index.

Current
Gets the current current draw of a motor.

Current(
Index as Long
) as Double [get]

Parameters:

Index
The motor index.

Velocity
Gets / Sets the current velocity of a motor.

Velocity(
Index as Long
) as Double [get,set]

Parameters:

Index
The motor index.

PhidgetMotorControl 25
Events

OnInputChange
Fired when a digital input changes.

event OnInputChange(
Index as Long,
NewState as Boolean
)

Parameters:

Index
The digital input index.

NewState
The state of the input

OnVelocityChange
Fired when the velocity of a motor changes.

event OnVelocityChange(
Index as Long,
Velocity as Double
)

Parameters:

Index
The motor index.

Velocity
The current velocity.

PhidgetMotorControl 26
PhidgetPHSensor
Class documentation for PhidgetPHSensor. This class contains all calls specific to the Phidget
PH Sensor. See the product manual for more specific API details, supported functionality,
units, etc.

Properties

PH
Gets the currently sensed PH.

PH as Double [get]

PHMax
Gets the maximum PH that could be sensed.

PHMax as Double [get]

PHMin
Gets the minimum PH that could be sensed.

PHMin as Double [get]

PHChangeTrigger
Gets / Sets the PH change trigger.

PHChangeTrigger as Double [get,set]

Potential
Gets the currently sensed potential.

Potential as Double [get]

PotentialMax
Gets the maximum potential that the board can sense.

PotentialMax as Double [get]

PotentialMin
Gets the minimum potential that the board can sense.

PotentialMin as Double [get]

PhidgetPHSensor 27
Temperature
Sets the temperature value used for the PH calculation. Default is 20 degrees Celsius.

Temperature as Double [set]

Events

OnPHChange
Fired when the PH changes by more then the change trigger.

event OnPHChange(
PH as Double
)

Parameters:

PH
The PH.

PhidgetPHSensor 28
PhidgetRFID
Class documentation for PhidgetRFID. This class contains all calls specific to the Phidget
RFID. See the product manual for more specific API details, supported functionality, units,
etc.

Properties

OutputCount
Gets the number of digital outputs supported by this board.

OutputCount as Long [get]

OutputState
Gets / Sets the state of a digital output.

OutputState(
Index as Long
) as Boolean [get,set]

Parameters:

Index
The digital output index.

AntennaOn
Gets / Sets the state of the antenna. Note that antenna must be enabled before tags will be
read.

AntennaOn as Boolean [get,set]

LEDOn
Gets / Sets the state of the onboard LED.

LEDOn as Boolean [get,set]

TagStatus
Gets the tag status. This is true if there is a tag on the reader.

TagStatus as Boolean [get]

LastTag
Gets the last tag that was read. This tag may or may not still be on the reader.

LastTag as String [get]

PhidgetRFID 29
Events

OnOutputChange
Fired when a digital output changes.

event OnOutputChange(
Index as Long,
NewState as Boolean
)

Parameters:

Index
The digital output index.

NewState
The digital output state.

OnTag
Fired when a tag is detected.

event OnTag(
TagNumber as String
)

Parameters:

TagNumber
The detected tag.

OnTagLost
Fired when a tag is is taken off the reader.

event OnTagLost(
TagNumber as String
)

Parameters:

TagNumber
The lost tag.

PhidgetRFID 30
PhidgetServo
Class documentation for PhidgetServo. This class contains all calls specific to the Phidget
Servo. See the product manual for more specific API details, supported functionality, units,
etc.

Properties

MotorCount
Gets the number of motors supported by this controller.

MotorCount as Long [get]

Position
Gets / Sets the current / target position of a motor.

Position(
Index as Long
) as Double [get,set]

Parameters:

Index
The motor index.

PositionMax
Gets the maximum position supported by a motor.

PositionMax(
Index and Long
) as Double [get]

Parameters:

Index
The motor index.

PositionMin
Gets the minimum position supported by a motor.

PositionMin(
Index as Long
) as Double [get]

Parameters:

Index
The motor index.

PhidgetServo 31
Engaged
Gets / Sets the engaged state of a motor. This is whether a motor is powered or not.

Engaged(
Index as Long
) as Boolean [get,set]

Parameters:

Index
The motor index.

Events

OnPositionChange
Fired when the position of a motor changes.

event OnPositionChange(
Index as Long,
Position as Double
)

Parameters:

Index
The motor index.

Position
The motor position.

PhidgetServo 32
PhidgetStepper
Class documentation for PhidgetStepper. This class contains all calls specific to the Phidget
Stepper. See the product manual for more specific API details, supported functionality, units,
etc.

Properties

InputCount
Gets the number of digital inputs supported by this board.

InputCount as Long [get]

InputState
Gets the state of a digital input.

InputState(
Index as Long
) as Boolean [get]

Parameters:

Index
The digital input index.

MotorCount
Gets the number of motors supported by this controller.

MotorCount as Long [get]

Acceleration
Gets / Sets the acceleration for a motor.

Acceleration(
Index as Long
) as Double [get,set]

Parameters:

Index
The motor index.

PhidgetStepper 33
AccelerationMax
Gets the maximum acceleration supported by a motor.

AccelerationMax(
Index as Long
) as Double [get]

Parameters:

Index
The motor index.

AccelerationMin
Gets the minimum acceleration supported by a motor.

AccelerationMin(
Index as Long
) as Double [get]

Parameters:

Index
The motor index.

Current
Gets the current current draw of a motor.

Current(
Index as Long
) as Double [get]

Parameters:

Index
The motor index.

CurrentLimit
Gets / Sets the current limit for a motor.

CurrentLimit(
Index as Long
) as Double [get,set]

Parameters:

Index
The motor index.

PhidgetStepper 34
CurrentMax
Gets the maximum current limit supported by a motor.

CurrentMax(
Index as Long
) as Double [get]

Parameters:

Index
The motor index.

CurrentMin
Gets the minimum current limit supported by a motor.

CurrentMin(
Index as Long
) as Double [get]

Parameters:

Index
The motor index.

CurrentPosition
Gets / Sets the current position of a motor.

CurrentPosition(
Index as Long
) as Long [get,set]

Parameters:

Index
The motor index.

TargetPosition
Gets / Sets the target position of a motor.

TargetPosition(
Index as Long
) as Long [get,set]

Parameters:

Index
The motor index.

PhidgetStepper 35
PositionMax
Gets the maximum position supported by a motor.

PositionMax(
Index and Long
) as Long [get]

Parameters:

Index
The motor index.

PositionMin
Gets the minimum position supported by a motor.

PositionMin(
Index as Long
) as Long [get]

Parameters:

Index
The motor index.

Velocity
Gets the current velocity of a motor.

Velocity(
Index as Long
) as Double [get]

Parameters:

Index
The motor index.

VelcityLimit
Gets / Set the velocity limit of a motor.

VelocityLimit(
Index as Long
) as Double [get,set]

Parameters:

Index
The motor index.

PhidgetStepper 36
VelocityMax
Gets the maximum velocity limit supported by a motor.

VelocityMax(
Index as Long
) as Double [get]

Parameters:

Index
The motor index.

VelocityMin
Gets the minimum velocity limit supported by a motor.

VelocityMin(
Index as Long
) as Double [get]

Parameters:

Index
The motor index.

Engaged
Gets / Sets the engaged state of a motor. This is whether a motor is powered or not.

Engaged(
Index as Long
) as Boolean [get,set]

Parameters:

Index
The motor index.

Stopped
Gets the stopped state of a motor. If this is true, the motor is not moving and there are no
outstanding commands.

Stopped(
Index as Long
) as Boolean [get]

Parameters:

Index
The motor index.

PhidgetStepper 37
Events

OnInputChange
Fired when a digital input changes.

event OnInputChange(
Index as Long,
NewState as Boolean
)

Parameters:

Index
The digital inputs index.

NewState
The digital input state.

OnCurrentChange
Fired when the current draw of a motor changes.

event OnCurrentChange(
Index as Long,
Current as Double
)

Parameters:

Index
The motor index.

Current
The current draw.

OnPositionChange
Fired when the position of a motor changes.

event OnPositionChange(
Index as Long,
Position as Long
)

Parameters:

Index
The motor index.

Position
The motor position.

PhidgetStepper 38
OnVelocityChange
Fired when the velocity of a motor changes.

event OnVelocityChange(
Index as Long,
Velocity as Double
)

Parameters:

Index
The motor index.

Velocity
The current velocity.

PhidgetStepper 39
PhidgetTemperatureSensor
Class documentation for PhidgetTemperatureSensor. This class contains all calls specific
to the Phidget Temperature Sensor. See the product manual for more specific API details,
supported functionality, units, etc.

Properties

TemperatureInputCount
Gets the number of thermocouple inputs supported by this board.

TemperatureInputCount as Long [get]

Temperature
Gets the currently sensed temperature of a thermocouple input.

Temperature(
Index as Long
) as Double [get]

Parameters:

Index
The thermocouple input index.

TemperatureMax
Gets the maximum temperature that a thermocouple input can measure.

TemperatureMax(
Index as Long
) as Double [get]

Parameters:

Index
The thermocouple input index.

TemperatureMin
Gets the minimum temperature that a thermocouple input can measure.

TemperatureMin(
Index as Long
) as Double [get]

Parameters:

Index
The thermocouple input index.

PhidgetTemperatureSensor 40
TemperatureChangeTrigger
Gets / Sets the change trigger for a thermocouple input.

TemperatureChangeTrigger(
Index as Long
) as Double [get,set]

Parameters:

Index
The thermocouple input index.

ThermocoupleType
Gets / Sets the type of thermocouple attached to a thermocouple input.

ThermocoupleType(
Index as Long
) as Long [get,set]

Parameters:

Index
The thermocouple input index.

Discussion:

There are 4 thermocouple types supported: K-Type=1, J-Type=2, E-Type=3 and T-Type=4.

Potential
Gets the currently measured potential at a thermocouple input.

Potential(
Index as Long
) as Double [get]

Parameters:

Index
The thermocouple input index.

PotentialMax
Gets the maximum potential that a thermocouple input can measure.

PotentialMax(
Index as long
) as Double [get]

Parameters:

Index
The thermocouple input index.

PhidgetTemperatureSensor 41
PotentialMin
Gets the minimum potential that a thermocouple input can measure.

PotentilaMin(
Index as Long
) as Double [get]

Parameters:

Index
The thermocouple input index.

AmbientTemperature
Gets the ambient (board) temperature.

AmbientTemperature as Double [get]

AmbientTemperatureMax
Gets the maximum temperature that the ambient sensor can measure.

AmbientTemperatureMax as Double [get]

AmbientTemperatureMin
Gets the minimum temperature that the ambient sensor can measure.

AmbientTemperatureMin as Double [get]

Events

OnTemperatureChange
Fired when the temperature of a thermocouple changes by more then the change trigger.

event OnTemperatureChange(
Index as Long,
Temperature as Double
)

Parameters:

Index
The thermocouple input index.

Temperature
The temperature.

PhidgetTemperatureSensor 42
PhidgetTextLCD
Class documentation for PhidgetTextLCD. This class contains all calls specific to the Phidget
Text LCD. See the product manual for more specific API details, supported functionality,
units, etc.

Properties

RowCount
Gets the number of display rows supported by this board.

RowCount as Long [get]

ColumnCount
Gets the number of columns per row supported by this board

ColumnCount as Long [get]

Backlight
Gets / Sets the backlight state.

Backlight as Boolean [get,set]

Contrast
Gets / Sets the contrast (0-255).

Constrast as Long [get,set]

CursorBlink
Gets / Sets the cursor blink state.

CursorBlink as Boolean [get,set]

CursorOn
Gets / Sets the cursor on state.

CursorOn as Boolean [get,set]

PhidgetTextLCD 43
CustomCharacter
Sets a custom character. See the TextLCD manual for more information.

CustomCharacter(
Index as Long,
Val1 as Long,
Val2 as Long
) [set]

Parameters:

Index
The custom character index (8-15)

Val1
The first half of the custom character

Val1
The second half of the custom character

DisplayString
Sets the string to display on a row.

DisplayString(
Index as Long
) as String [set]

Parameters:

Index
The row index.

PhidgetTextLCD 44
PhidgetTextLED
Class documentation for PhidgetTextLED. This class contains all calls specific to the Phidget
Text LED. See the product manual for more specific API details, supported functionality, units,
etc.

Properties

RowCount
Gets the number of display rows supported by this board.

RowCount as Long [get]

ColumnCount
Gets the number of columns per row supported by this board

ColumnCount as Long [get]

Brightness
Gets / Sets the brightness.

Brightness as Long [get,set]

DisplayString
Sets the string to display on a row.

DisplayString(
Index as Long
) as String [set]

Parameters:

Index
The row index.

PhidgetTextLED 45
PhidgetWeightSensor
Class documentation for PhidgetWeightSensor. This class contains all calls specific to the
Phidget Weight Sensor. See the product manual for more specific API details, supported
functionality, units, etc.

Properties

Weight
Gets the currently sensed weight.

Weight as Double [get]

WeightChangeTrigger
Gets / Sets the change trigger.

WeightChangeTrigger as Double [get,set]

Events

OnWeightChange
Fired when the weight changes by more then the change trigger.

event OnWeightChange(
Weight as Double
)

Parameters:

Weight
The weight.

PhidgetWeightSensor 46
PhidgetManager
Class documentation for PhidgetManager. This class contains all calls specific to the Phidget
Manager. See the programming manual for more specific API details, supported functionality,
etc.

Functions

Open
Opens a manager

Open();

OpenRemote
Opens a manager remotely using a server id.

OpenRemote(
ServerID as String [optional],
Password as String [optional]
);

Parameters:

ServerID
Server ID of the webservice to connect to. Not not specify to connect to any.

Password
Password of the webservice. Do not specify if the webservice does not have a password.

OpenRemoteIP
Opens a manager remotely using an address and port.

OpenRemote(
IPAddress as String,
Post as Long,
Password as String [optional]
);

Parameters:

IPAddress
The address of the webservice to connect to.

Port
The port of the webservice to connect to.

Password
Password of the webservice. Do not specify if the webservice does not have a password.

PhidgetManager 47
Close
Closes a manager.

Close();

Properties

Count
Gets the number of attached phidgets. Use with the Device functions to enumerate
connected devices by index.

Count as Long [get]

DeviceType
Gets the device type of a Phidget.

DeviceType(

Index as Long

) as String [get]

Parameters:

Index
Index of an attached phidget.

DeviceVersion
Gets the firmware version of a Phidget.

DeviceVersion(

Index as Long

) as Long [get]

Parameters:

Index
Index of an attached phidget.

PhidgetManager 48
DeviceName
Gets the long name of a Phidget.

DeviceName(

Index as Long

) as String [get]

Parameters:

Index
Index of an attached phidget.

DeviceSerial
Gets the unique serial number of a Phidget.

DeviceSerial(

Index as Long

) as Long [get]

Parameters:

Index
Index of an attached phidget.

DeviceLabel
Gets the Label of a Phidget.

DeviceLabel(

Index as Long

) as String [get]

Parameters:

Index
Index of an attached phidget.

IsAttachedToServer
Gets the attached to server state of a remotely opened manager.

IsAttachedToServer as Boolean [get]

Address
Gets the webservice address of a remotely opened manager.

Address as String [get]

PhidgetManager 49
Port
Gets the webservice port number of a remotely opened manager.

Port as Long [get]

ServerID
Gets the webservice Server ID of a remotely opened manager.

ServerID as String [get]

PhidgetManager 50
Events

OnAttach
Fired when a Phidget is plugged in.

event OnAttach(
deviceType as String,
deviceName as String,
serialNumber as Long,
deviceVersion as Long,
deviceLabel as String
)

Parameters:

deviceType
The device type.

deviceName
The device name.

serialNumber
The serial number.

deviceVersion
The device version.

deviceLabel
The device label.

OnDetach
Fired when a Phidget is unplugged.

event OnDetach(
deviceType as String,
deviceName as String,
serialNumber as Long,
deviceVersion as Long,
deviceLabel as String
)

PhidgetManager 51
Parameters:

deviceType
The device type.

deviceName
The device name.

serialNumber
The serial number.

deviceVersion
The device version.

deviceLabel
The device label.

OnError
Fired on an asynchronous error. These are mostly network related.

event OnError(
Description as String,
SCODE as Long
)

Parameters:

Description
A description of the error.

SCODE
An error code corresponding to the error. See the Programming Manual for a list of error
codes.

OnServerConnect
Fired when a connection to the webservice is made, when opening a manager remotely.

event OnServerConnect

OnServerDisconnect
Fired when a connection to the webservice is lost, when opening a manager remotely.

event OnServerDisconnect

PhidgetManager 52
PhidgetDictionary
Class documentation for PhidgetDictionary. This class contains all calls specific to the
Phidget Dictionary. See the programming manual for more specific API details, supported
functionality, etc.

Functions

OpenRemote
Opens a dictionary remotely using a server id.

OpenRemote(
ServerID as String [optional],
Password as String [optional]
);

Parameters:

ServerID
Server ID of the webservice to connect to. Not not specify to connect to any.

Password
Password of the webservice. Do not specify if the webservice does not have a password.

OpenRemoteIP
Opens a dictionary remotely using an address and port.

OpenRemote(
IPAddress as String,
Post as Long,
Password as String [optional]
);

Parameters:

IPAddress
The address of the webservice to connect to.

Port
The port of the webservice to connect to.

Password
Password of the webservice. Do not specify if the webservice does not have a password.

Close
Closes the connection to a dictionary.

Close();

PhidgetDictionary 53
Add
Adds a key / value pair to the dictionary, or updates the value of an existing key.

Add(
Key as String,
Value as String,
Persistent as Boolean [optional]
);

Parameters:

Key
The key string to add. The key can only contain numbers, letters, “/”, “.”, “-”, “_”, and must
begin with a letter, “_” or “/”.

Value
The value string.

Persistent
Whether this key remains in the dictionary once this connection is closed. Default is True.

Remove
Removes a set of keys from the dictionary.

Remove(
Pattern as String
);

Parameters:

Pattern
A regular expression representing a set of keys to remove.

Get
This is not implemented.

Get(
Key as String
) as String;

Parameters:

Key
The key to get the value of.

Returns:

The value for the specified key.

PhidgetDictionary 54
Properties

IsAttachedToServer
Gets the attached to server state of a remotely opened manager.

IsAttachedToServer as Boolean [get]

Address
Gets the webservice address of a remotely opened manager.

Address as String [get]

Port
Gets the webservice port number of a remotely opened manager.

Port as Long [get]

ServerID
Gets the webservice Server ID of a remotely opened manager.

ServerID as String [get]

Events

OnError
Fired on an asynchronous error. These are mostly network related.

event OnError(
Description as String,
SCODE as Long
)

Parameters:

Description
A description of the error.

SCODE
An error code corresponding to the error. See the Programming Manual for a list of error
codes.

PhidgetDictionary 55
OnServerConnect
Fired when a connection to the webservice is made, when opening a manager remotely.

event OnServerConnect

OnServerDisconnect
Fired when a connection to the webservice is lost, when opening a manager remotely.

event OnServerDisconnect

PhidgetDictionary 56
PhidgetKeyListener
Class documentation for PhidgetKeyListener. This class enables the key listening abilities of
the Phidget Dictionary. See the programming manual for more specific API details, supported
functionality, etc.

Functions

Start
Starts listening for key changes on a dictionary with a specific pattern. This must be called on
a connected dictionary, and is best called in the dictionary’s OnServerConnect event.

Start(
Dict as PhidgetDictionary,
Pattern as String
);

Parameters:

Dict
The dictionary to listen for keys on.

Pattern
The key pattern to listen for.

Stop
Stops listening for keys. This should be called in the dictionary’s OnServerDisconnect event.

Stop();

Properties

Pattern
Gets the key pattern that this listener is listening for.

Pattern as String [get]

PhidgetKeyListener 57
Events

OnKeyChange
Fired when a key is added or a value changes.

event OnKeyChange(
Key as String,
Value as String
)

Parameters:

Key
The key value.

Value
The value value.

OnKeyRemoval
Fired when a key is removed.

event OnKeyRemoval(
Key as String,
Value as String
)

Parameters:

Key
The key value.

Value
The value value.

PhidgetKeyListener 58