Cdata

SCPI Commands :

[SOURce<HW>]:BB:BTOoth:CS:CDATa:ACI
[SOURce<HW>]:BB:BTOoth:CS:CDATa:CECount
[SOURce<HW>]:BB:BTOoth:CS:CDATa:CID
[SOURce<HW>]:BB:BTOoth:CS:CDATa:CSAThreec
[SOURce<HW>]:BB:BTOoth:CS:CDATa:CSIGnal
[SOURce<HW>]:BB:BTOoth:CS:CDATa:CSPCapability
[SOURce<HW>]:BB:BTOoth:CS:CDATa:EOFFset
[SOURce<HW>]:BB:BTOoth:CS:CDATa:MAPath
[SOURce<HW>]:BB:BTOoth:CS:CDATa:MMASteps
[SOURce<HW>]:BB:BTOoth:CS:CDATa:MMISteps
[SOURce<HW>]:BB:BTOoth:CS:CDATa:MMODe
[SOURce<HW>]:BB:BTOoth:CS:CDATa:MMRepetition
[SOURce<HW>]:BB:BTOoth:CS:CDATa:MPLength
[SOURce<HW>]:BB:BTOoth:CS:CDATa:MPSupported
[SOURce<HW>]:BB:BTOoth:CS:CDATa:MTYPe
[SOURce<HW>]:BB:BTOoth:CS:CDATa:MZSTeps
[SOURce<HW>]:BB:BTOoth:CS:CDATa:NANT
[SOURce<HW>]:BB:BTOoth:CS:CDATa:NCONfig
[SOURce<HW>]:BB:BTOoth:CS:CDATa:NFAE
[SOURce<HW>]:BB:BTOoth:CS:CDATa:NRSCapability
[SOURce<HW>]:BB:BTOoth:CS:CDATa:NSCapability
[SOURce<HW>]:BB:BTOoth:CS:CDATa:OMAX
[SOURce<HW>]:BB:BTOoth:CS:CDATa:OMIN
[SOURce<HW>]:BB:BTOoth:CS:CDATa:PCOunt
[SOURce<HW>]:BB:BTOoth:CS:CDATa:PDELta
[SOURce<HW>]:BB:BTOoth:CS:CDATa:PHY
[SOURce<HW>]:BB:BTOoth:CS:CDATa:PINTerval
[SOURce<HW>]:BB:BTOoth:CS:CDATa:PPANtenna
[SOURce<HW>]:BB:BTOoth:CS:CDATa:RAONly
[SOURce<HW>]:BB:BTOoth:CS:CDATa:RCAPability
[SOURce<HW>]:BB:BTOoth:CS:CDATa:RFU
[SOURce<HW>]:BB:BTOoth:CS:CDATa:RRSequence
[SOURce<HW>]:BB:BTOoth:CS:CDATa:RSOunding
[SOURce<HW>]:BB:BTOoth:CS:CDATa:RTYPe
[SOURce<HW>]:BB:BTOoth:CS:CDATa:SINTerval
[SOURce<HW>]:BB:BTOoth:CS:CDATa:SLENgth
[SOURce<HW>]:BB:BTOoth:CS:CDATa:SMODe
[SOURce<HW>]:BB:BTOoth:CS:CDATa:SNUMber
[SOURce<HW>]:BB:BTOoth:CS:CDATa:SPEStimate
[SOURce<HW>]:BB:BTOoth:CS:CDATa:TFCS
[SOURce<HW>]:BB:BTOoth:CS:CDATa:TIONe
[SOURce<HW>]:BB:BTOoth:CS:CDATa:TITWo
[SOURce<HW>]:BB:BTOoth:CS:CDATa:TPM
[SOURce<HW>]:BB:BTOoth:CS:CDATa:TSW
class CdataCls[source]

Cdata commands group definition. 51 total commands, 4 Subgroups, 44 group commands

get_aci() BtoCsCtrlAci[source]
# SCPI: [SOURce<HW>]:BB:BTOoth:CS:CDATa:ACI
value: enums.BtoCsCtrlAci = driver.source.bb.btooth.cs.cdata.get_aci()

Sets the antenna configuration index (ACI) field. The value has a length of 1 octet or 0 to 7 in decimal representation.

return:

aci: ACI0| ACI1| ACI2| ACI3| ACI4| ACI5| ACI6| ACI7

get_ce_count() int[source]
# SCPI: [SOURce<HW>]:BB:BTOoth:CS:CDATa:CECount
value: int = driver.source.bb.btooth.cs.cdata.get_ce_count()

Sets the 16-bit connEventCount field bits in hexadecimal representation.

return:

conn_event_count: integer Range: 0 to 65535

get_cid() int[source]
# SCPI: [SOURce<HW>]:BB:BTOoth:CS:CDATa:CID
value: int = driver.source.bb.btooth.cs.cdata.get_cid()

Sets the 6-bit Config_ID field that is the CS configuration ID. Settable ID values are 2 bits in decimal representation. All other values are for future use.

return:

config_id: integer Range: 0 to 3

get_csa_threec() bool[source]
# SCPI: [SOURce<HW>]:BB:BTOoth:CS:CDATa:CSAThreec
value: bool = driver.source.bb.btooth.cs.cdata.get_csa_threec()

