eoSignal.h File Reference

Class for parsing signal telegrams, and generate parsed answears. More...

#include <stdint.h>
#include "eoProfile.h"
#include "eoMessage.h"
#include "eoEEProfile.h"

Include dependency graph for eoSignal.h:

Go to the source code of this file.

Classes
class	eoSignal
	abstract class for eosignals parsing More...

Enumerations
enum	EEP_SIGNAL_TYPES {   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 }
enum	SIGNAL_TRIGGER_TYPE {   SIG_TRIGGER_EEP_STATUS = 0x00, SIG_TRIGGER_ENERGY_STATUS = 0x01, SIG_TRIGGER_REVISION = 0x02, SIG_TRIGGER_RX_LEVEL = 0x03,   SIG_TRIGGER_CURRENT_HARVESTING = 0x04 }
enum	SIGNAL_ENERGY_DELIVERY {   SIG_DELIVERY_EXCELLENT_ENERGY = 0x00, SIG_DELIVERY_GOOD_ENERGY = 0x01, SIG_DELIVERY_AVERAGE_ENERGY = 0x02, SIG_DELIVERY_BAD_ENERGY = 0x03,   SIG_DELIVERY_VERY_BAD_ENERGY = 0x04 }
enum	SIGNAL_SUBTEL_COUNT {   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 }
enum	SIGNAL_REPEATER_LEVEL { SIG_REPEATER_LEVEL_NONE = 0x00, SIG_REPEATER_LEVEL_1 = 0x1, SIG_REPEATER_LEVEL_2 = 0x2, SIG_REPEATER_LEVEL_F = 0xF }
enum	SIGNAL_DUTY_CYCLE { SIG_DUTY_CYCLE_EXCEEDED = 0x00, SIG_DUTY_CYCLE_AVAILABLE = 0x1 }
enum	SIGNAL_BACKUP_BATTERY_AVAILABLE { SIG_NO_BATTERY_AVAILABLE = 255 }
enum	SIGNAL_LINK_TABLE_STATUS { SIG_LINK_TABLE_NOT_FULL = 0, SIG_LINK_TABLE_IS_FULL = 1 }
enum	SIGNAL_REC_OF_TI_REQ { SIG_REC_OF_TI_REQ_DISABLED = 0, SIG_REC_OF_TI_REQ_ENABLED = 1 }
enum	SIGNAL_LRN_MODE { SIG_LRN_MODE_STANDARD = 0, SIG_LRN_MODE_EXTENDED1 = 1, SIG_LRN_MODE_EXTENDED2 = 2 }
enum	SIGNAL_TEACH_RESULT {   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 }

Detailed Description

Class for parsing signal telegrams, and generate parsed answears.

Author

EnOcean GmBH

Enumeration Type Documentation

EEP_SIGNAL_TYPES

enum EEP_SIGNAL_TYPES

Enumerator
SIGNAL_SMARTACK_MAILBOXEMTPY	Smart Ack Mailbox empty, no additional data needed.
SIGNAL_SMARTACK_MAILBOXNOTEXISTENT	Smart Ack Mailbox does not exist, no additional data needed.
SIGNAL_SMARTACK_RESET	Smart Ack Reset : Trigger LRN Request , no additional data needed.
SIGNAL_TRIGGER_STATUS	Trigger status message of device, additional data needed.
SIGNAL_ACK	Last unicast - message acknowledge, no additional data needed.
SIGNAL_ENERGY_STATUS	Energy status of device, additional data needed.
SIGNAL_DEVICE_REVISION	Revision of device, additional data needed.
SIGNAL_HEARTBEAT	Heartbeat,no additional data needed.
SIGNAL_RX_OPEN	RX - window open,no additional data needed.
SIGNAL_RX_QUALTIY	RX - channel quality, additional data needed.
SIGNAL_DUTY_CYCLE_STATUS	Duty - cycle status, additional data needed.
SIGNAL_CONFIG_CHANGED	SIGNAL_CONFIG_CHANGED,no additional data needed.
SIGNAL_HARVESTER_DELIVEY	Energy delivery of the harvester, additional data needed.
SIGNAL_TX_OFF	TX Mode off.
SIGNAL_TX_ON	TX Mode on.
SIGNAL_BACKUP_BATTERY_STATUS	Backup Battery status.
SIGNAL_LEARN_MODUS_STATUS	TX Mode on.

