Object Client#

sl_bt_ots_client_status_t#

sl_bt_ots_client_status_t

sl_bt_ots_characteristic_uuid_index#

sl_bt_ots_characteristic_uuid_index

sl_bt_ots_object_metadata_write_event_type_t#

sl_bt_ots_object_metadata_write_event_type_t

sl_bt_ots_object_metadata_write_response_code_t#

sl_bt_ots_object_metadata_write_response_code_t

sl_bt_ots_object_metadata_read_event_type_t#

sl_bt_ots_object_metadata_read_event_type_t

sl_bt_ots_object_metadata_read_response_code_t#

sl_bt_ots_object_metadata_read_response_code_t

sl_bt_ots_oacp_opcode_t#

sl_bt_ots_oacp_opcode_t

sl_bt_ots_oacp_response_code_t#

sl_bt_ots_oacp_response_code_t

sl_bt_ots_transfer_result_t#

sl_bt_ots_transfer_result_t

sl_bt_ots_olcp_opcode_t#

sl_bt_ots_olcp_opcode_t

sl_bt_ots_olcp_response_code_t#

sl_bt_ots_olcp_response_code_t

sl_bt_ots_list_sort_order_t#

sl_bt_ots_list_sort_order_t

sl_bt_ots_object_list_filter_type_t#

sl_bt_ots_object_list_filter_type_t

sl_bt_ots_client_handle_t#

typedef struct sl_bt_ots_client* sl_bt_ots_client_handle_t

OTS Object Client handle.

sl_bt_ots_client_connection_callback_t#

typedef void(* sl_bt_ots_client_connection_callback_t) (sl_bt_ots_client_handle_t client) )(sl_bt_ots_client_handle_t client)

OTS Object Client callback function prototype for connection or disconnection

sl_bt_ots_client_subscription_callback_t#

typedef void(* sl_bt_ots_client_subscription_callback_t) (sl_bt_ots_client_handle_t client, sl_bt_ots_subscription_status_t status) )(sl_bt_ots_client_handle_t client, sl_bt_ots_subscription_status_t status)

OTS Object Client callback function prototype for indication subscription status

sl_bt_ots_client_object_changed_callback_t#

typedef void(* sl_bt_ots_client_object_changed_callback_t) (sl_bt_ots_client_handle_t client, sl_bt_ots_object_changed_flags_t flags, sl_bt_ots_object_id_t *object) )(sl_bt_ots_client_handle_t client, sl_bt_ots_object_changed_flags_t flags, sl_bt_ots_object_id_t *object)

OTS Object Client callback function prototype to handle Object Change event

sl_bt_ots_client_features_callback_t#

typedef void(* sl_bt_ots_client_features_callback_t) (sl_bt_ots_client_handle_t client, sl_status_t status, sl_bt_ots_features_t features) )(sl_bt_ots_client_handle_t client, sl_status_t status, sl_bt_ots_features_t features)

OTS Object Client callback function prototype for OTS Feature read status

sl_bt_ots_client_list_filter_write_callback_t#

typedef void(* sl_bt_ots_client_list_filter_write_callback_t) (sl_bt_ots_client_handle_t client, uint16_t status) )(sl_bt_ots_client_handle_t client, uint16_t status)

OTS Object Client callback function prototype List Filter Write response

sl_bt_ots_client_list_filter_read_callback_t#

typedef void(* sl_bt_ots_client_list_filter_read_callback_t) (sl_bt_ots_client_handle_t client, sl_status_t status, sl_bt_ots_object_list_filter_content_t filter) )(sl_bt_ots_client_handle_t client, sl_status_t status, sl_bt_ots_object_list_filter_content_t filter)

OTS Object Client callback function prototype List Filter Write response

sl_bt_ots_client_olcp_callback_t#

