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!

esl_display_get_width#

sl_status_t esl_display_get_width (uint8_t display_index, uint16_t * width)

Get a display width based on display index. Returns

• sl_status_t SL_STATUS_OK if display_index is valid, error otherwise.

Note

• : The function is only defined in esl_tag_display component (if added)

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)

Get a display height based on display index. Returns

• sl_status_t SL_STATUS_OK if display_index is valid, error otherwise.

Note

• : The function is only defined in esl_tag_display component (if added)

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)

Get a display type based on display index. Returns

• sl_status_t SL_STATUS_OK if display_index is valid, error otherwise.

Note

• : The function is only defined in esl_tag_display component (if added)

Display type getter. Returns

• sl_status_t

esl_image_select_object#

sl_status_t esl_image_select_object (void const * data, uint16_t length)

Select an image storage OTS object. Returns

• sl_status_t SL_STATUS_OK if select successful, error code otherwise.

Note

• : The function is only defined in esl_tag_image component (if added)

esl_image_chunk_received#

sl_status_t esl_image_chunk_received (uint8_t const * data, uint32_t offset, uint16_t length)

Callback on image chunk received event. Returns

• sl_status_t SL_STATUS_OK if stored successfully, error otherwise.

Note

• : The function is defined in esl_tag_image component (if added), and is used externally only by esl_tag_cli_test_harness to mimic the image transfer during ESL PTS tests where OTS data transfer itself is far out of scope.

esl_core_update_complete#

sl_status_t esl_core_update_complete (void )

Request ESL to return the Synchronized state from a connection if it's already synchronized to the AP's PAwR train. Note

• : Defined in esl_core but not exposed to the public ESL API

esl_core_start_advertising#

sl_status_t esl_core_start_advertising (void )

Start ESL service advertisement. Note

• : Defined in esl_core but not exposed to the public ESL API

esl_core_purge_responses#

void esl_core_purge_responses (void )

Purge any pending responses that aren't sent yet. Note

• : Defined in esl_tag_response.c but not exposed to the public ESL API

esl_reschedule_delayed_commands#

void esl_reschedule_delayed_commands (uint32_t current_absolute_time)

Re-schedule pending commands if there're any. Note

• : Called by esl core internally after absolute time has been adjusted. The function is defined in esl_tag_opcodes.c

esl_core_get_sync_handle#

uint16_t esl_core_get_sync_handle (void )

Get sync handle. Returns

• The PAwR sync hanle or SL_BT_INVALID_SYNC_HANDLE if ESL is out of sync.

Note

• : Called by esl core internally on opcodes parsing. The function is defined in esl_tag_core.c

esl_core_get_request_event#

uint16_t esl_core_get_request_event (void )

Get request event value for PAwR response. Returns

• The most recent PAwR sync request event value.

Note

• : Called by esl core internally on opcodes parsing. The function is defined in esl_tag_core.c

esl_core_get_request_subevent#

uint8_t esl_core_get_request_subevent (void )

Get request subevent value for PAwR response. Returns

• The most recent PAwR sync request subevent value.

Note

• : Called by esl core internally on opcodes parsing. The function is defined in esl_tag_core.c

esl_core_invalidate_config#

void esl_core_invalidate_config (void )

Invalidate entire ESL configuration to prevent later opcode processing. Note

• : Called by esl core internally on factory reset opcode execution. The function is defined in esl_tag_core.c

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_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.