# 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 Paused
* Print Failed
* 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://108540498-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-MSiApSchMtrWLO7ruS3%2Fsync%2Fdb6528660a98d38a24c1fbf5d48478f76f4b06fd.gif?generation=1612481673317671\&alt=media)

### Colour Wipe

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

![](https://108540498-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-MSiApSchMtrWLO7ruS3%2Fsync%2F555a6b6006715a3da0fd079476f84f2cb0f5b0ea.gif?generation=1612463146053970\&alt=media)

### Colour Wipe V2

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

![](https://108540498-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-MSiApSchMtrWLO7ruS3%2F-MSihgSFPyGMlxtABU_P%2F-MSipafQuWzw8UZL8AAW%2Fcolor_wipe_2.gif?alt=media\&token=01ae3d05-e8f1-4495-b39e-1dc46552d2d7)

### Pulse

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

![](https://108540498-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-MSiApSchMtrWLO7ruS3%2Fsync%2F282e1d3fa46384eae9ba77333d89c1996986b009.gif?generation=1612481672513953\&alt=media)

### Bounce

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

![](https://108540498-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-MSiApSchMtrWLO7ruS3%2Fsync%2F513e4513cc2bb0b6502b0372348b7b791cc85b47.gif?generation=1612481675702590\&alt=media)

### Solo Bounce

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

![](https://108540498-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-MSiApSchMtrWLO7ruS3%2F-MSihgSFPyGMlxtABU_P%2F-MSipafXbCg1rY0pAfPF%2Fsolo_bounce.gif?alt=media\&token=2d363c44-bf30-4548-84e3-1412c6d96349)

### Rainbow

Cycles all the LEDs through the rainbow together.

![](https://108540498-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-MSiApSchMtrWLO7ruS3%2Fsync%2F8ddbc5f4836eee829259fb2b87486f19b5ff366e.gif?generation=1612463147307936\&alt=media)

### Rainbow Cycle

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

![](https://108540498-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-MSiApSchMtrWLO7ruS3%2Fsync%2F4f4ae53caddc577d1586f3639e1d43d6611f31bf.gif?generation=1612481682845257\&alt=media)

### Crossover

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

![](https://108540498-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-MSiApSchMtrWLO7ruS3%2F-MSihgSFPyGMlxtABU_P%2F-MSipafR9CfO9kE7HpVa%2Fcrossover.gif?alt=media\&token=0bf7ac94-cefc-4ebc-a49f-25a664b82577)

### Random

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

![](https://108540498-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-MSiApSchMtrWLO7ruS3%2Fsync%2F6cb22e6d2fd5f8480935765e718d777f9c3b59f2.gif?generation=1612481671420763\&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!


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://cp2004.gitbook.io/ws281x-led-status/devel/configuration/printing-effects.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
