Addressable LED#

Introduction#

An Addressable LED is a programmable RGB LED strip device that connects to a 3-Wire port and lets you control individual LEDs (such as WS2812/“NeoPixel” style) to display custom colors and patterns.

This page uses address_led as the example Addressable LED’s name. Replace it with your own configured name as needed.

Below is a list of available methods:

  • set – Sets the Addressable LED strip’s colors.

  • clear – Turns the whole Addressable LED strip off.

Constructor – Manually initialize and configure an Addressable LED.

set#

set sets the Addressable LED strip to provided values.

Usage:
address_led.set(data, offset)

Parameters

Description

data

A list of Color values. This includes predefined colors, hexadecimal integers, and web colors.

offset

Optional. The index of LED to start at.

# Create a sequence of colors: Red, Green, Blue
color_list = [Color(0xFF0000), Color(0x00FF00), Color(0x0000FF)]

# Set the Addressable LED to the color_list sequence
address_led.set(color_list)

clear#

clear turns the whole Addressable LED strip off.

Usage:
address_led.clear()

Parameters

Description

This method has no parameters.

Constructor#

Constructors are used to create AddressableLed objects, which are necessary for configuring an Addressable LED.

AddressableLed#

AddressableLed creates an Addressable LED.

Usage:
AddressableLed(port)

Parameter

Description

port

The 3-Wire Port that the Addressable LED strip is connected to:

  • On the V5 Brainbrain.three_wire_port.x where x is the number of the port.
  • On a 3-Wire Expanderexpander.a where expander is the name of the expander instance.

# Create an Addressable LED in Port A
address_led = AddressableLed(brain.three_wire_port.a)