> For the complete documentation index, see [llms.txt](https://documentation.hak5.org/packet-squirrel/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://documentation.hak5.org/packet-squirrel/payload-development/the-led-command.md).

# The LED Command

The multi-color RGB LED status indicator on the Packet Squirrel may be set using the `LED` command. It accepts either a combination of color and pattern, or a common payload state.

### LED COLORS

| COMMAND | Description                    |
| ------- | ------------------------------ |
| R       | Red                            |
| G       | Green                          |
| B       | Blue                           |
| Y       | Yellow (AKA Amber)             |
| C       | Cyan (AKA Light Blue)          |
| M       | Magenta (AKA Violet or Purple) |
| W       | White                          |

#### LED PATTERNS

| PATTERN  | Description                                             |
| -------- | ------------------------------------------------------- |
| SOLID    | *Default* No blink. Used if pattern argument is omitted |
| SLOW     | Symmetric 1000ms ON, 1000ms OFF, repeating              |
| FAST     | Symmetric 100ms ON, 100ms OFF, repeating                |
| VERYFAST | Symmetric 10ms ON, 10ms OFF, repeating                  |
| SINGLE   | 1 100ms blink(s) ON followed by 1 second OFF, repeating |
| DOUBLE   | 2 100ms blink(s) ON followed by 1 second OFF, repeating |
| TRIPLE   | 3 100ms blink(s) ON followed by 1 second OFF, repeating |
| QUAD     | 4 100ms blink(s) ON followed by 1 second OFF, repeating |
| QUIN     | 5 100ms blink(s) ON followed by 1 second OFF, repeating |
| ISINGLE  | 1 100ms blink(s) OFF followed by 1 second ON, repeating |
| IDOUBLE  | 2 100ms blink(s) OFF followed by 1 second ON, repeating |
| ITRIPLE  | 3 100ms blink(s) OFF followed by 1 second ON, repeating |
| IQUAD    | 4 100ms blink(s) OFF followed by 1 second ON, repeating |
| IQUIN    | 5 100ms blink(s) OFF followed by 1 second ON, repeating |
| SUCCESS  | 1000ms VERYFAST blink followed by SOLID                 |
| 1-10000  | Custom value in ms for continuous symmetric blinking    |

### LED STATE

These standardized LED States may be used to indicate common payload status. The basic LED states include `SETUP`, `FAIL`, `ATTACK`, `CLEANUP` and `FINISH`. Payload developers are encouraged to use these common payload states. Additional states including multi-staged attack patterns are shown in the table below.

| STATE    | COLOR PATTERN | Description                                   |
| -------- | ------------- | --------------------------------------------- |
| SETUP    | M SOLID       | Magenta solid                                 |
| FAIL     | R SLOW        | Red slow blink                                |
| FAIL1    | R SLOW        | Red slow blink                                |
| FAIL2    | R FAST        | Red fast blink                                |
| FAIL3    | R VERYFAST    | Red very fast blink                           |
| ATTACK   | Y SINGLE      | Yellow single blink                           |
| STAGE1   | Y SINGLE      | Yellow single blink                           |
| STAGE2   | Y DOUBLE      | Yellow double blink                           |
| STAGE3   | Y TRIPLE      | Yellow triple blink                           |
| STAGE4   | Y QUAD        | Yellow quadruple blink                        |
| STAGE5   | Y QUIN        | Yellow quintuple blink                        |
| SPECIAL  | C ISINGLE     | Cyan inverted single blink                    |
| SPECIAL1 | C ISINGLE     | Cyan inverted single blink                    |
| SPECIAL2 | C IDOUBLE     | Cyan inverted double blink                    |
| SPECIAL3 | C ITRIPLE     | Cyan inverted triple blink                    |
| SPECIAL4 | C IQUAD       | Cyan inverted quadriple blink                 |
| SPECIAL5 | C IQUIN       | Cyan inverted quintuple blink                 |
| CLEANUP  | W FAST        | White fast blink                              |
| FINISH   | G SUCCESS     | Green 1000ms VERYFAST blink followed by SOLID |

### EXAMPLES

```
LED Y SINGLE
```

```
LED M 500
```

```
LED SETUP
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## 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://documentation.hak5.org/packet-squirrel/payload-development/the-led-command.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.