Add type annotation protocols for LEDs

[tekktrik]

Useful for typing LEDs without having to import them. Spawned from typing adafruit_esp32spi.

[tekktrik]

If this isn't widely used enough, I could also just type it in the relevant library

[dhalbert]

If this isn't widely used enough, I could also just type it in the relevant library

If it's used in more than one library, it's good to have it in a central place. Otherwise you can put the definitions inside the try block for the typing imports. They will take space in a library, which is one reason not to include them in libraries.

[tekktrik]

If they get caught (or missed, really) because of the try/except block, that should prevent them from using memory though, right? Either way, I'll try to raise it on a case-by-case basis then

[dhalbert]

Right, it's static code size, either in the filesystem, or in a frozen module.

[tekktrik]

Converted to draft for now. There may be other uses of this in the libraries but I'm not sure... I'll take a look and see if it's worth putting here or not!

[tekktrik]

Okay, I found at least a few libraries that use Protocol for LEDs in their library. Basing those types here seems to be a good idea in this case.

[FoamyGuy]

Makes sense to me to have this as a Protocol, I believe I've seen this concept used in multiple places and I'm sure there are likely more that I am unaware of.

Looks good to me.

I am more familiar with the ones that use fill(). I don't recall seeing any that use color() but they're probably among the ones I am unaware of.

I'm curious if you know about square bracket accessing in protocols? I believe neopixel and similar LEDs with a fill() function also typically support things like:

led_strip_obj[0] = 0x00ff00

to set an individual LED by it's index to a given color. I don't know if it's possible to express this in a typing protocol but if so it might be nice to include that as well.

[tekktrik]

Looks like you'd need to define __getitem__ and/or __setitem__ in the protocol so yup!

[tekktrik]

@FoamyGuy do you know of any libraries that would need that set in the Protocol? I don't necessarily want to over constrain the protocols if where they are doesn't require that specific behavior (ex: the only need to generically describe fill()/color().)

[FoamyGuy]

https://github.com/adafruit/Adafruit_CircuitPython_led_animation

and the board specific helper libraries like:
https://github.com/adafruit/Adafruit_CircuitPython_PyBadger
https://github.com/adafruit/Adafruit_CircuitPython_CircuitPlayground
https://github.com/adafruit/Adafruit_CircuitPython_NeoTrellis

are the ones that come to mind that use neopixels. I'm not sure that any of them would specifically need this functionality though. The places I did see it typed so far looking around have it as NeoPixel. I think it makes sense to use that in these contexts instead of a protocol. So yeah, probably not worth adding the set_item. We can always do it later if a need arises.

[tekktrik]

Sounds good!