ESL Tag core#

esl_display_type_t#

typedef uint8_t esl_display_type_t

ESL Display Info Display Type.

esl_display_info_p#

typedef struct esl_display_info_t* esl_display_info_p

ESL Display Info first class abstract data pointer type.

esl_error_t#

typedef uint8_t esl_error_t

esl_image_object_id_t#

typedef uint8_t esl_image_object_id_t[6] [6]

ESL Service Specification d09r18, Section 3.7.2.4: 48 bit Image Object ID.

esl_led_type_t#

typedef uint8_t esl_led_type_t

ESL LED type.

esl_led_gamut_control_t#

typedef uint8_t esl_led_gamut_control_t

ESL LED color gamut control type.

esl_led_repeats_type_t#

typedef uint16_t esl_led_repeats_type_t

ESL LED repeats type.

tlv_t#

typedef uint8_t tlv_t

tlv_tag_t#

typedef uint8_t tlv_tag_t

tlv_length_t#

typedef uint8_t tlv_length_t

esl_sensor_battery_init#

sl_status_t esl_sensor_battery_init (void )

esl_sensor_battery_read#

sl_status_t esl_sensor_battery_read (void )

esl_sensor_get_battery_voltage_mv#

uint32_t esl_sensor_get_battery_voltage_mv (void )

esl_sensor_core_check_battery_level#

void esl_sensor_core_check_battery_level (void )

esl_core_encrypt_message#

void * esl_core_encrypt_message (void * msg, uint8_t * len)

Message encryption function Returns

• void* Pointer to the encrypted message on success, NULL otherwise.

Note

• Also changes the value of *len to the resulting length on successful operation.

esl_core_decrypt_message#

void * esl_core_decrypt_message (void * msg, uint8_t * len)

Message decryption function Returns

• void* Pointer to the decrypted message on success, NULL otherwise.

Note

• Also changes the value of *len to the resulting length on successful operation.

esl_display_init#

void esl_display_init (void )

ESL Tag display component init function. ESL Core component will call this during the initialization of application. This call is hidden and happens automatically.

esl_display_refresh#

sl_status_t esl_display_refresh (uint8_t display_index, uint8_t * image_index)

Refresh the content of the ESL Tag Display. Re-displays the image which was previously set on the given screen. Returns

• sl_status_t

esl_display_update#

sl_status_t esl_display_update (uint8_t display_index, uint8_t image_index)

Update image data on ESL Tag Display. Returns

• sl_status_t

esl_display_get_count#

uint8_t esl_display_get_count ()

ESL Display: display count getter Returns

• Number of available displays

esl_core_get_last_error#

esl_error_t esl_core_get_last_error (void )

Gets the last error code Returns

• esl_error_t_t

esl_core_set_last_error#

void esl_core_set_last_error (esl_error_t error_code)

Sets the last error code

esl_image_init#

void esl_image_init (void )

ESL Tag image init function. ESL Core component will call this during the initialization of application. This call is hidden and happens automatically.

esl_image_characteristic_update#

void esl_image_characteristic_update (void )

ESL Tag image characteristic update. ESL Core component will call this automatically on the bluetooth stack boot event. The real implementation in the ESL Tag Image component will get the display info and write it to the ESL Image Information Characteristic value for the lifecycle of the tag.

esl_image_get_data#

sl_status_t esl_image_get_data (uint8_t image_index, uint16_t * offset, uint16_t buf_size, uint8_t * target_buf)

Getter for an ESL Tag image raw data chunk

Note

• To get full image data this function needs to be called repeatedly until the offset value increases - offset in caller has to be persistent during the process, and usually its value must be set to 0, initially

Returns

• sl_status_t

esl_image_get_count#

uint8_t esl_image_get_count (void )

ESL Tag maximum image count getter Returns

• Number of available images

Note

• : To be implemented with each custom image storage implementation!

esl_image_reset_storage#

void esl_image_reset_storage (void )

Reset image storage objects Note

• : To be implemented with each custom image storage implementation!

