Enumerations

enum  esl_cmd_opcode_t {
  ESL_CMD_OPCODE_PING = 0x00,
  ESL_CMD_OPCODE_UNASSOCIATE_AP,
  ESL_CMD_OPCODE_SRV_RST,
  ESL_CMD_OPCODE_FACTORY_RST,
  ESL_CMD_OPCODE_UPDATE_COMP,
  ESL_CMD_OPCODE_RD_SENSOR_DATA = 0x10,
  ESL_CMD_OPCODE_REFRESH_DISP,
  ESL_CMD_OPCODE_DISP_IMAGE = 0x20,
  ESL_CMD_OPCODE_DISP_TIM_IMAGE = 0x60,
  ESL_CMD_OPCODE_LED_CTL = 0xB0,
  ESL_CMD_OPCODE_LED_TIM_CTL = 0xF0,
  ESL_CMD_OPCODE_PING = 0x00,
  ESL_CMD_OPCODE_UNASSOCIATE_AP,
  ESL_CMD_OPCODE_SRV_RST,
  ESL_CMD_OPCODE_FACTORY_RST,
  ESL_CMD_OPCODE_UPDATE_COMP,
  ESL_CMD_OPCODE_RD_SENSOR_DATA = 0x10,
  ESL_CMD_OPCODE_REFRESH_DISP,
  ESL_CMD_OPCODE_DISP_IMAGE = 0x20,
  ESL_CMD_OPCODE_DISP_TIM_IMAGE = 0x60,
  ESL_CMD_OPCODE_LED_CTL = 0xB0,
  ESL_CMD_OPCODE_LED_TIM_CTL = 0xF0,
  ESL_CMD_OPCODE_VEND_SPEC_TAG = 0x0F
}
 Values for The ESL Control Point characteristic command procedure. More...
 
enum  esl_rsp_err_code_t {
  ESL_RSP_ERR_CODE_RFU = 0x00,
  ESL_RSP_ERR_CODE_UNSPEC,
  ESL_RSP_ERR_CODE_INVALID_OPCODE,
  ESL_RSP_ERR_CODE_INVALID_STATE,
  ESL_RSP_ERR_CODE_INVALID_IMAGE_IDX,
  ESL_RSP_ERR_CODE_IMAGE_NOT_AVAILABLE,
  ESL_RSP_ERR_CODE_INVALID_PARAM,
  ESL_RSP_ERR_CODE_CAPACITY_LIMIT,
  ESL_RSP_ERR_CODE_INSUFF_BATTERY,
  ESL_RSP_ERR_CODE_INSUFF_RESOURCE,
  ESL_RSP_ERR_CODE_RETRY,
  ESL_RSP_ERR_CODE_QUEUE_FULL,
  ESL_RSP_ERR_CODE_IMPLAUSIBLE_ABS_TIM,
  ESL_RSP_ERR_CODE_VEND_BEGIN = 0xF0,
  ESL_RSP_ERR_CODE_VEND_NO_ERR = 0xFF,
  ESL_RSP_ERR_CODE_MAX = 0x100,
  ESL_RSP_ERR_CODE_RFU = 0x00,
  ESL_RSP_ERR_CODE_UNSPEC,
  ESL_RSP_ERR_CODE_INVALID_OPCODE,
  ESL_RSP_ERR_CODE_INVALID_STATE,
  ESL_RSP_ERR_CODE_INVALID_IMAGE_IDX,
  ESL_RSP_ERR_CODE_IMAGE_NOT_AVAILABLE,
  ESL_RSP_ERR_CODE_INVALID_PARAM,
  ESL_RSP_ERR_CODE_CAPACITY_LIMIT,
  ESL_RSP_ERR_CODE_INSUFF_BATTERY,
  ESL_RSP_ERR_CODE_INSUFF_RESOURCE,
  ESL_RSP_ERR_CODE_RETRY,
  ESL_RSP_ERR_CODE_QUEUE_FULL,
  ESL_RSP_ERR_CODE_IMPLAUSIBLE_ABS_TIM,
  ESL_RSP_ERR_CODE_VEND_BEGIN = 0xF0,
  ESL_RSP_ERR_CODE_VEND_NO_ERR = 0xFF,
  ESL_RSP_ERR_CODE_MAX = 0x100
}
 The Error response has a single parameter that contains an error code . More...
 
