Enumerations
Enumerations
BLE Services » Throughput Control Point Client (THSCPS)

## Enumerations
enum | thscps_test_role_t { THSCPS_TEST_ROLE_INVALID, THSCPS_TEST_ROLE_SLAVE, THSCPS_TEST_ROLE_MASTER }
| Local device GAP Role Type. More...
enum | thscps_adv_phy_t { THSCPS_LEGACY_ADV_PHY, THSCPS_1MBPS_PHY, THSCPS_CODED_PHY }
| Specify PHY. More...
enum | thscps_test_state_t { THSCPS_TEST_STOP, THSCPS_TEST_STARTED }
| Throughput Test State. More...
enum | thscps_ctrl_pt_id_t { THSCPS_CTRL_PT_INVALID, THSCPS_CTRL_PT_TEST_ROLE, THSCPS_CTRL_PT_ADV_PARAM, THSCPS_CTRL_PT_ADV_ACTION, THSCPS_CTRL_PT_SCAN_ACTION, THSCPS_CTRL_PT_TEST_READY, THSCPS_CTRL_PT_SETTING }
| THS Control Point Service Control Point IDs. More...
enum | thscps_settings_type_t { THSCPS_SETTINGS_TYPE_CI, THSCPS_SETTINGS_TYPE_MTU, THSCPS_SETTINGS_TYPE_PDU, THSCPS_SETTINGS_TYPE_PHY, THSCPS_SETTINGS_TYPE_TRANS_MODE, THSCPS_SETTINGS_TYPE_TX_POWER, THSCPS_SETTINGS_TYPE_TOGGLE }
| Throughput service settings types. More...
enum | thscps_status_rsp_t { THSCPS_RSP_ID_SUCCESS, THSCPS_RSP_ID_UNSUPPORT, THSCPS_RSP_ID_STATUS_ERR, THSCPS_RSP_ID_PARAM_ERR, THSCPS_RSP_ID_TEST_ROLE_ERR, THSCPS_RSP_ID_SDK_ERR }
| THS Control Point Response Types. More...
enum | thscps_evt_type_t { THSCPS_EVT_INVALID, THSCPS_EVT_CTRL_PT_IND_ENABLE, THSCPS_EVT_CTRL_PT_IND_DISABLE, THSCPS_EVT_TSET_SET_NTF_ENABLE, THSCPS_EVT_TSET_SET_NTF_DISABLE, THSCPS_EVT_TSET_INFO_NTF_ENABLE, THSCPS_EVT_TSET_INFO_NTF_DISABLE, THSCPS_EVT_CONN_INFO_NTF_ENABLE, THSCPS_EVT_CONN_INFO_NTF_DISABLE, THSCPS_EVT_TEST_ROLE_SET, THSCPS_EVT_ADV_PRAM_SET, THSCPS_EVT_ADV_ACTION, THSCPS_EVT_SCAN_ACTION, THSCPS_EVT_SETTING_SET }
| THS Control Point Service Event Type. More...

## Detailed Description

## Enumeration Type Documentation

## ◆ thscps_adv_phy_t

enum thscps_adv_phy_t

Specify PHY.

Enumerator
THSCPS_LEGACY_ADV_PHY | Undefined LE PHY.
THSCPS_1MBPS_PHY | LE 1M PHY.
THSCPS_CODED_PHY | LE Coded PHY.

Definition at line 94 of file thscps.h.

## ◆ thscps_ctrl_pt_id_t

enum thscps_ctrl_pt_id_t

THS Control Point Service Control Point IDs.

Enumerator
THSCPS_CTRL_PT_INVALID | Invalid cmd id.
THSCPS_CTRL_PT_TEST_ROLE | Test role set.
THSCPS_CTRL_PT_ADV_PARAM | Advertising parameters set.
THSCPS_CTRL_PT_ADV_ACTION | Advertiding action.
THSCPS_CTRL_PT_SCAN_ACTION | Scan action.
THSCPS_CTRL_PT_TEST_READY | Ready for test.
THSCPS_CTRL_PT_SETTING |

Definition at line 109 of file thscps.h.

## ◆ thscps_evt_type_t

enum thscps_evt_type_t

THS Control Point Service Event Type.

Enumerator
THSCPS_EVT_INVALID | Throughput Control Point Service invalid event.
THSCPS_EVT_CTRL_PT_IND_ENABLE | THS Control Point indicaiton is enabled.
THSCPS_EVT_CTRL_PT_IND_DISABLE | THS Control Point indicaiton is disabled.
THSCPS_EVT_TSET_SET_NTF_ENABLE | THS Test Information notification is enabled.
THSCPS_EVT_TSET_SET_NTF_DISABLE | THS Test Information notification is disabled.
THSCPS_EVT_TSET_INFO_NTF_ENABLE | THS Test Information notification is enabled.
THSCPS_EVT_TSET_INFO_NTF_DISABLE | THS Test Information notification is disabled.
THSCPS_EVT_CONN_INFO_NTF_ENABLE | THS Connection Information notification is enabled.
THSCPS_EVT_CONN_INFO_NTF_DISABLE | THS Connection Information notification is disabled.
THSCPS_EVT_TEST_ROLE_SET | Set Test role.
THSCPS_EVT_ADV_PRAM_SET | Set advertising parameters.
THSCPS_EVT_ADV_ACTION | Set advertising action.
THSCPS_EVT_SCAN_ACTION | Set scan action.
THSCPS_EVT_SETTING_SET | Throughput setting.

Definition at line 144 of file thscps.h.

## ◆ thscps_settings_type_t

enum thscps_settings_type_t

Throughput service settings types.

Enumerator
THSCPS_SETTINGS_TYPE_CI | BLE Connection Interval parameter.
THSCPS_SETTINGS_TYPE_MTU | MTU Size.
THSCPS_SETTINGS_TYPE_PDU | PDU Size.
THSCPS_SETTINGS_TYPE_PHY | Radio Phy mode, 1M, 2M, Encoded.
THSCPS_SETTINGS_TYPE_TRANS_MODE | Data transmission mode.
THSCPS_SETTINGS_TYPE_TX_POWER | Connect Tx power.
THSCPS_SETTINGS_TYPE_TOGGLE | Throughput toggle state of sending the data.

Definition at line 121 of file thscps.h.

## ◆ thscps_status_rsp_t

enum thscps_status_rsp_t

THS Control Point Response Types.

Enumerator
THSCPS_RSP_ID_SUCCESS | Success.
THSCPS_RSP_ID_UNSUPPORT | Failed because of unsupport command.
THSCPS_RSP_ID_STATUS_ERR | Failed because of disallowed status.
THSCPS_RSP_ID_PARAM_ERR | Failed because of parameter error.
THSCPS_RSP_ID_TEST_ROLE_ERR | Failed becaude of Test role error.
THSCPS_RSP_ID_SDK_ERR | Failed becaude of SDK error Size.

Definition at line 133 of file thscps.h.

## ◆ thscps_test_role_t

enum thscps_test_role_t

Local device GAP Role Type.

Enumerator
THSCPS_TEST_ROLE_INVALID | Test role: Invalid.
THSCPS_TEST_ROLE_SLAVE | Test role: Slave.
THSCPS_TEST_ROLE_MASTER | Test role: Master.

Definition at line 85 of file thscps.h.

## ◆ thscps_test_state_t

enum thscps_test_state_t

Throughput Test State.

Enumerator
THSCPS_TEST_STOP | Throughput Test is not ongoing.
THSCPS_TEST_STARTED | Throughput Test is ongoing.

Definition at line 102 of file thscps.h.