Bluetooth Generation

Defines a root class which is used to identify and control bt signal generation configuration.

class nirfmxbluetoothgen.bluetoothgen.Session(toolkit_compatibility_version, session_name=None, *, grpc_options=None)

Bases: object

Defines a root class which is used to identify and control bt signal generation configuration.

carrier_frequency_to_channel_number(carrier_frequency, standard)

Computes the channel number of the Bluetooth signal based on the carrier frequency you specify in the carrier_frequency parameter. The BT Generation computes the channel number according to section 2, Part A, Volume 2 of the Bluetooth Specification Version 4.2.

Parameters:

• carrier_frequency (float) – Specifies the carrier frequency, in Hz, for which you want to compute the channel number.

• standard (int) –

  Specifies the standard. The default value is NIBTSG_STANDARD_BASIC_OR_EDR.

  NIBTSG_STANDARD_BASIC_OR_EDR(0)	Specifies that the standard is basic rate or enhanced data rate (EDR).
  NIBTSG_STANDARD_LE(1)	Specifies that the standard is low energy (LE).

Returns:

channel_number (int):

Returns the channel number corresponding to the specified carrier frequency.

error_code (int):

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (channel_number, error_code)

channel_number_to_carrier_frequency(channel_number, standard)

Computes the carrier frequency of the Bluetooth signal to generate based on the value that you specify in the channel_number parameter. The BT Generation computes the center frequency according to section 2, Part A, Volume 2 of the Bluetooth Specification Version 4.2.

The Bluetooth system operates in the 2.4 GHz ISM band. This frequency band is 2,400 MHz to 2,483.5 MHz. RF channels are spaced 1 MHz apart and are ordered in channel number k according to the following formula: f = 2,402 + k MHz, where k = 0, 1, …, 78 for Basic Rate/Enhanced Data Rate packets and f = 2,402 + (2 * k) MHz, where k = 0, 1, …, 39 for a Low Energy packet, and f is the frequency of the RF channels.

Parameters:

• channel_number (int) – Specifies the channel number.

• standard (int) –

  Specifies the standard. The default value is NIBTSG_STANDARD_BASIC_OR_EDR.

  NIBTSG_STANDARD_BASIC_OR_EDR(0)	Specifies that the standard is basic rate or enhanced data rate (EDR).
  NIBTSG_STANDARD_LE(1)	Specifies that the standard is low energy (LE).

Returns:

carrier_frequency (float):

Returns the RF frequency (f) corresponding to the channel number k, where f = 2,402 + k MHz.

error_code (int):

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (carrier_frequency, error_code)

close()

Closes the bt generation session and releases resources associated with that session. Call this function once for each uniquely named session that you have created..

create_and_write_waveforms_to_file(file_path, file_operation)

Creates waveforms according to the parameters you specify, and saves the waveforms to a file.

In addition to the waveform, this function also saves the HEADROOM and IQ_RATE attributes to the file.

Parameters:

• file_path (string) – Specifies the absolute path to the file to which the BT Generation saves the waveforms.

• file_operation (int) –

  Specifies the operation to perform on the file.

  NIBTSG_FILE_OPERATION_MODE_OPEN(0)	Opens an existing file to write the niBT SG session attribute values.
  NIBTSG_FILE_OPERATION_MODE_OPENORCREATE(1)	Opens an existing file or creates a new file if the file does not exist.
  NIBTSG_FILE_OPERATION_MODE_CREATEORREPLACE(2)	Creates a new file or replaces a file if it exists.
  NIBTSG_FILE_OPERATION_MODE_CREATE(3)	Creates a new file.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

create_waveform_complex_f64(reset, waveform)

Creates a waveform according to the values that you specify. This function generates one frame at a time.

Parameters:

• reset (bool) – Specifies whether to reset the internal states in the created waveform.

• waveform (numpy.complex128) – Returns the array of baseband complex I/Q samples.

Returns:

t0 (float):

Returns the starting time, in seconds.

dt (float):

Returns the time interval between baseband I/Q samples, in seconds.

generation_done (bool):

Indicates whether the function has generated all the frames.

error_code (int):

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (t0, dt, generation_done, error_code)

get_actual_headroom(channel_string)

Gets the actual headroom used by the BT Generation. This value is expressed in dB. You can use this value to configure the peak power of the generation hardware.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Returns the actual headroom used by the BT Generation. This value is expressed in dB. You can use this value to configure the peak power of the generation hardware.

error_code (int):

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_actual_payload_length(channel_string)

Gets the actual payload length, in bytes, that is calculated by the BT Generation.

If you set the PAYLOAD_LENGTH_MODE attribute to NIBTSG_VAL_PAYLOAD_LENGTH_MODE_MAXIMUM_LENGTH, the BT Generation returns the maximum permissible payload data length as specified in the Bluetooth specifications. If you set the PAYLOAD_LENGTH_MODE attribute to NIBTSG_VAL_PAYLOAD_LENGTH_MODE_USER_DEFINED, the BT Generation returns the value that you specify in the PAYLOAD_LENGTH attribute. If the value that you specify in the PAYLOAD_LENGTH attribute exceeds the maximum permissible payload length for the packet, the BT Generation returns this maximum permissible payload length.

For LE-HDT Packets when HDT_PACKET_FORMAT is set to NIBTSG_VAL_HDT_PACKET_FORMAT_FORMAT1 and FORMAT1_PAYLOAD_ZONE_CONFIGURATION_MODE is set to NIBTSG_VAL_FORMAT1_PAYLOAD_ZONE_CONFIGURATION_MODE_USER_DEFINED, the Actual Payload Length is computed as Payload length = (Nb * BLOCK_SIZE) + LAST_BLOCK_SIZE for each payload. Here Nb is number of transmitted blocks depends on the TXBLOCK_MAP attribute.

You must use “payload x” as the active channel string to configure this property for the LE-HDT packet when HDT_PACKET_FORMAT is set to NIBTSG_VAL_HDT_PACKET_FORMAT_FORMAT1.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):

Returns the actual payload length, in bytes, that is calculated by the BT Generation.

error_code (int):

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_all_iq_impairments_enabled(channel_string)

Gets whether to enable I/Q impairments.

The default value is NIBTSG_VAL_TRUE.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.AllIQImpairmentsEnabled):

Specifies whether to enable I/Q impairments.

error_code (int):

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_auto_headroom_enabled(channel_string)

Gets whether the BT Generation calculates the headroom or uses the value that you specify in the HEADROOM attribute.

The default value is NIBTSG_VAL_TRUE.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.AutoHeadroomEnabled):

Specifies whether the BT Generation calculates the headroom or uses the value that you specify in the HEADROOM attribute.

error_code (int):

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_awgn_enabled(channel_string)

Gets whether to add additive white Gaussian noise (AWGN) to the baseband waveform.

The default value is NIBTSG_VAL_FALSE.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.AwgnEnabled):

Specifies whether to add additive white Gaussian noise (AWGN) to the baseband waveform.

error_code (int):

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_bandwidth_bit_period_product(channel_string)

Gets the bandwidth bit period product of GFSK modulation for LE-CS packet type.

The default value is 0.5. The valid values are 0.5 and 2.0 .

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Specifies the bandwidth bit period product of GFSK modulation for LE-CS packet type.

error_code (int):

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_bd_address_lap(channel_string)

Gets the 24-bit lower address part (LAP) of the Bluetooth device address.

The default value is 0.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):

Specifies the 24-bit lower address part (LAP) of the Bluetooth device address.

error_code (int):

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_bd_address_nap(channel_string)

Gets the 16-bit nonsignificant address part (NAP) of the Bluetooth device address.

The default value is 0.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):

Specifies the 16-bit nonsignificant address part (NAP) of the Bluetooth device address.

error_code (int):

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_bd_address_uap(channel_string)

Gets the 8-bit upper address part (UAP) of the Bluetooth device address.

The default value is 0.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):

Specifies the 8-bit upper address part (UAP) of the Bluetooth device address.

error_code (int):

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_block_size(channel_string)

Gets the block size of each block specified by NUMBER_OF_BLOCKS.This property is valid only for the LE-HDT packet when HDT_PACKET_FORMAT is set to NIBTSG_VAL_HDT_PACKET_FORMAT_FORMAT1 and FORMAT1_PAYLOAD_ZONE_CONFIGURATION_MODE is set to NIBTSG_VAL_FORMAT1_PAYLOAD_ZONE_CONFIGURATION_MODE_USER_DEFINED.

You must use “payload x” as the active channel string to configure this property.

The valid values are 32 to 511. The default value is 511.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):

Specifies the block size of each block specified by NUMBER_OF_BLOCKS.This property is valid only for the LE-HDT packet when HDT_PACKET_FORMAT is set to NIBTSG_VAL_HDT_PACKET_FORMAT_FORMAT1 and FORMAT1_PAYLOAD_ZONE_CONFIGURATION_MODE is set to NIBTSG_VAL_FORMAT1_PAYLOAD_ZONE_CONFIGURATION_MODE_USER_DEFINED.

error_code (int):

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_burst_start_locations(channel_string)

Gets an array of sample positions for the start of all bursts, within the waveform.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):

Returns an array of sample positions for the start of all bursts, within the waveform.

error_code (int):

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_burst_stop_locations(channel_string)

Gets an array of sample positions for the end of all bursts, within the waveform.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):

Returns an array of sample positions for the end of all bursts, within the waveform.

error_code (int):

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_carrier_frequency(channel_string)

Gets the carrier frequency. This value is expressed in Hz.

If you set the WHITENING_ENABLED attribute to NIBTSG_VAL_TRUE and the PACKET_TYPE attribute to any LE packets, you should set a value for the CARRIER_FREQUENCY attribute.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Specifies the carrier frequency. This value is expressed in Hz.

error_code (int):

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_carrier_frequency_offset(channel_string)

Gets the carrier frequency offset from the value that you specify as the center frequency of the RF signal generator. This value is expressed in Hz.

The default value is 0.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Specifies the carrier frequency offset from the value that you specify as the center frequency of the RF signal generator. This value is expressed in Hz.

error_code (int):

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_carrier_mode(channel_string)

Gets whether the carrier is continuous or includes bursts.

If you set this attribute to NIBTSG_VAL_CARRIER_MODE_BURST, the BT Generation generates the burst signal by adding zeros at the end of the packet to create one or more complete slots, depending on the packet type. In this mode, the BT Generation also shapes the generated waveform to meet the burst ramp characteristics specified in the Bluetooth Test Purposes (TP) specification 1.2/2.0+EDR/2.1/2.1+EDR/3.0/3.0+HS. If you set this attribute to NIBTSG_VAL_CARRIER_MODE_CONTINUOUS, the BT Generation generates a phase continuous Bluetooth signal, which is used as an interference signal. This mode is useful to generate an interference signal with pseudorandom bits and continuous phase. In this mode, the NUMBER_OF_IDLE_SLOTS attribute is not used, and the number of idle slots is assumed be zero. In this mode, NI recommends you to leave the NUMBER_OF_UNIQUE_PACKETS, PAYLOAD_DATA_TYPE, and DIRTY_TX_ENABLED attributes at their default values. Refer to the Carrier Mode topic for more information about the CARRIER_MODE attribute.

The default value is NIBTSG_VAL_CARRIER_MODE_BURST.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.CarrierMode):

Specifies whether the carrier is continuous or includes bursts.

error_code (int):

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_carrier_to_noise_ratio(channel_string)

Gets the carrier-to-noise ratio (CNR)of the waveform generated. This value is expressed in dB. Noise bandwidth is equal to half the value of the IQ_RATE attribute. Configure the CARRIER_TO_NOISE_RATIO attribute only if you set the AWGN_ENABLED attribute to NIBTSG_VAL_TRUE.

The default value is 50.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Specifies the carrier-to-noise ratio (CNR)of the waveform generated. This value is expressed in dB. Noise bandwidth is equal to half the value of the IQ_RATE attribute. Configure the CARRIER_TO_NOISE_RATIO attribute only if you set the AWGN_ENABLED attribute to NIBTSG_VAL_TRUE.

error_code (int):

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_cs_packet_format(channel_string)

Gets the channel sounding (CS) packet format. This property is applicable only when you set the packet type to either LE-CS-1M or LE-CS-2M. The default value is NIBTSG_VAL_PACKET_FORMAT_SYNC.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.CSPacketFormat):

Specifies the channel sounding (CS) packet format. This property is applicable only when you set the packet type to either LE-CS-1M or LE-CS-2M. The default value is NIBTSG_VAL_PACKET_FORMAT_SYNC.

error_code (int):

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_cs_phase_measurement_period(channel_string)

Gets the phase measurement period in the generated CS packet. This property is applicable for all CS packet formats except NIBTSG_VAL_PACKET_FORMAT_SYNC. The default value is 10us. Valid values are 10 us, 20us and 40 us.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Specifies the phase measurement period in the generated CS packet. This property is applicable for all CS packet formats except NIBTSG_VAL_PACKET_FORMAT_SYNC. The default value is 10us. Valid values are 10 us, 20us and 40 us.

error_code (int):

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_cs_sync_sequence(channel_string)

Gets whether the sounding sequence field is present in SYNC packet. This property is applicable for all CS Packet formats except CS Tone. The default value is NIBTSG_VAL_SYNC_SEQUENCE_SOUNDING_SEQUENCE.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.CSSyncSequence):

Specifies whether the sounding sequence field is present in SYNC packet. This property is applicable for all CS Packet formats except CS Tone. The default value is NIBTSG_VAL_SYNC_SEQUENCE_SOUNDING_SEQUENCE.

error_code (int):

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_cs_tone_extension_slot_enabled(channel_string)

Gets whether CS tone extension slot is present in generated LE CS packets. This property is applicable for all CS packet formats except NIBTSG_VAL_PACKET_FORMAT_SYNC. The default value is NIBTSG_VAL_FALSE.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.CSToneExtensionSlotEnabled):

Specifies whether CS tone extension slot is present in generated LE CS packets. This property is applicable for all CS packet formats except NIBTSG_VAL_PACKET_FORMAT_SYNC. The default value is NIBTSG_VAL_FALSE.

error_code (int):

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_data_rate(channel_string)

Gets the Higher Data Throughput (HDT) Bit Rate. This property is applicable only when you set the packet type to LE-HDT. The default value is 2000000. Valid values are 2000000, 3000000, 4000000, 6000000, 7500000.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.DataRate):

Specifies the Higher Data Throughput (HDT) Bit Rate. This property is applicable only when you set the packet type to LE-HDT. The default value is 2000000. Valid values are 2000000, 3000000, 4000000, 6000000, 7500000.

error_code (int):

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_direction_finding_antenna_switching_duration(channel_string)

Gets the duration for which the transitions of phase and amplitude take place in the switching slots of the constant tone extension (CTE) portion of the low energy (LE) packet. This attribute is applicable only when the DIRECTION_FINDING_ANTENNA_SWITCHING_ENABLED attribute to NIBTSG_VAL_TRUE.

The default value is 500n.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Specifies the duration for which the transitions of phase and amplitude take place in the switching slots of the constant tone extension (CTE) portion of the low energy (LE) packet. This attribute is applicable only when the DIRECTION_FINDING_ANTENNA_SWITCHING_ENABLED attribute to NIBTSG_VAL_TRUE.

error_code (int):

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_direction_finding_antenna_switching_duration_used(channel_string)

Gets the actual duration used to make the transitions of phase and amplitude in the switching slots of the constant tone extension (CTE) portion of low energy (LE) packet. This attribute is applicable only when you set the DIRECTION_FINDING_ANTENNA_SWITCHING_ENABLED attribute to NIBTSG_VAL_TRUE.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Returns the actual duration used to make the transitions of phase and amplitude in the switching slots of the constant tone extension (CTE) portion of low energy (LE) packet. This attribute is applicable only when you set the DIRECTION_FINDING_ANTENNA_SWITCHING_ENABLED attribute to NIBTSG_VAL_TRUE.

error_code (int):

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_direction_finding_antenna_switching_enabled(channel_string)

Gets whether antenna switching is enabled for the generated low energy (LE) packets. This attribute is valid only when you set the DIRECTION_FINDING_MODE attribute to NIBTSG_VAL_DIRECTION_FINDING_MODE_ANGLE_OF_ARRIVAL or NIBTSG_DIRECTION_FINDING_MODE_ANGLE_OF_DEPARTURE.

The default value is NIBTSG_VAL_FALSE.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.AntennaSwitchingEnabled):

Specifies whether antenna switching is enabled for the generated low energy (LE) packets. This attribute is valid only when you set the DIRECTION_FINDING_MODE attribute to NIBTSG_VAL_DIRECTION_FINDING_MODE_ANGLE_OF_ARRIVAL or NIBTSG_DIRECTION_FINDING_MODE_ANGLE_OF_DEPARTURE.

error_code (int):

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_direction_finding_antenna_switching_pattern(channel_string)

Gets the pattern in which the antennas switch in constant tone extension (CTE) portion of the low energy (LE) packet. The current definition always treats A0 as the reference antenna. A1, A2, A3…Am are all non-reference antennas. This attribute is applicable only when you set the DIRECTION_FINDING_ANTENNA_SWITCHING_ENABLED to NIBTSG_VAL_TRUE.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (string):

Specifies the pattern in which the antennas switch in constant tone extension (CTE) portion of the low energy (LE) packet. The current definition always treats A0 as the reference antenna. A1, A2, A3…Am are all non-reference antennas. This attribute is applicable only when you set the DIRECTION_FINDING_ANTENNA_SWITCHING_ENABLED to NIBTSG_VAL_TRUE.

