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  ESL_DISP_TYPE_T {
  ESL_DISP_TYPE_BLACK_WHITE = 0x01,
  ESL_DISP_TYPE_THREE_GRAY_SCALE,
  ESL_DISP_TYPE_FOUR_GRAY_SCALE,
  ESL_DISP_TYPE_EIGHT_GRAY_SCALE,
  ESL_DISP_TYPE_SIXTEEN_GRAY_SCALE,
  ESL_DISP_TYPE_RED_BLACK_WHITE,
  ESL_DISP_TYPE_YELLOW_BLACK_WHITE,
  ESL_DISP_TYPE_RED_YELLOW_BLACK_WHITE,
  ESL_DISP_TYPE_SEVEN_COLOR,
  ESL_DISP_TYPE_SIXTEEN_COLOR,
  ESL_DISP_TYPE_FULL_RGB
}
 The value of the Display_Type field is from an enumeration , which identifies the colors that are supported by the display and may provide additional information about the display. 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 The ESL Control Point characteristic vendor command procedure. 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  esls_evt_type_t {
  ESLS_EVT_NOTIFICATION_ENABLED,
  ESLS_EVT_NOTIFICATION_DISABLED,
  ESLS_EVT_WRITE_VEND_COMMAND,
  ESLS_EVT_UNASSOCIATE_FROM_AP,
  ESLS_EVT_SERVICE_RESET,
  ESLS_EVT_FACTORY_RESET,
  ESLS_EVT_CURRENT_ABS_TIM,
  ESLS_EVT_READ_SENSOR_DATA,
  ESLS_EVT_REFRESH_DISPLAY,
  ESLS_EVT_DISPLAY_IMAGE,
  ESLS_EVT_DISPLAY_TIMED_IMAGE,
  ESLS_EVT_LED_CTL,
  ESLS_EVT_LED_TIMED_CTL,
  ESLS_EVT_TX_DATA_SENT,
  ESLS_EVT_NO_NEED_PROC
}
 Electronic Shelf Label Service event types. More...
 
enum  ESL_STATE_T {
  UNASSOCIAT_STATE,
  CONFIGURING_STATE,
  SYNCHRONIZE_STATE,
  UPDATING_STATE,
  UNSYNCHRONIZE_STATE,
  ESL_STATE_MAX
}
 Electronic Shelf Label Service state machine types. More...
 
enum  ESL_SYNC_STATE_T {
  SYNC_STATE_IDLE,
  SYNC_STATE_START,
  SYNC_STATE_ACTIVE,
  SYNC_STATE_MAX
}
 Electronic Shelf Label Service state machine types. More...
 
enum  ESLS_NVDS_PARAM_ID_T { PARAM_ID_ESL_CONFIG_INFOR = 0xcb }
 Electronic Shelf Label Service List of NVDS parameters identifiers. 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 129 of file esls.h.

◆ ESL_DISP_TYPE_T

The value of the Display_Type field is from an enumeration , which identifies the colors that are supported by the display and may provide additional information about the display.

Enumerator
ESL_DISP_TYPE_BLACK_WHITE 

the display supported show the colors of black white.

ESL_DISP_TYPE_THREE_GRAY_SCALE 

the display supported show the colors of three gray scale.

ESL_DISP_TYPE_FOUR_GRAY_SCALE 

the display supported show the colors of four gray scale.

ESL_DISP_TYPE_EIGHT_GRAY_SCALE 

the display supported show the colors of eight gray scale.

ESL_DISP_TYPE_SIXTEEN_GRAY_SCALE 

the display supported show the colors of sixteen gray scale.

ESL_DISP_TYPE_RED_BLACK_WHITE 

the display supported show the colors of red black white.

ESL_DISP_TYPE_YELLOW_BLACK_WHITE 

the display supported show the colors of yellow black white.

ESL_DISP_TYPE_RED_YELLOW_BLACK_WHITE 

the display supported show the colors of red yellow black white.

ESL_DISP_TYPE_SEVEN_COLOR 

the display supported show the colors of seven color.

ESL_DISP_TYPE_SIXTEEN_COLOR 

the display supported show the colors of sixteen color.

ESL_DISP_TYPE_FULL_RGB 

the display supported show the colors of full RGB.

Definition at line 178 of file esls.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 145 of file esls.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 167 of file esls.h.

◆ ESL_STATE_T

Electronic Shelf Label Service state machine types.

Enumerator
UNASSOCIAT_STATE 

Electronic Shelf Label unassociated state of state machine .

CONFIGURING_STATE 

Electronic Shelf Label configuring state of state machine .

SYNCHRONIZE_STATE 

Electronic Shelf Label synchronized state of state machine .

UPDATING_STATE 

Electronic Shelf Label updating state of state machine .

UNSYNCHRONIZE_STATE 

Electronic Shelf Label unsynchronized state of state machine .

ESL_STATE_MAX 

Electronic Shelf Label state machine max value.

Definition at line 235 of file esls.h.

◆ ESL_SYNC_STATE_T

Electronic Shelf Label Service state machine types.

Enumerator
SYNC_STATE_IDLE 

Electronic Shelf Label sync procedure is idle .

SYNC_STATE_START 

Electronic Shelf Label sync procedure is starting .

SYNC_STATE_ACTIVE 

Electronic Shelf Label sync procedure is running .

SYNC_STATE_MAX 

Definition at line 245 of file esls.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 207 of file esls.h.

◆ esl_vendor_opcode_t

Values for The ESL Control Point characteristic vendor command procedure.

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 194 of file esls.h.

◆ esls_evt_type_t

Electronic Shelf Label Service event types.

Enumerator
ESLS_EVT_NOTIFICATION_ENABLED 

Electronic Shelf Label value notification has been enabled.

ESLS_EVT_NOTIFICATION_DISABLED 

Electronic Shelf Label value notification has been disabled.

ESLS_EVT_WRITE_VEND_COMMAND 

Electronic Shelf Label vendor command procedure, esl_vendor_opcode_t.

ESLS_EVT_UNASSOCIATE_FROM_AP 

Electronic Shelf Label unassociate from AP command report to user.

ESLS_EVT_SERVICE_RESET 

Electronic Shelf Label service reset command report to user.

ESLS_EVT_FACTORY_RESET 

Electronic Shelf Label factory reset command report to user.

ESLS_EVT_CURRENT_ABS_TIM 

Electronic Shelf Label set current absolute time command report to user.

ESLS_EVT_READ_SENSOR_DATA 

Electronic Shelf Label read sensor data command .

ESLS_EVT_REFRESH_DISPLAY 

Electronic Shelf Label refresh display.

ESLS_EVT_DISPLAY_IMAGE 

Electronic Shelf Label display Image.

ESLS_EVT_DISPLAY_TIMED_IMAGE 

Electronic Shelf Label display Image, when the timer timeout.

ESLS_EVT_LED_CTL 

Electronic Shelf Label control LED.

ESLS_EVT_LED_TIMED_CTL 

Electronic Shelf Label control LED, when the timer timeout.

ESLS_EVT_TX_DATA_SENT 

The data from the application has been sent, and the service is ready to accept new data from the application.

ESLS_EVT_NO_NEED_PROC 

Electronic Shelf Label event max value.

Definition at line 215 of file esls.h.

◆ ESLS_NVDS_PARAM_ID_T

Electronic Shelf Label Service List of NVDS parameters identifiers.

Enumerator
PARAM_ID_ESL_CONFIG_INFOR 

Definition of the tag associated to each parameters Service config information tag id

Definition at line 253 of file esls.h.