Skip to Content
Lumensalis CircuitPython framework coming soon 🎉

LumensalisCP.Lights.Patterns

Module Contents

Classes

Rainbow
Gauge
Blink
Random
Cylon2
CylonPatternStep
Cylon

Functions

prepRGBValue

Data

__all__

API

LumensalisCP.Lights.Patterns.prepRGBValue(value)

class LumensalisCP.Lights.Patterns.Rainbow(*args, colorCycle: LumensalisCP.Lights.Pattern.TimeInSeconds | LumensalisCP.Lights.Pattern.Evaluatable = 1.0, spread: float | LumensalisCP.Lights.Pattern.Evaluatable = 1, **kwargs)

Bases: LumensalisCP.Lights.Pattern.Pattern

Initialization

property colorCycle

refresh(context: LumensalisCP.IOContext.UpdateContext)

class LumensalisCP.Lights.Patterns.Gauge(target: LumensalisCP.Lights.Pattern.LightGroup, name: LumensalisCP.Lights.Pattern.Optional[str] = None, onValue: LumensalisCP.Lights.Pattern.AnyLightValue = 1.0, offValue: LumensalisCP.Lights.Pattern.AnyLightValue = 0.0, value: LumensalisCP.Lights.Pattern.ZeroToOne | LumensalisCP.Lights.Pattern.Evaluatable = 0.0, **kwargs)

Bases: LumensalisCP.Lights.Pattern.Pattern, LumensalisCP.IOContext.NamedOutputTarget

Initialization

property value : LumensalisCP.Lights.Pattern.ZeroToOne | LumensalisCP.Lights.Pattern.Evaluatable

property onValue

set(value: LumensalisCP.Lights.Pattern.ZeroToOne, context: LumensalisCP.IOContext.EvaluationContext)

refresh(context: LumensalisCP.IOContext.UpdateContext)

class LumensalisCP.Lights.Patterns.Blink(*args, onTime: LumensalisCP.Lights.Pattern.TimeInSeconds = 1.0, offTime: LumensalisCP.Lights.Pattern.TimeInSeconds = 1.0, onValue: LumensalisCP.Lights.Pattern.AnyLightValue = 1.0, offValue: LumensalisCP.Lights.Pattern.AnyLightValue = 0.0, intermediateRefresh: LumensalisCP.Lights.Pattern.TimeInSeconds | None = None, **kwargs)

Bases: LumensalisCP.Lights.Pattern.PatternGenerator

Initialization

regenerate(context: LumensalisCP.IOContext.UpdateContext)

class LumensalisCP.Lights.Patterns.Random(*args, duration: LumensalisCP.Lights.Pattern.TimeInSeconds = 1.0, intermediateRefresh: LumensalisCP.Lights.Pattern.TimeInSeconds = 0.1, brightness: LumensalisCP.Lights.Pattern.ZeroToOne = 1, **kwargs)

Bases: LumensalisCP.Lights.Pattern.PatternGenerator

Initialization

_generateRandomValues(context: LumensalisCP.IOContext.UpdateContext)

regenerate1(context: LumensalisCP.IOContext.UpdateContext)

regenerate(context: LumensalisCP.IOContext.UpdateContext)

class LumensalisCP.Lights.Patterns.Cylon2(*args, sweepTime: LumensalisCP.Lights.Pattern.TimeInSeconds = 1.0, onValue: LumensalisCP.Lights.Pattern.AnyLightValue = 1.0, offValue: LumensalisCP.Lights.Pattern.AnyLightValue = 0.0, intermediateRefresh: LumensalisCP.Lights.Pattern.TimeInSeconds = 0.1, dimRatio: LumensalisCP.Lights.Pattern.ZeroToOne = 0.7, **kwargs)

Bases: LumensalisCP.Lights.Pattern.PatternGenerator

Initialization

property sweepTime : LumensalisCP.Lights.Pattern.TimeInSeconds

regenerate(context: LumensalisCP.IOContext.UpdateContext)

class LumensalisCP.Lights.Patterns.CylonPatternStep(index: int = 0, up: bool = True, *args, **kwds)

Bases: LumensalisCP.Lights.Pattern.PatternGeneratorSharedStep

Initialization

startValue(index, context: LumensalisCP.IOContext.UpdateContext)

endValue(index, context: LumensalisCP.IOContext.UpdateContext)

intermediateValue(index, progression: LumensalisCP.Lights.Pattern.ZeroToOne, context: LumensalisCP.IOContext.UpdateContext)

class LumensalisCP.Lights.Patterns.Cylon(*args, sweepTime: LumensalisCP.Lights.Pattern.TimeInSeconds = 1.0, onValue: LumensalisCP.Lights.Pattern.AnyLightValue = 1.0, offValue: LumensalisCP.Lights.Pattern.AnyLightValue = 0.0, intermediateRefresh: LumensalisCP.Lights.Pattern.TimeInSeconds = 0.1, **kwargs)

Bases: LumensalisCP.Lights.Pattern.Pattern

Initialization

refresh(context: LumensalisCP.IOContext.UpdateContext)

regenerate(context: LumensalisCP.IOContext.UpdateContext)

LumensalisCP.Lights.Patterns.__all__ = None