C API for BALTECH SDK
ui.h
Go to the documentation of this file.
1 
11 #ifndef __BRP_BALTECH_API_CMDS_UI_H__
12 #define __BRP_BALTECH_API_CMDS_UI_H__
13 #include "../typedefs.h"
18 #define BRP_UI_ErrInvalidPort BRP_ERR_STATUS(0x0A00, 0x01)
19 
63 brp_errcode brp_UI_Toggle(brp_protocol protocol, brp_IoPort Port, unsigned ToggleCount, unsigned Timespan1, unsigned Timespan2, brp_UI_Toggle_Polarity Polarity);
84 brp_errcode brp_UI_SetRgbLed(brp_protocol protocol, brp_LedBitMask LedState, unsigned RgbColor, unsigned TransitionTime);
105 brp_errcode brp_UI_PulseRgbLed(brp_protocol protocol, brp_LedBitMask LedState, unsigned RgbColor1, unsigned RgbColor2, unsigned TransitionTime, unsigned Period);
106 #endif
107 
unsigned int brp_errcode
This type is used library-wide for passing error codes in the return value of functions.
Definition: errorcodes.h:23
brp_errcode brp_UI_Enable(brp_protocol protocol, brp_IoPort Port)
This command enables a specific port of the reader.
struct brp_protocol_t * brp_protocol
This is a generic handle of a protocol.
Definition: protocol.h:34
brp_UI_Toggle_Polarity
Definition: typedefs.h:2455
brp_errcode brp_UI_PulseRgbLed(brp_protocol protocol, brp_LedBitMask LedState, 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 smoo...
brp_errcode brp_UI_Toggle(brp_protocol protocol, brp_IoPort Port, unsigned ToggleCount, unsigned Timespan1, unsigned Timespan2, brp_UI_Toggle_Polarity Polarity)
This command toggles the output state of a specific port.
A bitmask containing the physical LEDs you want to switch.
Definition: typedefs.h:3762
brp_IoPort
I/O pins of the reader that can be controlled by the user.
Definition: typedefs.h:3874
brp_errcode brp_UI_Disable(brp_protocol protocol, brp_IoPort Port)
This command disables a specific port of the reader.
brp_errcode brp_UI_SetRgbLed(brp_protocol protocol, brp_LedBitMask LedState, unsigned RgbColor, unsigned TransitionTime)
This command changes the RGB color of a single LED or a group of LEDs.