typedef void(* sl_bt_ots_client_olcp_callback_t) (sl_bt_ots_client_handle_t client, sl_bt_ots_object_id_t *object, sl_bt_ots_olcp_opcode_t opcode, uint16_t status, sl_bt_ots_olcp_response_code_t response, uint32_t number_of_objects) )(sl_bt_ots_client_handle_t client, sl_bt_ots_object_id_t *object, sl_bt_ots_olcp_opcode_t opcode, uint16_t status, sl_bt_ots_olcp_response_code_t response, uint32_t number_of_objects)

OTS Object Client callback function prototype to handle OLCP responses

sl_bt_ots_client_oacp_callback_t#

typedef void(* sl_bt_ots_client_oacp_callback_t) (sl_bt_ots_client_handle_t client, sl_bt_ots_object_id_t *object, sl_bt_ots_oacp_opcode_t opcode, uint16_t status, sl_bt_ots_oacp_response_code_t response, sl_bt_ots_oacp_response_data_t *data) )(sl_bt_ots_client_handle_t client, sl_bt_ots_object_id_t *object, sl_bt_ots_oacp_opcode_t opcode, uint16_t status, sl_bt_ots_oacp_response_code_t response, sl_bt_ots_oacp_response_data_t *data)

OTS Object Client callback function prototype to handle OACP responses

sl_bt_ots_client_object_metadata_write_callback_t#

typedef void(* sl_bt_ots_client_object_metadata_write_callback_t) (sl_bt_ots_client_handle_t client, sl_bt_ots_object_id_t *object, sl_bt_ots_object_metadata_write_event_type_t event, uint16_t status) )(sl_bt_ots_client_handle_t client, sl_bt_ots_object_id_t *object, sl_bt_ots_object_metadata_write_event_type_t event, uint16_t status)

OTS Object Server callback function prototype to handle metadata writes

sl_bt_ots_client_object_metadata_read_callback_t#

typedef void(* sl_bt_ots_client_object_metadata_read_callback_t) (sl_bt_ots_client_handle_t client, sl_bt_ots_object_id_t *object, uint16_t status, sl_bt_ots_object_metadata_read_event_type_t event, sl_bt_ots_object_metadata_read_parameters_t *parameters) )(sl_bt_ots_client_handle_t client, sl_bt_ots_object_id_t *object, uint16_t status, sl_bt_ots_object_metadata_read_event_type_t event, sl_bt_ots_object_metadata_read_parameters_t *parameters)

OTS Object Client callback function prototype to handle metadata reads

sl_bt_ots_client_data_receive_callback_t#

typedef sl_bt_ots_l2cap_credit_t(* sl_bt_ots_client_data_receive_callback_t) (sl_bt_ots_client_handle_t client, sl_bt_ots_object_id_t *object, uint32_t current_offset, uint8_t *data, uint32_t size) )(sl_bt_ots_client_handle_t client, sl_bt_ots_object_id_t *object, uint32_t current_offset, uint8_t *data, uint32_t size)

OTS Object Client callback function prototype to handle data reception Returns

• Credits to give to the transmitter.

sl_bt_ots_client_data_transmit_callback_t#

typedef void(* sl_bt_ots_client_data_transmit_callback_t) (sl_bt_ots_client_handle_t client, sl_bt_ots_object_id_t *object, uint32_t current_offset, uint32_t size, uint8_t **data, uint32_t *data_size) )(sl_bt_ots_client_handle_t client, sl_bt_ots_object_id_t *object, uint32_t current_offset, uint32_t size, uint8_t **data, uint32_t *data_size)

OTS Object Client callback function prototype to handle data transmission

sl_bt_ots_client_data_transfer_finished_t#

typedef void(* sl_bt_ots_client_data_transfer_finished_t) (sl_bt_ots_client_handle_t client, sl_bt_ots_object_id_t *object, sl_bt_ots_transfer_result_t result) )(sl_bt_ots_client_handle_t client, sl_bt_ots_object_id_t *object, sl_bt_ots_transfer_result_t result)

OTS Object Client callback function prototype to handle transmission status

sl_bt_ots_client_group_metadata_read_t#

