Skip to Content
Lumensalis CircuitPython framework coming soon 🎉

LumensalisCP.Lights.Pattern

Module Contents

Classes

Pattern
PatternGeneratorStep
PatternGeneratorSharedStep
MultiLightPatternStep
PatternGenerator

API

class LumensalisCP.Lights.Pattern.Pattern(target: LumensalisCP.Lights.Light.LightGroup, name: LumensalisCP.Lights.Light.Optional[str] = None, whenOffset: LumensalisCP.Lights.Light.TimeInSeconds = 0.0, startingSpeed: LumensalisCP.Lights.Light.TimeInSeconds = 1.0)

Bases: LumensalisCP.Lights.Light.NamedLocalIdentifiable

Initialization

_theManager : LumensalisCP.Main.Manager.MainManager = None

property whenOffset : LumensalisCP.Lights.Light.TimeInSeconds

offsetWhen(context: EvaluationContext) → LumensalisCP.Lights.Light.TimeInSeconds

property target : LumensalisCP.Lights.Light.LightGroup

property speed : LumensalisCP.Lights.Light.TimeInSeconds

property running : bool

setSpeed(value: LumensalisCP.Lights.Light.TimeInSeconds, context: EvaluationContext | None = None)

setRunning(value: bool, context: EvaluationContext | None = None)

refresh(context: EvaluationContext) → None

main()

class LumensalisCP.Lights.Pattern.PatternGeneratorStep(duration: LumensalisCP.Lights.Light.TimeInSeconds = 1.0)

Bases: object

Initialization

startValue(index: int, context: EvaluationContext) → None

endValue(index: int, context: EvaluationContext) → None

intermediateValue(index: int, progression: LumensalisCP.Lights.Light.ZeroToOne, context: EvaluationContext) → None

class LumensalisCP.Lights.Pattern.PatternGeneratorSharedStep(duration: LumensalisCP.Lights.Light.TimeInSeconds = 1.0, startValue: LumensalisCP.Lights.Light.Optional[LumensalisCP.Lights.Light.AnyLightValue] = None, endValue: LumensalisCP.Lights.Light.Optional[LumensalisCP.Lights.Light.AnyLightValue] = None, intermediateRefresh: LumensalisCP.Lights.Light.TimeInSeconds | None = None)

Bases: LumensalisCP.Lights.Pattern.PatternGeneratorStep

Initialization

startValue(index: int, context: EvaluationContext)

endValue(index: int, context: EvaluationContext)

intermediateValue(index, progression: LumensalisCP.Lights.Light.ZeroToOne, context: EvaluationContext)

class LumensalisCP.Lights.Pattern.MultiLightPatternStep(duration, starts: LumensalisCP.Lights.Light.List[LumensalisCP.Lights.Light.AnyLightValue], ends: LumensalisCP.Lights.Light.List[LumensalisCP.Lights.Light.AnyLightValue], **kwds)

Bases: LumensalisCP.Lights.Pattern.PatternGeneratorSharedStep

Initialization

startValue(index: int, context: EvaluationContext)

endValue(index: int, context: EvaluationContext)

class LumensalisCP.Lights.Pattern.PatternGenerator(*args, intermediateRefresh: LumensalisCP.Lights.Light.TimeInSeconds | None = None, **kwargs)

Bases: LumensalisCP.Lights.Pattern.Pattern

Initialization

stats() → LumensalisCP.util.bags.Bag

refresh(context: EvaluationContext)

stepForward(context: EvaluationContext)

regenerate(context: EvaluationContext) → LumensalisCP.Lights.Light.Generator[LumensalisCP.Lights.Pattern.PatternGeneratorSharedStep]

setRunning(value: bool, context: EvaluationContext | None = None)