Click or drag to resize
RgbLed Class
A light capable of producing multiple colors by adjusting red, green and blue values. This class implements the ILight interface.
Inheritance Hierarchy
SystemObject
  Microsoft.IoT.Devices.LightsRgbLed

Namespace: Microsoft.IoT.Devices.Lights
Assembly: Microsoft.IoT.Devices (in Microsoft.IoT.Devices.dll) Version: 1.0.0.0 (1.0.0.0)
Syntax
public sealed class RgbLed : ILight, 
	IClosable, IStringable

The RgbLed type exposes the following members.

Constructors
  NameDescription
Public methodRgbLed
Initializes a new instance of the RgbLed class
Top
Properties
  NameDescription
Public propertyBluePin
Gets or sets the pin that the blue component is connected to.
Public propertyBrightnessLevel
Gets or sets a value indicating the current brightness level of the light, where 0.0 is completely off and 1.0 is maximum brightness.
Public propertyColor
Gets or sets the color of the light.
Public propertyGreenPin
Gets or sets the pin that the green component is connected to.
Public propertyIsColorSettable
Gets a value indicating whether you can set the Color property of the light.
Public propertyRedPin
Gets or sets the pin that the red component is connected to.
Top
Methods
  NameDescription
Public methodClose
Public methodEquals (Inherited from Object.)
Public methodGetHashCode (Inherited from Object.)
Public methodGetType (Inherited from Object.)
Public methodToString (Inherited from Object.)
Top
Remarks
Each color component is represented by a PwmPin. All three color components are not required but at least one PwmPin must be specified before setting the Color property. Setting the color to a value that cannot be displayed by the hardware configuration will not raise an error. For example, setting Color to Blue when only the GreenPin is connected will not result in an exception (though obviously no color will be shown).
See Also