Throughput Test helper#

Helper for throughput tests

Modules#

allowlist_s

throughput_t

Enumerations#

enum

action_t {

act_none = 0

act_discover_service

act_discover_characteristics

act_enable_transmission_notification

act_enable_notification

act_enable_indication

act_subscribe_result

}

enum

throughput_role_t {

THROUGHPUT_ROLE_PERIPHERAL

THROUGHPUT_ROLE_CENTRAL

}

Role enum type.

enum

throughput_state_t {

THROUGHPUT_STATE_UNINITALIZED

THROUGHPUT_STATE_DISCONNECTED

THROUGHPUT_STATE_CONNECTED

THROUGHPUT_STATE_SUBSCRIBED

THROUGHPUT_STATE_TEST

THROUGHPUT_STATE_TEST_FINISH

THROUGHPUT_STATE_UNINITALIZING

}

State enum type.

enum

throughput_mode_t {

THROUGHPUT_MODE_CONTINUOUS

THROUGHPUT_MODE_FIXED_TIME

THROUGHPUT_MODE_FIXED_LENGTH

}

Mode enum type.

enum

throughput_discovery_state_t {

THROUGHPUT_DISCOVERY_STATE_IDLE

THROUGHPUT_DISCOVERY_STATE_CONN

THROUGHPUT_DISCOVERY_STATE_SCAN

THROUGHPUT_DISCOVERY_STATE_SERVICE

THROUGHPUT_DISCOVERY_STATE_CHARACTERISTICS

THROUGHPUT_DISCOVERY_STATE_FINISHED

}

Discovery state.

Typedefs#

typedef int8_t

throughput_tx_power_t

TX power type.

typedef int8_t

throughput_rssi_t

RSSI type.

typedef uint16_t

throughput_pdu_size_t

PDU size type.

typedef uint16_t

throughput_mtu_size_t

MTU size type.

typedef uint16_t

throughput_data_size_t

Data size type.

typedef sl_bt_gap_phy_coding_t

throughput_phy_t

PHY type.

typedef sl_bt_scanner_scan_phy_t

throughput_scan_phy_t

typedef sl_bt_gatt_client_config_flag_t

throughput_notification_t

Notification/indication type.

typedef uint32_t

throughput_value_t

Throughput type.

typedef uint32_t

throughput_count_t

Data counter type type.

typedef uint32_t

throughput_time_t

Time type type.

typedef struct allowlist_s

throughput_allowlist_t

Throughput test allowlist structure.

Macros#

#define

THROUGHPUT_DEFAULT_PDU_SIZE 27u

The default PDU size if 27 bytes according to the Core Specification.

#define

CLI_RESPONSE (...)

#define

CLI_OK "OK" APP_LOG_NEW_LINE

#define

CLI_ERROR "ERROR" APP_LOG_NEW_LINE

Enumeration Documentation#

action_t#

action_t

Discovering services/characteristics and subscribing raises procedure_complete events Actions are used to indicate which procedure was completed.

Enumerator
act_none
act_discover_service
act_discover_characteristics
act_enable_transmission_notification
act_enable_notification
act_enable_indication
act_subscribe_result

Definition at line 40 of file common/throughput/throughput_common.h

throughput_role_t#

throughput_role_t

Role enum type.

Enumerator
THROUGHPUT_ROLE_PERIPHERAL
THROUGHPUT_ROLE_CENTRAL

Definition at line 45 of file common/throughput/throughput_types.h

throughput_state_t#

throughput_state_t

State enum type.

Enumerator
THROUGHPUT_STATE_UNINITALIZED
THROUGHPUT_STATE_DISCONNECTED
THROUGHPUT_STATE_CONNECTED
THROUGHPUT_STATE_SUBSCRIBED
THROUGHPUT_STATE_TEST
THROUGHPUT_STATE_TEST_FINISH
THROUGHPUT_STATE_UNINITALIZING

Definition at line 51 of file common/throughput/throughput_types.h

throughput_mode_t#

throughput_mode_t

Mode enum type.

Enumerator
THROUGHPUT_MODE_CONTINUOUS
THROUGHPUT_MODE_FIXED_TIME
THROUGHPUT_MODE_FIXED_LENGTH

Definition at line 62 of file common/throughput/throughput_types.h

throughput_discovery_state_t#

throughput_discovery_state_t

Discovery state.

Enumerator
THROUGHPUT_DISCOVERY_STATE_IDLE
THROUGHPUT_DISCOVERY_STATE_CONN
THROUGHPUT_DISCOVERY_STATE_SCAN
THROUGHPUT_DISCOVERY_STATE_SERVICE
THROUGHPUT_DISCOVERY_STATE_CHARACTERISTICS
THROUGHPUT_DISCOVERY_STATE_FINISHED

Definition at line 69 of file common/throughput/throughput_types.h

Typedef Documentation#

throughput_tx_power_t#

typedef int8_t throughput_tx_power_t

TX power type.

Definition at line 79 of file common/throughput/throughput_types.h

throughput_rssi_t#

typedef int8_t throughput_rssi_t

RSSI type.

Definition at line 81 of file common/throughput/throughput_types.h

throughput_pdu_size_t#

typedef uint16_t throughput_pdu_size_t

PDU size type.

Definition at line 83 of file common/throughput/throughput_types.h

throughput_mtu_size_t#

typedef uint16_t throughput_mtu_size_t

MTU size type.

Definition at line 85 of file common/throughput/throughput_types.h

throughput_data_size_t#

typedef uint16_t throughput_data_size_t

Data size type.

Definition at line 87 of file common/throughput/throughput_types.h

throughput_phy_t#

typedef sl_bt_gap_phy_coding_t throughput_phy_t

PHY type.

Definition at line 89 of file common/throughput/throughput_types.h

throughput_scan_phy_t#

typedef sl_bt_scanner_scan_phy_t throughput_scan_phy_t

Definition at line 90 of file common/throughput/throughput_types.h

throughput_notification_t#

typedef sl_bt_gatt_client_config_flag_t throughput_notification_t

Notification/indication type.

Definition at line 92 of file common/throughput/throughput_types.h

throughput_value_t#

typedef uint32_t throughput_value_t

Throughput type.

Definition at line 94 of file common/throughput/throughput_types.h

throughput_count_t#

typedef uint32_t throughput_count_t

Data counter type type.

Definition at line 96 of file common/throughput/throughput_types.h

throughput_time_t#

typedef uint32_t throughput_time_t

Time type type.

Definition at line 98 of file common/throughput/throughput_types.h

throughput_allowlist_t#

typedef struct allowlist_s throughput_allowlist_t

Throughput test allowlist structure.

Definition at line 105 of file common/throughput/throughput_types.h

Macro Definition Documentation#

THROUGHPUT_DEFAULT_PDU_SIZE#

#define THROUGHPUT_DEFAULT_PDU_SIZE

Value:

27u

The default PDU size if 27 bytes according to the Core Specification.

Definition at line 51 of file common/throughput/throughput_common.h

CLI_RESPONSE#

#define CLI_RESPONSE

Value:

(...)

Definition at line 148 of file common/throughput/throughput_types.h

CLI_OK#

#define CLI_OK

Value:

"OK" APP_LOG_NEW_LINE

Definition at line 149 of file common/throughput/throughput_types.h

CLI_ERROR#

#define CLI_ERROR

Value:

"ERROR" APP_LOG_NEW_LINE

Definition at line 150 of file common/throughput/throughput_types.h