# ThreeIconPlugin

The plugin is able to show three different icons.

Each icon can be set separately via the REST API.

If a Sprite Sheet is used the animation of an can be controlled via the REST API (see Sprite Sheet).

Show bitmap in one of the three slots. Supported are bitmap files (.bmp) with:

- 24 or 32 bits per pixel.
- 1 plane.
- No compression.

Note, if you are using _gimp_ to create bitmap files, please configure like:

- Compatibility options: Don't write color informations.
- Extended options: Select 24 bit per pixel.

## REST API

### Set icon

    POST {{ORIGIN}}/rest/api/v1/display/uid/<PLUGIN-UID>/bitmap/<ICON-ID>

    POST {{ORIGIN}}/rest/api/v1/display/alias/<PLUGIN-ALIAS>/bitmap/<ICON-ID>

- PLUGIN-UID: The plugin unique id.
- PLUGIN-ALIAS: The plugin alias name.
- ICON-ID: The id of the icon (starting with 0 from left).

### Clear icon

    POST {{ORIGIN}}/rest/api/v1/display/uid/<PLUGIN-UID>/bitmap/<ICON-ID>?clear=<STATE>

    POST {{ORIGIN}}/rest/api/v1/display/alias/<PLUGIN-ALIAS>/bitmap/<ICON-ID>?clear=<STATE>

- PLUGIN-UID: The plugin unique id.
- PLUGIN-ALIAS: The plugin alias name.
- ICON-ID: The id of the icon (starting with 0 from left).
- STATE: `true` or `false`

### Control animation (Sprite Sheet required)

    POST {{ORIGIN}}/rest/api/v1/display/uid/<PLUGIN-UID>/animation/<ICON-ID>?forward=<STATE>

    POST {{ORIGIN}}/rest/api/v1/display/alias/<PLUGIN-ALIAS>/animation/<ICON-ID>?forward=<STATE>

    POST {{ORIGIN}}/rest/api/v1/display/uid/<PLUGIN-UID>/animation/<ICON-ID>?repeat=<STATE>

    POST {{ORIGIN}}/rest/api/v1/display/alias/<PLUGIN-ALIAS>/animation/<ICON-ID>?repeat=<STATE>

- PLUGIN-UID: The plugin unique id.
- PLUGIN-ALIAS: The plugin alias name.
- ICON-ID: The id of the icon (starting with 0 from left).
- STATE: `true` or `false`

## Configuration

### Bitmap/Sprite sheet

#### Set Icon

Plugin UID:
Icon Position:
Icon:

#### Clear Icon

Plugin UID:
Icon Position:

### Animation configuration

Plugin UID:
Icon Position:
Forward:
Repeat: