esls.h

Go to the documentation of this file.

/**
 *****************************************************************************************
 *
 * @file esls.h
 *
 * @brief Electronic Shelf Label Service API.
 *
 *****************************************************************************************
 * @attention
  #####Copyright (c) 2019 GOODIX
  All rights reserved.
 
    Redistribution and use in source and binary forms, with or without
    modification, are permitted provided that the following conditions are met:
  * Redistributions of source code must retain the above copyright
    notice, this list of conditions and the following disclaimer.
  * Redistributions in binary form must reproduce the above copyright
    notice, this list of conditions and the following disclaimer in the
    documentation and/or other materials provided with the distribution.
  * Neither the name of GOODIX nor the names of its contributors may be used
    to endorse or promote products derived from this software without
    specific prior written permission.
 
  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  ARE DISCLAIMED. IN NO EVENT SHALL COPYRIGHT HOLDERS AND CONTRIBUTORS BE
  LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  POSSIBILITY OF SUCH DAMAGE.
 *****************************************************************************************
 */
 
/**
 * @addtogroup BLE_SRV BLE Services
 * @{
 * @brief Definitions and prototypes for the BLE Service interface.
 */
 
/**
 * @defgroup BLE_SDK_ESLS Electronic Shelf Label Service (ESLS)
 * @{
 * @brief Definitions and prototypes for the ESLS interface.
 *
 * @details The Electronic Shelf Label Service allows electronic shelf labels (ESLs) to be controlled and updated using
 *             Bluetooth wireless technology.The ESL Service enables a Client to discover the capabilities of the ESL and
 *             to send configuration settings to an ESL on which the service is exposed.The Bluetooth wireless technology
 *             that can be used to update and control the ESL is described by this specification.
 */
 
#ifndef __ESLS_H__
#define __ESLS_H__
 
#include "gr_includes.h"
#include "custom_config.h"
#include <stdint.h>
#include <stdbool.h>
 
/**
 * @defgroup ESLS_MACRO Defines
 * @{
 */
#define PAWR_MAX_SENT_DATA_LEN             250                                 /**< Maximum data length per subevt. */
#define PAWR_SENT_DATA_LEN_OFFSET          0                                   /**< Advertising data length field offset. */
#define PAWR_SENT_DATA_TYPE_OFFSET         1                                   /**< Advertising data type field offset. */
 
#define ESLS_CONNECTION_MAX                10                                  /**< Maximum number of Electronic Shelf Label Service connections. */
#define ESL_ADDR_LEN                       2                                   /**< Maximum length of heart rate measurement characteristic. */
#define ESL_SESSION_KEY_LEN                16                                  /**< The length of shared session key. */
#define ESL_IV_LEN                         8                                   /**< The length of initialization vector. */
#define AP_SYNC_KEY_MATERIAL_LEN           (ESL_SESSION_KEY_LEN + ESL_IV_LEN)  /**< The encryption keys of AP sent data . */
#define ESL_RSP_KEY_MATERIAL_LEN           (ESL_SESSION_KEY_LEN + ESL_IV_LEN)  /**< The encryption keys of ESL response data . */
#define ESL_CTL_PT_TLV_MIN_LEN             2                                   /**< The shortest TLV length . */
#define ESL_CTL_PT_TLV_MAX_LEN             17                                  /**< The longest TLV length . */
#define ESL_MAX_VAL_LEN                    512
 
#define ESL_ADDR_ESL_ID_BROAD_ADDR         0xFF                                /**< The value 0xFF is reserved for the Broadcast Address. */
 
#define ESL_CTL_PT_SENSOR_DATA_MAX_LEN     15                                  /**< The max sensor data length. */
#define ESL_VENDOR_DATA_MAX_LEN                 15                             /**< The max vendor data length. */
 
#define esls_sensor_size00(x) x&0xFF, (x>>8)&0xFF
#define esls_sensor_size01(y) y&0xFF, (y>>8)&0xFF, (y>>16)&0xFF, (y>>24)&0xFF
 
#define GRP_ID_MSK(esl_addr)               (esl_addr & 0x7F)
#define ESL_TLV_CMD_TAG(OPCODE)            (OPCODE & 0xF)                       /**< Get opcode tag field. */
#define ESL_TLV_CMD_LEN(OPCODE)            ((OPCODE>>4) & 0xF)                  /**< Get opcode length field. */
#define ESL_VEND_TAG                                0x0F                        /**< Vendor tag field. */
#define ESL_LED_INFOR_TYPE_RGB(x)          (x & 0x3F)                           /**< sRGB LED Type. */
#define ESL_LED_INFOR_TYPE_MON(y)          ((y & 0x3F)|(0x40))                  /**< Monochrome LED Type. */
/** @} */
 
/**
 * @defgroup ESLS_CHAR_MASK Characteristics Mask
 * @{
 * @brief Bit masks for the initialization of \ref esls_init_t.char_mask.
 */
 
#define ESLS_CHAR_MANDATORY                0xE01FF                              /**< Bit mask of the mandatory characteristics. */
#define ESLS_CHAR_DISPLAY_INFOR_SUP        0x00600                              /**< Bit mask of esl display information Feature Supported. */
#define ESLS_CHAR_IMAGE_INFOR_SUP          0x01800                              /**< Bit mask of esl image information Feature Supported. */
#define ESLS_CHAR_SENSOR_INFOR_SUP         0x06000                              /**< Bit mask of esl sensor information Feature Supported. */
#define ESLS_CHAR_LED_INFOR_SUP            0x18000                              /**< Bit mask of esl LED information Feature Supported. */
/** @} */
 
/**
 * @defgroup ESLS_CONFIG_MASK Characteristics Mask
 * @{
 * @brief Bit masks for the initialization of esls_env_t.config_mask.
 */
#define ESLS_CONFIG_ADDR_MASK              0x1                                   /**< Bit mask of the address characteristics config flag . */
#define ESLS_CONFIG_SYNC_KEY_MASK          0x2                                   /**< Bit mask of the sync key characteristics config flag . */
#define ESLS_CONFIG_RSP_KEY_MASK           0x4                                   /**< Bit mask of the response key characteristics config flag . */
#define ESLS_CONFIG_ABS_TIME_MASK          0x8                                   /**< Bit mask of the current time characteristics config flag . */
 
#define ESLS_CONFIG_COMPLETE_MASK          (ESLS_CONFIG_ADDR_MASK|ESLS_CONFIG_SYNC_KEY_MASK|ESLS_CONFIG_RSP_KEY_MASK|ESLS_CONFIG_ABS_TIME_MASK)
 
/** @} */
 
/**
 * @defgroup ESLS_ENUM Enumerations
 * @{
 */
/**@brief Values for The ESL Control Point characteristic command procedure. */
typedef enum
{
    ESL_CMD_OPCODE_PING = 0x00,                                                  /**< 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 = 0x10,                                        /**< 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 = 0x20,                                            /**< The ESL Control Point characteristic command procedure is Display Image. */
    ESL_CMD_OPCODE_DISP_TIM_IMAGE = 0x60,                                        /**< The ESL Control Point characteristic command procedure is Display Timed Image. */
    ESL_CMD_OPCODE_LED_CTL = 0xB0,                                               /**< The ESL Control Point characteristic command procedure is LED Control. */
    ESL_CMD_OPCODE_LED_TIM_CTL = 0xF0,                                           /**< The ESL Control Point characteristic command procedure is LED Timed Control. */
} esl_cmd_opcode_t;
 
/** @brief The Error response has a single parameter that contains an error code .**/
typedef enum
{
    ESL_RSP_ERR_CODE_RFU = 0x00,                                                 /**<  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 = 0xF0,                                          /**<  Error codes defined by a vendor. */
    ESL_RSP_ERR_CODE_VEND_NO_ERR = 0xFF,                                         /**<  Error codes defined by a vendor to represent no error. */
 
    ESL_RSP_ERR_CODE_MAX = 0x100,                                                /**<  Error codes defined MAX. */
}esl_rsp_err_code_t;
 
/** @brief The ESL Control Point characteristic response behavior**/
typedef enum
{
    ESL_RSP_OPCODE_ERR = 0x00,                                                   /**<  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 = 0x10,                                           /**<  General acknowledgment containing ESL status data. */
    ESL_RSP_OPCODE_DISP_STATE = 0x11,                                            /**<  Acknowledgment of a request to display an image. */
    ESL_RSP_OPCODE_SENSOR_TAG = 0x0E,                                            /**<  Sensor report. */
    ESL_RSP_OPCODE_VEND_TAG = 0x0F,                                              /**<  Response data as specified by the vendor of the ESL. */
}esl_rsp_opcode_t;
 
/** @brief 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.*/
typedef enum
{
    ESL_DISP_TYPE_BLACK_WHITE = 0x01,                                            /**<  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. */
}ESL_DISP_TYPE_T;
 
/**@brief Values for The ESL Control Point characteristic vendor command procedure. */
typedef enum
{
    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 = 0xFF,
}esl_vendor_opcode_t;
 
/**@brief Values for contrl point vendor command data error code. */
typedef enum
{
    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_err_t;
 
/**@brief Electronic Shelf Label Service event types. */
typedef enum
{
    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, \ref 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. */
} esls_evt_type_t;
 
/**@brief Electronic Shelf Label Service state machine types. */
typedef enum{
    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. */
}ESL_STATE_T;
 
/**@brief Electronic Shelf Label Service state machine types. */
typedef enum{
    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,
}ESL_SYNC_STATE_T;
 
/**@brief Electronic Shelf Label Service List of NVDS parameters identifiers. */
typedef enum
{
    /// Definition of the tag associated to each parameters
    /// Service config information tag id
    PARAM_ID_ESL_CONFIG_INFOR            = 0xcb,
}ESLS_NVDS_PARAM_ID_T;
 
/** @} */
 
/**
 * @defgroup ESLC_STRUCT Structures
 * @{
 */
 
/**@brief Electronic Shelf Label Service sync parameter format. */
typedef struct
{
    ESL_SYNC_STATE_T sync_state;                                                  /**< ESL Service state machine. */
    bool config_flag;                                                             /**< ESL Service sync paramter config flag. */
    uint8_t sync_idx;                                                             /**< ESL Service sync index. */
    uint16_t sync_to;                                                             /**< ESL Service sync timeout. */
    ble_gap_bdaddr_t target_addr;                                                 /**< ESL Service sync peer device bd addr. */
    uint16_t target_id_len;                                                       /**< ESL Service sync peer device target id length. */
    char target_id[128];                                                          /**< ESL Service sync peer device target id. */
}esls_ap_sync_param_t;
 
/**@brief Electronic Shelf Label Service display information format. */
typedef struct __attribute__((packed))
{
    uint16_t esls_display_width;                                                  /**< The width of the display in pixels. */
    uint16_t esls_display_height;                                                 /**< The height of the display in pixels. */
    uint8_t esls_display_type;                                                    /**< ESL Service display type, \ref ESL_DISP_TYPE_T. */
}esls_display_infor_t;
 
/**@brief Electronic Shelf Label Service display information data. */
struct esls_display_arr_t
{
    uint16_t display_arr_len;                                                     /**< ESL Service display infor buffer len. */
    uint8_t *display_arr_p;                                                       /**< ESL Service display infor buffer. */
};
 
/**@brief Electronic Shelf Label Service sensor information data. */
struct esls_sensor_arr_t
{
    uint16_t sensor_arr_len;                                                      /**< ESL Service sensor infor buffer len. */
    uint8_t *sensor_arr_p;                                                        /**< ESL Service sensor infor buffer. */
};
 
/**@brief Electronic Shelf Label Service led information data. */
struct esls_led_arr_t
{
    uint16_t led_arr_len;                                                         /**< ESL Service led infor buffer len. */
    uint8_t *led_arr_p;                                                           /**< ESL Service led infor buffer. */
};
 
/**@brief Electronic Shelf Label Service characteristic information. */
typedef struct
{
    struct esls_display_arr_t display_infor;                                      /**< Electronic Shelf Label Service display infor struct. */
    struct esls_sensor_arr_t sensor_infor;                                        /**< Electronic Shelf Label Service sensor infor struct. */
    struct esls_led_arr_t      led_infor;                                         /**< Electronic Shelf Label Service led infor struct. */
    uint8_t max_image_idx;                                                        /**< Electronic Shelf Label Service max image index. */
}esls_char_infor_t;
 
/**@brief Electronic Shelf Label Key Material. */
typedef struct __attribute__((packed))
{
    uint8_t session_key[16];
    uint8_t iv[8];
}esls_key_material_t;
 
/**@brief Electronic Shelf Label Service display image command data format. */
typedef struct __attribute__((packed))
{
    uint8_t display_idx;                                                          /**< Electronic Shelf Label Service display index. */
    uint8_t image_idx;                                                            /**< Electronic Shelf Label Service image index. */
    uint32_t abs_time;                                                            /**< Time when the display changes state. */
}esls_display_cmd_t;
 
/**@brief Electronic Shelf Label Service led control command data format. */
typedef struct __attribute__((packed))
{
    uint8_t led_idx;
    uint8_t color_red:2;
    uint8_t color_green:2;
    uint8_t color_blue:2;
    uint8_t color_brightness:2;
    /**< a bit of 1 means led on (bit_on_period*2)ms; a bit of 0 means led off (bit_off_period*2)ms. There are max 40 bits periods to be present. */
    uint8_t Pattern[5];
    uint8_t bit_off_period;
    uint8_t bit_on_period;
    /*
     *  If Repeat_Type = 0, an integer number of repeats of the flashing pattern specified by the Flashing_Pattern fields.
     *  If Repeat_Type = 1, a time duration specified in units of seconds.
    */
    uint16_t repeat_type:1;
    uint16_t repeat_duration:15;                                                   /**< Number of times to repeat, or time duration in increments of 1 second. */
    uint32_t abs_time;                                                             /**< Time when the led changes state. */
}esls_led_cmd_t;
 
/**@brief Electronic Shelf Label Service control Point format. */
typedef struct __attribute__((packed))
{
    uint8_t esl_id;                                                                /**< Electronic Shelf Label Service address id. */
    union
    {
        uint8_t sensor_idx;
        esls_display_cmd_t display_cmd;
        esls_led_cmd_t led_cmd;
    }data;                                                                         /**< Electronic Shelf Label Service command data struct. */
}esls_ecp_cmd_t;
 
/**@brief Electronic Shelf Label data format. */
typedef struct __attribute__((packed))
{
    esl_cmd_opcode_t Opcode;                                                       /**The ESL Control Point characteristic command opcode. */
    uint8_t param[ESL_CTL_PT_TLV_MAX_LEN];                                         /**The ESL Control Point characteristic command data, struct type \ref esls_ecp_cmd_t. */
}esls_tlv_format_t;
 
/**@brief Electronic Shelf Label Service event. */
typedef struct
{
    uint8_t         conn_idx;                                                      /**< Index of connection. */
    esls_evt_type_t  evt_type;                                                     /**< Electronic Shelf Label Service event type. */
    esls_tlv_format_t *tlv_data;                                                   /**< Electronic Shelf Label Service tlv data format. */
    void *evt_data_ptr;                                                            /**< Electronic Shelf Label Service raw data format. */
} esls_evt_t;
 
/**@brief Electronic Shelf Label Service NVDS callback func define. */
typedef uint8_t (*ble_app_nvds_get_cb_t)(uint8_t tag, uint8_t *p_len, uint8_t *p_buf);
typedef uint8_t (*ble_app_nvds_put_cb_t)(uint8_t tag, uint8_t len, uint8_t *p_buf);
typedef uint8_t (*ble_app_nvds_del_cb_t)(uint8_t tag);
 
/**@brief Electronic Shelf Label Service NVDS callback func. */
typedef struct
{
    ble_app_nvds_get_cb_t get_cb;                                                  /**< The pointer of Electronic Shelf Label Service nvds get func. */
    ble_app_nvds_put_cb_t put_cb;                                                  /**< The pointer of Electronic Shelf Label Service nvds put func. */
    ble_app_nvds_del_cb_t del_cb;                                                  /**< The pointer of Electronic Shelf Label Service nvds delete func. */
}esls_nvds_cb_t;
 
/**@brief Electronic Shelf Label Service  event handler func define. */
typedef sdk_err_t (*esls_evt_handler_t)(esls_evt_t *p_evt);
typedef bool (*app_dev_reset_cbk_t)(uint8_t conn_idx, bool factory_rst);
 
/**@brief Electronic Shelf Label Service Init variable. */
typedef struct
{
    uint32_t char_mask;                                                            /**< Mask of Supported characteristics, and configured with \ref ESLS_CHAR_MASK */
    esls_char_infor_t esls_char_infor;                                             /**< Electronic Shelf Label Service characteristic information. */
    esls_evt_handler_t  evt_handler;                                               /**< Electronic Shelf Label Service event handler. */
    esls_nvds_cb_t esls_nvds_cb;                                                   /**< Electronic Shelf Label Service NVDS callback func. */
} esls_init_t;
 
/** @} */
 
/**
 * @defgroup ESLS_FUNCTION Functions
 * @{
 */
/**
 *****************************************************************************************
 * @brief Init a Electronic Shelf Label Service instance and add in the DB.
 *
 * @param[in] p_esls_init: Pointer to a Electronic Shelf Label Init variable.
 *
 * @return Result of service initialization.
 *****************************************************************************************
 */
sdk_err_t esls_service_init(esls_init_t *p_esls_init);
 
/**
 *****************************************************************************************
 * @brief Get Electronic Shelf Label Service nvds load flag.
 *
 * @return Result of nvds load flag.
 *****************************************************************************************
 */
bool esls_service_nvds_load_flag_get(void);
 
/**
 *****************************************************************************************
 * @brief Capture esl service events on BLE.
 *
 * @param[in] p_evt:   pointer on BLE event.
 *****************************************************************************************
 */
void ble_esls_evt_on_ble_capture(const ble_evt_t *p_evt);
 
/**
 *****************************************************************************************
 * @brief Provide the interface for other modules to obtain the esls service start handle .
 *
 * @return The esls service start handle.
 *****************************************************************************************
 */
uint16_t esls_service_start_handle_get(void);
 
/**
 ****************************************************************************************
 * @brief Set Electronic Shelf Label default per sync trans parameter. Will be used after created conection with AP
 *
 * @param[in] sync_past_ptr: Pointer to the parameters.
 *
 * @return Result of setting.
 ****************************************************************************************
 */
sdk_err_t esls_sync_past_param_set(esls_ap_sync_param_t *sync_past_ptr);
 
/**
 ****************************************************************************************
 * @brief Set Electronic Shelf Label state machine
 *
 * @param[in] esl_state: Esl state to setting.
 *
 * @return Result of setting.
 ****************************************************************************************
 */
sdk_err_t esls_set_state_machine(ESL_STATE_T esl_state);
 
/**
 ****************************************************************************************
 * @brief Get Electronic Shelf Label state machine
 *
 * @return Current Esl state.
 ****************************************************************************************
 */
ESL_STATE_T esls_get_state_machine(void);
 
/**
 *****************************************************************************************
 * @brief Reset Electronic Shelf Label Service state and database.
 *****************************************************************************************
 */
void esls_service_reset(void);
 
/**
 *****************************************************************************************
 * @brief Send response message to AP.
 *
 * @param[in] conn_idx: Connection index.
 * @param[in] rsp_data_p:  Pointer to the data of response.
 * @param[in] len:  the data length of response.
 *
 * @return Result of message response.
 *****************************************************************************************
 */
sdk_err_t esls_tlv_response_send(uint8_t conn_idx, uint8_t *rsp_data_p, uint16_t len);
 
/**
 *****************************************************************************************
 * @brief a Electronic Shelf Label Service reponse AP with a Error code.
 *
 * @param[in] conn_idx:     Connnection index..
 * @param[in] err_code:     The command could not be processed successfully, will response this err code.
 *
 * @return Result of data sent.
 *****************************************************************************************
 */
sdk_err_t esls_err_state_send(uint8_t conn_idx, esl_rsp_err_code_t err_code);
 
/**
 *****************************************************************************************
 * @brief a Electronic Shelf Label Service reponse of LED control command .
 *
 * @param[in] conn_idx:     Connnection index..
 * @param[in] led_idx:      LED index.
 *
 * @return Result of data sent.
 *****************************************************************************************
 */
sdk_err_t esls_led_state_send(uint8_t conn_idx, uint8_t led_idx);
 
/**
 *****************************************************************************************
 * @brief Sent a Electronic Shelf Label Service base state.
 *
 * @param[in] conn_idx:     Connnection index.
 *
 * @return Result of data sent.
 *****************************************************************************************
 */
sdk_err_t esls_base_state_send(uint8_t conn_idx);
 
/**
 *****************************************************************************************
 * @brief Sent Electronic Shelf Label Service sensor data.
 *
 * @param[in] conn_idx:      Connnection index.
 * @param[in] sensor_idx:    Sensor index.
 * @param[in] sensor_data_p: Pointer of Sensor data.
 * @param[in] len:           Sensor data length.
 *
 * @return Result of data sent.
 *****************************************************************************************
 */
sdk_err_t esls_sensor_value_send(uint8_t conn_idx, uint8_t sensor_idx, uint8_t *sensor_data_p, uint8_t len);
 
/**
 *****************************************************************************************
 * @brief Sent Electronic Shelf Label Service diaplay state.
 *
 * @param[in] conn_idx:     Connnection index.
 * @param[in] display_idx:     display index.
 * @param[in] image_idx:     image index.
 *
 * @return Result of data sent.
 *****************************************************************************************
 */
sdk_err_t esls_display_state_send(uint8_t conn_idx, uint8_t display_idx, uint8_t image_idx);
 
/**
 *****************************************************************************************
 * @brief Sent Electronic Shelf Label Service user data.
 *
 * @param[in] conn_idx:     Connnection index.
 * @param[in] user_opcode:     User define opcode, \ref esl_vendor_opcode_t.
 * @param[in] esl_payload:     Pointer on payload data.
 * @param[in] esl_len:     Pointer on payload data.
 *
 * @return Result of data sent.
 *****************************************************************************************
 */
sdk_err_t esls_user_payload_send(uint8_t conn_idx, uint8_t user_opcode, uint8_t *esl_payload, uint16_t esl_len);
 
/**
 *****************************************************************************************
 * @brief Set Electronic Shelf Label Service user data in esl_sent_buffer, will sent later.
 *
 * @param[in] esl_sent_buffer:     data buffer.
 * @param[in] esl_sent_buffer_offset:     buffer head offset.
 * @param[in] user_opcode:     Opcode of payload data.
 * @param[in] esl_payload:     Pointer on payload data.
 * @param[in] esl_len:     Pointer on payload length.
 *
 * @return Result of data sent.
 *****************************************************************************************
 */
sdk_err_t esls_user_payload_prepare(uint8_t* esl_sent_buffer, uint16_t *esl_sent_buffer_offset, uint8_t user_opcode, uint8_t *esl_payload, uint16_t esl_len);
 
/**
 *****************************************************************************************
 * @brief Electronic Shelf Label Service service need state set.
 *
 * @param[in] flag:     True or False.
 *
 * @return Result of service state.
 *****************************************************************************************
 */
uint16_t esls_service_need_state_set(bool flag);
 
/**
 *****************************************************************************************
 * @brief Get Electronic Shelf Label Service service need state .
 *
 * @return Result of service state.
 *****************************************************************************************
 */
uint16_t esls_service_need_state_get(void);
 
/**
 *****************************************************************************************
 * @brief Electronic Shelf Label Service sync state set.
 *
 * @param[in] flag:     True or False.
 *
 * @return Result of service state.
 *****************************************************************************************
 */
uint16_t esls_sync_to_ap_state_set(bool flag);
 
/**
 *****************************************************************************************
 * @brief Get Electronic Shelf Label Service sync state .
 *
 * @return Result of service state.
 *****************************************************************************************
 */
uint16_t esls_sync_to_ap_state_get(void);
 
/**
 *****************************************************************************************
 * @brief Electronic Shelf Label Service active LED state set.
 *
 * @param[in] flag:     True or False.
 *
 * @return Result of service state.
 *****************************************************************************************
 */
uint16_t esls_active_led_state_set(bool flag);
 
/**
 *****************************************************************************************
 * @brief Get Electronic Shelf Label Service active LED state state .
 *
 * @return Result of service state.
 *****************************************************************************************
 */
uint16_t esls_active_led_state_get(void);
 
/**
 *****************************************************************************************
 * @brief Electronic Shelf Label Service pengding LED state set.
 *
 * @param[in] flag:     True or False.
 *
 * @return Result of service state.
 *****************************************************************************************
 */
uint16_t esls_pending_led_update_state_set(bool flag);
 
/**
 *****************************************************************************************
 * @brief Get Electronic Shelf Label Service pengding LED state state .
 *
 * @return Result of service state.
 *****************************************************************************************
 */
uint16_t esls_pending_led_update_state_get(void);
 
/**
 *****************************************************************************************
 * @brief Electronic Shelf Label Service pengding display state set.
 *
 * @param[in] flag:     True or False.
 *
 * @return Result of service state.
 *****************************************************************************************
 */
uint16_t esls_pending_display_update_state_set(bool flag);
 
/**
 *****************************************************************************************
 * @brief Get Electronic Shelf Label Service pengding display state state .
 *
 * @return Result of service state.
 *****************************************************************************************
 */
uint16_t esls_pending_display_update_state_get(void);
 
 
/** @} */
 
#endif
/** @} */
/** @} */