error_code (int):

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_direction_finding_constant_tone_extension_length(channel_string)

Gets the length of the constant tone extension field in the generated signal. This value is expressed in seconds. This parameter is applicable only when you set the DIRECTION_FINDING_MODE attribute to either NIBTSG_VAL_DIRECTION_FINDING_MODE_ANGLE_OF_ARRIVAL or NIBTSG_DIRECTION_FINDING_MODE_ANGLE_OF_DEPARTURE.

The default value is 0.00016.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Specifies the length of the constant tone extension field in the generated signal. This value is expressed in seconds. This parameter is applicable only when you set the DIRECTION_FINDING_MODE attribute to either NIBTSG_VAL_DIRECTION_FINDING_MODE_ANGLE_OF_ARRIVAL or NIBTSG_DIRECTION_FINDING_MODE_ANGLE_OF_DEPARTURE.

error_code (int):

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_direction_finding_constant_tone_extension_slot_duration(channel_string)

Gets the length of the antenna switching and sampling slots in the constant tone extension field. This value is expressed in seconds.

The default value is 1 us. Valid values are 1 us and 2 us.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Specifies the length of the antenna switching and sampling slots in the constant tone extension field. This value is expressed in seconds.

error_code (int):

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_direction_finding_mode(channel_string)

Gets the mode for direction finding. The attribute is valid only for LE-TP, LE-TP EXT, LE-Enhanced and LE-HDT packet type.

The default value is NIBTSG_VAL_DIRECTION_FINDING_MODE_DISABLE.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.DirectionFindingMode):

Specifies the mode for direction finding. The attribute is valid only for LE-TP, LE-TP EXT, LE-Enhanced and LE-HDT packet type.

error_code (int):

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_direction_finding_number_of_antennas(channel_string)

Gets the number of antennas used to transmit or receive the constant tone extension (CTE) portion of low energy (LE) packet. This attribute is applicable only when you set the DIRECTION_FINDING_ANTENNA_SWITCHING_ENABLED to NIBTSG_VAL_TRUE.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):

Specifies the number of antennas used to transmit or receive the constant tone extension (CTE) portion of low energy (LE) packet. This attribute is applicable only when you set the DIRECTION_FINDING_ANTENNA_SWITCHING_ENABLED to NIBTSG_VAL_TRUE.

error_code (int):

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_dirty_tx_carrier_frequency_offset_set(channel_string)

Gets the offset value of each of the impairment set that you enable in the DIRTY_TX_PARAMETERS_ENABLED_SET attribute. This attribute is applicable with you set the DIRTY_TX_MODE attribute to NIBTSG_VAL_DIRTY_TX_MODE_USER_DEFINED. The BT Generation ignores this attribute if you set the DIRTY_TX_MODE attribute to NIBTSG_VAL_DIRTY_TX_MODE_STANDARD.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):

Specifies the offset value of each of the impairment set that you enable in the DIRTY_TX_PARAMETERS_ENABLED_SET attribute. This attribute is applicable with you set the DIRTY_TX_MODE attribute to NIBTSG_VAL_DIRTY_TX_MODE_USER_DEFINED. The BT Generation ignores this attribute if you set the DIRTY_TX_MODE attribute to NIBTSG_VAL_DIRTY_TX_MODE_STANDARD.

error_code (int):

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_dirty_tx_enabled(channel_string)

Gets whether to enable the dirty transmitter.

The default value is NIBTSG_VAL_FALSE.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.DirtyTxEnabled):

Specifies whether to enable the dirty transmitter.

error_code (int):

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_dirty_tx_mode(channel_string)

Gets whether to enable the dirty transmitter with the standard settings, the user-defined settings or the frequency drift.

The default value is NIBTSG_VAL_DIRTY_TX_MODE_STANDARD.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.DirtyTxMode):

Specifies whether to enable the dirty transmitter with the standard settings, the user-defined settings or the frequency drift.

error_code (int):

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_dirty_tx_modulation_index_set(channel_string)

Gets the modulation index value of each of the impairment set that you enable in the DIRTY_TX_PARAMETERS_ENABLED_SET attribute.

This attribute is applicable when you set the DIRTY_TX_MODE attribute to NIBTSG_VAL_DIRTY_TX_MODE_USER_DEFINED. The BT Generation ignores this attribute if you set the DIRTY_TX_MODE attribute to NIBTSG_VAL_DIRTY_TX_MODE_STANDARD.

Valid values are 0.28 to 0.4 for Basic Rate and EDR packets and 0.45 to 0.55 for LE packets, inclusive. The valid values are 0.495 to 0.505, inclusive, for LE packets when you set the DIRTY_TX_MODULATION_INDEX_TYPE attribute to NIBTSG_VAL_DIRTY_TX_MODULATION_INDEX_TYPE_STABLE.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Specifies the modulation index value of each of the impairment set that you enable in the DIRTY_TX_PARAMETERS_ENABLED_SET attribute.

error_code (int):

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_dirty_tx_modulation_index_type(channel_string)

Gets whether the modulation index type is NIBTSG_DIRTY_TX_MODULATION_INDEX_TYPE_STANDARD or NIBTSG_VAL_DIRTY_TX_MODULATION_INDEX_TYPE_STABLE. This attribute is valid only for LE packets. This attribute is applicable only if DIRTY_TX_ENABLED attribute is set to NIBTSG_VAL_TRUE. The default value is NIBTSG_DIRTY_TX_MODULATION_INDEX_TYPE_STANDARD.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.DirtyTxModulationIndexType):

Specifies whether the modulation index type is NIBTSG_DIRTY_TX_MODULATION_INDEX_TYPE_STANDARD or NIBTSG_VAL_DIRTY_TX_MODULATION_INDEX_TYPE_STABLE. This attribute is valid only for LE packets. This attribute is applicable only if DIRTY_TX_ENABLED attribute is set to NIBTSG_VAL_TRUE. The default value is NIBTSG_DIRTY_TX_MODULATION_INDEX_TYPE_STANDARD.

error_code (int):

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_dirty_tx_parameters_enabled_set(channel_string)

Gets the impairment sets that you must enable out of the ten sets in LE and BR or the three sets in EDR. This attribute is applicable if you set the DIRTY_TX_MODE attribute to NIBTSG_VAL_DIRTY_TX_MODE_USER_DEFINED. The BT Generation ignores this attribute when the DIRTY_TX_MODE attribute is set to NIBTSG_VAL_DIRTY_TX_MODE_STANDARD.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.DirtyTxParametersEnabledSet):

Specifies the impairment sets that you must enable out of the ten sets in LE and BR or the three sets in EDR. This attribute is applicable if you set the DIRTY_TX_MODE attribute to NIBTSG_VAL_DIRTY_TX_MODE_USER_DEFINED. The BT Generation ignores this attribute when the DIRTY_TX_MODE attribute is set to NIBTSG_VAL_DIRTY_TX_MODE_STANDARD.

error_code (int):

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_dirty_tx_residual_fm_deviation(channel_string)

Gets the frequency of the modulated signal to provide the additional frequency drift. This value is expressed in Hz.

This attribute is applicable when you set the DIRTY_TX_MODE attribute to NIBTSG_VAL_DIRTY_TX_MODE_USER_DEFINED. The BT Generation ignores this attribute if you set the DIRTY_TX_MODE attribute to NIBTSG_VAL_DIRTY_TX_MODE_STANDARD.

The default value is 0.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Specifies the frequency of the modulated signal to provide the additional frequency drift. This value is expressed in Hz.

error_code (int):

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_dirty_tx_residual_fm_frequency(channel_string)

Gets the frequency deviation of the modulated signal to provide the additional frequency drift. This value is expressed in Hz.

This attribute is applicable when you set the DIRTY_TX_MODE attribute to NIBTSG_VAL_DIRTY_TX_MODE_USER_DEFINED. The BT Generation ignores this attribute if you set the DIRTY_TX_MODE attribute to NIBTSG_VAL_DIRTY_TX_MODE_STANDARD.

The default value is 0.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Specifies the frequency deviation of the modulated signal to provide the additional frequency drift. This value is expressed in Hz.

error_code (int):

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_dirty_tx_symbol_timing_error_set(channel_string)

Gets the symbol timing error value of each of the impairment set that you enable in the DIRTY_TX_PARAMETERS_ENABLED_SET attribute.

This attribute is applicable with you set the DIRTY_TX_MODE attribute to NIBTSG_VAL_DIRTY_TX_MODE_USER_DEFINED. The BT Generation ignores this attribute if you set the DIRTY_TX_MODE attribute to NIBTSG_VAL_DIRTY_TX_MODE_STANDARD.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):

Specifies the symbol timing error value of each of the impairment set that you enable in the DIRTY_TX_PARAMETERS_ENABLED_SET attribute.

error_code (int):

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_dv_voice_payload_data_type(channel_string)

Gets the type of payload for the data voice (DV) packet.

The default value is NIBTSG_VAL_PAYLOAD_DATA_TYPE_PN_SEQUENCE.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.DVVoicePayloadDataType):

Specifies the type of payload for the data voice (DV) packet.

error_code (int):

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_dv_voice_payload_pn_order(channel_string)

Gets the order (length of memory) of the pseudorandom bit sequence (PRBS) generator. If you set the DV_VOICE_PAYLOAD_DATA_TYPE attribute to NIBTSG_VAL_PAYLOAD_DATA_TYPE_USER_DEFINED_BITS, the BT Generation ignores the DV_VOICE_PAYLOAD_PN_ORDER attribute.

The default value is 9. Valid values are 5 to 31, inclusive.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):

Specifies the order (length of memory) of the pseudorandom bit sequence (PRBS) generator. If you set the DV_VOICE_PAYLOAD_DATA_TYPE attribute to NIBTSG_VAL_PAYLOAD_DATA_TYPE_USER_DEFINED_BITS, the BT Generation ignores the DV_VOICE_PAYLOAD_PN_ORDER attribute.

error_code (int):

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_dv_voice_payload_pn_seed(channel_string)

Gets the initialization seed used for the pseudorandom bit sequence (PRBS) generator. If you set the DV_VOICE_PAYLOAD_DATA_TYPE attribute to NIBTSG_VAL_PAYLOAD_DATA_TYPE_USER_DEFINED_BITS, the BT Generation ignores the DV_VOICE_PAYLOAD_PN_SEED attribute.

The default value is 497.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):

Specifies the initialization seed used for the pseudorandom bit sequence (PRBS) generator. If you set the DV_VOICE_PAYLOAD_DATA_TYPE attribute to NIBTSG_VAL_PAYLOAD_DATA_TYPE_USER_DEFINED_BITS, the BT Generation ignores the DV_VOICE_PAYLOAD_PN_SEED attribute.

error_code (int):

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_dv_voice_payload_user_defined_bits(channel_string)

Gets a bit pattern as an array of zeros and ones.

If the array length is greater than the required payload length, the BT Generation uses a subset of the required length from the beginning of the array for waveform generation. If the array length is less than the required payload length, the BT Generation repeats the bit pattern until the required length is achieved. If you set the DV_VOICE_PAYLOAD_DATA_TYPE attribute to NIBTSG_VAL_PAYLOAD_DATA_TYPE_PN_SEQUENCE, the BT Generation ignores the DV_VOICE_PAYLOAD_USER_DEFINED_BITS attribute.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):

Specifies a bit pattern as an array of zeros and ones.

error_code (int):

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_error_string(error_code)

Gets the description of a driver error code.

Parameters:

error_code (int) – Specifies an error or warning code.

Returns:

Contains the error description.

Return type:

string

get_fhs_payload_bd_address_lap(channel_string)

Gets the 24-bit field in the frequency hop synchronization (FHS) packet payload. This field contains the lower address part (LAP) of the device that sends the FHS packet.

The default value is 0.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):

Specifies the 24-bit field in the frequency hop synchronization (FHS) packet payload. This field contains the lower address part (LAP) of the device that sends the FHS packet.

error_code (int):

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_fhs_payload_bd_address_nap(channel_string)

Gets the 16-bit field in the frequency hop synchronization (FHS) packet payload. This field contains the non-significant address part (NAP) of the device that sends the FHS packet. Refer to Section 6.5.1.4, Part B, Volume 2 of the Bluetooth Specification v2.1+EDR for more information about the NAP field.

The default value is 0.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):

Specifies the 16-bit field in the frequency hop synchronization (FHS) packet payload. This field contains the non-significant address part (NAP) of the device that sends the FHS packet. Refer to Section 6.5.1.4, Part B, Volume 2 of the Bluetooth Specification v2.1+EDR for more information about the NAP field.

error_code (int):

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_fhs_payload_bd_address_uap(channel_string)

Gets the 8-bit field in the frequency hop synchronization (FHS) packet payload. This field contains the upper address part (UAP) of the device that sends the FHS packet.

The default value is 0.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):

Specifies the 8-bit field in the frequency hop synchronization (FHS) packet payload. This field contains the upper address part (UAP) of the device that sends the FHS packet.

error_code (int):

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_fhs_payload_device_class(channel_string)

Gets the 24-bit field in the frequency hop synchronization (FHS) packet payload. This field indicates the class of device of the device that sends the FHS packet. Refer to Section 6.5.1.4, Part B, Volume 2 of the Bluetooth Specification v2.1+EDR for more information about the device class field in the FHS packet payload.

The default value is 0. Valid values are 0 to 0xFFFFFF, inclusive.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):

Specifies the 24-bit field in the frequency hop synchronization (FHS) packet payload. This field indicates the class of device of the device that sends the FHS packet. Refer to Section 6.5.1.4, Part B, Volume 2 of the Bluetooth Specification v2.1+EDR for more information about the device class field in the FHS packet payload.

error_code (int):

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_fhs_payload_device_clock(channel_string)

Gets the 26-bit field in the frequency hop synchronization (FHS) packet payload. This field contains the value of the native clock of the device that sends the FHS packet. Refer to Section 6.5.1.4, Part B, Volume 2 of the Bluetooth Specification v2.1+EDR for more information about the device clock field of the FHS packet payload.

The default value is 0.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):

Specifies the 26-bit field in the frequency hop synchronization (FHS) packet payload. This field contains the value of the native clock of the device that sends the FHS packet. Refer to Section 6.5.1.4, Part B, Volume 2 of the Bluetooth Specification v2.1+EDR for more information about the device clock field of the FHS packet payload.

error_code (int):

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_fhs_payload_lt_address(channel_string)

Gets the 3-bit logical transport (LT) address of the frequency hop synchronization (FHS) packet. Refer to Section 6.5.1.4, Part B, Volume 2 of the Bluetooth specification v2.1+EDR for more information about the LT address of the FHS packet.

The default value is 0. Valid values are 0 to 7, inclusive.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):

Specifies the 3-bit logical transport (LT) address of the frequency hop synchronization (FHS) packet. Refer to Section 6.5.1.4, Part B, Volume 2 of the Bluetooth specification v2.1+EDR for more information about the LT address of the FHS packet.

error_code (int):

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_fhs_payload_page_scan_mode(channel_string)

Gets the 3-bit field in the frequency hop synchronization (FHS) packet payload. This field indicates the default scan mode used by the sender of the FHS packet. Refer to Section 6.5.1.4, Part B, Volume 2 of the Bluetooth Specification v2.1+EDR for more information about the page scan mode field of the FHS packet payload.

The default value is 0. Valid values are 0 to 7, inclusive.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):

Specifies the 3-bit field in the frequency hop synchronization (FHS) packet payload. This field indicates the default scan mode used by the sender of the FHS packet. Refer to Section 6.5.1.4, Part B, Volume 2 of the Bluetooth Specification v2.1+EDR for more information about the page scan mode field of the FHS packet payload.

error_code (int):

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_fhs_payload_scan_repetition(channel_string)

Gets the 2-bit field in the frequency hop synchronization (FHS) packet payload. This field indicates the interval between two consecutive page scan windows. Refer to Section 6.5.1.4, Part B, Volume 2 of the Bluetooth specification v2.1+EDR for more information about the payload scan repetition field of the FHS packet payload.

The default value is 0. Valid values are 0 to 3, inclusive.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):

Specifies the 2-bit field in the frequency hop synchronization (FHS) packet payload. This field indicates the interval between two consecutive page scan windows. Refer to Section 6.5.1.4, Part B, Volume 2 of the Bluetooth specification v2.1+EDR for more information about the payload scan repetition field of the FHS packet payload.

error_code (int):

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_format1_payload_zone_configuration_mode(channel_string)

Gets the payload zone configuration mode for the LE-HDT packet when HDT_PACKET_FORMAT is set to NIBTSG_VAL_HDT_PACKET_FORMAT_FORMAT1 and FORMAT1_PAYLOAD_ZONE_CONFIGURATION_MODE is set to NIBTSG_VAL_FORMAT1_PAYLOAD_ZONE_CONFIGURATION_MODE_USER_DEFINED.

The default value is NIBTSG_VAL_FORMAT1_PAYLOAD_ZONE_CONFIGURATION_MODE_AUTO.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.Format1PayloadZoneConfigurationMode):

Specifies the payload zone configuration mode for the LE-HDT packet when HDT_PACKET_FORMAT is set to NIBTSG_VAL_HDT_PACKET_FORMAT_FORMAT1 and FORMAT1_PAYLOAD_ZONE_CONFIGURATION_MODE is set to NIBTSG_VAL_FORMAT1_PAYLOAD_ZONE_CONFIGURATION_MODE_USER_DEFINED.

