PROPixx

class propixx.PROPixx[source]

Bases: DpxDevice, VideoFeatures

Class Definition for the PROPixx Device.

Tip

If you want to use these functions, you must connect your PROPixx device with a USB cable. If you want to use the PROPixx Controller, see PROPixxCtrl.

>>> from pypixxlib.propixx import PROPixx
>>> my_device = PROPixx()
>>> my_device.function() # A PROPixx has no sub-systems, only function and bases.
>>> my_device.BaseFunction() # A base function from one of the class' bases.
get3dCrosstalk()[source]

Get 3D crosstalk (0-1) which is being subtracted from stereoscopic stimuli

Warning

This only works with RB3D mode and requires revision 6 of the PROPixx.

Returns:

A double value for the 3D Crosstalk.

getDlpSequencerProgram()[source]

Get PROPixx DLP Sequencer program.

This method allows the user to set the video mode of the PROPixx.

Returns:

Any of the following predefined constants.

  • RGB: Default RGB

  • RB3D: R/B channels drive grayscale 3D

  • RGB240: Only show the frame for 1/2 a 120 Hz frame duration.

  • RGB180: Only show the frame for 2/3 of a 120 Hz frame duration.

  • QUAD4X: Display quadrants are projected at 4x refresh rate.

  • QUAD12X: Display quadrants are projected at 12x refresh rate with grayscales.

  • GREY3X: Converts 640x1080@360Hz RGB to 1920x1080@720Hz Grayscale with blank frames.

Return type:

String

getFanPwm()[source]

Gets the PROPixx PWM.

Returns:

PWM value.

Return type:

pwm (float)

getFanSpeed(fan_nbr)[source]

Gets the speed of one of the PROPixx fans.

Parameters:

fan_nbr (int) – number of the queried fan.

Returns:

current for a given fan.

Return type:

speed (float)

getLedCurrent(led_nbr)[source]

Gets the current for a given LED.

Parameters:

led_nbr (int) – number of the queried LED.

Returns:

current for a given LED.

Return type:

current (float)

getTemperature(component_temperature)[source]

Gets the temperature for a given power supply.

Parameters:

component_temperature (int) –

power supply for which the voltage is queried. A valid argument is one of the following:

  • PPX_TEMP_LED_RED,

  • PPX_TEMP_LED_GRN,

  • PPX_TEMP_LED_BLU,

  • PPX_TEMP_LED_ALT,

  • PPX_TEMP_DMD,

  • PPX_TEMP_POWER_BOARD,

  • PPX_TEMP_LED_POWER_BOARD,

  • PPX_TEMP_RX_DVI,

  • PPX_TEMP_FPGA,

  • PPX_TEMP_FPGA2,

  • PPX_TEMP_VOLTAGE_MONITOR

Returns:

temperature for a given power supply.

Return type:

temperature (float)

getVoltageMonitor(power_supply_type)[source]

Gets the voltage for a given power supply.

Parameters:

power_supply_type (int) –

Power supply for which the voltage is queried. Valid arguments are the following:

  • PPX_POWER_5V,

  • PPX_POWER_2P5V,

  • PPX_POWER_1P8V,

  • PPX_POWER_1P5V,

  • PPX_POWER_1P1V,

  • PPX_POWER_1V,

  • PPX_POWER_12V,

  • PPX_POWER_VCC

Returns:

voltage for a given power supply.

Return type:

voltage (float)

isCeilingMount()[source]

Gets the ceiling mount mode state.

Returns:

True if enabled, False if disabled.

Return type:

bool

isHotSpotCorrection()[source]

Returns non-0 if PROPixx VESA 3D output is enabled.

isLampLEDMode()[source]

Returns non-0 if PROPixx lamp LED is enabled.

Warning

This requires revision 12 of the PROPixx.

See also

setLampLED

isQuietMode()[source]

Returns non-0 if PROPixx quiet mode is enabled.

Warning

This requires revision 19 of the PROPixx.

See also

setQuietMode

isRearProjection()[source]

Gets the rear projection mode state.

Returns:

True if enabled, False if disabled.

Return type:

bool

isSequencerEnabled()[source]

Gets the sequencer mode state.

Returns:

True if enabled, False if disabled.

Return type:

bool

isSleepMode()[source]

Returns True if PROPixx sleep mode is enabled.

Warning

This requires revision 12 of the PROPixx.

See also

setSleepMode

isVesaFreeRun()[source]

Returns non-0 if PROPixx VESA 3D output is enabled.

set3dCrosstalk(crosstalk)[source]

Set 3D crosstalk (0-1) which should be subtracted from stereoscopic stimuli.

Warning

This only works with RB3D mode and requires revision 6 of the PROPixx.

Parameters:

crosstalk (double) – A value between 0 and 1 which represents the 3d crosstalk.

setCeilingMountMode(enable)[source]

Sets the ceiling mount mode.

This method allows the user to turn the ceiling mount mode on or off. When enabled, the image will be displayed up side down. This allows the user to install the PROPixx on the ceiling. when this mode is disabled, the image will be displayed normally.

Parameters:

enable (bool) – Ceiling mount mode.

setDlpSequencerProgram(program)[source]

Sets the PROPixx DLP Sequencer program.

Only available for PROPixx Revision 6 and higher.

Parameters:

program (string) –

Any of the following predefined constants.

  • RGB: Default RGB

  • RB3D: R/B channels drive grayscale 3D

  • RGB240: Only show the frame for 1/2 a 120 Hz frame duration.

  • RGB180: Only show the frame for 2/3 of a 120 Hz frame duration.

  • QUAD4X: Display quadrants are projected at 4x refresh rate.

  • QUAD12X: Display quadrants are projected at 12x refresh rate with grayscales.

  • GREY3X: Converts 640x1080@360Hz RGB to 1920x1080@720Hz Grayscale with blank frames.

  • RGB2: Older 120Hz sequencer.

setHotSpotCorrection(enable)[source]

Enables or disables the Hotspot Correction

Parameters:

enable (bool) – Set to true to enable Hotspot Correction.

setLampLED(enable)[source]

Enables or disables the lamp LED.

Warning

This requires revision 12 of the PROPixx.

Parameters:

enable (bool) – Set to true to enable the lamp LED.

See also

isLampLEDMode

setQuietMode(enable)[source]

Enables or disables the quiet mode.

Enabling this mode reduces the noise generated by the PROPixx by lowering the speed of the fans. It should be kept enabled unless reducing the noise is essential.

Warning

This requires revision 19 of the PROPixx.

Parameters:

enable (bool) – Set to true to enable quiet mode.

See also

isQuietMode

setRearProjectionMode(enable)[source]

Sets the rear projection mode.

This method allows the user to turn the rear projection mode on or off. When enabled, the image will be displayed in mirrored view, allowing the user to install the PROPixx behind a projection screen.

Parameters:

enable (bool) – rear projection mode.

setSleepMode(enable)[source]

Enables or disables the sleep mode.

Enabling this mode turns the PROPixx off. Disabling it will turn the PROPixx on.

Warning

This requires revision 12 of the PROPixx.

Parameters:

enable (bool) – Set to true to enable sleep mode.

See also

isSleepMode

setVesaFreeRun(enable)[source]

Enables or disables the Vesa output to work with the polariser.

Parameters:

enable (bool) – Set to true to enable VesaFreeRun.