Bluetooth LE Profile API document
Bluetooth LE Profile API document Rev.1.00 [May 22, 2020]
Object Transfer Service Client

This is the client for the Object Transfer Service Service. More...

Detailed Description

This is the client for the Object Transfer Service Service.

Data Structures

struct  st_ble_otc_uuid_value_t
 
struct  st_ble_otc_uuid_t
 
struct  st_ble_lnc_feat_oacp_features_t
 OTS Feature OACP Features value structure. More...
 
struct  st_ble_lnc_feat_olcp_features_t
 OTS Feature OLCP Features value structure. More...
 
struct  st_ble_otc_feat_t
 OTS Feature value structure. More...
 
struct  st_ble_otc_feat_attr_hdl_t
 OTS Feature attribute handle value. More...
 
struct  st_ble_otc_obj_name_attr_hdl_t
 Object Name attribute handle value. More...
 
struct  st_ble_otc_obj_type_attr_hdl_t
 Object Type attribute handle value. More...
 
struct  st_ble_otc_obj_size_t
 Object Size value structure. More...
 
struct  st_ble_otc_obj_size_attr_hdl_t
 Object Size attribute handle value. More...
 
struct  st_ble_otc_obj_first_created_attr_hdl_t
 Object First-Created attribute handle value. More...
 
struct  st_ble_otc_obj_last_modified_attr_hdl_t
 Object Last-Modified attribute handle value. More...
 
struct  st_ble_otc_obj_id_attr_hdl_t
 Object ID attribute handle value. More...
 
struct  st_ble_otc_obj_prop_t
 Object Properties value structure. More...
 
struct  st_ble_otc_obj_prop_attr_hdl_t
 Object Properties attribute handle value. More...
 
struct  st_ble_otc_obj_action_cp_t
 Object Action Control Point value structure. More...
 
struct  st_ble_otc_obj_action_cp_attr_hdl_t
 Object Action Control Point attribute handle value. More...
 
struct  st_ble_otc_obj_list_cp_t
 Object List Control Point value structure. More...
 
struct  st_ble_otc_obj_list_cp_attr_hdl_t
 Object List Control Point attribute handle value. More...
 
struct  st_ble_otc_obj_list_filter_0_t
 Object List Filter 0 value structure. More...
 
struct  st_ble_otc_obj_list_filter_0_attr_hdl_t
 Object List Filter 0 attribute handle value. More...
 
struct  st_ble_otc_obj_list_filter_1_t
 Object List Filter 1 value structure. More...
 
struct  st_ble_otc_obj_list_filter_1_attr_hdl_t
 Object List Filter 1 attribute handle value. More...
 
struct  st_ble_otc_obj_list_filter_2_t
 Object List Filter 2 value structure. More...
 
struct  st_ble_otc_obj_list_filter_2_attr_hdl_t
 Object List Filter 2 attribute handle value. More...
 
struct  st_ble_lnc_obj_changed_flags_t
 Object Changed Flags value structure. More...
 
struct  st_ble_otc_obj_changed_t
 Object Changed value structure. More...
 
struct  st_ble_otc_obj_changed_attr_hdl_t
 Object Changed attribute handle value. More...
 
struct  st_ble_otc_evt_data_t
 Object Transfer Service client event data. More...
 

Macros

#define BLE_OTC_PRV_OACP_CREATE_OP_CODE_SUPPORTED   (1 << 0)
 OACP Create Op Code Supported bit. More...
 
#define BLE_OTC_PRV_OACP_DELETE_OP_CODE_SUPPORTED   (1 << 1)
 OACP Delete Op Code Supported bit. More...
 
#define BLE_OTC_PRV_OACP_CALCULATE_CHECKSUM_OP_CODE_SUPPORTED   (1 << 2)
 OACP Calculate Checksum Op Code Supported bit. More...
 
#define BLE_OTC_PRV_OACP_EXECUTE_OP_CODE_SUPPORTED   (1 << 3)
 OACP Execute Op Code Supported bit. More...
 
#define BLE_OTC_PRV_OACP_READ_OP_CODE_SUPPORTED   (1 << 4)
 OACP Read Op Code Supported bit. More...
 
#define BLE_OTC_PRV_OACP_WRITE_OP_CODE_SUPPORTED   (1 << 5)
 OACP Write Op Code Supported bit. More...
 
#define BLE_OTC_PRV_APPENDING_ADDITIONAL_DATA_TO_OBJECTS_SUPPORTED   (1 << 6)
 Appending Additional Data to Objects Supported bit. More...
 
#define BLE_OTC_PRV_TRUNCATION_OF_OBJECTS_SUPPORTED   (1 << 7)
 Truncation of Objects Supported bit. More...
 
#define BLE_OTC_PRV_PATCHING_OF_OBJECTS_SUPPORTED   (1 << 8)
 Patching of Objects Supported bit. More...
 
#define BLE_OTC_PRV_OACP_ABORT_OP_CODE_SUPPORTED   (1 << 9)
 OACP Abort Op Code Supported bit. More...
 
#define BLE_OTC_PRV_OLCP_GO_TO_OP_CODE_SUPPORTED   (1 << 0)
 OLCP Go To Op Code Supported bit. More...
 
#define BLE_OTC_PRV_OLCP_ORDER_OP_CODE_SUPPORTED   (1 << 1)
 OLCP Order Op Code Supported bit. More...
 
#define BLE_OTC_PRV_OLCP_REQUEST_NUMBER_OF_OBJECTS_OP_CODE_SUPPORTED   (1 << 2)
 OLCP Request Number of Objects Op Code Supported bit. More...
 
#define BLE_OTC_PRV_OLCP_CLEAR_MARKING_OP_CODE_SUPPORTED   (1 << 3)
 OLCP Clear Marking Op Code Supported bit. More...
 
#define BLE_OTC_PRV_DELETION_OF_THIS_OBJECT_IS_PERMITTED   (1 << 0)
 Deletion of this object is permitted bit. More...
 
#define BLE_OTC_PRV_EXECUTION_OF_THIS_OBJECT_IS_PERMITTED   (1 << 1)
 Execution of this object is permitted bit. More...
 
#define BLE_OTC_PRV_READING_THIS_OBJECT_IS_PERMITTED   (1 << 2)
 Reading this object is permitted bit. More...
 
#define BLE_OTC_PRV_WRITING_DATA_TO_THIS_OBJECT_IS_PERMITTED   (1 << 3)
 Writing data to this object is permitted bit. More...
 
#define BLE_OTC_PRV_APPENDING_DATA_THAT_INCREASES_OBJ_ALLOCATED_SIZE_IS_PERMITTED   (1 << 4)
 Appending data to this object is permitted bit. More...
 
#define BLE_OTC_PRV_TRUNCATION_OF_THIS_OBJECT_IS_PERMITTED   (1 << 5)
 Truncation of this object is permitted bit. More...
 
#define BLE_OTC_PRV_PATCHING_BY_OVERWRITING_OBJECT_EXISTING_CONTENTS_IS_PERMITTED   (1 << 6)
 Patching this object by overwriting is permitted bit. More...
 
#define BLE_OTC_PRV_THIS_OBJECT_IS_A_MARKED_OBJECT   (1 << 7)
 This object is a marked object bit. More...
 
#define BLE_OTC_PRV_SOURCE_OF_CHANGE   (1 << 0)
 Source of change bit. More...
 
#define BLE_OTC_PRV_CHANGE_OCCURRED_TO_THE_OBJECT_CONTENTS   (1 << 1)
 Change occured to the object contents bit. More...
 
#define BLE_OTC_PRV_CHANGE_OCCURRED_TO_THE_OBJECT_METADATA   (1 << 2)
 Change occured to the object metadata bit. More...
 
#define BLE_OTC_PRV_OBJECT_CREATION   (1 << 3)
 Object creation bit. More...
 
#define BLE_OTC_PRV_OBJECT_DELETION   (1 << 4)
 Object deletion bit. More...
 
#define BLE_OTC_FEAT_UUID   (0x2ABD)
 
#define BLE_OTC_FEAT_LEN   (8)
 
#define BLE_OTC_OBJ_NAME_UUID   (0x2ABE)
 
#define BLE_OTC_OBJ_NAME_LEN   (100)
 
#define BLE_OTC_OBJ_TYPE_UUID   (0x2ABF)
 
#define BLE_OTC_OBJ_TYPE_LEN   (16)
 
#define BLE_OTC_OBJ_SIZE_UUID   (0x2AC0)
 
#define BLE_OTC_OBJ_SIZE_LEN   (8)
 
#define BLE_OTC_OBJ_FIRST_CREATED_UUID   (0x2AC1)
 
#define BLE_OTC_OBJ_FIRST_CREATED_LEN   (7)
 
#define BLE_OTC_OBJ_LAST_MODIFIED_UUID   (0x2AC2)
 
#define BLE_OTC_OBJ_LAST_MODIFIED_LEN   (7)
 
#define BLE_OTC_OBJ_ID_UUID   (0x2AC3)
 
#define BLE_OTC_OBJ_ID_LEN   (6)
 
#define BLE_OTC_OBJ_PROP_UUID   (0x2AC4)
 
#define BLE_OTC_OBJ_PROP_LEN   (4)
 
#define BLE_OTC_OBJ_ACTION_CP_UUID   (0x2AC5)
 
#define BLE_OTC_OBJ_ACTION_CP_LEN   (21)
 
#define BLE_OTC_OBJ_ACTION_CP_CLI_CNFG_UUID   (0x2902)
 
#define BLE_OTC_OBJ_ACTION_CP_CLI_CNFG_LEN   (2)
 
#define BLE_OTC_OBJ_LIST_CP_UUID   (0x2AC6)
 
#define BLE_OTC_OBJ_LIST_CP_LEN   (7)
 
#define BLE_OTC_OBJ_LIST_CP_CLI_CNFG_UUID   (0x2902)
 
#define BLE_OTC_OBJ_LIST_CP_CLI_CNFG_LEN   (2)
 
