Cs

SCPI Commands :

[SOURce<HW>]:BB:BTOoth:CS:CFCHm
[SOURce<HW>]:BB:BTOoth:CS:CINTerval
[SOURce<HW>]:BB:BTOoth:CS:CMRepetition
[SOURce<HW>]:BB:BTOoth:CS:CSEL
[SOURce<HW>]:BB:BTOoth:CS:CTCJump
[SOURce<HW>]:BB:BTOoth:CS:CTCShape
[SOURce<HW>]:BB:BTOoth:CS:EINTerval
[SOURce<HW>]:BB:BTOoth:CS:EOFFset
[SOURce<HW>]:BB:BTOoth:CS:NTFCs
[SOURce<HW>]:BB:BTOoth:CS:ROLE
[SOURce<HW>]:BB:BTOoth:CS:SINTerval
[SOURce<HW>]:BB:BTOoth:CS:SLENgth
[SOURce<HW>]:BB:BTOoth:CS:SNUMber
[SOURce<HW>]:BB:BTOoth:CS:SSCHeduling

class CsCls[source]

Cs commands group definition. 109 total commands, 9 Subgroups, 14 group commands

class CfChmStruct[source]

Structure for reading output parameters. Fields:

Cs_Filtered_Ch_M: str: numeric CSFilteredChM value in hexadecimal representation.
Bitcount: int: integer Fixed bit count of 80 bits. Range: 80 to 80

get_cf_chm() → CfChmStruct[source]

# SCPI: [SOURce<HW>]:BB:BTOoth:CS:CFCHm
value: CfChmStruct = driver.source.bb.btooth.cs.get_cf_chm()

Queries the value of the field CSFilteredChM. This value determines the bit map for the Channel Sounding channel map update procedure. The parameter is 64-bit in hexadecimal representation.

return:

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

get_cinterval() → float[source]

# SCPI: [SOURce<HW>]:BB:BTOoth:CS:CINTerval
value: float = driver.source.bb.btooth.cs.get_cinterval()

Sets the time of the LE connection interval. The anchor points of two consecutive CS events define the length of this interval.

return:

connect_interval: float Range: 7.5 to 4000

get_cm_repetition() → int[source]

# SCPI: [SOURce<HW>]:BB:BTOoth:CS:CMRepetition
value: int = driver.source.bb.btooth.cs.get_cm_repetition()

Sets the 3-bit ChM_Repetition field. The value equals the number of cycles of the ChM field for non-Mode-0 steps within a CS procedure.

return:

chm_repetition: integer Range: 1 to 3

get_csel() → BtoCsChSel[source]

# SCPI: [SOURce<HW>]:BB:BTOoth:CS:CSEL
value: enums.BtoCsChSel = driver.source.bb.btooth.cs.get_csel()

Sets the algorithm to select the channels.

return:

ch_sel: SEL_3B| SEL_3C SEL_3B Sets for Algorithm #3b channel selection algorithm. SEL_3C Sets for Algorithm #3c channel selection algorithm. For related parameters, see Table ‘Algorithm #3c parameters’.

get_ctc_jump() → BtoCsCh3Cjump[source]

# SCPI: [SOURce<HW>]:BB:BTOoth:CS:CTCJump
value: enums.BtoCsCh3Cjump = driver.source.bb.btooth.cs.get_ctc_jump()

Determines the number of skipped channels when rendering the channel shapes. The Ch3cJump field has a length of 1 octet and relates to the channel index values. Configure this field when using the channel selection algorithm Algorithm #3c: SOURce1:BB:BTOoth:CS:CSEL SEL_3C

return:

ch_three_cjump: JUMP_2| JUMP_3| JUMP_4| JUMP_5| JUMP_6| JUMP_7| JUMP_8 For Ch3cJump field parameters, see Table ‘Algorithm #3c parameters’.

get_ctc_shape() → BtoCsCh3Cshape[source]

# SCPI: [SOURce<HW>]:BB:BTOoth:CS:CTCShape
value: enums.BtoCsCh3Cshape = driver.source.bb.btooth.cs.get_ctc_shape()

Sets the bits of the Ch3cShape field. The field has a length of 4 bits and sets the shaping method of the rising and falling ramps of the channels. Configure this field when using the channel selection algorithm Algorithm #3c: SOURce1:BB:BTOoth:CS:CSEL SEL_3C

return:

ch_three_cshape: HAT| X HAT Channel with a rising ramp and a falling ramp. X Channel with interleaved rising and falling ramps.

get_einterval() → int[source]

# SCPI: [SOURce<HW>]:BB:BTOoth:CS:EINTerval
value: int = driver.source.bb.btooth.cs.get_einterval()

Sets the number of LE connection event intervals.

return:

event_interval: integer Range: 1 to 65535

get_eoffset() → int[source]

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

