RetrieveIqSamplesFromCapturedPktsCommand Object


Description:

Retrieve IQ Samples from captured ORAN User Data packets

- Wireshark/TShark is required.

- After installation, Wireshark path must be added to the PATH environmental variable.

- Output IQ sample file is stored at: <User Data Path>\Retrieved IQ Sample Files\

- User Data Path may be modified in Options -> User Data.

Can be used with Command Sequencer: Yes

GUI Command Name: eCPRI: Retrieve IQ Samples From Captured Packets

RetrieveIqSamplesFromCapturedPktsCommand Writable Attributes

Attribute Description
CaptureFileName

Name of the file from which to Retrieve IQ Samples

Type: inputFilePath

Default: "" (empty string)

CaptureInput

Indicates whether to retrieve IQ samples from a configured capture file or a port

Type: enum

Default: CAPTURE_PORT

Possible Values:

Value Description
CAPTURE_FILE_NAME

Retrieve IQ samples from configured capture file

CAPTURE_PORT

Retrieve IQ samples from configured capture port

CapturePort

Retrieve IQ Samples from captured packets on selected port handle.

Type: handle

Default: "" (empty string)

DstMacAddr

Retrieve IQ samples from user data packets with configured Destination MAC Address

Type: mac

Default: 00:00:00:00:00:00

EaxcId

Retrieve IQ samples from user data packets with configured eAxC ID

Type: string

Default: 0010

EnableUdCompHdr

Enable if user data compression header is present in received user data packets

Type: bool

Default: FALSE

Possible Values:

Value Description
TRUE

User data compression header is present in received user data packets

FALSE

User data compression header is not present in received user data packets

EnableUdCompLenHdr

Enable if user data Comp Length(PRB Field Length) is present in received user data packets

Type: bool

Default: FALSE

Possible Values:

Value Description
TRUE

User data Compression Length(PRB Field Length) is received in user data packets

FALSE

User data Compression Length(PRB Field Length) is not present in received user data packets

IqSampleFileName

Name of the file to store retrieved IQ samples

Type: string

Default: IQ_Sample

NumOfRadioFrames

Number of radio frames from which to retrieve IQ samples

Type: u8

Default: 1

ReMask

reMask for DL and UL allocation

Type: string

Default: 111111111111

SrcMacAddr

Retrieve IQ samples from user data packets with configured Source MAC Address

Type: mac

Default: 00:00:00:00:00:00

UdCompressionMethod

Compression Method to be used if the user data compression header is not present in the received user data packets.

Type: enum

Default: BLOCK_FLOATING_POINT

Possible Values:

Value Description
NO_COMPRESSION

No Compression

BLOCK_FLOATING_POINT

Block Floating Point Compression Method

BLOCK_SCALING

Block Scaling Compression Method

MU_LAW

MuLaw Compression Method

BFP_SELECTIVE_RE_SENDING

BFP Selective RE Sending Compression Method

UdMantissaMode

Mantissa Mode (IQ Width) if user data compression header is not present in received user data packets

Type: enum

Default: MANTISSA_9_BIT

Possible Values:

Value Description
MANTISSA_1_BIT

1-Bit Mantissa Mode

MANTISSA_2_BIT

2-Bit Mantissa Mode

MANTISSA_3_BIT

3-Bit Mantissa Mode

MANTISSA_4_BIT

4-Bit Mantissa Mode

MANTISSA_5_BIT

5-Bit Mantissa Mode

MANTISSA_6_BIT

6-Bit Mantissa Mode

MANTISSA_7_BIT

7-Bit Mantissa Mode

MANTISSA_8_BIT

8-Bit Mantissa Mode

MANTISSA_9_BIT

9-Bit Mantissa Mode

MANTISSA_10_BIT

10-Bit Mantissa Mode

MANTISSA_11_BIT

11-Bit Mantissa Mode

MANTISSA_12_BIT

12-Bit Mantissa Mode

MANTISSA_13_BIT

13-Bit Mantissa Mode

MANTISSA_14_BIT

14-Bit Mantissa Mode

MANTISSA_15_BIT

15-Bit Mantissa Mode

MANTISSA_16_BIT

16-Bit Mantissa Mode

UdpPort

Configure the UDP source or destination port if eCPRI encapsulation is over IPv4/IPv6 in the user data packets

Type: u16

Default: 0

RetrieveIqSamplesFromCapturedPktsCommand Read-Only Attributes

Read-Only Attribute Description
RetrievedIqSampleFileName

Retrieved IQ Sample file path

Type: outputFilePath

Default: "" (empty string)