EnOcean Link  1.14.0.0
Middleware to Connect EnOcean easily to other Projects
Macros | Enumerations | Variables
eoChannelEnums.h File Reference

Contains Channel Enums. More...

#include "eoHalTypes.h"
Include dependency graph for eoChannelEnums.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Macros

#define T_DATA   0x0000
 Data type flag.
 
#define T_FLAG   0x0F00
 Flag type flag.
 
#define T_GP_DATA_END   0x0100
 Flag type flag.
 
#define GP_ENUM   0x6000
 GP enum type flag.
 
#define T_ENUM   0xE000
 Enum type flag.
 
#define SIGNAL_CHANNELS   0xF000
 Signal type flag.
 
#define SP_ABS   0x1000
 Absolute Setpoint.
 
#define SP_REL   0x2000
 Relative Setpoint.
 
#define NUM_SIGNAL_STRINGS   0x2D
 Number of named signals, these are not GP channels but a bigger set.
 
#define NUM_FLAG_STRINGS   0x11
 Number of named flags.
 
#define NUM_ENUMS_STRINGS   0x20
 Number of named enums.
 
#define NUM_SIGNAL_STRING   0x14
 
#define NUM_GP_ENUMS_STRING   0x08
 Number of names GP enums.
 

Enumerations

enum  CHANNEL_TYPE {
  S_RES = 0x00, S_ACCEL = 0x01, S_ACCEL_ABS = S_ACCEL + SP_ABS, S_ACCEL_REL = S_ACCEL + SP_REL,
  S_ANGLE = 0x02, S_ANGLE_ABS = S_ANGLE + SP_ABS, S_ANGLE_REL = S_ANGLE + SP_REL, S_ANGVD = 0x03,
  S_ANGVD_ABS = S_ANGVD + SP_ABS, S_ANGVD_REL = S_ANGVD + SP_REL, S_AREA = 0x04, S_AREA_ABS = S_AREA + SP_ABS,
  S_AREA_REL = S_AREA + SP_REL, S_CONC = 0x05, S_CONC_ABS = S_CONC + SP_ABS, S_CONC_REL = S_CONC + SP_REL,
  S_CURRENT = 0x06, S_CURRENT_ABS = S_CURRENT + SP_ABS, S_CURRENT_REL = S_CURRENT + SP_REL, S_DISTANCE = 0x07,
  S_DISTANCE_ABS = S_DISTANCE + SP_ABS, S_DISTANCE_REL = S_DISTANCE + SP_REL, S_ELECFSTR = 0x08, S_ELECFSTR_ABS = S_ELECFSTR + SP_ABS,
  S_ELECFSTR_REL = S_ELECFSTR + SP_REL, S_ENERGY = 0x09, S_ENERGY_ABS = S_ENERGY + SP_ABS, S_ENERGY_REL = S_ENERGY + SP_REL,
  S_COUNTER = 0x0A, S_COUNTER_ABS = S_COUNTER + SP_ABS, S_COUNTER_REL = S_COUNTER + SP_REL, S_FORCE = 0x0B,
  S_FORCE_ABS = S_FORCE + SP_ABS, S_FORCE_REL = S_FORCE + SP_REL, S_FREQ = 0x0C, S_FREQ_ABS = S_FREQ + SP_ABS,
  S_FREQ_REL = S_FREQ + SP_REL, S_HEATFLUX = 0x0D, S_HEATFLUX_ABS = S_HEATFLUX + SP_ABS, S_HEATFLUX_REL = S_HEATFLUX + SP_REL,
  S_IMPULSE = 0x0E, S_IMPULSE_ABS = S_IMPULSE + SP_ABS, S_IMPULSE_REL = S_IMPULSE + SP_REL, S_LUMINANCE = 0x0F,
  S_LUMINANCE_ABS = S_LUMINANCE + SP_ABS, S_LUMINANCE_REL = S_LUMINANCE + SP_REL, S_MAGNETICF = 0x10, S_MAGNETICF_ABS = S_MAGNETICF + SP_ABS,
  S_MAGNETICF_REL = S_MAGNETICF + SP_REL, S_MASS = 0x11, S_MASS_ABS = S_MASS + SP_ABS, S_MASS_REL = S_MASS + SP_REL,
  S_MASSDENS = 0x12, S_MASSDENS_ABS = S_MASSDENS + SP_ABS, S_MASSDENS_REL = S_MASSDENS + SP_REL, S_MASSFLOW = 0x13,
  S_MASSFLOW_ABS = S_MASSFLOW + SP_ABS, S_MASSFLOW_REL = S_MASSFLOW + SP_REL, S_POWER = 0x14, S_POWER_ABS = S_POWER + SP_ABS,
  S_POWER_REL = S_POWER + SP_REL, S_PRESSURE = 0x15, S_PRESSURE_ABS = S_PRESSURE + SP_ABS, S_PRESSURE_REL = S_PRESSURE + SP_REL,
  S_RELHUM = 0x16, S_RELHUM_ABS = S_RELHUM + SP_ABS, S_RELHUM_REL = S_RELHUM + SP_REL, S_RESIST = 0x17,
  S_RESIST_ABS = S_RESIST + SP_ABS, S_RESIST_REL = S_RESIST + SP_REL, S_TEMP = 0x18, S_TEMP_ABS = S_TEMP + SP_ABS,
  S_TEMP_REL = S_TEMP + SP_REL, S_TIME = 0x19, S_TIME_ABS = S_TIME + SP_ABS, S_TIME_REL = S_TIME + SP_REL,
  S_TORQUE = 0x1A, S_TORQUE_ABS = S_TORQUE + SP_ABS, S_TORQUE_REL = S_TORQUE + SP_REL, S_VELOCITY = 0x1B,
  S_VELOCITY_ABS = S_VELOCITY + SP_ABS, S_VELOCITY_REL = S_VELOCITY + SP_REL, S_VOLTAGE = 0x1C, S_VOLTAGE_ABS = S_VOLTAGE + SP_ABS,
  S_VOLTAGE_REL = S_VOLTAGE + SP_REL, S_VOLUME = 0x1D, S_VOLUME_ABS = S_VOLUME + SP_ABS, S_VOLUME_REL = S_VOLUME + SP_REL,
  S_VOLFLOW = 0x1E, S_VOLFLOW_ABS = S_VOLFLOW + SP_ABS, S_VOLFLOW_REL = S_VOLFLOW + SP_REL, S_SETPOINT = 0x1F,
  S_SETPOINT_ABS = S_SETPOINT + SP_ABS, S_SETPOINT_REL = S_SETPOINT + SP_REL, S_PARTICLES = 0x20, S_PARTICLES_ABS = S_PARTICLES + SP_ABS,
  S_PARTICLES_REL = S_PARTICLES + SP_REL, S_DIMMING = 0x21, S_DIMMING_ABS = S_DIMMING + SP_ABS, S_DIMMING_REL = S_DIMMING + SP_REL,
  S_SOLAR_RAD = 0x22, S_SOLAR_RAD_ABS = S_SOLAR_RAD + SP_ABS, S_SOLAR_RAD_REL = S_SOLAR_RAD + SP_REL, S_PERCENTAGE = 0x23,
  S_PERCENTAGE_ABS = S_PERCENTAGE + SP_ABS, S_PERCENTAGE_REL = S_PERCENTAGE + SP_REL, S_VALUE = 0x24, S_VALUE_ABS = S_VALUE + SP_ABS,
  S_VALUE_REL = S_VALUE + SP_REL, S_RGB = 0x25, S_RGB_ABS = S_RGB + SP_ABS, S_RGB_REL = S_RGB + SP_REL,
  S_ERROR_CODE = 0x26, S_ERROR_CODE_ABS = S_ERROR_CODE + SP_ABS, S_ERROR_CODE_REL = S_ERROR_CODE + SP_REL, S_RADON_ACTIVITY = 0x27,
  S_RADON_ACTIVITY_ABS = S_RADON_ACTIVITY + SP_ABS, S_RADON_ACTIVITY_REL = S_RADON_ACTIVITY + SP_REL, S_AMPER_PER_HOUR = 0x28, S_AMPER_PER_HOUR_ABS = S_AMPER_PER_HOUR + SP_ABS,
  S_AMPER_PER_HOUR_REL = S_AMPER_PER_HOUR + SP_REL, S_ROTATION_PER_MIN = 0x29, S_ROTATION_PER_MIN_ABS = S_ROTATION_PER_MIN + SP_ABS, S_ROTATION_PER_MIN_REL = S_ROTATION_PER_MIN + SP_REL,
  S_PH = 0x2A, S_PH_ABS = S_PH + SP_ABS, S_PH_REL = S_PH + SP_REL, S_SOUNDPRESSURE = 0x2B,
  S_SOUNDPRESSURE_ABS = S_SOUNDPRESSURE + SP_ABS, S_SOUNDPRESSURE_REL = S_SOUNDPRESSURE + SP_REL, S_CORRELATED_COLOR_TEMPERATURE = 0x2C, S_CORRELATED_COLOR_TEMPERATURE_ABS = 0x2C + SP_ABS,
  S_CORRELATED_COLOR_TEMPERATURE_REL = 0x2C + SP_REL, S_PHOTOSYNTHETIC_PHOTON_FLUX_DENSITY = 0x2D, S_PHOTOSYNTHETIC_PHOTON_FLUX_DENSITY_ABS = 0x2D + SP_ABS, S_PHOTOSYNTHETIC_PHOTON_FLUX_DENSITY_REL = 0x2D + SP_REL,
  S_VOC_PERCENTAGE = 0x2E, S_VOC_PERCENTAGE_ABS = S_VOC_PERCENTAGE + SP_ABS, S_VOC_PERCENTAGE_REL = S_VOC_PERCENTAGE + SP_REL, E_ROCKER_A = T_ENUM + 0x01,
  E_ROCKER_B = T_ENUM + 0x02, E_ROCKER_C = T_ENUM + 0x03, E_ROCKER_D = T_ENUM + 0x04, E_ENERGYBOW = T_ENUM + 0x05,
  E_MULTIPRESS = T_ENUM + 0x06, E_WINDOWHANDLE = T_ENUM + 0x07, E_FANSPEED = T_ENUM + 0x08, E_TARIFF = T_ENUM + 0x09,
  E_VOC = T_ENUM + 0x0A, E_CONTROLLER_MODE = T_ENUM + 0x0B, E_ERROR_STATE = T_ENUM + 0x0C, E_STATE = T_ENUM + 0x0D,
  E_END_POS = T_ENUM + 0x0E, E_OCCUPANCY = T_ENUM + 0x0F, E_USER_ACTION = T_ENUM + 0x10, E_PRESENCE = T_ENUM + 0x11,
  E_DIM_VALUE = T_ENUM + 0x12, E_IO_CHANNEL = T_ENUM + 0x13, E_UNITS = T_ENUM + 0x14, E_DAYS = T_ENUM + 0x15,
  E_COMMAND = T_ENUM + 0x16, E_DIRECTION = T_ENUM + 0x17, E_ROOM_SIZE = T_ENUM + 0x18, E_KEY_DATA = T_ENUM + 0x19,
  E_GP_MULTIPURPOSE = GP_ENUM + 0x01, E_GP_BUILDING_MODE = GP_ENUM + 0x02, E_GP_OCCUPANCY = GP_ENUM + 0x03, E_GP_HVAC_MODE = GP_ENUM + 0x04,
  E_GP_CHANGEOVER_MODE = GP_ENUM + 0x05, E_GP_TIME = GP_ENUM + 0x06, E_GP_BATTERY = GP_ENUM + 0x07, F_AUTO_MAN = T_FLAG + 0x01,
  F_BTN_PRESS = T_FLAG + 0x02, F_BTN_TRIGGER = T_FLAG + 0x03, F_DAY_NIGHT = T_FLAG + 0x04, F_DOWN = T_FLAG + 0x05,
  F_GENALARM = T_FLAG + 0x06, F_HEAT_COOL = T_FLAG + 0x07, F_HIGH_LOW = T_FLAG + 0x08, F_OCCUPIED = T_FLAG + 0x09,
  F_ON_OFF = T_FLAG + 0x0A, F_OPEN_CLOSED = T_FLAG + 0x0B, F_POWERALARM = T_FLAG + 0x0C, F_START_STOP = T_FLAG + 0x0D,
  F_UP = T_FLAG + 0x0E, F_VIBRATION = T_FLAG + 0x0F, F_RES = T_FLAG + 0xFF, SIG_TYPE = SIGNAL_CHANNELS,
  SIG_TRIGGER_DETAILS = SIGNAL_CHANNELS + 0x01, SIG_ENERGY_STATUS = SIGNAL_CHANNELS + 0x02, SIG_SW_REVISION = SIGNAL_CHANNELS + 0x03, SIG_HW_REVISION = SIGNAL_CHANNELS + 0x04,
  SIG_EURID = SIGNAL_CHANNELS + 0x05, SIG_DBM_WORST = SIGNAL_CHANNELS + 0x06, SIG_DBM_BEST = SIGNAL_CHANNELS + 0x07, SIG_SUBTEL_COUNT = SIGNAL_CHANNELS + 0x08,
  SIG_MAX_REPEATER_LEVEL = SIGNAL_CHANNELS + 0x09, SIG_DUTY_CYCLE_STATUS = SIGNAL_CHANNELS + 0x0A, SIG_CHARGING_CAPABILITES = SIGNAL_CHANNELS + 0x0B, SIG_BACKUP_BATTERY_ENERGY = SIGNAL_CHANNELS + 0x0C,
  SIG_LINK_TABLE_FULL = SIGNAL_CHANNELS + 0x0D, SIG_REC_TI_REQ_MSG = SIGNAL_CHANNELS + 0x0E, SIG_LRN_MODE_TYPE = SIGNAL_CHANNELS + 0x0F, SIG_TEACH_RESULT = SIGNAL_CHANNELS + 0x10,
  SIG_REMAINING_LEARN_MODE = SIGNAL_CHANNELS + 0x11, SIG_TAUGHT_DEVICE_ID = SIGNAL_CHANNELS + 0x12, SIG_TAUGHT_EEP = SIGNAL_CHANNELS + 0x13, S_SOUNDPRESSURE_DBA = 0x2F,
  S_SOUNDPRESSURE_DBA_ABS = S_SOUNDPRESSURE_DBA + SP_ABS, S_SOUNDPRESSURE_DBA_REL = S_SOUNDPRESSURE_DBA + SP_REL
}
 