Sets the time between the anchor point of the LE connection event and the beginning of the CS event. If you select manual step scheduling, you can set event offsets lower than 500 microseconds. An offset of 0 microseconds means that the CS event starts at the anchor point of the LE connection event.

return:

event_offset: integer Range: 500 to 4e6

get_ntfcs() → bool[source]

# SCPI: [SOURce<HW>]:BB:BTOoth:CS:NTFCs
value: bool = driver.source.bb.btooth.cs.get_ntfcs()

Enables setting of a zero frequency change period (T_FCS) in the first CS step.

return:

no_tfcs: 1| ON| 0| OFF

get_role() → BtoCsRoles[source]

# SCPI: [SOURce<HW>]:BB:BTOoth:CS:ROLE
value: enums.BtoCsRoles = driver.source.bb.btooth.cs.get_role()

Sets the role of the channel sounding device that is the R&S SMW200A.

return:

role: INITiator| REFLector INITiator The instrument initiates a CS procedure. REFLector The instrument responds to a CS procedure.

get_sinterval() → int[source]

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

Sets the subevent interval. This interval is the time in multiples of 625 us between the beginning of a CS subevent and the beginning of the next CS subevent within the same CS event. For SOURce1:BB:BTO:CS:SNUM 1, the subevent interval is 0us. For SOURce1:BB:BTO:CS:SNUM 2 or higher, settable subevent intervals depend on the number of event intervals, the connection interval, the event offset and the subevent length. See also [:SOURce<hw>]:BB:BTOoth:CS:SNUMber.

return:

sub_interval: integer Range: 0 to 2.7e11

get_slength() → int[source]

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

Sets the subevent length that is the duration of a CS subevent. You can set values in multiples of 625 us. Settable subevent lengths depend on the number of event intervals, the connection interval, the event offset and the subevent interval.

return:

sub_length: integer Range: 1250 to 4e6

get_snumber() → int[source]

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

Sets number of subevents. Settable values depend on the subevent interval.

return:

sub_number: integer Range: 1 to 32

get_sscheduling() → AutoManualMode[source]

# SCPI: [SOURce<HW>]:BB:BTOoth:CS:SSCHeduling
value: enums.AutoManualMode = driver.source.bb.btooth.cs.get_sscheduling()

Sets the step scheduling mode.

return:

step_scheduling: AUTO| MANual AUTO Automatic CS step scheduling. The subevent length, the subevent interval and the number of subevents are configurable. The number of CS steps is 2. MANual Manual CS step scheduling. The subevent length is 1250 us, the subevent interval is 0 us and the number of subevents is 1. The number of CS steps is configurable.

set_cinterval(connect_interval: float) → None[source]

# SCPI: [SOURce<HW>]:BB:BTOoth:CS:CINTerval
driver.source.bb.btooth.cs.set_cinterval(connect_interval = 1.0)

Sets the time of the LE connection interval. The anchor points of two consecutive CS events define the length of this interval.

param connect_interval:

float Range: 7.5 to 4000

set_cm_repetition(chm_repetition: int) → None[source]

# SCPI: [SOURce<HW>]:BB:BTOoth:CS:CMRepetition
driver.source.bb.btooth.cs.set_cm_repetition(chm_repetition = 1)

Sets the 3-bit ChM_Repetition field. The value equals the number of cycles of the ChM field for non-Mode-0 steps within a CS procedure.

param chm_repetition:

integer Range: 1 to 3

set_csel(ch_sel: BtoCsChSel) → None[source]

# SCPI: [SOURce<HW>]:BB:BTOoth:CS:CSEL
driver.source.bb.btooth.cs.set_csel(ch_sel = enums.BtoCsChSel.SEL_3B)

Sets the algorithm to select the channels.

param ch_sel:

SEL_3B| SEL_3C SEL_3B Sets for Algorithm #3b channel selection algorithm. SEL_3C Sets for Algorithm #3c channel selection algorithm. For related parameters, see Table ‘Algorithm #3c parameters’.

set_ctc_jump(ch_three_cjump: BtoCsCh3Cjump) → None[source]

# SCPI: [SOURce<HW>]:BB:BTOoth:CS:CTCJump
driver.source.bb.btooth.cs.set_ctc_jump(ch_three_cjump = enums.BtoCsCh3Cjump.JUMP_2)

Determines the number of skipped channels when rendering the channel shapes. The Ch3cJump field has a length of 1 octet and relates to the channel index values. Configure this field when using the channel selection algorithm Algorithm #3c: SOURce1:BB:BTOoth:CS:CSEL SEL_3C

param ch_three_cjump:

JUMP_2| JUMP_3| JUMP_4| JUMP_5| JUMP_6| JUMP_7| JUMP_8 For Ch3cJump field parameters, see Table ‘Algorithm #3c parameters’.

set_ctc_shape(ch_three_cshape: BtoCsCh3Cshape) → None[source]

