add pico_status_led #2501

peterharperuk · 2025-06-03T13:04:17Z

Add a status led library to make adapting to a "normal" led and the cyw43 led a bit easier.
Bonus support for ws2812 leds.

src/rp2_common/pico_status_led/include/pico/status_led.h

src/rp2_common/pico_status_led/status_led.c

kilograham · 2025-06-04T16:16:03Z

I think the color setting should be orthogonal to the On/Off and the color method should not mention WS2812 in their name - they should probably (and all the methods really) have a bool which says whether they do anything (so you can still use the library with no LEDs at all)

I'm not quite sure about the color APIs right now - somewhat leaning towards uint32_t so you can read, and allow r,g,b or w,r,g,b methods - maybe make it a #define what WRGB LEDs do when you set r,g,b (either 0 for WRGB or auto set)

peterharperuk · 2025-06-04T16:41:27Z

I think the color setting should be orthogonal

Ah right. I was thinking you'd use the ws2812 as the blinking led. But just having a function to set the ws2812 colour might be better - as most boards seem to have both a simple led and a ws2812 led.

lurch · 2025-06-04T16:44:18Z

as most boards seem to have both a simple led and a ws2812 led.

There are definitely several boards with only a WS2812 and no normal LED though.

EDIT: Hmmm, so given that this is a "status LED" library and not a "WS2812 library", and we're basically using the ws2812 as though it were a normal LED; perhaps it makes sense to only have the "on" colour configurable, and always have the "off colour" as blank? 🤔 Because otherwise it might not be clear that e.g. "red" is "on" and "turquoise" is "off"! 🌈

peterharperuk · 2025-06-04T17:34:56Z

I'll get rid of the on off thing and just have a method that sets the RGB of a colour status led.

lurch · 2025-06-04T18:05:52Z

I'll get rid of the on off thing and just have a method that sets the RGB of a colour status led.

IMHO being able to simply turn on/off an RGB LED would mean that a board with an RGB LED (using this status_led library) could be used identically (after a recompile of course) to a board with a normal LED? (e.g. the canonical "status-LED-blink" example)
Perhaps we've just got a different mental-model of what it is that this status_led library is actually for?

peterharperuk · 2025-06-04T18:28:25Z

But most boards are configured with both. Who's to say that you shouldn't be able to control both individually?

lurch · 2025-06-04T23:55:24Z

But most boards are configured with both. Who's to say that you shouldn't be able to control both individually?

I'm not saying that you shouldn't be able to control both LEDs individually, I guess I was just kinda expecting a status_led library to control only one of them, with the other LED then free for user-purposes. 💡

So, entirely IMVHO:

board has a regular LED (i.e. PICO_DEFAULT_LED_PIN or CYW43_WL_GPIO_LED_PIN) but no RGB LED : status_led on/off turns the regular LED on/off
board has an RGB LED (i.e. PICO_DEFAULT_WS2812_PIN) but no regular LED : status_led on/off turns the RGB led on/off, with optional control of the "on" colour (defaults to "white")
board has both a regular LED and an RGB LED (i.e. PICO_DEFAULT_LED_PIN and PICO_DEFAULT_WS2812_PIN) : status_led on/off turns the regular LED on/off, with the RGB LED then left free for any other purposes
board has both a regular LED and an RGB LED and the user sets the PICO_STATUS_LED_USE_WS2812_PIN define (or equivalent) : status_led on/off turns the RGB led on/off, with the regular LED then left free for any other purpose
board has lots of regular LEDs and lots of RGB LEDs : user is free to set whatever PICO_CONFIG defines they want, in order to customise which LED the status_led on/off functions will control

That way any example-code that's using the status_led on/off functions will "just work" on any type of board? 🤷

peterharperuk · 2025-06-05T07:32:18Z

Let's keep it simple. If @kilograham disagrees we can change it

src/rp2_common/pico_status_led/include/pico/status_led.h

kilograham · 2025-06-05T16:23:22Z

But most boards are configured with both. Who's to say that you shouldn't be able to control both individually?

I'm not saying that you shouldn't be able to control both LEDs individually, I guess I was just kinda expecting a status_led library to control only one of them, with the other LED then free for user-purposes. 💡

So, entirely IMVHO:
* board has a regular LED (i.e. `PICO_DEFAULT_LED_PIN` or `CYW43_WL_GPIO_LED_PIN`) but no RGB LED : `status_led` on/off turns the regular LED on/off

* board has an RGB LED (i.e. `PICO_DEFAULT_WS2812_PIN`) but no regular LED : `status_led` on/off turns the RGB led on/off, with optional control of the "on" colour (defaults to "white")

