The BLE instrument API library functions. More...

Typedefs
typedef void(*	_callback_ble_instr) (int status, char *data)
	BLE tester instrument API callback function type definition. More...

Functions
BLE_INSTR_API int	ble_instr_dbg_init (_dbg_params *dbg_params_t)
	BLE tester instrument debug session initialize. More...

BLE_INSTR_API int	ble_instr_dbg_close (void)
	BLE tester instrument debug session close. More...

BLE_INSTR_API int	ble_instr_init (void *data, _callback_ble_instr callback_ble_instr)
	BLE tester instrument API initialize function. More...

BLE_INSTR_API int	ble_instr_close (void)
	BLE tester instrument API close function and free allocated resources. More...

BLE_INSTR_API int	ble_instr_set_path_loss (float path_loss)
	BLE tester instrument API function to set the path losses between the instrument and the DUT. More...

BLE_INSTR_API int	ble_instr_set_pwr_range (_ble_instr_pwr_range pwr_range)
	BLE tester instrument API function to set the instrument TX input power range. More...

BLE_INSTR_API int	ble_instr_set_tx_pwr_h_lim (float avg_high_limit)
	BLE tester instrument API function to set the packet average high power limit for the TX output power measurements. More...

BLE_INSTR_API int	ble_instr_set_tx_pwr_l_lim (float avg_low_limit)
	BLE tester instrument API function to set the packet average low power limit for the TX output power measurements. More...

BLE_INSTR_API int	ble_instr_set_tx_pwr_pk_lim (float pk_avg_limit)
	BLE tester instrument API function to set the peak to average power limit for the TX output power measurements. The largest peak power of a bit in a packet. measured for all packets in the tests. More...

BLE_INSTR_API int	ble_instr_do_tx_pwr (uint32_t freq)
	BLE tester instrument API function that performs the TX output power measurements on a specific BLE frequency channel. More...

BLE_INSTR_API int	ble_instr_set_freq_offs_h_lim (uint32_t pos_freq_limit)
	BLE tester instrument API function to set the maximum positive offset limit in KHz for the TX carrier frequency offset measurements. More...

BLE_INSTR_API int	ble_instr_set_freq_offs_l_lim (uint32_t neg_freq_limit)
	BLE tester instrument API function to set the maximum negative offset limit in KHz for the TX carrier frequency offset measurements. More...

BLE_INSTR_API int	ble_instr_set_freq_drift_pkt_lim (uint32_t drift_pkt_limit)
	BLE tester instrument API function to set the overall packet drift limit in KHz for the TX drift measurements. More...

BLE_INSTR_API int	ble_instr_set_freq_drift_rate_lim (uint32_t drift_rate_limit)
	BLE tester instrument API function to set the drift rate limit in KHz/50us for the TX drift measurements. More...

BLE_INSTR_API int	ble_instr_do_freq_offs (uint32_t freq)
	BLE tester instrument API function that performs the TX frequency offset measurements on a specific BLE channel. More...

BLE_INSTR_API int	ble_instr_set_mod_idx_f1_min (uint32_t f1_min_limit)
	Set the F1 minimum average limit in KHz for the TX modulation index measurements. More...

BLE_INSTR_API int	ble_instr_set_mod_idx_f1_max (uint32_t f1_max_limit)
	Set the F1 maximum average limit in KHz for the TX modulation index measurements. More...

BLE_INSTR_API int	ble_instr_set_mod_idx_f2_max (uint32_t f2_max_limit)
	Set the F2 maximum limit in KHz for the TX modulation index measurements. More...

BLE_INSTR_API int	ble_instr_set_mod_idx_f1f2_ratio (float f1f2_ratio_limit)
	Set the F1/F2 maximum average ratio limit for the TX modulation index measurements. More...

BLE_INSTR_API int	ble_instr_do_mod_idx (int payload, uint32_t freq)
	BLE tester instrument API function that performs the TX modulation index measurements on a specific BLE channel. More...

BLE_INSTR_API int	ble_instr_set_rx_sens_tx_pat (uint8_t pattern)
	Set the instrument TX packet pattern type for RX sensitivity measurements. More...

BLE_INSTR_API int	ble_instr_set_rx_sens_pkt_space (uint16_t spacing)
	Set the instrument TX packet spacing in us for RX sensitivity measurements. More...

BLE_INSTR_API int	ble_instr_set_rx_sens_pkt_num (uint16_t num_of_pkts)
	Set the instrument TX number of packets for RX sensitivity measurements. More...

