EnOcean Link  1.14.0.0
Middleware to Connect EnOcean easily to other Projects
Remote Commissioning API

This section shows the functions and structures used for remote commissioning. More...

Collaboration diagram for Remote Commissioning API:

Classes

class  eoReCom
 Remote Commissioning interface class. More...
 
enum  eoReComReturn {
  RECOM_OK = 0x00, RECOM_WRONG_ID = 0x01, RECOM_WRONG_UNLOCK_CODE = 0x02, RECOM_WRONG_EEP = 0x03,
  RECOM_WRONG_MANUFACTURER_ID = 0x04, RECOM_WRONG_DATA_SIZE = 0x05, RECOM_NO_CODE_SET = 0x06, RECOM_NOT_SEND = 0x07,
  RECOM_RPC_FAIL = 0x08, RECOM_MSG_TIMEOUT = 0x09, RECOM_MSG_TOO_LONG = 0x0A, RECOM_MSG_PART_RECEIVED = 0x0B,
  RECOM_MSG_PART_NOT_RECEIVED = 0x0C, RECOM_ADDR_OUT_OF_RANGE = 0x0D, RECOM_CODE_DATA_SIZE_EXCEED = 0x0E, RECOM_SESSION_CLOSED = 0x10,
  RECOM_INSUFFICENT_RIGHTS = 0x11
}
 Contains all the return values from ReCom functions. More...
 
enum  FN_RECOM_CODE {
  FN_RECOM_ACK = 0x240, FN_RECOM_GET_METADATA = 0x210, FN_RECOM_GET_METADATA_RESPONSE = 0x810, FN_RECOM_GET_TABLE = 0x211,
  FN_RECOM_GET_TABLE_RESPONSE = 0x811, FN_RECOM_SET_TABLE = 0x212, FN_RECOM_GET_GP_TABLE = 0x213, FN_RECOM_GET_GP_TABLE_RESPONSE = 0x813,
  FN_RECOM_SET_GP_TABLE = 0x214, FN_RECOM_SET_LEARN_MODE = 0x220, FN_RECOM_TRIG_OUTBOUND_TEACH_REQ = 0x221, FN_RECOM_GET_DEVICE_CONFIG = 0x230,
  FN_RECOM_GET_DEVICE_CONFIG_RESPONSE = 0x830, FN_RECOM_SET_DEVICE_CONFIG = 0x231, FN_RECOM_GET_LINK_BASED_CONFIG = 0x232, FN_RECOM_GET_LINK_BASED_CONFIG_RESPONSE = 0x832,
  FN_RECOM_SET_LINK_BASED_CONFIG = 0x233, FN_RECOM_APPLY_CHANGES = 0x226, FN_RECOM_RESET_TO_DEFAULTS = 0x224, FN_RECOM_RADIO_LINK_TEST_CONTROL = 0x225,
  FN_RECOM_GET_PRODUCT_ID = 0x227, FN_RECOM_GET_PRODUCT_RESPONSE = 0x827, FN_RECOM_GET_REPEATER_FUNCTIONS = 0x250, FN_RECOM_GET_REPEATER_FUNCTIONS_RESPONSE = 0x850,
  FN_RECOM_SET_REPEATER_FUNCTIONS = 0x251, FN_RECOM_SET_REPEATER_FILTER = 0x252
}
 Function codes for Remote Commissioning. More...
 
enum  RECOM_SUPPORT { RECOM_NOT_SUPPORTED = 0x00, RECOM_SUPPORTED = 0x01 }
 Enums for supported flags. More...
 
enum  RECOM_TABLE_DIR { RECOM_INBOUND_TABLE = 0x00, RECOM_OUTBOUND_TABLE = 0x01 }
 Enums for table direction. More...
 
enum  RECOM_CHANGES { RECOM_CHANGES_NOT_APPLY = 0x00, RECOM_CHANGES_APPLY = 0x01 }
 Enums for changes. More...
 
enum  RECOM_LEARN_MODE { RECOM_LEARN_IN = 0x00, RECOM_LEARN_OUT = 0x01, RECOM_EXIT_LEARN = 0x02 }
 Enums for learn modes. More...
 