error_code (int):

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_hdt_packet_format(channel_string)

Gets the Higher Data Throughput (HDT) packet format. This property is applicable only for LE HDT packet type. The default value is NIBTSG_VAL_HDT_PACKET_FORMAT_FORMAT0.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.HdtPacketFormat):

Specifies the Higher Data Throughput (HDT) packet format. This property is applicable only for LE HDT packet type. The default value is NIBTSG_VAL_HDT_PACKET_FORMAT_FORMAT0.

error_code (int):

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_hdt_phy_interval(channel_string)

Gets the physical layer intervals. This property is only valid for Format1 packet format. This value is expressed in seconds. The default value is 64us. Valid values are 64us, 128us, 192us and 256us.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Specifies the physical layer intervals. This property is only valid for Format1 packet format. This value is expressed in seconds. The default value is 64us. Valid values are 64us, 128us, 192us and 256us.

error_code (int):

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_headroom(channel_string)

Gets the value for the headroom. This value is expressed in dB. The BT Generation uses this attribute for scaling the waveform when you set the AUTO_HEADROOM_ENABLED attribute to NIBTSG_VAL_FALSE.

The default value is 0.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Specifies the value for the headroom. This value is expressed in dB. The BT Generation uses this attribute for scaling the waveform when you set the AUTO_HEADROOM_ENABLED attribute to NIBTSG_VAL_FALSE.

error_code (int):

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_i_dc_offset(channel_string)

Gets the value of the DC offset in the in-phase (I) signal as a percentage of the peak magnitude of the complex I/Q signal.

The default value is 0. Valid values are -100 to 100, inclusive.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Specifies the value of the DC offset in the in-phase (I) signal as a percentage of the peak magnitude of the complex I/Q signal.

error_code (int):

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_iq_gain_imbalance(channel_string)

Gets the ratio of the mean amplitude of the in-phase (I) signal to the mean amplitude of the quadrature-phase (Q) signal. This value is expressed in dB.

For more information on IQ gain imbalance equations, refer to the IQ Gain Imbalance topic in RFmx BT Generation Help.

The default value is 0. Valid values are -6 to 6, inclusive.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Specifies the ratio of the mean amplitude of the in-phase (I) signal to the mean amplitude of the quadrature-phase (Q) signal. This value is expressed in dB.

error_code (int):

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_iq_rate(channel_string)

Gets the sample rate for generation. This value is expressed in samples per second (S/s). The symbol rate of the Bluetooth signal is 1 megasymbol per second. The sample rate of the generated signal is the product of the symbol rate and the oversampling factor. The BT Generation uses an oversampling factor of 8.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Returns the sample rate for generation. This value is expressed in samples per second (S/s). The symbol rate of the Bluetooth signal is 1 megasymbol per second. The sample rate of the generated signal is the product of the symbol rate and the oversampling factor. The BT Generation uses an oversampling factor of 8.

error_code (int):

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_iq_waveform_size(channel_string)

Gets the size, in complex samples, for a packet as specified by the PACKET_TYPE attribute and the number of idle slots specified by the NUMBER_OF_IDLE_SLOTS attribute.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):

Returns the size, in complex samples, for a packet as specified by the PACKET_TYPE attribute and the number of idle slots specified by the NUMBER_OF_IDLE_SLOTS attribute.

error_code (int):

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_last_block_size(channel_string)

Gets the block size of the last block. This property is valid only for the LE-HDT packet when HDT_PACKET_FORMAT is set to NIBTSG_VAL_HDT_PACKET_FORMAT_FORMAT1 and FORMAT1_PAYLOAD_ZONE_CONFIGURATION_MODE is set to NIBTSG_VAL_FORMAT1_PAYLOAD_ZONE_CONFIGURATION_MODE_USER_DEFINED.

You must use “payload x” as the active channel string to configure this property.

The valid values are 1 to 8191. The default value is 526.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):

Specifies the block size of the last block. This property is valid only for the LE-HDT packet when HDT_PACKET_FORMAT is set to NIBTSG_VAL_HDT_PACKET_FORMAT_FORMAT1 and FORMAT1_PAYLOAD_ZONE_CONFIGURATION_MODE is set to NIBTSG_VAL_FORMAT1_PAYLOAD_ZONE_CONFIGURATION_MODE_USER_DEFINED.

error_code (int):

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_le_access_address(channel_string)

Gets the 32-bit LE access address.

The Bluetooth core specification recommends to use 0x71764129 as the LE access address for all test packets. The preamble of LE-TP/LE-TP-EXT packets is either 01010101b or 10101010b, depending on the LSB of the LE access address. If the LSB of the LE access address is 1, the preamble shall be 01010101b, otherwise the preamble shall be 10101010b. This will be 0101010101010101b, 1010101010101010b respectively for LE-Enhanced packets.

The default value is 0x71764129.

Note: This attribute is applicable for LE packets.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):

Specifies the 32-bit LE access address.

error_code (int):

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_le_tp_corrupt_alternate_crc(channel_string)

Gets whether the BT Generation intentionally corrupts the cyclic redundancy check (CRC) portion of every alternate packet generated. Refer to Section 6.3.7 of the Bluetooth Low Energy RF PHY Test Specification 4.0.0. CRC corruption is done by toggling the seed used for CRC computation.

The default value is NIBTSG_VAL_FALSE.

Note: This attribute is applicable for LE packets.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.LETPCorruptAlternateCrc):

Specifies whether the BT Generation intentionally corrupts the cyclic redundancy check (CRC) portion of every alternate packet generated. Refer to Section 6.3.7 of the Bluetooth Low Energy RF PHY Test Specification 4.0.0. CRC corruption is done by toggling the seed used for CRC computation.

error_code (int):

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_le_tp_payload_type(channel_string)

Gets the type of payload for the LE and LE CS packets.

The default value is NIBTSG_VAL_LE_TP_PAYLOAD_TYPE_PRBS9.

Note: This attribute is applicable for LE and LE CS packets.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.LETPPayloadType):

Specifies the type of payload for the LE and LE CS packets.

error_code (int):

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_maximum_hardware_iq_rate(channel_string)

Gets the maximum I/Q rate that the NI RF vector signal generator supports.

This property will be set according to the device model in the rfsg_create_and_download_waveform() function.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Specifies the maximum I/Q rate that the NI RF vector signal generator supports.

error_code (int):

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_modulation_index(channel_string)

Gets the modulation index value for the Gaussian frequency shift keying modulation in Bluetooth packets.

Valid values are 0 to 1, excluding 0. The default value is -1. NI recommends you to set the value of this attribute to 0.32 for BR and EDR packets and 0.5 for LE packets.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Specifies the modulation index value for the Gaussian frequency shift keying modulation in Bluetooth packets.

error_code (int):

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_number_of_block_repetition_sequences(channel_string)

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):

error_code (int):

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_number_of_blocks(channel_string)

Gets the number of blocks minus one that the payload is split into.This property is valid only for the LE-HDT packet when HDT_PACKET_FORMAT is set to NIBTSG_VAL_HDT_PACKET_FORMAT_FORMAT1 and FORMAT1_PAYLOAD_ZONE_CONFIGURATION_MODE is set to NIBTSG_VAL_FORMAT1_PAYLOAD_ZONE_CONFIGURATION_MODE_USER_DEFINED.

You must use “payload x” as the active channel string to configure this property.

The default value is 15.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):

Specifies the number of blocks minus one that the payload is split into.This property is valid only for the LE-HDT packet when HDT_PACKET_FORMAT is set to NIBTSG_VAL_HDT_PACKET_FORMAT_FORMAT1 and FORMAT1_PAYLOAD_ZONE_CONFIGURATION_MODE is set to NIBTSG_VAL_FORMAT1_PAYLOAD_ZONE_CONFIGURATION_MODE_USER_DEFINED.

error_code (int):

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_number_of_idle_slots(channel_string)

Gets the number of idle slots that the BT Generation appends at the end of each valid packet.

The default value is 0.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):

Specifies the number of idle slots that the BT Generation appends at the end of each valid packet.

error_code (int):

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_number_of_payloads(channel_string)

Gets the number of payloads for the LE-HDT packet when HDT_PACKET_FORMAT is set to NIBTSG_VAL_HDT_PACKET_FORMAT_FORMAT1. The valid values are 1 to 4.

The default value is 1.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):

Specifies the number of payloads for the LE-HDT packet when HDT_PACKET_FORMAT is set to NIBTSG_VAL_HDT_PACKET_FORMAT_FORMAT1. The valid values are 1 to 4.

error_code (int):

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_number_of_unique_packets(channel_string)

Gets the number of unique packets for which the pseudonoise (PN) generator must run continuously. The BT Generation resets the PN generator after it reaches the number of packets that you specify in this attribute. For example, if you set this attribute to 1, the same payload is used for each packet, and if you set this attribute to 2, the same payload is used after every 2 packets. Configure this attribute only if you set the PAYLOAD_DATA_TYPE attribute to NIBTSG_VAL_PAYLOAD_DATA_TYPE_PN_SEQUENCE.

The value of this attribute must be the same as the value of the NIBTSG_BER_NUMBER_OF_UNIQUE_PACKETS attribute. Refer to Dirty Transmitter topic for details of the restrictions on the value of the NUMBER_OF_UNIQUE_PACKETS attribute.

The default value is 1.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):

Specifies the number of unique packets for which the pseudonoise (PN) generator must run continuously. The BT Generation resets the PN generator after it reaches the number of packets that you specify in this attribute. For example, if you set this attribute to 1, the same payload is used for each packet, and if you set this attribute to 2, the same payload is used after every 2 packets. Configure this attribute only if you set the PAYLOAD_DATA_TYPE attribute to NIBTSG_VAL_PAYLOAD_DATA_TYPE_PN_SEQUENCE.

error_code (int):

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_oversampling_factor(channel_string)

Gets the number of times the Nyquist sample rate is increased to obtain the final sample rate of a signal.

The default value is 8.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):

Specifies the number of times the Nyquist sample rate is increased to obtain the final sample rate of a signal.

error_code (int):

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_packet_bit_sequence_trace_enabled(channel_string)

Gets whether to enable the packet bit sequence trace.

The default value is NIBTSG_VAL_FALSE.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.PacketBitSequenceTraceEnabled):

Specifies whether to enable the packet bit sequence trace.

error_code (int):

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_packet_header_arqn(channel_string)

Gets the value for the automatic repeat request number (ARQN) field in the packet header. This attribute controls the value for the 1-bit acknowledgement indicator, which indicates whether the data packet transfer is successful. Refer to sections 6.4.4 and 7.6, Part B, Volume 2 of the Bluetooth Specification v2.1+EDR for more information about the ARQN field.

The default value is NIBTSG_VAL_PACKET_HEADER_ARQN_NAK.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.PacketHeaderArqn):

Specifies the value for the automatic repeat request number (ARQN) field in the packet header. This attribute controls the value for the 1-bit acknowledgement indicator, which indicates whether the data packet transfer is successful. Refer to sections 6.4.4 and 7.6, Part B, Volume 2 of the Bluetooth Specification v2.1+EDR for more information about the ARQN field.

error_code (int):

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_packet_header_flow(channel_string)

Gets the value for the flow control field in the packet header. This field controls the 1-bit flow control parameter in the packet. Refer to Section 6.4.3, Part B, Volume 2 of the Bluetooth Specification v2.1+EDR for more information about the flow control field.

The default value is 0. Valid values are 0, which indicates a Stop condition, and 1, which indicates a Go condition.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):

Specifies the value for the flow control field in the packet header. This field controls the 1-bit flow control parameter in the packet. Refer to Section 6.4.3, Part B, Volume 2 of the Bluetooth Specification v2.1+EDR for more information about the flow control field.

error_code (int):

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_packet_header_lt_address(channel_string)

Gets the 3-bit logical transport (LT) address of the packet. The LT address field indicates the destination slave for a packet in a master-to-slave transmission slot and indicates the source slave for a slave-to-master transmission slot. Refer to sections 6.4.1 and 6.4.2, Part B, Volume 2 of the Bluetooth Specification v2.1+EDR for more information about the LT address of a packet.

The default value is 0. Valid values are 0 to 7, inclusive.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):

Specifies the 3-bit logical transport (LT) address of the packet. The LT address field indicates the destination slave for a packet in a master-to-slave transmission slot and indicates the source slave for a slave-to-master transmission slot. Refer to sections 6.4.1 and 6.4.2, Part B, Volume 2 of the Bluetooth Specification v2.1+EDR for more information about the LT address of a packet.

error_code (int):

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_packet_header_seqn(channel_string)

Gets the value for the sequential numbering scheme (SEQN) field in the packet header. This attribute controls the value for the 1-bit sequence bit, which allows you to provide a sequential numbering scheme to order the data packet scheme. Refer to sections 6.4.5, 7.6.2, and 7.6.5, Part B, Volume 2 of the Bluetooth Specification v2.1+EDR for more information about the SEQN field.

The default value is 0. Valid values are 0 and 1.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):

Specifies the value for the sequential numbering scheme (SEQN) field in the packet header. This attribute controls the value for the 1-bit sequence bit, which allows you to provide a sequential numbering scheme to order the data packet scheme. Refer to sections 6.4.5, 7.6.2, and 7.6.5, Part B, Volume 2 of the Bluetooth Specification v2.1+EDR for more information about the SEQN field.

error_code (int):

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_packet_type(channel_string)

Gets the Bluetooth packet type.

The default value is NIBTSG_VAL_PACKET_TYPE_DH1.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.PacketType):

Specifies the Bluetooth packet type.

error_code (int):

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_payload_crc_seed(channel_string)

Gets the 32 bit CRC initialization seed value. This property is applicable only when user set the Packet Type to LE-HDT and HDT_PACKET_FORMAT is set to NIBTSG_VAL_HDT_PACKET_FORMAT_FORMAT0 or NIBTSG_VAL_HDT_PACKET_FORMAT_FORMAT1.

The default value is 0x00000000. The valid values are 0x00000000 to 0xFFFFFFFF.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):

Specifies the 32 bit CRC initialization seed value. This property is applicable only when user set the Packet Type to LE-HDT and HDT_PACKET_FORMAT is set to NIBTSG_VAL_HDT_PACKET_FORMAT_FORMAT0 or NIBTSG_VAL_HDT_PACKET_FORMAT_FORMAT1.

error_code (int):

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_payload_data_type(channel_string)

Gets the type of payload for the packet.

The default value is NIBTSG_VAL_PAYLOAD_DATA_TYPE_PN_SEQUENCE.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.PayloadDataType):

Specifies the type of payload for the packet.

error_code (int):

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_payload_header_enabled(channel_string)

Gets whether to enable payload header in the Bluetooth packet to be generated. This is applicable only for LE packets.

For generating custom Bluetooth packets, set the value of this property to NIBTSG_VAL_FALSE. In this case, the header bits can be given as input to the PAYLOAD_USER_DEFINED_BITS property along with the payload bits. The default value is NIBTSG_VAL_TRUE.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.PayloadHeaderEnabled):

Specifies whether to enable payload header in the Bluetooth packet to be generated. This is applicable only for LE packets.

error_code (int):

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_payload_header_flow(channel_string)

Gets the value for the flow control bit in the payload header. This field controls the 1-bit flow control parameter in the packet.

The default value is 0. Valid values are 0, which indicates a Stop condition, and 1, which indicates a Go condition.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):

Specifies the value for the flow control bit in the payload header. This field controls the 1-bit flow control parameter in the packet.

error_code (int):

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_payload_header_llid(channel_string)

Gets whether the payload is the start or continuation fragment of a logical link control and adaptation protocol (L2CAP) or link management protocol (LMP) message.

You must use “payload x” as the active channel string to configure this property for the LE-HDT packet when HDT_PACKET_FORMAT is set to NIBTSG_VAL_HDT_PACKET_FORMAT_FORMAT1 and FORMAT1_PAYLOAD_ZONE_CONFIGURATION_MODE is set to NIBTSG_VAL_FORMAT1_PAYLOAD_ZONE_CONFIGURATION_MODE_USER_DEFINED.

The default value is 0. Valid values are 0, 1, 2, and 3.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):

Specifies whether the payload is the start or continuation fragment of a logical link control and adaptation protocol (L2CAP) or link management protocol (LMP) message.

error_code (int):

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_payload_length(channel_string)

Gets the payload length, in bytes. If the length exceeds the maximum permissible length mentioned in the Bluetooth specification, the BT Generation uses this maximum permissible length as the payload length. For LE-TP-EXT and LE-Enhanced packet types, typical LE packet is generated length up to 255 bytes, and Hyper Length LE packet is generated for length from 256 bytes to 8191 bytes. For LE HDT packet, Format0 supports payload length up to 510 bytes, whereas Format1 supports up to 8191 bytes per payload. In the case of LE HDT Format1, when the Payload Zone Configuration Mode is set to Auto and the Payload Length Mode is set to User Defined, you must specify “payload x” as the active channel string to configure this property.

The default value is 0.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):

Specifies the payload length, in bytes. If the length exceeds the maximum permissible length mentioned in the Bluetooth specification, the BT Generation uses this maximum permissible length as the payload length. For LE-TP-EXT and LE-Enhanced packet types, typical LE packet is generated length up to 255 bytes, and Hyper Length LE packet is generated for length from 256 bytes to 8191 bytes. For LE HDT packet, Format0 supports payload length up to 510 bytes, whereas Format1 supports up to 8191 bytes per payload. In the case of LE HDT Format1, when the Payload Zone Configuration Mode is set to Auto and the Payload Length Mode is set to User Defined, you must specify “payload x” as the active channel string to configure this property.

