eoSignal.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_SIGNAL_H_
#define EO_SIGNAL_H_
//WIP adding newest signals
#include <stdint.h>
#include "eoProfile.h"
#include "eoMessage.h"
#include "eoEEProfile.h"
typedef enum
{
  SIGNAL_RESERVED = 0x00,
  SIGNAL_SMARTACK_MAILBOXEMTPY = 0x01,
  SIGNAL_SMARTACK_MAILBOXNOTEXISTENT = 0x02,
  SIGNAL_SMARTACK_RESET = 0x03,
  SIGNAL_TRIGGER_STATUS = 0x04,
  SIGNAL_ACK = 0x05,
  SIGNAL_ENERGY_STATUS = 0x06,
  SIGNAL_DEVICE_REVISION = 0x07,
  SIGNAL_HEARTBEAT = 0x08,
  SIGNAL_RX_OPEN = 0x09,
  SIGNAL_RX_QUALTIY = 0x0A,
  SIGNAL_DUTY_CYCLE_STATUS = 0x0B,
  SIGNAL_CONFIG_CHANGED = 0x0C,
  SIGNAL_HARVESTER_DELIVEY = 0x0D,
  SIGNAL_TX_OFF =  0x0E,
  SIGNAL_TX_ON = 0x0F,
  SIGNAL_BACKUP_BATTERY_STATUS = 0x10,
  SIGNAL_LEARN_MODUS_STATUS = 0x11,

} EEP_SIGNAL_TYPES;


typedef enum
{
  SIG_TRIGGER_EEP_STATUS = 0x00,
  SIG_TRIGGER_ENERGY_STATUS = 0x01,
  SIG_TRIGGER_REVISION = 0x02,
  SIG_TRIGGER_RX_LEVEL = 0x03,
  SIG_TRIGGER_CURRENT_HARVESTING = 0x04,
} SIGNAL_TRIGGER_TYPE;
typedef enum
{
  SIG_DELIVERY_EXCELLENT_ENERGY = 0x00, // Sunshine, charging at max level
  SIG_DELIVERY_GOOD_ENERGY = 0x01, //Device will slowly charge caps
  SIG_DELIVERY_AVERAGE_ENERGY = 0x02, //Device can operate normally
  SIG_DELIVERY_BAD_ENERGY = 0x03, //Device will discharge over time
  SIG_DELIVERY_VERY_BAD_ENERGY = 0x04 // No charging at all
} SIGNAL_ENERGY_DELIVERY;

typedef enum
{
  SIG_SUBTEL_UNKONW = 0x00, 
  SIG_SUBTEL_1 = 0x01, 
  SIG_SUBTEL_2 = 0x02, 
  SIG_SUBTEL_3 = 0x03, 
  SIG_SUBTEL_4 = 0x04, 
  SIG_SUBTEL_5 = 0x05, 
  SIG_SUBTEL_6 = 0x06, 
  SIG_SUBTEL_7 = 0x07, 
  SIG_SUBTEL_8 = 0x08, 
  SIG_SUBTEL_9 = 0x09, 
  SIG_SUBTEL_10 = 0x0A, 
  SIG_SUBTEL_11 = 0x0B, 
  SIG_SUBTEL_12 = 0x0C, 
  SIG_SUBTEL_13 = 0x0D, 
  SIG_SUBTEL_14 = 0x0E, 
  SIG_SUBTEL_15_OR_MORE = 0x0F, 
} SIGNAL_SUBTEL_COUNT;

typedef enum
{
  SIG_REPEATER_LEVEL_NONE = 0x00, 
  SIG_REPEATER_LEVEL_1 = 0x1, 
  SIG_REPEATER_LEVEL_2 =  0x2, 
  SIG_REPEATER_LEVEL_F = 0xF 
} SIGNAL_REPEATER_LEVEL;
typedef enum
{
  SIG_DUTY_CYCLE_EXCEEDED = 0x00, 
  SIG_DUTY_CYCLE_AVAILABLE = 0x1, 
} SIGNAL_DUTY_CYCLE;

typedef enum
{
  SIG_NO_BATTERY_AVAILABLE = 255, 
} SIGNAL_BACKUP_BATTERY_AVAILABLE;

typedef enum
{
  SIG_LINK_TABLE_NOT_FULL = 0,
  SIG_LINK_TABLE_IS_FULL = 1, 
} SIGNAL_LINK_TABLE_STATUS;

typedef enum
{
  SIG_REC_OF_TI_REQ_DISABLED = 0,
  SIG_REC_OF_TI_REQ_ENABLED = 1, 
} SIGNAL_REC_OF_TI_REQ;

typedef enum
{
  SIG_LRN_MODE_STANDARD = 0,
  SIG_LRN_MODE_EXTENDED1 = 1, 
  SIG_LRN_MODE_EXTENDED2 = 2, 
} SIGNAL_LRN_MODE;


typedef enum
{
  SIG_TEACH_IN_SUCCESS   = 0,
  SIG_TEACH_IN_FAIL_EEP_NOT_SUPPORTED = 1, 
  SIG_TEACH_IN_FAIL_EEP_FULL= 2, 
  SIG_TEACH_IN_TABLE_FULL = 3, 
  SIG_TEACH_OUT_SUCCESS = 4, 
  SIG_TEACH_OUT_FAILED = 5, 
} SIGNAL_TEACH_RESULT;
//TODO all the signal types enums :/

class eoSignal : public eoEEProfile
{
public:
  eoSignal();
  ~eoSignal();
  eoReturn SetMID(EEP_SIGNAL_TYPES type,bool receivedMessage);

  virtual eoReturn SetType(uint8_t type);
  virtual eoReturn Parse(const eoMessage &msg);

};

#endif /* EOEEPROFILE_H_ */