#define BLE_OTC_OBJ_LIST_CP_PARAMETER_LEN   (6)
 
#define BLE_OTC_OBJ_LIST_FILTER_STRING_LEN   (18)
 
#define BLE_OTC_OBJ_NAME_OBJECT_NAME_LEN   (100)
 
#define BLE_OTC_OBJ_LIST_FILTER_0_UUID   (0x2AC7)
 
#define BLE_OTC_OBJ_LIST_FILTER_0_LEN   (100)
 
#define BLE_OTC_OBJ_LIST_FILTER_1_UUID   (0x2AC7)
 
#define BLE_OTC_OBJ_LIST_FILTER_1_LEN   (100)
 
#define BLE_OTC_OBJ_LIST_FILTER_2_UUID   (0x2AC7)
 
#define BLE_OTC_OBJ_LIST_FILTER_2_LEN   (100)
 
#define BLE_OTC_OBJ_CHANGED_UUID   (0x2AC8)
 
#define BLE_OTC_OBJ_CHANGED_LEN   (7)
 
#define BLE_OTC_OBJ_CHANGED_CLI_CNFG_UUID   (0x2902)
 
#define BLE_OTC_OBJ_CHANGED_CLI_CNFG_LEN   (2)
 
#define BLE_OTC_WRITE_REQUEST_REJECTED_ERROR   (BLE_ERR_GROUP_GATT | 0x80)
 An attempt was made to write a value that is invalid or not supported by this Server for a reason other than the attribute permissions. More...
 
#define BLE_OTC_OBJECT_NOT_SELECTED_ERROR   (BLE_ERR_GROUP_GATT | 0x81)
 An attempt was made to read or write to an Object Metadata characteristic while the Current Object was an Invalid Object (see Section 1.8 in the PDF sepcification). More...
 
#define BLE_OTC_CONCURRENCY_LIMIT_EXCEEDED_ERROR   (BLE_ERR_GROUP_GATT | 0x82)
 The Server is unable to service the Read Request or Write Request because it exceeds the concurrency limit of the service. More...
 
#define BLE_OTC_OBJECT_NAME_ALREADY_EXISTS_ERROR   (BLE_ERR_GROUP_GATT | 0x83)
 The requested object name was rejected because the name was already in use by an existing object on the Server. More...
 

Enumerations

enum  e_ble_otc_obj_id_object_id_t { BLE_OTC_OBJ_ID_OBJECT_ID_RESERVED_FOR_THE_DIRECTORY_LISTING_OBJECT = 0 }
 Object ID Object ID enumeration. More...
 
enum  e_ble_otc_obj_action_cp_op_code_t {
  BLE_OTC_OBJ_ACTION_CP_OP_CODE_CREATE = 1,
  BLE_OTC_OBJ_ACTION_CP_OP_CODE_DELETE = 2,
  BLE_OTC_OBJ_ACTION_CP_OP_CODE_CALCULATE_CHECKSUM = 3,
  BLE_OTC_OBJ_ACTION_CP_OP_CODE_EXECUTE = 4,
  BLE_OTC_OBJ_ACTION_CP_OP_CODE_READ = 5,
  BLE_OTC_OBJ_ACTION_CP_OP_CODE_WRITE = 6,
  BLE_OTC_OBJ_ACTION_CP_OP_CODE_ABORT = 7,
  BLE_OTC_OBJ_ACTION_CP_OP_CODE_RESPONSE_CODE = 96
}
 Object Action Control Point Op Code enumeration. More...
 
enum  e_ble_otc_obj_action_cp_result_code_t {
  BLE_OTC_OBJ_ACTION_CP_RESULT_CODE_SUCCESS = 1,
  BLE_OTC_OBJ_ACTION_CP_RESULT_CODE_OP_CODE_NOT_SUPPORTED = 2,
  BLE_OTC_OBJ_ACTION_CP_RESULT_CODE_INVALID_PARAMETER = 3,
  BLE_OTC_OBJ_ACTION_CP_RESULT_CODE_INSUFFICIENT_RESOURCES = 4,
  BLE_OTC_OBJ_ACTION_CP_RESULT_CODE_INVALID_OBJECT = 5,
  BLE_OTC_OBJ_ACTION_CP_RESULT_CODE_CHANNEL_UNAVAILABLE = 6,
  BLE_OTC_OBJ_ACTION_CP_RESULT_CODE_UNSUPPORTED_TYPE = 7,
  BLE_OTC_OBJ_ACTION_CP_RESULT_CODE_PROCEDURE_NOT_PERMITTED = 8,
  BLE_OTC_OBJ_ACTION_CP_RESULT_CODE_OBJECT_LOCKED = 9,
  BLE_OTC_OBJ_ACTION_CP_RESULT_CODE_OPERATION_FAILED = 10
}
 Object Action Control Point Result Code enumeration. More...
 
enum  e_ble_otc_obj_list_cp_op_code_t {
  BLE_OTC_OBJ_LIST_CP_OP_CODE_FIRST = 1,
  BLE_OTC_OBJ_LIST_CP_OP_CODE_LAST = 2,
  BLE_OTC_OBJ_LIST_CP_OP_CODE_PREVIOUS = 3,
  BLE_OTC_OBJ_LIST_CP_OP_CODE_NEXT = 4,
  BLE_OTC_OBJ_LIST_CP_OP_CODE_GO_TO = 5,
  BLE_OTC_OBJ_LIST_CP_OP_CODE_ORDER = 6,
  BLE_OTC_OBJ_LIST_CP_OP_CODE_REQUEST_NUMBER_OF_OBJECTS = 7,
  BLE_OTC_OBJ_LIST_CP_OP_CODE_CLEAR_MARKING = 8,
  BLE_OTC_OBJ_LIST_CP_OP_CODE_RESPONSE_CODE = 112
}
 Object List Control Point Op Code enumeration. More...
 
enum  e_ble_otc_obj_list_cp_result_code_t {
  BLE_OTC_OBJ_LIST_CP_RESULT_CODE_SUCCESS = 1,
  BLE_OTC_OBJ_LIST_CP_RESULT_CODE_OP_CODE_NOT_SUPPORTED = 2,
  BLE_OTC_OBJ_LIST_CP_RESULT_CODE_INVALID_PARAMETER = 3,
  BLE_OTC_OBJ_LIST_CP_RESULT_CODE_OPERATION_FAILED = 4,
  BLE_OTC_OBJ_LIST_CP_RESULT_CODE_OUT_OF_BOUNDS = 5,
  BLE_OTC_OBJ_LIST_CP_RESULT_CODE_TOO_MANY_OBJECTS = 6,
  BLE_OTC_OBJ_LIST_CP_RESULT_CODE_NO_OBJECT = 7,
  BLE_OTC_OBJ_LIST_CP_RESULT_CODE_OBJECT_ID_NOT_FOUND = 8
}
 Object List Control Point Result Code enumeration. More...
 
enum  e_ble_otc_obj_list_cp_list_sort_order_t {
  BLE_OTC_OBJ_LIST_CP_LIST_SORT_ORDER_ORDER_THE_LIST_BY_OBJECT_NAME__ASCENDING = 1,
  BLE_OTC_OBJ_LIST_CP_LIST_SORT_ORDER_ORDER_THE_LIST_BY_OBJECT_TYPE__ASCENDING = 2,
  BLE_OTC_OBJ_LIST_CP_LIST_SORT_ORDER_ORDER_THE_LIST_BY_OBJECT_CURRENT_SIZE__ASCENDING = 3,
  BLE_OTC_OBJ_LIST_CP_LIST_SORT_ORDER_ORDER_THE_LIST_BY_OBJECT_FIRST_CREATED_TIMESTAMP__ASCENDING = 4,
  BLE_OTC_OBJ_LIST_CP_LIST_SORT_ORDER_ORDER_THE_LIST_BY_OBJECT_LAST_MODIFIED_TIMESTAMP__ASCENDING = 5,
  BLE_OTC_OBJ_LIST_CP_LIST_SORT_ORDER_ORDER_THE_LIST_BY_OBJECT_NAME__DESCENDING = 17,
  BLE_OTC_OBJ_LIST_CP_LIST_SORT_ORDER_ORDER_THE_LIST_BY_OBJECT_TYPE__DESCENDING = 18,
  BLE_OTC_OBJ_LIST_CP_LIST_SORT_ORDER_ORDER_THE_LIST_BY_OBJECT_CURRENT_SIZE__DESCENDING = 19,
  BLE_OTC_OBJ_LIST_CP_LIST_SORT_ORDER_ORDER_THE_LIST_BY_OBJECT_FIRST_CREATED_TIMESTAMP__DESCENDING = 20,
  BLE_OTC_OBJ_LIST_CP_LIST_SORT_ORDER_ORDER_THE_LIST_BY_OBJECT_LAST_MODIFIED_TIMESTAMP__DESCENDING = 21
}
 Object List Control Point List Sort Order enumeration. More...
 
enum  e_ble_otc_obj_list_filter_0_filter_t {
  BLE_OTC_OBJ_LIST_FILTER_0_FILTER_NO_FILTER = 0,
  BLE_OTC_OBJ_LIST_FILTER_0_FILTER_NAME_STARTS_WITH = 1,
  BLE_OTC_OBJ_LIST_FILTER_0_FILTER_NAME_ENDS_WITH = 2,
  BLE_OTC_OBJ_LIST_FILTER_0_FILTER_NAME_CONTAINS = 3,
  BLE_OTC_OBJ_LIST_FILTER_0_FILTER_NAME_IS_EXACTLY = 4,
  BLE_OTC_OBJ_LIST_FILTER_0_FILTER_OBJECT_TYPE = 5,
  BLE_OTC_OBJ_LIST_FILTER_0_FILTER_CREATED_BETWEEN = 6,
  BLE_OTC_OBJ_LIST_FILTER_0_FILTER_MODIFIED_BETWEEN = 7,
  BLE_OTC_OBJ_LIST_FILTER_0_FILTER_CURRENT_SIZE_BETWEEN = 8,
  BLE_OTC_OBJ_LIST_FILTER_0_FILTER_ALLOCATED_SIZE_BETWEEN = 9,
  BLE_OTC_OBJ_LIST_FILTER_0_FILTER_MARKED_OBJECTS = 10
}
 Object List Filter 0 Filter enumeration. More...
 