enum  VALUE_TYPE { VAL_CURR = 0x01, VAL_SP_ABS = 0x02, VAL_SP_REL = 0x03 }
 Value types.
 

Variables

const char signalStrings [NUM_SIGNAL_STRINGS][2][29]
 List of named signal types. When you add a new channel type, you've to update the description!!
 
const char flagStrings [NUM_FLAG_STRINGS][32]
 String names for flag channles. More...
 
const char enumStrings [NUM_ENUMS_STRINGS][32]
 String names for enum channles. More...
 
const char signalTypeString [NUM_SIGNAL_STRING][32]
 
const char gpEnumString [NUM_GP_ENUMS_STRING][20]
 String names for GP enum channels. More...
 

Detailed Description

Contains Channel Enums.

Author
EnOcean GmBH

Variable Documentation

◆ enumStrings

const char enumStrings[NUM_ENUMS_STRINGS][32]
Initial value:
=
{ "", "Rocker Button A", "Rocker Button B", "Rocker Button C", "Rocker Button D", "Energybow direction", "Multiple Buttons pressed?", "Windowhandle", "Fan Speed", "Tariff information", "VOC (Volatile organic compound)", "Controller mode", "Error state", "State", "End position", "Occupancy", "User action", "Presence", "Dim value", "Input/Output channel", "Units", "Days", "Commands" }

