ths_c.h File Reference

Throughput Client API. More...

#include "ble_prf_types.h"
#include "gr_includes.h"
#include "custom_config.h"
#include <stdint.h>
#include <stdbool.h>

Go to the source code of this file.

Classes

struct  ths_c_handles_t
 Handles on the connected peer device needed to interact with it. More...
 
struct  ths_c_evt_t
 Throughput Service Client event. More...
 

Macros

#define THS_C_CONNECTION_MAX   10
 
#define THS_SVC_UUID
 
#define THS_TX_CHAR_UUID
 
#define THS_RX_CHAR_UUID
 
#define THS_SETTING_CHAR_UUID
 
#define THS_TOGGLE_CHAR_UUID
 

Typedefs

typedef void(* ths_c_evt_handler_t) (ths_c_evt_t *p_evt)
 Throughput Service Client event handler type. More...
 

Enumerations

enum  ths_c_transport_mode_t {
  THS_C_SLAVE_NOTIFY_MODE,
  THS_C_MASTER_WRITE_MODE,
  THS_C_DOUBLE_MODE
}
 Throughput Service Client data transport mode. More...
 
enum  ths_c_settings_type_t {
  THS_C_SETTINGS_TYPE_CI,
  THS_C_SETTINGS_TYPE_MTU,
  THS_C_SETTINGS_TYPE_PDU,
  THS_C_SETTINGS_TYPE_PHY,
  THS_C_SETTINGS_TYPE_TRANS_MODE,
  THS_C_SETTINGS_TYPE_TX_POWER
}
 Throughput service settings types. More...
 
enum  ths_c_evt_type_t {
  THS_C_EVT_INVALID,
  THS_C_EVT_DISCOVERY_COMPLETE,
  THS_C_EVT_DISCOVERY_FAIL,
  THS_C_EVT_TX_NTF_SET_SUCCESS,
  THS_C_EVT_SETTING_NTF_SET_SUCCESS,
  THS_C_EVT_TOGGLE_SET_SUCCESS,
  THS_C_EVT_SETTING_RSP_RECEIVE,
  THS_C_EVT_THRP_DATA_RECEIVE,
  THS_C_EVT_TX_SUCCESS,
  THS_C_EVT_PARAM_SET_SUCCESS,
  THS_C_EVT_WRITE_OP_ERR
}
 Throughput Service Client event type. More...
 

Functions

sdk_err_t ths_client_init (ths_c_evt_handler_t evt_handler)
 Register THS Client event handler. More...
 
sdk_err_t ths_c_disc_srvc_start (uint8_t conn_idx)
 Discovery THS on peer. More...
 
sdk_err_t ths_c_tx_notify_set (uint8_t conn_idx, bool is_enable)
 Enable or disable peer THS Tx characteristic notify. More...
 
sdk_err_t ths_c_setting_notify_set (uint8_t conn_idx, bool is_enable)
 Enable or disable peer THS setting characteristic notify. More...
 
sdk_err_t ths_c_comm_param_send (uint8_t conn_idx, uint8_t *p_data, uint16_t length)
 Send communication parameter to peer. More...
 
sdk_err_t ths_c_toggle_set (uint8_t conn_idx, bool is_enable)
 Set Throughput service toggle state of sending the data. More...
 
sdk_err_t ths_c_tx_data_send (uint8_t conn_idx, uint8_t *p_data, uint16_t length)
 Send data to peer. More...
 

Detailed Description

Throughput Client API.

Attention
#####Copyright (c) 2019 GOODIX All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. Neither the name of GOODIX nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL COPYRIGHT HOLDERS AND CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Definition in file ths_c.h.