error_code (int):

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_payload_length_mode(channel_string)

Gets whether the BT Generation automatically sets the value of the LENGTH field in the payload header to the maximum permissible length or whether it uses the value that you specify in the PAYLOAD_LENGTH attribute.

The default value is NIBTSG_VAL_PAYLOAD_LENGTH_MODE_MAXIMUM_LENGTH.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.PayloadLengthMode):

Specifies whether the BT Generation automatically sets the value of the LENGTH field in the payload header to the maximum permissible length or whether it uses the value that you specify in the PAYLOAD_LENGTH attribute.

error_code (int):

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_payload_pn_order(channel_string)

Gets the order (length of memory) of the pseudorandom bit sequence (PRBS) generator. If you set the PAYLOAD_DATA_TYPE attribute to NIBTSG_VAL_PAYLOAD_DATA_TYPE_USER_DEFINED_BITS, the BT Generation ignores the PAYLOAD_PN_ORDER attribute.

The default value is 9. Valid values are 5 to 31, inclusive.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):

Specifies the order (length of memory) of the pseudorandom bit sequence (PRBS) generator. If you set the PAYLOAD_DATA_TYPE attribute to NIBTSG_VAL_PAYLOAD_DATA_TYPE_USER_DEFINED_BITS, the BT Generation ignores the PAYLOAD_PN_ORDER attribute.

error_code (int):

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_payload_pn_seed(channel_string)

Gets the initialization seed used for the pseudorandom bit sequence (PRBS) generator. If you set the PAYLOAD_DATA_TYPE attribute to NIBTSG_VAL_PAYLOAD_DATA_TYPE_USER_DEFINED_BITS, the BT Generation ignores the PAYLOAD_PN_SEED attribute.

The default value is 497.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):

Specifies the initialization seed used for the pseudorandom bit sequence (PRBS) generator. If you set the PAYLOAD_DATA_TYPE attribute to NIBTSG_VAL_PAYLOAD_DATA_TYPE_USER_DEFINED_BITS, the BT Generation ignores the PAYLOAD_PN_SEED attribute.

error_code (int):

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_payload_user_defined_bits(channel_string)

Gets a bit pattern as an array of zeros and ones.

If the array length is greater than the required payload length, the BT Generation uses a subset of the required length from the beginning of the array for waveform generation. If the array length is less than the required payload length, the BT Generation repeats the bit pattern until the required length is achieved. If you set the PAYLOAD_DATA_TYPE attribute to NIBTSG_VAL_PAYLOAD_DATA_TYPE_PN_SEQUENCE, the BT Generation ignores the PAYLOAD_USER_DEFINED_BITS attribute.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):

Specifies a bit pattern as an array of zeros and ones.

error_code (int):

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_payload_zone_length(channel_string)

Gets the payload zone length of LE-HDT packets. The payload zone length has all payloads and each payload contains blocks followed by CRCs.

This property is valid only for the LE-HDT packet.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):

Returns the payload zone length of LE-HDT packets. The payload zone length has all payloads and each payload contains blocks followed by CRCs.

error_code (int):

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_physical_channel_address(channel_string)

Gets the 40-bit physical channel address of Higher Data Throughput (HDT) packet. The default value is 0x9F15555555.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):

Specifies the 40-bit physical channel address of Higher Data Throughput (HDT) packet. The default value is 0x9F15555555.

error_code (int):

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_power_ramp_settling_time(channel_string)

Gets the settling time of the burst. The settling time is the time interval from the time when output power is 40 dB less than the final output power to the time when the output power is ±1 dB of the final output power. This value is expressed in seconds.

The default value is 4 microseconds. Valid values are from 1 microseconds to 20 microseconds, inclusive.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Specifies the settling time of the burst. The settling time is the time interval from the time when output power is 40 dB less than the final output power to the time when the output power is ±1 dB of the final output power. This value is expressed in seconds.

error_code (int):

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_power_ramp_time(channel_string)

Gets the ramp time of the burst. The settling time is the time interval from the time when output power (X dBm) is 40 dB less than the final output power to the time when the output power is ±1 dB of the final output power. This value is expressed in seconds. The default value is 2 microseconds. Valid values are from 1 microseconds to 10 microseconds, inclusive.

Note: The value of ramp time should not exceed the value of settling time.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Specifies the ramp time of the burst. The settling time is the time interval from the time when output power (X dBm) is 40 dB less than the final output power to the time when the output power is ±1 dB of the final output power. This value is expressed in seconds. The default value is 2 microseconds. Valid values are from 1 microseconds to 10 microseconds, inclusive.

error_code (int):

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_q_dc_offset(channel_string)

Gets the value of the DC offset in the quadrature-phase (Q) signal as percentage of the peak magnitude of the complex I/Q signal.

The default value is 0. Valid values are -100 to 100, inclusive.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Specifies the value of the DC offset in the quadrature-phase (Q) signal as percentage of the peak magnitude of the complex I/Q signal.

error_code (int):

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_quadrature_skew(channel_string)

Gets the deviation in angle from 90 degrees between the in-phase (I) and quadrature-phase (Q) signals.

For more information on quadrature skew equations, refer to the IQ Gain Imbalance topic RFmx BT Generation Help.

The default value is 0. Valid values are -30 to 30, inclusive.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Specifies the deviation in angle from 90 degrees between the in-phase (I) and quadrature-phase (Q) signals.

error_code (int):

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_run_time_scaling(channel_string)

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

error_code (int):

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_sample_clock_offset(channel_string)

Gets the offset in the Sample Clock frequency from the sample frequency for CS packets. This value is expressed in parts per million (ppm).

The default value is 0.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Specifies the offset in the Sample Clock frequency from the sample frequency for CS packets. This value is expressed in parts per million (ppm).

error_code (int):

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_sounding_sequence_length(channel_string)

Gets sounding sequence length, in bits. This property is applicable only when you set the CS SYNC Sequence to Sounding Sequence. The default value is 32. Valid values are 32 and 96.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):

Specifies sounding sequence length, in bits. This property is applicable only when you set the CS SYNC Sequence to Sounding Sequence. The default value is 32. Valid values are 32 and 96.

error_code (int):

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_sounding_sequence_marker_positions(channel_string)

Gets an array of sounding sequence marker positions at which sounding sequence marker signals are inserted. This property is applicable only when you set the CS SYNC Sequence to Sounding Sequence. When sounding sequence length property is set to 32, only the first element from the sounding sequence marker positions array is considered, and remaining elements are discarded. Valid values are from 0 to 28. When sounding sequence length property is set to 96, up to the first two elements from sounding sequence marker positions array are considered and remaining elements are discarded. Valid values for array index 0 are from 0 to 63 and for array index 1 are from 67 to 92. The default value is 0.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):

Specifies an array of sounding sequence marker positions at which sounding sequence marker signals are inserted. This property is applicable only when you set the CS SYNC Sequence to Sounding Sequence. When sounding sequence length property is set to 32, only the first element from the sounding sequence marker positions array is considered, and remaining elements are discarded. Valid values are from 0 to 28. When sounding sequence length property is set to 96, up to the first two elements from sounding sequence marker positions array are considered and remaining elements are discarded. Valid values for array index 0 are from 0 to 63 and for array index 1 are from 67 to 92. The default value is 0.

error_code (int):

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_sounding_sequence_marker_signals(channel_string)

Gets an array of sounding sequence marker signals. This property is applicable only when you set the CS SYNC Sequence to Sounding Sequence. When sounding sequence length property is set to 32, only the first element shall be inserted in the sounding sequence, and remaining elements shall be discarded. When sounding sequence length property is set to 96, up to the first two elements shall be inserted in the sounding sequence, and remaining elements shall be discarded. The default value is NIBTSG_VAL_SOUNDING_SEQUENCE_MARKER_SIGNALS_1100.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.SoundingSequenceMarkerSignals):

Specifies an array of sounding sequence marker signals. This property is applicable only when you set the CS SYNC Sequence to Sounding Sequence. When sounding sequence length property is set to 32, only the first element shall be inserted in the sounding sequence, and remaining elements shall be discarded. When sounding sequence length property is set to 96, up to the first two elements shall be inserted in the sounding sequence, and remaining elements shall be discarded. The default value is NIBTSG_VAL_SOUNDING_SEQUENCE_MARKER_SIGNALS_1100.

error_code (int):

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_time_delay(channel_string)

Gets the time delay for CS packets This value is expressed in seconds.

The default value is 0.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Specifies the time delay for CS packets This value is expressed in seconds.

error_code (int):

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_toolkit_compatibility_version(channel_string)

Indicates the version of the BT Generation to which the current version of the BT Generation is compatible.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.CompatibilityVersion):

Indicates the version of the BT Generation to which the current version of the BT Generation is compatible.

error_code (int):

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_txblock_map(channel_string)

Gets the TxBlockMap field of Tx Portion of PDU Header. The TxBlockMap field is 8 or 16 bits depending on the value of TXLEN_SEQUENCE_NUMBER. It indicates which blocks are actually being transmitted in the packet, with bit b set to 1 if block b (counting from 0) is included and 0 if it is not. At least one bit shall be set. This property is valid only for the LE-HDT packet when HDT_PACKET_FORMAT is set to NIBTSG_VAL_HDT_PACKET_FORMAT_FORMAT1 and FORMAT1_PAYLOAD_ZONE_CONFIGURATION_MODE is set to NIBTSG_VAL_FORMAT1_PAYLOAD_ZONE_CONFIGURATION_MODE_USER_DEFINED.

You must use “payload x” as the active channel string to configure this property.

The valid values are 1 to 0xFFFF. The default value is 0xFFFF.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):

Specifies the TxBlockMap field of Tx Portion of PDU Header. The TxBlockMap field is 8 or 16 bits depending on the value of TXLEN_SEQUENCE_NUMBER. It indicates which blocks are actually being transmitted in the packet, with bit b set to 1 if block b (counting from 0) is included and 0 if it is not. At least one bit shall be set. This property is valid only for the LE-HDT packet when HDT_PACKET_FORMAT is set to NIBTSG_VAL_HDT_PACKET_FORMAT_FORMAT1 and FORMAT1_PAYLOAD_ZONE_CONFIGURATION_MODE is set to NIBTSG_VAL_FORMAT1_PAYLOAD_ZONE_CONFIGURATION_MODE_USER_DEFINED.

error_code (int):

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_txlen_sequence_number(channel_string)

Gets the value of TxLen SN field of Tx Portion of PDU Header. This property is valid only for the LE-HDT packet when HDT_PACKET_FORMAT is set to NIBTSG_VAL_HDT_PACKET_FORMAT_FORMAT1 and FORMAT1_PAYLOAD_ZONE_CONFIGURATION_MODE is set to NIBTSG_VAL_FORMAT1_PAYLOAD_ZONE_CONFIGURATION_MODE_USER_DEFINED.

You must use “payload x” as the active channel string to configure this property.

The default value is NIBTSG_VAL_TXLEN_SEQUENCE_NUMBER_11.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.TxlenSequenceNumber):

Specifies the value of TxLen SN field of Tx Portion of PDU Header. This property is valid only for the LE-HDT packet when HDT_PACKET_FORMAT is set to NIBTSG_VAL_HDT_PACKET_FORMAT_FORMAT1 and FORMAT1_PAYLOAD_ZONE_CONFIGURATION_MODE is set to NIBTSG_VAL_FORMAT1_PAYLOAD_ZONE_CONFIGURATION_MODE_USER_DEFINED.

error_code (int):

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_vhdt_mode_enabled(channel_string)

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):

error_code (int):

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_waveform_file_version(channel_string)

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.WaveformFileVersion):

error_code (int):

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_whitening_clock(channel_string)

Gets the 28-bit master Bluetooth device clock. This attribute is applicable only to BR and EDR packets. The BT Generation uses this attribute to initialize the linear feedback shift register used for calculating the whitening word. The BT Generation uses bits 1 to 6 for this purpose. Refer to sections 1.1 and 7.2, Part B, Volume 2 of the Bluetooth Specification v2.1+EDR for more information about the Bluetooth device clock.

The default value is 0.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):

Specifies the 28-bit master Bluetooth device clock. This attribute is applicable only to BR and EDR packets. The BT Generation uses this attribute to initialize the linear feedback shift register used for calculating the whitening word. The BT Generation uses bits 1 to 6 for this purpose. Refer to sections 1.1 and 7.2, Part B, Volume 2 of the Bluetooth Specification v2.1+EDR for more information about the Bluetooth device clock.

error_code (int):

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_whitening_enabled(channel_string)

Gets whether to enable the whitening settings.

The default value is NIBTSG_VAL_FALSE.

If you set this attribute to NIBTSG_VAL_TRUE and the PACKET_TYPE attribute to any LE packets, you should set a value for the CARRIER_FREQUENCY attribute.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.WhiteningEnabled):

Specifies whether to enable the whitening settings.

error_code (int):

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_zadoff_chu_index(channel_string)

Gets Zadoff-Chu Index for the Long Training Sequence in the preamble. The default value is 7. Valid values are in the range of [1 - 16].

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):

Specifies Zadoff-Chu Index for the Long Training Sequence in the preamble. The default value is 7. Valid values are in the range of [1 - 16].

error_code (int):

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

load_configuration_from_file(file_path, reset)

Reads values of session attributes (configuration) saved in a file and sets these values to the corresponding attributes on the session, thus restoring the state of the BT Generation to the original state when the file was saved.

Parameters:

• file_path (string) – Specifies the absolute path to the file from which the BT Generation loads the configuration.

• reset (bool) – Specifies whether BT Generation must reset all the attributes of the session to their default values before setting the new values specified in the file. The default value is NIBTSG_VAL_TRUE.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

read_waveform_from_file(file_path, waveform_name, offset, count, waveform)

Reads a waveform from a TDMS file. You can save this file using the Generation Interactive Example for Bluetooth. The read_waveform_from_file() function returns the I/Q complex waveform data that you can subsequently download to an RF signal generator device.

In addition to the I/Q complex waveform data, the Generation Interactive Example for Bluetooth also saves the HEADROOM and IQ_RATE attributes of the waveform to the file. Use the read_waveform_from_file() function or TDMS file attributes in your programming environment to read the values of these attributes. The NI_RF_IQRate and NI_RF_Headroom attributes are located in the following locations within the TDMS file.

Attribute Name	Datatype	Group Name	Channel Name
NI_RF_IQRate	float64	waveforms	niBT SG Waveform
NI_RF_Headroom	float64	waveforms	niBT SG Waveform

Parameters:

• file_path (string) – Specifies the complete path to the TDMS file from which the BT Generation reads the waveform.

• waveform_name (string) – Specifies the name of the waveform to read from the file.

• offset (int) – Specifies the number of samples into the waveform at which the function begins reading the I/Q data. The default value is 0. If you set count to 1,000 and offset to 2, the function returns 1,000 samples, starting from index 2 and ending at index 1,002.

• count (int) – Specifies the maximum number of samples of the I/Q complex waveform to read from the file. The default value is -1, which returns all samples. If you set count to 1,000 and offset to 2, the function returns 1,000 samples, starting from index 2 and ending at index 1,002.

• waveform (numpy.complex128) – Returns the array of baseband complex I/Q samples.

Returns:

t0 (float):

Returns the starting time, in seconds.

dt (float):

Returns the time interval between baseband I/Q samples, in seconds.

iq_rate (float):

Returns the I/Q rate, in samples per second (S/s), of the waveform.

headroom (float):

Returns the headroom of the waveform. This value is expressed in dB.

eof (bool):

Indicates whether the end of file has been reached with this read.

error_code (int):

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (t0, dt, iq_rate, headroom, eof, error_code)

reset_attribute(channel_string, attribute_id)

Resets the attribute specified in the attribute_id parameter to its default value. You can reset only a writable attribute using this function.

Parameters:

• channel_string (string) – Set this parameter to “” (empty string) or NULL.

• attribute_id (enums.AttributeID, int) – Specifies the ID of the niBT SG attribute that you want to reset.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

reset_session()

Resets all the attributes of the session to their default values.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

rfsg_clear_database(rfsg_session, channel_string, waveform_name)

Clears the attributes stored in the RFSG database and clears the waveforms from the NI RF vector signal generator memory.

This function clears the waveform and attributes of the waveform that you specify in the waveform_name parameter. If you set the waveform_name parameter to an empty string, this function clears all the waveforms and their attributes.

Parameters:

• rfsg_session (object) – Identifies the instrument session. You can obtain this parameter from the niRFSG_init function or the niRFSG_InitWithOptions function.

• channel_string (string) – Set this parameter to “” (empty string) or NULL.

• waveform_name (string) – Specifies the name of the waveform to clear. If you set this parameter as empty, the function clears all the waveforms and their attributes.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

rfsg_configure_script(rfsg_session, channel_string, script, power_level)

Configures the I/Q rate and power level of the waveforms that you specify in the script parameter. This function sets the NIRFSG_ATTR_IQ_RATE attribute to the I/Q rate in the RFSG database if the I/Q rates are the same for all the waveforms. The function sets the NIRFSG_ATTR_POWER_LEVEL attribute to the sum of the power level that you specify in the power_level parameter and the minimum headrooms of all the waveforms.

Parameters:

• rfsg_session (object) – Identifies the instrument session. You can obtain this parameter from the niRFSG_init function or the niRFSG_InitWithOptions function.

• channel_string (string) – Set this parameter to “” (empty string) or NULL.

