eoUTEHelper.h

Go to the documentation of this file.

/******************************************************************************
DISCLAIMER

THIS SOFTWARE PRODUCT ("SOFTWARE") IS PROPRIETARY TO ENOCEAN GMBH, OBERHACHING,
GERMANY (THE "OWNER") AND IS PROTECTED BY COPYRIGHT AND INTERNATIONAL TREATIES OR
PROTECTED AS TRADE SECRET OR AS OTHER INTELLECTUAL PROPERTY RIGHT. ALL RIGHTS, TITLE AND
INTEREST IN AND TO THE SOFTWARE, INCLUDING ANY COPYRIGHT, TRADE SECRET OR ANY OTHER
INTELLECTUAL PROPERTY EMBODIED IN THE SOFTWARE, AND ANY RIGHTS TO REPRODUCE,
DISTRIBUTE, MODIFY, DISPLAY OR OTHERWISE USE THE SOFTWARE SHALL EXCLUSIVELY VEST IN THE
OWNER. ANY UNAUTHORIZED REPRODUCTION, DISTRIBUTION, MODIFICATION, DISPLAY OR OTHER
USE OF THE SOFTWARE WITHOUT THE EXPLICIT PERMISSION OF OWNER IS PROHIBITED AND WILL
CONSTITUTE AN INFRINGEMENT OF THE OWNER'S RIGHT AND MAY BE SUBJECT TO CIVIL OR
CRIMINAL SANCTION.

THIS SOFTWARE IS PROVIDED BY THE OWNER "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN PARTICULAR, THE OWNER DOES NOT WARRANT
THAT THE SOFTWARE SHALL BE ERROR FREE AND WORKS WITHOUT INTERRUPTION.

IN NO EVENT SHALL THE OWNER BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
******************************************************************************/

#ifndef EO_UTE_HELPER_H_
#define EO_UTE_HELPER_H_
#include "eoHalTypes.h"
#include "eoMessage.h"

typedef enum
{
 GENERAL_REASON = 0,         
 TEACH_IN_ACCEPTED = 1,         
 TEACH_OUT_ACCEPTED = 2,         
 EEP_NOT_SUPPORTED = 3         
} UTE_RESPONSE;

typedef enum
{
 TEACH_IN_REQUEST = 0,         
 TEACH_OUT_REQUEST = 1,         
 TEACH_UNKNOW_REQUEST = 2,         
 UTE_NOT_USED_TEACH = 3         
} UTE_REQUEST;

typedef enum
{
 EEP_TEACH_IN_QUERY = 0,         
 EEP_TEACH_IN_RESPONSE = 1         
} UTE_COMMAND;

typedef enum
{
 UTE_DIRECTION_UNIDIRECTIONAL = 0,         
 UTE_DIRECTION_BIDIRECTIONAL = 1         
} UTE_DIRECTION;

typedef struct
{
 uint8_t rorg; 
 uint8_t func;
 uint8_t type;
 uint8_t numberOfChannel;
 uint16_t manufacturerID;
 UTE_DIRECTION direction;
 UTE_REQUEST request;
}UTE_EEP_TEACH_IN_QUERY;

typedef struct
{
 uint8_t rorg; 
 uint8_t func;
 uint8_t type;
 uint8_t numberOfChannel;
 uint16_t manufacturerID;
 UTE_DIRECTION direction;
 UTE_RESPONSE response;
}UTE_EEP_TEACH_IN_RESPONSE;

class eoUTEHelper
{
public:
static eoReturn ParseUTE(eoMessage &msg, UTE_EEP_TEACH_IN_QUERY &uteQuery);
static eoReturn CreateUTEResponse(UTE_EEP_TEACH_IN_RESPONSE &uteResponse, eoMessage &responseMessage);
static eoReturn CreateUTEResponseFromQuery(UTE_EEP_TEACH_IN_QUERY &uteQuery, eoMessage &responseMessage, UTE_RESPONSE type, UTE_DIRECTION direction);
};
#endif