EnOcean Link  1.14.0.0
Middleware to Connect EnOcean easily to other Projects
eoEEP_A530xx.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_A530_H__INCLUDED_)
29 #define eoEEP_A530_H__INCLUDED_
30 
33 #include "eoA5EEProfile.h"
93 typedef enum {
96  KEY_DATA_1 = 0x00,
98  KEY_DATA_2 = 0x01,
100  KEY_DATA_3 = 0x02,
102  KEY_DATA_4 = 0x03,
104  KEY_DATA_5 = 0x04,
106  KEY_DATA_6 = 0x05
107 } A530_INDEX;
108 
110 typedef enum {
112  BATTERY_LOW = 0x00,
116 
118 typedef enum {
124 
126 typedef enum {
128  STATUS_WAKE = 0x00,
130  DIGITAL_IN_0 = 0x01,
132  DIGITAL_IN_1 = 0x02,
134  DIGITAL_IN_2 = 0x03,
138 
139 typedef enum {
145 
146 class eoEEP_A530xx : public eoA5EEProfile {
147 
148 public:
149  eoEEP_A530xx();
150  virtual ~eoEEP_A530xx();
151 
152  eoReturn SetType(uint8_t type);
153  virtual eoReturn GetValue(CHANNEL_TYPE type, float &value, uint8_t index);
154  virtual eoReturn SetValue(CHANNEL_TYPE type, float value, uint8_t index);
155  virtual eoReturn GetValue(CHANNEL_TYPE type, uint32_t &value, uint8_t index);
156  virtual eoReturn SetValue(CHANNEL_TYPE type, uint32_t value, uint8_t index);
157 };
160 #endif // !defined(EA_259BDE62_FE41_490e_8B3E_427A72922C4A__INCLUDED_)
eoReturn SetType(uint8_t type)
EnOcean Equipment Profiles.
Definition: eoA5EEProfile.h:85
A530_SIGNAL_TYPE
Signal type.
Definition: eoEEP_A530xx.h:118
Digital Input 3 4
Definition: eoEEP_A530xx.h:136
1st key data 0
Definition: eoEEP_A530xx.h:96
4th key data 3
Definition: eoEEP_A530xx.h:102
Index counter.
Definition: eoEEP_A530xx.h:141
3rd key data 2
Definition: eoEEP_A530xx.h:100
uint8_t type
Type.
Definition: eoProfile.h:69
The class to handle EEP a530 profiles.
Definition: eoEEP_A530xx.h:146
Heart beat signal.
Definition: eoEEP_A530xx.h:122
Status of wake 0
Definition: eoEEP_A530xx.h:128
A530_BATTERY_VALUE
Battery values.
Definition: eoEEP_A530xx.h:110
Normal signal.
Definition: eoEEP_A530xx.h:120
2nd key data 1
Definition: eoEEP_A530xx.h:98
ENUM_DIGITAL_INPUT
Digital Inputs in A5-30-03 profile.
Definition: eoEEP_A530xx.h:126
A530_INDEX
Index enums for A5-30-xx profiles.
Definition: eoEEP_A530xx.h:94
Battery OK.
Definition: eoEEP_A530xx.h:114
Digital Input 1 2
Definition: eoEEP_A530xx.h:132
Retransmission counter.
Definition: eoEEP_A530xx.h:143
Battery low.
Definition: eoEEP_A530xx.h:112
eoReturn
contains all the return values from different functions
Definition: eoApiDef.h:40
Digital Input 2 3
Definition: eoEEP_A530xx.h:134
virtual eoReturn GetValue(CHANNEL_TYPE type, float &value, uint8_t index)
Gets the Value as Floating point.
5th key data 4
Definition: eoEEP_A530xx.h:104
CHANNEL_TYPE
Definition: eoChannelEnums.h:169
A530_COUNTER_TYPE
Definition: eoEEP_A530xx.h:139
Digital Input 0 1
Definition: eoEEP_A530xx.h:130
virtual eoReturn SetValue(CHANNEL_TYPE type, float value, uint8_t index)
Gets the Value as a float.
6th key data 5
Definition: eoEEP_A530xx.h:106