BALTECH Docs |
C API for BALTECH SDK
|
brp_errcode brp_UI_PulseRgbLed | ( | brp_protocol | protocol, |
unsigned | LedBitMask, | ||
unsigned | RgbColor1, | ||
unsigned | RgbColor2, | ||
unsigned | TransitionTime, | ||
unsigned | Period | ||
) |
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 commandUI.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.
[in] | protocol | used to execute the command |
[in] | LedBitMask | A bitmask containing all LEDs you want to switch. |
[in] | RgbColor1 | The first RGB color of the desired pulse signal (0x00RRGGBB). |
[in] | RgbColor2 | The second RGB color of the desired pulse signal (0x00RRGGBB). |
[in] | TransitionTime | 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. |
[in] | Period | 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. |