DSL Reference - Animation DSL Language Specification~
This document provides a comprehensive reference for the Animation DSL syntax, keywords, and grammar. It focuses purely on the language specification without implementation details.
For detailed information about the DSL transpiler's internal architecture and processing flow, see Transpiler_Architecture.md.
Language Overview~
The Animation DSL is a declarative language for defining LED strip animations. It uses natural, readable syntax with named parameters and supports colors, animations, sequences, and property assignments.
Comments~
Comments use the # character and extend to the end of the line:
# This is a full-line comment
# strip length 30 # This is an inline comment (TEMPORARILY DISABLED)
color bordeaux = 0x6F2C4F # This is an inline comment
Comments are preserved in the generated code and can appear anywhere in the DSL.
Program Structure~
A DSL program consists of statements that can appear in any order:
# Strip configuration is handled automatically
# strip length 60 # TEMPORARILY DISABLED
# Color definitions
color bordeaux = 0x6F2C4F
color majorelle = 0x6050DC
# Animation definitions
animation pulse_bordeaux = pulsating_animation(color=bordeaux, period=2s)
# Property assignments
pulse_red.priority = 10
# Sequences
sequence demo {
play pulse_bordeaux for 5s
wait 1s
}
# Execution
run demo
Keywords~
Reserved Keywords~
The following keywords are reserved and cannot be used as identifiers:
Configuration Keywords: - strip - Strip configuration (temporarily disabled, reserved keyword) - set - Variable assignment - import - Import Berry modules - berry - Embed arbitrary Berry code - extern - Declare external Berry functions for DSL use
Definition Keywords: - color - Color definition - palette - Palette definition - animation - Animation definition - sequence - Sequence definition - template - Template definition - param - Template parameter declaration - type - Parameter type annotation
Control Flow Keywords: - play - Play animation in sequence - wait - Wait/pause in sequence - repeat - Repeat loop - times - Loop count specifier - for - Duration specifier - run - Execute animation or sequence - restart - Restart value provider or animation from beginning
Easing Keywords: - linear - Linear/triangle wave easing - triangle - Triangle wave easing (alias for linear) - smooth - Smooth cosine easing - sine - Pure sine wave easing - ease_in - Ease in transition (quadratic acceleration) - ease_out - Ease out transition (quadratic deceleration) - ramp - Ramp/sawtooth easing - sawtooth - Sawtooth easing (alias for ramp) - square - Square wave easing - elastic - Elastic easing with spring-like overshoot - bounce - Bounce easing like a ball with decreasing amplitude
Value Keywords: - true - Boolean true - false - Boolean false - nil - Null value - transparent - Transparent color
Predefined Colors~
The following color names are predefined and cannot be redefined:
Primary Colors: - red, green, blue - white, black
Extended Colors: - yellow, orange, purple, pink - cyan, magenta, gray, grey - silver, gold, brown - lime, navy, olive - maroon, teal, aqua - fuchsia, indigo, violet - crimson, coral, salmon - khaki, plum, orchid - turquoise, tan, beige - ivory, snow - transparent
Data Types~
Numbers~
42 # Integer
3.14 # Floating point
-5 # Negative number
Time Values~
Time values require a unit suffix and are automatically converted to milliseconds:
500ms # Milliseconds (stays 500)
2s # Seconds (converted to 2000ms)
1m # Minutes (converted to 60000ms)
1h # Hours (converted to 3600000ms)
Percentages~
Percentages use the % suffix and are automatically converted to 0-255 range with possible over-shooting:
0% # 0 percent (converted to 0)
50% # 50 percent (converted to 128)
100% # 100 percent (converted to 255)
120% # 120 percent (converted to 306)
Colors~
Hexadecimal Colors~
0xFF0000 # Red (RGB format)
0x80FF0000 # Semi-transparent red (ARGB format)
Named Colors~
red # Predefined color name
blue # Predefined color name
transparent # Transparent color
Strings~
"hello" # Double-quoted string
'world' # Single-quoted string
Identifiers~
Identifiers must start with a letter or underscore, followed by letters, digits, or underscores:
my_color # Valid identifier
_private_var # Valid identifier
Color123 # Valid identifier
Configuration Statements~
Strip Configuration~
Note: The strip directive is temporarily disabled. Strip configuration is handled automatically by the host system.
The strip statement configures the LED strip and must be the first statement if present:
# strip length 60 # TEMPORARILY DISABLED
If omitted, The system uses the configured strip length from the host system.
Variable Assignment~
The set keyword assigns static values or value providers to global variables:
set brightness = 200 # Static integer value
set cycle_time = 5s # Static time value (converted to 5000ms)
set opacity_level = 80% # Static percentage (converted to 204)
# Value providers for dynamic values
set brightness_osc = smooth(min_value=50, max_value=255, period=3s)
set position_sweep = triangle(min_value=0, max_value=29, period=5s)
# Computed values using strip length
set strip_len = strip_length() # Get current strip length
Import Statements~
The import keyword imports Berry modules for use in animations:
import user_functions # Import user-defined functions
import my_custom_module # Import custom animation libraries
import math # Import standard Berry modules
import string # Import utility modules
Import Behavior: - Module names should be valid identifiers (no quotes needed in DSL) - Import statements are typically placed at the beginning of DSL files - Transpiles to standard Berry import "module_name" statements - Imported modules become available for the entire animation
Common Use Cases:
# Import user functions for computed parameters
import user_functions
animation dynamic = solid(color=blue)
dynamic.opacity = my_custom_function()
# Import custom animation libraries
import fire_effects
animation campfire = fire_effects.create_fire(intensity=200)
Transpilation Example:
# DSL Code
import user_functions
# Transpiles to Berry Code
import "user_functions"
Berry Code Blocks~
The berry keyword allows embedding arbitrary Berry code within DSL files using triple-quoted strings:
berry """
import math
var custom_value = math.pi * 2
print("Custom calculation:", custom_value)
"""
berry '''
# Alternative syntax with single quotes
def helper_function(x)
return x * 1.5
end
'''
Berry Code Block Features: - Code is copied verbatim to the generated Berry code - Supports both """ and ''' triple-quote syntax - Can span multiple lines and include complex Berry syntax - Variables and functions defined in one block are available in subsequent blocks - Can interact with DSL-generated objects (e.g., animation_name_.property = value)
Example with DSL Integration:
animation pulse = pulsating_animation(color=red, period=2s)
berry """
# Modify animation using Berry code
pulse_.opacity = 200
pulse_.priority = 10
print("Animation configured")
"""
run pulse
External Function Declarations~
The extern keyword declares Berry functions defined in berry code blocks so they can be used in DSL expressions and computed parameters:
# Define the function in a berry block
berry """
def rand_meter(time_ms, self)
import math
var r = math.rand() % 101
return r
end
def breathing_effect(base_value, amplitude)
import math
var time_factor = (tasmota.millis() / 1000) % 4 # 4-second cycle
var breath = math.sin(time_factor * math.pi / 2)
return int(base_value + breath * amplitude)
end
"""
# Declare functions as external so DSL knows about them
extern function rand_meter
extern function breathing_effect
# Now they can be used in DSL expressions
animation back_pattern = palette_meter_animation(value_func = rand_meter)
animation breathing_light = solid(color=blue)
breathing_light.opacity = breathing_effect
run back_pattern
External Function Features: - Functions must be declared with extern function function_name after being defined in berry blocks - Can be used with or without parentheses: rand_meter or rand_meter() - Automatically receive engine as the first parameter when called from DSL - Can be used in computed parameters and property assignments - Support the same signature pattern as registered user functions
Function Signature Requirements: External functions should follow the user function pattern where the first parameter is the engine:
berry """
def my_external_func(engine, param1, param2)
# engine is automatically provided by DSL
# param1, param2 are user-provided parameters
return computed_value
end
"""
extern function my_external_func
# Usage in DSL (engine parameter is automatic)
animation test = solid(color=red)
test.opacity = my_external_func # Called as my_external_func(engine)
Comparison with User Functions: - External functions: Defined in berry blocks within the same DSL file, declared with extern function - User functions: Defined in separate Berry modules, imported with import, registered with animation.register_user_function() - Both use the same calling convention and can be used interchangeably in DSL expressions
Color Definitions~
The color keyword defines static colors or color providers:
# Static colors
color bordeaux = 0x6F2C4F # Static hex color
color majorelle = 0x6050DC # Static hex color
color semi_red = 0x80FF0000 # Static color with alpha channel
color my_white = white # Reference to predefined color
# Color providers for dynamic colors
color rainbow_cycle = color_cycle(
colors=bytes("FFFF0000" "FF00FF00" "FF0000FF")
period=5s
)
color breathing_red = breathe_color(
base_color=red
min_brightness=5%
max_brightness=100%
duration=3s
curve_factor=2
)
color pulsing_blue = pulsating_color(
base_color=blue
min_brightness=20%
max_brightness=80%
duration=1s
)
Palette Definitions~
Palettes define color gradients using position-color pairs and support two encoding formats with flexible syntax:
Value-Based Palettes (Recommended)~
Standard palettes use value positions from 0-255:
# Traditional syntax with commas
palette fire_colors = [
(0, 0x000000) # Position 0: Black
(128, 0xFF0000) # Position 128: Red
(255, 0xFFFF00) # Position 255: Yellow
]
# New syntax without commas (when entries are on separate lines)
palette ocean_palette = [
(0, navy) # Using named colors
(128, cyan)
(255, green)
]
# Mixed syntax also works
palette matrix_greens = [
(0, 0x000000), (64, 0x003300) # Multiple entries on one line
(128, 0x006600) # Single entry on separate line
(192, 0x00AA00)
(255, 0x00FF00)
]
Tick-Based Palettes (Advanced)~
Palettes can also use tick counts for timing-based transitions:
palette timed_colors = [
(10, 0xFF0000) # Red for 10 ticks
(20, 0x00FF00) # Green for 20 ticks
(15, 0x0000FF) # Blue for 15 ticks
]
Palette Rules: - Value-based: Positions range from 0 to 255, represent intensity/brightness levels - Tick-based: Positions represent duration in arbitrary time units - Colors: Only hex values (0xRRGGBB) or predefined color names (red, blue, green, etc.) - Custom colors: Previously defined custom colors are NOT allowed in palettes - Dynamic palettes: For palettes with custom colors, use user functions instead - Entries are automatically sorted by position - Comments are preserved - Automatically converted to efficient VRGB bytes format
Palette Color Restrictions~
Palettes have strict color validation to ensure compile-time safety:
✅ Allowed:
palette valid_colors = [
(0, 0xFF0000) # Hex colors
(128, red) # Predefined color names
(255, blue) # More predefined colors
]
❌ Not Allowed:
color custom_red = 0xFF0000
palette invalid_colors = [
(0, custom_red) # ERROR: Custom colors not allowed
(128, my_color) # ERROR: Undefined color
]
Alternative for Dynamic Palettes: For palettes that need custom or computed colors, use user functions:
# Define a user function that creates dynamic palettes
def create_custom_palette(engine, base_color, intensity)
# Create palette with custom logic
var palette_data = create_dynamic_palette_bytes(base_color, intensity)
return palette_data
end
# Register for DSL use
animation.register_user_function("custom_palette", create_custom_palette)
# Use in DSL
animation dynamic_anim = rich_palette(
colors=custom_palette(0xFF0000, 200)
period=3s
)
Animation Definitions~
The animation keyword defines instances of animation classes (subclasses of Animation):
animation red_solid = solid(color=red)
animation pulse_effect = pulsating_animation(
color=blue
period=2s
)
animation comet_trail = comet_animation(
color=white
tail_length=10
speed=1500
direction=1
)
Parameter Syntax: - All parameters use name=value format - Parameters can reference colors, other animations, or literal values - Nested function calls are supported
Property Assignments~
Animation properties can be modified after creation:
animation pulse_red = pulsating_animation(color=red, period=2s)
# Set properties
pulse_red.priority = 10
pulse_red.opacity = 200
pulse_red.position = 15
# Dynamic properties using value providers
pulse_red.position = triangle(min_value=0, max_value=29, period=5s)
pulse_red.opacity = smooth(min_value=100, max_value=255, period=2s)
# Computed properties using arithmetic expressions
set strip_len = strip_length()
pulse_red.position = strip_len / 2 # Center position
pulse_red.opacity = strip_len * 4 # Scale with strip size
# Animation opacity (using another animation as opacity mask)
animation opacity_mask = pulsating_animation(period=2s)
pulse_red.opacity = opacity_mask # Dynamic opacity from animation
Common Properties: - priority - Animation priority (higher numbers have precedence) - opacity - Opacity level (number, value provider, or animation) - position - Position on strip - speed - Speed multiplier - phase - Phase offset
Computed Values~
The DSL supports computed values using arithmetic expressions with value providers and mathematical functions:
Safe Patterns~
# ✅ RECOMMENDED: Single value provider assignment
set strip_len = strip_length()
# ✅ RECOMMENDED: Computation with existing values
set strip_len2 = (strip_len + 1) / 2
# Use computed values in animation parameters
animation stream1 = comet_animation(
color=red
tail_length=strip_len / 4 # Computed: quarter of strip length
speed=1.5
priority=10
)
⚠️ Dangerous Patterns (Prevented by Transpiler)~
The transpiler prevents dangerous patterns that would create new value provider instances at each evaluation:
# ❌ DANGEROUS: Function creation in computed expression
# This would create a new strip_length() instance at each evaluation
set strip_len3 = (strip_length() + 1) / 2
# ❌ ERROR: Transpiler will reject this with:
# "Function 'strip_length()' cannot be used in computed expressions.
# This creates a new instance at each evaluation."
Why This Is Dangerous: - Creates a new function instance every time the expression is evaluated - Causes memory leaks and performance degradation - Each new instance has its own timing and state, leading to inconsistent behavior
Safe Alternative:
# ✅ CORRECT: Separate the value provider creation from computation
set strip_len = strip_length() # Single value provider
set strip_len3 = (strip_len + 1) / 2 # Computation with existing value
Functions That Are Restricted in Computed Expressions: - Any function that creates instances (value providers, animations, etc.) when called - Examples: strip_length(), triangle(), smooth(), solid(), etc.
Note: These functions are allowed in set statements as they create the instance once, but they cannot be used inside arithmetic expressions that get wrapped in closures, as this would create new instances at each evaluation.
Advanced Computed Values~
# Complex expressions with multiple operations
set base_speed = 2.0
animation stream2 = comet_animation(
color=blue
tail_length=strip_len / 8 + 2 # Computed: eighth of strip + 2
speed=base_speed * 1.5 # Computed: base speed × 1.5
)
# Computed values in property assignments
stream1.position = strip_len / 2 # Center of strip
stream2.opacity = strip_len * 4 # Scale opacity with strip size
# Using mathematical functions in computed values
animation pulse = pulsating_animation(
color=red
period=2s
)
pulse.opacity = abs(sine(strip_len) * 128 + 127) # Sine wave opacity
pulse.position = max(0, min(strip_len - 1, round(strip_len / 2))) # Clamped center position
Supported Operations: - Addition: + - Subtraction: - - Multiplication: * - Division: / - Parentheses for grouping: (expression)
Mathematical Functions: The following mathematical functions are available in computed parameters and are automatically detected by the transpiler:
| Function | Description | Parameters | Return Value |
|---|---|---|---|
min(a, b, ...) | Returns the minimum value | Two or more numbers | Minimum value |
max(a, b, ...) | Returns the maximum value | Two or more numbers | Maximum value |
abs(x) | Returns the absolute value | One number | Absolute value |
round(x) | Rounds to nearest integer | One number | Rounded integer |
sqrt(x) | Returns the square root | One number | Square root (scaled for integers) |
scale(v, from_min, from_max, to_min, to_max) | Scales value from one range to another | Value and range parameters | Scaled integer |
sin(angle) | Returns sine of angle | Angle in 0-255 range (0-360°) | Sine value in -255 to 255 range |
cos(angle) | Returns cosine of angle | Angle in 0-255 range (0-360°) | Cosine value in -255 to 255 range |
Mathematical Function Examples:
# Basic math functions
set strip_len = strip_length()
animation test = pulsating_animation(color=red, period=2s)
# Absolute value for ensuring positive results
test.opacity = abs(strip_len - 200)
# Min/max for clamping values
test.position = max(0, min(strip_len - 1, 15)) # Clamp position to valid range
# Rounding for integer positions
test.position = round(strip_len / 2.5)
# Square root for non-linear scaling
test.brightness = sqrt(strip_len * 4) # Non-linear brightness based on strip size
# Scaling values between ranges
test.opacity = scale(strip_len, 10, 60, 50, 255) # Scale strip length to opacity range
# Trigonometric functions for wave patterns
set angle = 128 # 180 degrees in 0-255 range
test.opacity = sin(angle) + 128 # Mathematical sine function (not oscillator)
test.brightness = cos(angle) + 128 # Mathematical cosine function (not oscillator)
# Complex expressions combining multiple functions
test.position = max(0, round(abs(sin(strip_len * 2)) * (strip_len - 1) / 255))
test.opacity = min(255, max(50, scale(sqrt(strip_len), 0, 16, 100, 255)))
Special Notes: - Integer Optimization: sqrt() function automatically handles integer scaling for 0-255 range values - Trigonometric Range: sin() and cos() use 0-255 input range (mapped to 0-360°) and return -255 to 255 output range - Automatic Detection: Mathematical functions are automatically detected at transpile time using dynamic introspection - Closure Context: In computed parameters, mathematical functions are called as animation._math.<function>() in the generated closure context
How It Works: When the DSL detects arithmetic expressions containing value providers, variable references, or mathematical functions, it automatically creates closure functions that capture the computation. These closures are called with (self, param_name, time_ms) parameters, allowing the computation to be re-evaluated dynamically as needed. Mathematical functions are automatically prefixed with animation._math. in the closure context to access the ClosureValueProvider's mathematical methods.
User Functions in Computed Parameters: User-defined functions can also be used in computed parameter expressions, providing powerful custom effects:
# Simple user function in computed parameter
animation base = solid(color=blue)
base.opacity = rand_demo()
# User functions mixed with math operations
animation dynamic = solid(
color=purple
opacity=max(50, min(255, rand_demo() + 100))
)
User Functions~
User functions are custom Berry functions that can be called from computed parameters. They provide dynamic values that change over time.
Available User Functions: - rand_demo() - Returns random values for demonstration purposes
Usage in Computed Parameters:
# Simple user function
animation.opacity = rand_demo()
# User function with math operations
animation.opacity = max(100, rand_demo())
# User function in arithmetic expressions
animation.opacity = abs(rand_demo() - 128) + 64
Available User Functions: The following user functions are available by default (see User Functions Guide for details):
| Function | Parameters | Description |
|---|---|---|
rand_demo() | none | Returns a random value (0-255) for demonstration |
User Function Behavior: - User functions are automatically detected by the transpiler - They receive self.engine as the first parameter in closure context - They can be mixed with mathematical functions and arithmetic operations - The entire expression is wrapped in a single efficient closure
Sequences~
Sequences orchestrate multiple animations with timing control. The DSL supports two syntaxes for sequences with repeat functionality:
Basic Sequence Syntax~
sequence demo {
play red_animation for 3s
wait 1s
play blue_animation for 2s
repeat 3 times {
play flash_effect for 200ms
wait 300ms
}
play final_animation
}
Repeat Sequence Syntax~
For sequences that are primarily repeating patterns, you can use the alternative syntax:
# Option 1: Traditional syntax with repeat sub-sequence
sequence cylon_eye {
repeat forever {
play red_eye for 3s
red_eye.pos = triangle_val
play red_eye for 3s
red_eye.pos = cosine_val
eye_color.next = 1
}
}
# Option 2: Alternative syntax - sequence with repeat modifier
sequence cylon_eye repeat forever {
play red_eye for 3s
red_eye.pos = triangle_val
play red_eye for 3s
red_eye.pos = cosine_val
eye_color.next = 1
}
# Option 3: Parametric repeat count
sequence rainbow_cycle repeat palette.size times {
play animation for 1s
colors.next = 1
}
Note: All syntaxes are functionally equivalent. The repeat count can be a literal number, variable, or dynamic expression that evaluates at runtime.
Sequence Statements~
Play Statement~
play animation_name # Play indefinitely
play animation_name for 5s # Play for specific duration
play animation_name for duration_var # Play for variable duration
Wait Statement~
wait 1s # Wait for 1 second
wait 500ms # Wait for 500 milliseconds
wait duration_var # Wait for variable duration
Duration Support~
Both play and wait statements support flexible duration specifications:
Literal Time Values:
play animation for 5s # 5 seconds
play animation for 2000ms # 2000 milliseconds
play animation for 1m # 1 minute
Variable References:
set short_time = 2s
set long_time = 10s
sequence demo {
play animation for short_time # Use variable duration
wait long_time # Variables work in wait too
}
Value Providers (Dynamic Duration):
set dynamic_duration = triangle(min_value=1000, max_value=5000, period=10s)
sequence demo {
play animation for dynamic_duration # Duration changes over time
}
Examples:
# Cylon eye with variable duration
set eye_duration = 5s
sequence cylon_eye forever {
play red_eye for eye_duration # Use variable for consistent timing
red_eye.pos = triangle_val
play red_eye for eye_duration # Same duration for both phases
red_eye.pos = cosine_val
eye_color.next = 1
}
Repeat Statement~
Repeat statements create runtime sub-sequences that execute repeatedly:
repeat 3 times { # Repeat exactly 3 times
play animation for 1s
wait 500ms
}
repeat forever { # Repeat indefinitely until parent sequence stops
play animation for 1s
wait 500ms
}
repeat col1.palette_size times { # Parametric repeat count using property access
play animation for 1s
col1.next = 1
}
Repeat Count Types: - Literal numbers: repeat 5 times - fixed repeat count - Variables: repeat count_var times - using previously defined variables - Property access: repeat color_provider.palette_size times - dynamic values from object properties - Computed expressions: repeat strip_length() / 2 times - calculated repeat counts
Repeat Behavior: - Runtime Execution: Repeats are executed at runtime, not expanded at compile time - Dynamic Evaluation: Parametric repeat counts are evaluated when the sequence starts - Sub-sequences: Each repeat block creates a sub-sequence that manages its own iteration state - Nested Repeats: Supports nested repeats with multiplication (e.g., repeat 3 times { repeat 2 times { ... } } executes 6 times total) - Forever Loops: repeat forever continues until the parent sequence is stopped - Efficient: No memory overhead for large repeat counts
Assignment Statement~
Property assignments can be performed within sequences to dynamically modify animation parameters during playback:
sequence demo {
play red_eye for 3s
red_eye.pos = triangle_val # Change position to triangle oscillator
play red_eye for 3s
red_eye.pos = cosine_val # Change position to cosine oscillator
eye_color.next = 1 # Advance color cycle to next color
}
Assignment Semantics: - Assignments in sequences have exactly the same semantics as assignments outside sequences - They can assign static values, value providers, or computed expressions - Assignments are executed instantly when the sequence step is reached - The assignment is wrapped in a closure: def (engine) <assign_code> end
Examples:
sequence dynamic_show {
play pulse_anim for 2s
pulse_anim.opacity = 128 # Set static opacity
play pulse_anim for 2s
pulse_anim.opacity = brightness # Use value provider
play pulse_anim for 2s
pulse_anim.color = next_color # Change color provider
play pulse_anim for 2s
}
# Assignments work in repeat blocks too
sequence cylon_eye {
repeat 3 times {
play red_eye for 1s
red_eye.pos = triangle_val # Change oscillator pattern
play red_eye for 1s
red_eye.pos = cosine_val # Change back
eye_color.next = 1 # Advance color
}
}
If Statement~
Conditional execution statements that run their body 0 or 1 times based on a boolean condition:
if condition { # Execute if condition is true (non-zero)
play animation for 1s
wait 500ms
}
Condition Types: - Static values: if true { ... }, if false { ... }, if 5 { ... } - Variables: if flag { ... } - using previously defined variables - Template parameters: if self.enabled { ... } - dynamic values from template parameters - Computed expressions: if strip_length() > 30 { ... } - calculated conditions
If Behavior: - Boolean Coercion: All conditions are wrapped with bool() to ensure 0 or 1 iterations - Static Optimization: Static conditions (literals) are evaluated at compile time without closures - Dynamic Evaluation: Dynamic conditions (variables, parameters) are wrapped in closures - Conditional Gate: Useful for enabling/disabling parts of sequences based on flags
Examples:
# Static condition
sequence demo {
if true {
play animation for 1s
}
}
# Template parameter condition
template animation configurable {
param enable_effect type bool default true
color my_red = 0xFF0000
animation solid_red = solid(color=my_red)
sequence main repeat forever {
if enable_effect {
play solid_red for 1s
}
}
run main
}
# Variable condition
set flag = true
sequence conditional {
if flag {
play animation for 2s
}
}
# Bidirectional animation with flags
template animation shutter_bidir {
param ascending type bool default true
param descending type bool default true
sequence shutter_seq repeat forever {
if ascending {
play shutter_lr for 2s
}
if descending {
play shutter_rl for 2s
}
}
run shutter_seq
}
Comparison with Repeat: - if condition { ... } - Runs 0 or 1 times (boolean gate) - repeat count times { ... } - Runs exactly count times (iteration)
Restart Statements~
Restart statements allow you to restart value providers and animations from their initial state during sequence execution:
restart value_provider_name # Restart value provider from beginning
restart animation_name # Restart animation from beginning
Restart Statement: - Restarts value providers (oscillators, color cycles, etc.) from their initial state - Restarts animations from their beginning state - Calls the start() method on the value provider or animation, which resets the time origin only if the object was already started previously - Useful for synchronizing oscillators, restarting color cycles, or restarting complex animations
Timing Behavior: - The start() method only resets the time origin if self.start_time is not nil (i.e., the object was already started) - For fresh objects, the first call to update(), render(), or produce_value() initializes the time reference - This prevents premature time initialization and ensures proper timing behavior
Examples:
# Restart oscillators for synchronized movement
sequence sync_demo {
play wave_anim for 3s
restart position_osc # Restart oscillator time origin
play wave_anim for 3s
}
# Restart animations for clean transitions
sequence clean_transitions {
play comet_anim for 5s
restart comet_anim # Restart from beginning position
play comet_anim for 5s
}
Template Animations~
Template animations provide a powerful way to create reusable, parameterized animation classes. They allow you to define animation blueprints that can be instantiated multiple times with different parameters, promoting code reuse and maintainability.
Template-Only Files: DSL files containing only template animation definitions transpile to pure Berry classes without engine initialization or execution code. This allows template animations to be used as reusable animation libraries.
Template Animation Definition~
Template animations are defined using the template animation keywords followed by a parameter block and body:
template animation shutter_effect {
param colors type palette nillable true
param duration type time min 0 max 3600 default 5 nillable false
set strip_len = strip_length()
set shutter_size = sawtooth(min_value = 0, max_value = strip_len, duration = duration)
color col = color_cycle(colors=colors, period=0)
animation shutter = beacon_animation(
color = col
pos = strip_len / 2
beacon_size = shutter_size
priority = 5
)
sequence seq repeat forever {
restart shutter_size
play shutter for duration
col.next = 1
}
run seq
}
# Use the template animation
palette rainbow = [red, orange, yellow, green, blue, indigo, white]
animation my_shutter = shutter_effect(colors=rainbow, duration=2s)
run my_shutter
Code Generation: Template animations generate Berry classes extending engine_proxy:
class shutter_effect_animation : animation.engine_proxy
static var PARAMS = animation.enc_params({
"colors": {"type": "palette"},
"duration": {"type": "time", "min": 0, "max": 3600, "default": 5}
})
def init(engine)
super(self).init(engine)
# Generated code with self.colors and self.duration references
self.add(seq_)
end
end
Parameter Constraints: Template animation parameters support constraints: - type - Parameter type (palette, time, int, color, etc.) - min - Minimum value (for numeric types) - max - Maximum value (for numeric types) - default - Default value - nillable - Whether parameter can be nil (true/false)
Implicit Parameters: Template animations automatically inherit parameters from the engine_proxy class hierarchy. These parameters are available without explicit declaration and can be used directly in your template animation body:
# These parameters are implicitly available in all template animations:
param id type string default "animation"
param priority type int default 10
param duration type int default 0
param loop type bool default false
param opacity type int default 255
param color type int default 0
param is_running type bool default false
Example using implicit parameters:
template animation fade_effect {
param colors type palette
# 'duration' is an implicit parameter - no need to declare it
set oscillator = sawtooth(min_value=0, max_value=255, duration=duration)
color col = color_cycle(colors=colors, period=0)
animation test = solid(color=col)
# 'opacity' is also implicit
test.opacity = oscillator
run test
}
# When instantiating, you can set implicit parameters
animation my_fade = fade_effect(colors=rainbow)
my_fade.duration = 5000 # Set the implicit duration parameter
my_fade.opacity = 200 # Set the implicit opacity parameter
Notes on Implicit Parameters: - Implicit parameters can be overridden by explicit declarations if needed - They follow the same constraint rules as explicit parameters - They are accessed as self.<param> within the template body - All implicit parameters come from the Animation and ParameterizedObject base classes
Key Features: - Generates reusable animation classes extending engine_proxy - Parameters accessed as self.<param> within the template body - Uses self.add() to add child animations - Can be instantiated multiple times with different parameters - Supports parameter constraints (type, min, max, default, nillable)
Template Parameter Validation~
The DSL transpiler provides comprehensive validation for template parameters to ensure code quality and catch errors early:
Parameter Name Validation: - Duplicate Detection: Prevents using the same parameter name twice - Reserved Keywords: Prevents conflicts with Berry keywords (animation, color, def, etc.) - Built-in Colors: Prevents conflicts with predefined color names (red, blue, etc.)
template bad_example {
param color type color # ❌ Error: conflicts with built-in color
param animation type number # ❌ Error: conflicts with reserved keyword
param my_param type color
param my_param type number # ❌ Error: duplicate parameter name
}
Type Annotation Validation:
Valid parameter types for static var PARAMS and template parameters:
| Type | Description | Synonym For | Example |
|---|---|---|---|
int | Integer values | - | {"type": "int", "default": 100} |
bool | Boolean values | - | {"type": "bool", "default": false} |
string | String values | - | {"type": "string", "default": "name"} |
bytes | Byte buffers (palettes) | - | {"type": "bytes", "default": bytes("FF0000")} |
function | Functions/closures | - | {"type": "function", "default": nil} |
animation | Animation instances | - | Symbol table tracking |
value_provider | Value provider instances | - | Symbol table tracking |
number | Generic numeric type | - | Numeric constraints only |
any | Any type (no validation) | - | {"type": "any", "default": nil} |
color | Color values | int | {"type": "color", "default": 0xFFFF0000} |
palette | Palette definitions | bytes | {"type": "palette", "default": bytes(...)} |
time | Time values (ms) | int | {"type": "time", "default": 5000} |
percentage | Percentage (0-255) | int | {"type": "percentage", "default": 128} |
Note: Types color, palette, time, and percentage are user-friendly synonyms that map to their base types during validation.
template type_example {
param my_color type invalid_type # ❌ Error: invalid type annotation
param valid_color type color # ✅ Valid type annotation
}
Parameter Usage Validation: The transpiler generates warnings (not errors) for unused parameters:
template unused_example {
param used_color type color
param unused_param type number # ⚠️ Warning: parameter never used
animation test = solid(color=used_color)
run test
}
Validation Benefits: - Early Error Detection: Catches parameter issues at compile time - Clear Error Messages: Provides helpful suggestions for fixing issues - Code Quality: Encourages proper parameter naming and usage - Warnings vs Errors: Unused parameters generate warnings that don't prevent compilation
Execution Statements~
Execute animations or sequences:
run animation_name # Run an animation
run sequence_name # Run a sequence
Debug and Logging~
Log debug messages during animation execution:
log("Debug message") # Log message at level 3
log("Animation started") # Useful for debugging sequences
log("Color changed to red") # Track animation state changes
Log Function Behavior: - Accepts string literals only (no variables or expressions) - Transpiles to Berry log(f"message", 3) - Messages are logged at level 3 for debugging purposes - Can be used anywhere in DSL code: standalone, in sequences, etc.
Operators and Expressions~
Arithmetic Operators~
+ # Addition
- # Subtraction (also unary minus)
* # Multiplication
/ # Division
% # Modulo
Comparison Operators~
== # Equal to
!= # Not equal to
< # Less than
<= # Less than or equal
> # Greater than
>= # Greater than or equal
Logical Operators~
&& # Logical AND
|| # Logical OR
! # Logical NOT
Assignment Operators~
= # Simple assignment
Function Calls~
Functions use named parameter syntax with flexible formatting:
# Single line (commas required)
function_name(param1=value1, param2=value2)
# Multi-line (commas optional when parameters are on separate lines)
function_name(
param1=value1
param2=value2
param3=value3
)
# Mixed syntax (both commas and newlines work)
function_name(
param1=value1, param2=value2
param3=value3
)
Examples:
# Traditional single-line syntax
solid(color=red)
pulsating_animation(color=blue, period=2s)
# New multi-line syntax (no commas needed)
pulsating_animation(
color=blue
period=2s
brightness=255
)
# Mixed syntax
comet_animation(
color=stream_pattern, tail_length=15
speed=1.5s
priority=10
)
Nested Function Calls:
pulsating_animation(
color=solid(color=red)
period=smooth(
min_value=1000
max_value=3000
period=10s
)
)
Mathematical Functions in Computed Parameters: Mathematical functions can be used in computed parameter expressions and are automatically detected by the transpiler:
animation wave = pulsating_animation(
color=blue
period=2s
)
# Mathematical functions in property assignments
wave.opacity = abs(sine(strip_length()) - 128) # Sine wave opacity
wave.position = max(0, min(strip_length() - 1, 15)) # Clamped position
wave.brightness = round(sqrt(strip_length()) * 4) # Non-linear scaling
Supported Classes~
Value Providers~
Value providers create dynamic values that change over time:
| Function | Description |
|---|---|
static_value | Returns a constant value |
strip_length | Returns the LED strip length in pixels |
oscillator_value | Oscillates between min/max values with various waveforms |
Oscillator Aliases: | Function | Description | |----------|-------------| | triangle | Triangle wave oscillation (alias for oscillator with triangle waveform) | | smooth | Smooth cosine wave (alias for oscillator with smooth waveform) | | cosine_osc | Cosine wave oscillation (alias for smooth - cosine waveform) | | sine_osc | Pure sine wave oscillation (alias for oscillator with sine waveform) | | linear | Linear progression (alias for oscillator with linear waveform) | | ramp | Sawtooth wave (alias for oscillator with ramp waveform) | | sawtooth | Sawtooth wave (alias for ramp) | | square | Square wave oscillation | | ease_in | Quadratic ease-in (starts slow, accelerates) | | ease_out | Quadratic ease-out (starts fast, decelerates) | | elastic | Elastic easing with spring-like overshoot | | bounce | Bounce easing like a ball with decreasing amplitude |
# Direct oscillator usage
triangle(min_value=0, max_value=255, period=2s) # Triangle wave
smooth(min_value=50, max_value=200, period=3s) # Smooth cosine
cosine_osc(min_value=3, max_value=1, period=5s) # Cosine wave (alias for smooth)
sine_osc(min_value=0, max_value=255, period=2s) # Pure sine wave
linear(min_value=0, max_value=100, period=1s) # Linear progression
ramp(min_value=0, max_value=255, period=2s) # Sawtooth wave
square(min_value=0, max_value=255, period=1s) # Square wave
ease_in(min_value=0, max_value=255, period=2s) # Quadratic ease-in
ease_out(min_value=0, max_value=255, period=2s) # Quadratic ease-out
elastic(min_value=0, max_value=255, period=2s) # Elastic spring effect
bounce(min_value=0, max_value=255, period=2s) # Bouncing ball effect
# Value providers can be assigned to variables
set brightness_oscillator = smooth(min_value=50, max_value=255, period=3s)
set position_sweep = triangle(min_value=0, max_value=29, period=5s)
set elastic_movement = elastic(min_value=0, max_value=30, period=4s)
set sine_wave = sine_osc(min_value=0, max_value=255, period=2s)
set cosine_wave = cosine_osc(min_value=50, max_value=200, period=3s)
set strip_len = strip_length() # Get the current strip length
Color Providers~
Color providers create dynamic colors that change over time:
| Function | Description |
|---|---|
static_color | Solid color with optional dynamic opacity |
color_cycle | Cycles through a palette of colors |
rich_palette | Advanced palette-based color cycling with smooth transitions |
composite_color | Combines multiple color providers |
breathe_color | Breathing/pulsing color effect with brightness modulation |
pulsating_color | Fast pulsing color effect (alias for breathe_color with curve_factor=1) |
Animation Classes~
Animation classes create visual effects on LED strips:
| Function | Description |
|---|---|
solid | Solid color fill |
pulsating_animation | Pulsing brightness effect |
beacon_animation | Positioned pulse effect |
crenel_animation | Square wave pulse at specific position |
breathe_animation | Breathing/fading effect |
comet_animation | Moving comet with trailing tail |
fire_animation | Realistic fire simulation |
twinkle_animation | Twinkling stars effect |
gradient_animation | Color gradient effects |
noise_animation | Perlin noise-based patterns |
wave_animation | Wave propagation effects |
rich_palette_animation | Palette-based color cycling |
palette_wave_animation | Wave patterns using palettes |
palette_gradient_animation | Gradient patterns using palettes |
palette_meter_animation | Meter/bar patterns using palettes |
Error Handling~
Validation Rules~
The DSL performs comprehensive validation at compile time:
- Reserved Names: Cannot redefine keywords or predefined colors
- Class Existence: Animation and color provider factory functions must exist
- Parameter Validation: Function parameters must exist and be valid for the specific class
- Type Checking: Values must match expected types
- Reference Resolution: All referenced identifiers must be defined
Compile-Time Validation~
The DSL validates class and parameter existence during compilation, catching errors before execution:
- Factory Functions: Verifies that animation and color provider factories exist in the animation module
- Parameter Names: Checks that all named parameters are valid for the specific class
- Parameter Constraints: Validates parameter values against defined constraints (min/max, enums, types)
- Nested Validation: Validates parameters in nested function calls and value providers
- Property Assignment Validation: Validates parameter names in property assignments (e.g.,
animation.invalid_param = value) against the actual class parameters - Object Reference Validation: Validates that referenced objects exist in
runstatements and sequenceplaystatements
Common Errors~
# Invalid: Redefining predefined color
color red = 0x800000 # Error: Cannot redefine 'red'
# Invalid: Unknown parameter in constructor
animation bad = pulsating_animation(invalid_param=123) # Error: Unknown parameter
# Invalid: Unknown parameter in property assignment
animation pulse = pulsating_animation(color=red, period=2s)
pulse.wrong_arg = 15 # Error: Parameter 'wrong_arg' not valid for PulseAnimation
# Invalid: Undefined reference in color definition
animation ref = solid(color=undefined_color) # Error: Undefined reference
# Invalid: Undefined reference in run statement
run undefined_animation # Error: Undefined reference 'undefined_animation' in run
# Invalid: Undefined reference in sequence
sequence demo {
play undefined_animation for 5s # Error: Undefined reference 'undefined_animation' in sequence play
}
# Valid alternatives
color my_red = 0x800000 # OK: Different name
animation good = pulsating_animation(color=red, period=2s) # OK: Valid parameters
good.priority = 10 # OK: Valid parameter assignment
Formal Grammar (EBNF)~
(* Animation DSL Grammar *)
program = { statement } ;
statement = import_stmt
| config_stmt
| definition
| property_assignment
| sequence
| template_def
| external_stmt
| execution_stmt ;
(* Import and Configuration *)
import_stmt = "import" identifier ;
config_stmt = variable_assignment ;
external_stmt = "extern" "function" identifier ;
(* strip_config = "strip" "length" number ; -- TEMPORARILY DISABLED *)
variable_assignment = "set" identifier "=" expression ;
(* Definitions *)
definition = color_def | palette_def | animation_def | template_animation_def ;
color_def = "color" identifier "=" color_expression ;
palette_def = "palette" identifier "=" palette_array ;
animation_def = "animation" identifier "=" animation_expression ;
template_animation_def = "template" "animation" identifier "{" template_body "}" ;
(* Property Assignments *)
property_assignment = identifier "." identifier "=" expression ;
(* Sequences *)
sequence = "sequence" identifier [ "repeat" ( expression "times" | "forever" ) ] "{" sequence_body "}" ;
sequence_body = { sequence_statement } ;
sequence_statement = play_stmt | wait_stmt | repeat_stmt | if_stmt | sequence_assignment | restart_stmt ;
play_stmt = "play" identifier [ "for" time_expression ] ;
wait_stmt = "wait" time_expression ;
repeat_stmt = "repeat" ( expression "times" | "forever" ) "{" sequence_body "}" ;
if_stmt = "if" expression "{" sequence_body "}" ;
sequence_assignment = identifier "." identifier "=" expression ;
restart_stmt = "restart" identifier ;
(* Template Animations *)
template_animation_def = "template" "animation" identifier "{" template_body "}" ;
template_body = { template_statement } ;
template_statement = param_decl | color_def | palette_def | animation_def | property_assignment | sequence_def | execution_stmt ;
param_decl = "param" identifier [ "type" identifier ] [ constraint_list ] ;
constraint_list = ( "min" number | "max" number | "default" expression | "nillable" boolean ) { constraint_list } ;
(* Execution *)
execution_stmt = "run" identifier ;
(* Expressions *)
expression = logical_or_expr ;
logical_or_expr = logical_and_expr { "||" logical_and_expr } ;
logical_and_expr = equality_expr { "&&" equality_expr } ;
equality_expr = relational_expr { ( "==" | "!=" ) relational_expr } ;
relational_expr = additive_expr { ( "<" | "<=" | ">" | ">=" ) additive_expr } ;
additive_expr = multiplicative_expr { ( "+" | "-" ) multiplicative_expr } ;
multiplicative_expr = unary_expr { ( "*" | "/" | "%" ) unary_expr } ;
unary_expr = ( "!" | "-" | "+" ) unary_expr | primary_expr ;
primary_expr = literal | identifier | function_call | "(" expression ")" ;
(* Color Expressions *)
color_expression = hex_color | named_color | identifier ;
hex_color = "0x" hex_digit{6} | "0x" hex_digit{8} ;
named_color = color_name ;
(* Animation Expressions *)
animation_expression = function_call | identifier ;
(* Palette Arrays *)
palette_array = "[" palette_entry { "," palette_entry } "]" ;
palette_entry = "(" number "," color_expression ")" ;
(* Function Calls *)
function_call = identifier "(" [ named_argument_list ] ")" ;
named_argument_list = named_argument { "," named_argument } ;
named_argument = identifier "=" expression ;
(* Time Expressions *)
time_expression = time_literal ;
time_literal = number time_unit ;
time_unit = "ms" | "s" | "m" | "h" ;
(* Literals *)
literal = number | string | color_expression | time_expression | percentage | boolean ;
number = integer | real ;
integer = [ "-" ] digit { digit } ;
real = [ "-" ] digit { digit } "." digit { digit } ;
string = '"' { string_char } '"' | "'" { string_char } "'" ;
percentage = number "%" ;
boolean = "true" | "false" ;
(* Identifiers *)
identifier = ( letter | "_" ) { letter | digit | "_" } ;
color_name = "red" | "green" | "blue" | "white" | "black" | "yellow"
| "orange" | "purple" | "pink" | "cyan" | "magenta" | "gray"
| "silver" | "gold" | "brown" | "lime" | "navy" | "olive"
| "maroon" | "teal" | "aqua" | "fuchsia" | "transparent" ;
(* Character Classes *)
letter = "a" .. "z" | "A" .. "Z" ;
digit = "0" .. "9" ;
hex_digit = digit | "A" .. "F" | "a" .. "f" ;
string_char = (* any character except quote *) ;
(* Comments and Whitespace *)
comment = "#" { (* any character except newline *) } newline ;
whitespace = " " | "\t" | "\r" | "\n" ;
newline = "\n" | "\r\n" ;
Flexible Parameter Syntax~
The DSL supports flexible parameter syntax that makes multi-line function calls more readable:
Traditional Syntax (Commas Required)~
animation stream = comet_animation(color=red, tail_length=15, speed=1.5s, priority=10)
New Multi-Line Syntax (Commas Optional)~
animation stream = comet_animation(
color=red
tail_length=15
speed=1.5s
priority=10
)
Mixed Syntax (Both Supported)~
animation stream = comet_animation(
color=red, tail_length=15
speed=1.5s
priority=10
)
Rules~
- Single line: Commas are required between parameters
- Multi-line: Commas are optional when parameters are on separate lines
- Mixed: You can use both commas and newlines as separators
- Comments: Inline comments work with both syntaxes
This applies to: - Animation function calls - Color provider function calls
- Value provider function calls - Palette entries
Language Features Summary~
✅ Currently Implemented~
- Comments with preservation
- Strip configuration (optional)
- Color definitions (hex and named)
- Palette definitions with VRGB conversion
- Animation definitions with named parameters
- Property assignments
- Basic sequences (play, wait, repeat, if)
- Conditional execution:
ifstatement for boolean-based conditional execution - Variable assignments with type conversion
- Reserved name validation
- Parameter validation at compile time
- Execution statements
- Template animations: Reusable animation classes with parameters extending
engine_proxy - User-defined functions (with engine-first parameter pattern) - see User Functions Guide
- External function declarations:
externkeyword to declare Berry functions defined inberryblocks for DSL use - User functions in computed parameters: User functions can be used in arithmetic expressions alongside mathematical functions
- Flexible parameter syntax: Commas optional when parameters are on separate lines
- Computed values: Arithmetic expressions with value providers automatically create closures
- Mathematical functions:
min,max,abs,round,sqrt,scale,sine,cosinein computed parameters
🚧 Partially Implemented~
- Expression evaluation (basic support)
- Nested function calls (working but limited)
- Error recovery (basic error reporting)
❌ Planned Features~
- Advanced control flow (else, elif, choose random)
- Event system and handlers
- Variable references with $ syntax
- Spatial operations and zones
- 2D matrix support
This reference provides the complete syntax specification for the Animation DSL language as currently implemented and planned for future development.