EnOcean Link  1.14.0.0
Middleware to Connect EnOcean easily to other Projects
eoSerialCommand.h File Reference

eoSerialCommand More...

#include "eoHalTypes.h"
#include "eoApiDef.h"
#include "eoPacket.h"
#include "eoSerialEvents.h"
#include <vector>
Include dependency graph for eoSerialCommand.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes

class  CO_RD_VERSION_RESPONSE
 Read version response. More...
 
struct  CO_RD_MEMORY
 Read memory command. More...
 
struct  CO_RD_MEMORY_RESPONSE
 Read memory response. More...
 
struct  CO_WR_MEMORY
 Read memory command. More...
 
class  CO_RD_IDBASE_RESPONSE
 Read base ID response. More...
 
class  CO_RD_REPEATER_RESPONSE
 Read repeater response. More...
 
class  CO_RD_FILTER_RESPONSE
 Read filter response. More...
 
struct  SA_CONFIRM_LEARN_REQUEST
 Confirm Learn response. More...
 
class  SA_LEARN_ACK_RESPONSE
 Learn SmartAck response. More...
 
class  CO_READY_RESPONSE
 Ready response. More...
 
class  SA_RD_LEARNMODE_RESPONSE
 SmartAck read learnmode response structure. More...
 
class  SA_RD_LEARNEDCLIENTS_RESPONSE
 SmartAck learned clients response structure. More...
 
struct  CO_RD_DUTYCYCLE_RESPONSE
 Read actual duty cycle limit structure. More...
 
class  eoSerialCommand
 EnOcean Common Commands class, enables an easy interface for the most common commands. More...
 

Enumerations

enum  COMMON_COMMAND_TYPE {
  CO_WR_SLEEP = 1, CO_WR_RESET = 2, CO_RD_VERSION = 3, CO_RD_SYS_LOG = 4,
  CO_WR_SYS_LOG = 5, CO_WR_BIST = 6, CO_WR_IDBASE = 7, CO_RD_IDBASE = 8,
  CO_WR_REPEATER = 9, CO_RD_REPEATER = 10, CO_WR_FILTER_ADD = 11, CO_WR_FILTER_DEL = 12,
  CO_WR_FILTER_DEL_ALL = 13, CO_WR_FILTER_ENABLE = 14, CO_RD_FILTER = 15, CO_WR_WAIT_MATURITY = 16,
  CO_WR_SUBTEL = 17, CO_WR_MEM = 18, CO_RD_MEM = 19, CO_RD_MEM_ADDRESS = 20,
  CO_RD_SECURITY = 21, CO_WR_SECURITY = 22, CO_WR_MODE = 28, CO_RD_SECUREDEVICE_COUNT = 29,
  CO_RD_SECUREDEVICE_BY_ID = 30, CO_WR_SECUREDEVICE_ADD_PSK = 31, CO_WR_SECUREDEVICE_SENDTEACHIN = 32, CO_WR_TEMPORARY_RLC_WINDOW = 33,
  CO_RD_SECUREDEVICE_PSK = 34, CO_RD_DUTYCYCLE_LIMIT = 35, CO_SET_BAUDRATE = 36, CO_GET_FREQUENCY_INFO = 37,
  CO_GET_STEPCODE = 39, CO_WR_SECUREDEVICE_CLEAR_LIST = 40, CO_WR_REMAN_CODE = 46, CO_WR_STARTUP_DELAY = 47,
  CO_WR_REMAN_REPEATING = 48, CO_RD_REMAN_REPEATING = 49, CO_SET_NOISETHRESHOLD = 50, CO_GET_NOISETHRESHOLD = 51,
  CO_WR_RLC_SAVE_PERIOD = 52, CO_WR_RLC_LEGACY_MODE = 53, CO_WR_SECUREDEVICEV2_ADD = 54, CO_RD_SECUREDEVICEV2_BY_INDEX = 55,
  CO_WR_RSSITEST_MODE = 58, CO_RD_RSSITEST_MODE = 59, CO_WR_SECUREDEVICE_MAINTENANCEKEY = 60, CO_RD_SECUREDEVICE_MAINTENANCEKEY = 61,
  CO_WR_TRANSPARENT_MODE = 62, CO_RD_TRANSPARENT_MODE = 63, CO_WR_TX_ONLY_MODE = 64, CO_RD_TX_ONLY_MODE = 65
}
 The most common commands for ESP3. More...
 
enum  FILTER_KIND { BLOCK_RADIO = 0x00, APPLY_RADIO = 0x80, BLOCK_REPEATED = 0x40, APPLY_REPEATED = 0xC0 }
 Filter kinds. More...
 
enum  FILTER_TYPE { SOURCE_ID = 0, CHOICE = 1, DBM = 2, DESTINATION_ID = 0 }
 Filter types. More...
 
enum  MEMORY_TYPE {
  FLASH = 0, RAM_0 = 0x01, DATA_RAM = 0x02, IDATA_RAM = 0x03,
  XDATA_RAM = 0x04
}
 Memory TYPE.
 
enum  FILTER_OPERATOR { OR = 0, AND = 1 }
 Filter operator. More...
 
