| | |
- IRCode
- IRCodeInfo
- IRCodeLength
- IREncoding
- IRLearnedCode
- Phidgets.Phidget.Phidget
-
- IR
- _ctypes.Structure(_ctypes._CData)
-
- CPhidgetIR_CodeInfo
class CPhidgetIR_CodeInfo(_ctypes.Structure) |
| | |
- Method resolution order:
- CPhidgetIR_CodeInfo
- _ctypes.Structure
- _ctypes._CData
- __builtin__.object
Data descriptors defined here:
- __dict__
- dictionary for instance variables (if defined)
- __weakref__
- list of weak references to the object (if defined)
- bitCount
- Structure/Union member
- carrierFrequency
- Structure/Union member
- dutyCycle
- Structure/Union member
- encoding
- Structure/Union member
- gap
- Structure/Union member
- header
- Structure/Union member
- length
- Structure/Union member
- min_repeat
- Structure/Union member
- one
- Structure/Union member
- repeat
- Structure/Union member
- toggle_mask
- Structure/Union member
- trail
- Structure/Union member
- zero
- Structure/Union member
Methods inherited from _ctypes.Structure:
- __init__(...)
- x.__init__(...) initializes x; see x.__class__.__doc__ for signature
Data and other attributes inherited from _ctypes.Structure:
- __new__ = <built-in method __new__ of _ctypes.StructType object at 0x1D1B18A8>
- T.__new__(S, ...) -> a new object with type S, a subtype of T
Methods inherited from _ctypes._CData:
- __ctypes_from_outparam__(...)
- __hash__(...)
- x.__hash__() <==> hash(x)
- __reduce__(...)
- __setstate__(...)
|
class IR(Phidgets.Phidget.Phidget) |
| |
This class represents a Phidget IR controller.
All methods to control an IR Controller are implemented in this class.
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 IR Class
- __init__(self)
- The Constructor Method for the Accelerometer Class
Exceptions:
RuntimeError - If current platform is not supported/phidget c dll cannot be found
- getLastCode(self)
- Gets the last code that was recieved.
Returns:
The last IR Code received. <IRCode>.
Exceptions:
RuntimeError - If current platform is not supported/phidget c dll cannot be found
PhidgetException: If this Phidget is not opened and attached.
- getLastLearnedCode(self)
- Gets the last code the was learned.
Returns:
The last IR Code Learned. <IRLearnedCode>.
Exceptions:
RuntimeError - If current platform is not supported/phidget c dll cannot be found
PhidgetException: If this Phidget is not opened and attached.
- readRaw(self)
- Reads raw IR data.
Returns:
Buffer holding the read raw data <List of int>.
Exceptions:
RuntimeError - If current platform is not supported/phidget c dll cannot be found
PhidgetException: If this Phidget is not opened and attached.
- setOnIRCodeHandler(self, IRCodeHandler)
- IR Code event.
This event is called whenever a new code is recognized.
Parameters:
IRCodeHandler: hook to the IRCodeHandler callback function.
Exceptions:
RuntimeError - If current platform is not supported/phidget c dll cannot be found
PhidgetException
- setOnIRLearnHandler(self, IRLearnHandler)
- IR Learn event.
This event is called when a new code has been learned. This generally requires the button to be held down for a second or two.
Parameters:
IRLearnHandler: hook to the IRLearnHandler callback function.
Exceptions:
RuntimeError - If current platform is not supported/phidget c dll cannot be found
PhidgetException
- setOnIRRawDataHandler(self, IRRawDataHandler)
- IR Raw Data event
This event is called whenever new IR data is available. Data is in the form of an array of microsecond pulse values.
This can be used if the user wishes to do their own data decoding, or for codes that the PhidgetIR cannot automatically recognize.
Parameters:
IRRawHandler: hook to the IRRawHandler callback function.
Exceptions:
RuntimeError - If current platform is not supported/phidget c dll cannot be found
PhidgetException
- transmit(self, code, codeInfo)
- Transmits a code
Parameters:
code<IRCode>: The code to transmit.
codeInfo<IRCodeInfo>: Code encoding information.
Exceptions:
RuntimeError - If current platform is not supported/phidget c dll cannot be found
PhidgetException: If this Phidget is not opened and attached.
- transmitRaw(self, data, gap=0, count=0, carrierFrequency=0, dutyCycle=0)
- Transmits raw microsecond pulse data.
Parameters:
data<List of int>: An array of microsecond data which starts and ends with a pulse.
gap<int>: A microsecond gap that will be maintained after the data is sent.
count<int>: The number of data elements to transmit - this must be uneven.
carrierFrequency<int>: The carrier frequency.
dutyCycle<int>: The duty cycle.
Exceptions:
RuntimeError - If current platform is not supported/phidget c dll cannot be found
PhidgetException: If this Phidget is not opened and attached.
- transmitRepeat(self)
- Transmits a repeat of a previously transmitted code.
his must be called within the gap period after transmitting the original code.
This is required for codes that use seperate sequences for the code and the repeat identifier.
Exceptions:
RuntimeError - If current platform is not supported/phidget c dll cannot be found
PhidgetException: If this Phidget is not opened and attached.
Static methods defined here:
- HexToData(hexString)
Data and other attributes defined here:
- RAWDATA_LONGSPACE = 2147483647
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
|
class IRCode |
| |
This class represents an IR Code.
|
| |
Methods defined here:
- __init__(self, data, bitCount)
- Creates a new IR Code from a string or from c_ubyte_Array.
Parameters:
data<string or c_ubyte_Array>: The IR code.
bitCount<int>: The code length in bits.
Exceptions:
RuntimeError - If current platform is not supported/phidget c dll cannot be found
PhidgetException - If the length of the provided data is less than the expected length based on the provided bitCount
- toString(self)
- String representation of the IR code.
|
class IRCodeInfo |
| |
This class represents the encoding parameters needed to transmit a code.
|
| |
Methods defined here:
- __init__(self, codeInfo=None)
- The Constructor Method for the Accelerometer Class
Sets the members to their defaults. If a codeInfo structure is provided, will set the members to their values from the provided structure.
Parameters:
code<IRCode>: The learned code.
codeInfo<IRCodeInfo>: The code encoding parameters.
- toCPhidgetIR_CodeInfo(self)
|
class IRCodeLength |
| |
This is an enumeration of IR Code Length Types and their values.
|
| |
Static methods defined here:
- toString(val)
Data and other attributes defined here:
- Constant = 2
- Unknown = 1
- Variable = 3
|
class IREncoding |
| |
This is an enumeration of IR Encoding types and their values.
|
| |
Static methods defined here:
- toString(val)
Data and other attributes defined here:
- BiPhase = 4
- Pulse = 3
- RC5 = 5
- RC6 = 6
- Space = 2
- Unknown = 1
|
class IRLearnedCode |
| |
This class represents a learned IR Code.
This contains all data needed to re-transmit the code.
|
| |
Methods defined here:
- __init__(self, code, codeInfo)
- Creates a new IR Learned Code from a IRCode and a IRCodeInfo.
Parameters:
code<IRCode>: The learned code.
codeInfo<IRCodeInfo>: The code encoding parameters.
| |