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 {
18  brp_protocol protocol;
19  brp_IoPort Port;
20 } brp_UI_Enable_t;
34 #ifdef BRP_SUPPORT_LEGACY_METHODS
35 brp_errcode brp_UI_Enable(brp_protocol protocol, brp_IoPort Port);
36 #else
37 brp_errcode brp_UI_Enable(brp_UI_Enable_t params);
38 #endif
39 typedef struct {
40  brp_protocol protocol;
41  brp_IoPort Port;
42 } brp_UI_Disable_t;
56 #ifdef BRP_SUPPORT_LEGACY_METHODS
57 brp_errcode brp_UI_Disable(brp_protocol protocol, brp_IoPort Port);
58 #else
59 brp_errcode brp_UI_Disable(brp_UI_Disable_t params);
60 #endif
61 typedef struct {
62  brp_protocol protocol;
63  brp_IoPort Port;
64  unsigned ToggleCount;
65  unsigned Timespan1;
66  unsigned Timespan2;
67  brp_UI_Toggle_Polarity Polarity;
68 } brp_UI_Toggle_t;
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
87 brp_errcode brp_UI_Toggle(brp_UI_Toggle_t params);
88 #endif
89 typedef struct {
90  brp_protocol protocol;
91  brp_IoPort Port;
92  brp_UI_Sense_PortState* PortState;
93 } brp_UI_Sense_t;
104 #ifdef BRP_SUPPORT_LEGACY_METHODS
105 brp_errcode brp_UI_Sense(brp_protocol protocol, brp_IoPort Port, brp_UI_Sense_PortState* PortState);
106 #else
107 brp_errcode brp_UI_Sense(brp_UI_Sense_t params);
108 #endif
109 typedef struct {
110  brp_protocol protocol;
111  brp_LedBitMask LedState;
112  unsigned RgbColor;
113  unsigned TransitionTime;
114 } brp_UI_SetRgbLed_t;
128 #ifdef BRP_SUPPORT_LEGACY_METHODS
129 brp_errcode brp_UI_SetRgbLed(brp_protocol protocol, brp_LedBitMask LedState, unsigned RgbColor, unsigned TransitionTime);
130 #else
131 brp_errcode brp_UI_SetRgbLed(brp_UI_SetRgbLed_t params);
132 #endif
133 typedef struct {
134  brp_protocol protocol;
135  brp_LedBitMask LedState;
136  unsigned RgbColor1;
137  unsigned RgbColor2;
138  unsigned TransitionTime;
139  unsigned Period;
140 } brp_UI_PulseRgbLed_t;
156 #ifdef BRP_SUPPORT_LEGACY_METHODS
157 brp_errcode brp_UI_PulseRgbLed(brp_protocol protocol, brp_LedBitMask LedState, unsigned RgbColor1, unsigned RgbColor2, unsigned TransitionTime, unsigned Period);
158 #else
159 brp_errcode brp_UI_PulseRgbLed(brp_UI_PulseRgbLed_t params);
160 #endif
161 #endif
162 
brp_UI_PulseRgbLed_t::TransitionTime
unsigned TransitionTime
Definition: ui.h:138
brp_UI_SetRgbLed_t::LedState
brp_LedBitMask LedState
Definition: ui.h:111
brp_UI_Sense_PortState
brp_UI_Sense_PortState
Definition: typedefs.h:2303
brp_UI_Enable_t
Definition: ui.h:17
brp_errcode
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_UI_Disable_t::protocol
brp_protocol protocol
Definition: ui.h:40
brp_UI_Toggle_t::Polarity
brp_UI_Toggle_Polarity Polarity
Definition: ui.h:67
brp_protocol
struct brp_protocol_t * brp_protocol
This is a generic handle of a protocol.
Definition: protocol.h:34
brp_UI_Toggle_Polarity
brp_UI_Toggle_Polarity
Definition: typedefs.h:2289
brp_UI_Sense_t::protocol
brp_protocol protocol
Definition: ui.h:90
brp_UI_Sense_t::Port
brp_IoPort Port
Definition: ui.h:91
brp_UI_Disable
brp_errcode brp_UI_Disable(brp_UI_Disable_t params)
This command disables a specific port of the reader.
brp_LedBitMask
A bitmask containing the physical LEDs you want to switch.
Definition: typedefs.h:3768
brp_UI_PulseRgbLed_t::Period
unsigned Period
Definition: ui.h:139
brp_UI_PulseRgbLed_t
Definition: ui.h:133
brp_UI_Disable_t
Definition: ui.h:39
brp_UI_SetRgbLed_t::protocol
brp_protocol protocol
Definition: ui.h:110
brp_UI_SetRgbLed_t::RgbColor
unsigned RgbColor
Definition: ui.h:112
brp_UI_Sense
brp_errcode brp_UI_Sense(brp_UI_Sense_t params)
This command retrieves the logical state of a specific reader port.
brp_UI_SetRgbLed
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_UI_Toggle_t::protocol
brp_protocol protocol
Definition: ui.h:62
brp_UI_PulseRgbLed_t::protocol
brp_protocol protocol
Definition: ui.h:134
brp_IoPort
brp_IoPort
I/O pins of the reader that can be controlled by the user.
Definition: typedefs.h:3877
brp_UI_Toggle_t::ToggleCount
unsigned ToggleCount
Definition: ui.h:64
brp_UI_PulseRgbLed_t::LedState
brp_LedBitMask LedState
Definition: ui.h:135
brp_UI_Toggle
brp_errcode brp_UI_Toggle(brp_UI_Toggle_t params)
This command toggles the output state of a specific port.
brp_UI_PulseRgbLed_t::RgbColor1
unsigned RgbColor1
Definition: ui.h:136
brp_UI_Disable_t::Port
brp_IoPort Port
Definition: ui.h:41
brp_UI_Toggle_t::Timespan2
unsigned Timespan2
Definition: ui.h:66
brp_UI_Enable_t::Port
brp_IoPort Port
Definition: ui.h:19
brp_UI_Toggle_t::Timespan1
unsigned Timespan1
Definition: ui.h:65
brp_UI_Sense_t::PortState
brp_UI_Sense_PortState * PortState
Definition: ui.h:92
brp_UI_Sense_t
Definition: ui.h:89
brp_UI_SetRgbLed_t
Definition: ui.h:109
brp_UI_PulseRgbLed_t::RgbColor2
unsigned RgbColor2
Definition: ui.h:137
brp_UI_Enable
brp_errcode brp_UI_Enable(brp_UI_Enable_t params)
This command enables a specific port of the reader.
brp_UI_Enable_t::protocol
brp_protocol protocol
Definition: ui.h:18
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 smoo...
brp_UI_Toggle_t::Port
brp_IoPort Port
Definition: ui.h:63
brp_UI_SetRgbLed_t::TransitionTime
unsigned TransitionTime
Definition: ui.h:113
brp_UI_Toggle_t
Definition: ui.h:61