enum  e_ble_otc_obj_list_filter_1_filter_t {
  BLE_OTC_OBJ_LIST_FILTER_1_FILTER_NO_FILTER = 0,
  BLE_OTC_OBJ_LIST_FILTER_1_FILTER_NAME_STARTS_WITH = 1,
  BLE_OTC_OBJ_LIST_FILTER_1_FILTER_NAME_ENDS_WITH = 2,
  BLE_OTC_OBJ_LIST_FILTER_1_FILTER_NAME_CONTAINS = 3,
  BLE_OTC_OBJ_LIST_FILTER_1_FILTER_NAME_IS_EXACTLY = 4,
  BLE_OTC_OBJ_LIST_FILTER_1_FILTER_OBJECT_TYPE = 5,
  BLE_OTC_OBJ_LIST_FILTER_1_FILTER_CREATED_BETWEEN = 6,
  BLE_OTC_OBJ_LIST_FILTER_1_FILTER_MODIFIED_BETWEEN = 7,
  BLE_OTC_OBJ_LIST_FILTER_1_FILTER_CURRENT_SIZE_BETWEEN = 8,
  BLE_OTC_OBJ_LIST_FILTER_1_FILTER_ALLOCATED_SIZE_BETWEEN = 9,
  BLE_OTC_OBJ_LIST_FILTER_1_FILTER_MARKED_OBJECTS = 10
}
 Object List Filter 1 Filter enumeration. More...
 
enum  e_ble_otc_obj_list_filter_2_filter_t {
  BLE_OTC_OBJ_LIST_FILTER_2_FILTER_NO_FILTER = 0,
  BLE_OTC_OBJ_LIST_FILTER_2_FILTER_NAME_STARTS_WITH = 1,
  BLE_OTC_OBJ_LIST_FILTER_2_FILTER_NAME_ENDS_WITH = 2,
  BLE_OTC_OBJ_LIST_FILTER_2_FILTER_NAME_CONTAINS = 3,
  BLE_OTC_OBJ_LIST_FILTER_2_FILTER_NAME_IS_EXACTLY = 4,
  BLE_OTC_OBJ_LIST_FILTER_2_FILTER_OBJECT_TYPE = 5,
  BLE_OTC_OBJ_LIST_FILTER_2_FILTER_CREATED_BETWEEN = 6,
  BLE_OTC_OBJ_LIST_FILTER_2_FILTER_MODIFIED_BETWEEN = 7,
  BLE_OTC_OBJ_LIST_FILTER_2_FILTER_CURRENT_SIZE_BETWEEN = 8,
  BLE_OTC_OBJ_LIST_FILTER_2_FILTER_ALLOCATED_SIZE_BETWEEN = 9,
  BLE_OTC_OBJ_LIST_FILTER_2_FILTER_MARKED_OBJECTS = 10
}
 Object List Filter 2 Filter enumeration. More...
 
enum  e_ble_otc_char_idx_t {
  BLE_OTC_FEAT_IDX,
  BLE_OTC_OBJ_NAME_IDX,
  BLE_OTC_OBJ_TYPE_IDX,
  BLE_OTC_OBJ_SIZE_IDX,
  BLE_OTC_OBJ_FIRST_CREATED_IDX,
  BLE_OTC_OBJ_LAST_MODIFIED_IDX,
  BLE_OTC_OBJ_ID_IDX,
  BLE_OTC_OBJ_PROP_IDX,
  BLE_OTC_OBJ_ACTION_CP_IDX,
  BLE_OTC_OBJ_ACTION_CP_CLI_CNFG_IDX,
  BLE_OTC_OBJ_LIST_CP_IDX,
  BLE_OTC_OBJ_LIST_CP_CLI_CNFG_IDX,
  BLE_OTC_OBJ_LIST_FILTER_0_IDX,
  BLE_OTC_OBJ_LIST_FILTER_1_IDX,
  BLE_OTC_OBJ_LIST_FILTER_2_IDX,
  BLE_OTC_OBJ_CHANGED_IDX,
  BLE_OTC_OBJ_CHANGED_CLI_CNFG_IDX
}
 Object Transfer Service characteristic ID. More...
 
enum  e_ble_otc_event_t {
  BLE_OTC_EVENT_FEAT_READ_RSP = BLE_SERVC_ATTR_EVENT(BLE_OTC_FEAT_IDX, BLE_SERVC_READ_RSP),
  BLE_OTC_EVENT_OBJ_NAME_READ_RSP = BLE_SERVC_ATTR_EVENT(BLE_OTC_OBJ_NAME_IDX, BLE_SERVC_READ_RSP),
  BLE_OTC_EVENT_OBJ_NAME_WRITE_RSP = BLE_SERVC_ATTR_EVENT(BLE_OTC_OBJ_NAME_IDX, BLE_SERVC_WRITE_RSP),
  BLE_OTC_EVENT_OBJ_TYPE_READ_RSP = BLE_SERVC_ATTR_EVENT(BLE_OTC_OBJ_TYPE_IDX, BLE_SERVC_READ_RSP),
  BLE_OTC_EVENT_OBJ_SIZE_READ_RSP = BLE_SERVC_ATTR_EVENT(BLE_OTC_OBJ_SIZE_IDX, BLE_SERVC_READ_RSP),
  BLE_OTC_EVENT_OBJ_FIRST_CREATED_READ_RSP = BLE_SERVC_ATTR_EVENT(BLE_OTC_OBJ_FIRST_CREATED_IDX, BLE_SERVC_READ_RSP),
  BLE_OTC_EVENT_OBJ_FIRST_CREATED_WRITE_RSP = BLE_SERVC_ATTR_EVENT(BLE_OTC_OBJ_FIRST_CREATED_IDX, BLE_SERVC_WRITE_RSP),
  BLE_OTC_EVENT_OBJ_LAST_MODIFIED_READ_RSP = BLE_SERVC_ATTR_EVENT(BLE_OTC_OBJ_LAST_MODIFIED_IDX, BLE_SERVC_READ_RSP),
  BLE_OTC_EVENT_OBJ_LAST_MODIFIED_WRITE_RSP = BLE_SERVC_ATTR_EVENT(BLE_OTC_OBJ_LAST_MODIFIED_IDX, BLE_SERVC_WRITE_RSP),
  BLE_OTC_EVENT_OBJ_ID_READ_RSP = BLE_SERVC_ATTR_EVENT(BLE_OTC_OBJ_ID_IDX, BLE_SERVC_READ_RSP),
  BLE_OTC_EVENT_OBJ_PROP_READ_RSP = BLE_SERVC_ATTR_EVENT(BLE_OTC_OBJ_PROP_IDX, BLE_SERVC_READ_RSP),
  BLE_OTC_EVENT_OBJ_PROP_WRITE_RSP = BLE_SERVC_ATTR_EVENT(BLE_OTC_OBJ_PROP_IDX, BLE_SERVC_WRITE_RSP),
  BLE_OTC_EVENT_OBJ_ACTION_CP_WRITE_RSP = BLE_SERVC_ATTR_EVENT(BLE_OTC_OBJ_ACTION_CP_IDX, BLE_SERVC_WRITE_RSP),
  BLE_OTC_EVENT_OBJ_ACTION_CP_HDL_VAL_IND = BLE_SERVC_ATTR_EVENT(BLE_OTC_OBJ_ACTION_CP_IDX, BLE_SERVC_HDL_VAL_IND),
  BLE_OTC_EVENT_OBJ_ACTION_CP_CLI_CNFG_READ_RSP = BLE_SERVC_ATTR_EVENT(BLE_OTC_OBJ_ACTION_CP_CLI_CNFG_IDX, BLE_SERVC_READ_RSP),
  BLE_OTC_EVENT_OBJ_ACTION_CP_CLI_CNFG_WRITE_RSP = BLE_SERVC_ATTR_EVENT(BLE_OTC_OBJ_ACTION_CP_CLI_CNFG_IDX, BLE_SERVC_WRITE_RSP),
  BLE_OTC_EVENT_OBJ_LIST_CP_WRITE_RSP = BLE_SERVC_ATTR_EVENT(BLE_OTC_OBJ_LIST_CP_IDX, BLE_SERVC_WRITE_RSP),
  BLE_OTC_EVENT_OBJ_LIST_CP_HDL_VAL_IND = BLE_SERVC_ATTR_EVENT(BLE_OTC_OBJ_LIST_CP_IDX, BLE_SERVC_HDL_VAL_IND),
  BLE_OTC_EVENT_OBJ_LIST_CP_CLI_CNFG_READ_RSP = BLE_SERVC_ATTR_EVENT(BLE_OTC_OBJ_LIST_CP_CLI_CNFG_IDX, BLE_SERVC_READ_RSP),
  BLE_OTC_EVENT_OBJ_LIST_CP_CLI_CNFG_WRITE_RSP = BLE_SERVC_ATTR_EVENT(BLE_OTC_OBJ_LIST_CP_CLI_CNFG_IDX, BLE_SERVC_WRITE_RSP),
  BLE_OTC_EVENT_OBJ_LIST_FILTER_0_READ_RSP = BLE_SERVC_ATTR_EVENT(BLE_OTC_OBJ_LIST_FILTER_0_IDX, BLE_SERVC_READ_RSP),
  BLE_OTC_EVENT_OBJ_LIST_FILTER_0_WRITE_RSP = BLE_SERVC_ATTR_EVENT(BLE_OTC_OBJ_LIST_FILTER_0_IDX, BLE_SERVC_WRITE_RSP),
  BLE_OTC_EVENT_OBJ_LIST_FILTER_1_READ_RSP = BLE_SERVC_ATTR_EVENT(BLE_OTC_OBJ_LIST_FILTER_1_IDX, BLE_SERVC_READ_RSP),
  BLE_OTC_EVENT_OBJ_LIST_FILTER_1_WRITE_RSP = BLE_SERVC_ATTR_EVENT(BLE_OTC_OBJ_LIST_FILTER_1_IDX, BLE_SERVC_WRITE_RSP),
  BLE_OTC_EVENT_OBJ_LIST_FILTER_2_READ_RSP = BLE_SERVC_ATTR_EVENT(BLE_OTC_OBJ_LIST_FILTER_2_IDX, BLE_SERVC_READ_RSP),
  BLE_OTC_EVENT_OBJ_LIST_FILTER_2_WRITE_RSP = BLE_SERVC_ATTR_EVENT(BLE_OTC_OBJ_LIST_FILTER_2_IDX, BLE_SERVC_WRITE_RSP),
  BLE_OTC_EVENT_OBJ_CHANGED_HDL_VAL_IND = BLE_SERVC_ATTR_EVENT(BLE_OTC_OBJ_CHANGED_IDX, BLE_SERVC_HDL_VAL_IND),
  BLE_OTC_EVENT_OBJ_CHANGED_CLI_CNFG_READ_RSP = BLE_SERVC_ATTR_EVENT(BLE_OTC_OBJ_CHANGED_CLI_CNFG_IDX, BLE_SERVC_READ_RSP),
  BLE_OTC_EVENT_OBJ_CHANGED_CLI_CNFG_WRITE_RSP = BLE_SERVC_ATTR_EVENT(BLE_OTC_OBJ_CHANGED_CLI_CNFG_IDX, BLE_SERVC_WRITE_RSP)
}
 Object Transfer Service client event type. More...
 

