EnOcean Link  1.14.0.0
Middleware to Connect EnOcean easily to other Projects
eoEEP_D20701.h
Go to the documentation of this file.
1 /******************************************************************************
2  DISCLAIMER
3 
4  THIS SOFTWARE PRODUCT ("SOFTWARE") IS PROPRIETARY TO ENOCEAN GMBH, OBERHACHING,
5  GERMANY (THE "OWNER") AND IS PROTECTED BY COPYRIGHT AND INTERNATIONAL TREATIES OR
6  PROTECTED AS TRADE SECRET OR AS OTHER INTELLECTUAL PROPERTY RIGHT. ALL RIGHTS, TITLE AND
7  INTEREST IN AND TO THE SOFTWARE, INCLUDING ANY COPYRIGHT, TRADE SECRET OR ANY OTHER
8  INTELLECTUAL PROPERTY EMBODIED IN THE SOFTWARE, AND ANY RIGHTS TO REPRODUCE,
9  DISTRIBUTE, MODIFY, DISPLAY OR OTHERWISE USE THE SOFTWARE SHALL EXCLUSIVELY VEST IN THE
10  OWNER. ANY UNAUTHORIZED REPRODUCTION, DISTRIBUTION, MODIFICATION, DISPLAY OR OTHER
11  USE OF THE SOFTWARE WITHOUT THE EXPLICIT PERMISSION OF OWNER IS PROHIBITED AND WILL
12  CONSTITUTE AN INFRINGEMENT OF THE OWNER'S RIGHT AND MAY BE SUBJECT TO CIVIL OR
13  CRIMINAL SANCTION.
14 
15  THIS SOFTWARE IS PROVIDED BY THE OWNER "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
16  INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
17  FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN PARTICULAR, THE OWNER DOES NOT WARRANT
18  THAT THE SOFTWARE SHALL BE ERROR FREE AND WORKS WITHOUT INTERRUPTION.
19 
20  IN NO EVENT SHALL THE OWNER BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
21  EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
22  SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23  HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
24  OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
25  SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26  ******************************************************************************/
27 
28 #ifndef EO_EEP_D20701_H
29 #define EO_EEP_D20701_H
30 
33 #include "eoD2EEProfile.h"
67  typedef enum
68  {
69  D20701_LN = 0,
70  D20701_LS = 1,
71  D20701_DS = 2,
72  D20701_AS = 3,
73  D20701_ET = 4,
74  D20701_KT = 5,
75  D20701_TOA = 6,
76  D20701_AI = 7,
77  D20701_RFR = 8,
79 
83  typedef enum
84  {
85  D20701_LS_LOCK_OPEN = 0,
86  D20701_LS_LOCK_CLOSED = 1,
87  D20701_LS_LOCK_USABLE_FOR_A_TIME = 2,
88  D20701_LS_LOCK_BLOCKED = 3,
90 
91  typedef enum
92  {
93  D20701_DS_DND_NOT_ACTIVE = 0,
94  D20701_DS_DND_ACTIVE = 1,
95  }D20701_DS_ENUM;
96 
97  typedef enum
98  {
99  D20701_AS_NO_ALARM = 0,
100  D20701_AS_ALARM_ACTIVE = 1,
101  }D20701_AS_ENUM;
102 
103 
104  typedef enum
105  {
106  D20701_ET_LOCK_USED = 0,
107  D20701_ET_LOCK_PROGRAMMED = 1,
108  D20701_ET_LOCK_RESETTED = 2,
109  D20701_ET_LOCK_PROTOCOLLS_READ = 3,
110  D20701_ET_BATTERY_CHANGED = 4,
111  }D20701_ET_ENUM;
112 
113  typedef enum
114  {
115  D20701_KT_USER_KEY = 0,
116  D20701_KT_MASTER_KEY = 1,
117  D20701_KT_HOUSEKEEPIN_KEY = 2,
118  }D20701_KT_ENUM;
119 
120  typedef enum
121  {
122  D20701_TOA_RFID = 0,
123  D20701_TOA_PIN_CODE = 1,
124  D20701_TOA_BLUETOOTH = 2,
125  }D20701_TOA_ENUM;
126 
127  typedef enum
128  {
129  D20701_RFR_NO_REJECTION = 0,
130  D20701_RFR_KEY_NOT_VALID_YET = 1,
131  D20701_RFR_KEY_NOT_VALID_ANY_MORE = 2,
132  D20701_RFR_KEY_WITH_WRONG_GENERATION = 3,
133  D20701_RFR_KEY_NOT_ALLOWED_AT_THIS_LOCK = 4,
134  D20701_RFR_DND_ACTIVE = 5,
135  D20701_RFR_TIMEZONE_NOT_ACTIVE = 6,
136  D20701_RFR_PIN_CODE_NOT_ALLOWED = 7,
137  D20701_RFR_USERCOUNT_EXCEEDED = 8,
138  D20701_RFR_LOCK_BLOCKED = 9,
139  }D20701_RFR_ENUM;
140 
141 
143 {
144 
145 public:
146  eoReturn SetType(uint8_t type);
147 
148  eoEEP_D20701(uint16_t size=14);
149  virtual ~eoEEP_D20701();
150 
151  eoReturn SetValue(CHANNEL_TYPE type, uint64_t value, uint8_t index);
152  eoReturn GetValue(CHANNEL_TYPE type, uint64_t &value, uint8_t index);
153 
154 };
157 #endif // !eoEEP_D20701
eoReturn SetType(uint8_t type)
uint8_t type
Type.
Definition: eoProfile.h:69
eoReturn SetValue(CHANNEL_TYPE type, uint64_t value, uint8_t index)
Sets the Value as a 64-bit.
D20701_CHANNELS
Definition: eoEEP_D20701.h:67
The class to handle eoEEP_D20701.
Definition: eoEEP_D20701.h:142
eoReturn
contains all the return values from different functions
Definition: eoApiDef.h:40
EnOcean Equipment Profiles.
Definition: eoD2EEProfile.h:96
CHANNEL_TYPE
Definition: eoChannelEnums.h:169
D20701_LS_ENUM
Definition: eoEEP_D20701.h:83