enum  esl_rsp_opcode_t {
  ESL_RSP_OPCODE_ERR = 0x00,
  ESL_RSP_OPCODE_LED_STATE,
  ESL_RSP_OPCODE_BASIC_STATE = 0x10,
  ESL_RSP_OPCODE_DISP_STATE = 0x11,
  ESL_RSP_OPCODE_SENSOR_TAG = 0x0E,
  ESL_RSP_OPCODE_VEND_TAG = 0x0F,
  ESL_RSP_OPCODE_ERR = 0x00,
  ESL_RSP_OPCODE_LED_STATE,
  ESL_RSP_OPCODE_BASIC_STATE = 0x10,
  ESL_RSP_OPCODE_DISP_STATE = 0x11,
  ESL_RSP_OPCODE_SENSOR_TAG = 0x0E,
  ESL_RSP_OPCODE_VEND_TAG = 0x0F
}
 The ESL Control Point characteristic response behavior. More...
 
enum  esls_c_key_type_t {
  ESLS_C_AP_SYNC_KEY_FLAG,
  ESLS_C_ESL_RSP_KEY_FLAG,
  ESLS_C_ESL_KEY_FLAG_MAX
}
 Electronic Shelf Label Key Material type. More...
 
enum  esls_c_evt_type_t {
  ESLS_C_EVT_INVALID,
  ESLS_C_EVT_DISCOVERY_COMPLETE,
  ESLS_C_EVT_DISCOVERY_FAIL,
  ESLS_C_EVT_ESL_ADDR_SET_SUCCESS,
  ESLS_C_EVT_AP_SYNC_KEY_SET_SUCCESS,
  ESLS_C_EVT_ESL_RSP_KEY_SET_SUCCESS,
  ESLS_C_EVT_ESL_ABS_TIM_SET_SUCCESS,
  ESLS_C_EVT_ESL_DISP_READ_INFO,
  ESLS_C_EVT_ESL_IMAGE_READ_INFO,
  ESLS_C_EVT_ESL_SENSOR_READ_INFO,
  ESLS_C_EVT_ESL_LED_READ_INFO,
  ESLS_C_EVT_CTRL_POINT_SET_RSP,
  ESLS_C_EVT_CTRL_POINT_CCCD_SET,
  ESLS_C_EVT_CTRL_POINT_RSP_RECEIVE,
  ESLS_C_EVT_ESL_SYNC_RSP_RECEIVE,
  ESLS_C_EVT_WRITE_OP_ERR
}
 Electronic Shelf Label User event to APP. More...
 
enum  esl_vendor_opcode_t {
  ESL_VENDOR_REQ_DEVICE_NAME,
  ESL_VENDOR_RSP_DEVICE_NAME,
  ESL_VENDOR_REQ_BD_ADDR,
  ESL_VENDOR_RSP_BD_ADDR,
  ESL_VENDOR_IMAGE_START_REQ,
  ESL_VENDOR_IMAGE_START_RSP,
  ESL_VENDOR_IMAGE_END_NTF,
  ESL_VENDOR_OPCODE_MAX = 0xFF,
  ESL_VENDOR_REQ_DEVICE_NAME,
  ESL_VENDOR_RSP_DEVICE_NAME,
  ESL_VENDOR_REQ_BD_ADDR,
  ESL_VENDOR_RSP_BD_ADDR,
  ESL_VENDOR_IMAGE_START_REQ,
  ESL_VENDOR_IMAGE_START_RSP,
  ESL_VENDOR_IMAGE_END_NTF,
  ESL_VENDOR_OPCODE_MAX = 0xFF
}
 Values for contrl point vendor command and response. More...
 
enum  esl_vendor_data_err_t {
  ESL_VENDOR_DATA_NO_ERR,
  ESL_VENDOR_DATA_ERR_CKSUM,
  ESL_VENDOR_DATA_ERR_LEN,
  ESL_VENDOR_DATA_NO_ERR,
  ESL_VENDOR_DATA_ERR_CKSUM,
  ESL_VENDOR_DATA_ERR_LEN
}
 Values for contrl point vendor command data error code. More...
 
enum  led_type_t {
  led_sRGB,
  led_mono
}
 Values for LED type enumeration. More...
 

Detailed Description

Enumeration Type Documentation

◆ esl_cmd_opcode_t

Values for The ESL Control Point characteristic command procedure.

Enumerator
ESL_CMD_OPCODE_PING 

The ESL Control Point characteristic command procedure is ping.