• script (string) – Specifies the script that controls waveform generation. NI-RFSG supports multiple scripts that you can select using the NIRFSG_ATTR_SELECTED_SCRIPT attribute.

• power_level (float) – Specifies the power level. This value is expressed in dBm.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

rfsg_create_and_download_waveform(rfsg_session, channel_string, waveform_name)

Creates a waveform according to parameters that you specify, writes it into the NI RF vector signal generator memory, and stores the I/Q rate and headroom of the waveform in the n the RFSG database.

Parameters:

• rfsg_session (object) – Identifies the instrument session. You can obtain this parameter from the niRFSG_init function or the niRFSG_InitWithOptions function.

• channel_string (string) – Specifies the RFSG device channel. Set this parameter to “” (empty string) or NULL.

• waveform_name (string) – Specifies the name used to store the waveform. This string is case-insensitive, alphanumeric, and does not use reserved words.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

rfsg_retrieve_headroom(rfsg_session, channel_string, waveform_name)

Returns the headroom stored in the RFSG database. This value is expressed in dB. The function uses the waveform name as the key to retrieve the waveform attributes.

—- Note

---

Parameters:

• rfsg_session (object) – Identifies the instrument session. You can obtain this parameter from the niRFSG_init function or the niRFSG_InitWithOptions function.

• channel_string (string) – Set this parameter to “” (empty string) or NULL.

• waveform_name (string) – Specifies the name of the waveform for which you want to retrieve the headroom.

Returns:

headroom (float):

Returns the headroom stored in the RFSG database for the waveform that you specify in the waveform_name parameter. This value is expressed in dB.

error_code (int):

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (headroom, error_code)

rfsg_retrieve_iq_rate(rfsg_session, channel_string, waveform_name)

Returns the I/Q rate stored in the RFSG database. The function uses the waveform name as the key to retrieve the waveform attributes.

—- Note

---

Parameters:

• rfsg_session (object) – Identifies the instrument session. You can obtain this parameter from the niRFSG_init function or the niRFSG_InitWithOptions function.

• channel_string (string) – Set this parameter to “” (empty string) or NULL.

• waveform_name (string) – Specifies the name of the waveform for which you want to retrieve the I/Q rate. The BT Generation uses the waveform_name parameter as the key to retrieve the waveform attributes from the RFSG database.

Returns:

iq_rate (float):

Returns the I/Q rate stored in the RFSG database for the waveform that you specify in the waveform_name parameter.

error_code (int):

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (iq_rate, error_code)

rfsg_retrieve_iq_rate_all_waveforms(rfsg_session, channel_string, script)

Checks the I/Q rate of all the waveforms in the script that you specify in the script parameter. This function returns the I/Q rate if the I/Q rates are the same for all the waveforms. If the I/Q rates are different, the function returns an error.

Parameters:

• rfsg_session (object) – Identifies the instrument session. You can obtain this parameter from the niRFSG_init function or the niRFSG_InitWithOptions function.

• channel_string (string) – Set this parameter to “” (empty string) or NULL.

• script (string) – Specifies the RFSG script used to generate the signal. The function looks up the I/Q rate of all the waveforms contained in the script.

Returns:

iq_rate (float):

Returns the I/Q rate if the I/Q rates are the same for all the waveforms that you specify in the script parameter. If the I/Q rates are different, the function returns an error.

error_code (int):

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (iq_rate, error_code)

rfsg_retrieve_minimum_headroom_all_waveforms(rfsg_session, channel_string, script)

Looks up the headroom of all the waveforms contained in the script and returns the minimum of all these headrooms. This value is expressed in dB.

Parameters:

• rfsg_session (object) – Identifies the instrument session. You can obtain this parameter from the niRFSG_init function or the niRFSG_InitWithOptions function.

• channel_string (string) – Set this parameter to “” (empty string) or NULL.

• script (string) – Specifies the NI-RFSG script used to generate the signal.

Returns:

headroom (float):

Returns the minimum headroom of all the waveforms in the script that you specify in the script parameter. This value is expressed in dB.

error_code (int):

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (headroom, error_code)

rfsg_store_headroom(rfsg_session, channel_string, waveform_name, headroom)

Stores the headroom, which you specify in the headroom parameter, in the RFSG database.

Parameters:

• rfsg_session (object) – Identifies the instrument session. You can obtain this parameter from the niRFSG_init function or the niRFSG_InitWithOptions function.

• channel_string (string) – Set this parameter to “” (empty string) or NULL.

• waveform_name (string) – Specifies the name of the waveform for which you want to store the headroom. The BT Generation uses the waveform_name parameter as the key to store the waveform attributes in the RFSG database.

• headroom (float) – Specifies the headroom to store in the RFSG database. This value is expressed in dB.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

rfsg_store_iq_rate(rfsg_session, channel_string, waveform_name, iq_rate)

Stores the I/Q rate, which you specify in the iq_rate parameter, in the RFSG database.

Parameters:

• rfsg_session (object) – Identifies the instrument session. You can obtain this parameter from the niRFSG_init function or the niRFSG_InitWithOptions function.

• channel_string (string) – Set this parameter to “” (empty string) or NULL.

• waveform_name (string) – Specifies the name of the waveform for which you want to store the I/Q rate. The BT Generation uses the waveform_name parameter as the key to store the waveform attributes in the RFSG database.

• iq_rate (float) – Specifies the I/Q rate to store in the RFSG database.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

save_configuration_to_file(file_path, operation)

Saves attributes of the session, which you may have modified after opening the session, to a file located at the specified path.

You can use this function to save the current state of the BT Generation session to a file. You can later load the saved configuration using the load_configuration_from_file() function.

Parameters:

• file_path (string) – Specifies the absolute path to the TDMS file to which the BT Generation saves the configuration.

• operation (int) –

  Specifies the operation to perform on the file. The default value is NIBTSG_FILE_OPERATION_MODE_CREATEORREPLACE.

  NIBTSG_FILE_OPERATION_MODE_OPEN(0)	Opens an existing file to write the niBT SG session attribute values.
  NIBTSG_FILE_OPERATION_MODE_OPENORCREATE(1)	Opens an existing file or creates a new file if the file does not exist.
  NIBTSG_FILE_OPERATION_MODE_CREATEORREPLACE(2)	Creates a new file or replaces an existing file.
  NIBTSG_FILE_OPERATION_MODE_CREATE(3)	Creates a new file.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_all_iq_impairments_enabled(channel_string, value)

Sets whether to enable I/Q impairments.

The default value is NIBTSG_VAL_TRUE.

Parameters:

• selector_string (string) – Pass an empty string.

• value (enums.AllIQImpairmentsEnabled, int) – Specifies whether to enable I/Q impairments.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_antenna_relative_phase_and_amplitude(channel_string, relative_amplitude_db, relative_phase_deg)

Sets the Relative Phase and Relative Amplitude values for the non reference antennas An (1<n<=256) relative to the reference antenna A0 when you set the DIRECTION_FINDING_ANTENNA_SWITCHING_ENABLED attribute to NIBTSG_VAL_TRUE. The reference period and sampling slots in the constant tone extension (CTE) field are modulated in amplitude and phase as specified in the DIRECTION_FINDING_ANTENNA_SWITCHING_PATTERN attribute.

Parameters:

• channel_string (string) – Specifies the RFSG device channel. Set this parameter to “” (empty string) or NULL.

• relative_amplitude_db (float) – Specifies the array of amplitudes of each non-reference antenna An (1<n<=256) relative to the reference antenna A0. The first element of the array corresponds to the amplitude of antenna A1, the second element of the array corresponds to amplitude of antenna A2, and so on.

• relative_phase_deg (float) – Specifies the array of phases of each non-reference antenna An (1<n<=256) relative to the reference antenna A0. The first element of the array corresponds to the phase of antenna A1, the second element of the array corresponds to phase of antenna A2, and so on.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_auto_headroom_enabled(channel_string, value)

Sets whether the BT Generation calculates the headroom or uses the value that you specify in the HEADROOM attribute.

The default value is NIBTSG_VAL_TRUE.

Parameters:

• selector_string (string) – Pass an empty string.

• value (enums.AutoHeadroomEnabled, int) – Specifies whether the BT Generation calculates the headroom or uses the value that you specify in the HEADROOM attribute.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_awgn_enabled(channel_string, value)

Sets whether to add additive white Gaussian noise (AWGN) to the baseband waveform.

The default value is NIBTSG_VAL_FALSE.

Parameters:

• selector_string (string) – Pass an empty string.

• value (enums.AwgnEnabled, int) – Specifies whether to add additive white Gaussian noise (AWGN) to the baseband waveform.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_bandwidth_bit_period_product(channel_string, value)

Sets the bandwidth bit period product of GFSK modulation for LE-CS packet type.

The default value is 0.5. The valid values are 0.5 and 2.0 .

Parameters:

• selector_string (string) – Pass an empty string.

• value (float) – Specifies the bandwidth bit period product of GFSK modulation for LE-CS packet type.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_bd_address_lap(channel_string, value)

Sets the 24-bit lower address part (LAP) of the Bluetooth device address.

The default value is 0.

Parameters:

• selector_string (string) – Pass an empty string.

• value (int) – Specifies the 24-bit lower address part (LAP) of the Bluetooth device address.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_bd_address_nap(channel_string, value)

Sets the 16-bit nonsignificant address part (NAP) of the Bluetooth device address.

The default value is 0.

Parameters:

• selector_string (string) – Pass an empty string.

• value (int) – Specifies the 16-bit nonsignificant address part (NAP) of the Bluetooth device address.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_bd_address_uap(channel_string, value)

Sets the 8-bit upper address part (UAP) of the Bluetooth device address.

The default value is 0.

Parameters:

• selector_string (string) – Pass an empty string.

• value (int) – Specifies the 8-bit upper address part (UAP) of the Bluetooth device address.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_block_size(channel_string, value)

Sets the block size of each block specified by NUMBER_OF_BLOCKS.This property is valid only for the LE-HDT packet when HDT_PACKET_FORMAT is set to NIBTSG_VAL_HDT_PACKET_FORMAT_FORMAT1 and FORMAT1_PAYLOAD_ZONE_CONFIGURATION_MODE is set to NIBTSG_VAL_FORMAT1_PAYLOAD_ZONE_CONFIGURATION_MODE_USER_DEFINED.

You must use “payload x” as the active channel string to configure this property.

The valid values are 32 to 511. The default value is 511.

Parameters:

• selector_string (string) – Pass an empty string.

• value (int) – Specifies the block size of each block specified by NUMBER_OF_BLOCKS.This property is valid only for the LE-HDT packet when HDT_PACKET_FORMAT is set to NIBTSG_VAL_HDT_PACKET_FORMAT_FORMAT1 and FORMAT1_PAYLOAD_ZONE_CONFIGURATION_MODE is set to NIBTSG_VAL_FORMAT1_PAYLOAD_ZONE_CONFIGURATION_MODE_USER_DEFINED.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_carrier_frequency(channel_string, value)

Sets the carrier frequency. This value is expressed in Hz.

If you set the WHITENING_ENABLED attribute to NIBTSG_VAL_TRUE and the PACKET_TYPE attribute to any LE packets, you should set a value for the CARRIER_FREQUENCY attribute.

Parameters:

• selector_string (string) – Pass an empty string.

• value (float) – Specifies the carrier frequency. This value is expressed in Hz.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_carrier_frequency_offset(channel_string, value)

Sets the carrier frequency offset from the value that you specify as the center frequency of the RF signal generator. This value is expressed in Hz.

The default value is 0.

Parameters:

• selector_string (string) – Pass an empty string.

• value (float) – Specifies the carrier frequency offset from the value that you specify as the center frequency of the RF signal generator. This value is expressed in Hz.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_carrier_mode(channel_string, value)

Sets whether the carrier is continuous or includes bursts.

If you set this attribute to NIBTSG_VAL_CARRIER_MODE_BURST, the BT Generation generates the burst signal by adding zeros at the end of the packet to create one or more complete slots, depending on the packet type. In this mode, the BT Generation also shapes the generated waveform to meet the burst ramp characteristics specified in the Bluetooth Test Purposes (TP) specification 1.2/2.0+EDR/2.1/2.1+EDR/3.0/3.0+HS. If you set this attribute to NIBTSG_VAL_CARRIER_MODE_CONTINUOUS, the BT Generation generates a phase continuous Bluetooth signal, which is used as an interference signal. This mode is useful to generate an interference signal with pseudorandom bits and continuous phase. In this mode, the NUMBER_OF_IDLE_SLOTS attribute is not used, and the number of idle slots is assumed be zero. In this mode, NI recommends you to leave the NUMBER_OF_UNIQUE_PACKETS, PAYLOAD_DATA_TYPE, and DIRTY_TX_ENABLED attributes at their default values. Refer to the Carrier Mode topic for more information about the CARRIER_MODE attribute.

The default value is NIBTSG_VAL_CARRIER_MODE_BURST.

Parameters:

• selector_string (string) – Pass an empty string.

• value (enums.CarrierMode, int) – Specifies whether the carrier is continuous or includes bursts.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_carrier_to_noise_ratio(channel_string, value)

Sets the carrier-to-noise ratio (CNR)of the waveform generated. This value is expressed in dB. Noise bandwidth is equal to half the value of the IQ_RATE attribute. Configure the CARRIER_TO_NOISE_RATIO attribute only if you set the AWGN_ENABLED attribute to NIBTSG_VAL_TRUE.

The default value is 50.

Parameters:

• selector_string (string) – Pass an empty string.

• value (float) – Specifies the carrier-to-noise ratio (CNR)of the waveform generated. This value is expressed in dB. Noise bandwidth is equal to half the value of the IQ_RATE attribute. Configure the CARRIER_TO_NOISE_RATIO attribute only if you set the AWGN_ENABLED attribute to NIBTSG_VAL_TRUE.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_cs_packet_format(channel_string, value)

Sets the channel sounding (CS) packet format. This property is applicable only when you set the packet type to either LE-CS-1M or LE-CS-2M. The default value is NIBTSG_VAL_PACKET_FORMAT_SYNC.

Parameters:

• selector_string (string) – Pass an empty string.

• value (enums.CSPacketFormat, int) – Specifies the channel sounding (CS) packet format. This property is applicable only when you set the packet type to either LE-CS-1M or LE-CS-2M. The default value is NIBTSG_VAL_PACKET_FORMAT_SYNC.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_cs_phase_measurement_period(channel_string, value)

Sets the phase measurement period in the generated CS packet. This property is applicable for all CS packet formats except NIBTSG_VAL_PACKET_FORMAT_SYNC. The default value is 10us. Valid values are 10 us, 20us and 40 us.

Parameters:

• selector_string (string) – Pass an empty string.

• value (float) – Specifies the phase measurement period in the generated CS packet. This property is applicable for all CS packet formats except NIBTSG_VAL_PACKET_FORMAT_SYNC. The default value is 10us. Valid values are 10 us, 20us and 40 us.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_cs_sync_sequence(channel_string, value)

Sets whether the sounding sequence field is present in SYNC packet. This property is applicable for all CS Packet formats except CS Tone. The default value is NIBTSG_VAL_SYNC_SEQUENCE_SOUNDING_SEQUENCE.

Parameters:

• selector_string (string) – Pass an empty string.

• value (enums.CSSyncSequence, int) – Specifies whether the sounding sequence field is present in SYNC packet. This property is applicable for all CS Packet formats except CS Tone. The default value is NIBTSG_VAL_SYNC_SEQUENCE_SOUNDING_SEQUENCE.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_cs_tone_extension_slot_enabled(channel_string, value)

Sets whether CS tone extension slot is present in generated LE CS packets. This property is applicable for all CS packet formats except NIBTSG_VAL_PACKET_FORMAT_SYNC. The default value is NIBTSG_VAL_FALSE.

Parameters:

• selector_string (string) – Pass an empty string.

• value (enums.CSToneExtensionSlotEnabled, int) – Specifies whether CS tone extension slot is present in generated LE CS packets. This property is applicable for all CS packet formats except NIBTSG_VAL_PACKET_FORMAT_SYNC. The default value is NIBTSG_VAL_FALSE.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_data_rate(channel_string, value)

Sets the Higher Data Throughput (HDT) Bit Rate. This property is applicable only when you set the packet type to LE-HDT. The default value is 2000000. Valid values are 2000000, 3000000, 4000000, 6000000, 7500000.

Parameters:

• selector_string (string) – Pass an empty string.

• value (enums.DataRate, int) – Specifies the Higher Data Throughput (HDT) Bit Rate. This property is applicable only when you set the packet type to LE-HDT. The default value is 2000000. Valid values are 2000000, 3000000, 4000000, 6000000, 7500000.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_direction_finding_antenna_switching_duration(channel_string, value)

Sets the duration for which the transitions of phase and amplitude take place in the switching slots of the constant tone extension (CTE) portion of the low energy (LE) packet. This attribute is applicable only when the DIRECTION_FINDING_ANTENNA_SWITCHING_ENABLED attribute to NIBTSG_VAL_TRUE.

The default value is 500n.

Parameters:

• selector_string (string) – Pass an empty string.

• value (float) – Specifies the duration for which the transitions of phase and amplitude take place in the switching slots of the constant tone extension (CTE) portion of the low energy (LE) packet. This attribute is applicable only when the DIRECTION_FINDING_ANTENNA_SWITCHING_ENABLED attribute to NIBTSG_VAL_TRUE.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_direction_finding_antenna_switching_enabled(channel_string, value)

