eoRemoteManager.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_REMOTE_MANAGER_H_
#define EO_REMOTE_MANAGER_H_


typedef enum
{
  R_START_LEARN = 1, //Start learn
  R_NEXT_CHANNEL,  //Next channel
  R_STOP_LEARN,  //Stop learn
  R_S_SIMPLE_LEARN, //SmartACK start simple learn mode
  R_S_ADVANCED_LEARN, //SmartACK start advanced learn mode
  R_S_STOP_LEARN  //SmartACK stop learn
} REMOTE_TYPE;

typedef enum
{
  FN_UNLOCK = 0x001, //Unlock
  FN_LOCK = 0x002, //Lock
  FN_SETCODE = 0x003, //Set code
  FN_QUERYID = 0x004, //Query ID
  FN_QUERYID_ANSWER = 0x604, //Query ID answer
  FN_QUERYID_ANSWER_EXT = 0x704,
  FN_ACTION = 0x005, //Action
  FN_PING  = 0x006, //Ping
  FN_PING_ANSWER  = 0x606, //Ping answer
  FN_QUERY_FUNCTION = 0x007, //Query function
  FN_QUERY_FUNCTION_ANSWER = 0x607, //Query function answer
  FN_QUERY_STATUS = 0x008, //Query status
  FN_QUERY_STATUS_ANSWER = 0x608, //Query status answer
  FN_START_SESSION = 0x009,
  FN_START_SESSION_ANSWER = 0x609,
  FN_CLOSE_SESSION = 0x00A,
  FN_REMOTE_LEARNIN = 0x201, //Remote learn in
  FN_REMOTE_FLASH_WRITE = 0x203, //Remote flash write
  FN_REMOTE_FLASH_READ = 0x204, //Remote flash read
  FN_REMOTE_FLASH_READ_ANSWER = 0x804, //Remote flash read answer
  FN_SMARTACK_READ = 0x205, //SmartACK read
  FN_SMARTACK_READ_MAILBOX_ANSWER = 0x805, //SmartACK read mailbox answer
  FN_SMARTACK_READ_LEARNED_SENSOR_ANSWER = 0x806, //SmartACK read learned sensor answer
  FN_SMARTACK_WRITE = 0x206 //SmartACK write
} FN_CODE;

typedef struct
{
  uint8_t rorg; //EEP RORG 8 bits
  uint8_t func; //EEP Function 6 bits
  uint8_t type; //EEP Type 7 bits
} QUERY_ID;

typedef struct
{
  uint8_t rorg; //EEP RORG 8 bits
  uint8_t func; //EEP Function 6 bits
  uint8_t type; //EEP Type 7 bits
  uint8_t locked; //Locked by other manager - bool
} QUERY_ID_RESPONSE;

typedef struct
{
  uint16_t functionNum; //Function number
  uint16_t manufaturerID; //Manufacturer ID
} QUERY_FUNCTION_RESPONSE;

typedef struct
{
  uint8_t rorg; //EEP RORG
  uint8_t func; //EEP Function
  uint8_t type; //EEP Type
  int8_t  rssi; //RSSI of the pinged device
} PING_RESPONSE;


typedef enum
{
  START_SESSION_OK = 0x00,
  START_SESSION_ALREADY_OPEN = 0x01,
  START_RESPONSE_MAX,
} START_RESPONSE;
typedef struct
{
  bool codeSetFlag; //Code set flag
  uint8_t lastSEQ;  //Last SEQ
  uint16_t lastFunc; //Last function code
  uint8_t lastFuncRet; //Last function return code
} QUERY_STATUS_RESPONSE;

typedef struct
{
  uint8_t data; //Read data
} FLASH_READ_RESPONSE;

typedef struct
{
  uint16_t flashAddress;//SmartAck flash address where the settings are stored
  uint16_t mailboxCount; //Number of mailboxes
} MAILBOX_SETTINGS_RESPONSE;