typedef void(* sl_bt_ots_client_group_metadata_read_t) (sl_bt_ots_client_handle_t client, sl_bt_ots_object_t *object, sl_bt_ots_metadata_fields_t remaining_fields, sl_status_t result) )(sl_bt_ots_client_handle_t client, sl_bt_ots_object_t *object, sl_bt_ots_metadata_fields_t remaining_fields, sl_status_t result)

OTS Object Client callback function prototype to handle metadata read.

sl_bt_ots_client_init_callback_t#

typedef void(* sl_bt_ots_client_init_callback_t) (sl_bt_ots_client_handle_t client, sl_status_t result, sl_bt_ots_gattdb_handles_t *gattdb_handles) )(sl_bt_ots_client_handle_t client, sl_status_t result, sl_bt_ots_gattdb_handles_t *gattdb_handles)

OTS Object Client callback function prototype to handle initialization status.

sl_bt_ots_client_t#

typedef struct sl_bt_ots_client sl_bt_ots_client_t

OTS Object Client instance type.

sl_bt_ots_oacp_features_t#

typedef uint32_t sl_bt_ots_oacp_features_t

Object Action Control Point Features.

sl_bt_ots_olcp_features_t#

typedef uint32_t sl_bt_ots_olcp_features_t

Object List Control Point Features.

sl_bt_ots_features_t#

typedef struct @23 sl_bt_ots_features_t

Object Transfer Service features.

< OACP feature flags OLCP feature flags

sl_bt_ots_object_name_t#

typedef struct @24 sl_bt_ots_object_name_t

Object name.

< Length of the object name field Object name string.

sl_bt_ots_object_size_t#

typedef struct @25 sl_bt_ots_object_size_t

Object size.

< Indicates the actual size of the object Contains the allocated size of the object

sl_bt_ots_object_first_created_t#

typedef sl_bt_ots_time_t sl_bt_ots_object_first_created_t

Object first created.

sl_bt_ots_object_last_modified_t#

typedef sl_bt_ots_time_t sl_bt_ots_object_last_modified_t

Object last modified.

sl_bt_ots_object_id_complete_t#

typedef struct @26 sl_bt_ots_object_id_complete_t

Complete Object ID.

< First byte is Reserved for Future Use Usable data for Object ID

sl_bt_ots_object_properties_t#

typedef uint32_t sl_bt_ots_object_properties_t

Object properties.

sl_bt_ots_metadata_fields_t#

typedef uint8_t sl_bt_ots_metadata_fields_t

Metadata fields type.

sl_bt_ots_oacp_event_t#

typedef sl_bt_ots_oacp_opcode_t sl_bt_ots_oacp_event_t

sl_bt_ots_oacp_create_parameters_t#

typedef struct @27 sl_bt_ots_oacp_create_parameters_t

OACP Create opcode parameters.

< Required size of the object Required type of the object

sl_bt_ots_oacp_calculate_checksum_parameters_t#

typedef struct @28 sl_bt_ots_oacp_calculate_checksum_parameters_t

OACP Calculate Checksum opcode parameters.

< Offset to calculate checksum from. Length of the data from the offset.

sl_bt_ots_oacp_execute_parameters_t#

typedef uint8array sl_bt_ots_oacp_execute_parameters_t

OACP Execute opcode parameters.

sl_bt_ots_oacp_read_parameters_t#

typedef struct @29 sl_bt_ots_oacp_read_parameters_t

OACP Read opcode parameters.

< Offset to read data from. Length of the data to be read.

sl_bt_ots_oacp_write_mode_t#

typedef uint8_t sl_bt_ots_oacp_write_mode_t

Object write mode flags.

sl_bt_ots_oacp_write_parameters_t#

typedef struct @30 sl_bt_ots_oacp_write_parameters_t

OACP Write opcode parameters.

< Offset of the data to be written. Length of the data to be written. Mode of write: truncation can be selected.

sl_bt_ots_l2cap_credit_t#

typedef uint16_t sl_bt_ots_l2cap_credit_t

Data response credits.

sl_bt_ots_oacp_message_t#

typedef struct @31 sl_bt_ots_oacp_message_t

OACP Message.

< OACP opcode Response data

sl_bt_ots_oacp_response_message_t#