Sets whether antenna switching is enabled for the generated low energy (LE) packets. This attribute is valid only when you set the DIRECTION_FINDING_MODE attribute to NIBTSG_VAL_DIRECTION_FINDING_MODE_ANGLE_OF_ARRIVAL or NIBTSG_DIRECTION_FINDING_MODE_ANGLE_OF_DEPARTURE.

The default value is NIBTSG_VAL_FALSE.

Parameters:

• selector_string (string) – Pass an empty string.

• value (enums.AntennaSwitchingEnabled, int) – Specifies whether antenna switching is enabled for the generated low energy (LE) packets. This attribute is valid only when you set the DIRECTION_FINDING_MODE attribute to NIBTSG_VAL_DIRECTION_FINDING_MODE_ANGLE_OF_ARRIVAL or NIBTSG_DIRECTION_FINDING_MODE_ANGLE_OF_DEPARTURE.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_direction_finding_antenna_switching_pattern(channel_string, value)

Sets the pattern in which the antennas switch in constant tone extension (CTE) portion of the low energy (LE) packet. The current definition always treats A0 as the reference antenna. A1, A2, A3…Am are all non-reference antennas. This attribute is applicable only when you set the DIRECTION_FINDING_ANTENNA_SWITCHING_ENABLED to NIBTSG_VAL_TRUE.

Parameters:

• selector_string (string) – Pass an empty string.

• value (string) – Specifies the pattern in which the antennas switch in constant tone extension (CTE) portion of the low energy (LE) packet. The current definition always treats A0 as the reference antenna. A1, A2, A3…Am are all non-reference antennas. This attribute is applicable only when you set the DIRECTION_FINDING_ANTENNA_SWITCHING_ENABLED to NIBTSG_VAL_TRUE.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_direction_finding_constant_tone_extension_length(channel_string, value)

Sets the length of the constant tone extension field in the generated signal. This value is expressed in seconds. This parameter is applicable only when you set the DIRECTION_FINDING_MODE attribute to either NIBTSG_VAL_DIRECTION_FINDING_MODE_ANGLE_OF_ARRIVAL or NIBTSG_DIRECTION_FINDING_MODE_ANGLE_OF_DEPARTURE.

The default value is 0.00016.

Parameters:

• selector_string (string) – Pass an empty string.

• value (float) – Specifies the length of the constant tone extension field in the generated signal. This value is expressed in seconds. This parameter is applicable only when you set the DIRECTION_FINDING_MODE attribute to either NIBTSG_VAL_DIRECTION_FINDING_MODE_ANGLE_OF_ARRIVAL or NIBTSG_DIRECTION_FINDING_MODE_ANGLE_OF_DEPARTURE.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_direction_finding_constant_tone_extension_slot_duration(channel_string, value)

Sets the length of the antenna switching and sampling slots in the constant tone extension field. This value is expressed in seconds.

The default value is 1 us. Valid values are 1 us and 2 us.

Parameters:

• selector_string (string) – Pass an empty string.

• value (float) – Specifies the length of the antenna switching and sampling slots in the constant tone extension field. This value is expressed in seconds.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_direction_finding_mode(channel_string, value)

Sets the mode for direction finding. The attribute is valid only for LE-TP, LE-TP EXT, LE-Enhanced and LE-HDT packet type.

The default value is NIBTSG_VAL_DIRECTION_FINDING_MODE_DISABLE.

Parameters:

• selector_string (string) – Pass an empty string.

• value (enums.DirectionFindingMode, int) – Specifies the mode for direction finding. The attribute is valid only for LE-TP, LE-TP EXT, LE-Enhanced and LE-HDT packet type.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_direction_finding_number_of_antennas(channel_string, value)

Sets the number of antennas used to transmit or receive the constant tone extension (CTE) portion of low energy (LE) packet. This attribute is applicable only when you set the DIRECTION_FINDING_ANTENNA_SWITCHING_ENABLED to NIBTSG_VAL_TRUE.

Parameters:

• selector_string (string) – Pass an empty string.

• value (int) – Specifies the number of antennas used to transmit or receive the constant tone extension (CTE) portion of low energy (LE) packet. This attribute is applicable only when you set the DIRECTION_FINDING_ANTENNA_SWITCHING_ENABLED to NIBTSG_VAL_TRUE.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_dirty_tx_carrier_frequency_offset_set(channel_string, value)

Sets the offset value of each of the impairment set that you enable in the DIRTY_TX_PARAMETERS_ENABLED_SET attribute. This attribute is applicable with you set the DIRTY_TX_MODE attribute to NIBTSG_VAL_DIRTY_TX_MODE_USER_DEFINED. The BT Generation ignores this attribute if you set the DIRTY_TX_MODE attribute to NIBTSG_VAL_DIRTY_TX_MODE_STANDARD.

Parameters:

• selector_string (string) – Pass an empty string.

• value (int) – Specifies the offset value of each of the impairment set that you enable in the DIRTY_TX_PARAMETERS_ENABLED_SET attribute. This attribute is applicable with you set the DIRTY_TX_MODE attribute to NIBTSG_VAL_DIRTY_TX_MODE_USER_DEFINED. The BT Generation ignores this attribute if you set the DIRTY_TX_MODE attribute to NIBTSG_VAL_DIRTY_TX_MODE_STANDARD.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_dirty_tx_enabled(channel_string, value)

Sets whether to enable the dirty transmitter.

The default value is NIBTSG_VAL_FALSE.

Parameters:

• selector_string (string) – Pass an empty string.

• value (enums.DirtyTxEnabled, int) – Specifies whether to enable the dirty transmitter.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_dirty_tx_mode(channel_string, value)

Sets whether to enable the dirty transmitter with the standard settings, the user-defined settings or the frequency drift.

The default value is NIBTSG_VAL_DIRTY_TX_MODE_STANDARD.

Parameters:

• selector_string (string) – Pass an empty string.

• value (enums.DirtyTxMode, int) – Specifies whether to enable the dirty transmitter with the standard settings, the user-defined settings or the frequency drift.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_dirty_tx_modulation_index_set(channel_string, value)

Sets the modulation index value of each of the impairment set that you enable in the DIRTY_TX_PARAMETERS_ENABLED_SET attribute.

This attribute is applicable when you set the DIRTY_TX_MODE attribute to NIBTSG_VAL_DIRTY_TX_MODE_USER_DEFINED. The BT Generation ignores this attribute if you set the DIRTY_TX_MODE attribute to NIBTSG_VAL_DIRTY_TX_MODE_STANDARD.

Valid values are 0.28 to 0.4 for Basic Rate and EDR packets and 0.45 to 0.55 for LE packets, inclusive. The valid values are 0.495 to 0.505, inclusive, for LE packets when you set the DIRTY_TX_MODULATION_INDEX_TYPE attribute to NIBTSG_VAL_DIRTY_TX_MODULATION_INDEX_TYPE_STABLE.

Parameters:

• selector_string (string) – Pass an empty string.

• value (float) – Specifies the modulation index value of each of the impairment set that you enable in the DIRTY_TX_PARAMETERS_ENABLED_SET attribute.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_dirty_tx_modulation_index_type(channel_string, value)

Sets whether the modulation index type is NIBTSG_DIRTY_TX_MODULATION_INDEX_TYPE_STANDARD or NIBTSG_VAL_DIRTY_TX_MODULATION_INDEX_TYPE_STABLE. This attribute is valid only for LE packets. This attribute is applicable only if DIRTY_TX_ENABLED attribute is set to NIBTSG_VAL_TRUE. The default value is NIBTSG_DIRTY_TX_MODULATION_INDEX_TYPE_STANDARD.

Parameters:

• selector_string (string) – Pass an empty string.

• value (enums.DirtyTxModulationIndexType, int) – Specifies whether the modulation index type is NIBTSG_DIRTY_TX_MODULATION_INDEX_TYPE_STANDARD or NIBTSG_VAL_DIRTY_TX_MODULATION_INDEX_TYPE_STABLE. This attribute is valid only for LE packets. This attribute is applicable only if DIRTY_TX_ENABLED attribute is set to NIBTSG_VAL_TRUE. The default value is NIBTSG_DIRTY_TX_MODULATION_INDEX_TYPE_STANDARD.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_dirty_tx_parameters_enabled_set(channel_string, value)

Sets the impairment sets that you must enable out of the ten sets in LE and BR or the three sets in EDR. This attribute is applicable if you set the DIRTY_TX_MODE attribute to NIBTSG_VAL_DIRTY_TX_MODE_USER_DEFINED. The BT Generation ignores this attribute when the DIRTY_TX_MODE attribute is set to NIBTSG_VAL_DIRTY_TX_MODE_STANDARD.

Parameters:

• selector_string (string) – Pass an empty string.

• value (enums.DirtyTxParametersEnabledSet, int) – Specifies the impairment sets that you must enable out of the ten sets in LE and BR or the three sets in EDR. This attribute is applicable if you set the DIRTY_TX_MODE attribute to NIBTSG_VAL_DIRTY_TX_MODE_USER_DEFINED. The BT Generation ignores this attribute when the DIRTY_TX_MODE attribute is set to NIBTSG_VAL_DIRTY_TX_MODE_STANDARD.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_dirty_tx_residual_fm_deviation(channel_string, value)

Sets the frequency of the modulated signal to provide the additional frequency drift. This value is expressed in Hz.

This attribute is applicable when you set the DIRTY_TX_MODE attribute to NIBTSG_VAL_DIRTY_TX_MODE_USER_DEFINED. The BT Generation ignores this attribute if you set the DIRTY_TX_MODE attribute to NIBTSG_VAL_DIRTY_TX_MODE_STANDARD.

The default value is 0.

Parameters:

• selector_string (string) – Pass an empty string.

• value (float) – Specifies the frequency of the modulated signal to provide the additional frequency drift. This value is expressed in Hz.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_dirty_tx_residual_fm_frequency(channel_string, value)

Sets the frequency deviation of the modulated signal to provide the additional frequency drift. This value is expressed in Hz.

This attribute is applicable when you set the DIRTY_TX_MODE attribute to NIBTSG_VAL_DIRTY_TX_MODE_USER_DEFINED. The BT Generation ignores this attribute if you set the DIRTY_TX_MODE attribute to NIBTSG_VAL_DIRTY_TX_MODE_STANDARD.

The default value is 0.

Parameters:

• selector_string (string) – Pass an empty string.

• value (float) – Specifies the frequency deviation of the modulated signal to provide the additional frequency drift. This value is expressed in Hz.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_dirty_tx_symbol_timing_error_set(channel_string, value)

Sets the symbol timing error value of each of the impairment set that you enable in the DIRTY_TX_PARAMETERS_ENABLED_SET attribute.

This attribute is applicable with you set the DIRTY_TX_MODE attribute to NIBTSG_VAL_DIRTY_TX_MODE_USER_DEFINED. The BT Generation ignores this attribute if you set the DIRTY_TX_MODE attribute to NIBTSG_VAL_DIRTY_TX_MODE_STANDARD.

Parameters:

• selector_string (string) – Pass an empty string.

• value (int) – Specifies the symbol timing error value of each of the impairment set that you enable in the DIRTY_TX_PARAMETERS_ENABLED_SET attribute.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_dv_voice_payload_data_type(channel_string, value)

Sets the type of payload for the data voice (DV) packet.

The default value is NIBTSG_VAL_PAYLOAD_DATA_TYPE_PN_SEQUENCE.

Parameters:

• selector_string (string) – Pass an empty string.

• value (enums.DVVoicePayloadDataType, int) – Specifies the type of payload for the data voice (DV) packet.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_dv_voice_payload_pn_order(channel_string, value)

Sets the order (length of memory) of the pseudorandom bit sequence (PRBS) generator. If you set the DV_VOICE_PAYLOAD_DATA_TYPE attribute to NIBTSG_VAL_PAYLOAD_DATA_TYPE_USER_DEFINED_BITS, the BT Generation ignores the DV_VOICE_PAYLOAD_PN_ORDER attribute.

The default value is 9. Valid values are 5 to 31, inclusive.

Parameters:

• selector_string (string) – Pass an empty string.

• value (int) – Specifies the order (length of memory) of the pseudorandom bit sequence (PRBS) generator. If you set the DV_VOICE_PAYLOAD_DATA_TYPE attribute to NIBTSG_VAL_PAYLOAD_DATA_TYPE_USER_DEFINED_BITS, the BT Generation ignores the DV_VOICE_PAYLOAD_PN_ORDER attribute.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_dv_voice_payload_pn_seed(channel_string, value)

Sets the initialization seed used for the pseudorandom bit sequence (PRBS) generator. If you set the DV_VOICE_PAYLOAD_DATA_TYPE attribute to NIBTSG_VAL_PAYLOAD_DATA_TYPE_USER_DEFINED_BITS, the BT Generation ignores the DV_VOICE_PAYLOAD_PN_SEED attribute.

The default value is 497.

Parameters:

• selector_string (string) – Pass an empty string.

• value (int) – Specifies the initialization seed used for the pseudorandom bit sequence (PRBS) generator. If you set the DV_VOICE_PAYLOAD_DATA_TYPE attribute to NIBTSG_VAL_PAYLOAD_DATA_TYPE_USER_DEFINED_BITS, the BT Generation ignores the DV_VOICE_PAYLOAD_PN_SEED attribute.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_dv_voice_payload_user_defined_bits(channel_string, value)

Sets a bit pattern as an array of zeros and ones.

If the array length is greater than the required payload length, the BT Generation uses a subset of the required length from the beginning of the array for waveform generation. If the array length is less than the required payload length, the BT Generation repeats the bit pattern until the required length is achieved. If you set the DV_VOICE_PAYLOAD_DATA_TYPE attribute to NIBTSG_VAL_PAYLOAD_DATA_TYPE_PN_SEQUENCE, the BT Generation ignores the DV_VOICE_PAYLOAD_USER_DEFINED_BITS attribute.

Parameters:

• selector_string (string) – Pass an empty string.

• value (int) – Specifies a bit pattern as an array of zeros and ones.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_fhs_payload_bd_address_lap(channel_string, value)

Sets the 24-bit field in the frequency hop synchronization (FHS) packet payload. This field contains the lower address part (LAP) of the device that sends the FHS packet.

The default value is 0.

Parameters:

• selector_string (string) – Pass an empty string.

• value (int) – Specifies the 24-bit field in the frequency hop synchronization (FHS) packet payload. This field contains the lower address part (LAP) of the device that sends the FHS packet.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_fhs_payload_bd_address_nap(channel_string, value)

Sets the 16-bit field in the frequency hop synchronization (FHS) packet payload. This field contains the non-significant address part (NAP) of the device that sends the FHS packet. Refer to Section 6.5.1.4, Part B, Volume 2 of the Bluetooth Specification v2.1+EDR for more information about the NAP field.

The default value is 0.

Parameters:

• selector_string (string) – Pass an empty string.

• value (int) – Specifies the 16-bit field in the frequency hop synchronization (FHS) packet payload. This field contains the non-significant address part (NAP) of the device that sends the FHS packet. Refer to Section 6.5.1.4, Part B, Volume 2 of the Bluetooth Specification v2.1+EDR for more information about the NAP field.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_fhs_payload_bd_address_uap(channel_string, value)

Sets the 8-bit field in the frequency hop synchronization (FHS) packet payload. This field contains the upper address part (UAP) of the device that sends the FHS packet.

The default value is 0.

Parameters:

• selector_string (string) – Pass an empty string.

• value (int) – Specifies the 8-bit field in the frequency hop synchronization (FHS) packet payload. This field contains the upper address part (UAP) of the device that sends the FHS packet.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_fhs_payload_device_class(channel_string, value)

Sets the 24-bit field in the frequency hop synchronization (FHS) packet payload. This field indicates the class of device of the device that sends the FHS packet. Refer to Section 6.5.1.4, Part B, Volume 2 of the Bluetooth Specification v2.1+EDR for more information about the device class field in the FHS packet payload.

The default value is 0. Valid values are 0 to 0xFFFFFF, inclusive.

Parameters:

• selector_string (string) – Pass an empty string.

• value (int) – Specifies the 24-bit field in the frequency hop synchronization (FHS) packet payload. This field indicates the class of device of the device that sends the FHS packet. Refer to Section 6.5.1.4, Part B, Volume 2 of the Bluetooth Specification v2.1+EDR for more information about the device class field in the FHS packet payload.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_fhs_payload_device_clock(channel_string, value)

Sets the 26-bit field in the frequency hop synchronization (FHS) packet payload. This field contains the value of the native clock of the device that sends the FHS packet. Refer to Section 6.5.1.4, Part B, Volume 2 of the Bluetooth Specification v2.1+EDR for more information about the device clock field of the FHS packet payload.

The default value is 0.

Parameters:

• selector_string (string) – Pass an empty string.

• value (int) – Specifies the 26-bit field in the frequency hop synchronization (FHS) packet payload. This field contains the value of the native clock of the device that sends the FHS packet. Refer to Section 6.5.1.4, Part B, Volume 2 of the Bluetooth Specification v2.1+EDR for more information about the device clock field of the FHS packet payload.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_fhs_payload_lt_address(channel_string, value)

Sets the 3-bit logical transport (LT) address of the frequency hop synchronization (FHS) packet. Refer to Section 6.5.1.4, Part B, Volume 2 of the Bluetooth specification v2.1+EDR for more information about the LT address of the FHS packet.

The default value is 0. Valid values are 0 to 7, inclusive.

Parameters:

• selector_string (string) – Pass an empty string.