ESL_CMD_OPCODE_UNASSOCIATE_AP 

The ESL Control Point characteristic command procedure is Unassociate from AP.

ESL_CMD_OPCODE_SRV_RST 

The ESL Control Point characteristic command procedure is Service Reset.

ESL_CMD_OPCODE_FACTORY_RST 

The ESL Control Point characteristic command procedure is Factory Reset.

ESL_CMD_OPCODE_UPDATE_COMP 

The ESL Control Point characteristic command procedure is Update Complete.

ESL_CMD_OPCODE_RD_SENSOR_DATA 

The ESL Control Point characteristic command procedure is Read Sensor Data.

ESL_CMD_OPCODE_REFRESH_DISP 

The ESL Control Point characteristic command procedure is Refresh Display.

ESL_CMD_OPCODE_DISP_IMAGE 

The ESL Control Point characteristic command procedure is Display Image.

ESL_CMD_OPCODE_DISP_TIM_IMAGE 

The ESL Control Point characteristic command procedure is Display Timed Image.

ESL_CMD_OPCODE_LED_CTL 

The ESL Control Point characteristic command procedure is LED Control.

ESL_CMD_OPCODE_LED_TIM_CTL 

The ESL Control Point characteristic command procedure is LED Timed Control.

ESL_CMD_OPCODE_PING 

The ESL Control Point characteristic command procedure is ping.

ESL_CMD_OPCODE_UNASSOCIATE_AP 

The ESL Control Point characteristic command procedure is Unassociate from AP.

ESL_CMD_OPCODE_SRV_RST 

The ESL Control Point characteristic command procedure is Service Reset.

ESL_CMD_OPCODE_FACTORY_RST 

The ESL Control Point characteristic command procedure is Factory Reset.

ESL_CMD_OPCODE_UPDATE_COMP 

The ESL Control Point characteristic command procedure is Update Complete.

ESL_CMD_OPCODE_RD_SENSOR_DATA 

The ESL Control Point characteristic command procedure is Read Sensor Data.

ESL_CMD_OPCODE_REFRESH_DISP 

The ESL Control Point characteristic command procedure is Refresh Display.

ESL_CMD_OPCODE_DISP_IMAGE 

The ESL Control Point characteristic command procedure is Display Image.

ESL_CMD_OPCODE_DISP_TIM_IMAGE 

The ESL Control Point characteristic command procedure is Display Timed Image.

ESL_CMD_OPCODE_LED_CTL 

The ESL Control Point characteristic command procedure is LED Control.

ESL_CMD_OPCODE_LED_TIM_CTL 

The ESL Control Point characteristic command procedure is LED Timed Control.

ESL_CMD_OPCODE_VEND_SPEC_TAG 

Definition at line 95 of file esls_c.h.

◆ esl_rsp_err_code_t

The Error response has a single parameter that contains an error code .

Enumerator
ESL_RSP_ERR_CODE_RFU 

Reserved for Future Use.

ESL_RSP_ERR_CODE_UNSPEC 

Any error condition that is not covered by a specific error code below.

ESL_RSP_ERR_CODE_INVALID_OPCODE 

The opcode was not recognized.

ESL_RSP_ERR_CODE_INVALID_STATE 

The request was not valid for the present ESL state.

ESL_RSP_ERR_CODE_INVALID_IMAGE_IDX 

The Image_Index value was out of range.

ESL_RSP_ERR_CODE_IMAGE_NOT_AVAILABLE 

The requested image contained no image data.

ESL_RSP_ERR_CODE_INVALID_PARAM 

The parameter value(s) or length did not match the opcode.

ESL_RSP_ERR_CODE_CAPACITY_LIMIT 

The required response could not be sent as it would exceed the payload size limit.

ESL_RSP_ERR_CODE_INSUFF_BATTERY 

The request could not be processed because of a lack of battery charge.

ESL_RSP_ERR_CODE_INSUFF_RESOURCE 

The request could not be processed because of a lack of resources. This may be a temporary condition..

ESL_RSP_ERR_CODE_RETRY 

The ESL is temporarily unable to give a full response (e.g., because the required sensor hardware was asleep) and the AP is asked to try the same command again.

ESL_RSP_ERR_CODE_QUEUE_FULL 

The ESL is temporarily unable to add a further timed command to the queue of pending commands¡ªthe queue has reached its limit.