typedef struct @32 sl_bt_ots_oacp_response_message_t

OACP response.

< OACP response opcode OACP opcode Response parameters Response data

sl_bt_ots_olcp_event_t#

typedef sl_bt_ots_olcp_opcode_t sl_bt_ots_olcp_event_t

sl_bt_ots_olcp_go_to_parameters_t#

typedef struct @33 sl_bt_ots_olcp_go_to_parameters_t

OLCP Go To opcode parameters.

< ID parameter

sl_bt_ots_olcp_order_parameters_t#

typedef struct @34 sl_bt_ots_olcp_order_parameters_t

OLCP Order opcode parameters.

< List Sort Order parameter

sl_bt_ots_olcp_message_t#

typedef struct @35 sl_bt_ots_olcp_message_t

OLCP message.

< OLCP opcode OLCP opcode parameters

sl_bt_ots_olcp_response_message_t#

typedef struct @36 sl_bt_ots_olcp_response_message_t

OLCP response message.

< OLCP opcode OLCP opcode OLCP response OLCP Number of Objects in response (optional)

sl_bt_ots_object_list_filter_name_parameters_t#

typedef sl_bt_ots_object_name_t sl_bt_ots_object_list_filter_name_parameters_t

Name filter parameters.

sl_bt_ots_object_list_filter_time_parameters_t#

typedef struct @37 sl_bt_ots_object_list_filter_time_parameters_t

Time filter parameters.

< Inclusive time to contain objects from Inclusive time to contain objects to

sl_bt_ots_object_list_filter_size_parameters_t#

typedef struct @38 sl_bt_ots_object_list_filter_size_parameters_t

Size filter parameters.

< Inclusive size to contain objects from Inclusive size to contain objects to

sl_bt_ots_object_list_filter_type_parameters_t#

typedef sl_bt_ots_object_type_t sl_bt_ots_object_list_filter_type_parameters_t

sl_bt_ots_object_list_filter_content_t#

typedef struct @39 sl_bt_ots_object_list_filter_content_t

Object List Filter content.

< Filter type < Name based filter parameter Time based filter parameter Size filter parameter Size filter parameter Filter parameters

sl_bt_ots_object_changed_flags_t#

typedef uint8_t sl_bt_ots_object_changed_flags_t

Object change flags.

sl_bt_ots_object_changed_content_t#

typedef struct @40 sl_bt_ots_object_changed_content_t

Object Changed content.

< Flags to indicate the type of change Object ID

sl_bt_ots_gattdb_handles_t#

typedef struct @41 sl_bt_ots_gattdb_handles_t

OTS GATT database handles.

< GATT database handle for Object Transfer Service < GATT database handle for OTS Features characteristic GATT database handle for Object Name characteristic GATT database handle for Object Type characteristic GATT database handle for Object Size characteristic GATT database handle for Object Frist Created characteristic GATT database handle for Object Last Modified characteristic GATT database handle for Object ID characteristic GATT database handle for Object Properties characteristic GATT database handle for OACP characteristic GATT database handle for OLCP characteristic GATT database handle for Object List Filter characteristic GATT database handle for Object Changed characteristic

sl_bt_ots_compare_t#

typedef int(* sl_bt_ots_compare_t) (uint8_t *key_1, uint8_t *key_2) )(uint8_t *key_1, uint8_t *key_2)

Function prototype to compare keys (for list ordering) Returns

• 0 if key_1 is equal to key_2, less than 0 if key_2 < key_1 and more than 0 otherwise.

sl_bt_ots_list_item_t#

typedef struct @42 sl_bt_ots_list_item_t

Datatype for object list item.

< List node field (pointer to next) Pointer to list key (order key) Pointer to value (the Object)

sl_bt_ots_list_t#

typedef struct @43 sl_bt_ots_list_t

Datatype for object list.

< Comparator function List header

sl_bt_ots_characteristic_uuids#

const uint16_t sl_bt_ots_characteristic_uuids[SL_BT_OTS_CHARACTERISTIC_UUID_COUNT]