String names for enum channles.

◆ flagStrings

const char flagStrings[NUM_FLAG_STRINGS][32]
Initial value:
=
{
"", "Automatic flag", "Button pressed",
"Button triggered",
"Day/Night",
"Down",
"General alarm",
"Heat (1) / cool (0)",
"High (1) / low (0)",
"Occupied (1) / unoccupied (0)",
"On (1) / off (0)",
"Open (1) / closed (0)",
"Power alarm (1)",
"Start (1) / stop (0)",
"Up 'p'",
"Vibration(1) / No vibration (0)",
}

String names for flag channles.

◆ gpEnumString

const char gpEnumString[NUM_GP_ENUMS_STRING][20]
Initial value:
=
{
"",
"Multipurpose",
"Bulding Mode",
"Occupancy Mode",
"HVAC Mode",
"Changeover Mode",
"Time",
"Battery"
}

String names for GP enum channels.

◆ signalTypeString

const char signalTypeString[NUM_SIGNAL_STRING][32]
Initial value:
=
{
"MID","Trigger Details","Energy Status","SW Revision","HW Revision","ID","Worst dBm","Best dBm","Subtelegram Count",
"Max Repeater Level","Duty Cycle Status","Charging Capabilites", "Backup Battery Status","Link Table Full",
"Teach Request Enabled","Learn Mode Type","Teach Result","Remaining Learn Type","Taught in Device ID","Taught in EEP"
}