Mms

SCPI Commands :

[SOURce<HW>]:BB:LRWPan:MMS:MPFormat
[SOURce<HW>]:BB:LRWPan:MMS:NRIF
[SOURce<HW>]:BB:LRWPan:MMS:NRSF
[SOURce<HW>]:BB:LRWPan:MMS:RIOFfset
[SOURce<HW>]:BB:LRWPan:MMS:ROLE
[SOURce<HW>]:BB:LRWPan:MMS:RPDuration
[SOURce<HW>]:BB:LRWPan:MMS:RSDuration
[SOURce<HW>]:BB:LRWPan:MMS:RSOFfset
[SOURce<HW>]:BB:LRWPan:MMS:RSTU
[SOURce<HW>]:BB:LRWPan:MMS:SRF
[SOURce<HW>]:BB:LRWPan:MMS:SSCI
[SOURce<HW>]:BB:LRWPan:MMS:TFSYnc
[SOURce<HW>]:BB:[LRWPan]:MMS:ASL
[SOURce<HW>]:BB:[LRWPan]:MMS:ASN
[SOURce<HW>]:BB:[LRWPan]:MMS:BWIDth
[SOURce<HW>]:BB:[LRWPan]:MMS:CNUMber
[SOURce<HW>]:BB:[LRWPan]:MMS:F2MS
[SOURce<HW>]:BB:[LRWPan]:MMS:IINTerval

Commands in total: 33

Subgroups: 5

Direct child commands: 18

get_asl() → HrpUwbActSegmentLength

# [SOURce<HW>]:BB:[LRWPan]:MMS:ASL
value: enums.HrpUwbActSegmentLength = driver.source.bb.lrWpan.mms.get_asl()

Sets the active segment length.

Returns:

act_seg_length: ASL_16 | ASL_32 | ASL_64 | ASL_128 | ASL_256 | ASL_512 | ASL_1024 | ASL_2048

get_asn() → HrpUwbActSegmentNum

# [SOURce<HW>]:BB:[LRWPan]:MMS:ASN
value: enums.HrpUwbActSegmentNum = driver.source.bb.lrWpan.mms.get_asn()

Requires [:SOURce<hw>]:BB:LRWPan | HUWB:STD BPRF | HPRF | EHPRF | SENS. Sets the number of active segments.

Returns:

acg_seg_number: ASN_1 | ASN_2 | ASN_3 | ASN_4

get_bandwidth() → float

# [SOURce<HW>]:BB:[LRWPan]:MMS:BWIDth
value: float = driver.source.bb.lrWpan.mms.get_bandwidth()

Queries the channel bandwidth. The bandwidth depends on the channel number.

get_cnumber() → int

# [SOURce<HW>]:BB:[LRWPan]:MMS:CNUMber
value: int = driver.source.bb.lrWpan.mms.get_cnumber()

Sets the channel number that is a 4-bit value in decimal representation. The channel number determines the bandwidth and the code index.

Returns:

channel_number: integer Range: 0 to 15

get_f_2_ms() → bool

# [SOURce<HW>]:BB:[LRWPan]:MMS:F2MS
value: bool = driver.source.bb.lrWpan.mms.get_f_2_ms()

Sets the frame length of a generated waveform shorter than 2 ms to a fixed value of 2 ms. If activated, the idle interval is set to 0.0 us by default. Generated waveforms longer than 2 ms remain unaffected.

Returns:

fixed_2_ms_frame: 1 | ON | 0| OFF

get_iinterval() → float

# [SOURce<HW>]:BB:[LRWPan]:MMS:IINTerval
value: float = driver.source.bb.lrWpan.mms.get_iinterval()

Sets the time of the interval separating two frames.

Returns:

iinterval: float Range: 0 to 1000000, Unit: us

get_mp_format() → HrpUwbMmsPktTyp

# [SOURce<HW>]:BB:LRWPan:MMS:MPFormat
value: enums.HrpUwbMmsPktTyp = driver.source.bb.lrWpan.mms.get_mp_format()

Sets the packet format for multi-millisecond ranging.

Returns:

