| | |
- Manager
class Manager |
| |
This class represents a Phidget Manager.
The Phidget manager is a way to keep track of attached phidgets,
it will send Attach and Detach events as Phidgets are added and removed fromt the system.
The Phidget manager deals in base Phidget objects.
These objects are not actually connected to opened Phidgets but can be used
to get serial number, name, version, etc.
|
| |
Methods defined here:
- __del__(self)
- __init__(self)
- The Constructor Method for the Manager Class
Exceptions:
RuntimeError - If current platform is not supported/phidget c dll cannot be found
PhidgetException: If this Phidget is not opened.
- closeManager(self)
- Shuts down the Phidget Manager.
This method should be called to close down the Phidget Manager.
Events will no longer be recieved. This method gets calledd automatically when the class is destroyed so calling it is not required.
Exceptions:
RuntimeError - If current platform is not supported/phidget c dll cannot be found
PhidgetException: If this manager is not opened.
- getAttachedDevices(self)
- Returns a list of Phidgets attached to the host computer.
This list is updated right before the attach and detach events, and so will be up to date within these events.
Returns:
The list of attached phidgets <array of Phidget objects>.
Exceptions:
RuntimeError - If current platform is not supported/phidget c dll cannot be found
PhidgetException
- getServerAddress(self)
- Returns the Address of a Phidget Webservice when this Manager was opened as remote.
This may be an IP Address or a hostname.
Returns:
The server address for the webservice <string>.
Exceptions:
RuntimeError - If current platform is not supported/phidget c dll cannot be found
PhidgetException: if the Manager was not opened or opened remotely.
- getServerID(self)
- Returns the Server ID of a Phidget Webservice when this Manager was opened as remote.
This is an arbitrary server identifier, independant of IP address and Port.
Returns:
The serverID <string>.
Exceptions:
RuntimeError - If current platform is not supported/phidget c dll cannot be found
PhidgetException: If this manager is not opened or opened remotely.
- getServerPort(self)
- Returns the Port of a Phidget Webservice when this Manager was opened as remote.
Returns:
The server port for the webservice.
Exceptions:
RuntimeError - If current platform is not supported/phidget c dll cannot be found
PhidgetException: if the Manager was not opened or opened remotely.
- 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:
The attached status <boolean>.
Exceptions:
RuntimeError - If current platform is not supported/phidget c dll cannot be found
PhidgetException: if the Manager was not opened or opened remotely.
- openManager(self)
- Starts the PhidgetManager.
This method starts the phidget manager running in the base Phidget21 C library.
If attach and detach listeners are to be used, they should be registered before start is called so that no events are missed.
Once start is called, the Phidget Manager will be active until close is called.
Exceptions:
RuntimeError - If current platform is not supported/phidget c dll cannot be found
PhidgetException
- openRemote(self, serverID, password='')
- Open this Manager remotely using a Server ID, and securely using a Password.
ServerID can be NULL to get a listing of all Phidgets on all Servers
This password can be set as a parameter when starting the Phidget Webservice.
The use of a password is optional and calling the function without providing a password will
connect normally.
Parameters:
serverID<string>: ServerID of the Phidget Webservice.
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, password='')
- Open this Manager remotely using an IP Address and port, and securely using a password.
This password can be set as a parameter when starting the Phidget Webservice.
The use of a password is optional and calling the function without providing a password will
connect normally.
Parameters:
IPAddress<string>: IP Address or hostname of the Phidget Webservice
port<int>: Port of the Phidget Webservice
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)
- Set the Attach event handler.
The attach handler is a method that will be called when a Phidget is phisically 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
- setOnDetachHandler(self, detachHandler)
- Set the Detach event handler.
The detach handler is a method that will be called when a Phidget is phisically detached from the system, and is no longer available.
Parameters:
detachHandler: hook to the detachHandler callback function.
Exceptions:
RuntimeError - If current platform is not supported/phidget c dll cannot be found
PhidgetException
- 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
- setOnServerConnectHandler(self, serverConnectHandler)
- Sets the ServerConnect event handler
The serverConnect handler is a method that will be called when a connection to a server is made
Parameters:
serverConnectHandler: hook to the serverConnectHandler callback function.
Exceptions:
RuntimeError - If current platform is not supported/phidget c dll cannot be found
PhidgetException
- setOnServerDisconnectHandler(self, serverDisconnectHandler)
- Sets the ServerDisconnect event handler.
The serverDisconnect handler is a method that will be called when a connection to a server is terminated.
Parameters:
serverDisconnectHandler: hook to the serverDisconnectHandler callback function.
Exceptions:
RuntimeError - If current platform is not supported/phidget c dll cannot be found
PhidgetException
| |