* board has both a regular LED and an RGB LED (i.e. `PICO_DEFAULT_LED_PIN` and  `PICO_DEFAULT_WS2812_PIN`) : `status_led` on/off turns the regular LED on/off, with the RGB LED then left free for any other purposes

* board has both a regular LED and an RGB LED **and** the user sets the `PICO_STATUS_LED_USE_WS2812_PIN` define (or equivalent) : `status_led` on/off turns the RGB led on/off, with the regular LED then left free for any other purpose

* board has lots of regular LEDs and lots of RGB LEDs : user is free to set whatever `PICO_CONFIG` defines they want, in order to customise which LED the `status_led` on/off functions will control
That way any example-code that's using the status_led on/off functions will "just work" on any type of board? 🤷

This is somewhat similar to what i was expecting.

The ability to blink a LED on any old board. If it has a WS812 or similar, the ability to set the color too (the API can exist but return false)
Possibly in the future, some helpers, like "blink error pattern" (possibly incorporating colors for colored LEDs)
The ability to target these APIs at a particular LED pin or WS2812 pin, or WIFI LED is probably nice too

Sorry, i haven't given a lot of though yet to how i would like this to look

src/rp2_common/pico_status_led/status_led.c

src/rp2_common/pico_status_led/include/pico/status_led.h

kilograham · 2025-06-05T17:39:16Z

looking nice - one comment in code

src/rp2_common/pico_status_led/include/pico/status_led.h

kilograham · 2025-07-15T20:53:16Z

looking great; a few comments in the code, but also

I still think
c
the status LED may or may not have a settable color
the status LED may or may not be on/off

i.e. turning on/off a WS2812 LED should set it to the "currently chosen" color for on and zeros for off

peterharperuk · 2025-07-18T13:36:02Z

Another attempt pushed. Note that I don't have a WS2812 atm, so will test more on Monday.

peterharperuk · 2025-07-18T13:38:48Z

@kilograham Can you tell me if this is closer to what you want before I waste more time on it?

src/rp2_common/pico_status_led/include/pico/status_led.h

src/rp2_common/pico_status_led/status_led.c

src/rp2_common/pico_status_led/include/pico/status_led.h

src/rp2_common/pico_status_led/status_led.c

The cyw43-driver enables LwIP if CYW43_LWIP is not defined. Allow LwIP to be disabled by default if CYW43_LWIP is not defined so we can use the driver to access the led without needing to link to LwIP. Add CYW43_LWIP_DEFAULT to enable this.

Functions for turning a binary led on and off and setting value of a colour status led. Set/get the colour used if the colored led is ON... pico_status_led_color_set_on_value pico_status_led_color_get_on_value Set the coloured led ON or OFF pico_status_led_color_set pico_status_led_color_get pico_status_led_set and pico_status_led_get call these functions if PICO_DEFAULT_LED_PIN is not defined or PICO_STATUS_LED_COLOR_ONLY is true. PICO_DEFAULT_LED_PIN_INVERTED and PICO_DEFAULT_WS2812_POWER_PIN are now used. Fixes raspberrypi#188

peterharperuk · 2025-07-21T12:20:02Z

@kilograham I've tested this again.

Fix some typos and some sentances that didn't scan.

kilograham

nice thanks

kilograham · 2025-07-28T17:05:30Z

fixes #188

lurch reviewed Jun 3, 2025

View reviewed changes

src/rp2_common/pico_status_led/include/pico/status_led.h Outdated Show resolved Hide resolved

lurch reviewed Jun 3, 2025

View reviewed changes

src/rp2_common/pico_status_led/include/pico/status_led.h Outdated Show resolved Hide resolved

lurch reviewed Jun 3, 2025

View reviewed changes

src/rp2_common/pico_status_led/include/pico/status_led.h Outdated Show resolved Hide resolved

lurch reviewed Jun 3, 2025

View reviewed changes

src/rp2_common/pico_status_led/include/pico/status_led.h Outdated Show resolved Hide resolved

lurch reviewed Jun 3, 2025

View reviewed changes

src/rp2_common/pico_status_led/include/pico/status_led.h Outdated Show resolved Hide resolved

lurch reviewed Jun 3, 2025

View reviewed changes

src/rp2_common/pico_status_led/status_led.c Outdated Show resolved Hide resolved

lurch reviewed Jun 3, 2025

View reviewed changes

src/rp2_common/pico_status_led/status_led.c Outdated Show resolved Hide resolved

lurch reviewed Jun 3, 2025

View reviewed changes

src/rp2_common/pico_status_led/status_led.c Outdated Show resolved Hide resolved

peterharperuk force-pushed the status_led branch 3 times, most recently from fcada13 to 0e0dd15 Compare June 5, 2025 14:35

peterharperuk commented Jun 5, 2025

View reviewed changes