mms_pkt_format: RSF | RIF | BOTH RSF The MMS packet composed of ranging sequence fragments (RSF) , consisting of a repetition of a selected multi-millisecond ranging sequence (MMRS) symbol. RIF The MMS packet composed of ranging integrity fragments (RIF) , consisting of a sequence of active scrambled timestamp sequence (STS) pulses. BOTH The MMS packet composed of both ranging sequence fragments and ranging integrity fragments.

get_nrif() → HrpUwbMmsrFragNumRif

# [SOURce<HW>]:BB:LRWPan:MMS:NRIF
value: enums.HrpUwbMmsrFragNumRif = driver.source.bb.lrWpan.mms.get_nrif()

Sets the number of RIF fragments in the MMS ranging phase.

Returns:

rif_number: FN0 | FN1 | FN2 | FN4 | FN8

get_nrsf() → HrpUwbMmsrFragNumRsf

# [SOURce<HW>]:BB:LRWPan:MMS:NRSF
value: enums.HrpUwbMmsrFragNumRsf = driver.source.bb.lrWpan.mms.get_nrsf()

Sets the number of RSF fragments in the MMS ranging phase.

Returns:

rsf_number: FN0 | FN1 | FN2 | FN4 | FN8 | FN16

get_ri_offset() → int

# [SOURce<HW>]:BB:LRWPan:MMS:RIOFfset
value: int = driver.source.bb.lrWpan.mms.get_ri_offset()

Requires [:SOURce<hw>]:BB:LRWPan:MMS:MPFormat BOTH. Queries the number of RSTU from the start of the last RSF fragment in the MMS ranging pahse after which the initiator starts to transmit the first RIF fragment into the MMS ranging phase.

Returns:

rif_offset: integer Range: 2400 to 2400

get_role() → HrpUwbRangingRole

# [SOURce<HW>]:BB:LRWPan:MMS:ROLE
value: enums.HrpUwbRangingRole = driver.source.bb.lrWpan.mms.get_role()

Sets the role for the MMS ranging round.

Returns:

role: RESP | INIT RESP The responder is the complementary role to the initiator in the ranging process. For example, the responder receives requests and generates and sends responses. INIT The initiator controls the ranging process between the devices. For example, the initiator initiates the ranging process and executes distance calculation.

get_rp_duration() → int

# [SOURce<HW>]:BB:LRWPan:MMS:RPDuration
value: int = driver.source.bb.lrWpan.mms.get_rp_duration()

Sets the number of slots within the MMS ranging phase. The available range of the ranging phase duration depends on the MMS packet format set with method RsSmw.source.bb.lrWpan.mms.mp_format() .

Returns:

rp_duration: integer Range: 0 to 4095

get_rs_duration() → HrpUwbMmsrSlotDur

# [SOURce<HW>]:BB:LRWPan:MMS:RSDuration
value: enums.HrpUwbMmsrSlotDur = driver.source.bb.lrWpan.mms.get_rs_duration()

Selects the duration of each ranging slot in RSTU (ranging scheduling time unit) . A ranging slot refers to a specific time interval allocated for the transmission and reception of ranging messages between devices.

Returns:

rs_duration: SD3 | SD6 | SD9 | SD12 | SD15 | SD18 | SD21 | SD24

get_rs_offset() → int

# [SOURce<HW>]:BB:LRWPan:MMS:RSOFfset
value: int = driver.source.bb.lrWpan.mms.get_rs_offset()

Sets the number of slots after which the initiator starts to transmit the first RSF fragment into the MMS ranging phase.

Returns:

rsf_offset: integer Range: 0 to 15

get_rstu() → int

# [SOURce<HW>]:BB:LRWPan:MMS:RSTU
value: int = driver.source.bb.lrWpan.mms.get_rstu()

Queries the size of the ranging scheduling time unit (RSTU) .

Returns:

rstu: integer Range: 416 to 416

get_srf() → bool

# [SOURce<HW>]:BB:LRWPan:MMS:SRF
value: bool = driver.source.bb.lrWpan.mms.get_srf()

Sets the RF output frequency automatically to the value of the channel center frequency according to the selected channel number. You can still adjust the RF frequency afterwards.

Returns:

set_rf: 1 | ON | 0| OFF

get_ssci() → HrpUwbCodeIndexSsci