BLE_INSTR_API int	ble_instr_set_rx_sens_tx_pwr (float tx_power)
	Set the instrument TX output power for RX sensitivity measurements. More...

BLE_INSTR_API int	ble_instr_set_rx_sens_tx_dirty (bool dirty)
	Set the instrument TX dirty packets enable/disable for RX sensitivity measurements. More...

BLE_INSTR_API int	ble_instr_set_rx_sens_tx_crc (bool crc_state)
	Set the instrument TX packet CRC alternate state on/off for RX sensitivity measurements. More...

BLE_INSTR_API int	ble_instr_do_rx_sens (uint32_t freq)
	Performs the transmission of packets, for DUT RX sensitivity measurements. More...

Detailed Description

The BLE instrument API library functions.

Typedef Documentation

◆ _callback_ble_instr

typedef void(* _callback_ble_instr) (int status, char *data)

BLE tester instrument API callback function type definition.

@ param [in] status The measurement status taken from _BLE_INSTR_STATUS_CODES. @ param [in] data A string data pointer containing result information with size up to BLE_TESTER_STR_SIZE.

Definition at line 165 of file ble_instr_api.h.

Function Documentation

◆ ble_instr_close()

BLE_INSTR_API int ble_instr_close ( void )

BLE tester instrument API close function and free allocated resources.

Returns: BLE_INSTR_STATUS_CODES.

◆ ble_instr_dbg_close()

BLE_INSTR_API int ble_instr_dbg_close ( void )

BLE tester instrument debug session close.

Returns: BLE_INSTR_STATUS_CODES.

◆ ble_instr_dbg_init()

BLE_INSTR_API int ble_instr_dbg_init ( _dbg_params * dbg_params_t )

BLE tester instrument debug session initialize.

Parameters

[in] dbg_params_t A pointer to the a __dbg_params.

Returns: BLE_INSTR_STATUS_CODES.

◆ ble_instr_do_freq_offs()

BLE_INSTR_API int ble_instr_do_freq_offs ( uint32_t freq )

BLE tester instrument API function that performs the TX frequency offset measurements on a specific BLE channel.

Parameters

[in] freq The frequency in MHz that the TX frequency measurements will be performed.

Returns: BLE_INSTR_STATUS_CODES.

◆ ble_instr_do_mod_idx()

BLE_INSTR_API int ble_instr_do_mod_idx	(	int	payload,
		uint32_t	freq
	)

BLE tester instrument API function that performs the TX modulation index measurements on a specific BLE channel.

Parameters

[in]	payload	The payload type. 0 = 11110000, 1 = 01010101.
[in]	freq	The frequency in MHz that the TX frequency measurements will be performed.

Returns: BLE_INSTR_STATUS_CODES.

◆ ble_instr_do_rx_sens()

BLE_INSTR_API int ble_instr_do_rx_sens ( uint32_t freq )

Performs the transmission of packets, for DUT RX sensitivity measurements.

Parameters

[in] freq The frequency in MHz that the RX sensitivity measurements will be performed.

Returns: BLE_INSTR_STATUS_CODES.

◆ ble_instr_do_tx_pwr()

BLE_INSTR_API int ble_instr_do_tx_pwr ( uint32_t freq )

BLE tester instrument API function that performs the TX output power measurements on a specific BLE frequency channel.

Parameters

[in] freq The frequency in MHz that the TX measurements will be performed.

Returns: BLE_INSTR_STATUS_CODES.

◆ ble_instr_init()

BLE_INSTR_API int ble_instr_init	(	void *	data,
		_callback_ble_instr	callback_ble_instr
	)

BLE tester instrument API initialize function.

Parameters

[in]	data	A void pointer of generic initialization instrument data. Could be a string for the instrument interface e.g. "GPIB0::27::INSTR" or "TCPIP::192.168.1.1::INSTR".
[in]	callback_ble_instr	A callback function, with _callback_ble_instr type, called whenever the BLE tester measurements are ready.

Returns: BLE_INSTR_STATUS_CODES.

◆ ble_instr_set_freq_drift_pkt_lim()

BLE_INSTR_API int ble_instr_set_freq_drift_pkt_lim ( uint32_t drift_pkt_limit )

BLE tester instrument API function to set the overall packet drift limit in KHz for the TX drift measurements.

Parameters

[in] drift_pkt_limit The overall packet drift in KHz for the TX drift pass/fail test criteria.

Returns: BLE_INSTR_STATUS_CODES.