• value (int) – Specifies the 3-bit logical transport (LT) address of the frequency hop synchronization (FHS) packet. Refer to Section 6.5.1.4, Part B, Volume 2 of the Bluetooth specification v2.1+EDR for more information about the LT address of the FHS packet.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_fhs_payload_page_scan_mode(channel_string, value)

Sets the 3-bit field in the frequency hop synchronization (FHS) packet payload. This field indicates the default scan mode used by the sender of the FHS packet. Refer to Section 6.5.1.4, Part B, Volume 2 of the Bluetooth Specification v2.1+EDR for more information about the page scan mode field of the FHS packet payload.

The default value is 0. Valid values are 0 to 7, inclusive.

Parameters:

• selector_string (string) – Pass an empty string.

• value (int) – Specifies the 3-bit field in the frequency hop synchronization (FHS) packet payload. This field indicates the default scan mode used by the sender of the FHS packet. Refer to Section 6.5.1.4, Part B, Volume 2 of the Bluetooth Specification v2.1+EDR for more information about the page scan mode field of the FHS packet payload.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_fhs_payload_scan_repetition(channel_string, value)

Sets the 2-bit field in the frequency hop synchronization (FHS) packet payload. This field indicates the interval between two consecutive page scan windows. Refer to Section 6.5.1.4, Part B, Volume 2 of the Bluetooth specification v2.1+EDR for more information about the payload scan repetition field of the FHS packet payload.

The default value is 0. Valid values are 0 to 3, inclusive.

Parameters:

• selector_string (string) – Pass an empty string.

• value (int) – Specifies the 2-bit field in the frequency hop synchronization (FHS) packet payload. This field indicates the interval between two consecutive page scan windows. Refer to Section 6.5.1.4, Part B, Volume 2 of the Bluetooth specification v2.1+EDR for more information about the payload scan repetition field of the FHS packet payload.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_format1_payload_zone_configuration_mode(channel_string, value)

Sets the payload zone configuration mode for the LE-HDT packet when HDT_PACKET_FORMAT is set to NIBTSG_VAL_HDT_PACKET_FORMAT_FORMAT1 and FORMAT1_PAYLOAD_ZONE_CONFIGURATION_MODE is set to NIBTSG_VAL_FORMAT1_PAYLOAD_ZONE_CONFIGURATION_MODE_USER_DEFINED.

The default value is NIBTSG_VAL_FORMAT1_PAYLOAD_ZONE_CONFIGURATION_MODE_AUTO.

Parameters:

• selector_string (string) – Pass an empty string.

• value (enums.Format1PayloadZoneConfigurationMode, int) – Specifies the payload zone configuration mode for the LE-HDT packet when HDT_PACKET_FORMAT is set to NIBTSG_VAL_HDT_PACKET_FORMAT_FORMAT1 and FORMAT1_PAYLOAD_ZONE_CONFIGURATION_MODE is set to NIBTSG_VAL_FORMAT1_PAYLOAD_ZONE_CONFIGURATION_MODE_USER_DEFINED.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_hdt_packet_format(channel_string, value)

Sets the Higher Data Throughput (HDT) packet format. This property is applicable only for LE HDT packet type. The default value is NIBTSG_VAL_HDT_PACKET_FORMAT_FORMAT0.

Parameters:

• selector_string (string) – Pass an empty string.

• value (enums.HdtPacketFormat, int) – Specifies the Higher Data Throughput (HDT) packet format. This property is applicable only for LE HDT packet type. The default value is NIBTSG_VAL_HDT_PACKET_FORMAT_FORMAT0.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_hdt_phy_interval(channel_string, value)

Sets the physical layer intervals. This property is only valid for Format1 packet format. This value is expressed in seconds. The default value is 64us. Valid values are 64us, 128us, 192us and 256us.

Parameters:

• selector_string (string) – Pass an empty string.

• value (float) – Specifies the physical layer intervals. This property is only valid for Format1 packet format. This value is expressed in seconds. The default value is 64us. Valid values are 64us, 128us, 192us and 256us.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_headroom(channel_string, value)

Sets the value for the headroom. This value is expressed in dB. The BT Generation uses this attribute for scaling the waveform when you set the AUTO_HEADROOM_ENABLED attribute to NIBTSG_VAL_FALSE.

The default value is 0.

Parameters:

• selector_string (string) – Pass an empty string.

• value (float) – Specifies the value for the headroom. This value is expressed in dB. The BT Generation uses this attribute for scaling the waveform when you set the AUTO_HEADROOM_ENABLED attribute to NIBTSG_VAL_FALSE.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_i_dc_offset(channel_string, value)

Sets the value of the DC offset in the in-phase (I) signal as a percentage of the peak magnitude of the complex I/Q signal.

The default value is 0. Valid values are -100 to 100, inclusive.

Parameters:

• selector_string (string) – Pass an empty string.

• value (float) – Specifies the value of the DC offset in the in-phase (I) signal as a percentage of the peak magnitude of the complex I/Q signal.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_iq_gain_imbalance(channel_string, value)

Sets the ratio of the mean amplitude of the in-phase (I) signal to the mean amplitude of the quadrature-phase (Q) signal. This value is expressed in dB.

For more information on IQ gain imbalance equations, refer to the IQ Gain Imbalance topic in RFmx BT Generation Help.

The default value is 0. Valid values are -6 to 6, inclusive.

Parameters:

• selector_string (string) – Pass an empty string.

• value (float) – Specifies the ratio of the mean amplitude of the in-phase (I) signal to the mean amplitude of the quadrature-phase (Q) signal. This value is expressed in dB.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_last_block_size(channel_string, value)

Sets the block size of the last block. This property is valid only for the LE-HDT packet when HDT_PACKET_FORMAT is set to NIBTSG_VAL_HDT_PACKET_FORMAT_FORMAT1 and FORMAT1_PAYLOAD_ZONE_CONFIGURATION_MODE is set to NIBTSG_VAL_FORMAT1_PAYLOAD_ZONE_CONFIGURATION_MODE_USER_DEFINED.

You must use “payload x” as the active channel string to configure this property.

The valid values are 1 to 8191. The default value is 526.

Parameters:

• selector_string (string) – Pass an empty string.

• value (int) – Specifies the block size of the last block. This property is valid only for the LE-HDT packet when HDT_PACKET_FORMAT is set to NIBTSG_VAL_HDT_PACKET_FORMAT_FORMAT1 and FORMAT1_PAYLOAD_ZONE_CONFIGURATION_MODE is set to NIBTSG_VAL_FORMAT1_PAYLOAD_ZONE_CONFIGURATION_MODE_USER_DEFINED.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_le_access_address(channel_string, value)

Sets the 32-bit LE access address.

The Bluetooth core specification recommends to use 0x71764129 as the LE access address for all test packets. The preamble of LE-TP/LE-TP-EXT packets is either 01010101b or 10101010b, depending on the LSB of the LE access address. If the LSB of the LE access address is 1, the preamble shall be 01010101b, otherwise the preamble shall be 10101010b. This will be 0101010101010101b, 1010101010101010b respectively for LE-Enhanced packets.

The default value is 0x71764129.

Note: This attribute is applicable for LE packets.

Parameters:

• selector_string (string) – Pass an empty string.

• value (int) – Specifies the 32-bit LE access address.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_le_tp_corrupt_alternate_crc(channel_string, value)

Sets whether the BT Generation intentionally corrupts the cyclic redundancy check (CRC) portion of every alternate packet generated. Refer to Section 6.3.7 of the Bluetooth Low Energy RF PHY Test Specification 4.0.0. CRC corruption is done by toggling the seed used for CRC computation.

The default value is NIBTSG_VAL_FALSE.

Note: This attribute is applicable for LE packets.

Parameters:

• selector_string (string) – Pass an empty string.

• value (enums.LETPCorruptAlternateCrc, int) – Specifies whether the BT Generation intentionally corrupts the cyclic redundancy check (CRC) portion of every alternate packet generated. Refer to Section 6.3.7 of the Bluetooth Low Energy RF PHY Test Specification 4.0.0. CRC corruption is done by toggling the seed used for CRC computation.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_le_tp_payload_type(channel_string, value)

Sets the type of payload for the LE and LE CS packets.

The default value is NIBTSG_VAL_LE_TP_PAYLOAD_TYPE_PRBS9.

Note: This attribute is applicable for LE and LE CS packets.

Parameters:

• selector_string (string) – Pass an empty string.

• value (enums.LETPPayloadType, int) – Specifies the type of payload for the LE and LE CS packets.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_maximum_hardware_iq_rate(channel_string, value)

Sets the maximum I/Q rate that the NI RF vector signal generator supports.

This property will be set according to the device model in the rfsg_create_and_download_waveform() function.

Parameters:

• selector_string (string) – Pass an empty string.

• value (float) – Specifies the maximum I/Q rate that the NI RF vector signal generator supports.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_modulation_index(channel_string, value)

Sets the modulation index value for the Gaussian frequency shift keying modulation in Bluetooth packets.

Valid values are 0 to 1, excluding 0. The default value is -1. NI recommends you to set the value of this attribute to 0.32 for BR and EDR packets and 0.5 for LE packets.

Parameters:

• selector_string (string) – Pass an empty string.

• value (float) – Specifies the modulation index value for the Gaussian frequency shift keying modulation in Bluetooth packets.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_number_of_block_repetition_sequences(channel_string, value)

Parameters:

• selector_string (string) – Pass an empty string.

• value (int)

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_number_of_blocks(channel_string, value)

Sets the number of blocks minus one that the payload is split into.This property is valid only for the LE-HDT packet when HDT_PACKET_FORMAT is set to NIBTSG_VAL_HDT_PACKET_FORMAT_FORMAT1 and FORMAT1_PAYLOAD_ZONE_CONFIGURATION_MODE is set to NIBTSG_VAL_FORMAT1_PAYLOAD_ZONE_CONFIGURATION_MODE_USER_DEFINED.

You must use “payload x” as the active channel string to configure this property.

The default value is 15.

Parameters:

• selector_string (string) – Pass an empty string.

• value (int) – Specifies the number of blocks minus one that the payload is split into.This property is valid only for the LE-HDT packet when HDT_PACKET_FORMAT is set to NIBTSG_VAL_HDT_PACKET_FORMAT_FORMAT1 and FORMAT1_PAYLOAD_ZONE_CONFIGURATION_MODE is set to NIBTSG_VAL_FORMAT1_PAYLOAD_ZONE_CONFIGURATION_MODE_USER_DEFINED.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_number_of_idle_slots(channel_string, value)

Sets the number of idle slots that the BT Generation appends at the end of each valid packet.

The default value is 0.

Parameters:

• selector_string (string) – Pass an empty string.

• value (int) – Specifies the number of idle slots that the BT Generation appends at the end of each valid packet.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_number_of_payloads(channel_string, value)

Sets the number of payloads for the LE-HDT packet when HDT_PACKET_FORMAT is set to NIBTSG_VAL_HDT_PACKET_FORMAT_FORMAT1. The valid values are 1 to 4.

The default value is 1.

Parameters:

• selector_string (string) – Pass an empty string.

• value (int) – Specifies the number of payloads for the LE-HDT packet when HDT_PACKET_FORMAT is set to NIBTSG_VAL_HDT_PACKET_FORMAT_FORMAT1. The valid values are 1 to 4.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_number_of_unique_packets(channel_string, value)

Sets the number of unique packets for which the pseudonoise (PN) generator must run continuously. The BT Generation resets the PN generator after it reaches the number of packets that you specify in this attribute. For example, if you set this attribute to 1, the same payload is used for each packet, and if you set this attribute to 2, the same payload is used after every 2 packets. Configure this attribute only if you set the PAYLOAD_DATA_TYPE attribute to NIBTSG_VAL_PAYLOAD_DATA_TYPE_PN_SEQUENCE.

The value of this attribute must be the same as the value of the NIBTSG_BER_NUMBER_OF_UNIQUE_PACKETS attribute. Refer to Dirty Transmitter topic for details of the restrictions on the value of the NUMBER_OF_UNIQUE_PACKETS attribute.

The default value is 1.

Parameters:

• selector_string (string) – Pass an empty string.

• value (int) – Specifies the number of unique packets for which the pseudonoise (PN) generator must run continuously. The BT Generation resets the PN generator after it reaches the number of packets that you specify in this attribute. For example, if you set this attribute to 1, the same payload is used for each packet, and if you set this attribute to 2, the same payload is used after every 2 packets. Configure this attribute only if you set the PAYLOAD_DATA_TYPE attribute to NIBTSG_VAL_PAYLOAD_DATA_TYPE_PN_SEQUENCE.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_oversampling_factor(channel_string, value)

Sets the number of times the Nyquist sample rate is increased to obtain the final sample rate of a signal.

The default value is 8.

Parameters:

• selector_string (string) – Pass an empty string.

• value (int) – Specifies the number of times the Nyquist sample rate is increased to obtain the final sample rate of a signal.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_packet_bit_sequence_trace_enabled(channel_string, value)

Sets whether to enable the packet bit sequence trace.

The default value is NIBTSG_VAL_FALSE.

Parameters:

• selector_string (string) – Pass an empty string.

• value (enums.PacketBitSequenceTraceEnabled, int) – Specifies whether to enable the packet bit sequence trace.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_packet_header_arqn(channel_string, value)

Sets the value for the automatic repeat request number (ARQN) field in the packet header. This attribute controls the value for the 1-bit acknowledgement indicator, which indicates whether the data packet transfer is successful. Refer to sections 6.4.4 and 7.6, Part B, Volume 2 of the Bluetooth Specification v2.1+EDR for more information about the ARQN field.

The default value is NIBTSG_VAL_PACKET_HEADER_ARQN_NAK.

Parameters:

• selector_string (string) – Pass an empty string.

• value (enums.PacketHeaderArqn, int) – Specifies the value for the automatic repeat request number (ARQN) field in the packet header. This attribute controls the value for the 1-bit acknowledgement indicator, which indicates whether the data packet transfer is successful. Refer to sections 6.4.4 and 7.6, Part B, Volume 2 of the Bluetooth Specification v2.1+EDR for more information about the ARQN field.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_packet_header_flow(channel_string, value)

Sets the value for the flow control field in the packet header. This field controls the 1-bit flow control parameter in the packet. Refer to Section 6.4.3, Part B, Volume 2 of the Bluetooth Specification v2.1+EDR for more information about the flow control field.

The default value is 0. Valid values are 0, which indicates a Stop condition, and 1, which indicates a Go condition.

Parameters:

• selector_string (string) – Pass an empty string.

• value (int) – Specifies the value for the flow control field in the packet header. This field controls the 1-bit flow control parameter in the packet. Refer to Section 6.4.3, Part B, Volume 2 of the Bluetooth Specification v2.1+EDR for more information about the flow control field.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_packet_header_lt_address(channel_string, value)

Sets the 3-bit logical transport (LT) address of the packet. The LT address field indicates the destination slave for a packet in a master-to-slave transmission slot and indicates the source slave for a slave-to-master transmission slot. Refer to sections 6.4.1 and 6.4.2, Part B, Volume 2 of the Bluetooth Specification v2.1+EDR for more information about the LT address of a packet.

The default value is 0. Valid values are 0 to 7, inclusive.

Parameters:

• selector_string (string) – Pass an empty string.

• value (int) – Specifies the 3-bit logical transport (LT) address of the packet. The LT address field indicates the destination slave for a packet in a master-to-slave transmission slot and indicates the source slave for a slave-to-master transmission slot. Refer to sections 6.4.1 and 6.4.2, Part B, Volume 2 of the Bluetooth Specification v2.1+EDR for more information about the LT address of a packet.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_packet_header_seqn(channel_string, value)

Sets the value for the sequential numbering scheme (SEQN) field in the packet header. This attribute controls the value for the 1-bit sequence bit, which allows you to provide a sequential numbering scheme to order the data packet scheme. Refer to sections 6.4.5, 7.6.2, and 7.6.5, Part B, Volume 2 of the Bluetooth Specification v2.1+EDR for more information about the SEQN field.

The default value is 0. Valid values are 0 and 1.

Parameters:

• selector_string (string) – Pass an empty string.

• value (int) – Specifies the value for the sequential numbering scheme (SEQN) field in the packet header. This attribute controls the value for the 1-bit sequence bit, which allows you to provide a sequential numbering scheme to order the data packet scheme. Refer to sections 6.4.5, 7.6.2, and 7.6.5, Part B, Volume 2 of the Bluetooth Specification v2.1+EDR for more information about the SEQN field.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_packet_type(channel_string, value)

Sets the Bluetooth packet type.

The default value is NIBTSG_VAL_PACKET_TYPE_DH1.

Parameters:

• selector_string (string) – Pass an empty string.

• value (enums.PacketType, int) – Specifies the Bluetooth packet type.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_payload_crc_seed(channel_string, value)

Sets the 32 bit CRC initialization seed value. This property is applicable only when user set the Packet Type to LE-HDT and HDT_PACKET_FORMAT is set to NIBTSG_VAL_HDT_PACKET_FORMAT_FORMAT0 or NIBTSG_VAL_HDT_PACKET_FORMAT_FORMAT1.

The default value is 0x00000000. The valid values are 0x00000000 to 0xFFFFFFFF.

Parameters:

• selector_string (string) – Pass an empty string.

• value (int) – Specifies the 32 bit CRC initialization seed value. This property is applicable only when user set the Packet Type to LE-HDT and HDT_PACKET_FORMAT is set to NIBTSG_VAL_HDT_PACKET_FORMAT_FORMAT0 or NIBTSG_VAL_HDT_PACKET_FORMAT_FORMAT1.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_payload_data_type(channel_string, value)