enum  EC_RESET_CAUSE {
  EC_VOLTAGE_DROP = 0x00, EC_RESET_PIN = 0x01, EC_WATCHDOG_TIMER = 0x02, EC_FLYWHEEL_TIMER = 0x03,
  EC_PARITY_ERROR = 0x04, EC_PARITY_MEM_ERROR = 0x05, EC_MEM_ERRPR = 0x06, EC_WAKE_PIN_0 = 0x07,
  EC_WAKE_PIN_1 = 0x08, EC_UNKNOWN = 0x09
}
 Reset cause according ESP 3. More...
 
enum  WR_MODE_CODE { MODE_COMPATIBLE = 0x00, MODE_ADVANCED = 0x01 }
 Types of mode. More...
 
enum  SA_COMMAND_TYPE {
  SA_WR_LEARNMODE = 1, SA_RD_LEARNMODE = 2, SA_WR_LEARNCONFIRM = 3, SA_WR_CLIENTLEARNRQ = 4,
  SA_WR_RESET = 5, SA_RD_LEARNEDCLIENTS = 6, SA_WR_RECLAIMS = 7, SA_WR_POSTMASTER = 8
}
 SmartAck command enum. More...
 
enum  SMARTACK_CONFIRM_CODE { SA_CC_LEARNIN = 0X00, SA_CC_LEARNOUT = 0X20 }
 SmartAck confirm code enum send to gateway in serial command. More...
 
enum  SA_EXTENDED_LEARNMODE { SA_EL_SIMPLE = 0X00, SA_EL_ADVANCE = 0X01, SA_EL_ADVANCE_REP = 0X02 }
 SmartAck extended learnmode enum. More...
 
enum  ESP3_FREQUENCY {
  MHZ_315 =0x00, MHZ_868_3 = 0x01, MHZ_902_875 = 0x02, MHZ_925 = 0x03,
  MHZ_928 = 0x04, GHZ_2_4 = 0x20
}
 
enum  ESP3_PROTOCOL {
  ERP1 = 0x00, ERP2 = 0x01, IEEE_802_15_4 = 0x10, BLUETOOTH = 0x20,
  LONGRANGE = 0x30
}
 
enum  CO_TX_ONLY_MODE { TX_ONLY_OFF = 0, TX_ONLY_ON =1, TX_ONLY_WITH_ON_AUTO_SLEEP =2, TX_ONLY_MAX }
 

Detailed Description

eoSerialCommand

Author
EnOcean GmBH

Enumeration Type Documentation

◆ COMMON_COMMAND_TYPE

The most common commands for ESP3.

Enumerator
CO_WR_SLEEP 

Order to enter in energy saving mode.

CO_WR_RESET 

Order to reset the device.

CO_RD_VERSION 

Read the device (SW) version / (HW) version, chip ID etc.

CO_RD_SYS_LOG 

Read system log from device databank.

CO_WR_SYS_LOG 

Reset System log from device databank.

CO_WR_BIST 

Perform Flash BIST operation.

CO_WR_IDBASE 

Write ID range base number.

CO_RD_IDBASE 

Read ID range base number.

CO_WR_REPEATER 

Write Repeater Level off,1,2.

CO_RD_REPEATER 

Read Repeater Level off,1,2.

CO_WR_FILTER_ADD 

Add filter to filter list.

CO_WR_FILTER_DEL 

Delete filter from filter list.

CO_WR_FILTER_DEL_ALL 

Delete filters.

CO_WR_FILTER_ENABLE 

Enable/Disable supplied filters.

CO_RD_FILTER 

Read supplied filters.

CO_WR_WAIT_MATURITY 

Waiting till end of maturity time before received radio telegrams will transmitted.

CO_WR_SUBTEL 

Enable/Disable transmitting additional subtelegram info.

CO_WR_MEM 

Write x bytes of the Flash, XRAM, RAM0 ….

CO_RD_MEM 

Read x bytes of the Flash, XRAM, RAM0 ….

CO_RD_MEM_ADDRESS 

Feedback about the used address and length of the config area and the Smart Ack Table.

CO_RD_SECURITY 

Read security informations (level, keys)

CO_WR_SECURITY 

Write security informations (level, keys)

CO_WR_MODE 

Write mode, Advanced or Compatible mode.

CO_RD_SECUREDEVICE_COUNT 

Read number of teached in secure devices.

CO_RD_SECUREDEVICE_BY_ID 

Check, if secure device with given Id is teached in.

CO_WR_SECUREDEVICE_ADD_PSK 

Add Pre-shared key for inbound secure device.

CO_WR_SECUREDEVICE_SENDTEACHIN 

Send secure Teach-In message.

CO_WR_TEMPORARY_RLC_WINDOW 

Set the temporary rolling-code window.

CO_RD_SECUREDEVICE_PSK 

Read Pre-shared key for inbound secure device.

CO_RD_DUTYCYCLE_LIMIT 

Read actual duty cycle limit values.

CO_SET_BAUDRATE 

Modifies the baudrate of the device.

CO_GET_FREQUENCY_INFO 

Set frequency info.

