| | |
- Phidgets.Phidget.Phidget
-
- Stepper
class Stepper(Phidgets.Phidget.Phidget) |
| |
This class represents a Phidget Stepper Controller.
All methods to to control a stepper controller and read back stepper data are implemented in this class.
The Phidget Stepper is able to control 1 or more Stepper motors.
Motor Acceleration and Velocity are controllable, and micro-stepping is used for bipolar motors.
The type and number of motors that can be controlled depend on the Stepper Controller.
Digital inputs are available on select Phidget Stepper Controllers.
See your device's User Guide for more specific API details, technical information, and revision details.
The User Guide, along with other resources, can be found on the product page for your device.
Extends:
Phidget
|
| |
Methods defined here:
- __del__(self)
- The Destructor Method for the Stepper Class
- __init__(self)
- The Constructor Method for the Stepper Class
Exceptions:
RuntimeError - If current platform is not supported/phidget c dll cannot be found
- getAcceleration(self, index)
- Returns a motor's acceleration.
The valid range is between getAccelerationMin and getAccelerationMax, and refers to how fast the Stepper Controller will change the speed of a motor.
This value is in (micro)steps per second squared. The step unit will depend on the Stepper Controller.
For example, the Bipolar Stepper controller has an accuracy of 16th steps, so this value would be in 16th steps per second squared.
Parameters:
index<int>: INdex of a motor.
Returns:
The acceleration of the motor <double>.
Exceptions:
RuntimeError - If current platform is not supported/phidget c dll cannot be found
PhidgetException: If this Phidget is not opened and attached, or if the index is invalid, or if the acceleration is unknown.
- getAccelerationMax(self, index)
- Returns the maximum acceleration that a motor will accept, or return.
This value uses the same units as setAcceleration/getAcceleration.
Parameters:
index<int>: Index of the motor.
Returns:
The maximum allowable acceleration <double>.
Exceptions:
RuntimeError - If current platform is not supported/phidget c dll cannot be found
PhidgetException: If this Phidget is not opened and attached, or the index is invalid.
- getAccelerationMin(self, index)
- Returns the minimum acceleration that a motor will accept, or return.
This value uses the same units as setAcceleration/getAcceleration.
Parameters:
index<int>: Index of the motor.
Returns:
The minumum allowable acceleration <double>.
Exceptions:
RuntimeError - If current platform is not supported/phidget c dll cannot be found
PhidgetException: If this Phidget is not opened and attached, or if the index is invalid.
- getCurrent(self, index)
- Returns a motor's current usage.
The valid range is between getCurrentMin and getCurrentMax.
This value is in Amps.
Note that this is not supported on all stepper controllers.
Parameters:
index<int>: Index of the motor.
Returns:
The Current usage for the motor <double>.
Exceptions:
RuntimeError - If current platform is not supported/phidget c dll cannot be found
PhidgetException: If this Phidget is not opened and attached, if the index is invalid, if the value is unknown, or if this is not supported.
- getCurrentLimit(self, index)
- Gets a motor's current usage limit.
The valid range is between getCurrentMin and getCurrentMax.
This gets the maximum current that a motor will be allowed to draw.
Use this with the Bipolar stepper controller to get smooth micro stepping - see the product manual for more details. This value is in Amps.
Note that this is not supported on all stepper controllers.
Parameters:
index<int>: Index of the motor.
Returns:
The Current limit for the motor <double>.
Exceptions:
RuntimeError - If current platform is not supported/phidget c dll cannot be found
PhidgetException: If this Phidget is not opened and attached, if the index is invalid, if the value is unknown, or if this is not supported.
- getCurrentMax(self, index)
- Returns the maximum current that a stepper motor will accept, or return.
This value is in Amps.
Parameters:
index<int>: Index of the motor.
Returns:
The Maximum allowable Current usage for the motor <double>.
Exceptions:
RuntimeError - If current platform is not supported/phidget c dll cannot be found
PhidgetException: If this Phidget is not opened and attached, if the index is invalid, or if this is not supported.
- getCurrentMin(self, index)
- Returns the minimum current that a stepper motor will accept, or return.
This value is in Amps.
Parameters:
index<int>: Index of the motor.
Returns:
The Minimum allowable Current usage for the motor <double>.
Exceptions:
RuntimeError - If current platform is not supported/phidget c dll cannot be found
PhidgetException: If this Phidget is not opened and attached, if the index is invalid, or if this is not supported.
- getCurrentPosition(self, index)
- Returns a motor's current position.
This is the actual step position that the motor is at right now.
The valid range is between getPositionMin and getPositionMax.
This value is in (micro)steps. The step unit will depend on the Stepper Controller.
For example, the Bipolar Stepper controller has an accuracy of 16th steps, so this value would be in 16th steps.
Parameters:
index<int>: Index of the motor.
Returns:
The current position of the motor <longlong>.
Exceptions:
RuntimeError - If current platform is not supported/phidget c dll cannot be found
PhidgetException: If this Phidget is not opened and attached, or if the index is invalid.
- getEngaged(self, index)
- Returns the engaged state of a motor.
Parameters:
index<int>: Index of the motor.
Returns:
The engaged state for the motor <boolean>.
Exceptions:
RuntimeError - If current platform is not supported/phidget c dll cannot be found
PhidgetException: If this Phidget is not opened and attached, or if the index is out of range.
- getInputCount(self)
- Returns the number of digital inputs.
Not all Stepper Controllers have digital inputs.
Returns:
The number of digital inputs available <int>.
Exceptions:
RuntimeError - If current platform is not supported/phidget c dll cannot be found
PhidgetException: If this Phidget is not opened and attached.
- getInputState(self, index)
- Returns the state of a digital input.
True means that the input is activated, and False indicated the default state.
Parameters:
index<int>: The index of the input.
Returns:
The state of the input <boolean>.
Exceptions:
RuntimeError - If current platform is not supported/phidget c dll cannot be found
PhidgetException: If this Phidget is not opened and attached, or if the index is invalid.
- getMotorCount(self)
- Returns the number of stepper motors supported by this Phidget.
This does not neccesarily correspond to the number of motors actually attached to the board.
Returns:
The number of supported motors <int>.
Exceptions:
RuntimeError - If current platform is not supported/phidget c dll cannot be found
PhidgetException: If this Phidget is not opened and attached.
- getPositionMax(self, index)
- Returns the maximum position that a stepper motor will accept, or return.
This value uses the same usits as setTargetPosition/getTargetPosition and setCurrentPosition/getCurrentPosition.
Parameters:
index<int>: Index of the motor.
Returns:
The maximum allowable position <longlong>.
Exceptions:
RuntimeError - If current platform is not supported/phidget c dll cannot be found
PhidgetException: If this Phidget is not opened and attached, or if the index is invalid.
- getPositionMin(self, index)
- Returns the minimum position that a stepper motor will accept, or return.
This value uses the same usits as setTargetPosition/getTargetPosition and setCurrentPosition/getCurrentPosition.
Parameters:
index<int>: Index of the motor.
Returns:
The minimum allowable position <longlong>.
Exceptions:
RuntimeError - If current platform is not supported/phidget c dll cannot be found
PhidgetException: If this Phidget is not opened and attached, or if the index is invalid.
- getStopped(self, index)
- Returns the stopped state of a motor.
Use this to determine if the motor is moving and/or up to date with the latest commands you have sent.
If this is true, the motor is guaranteed to be stopped and to have processed every command issued.
Generally, this would be polled after a target position is set to wait until that position is reached.
Parameters:
index<int>: Index of the motor.
Returns:
The stopped state of the motor <boolean>.
Exceptions:
RuntimeError - If current platform is not supported/phidget c dll cannot be found
PhidgetException: If this Phidget is not opened and attached, or if the index is out of range.
- getTargetPosition(self, index)
- Returns a motor's target position.
This is the position that the motor wants to be at. If the motor is not moving,
it probably has reached the target position, and this will match getCurrentPosition.
The valid range is between getPositionMin and getPositionMax.
This value is in (micro)steps. The step unit will depend on the Stepper Controller.
For example, the Bipolar Stepper controller has an accuracy of 16th steps, so this value would be in 16th steps.
Parameters:
index<int>: The index of the motor.
Returns:
The target position of the motor <longlong>.
Exceptions:
RuntimeError - If current platform is not supported/phidget c dll cannot be found
PhidgetException: If this Phidget is not opened and attached, or if the index is invalid, or if the position in unknown.
- getVelocity(self, index)
- Returns a motor's current velocity.
The valid range is between getVelocityMin and getVelocityMax, with 0 being stopped.
This value is in (micro)steps per second. The step unit will depend on the Stepper Controller.
For example, the Bipolar Stepper controller has an accuracy of 16th steps, so this value would be in 16th steps per second.
Parameters:
index<int>: The index of the motor.
Returns:
The current velocity of the motor <double>.
Exceptions:
RuntimeError - If current platform is not supported/phidget c dll cannot be found
PhidgetException: If this Phidget is not opened and attached, or if the index is invalid, or if the velocity in unknown.
- getVelocityLimit(self, index)
- Returns a motor's velocity limit.
This is the maximum velocity that the motor will turn at.
The valid range is between getVelocityMin and getVelocityMax, with 0 being stopped.
This value is in (micro)steps per second. The step unit will depend on the Stepper Controller.
For example, the Bipolar Stepper controller has an accuracy of 16th steps, so this value would be in 16th steps per second.
Parameters:
index<int>: The index of the motor.
Returns:
The maximum speed the motor will run at <double>.
Exceptions:
RuntimeError - If current platform is not supported/phidget c dll cannot be found
PhidgetException: If this Phidget is not opened and attached, or if the index is invalid.
- getVelocityMax(self, index)
- Returns the maximum velocity that a stepper motor will accept, or return.
This value uses the same units as setVelocityLimit/getVelocityLimit and getVelocity.
Parameters:
index<int>: The index of the motor.
Returns:
The maximum allowable velocity of the motor <double>.
Exceptions:
RuntimeError - If current platform is not supported/phidget c dll cannot be found
PhidgetException: If this Phidget is not opened and attached, or if the index is invalid.
- getVelocityMin(self, index)
- Returns the minimum velocity that a stepper motor will accept, or return.
This value uses the same units as setVelocityLimit/getVelocityLimit and getVelocity.
Parameters:
index<int>: The index of the motor.
Returns:
The minimum allowable velocity of the motor <double>.
Exceptions:
RuntimeError - If current platform is not supported/phidget c dll cannot be found
PhidgetException: If this Phidget is not opened and attached, or if the index is invalid.
- setAcceleration(self, index, value)
- Sets a motor's acceleration.
The valid range is between getAccelerationMin and getAccelerationMax, and refers to how fast the Stepper Controller will change the speed of a motor.
This value is in (micro)steps per second squared. The step unit will depend on the Stepper Controller.
For example, the Bipolar Stepper controller has an accuracy of 16th steps, so this value would be in 16th steps per second squared.
Parameters:
index<int>: Index of the motor.
value<double>: Desired acceleration for that motor.
Exceptions:
RuntimeError - If current platform is not supported/phidget c dll cannot be found
PhidgetException: If this Phidget is not opened and attached, or if the index is invalid, or if the acceleration is unknown.
- setCurrentLimit(self, index, value)
- Sets a motor's current usage limit.
The valid range is between getCurrentMin and getCurrentMax.
This sets the maximum current that a motor will be allowed to draw.
Use this with the Bipolar stepper controller to get smooth micro stepping - see the product manual for more details. This value is in Amps.
Note that this is not supported on all stepper controllers.
Parameters:
index<int>: Index of the motor.
value<double>: The desired Current limit for the motor.
Exceptions:
RuntimeError - If current platform is not supported/phidget c dll cannot be found
PhidgetException: If this Phidget is not opened and attached, if the index or value are invalid, or if this is not supported.
- setCurrentPosition(self, index, value)
- Sets a motor's current position.
Use this is (re)set the current physical position of the motor to a specific position value.
This does not move the motor, and if the motor is moving, calling this will cause it to stop moving.
Use setTargetPosition to move the motor to a position.
The valid range is between getPositionMin and getPositionMax.
This value is in (micro)steps. The step unit will depend on the Stepper Controller.
For example, the Bipolar Stepper controller has an accuracy of 16th steps, so this value would be in 16th steps.
Parameters:
index<int>: Index of the motor.
value<longlong>: The current position of the motor.
Exceptions:
RuntimeError - If current platform is not supported/phidget c dll cannot be found
PhidgetException: If this Phidget is not opened and attached, or if the index or position are invalid.
- setEngaged(self, index, state)
- Engage or disengage a motor.
This engages or disengages the stepper motor. The motors are by default disengaged when the stepper controller is plugged in.
When the stepper is disengaged, position, velocity, etc. can all be set, but the motor will not start moving until it is engaged.
If position is read when a motor is disengaged, it will throw an exception.
Parameters:
index<int>: Index of the motor.
state<boolean>: The desired engaged state for the motor.
Exceptions:
RuntimeError - If current platform is not supported/phidget c dll cannot be found
PhidgetException: If this Phidget is not opened and attached, or if the index is out of range.
- setOnCurrentChangeHandler(self, currentChangeHandler)
- Sets the CurrentChange event handler
The current change handler is a method that will be called when the stepper current has changed.
Note that not all stepper controllers support current sensing.
Parameters:
currentChangeHandler: hook to the currentChangeHandler callback function.
Exceptions:
RuntimeError - If current platform is not supported/phidget c dll cannot be found
PhidgetException: If this is not supported.
- setOnInputChangeHandler(self, inputChangeHandler)
- Set the InputChange event handler
The input change handler is a method that will be called when an input on this Stepper Controller board has changed.
Parameters:
inputChangeHandler: hook to the inputChangeHandler callback function.
Exceptions:
RuntimeError - If current platform is not supported/phidget c dll cannot be found
PhidgetException
- setOnPositionChangeHandler(self, positionChangeHandler)
- Sets the PositionChange event handler
The position change handler is a method that will be called when the stepper position has changed.
Parameters:
positionChangeHandler: hook to the positionChangeHandler callback function.
Exceptions:
RuntimeError - If current platform is not supported/phidget c dll cannot be found
PhidgetException
- setOnVelocityChangeHandler(self, velocityChangeHandler)
- Sets the VelocityChange event handler.
The velocity change handler is a method that will be called when the stepper velocity has changed.
Parameters:
velocityChangeHandler: hook to the velocityChangeHandler callback function.
Exceptions:
RuntimeError - If current platform is not supported/phidget c dll cannot be found
PhidgetException
- setTargetPosition(self, index, value)
- Sets a motor's target position.
Use this is set the target position for the stepper. If the stepper is engaged (getEngaged) it will start moving towards this target position.
The valid range is between getPositionMin and getPositionMax.
This value is in (micro)steps. The step unit will depend on the Stepper Controller.
For example, the Bipolar Stepper controller has an accuracy of 16th steps, so this value would be in 16th steps.
Parameters:
index<int>: The index of the motor.
value<longlong>: The desired position for the motor.
Exceptions:
RuntimeError - If current platform is not supported/phidget c dll cannot be found
PhidgetException: If this Phidget is not opened and attached, or if the index or position are invalid.
- setVelocityLimit(self, index, value)
- Sets a motor's velocity limit.
This is the maximum velocity that the motor will turn at. The valid range is between getVelocityMin and getVelocityMax, with 0 being stopped.
This value is in (micro)steps per second. The step unit will depend on the Stepper Controller.
For example, the Bipolar Stepper controller has an accuracy of 16th steps, so this value would be in 16th steps per second.
Parameters:
index<int>: The index of the motor.
value<double>: Desired velocity for the motor.
Exceptions:
RuntimeError - If current platform is not supported/phidget c dll cannot be found
PhidgetException: If this Phidget is not opened and attached, or if the index or velocity are invalid.
Methods inherited from Phidgets.Phidget.Phidget:
- closePhidget(self)
- Closes this Phidget.
This will shut down all threads dealing with this Phidget and you won't recieve any more events.
Exceptions:
RuntimeError - If current platform is not supported/phidget c dll cannot be found
PhidgetException: If this Phidget is not opened.
- getDeviceClass(self)
- Gets the class of this Phidget.
Classes represent a group of Phidgets that use the same API type.
Returns:
The Device Class number<int>.
Exceptions:
RuntimeError - If current platform is not supported/phidget c dll cannot be found
PhidgetException: If there is no Phidget attached.
- getDeviceID(self)
- Gets the ID of this Phidget.
This ID specifies a specific Phidget device, within the phidget class.
Returns:
The Device ID <int>.
Exceptions:
RuntimeError - If current platform is not supported/phidget c dll cannot be found
PhidgetException: If there is no Phidget attached.
- getDeviceLabel(self)
- Gets the label associated with this Phidget.
This label is a String - up to ten digits - that is stored in the Flash memory of newer Phidgets.
This label can be set programatically (see setDeviceLabel), and is non-volatile - so it is remembered even if the Phidget is unplugged.
Returns:
The label associated with this Phidget <string>.
Exceptions:
RuntimeError - If current platform is not supported/phidget c dll cannot be found
PhidgetException: If this Phidget is not opened and attached, or if this Phidget does not support labels.
- getDeviceName(self)
- Return the name of this Phidget.
This is a string that describes the device. For example, a PhidgetInterfaceKit
could be described as "Phidget InterfaceKit 8/8/8", or "Phidget InterfaceKit 0/0/4", among others, depending on the specific device.
This lets you determine the specific type of a Phidget, within the broader classes of Phidgets, such as PhidgetInterfaceKit, or PhidgetServo.
Returns:
The name of the device <string>.
Exceptions:
RuntimeError - If current platform is not supported/phidget c dll cannot be found
PhidgetException: If this phidget is not opened or attached.
- getDeviceType(self)
- Return the device type of this Phidget.
This is a string that describes the device as a class of devices. For example, all PhidgetInterfaceKit Phidgets
will returns the String "PhidgetInterfaceKit".
Returns:
The Device Type <string>.
Exceptions:
RuntimeError - If current platform is not supported/phidget c dll cannot be found
PhidgetException: If there is no Phidget attached.
- getDeviceVersion(self)
- Returns the device version of this Phidget.
This number is simply a way of distinguishing between different revisions of a specific type of Phidget, and is
only really of use if you need to troubleshoot device problems with Phidgets Inc.
Returns:
The Device Version <int>.
Exceptions:
RuntimeError - If current platform is not supported/phidget c dll cannot be found
PhidgetException: If there is no Phidget attached.
- getLibraryVersion(self)
- Returns the library version.
This is the library version of the underlying phidget21 C library and not the version of the Python wrapper module implementation.
The version is retured as a string which contains the version number and build date.
Returns:
The Library Version <string>.
Exceptions:
RuntimeError - If current platform is not supported/phidget c dll cannot be found
PhidgetException: If this Phidget is not opened and attached.
- getSerialNum(self)
- Returns the unique serial number of this Phidget.
This number is set during manufacturing, and is unique across all Phidgets. This number can be used in calls to open to specify this specific Phidget to be opened.
Returns:
The Serial Number <int>.
Exceptions:
RuntimeError - If current platform is not supported/phidget c dll cannot be found
PhidgetException: If this Phidget is not opened and attached.
- getServerAddress(self)
- Returns the Address of a Phidget Webservice.
Returns the Address of a Phidget Webservice when this Phidget was opened as remote.
This may be an IP Address or a hostname.
Returns:
The Address of the Webservice <string>.
Exceptions:
RuntimeError - If current platform is not supported/phidget c dll cannot be found
PhidgetException: if this Phidget was open opened as a remote Phidget.
- getServerID(self)
- Returns the Server ID of a Phidget Webservice.
Returns the Server ID of a Phidget Webservice when this Phidget was opened as remote.
This is an arbitrary server identifier, independant of IP address and Port.
Returns:
The ServerID of the Webservice <string>.
Exceptions:
RuntimeError - If current platform is not supported/phidget c dll cannot be found
PhidgetException: if this Phidget was open opened as a remote Phidget.
- isAttached(self)
- Returns the attached status of this Phidget.
This method returns True or False, depending on whether the Phidget is phisically plugged into the computer, initialized, and ready to use - or not.
If a Phidget is not attached, many functions calls will fail with a PhidgetException, so either checking this function, or using the Attach and Detach events, is recommended, if a device is likely to be attached or detached during use.
Returns:
Attached Status of the Phidget <boolean>
Exceptions:
RuntimeError - If current platform is not supported/phidget c dll cannot be found
PhidgetException: If this Phidget is not opened.
- isAttachedToServer(self)
- Returns the network attached status for remotely opened Phidgets.
This method returns True or False, depending on whether a connection to the Phidget WebService is open - or not.
If this is false for a remote Phidget then the connection is not active - either because a connection has not yet been established,
or because the connection was terminated.
Returns:
Phidget Network Attached Status <boolean>.
Exceptions:
RuntimeError - If current platform is not supported/phidget c dll cannot be found
PhidgetException: If this Phidget is not opened remotely.
- openPhidget(self, serial=-1)
- Open a Phidget with or without a serial number.
Open is pervasive. What this means is that you can call open on a device before it is plugged in, and keep the device opened across device dis- and re-connections.
Open is Asynchronous. What this means is that open will return immediately -- before the device being opened is actually available,
so you need to use either the attach event or the waitForAttachment method to determine if a device is available before using it.
If no arguement is provided, the first available Phidget will be opened. If there are two Phidgets of the same type attached to the system,
you should specify a serial number, as there is no guarantee which Phidget will be selected by the call to open().
The serial number is a unique number assigned to each Phidget during production and can be used to uniquely identify specific phidgets.
Parameters:
serial<int>: The serial number of the device
Exceptions:
RuntimeError - If current platform is not supported/phidget c dll cannot be found
PhidgetException
- openRemote(self, serverID, serial=-1, password='')
- Open this Phidget remotely using a Server ID, securely providing a password, and whether or not to connect to a specific serial number.
Providing a password will open the connection securely depending on if a password is set on the host machine's webservice.
If no serial number is provided, the first available Phidget will be opened. If there are two Phidgets of the same type attached to the system,
you should specify a serial number, as there is no guarantee which Phidget will be selected by the call to open().
Parameters:
serverID<string>: ServerID of the Phidget Webservice
serial<int>: The serial number of the device
password<string>: The secure password for the Phidget Webservice
Exceptions:
RuntimeError - If current platform is not supported/phidget c dll cannot be found
PhidgetException: if the Phidget Webservice cannot be contacted
- openRemoteIP(self, IPAddress, port, serial=-1, password='')
- Open this Phidget remotely using an IP Address, securely providing a password,and whether or not to connect to a specific serial number.
Providing a password will open the connection securely depending on if a password is set on the host machine's webservice.
If no serial number is provided, the first available Phidget will be opened. If there are two Phidgets of the same type attached to the system,
you should specify a serial number, as there is no guarantee which Phidget will be selected by the call to open().
Parameters:
IPAddress<string>: IP Address or hostname of the Phidget Webservice
port<int>: Port of the Phidget Webservice
serial<int>: The serial number of the device
password<string>: The secure password for the Phidget Webservice
Exceptions:
RuntimeError - If current platform is not supported/phidget c dll cannot be found
PhidgetException: if the Phidget Webservice cannot be contacted
- setOnAttachHandler(self, attachHandler)
- Sets the Attach Event Handler.
The attach handler is a method that will be called when this Phidget is physically attached to the system, and has gone through its initalization, and so is ready to be used.
Parameters:
attachHandler: hook to the attachHandler callback function
Exceptions:
RuntimeError - If current platform is not supported/phidget c dll cannot be found
PhidgetException: If this Phidget is not opened.
- setOnDetachHandler(self, detachHandler)
- Sets the Detach Event Handler.
The detach handler is a method that will be called when this Phidget is phisically detached from the system, and is no longer available.
This is particularly usefull for applications when a phisical detach would be expected.
Remember that many of the methods, if called on an unattached device, will throw a PhidgetException.
This Exception can be checked to see if it was caused by a device being unattached, but a better method would be to regiter the detach handler,
which could notify the main program logic that the device is no longer available, disable GUI controls, etc.
Parameters:
detachHandler: hook to the detachHandler callback function
Exceptions:
RuntimeError - If current platform is not supported/phidget c dll cannot be found
PhidgetException: If this Phidget is not opened.
- setOnErrorhandler(self, errorHandler)
- Sets the Error Event Handler.
The error handler is a method that will be called when an asynchronous error occurs.
Error events are not currently used, but will be in the future to report any problems that happen out of context from a direct function call.
Parameters:
errorHandler: hook to the errorHandler callback function.
Exceptions:
RuntimeError - If current platform is not supported/phidget c dll cannot be found
PhidgetException: If this Phidget is not opened.
- setOnServerConnectHandler(self, serverConnectHandler)
- Sets the Server Connect Event Handler.
The serverConnect handler is a method that will be called when a connection to a server is made. This is only usefull for Phidgets opened remotely.
Parameters:
serverConnectHandler: hook to the serverConnectHandler callback function
Exceptions:
RuntimeError - If current platform is not supported/phidget c dll cannot be found
PhidgetException: If this Phidget is not opened
- setOnServerDisconnectHandler(self, serverDisconnectHandler)
- Set the Server Disconnect event handler.
The serverDisconnect handler is a method that will be called when a connection to a server is terminated. This is only usefull for Phidgets opened remotely.
Exceptions:
RuntimeError - If current platform is not supported/phidget c dll cannot be found
PhidgetException: If this Phidget is not opened
- waitForAttach(self, timeout)
- Waits for this Phidget to become available.
This method can be called after open has been called to wait for thid Phidget to become available.
This is usefull because open is asynchronous (and thus returns immediately), and most methods will throw a PhidgetException is they are called before a device is actually ready.
This method is synonymous with polling the isAttached method until it returns True, or using the Attach event.
This method blocks for up to the timeout, at which point it will throw a PhidgetException. Otherwise, it returns when the phidget is attached and initialized.
A timeout of 0 is infinite.
Parameters:
timeout<long>: Timeout in milliseconds
Exceptions:
RuntimeError - If current platform is not supported/phidget c dll cannot be found
PhidgetException: If this Phidget is not opened.
Static methods inherited from Phidgets.Phidget.Phidget:
- disableLogging()
- Turns off logging in the native C Library.
This only needs to be called if enableLogging was called to turn logging on.
This will turn logging back off.
Exceptions:
RuntimeError - If current platform is not supported/phidget c dll cannot be found
PhidgetException
- dispose(self)
- enableLogging(level, file)
- Turns on logging in the native C Library.
This is mostly usefull for debugging purposes - when an issue needs to be resolved by Phidgets Inc.
The output is mostly low-level library information, that won't be usefull for most users.
Logging may be usefull for users trying to debug their own problems, as logs can be inserted by the user using log.
The level can be one of:
PhidgetLogLevel.PHIDGET_LOG_VERBOSE ,
PhidgetLogLevel.PHIDGET_LOG_INFO ,
PhidgetLogLevel.PHIDGET_LOG_DEBUG ,
PhidgetLogLevel.PHIDGET_LOG_WARNING ,
PhidgetLogLevel.PHIDGET_LOG_ERROR or
PhidgetLogLevel.PHIDGET_LOG_CRITICAL
Parameters:
level<int>: highest level of logging that will be output, the PhidgetLogLevel object has been provided for a readable way to set this.
file<string>: path and name of file to output to. specify NULL to output to the console.
Exceptions:
RuntimeError - If current platform is not supported/phidget c dll cannot be found
PhidgetException
- log(level, id, log)
- Adds a log entry into the phidget log.
This log is enabled by calling enableLogging and this allows the entry of user logs in amongst the phidget library logs.
The level can be one of:
PhidgetLogLevel.PHIDGET_LOG_VERBOSE,
PhidgetLogLevel.PHIDGET_LOG_INFO,
PhidgetLogLevel.PHIDGET_LOG_DEBUG,
PhidgetLogLevel.PHIDGET_LOG_WARNING,
PhidgetLogLevel.PHIDGET_LOG_ERROR or
PhidgetLogLevel.PHIDGET_LOG_CRITICAL
Note: PhidgetLogLevel.PHIDGET_LOG_DEBUG should not be used, as these logs are only printed when using the debug library,
which is not generally available.
Parameters:
level<int>: level to enter the log at.
id<string>: an arbitrary identifier for this log. This can be NULL. The C library uses this field for source filename and line number.
log<string>: the message to log.
Exceptions:
RuntimeError - If current platform is not supported/phidget c dll cannot be found
PhidgetException
| |