BALTECH SDK wrapper functions reference

§ brp_UI_PulseRgbLed()

brp_errcode brp_UI_PulseRgbLed ( brp_UI_PulseRgbLed_t  params)

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 brp_UI_SetRgbLed().

This command gives you direct control of the reader's LEDs. It competes with the command brp_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.

Parameters
[in]paramsStruct with the following fields:
  • protocol used to execute the command
  • LedState (in) A bitmask containing the physical LEDs you want to switch.
  • RgbColor1 (in) The first RGB color of the desired pulse signal (0x00RRGGBB).
  • RgbColor2 (in) The second RGB color of the desired pulse signal (0x00RRGGBB).
  • TransitionTime (in) 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 (in) 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.