CO_GET_STEPCODE 

Get the chip revision.

CO_WR_SECUREDEVICE_CLEAR_LIST 

Clear the internal list of all secure devices.

CO_WR_REMAN_CODE 

Write the reman code.

CO_WR_STARTUP_DELAY 

Modify the startup time for a time.

CO_WR_REMAN_REPEATING 

Select if REMAN telegrams originating from this transceiver can be repeated.

CO_RD_REMAN_REPEATING 

Check if the REMAN telegrams originating from this module can be repeated.

CO_SET_NOISETHRESHOLD 

Sets the RSSI noise rejection threshold level for telegram reception. Received Signals below this threshold will be filtered out.

CO_GET_NOISETHRESHOLD 

Read the RSSI noise threshold level for telegram detection.

CO_WR_RLC_SAVE_PERIOD 

Select how frequently the rolling codes in the outbound secure link table will be saved to the NVM.

CO_WR_RLC_LEGACY_MODE 

Enable / disable the legacy RLC processing mode for 24 bit RLC.

CO_WR_SECUREDEVICEV2_ADD 

Add device to secure link table. New version to allow for 32 bit RLC.

CO_RD_SECUREDEVICEV2_BY_INDEX 

Read device from secure link table by index (new version for 32 bit RLC).

CO_WR_RSSITEST_MODE 

Enter a state where it mirrors the RSSI signal strength.

CO_RD_RSSITEST_MODE 

Enter a state where it mirrors the RSSI signal strength.

CO_WR_SECUREDEVICE_MAINTENANCEKEY 

Add secure device maintenance key to controller.

CO_RD_SECUREDEVICE_MAINTENANCEKEY 

Read secure device maintenance by index.

CO_WR_TRANSPARENT_MODE 

Change the firmware to run in a transparent mode, deactivates chaining,reman,encryption.

CO_RD_TRANSPARENT_MODE 

Reads if the firmware runs in a transparent mode.

CO_WR_TX_ONLY_MODE 

This command enables/disables the tx only mode of a device. The device still can send but will disable the rx of the radio totally.

CO_RD_TX_ONLY_MODE 

This command reads the current state of the receiver.

◆ EC_RESET_CAUSE

Reset cause according ESP 3.

Enumerator
EC_VOLTAGE_DROP 

Voltage supply drop or indicates that VDD > VON.

EC_RESET_PIN 

Reset caused by usage of the reset pin.

EC_WATCHDOG_TIMER 

Watchdog timer counter reached the time period.

EC_FLYWHEEL_TIMER 

Flywheel timer counter reached the time period.

EC_PARITY_ERROR 

Parity error.

EC_PARITY_MEM_ERROR 

HW Parity error in internal or external memory.

EC_MEM_ERRPR 

CPU memory request does not correspond to valid memory location.

EC_WAKE_PIN_0 

Wake-up pint 0 activated.

EC_WAKE_PIN_1 

Wake-up pint 1 activated.

EC_UNKNOWN 

Unknown reset source.

◆ FILTER_KIND

Filter kinds.

Enumerator
BLOCK_RADIO 

Blocking radio filter.

APPLY_RADIO 

Applying radio filter.

BLOCK_REPEATED 

Block filtered repeating.

APPLY_REPEATED 

Apply filtered repeating.

◆ FILTER_OPERATOR

Filter operator.

Enumerator
OR 

OR composition of filters.

AND 

AND composition of filters.

◆ FILTER_TYPE

Filter types.

Enumerator
SOURCE_ID 

Source ID filter.

CHOICE 

Choice filter.

DBM 

dBm filter

DESTINATION_ID 

Destination ID filter.

◆ SA_COMMAND_TYPE

SmartAck command enum.

Enumerator
SA_WR_LEARNMODE 

Set/Reset Smart Ack learn mode.

SA_RD_LEARNMODE 

Get Smart Ack learn mode state.

SA_WR_LEARNCONFIRM 

Used for Smart Ack to add or delete a mailbox of a client.

SA_WR_CLIENTLEARNRQ 

Send Smart Ack Learn request (Client)

SA_WR_RESET 

Send reset command to every SA sensor.

SA_RD_LEARNEDCLIENTS 

Get Smart Ack learned sensors / mailboxes.

SA_WR_RECLAIMS 

Set number of reclaim attempts.

SA_WR_POSTMASTER 

Activate/Deactivate Post master functionality.

◆ SA_EXTENDED_LEARNMODE

SmartAck extended learnmode enum.

Enumerator
SA_EL_SIMPLE 

Simple Learnmode.

SA_EL_ADVANCE 

Advanced Learnmode.

SA_EL_ADVANCE_REP 

Advanced Learnmode select Rep.

◆ SMARTACK_CONFIRM_CODE

SmartAck confirm code enum send to gateway in serial command.

Enumerator
SA_CC_LEARNIN 

Learn IN.

SA_CC_LEARNOUT 

Learn OUT.

◆ WR_MODE_CODE

Types of mode.

Enumerator
MODE_COMPATIBLE 

Compatible mode (default)

MODE_ADVANCED 

Advanced mode.