Sets the type of payload for the packet.

The default value is NIBTSG_VAL_PAYLOAD_DATA_TYPE_PN_SEQUENCE.

Parameters:

• selector_string (string) – Pass an empty string.

• value (enums.PayloadDataType, int) – Specifies the type of payload for the packet.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_payload_header_enabled(channel_string, value)

Sets whether to enable payload header in the Bluetooth packet to be generated. This is applicable only for LE packets.

For generating custom Bluetooth packets, set the value of this property to NIBTSG_VAL_FALSE. In this case, the header bits can be given as input to the PAYLOAD_USER_DEFINED_BITS property along with the payload bits. The default value is NIBTSG_VAL_TRUE.

Parameters:

• selector_string (string) – Pass an empty string.

• value (enums.PayloadHeaderEnabled, int) – Specifies whether to enable payload header in the Bluetooth packet to be generated. This is applicable only for LE packets.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_payload_header_flow(channel_string, value)

Sets the value for the flow control bit in the payload header. This field controls the 1-bit flow control parameter in the packet.

The default value is 0. Valid values are 0, which indicates a Stop condition, and 1, which indicates a Go condition.

Parameters:

• selector_string (string) – Pass an empty string.

• value (int) – Specifies the value for the flow control bit in the payload header. This field controls the 1-bit flow control parameter in the packet.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_payload_header_llid(channel_string, value)

Sets whether the payload is the start or continuation fragment of a logical link control and adaptation protocol (L2CAP) or link management protocol (LMP) message.

You must use “payload x” as the active channel string to configure this property for the LE-HDT packet when HDT_PACKET_FORMAT is set to NIBTSG_VAL_HDT_PACKET_FORMAT_FORMAT1 and FORMAT1_PAYLOAD_ZONE_CONFIGURATION_MODE is set to NIBTSG_VAL_FORMAT1_PAYLOAD_ZONE_CONFIGURATION_MODE_USER_DEFINED.

The default value is 0. Valid values are 0, 1, 2, and 3.

Parameters:

• selector_string (string) – Pass an empty string.

• value (int) – Specifies whether the payload is the start or continuation fragment of a logical link control and adaptation protocol (L2CAP) or link management protocol (LMP) message.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_payload_length(channel_string, value)

Sets the payload length, in bytes. If the length exceeds the maximum permissible length mentioned in the Bluetooth specification, the BT Generation uses this maximum permissible length as the payload length. For LE-TP-EXT and LE-Enhanced packet types, typical LE packet is generated length up to 255 bytes, and Hyper Length LE packet is generated for length from 256 bytes to 8191 bytes. For LE HDT packet, Format0 supports payload length up to 510 bytes, whereas Format1 supports up to 8191 bytes per payload. In the case of LE HDT Format1, when the Payload Zone Configuration Mode is set to Auto and the Payload Length Mode is set to User Defined, you must specify “payload x” as the active channel string to configure this property.

The default value is 0.

Parameters:

• selector_string (string) – Pass an empty string.

• value (int) – Specifies the payload length, in bytes. If the length exceeds the maximum permissible length mentioned in the Bluetooth specification, the BT Generation uses this maximum permissible length as the payload length. For LE-TP-EXT and LE-Enhanced packet types, typical LE packet is generated length up to 255 bytes, and Hyper Length LE packet is generated for length from 256 bytes to 8191 bytes. For LE HDT packet, Format0 supports payload length up to 510 bytes, whereas Format1 supports up to 8191 bytes per payload. In the case of LE HDT Format1, when the Payload Zone Configuration Mode is set to Auto and the Payload Length Mode is set to User Defined, you must specify “payload x” as the active channel string to configure this property.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_payload_length_mode(channel_string, value)

Sets whether the BT Generation automatically sets the value of the LENGTH field in the payload header to the maximum permissible length or whether it uses the value that you specify in the PAYLOAD_LENGTH attribute.

The default value is NIBTSG_VAL_PAYLOAD_LENGTH_MODE_MAXIMUM_LENGTH.

Parameters:

• selector_string (string) – Pass an empty string.

• value (enums.PayloadLengthMode, int) – Specifies whether the BT Generation automatically sets the value of the LENGTH field in the payload header to the maximum permissible length or whether it uses the value that you specify in the PAYLOAD_LENGTH attribute.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_payload_pn_order(channel_string, value)

Sets the order (length of memory) of the pseudorandom bit sequence (PRBS) generator. If you set the PAYLOAD_DATA_TYPE attribute to NIBTSG_VAL_PAYLOAD_DATA_TYPE_USER_DEFINED_BITS, the BT Generation ignores the PAYLOAD_PN_ORDER attribute.

The default value is 9. Valid values are 5 to 31, inclusive.

Parameters:

• selector_string (string) – Pass an empty string.

• value (int) – Specifies the order (length of memory) of the pseudorandom bit sequence (PRBS) generator. If you set the PAYLOAD_DATA_TYPE attribute to NIBTSG_VAL_PAYLOAD_DATA_TYPE_USER_DEFINED_BITS, the BT Generation ignores the PAYLOAD_PN_ORDER attribute.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_payload_pn_seed(channel_string, value)

Sets the initialization seed used for the pseudorandom bit sequence (PRBS) generator. If you set the PAYLOAD_DATA_TYPE attribute to NIBTSG_VAL_PAYLOAD_DATA_TYPE_USER_DEFINED_BITS, the BT Generation ignores the PAYLOAD_PN_SEED attribute.

The default value is 497.

Parameters:

• selector_string (string) – Pass an empty string.

• value (int) – Specifies the initialization seed used for the pseudorandom bit sequence (PRBS) generator. If you set the PAYLOAD_DATA_TYPE attribute to NIBTSG_VAL_PAYLOAD_DATA_TYPE_USER_DEFINED_BITS, the BT Generation ignores the PAYLOAD_PN_SEED attribute.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_payload_user_defined_bits(channel_string, value)

Sets a bit pattern as an array of zeros and ones.

If the array length is greater than the required payload length, the BT Generation uses a subset of the required length from the beginning of the array for waveform generation. If the array length is less than the required payload length, the BT Generation repeats the bit pattern until the required length is achieved. If you set the PAYLOAD_DATA_TYPE attribute to NIBTSG_VAL_PAYLOAD_DATA_TYPE_PN_SEQUENCE, the BT Generation ignores the PAYLOAD_USER_DEFINED_BITS attribute.

Parameters:

• selector_string (string) – Pass an empty string.

• value (int) – Specifies a bit pattern as an array of zeros and ones.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_physical_channel_address(channel_string, value)

Sets the 40-bit physical channel address of Higher Data Throughput (HDT) packet. The default value is 0x9F15555555.

Parameters:

• selector_string (string) – Pass an empty string.

• value (int) – Specifies the 40-bit physical channel address of Higher Data Throughput (HDT) packet. The default value is 0x9F15555555.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_power_ramp_settling_time(channel_string, value)

Sets the settling time of the burst. The settling time is the time interval from the time when output power is 40 dB less than the final output power to the time when the output power is ±1 dB of the final output power. This value is expressed in seconds.

The default value is 4 microseconds. Valid values are from 1 microseconds to 20 microseconds, inclusive.

Parameters:

• selector_string (string) – Pass an empty string.

• value (float) – Specifies the settling time of the burst. The settling time is the time interval from the time when output power is 40 dB less than the final output power to the time when the output power is ±1 dB of the final output power. This value is expressed in seconds.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_power_ramp_time(channel_string, value)

Sets the ramp time of the burst. The settling time is the time interval from the time when output power (X dBm) is 40 dB less than the final output power to the time when the output power is ±1 dB of the final output power. This value is expressed in seconds. The default value is 2 microseconds. Valid values are from 1 microseconds to 10 microseconds, inclusive.

Note: The value of ramp time should not exceed the value of settling time.

Parameters:

• selector_string (string) – Pass an empty string.

• value (float) – Specifies the ramp time of the burst. The settling time is the time interval from the time when output power (X dBm) is 40 dB less than the final output power to the time when the output power is ±1 dB of the final output power. This value is expressed in seconds. The default value is 2 microseconds. Valid values are from 1 microseconds to 10 microseconds, inclusive.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_q_dc_offset(channel_string, value)

Sets the value of the DC offset in the quadrature-phase (Q) signal as percentage of the peak magnitude of the complex I/Q signal.

The default value is 0. Valid values are -100 to 100, inclusive.

Parameters:

• selector_string (string) – Pass an empty string.

• value (float) – Specifies the value of the DC offset in the quadrature-phase (Q) signal as percentage of the peak magnitude of the complex I/Q signal.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_quadrature_skew(channel_string, value)

Sets the deviation in angle from 90 degrees between the in-phase (I) and quadrature-phase (Q) signals.

For more information on quadrature skew equations, refer to the IQ Gain Imbalance topic RFmx BT Generation Help.

The default value is 0. Valid values are -30 to 30, inclusive.

Parameters:

• selector_string (string) – Pass an empty string.

• value (float) – Specifies the deviation in angle from 90 degrees between the in-phase (I) and quadrature-phase (Q) signals.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_run_time_scaling(channel_string, value)

Parameters:

• selector_string (string) – Pass an empty string.

• value (float)

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_sample_clock_offset(channel_string, value)

Sets the offset in the Sample Clock frequency from the sample frequency for CS packets. This value is expressed in parts per million (ppm).

The default value is 0.

Parameters:

• selector_string (string) – Pass an empty string.

• value (float) – Specifies the offset in the Sample Clock frequency from the sample frequency for CS packets. This value is expressed in parts per million (ppm).

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_sounding_sequence_length(channel_string, value)

Sets sounding sequence length, in bits. This property is applicable only when you set the CS SYNC Sequence to Sounding Sequence. The default value is 32. Valid values are 32 and 96.

Parameters:

• selector_string (string) – Pass an empty string.

• value (int) – Specifies sounding sequence length, in bits. This property is applicable only when you set the CS SYNC Sequence to Sounding Sequence. The default value is 32. Valid values are 32 and 96.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_sounding_sequence_marker_positions(channel_string, value)

Sets an array of sounding sequence marker positions at which sounding sequence marker signals are inserted. This property is applicable only when you set the CS SYNC Sequence to Sounding Sequence. When sounding sequence length property is set to 32, only the first element from the sounding sequence marker positions array is considered, and remaining elements are discarded. Valid values are from 0 to 28. When sounding sequence length property is set to 96, up to the first two elements from sounding sequence marker positions array are considered and remaining elements are discarded. Valid values for array index 0 are from 0 to 63 and for array index 1 are from 67 to 92. The default value is 0.

Parameters:

• selector_string (string) – Pass an empty string.

• value (int) – Specifies an array of sounding sequence marker positions at which sounding sequence marker signals are inserted. This property is applicable only when you set the CS SYNC Sequence to Sounding Sequence. When sounding sequence length property is set to 32, only the first element from the sounding sequence marker positions array is considered, and remaining elements are discarded. Valid values are from 0 to 28. When sounding sequence length property is set to 96, up to the first two elements from sounding sequence marker positions array are considered and remaining elements are discarded. Valid values for array index 0 are from 0 to 63 and for array index 1 are from 67 to 92. The default value is 0.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_sounding_sequence_marker_signals(channel_string, value)

Sets an array of sounding sequence marker signals. This property is applicable only when you set the CS SYNC Sequence to Sounding Sequence. When sounding sequence length property is set to 32, only the first element shall be inserted in the sounding sequence, and remaining elements shall be discarded. When sounding sequence length property is set to 96, up to the first two elements shall be inserted in the sounding sequence, and remaining elements shall be discarded. The default value is NIBTSG_VAL_SOUNDING_SEQUENCE_MARKER_SIGNALS_1100.

Parameters:

• selector_string (string) – Pass an empty string.

• value (enums.SoundingSequenceMarkerSignals, int) – Specifies an array of sounding sequence marker signals. This property is applicable only when you set the CS SYNC Sequence to Sounding Sequence. When sounding sequence length property is set to 32, only the first element shall be inserted in the sounding sequence, and remaining elements shall be discarded. When sounding sequence length property is set to 96, up to the first two elements shall be inserted in the sounding sequence, and remaining elements shall be discarded. The default value is NIBTSG_VAL_SOUNDING_SEQUENCE_MARKER_SIGNALS_1100.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_time_delay(channel_string, value)

Sets the time delay for CS packets This value is expressed in seconds.

The default value is 0.

Parameters:

• selector_string (string) – Pass an empty string.

• value (float) – Specifies the time delay for CS packets This value is expressed in seconds.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_txblock_map(channel_string, value)

Sets the TxBlockMap field of Tx Portion of PDU Header. The TxBlockMap field is 8 or 16 bits depending on the value of TXLEN_SEQUENCE_NUMBER. It indicates which blocks are actually being transmitted in the packet, with bit b set to 1 if block b (counting from 0) is included and 0 if it is not. At least one bit shall be set. This property is valid only for the LE-HDT packet when HDT_PACKET_FORMAT is set to NIBTSG_VAL_HDT_PACKET_FORMAT_FORMAT1 and FORMAT1_PAYLOAD_ZONE_CONFIGURATION_MODE is set to NIBTSG_VAL_FORMAT1_PAYLOAD_ZONE_CONFIGURATION_MODE_USER_DEFINED.

You must use “payload x” as the active channel string to configure this property.

The valid values are 1 to 0xFFFF. The default value is 0xFFFF.

Parameters:

• selector_string (string) – Pass an empty string.

• value (int) – Specifies the TxBlockMap field of Tx Portion of PDU Header. The TxBlockMap field is 8 or 16 bits depending on the value of TXLEN_SEQUENCE_NUMBER. It indicates which blocks are actually being transmitted in the packet, with bit b set to 1 if block b (counting from 0) is included and 0 if it is not. At least one bit shall be set. This property is valid only for the LE-HDT packet when HDT_PACKET_FORMAT is set to NIBTSG_VAL_HDT_PACKET_FORMAT_FORMAT1 and FORMAT1_PAYLOAD_ZONE_CONFIGURATION_MODE is set to NIBTSG_VAL_FORMAT1_PAYLOAD_ZONE_CONFIGURATION_MODE_USER_DEFINED.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_txlen_sequence_number(channel_string, value)

Sets the value of TxLen SN field of Tx Portion of PDU Header. This property is valid only for the LE-HDT packet when HDT_PACKET_FORMAT is set to NIBTSG_VAL_HDT_PACKET_FORMAT_FORMAT1 and FORMAT1_PAYLOAD_ZONE_CONFIGURATION_MODE is set to NIBTSG_VAL_FORMAT1_PAYLOAD_ZONE_CONFIGURATION_MODE_USER_DEFINED.

You must use “payload x” as the active channel string to configure this property.

The default value is NIBTSG_VAL_TXLEN_SEQUENCE_NUMBER_11.

Parameters:

• selector_string (string) – Pass an empty string.

• value (enums.TxlenSequenceNumber, int) – Specifies the value of TxLen SN field of Tx Portion of PDU Header. This property is valid only for the LE-HDT packet when HDT_PACKET_FORMAT is set to NIBTSG_VAL_HDT_PACKET_FORMAT_FORMAT1 and FORMAT1_PAYLOAD_ZONE_CONFIGURATION_MODE is set to NIBTSG_VAL_FORMAT1_PAYLOAD_ZONE_CONFIGURATION_MODE_USER_DEFINED.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_vhdt_mode_enabled(channel_string, value)

Parameters:

• selector_string (string) – Pass an empty string.

• value (int)

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_waveform_file_version(channel_string, value)

Parameters:

• selector_string (string) – Pass an empty string.

• value (enums.WaveformFileVersion, int)

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_whitening_clock(channel_string, value)

Sets the 28-bit master Bluetooth device clock. This attribute is applicable only to BR and EDR packets. The BT Generation uses this attribute to initialize the linear feedback shift register used for calculating the whitening word. The BT Generation uses bits 1 to 6 for this purpose. Refer to sections 1.1 and 7.2, Part B, Volume 2 of the Bluetooth Specification v2.1+EDR for more information about the Bluetooth device clock.

The default value is 0.

Parameters:

• selector_string (string) – Pass an empty string.

• value (int) – Specifies the 28-bit master Bluetooth device clock. This attribute is applicable only to BR and EDR packets. The BT Generation uses this attribute to initialize the linear feedback shift register used for calculating the whitening word. The BT Generation uses bits 1 to 6 for this purpose. Refer to sections 1.1 and 7.2, Part B, Volume 2 of the Bluetooth Specification v2.1+EDR for more information about the Bluetooth device clock.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_whitening_enabled(channel_string, value)

Sets whether to enable the whitening settings.

The default value is NIBTSG_VAL_FALSE.

If you set this attribute to NIBTSG_VAL_TRUE and the PACKET_TYPE attribute to any LE packets, you should set a value for the CARRIER_FREQUENCY attribute.

Parameters:

• selector_string (string) – Pass an empty string.

• value (enums.WhiteningEnabled, int) – Specifies whether to enable the whitening settings.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_zadoff_chu_index(channel_string, value)

Sets Zadoff-Chu Index for the Long Training Sequence in the preamble. The default value is 7. Valid values are in the range of [1 - 16].

Parameters:

• selector_string (string) – Pass an empty string.

• value (int) – Specifies Zadoff-Chu Index for the Long Training Sequence in the preamble. The default value is 7. Valid values are in the range of [1 - 16].

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int