src/rp2_common/pico_status_led/include/pico/status_led.h Outdated Show resolved Hide resolved

peterharperuk commented Jun 5, 2025

View reviewed changes

src/rp2_common/pico_status_led/status_led.c Outdated Show resolved Hide resolved

peterharperuk commented Jun 5, 2025

View reviewed changes

src/rp2_common/pico_status_led/include/pico/status_led.h Outdated Show resolved Hide resolved

peterharperuk force-pushed the status_led branch from 0e0dd15 to f83483a Compare June 5, 2025 17:19

peterharperuk marked this pull request as ready for review June 5, 2025 17:30

kilograham reviewed Jun 5, 2025

View reviewed changes

src/rp2_common/pico_status_led/include/pico/status_led.h Outdated Show resolved Hide resolved

kilograham changed the title ~~Status led~~ add pico_status_led Jun 12, 2025

kilograham added this to the 2.1.2 milestone Jun 12, 2025

kilograham assigned peterharperuk Jul 2, 2025

kilograham reviewed Jul 15, 2025

View reviewed changes

src/rp2_common/pico_status_led/include/pico/status_led.h Outdated Show resolved Hide resolved

kilograham reviewed Jul 15, 2025

View reviewed changes

src/rp2_common/pico_status_led/include/pico/status_led.h Outdated Show resolved Hide resolved

peterharperuk force-pushed the status_led branch 2 times, most recently from 33b3c32 to 0899540 Compare July 18, 2025 13:35

kilograham assigned kilograham and unassigned peterharperuk Jul 18, 2025

peterharperuk commented Jul 18, 2025

View reviewed changes

src/rp2_common/pico_status_led/include/pico/status_led.h Outdated Show resolved Hide resolved

peterharperuk commented Jul 18, 2025

View reviewed changes

src/rp2_common/pico_status_led/status_led.c Outdated Show resolved Hide resolved

peterharperuk commented Jul 18, 2025

View reviewed changes

src/rp2_common/pico_status_led/status_led.c Show resolved Hide resolved

peterharperuk commented Jul 18, 2025

View reviewed changes

src/rp2_common/pico_status_led/include/pico/status_led.h Outdated Show resolved Hide resolved

peterharperuk commented Jul 18, 2025

View reviewed changes

src/rp2_common/pico_status_led/status_led.c Outdated Show resolved Hide resolved

peterharperuk added 3 commits July 21, 2025 12:22

Fix dependency issue with pico_cyw43_driver

a6763c1

Fix build warnings in cyw43_driver.c

389ff83

Allow LwIP to be disabled by default

cce86cd

The cyw43-driver enables LwIP if CYW43_LWIP is not defined. Allow LwIP to be disabled by default if CYW43_LWIP is not defined so we can use the driver to access the led without needing to link to LwIP. Add CYW43_LWIP_DEFAULT to enable this.

peterharperuk force-pushed the status_led branch 2 times, most recently from cbd4e4d to 40417de Compare July 21, 2025 11:26

peterharperuk force-pushed the status_led branch from 40417de to 4dbc9e8 Compare July 21, 2025 11:35

agggghh

fd8888e

kilograham force-pushed the status_led branch from 71ac5aa to fd8888e Compare July 25, 2025 21:50

kilograham and others added 3 commits July 25, 2025 16:51

ah; alphabetically challenged

45b2ae5

Doc fixes

c52dcfb

Fix some typos and some sentances that didn't scan.

Some minor code fixes

b6fda71

kilograham approved these changes Jul 28, 2025

View reviewed changes

kilograham merged commit 9227cad into raspberrypi:develop Jul 28, 2025
6 checks passed

add pico_status_led #2501

add pico_status_led #2501

Uh oh!

Conversation

peterharperuk commented Jun 3, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

kilograham commented Jun 4, 2025

Uh oh!

peterharperuk commented Jun 4, 2025

Uh oh!

lurch commented Jun 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

peterharperuk commented Jun 4, 2025

Uh oh!

lurch commented Jun 4, 2025

Uh oh!

peterharperuk commented Jun 4, 2025

Uh oh!

lurch commented Jun 4, 2025

Uh oh!

peterharperuk commented Jun 5, 2025

Uh oh!

Uh oh!

kilograham commented Jun 5, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

kilograham commented Jun 5, 2025

Uh oh!

Uh oh!

Uh oh!

kilograham commented Jul 15, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

peterharperuk commented Jul 18, 2025

Uh oh!

peterharperuk commented Jul 18, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

peterharperuk commented Jul 21, 2025

Uh oh!

kilograham left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

kilograham commented Jul 28, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

lurch commented Jun 4, 2025 •

edited

Loading

kilograham commented Jun 5, 2025 •

edited

Loading

kilograham commented Jul 15, 2025 •

edited

Loading