Functions

ble_status_t R_BLE_OTC_ReadFeat (uint16_t conn_hdl)
 Read OTS Feature characteristic value from the remote GATT database. More...
 
void R_BLE_OTC_GetFeatAttrHdl (const st_ble_dev_addr_t *p_addr, st_ble_otc_feat_attr_hdl_t *p_hdl)
 Get OTS Feature attribute handles. More...
 
ble_status_t R_BLE_OTC_ReadObjName (uint16_t conn_hdl, int32_t type)
 Read Object Name characteristic value from the remote GATT database. More...
 
ble_status_t R_BLE_OTC_WriteObjName (uint16_t conn_hdl, const st_ble_seq_data_t *p_value)
 Write Object Name characteristic value to remote GATT database. More...
 
void R_BLE_OTC_GetObjNameAttrHdl (const st_ble_dev_addr_t *p_addr, st_ble_otc_obj_name_attr_hdl_t *p_hdl)
 Get Object Name attribute handles. More...
 
ble_status_t R_BLE_OTC_ReadObjType (uint16_t conn_hdl)
 Read Object Type characteristic value from the remote GATT database. More...
 
void R_BLE_OTC_GetObjTypeAttrHdl (const st_ble_dev_addr_t *p_addr, st_ble_otc_obj_type_attr_hdl_t *p_hdl)
 Get Object Type attribute handles. More...
 
ble_status_t R_BLE_OTC_ReadObjSize (uint16_t conn_hdl)
 Read Object Size characteristic value from the remote GATT database. More...
 
void R_BLE_OTC_GetObjSizeAttrHdl (const st_ble_dev_addr_t *p_addr, st_ble_otc_obj_size_attr_hdl_t *p_hdl)
 Get Object Size attribute handles. More...
 
ble_status_t R_BLE_OTC_ReadObjFirstCreated (uint16_t conn_hdl)
 Read Object First-Created characteristic value from the remote GATT database. More...
 
ble_status_t R_BLE_OTC_WriteObjFirstCreated (uint16_t conn_hdl, const st_ble_date_time_t *p_value)
 Write Object First-Created characteristic value to remote GATT database. More...
 
void R_BLE_OTC_GetObjFirstCreatedAttrHdl (const st_ble_dev_addr_t *p_addr, st_ble_otc_obj_first_created_attr_hdl_t *p_hdl)
 Get Object First-Created attribute handles. More...
 
ble_status_t R_BLE_OTC_ReadObjLastModified (uint16_t conn_hdl)
 Read Object Last-Modified characteristic value from the remote GATT database. More...
 
ble_status_t R_BLE_OTC_WriteObjLastModified (uint16_t conn_hdl, const st_ble_date_time_t *p_value)
 Write Object Last-Modified characteristic value to remote GATT database. More...
 
void R_BLE_OTC_GetObjLastModifiedAttrHdl (const st_ble_dev_addr_t *p_addr, st_ble_otc_obj_last_modified_attr_hdl_t *p_hdl)
 Get Object Last-Modified attribute handles. More...
 
ble_status_t R_BLE_OTC_ReadObjId (uint16_t conn_hdl)
 Read Object ID characteristic value from the remote GATT database. More...
 
void R_BLE_OTC_GetObjIdAttrHdl (const st_ble_dev_addr_t *p_addr, st_ble_otc_obj_id_attr_hdl_t *p_hdl)
 Get Object ID attribute handles. More...
 
ble_status_t R_BLE_OTC_ReadObjProp (uint16_t conn_hdl)
 Read Object Properties characteristic value from the remote GATT database. More...
 
ble_status_t R_BLE_OTC_WriteObjProp (uint16_t conn_hdl, const st_ble_otc_obj_prop_t *p_value)
 Write Object Properties characteristic value to remote GATT database. More...
 
void R_BLE_OTC_GetObjPropAttrHdl (const st_ble_dev_addr_t *p_addr, st_ble_otc_obj_prop_attr_hdl_t *p_hdl)
 Get Object Properties attribute handles. More...
 
ble_status_t R_BLE_OTC_ReadObjActionCpCliCnfg (uint16_t conn_hdl)
 Read Object Action Control Point characteristic Client Characteristic Configuration descriptor value from the remote GATT database. More...
 
ble_status_t R_BLE_OTC_WriteObjActionCpCliCnfg (uint16_t conn_hdl, const uint16_t *p_value)
 Write Object Action Control Point characteristic Client Characteristic Configuration descriptor value to remote GATT database. More...
 
ble_status_t R_BLE_OTC_WriteObjActionCp (uint16_t conn_hdl, const st_ble_otc_obj_action_cp_t *p_value)
 Write Object Action Control Point characteristic value to remote GATT database. More...
 
void R_BLE_OTC_GetObjActionCpAttrHdl (const st_ble_dev_addr_t *p_addr, st_ble_otc_obj_action_cp_attr_hdl_t *p_hdl)
 Get Object Action Control Point attribute handles. More...
 
ble_status_t R_BLE_OTC_ReadObjListCpCliCnfg (uint16_t conn_hdl)
 Read Object List Control Point characteristic Client Characteristic Configuration descriptor value from the remote GATT database. More...
 
ble_status_t R_BLE_OTC_WriteObjListCpCliCnfg (uint16_t conn_hdl, const uint16_t *p_value)
 Write Object List Control Point characteristic Client Characteristic Configuration descriptor value to remote GATT database. More...
 
ble_status_t R_BLE_OTC_WriteObjListCp (uint16_t conn_hdl, const st_ble_otc_obj_list_cp_t *p_value)
 Write Object List Control Point characteristic value to remote GATT database. More...
 
void R_BLE_OTC_GetObjListCpAttrHdl (const st_ble_dev_addr_t *p_addr, st_ble_otc_obj_list_cp_attr_hdl_t *p_hdl)
 Get Object List Control Point attribute handles. More...
 
ble_status_t R_BLE_OTC_ReadObjListFilter0 (uint16_t conn_hdl, int32_t type)
 Read Object List Filter 0 characteristic value from the remote GATT database. More...
 
ble_status_t R_BLE_OTC_WriteObjListFilter0 (uint16_t conn_hdl, const st_ble_otc_obj_list_filter_0_t *p_value)
 Write Object List Filter 0 characteristic value to remote GATT database. More...
 
void R_BLE_OTC_GetObjListFilter0AttrHdl (const st_ble_dev_addr_t *p_addr, st_ble_otc_obj_list_filter_0_attr_hdl_t *p_hdl)
 Get Object List Filter 0 attribute handles. More...
 
ble_status_t R_BLE_OTC_ReadObjListFilter1 (uint16_t conn_hdl, int32_t type)
 Read Object List Filter 1 characteristic value from the remote GATT database. More...
 
ble_status_t R_BLE_OTC_WriteObjListFilter1 (uint16_t conn_hdl, const st_ble_otc_obj_list_filter_1_t *p_value)
 Write Object List Filter 1 characteristic value to remote GATT database. More...
 
void R_BLE_OTC_GetObjListFilter1AttrHdl (const st_ble_dev_addr_t *p_addr, st_ble_otc_obj_list_filter_1_attr_hdl_t *p_hdl)
 Get Object List Filter 1 attribute handles. More...
 
ble_status_t R_BLE_OTC_ReadObjListFilter2 (uint16_t conn_hdl, int32_t type)
 Read Object List Filter 2 characteristic value from the remote GATT database. More...
 
ble_status_t R_BLE_OTC_WriteObjListFilter2 (uint16_t conn_hdl, const st_ble_otc_obj_list_filter_2_t *p_value)
 Write Object List Filter 2 characteristic value to remote GATT database. More...
 
void R_BLE_OTC_GetObjListFilter2AttrHdl (const st_ble_dev_addr_t *p_addr, st_ble_otc_obj_list_filter_2_attr_hdl_t *p_hdl)
 Get Object List Filter 2 attribute handles. More...
 
ble_status_t R_BLE_OTC_ReadObjChangedCliCnfg (uint16_t conn_hdl)
 Read Object Changed characteristic Client Characteristic Configuration descriptor value from the remote GATT database. More...
 
