Effects Reference
The NeoRing comes with 26 built-in effects via the RobotechPixel library. Each effect is a single function call that handles all animation timing internally.
Usage Pattern
All effects follow the same pattern:
void loop() {
fxEffectName(px, millis(), /* optional parameters */);
px.show();
}
Orbit & Trail Effects
Pixel Walk
A single pixel walks around each ring with configurable colors.
fxPixelWalk(px, now, innerColor=0x00FF00, outerColor=0x0000FF, wait=40)
Radar Sweep
A bright dot sweeps around the ring with a fading tail, like a radar display.
fxRadarSweep(px, now, color=0x00FF40, tailLen=12, wait=30)
Dual Spin
Inner and outer rings spin in opposite directions with colored arcs.
fxDualSpin(px, now, innerColor=0xFF00C8, outerColor=0x00C8FF, arcLen=10, wait=40)
Comets
Glowing comets with sparkling tails orbit the rings.
fxComets(px, now, cometColor=0x00C8FF, tailLen=20, sparkleColor=0x008080, numSparkles=0, wait=25)
Comet Crosser
A comet crosses between inner and outer rings with color blending.
fxCometCrosser(px, now, cometColor=0xFF6400, sparkleColor=0x008080, numSparkles=1, tailLen=18, cometSpeed=1.5f, blendSpeed=0.025f, wait=20)
Orbit
Multiple dots orbit with fading tails in a planetary motion pattern.
fxOrbit(px, now, numDots=4, tailLen=6, wait=15)
Meteor Shower
Three colored meteors streak around the rings with fading trails.
fxMeteorShower(px, now, color1=0xFFFFFF, color2=0xC8C8FF, color3=0xFFC8C8, fadeFactor=180, wait=25)
Scan & Chase Effects
Cylon
A red scanner sweeps back and forth, inspired by Battlestar Galactica.
fxCylon(px, now, color=0xFF0000, width=8, wait=30)
Theater Chase
Classic theater marquee chase pattern with configurable color.
fxTheaterChase(px, now, color=0xFFB400, wait=80)
Sparkle & Particle Effects
Sparkle
Random LEDs flash on and slowly fade out, creating a twinkling effect.
fxSparkle(px, now, numSparks=8, fadeFactor=200, wait=50)
Confetti
Random bursts of color scattered across all LEDs with gradual fade.
fxConfetti(px, now, fadeFactor=230, wait=30)
Sparks
Quick bright flashes that rapidly decay, like electrical sparks.
fxSparks(px, now, fadeFactor=220, wait=30)
Twinkle
Gentle twinkling stars with configurable color and density.
fxTwinkle(px, now, color=0xCCCCFF, maxStars=12, wait=20)
Pulse & Wave Effects
Color Cycle
All LEDs smoothly cycle through the full color spectrum together.
fxColorCycle(px, now, interval=1000)
Rainbow Wheel
A complete rainbow spread across the ring, continuously rotating.
fxRainbowWheel(px, now, wait=15)
Wave
Sinusoidal waves of color flow around the rings.
fxWave(px, now, innerColor=0x00FF80, outerColor=0x8000FF, speed=3, wait=20)
Ripple Pulse
Pulsing ripples radiate outward from inner to outer ring.
fxRipplePulse(px, now, innerColor=0xFF0055, outerColor=0x0055FF, wait=15)
Color Wipe
LEDs light up one by one in sequence, then wipe off.
fxColorWipe(px, now, color=0xFF0000, wait=30)
Breathing
All LEDs gently pulse in brightness like a breathing pattern.
fxBreathing(px, now, r=255, g=100, b=20, wait=20)
Heartbeat
A double-pulse heartbeat pattern with configurable color.
fxHeartbeat(px, now, color=0xFF0000, wait=10)
Simulation Effects
Fire Ring
Simulated fire effect with flickering flames around the ring.
fxFireRing(px, now, cooling=10, sparking=2, wait=30)
Starfield
Twinkling stars appear and fade across the rings.
fxStarfield(px, now, maxStars=10, wait=20)
Signal & Flash Effects
Strobe
Fast flashing strobe light with shifting hue.
fxStrobe(px, now, hueStep=32, wait=60)
Police
Alternating red and blue flashes like emergency lights.
fxPolice(px, now, color1=0xFF0000, color2=0x0000FF, wait=80)
Dial Effects
Clock
Displays hour, minute, and second hands using the LED ring as a clock face.
fxClockEffect(px, now, hourColor=0xFF0000, minuteColor=0x00FF00, secondColor=0x0000FF, hourWidth=3, clockOffset=12)
Meta
Auto Cycle
Automatically cycles through all effects at a configurable interval.
fxAutoCycle(px, now, interval=5000)
