eoGateway.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.
 ******************************************************************************/

#if !defined(_EO_GATEWAY_H)
#define _EO_GATEWAY_H

#include "eoHalTypes.h"
#include "eoApiDef.h"
#include "eoISerialize.h"
#include "eoMessage.h"
#include "eoTelegram.h"
#include "eoTelegramERP2.h"
#include "eoDevice.h"
#include "eoIFilter.h"
#include "eoPacketStream.h"
#include "eoDeviceManager.h"
#include "eoMessageHandler.h"
#include "eoSecurity.h"
#include "eoProfileFactory.h"
#include "eoTeachInModule.h"
#include "eoReManMessage.h"
#include "eoMaintenanceMessage.h"
#include "eoSerialCommand.h"
#include "eoIWatcher.h"
#include <queue>

typedef enum
{
  RECV_PACKET = (1 << 0), 
  RECV_TELEGRAM = (1 << 1), 
  RECV_MESSAGE = (1 << 2), 
  RECV_TEACHIN = (1 << 3), 
  RECV_PROFILE = (1 << 4), 
  RECV_TELEGRAM_SEC = (1 << 5), 
  RECV_ERROR = (1 << 6), 
  RECV_DEVICE_ADDED = (1 << 7), 
  RECV_SECTEACHIN = (1 << 8), 
  RECV_REMAN = (1 << 9), 
  RECV_TELEGRAM_ERP2 = (1 << 10), 
  RECV_MAINTENANCE = (1 << 11),
} RECEIVE_FLAGS;
class eoGateway: public eoISerialize
{
public:
  inline void LearnModeOn()
  {
    LearnMode = true;
  }
  inline void LearnModeOff()
  {
    LearnMode = false;
  }
  eoPacketStream *stream;
  eoTeachInModule* TeachInModule;
  eoDeviceManager *deviceManager;
  eoIFilter *filter;
  eoIFilter *learnFilter;
  eoIWatcher *secWatcher;
  uint32_t GetSecWatchResult() const
  {
    return secWatchResult;
  }
  bool LearnMode;
  uint8_t errorCode;
  eoDevice *device;
  eoPacket packet;
  eoPacket responsePacket;
  eoTelegram telegram;
  eoTelegramERP2 telegramERP2;
  eoMessage message;
  eoMaintenanceMessage maintenanceMessage;
  eoReManMessage reManMessage;
  eoSerialCommand commands;
  bool advancedMode;
  eoGateway();
  eoGateway(eoDeviceManager *devManager);
  eoGateway(eoPacketStream *str);
  eoGateway(eoPacketStream *str, eoDeviceManager *devManager);

  eoGateway(eoPacketStream *str, eoDeviceManager *devManager, eoIFilter * normFilter, eoIFilter * lrnFilter);

  virtual ~eoGateway();
  uint16_t Receive();

  virtual eoReturn Send(const eoPacket &p);
  virtual eoReturn Send(const eoMessage &msg);
  virtual eoReturn Send(const eoReManMessage &reMsg,bool shallBeRepeated=false,uint8_t keyToUse=0);
  virtual eoReturn Send(const eoMaintenanceMessage &manMsg);
  eoReturn Open(const char *port);

  eoSecurity security;
  void Close();
  uint8_t Serialize(eoArchive &arch);

private:
  void defaultConstructor();

  eoMessageHandler msgHandler;

  uint16_t flags;
  uint32_t secWatchResult;

  std::deque<eoPacket*> packet_queue;

  eoReturn learnHandler(eoTelegram &recvTelegram); //Handles received telegram in learnMode
  eoReturn secHandler(eoTelegram &recvTelegram); //Handles secure telegram
  eoReturn secHandler(eoMessage &recvTelegram); //Handles secure telegram
  eoReturn normalHandler(eoTelegram &recvTelegram); //Handles received telegram in normalMode

  //helper
  eoReturn handleSysEx(eoTelegram &recvTelegram);
  eoReturn handleMaintenance(eoTelegram &recvTelegram);
  eoReturn handleTelegramInLearn(eoTelegram &recvTelegram);
  eoReturn handleTelegramNormal(eoTelegram &recvTelegram);
};
#endif // !defined(_EO_GATEWAY_H)