enum  RECOM_RESET { RECOM_NO_DEFAULT_RESET = 0x00, RECOM_DEFAULT_RESET = 0x01 }
 Enums for configuration. More...
 
enum  RECOM_REPEATER_FUNC { RECOM_REPEATER_OFF = 0x00, RECOM_REPEATER_ON = 0x01, RECOM_FILTERED_REPEATER_ON = 0x02 }
 Enums for repeater function. More...
 
enum  RECOM_REPEATER_LEVEL { RECOM_REPEATER_LEVEL_1 = 0x01, RECOM_REPEATER_LEVEL_2 = 0x02 }
 Enums for repeater level. More...
 
enum  RECOM_REPEATER_FILTER { RECOM_REPEATER_AND = 0x00, RECOM_REPEATER_OR = 0x01 }
 Enums for repeater filter. More...
 
enum  RECOM_REPEATER_FILTER_CONTROL { RECOM_REPEATER_BLOCK = 0x00, RECOM_REPEATER_APPLY = 0x01, RECOM_REPEATER_DELETE_FILTER = 0x02, RECOM_REPEATER_DELETE_ALL = 0x03 }
 Enums for repeater filter control. More...
 
enum  RECOM_REPEATER_FILTER_TYPE { RECOM_FILTER_SOURCE_ID = 0x00, RECOM_FILTER_RORG = 0x01, RECOM_FILTER_DBM = 0x02, RECOM_FILTER_DESTINATION_ID = 0x03 }
 Enums for repeater filter type. More...
 
typedef struct gplinkTable GP_LINK_TABLE
 

Detailed Description

This section shows the functions and structures used for remote commissioning.

Enumeration Type Documentation

◆ eoReComReturn

Contains all the return values from ReCom functions.

Enumerator
RECOM_OK 

OK.

RECOM_WRONG_ID 

Wrong target ID.

RECOM_WRONG_UNLOCK_CODE 

Wrong unlock code.

RECOM_WRONG_EEP 

Wrong EEP.

RECOM_WRONG_MANUFACTURER_ID 

Wrong manufacturer ID.

RECOM_WRONG_DATA_SIZE 

Wrong data size.

RECOM_NO_CODE_SET 

No code set.

RECOM_NOT_SEND 

Not send.

RECOM_RPC_FAIL 

RPC failed.

RECOM_MSG_TIMEOUT 

Message time out.

RECOM_MSG_TOO_LONG 

Too long message.

RECOM_MSG_PART_RECEIVED 

Message part already received.

RECOM_MSG_PART_NOT_RECEIVED 

Message part not received.

RECOM_ADDR_OUT_OF_RANGE 

Address out of range.

RECOM_CODE_DATA_SIZE_EXCEED 

Code data size exceeded.

RECOM_SESSION_CLOSED 

Wrong data.

RECOM_INSUFFICENT_RIGHTS 

Wrong data.

◆ FN_RECOM_CODE

Function codes for Remote Commissioning.

Enumerator
FN_RECOM_ACK 

Remote Commissioning Acknowledge.

FN_RECOM_GET_METADATA 

Get Link Table Metadata Query.

FN_RECOM_GET_METADATA_RESPONSE 

Get Link Table Metadata Response.

FN_RECOM_GET_TABLE 

Get Link Table Query.

FN_RECOM_GET_TABLE_RESPONSE 

Get Link Table Response.

FN_RECOM_SET_TABLE 

Set Link Table Query.

FN_RECOM_GET_GP_TABLE 

Get Link Table GP Entry Query.

FN_RECOM_GET_GP_TABLE_RESPONSE 

Get Link Table GP Entry Response.

FN_RECOM_SET_GP_TABLE 

Set Link Table GP Entry Query.

FN_RECOM_SET_LEARN_MODE 

Remote Set Learn Mode.

FN_RECOM_TRIG_OUTBOUND_TEACH_REQ 

Trigger Outbound Remote Teach Request.