ble_status_t R_BLE_OTC_WriteObjChangedCliCnfg (uint16_t conn_hdl, const uint16_t *p_value)
 Write Object Changed characteristic Client Characteristic Configuration descriptor value to remote GATT database. More...
 
void R_BLE_OTC_GetObjChangedAttrHdl (const st_ble_dev_addr_t *p_addr, st_ble_otc_obj_changed_attr_hdl_t *p_hdl)
 Get Object Changed attribute handles. More...
 
ble_status_t R_BLE_OTC_Init (ble_servc_app_cb_t cb)
 Initialize Object Transfer Service client. More...
 
void R_BLE_OTC_ServDiscCb (uint16_t conn_hdl, uint8_t serv_idx, uint16_t type, void *p_param)
 Object Transfer Service client discovery callback. More...
 
void R_BLE_OTC_GetServAttrHdl (const st_ble_dev_addr_t *p_addr, st_ble_gatt_hdl_range_t *p_hdl)
 Get Object Transfer Service client attribute handle. More...
 

Variables

uint8_t g_obj_filter0_str [BLE_OTC_OBJ_LIST_FILTER_0_LEN - 3]
 
uint8_t g_obj_filter1_str [BLE_OTC_OBJ_LIST_FILTER_1_LEN - 3]
 
uint8_t g_obj_filter2_str [BLE_OTC_OBJ_LIST_FILTER_2_LEN - 3]
 

Macro Definition Documentation

◆ BLE_OTC_PRV_OACP_CREATE_OP_CODE_SUPPORTED

#define BLE_OTC_PRV_OACP_CREATE_OP_CODE_SUPPORTED   (1 << 0)

OACP Create Op Code Supported bit.

◆ BLE_OTC_PRV_OACP_DELETE_OP_CODE_SUPPORTED

#define BLE_OTC_PRV_OACP_DELETE_OP_CODE_SUPPORTED   (1 << 1)

OACP Delete Op Code Supported bit.

◆ BLE_OTC_PRV_OACP_CALCULATE_CHECKSUM_OP_CODE_SUPPORTED

#define BLE_OTC_PRV_OACP_CALCULATE_CHECKSUM_OP_CODE_SUPPORTED   (1 << 2)

OACP Calculate Checksum Op Code Supported bit.

◆ BLE_OTC_PRV_OACP_EXECUTE_OP_CODE_SUPPORTED

#define BLE_OTC_PRV_OACP_EXECUTE_OP_CODE_SUPPORTED   (1 << 3)

OACP Execute Op Code Supported bit.

◆ BLE_OTC_PRV_OACP_READ_OP_CODE_SUPPORTED

#define BLE_OTC_PRV_OACP_READ_OP_CODE_SUPPORTED   (1 << 4)

OACP Read Op Code Supported bit.

◆ BLE_OTC_PRV_OACP_WRITE_OP_CODE_SUPPORTED

#define BLE_OTC_PRV_OACP_WRITE_OP_CODE_SUPPORTED   (1 << 5)

OACP Write Op Code Supported bit.

◆ BLE_OTC_PRV_APPENDING_ADDITIONAL_DATA_TO_OBJECTS_SUPPORTED

#define BLE_OTC_PRV_APPENDING_ADDITIONAL_DATA_TO_OBJECTS_SUPPORTED   (1 << 6)

Appending Additional Data to Objects Supported bit.

◆ BLE_OTC_PRV_TRUNCATION_OF_OBJECTS_SUPPORTED

#define BLE_OTC_PRV_TRUNCATION_OF_OBJECTS_SUPPORTED   (1 << 7)

Truncation of Objects Supported bit.

◆ BLE_OTC_PRV_PATCHING_OF_OBJECTS_SUPPORTED

#define BLE_OTC_PRV_PATCHING_OF_OBJECTS_SUPPORTED   (1 << 8)

Patching of Objects Supported bit.

◆ BLE_OTC_PRV_OACP_ABORT_OP_CODE_SUPPORTED

#define BLE_OTC_PRV_OACP_ABORT_OP_CODE_SUPPORTED   (1 << 9)

OACP Abort Op Code Supported bit.

◆ BLE_OTC_PRV_OLCP_GO_TO_OP_CODE_SUPPORTED

#define BLE_OTC_PRV_OLCP_GO_TO_OP_CODE_SUPPORTED   (1 << 0)

OLCP Go To Op Code Supported bit.

◆ BLE_OTC_PRV_OLCP_ORDER_OP_CODE_SUPPORTED

#define BLE_OTC_PRV_OLCP_ORDER_OP_CODE_SUPPORTED   (1 << 1)

OLCP Order Op Code Supported bit.

◆ BLE_OTC_PRV_OLCP_REQUEST_NUMBER_OF_OBJECTS_OP_CODE_SUPPORTED

#define BLE_OTC_PRV_OLCP_REQUEST_NUMBER_OF_OBJECTS_OP_CODE_SUPPORTED   (1 << 2)

OLCP Request Number of Objects Op Code Supported bit.

◆ BLE_OTC_PRV_OLCP_CLEAR_MARKING_OP_CODE_SUPPORTED

#define BLE_OTC_PRV_OLCP_CLEAR_MARKING_OP_CODE_SUPPORTED   (1 << 3)

OLCP Clear Marking Op Code Supported bit.

◆ BLE_OTC_PRV_DELETION_OF_THIS_OBJECT_IS_PERMITTED

#define BLE_OTC_PRV_DELETION_OF_THIS_OBJECT_IS_PERMITTED   (1 << 0)

Deletion of this object is permitted bit.

◆ BLE_OTC_PRV_EXECUTION_OF_THIS_OBJECT_IS_PERMITTED

#define BLE_OTC_PRV_EXECUTION_OF_THIS_OBJECT_IS_PERMITTED   (1 << 1)

Execution of this object is permitted bit.

◆ BLE_OTC_PRV_READING_THIS_OBJECT_IS_PERMITTED

#define BLE_OTC_PRV_READING_THIS_OBJECT_IS_PERMITTED   (1 << 2)

Reading this object is permitted bit.

◆ BLE_OTC_PRV_WRITING_DATA_TO_THIS_OBJECT_IS_PERMITTED

#define BLE_OTC_PRV_WRITING_DATA_TO_THIS_OBJECT_IS_PERMITTED   (1 << 3)

Writing data to this object is permitted bit.

◆ BLE_OTC_PRV_APPENDING_DATA_THAT_INCREASES_OBJ_ALLOCATED_SIZE_IS_PERMITTED

#define BLE_OTC_PRV_APPENDING_DATA_THAT_INCREASES_OBJ_ALLOCATED_SIZE_IS_PERMITTED   (1 << 4)

Appending data to this object is permitted bit.

◆ BLE_OTC_PRV_TRUNCATION_OF_THIS_OBJECT_IS_PERMITTED

#define BLE_OTC_PRV_TRUNCATION_OF_THIS_OBJECT_IS_PERMITTED   (1 << 5)

Truncation of this object is permitted bit.

◆ BLE_OTC_PRV_PATCHING_BY_OVERWRITING_OBJECT_EXISTING_CONTENTS_IS_PERMITTED

#define BLE_OTC_PRV_PATCHING_BY_OVERWRITING_OBJECT_EXISTING_CONTENTS_IS_PERMITTED   (1 << 6)

Patching this object by overwriting is permitted bit.

◆ BLE_OTC_PRV_THIS_OBJECT_IS_A_MARKED_OBJECT

#define BLE_OTC_PRV_THIS_OBJECT_IS_A_MARKED_OBJECT   (1 << 7)

This object is a marked object bit.

◆ BLE_OTC_PRV_SOURCE_OF_CHANGE

#define BLE_OTC_PRV_SOURCE_OF_CHANGE   (1 << 0)

Source of change bit.

◆ BLE_OTC_PRV_CHANGE_OCCURRED_TO_THE_OBJECT_CONTENTS

#define BLE_OTC_PRV_CHANGE_OCCURRED_TO_THE_OBJECT_CONTENTS   (1 << 1)

Change occured to the object contents bit.

◆ BLE_OTC_PRV_CHANGE_OCCURRED_TO_THE_OBJECT_METADATA

#define BLE_OTC_PRV_CHANGE_OCCURRED_TO_THE_OBJECT_METADATA   (1 << 2)

Change occured to the object metadata bit.

◆ BLE_OTC_PRV_OBJECT_CREATION

#define BLE_OTC_PRV_OBJECT_CREATION   (1 << 3)

Object creation bit.

◆ BLE_OTC_PRV_OBJECT_DELETION

#define BLE_OTC_PRV_OBJECT_DELETION   (1 << 4)

Object deletion bit.

◆ BLE_OTC_OBJ_LIST_CP_PARAMETER_LEN

#define BLE_OTC_OBJ_LIST_CP_PARAMETER_LEN   (6)

Parameter Length

◆ BLE_OTC_OBJ_NAME_OBJECT_NAME_LEN

#define BLE_OTC_OBJ_NAME_OBJECT_NAME_LEN   (100)

Object Name Length

◆ BLE_OTC_WRITE_REQUEST_REJECTED_ERROR

#define BLE_OTC_WRITE_REQUEST_REJECTED_ERROR   (BLE_ERR_GROUP_GATT | 0x80)

An attempt was made to write a value that is invalid or not supported by this Server for a reason other than the attribute permissions.

◆ BLE_OTC_OBJECT_NOT_SELECTED_ERROR

#define BLE_OTC_OBJECT_NOT_SELECTED_ERROR   (BLE_ERR_GROUP_GATT | 0x81)

An attempt was made to read or write to an Object Metadata characteristic while the Current Object was an Invalid Object (see Section 1.8 in the PDF sepcification).

◆ BLE_OTC_CONCURRENCY_LIMIT_EXCEEDED_ERROR

#define BLE_OTC_CONCURRENCY_LIMIT_EXCEEDED_ERROR   (BLE_ERR_GROUP_GATT | 0x82)

The Server is unable to service the Read Request or Write Request because it exceeds the concurrency limit of the service.