Array of OTS Characteristic UUIDs.

sl_bt_ots_client_init#

sl_status_t sl_bt_ots_client_init (sl_bt_ots_client_handle_t client, uint8_t connection, uint32_t service, sl_bt_ots_client_callbacks_t * callbacks, sl_bt_ots_gattdb_handles_t * gattdb_handles)

Initialize Object Client. Returns

• Status code

sl_bt_ots_client_read_ots_features#

sl_status_t sl_bt_ots_client_read_ots_features (sl_bt_ots_client_handle_t client)

Read Object Transfer Service Features supported by the Server.

Read response is given in callback. Returns

• Status code

sl_bt_ots_client_read_object_name#

sl_status_t sl_bt_ots_client_read_object_name (sl_bt_ots_client_handle_t client)

Read Object Name of the Current Object.

Read response is given in callback. Returns

• Status code

sl_bt_ots_client_read_object_type#

sl_status_t sl_bt_ots_client_read_object_type (sl_bt_ots_client_handle_t client)

Read Object Type of the Current Object.

Read response is given in callback. Returns

• Status code

sl_bt_ots_client_read_object_size#

sl_status_t sl_bt_ots_client_read_object_size (sl_bt_ots_client_handle_t client)

Read Object Size of the Current Object.

Read response is given in callback. Returns

• Status code

sl_bt_ots_client_read_object_first_created#

sl_status_t sl_bt_ots_client_read_object_first_created (sl_bt_ots_client_handle_t client)

Read Object First Created time of the Current Object.

Read response is given in callback. Returns

• Status code

sl_bt_ots_client_read_object_last_modified#

sl_status_t sl_bt_ots_client_read_object_last_modified (sl_bt_ots_client_handle_t client)

Read Object Last Modifed time of the Current Object.

Read response is given in callback. Returns

• Status code

sl_bt_ots_client_read_object_id#

sl_status_t sl_bt_ots_client_read_object_id (sl_bt_ots_client_handle_t client)

Read Object ID of the Current Object.

Read response is given in callback. Returns

• Status code

sl_bt_ots_client_read_object_properties#

sl_status_t sl_bt_ots_client_read_object_properties (sl_bt_ots_client_handle_t client)

Read Object Properties of the Current Object.

Read response is given in callback. Returns

• Status code

sl_bt_ots_client_write_name#

sl_status_t sl_bt_ots_client_write_name (sl_bt_ots_client_handle_t client, char * name, uint8_t size)

Write Object Name of the Current Object.

Write response is given in callback. Returns

• Status code

sl_bt_ots_client_write_object_first_created#

sl_status_t sl_bt_ots_client_write_object_first_created (sl_bt_ots_client_handle_t client, sl_bt_ots_time_t * time)

Write Object First Created field of the Current Object.

Write response is given in callback. Returns

• Status code

sl_bt_ots_client_write_object_last_modified#

sl_status_t sl_bt_ots_client_write_object_last_modified (sl_bt_ots_client_handle_t client, sl_bt_ots_time_t * time)

Write Object Last Modifed field of the Current Object.

Write response is given in callback. Returns

• Status code

sl_bt_ots_client_write_object_properties#

sl_status_t sl_bt_ots_client_write_object_properties (sl_bt_ots_client_handle_t client, sl_bt_ots_object_properties_t properties)

Write Object Properties field of the Current Object.

Write response is given in callback. Returns

• Status code

sl_bt_ots_client_olcp_first#

sl_status_t sl_bt_ots_client_olcp_first (sl_bt_ots_client_handle_t client)

Select the first object as Current Object.

Returns

• Status code

sl_bt_ots_client_olcp_last#

sl_status_t sl_bt_ots_client_olcp_last (sl_bt_ots_client_handle_t client)

Select the last object as Current Object.

Returns

• Status code

sl_bt_ots_client_olcp_previous#

sl_status_t sl_bt_ots_client_olcp_previous (sl_bt_ots_client_handle_t client)

Select the previous object as Current Object.

Returns

• Status code

