EnOcean Link  1.14.0.0
Middleware to Connect EnOcean easily to other Projects
eoEEP_A511xx.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 #if !defined(eoEEP_A511_H__INCLUDED_)
29 #define eoEEP_A511_H__INCLUDED_
30 
33 #include "eoA5EEProfile.h"
109 typedef enum
111 {
113  CS_REPEATER = 0x00,
119  CS_DIMMING = 0x03,
123  CS_ALARM = 0x05,
141  CS_STATUS = 0x0E,
143  CS_RGB_RED = 0x0F,
145  CS_RGB_GREEN = 0x10,
147  CS_RGB_BLUE = 0x11
148 
149 } CS_INDEXES;
150 
152 typedef enum
153 {
155  CS_MILI_W = 0x00,
157  CS_W = 0x01,
159  CS_KILO_W = 0x02,
161  CS_MEGA_W = 0x03,
163  CS_WH = 0x04,
165  CS_KILO_WH = 0x05,
167  CS_MEGA_WH = 0x06,
169  CS_GIGA_WH = 0x07,
171  CS_MILI_A = 0x08,
173  CS_A_1_10 = 0x09,
175  CS_MILI_V = 0x0A,
177  CS_V_1_10 = 0x0B
179 
181 typedef enum
182 {
184  CS_NO_ERROR = 0x00,
190 
192 typedef enum
193 {
195  A5O_ERROR = 0x00,
203 
205 typedef enum
206 {
212  BLIND_OPENS = 0x02,
216 
218 typedef enum
219 {
229 
231 typedef enum
232 {
234  HEATING = 0x00,
236  COOLING = 0x01,
238  OFF = 0x02
240 
242 typedef enum
243 {
245  OCCUPIED = 0x00,
247  UNOCCUPIED = 0x01,
249  STANDBY = 0x02,
251  FROST = 0x03
253 
255 typedef enum
256 {
266  STAGE_0_AUTO = 0x10,
268  STAGE_1_AUTO = 0x11,
270  STAGE_2_AUTO = 0x12,
273 } CS_FAN_STAGE;
274 
276 typedef enum
277 {
287 
289 typedef enum
290 {
300 
302 {
303 
304 public:
305  eoReturn SetType(uint8_t type);
306 
307  eoEEP_A511xx();
308  virtual ~eoEEP_A511xx();
309 
310  virtual eoReturn GetValue(CHANNEL_TYPE type, uint32_t &value, uint8_t index);
311  virtual eoReturn SetValue(CHANNEL_TYPE type, uint32_t value, uint8_t index);
312  virtual eoReturn GetValue(CHANNEL_TYPE type, float &value, uint8_t index);
313  virtual eoReturn SetValue(CHANNEL_TYPE type, float value, uint8_t index);
314 
315 };
318 #endif // !defined(EA_259BDE62_FE41_490e_8B3E_427A72922C4A__INCLUDED_)
Angle value flag 10
Definition: eoEEP_A511xx.h:133
EnOcean Equipment Profiles.
Definition: eoA5EEProfile.h:85
Unoccupied 1
Definition: eoEEP_A511xx.h:247
CS_RELAY_STATUS
Relay Status for A5-11-05 profile.
Definition: eoEEP_A511xx.h:289
CS_WORKING_MODE
Working mode for A5-11-05 profile.
Definition: eoEEP_A511xx.h:276
Power relay timer 1
Definition: eoEEP_A511xx.h:115
Occupied 0
Definition: eoEEP_A511xx.h:245
uint8_t type
Type.
Definition: eoProfile.h:69
Blind is stopped 1
Definition: eoEEP_A511xx.h:210
Angle sign 8
Definition: eoEEP_A511xx.h:129
The class to handle EEP a511 profiles.
Definition: eoEEP_A511xx.h:301
RGB green 16
Definition: eoEEP_A511xx.h:145
Channel 1 on, channel 2 off 1
Definition: eoEEP_A511xx.h:294
CS_ENUM_END_POS
Blind end position for A5-11-xx profiles.
Definition: eoEEP_A511xx.h:218
CS_FAN_STAGE
Fan speed for A5-11-xx profiles.
Definition: eoEEP_A511xx.h:255
Not available 0
Definition: eoEEP_A511xx.h:208
RGB red 15
Definition: eoEEP_A511xx.h:143
eoReturn SetType(uint8_t type)
Lamp failure 1
Definition: eoEEP_A511xx.h:186
Stage 2 Automatic 18
Definition: eoEEP_A511xx.h:270
Operating hours flag 13
Definition: eoEEP_A511xx.h:139
CS_ENUM_ROOM_OCCUPANCY
Room occupancy for A5-11-xx profiles.
Definition: eoEEP_A511xx.h:242
Watt 1
Definition: eoEEP_A511xx.h:157
Stage 1 Manual 1
Definition: eoEEP_A511xx.h:260
Channel 1 off, channel 2 off 0
Definition: eoEEP_A511xx.h:292
Stage 0 Manual 0
Definition: eoEEP_A511xx.h:258
Mode 1 0
Definition: eoEEP_A511xx.h:279
Mili Volt 10
Definition: eoEEP_A511xx.h:175
Stage 3 Manual 3
Definition: eoEEP_A511xx.h:264
CS_ENUM_CONTROLLER_MODE
Controller mode for A5-11-xx profiles.
Definition: eoEEP_A511xx.h:231
Cooling 1
Definition: eoEEP_A511xx.h:236
Stage 2 Manual 2
Definition: eoEEP_A511xx.h:262
CS_INDEXES
Index enums for A5-11-xx profiles.
Definition: eoEEP_A511xx.h:110
Mode 2 1
Definition: eoEEP_A511xx.h:281
Mili Watt 0
Definition: eoEEP_A511xx.h:155
1/10 Amper 9
Definition: eoEEP_A511xx.h:173
Mega Watt 3
Definition: eoEEP_A511xx.h:161
CS_ENUM_04_ERROR_STATE
4 state error code for A5-11-xx profiles
Definition: eoEEP_A511xx.h:192
Stage 1 Automatic 17
Definition: eoEEP_A511xx.h:268
Dimming 3
Definition: eoEEP_A511xx.h:119
Mili Amper 8
Definition: eoEEP_A511xx.h:171
Lamp failure 1
Definition: eoEEP_A511xx.h:197
Kilo Watthour 5
Definition: eoEEP_A511xx.h:165
Controller state 6
Definition: eoEEP_A511xx.h:125
Blind fully close 3
Definition: eoEEP_A511xx.h:227
Channel 1 on, channel 2 on 3
Definition: eoEEP_A511xx.h:298
Position value flag 9
Definition: eoEEP_A511xx.h:131
eoReturn
contains all the return values from different functions
Definition: eoApiDef.h:40
Mode 4 3
Definition: eoEEP_A511xx.h:285
1/10 Volt 11
Definition: eoEEP_A511xx.h:177
Heating 0
Definition: eoEEP_A511xx.h:234
CS_ENUM_03_ERROR_STATE
3 state error code for A5-11-xx profiles
Definition: eoEEP_A511xx.h:181
No end-position reached 1
Definition: eoEEP_A511xx.h:223
Blind opens 2
Definition: eoEEP_A511xx.h:212
StandBy 2
Definition: eoEEP_A511xx.h:249
Blind fully open 2
Definition: eoEEP_A511xx.h:225
Status 14
Definition: eoEEP_A511xx.h:141
Off 2
Definition: eoEEP_A511xx.h:238
No error 0
Definition: eoEEP_A511xx.h:195
Repeater 0
Definition: eoEEP_A511xx.h:113
CS_ENERGY_UNITS
Units for A5-11-xx profiles.
Definition: eoEEP_A511xx.h:152
Stage 0 Automatic 16
Definition: eoEEP_A511xx.h:266
CHANNEL_TYPE
Definition: eoChannelEnums.h:169
Mode 3 2
Definition: eoEEP_A511xx.h:283
Power relay 4
Definition: eoEEP_A511xx.h:121
No error 0
Definition: eoEEP_A511xx.h:184
Service mode 11
Definition: eoEEP_A511xx.h:135
RGB blue 17
Definition: eoEEP_A511xx.h:147
Channel 1 off, channel 2 on 2
Definition: eoEEP_A511xx.h:296
Kilo Watt 2
Definition: eoEEP_A511xx.h:159
Daylight Harvest 2
Definition: eoEEP_A511xx.h:117
CS_ENUM_BLIND_STATE
Blind status for A5-11-xx profiles.
Definition: eoEEP_A511xx.h:205
Giga Watthour 7
Definition: eoEEP_A511xx.h:169
Stage 3 Automatic 19
Definition: eoEEP_A511xx.h:272
Internal failure 2
Definition: eoEEP_A511xx.h:199
Internal failure 2
Definition: eoEEP_A511xx.h:188
Mega Watthour 6
Definition: eoEEP_A511xx.h:167
Mode of the position 12
Definition: eoEEP_A511xx.h:137
Energy hold-off 7
Definition: eoEEP_A511xx.h:127
Alarm 5
Definition: eoEEP_A511xx.h:123
Blind closes 3
Definition: eoEEP_A511xx.h:214
Watthour 4
Definition: eoEEP_A511xx.h:163
Frost 3
Definition: eoEEP_A511xx.h:251
Failure on the external periphery 3
Definition: eoEEP_A511xx.h:201
No end-position available 0
Definition: eoEEP_A511xx.h:221