typedef struct
{
  uint32_t sensorID; //Device ID of the sensor
  uint32_t controllerID; //Device ID of the controller
  uint8_t learnedCount; //Number of learned in devices
} LEARNED_SENSOR_RESPONSE;
class eoRemoteManager
{
private:
  eoGateway *gateway;
  eoReManMessage reManMessage;
  bool shallBeRepeated;
  uint8_t keyToUse;

  eoReturn sendMessage()
  {
    return gateway->Send(reManMessage, shallBeRepeated, keyToUse);
  }
public:
  eoRemoteManager(eoGateway *gateway);
  ~eoRemoteManager();


  bool GetKeyToUse() const
  {
    return keyToUse;
  };
  void SetKeyToUse(uint8_t key)
  {
    keyToUse = key;
  };
  bool GetShallBeRepeated() const
  {
    return shallBeRepeated;
  };
  void SetShallBeRepeated(bool repeat)
  {
    shallBeRepeated = repeat;
  };
  eoReturn UnLock(const uint32_t securityCode, const uint32_t destinationID);
  eoReturn Lock(const uint32_t securityCode, const uint32_t destinationID);


  eoReturn Start(const uint32_t destinationID);
  eoReturn ParseStartAnswear(START_RESPONSE &responseCode);

  eoReturn Close(const uint32_t destinationID);

  eoReturn SetCode(const uint32_t securityCode, const uint32_t destinationID);
  eoReturn Action(const uint32_t destinationID);
  eoReturn Ping(const uint32_t destinationID);
  eoReturn ParsePingAnswer(PING_RESPONSE &response);
  eoReturn QueryID(const QUERY_ID &msg);
  eoReturn ParseQueryIDAnswer(QUERY_ID_RESPONSE &response);
  eoReturn ParseQueryIDAnswer(QUERY_ID &response);
  eoReturn QueryFunction(const uint32_t destinationID);
  eoReturn ParseQueryFunctionAnswer(QUERY_FUNCTION_RESPONSE *response, uint8_t maxIDCount, uint8_t &IDCount);
  eoReturn QueryStatus(const uint32_t destinationID);
  eoReturn ParseQueryStatusAnswer(QUERY_STATUS_RESPONSE &response);
  eoReturn RemoteLearnIn(const uint32_t destinationID, REMOTE_TYPE learnFlag);
  eoReturn RemoteFlashWrite(const uint32_t destinationID, const uint16_t &memoryAddress, const uint16_t numOfBytes, const uint8_t data[]);
  eoReturn RemoteFlashRead(const uint32_t destinationID, const uint16_t &memoryAddress, const uint16_t numOfBytes);
  eoReturn ParseRemoteFlashReadAnswer(FLASH_READ_RESPONSE *response, uint16_t *dataCount, uint8_t maxDataCount);
  eoReturn RemoteSmartReadMailboxSettings(const uint32_t destinationID);
  eoReturn ParseRemoteSmartReadMailboxSettingsAnswer(MAILBOX_SETTINGS_RESPONSE &response);
  eoReturn RemoteSmartReadLearnedSensors(const uint32_t destinationID);
  eoReturn ParseRemoteSmartReadLearnedSensors(LEARNED_SENSOR_RESPONSE *response, uint8_t *learnedCount, uint8_t maxLearnedCount);
  eoReturn RemoteSmartAddMailbox(const uint32_t destinationID, const uint8_t mailboxIndex, const uint32_t sensorID, const uint32_t postmasterID);
  eoReturn RemoteSmartDeleteMailbox(const uint32_t destinationID, const uint8_t mailboxIndex);
  eoReturn RemoteSmartLearnIn(const uint32_t destinationID, const uint8_t learnCount, const uint32_t sensorID, const uint32_t controllerID);
  eoReturn RemoteSmartLearnOut(const uint32_t destinationID, const uint8_t learnCount, const uint32_t sensorID, const uint32_t controllerID);

};

#endif // !defined(EA_4BFBF49B_3520_48f7_BACB_B62331BA4509__INCLUDED_)