# [SOURce<HW>]:BB:LRWPan:MMS:SSCI
value: enums.HrpUwbCodeIndexSsci = driver.source.bb.lrWpan.mms.get_ssci()

Requires [:SOURce<hw>]:BB:LRWPan:MMS:TFSYnc 1. Queries or sets the code index used for the SYNC and SFD in the MMS packet, depending on the MMS packet format.

Returns:

ssci: CI_25 | CI_26 | CI_27 | CI_28 | CI_29 | CI_30 | CI_31 | CI_32

get_tf_sync() → bool

# [SOURce<HW>]:BB:LRWPan:MMS:TFSYnc
value: bool = driver.source.bb.lrWpan.mms.get_tf_sync()

Enables a fragment consisting of SYNC and SFD preceding the MMS ranging phase for initial timing and frequency synchronization.

Returns:

time_freq_sync: 1 | ON | 0| OFF

set_asl(act_seg_length: HrpUwbActSegmentLength) → None

# [SOURce<HW>]:BB:[LRWPan]:MMS:ASL
driver.source.bb.lrWpan.mms.set_asl(act_seg_length = enums.HrpUwbActSegmentLength.ASL_1024)

Sets the active segment length.

Parameters:

act_seg_length – ASL_16 | ASL_32 | ASL_64 | ASL_128 | ASL_256 | ASL_512 | ASL_1024 | ASL_2048

set_asn(acg_seg_number: HrpUwbActSegmentNum) → None

# [SOURce<HW>]:BB:[LRWPan]:MMS:ASN
driver.source.bb.lrWpan.mms.set_asn(acg_seg_number = enums.HrpUwbActSegmentNum.ASN_1)

Requires [:SOURce<hw>]:BB:LRWPan | HUWB:STD BPRF | HPRF | EHPRF | SENS. Sets the number of active segments.

Parameters:

acg_seg_number – ASN_1 | ASN_2 | ASN_3 | ASN_4

set_cnumber(channel_number: int) → None

# [SOURce<HW>]:BB:[LRWPan]:MMS:CNUMber
driver.source.bb.lrWpan.mms.set_cnumber(channel_number = 1)

Sets the channel number that is a 4-bit value in decimal representation. The channel number determines the bandwidth and the code index.

Parameters:

channel_number – integer Range: 0 to 15

set_f_2_ms(fixed_2_ms_frame: bool) → None

# [SOURce<HW>]:BB:[LRWPan]:MMS:F2MS
driver.source.bb.lrWpan.mms.set_f_2_ms(fixed_2_ms_frame = False)

Sets the frame length of a generated waveform shorter than 2 ms to a fixed value of 2 ms. If activated, the idle interval is set to 0.0 us by default. Generated waveforms longer than 2 ms remain unaffected.

Parameters:

fixed_2_ms_frame – 1 | ON | 0| OFF

set_iinterval(iinterval: float) → None

# [SOURce<HW>]:BB:[LRWPan]:MMS:IINTerval
driver.source.bb.lrWpan.mms.set_iinterval(iinterval = 1.0)

Sets the time of the interval separating two frames.

Parameters:

iinterval – float Range: 0 to 1000000, Unit: us

set_mp_format(mms_pkt_format: HrpUwbMmsPktTyp) → None

# [SOURce<HW>]:BB:LRWPan:MMS:MPFormat
driver.source.bb.lrWpan.mms.set_mp_format(mms_pkt_format = enums.HrpUwbMmsPktTyp.BOTH)

Sets the packet format for multi-millisecond ranging.

Parameters:

mms_pkt_format – RSF | RIF | BOTH RSF The MMS packet composed of ranging sequence fragments (RSF) , consisting of a repetition of a selected multi-millisecond ranging sequence (MMRS) symbol. RIF The MMS packet composed of ranging integrity fragments (RIF) , consisting of a sequence of active scrambled timestamp sequence (STS) pulses. BOTH The MMS packet composed of both ranging sequence fragments and ranging integrity fragments.

set_nrif(rif_number: HrpUwbMmsrFragNumRif) → None

# [SOURce<HW>]:BB:LRWPan:MMS:NRIF
driver.source.bb.lrWpan.mms.set_nrif(rif_number = enums.HrpUwbMmsrFragNumRif.FN0)