Enables the channel selection algorithm #3c.

return:

csa_threec: 1| ON| 0| OFF

get_csignal() bool[source]
# SCPI: [SOURce<HW>]:BB:BTOoth:CS:CDATa:CSIGnal
value: bool = driver.source.bb.btooth.cs.cdata.get_csignal()

Enables the companion signal. See also ‘Companion Signal’.

return:

companion_signal: 1| ON| 0| OFF

get_csp_capability() BtoCsCtrlSyncPhy[source]
# SCPI: [SOURce<HW>]:BB:BTOoth:CS:CDATa:CSPCapability
value: enums.BtoCsCtrlSyncPhy = driver.source.bb.btooth.cs.cdata.get_csp_capability()

Queries the value of the CS_SYNC_PHY_Capability field that is the LE 2M PHY.

return:

sync_phy: LE2M

get_eoffset() int[source]
# SCPI: [SOURce<HW>]:BB:BTOoth:CS:CDATa:EOFFset
value: int = driver.source.bb.btooth.cs.cdata.get_eoffset()

Sets the time value of the Offset field. The value has a length of three octets or 9 bits.

return:

event_offset: integer Range: 500 to 4e6

get_ma_path() int[source]
# SCPI: [SOURce<HW>]:BB:BTOoth:CS:CDATa:MAPath
value: int = driver.source.bb.btooth.cs.cdata.get_ma_path()

Sets the maximum Num_Ant paths.

return:

max_ant_path: integer Range: 1 to 4

get_mm_repetition() int[source]
# SCPI: [SOURce<HW>]:BB:BTOoth:CS:CDATa:MMRepetition
value: int = driver.source.bb.btooth.cs.cdata.get_mm_repetition()

Sets the main mode repetition.

return:

mm_repetition: integer Range: 0 to 3

get_mma_steps() int[source]
# SCPI: [SOURce<HW>]:BB:BTOoth:CS:CDATa:MMASteps
value: int = driver.source.bb.btooth.cs.cdata.get_mma_steps()

Sets the maximum number of main mode steps.

return:

mm_max_steps: integer Range: 2 to 255

get_mmi_steps() int[source]
# SCPI: [SOURce<HW>]:BB:BTOoth:CS:CDATa:MMISteps
value: int = driver.source.bb.btooth.cs.cdata.get_mmi_steps()

Sets the minimum number of main mode steps.

return:

mm_min_steps: integer Range: 2 to 255

get_mmode() BtoCsMainMode[source]
# SCPI: [SOURce<HW>]:BB:BTOoth:CS:CDATa:MMODe
value: enums.BtoCsMainMode = driver.source.bb.btooth.cs.cdata.get_mmode()

Sets the main mode of the CS LL Control PDU. For an overview on available submodes per main mode, see Table ‘CS step main modes and submodes’.

return:

main_mode: MODE1| MODE2| MODE3 For a description, see [:SOURcehw]:BB:BTOoth:CS[:SEVentch0]:MMODe.

get_mp_length() float[source]
# SCPI: [SOURce<HW>]:BB:BTOoth:CS:CDATa:MPLength
value: float = driver.source.bb.btooth.cs.cdata.get_mp_length()

Sets the time value of the Max_Procedure_Len field. The value has a length of two octets or 6 bits.

return:

mp_length: float Range: 2.5 to 40959375

get_mp_supported() int[source]
# SCPI: [SOURce<HW>]:BB:BTOoth:CS:CDATa:MPSupported
value: int = driver.source.bb.btooth.cs.cdata.get_mp_supported()

Sets the bits of the Max_Procedures_Supported field.

return:

mp_supported: integer Range: 0 to 4

get_mtype() BtoCsCtrlModeType[source]
# SCPI: [SOURce<HW>]:BB:BTOoth:CS:CDATa:MTYPe
value: enums.BtoCsCtrlModeType = driver.source.bb.btooth.cs.cdata.get_mtype()

Queries the CS LL control packet mode type that is Mode-3.

return:

mode_type: MODE3

get_mz_steps() int[source]
# SCPI: [SOURce<HW>]:BB:BTOoth:CS:CDATa:MZSTeps
value: int = driver.source.bb.btooth.cs.cdata.get_mz_steps()

Sets the number of Mode-0 steps.

return:

mode_0_steps: integer Range: 1 to 3

get_nant() int[source]
# SCPI: [SOURce<HW>]:BB:BTOoth:CS:CDATa:NANT
value: int = driver.source.bb.btooth.cs.cdata.get_nant()

Sets the bits of the Num_Ant field. This field indicates the number of antenna elements of the channel sounding device.

return:

num_ant: integer Range: 1 to 4

get_nconfig() int[source]
# SCPI: [SOURce<HW>]:BB:BTOoth:CS:CDATa:NCONfig
value: int = driver.source.bb.btooth.cs.cdata.get_nconfig()

Sets the Num_Configs field that relates to the number of independent CS configurations.

return:

num_config: integer Range: 1 to 4

