Skip to Content
Lumensalis CircuitPython framework coming soon 🎉

LumensalisCP.Lights.Groups

Module Contents

Classes

LightGroupa group of related lights used for a common purpose
LightGroupList
NextNLights
Ring
Stick
Strip
AdHocLightGroup
LightSourcedriver / hardware interface providing Lights

API

class LumensalisCP.Lights.Groups.LightGroup(**kwargs)

Bases: LumensalisCP.Identity.Local.NamedLocalIdentifiable

a group of related lights used for a common purpose

Args: : object (type): _description_

Initialization

property lightCount : int

property lights : LumensalisCP.Lights.Values.Iterable[LumensalisCP.Lights.Light.Light]

__getitem__(index: int) → LumensalisCP.Lights.Light.Light

__setitem__(index: int, value: LumensalisCP.Lights.Values.AnyLightValue)

values(context: LumensalisCP.Lights.Values.Optional[EvaluationContext] = None)

class LumensalisCP.Lights.Groups.LightGroupList(lights: LumensalisCP.Lights.Values.List[LumensalisCP.Lights.Light.Light] = [], name: str | None = None, **kwargs)

Bases: LumensalisCP.Lights.Groups.LightGroup

property lightCount : int

property lights : LumensalisCP.Lights.Values.Iterable[LumensalisCP.Lights.Light.Light]

__getitem__(index) → LumensalisCP.Lights.Light.Light

__setitem__(index, value: LumensalisCP.Lights.Values.AnyLightValue)

class LumensalisCP.Lights.Groups.NextNLights(count: int, name: str, source: LumensalisCP.Lights.Groups.LightSource, **kwargs)

Bases: LumensalisCP.Lights.Groups.LightGroupList

class LumensalisCP.Lights.Groups.Ring(count: int, name: str, source: LumensalisCP.Lights.Groups.LightSource, **kwargs)

Bases: LumensalisCP.Lights.Groups.NextNLights

class LumensalisCP.Lights.Groups.Stick(count: int, name: str, source: LumensalisCP.Lights.Groups.LightSource, **kwargs)

Bases: LumensalisCP.Lights.Groups.NextNLights

class LumensalisCP.Lights.Groups.Strip(count: int, name: str, source: LumensalisCP.Lights.Groups.LightSource, **kwargs)

Bases: LumensalisCP.Lights.Groups.NextNLights

class LumensalisCP.Lights.Groups.AdHocLightGroup(name: str, **kwargs)

Bases: LumensalisCP.Lights.Groups.LightGroupList

append(light: LumensalisCP.Lights.Light.Light | LumensalisCP.Lights.Groups.LightGroup)

class LumensalisCP.Lights.Groups.LightSource(**kwargs)

Bases: LumensalisCP.Lights.Groups.LightGroupList

driver / hardware interface providing Lights

Initialization

startOfNextN(count: int)

_nextNLights(cls, count: int, name: LumensalisCP.Lights.Values.Optional[str] = None, desc: LumensalisCP.Lights.Values.Optional[str] = None, **kwargs)

nextNLights(count: int, name: LumensalisCP.Lights.Values.Optional[str] = None, **kwargs) → LumensalisCP.Lights.Groups.NextNLights

ring(count: int, name: LumensalisCP.Lights.Values.Optional[str] = None, **kwargs) → LumensalisCP.Lights.Groups.Ring

stick(count: int, name: LumensalisCP.Lights.Values.Optional[str] = None, **kwargs) → LumensalisCP.Lights.Groups.Stick

strip(count: int, name: LumensalisCP.Lights.Values.Optional[str] = None, **kwargs) → LumensalisCP.Lights.Groups.Strip

single(name: LumensalisCP.Lights.Values.Optional[str] = None, **kwargs) → LumensalisCP.Lights.Groups.NextNLights

lightChanged(light: LumensalisCP.Lights.Light.Light)