◆ ble_instr_set_freq_drift_rate_lim()

BLE_INSTR_API int ble_instr_set_freq_drift_rate_lim ( uint32_t drift_rate_limit )

BLE tester instrument API function to set the drift rate limit in KHz/50us for the TX drift measurements.

Parameters

[in] drift_rate_limit The drift rate limit in KHz/50us for the TX drift pass/fail test criteria.

Returns: BLE_INSTR_STATUS_CODES.

◆ ble_instr_set_freq_offs_h_lim()

BLE_INSTR_API int ble_instr_set_freq_offs_h_lim ( uint32_t pos_freq_limit )

BLE tester instrument API function to set the maximum positive offset limit in KHz for the TX carrier frequency offset measurements.

Parameters

[in] pos_freq_limit The maximum positive offset limit in KHz for the TX carrier frequency offset pass/fail test criteria.

Returns: BLE_INSTR_STATUS_CODES.

◆ ble_instr_set_freq_offs_l_lim()

BLE_INSTR_API int ble_instr_set_freq_offs_l_lim ( uint32_t neg_freq_limit )

BLE tester instrument API function to set the maximum negative offset limit in KHz for the TX carrier frequency offset measurements.

Parameters

[in] neg_freq_limit The maximum negative offset limit in KHz for the TX carrier frequency offset pass/fail test criteria.

Returns: BLE_INSTR_STATUS_CODES.

◆ ble_instr_set_mod_idx_f1_max()

BLE_INSTR_API int ble_instr_set_mod_idx_f1_max ( uint32_t f1_max_limit )

Set the F1 maximum average limit in KHz for the TX modulation index measurements.

Parameters

[in] f1_max_limit The F1 maximum average limit in KHz for the TX modulation index pass/fail test criteria.

Returns: BLE_INSTR_STATUS_CODES.

◆ ble_instr_set_mod_idx_f1_min()

BLE_INSTR_API int ble_instr_set_mod_idx_f1_min ( uint32_t f1_min_limit )

Set the F1 minimum average limit in KHz for the TX modulation index measurements.

Parameters

[in] f1_min_limit The F1 minimum average limit in KHz for the TX modulation index pass/fail test criteria.

Returns: BLE_INSTR_STATUS_CODES.

◆ ble_instr_set_mod_idx_f1f2_ratio()

BLE_INSTR_API int ble_instr_set_mod_idx_f1f2_ratio ( float f1f2_ratio_limit )

Set the F1/F2 maximum average ratio limit for the TX modulation index measurements.

Parameters

[in] f1f2_ratio_limit The F1/F2 maximum average ratio limit for the TX modulation index pass/fail test criteria.

Returns: BLE_INSTR_STATUS_CODES.

◆ ble_instr_set_mod_idx_f2_max()

BLE_INSTR_API int ble_instr_set_mod_idx_f2_max ( uint32_t f2_max_limit )

Set the F2 maximum limit in KHz for the TX modulation index measurements.

Parameters

[in] f2_max_limit The F2 maximum limit in KHz for the TX modulation index pass/fail test criteria.

Returns: BLE_INSTR_STATUS_CODES.

◆ ble_instr_set_path_loss()

BLE_INSTR_API int ble_instr_set_path_loss ( float path_loss )

BLE tester instrument API function to set the path losses between the instrument and the DUT.

Parameters

[in] path_loss A value indicating the path losses.

Returns: BLE_INSTR_STATUS_CODES.

◆ ble_instr_set_pwr_range()

BLE_INSTR_API int ble_instr_set_pwr_range ( _ble_instr_pwr_range pwr_range )

BLE tester instrument API function to set the instrument TX input power range.

Parameters

[in] pwr_range The instrument input power range taken from __ble_instr_pwr_range.

Returns: BLE_INSTR_STATUS_CODES.

◆ ble_instr_set_rx_sens_pkt_num()

BLE_INSTR_API int ble_instr_set_rx_sens_pkt_num ( uint16_t num_of_pkts )

Set the instrument TX number of packets for RX sensitivity measurements.

Parameters

[in] num_of_pkts The number of packets to transmit. 0=continuous. 1-65535=Fixed umber of packets to sent.

Returns: BLE_INSTR_STATUS_CODES.

◆ ble_instr_set_rx_sens_pkt_space()

BLE_INSTR_API int ble_instr_set_rx_sens_pkt_space ( uint16_t spacing )

Set the instrument TX packet spacing in us for RX sensitivity measurements.

Parameters