get_nfae() bool[source]
# SCPI: [SOURce<HW>]:BB:BTOoth:CS:CDATa:NFAE
value: bool = driver.source.bb.btooth.cs.cdata.get_nfae()

Sets the No_FAE bit. This bit indicates if the transmitting LE device supports a fractional frequency offset actuation error (FAE) or not.

return:

no_fae: 1| ON| 0| OFF 1|ON The transmitting LE device only supports an FAE of zero. 0|OFF The transmitting LE device supports FAE values as listed in an FAE table.

get_nrs_capability() BtoCsCtrlNadm[source]
# SCPI: [SOURce<HW>]:BB:BTOoth:CS:CDATa:NRSCapability
value: enums.BtoCsCtrlNadm = driver.source.bb.btooth.cs.cdata.get_nrs_capability()

Sets the NADM random sequence capability.

return:

nrs_capability: NONADM| NADM NONADM NADM disabled NADM NADM enabled

get_ns_capability() BtoCsCtrlNadm[source]
# SCPI: [SOURce<HW>]:BB:BTOoth:CS:CDATa:NSCapability
value: enums.BtoCsCtrlNadm = driver.source.bb.btooth.cs.cdata.get_ns_capability()

Sets the NADM sounding sequence capability.

return:

ns_capability: NONADM| NADM NONADM NADM disabled NADM NADM enabled

get_omax() int[source]
# SCPI: [SOURce<HW>]:BB:BTOoth:CS:CDATa:OMAX
value: int = driver.source.bb.btooth.cs.cdata.get_omax()

Sets the time value of the Offset_Max field. The value has a length of 3 octets or 9 bits.

return:

offset_max: integer Range: 500 to 16777215

get_omin() int[source]
# SCPI: [SOURce<HW>]:BB:BTOoth:CS:CDATa:OMIN
value: int = driver.source.bb.btooth.cs.cdata.get_omin()

Sets the time value of the Offset_Min field. The value has a length of 3 octets or 9 bits.

return:

offset_min: integer Range: 500 to 4e6

get_pcount() int[source]
# SCPI: [SOURce<HW>]:BB:BTOoth:CS:CDATa:PCOunt
value: int = driver.source.bb.btooth.cs.cdata.get_pcount()

Sets the bits in the Procedure_Count field. The value has a length of 2 octets.

return:

proc_count: integer Range: 1 to 65535

get_pdelta() int[source]
# SCPI: [SOURce<HW>]:BB:BTOoth:CS:CDATa:PDELta
value: int = driver.source.bb.btooth.cs.cdata.get_pdelta()

Sets the bits in the Pwr_Delta field. The value has a length of 1 octets or 3 bits.

return:

pwr_delta: integer Range: 0 to 255

get_phy() BtoPackFormat[source]
# SCPI: [SOURce<HW>]:BB:BTOoth:CS:CDATa:PHY
value: enums.BtoPackFormat = driver.source.bb.btooth.cs.cdata.get_phy()

Queries the PHY field value. This value indicates the TX PHY of the remote device to which the Pwr_Delta field in this PDU applies.

return:

phy: L1M| L2M| LCOD| L2M2B For a description, see [:SOURcehw]:BB:BTOoth:PFORmat.

get_pinterval() int[source]
# SCPI: [SOURce<HW>]:BB:BTOoth:CS:CDATa:PINTerval
value: int = driver.source.bb.btooth.cs.cdata.get_pinterval()

Sets the procedure interval in the Procedure_Interval field. The value has a length of two octets or 6 bits.

return:

proc_interval: integer Range: 0 to 65535

get_pp_antenna() BtoCsCtrlAnt[source]
# SCPI: [SOURce<HW>]:BB:BTOoth:CS:CDATa:PPANtenna
value: enums.BtoCsCtrlAnt = driver.source.bb.btooth.cs.cdata.get_pp_antenna()

Sets the bits in the Preferred_Peer_Ant field. The value has a length of one octet or 3 bits. The table Table ‘Preferred_Peer_Ant field values’ lists all possible values and their meaning.

return:

pp_antenna: ANT0| ANT1| ANT2| ANT3

get_ra_only() BtoCsCtrlAccReq[source]
# SCPI: [SOURce<HW>]:BB:BTOoth:CS:CDATa:RAONly
value: enums.BtoCsCtrlAccReq = driver.source.bb.btooth.cs.cdata.get_ra_only()

Queries or sets the time values of the RTT_AA_Only_N field. Setting the value depends on the bits of the RTT_Capability field via the command: SOURce1:BB:BTOoth:CS:CDATa:RCAPability See also the table Table ‘RTT_Capability bit numbers and RTT fields’ for an overview.

return:

rtt_aa_only: AR150| AR10| AR0

get_rcapability() BtoCsCtrlRttCap[source]
# SCPI: [SOURce<HW>]:BB:BTOoth:CS:CDATa:RCAPability
value: enums.BtoCsCtrlRttCap = driver.source.bb.btooth.cs.cdata.get_rcapability()

Sets the bits in the RTT_Capability field. These bits determine the time values for the RTT_AA_Only_N field, the RTT_Sounding_ N field and the RTT_Random_Sequence_N field.

return:

rtt_capability: CAP0| CAP1| CAP2 See the table Table ‘RTT_Capability bit numbers and RTT fields’ for an overview.

get_rfu() int[source]
# SCPI: [SOURce<HW>]:BB:BTOoth:CS:CDATa:RFU
value: int = driver.source.bb.btooth.cs.cdata.get_rfu()

Sets the bits that are reserved for future use (RFU) . The number of RFU bits can vary depending on the CS_Control_Data PDU.

return:

rfu: integer Range: 0 to 3

get_rr_sequence() BtoCsCtrlAccReq[source]
# SCPI: [SOURce<HW>]:BB:BTOoth:CS:CDATa:RRSequence
value: enums.BtoCsCtrlAccReq = driver.source.bb.btooth.cs.cdata.get_rr_sequence()

Queries or sets the time values of the RTT_Random_Sequence_N field. Setting the value depends on the bits of the RTT_Capability field via the command: SOURce1:BB:BTOoth:CS:CDATa:RCAPability See also the table Table ‘RTT_Capability bit numbers and RTT fields’ for an overview.

return:

rr_sequence: AR150| AR10| AR0

get_rsounding() BtoCsCtrlAccReq[source]
# SCPI: [SOURce<HW>]:BB:BTOoth:CS:CDATa:RSOunding
value: enums.BtoCsCtrlAccReq = driver.source.bb.btooth.cs.cdata.get_rsounding()

Queries or sets the time values of the RTT_Sounding_N field. Setting the value depends on the bits of the RTT_Capability field via the command: SOURce1:BB:BTOoth:CS:CDATa:RCAPability See also the table Table ‘RTT_Capability bit numbers and RTT fields’ for an overview.

return:

rsounding: AR150| AR10| AR0

get_rtype() BtoCsCtrlRttType[source]
# SCPI: [SOURce<HW>]:BB:BTOoth:CS:CDATa:RTYPe
value: enums.BtoCsCtrlRttType = driver.source.bb.btooth.cs.cdata.get_rtype()

Sets the RTT type determined by the 4-bit RTT_Type field. This field indicates the round trip time (RTT) variant within the CS procedure.

return:

rtt_type: No help available

get_sinterval() int[source]
# SCPI: [SOURce<HW>]:BB:BTOoth:CS:CDATa:SINTerval
value: int = driver.source.bb.btooth.cs.cdata.get_sinterval()

Sets or queries the subevent interval. Setting requires BB:BTOoth:CS:SNUMber 2 or higher. Query is for BB:BTOoth:CS:SNUMber 1. See [:SOURce<hw>]:BB:BTOoth:CS:CDATa:SNUMber.

return:

sub_interval: integer Range: 0 to 2.7e11

get_slength() int[source]
# SCPI: [SOURce<HW>]:BB:BTOoth:CS:CDATa:SLENgth
value: int = driver.source.bb.btooth.cs.cdata.get_slength()

Sets the subevent length in the Subevent_Len field. The value has a length of three octets or 9 bits.

return:

sub_length: integer Range: 1250 to 4e6

get_smode() BtoCsSubMode[source]
# SCPI: [SOURce<HW>]:BB:BTOoth:CS:CDATa:SMODe
value: enums.BtoCsSubMode = driver.source.bb.btooth.cs.cdata.get_smode()

Sets the submode of the main mode.

return:

sub_mode: MODE1| MODE2| MODE3| NONE See the table Table ‘CS step main modes and submodes’ for an overview on available submodes per main mode.

get_snumber() int[source]
# SCPI: [SOURce<HW>]:BB:BTOoth:CS:CDATa:SNUMber
value: int = driver.source.bb.btooth.cs.cdata.get_snumber()

Sets the number of subevents per event.

return:

sub_number: integer Range: 1 to 32

get_sp_estimate() bool[source]
# SCPI: [SOURce<HW>]:BB:BTOoth:CS:CDATa:SPEStimate
value: bool = driver.source.bb.btooth.cs.cdata.get_sp_estimate()

Sets the Sounding_PCT_Estimate bit. This bit indicates if the device supports phase correction term (PCT) estimates from a sounding sequence or not.

return:

sp_estimate: 1| ON| 0| OFF 1|ON The Sounding_PCT_Estimate bit is 1. The device supports PCT estimates from a sounding sequence. 0|OFF The Sounding_PCT_Estimate bit is 0. The device does not support PCT estimates from a sounding sequence.

get_tfcs() BtoCsTfcs[source]
# SCPI: [SOURce<HW>]:BB:BTOoth:CS:CDATa:TFCS
value: enums.BtoCsTfcs = driver.source.bb.btooth.cs.cdata.get_tfcs()

Sets the frequency change period (T_FCS) between consecutive CS steps. The period ranges from 15 us to 150 us.

return:

tfcs: TFCS_15| TFCS_20| TFCS_30| TFCS_40| TFCS_50| TFCS_60| TFCS_80| TFCS_100| TFCS_120| TFCS_150 TFCS_x, x represents values in microseconds.

get_ti_one() BtoCsTiP1[source]
# SCPI: [SOURce<HW>]:BB:BTOoth:CS:CDATa:TIONe
value: enums.BtoCsTiP1 = driver.source.bb.btooth.cs.cdata.get_ti_one()