ESL_RSP_ERR_CODE_IMPLAUSIBLE_ABS_TIM 

The Absolute Time parameter value in the command is implausible.

ESL_RSP_ERR_CODE_VEND_BEGIN 

Error codes defined by a vendor.

ESL_RSP_ERR_CODE_VEND_NO_ERR 

Error codes defined by a vendor to represent no error.

ESL_RSP_ERR_CODE_MAX 

Error codes defined MAX.

ESL_RSP_ERR_CODE_RFU 

Reserved for Future Use.

ESL_RSP_ERR_CODE_UNSPEC 

Any error condition that is not covered by a specific error code below.

ESL_RSP_ERR_CODE_INVALID_OPCODE 

The opcode was not recognized.

ESL_RSP_ERR_CODE_INVALID_STATE 

The request was not valid for the present ESL state.

ESL_RSP_ERR_CODE_INVALID_IMAGE_IDX 

The Image_Index value was out of range.

ESL_RSP_ERR_CODE_IMAGE_NOT_AVAILABLE 

The requested image contained no image data.

ESL_RSP_ERR_CODE_INVALID_PARAM 

The parameter value(s) or length did not match the opcode.

ESL_RSP_ERR_CODE_CAPACITY_LIMIT 

The required response could not be sent as it would exceed the payload size limit.

ESL_RSP_ERR_CODE_INSUFF_BATTERY 

The request could not be processed because of a lack of battery charge.

ESL_RSP_ERR_CODE_INSUFF_RESOURCE 

The request could not be processed because of a lack of resources. This may be a temporary condition..

ESL_RSP_ERR_CODE_RETRY 

The ESL is temporarily unable to give a full response (e.g., because the required sensor hardware was asleep) and the AP is asked to try the same command again.

ESL_RSP_ERR_CODE_QUEUE_FULL 

The ESL is temporarily unable to add a further timed command to the queue of pending commands¡ªthe queue has reached its limit.

ESL_RSP_ERR_CODE_IMPLAUSIBLE_ABS_TIM 

The Absolute Time parameter value in the command is implausible.

ESL_RSP_ERR_CODE_VEND_BEGIN 

Error codes defined by a vendor.

ESL_RSP_ERR_CODE_VEND_NO_ERR 

Error codes defined by a vendor to represent no error.

ESL_RSP_ERR_CODE_MAX 

Error codes defined MAX.

Definition at line 112 of file esls_c.h.

◆ esl_rsp_opcode_t

The ESL Control Point characteristic response behavior.

Enumerator
ESL_RSP_OPCODE_ERR 

The command could not be processed successfully.

ESL_RSP_OPCODE_LED_STATE 

Acknowledgment of a request to control an LED.

ESL_RSP_OPCODE_BASIC_STATE 

General acknowledgment containing ESL status data.

ESL_RSP_OPCODE_DISP_STATE 

Acknowledgment of a request to display an image.

ESL_RSP_OPCODE_SENSOR_TAG 

Sensor report.

ESL_RSP_OPCODE_VEND_TAG 

Response data as specified by the vendor of the ESL.

ESL_RSP_OPCODE_ERR 

The command could not be processed successfully.

ESL_RSP_OPCODE_LED_STATE 

Acknowledgment of a request to control an LED.

ESL_RSP_OPCODE_BASIC_STATE 

General acknowledgment containing ESL status data.

ESL_RSP_OPCODE_DISP_STATE 

Acknowledgment of a request to display an image.

ESL_RSP_OPCODE_SENSOR_TAG 

Sensor report.

ESL_RSP_OPCODE_VEND_TAG 

Response data as specified by the vendor of the ESL.

Definition at line 134 of file esls_c.h.

◆ esl_vendor_data_err_t

Values for contrl point vendor command data error code.

Enumerator
ESL_VENDOR_DATA_NO_ERR 

The ESL profile vendor data no error.

ESL_VENDOR_DATA_ERR_CKSUM 

The ESL profile vendor data error is checksum fail.

ESL_VENDOR_DATA_ERR_LEN 

The ESL profile vendor data error is invalid-length .

ESL_VENDOR_DATA_NO_ERR 

The ESL profile vendor command data no error.

ESL_VENDOR_DATA_ERR_CKSUM 

The ESL profile vendor command data checksum fail.

ESL_VENDOR_DATA_ERR_LEN 

The ESL profile vendor command data length error.

Definition at line 187 of file esls_c.h.