typedef#

typedef (struct { uint8_t data[5];uint8_t bit_off_period;uint8_t bit_on_period;} )

ESL LED flashing pattern ESL Service Spec. d09r18, Section 3.10.2.10.2.2.

typedef#

typedef (struct { uint8_t index;esl_led_gamut_control_t gamut;esl_led_flashing_pattern_t pattern;esl_led_repeats_type_t repeats;} )

ESL LED Control parameter, ESL Service Spec. d09r18, Section 3.10.2.10.1.

esl_led_init#

void esl_led_init (void )

ESL Tag LED init function. ESL Core component will call this during the initialization of application. This call is hidden and happens automatically.

esl_led_control#

sl_status_t esl_led_control (esl_led_control_t * control_param)

ESL Tag LED control function Note

• updates the active LED bit in ESL basic state register according to the actual status of all LEDs

Returns

• sl_status_t

esl_led_get_count#

uint8_t esl_led_get_count ()

Get ESL Tag LED count Returns

• Number of available LEDs

esl_led_is_srgb#

bool esl_led_is_srgb (uint8_t led_index)

Get ESL Tag LED count Returns

• Number of available LEDs

esl_core_respones_init#

void esl_core_respones_init ()

Init ESL Tag responses queue. ESL Core component will call this during the initialization of application. This call is hidden and happens automatically.

esl_core_build_response#

sl_status_t esl_core_build_response (tlv_t tlv, const void * input_data)

Create response byte stream for single TLV based on input data and error status (if any) then puts the response stream into a circular buffer. The resulting output length of a single TLV will be the length encoded in that particular TLV + 1 byte as per ESL specification. Multiple response streams will be then concatenated on consecutive calls up to the maximum length limit of 48 bytes for multiple response data. Note

• the actual length of the input data length MUST be in correspondence with the TLV passed as the first parameter!

Returns

• sl_tatus_t

esl_core_get_responses#

uint8_t esl_core_get_responses (uint8_t remaining_length, uint8_t * buf_p)

Copy all possible responses from internal circular buffer to a temporary linear buffer. Circular buffer drops the successfully read out data, while it might keep remaining responses which doesn't fit into the target buffer. Consistency of any response will be kept, that is, it might copy less data than the allowed maximum length passed as the first parameter, if there are responses left still in the internal circular buffer which otherwise wont fit into the target buffer. Returns

• overall length of responses, might be 0 if there's no response

esl_sensor_init#

void esl_sensor_init (void )

ESL Tag sensor init function. ESL Core component will call this during the initialization of application. This call is hidden and happens automatically.

esl_sensor_read#

sl_status_t esl_sensor_read (uint8_t index)

Read interface (only) for ESL Sensor. Returns

• sl_status_t SL_NOT_SUPPORTED if the ESL Sensor component is missing.

esl_sensor_get_count#

uint8_t esl_sensor_get_count (void )

Get ESL Tag Sensor count Returns

• Number of available sensors

esl_display_create#

sl_status_t esl_display_create (uint16_t width, uint16_t height, esl_display_type_t type, esl_display_info_p * info)

Create an ESL Tag display. Any display which a Tag wants to implement needs to becreated properly in the first place.

Returns

• sl_status_t

esl_display_add#

sl_status_t esl_display_add (esl_display_info_p info, esl_va_method_p init_func, esl_va_method_p write_func)

Add an ESL Tag display to the list of available displays after creation. Any display on a Tag can be only used after adding it to the list.

Returns

• sl_status_t

esl_display_bt_on_event#

void esl_display_bt_on_event (sl_bt_msg_t * evt)

ESL display's bluetooth stack event handler. This one runs by the user implementation (usually in app.c) in parallel.

esl_display_set_image#

sl_status_t esl_display_set_image (uint8_t display_index, uint8_t image_index)

ESL Display: chose an image to show. Invokes the users write_func passed to esl_display_add as its 3rd parameter. Returns

• sl_status_t

esl_display_get_width#