FN_RECOM_GET_DEVICE_CONFIG 

Get Device Configuration Query.

FN_RECOM_GET_DEVICE_CONFIG_RESPONSE 

Get Device Configuration Response.

FN_RECOM_SET_DEVICE_CONFIG 

Set Device Configuration Query.

FN_RECOM_GET_LINK_BASED_CONFIG 

Get Link Based Configuration Query.

FN_RECOM_GET_LINK_BASED_CONFIG_RESPONSE 

Get Link Based Configuration Response.

FN_RECOM_SET_LINK_BASED_CONFIG 

Set Link Based Configuration Query.

FN_RECOM_APPLY_CHANGES 

Apply Changes Command.

FN_RECOM_RESET_TO_DEFAULTS 

Reset to Defaults.

FN_RECOM_RADIO_LINK_TEST_CONTROL 

Radio Link Test Control.

FN_RECOM_GET_PRODUCT_ID 

Get Product ID Query.

FN_RECOM_GET_PRODUCT_RESPONSE 

Get Product ID Response.

FN_RECOM_GET_REPEATER_FUNCTIONS 

Get Repeater Functions Query.

FN_RECOM_GET_REPEATER_FUNCTIONS_RESPONSE 

Get Repeater Functions Response.

FN_RECOM_SET_REPEATER_FUNCTIONS 

Set Repeater Functions Query.

FN_RECOM_SET_REPEATER_FILTER 

Set Repeater Filter Query.

◆ RECOM_CHANGES

Enums for changes.

Enumerator
RECOM_CHANGES_NOT_APPLY 

Do not apply changes.

RECOM_CHANGES_APPLY 

Apply changes.

◆ RECOM_LEARN_MODE

Enums for learn modes.

Enumerator
RECOM_LEARN_IN 

Learn in mode.

RECOM_LEARN_OUT 

Learn out mode.

RECOM_EXIT_LEARN 

Exit any learn mode.

◆ RECOM_REPEATER_FILTER

Enums for repeater filter.

Enumerator
RECOM_REPEATER_AND 

Repeater filter AND.

RECOM_REPEATER_OR 

Repeater filter OR.

◆ RECOM_REPEATER_FILTER_CONTROL

Enums for repeater filter control.

Enumerator
RECOM_REPEATER_BLOCK 

Repeater filter Block.

RECOM_REPEATER_APPLY 

Repeater filter Apply.

RECOM_REPEATER_DELETE_FILTER 

Repeater filter delete specified.

RECOM_REPEATER_DELETE_ALL 

Repeater filter delete all filter.

◆ RECOM_REPEATER_FILTER_TYPE

Enums for repeater filter type.

Enumerator
RECOM_FILTER_SOURCE_ID 

Repeater filter source ID.

RECOM_FILTER_RORG 

Repeater filter RORG.

RECOM_FILTER_DBM 

Repeater filter dBm.

RECOM_FILTER_DESTINATION_ID 

Repeater filter destination ID.

◆ RECOM_REPEATER_FUNC

Enums for repeater function.

Enumerator
RECOM_REPEATER_OFF 

Repeater off.

RECOM_REPEATER_ON 

Repeater on.

RECOM_FILTERED_REPEATER_ON 

Filtered repeating on.

◆ RECOM_REPEATER_LEVEL

Enums for repeater level.

Enumerator
RECOM_REPEATER_LEVEL_1 

Repeater level 1.

RECOM_REPEATER_LEVEL_2 

Repeater level 2.

◆ RECOM_RESET

Enums for configuration.

Enumerator
RECOM_NO_DEFAULT_RESET 

Do not reset default.

RECOM_DEFAULT_RESET 

Reset default.

◆ RECOM_SUPPORT

Enums for supported flags.

Enumerator
RECOM_NOT_SUPPORTED 

Not supported.

RECOM_SUPPORTED 

Supported.

◆ RECOM_TABLE_DIR

Enums for table direction.

Enumerator
RECOM_INBOUND_TABLE 

Inbound.

RECOM_OUTBOUND_TABLE 

Outbound.