Synopsis

typedef enum {
  PLATFORM_LED_UNKNOWN,
  PLATFORM_LED_RED,
  PLATFORM_LED_GREEN,
  PLATFORM_LED_BLUE,
  PLATFORM_LED_YELLOW,
  PLATFORM_LED_ORANGE,
  PLATFORM_LED_WHITE,
  PLATFORM_LED_IR,
  PLATFORM_LED_COLOR_MASK,
  PLATFORM_LED_TRICOLOR,
  PLATFORM_LED_POSITIVE_LOGIC,
  PLATFORM_LED_NEGATIVE_LOGIC
} PLATFORM_LED_ATTRIBUTE_t;

Description

PLATFORM_LED_ATTRIBUTE_t describes the attributes of a LED.

The attributes are a combination of LED color and how the LED is driven.

LEDs that are part of a tricolor arrangement have PLATFORM_LED_TRICOLOR set along with one of the red, green, and blue colors.

PLATFORM_LED_UNKNOWN

The LED color is unknown or varies between boards.

PLATFORM_LED_RED

The LED is red.

PLATFORM_LED_GREEN

The LED is green.

PLATFORM_LED_BLUE

The LED is blue.

PLATFORM_LED_YELLOW

The LED is yellow.

PLATFORM_LED_ORANGE

The LED is orange.

PLATFORM_LED_WHITE

The LED is white.

PLATFORM_LED_IR

The LED emits infrared light.

PLATFORM_LED_COLOR_MASK

The mask to isolate the color component of the LED attributes.

PLATFORM_LED_TRICOLOR

When set indicates that the LED is part of a tricolor arrangement.

PLATFORM_LED_POSITIVE_LOGIC

When set indicates that the LED is driven using positive logic: writing a one to the GPIO will turn the LED on and writing a zero will turn it off. When clear, indicates that the LED is driven using negative logic.

PLATFORM_LED_NEGATIVE_LOGIC

A documentation convenience when constructing LED attributes. Indicates that the LED is driven using negative logic: writing a one to the GPIO will turn the LED off and writing a zero will turn it on.