sl_status_t esl_display_get_width (uint8_t display_index, uint16_t * width)

Display width getter. Returns

• sl_status_t

esl_display_get_height#

sl_status_t esl_display_get_height (uint8_t display_index, uint16_t * height)

Display height getter Returns

• sl_status_t

esl_display_get_type#

sl_status_t esl_display_get_type (uint8_t display_index, esl_display_type_t * type)

Display type getter. Returns

• sl_status_t

esl_led_add#

sl_status_t esl_led_add (esl_led_type_t type, uint8_t red_value, uint8_t green_value, uint8_t blue_value)

Add an ESL Tag LED to the list of available LEDs after creation. Any LED on a Tag can be only used after adding it to the internal LED registry.

Returns

• sl_status_t

esl_led_on#

sl_status_t esl_led_on (uint8_t led_index, esl_led_gamut_control_t gamut)

ESL Tag LED on function. Simple turn on function with given brightness and color values, to be implemented by end users. It's the users responsibility to actually turn given LED on with the given brightness and color parameters (if applicable) and the function shall return SL_STATUS_OK in case of success. Return SL_STATUS_FAIL on any other case (e.g. index out of bound, detectable HW error etc. Returns

• sl_status_t

esl_led_off#

sl_status_t esl_led_off (uint8_t led_index)

ESL Tag LED off function. Simple turn off function, similar to sl_esl_led_on method except it omits the gamut parameter entirely. To be implemented by end users. It's the users responsibility to actually turn given LED off and the function shall return SL_STATUS_OK in case of success. Return SL_STATUS_FAIL on any other case (e.g. index out of bound, detectable HW error etc. Returns

• sl_status_t

esl_led_create_color#

esl_led_gamut_control_t esl_led_create_color (uint8_t red_value, uint8_t green_value, uint8_t blue_value, uint8_t brightness)

Assembly ESL Tag LED gamut value from input parameters for esl_led_gamut_control_t type Returns

• esl_led_gamut_control_t Resulting ESL LED gamut value

esl_led_bt_on_event#

void esl_led_bt_on_event (sl_bt_msg_t * evt)

ESL LED's bluetooth stack event handler. This one runs by the user implementation (usually in app.c) in parallel.

ESL_TAG_ADVERTISING_INTERVAL_MIN#

#define ESL_TAG_ADVERTISING_INTERVAL_MIN

750

ESL_TAG_ADVERTISING_INTERVAL_MAX#

#define ESL_TAG_ADVERTISING_INTERVAL_MAX

1500

ESL_TAG_MAX_SYNC_LOST_COUNT#

#define ESL_TAG_MAX_SYNC_LOST_COUNT

3

ESL_TAG_VENDOR_OPCODES_ENABLED#

#define ESL_TAG_VENDOR_OPCODES_ENABLED

1

ESL_TAG_BUILTIN_BATTERY_MEASURE_ENABLE#

#define ESL_TAG_BUILTIN_BATTERY_MEASURE_ENABLE

1

ESL_TAG_BATTERY_LEVEL_FULL_MILLIVOLTS#

#define ESL_TAG_BATTERY_LEVEL_FULL_MILLIVOLTS

3200

ESL_TAG_BATTERY_LEVEL_LOW_MILLIVOLTS#

#define ESL_TAG_BATTERY_LEVEL_LOW_MILLIVOLTS

2400

ESL_TAG_BATTERY_MEASUREMENT_INTERVAL_MIN#

#define ESL_TAG_BATTERY_MEASUREMENT_INTERVAL_MIN

10

ESL_TAG_POWER_DOWN_ENABLE#

#define ESL_TAG_POWER_DOWN_ENABLE

1

ESL_TAG_POWER_DOWN_TIMEOUT_MIN#

#define ESL_TAG_POWER_DOWN_TIMEOUT_MIN

60

ESL_TAG_BATTERY_MEASUREMENT_INTERVAL_MS#

#define ESL_TAG_BATTERY_MEASUREMENT_INTERVAL_MS

  (ESL_TAG_BATTERY_MEASUREMENT_INTERVAL_MIN * 60 * 1000)

