`QLed`

class QLed(parent=None, designMode=False)[source]

A Led

Import from taurus.qt.qtgui.display as:

from taurus.qt.qtgui.display import QLed

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()[source]

returns the blinking interval

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

getLedColor()[source]: Returns the led color :return: led color :rtype: str

getLedInverted()[source]: Returns if the led is inverted. :return: inverted mode :rtype: bool

getLedPatternName()[source]: Returns the current led pattern name :return: led pattern name :rtype: str

getLedStatus()[source]: Returns the led status :return: led status :rtype: bool

classmethod getQtDesignerPluginInfo()[source]

isLedColorValid(name)[source]

Determines if the given color name is valid.

Parameters:: color (str) – the color
Returns:: True is the given color name is valid or False otherwise
Return type:: bool

ledColor

This property holds the led color

Access functions:

QLed.getLedColor()

QLed.setLedColor()

QLed.resetLedColor()

ledInverted

False means do not invert the status, True means invert the status

Access functions:

QLed.getLedInverted()

QLed.setLedInverted()

QLed.resetLedInverted()

Type:: This property holds the led inverted

ledPattern

This property holds the led pattern name

Access functions:

QLed.getLedPatternName()

QLed.setLedPatternName()

QLed.resetLedPatternName()

ledStatus

False means OFF, True means ON

Access functions:

QLed.getLedStatus()

QLed.setLedStatus()

QLed.resetLedStatus()

Type:: This property holds the led status

minimumSizeHint()[source]: Overwrite the default minimum size hint (0,0) to be (16,16) :return: the minimum size hint 16,16 :rtype: PyQt5.Qt.QSize

resetBlinkingInterval()[source]: resets the blinking interval

resetLedColor()[source]: Resets the led color

resetLedInverted()[source]: Resets the led inverted mode

resetLedPatternName()[source]: Resets the led pattern to leds/images256/led_{color}_{status}.png

resetLedStatus()[source]: Resets the led status

setBlinkingInterval(interval)[source]

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

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

setLedColor(color)[source]

Sets the led color

Parameters:: status (str) – the new color

setLedInverted(inverted)[source]

Sets the led inverted mode

Parameters:: status (bool) – the new inverted mode

setLedPatternName(name)[source]

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

{status} - transformed to ‘on’ of ‘off’ according to the status

{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)[source]

Sets the led status

Parameters:: status (bool) – the new status

sizeHint(self) → QSize[source]

toLedName(status=None, color=None, inverted=None)[source]

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()[source]: toggles the current status of the led

QLed

`QLed`