2.17 LED Module API Manual

1. Overview

The development board includes an RGB LED, which users can control the brightness of each color through the API.

2. API Introduction

The LED class is located under the machine module.

2.1 Example

from machine import LED
import time

# Instantiate LED objects
red_led = LED("LED_RED")          # Or red_led = LED(1)
green_led = LED("LED_GREEN")      # Or green_led = LED(2)
blue_led = LED("LED_BLUE")        # Or blue_led = LED(3)

# Turn off all LEDs
blue_led.off()
green_led.off()
red_led.off()

while True:
    # Set the brightness of the green LED
    green_led.value(50)    # Brightness range is 0-255
    red_led.on()           # Turn on the red LED
    time.sleep_ms(250)
    
    green_led.value(200)   # Set the brightness of the green LED
    red_led.off()          # Turn off the red LED
    time.sleep_ms(250)

2.2 Constructor

led = LED(id)

Parameters

• id: Identifier of the LED, 1 or “LED_RED” for the red LED; 2 or “LED_GREEN” for the green LED; 3 or “LED_BLUE” for the blue LED.

2.3 value Method

led.value(val)

Controls the brightness of the LED.

Parameters

• val: Brightness level, ranging from 0 to 255.

Return Value

None

2.4 on Method

led.on()

Turns on the LED at maximum brightness.

Parameters

None

Return Value

None

2.5 off Method

led.off()

Turns off the LED.

Parameters

None

Return Value

None