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:ECODe
[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

Commands in total: 51

Subgroups: 3

Direct child commands: 45

class EcodeStruct

Structure for reading output parameters. Fields:

• Ecode: str: numeric

• Bitcount: int: integer Range: 8 to 8

get_aci() → BtoCsCtrlAci

# [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.

Returns:

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

get_ce_count() → int

# [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.

Returns:

conn_event_count: integer Range: 0 to 65535

get_cid() → int

# [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.

Returns:

config_id: integer Range: 0 to 3

get_csa_threec() → bool

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

Enables the channel selection algorithm #3c.

Returns:

csa_threec: 1 | ON | 0| OFF

get_csignal() → bool

# [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’.

Returns:

companion_signal: 1 | ON | 0| OFF

get_csp_capability() → BtoCsCtrlSyncPhy

# [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.

Returns:

sync_phy: LE2M

get_ecode() → EcodeStruct

# [SOURce<HW>]:BB:BTOoth:CS:CDATa:ECODe
value: EcodeStruct = driver.source.bb.btooth.cs.cdata.get_ecode()

Sets an 8-bit error code. For an LL_CS_TERMINATE_IND packet, informs the remote device about the termination of the connection.

Returns:

structure: for return value, see the help for EcodeStruct structure arguments.

get_eoffset() → int

# [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.

Returns:

event_offset: integer Range: 500 to 4e6

get_ma_path() → int

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

Sets the maximum Num_Ant paths.

Returns:

max_ant_path: integer Range: 1 to 4

get_mm_repetition() → int

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

Sets the main mode repetition.

Returns:

mm_repetition: integer Range: 0 to 3

get_mma_steps() → int

# [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.

Returns:

mm_max_steps: integer Range: 2 to 255

get_mmi_steps() → int

# [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.

Returns:

mm_min_steps: integer Range: 2 to 255

get_mmode() → BtoCsMainMode

# [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’.

Returns:

main_mode: MODE1 | MODE2 | MODE3 For a description, see method RsSmw.source.bb.btooth.cs.sevent.mmode.get() .

get_mp_length() → float

# [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.

Returns:

mp_length: float Range: 2.5 to 40959375

get_mp_supported() → int

# [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.

Returns:

mp_supported: integer Range: 0 to 4

get_mtype() → BtoCsCtrlModeType

# [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.

Returns:

mode_type: MODE3

get_mz_steps() → int

# [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.

Returns:

mode_0_steps: integer Range: 1 to 3

get_nant() → int

# [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.

Returns:

num_ant: integer Range: 1 to 4

get_nconfig() → int

# [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.

Returns:

num_config: integer Range: 1 to 4

get_nfae() → bool

# [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.

Returns:

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<HW>]:BB:BTOoth:CS:CDATa:NRSCapability
value: enums.BtoCsCtrlNadm = driver.source.bb.btooth.cs.cdata.get_nrs_capability()

Sets the NADM random sequence capability.

Returns:

nrs_capability: NONADM | NADM NONADM NADM disabled NADM NADM enabled

get_ns_capability() → BtoCsCtrlNadm

# [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.

Returns:

ns_capability: NONADM | NADM NONADM NADM disabled NADM NADM enabled

get_omax() → int

# [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.

Returns:

offset_max: integer Range: 500 to 16777215

get_omin() → int

# [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.

Returns:

offset_min: integer Range: 500 to 4e6

get_pcount() → int

# [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.

Returns:

proc_count: integer Range: 1 to 65535

get_pdelta() → int

# [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.

Returns:

pwr_delta: integer Range: 0 to 255

get_phy() → BtoPackFormat

# [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.

Returns:

phy: L1M | L2M | LCOD | L2M2B For a description, see method RsSmw.source.bb.btooth.pformat() .

get_pinterval() → int

# [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.

Returns:

proc_interval: integer Range: 0 to 65535

get_pp_antenna() → BtoCsCtrlAnt

# [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.

Returns:

pp_antenna: ANT0 | ANT1 | ANT2 | ANT3

get_ra_only() → BtoCsCtrlAccReq

# [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.

Returns:

rtt_aa_only: AR150 | AR10 | AR0

get_rcapability() → BtoCsCtrlRttCap

# [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.

Returns:

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

get_rfu() → int

# [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.

Returns:

rfu: integer Range: 0 to 3

get_rr_sequence() → BtoCsCtrlAccReq

# [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.

Returns:

rr_sequence: AR150 | AR10 | AR0

get_rsounding() → BtoCsCtrlAccReq

# [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.

Returns:

rsounding: AR150 | AR10 | AR0

get_rtype() → BtoCsCtrlRttType

# [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.

get_sinterval() → int

# [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 method RsSmw.source.bb.btooth.cs.cdata.snumber() .

Returns:

sub_interval: integer Range: 0 to 2.7e11

get_slength() → int

# [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.

Returns:

sub_length: integer Range: 1250 to 4e6

get_smode() → BtoCsSubMode

# [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.

Returns:

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<HW>]:BB:BTOoth:CS:CDATa:SNUMber
value: int = driver.source.bb.btooth.cs.cdata.get_snumber()

Sets the number of subevents per event.

Returns:

sub_number: integer Range: 1 to 32

get_sp_estimate() → bool

# [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.

Returns:

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<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.

Returns:

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<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.

Returns:

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<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.

Returns:

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<HW>]:BB:BTOoth:CS:CDATa:TPM
value: enums.BtoCsTpm = driver.source.bb.btooth.cs.cdata.get_tpm()

Sets the time ‘T_PM’ in microseconds.

Returns:

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

get_tsw() → BtoCsTsw

# [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.

Returns:

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 copy of the original group, that exists independently
cdata_copy = driver.source.bb.btooth.cs.cdata.clone()

Subgroups

• Bposition<ChannelNull>
  • TfCapability
  • Tipo
    • Capability
  • Tipt
    • Capability
  • TpCapability
• Ccid
• Channel<ChannelNull>
  • Cfae