SIGNAL_DUTY_CYCLE

enum SIGNAL_DUTY_CYCLE

Enumerator
SIG_DUTY_CYCLE_AVAILABLE	TX Duty cycle limit exceeded. Further communication is not possible.

SIGNAL_LINK_TABLE_STATUS

enum SIGNAL_LINK_TABLE_STATUS

Enumerator
SIG_LINK_TABLE_IS_FULL	Space available in the link table.

SIGNAL_LRN_MODE

enum SIGNAL_LRN_MODE

Enumerator
SIG_LRN_MODE_EXTENDED1	StandardLearn Mode= Binding of devices without further action.
SIG_LRN_MODE_EXTENDED2	Extended Learn Mode#1 , defined by the application.

SIGNAL_REC_OF_TI_REQ

enum SIGNAL_REC_OF_TI_REQ

Enumerator
SIG_REC_OF_TI_REQ_ENABLED	Reception of Teach Request Message disabled.

SIGNAL_REPEATER_LEVEL

enum SIGNAL_REPEATER_LEVEL

Enumerator
SIG_REPEATER_LEVEL_1	Max Repeater Level 0 received.
SIG_REPEATER_LEVEL_2	Max Repeater Level 1 received.
SIG_REPEATER_LEVEL_F	Max Repeater Level 2 received.

SIGNAL_SUBTEL_COUNT

enum SIGNAL_SUBTEL_COUNT

Enumerator
SIG_SUBTEL_1	No count available.
SIG_SUBTEL_2	1 Subtel received during RX intervall
SIG_SUBTEL_3	2 Subtel received during RX intervall
SIG_SUBTEL_4	3 Subtel received during RX intervall
SIG_SUBTEL_5	4 Subtel received during RX intervall
SIG_SUBTEL_6	5 Subtel received during RX intervall
SIG_SUBTEL_7	6 Subtel received during RX intervall
SIG_SUBTEL_8	7 Subtel received during RX intervall
SIG_SUBTEL_9	8 Subtel received during RX intervall
SIG_SUBTEL_10	9 Subtel received during RX intervall
SIG_SUBTEL_11	10 Subtel received during RX intervall
SIG_SUBTEL_12	11 Subtel received during RX intervall
SIG_SUBTEL_13	12 Subtel received during RX intervall
SIG_SUBTEL_14	13 Subtel received during RX intervall
SIG_SUBTEL_15_OR_MORE	14 Subtel received during RX intervall

SIGNAL_TEACH_RESULT

enum SIGNAL_TEACH_RESULT

Enumerator
SIG_TEACH_IN_FAIL_EEP_NOT_SUPPORTED	Teach-In of Device-ID successfull.
SIG_TEACH_IN_FAIL_EEP_FULL	: Teach-In of Device-ID failed, Device-EEP not supported
SIG_TEACH_IN_TABLE_FULL	Teach-In of Device-ID failed, Number of devices of Device-EEP exceeded.
SIG_TEACH_OUT_SUCCESS	Teach-In of Device-ID failed, Number of devices exceeded.
SIG_TEACH_OUT_FAILED	Teach-Out of Device-ID successful.

SIGNAL_TRIGGER_TYPE

enum SIGNAL_TRIGGER_TYPE

Enumerator
SIG_TRIGGER_ENERGY_STATUS	EEP Status. (Response: Defined by device)
SIG_TRIGGER_REVISION	Energy status (Response: MID 0x06)
SIG_TRIGGER_RX_LEVEL	Revision of device (Response: MID 0x07)
SIG_TRIGGER_CURRENT_HARVESTING	RX Level of received request(this) telegram(Response: MID 0x0A)