◆ BLE_OTC_OBJECT_NAME_ALREADY_EXISTS_ERROR

#define BLE_OTC_OBJECT_NAME_ALREADY_EXISTS_ERROR   (BLE_ERR_GROUP_GATT | 0x83)

The requested object name was rejected because the name was already in use by an existing object on the Server.

Enumeration Type Documentation

◆ e_ble_otc_obj_id_object_id_t

Object ID Object ID enumeration.

Enumerator
BLE_OTC_OBJ_ID_OBJECT_ID_RESERVED_FOR_THE_DIRECTORY_LISTING_OBJECT 

Reserved for the Directory Listing Object

◆ e_ble_otc_obj_action_cp_op_code_t

Object Action Control Point Op Code enumeration.

Enumerator
BLE_OTC_OBJ_ACTION_CP_OP_CODE_CREATE 

Create a new, empty object

BLE_OTC_OBJ_ACTION_CP_OP_CODE_DELETE 

Delete the Current Object

BLE_OTC_OBJ_ACTION_CP_OP_CODE_CALCULATE_CHECKSUM 

Compare a checksum

BLE_OTC_OBJ_ACTION_CP_OP_CODE_EXECUTE 

Use the Current Object to perform an operation

BLE_OTC_OBJ_ACTION_CP_OP_CODE_READ 

Send object data through Object Transfer Channel

BLE_OTC_OBJ_ACTION_CP_OP_CODE_WRITE 

Open the Current Object for writing and prepare to accept data

BLE_OTC_OBJ_ACTION_CP_OP_CODE_ABORT 

Cease sending previously requested data through Object Transfer Channel

BLE_OTC_OBJ_ACTION_CP_OP_CODE_RESPONSE_CODE 

Used to identify the response to this Control Point

◆ e_ble_otc_obj_action_cp_result_code_t

Object Action Control Point Result Code enumeration.

Enumerator
BLE_OTC_OBJ_ACTION_CP_RESULT_CODE_SUCCESS 

Response for successful operation

BLE_OTC_OBJ_ACTION_CP_RESULT_CODE_OP_CODE_NOT_SUPPORTED 

Response if unsupported Op Code is received

BLE_OTC_OBJ_ACTION_CP_RESULT_CODE_INVALID_PARAMETER 

Parameter received does not meet the requirements

BLE_OTC_OBJ_ACTION_CP_RESULT_CODE_INSUFFICIENT_RESOURCES 

Size parameter exceeds the available memory

BLE_OTC_OBJ_ACTION_CP_RESULT_CODE_INVALID_OBJECT 

Current Object is an Invalid Object

BLE_OTC_OBJ_ACTION_CP_RESULT_CODE_CHANNEL_UNAVAILABLE 

Object Transfer Channel was not available for use

BLE_OTC_OBJ_ACTION_CP_RESULT_CODE_UNSUPPORTED_TYPE 

OACP procedure Type parameter is not supported by the Server

BLE_OTC_OBJ_ACTION_CP_RESULT_CODE_PROCEDURE_NOT_PERMITTED 

Requested procedure is not permitted

BLE_OTC_OBJ_ACTION_CP_RESULT_CODE_OBJECT_LOCKED 

Current Object is temporarily locked

BLE_OTC_OBJ_ACTION_CP_RESULT_CODE_OPERATION_FAILED 

Operation Failed

◆ e_ble_otc_obj_list_cp_op_code_t

Object List Control Point Op Code enumeration.

Enumerator
BLE_OTC_OBJ_LIST_CP_OP_CODE_FIRST 

Make the first object in the list become the Current Object

BLE_OTC_OBJ_LIST_CP_OP_CODE_LAST 

Make the last object in the list become the Current Object

BLE_OTC_OBJ_LIST_CP_OP_CODE_PREVIOUS 

Make the object immediately preceding the Current Object in the list become the Current Object

BLE_OTC_OBJ_LIST_CP_OP_CODE_NEXT 

Make the object immediately after the Current Object in the list become the Current Object

BLE_OTC_OBJ_LIST_CP_OP_CODE_GO_TO 

Select an object by specifying its Object ID

BLE_OTC_OBJ_LIST_CP_OP_CODE_ORDER 

Arrange the list of objects in order

BLE_OTC_OBJ_LIST_CP_OP_CODE_REQUEST_NUMBER_OF_OBJECTS 

Report the total number of objects

BLE_OTC_OBJ_LIST_CP_OP_CODE_CLEAR_MARKING 

Update the marking of objects

BLE_OTC_OBJ_LIST_CP_OP_CODE_RESPONSE_CODE 

Used to identify the response to this Control Point

◆ e_ble_otc_obj_list_cp_result_code_t

Object List Control Point Result Code enumeration.

Enumerator
BLE_OTC_OBJ_LIST_CP_RESULT_CODE_SUCCESS 

Response for successful operation

BLE_OTC_OBJ_LIST_CP_RESULT_CODE_OP_CODE_NOT_SUPPORTED 

Response if unsupported Op Code is received

BLE_OTC_OBJ_LIST_CP_RESULT_CODE_INVALID_PARAMETER 

Parameter received does not meet the requirements

BLE_OTC_OBJ_LIST_CP_RESULT_CODE_OPERATION_FAILED 

Requested procedure failed

BLE_OTC_OBJ_LIST_CP_RESULT_CODE_OUT_OF_BOUNDS 

Selected object is beyond the first or last object in the current list

BLE_OTC_OBJ_LIST_CP_RESULT_CODE_TOO_MANY_OBJECTS 

Procedure failed due to too many objects

BLE_OTC_OBJ_LIST_CP_RESULT_CODE_NO_OBJECT 

Procedure failed due to there being zero objects in the current list

BLE_OTC_OBJ_LIST_CP_RESULT_CODE_OBJECT_ID_NOT_FOUND 

Procedure failed due to there being no object with the requested Object ID

◆ e_ble_otc_obj_list_cp_list_sort_order_t

Object List Control Point List Sort Order enumeration.

Enumerator
BLE_OTC_OBJ_LIST_CP_LIST_SORT_ORDER_ORDER_THE_LIST_BY_OBJECT_NAME__ASCENDING 

Order the list by object name, ascending

BLE_OTC_OBJ_LIST_CP_LIST_SORT_ORDER_ORDER_THE_LIST_BY_OBJECT_TYPE__ASCENDING 

Order the list by object name, ascending

BLE_OTC_OBJ_LIST_CP_LIST_SORT_ORDER_ORDER_THE_LIST_BY_OBJECT_CURRENT_SIZE__ASCENDING 

Order the list by object current size, ascending

BLE_OTC_OBJ_LIST_CP_LIST_SORT_ORDER_ORDER_THE_LIST_BY_OBJECT_FIRST_CREATED_TIMESTAMP__ASCENDING 

Order the list by object first-created timestamp, ascending

BLE_OTC_OBJ_LIST_CP_LIST_SORT_ORDER_ORDER_THE_LIST_BY_OBJECT_LAST_MODIFIED_TIMESTAMP__ASCENDING 

Order the list by object last-modified timestamp, ascending

BLE_OTC_OBJ_LIST_CP_LIST_SORT_ORDER_ORDER_THE_LIST_BY_OBJECT_NAME__DESCENDING 

Order the list by object name, descending

BLE_OTC_OBJ_LIST_CP_LIST_SORT_ORDER_ORDER_THE_LIST_BY_OBJECT_TYPE__DESCENDING 

Order the list by object type, descending

BLE_OTC_OBJ_LIST_CP_LIST_SORT_ORDER_ORDER_THE_LIST_BY_OBJECT_CURRENT_SIZE__DESCENDING 

Order the list by object current size, descending

BLE_OTC_OBJ_LIST_CP_LIST_SORT_ORDER_ORDER_THE_LIST_BY_OBJECT_FIRST_CREATED_TIMESTAMP__DESCENDING 

Order the list by object first-created timestamp, descending

BLE_OTC_OBJ_LIST_CP_LIST_SORT_ORDER_ORDER_THE_LIST_BY_OBJECT_LAST_MODIFIED_TIMESTAMP__DESCENDING 

Order the list by object last-modified timestamp, descending

◆ e_ble_otc_obj_list_filter_0_filter_t

Object List Filter 0 Filter enumeration.

Enumerator
BLE_OTC_OBJ_LIST_FILTER_0_FILTER_NO_FILTER 

No Filter

BLE_OTC_OBJ_LIST_FILTER_0_FILTER_NAME_STARTS_WITH 

Name Starts With

BLE_OTC_OBJ_LIST_FILTER_0_FILTER_NAME_ENDS_WITH 

Name Ends With

BLE_OTC_OBJ_LIST_FILTER_0_FILTER_NAME_CONTAINS 

Name Contains

BLE_OTC_OBJ_LIST_FILTER_0_FILTER_NAME_IS_EXACTLY 

Name is Exactly

BLE_OTC_OBJ_LIST_FILTER_0_FILTER_OBJECT_TYPE 

Object Type

BLE_OTC_OBJ_LIST_FILTER_0_FILTER_CREATED_BETWEEN 

Created between

BLE_OTC_OBJ_LIST_FILTER_0_FILTER_MODIFIED_BETWEEN 

Modified between

BLE_OTC_OBJ_LIST_FILTER_0_FILTER_CURRENT_SIZE_BETWEEN 

Current Size between

BLE_OTC_OBJ_LIST_FILTER_0_FILTER_ALLOCATED_SIZE_BETWEEN 

Allocated Size between

BLE_OTC_OBJ_LIST_FILTER_0_FILTER_MARKED_OBJECTS 

Marked Objects

◆ e_ble_otc_obj_list_filter_1_filter_t

Object List Filter 1 Filter enumeration.

Enumerator
BLE_OTC_OBJ_LIST_FILTER_1_FILTER_NO_FILTER 

No Filter

BLE_OTC_OBJ_LIST_FILTER_1_FILTER_NAME_STARTS_WITH 

Name Starts With