◆ esl_vendor_opcode_t

Values for contrl point vendor command and response.

Enumerator
ESL_VENDOR_REQ_DEVICE_NAME 

The ESL profile vendor command to request peer device name.

ESL_VENDOR_RSP_DEVICE_NAME 

The ESL profile has received peer device name.

ESL_VENDOR_REQ_BD_ADDR 

The ESL profile vendor command to request peer device bd_addr.

ESL_VENDOR_RSP_BD_ADDR 

The ESL profile has received peer device bd_addr.

ESL_VENDOR_IMAGE_START_REQ 

The ESL profile vendor command to request start image transport.

ESL_VENDOR_IMAGE_START_RSP 

The ESL profile vendor command to response start image transport.

ESL_VENDOR_IMAGE_END_NTF 

The ESL profile vendor command to notify image transport end.

ESL_VENDOR_OPCODE_MAX 
ESL_VENDOR_REQ_DEVICE_NAME 

The ESL profile vendor command to request peer device name.

ESL_VENDOR_RSP_DEVICE_NAME 

The ESL profile has received peer device name.

ESL_VENDOR_REQ_BD_ADDR 

The ESL profile vendor command to request peer device bd_addr.

ESL_VENDOR_RSP_BD_ADDR 

The ESL profile has received peer device bd_addr.

ESL_VENDOR_IMAGE_START_REQ 

The ESL profile vendor command to request start image transport.

ESL_VENDOR_IMAGE_START_RSP 

The ESL profile vendor command to response start image transport.

ESL_VENDOR_IMAGE_END_NTF 

The ESL profile vendor command to notify image transport end.

ESL_VENDOR_OPCODE_MAX 

Definition at line 174 of file esls_c.h.

◆ esls_c_evt_type_t

Electronic Shelf Label User event to APP.

Enumerator
ESLS_C_EVT_INVALID 

ESLS Client invalid event.

ESLS_C_EVT_DISCOVERY_COMPLETE 

ESLS Client has found ESLS service and its characteristics.

ESLS_C_EVT_DISCOVERY_FAIL 

ESLS Client found ESLS service failed because of invalid operation or no found at the peer.

ESLS_C_EVT_ESL_ADDR_SET_SUCCESS 

ESLS Client has set ESL Server Addr.

ESLS_C_EVT_AP_SYNC_KEY_SET_SUCCESS 

ESLS Client has set AP Sync Key .

ESLS_C_EVT_ESL_RSP_KEY_SET_SUCCESS 

ESLS Client has set ESL Response Key .

ESLS_C_EVT_ESL_ABS_TIM_SET_SUCCESS 

ESLS Client has set ESL Current Absolute Time.

ESLS_C_EVT_ESL_DISP_READ_INFO 

ESLS Client read ESL Display Information .

ESLS_C_EVT_ESL_IMAGE_READ_INFO 

ESLS Client read ESL Image Information.

ESLS_C_EVT_ESL_SENSOR_READ_INFO 

ESLS Client read ESL Sensor Information.

ESLS_C_EVT_ESL_LED_READ_INFO 

ESLS Client read ESL LED Information.

ESLS_C_EVT_CTRL_POINT_SET_RSP 

ESLS Client has sent command from control point.

ESLS_C_EVT_CTRL_POINT_CCCD_SET 

ESLS Client has set Control Point completely.

ESLS_C_EVT_CTRL_POINT_RSP_RECEIVE 

ESLS Client has reviced command response from control point by connection.

ESLS_C_EVT_ESL_SYNC_RSP_RECEIVE 

ESLS Client has reviced command response from control point by synchronization.

ESLS_C_EVT_WRITE_OP_ERR 

Error occured when ESLS Client writen to peer.

Definition at line 153 of file esls_c.h.

◆ esls_c_key_type_t

Electronic Shelf Label Key Material type.

Enumerator
ESLS_C_AP_SYNC_KEY_FLAG 

The AP Sync Key Material.

ESLS_C_ESL_RSP_KEY_FLAG 

The ESL Response Key Material.

ESLS_C_ESL_KEY_FLAG_MAX 

Definition at line 145 of file esls_c.h.

◆ led_type_t

enum led_type_t

Values for LED type enumeration.

Enumerator
led_sRGB 

An sRGB LED is a multi-color LED that can change color.

led_mono 

A monochrome LED is a single-color LED.

Definition at line 195 of file esls_c.h.