QLed

class QLed(parent=None, designMode=False)

Bases: taurus.qt.qtgui.display.qpixmapwidget.QPixmapWidget

A Led

DefaultBlinkingInterval = 0

DefaultLedColor = 'green'

DefaultLedInverted = False

DefaultLedPattern = ':leds/images256/led_{color}_{status}.png'

DefaultLedStatus = True

blinkingInterval

This property holds the blinking interval in millisecs. 0 means no blinking

Access functions:

• QLed.getBlinkingInterval()
• QLed.setBlinkingInterval()
• QLed.resetBlinkingInterval()

getBlinkingInterval()

returns the blinking interval

Return type::class:~`int` Returns:blinking interval or 0 if blinking is not enabled.

getLedColor()

Returns the led color :return: led color :rtype: str

getLedInverted()

Returns if the led is inverted. :return: inverted mode :rtype: bool

getLedPatternName()

Returns the current led pattern name :return: led pattern name :rtype: str

getLedStatus()

Returns the led status :return: led status :rtype: bool

classmethod getQtDesignerPluginInfo()

isLedColorValid(name)

Determines if the given color name is valid. :param color: the color :type color: str :return: True is the given color name is valid or False otherwise :rtype: bool

ledColor

This property holds the led color

Access functions:

• QLed.getLedColor()
• QLed.setLedColor()
• QLed.resetLedColor()

ledInverted

This property holds the led inverted: False means do not invert the

Access functions:

• QLed.getLedInverted()
• QLed.setLedInverted()
• QLed.resetLedInverted()

ledPattern

This property holds the led pattern name

Access functions:

• QLed.getLedPatternName()
• QLed.setLedPatternName()
• QLed.resetLedPatternName()

ledStatus

This property holds the led status: False means OFF, True means ON

Access functions:

• QLed.getLedStatus()
• QLed.setLedStatus()
• QLed.resetLedStatus()

minimumSizeHint()

Overwrite the default minimum size hint (0,0) to be (16,16) :return: the minimum size hint 16,16 :rtype: PyQt4.Qt.QSize

resetBlinkingInterval()

resets the blinking interval

resetLedColor()

Resets the led color

resetLedInverted()

Resets the led inverted mode

resetLedPatternName()

Resets the led pattern to :leds/images256/led_{color}_{status}.png.

resetLedStatus()

Resets the led status

setBlinkingInterval(interval)

sets the blinking interval (the time between status switching). Set to a nonpositive number for disabling blinking

Parameters:interval (:class:~`int`) – the blinking interval in millisecs. Set to 0 for disabling blinking

setLedColor(color)

Sets the led color :param status: the new color :type status: str

setLedInverted(inverted)

Sets the led inverted mode :param status: the new inverted mode :type status: bool

setLedPatternName(name)

Sets the led pattern name. Should be a string containing a path to valid images. The string can contain the keywords:

1. {status} - transformed to ‘on’ of ‘off’ according to the status
2. {color} - transformed to the current led color

Example: :leds/images256/led_{color}_{status}.png will be transformed to :leds/images256/led_red_on.png when the led status is True and the led color is red.

Parameters:name (str) – new pattern

setLedStatus(status)

Sets the led status :param status: the new status :type status: bool

sizeHint()

toLedName(status=None, color=None, inverted=None)

Gives the led name for the given status and color. If status or color are not given, the current led status or color are used.

Parameters:

• status (bool) – the status
• color (str) – the color

Returns:

string containing the led name

Return type:

str

toggleLedStatus()

toggles the current status of the led