Sets the time ‘T_IP1’ in microseconds.

return:

tip_one: TIP1_10| TIP1_20| TIP1_30| TIP1_40| TIP1_50| TIP1_60| TIP1_80| TIP1_145 TP1_x, x represents values in microseconds.

get_ti_two() BtoCsTiP2[source]
# SCPI: [SOURce<HW>]:BB:BTOoth:CS:CDATa:TITWo
value: enums.BtoCsTiP2 = driver.source.bb.btooth.cs.cdata.get_ti_two()

Sets the time ‘T_IP2’ in microseconds.

return:

tip_two: TIP2_10| TIP2_20| TIP2_30| TIP2_40| TIP2_50| TIP2_60| TIP2_80| TIP2_145 TIP2_x, x represents values in microseconds.

get_tpm() BtoCsTpm[source]
# SCPI: [SOURce<HW>]:BB:BTOoth:CS:CDATa:TPM
value: enums.BtoCsTpm = driver.source.bb.btooth.cs.cdata.get_tpm()

Sets the time ‘T_PM’ in microseconds.

return:

tpm: TPM_10| TPM_20| TPM_40| TPM_652 TPM_x, x represents values in microseconds.

get_tsw() BtoCsTsw[source]
# SCPI: [SOURce<HW>]:BB:BTOoth:CS:CDATa:TSW
value: enums.BtoCsTsw = driver.source.bb.btooth.cs.cdata.get_tsw()

Sets the T_SW field values that relate to the duration of the antenna switch period. The local controller uses this period when switching antennas during active transmissions.

return:

tsw: TSW_0| TSW_1| TSW_2| TSW_4| TSW_10 Duration of the antenna switch period is 0, 1, 2, 4 or 10 microseconds.

set_aci(aci: BtoCsCtrlAci) None[source]
# SCPI: [SOURce<HW>]:BB:BTOoth:CS:CDATa:ACI
driver.source.bb.btooth.cs.cdata.set_aci(aci = enums.BtoCsCtrlAci.ACI0)

Sets the antenna configuration index (ACI) field. The value has a length of 1 octet or 0 to 7 in decimal representation.

param aci:

ACI0| ACI1| ACI2| ACI3| ACI4| ACI5| ACI6| ACI7

set_ce_count(conn_event_count: int) None[source]
# SCPI: [SOURce<HW>]:BB:BTOoth:CS:CDATa:CECount
driver.source.bb.btooth.cs.cdata.set_ce_count(conn_event_count = 1)

Sets the 16-bit connEventCount field bits in hexadecimal representation.

param conn_event_count:

integer Range: 0 to 65535

set_cid(config_id: int) None[source]
# SCPI: [SOURce<HW>]:BB:BTOoth:CS:CDATa:CID
driver.source.bb.btooth.cs.cdata.set_cid(config_id = 1)

Sets the 6-bit Config_ID field that is the CS configuration ID. Settable ID values are 2 bits in decimal representation. All other values are for future use.

param config_id:

integer Range: 0 to 3

set_csa_threec(csa_threec: bool) None[source]
# SCPI: [SOURce<HW>]:BB:BTOoth:CS:CDATa:CSAThreec
driver.source.bb.btooth.cs.cdata.set_csa_threec(csa_threec = False)

Enables the channel selection algorithm #3c.

param csa_threec:

1| ON| 0| OFF

set_csignal(companion_signal: bool) None[source]
# SCPI: [SOURce<HW>]:BB:BTOoth:CS:CDATa:CSIGnal
driver.source.bb.btooth.cs.cdata.set_csignal(companion_signal = False)

Enables the companion signal. See also ‘Companion Signal’.

param companion_signal:

1| ON| 0| OFF

set_eoffset(event_offset: int) None[source]
# SCPI: [SOURce<HW>]:BB:BTOoth:CS:CDATa:EOFFset
driver.source.bb.btooth.cs.cdata.set_eoffset(event_offset = 1)

Sets the time value of the Offset field. The value has a length of three octets or 9 bits.

param event_offset:

integer Range: 500 to 4e6

set_ma_path(max_ant_path: int) None[source]
# SCPI: [SOURce<HW>]:BB:BTOoth:CS:CDATa:MAPath
driver.source.bb.btooth.cs.cdata.set_ma_path(max_ant_path = 1)

Sets the maximum Num_Ant paths.

param max_ant_path:

integer Range: 1 to 4

set_mm_repetition(mm_repetition: int) None[source]
# SCPI: [SOURce<HW>]:BB:BTOoth:CS:CDATa:MMRepetition
driver.source.bb.btooth.cs.cdata.set_mm_repetition(mm_repetition = 1)

Sets the main mode repetition.

param mm_repetition:

integer Range: 0 to 3

set_mma_steps(mm_max_steps: int) None[source]
# SCPI: [SOURce<HW>]:BB:BTOoth:CS:CDATa:MMASteps
driver.source.bb.btooth.cs.cdata.set_mma_steps(mm_max_steps = 1)

Sets the maximum number of main mode steps.

param mm_max_steps:

integer Range: 2 to 255

set_mmi_steps(mm_min_steps: int) None[source]
# SCPI: [SOURce<HW>]:BB:BTOoth:CS:CDATa:MMISteps
driver.source.bb.btooth.cs.cdata.set_mmi_steps(mm_min_steps = 1)

Sets the minimum number of main mode steps.

param mm_min_steps:

integer Range: 2 to 255

set_mmode(main_mode: BtoCsMainMode) None[source]
# SCPI: [SOURce<HW>]:BB:BTOoth:CS:CDATa:MMODe
driver.source.bb.btooth.cs.cdata.set_mmode(main_mode = enums.BtoCsMainMode.MODE1)

Sets the main mode of the CS LL Control PDU. For an overview on available submodes per main mode, see Table ‘CS step main modes and submodes’.

param main_mode:

MODE1| MODE2| MODE3 For a description, see [:SOURcehw]:BB:BTOoth:CS[:SEVentch0]:MMODe.

set_mp_length(mp_length: float) None[source]
# SCPI: [SOURce<HW>]:BB:BTOoth:CS:CDATa:MPLength
driver.source.bb.btooth.cs.cdata.set_mp_length(mp_length = 1.0)

Sets the time value of the Max_Procedure_Len field. The value has a length of two octets or 6 bits.

param mp_length:

float Range: 2.5 to 40959375

set_mp_supported(mp_supported: int) None[source]
# SCPI: [SOURce<HW>]:BB:BTOoth:CS:CDATa:MPSupported
driver.source.bb.btooth.cs.cdata.set_mp_supported(mp_supported = 1)

Sets the bits of the Max_Procedures_Supported field.

param mp_supported:

integer Range: 0 to 4

set_mz_steps(mode_0_steps: int) None[source]
# SCPI: [SOURce<HW>]:BB:BTOoth:CS:CDATa:MZSTeps
driver.source.bb.btooth.cs.cdata.set_mz_steps(mode_0_steps = 1)

Sets the number of Mode-0 steps.

param mode_0_steps:

integer Range: 1 to 3

set_nant(num_ant: int) None[source]
# SCPI: [SOURce<HW>]:BB:BTOoth:CS:CDATa:NANT
driver.source.bb.btooth.cs.cdata.set_nant(num_ant = 1)

Sets the bits of the Num_Ant field. This field indicates the number of antenna elements of the channel sounding device.

param num_ant:

integer Range: 1 to 4

set_nconfig(num_config: int) None[source]
# SCPI: [SOURce<HW>]:BB:BTOoth:CS:CDATa:NCONfig
driver.source.bb.btooth.cs.cdata.set_nconfig(num_config = 1)

Sets the Num_Configs field that relates to the number of independent CS configurations.

param num_config:

integer Range: 1 to 4

set_nfae(no_fae: bool) None[source]
# SCPI: [SOURce<HW>]:BB:BTOoth:CS:CDATa:NFAE
driver.source.bb.btooth.cs.cdata.set_nfae(no_fae = False)

Sets the No_FAE bit. This bit indicates if the transmitting LE device supports a fractional frequency offset actuation error (FAE) or not.

param no_fae:

1| ON| 0| OFF 1|ON The transmitting LE device only supports an FAE of zero. 0|OFF The transmitting LE device supports FAE values as listed in an FAE table.

set_nrs_capability(nrs_capability: BtoCsCtrlNadm) None[source]
# SCPI: [SOURce<HW>]:BB:BTOoth:CS:CDATa:NRSCapability
driver.source.bb.btooth.cs.cdata.set_nrs_capability(nrs_capability = enums.BtoCsCtrlNadm.NADM)

Sets the NADM random sequence capability.

param nrs_capability:

NONADM| NADM NONADM NADM disabled NADM NADM enabled

set_ns_capability(ns_capability: BtoCsCtrlNadm) None[source]
# SCPI: [SOURce<HW>]:BB:BTOoth:CS:CDATa:NSCapability
driver.source.bb.btooth.cs.cdata.set_ns_capability(ns_capability = enums.BtoCsCtrlNadm.NADM)

Sets the NADM sounding sequence capability.

param ns_capability:

NONADM| NADM NONADM NADM disabled NADM NADM enabled

set_omax(offset_max: int) None[source]
# SCPI: [SOURce<HW>]:BB:BTOoth:CS:CDATa:OMAX
driver.source.bb.btooth.cs.cdata.set_omax(offset_max = 1)

Sets the time value of the Offset_Max field. The value has a length of 3 octets or 9 bits.

param offset_max:

integer Range: 500 to 16777215

set_omin(offset_min: int) None[source]
# SCPI: [SOURce<HW>]:BB:BTOoth:CS:CDATa:OMIN
driver.source.bb.btooth.cs.cdata.set_omin(offset_min = 1)

Sets the time value of the Offset_Min field. The value has a length of 3 octets or 9 bits.

param offset_min:

integer Range: 500 to 4e6

set_pcount(proc_count: int) None[source]
# SCPI: [SOURce<HW>]:BB:BTOoth:CS:CDATa:PCOunt
driver.source.bb.btooth.cs.cdata.set_pcount(proc_count = 1)