[in] spacing 1us steps of packet spacing. 625us to 65535us.

Returns: BLE_INSTR_STATUS_CODES.

◆ ble_instr_set_rx_sens_tx_crc()

BLE_INSTR_API int ble_instr_set_rx_sens_tx_crc ( bool crc_state )

Set the instrument TX packet CRC alternate state on/off for RX sensitivity measurements.

Parameters

[in] crc_state ON=alternate CRC state from correct to incorrect.

Returns: BLE_INSTR_STATUS_CODES.

◆ ble_instr_set_rx_sens_tx_dirty()

BLE_INSTR_API int ble_instr_set_rx_sens_tx_dirty ( bool dirty )

Set the instrument TX dirty packets enable/disable for RX sensitivity measurements.

Parameters

[in] dirty When ON, the packet generator uses the dirty table from the selected script LESS test.

Returns: BLE_INSTR_STATUS_CODES.

◆ ble_instr_set_rx_sens_tx_pat()

BLE_INSTR_API int ble_instr_set_rx_sens_tx_pat ( uint8_t pattern )

Set the instrument TX packet pattern type for RX sensitivity measurements.

Parameters

[in] pattern The pattern of the TX data. 0=PRBS9, 1=10101010, 2=11110000.

Returns: BLE_INSTR_STATUS_CODES.

◆ ble_instr_set_rx_sens_tx_pwr()

BLE_INSTR_API int ble_instr_set_rx_sens_tx_pwr ( float tx_power )

Set the instrument TX output power for RX sensitivity measurements.

Parameters

[in] tx_power The transmitted power level from 0.0 to -90.0dBm.

Returns: BLE_INSTR_STATUS_CODES.

◆ ble_instr_set_tx_pwr_h_lim()

BLE_INSTR_API int ble_instr_set_tx_pwr_h_lim ( float avg_high_limit )

BLE tester instrument API function to set the packet average high power limit for the TX output power measurements.

Parameters

[in] avg_high_limit The packet average high power limit for the TX output power pass/fail test criteria.

Returns: BLE_INSTR_STATUS_CODES.

◆ ble_instr_set_tx_pwr_l_lim()

BLE_INSTR_API int ble_instr_set_tx_pwr_l_lim ( float avg_low_limit )

BLE tester instrument API function to set the packet average low power limit for the TX output power measurements.

Parameters

[in] avg_low_limit The packet average low power limit for the TX output power pass/fail test criteria.

Returns: BLE_INSTR_STATUS_CODES.

◆ ble_instr_set_tx_pwr_pk_lim()

BLE_INSTR_API int ble_instr_set_tx_pwr_pk_lim ( float pk_avg_limit )

BLE tester instrument API function to set the peak to average power limit for the TX output power measurements. The largest peak power of a bit in a packet. measured for all packets in the tests.

Parameters

[in] pk_avg_limit The peak to average power limit for the TX output power pass/fail test criteria.

Returns: BLE_INSTR_STATUS_CODES.

Typedefs

Functions

Detailed Description

Typedef Documentation

◆ _callback_ble_instr

Function Documentation

◆ ble_instr_close()

◆ ble_instr_dbg_close()

◆ ble_instr_dbg_init()

◆ ble_instr_do_freq_offs()

◆ ble_instr_do_mod_idx()

◆ ble_instr_do_rx_sens()

◆ ble_instr_do_tx_pwr()

◆ ble_instr_init()

◆ ble_instr_set_freq_drift_pkt_lim()

◆ ble_instr_set_freq_drift_rate_lim()

◆ ble_instr_set_freq_offs_h_lim()

◆ ble_instr_set_freq_offs_l_lim()

◆ ble_instr_set_mod_idx_f1_max()

◆ ble_instr_set_mod_idx_f1_min()

◆ ble_instr_set_mod_idx_f1f2_ratio()

◆ ble_instr_set_mod_idx_f2_max()

◆ ble_instr_set_path_loss()

◆ ble_instr_set_pwr_range()

◆ ble_instr_set_rx_sens_pkt_num()

◆ ble_instr_set_rx_sens_pkt_space()

◆ ble_instr_set_rx_sens_tx_crc()

◆ ble_instr_set_rx_sens_tx_dirty()

◆ ble_instr_set_rx_sens_tx_pat()

◆ ble_instr_set_rx_sens_tx_pwr()

◆ ble_instr_set_tx_pwr_h_lim()

◆ ble_instr_set_tx_pwr_l_lim()

◆ ble_instr_set_tx_pwr_pk_lim()