ESL_TAG_POWER_DOWN_TIMEOUT_MS#

#define ESL_TAG_POWER_DOWN_TIMEOUT_MS

  (ESL_TAG_POWER_DOWN_TIMEOUT_MIN * 60 * 1000)

ESL_TAG_BATTERY_LEVEL_UNKNOWN#

#define ESL_TAG_BATTERY_LEVEL_UNKNOWN

0

Definition for unknown battery voltage level (an implausible value)

ESL_DISPLAY_TYPE_BLACK_WHITE#

#define ESL_DISPLAY_TYPE_BLACK_WHITE

0x01

ESL Display Type Assigned Numbers.

ESL_DISPLAY_TYPE_3_GRAY_SCALE#

#define ESL_DISPLAY_TYPE_3_GRAY_SCALE

0x02

ESL_DISPLAY_TYPE_4_GRAY_SCALE#

#define ESL_DISPLAY_TYPE_4_GRAY_SCALE

0x03

ESL_DISPLAY_TYPE_8_GRAY_SCALE#

#define ESL_DISPLAY_TYPE_8_GRAY_SCALE

0x04

ESL_DISPLAY_TYPE_16_GRAY_SCALE#

#define ESL_DISPLAY_TYPE_16_GRAY_SCALE

0x05

ESL_DISPLAY_TYPE_RED_BLACK_WHITE#

#define ESL_DISPLAY_TYPE_RED_BLACK_WHITE

0x06

ESL_DISPLAY_TYPE_YELLOW_BLACK_WHITE#

#define ESL_DISPLAY_TYPE_YELLOW_BLACK_WHITE

0x07

ESL_DISPLAY_TYPE_RED_YELLOW_BLACK_WHITE#

#define ESL_DISPLAY_TYPE_RED_YELLOW_BLACK_WHITE

0x08

ESL_DISPLAY_TYPE_7_COLOR#

#define ESL_DISPLAY_TYPE_7_COLOR

0x09

ESL_DISPLAY_TYPE_16_COLOR#

#define ESL_DISPLAY_TYPE_16_COLOR

0x0A

ESL_DISPLAY_TYPE_FULL_RGB#

#define ESL_DISPLAY_TYPE_FULL_RGB

0x0B

ESL_ERROR_UNSPECIFIED#

#define ESL_ERROR_UNSPECIFIED

((esl_error_t)0x01)

Unspecified Error: any error condition that is not covered by a specific error code below

ESL_ERROR_INVALID_OPCODE#

#define ESL_ERROR_INVALID_OPCODE

((esl_error_t)0x02)

Invalid Opcode: The opcode was not recognized.

ESL_ERROR_INVALID_STATE#

#define ESL_ERROR_INVALID_STATE

((esl_error_t)0x03)

Invalid State: The request was not valid for the present ESL state.

ESL_ERROR_INVALID_IMAGE_INDEX#

#define ESL_ERROR_INVALID_IMAGE_INDEX

((esl_error_t)0x04)

Invalid Image Index: The Image_Index value was out of range.

ESL_ERROR_IMAGE_NOT_AVAILABLE#

#define ESL_ERROR_IMAGE_NOT_AVAILABLE

((esl_error_t)0x05)

Image Not Available: The requested image contained no image data.

ESL_ERROR_INVALID_PARAMETER#

#define ESL_ERROR_INVALID_PARAMETER

((esl_error_t)0x06)

Invalid Parameter(s): The parameter value(s) or length did not match the opcode

ESL_ERROR_CAPACITY_LIMIT#

#define ESL_ERROR_CAPACITY_LIMIT

((esl_error_t)0x07)

Capacity Limit: The required response could not be sent as it would exceed the payload size limit

ESL_ERROR_INSUFFICIENT_BATTERY#

#define ESL_ERROR_INSUFFICIENT_BATTERY

((esl_error_t)0x08)

Insufficient Battery: The request could not be processed because of a lack of battery charge