BLE_OTC_OBJ_LIST_FILTER_1_FILTER_NAME_ENDS_WITH 

Name Ends With

BLE_OTC_OBJ_LIST_FILTER_1_FILTER_NAME_CONTAINS 

Name Contains

BLE_OTC_OBJ_LIST_FILTER_1_FILTER_NAME_IS_EXACTLY 

Name is Exactly

BLE_OTC_OBJ_LIST_FILTER_1_FILTER_OBJECT_TYPE 

Name is Exactly

BLE_OTC_OBJ_LIST_FILTER_1_FILTER_CREATED_BETWEEN 

Created between

BLE_OTC_OBJ_LIST_FILTER_1_FILTER_MODIFIED_BETWEEN 

Modified between

BLE_OTC_OBJ_LIST_FILTER_1_FILTER_CURRENT_SIZE_BETWEEN 

Current Size between

BLE_OTC_OBJ_LIST_FILTER_1_FILTER_ALLOCATED_SIZE_BETWEEN 

Allocated Size between

BLE_OTC_OBJ_LIST_FILTER_1_FILTER_MARKED_OBJECTS 

Marked Objects

◆ e_ble_otc_obj_list_filter_2_filter_t

Object List Filter 2 Filter enumeration.

Enumerator
BLE_OTC_OBJ_LIST_FILTER_2_FILTER_NO_FILTER 

No Filter

BLE_OTC_OBJ_LIST_FILTER_2_FILTER_NAME_STARTS_WITH 

Name Starts With

BLE_OTC_OBJ_LIST_FILTER_2_FILTER_NAME_ENDS_WITH 

Name Ends With

BLE_OTC_OBJ_LIST_FILTER_2_FILTER_NAME_CONTAINS 

Name Contains

BLE_OTC_OBJ_LIST_FILTER_2_FILTER_NAME_IS_EXACTLY 

Name is Exactly

BLE_OTC_OBJ_LIST_FILTER_2_FILTER_OBJECT_TYPE 

Name is Exactly

BLE_OTC_OBJ_LIST_FILTER_2_FILTER_CREATED_BETWEEN 

Created between

BLE_OTC_OBJ_LIST_FILTER_2_FILTER_MODIFIED_BETWEEN 

Modified between

BLE_OTC_OBJ_LIST_FILTER_2_FILTER_CURRENT_SIZE_BETWEEN 

Current Size between

BLE_OTC_OBJ_LIST_FILTER_2_FILTER_ALLOCATED_SIZE_BETWEEN 

Allocated Size between

BLE_OTC_OBJ_LIST_FILTER_2_FILTER_MARKED_OBJECTS 

Marked Objects

◆ e_ble_otc_char_idx_t

Object Transfer Service characteristic ID.

◆ e_ble_otc_event_t

Object Transfer Service client event type.

Function Documentation

◆ R_BLE_OTC_ReadFeat()

ble_status_t R_BLE_OTC_ReadFeat ( uint16_t  conn_hdl)

Read OTS Feature characteristic value from the remote GATT database.

Parameters
[in]conn_hdlConnection handle.
Returns
ble_status_t

◆ R_BLE_OTC_GetFeatAttrHdl()

void R_BLE_OTC_GetFeatAttrHdl ( const st_ble_dev_addr_t p_addr,
st_ble_otc_feat_attr_hdl_t p_hdl 
)

Get OTS Feature attribute handles.

Parameters
[in]p_addrBluetooth device address for the attribute handles.
[out]p_hdlThe pointer to store the retrieved attribute handles.
Returns
ble_status_t

◆ R_BLE_OTC_ReadObjName()

ble_status_t R_BLE_OTC_ReadObjName ( uint16_t  conn_hdl,
int32_t  type 
)

Read Object Name characteristic value from the remote GATT database.

Parameters
[in]conn_hdlConnection handle.
Returns
ble_status_t

◆ R_BLE_OTC_WriteObjName()

ble_status_t R_BLE_OTC_WriteObjName ( uint16_t  conn_hdl,
const st_ble_seq_data_t p_value 
)

Write Object Name characteristic value to remote GATT database.

Parameters
[in]conn_hdlConnection handle.
[in]p_valueObject Name characteristic value to write.
Returns
ble_status_t

◆ R_BLE_OTC_GetObjNameAttrHdl()

void R_BLE_OTC_GetObjNameAttrHdl ( const st_ble_dev_addr_t p_addr,
st_ble_otc_obj_name_attr_hdl_t p_hdl 
)

Get Object Name attribute handles.

Parameters
[in]p_addrBluetooth device address for the attribute handles.
[out]p_hdlThe pointer to store the retrieved attribute handles.
Returns
ble_status_t

◆ R_BLE_OTC_ReadObjType()

ble_status_t R_BLE_OTC_ReadObjType ( uint16_t  conn_hdl)

Read Object Type characteristic value from the remote GATT database.

Parameters
[in]conn_hdlConnection handle.
Returns
ble_status_t

◆ R_BLE_OTC_GetObjTypeAttrHdl()

void R_BLE_OTC_GetObjTypeAttrHdl ( const st_ble_dev_addr_t p_addr,
st_ble_otc_obj_type_attr_hdl_t p_hdl 
)

Get Object Type attribute handles.

Parameters
[in]p_addrBluetooth device address for the attribute handles.
[out]p_hdlThe pointer to store the retrieved attribute handles.
Returns
ble_status_t

◆ R_BLE_OTC_ReadObjSize()

ble_status_t R_BLE_OTC_ReadObjSize ( uint16_t  conn_hdl)

Read Object Size characteristic value from the remote GATT database.

Parameters
[in]conn_hdlConnection handle.
Returns
ble_status_t

◆ R_BLE_OTC_GetObjSizeAttrHdl()

void R_BLE_OTC_GetObjSizeAttrHdl ( const st_ble_dev_addr_t p_addr,
st_ble_otc_obj_size_attr_hdl_t p_hdl 
)

Get Object Size attribute handles.

Parameters
[in]p_addrBluetooth device address for the attribute handles.
[out]p_hdlThe pointer to store the retrieved attribute handles.
Returns
ble_status_t

◆ R_BLE_OTC_ReadObjFirstCreated()

ble_status_t R_BLE_OTC_ReadObjFirstCreated ( uint16_t  conn_hdl)

Read Object First-Created characteristic value from the remote GATT database.

Parameters
[in]conn_hdlConnection handle.
Returns
ble_status_t

◆ R_BLE_OTC_WriteObjFirstCreated()

ble_status_t R_BLE_OTC_WriteObjFirstCreated ( uint16_t  conn_hdl,
const st_ble_date_time_t p_value 
)

Write Object First-Created characteristic value to remote GATT database.

Parameters
[in]conn_hdlConnection handle.
[in]p_valueObject First-Created characteristic value to write.
Returns
ble_status_t

◆ R_BLE_OTC_GetObjFirstCreatedAttrHdl()

void R_BLE_OTC_GetObjFirstCreatedAttrHdl ( const st_ble_dev_addr_t p_addr,
st_ble_otc_obj_first_created_attr_hdl_t p_hdl 
)

Get Object First-Created attribute handles.

Parameters
[in]p_addrBluetooth device address for the attribute handles.
[out]p_hdlThe pointer to store the retrieved attribute handles.
Returns
ble_status_t

◆ R_BLE_OTC_ReadObjLastModified()

ble_status_t R_BLE_OTC_ReadObjLastModified ( uint16_t  conn_hdl)

Read Object Last-Modified characteristic value from the remote GATT database.

Parameters
[in]conn_hdlConnection handle.
Returns
ble_status_t

◆ R_BLE_OTC_WriteObjLastModified()

ble_status_t R_BLE_OTC_WriteObjLastModified ( uint16_t  conn_hdl,
const st_ble_date_time_t p_value 
)

Write Object Last-Modified characteristic value to remote GATT database.

Parameters
[in]conn_hdlConnection handle.
[in]p_valueObject Last-Modified characteristic value to write.
Returns
ble_status_t

◆ R_BLE_OTC_GetObjLastModifiedAttrHdl()

void R_BLE_OTC_GetObjLastModifiedAttrHdl ( const st_ble_dev_addr_t p_addr,
st_ble_otc_obj_last_modified_attr_hdl_t p_hdl 
)

Get Object Last-Modified attribute handles.

Parameters
[in]p_addrBluetooth device address for the attribute handles.
[out]p_hdlThe pointer to store the retrieved attribute handles.
Returns
ble_status_t

◆ R_BLE_OTC_ReadObjId()

ble_status_t R_BLE_OTC_ReadObjId ( uint16_t  conn_hdl)

Read Object ID characteristic value from the remote GATT database.

Parameters
[in]conn_hdlConnection handle.
Returns
ble_status_t

◆ R_BLE_OTC_GetObjIdAttrHdl()

void R_BLE_OTC_GetObjIdAttrHdl ( const st_ble_dev_addr_t p_addr,
st_ble_otc_obj_id_attr_hdl_t p_hdl 
)

Get Object ID attribute handles.

Parameters
[in]p_addrBluetooth device address for the attribute handles.
[out]p_hdlThe pointer to store the retrieved attribute handles.
Returns
ble_status_t

◆ R_BLE_OTC_ReadObjProp()

ble_status_t R_BLE_OTC_ReadObjProp ( uint16_t  conn_hdl)

Read Object Properties characteristic value from the remote GATT database.

Parameters
[in]conn_hdlConnection handle.
Returns
ble_status_t

◆ R_BLE_OTC_WriteObjProp()

ble_status_t R_BLE_OTC_WriteObjProp ( uint16_t  conn_hdl,
const st_ble_otc_obj_prop_t p_value 
)

Write Object Properties characteristic value to remote GATT database.

Parameters
[in]conn_hdlConnection handle.
[in]p_valueObject Properties characteristic value to write.
Returns
ble_status_t

◆ R_BLE_OTC_GetObjPropAttrHdl()