Sets the bits in the Procedure_Count field. The value has a length of 2 octets.

param proc_count:

integer Range: 1 to 65535

set_pdelta(pwr_delta: int) None[source]
# SCPI: [SOURce<HW>]:BB:BTOoth:CS:CDATa:PDELta
driver.source.bb.btooth.cs.cdata.set_pdelta(pwr_delta = 1)

Sets the bits in the Pwr_Delta field. The value has a length of 1 octets or 3 bits.

param pwr_delta:

integer Range: 0 to 255

set_pinterval(proc_interval: int) None[source]
# SCPI: [SOURce<HW>]:BB:BTOoth:CS:CDATa:PINTerval
driver.source.bb.btooth.cs.cdata.set_pinterval(proc_interval = 1)

Sets the procedure interval in the Procedure_Interval field. The value has a length of two octets or 6 bits.

param proc_interval:

integer Range: 0 to 65535

set_pp_antenna(pp_antenna: BtoCsCtrlAnt) None[source]
# SCPI: [SOURce<HW>]:BB:BTOoth:CS:CDATa:PPANtenna
driver.source.bb.btooth.cs.cdata.set_pp_antenna(pp_antenna = enums.BtoCsCtrlAnt.ANT0)

Sets the bits in the Preferred_Peer_Ant field. The value has a length of one octet or 3 bits. The table Table ‘Preferred_Peer_Ant field values’ lists all possible values and their meaning.

param pp_antenna:

ANT0| ANT1| ANT2| ANT3

set_ra_only(rtt_aa_only: BtoCsCtrlAccReq) None[source]
# SCPI: [SOURce<HW>]:BB:BTOoth:CS:CDATa:RAONly
driver.source.bb.btooth.cs.cdata.set_ra_only(rtt_aa_only = enums.BtoCsCtrlAccReq.AR0)

Queries or sets the time values of the RTT_AA_Only_N field. Setting the value depends on the bits of the RTT_Capability field via the command: SOURce1:BB:BTOoth:CS:CDATa:RCAPability See also the table Table ‘RTT_Capability bit numbers and RTT fields’ for an overview.

param rtt_aa_only:

AR150| AR10| AR0

set_rcapability(rtt_capability: BtoCsCtrlRttCap) None[source]
# SCPI: [SOURce<HW>]:BB:BTOoth:CS:CDATa:RCAPability
driver.source.bb.btooth.cs.cdata.set_rcapability(rtt_capability = enums.BtoCsCtrlRttCap.CAP0)

Sets the bits in the RTT_Capability field. These bits determine the time values for the RTT_AA_Only_N field, the RTT_Sounding_ N field and the RTT_Random_Sequence_N field.

param rtt_capability:

CAP0| CAP1| CAP2 See the table Table ‘RTT_Capability bit numbers and RTT fields’ for an overview.

set_rfu(rfu: int) None[source]
# SCPI: [SOURce<HW>]:BB:BTOoth:CS:CDATa:RFU
driver.source.bb.btooth.cs.cdata.set_rfu(rfu = 1)

Sets the bits that are reserved for future use (RFU) . The number of RFU bits can vary depending on the CS_Control_Data PDU.

param rfu:

integer Range: 0 to 3

set_rr_sequence(rr_sequence: BtoCsCtrlAccReq) None[source]
# SCPI: [SOURce<HW>]:BB:BTOoth:CS:CDATa:RRSequence
driver.source.bb.btooth.cs.cdata.set_rr_sequence(rr_sequence = enums.BtoCsCtrlAccReq.AR0)

Queries or sets the time values of the RTT_Random_Sequence_N field. Setting the value depends on the bits of the RTT_Capability field via the command: SOURce1:BB:BTOoth:CS:CDATa:RCAPability See also the table Table ‘RTT_Capability bit numbers and RTT fields’ for an overview.

param rr_sequence:

AR150| AR10| AR0

set_rsounding(rsounding: BtoCsCtrlAccReq) None[source]
# SCPI: [SOURce<HW>]:BB:BTOoth:CS:CDATa:RSOunding
driver.source.bb.btooth.cs.cdata.set_rsounding(rsounding = enums.BtoCsCtrlAccReq.AR0)

Queries or sets the time values of the RTT_Sounding_N field. Setting the value depends on the bits of the RTT_Capability field via the command: SOURce1:BB:BTOoth:CS:CDATa:RCAPability See also the table Table ‘RTT_Capability bit numbers and RTT fields’ for an overview.

param rsounding:

AR150| AR10| AR0

set_rtype(rtt_type: BtoCsCtrlRttType) None[source]
# SCPI: [SOURce<HW>]:BB:BTOoth:CS:CDATa:RTYPe
driver.source.bb.btooth.cs.cdata.set_rtype(rtt_type = enums.BtoCsCtrlRttType.R128RS)

Sets the RTT type determined by the 4-bit RTT_Type field. This field indicates the round trip time (RTT) variant within the CS procedure.

param rtt_type:

No help available

set_sinterval(sub_interval: int) None[source]
# SCPI: [SOURce<HW>]:BB:BTOoth:CS:CDATa:SINTerval
driver.source.bb.btooth.cs.cdata.set_sinterval(sub_interval = 1)