# SCPI: [SOURce<HW>]:BB:BTOoth:CS:CTCShape
driver.source.bb.btooth.cs.set_ctc_shape(ch_three_cshape = enums.BtoCsCh3Cshape.HAT)

Sets the bits of the Ch3cShape field. The field has a length of 4 bits and sets the shaping method of the rising and falling ramps of the channels. Configure this field when using the channel selection algorithm Algorithm #3c: SOURce1:BB:BTOoth:CS:CSEL SEL_3C

param ch_three_cshape:

HAT| X HAT Channel with a rising ramp and a falling ramp. X Channel with interleaved rising and falling ramps.

set_einterval(event_interval: int) → None[source]

# SCPI: [SOURce<HW>]:BB:BTOoth:CS:EINTerval
driver.source.bb.btooth.cs.set_einterval(event_interval = 1)

Sets the number of LE connection event intervals.

param event_interval:

integer Range: 1 to 65535

set_eoffset(event_offset: int) → None[source]

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

Sets the time between the anchor point of the LE connection event and the beginning of the CS event. If you select manual step scheduling, you can set event offsets lower than 500 microseconds. An offset of 0 microseconds means that the CS event starts at the anchor point of the LE connection event.

param event_offset:

integer Range: 500 to 4e6

set_ntfcs(no_tfcs: bool) → None[source]

# SCPI: [SOURce<HW>]:BB:BTOoth:CS:NTFCs
driver.source.bb.btooth.cs.set_ntfcs(no_tfcs = False)

Enables setting of a zero frequency change period (T_FCS) in the first CS step.

param no_tfcs:

1| ON| 0| OFF

set_role(role: BtoCsRoles) → None[source]

# SCPI: [SOURce<HW>]:BB:BTOoth:CS:ROLE
driver.source.bb.btooth.cs.set_role(role = enums.BtoCsRoles.INITiator)

Sets the role of the channel sounding device that is the R&S SMW200A.

param role:

INITiator| REFLector INITiator The instrument initiates a CS procedure. REFLector The instrument responds to a CS procedure.

set_sinterval(sub_interval: int) → None[source]

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

Sets the subevent interval. This interval is the time in multiples of 625 us between the beginning of a CS subevent and the beginning of the next CS subevent within the same CS event. For SOURce1:BB:BTO:CS:SNUM 1, the subevent interval is 0us. For SOURce1:BB:BTO:CS:SNUM 2 or higher, settable subevent intervals depend on the number of event intervals, the connection interval, the event offset and the subevent length. See also [:SOURce<hw>]:BB:BTOoth:CS:SNUMber.

param sub_interval:

integer Range: 0 to 2.7e11

set_slength(sub_length: int) → None[source]

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

Sets the subevent length that is the duration of a CS subevent. You can set values in multiples of 625 us. Settable subevent lengths depend on the number of event intervals, the connection interval, the event offset and the subevent interval.

param sub_length:

integer Range: 1250 to 4e6

set_snumber(sub_number: int) → None[source]

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

Sets number of subevents. Settable values depend on the subevent interval.

param sub_number:

integer Range: 1 to 32

set_sscheduling(step_scheduling: AutoManualMode) → None[source]

# SCPI: [SOURce<HW>]:BB:BTOoth:CS:SSCHeduling
driver.source.bb.btooth.cs.set_sscheduling(step_scheduling = enums.AutoManualMode.AUTO)

Sets the step scheduling mode.

param step_scheduling:

AUTO| MANual AUTO Automatic CS step scheduling. The subevent length, the subevent interval and the number of subevents are configurable. The number of CS steps is 2. MANual Manual CS step scheduling. The subevent length is 1250 us, the subevent interval is 0 us and the number of subevents is 1. The number of CS steps is configurable.

Cloning the Group

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

Subgroups

Cdata
- Bposition<ChannelNull>
  - TfCapability
  - Tipo
    - Capability
  - Tipt
    - Capability
  - TpCapability
- Ccid
- Channel<ChannelNull>
  - Cfae
- Ecode
Cinc
Cinp
Civc
Civp
CorrectionTable
- Channel<ChannelNull>
  - Callowed
  - Cfrequency
  - Cindex
  - Ctype
Cpvc
Cpvp
Sevent<ChannelNull>
- Data
- Dlist
- MmaSteps
- MmiSteps
- Mmode
- MmRepetition
- MmSteps
- Mone
  - Tipo
- Mthree
  - Nap
  - Tipt
  - Tpm
  - Tsw
- Mtwo
  - Nap
  - Tipt
  - Tpm
  - Tsw
- Mzero
  - Tipo
- MzSteps
- NoStep
- Pattern
- SeqLength
- Smode
- SmStep
- Sspace
- Step<StepNull>
  - CaAddress
  - Cindex
  - Csignal
  - CtExtension
  - Mtype
  - Scontent
- Stype
- Tfcs
- Upayload
- UpPattern