UI.PulseRgbLed
This command starts to pulse a single LED or a group of multiple LEDs continuously by performing smooth sine-wave approximated transitions between 2 RGB colors.
To stop the pulsing, call the command UI.SetRgbLed.
This command gives you direct control of the reader's LEDs. It competes with the command UI.Enable, which can be used to switch LEDs via Virtual LED port definitions (VLEDs). UI.Enable operates on a higher abstraction level. Don't mix the 2 commands as this may result in inconsistent behavior.
Properties
- Command code: 0x0A21
- Command timeout: 100 ms
- Possible status codes: General status codes
Parameters (request frame)
| Name | Type/Size | Description | |
|---|---|---|---|
| LedState | Bit mask (16 bits) | A bitmask containing the physical LEDs you want to switch. | |
| RFU | Integer (bit mask area 0xFFF8) |
Zero padding |
|
| LeftLed | Boolean (bit 0x0004) |
LED(s) on the left side of the reader On readers with only a single LED, this bit has no effect. |
|
| RightLed | Boolean (bit 0x0002) |
LED(s) on the right side of the reader On readers with only a single LED, this bit has no effect. |
|
| SingleLed | Boolean (bit 0x0001) |
Single LED of the reader On readers with 2 or more LEDs, this bit has no effect. |
|
| RgbColor1 | Integer (32 bits) | The first RGB color of the desired pulse signal (0x00RRGGBB). | |
| RgbColor2 | Integer (32 bits) | The second RGB color of the desired pulse signal (0x00RRGGBB). | |
| TransitionTime | Integer (16 bits) | The time for the fading transition to activate the first RGB color in ms. If a color is currently activated, this is also the time to deactivate this color first. For an immediate color activation, choose the value 0. | |
| Period | Integer (16 bits) | The period of the pulse signal in ms. This is the time to transition from the first RGB color to the second and back to the first. | |
Returned values (response frame)
None