ESL_ERROR_INSUFFICIENT_RESOURCES#

#define ESL_ERROR_INSUFFICIENT_RESOURCES

((esl_error_t)0x09)

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

ESL_ERROR_RETRY#

#define ESL_ERROR_RETRY

((esl_error_t)0x0A)

Retry: The ESL is temporarily not able 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_ERROR_QUEUE_FULL#

#define ESL_ERROR_QUEUE_FULL

((esl_error_t)0x0B)

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_ERROR_IMPLAUSIBLE_TIME#

#define ESL_ERROR_IMPLAUSIBLE_TIME

((esl_error_t)0x0C)

Implausible time: The Absolute Time parameter value in the command would result in a delay longer than 48 days (that is, it's a possible overflow)

ESL_ERROR_VENDOR_NOERROR#

#define ESL_ERROR_VENDOR_NOERROR

((esl_error_t)0xFF)

No Error: 0xFF is reserved for 'no error' indication. For internal use only, and it is Silicon Labs specific.

ESL_ERROR_VENDOR_NOREPORT#

#define ESL_ERROR_VENDOR_NOREPORT

((esl_error_t)0xFE)

No report: 0xFE is reserved for 'no error report needed for timed commands' indication. For internal use only, and it is Silicon Labs specific.

esl_core_clear_last_error#

#define esl_core_clear_last_error

()

Wrapper around esl_core_set_last_error() to clear the last error

esl_core_has_no_error#

#define esl_core_has_no_error

()

Wrapper around esl_core_get_last_error() to check if there's no error

ESL_IMAGE_OBJECT_BASE#

#define ESL_IMAGE_OBJECT_BASE

0x100u

ESL Service Specification d09r18, Section 3.7.2.4: 48 bit Image Object ID.

ESL_LED_TYPE_SHIFT#

#define ESL_LED_TYPE_SHIFT

((esl_led_type_t)6)

ESL_LED_BRIGHTNESS_SHIFT#

#define ESL_LED_BRIGHTNESS_SHIFT

((esl_led_gamut_control_t)6)

ESL_LED_RED_GAMUT_SHIFT#

#define ESL_LED_RED_GAMUT_SHIFT

((esl_led_gamut_control_t)0)

ESL_LED_GREEN_GAMUT_SHIFT#

#define ESL_LED_GREEN_GAMUT_SHIFT

((esl_led_gamut_control_t)2)

ESL_LED_BLUE_GAMUT_SHIFT#

#define ESL_LED_BLUE_GAMUT_SHIFT

((esl_led_gamut_control_t)4)

ESL_LED_REPEATS_TYPE_MASK#

#define ESL_LED_REPEATS_TYPE_MASK

((esl_led_repeats_type_t)0x0001)

ESL_LED_REPEATS_TYPE_COUNT#

#define ESL_LED_REPEATS_TYPE_COUNT

((esl_led_repeats_type_t)0x0000)

ESL_LED_REPEATS_TYPE_TIME#

#define ESL_LED_REPEATS_TYPE_TIME

((esl_led_repeats_type_t)0x0001)

ESL_LED_REPEATS_DURATION_SHIFT#

#define ESL_LED_REPEATS_DURATION_SHIFT

((esl_led_repeats_type_t)0x0001)

ESL_LED_TYPE_SRGB#

#define ESL_LED_TYPE_SRGB

((esl_led_type_t)(0x00 << ESL_LED_TYPE_SHIFT))

ESL LED type definition: sRGB.

ESL_LED_TYPE_MONOCHROME#

#define ESL_LED_TYPE_MONOCHROME

((esl_led_type_t)(0x01 << ESL_LED_TYPE_SHIFT))

ESL LED type definition: Monochrome.

ESL_LED_TYPE_MASK#

#define ESL_LED_TYPE_MASK

((esl_led_type_t)0xC0)

ESL_LED_GENERIC_2BIT_MASK#

#define ESL_LED_GENERIC_2BIT_MASK

((esl_led_type_t)0x03)

ESL_LED_LEVEL_0#

#define ESL_LED_LEVEL_0

(0x00)

ESL LED color gamut / brightness values.

ESL_LED_LEVEL_1#

#define ESL_LED_LEVEL_1

(0x01)

ESL_LED_LEVEL_2#

#define ESL_LED_LEVEL_2

(0x02)

ESL_LED_LEVEL_3#

#define ESL_LED_LEVEL_3

(0x03)

ESL_LED_LEVEL_STEP_PERCENTAGE#

#define ESL_LED_LEVEL_STEP_PERCENTAGE

25

ESL LED color gamut / brightness step percentage.

esl_led_get_brightness#

#define esl_led_get_brightness

Function like macro getter for 2-bit brightness value from a gamut value Returns

• esl_led_gamut_control_t brightness

esl_led_get_red_value#

#define esl_led_get_red_value

Function like macro getter for 2-bit red value from a gamut value Returns

• esl_led_gamut_control_t red value

esl_led_get_green_value#

#define esl_led_get_green_value

Function like macro getter for 2-bit green value from a gamut value Returns

• esl_led_gamut_control_t green value

esl_led_get_blue_value#

#define esl_led_get_blue_value

Function like macro getter for 2-bit blue value from a gamut value Returns

• esl_led_gamut_control_t blue value

ESL_TLV_RESPONSE_ERROR#

#define ESL_TLV_RESPONSE_ERROR

((tlv_t)0x00)

The command could not be processed successfully.

ESL_TLV_RESPONSE_LED_STATE#

#define ESL_TLV_RESPONSE_LED_STATE

((tlv_t)0x01)

Acknowledgment of a request to control an LED.

ESL_TLV_RESPONSE_BASIC_STATE#

#define ESL_TLV_RESPONSE_BASIC_STATE

((tlv_t)0x10)

General acknowledgment containing ESL status data.

ESL_TLV_RESPONSE_DISPLAY_STATE#

#define ESL_TLV_RESPONSE_DISPLAY_STATE

((tlv_t)0x11)

Acknowledgment of a request to display an image.

ESL_TLV_RESPONSE_SENSOR_VALUE#

#define ESL_TLV_RESPONSE_SENSOR_VALUE

((tlv_t)0x0E)

Sensor report.

ESL_TLV_RESPONSE_VENDOR_VALUE#

#define ESL_TLV_RESPONSE_VENDOR_VALUE

((tlv_t)0x0F)

Response data as specified by the vendor of the ESL.

ESL_TLV_TAG_MASK#

#define ESL_TLV_TAG_MASK

((tlv_t)0x0F)

Mask for getting the Tag value from an ESL TLV.

ESL_TLV_LEN_MASK#

#define ESL_TLV_LEN_MASK

((tlv_t)0xF0)

Mask for getting the Length value from an ESL TLV.

esl_core_get_tlv_tag#

#define esl_core_get_tlv_tag

(tlv_byte)

Function like macro getter for 'Tag' field from an ESL TLV Returns

• tlv_tag_t 'Tag' value of the TLV

esl_core_get_tlv_len#

#define esl_core_get_tlv_len

Function like macro getter for real 'Length' value from an ESL TLV Returns

• tlv_length_t 'Length' value of the TLV

esl_core_set_tlv_tag#

#define esl_core_set_tlv_tag

Function like macro for setting the 'Tag' value of a TLV

esl_core_set_tlv_len#

#define esl_core_set_tlv_len

Function like macro for setting the 'Length' value of a TLV

ESL_DISPLAY_INIT_FUNC_PARAMETERS_COUNT#

#define ESL_DISPLAY_INIT_FUNC_PARAMETERS_COUNT

(1)

ESL Display extra parameters count for init_func esl_va_method function.

ESL_DISPLAY_WRITE_FUNC_PARAMETERS_COUNT#

#define ESL_DISPLAY_WRITE_FUNC_PARAMETERS_COUNT

(2)

ESL Display extra parameters count for write_func esl_va_method function.