Prach
SCPI Commands :
CONFigure:NRSub:MEASurement<Instance>:PRACh:TOUT
CONFigure:NRSub:MEASurement<Instance>:PRACh:REPetition
CONFigure:NRSub:MEASurement<Instance>:PRACh:SCONdition
CONFigure:NRSub:MEASurement<Instance>:PRACh:MOEXception
CONFigure:NRSub:MEASurement<Instance>:PRACh:PCINdex
CONFigure:NRSub:MEASurement<Instance>:PRACh:PFORmat
CONFigure:NRSub:MEASurement<Instance>:PRACh:SSYMbol
CONFigure:NRSub:MEASurement<Instance>:PRACh:SCSPacing
CONFigure:NRSub:MEASurement<Instance>:PRACh:NOPReambles
CONFigure:NRSub:MEASurement<Instance>:PRACh:POPReambles
CONFigure:NRSub:MEASurement<Instance>:PRACh:LRSindex
CONFigure:NRSub:MEASurement<Instance>:PRACh:ZCZone
- class PrachCls[source]
Prach commands group definition. 41 total commands, 7 Subgroups, 12 group commands
- get_lrs_index() int [source]
# SCPI: CONFigure:NRSub:MEASurement<Instance>:PRACh:LRSindex value: int = driver.configure.nrSubMeas.prach.get_lrs_index()
Specifies the logical root sequence index to be used for generation of the preamble sequence.
- return:
log_root_seq_index: No help available
- get_mo_exception() bool [source]
# SCPI: CONFigure:NRSub:MEASurement<Instance>:PRACh:MOEXception value: bool = driver.configure.nrSubMeas.prach.get_mo_exception()
Specifies whether measurement results that the CMP180 identifies as faulty or inaccurate are rejected.
- return:
meas_on_exception: OFF: Faulty results are rejected. ON: Results are never rejected.
- get_no_preambles() int [source]
# SCPI: CONFigure:NRSub:MEASurement<Instance>:PRACh:NOPReambles value: int = driver.configure.nrSubMeas.prach.get_no_preambles()
Specifies the number of preambles to be captured per measurement interval.
- return:
number_preamble: No help available
- get_pc_index() int [source]
# SCPI: CONFigure:NRSub:MEASurement<Instance>:PRACh:PCINdex value: int = driver.configure.nrSubMeas.prach.get_pc_index()
The PRACH configuration index identifies the PRACH configuration used by the UE (preamble format, which resources in the time domain are allowed for transmission of preambles etc.) . The range depends on the duplex mode, see ‘Preambles in the time domain’.
- return:
prach_conf_index: No help available
- get_pformat() PreambleFormat [source]
# SCPI: CONFigure:NRSub:MEASurement<Instance>:PRACh:PFORmat value: enums.PreambleFormat = driver.configure.nrSubMeas.prach.get_pformat()
Selects the preamble format. The command is only needed for PRACH configuration indices that allow two preamble formats, see tables in ‘Preambles in the time domain’.
- return:
preamble_format: No help available
- get_po_preambles() PeriodPreamble [source]
# SCPI: CONFigure:NRSub:MEASurement<Instance>:PRACh:POPReambles value: enums.PeriodPreamble = driver.configure.nrSubMeas.prach.get_po_preambles()
Specifies the periodicity of preambles to be captured for multi-preamble result squares.
- return:
period_preamble: 10 ms, 20 ms, 5 ms
- get_repetition() Repeat [source]
# SCPI: CONFigure:NRSub:MEASurement<Instance>:PRACh:REPetition value: enums.Repeat = driver.configure.nrSubMeas.prach.get_repetition()
Specifies the repetition mode of the measurement. The repetition mode specifies whether the measurement is stopped after a single shot or repeated continuously. Use CONFigure:..:MEAS<i>:…:SCOunt to determine the number of measurement intervals per single shot.
- return:
repetition: SINGleshot: Single-shot measurement CONTinuous: Continuous measurement
- get_sc_spacing() SubCarrSpacingB [source]
# SCPI: CONFigure:NRSub:MEASurement<Instance>:PRACh:SCSPacing value: enums.SubCarrSpacingB = driver.configure.nrSubMeas.prach.get_sc_spacing()
Specifies the subcarrier spacing used by the UE for the preambles. The allowed subset of values depends on the preamble format, see Table ‘Preambles in the frequency domain’.
- return:
sub_carr_spacing: 1.25 kHz, 5 kHz, 15 kHz, 30 kHz, 60 kHz
- get_scondition() StopCondition [source]
# SCPI: CONFigure:NRSub:MEASurement<Instance>:PRACh:SCONdition value: enums.StopCondition = driver.configure.nrSubMeas.prach.get_scondition()
Qualifies whether the measurement is stopped after a failed limit check or continued. SLFail means that the measurement is stopped and reaches the RDY state when one of the results exceeds the limits.
- return:
stop_condition: NONE: Continue measurement irrespective of the limit check. SLFail: Stop measurement on limit failure.
- get_ssymbol() int [source]
# SCPI: CONFigure:NRSub:MEASurement<Instance>:PRACh:SSYMbol value: int = driver.configure.nrSubMeas.prach.get_ssymbol()
Selects the OFDM symbol to be evaluated for single-symbol modulation result diagrams. The number of OFDM symbols in the preamble (<no of symbols>) depends on the preamble format, see Table ‘Preambles in the time domain’.
- return:
selected_symbol: No help available
- get_timeout() float [source]
# SCPI: CONFigure:NRSub:MEASurement<Instance>:PRACh:TOUT value: float = driver.configure.nrSubMeas.prach.get_timeout()
Defines a timeout for the measurement. The timer is started when the measurement is initiated via a READ or INIT command. It is not started if the measurement is initiated manually. When the measurement has completed the first measurement cycle (first single shot) , the statistical depth is reached and the timer is reset. If the first measurement cycle has not been completed when the timer expires, the measurement is stopped. The measurement state changes to RDY. The reliability indicator is set to 1, indicating that a measurement timeout occurred. Still running READ, FETCh or CALCulate commands are completed, returning the available results. At least for some results, there are no values at all or the statistical depth has not been reached. A timeout of 0 s corresponds to an infinite measurement timeout.
- return:
timeout: No help available
- get_zc_zone() int [source]
# SCPI: CONFigure:NRSub:MEASurement<Instance>:PRACh:ZCZone value: int = driver.configure.nrSubMeas.prach.get_zc_zone()
Specifies the zero correlation zone config, i.e. which NCS value of an NCS set is used for generation of the preamble sequence.
- return:
zero_corr_zone: No help available
- set_lrs_index(log_root_seq_index: int) None [source]
# SCPI: CONFigure:NRSub:MEASurement<Instance>:PRACh:LRSindex driver.configure.nrSubMeas.prach.set_lrs_index(log_root_seq_index = 1)
Specifies the logical root sequence index to be used for generation of the preamble sequence.
- param log_root_seq_index:
No help available
- set_mo_exception(meas_on_exception: bool) None [source]
# SCPI: CONFigure:NRSub:MEASurement<Instance>:PRACh:MOEXception driver.configure.nrSubMeas.prach.set_mo_exception(meas_on_exception = False)
Specifies whether measurement results that the CMP180 identifies as faulty or inaccurate are rejected.
- param meas_on_exception:
OFF: Faulty results are rejected. ON: Results are never rejected.
- set_no_preambles(number_preamble: int) None [source]
# SCPI: CONFigure:NRSub:MEASurement<Instance>:PRACh:NOPReambles driver.configure.nrSubMeas.prach.set_no_preambles(number_preamble = 1)
Specifies the number of preambles to be captured per measurement interval.
- param number_preamble:
No help available
- set_pc_index(prach_conf_index: int) None [source]
# SCPI: CONFigure:NRSub:MEASurement<Instance>:PRACh:PCINdex driver.configure.nrSubMeas.prach.set_pc_index(prach_conf_index = 1)
The PRACH configuration index identifies the PRACH configuration used by the UE (preamble format, which resources in the time domain are allowed for transmission of preambles etc.) . The range depends on the duplex mode, see ‘Preambles in the time domain’.
- param prach_conf_index:
No help available
- set_pformat(preamble_format: PreambleFormat) None [source]
# SCPI: CONFigure:NRSub:MEASurement<Instance>:PRACh:PFORmat driver.configure.nrSubMeas.prach.set_pformat(preamble_format = enums.PreambleFormat.PF0)
Selects the preamble format. The command is only needed for PRACH configuration indices that allow two preamble formats, see tables in ‘Preambles in the time domain’.
- param preamble_format:
No help available
- set_po_preambles(period_preamble: PeriodPreamble) None [source]
# SCPI: CONFigure:NRSub:MEASurement<Instance>:PRACh:POPReambles driver.configure.nrSubMeas.prach.set_po_preambles(period_preamble = enums.PeriodPreamble.MS05)
Specifies the periodicity of preambles to be captured for multi-preamble result squares.
- param period_preamble:
10 ms, 20 ms, 5 ms
- set_repetition(repetition: Repeat) None [source]
# SCPI: CONFigure:NRSub:MEASurement<Instance>:PRACh:REPetition driver.configure.nrSubMeas.prach.set_repetition(repetition = enums.Repeat.CONTinuous)
Specifies the repetition mode of the measurement. The repetition mode specifies whether the measurement is stopped after a single shot or repeated continuously. Use CONFigure:..:MEAS<i>:…:SCOunt to determine the number of measurement intervals per single shot.
- param repetition:
SINGleshot: Single-shot measurement CONTinuous: Continuous measurement
- set_sc_spacing(sub_carr_spacing: SubCarrSpacingB) None [source]
# SCPI: CONFigure:NRSub:MEASurement<Instance>:PRACh:SCSPacing driver.configure.nrSubMeas.prach.set_sc_spacing(sub_carr_spacing = enums.SubCarrSpacingB.S15K)
Specifies the subcarrier spacing used by the UE for the preambles. The allowed subset of values depends on the preamble format, see Table ‘Preambles in the frequency domain’.
- param sub_carr_spacing:
1.25 kHz, 5 kHz, 15 kHz, 30 kHz, 60 kHz
- set_scondition(stop_condition: StopCondition) None [source]
# SCPI: CONFigure:NRSub:MEASurement<Instance>:PRACh:SCONdition driver.configure.nrSubMeas.prach.set_scondition(stop_condition = enums.StopCondition.NONE)
Qualifies whether the measurement is stopped after a failed limit check or continued. SLFail means that the measurement is stopped and reaches the RDY state when one of the results exceeds the limits.
- param stop_condition:
NONE: Continue measurement irrespective of the limit check. SLFail: Stop measurement on limit failure.
- set_ssymbol(selected_symbol: int) None [source]
# SCPI: CONFigure:NRSub:MEASurement<Instance>:PRACh:SSYMbol driver.configure.nrSubMeas.prach.set_ssymbol(selected_symbol = 1)
Selects the OFDM symbol to be evaluated for single-symbol modulation result diagrams. The number of OFDM symbols in the preamble (<no of symbols>) depends on the preamble format, see Table ‘Preambles in the time domain’.
- param selected_symbol:
No help available
- set_timeout(timeout: float) None [source]
# SCPI: CONFigure:NRSub:MEASurement<Instance>:PRACh:TOUT driver.configure.nrSubMeas.prach.set_timeout(timeout = 1.0)
Defines a timeout for the measurement. The timer is started when the measurement is initiated via a READ or INIT command. It is not started if the measurement is initiated manually. When the measurement has completed the first measurement cycle (first single shot) , the statistical depth is reached and the timer is reset. If the first measurement cycle has not been completed when the timer expires, the measurement is stopped. The measurement state changes to RDY. The reliability indicator is set to 1, indicating that a measurement timeout occurred. Still running READ, FETCh or CALCulate commands are completed, returning the available results. At least for some results, there are no values at all or the statistical depth has not been reached. A timeout of 0 s corresponds to an infinite measurement timeout.
- param timeout:
No help available
- set_zc_zone(zero_corr_zone: int) None [source]
# SCPI: CONFigure:NRSub:MEASurement<Instance>:PRACh:ZCZone driver.configure.nrSubMeas.prach.set_zc_zone(zero_corr_zone = 1)
Specifies the zero correlation zone config, i.e. which NCS value of an NCS set is used for generation of the preamble sequence.
- param zero_corr_zone:
No help available
Cloning the Group
# Create a clone of the original group, that exists independently
group2 = driver.configure.nrSubMeas.prach.clone()
Subgroups