Sets the number of RIF fragments in the MMS ranging phase.

Parameters:

rif_number – FN0 | FN1 | FN2 | FN4 | FN8

set_nrsf(rsf_number: HrpUwbMmsrFragNumRsf) → None

# [SOURce<HW>]:BB:LRWPan:MMS:NRSF
driver.source.bb.lrWpan.mms.set_nrsf(rsf_number = enums.HrpUwbMmsrFragNumRsf.FN0)

Sets the number of RSF fragments in the MMS ranging phase.

Parameters:

rsf_number – FN0 | FN1 | FN2 | FN4 | FN8 | FN16

set_role(role: HrpUwbRangingRole) → None

# [SOURce<HW>]:BB:LRWPan:MMS:ROLE
driver.source.bb.lrWpan.mms.set_role(role = enums.HrpUwbRangingRole.INIT)

Sets the role for the MMS ranging round.

Parameters:

role – RESP | INIT RESP The responder is the complementary role to the initiator in the ranging process. For example, the responder receives requests and generates and sends responses. INIT The initiator controls the ranging process between the devices. For example, the initiator initiates the ranging process and executes distance calculation.

set_rp_duration(rp_duration: int) → None

# [SOURce<HW>]:BB:LRWPan:MMS:RPDuration
driver.source.bb.lrWpan.mms.set_rp_duration(rp_duration = 1)

Sets the number of slots within the MMS ranging phase. The available range of the ranging phase duration depends on the MMS packet format set with method RsSmw.source.bb.lrWpan.mms.mp_format() .

Parameters:

rp_duration – integer Range: 0 to 4095

set_rs_duration(rs_duration: HrpUwbMmsrSlotDur) → None

# [SOURce<HW>]:BB:LRWPan:MMS:RSDuration
driver.source.bb.lrWpan.mms.set_rs_duration(rs_duration = enums.HrpUwbMmsrSlotDur.SD12)

Selects the duration of each ranging slot in RSTU (ranging scheduling time unit) . A ranging slot refers to a specific time interval allocated for the transmission and reception of ranging messages between devices.

Parameters:

rs_duration – SD3 | SD6 | SD9 | SD12 | SD15 | SD18 | SD21 | SD24

set_rs_offset(rsf_offset: int) → None

# [SOURce<HW>]:BB:LRWPan:MMS:RSOFfset
driver.source.bb.lrWpan.mms.set_rs_offset(rsf_offset = 1)

Sets the number of slots after which the initiator starts to transmit the first RSF fragment into the MMS ranging phase.

Parameters:

rsf_offset – integer Range: 0 to 15

set_srf(set_rf: bool) → None

# [SOURce<HW>]:BB:LRWPan:MMS:SRF
driver.source.bb.lrWpan.mms.set_srf(set_rf = False)

Sets the RF output frequency automatically to the value of the channel center frequency according to the selected channel number. You can still adjust the RF frequency afterwards.

Parameters:

set_rf – 1 | ON | 0| OFF

set_ssci(ssci: HrpUwbCodeIndexSsci) → None

# [SOURce<HW>]:BB:LRWPan:MMS:SSCI
driver.source.bb.lrWpan.mms.set_ssci(ssci = enums.HrpUwbCodeIndexSsci.CI_25)

Requires [:SOURce<hw>]:BB:LRWPan:MMS:TFSYnc 1. Queries or sets the code index used for the SYNC and SFD in the MMS packet, depending on the MMS packet format.

Parameters:

ssci – CI_25 | CI_26 | CI_27 | CI_28 | CI_29 | CI_30 | CI_31 | CI_32

set_tf_sync(time_freq_sync: bool) → None

# [SOURce<HW>]:BB:LRWPan:MMS:TFSYnc
driver.source.bb.lrWpan.mms.set_tf_sync(time_freq_sync = False)

Enables a fragment consisting of SYNC and SFD preceding the MMS ranging phase for initial timing and frequency synchronization.

Parameters:

time_freq_sync – 1 | ON | 0| OFF

Cloning the Group

# Create a copy of the original group, that exists independently
mms_copy = driver.source.bb.lrWpan.mms.clone()

Subgroups

• Fconfig
• Rsf
• Setting
• Sfd
• Sts
  • Data