PhidgetIRCodeInfo

A class for storing Code parameters, used for transmitting codes.  See your product manual for more specific API details, supported functionality, units, etc.

Summary
PhidgetIRCodeInfoA class for storing Code parameters, used for transmitting codes.
Constants
IR EncodingsThese are the supported encoding types for the PhidgetIR.
IR Code length stylesThese are the supported code length styles for the PhidgetIR.
Variables
EncodingIR Code encoding.
LengthIR Code length style.
BitCountIR Code bit count.
GapIR Code gap in microseconds.
TrailIR Code trailing pulse in microseconds.
HeaderIR Code header.
One
Zero
MinRepeatNumber of times to repeat the code on transmit.
ToggleMaskMask of bits to toggle on each repeat.
RepeatRepeat code.
CarrierFrequencyCarrier Frequency.
DutyCycleIR LED duty cycle.
Functions
PhidgetIRCodeInfo

Constants

IR Encodings

These are the supported encoding types for the PhidgetIR.  These constants are used with Encoding.

ENCODING_UNKNOWNUnknown Encoding.
ENCODING_SPACESpace Encoding.
ENCODING_PULSEPulse Encoding.
ENCODING_BIPHASEBiPhase Encoding.
ENCODING_RC5RC5 Encoding.
ENCODING_RC6RC6 Encoding.

IR Code length styles

These are the supported code length styles for the PhidgetIR.  These constants are used with Length.

CODE_LENGTH_UNKNOWNUnknown length.
CODE_LENGTH_CONSTANTConstant - the bitstream + gap length is constant.
CODE_LENGTH_VARIABLEVariable - the bitstream has a variable length with a constant gap.

Variables

Encoding

public var Encoding: int

IR Code encoding.

Length

public var Length: int

IR Code length style.

BitCount

public var BitCount: int

IR Code bit count.

Gap

public var Gap: int

IR Code gap in microseconds.

Trail

public var Trail: int

IR Code trailing pulse in microseconds.

Header

public var Header: Array

IR Code header.  Can be null, or a two-element array (pulse and space in microseconds).

One

public var One: Array
IR Code onepulse and space in microseconds representing a ‘1’.

Zero

public var Zero: Array
IR Code zeropulse and space in microseconds representing a ‘0’.

MinRepeat

public var MinRepeat: int

Number of times to repeat the code on transmit.

ToggleMask

public var ToggleMask: String

Mask of bits to toggle on each repeat.

Repeat

public var Repeat: Array

Repeat code.  Must begin and end with a pulse.

CarrierFrequency

public var CarrierFrequency: int

Carrier Frequency.  Defaults to 38000kHz.

DutyCycle

public var DutyCycle: int

IR LED duty cycle.  Defaults to 33%.

Functions

PhidgetIRCodeInfo

public function PhidgetIRCodeInfo (bitCount: int = 32,
encoding: int = ENCODING_UNKNOWN,
header: Array = null,
zero: Array = null,
one: Array = null,
trail: int = 0,
gap: int = 0,
repeat: Array = null,
minRepeat: int = 0,
toggleMask: String = null,
Length: int = CODE_LENGTH_UNKNOWN,
carrierFrequency: int = 38000,
dutyCycle: int = 33)
Creates a new PhidgetIRCodeInfo object.  All arguments are optionaldefaults will be filled in for any arguments left out.
public var Encoding: int
IR Code encoding.
public var Length: int
IR Code length style.
public var BitCount: int
IR Code bit count.
public var Gap: int
IR Code gap in microseconds.
public var Trail: int
IR Code trailing pulse in microseconds.
public var Header: Array
IR Code header.
public var One: Array
public var Zero: Array
public var MinRepeat: int
Number of times to repeat the code on transmit.
public var ToggleMask: String
Mask of bits to toggle on each repeat.
public var Repeat: Array
Repeat code.
public var CarrierFrequency: int
Carrier Frequency.
public var DutyCycle: int
IR LED duty cycle.
public function PhidgetIRCodeInfo (bitCount: int = 32,
encoding: int = ENCODING_UNKNOWN,
header: Array = null,
zero: Array = null,
one: Array = null,
trail: int = 0,
gap: int = 0,
repeat: Array = null,
minRepeat: int = 0,
toggleMask: String = null,
Length: int = CODE_LENGTH_UNKNOWN,
carrierFrequency: int = 38000,
dutyCycle: int = 33)
Close