eoTeachInModule.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_TEACH_IN_MODULE_H_
#define EO_TEACH_IN_MODULE_H_
#include "eoHalTypes.h"
#include "eoMessage.h"
#include "eoDevice.h"
#include "eoISerialize.h"
#include "eoUTEHelper.h"

class eoDeviceManager;
class eoSecurity;

#include <map>

typedef struct
{
  bool teachedIN;
} TEACH_STRUCT;

typedef enum
{
  NO_TEACH_IN = 0,         
  NEW_DEVICE,             
  EEP_TEACH_IN,           
  NEW_DEVICE_AND_EPP,     
  SECURITY_TEACH_IN,      
  SECOND_TEACH_IN,        
  GENERIC_TEACH_IN,    
  REQUEST_FOR_TEACH_OUT
} TEACH_RETURN;

typedef enum
{
  RESP_REJECTED_GENERALLY = 0,
  RESP_TEACHIN,
  RESP_TEACHOUT,
  RESP_REJECTED_CHANNELS
} GP_RESPONSE_RESULT;

typedef std::map<uint32_t, bool> teach_id_map;
class eoTeachInModule : public eoISerialize
{

public:
  eoTeachInModule(eoDeviceManager *eoDevManager, eoSecurity *sec);
  virtual ~eoTeachInModule();

  void SetRPS(uint8_t func, uint8_t type);
  void Set1BS(uint8_t func, uint8_t type);
  void Set4BS(uint8_t func, uint8_t type);
  TEACH_RETURN TeachIN(eoMessage &m);

  TEACH_RETURN TeachIN(uint8_t rorg,uint8_t func,uint8_t type,uint32_t device_id);
  void SetAutoTeachOut(bool enable)
  {
    allowAutoTeachOut = enable;
  };
  bool GetAutoTeachOut()
  {
    return allowAutoTeachOut;
  };
  void TeachOut(uint32_t id);
  static bool isTeachIN(eoMessage &telegram);
  bool isTeachedIN(eoMessage &telegram) ;
  bool isTeachedIN(eoDevice &dev) ;
  bool isTeachedIN(uint32_t deviceID,uint8_t u8Rorg = 0xFF);
  DEPRECATED(eoReturn ParseUTE(eoMessage &msg));
  DEPRECATED(eoReturn CreateUTEResponse(eoMessage &teachInUTE, eoMessage &responseUTE, UTE_RESPONSE type, UTE_DIRECTION direction));


  eoReturn CreateGPResponse (eoMessage &msg, uint16_t manId, uint32_t destinationId, GP_RESPONSE_RESULT response, eoProfile *profile);

  virtual uint8_t Serialize(eoArchive &arch);
  UTE_EEP_TEACH_IN_QUERY GetUTEQuery();


private:
  teach_id_map teachInformation;
  eoSecurity *security;
  eoDeviceManager * deviceManager;
  uint8_t rps_func, rps_type, bs1_func, bs1_type, bs4_func, bs4_type;
  UTE_EEP_TEACH_IN_QUERY uteQuery;
  bool allowAutoTeachOut;

  bool IsDuplicatedSimpleTeachInMessage(eoMessage & m);
  bool LinkProfileToDevice(eoDevice * device, eoProfile * profile);

  friend class eoTeachMessageHandler;

};


#endif // !defined(EA_62DB5BA2_ABF0_41c3_9291_81B05C9C37AD__INCLUDED_)