# Printing Effects

The plugin reacts to several events to display printing effects. For each of these effects, they have similar settings:

* **Enable** Whether the effect will run or not
* **Effect** One of the available [effects](#effects)
* **Colour** The primary colour to run the effect. Note this is ignored in some effects.
* **Delay** The length of time to wait between each frame of the effect.

Some events also have some specific settings, these are detailed alongside them.

## Events

* Startup
* Printer Connected/Idle
* Printer Disconnected
* Print Success
  * This effect has configurable 'Return to idle' time in seconds. Set to 0 to disable returning to idle.
* Print Failed
* Print Paused
* Printing
  * This effect will override the print progress effect.

## Effects

All the standard effects available, with fancy visualisations!

### Solid Colour

Sets all LEDs to one colour, forever.

![](https://2191022671-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FxmQFFKyVwk9HSzrc4eAR%2Fuploads%2Fgit-blob-db6528660a98d38a24c1fbf5d48478f76f4b06fd%2Fsolidcolour.gif?alt=media)

### Colour Wipe

Wipes colour across the strip pixel by pixel, then clears it pixel by pixel.

![](https://2191022671-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FxmQFFKyVwk9HSzrc4eAR%2Fuploads%2Fgit-blob-555a6b6006715a3da0fd079476f84f2cb0f5b0ea%2Fcolorwipe.gif?alt=media)

### Colour Wipe V2

Wipes colour pixel by pixel, as above, but to clear it turns around and heads backwards.

![](https://github.com/cp2004/OctoPrint-WS281x_LED_Status/blob/0.8.x/docs/.gitbook/assets/colorwipe2.gif)

### Pulse

Fades brightness up and down. Looks better in real life than the visualisation below!

![](https://2191022671-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FxmQFFKyVwk9HSzrc4eAR%2Fuploads%2Fgit-blob-282e1d3fa46384eae9ba77333d89c1996986b009%2Fpulse.gif?alt=media)

### Bounce

Sends a pulse of light bouncing from one side of your strip to the other.

![](https://2191022671-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FxmQFFKyVwk9HSzrc4eAR%2Fuploads%2Fgit-blob-513e4513cc2bb0b6502b0372348b7b791cc85b47%2Fbounce.gif?alt=media)

### Solo Bounce

Sends just a single pixel from one side to the other, bouncing about.

![](https://2191022671-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FxmQFFKyVwk9HSzrc4eAR%2Fuploads%2Fgit-blob-f04ab81da81a989b5ebc900d9c991a7cf94986fb%2Fsolobounce.gif?alt=media)

### Rainbow

Cycles all the LEDs through the rainbow together.

![](https://2191022671-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FxmQFFKyVwk9HSzrc4eAR%2Fuploads%2Fgit-blob-8ddbc5f4836eee829259fb2b87486f19b5ff366e%2Frainbow.gif?alt=media)

### Rainbow Cycle

Rainbow that cycles across the strip, so a full rainbow is across the whole strip at once.

![](https://2191022671-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FxmQFFKyVwk9HSzrc4eAR%2Fuploads%2Fgit-blob-4f4ae53caddc577d1586f3639e1d43d6611f31bf%2Frainbowcycle.gif?alt=media)

### Crossover

Two pixels bouncing in opposite directions, crossing over in the middle.

![](https://2191022671-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FxmQFFKyVwk9HSzrc4eAR%2Fuploads%2Fgit-blob-1b5c6ea16cebec5d1b2b7c99e0a8bc707db8dd0b%2Fcrossover.gif?alt=media)

### Random

Sets all LEDs to a random colour, then changes a random pixel, to a new random colour

![](https://2191022671-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FxmQFFKyVwk9HSzrc4eAR%2Fuploads%2Fgit-blob-6cb22e6d2fd5f8480935765e718d777f9c3b59f2%2Frandom.gif?alt=media)

### Bouncy Balls

A physics based effect, simulating 2 balls bouncing up and down. Looks great on longer strips (and shorter ones too...!).

Unfortunately creating the simulation for this effect didn't work, so is unavailable for now. Sorry!
