Configuration

Details on the channel parameters used here can be found in core.

class excentis.xra31.configuration.Detection(xra31)

Access the upstream channel list detected by the XRA-31.

property ofdma

Get the OFDMA channels.

property a_tdma

Get the A-TDMA channels.

property upstream

Get the upstream channels.

wait_for_channel(channel_parameters: excentis.xra31.core.UpstreamChannel = None, *, channel_type: excentis.xra31.core.ChannelType = None, ucid: int = -1, frequency: float = 0.0, timeout: float = None) → excentis.xra31.core.UpstreamChannel

Wait for an upstream channel to be detected by the XRA-31.

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

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

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

  • frequency (float, optional) – The frequency of the channel (MHz).

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

Returns

The upstream channel if successful, None otherwise.

Return type

core.UpstreamChannel

class excentis.xra31.configuration.Configuration(xra31)

Add and remove XRA-31 channels (OFDM, SC-QAM, OFDMA, A-TDMA), and monitor their status.

detection

Channels detected by the XRA-31.

property annex

The active Annex.

property ofdm

Get the OFDM channels.

property sc_qam

Get the downstream SC-QAM channels.

property ofdma

Get the OFDMA channels.

property a_tdma

Get the A-TDMA channels.

add_ofdm(plc_frequency: int, fft_size: int = 4096, cyclic_prefix: int = 192, rolloff_period: int = 0) → bool

Add an OfdmChannel.

Parameters
  • plc_frequency (int) – PLC frequency (MHz).

  • fft_size (int, optional) – FFT size, defaults to 4096.

  • cyclic_prefix (int, optional) – Cyclic prefix, defaults to 192.

  • rolloff_period (int, optional) – Roll-off period, defaults to 0.

Returns

True if successful, False otherwise.

Return type

bool

add_sc_qam(frequency: float, modulation: excentis.xra31.core.ChannelModulation = <ChannelModulation.QAM256: 1>) → bool

Add an ScQamChannel.

Parameters
Returns

True if successful, False otherwise.

Return type

bool

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

Add an OfdmaChannel.

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

  • xra31_id (int, optional) – Channel identifier at the XRA-31.

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

  • frequency (float, optional) – Center frequency (MHz).

Returns

True if successful, False otherwise.

Return type

bool

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

Add an ATdmaChannel.

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

  • xra31_id (int, optional) – Channel identifier at the XRA-31.

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

  • frequency (float, optional) – 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

Remove a channel.

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

  • channel_type (core.ChannelType, optional) – The ChannelType.

  • 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

Remove all channels.

clear_upstream() → None

Remove all upstream channels.

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

Remove an OfdmChannel.

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

  • xra31_id (int, optional) – Channel identifier at the XRA-31.

  • frequency (float, optional) – PLC frequency (MHz).

Returns

True if successful, False otherwise.

Return type

bool

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

Remove an ScQamChannel.

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

  • xra31_id (int, optional) – Channel identifier at the XRA-31.

  • frequency (float, optional) – Center frequency (MHz).

Returns

True if successful, False otherwise.

Return type

bool

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

Remove an OfdmaChannel.

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

  • xra31_id (int, optional) – Channel identifier at the XRA-31.

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

  • frequency (float, optional) – Center frequency (MHz).

Returns

True if successful, False otherwise.

Return type

bool

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

Remove an ATdmaChannel.

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

  • xra31_id (int, optional) – Channel identifier at the XRA-31.

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

  • frequency (float, optional) – Center frequency (MHz).

Returns

True if successful, False otherwise.

Return type

bool

wait_for_state(channel_parameters: excentis.xra31.core.Channel = None, state: excentis.xra31.core.ChannelState = <ChannelState.LOCKED: 2>, *, channel_type: excentis.xra31.core.ChannelType = None, xra31_id: int = -1, ucid: int = -1, frequency: float = 0.0, timeout: float = None) → bool

Wait for a channel to arrive in state ChannelState.

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

  • state (core.ChannelState, optional) – The target state, defaults to LOCKED.

  • channel_type (core.ChannelType, optional) – The ChannelType.

  • xra31_id (int, optional) – Channel identifier at the XRA-31.

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

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

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

Returns

True if successful, False otherwise.

Return type

bool

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

Select the reference downstream channel. Note that this removes all upstream channels.

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.

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

Returns

True if successful, False otherwise.

Return type

bool

describe() → dict

Representation of information used to configure the XRA-31 channels.

apply(description: dict, downstream: bool = True, upstream: bool = True, timeout: float = None)

Apply a configuration.

Parameters
  • description (dict) – The configuration description (describe()).

  • downstream (bool, optional) – Whether or not to apply downstream channel configuration.

  • upstream (bool, optional) – Whether or not to apply upstream channel configuration.

  • timeout (float, optional) – Timeout before which upstream channels must have been detected (s), defaults to None (unlimited).