Sets or queries the subevent interval. Setting requires BB:BTOoth:CS:SNUMber 2 or higher. Query is for BB:BTOoth:CS:SNUMber 1. See [:SOURce<hw>]:BB:BTOoth:CS:CDATa:SNUMber.

param sub_interval:

integer Range: 0 to 2.7e11

set_slength(sub_length: int) None[source]
# SCPI: [SOURce<HW>]:BB:BTOoth:CS:CDATa:SLENgth
driver.source.bb.btooth.cs.cdata.set_slength(sub_length = 1)

Sets the subevent length in the Subevent_Len field. The value has a length of three octets or 9 bits.

param sub_length:

integer Range: 1250 to 4e6

set_smode(sub_mode: BtoCsSubMode) None[source]
# SCPI: [SOURce<HW>]:BB:BTOoth:CS:CDATa:SMODe
driver.source.bb.btooth.cs.cdata.set_smode(sub_mode = enums.BtoCsSubMode.MODE1)

Sets the submode of the main mode.

param sub_mode:

MODE1| MODE2| MODE3| NONE See the table Table ‘CS step main modes and submodes’ for an overview on available submodes per main mode.

set_snumber(sub_number: int) None[source]
# SCPI: [SOURce<HW>]:BB:BTOoth:CS:CDATa:SNUMber
driver.source.bb.btooth.cs.cdata.set_snumber(sub_number = 1)

Sets the number of subevents per event.

param sub_number:

integer Range: 1 to 32

set_sp_estimate(sp_estimate: bool) None[source]
# SCPI: [SOURce<HW>]:BB:BTOoth:CS:CDATa:SPEStimate
driver.source.bb.btooth.cs.cdata.set_sp_estimate(sp_estimate = False)

Sets the Sounding_PCT_Estimate bit. This bit indicates if the device supports phase correction term (PCT) estimates from a sounding sequence or not.

param sp_estimate:

1| ON| 0| OFF 1|ON The Sounding_PCT_Estimate bit is 1. The device supports PCT estimates from a sounding sequence. 0|OFF The Sounding_PCT_Estimate bit is 0. The device does not support PCT estimates from a sounding sequence.

set_tfcs(tfcs: BtoCsTfcs) None[source]
# SCPI: [SOURce<HW>]:BB:BTOoth:CS:CDATa:TFCS
driver.source.bb.btooth.cs.cdata.set_tfcs(tfcs = enums.BtoCsTfcs.TFCS_100)

Sets the frequency change period (T_FCS) between consecutive CS steps. The period ranges from 15 us to 150 us.

param tfcs:

TFCS_15| TFCS_20| TFCS_30| TFCS_40| TFCS_50| TFCS_60| TFCS_80| TFCS_100| TFCS_120| TFCS_150 TFCS_x, x represents values in microseconds.

set_ti_one(tip_one: BtoCsTiP1) None[source]
# SCPI: [SOURce<HW>]:BB:BTOoth:CS:CDATa:TIONe
driver.source.bb.btooth.cs.cdata.set_ti_one(tip_one = enums.BtoCsTiP1.TIP1_10)

Sets the time ‘T_IP1’ in microseconds.

param tip_one:

TIP1_10| TIP1_20| TIP1_30| TIP1_40| TIP1_50| TIP1_60| TIP1_80| TIP1_145 TP1_x, x represents values in microseconds.

set_ti_two(tip_two: BtoCsTiP2) None[source]
# SCPI: [SOURce<HW>]:BB:BTOoth:CS:CDATa:TITWo
driver.source.bb.btooth.cs.cdata.set_ti_two(tip_two = enums.BtoCsTiP2.TIP2_10)

Sets the time ‘T_IP2’ in microseconds.

param tip_two:

TIP2_10| TIP2_20| TIP2_30| TIP2_40| TIP2_50| TIP2_60| TIP2_80| TIP2_145 TIP2_x, x represents values in microseconds.

set_tpm(tpm: BtoCsTpm) None[source]
# SCPI: [SOURce<HW>]:BB:BTOoth:CS:CDATa:TPM
driver.source.bb.btooth.cs.cdata.set_tpm(tpm = enums.BtoCsTpm.TPM_10)

Sets the time ‘T_PM’ in microseconds.

param tpm:

TPM_10| TPM_20| TPM_40| TPM_652 TPM_x, x represents values in microseconds.

set_tsw(tsw: BtoCsTsw) None[source]
# SCPI: [SOURce<HW>]:BB:BTOoth:CS:CDATa:TSW
driver.source.bb.btooth.cs.cdata.set_tsw(tsw = enums.BtoCsTsw.TSW_0)

Sets the T_SW field values that relate to the duration of the antenna switch period. The local controller uses this period when switching antennas during active transmissions.

param tsw:

TSW_0| TSW_1| TSW_2| TSW_4| TSW_10 Duration of the antenna switch period is 0, 1, 2, 4 or 10 microseconds.

Cloning the Group

# Create a clone of the original group, that exists independently
group2 = driver.source.bb.btooth.cs.cdata.clone()

Subgroups