sl_bt_ots_client_olcp_next#

sl_status_t sl_bt_ots_client_olcp_next (sl_bt_ots_client_handle_t client)

Select the next object as Current Object.

Returns

• Status code

sl_bt_ots_client_olcp_go_to#

sl_status_t sl_bt_ots_client_olcp_go_to (sl_bt_ots_client_handle_t client, sl_bt_ots_object_id_t * object)

Select the specified object as Current Object.

Returns

• Status code

sl_bt_ots_client_olcp_order#

sl_status_t sl_bt_ots_client_olcp_order (sl_bt_ots_client_handle_t client, sl_bt_ots_list_sort_order_t order)

Select the List Sort Order.

Returns

• Status code

sl_bt_ots_client_olcp_request_number_of_objects#

sl_status_t sl_bt_ots_client_olcp_request_number_of_objects (sl_bt_ots_client_handle_t client)

Request total number of objects.

Returns

• Status code

sl_bt_ots_client_olcp_clear_marking#

sl_status_t sl_bt_ots_client_olcp_clear_marking (sl_bt_ots_client_handle_t client)

Clear marking of objects.

Returns

• Status code

sl_bt_ots_client_read_object_list_filter#

sl_status_t sl_bt_ots_client_read_object_list_filter (sl_bt_ots_client_handle_t client)

Read object list filter.

Read response is given in callback. Returns

• Status code

sl_bt_ots_client_write_object_list_filter#

sl_status_t sl_bt_ots_client_write_object_list_filter (sl_bt_ots_client_handle_t client, sl_bt_ots_object_list_filter_content_t filter)

Write/set object list filter.

Write response is given in callback. Returns

• Status code

sl_bt_ots_client_oacp_create_object#

sl_status_t sl_bt_ots_client_oacp_create_object (sl_bt_ots_client_handle_t client, uint32_t size, sl_bt_ots_object_type_t type)

Create new object.

Write response is given in callback. Returns

• Status code

sl_bt_ots_client_oacp_delete_object#

sl_status_t sl_bt_ots_client_oacp_delete_object (sl_bt_ots_client_handle_t client)

Delete current object.

Write response is given in callback. Returns

• Status code

sl_bt_ots_client_oacp_calculate_checksum#

sl_status_t sl_bt_ots_client_oacp_calculate_checksum (sl_bt_ots_client_handle_t client, uint32_t offset, uint32_t length)

Calculate checksum for Current Object.

Returns

• Status code

sl_bt_ots_client_oacp_execute#

sl_status_t sl_bt_ots_client_oacp_execute (sl_bt_ots_client_handle_t client, uint8_t * optional_data, uint8_t optional_data_size)

Execute Current Object.

Returns

• Status code

sl_bt_ots_client_oacp_read#

sl_status_t sl_bt_ots_client_oacp_read (sl_bt_ots_client_handle_t client, uint32_t offset, uint32_t length, uint16_t max_sdu, uint16_t max_pdu)

Read Current Object.

Returns

• Status code

sl_bt_ots_client_oacp_write#

sl_status_t sl_bt_ots_client_oacp_write (sl_bt_ots_client_handle_t client, uint32_t offset, uint32_t length, sl_bt_ots_oacp_write_mode_t mode, uint16_t max_sdu, uint16_t max_pdu)

Write Current Object.

Returns

• Status code

sl_bt_ots_client_oacp_abort#

sl_status_t sl_bt_ots_client_oacp_abort (sl_bt_ots_client_handle_t client)

Abort current read.

Returns

• Status code

sl_bt_ots_client_increase_credit#

sl_status_t sl_bt_ots_client_increase_credit (sl_bt_ots_client_handle_t client, uint16_t credit)

Increase the credit for the L2CAP transfer that is in progress Returns

• Response code

sl_bt_ots_client_abort#

sl_status_t sl_bt_ots_client_abort (sl_bt_ots_client_handle_t client)

Abort current write or read operation. Close the L2CAP channel in case of Write operation is in progress or execute OACP Abort in case of Read operation is in progress.

Returns

• Status code