Capture

Capture-related classes and enumerations.

class excentis.xra31.capture.PacketType

An enumeration of the packet types used for filtering.

DATA = 0

Data.

BURST = 1

Burst.

OTHER = 2

Other.

RANGING = 3

Ranging.

BW_REQ = 4

Bandwidth Request.

class excentis.xra31.capture.OfdmStream

An enumeration of the OFDM streams that can be added or removed.

PLC = 0

Physical Layer Link Channel.

NCP = 1

Next Codeword Pointer.

class excentis.xra31.capture.OfdmProfile

An enumeration of the OFDM Profiles.

A = 0

Profile A.

B = 1

Profile B.

C = 2

Profile C.

D = 3

Profile D.

E = 4

Profile E.

F = 5

Profile F.

G = 6

Profile G.

H = 7

Profile H.

I = 8

Profile I.

J = 9

Profile J.

K = 10

Profile K.

L = 11

Profile L.

M = 12

Profile M.

N = 13

Profile N.

O = 14

Profile O.

P = 15

Profile P.

class excentis.xra31.capture.Channels(xra31)

Access and manipulate the capture channel selection.

property ofdm

Get the OFDM channels.

property sc_qam

Get the downstream SC-QAM channels.

property downstream

Get the downstream channels.

property ofdma

Get the OFDMA channels.

property a_tdma

Get the A-TDMA channels.

property upstream

Get the upstream channels.

property channels

Get all channels.

add(channel_parameters: excentis.xra31.core.Channel = None, *, channel_type: excentis.xra31.core.ChannelType = None, xra31_id: int = -1, ucid: int = -1, frequency: float = 0.0) → bool

Include a channel in the capture.

Parameters
  • channel_parameters (core.Channel, optional) – A channel containing the relevant parameters.

  • channel_type (core.ChannelType, optional) – The channel’s type.

  • xra31_id (int, optional) – ID on the XRA-31.

  • ucid (int, optional) – DOCSIS Upstream Channel ID.

  • frequency (float, optional) – PLC (OFDM) or center frequency (MHz).

Returns

True if successful, False otherwise.

Return type

bool

remove(channel_parameters: excentis.xra31.core.Channel = None, *, channel_type: excentis.xra31.core.ChannelType = None, xra31_id: int = -1, ucid: int = -1, frequency: float = 0.0) → bool

Don’t include a channel in the capture.

Parameters
  • channel_parameters (core.Channel, optional) – A channel containing the relevant parameters.

  • channel_type (core.ChannelType, optional) – The channel’s type.

  • xra31_id (int, optional) – ID on the XRA-31.

  • ucid (int, optional) – DOCSIS Upstream Channel ID.

  • frequency (float, optional) – PLC (OFDM) or center frequency (MHz).

Returns

True if successful, False otherwise.

Return type

bool

clear() → None

Ignore all channels.

describe() → dict

Get a minimal representation of the capture channel selection.

Returns

Description listing frequencies for downstream, and UCIDs for upstream.

Return type

dict

apply(description: dict) → None

Apply a capture channel selection.

Parameters

description (dict) – The selection description (describe()).

class excentis.xra31.capture.Filtering(xra31)

Access the capture filtering parameters, including the packet types, OFDM profiles and OFDM streams.

property packet_types

The packet types, as listed in PacketType.

add_packet_type(packet_type: excentis.xra31.capture.PacketType) → None

Add a packet type.

remove_packet_type(packet_type: excentis.xra31.capture.PacketType) → None

Remove a packet type.

clear_packet_types() → None

Remove all packet types.

property ofdm_streams

The OFDM streams, as listed in OfdmStream.

add_ofdm_stream(stream: excentis.xra31.capture.OfdmStream) → None

Add an OFDM stream.

remove_ofdm_stream(stream: excentis.xra31.capture.OfdmStream) → None

Remove an OFDM stream.

clear_ofdm_streams() → None

Remove all OFDM streams.

property ofdm_profiles

The OFDM profiles, as listed in OfdmProfile.

add_ofdm_profile(profile: excentis.xra31.capture.OfdmProfile) → None

Add an OFDM profile.

remove_ofdm_profile(profile: excentis.xra31.capture.OfdmProfile) → None

Remove an OFDM profile.

clear_ofdm_profiles() → None

Remove all OFDM profiles.

describe() → dict

Get a minimal representation of the capture filtering.

Returns

Description listing packet types, OFDM profiles and OFDM streams.

Return type

dict

apply(description: dict) → None

Apply a filtering configuration.

Parameters

description (dict) – The filtering description (describe()).

class excentis.xra31.capture.Output(xra31)

Access the capture output parameters.

property directory

The directory in which the capture is stored.

property filename

The filename of the capture.

property duration

The maximum duration of the capture (s), None for unlimited. Setting the maximum capture duration resets the maximum capture size.

property size

The maximum size of the capture (MB), None for unlimited. Setting the maximum capture size resets the maximum capture duration.

property number_of_files

The number of files in a rolling file capture.

property file_duration

The maximum file duration before rolling over to the next file in a rolling file capture (s), None for unlimited. Setting the maximum file duration resets the maximum file size in a rolling file capture.

property file_size

The file size before rolling over to the next file in a rolling file capture (MB), None for unlimited. Setting the maximum file size resets the maximum file duration in a rolling file capture.

describe() → dict

Get a minimal representation of the capture output configuration.

Returns

A full description of the output configuration.

Return type

dict

apply(description: dict) → None

Apply a capture output configuration.

Parameters

description (dict) – The output configuration description (describe()).

class excentis.xra31.capture.Capture(xra31)

Access capture-related settings and actions.

property channels

Get the list of channels.

property active

Indicates if the capture is recording.

property filename

The active, or latest when inactive, capture filename.

property duration

The duration of the current capture.

property size

The file size of the current capture.

start() → None

Start a capture.

wait_for_end(timeout: float = None) → str

Wait for a capture to end.

Parameters

timeout (float, optional) – Number of seconds to wait before giving up; by default it will wait indefinitely.

Returns

The filename of the most recent capture if successful, None otherwise.

Return type

str

wait_for_file_end(timeout: float = None) → str

Wait for a file rollover in a rolling file capture.

Parameters

timeout (float, optional) – Number of seconds to wait before giving up; by default it will wait indefinitely.

Returns

The filename of the most recent capture if successful, None otherwise.

Return type

str

stop() → None

Stop a capture.

describe() → dict

Get a minimal representation of the capture configuration.

Returns

Description listing channels, filtering and output.

Return type

dict

apply(description: dict) → None

Apply a capture configuration.

Parameters

description (dict) – The capture description (describe()).