BALTECH SDK wrapper functions reference
ui.h
Go to the documentation of this file.
1 
10 #ifndef __BRP_BALTECH_SDK_CMDS_UI_H__
11 #define __BRP_BALTECH_SDK_CMDS_UI_H__
12 #include "../typedefs.h"
16 #define BRP_UI_ErrInvalidPort BRP_ERR_STATUS(0x0A00, 0x01)
17 typedef struct {
34 #ifdef BRP_SUPPORT_LEGACY_METHODS
36 #else
38 #endif
39 typedef struct {
56 #ifdef BRP_SUPPORT_LEGACY_METHODS
58 #else
60 #endif
61 typedef struct {
64  unsigned ToggleCount;
65  unsigned Timespan1;
66  unsigned Timespan2;
84 #ifdef BRP_SUPPORT_LEGACY_METHODS
85 brp_errcode brp_UI_Toggle(brp_protocol protocol, brp_IoPort Port, unsigned ToggleCount, unsigned Timespan1, unsigned Timespan2, brp_UI_Toggle_Polarity Polarity);
86 #else
88 #endif
89 typedef struct {
92  unsigned RgbColor;
93  unsigned TransitionTime;
108 #ifdef BRP_SUPPORT_LEGACY_METHODS
109 brp_errcode brp_UI_SetRgbLed(brp_protocol protocol, brp_LedBitMask LedState, unsigned RgbColor, unsigned TransitionTime);
110 #else
112 #endif
113 typedef struct {
116  unsigned RgbColor1;
117  unsigned RgbColor2;
118  unsigned TransitionTime;
119  unsigned Period;
136 #ifdef BRP_SUPPORT_LEGACY_METHODS
137 brp_errcode brp_UI_PulseRgbLed(brp_protocol protocol, brp_LedBitMask LedState, unsigned RgbColor1, unsigned RgbColor2, unsigned TransitionTime, unsigned Period);
138 #else
140 #endif
141 #endif
142 
unsigned TransitionTime
Definition: ui.h:118
brp_LedBitMask LedState
Definition: ui.h:91
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_protocol protocol
Definition: ui.h:40
brp_UI_Toggle_Polarity Polarity
Definition: ui.h:67
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:2289
brp_errcode brp_UI_Disable(brp_UI_Disable_t params)
This command disables a specific port of the reader.
A bitmask containing the physical LEDs you want to switch.
Definition: typedefs.h:3754
unsigned Period
Definition: ui.h:119
brp_protocol protocol
Definition: ui.h:90
unsigned RgbColor
Definition: ui.h:92
brp_errcode brp_UI_SetRgbLed(brp_UI_SetRgbLed_t params)
This command changes the RGB color of a single LED or a group of LEDs.
brp_protocol protocol
Definition: ui.h:62
brp_protocol protocol
Definition: ui.h:114
brp_IoPort
I/O pins of the reader that can be controlled by the user.
Definition: typedefs.h:3863
unsigned ToggleCount
Definition: ui.h:64
brp_LedBitMask LedState
Definition: ui.h:115
brp_errcode brp_UI_Toggle(brp_UI_Toggle_t params)
This command toggles the output state of a specific port.
unsigned RgbColor1
Definition: ui.h:116
brp_IoPort Port
Definition: ui.h:41
unsigned Timespan2
Definition: ui.h:66
brp_IoPort Port
Definition: ui.h:19
unsigned Timespan1
Definition: ui.h:65
unsigned RgbColor2
Definition: ui.h:117
brp_errcode brp_UI_Enable(brp_UI_Enable_t params)
This command enables a specific port of the reader.
brp_protocol protocol
Definition: ui.h:18
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 smoo...
brp_IoPort Port
Definition: ui.h:63
unsigned TransitionTime
Definition: ui.h:93