ChannelNewMediaGateway

Summary

Represents a base Media Gateway Channel Adapter.

Methods: ChannelNewMediaGateway.check_status()

ChannelNewMediaGateway.export_configuration()

ChannelNewMediaGateway.get_dest_mac()

ChannelNewMediaGateway.get_wakeup_line_status()

ChannelNewMediaGateway.import_configuration()

ChannelNewMediaGateway.port_enable()

ChannelNewMediaGateway.port_master_slave()

ChannelNewMediaGateway.reset_to_default()

ChannelNewMediaGateway.restart_device()

ChannelNewMediaGateway.set_dest_mac()

ChannelNewMediaGateway.set_dynamic()

ChannelNewMediaGateway.set_wakeup_line_status()
Properties: ChannelNewMediaGateway.cluster_name

ChannelNewMediaGateway.name

Structure

class ChannelNewMediaGateway

check_status() → str

Check the configuration mode of the MediaGateway

Returns: "Normal" if the configuration remains saved. "Dynamic" if the configuration is lost once the MediaGateway is restarted
Return type: str

export_configuration(path: str, name: str) → bool

Export the current configuration of the MediaGateway

Parameters

path (str) – path to save the configuration
name (str) – name of the saved configuration

Returns

True if accepted, False otherwise

Return type

bool

get_dest_mac() → str

Method that gets the mac address of the destination

Returns: Mac address of the destination
Return type: str

get_wakeup_line_status() → str

Get the status of the Wakeup lines

Returns

wakeup line one low or high
wakeup line two low or high

Return type

str

import_configuration(conf_file: str) → bool

Import a configuration file to the MediaGateway

Parameters: conf_file (str) – path of the configuration to import.
Returns: True if accepted, False otherwise
Return type: bool

port_enable(numPort: uint16, enableDisable: bool) → bool

Sets Enable or disable MediaGateway ports

Parameters

numPort (uint16) – port number from 0 to 11
enableDisable (bool) – True -> enabled, False -> disable

Returns

True if accepted, False otherwise

Return type

bool

port_master_slave(selected_port: int32, slave_master: int32) → bool

Sets Master or Slave MediaGateway ports

Parameters

selected_port (int32) – port number from 0 to 11
slave_master (int32) – 0 Slave or 1 Master

Returns

True if the operation was successful, False otherwise.

Return type

bool

reset_to_default() → bool

Set the MG to default configuration

Returns: True if accepted, False otherwise
Return type: bool

restart_device() → bool

Restart the MediaGateway device

Returns: True if accepted, False otherwise
Return type: bool

set_dest_mac(dstMac: Array[uint8]) → bool

Sets the destination mac address

Parameters: dstMac (Array[uint8]) – Destination Mac address to set.
Returns: True if Mac address is set, False if error occurred
Return type: bool

set_dynamic(conf_file: str) → bool

Import a configuration file to the MediaGateway and set the status to Dynamic mode

Parameters: conf_file (str) – path of the configuration to import
Returns: True if accepted, False otherwise
Return type: bool

set_wakeup_line_status(line_select: int32, line_status: int32) → bool

Sets the status of the Wakeup lines

Parameters

line_select (int32) – wakeup line: 1 or 2
line_status (int32) – line status: 0 (low) or 1 (high)

Returns

True if the operation was successful, False otherwise.

Return type

bool

cluster_name

The name of the cluster that is mapped to the channel.

Type: str

name

The channel name. This Property is Read Only.

Type: str