void R_BLE_OTC_GetObjPropAttrHdl ( const st_ble_dev_addr_t p_addr,
st_ble_otc_obj_prop_attr_hdl_t p_hdl 
)

Get Object Properties attribute handles.

Parameters
[in]p_addrBluetooth device address for the attribute handles.
[out]p_hdlThe pointer to store the retrieved attribute handles.
Returns
ble_status_t

◆ R_BLE_OTC_ReadObjActionCpCliCnfg()

ble_status_t R_BLE_OTC_ReadObjActionCpCliCnfg ( uint16_t  conn_hdl)

Read Object Action Control Point characteristic Client Characteristic Configuration descriptor value from the remote GATT database.

Parameters
[in]conn_hdlConnection handle.
Returns
ble_status_t

◆ R_BLE_OTC_WriteObjActionCpCliCnfg()

ble_status_t R_BLE_OTC_WriteObjActionCpCliCnfg ( uint16_t  conn_hdl,
const uint16_t *  p_value 
)

Write Object Action Control Point characteristic Client Characteristic Configuration descriptor value to remote GATT database.

Parameters
[in]conn_hdlConnection handle.
[in]p_valueObject Action Control Point characteristic Client Characteristic Configuration descriptor value to write.
Returns
ble_status_t

◆ R_BLE_OTC_WriteObjActionCp()

ble_status_t R_BLE_OTC_WriteObjActionCp ( uint16_t  conn_hdl,
const st_ble_otc_obj_action_cp_t p_value 
)

Write Object Action Control Point characteristic value to remote GATT database.

Parameters
[in]conn_hdlConnection handle.
[in]p_valueObject Action Control Point characteristic value to write.
Returns
ble_status_t

◆ R_BLE_OTC_GetObjActionCpAttrHdl()

void R_BLE_OTC_GetObjActionCpAttrHdl ( const st_ble_dev_addr_t p_addr,
st_ble_otc_obj_action_cp_attr_hdl_t p_hdl 
)

Get Object Action Control Point attribute handles.

Parameters
[in]p_addrBluetooth device address for the attribute handles.
[out]p_hdlThe pointer to store the retrieved attribute handles.
Returns
ble_status_t

◆ R_BLE_OTC_ReadObjListCpCliCnfg()

ble_status_t R_BLE_OTC_ReadObjListCpCliCnfg ( uint16_t  conn_hdl)

Read Object List Control Point characteristic Client Characteristic Configuration descriptor value from the remote GATT database.

Parameters
[in]conn_hdlConnection handle.
Returns
ble_status_t

◆ R_BLE_OTC_WriteObjListCpCliCnfg()

ble_status_t R_BLE_OTC_WriteObjListCpCliCnfg ( uint16_t  conn_hdl,
const uint16_t *  p_value 
)

Write Object List Control Point characteristic Client Characteristic Configuration descriptor value to remote GATT database.

Parameters
[in]conn_hdlConnection handle.
[in]p_valueObject List Control Point characteristic Client Characteristic Configuration descriptor value to write.
Returns
ble_status_t

◆ R_BLE_OTC_WriteObjListCp()

ble_status_t R_BLE_OTC_WriteObjListCp ( uint16_t  conn_hdl,
const st_ble_otc_obj_list_cp_t p_value 
)

Write Object List Control Point characteristic value to remote GATT database.

Parameters
[in]conn_hdlConnection handle.
[in]p_valueObject List Control Point characteristic value to write.
Returns
ble_status_t

◆ R_BLE_OTC_GetObjListCpAttrHdl()

void R_BLE_OTC_GetObjListCpAttrHdl ( const st_ble_dev_addr_t p_addr,
st_ble_otc_obj_list_cp_attr_hdl_t p_hdl 
)

Get Object List Control Point attribute handles.

Parameters
[in]p_addrBluetooth device address for the attribute handles.
[out]p_hdlThe pointer to store the retrieved attribute handles.
Returns
ble_status_t

◆ R_BLE_OTC_ReadObjListFilter0()

ble_status_t R_BLE_OTC_ReadObjListFilter0 ( uint16_t  conn_hdl,
int32_t  type 
)

Read Object List Filter 0 characteristic value from the remote GATT database.

Parameters
[in]conn_hdlConnection handle.
Returns
ble_status_t

◆ R_BLE_OTC_WriteObjListFilter0()

ble_status_t R_BLE_OTC_WriteObjListFilter0 ( uint16_t  conn_hdl,
const st_ble_otc_obj_list_filter_0_t p_value 
)

Write Object List Filter 0 characteristic value to remote GATT database.

Parameters
[in]conn_hdlConnection handle.
[in]p_valueObject List Filter 0 characteristic value to write.
Returns
ble_status_t

◆ R_BLE_OTC_GetObjListFilter0AttrHdl()

void R_BLE_OTC_GetObjListFilter0AttrHdl ( const st_ble_dev_addr_t p_addr,
st_ble_otc_obj_list_filter_0_attr_hdl_t p_hdl 
)

Get Object List Filter 0 attribute handles.

Parameters
[in]p_addrBluetooth device address for the attribute handles.
[out]p_hdlThe pointer to store the retrieved attribute handles.
Returns
ble_status_t

◆ R_BLE_OTC_ReadObjListFilter1()

ble_status_t R_BLE_OTC_ReadObjListFilter1 ( uint16_t  conn_hdl,
int32_t  type 
)

Read Object List Filter 1 characteristic value from the remote GATT database.

Parameters
[in]conn_hdlConnection handle.
Returns
ble_status_t

◆ R_BLE_OTC_WriteObjListFilter1()

ble_status_t R_BLE_OTC_WriteObjListFilter1 ( uint16_t  conn_hdl,
const st_ble_otc_obj_list_filter_1_t p_value 
)

Write Object List Filter 1 characteristic value to remote GATT database.

Parameters
[in]conn_hdlConnection handle.
[in]p_valueObject List Filter 1 characteristic value to write.
Returns
ble_status_t

◆ R_BLE_OTC_GetObjListFilter1AttrHdl()

void R_BLE_OTC_GetObjListFilter1AttrHdl ( const st_ble_dev_addr_t p_addr,
st_ble_otc_obj_list_filter_1_attr_hdl_t p_hdl 
)

Get Object List Filter 1 attribute handles.

Parameters
[in]p_addrBluetooth device address for the attribute handles.
[out]p_hdlThe pointer to store the retrieved attribute handles.
Returns
ble_status_t

◆ R_BLE_OTC_ReadObjListFilter2()

ble_status_t R_BLE_OTC_ReadObjListFilter2 ( uint16_t  conn_hdl,
int32_t  type 
)

Read Object List Filter 2 characteristic value from the remote GATT database.

Parameters
[in]conn_hdlConnection handle.
Returns
ble_status_t

◆ R_BLE_OTC_WriteObjListFilter2()

ble_status_t R_BLE_OTC_WriteObjListFilter2 ( uint16_t  conn_hdl,
const st_ble_otc_obj_list_filter_2_t p_value 
)

Write Object List Filter 2 characteristic value to remote GATT database.

Parameters
[in]conn_hdlConnection handle.
[in]p_valueObject List Filter 2 characteristic value to write.
Returns
ble_status_t

◆ R_BLE_OTC_GetObjListFilter2AttrHdl()

void R_BLE_OTC_GetObjListFilter2AttrHdl ( const st_ble_dev_addr_t p_addr,
st_ble_otc_obj_list_filter_2_attr_hdl_t p_hdl 
)

Get Object List Filter 2 attribute handles.

Parameters
[in]p_addrBluetooth device address for the attribute handles.
[out]p_hdlThe pointer to store the retrieved attribute handles.
Returns
ble_status_t

◆ R_BLE_OTC_ReadObjChangedCliCnfg()

ble_status_t R_BLE_OTC_ReadObjChangedCliCnfg ( uint16_t  conn_hdl)

Read Object Changed characteristic Client Characteristic Configuration descriptor value from the remote GATT database.

Parameters
[in]conn_hdlConnection handle.
Returns
ble_status_t

◆ R_BLE_OTC_WriteObjChangedCliCnfg()

ble_status_t R_BLE_OTC_WriteObjChangedCliCnfg ( uint16_t  conn_hdl,
const uint16_t *  p_value 
)

Write Object Changed characteristic Client Characteristic Configuration descriptor value to remote GATT database.

Parameters
[in]conn_hdlConnection handle.
[in]p_valueObject Changed characteristic Client Characteristic Configuration descriptor value to write.
Returns
ble_status_t

◆ R_BLE_OTC_GetObjChangedAttrHdl()

void R_BLE_OTC_GetObjChangedAttrHdl ( const st_ble_dev_addr_t p_addr,
st_ble_otc_obj_changed_attr_hdl_t p_hdl 
)

Get Object Changed attribute handles.

Parameters
[in]p_addrBluetooth device address for the attribute handles.
[out]p_hdlThe pointer to store the retrieved attribute handles.
Returns
ble_status_t

◆ R_BLE_OTC_Init()

ble_status_t R_BLE_OTC_Init ( ble_servc_app_cb_t  cb)

Initialize Object Transfer Service client.

Parameters
[in]cbClient callback.
Returns
ble_status_t

◆ R_BLE_OTC_ServDiscCb()

void R_BLE_OTC_ServDiscCb ( uint16_t  conn_hdl,
uint8_t  serv_idx,
uint16_t  type,
void *  p_param 
)

Object Transfer Service client discovery callback.

Parameters
[in]conn_hdlConnection handle
[in]serv_idxService instance index.
[in]typeService discovery event type.
[in]p_paramService discovery event parameter.
Returns
ble_status_t

◆ R_BLE_OTC_GetServAttrHdl()

void R_BLE_OTC_GetServAttrHdl ( const st_ble_dev_addr_t p_addr,
st_ble_gatt_hdl_range_t p_hdl 
)

Get Object Transfer Service client attribute handle.

Parameters
[in]p_addrBluetooth device address for the attribute handles.
[out]p_hdlThe pointer to store the retrieved attribute handles.