EnOcean Link  1.14.0.0
Middleware to Connect EnOcean easily to other Projects
eoEEP_A513xx.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 
29 
30 #if !defined(eoEEP_A513_H__INCLUDED_)
31 #define eoEEP_A513_H__INCLUDED_
32 
35 #include "eoA5EEProfile.h"
126 typedef enum
127 {
129  RAIN_NORAIN = 0x00,
131  SUN_WEST = 0x01,
133  SUN_SOUTH = 0x02,
135  SUN_EAST = 0x03,
137  TIME_SECOND = 0x04,
139  TIME_MINUTE = 0x05,
141  TIME_HOUR = 0x06,
143  TIME_DAY = 0x07,
145  TIME_MONTH = 0x08,
147  TIME_YEAR = 0x09,
149  TIME_SOURCE = 0x0A,
151  AM_PM = 0x0B,
153  ELEVATION = 0x0C,
155  AZIMUTH = 0x0D,
157  LATITUDE = 0x0E,
159  LONGITUDE = 0x0F,
161  TIME_FORMAT = 0x10,
166 } EA_INDEXS;
167 
172 typedef enum
173 {
175  MONDAY = 0x01,
177  TUESDAY = 0x02,
179  WEDNESDAY = 0x03,
181  THURSDAY = 0x04,
183  FRIDAY = 0x05,
185  SATURDAY = 0x06,
187  SUNDAY = 0x07
188 } EA_ENUM_DAYS;
189 
194 typedef enum
195 {
199  GPS = 0x01
201 
206 typedef enum
207 {
209  TIME_AM = 0x00,
211  TIME_PM = 0x01
212 } EA_AM_PM;
213 
218 typedef enum
219 {
221  FORMAT_24 = 0x00,
223  FORMAT_12 = 0x01
225 
230 typedef enum
231 {
233  NORTH = 0x00,
235  SOUTH = 0x01
236 } EA_HEMISPHERE;
237 
242 typedef enum
243 {
245  WIND_NNE = 0x00,
247  WIND_NE = 0x01,
249  WIND_ENE = 0x02,
251  WIND_E = 0x03,
253  WIND_ESE = 0x04,
255  WIND_SE = 0x05,
257  WIND_SSE = 0x06,
259  WIND_S = 0x07,
261  WIND_SSW = 0x08,
263  WIND_SW = 0x09,
265  WIND_WSW = 0x0A,
267  WIND_W = 0x0B,
269  WIND_WNW = 0x0C,
271  WIND_NW = 0x0D,
273  WIND_NNW = 0x0E,
275  WIND_N = 0x0F
277 
279 {
280 private:
281  uint8_t cmd;
282 
283 public:
284  eoReturn SetType(uint8_t type);
285  eoEEP_A513xx();
286  virtual ~eoEEP_A513xx();
287 
288  eoReturn GetValue(CHANNEL_TYPE type, uint32_t &value, uint8_t index);
289  eoReturn SetValue(CHANNEL_TYPE type, uint32_t value, uint8_t index);
290  eoReturn GetValue(CHANNEL_TYPE type, float &value, uint8_t index);
291  eoReturn SetValue(CHANNEL_TYPE type, float value, uint8_t index);
297  eoReturn SetCommand(uint8_t cmd);
298 
299  eoReturn Parse(const eoMessage &m);
300 };
301 
302 #endif
Maximum wind speed.
Definition: eoEEP_A513xx.h:165
AM.
Definition: eoEEP_A513xx.h:209
EnOcean Equipment Profiles.
Definition: eoA5EEProfile.h:85
AM or PM.
Definition: eoEEP_A513xx.h:151
uint8_t type
Type.
Definition: eoProfile.h:69
Time - second.
Definition: eoEEP_A513xx.h:137
The class to handle EEP a513 profiles.
Definition: eoEEP_A513xx.h:278
EA_HEMISPHERE
Hemisphere source.
Definition: eoEEP_A513xx.h:230
24 hours
Definition: eoEEP_A513xx.h:221
North East.
Definition: eoEEP_A513xx.h:247
Wednesday.
Definition: eoEEP_A513xx.h:179
South.
Definition: eoEEP_A513xx.h:235
GPS or equivalent.
Definition: eoEEP_A513xx.h:199
Message Class for communication.
Definition: eoMessage.h:47
Sun - East.
Definition: eoEEP_A513xx.h:135
Time - day.
Definition: eoEEP_A513xx.h:143
Azimuth.
Definition: eoEEP_A513xx.h:155
South - South West.
Definition: eoEEP_A513xx.h:261
EA_AM_PM
AM or PM.
Definition: eoEEP_A513xx.h:206
West - North West.
Definition: eoEEP_A513xx.h:269
Time - month.
Definition: eoEEP_A513xx.h:145
Time - hour.
Definition: eoEEP_A513xx.h:141
EA_INDEXS
Indexes for A513xx profiles.
Definition: eoEEP_A513xx.h:126
Longitude.
Definition: eoEEP_A513xx.h:159
EA_ENUM_WIND_DIR
Win direction definitions.
Definition: eoEEP_A513xx.h:242
Real time clock.
Definition: eoEEP_A513xx.h:197
Elevation.
Definition: eoEEP_A513xx.h:153
South West.
Definition: eoEEP_A513xx.h:263
EA_ENUM_DAYS
Days definition.
Definition: eoEEP_A513xx.h:172
Time format.
Definition: eoEEP_A513xx.h:161
eoReturn SetCommand(uint8_t cmd)
EA_TIME_SOURCE
Time source.
Definition: eoEEP_A513xx.h:194
East.
Definition: eoEEP_A513xx.h:251
Sunday.
Definition: eoEEP_A513xx.h:187
Friday.
Definition: eoEEP_A513xx.h:183
eoReturn
contains all the return values from different functions
Definition: eoApiDef.h:40
North.
Definition: eoEEP_A513xx.h:233
West - South West.
Definition: eoEEP_A513xx.h:265
Saturday.
Definition: eoEEP_A513xx.h:185
12 hours
Definition: eoEEP_A513xx.h:223
Monday.
Definition: eoEEP_A513xx.h:175
Latitude.
Definition: eoEEP_A513xx.h:157
eoReturn Parse(const eoMessage &m)
Parses a msg using learned in Profile from Device.
Average wind speed.
Definition: eoEEP_A513xx.h:163
South.
Definition: eoEEP_A513xx.h:259
Sun - South.
Definition: eoEEP_A513xx.h:133
Thursday.
Definition: eoEEP_A513xx.h:181
CHANNEL_TYPE
Definition: eoChannelEnums.h:169
Sun - West.
Definition: eoEEP_A513xx.h:131
North - North West.
Definition: eoEEP_A513xx.h:273
PM.
Definition: eoEEP_A513xx.h:211
Time - minute.
Definition: eoEEP_A513xx.h:139
West.
Definition: eoEEP_A513xx.h:267
Time source.
Definition: eoEEP_A513xx.h:149
Tuesday.
Definition: eoEEP_A513xx.h:177
East - South East.
Definition: eoEEP_A513xx.h:253
Rain / No rain.
Definition: eoEEP_A513xx.h:129
East - North East.
Definition: eoEEP_A513xx.h:249
North.
Definition: eoEEP_A513xx.h:275
South East.
Definition: eoEEP_A513xx.h:255
EA_TIME_FORMAT
24 hours or 12 hours
Definition: eoEEP_A513xx.h:218
eoReturn SetType(uint8_t type)
North West.
Definition: eoEEP_A513xx.h:271
Time - year.
Definition: eoEEP_A513xx.h:147
North - North East.
Definition: eoEEP_A513xx.h:245
South - South East.
Definition: eoEEP_A513xx.h:257