RDK Documentation (Open Sourced RDK Components)
TR-069 Object (Device.MoCA.) Public APIs
TR-069 » TR-069 Host Interface » TR-069 Host Interface Profile » TR-069 Object (Device.MoCA)

Description

MoCA interface table (a stackable interface object as described in [Section 4.2/TR-181i2]). Each table entry models the PHY and MAC levels of a MoCA interface [MoCAv1.0] [MoCAv1.1].
At most one entry in this table can exist with a given value for Alias, or with a given value for Name.

int MoCAInterface::check_MoCABootStatus (char *)
 Get the MoCA status for BootStatus. More...
 
int MoCAInterface::get_Enable (HOSTIF_MsgData_t *, bool *pChanged=NULL)
 Get the status (enabled/disabled) of the MoCA Interface. More...
 
int MoCAInterface::get_Status (HOSTIF_MsgData_t *, bool *pChanged=NULL)
 Get the current operational state of the interface (see [Section 4.2.2/TR-181i2]). Enumeration of: More...
 
int MoCAInterface::get_Alias (HOSTIF_MsgData_t *, bool *pChanged=NULL)
 Get the Alias-based addressing used for MoCA interface. More...
 
int MoCAInterface::get_Name (HOSTIF_MsgData_t *, bool *pChanged=NULL)
 Get the textual name of the interface as assigned by the CPE. More...
 
int MoCAInterface::get_LastChange (HOSTIF_MsgData_t *, bool *pChanged=NULL)
 Get the accumulated time in seconds since the interface entered its current operational state. More...
 
int MoCAInterface::get_LowerLayers (HOSTIF_MsgData_t *, bool *pChanged=NULL)
 Get the path name of the MoCA interface object. More...
 
int MoCAInterface::get_Upstream (HOSTIF_MsgData_t *, bool *pChanged=NULL)
 Check whether the interface points towards the Internet (true) or towards End Devices (false). More...
 
int MoCAInterface::get_MACAddress (HOSTIF_MsgData_t *, bool *pChanged=NULL)
 Get the MAC Address of the interface. More...
 
int MoCAInterface::get_FirmwareVersion (HOSTIF_MsgData_t *, bool *pChanged=NULL)
 Get the MoCA interface's firmware version. More...
 
int MoCAInterface::get_MaxBitRate (HOSTIF_MsgData_t *, bool *pChanged=NULL)
 Get the maximum MoCA PHY bit rate (expressed in Mbps). More...
 
int MoCAInterface::get_MaxIngressBW (HOSTIF_MsgData_t *, bool *pChanged=NULL)
 Get the maximum bandwidth of this interface for flows onto the MoCA network in Mbps. More...
 
int MoCAInterface::get_MaxEgressBW (HOSTIF_MsgData_t *, bool *pChanged=NULL)
 Get the maximum bandwidth of this interface for flows from the MoCA network in Mbps. More...
 
int MoCAInterface::get_HighestVersion (HOSTIF_MsgData_t *, bool *pChanged=NULL)
 Get the identifies the highest MoCA version that this interface supports. More...
 
int MoCAInterface::get_CurrentVersion (HOSTIF_MsgData_t *, bool *pChanged=NULL)
 Get the MoCA version that the MoCA network is currently running. More...
 
int MoCAInterface::get_NetworkCoordinator (HOSTIF_MsgData_t *, bool *pChanged=NULL)
 Get the Node ID of the current Network Coordinator (NC) for the MoCA network. More...
 
int MoCAInterface::get_NodeID (HOSTIF_MsgData_t *, bool *pChanged=NULL)
 Get the Node ID of the MoCA interface. More...
 
int MoCAInterface::get_MaxNodes (HOSTIF_MsgData_t *, bool *pChanged=NULL)
 Get the maximum network node capability supported by the interface. If MaxNodes is true then the interface supports 16 nodes (the maximum for a MoCA 1.1 network). If MaxNodes is false then the interface supports 8 nodes (the maximum for a MoCA 1.0 network). More...
 
int MoCAInterface::get_PreferredNC (HOSTIF_MsgData_t *, bool *pChanged=NULL)
 Check Whether this interface is a preferred Network Coordinator (NC). More...
 
int MoCAInterface::get_BackupNC (HOSTIF_MsgData_t *, bool *pChanged=NULL)
 Get the Node ID of the backup Network Coordinator node. More...
 
int MoCAInterface::get_PrivacyEnabledSetting (HOSTIF_MsgData_t *, bool *pChanged=NULL)
 Get the configured privacy mode. This indicates whether link-layer security is enabled (true) or disabled (false) for network admission. More...
 
int MoCAInterface::get_PrivacyEnabled (HOSTIF_MsgData_t *, bool *pChanged=NULL)
 Check whether link-layer security is enabled or disabled. More...
 
int MoCAInterface::get_FreqCapabilityMask (HOSTIF_MsgData_t *, bool *pChanged=NULL)
 Get the hexadecimal encoded 64-bit mask of supported frequencies. This is the bit map of the spectrum that the interface supports, and each bit represents 25 MHz of spectrum. The least significant bit of the rightmost character corresponds to 800MHz, which is the lowest frequency. More...
 
int MoCAInterface::get_FreqCurrentMaskSetting (HOSTIF_MsgData_t *, bool *pChanged=NULL)
 Get the configured hexadecimal encoded 64-bit mask of enabled frequencies for network admission. More...
 
int MoCAInterface::get_FreqCurrentMask (HOSTIF_MsgData_t *, bool *pChanged=NULL)
 Get the hexadecimal encoded 64-bit mask of used frequencies. This is the bit map of the spectrum that can be used and is a subset of the FreqCapabilityMask. Each bit represents 25 MHz of spectrum. The least significant bit of the rightmost character corresponds to 800MHz, which is the lowest frequency. More...
 
int MoCAInterface::get_CurrentOperFreq (HOSTIF_MsgData_t *, bool *pChanged=NULL)
 Get the current Operational Frequency. The RF frequency in Hz to which the MoCA interface is currently tuned. This parameter is only valid when Status is Up. More...
 
int MoCAInterface::get_LastOperFreq (HOSTIF_MsgData_t *, bool *pChanged=NULL)
 Get the last Operational Frequency. The RF frequency in Hz to which the MoCA interface was tuned when last in the Up state. More...
 
int MoCAInterface::get_KeyPassphrase (HOSTIF_MsgData_t *, bool *pChanged=NULL)
 Get the MoCA Password. The value consists of numeric characters (0-9). More...
 
int MoCAInterface::get_TxPowerLimit (HOSTIF_MsgData_t *, bool *pChanged=NULL)
 Get the transmit Power attenuation in dB relative to the maximum transmit power. More...
 
int MoCAInterface::get_PowerCntlPhyTarget (HOSTIF_MsgData_t *, bool *pChanged=NULL)
 Get the target PHY rate in Mbps for the power control algorithm. More...
 
int MoCAInterface::get_BeaconPowerLimit (HOSTIF_MsgData_t *, bool *pChanged=NULL)
 Get the Beacon Transmit Power attenuation in dB relative to the maximum transmit power. More...
 
int MoCAInterface::get_NetworkTabooMask (HOSTIF_MsgData_t *, bool *pChanged=NULL)
 Get the hexadecimal encoded 64-bit mask of MoCA taboo channels identified for the home network. This is the bit map of the spectrum that the interface supports, and each bit represents 25 MHz of spectrum. The least significant bit of the rightmost character corresponds to 800MHz, which is the lowest frequency. More...
 
int MoCAInterface::get_NodeTabooMask (HOSTIF_MsgData_t *, bool *pChanged=NULL)
 Get the hexadecimal encoded 64-bit mask of supported frequencies. This is the bit map of the spectrum that the interface supports, and each bit represents 25 MHz of spectrum. The least significant bit of the rightmost character corresponds to 800MHz, which is the lowest frequency. More...
 
int MoCAInterface::get_TxBcastRate (HOSTIF_MsgData_t *, bool *pChanged=NULL)
 Get the broadcast PHY transmit rate in Mbps for this interface. More...
 
int MoCAInterface::get_TxBcastPowerReduction (HOSTIF_MsgData_t *, bool *pChanged=NULL)
 Get the transmit Power attenuation in dB relative to the maximum transmit power for broadcast transmissions. More...
 
int MoCAInterface::get_QAM256Capable (HOSTIF_MsgData_t *, bool *pChanged=NULL)
 Check whether this interface supports the 256 QAM feature. More...
 
int MoCAInterface::get_PacketAggregationCapability (HOSTIF_MsgData_t *, bool *pChanged=NULL)
 Get the packet aggregation capability supported by the interface. Standard values are 0 (no support), 6 (6 packets) or 10 (10 packets). More...
 
int MoCAInterface::get_AssociatedDeviceNumberOfEntries (HOSTIF_MsgData_t *, bool *pChanged=NULL)
 The number of entries in the AssociatedDevice table. More...
 
int MoCAInterface::get_X_RDKCENTRAL_COM_MeshTableNumberOfEntries (HOSTIF_MsgData_t *, bool *pChanged=NULL)
 Get the number of entries in the X_RDKCENTRAL_COM_MeshTable table of a MoCA Interface. More...
 
int MoCAInterface::get_X_RDKCENTRAL_COM_PrimaryChannelFreq (HOSTIF_MsgData_t *)
 Get the X_RDKCENTRAL_COM_PrimaryChannelFreq of a MoCA Interface. More...
 
int MoCAInterface::get_X_RDKCENTRAL_COM_SecondaryChannelFreq (HOSTIF_MsgData_t *)
 Get the MoCA status for BootStatus. More...
 
int MoCAInterface::get_X_RDKCENTRAL_COM_TurboMode (HOSTIF_MsgData_t *)
 Get the MoCA status for BootStatus. More...
 
int MoCAInterface::get_X_RDKCENTRAL_COM_NodePowerState (HOSTIF_MsgData_t *)
 Get the MoCA status for BootStatus. More...
 

Function Documentation

◆ check_MoCABootStatus()

int MoCAInterface::check_MoCABootStatus ( char *  statusBuf)

Get the MoCA status for BootStatus.

This function provides the infromation about:

  • Coax connection confirmed, MoCA enabled
  • Discovering MoCA Network Coordinator: MoCA MAC: xx:xx:xx:xx:xx:xx
  • Joining MoCA Network

Definition at line 1146 of file Device_MoCA_Interface.cpp.

◆ get_Enable()

int MoCAInterface::get_Enable ( HOSTIF_MsgData_t *  stMsgData,
bool *  pChanged = NULL 
)

Get the status (enabled/disabled) of the MoCA Interface.

This function provides true/false value based on the Device.MoCA.Interface.{i}.Enable status.

Parameters
[in]stMsgDataTR-069 Host interface message request.
Returns
Returns 0 on success, otherwise will return the appropriate error code.

Definition at line 289 of file Device_MoCA_Interface.cpp.

◆ get_Status()

int MoCAInterface::get_Status ( HOSTIF_MsgData_t *  stMsgData,
bool *  pChanged = NULL 
)

Get the current operational state of the interface (see [Section 4.2.2/TR-181i2]). Enumeration of:

  • Up
  • Down
  • Unknown
  • Dormant
  • NotPresent
  • LowerLayerDown
  • Error (OPTIONAL)

When Enable is false then Status SHOULD normally be Down (or NotPresent or Error if there is a fault condition on the interface).

  • When Enable is changed to true then Status SHOULD change to Up if and only if the interface is able to transmit and receive network traffic; -It SHOULD change to Dormant if and only if the interface is operable but is waiting for external actions before it can transmit and receive network traffic (and subsequently change to Up if still operable when the expected actions have completed); It SHOULD change to LowerLayerDown if and only if the interface is prevented from entering the Up state because one or more of the interfaces beneath it is down; It SHOULD remain in the Error state if there is an error or other fault condition detected on the interface; it SHOULD remain in the NotPresent state if the interface has missing (typically hardware) components; It SHOULD change to Unknown if the state of the interface can not be determined for some reason.

This parameter is based on ifOperStatus from [RFC2863].

This function provides the output as a string available in Device.MoCA.Interface.{i}.Status parameter.

Returns
Returns 0 on success, otherwise will return the appropriate error code.

Definition at line 310 of file Device_MoCA_Interface.cpp.

◆ get_Alias()

int MoCAInterface::get_Alias ( HOSTIF_MsgData_t *  stMsgData,
bool *  pChanged = NULL 
)

Get the Alias-based addressing used for MoCA interface.

A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069a4] and described in [Appendix II/TR-069a4], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.

This function provides the output as a string available in Device.MoCA.Interface.{i}.Alias parameter.

Returns
Returns 0 on success, otherwise will return the appropriate error code.

Definition at line 348 of file Device_MoCA_Interface.cpp.

◆ get_Name()

int MoCAInterface::get_Name ( HOSTIF_MsgData_t *  stMsgData,
bool *  pChanged = NULL 
)

Get the textual name of the interface as assigned by the CPE.

This function provides the output as a string available in Device.MoCA.Interface.{i}.Name parameter.

Returns
Returns 0 on success, otherwise will return the appropriate error code.

Definition at line 355 of file Device_MoCA_Interface.cpp.

◆ get_LastChange()

int MoCAInterface::get_LastChange ( HOSTIF_MsgData_t *  stMsgData,
bool *  pChanged = NULL 
)

Get the accumulated time in seconds since the interface entered its current operational state.

This function provides the output as a numeric value available in Device.MoCA.Interface.{i}.LastChange parameter.

Returns
Returns 0 on success, otherwise will return the appropriate error code.

Definition at line 377 of file Device_MoCA_Interface.cpp.

◆ get_LowerLayers()

int MoCAInterface::get_LowerLayers ( HOSTIF_MsgData_t *  stMsgData,
bool *  pChanged = NULL 
)

Get the path name of the MoCA interface object.

Comma-separated list (maximum list length 1024) of strings. Each list item MUST be the path name of an interface object that is stacked immediately below this interface object.

Note
Since Interface is a layer 1 interface, it is expected that LowerLayers will not be used.

This function provides the output as a string available in Device.MoCA.Interface.{i}.LowerLayers parameter.

Returns
Returns 0 on success, otherwise will return the appropriate error code.

Definition at line 398 of file Device_MoCA_Interface.cpp.

◆ get_Upstream()

int MoCAInterface::get_Upstream ( HOSTIF_MsgData_t *  stMsgData,
bool *  pChanged = NULL 
)

Check whether the interface points towards the Internet (true) or towards End Devices (false).

For example:

  • For an Internet Gateway Device, Upstream will be true for all WAN interfaces and false for all LAN interfaces.

For a standalone WiFi Access Point that is connected via Ethernet to an Internet Gateway Device, Upstream will be true for the Ethernet interface and false for the WiFi Radio interface.

For an End Device, Upstream will be true for all interfaces.

This function provides true/false value based on the Device.MoCA.Interface.{i}.Upstream status.

Returns
Returns 0 on success, otherwise will return the appropriate error code.

Definition at line 405 of file Device_MoCA_Interface.cpp.

◆ get_MACAddress()

int MoCAInterface::get_MACAddress ( HOSTIF_MsgData_t *  stMsgData,
bool *  pChanged = NULL 
)

Get the MAC Address of the interface.

Note
This is not necessarily the same as the Ethernet header source or destination MAC address, which is associated with the IP interface and is modeled via the Ethernet.Link.{i}.MACAddress parameter.

This function provides the output as a string value available in Device.MoCA.Interface.{i}.MACAddress parameter.

Returns
Returns 0 on success, otherwise will return the appropriate error code.

Definition at line 423 of file Device_MoCA_Interface.cpp.

◆ get_FirmwareVersion()

int MoCAInterface::get_FirmwareVersion ( HOSTIF_MsgData_t *  stMsgData,
bool *  pChanged = NULL 
)

Get the MoCA interface's firmware version.

This parameter is based on mocaIfSoftwareVersion from [MOCA11-MIB].

This function provides the output as a string available in Device.MoCA.Interface.{i}.FirmwareVersion parameter.

Returns
Returns 0 on success, otherwise will return the appropriate error code.

Definition at line 448 of file Device_MoCA_Interface.cpp.

◆ get_MaxBitRate()

int MoCAInterface::get_MaxBitRate ( HOSTIF_MsgData_t *  stMsgData,
bool *  pChanged = NULL 
)

Get the maximum MoCA PHY bit rate (expressed in Mbps).

This function provides the output as a numeric value available in Device.MoCA.Interface.{i}.FirmwareVersion parameter.

Returns
Returns 0 on success, otherwise will return the appropriate error code.

Definition at line 471 of file Device_MoCA_Interface.cpp.

◆ get_MaxIngressBW()

int MoCAInterface::get_MaxIngressBW ( HOSTIF_MsgData_t *  stMsgData,
bool *  pChanged = NULL 
)

Get the maximum bandwidth of this interface for flows onto the MoCA network in Mbps.

This parameter is based on mocaIfMaxIngressNodeBw from [MOCA11-MIB].

This function provides the output as a numeric value available in Device.MoCA.Interface.{i}.MaxIngressBW parameter.

Returns
Returns 0 on success, otherwise will return the appropriate error code.

Definition at line 491 of file Device_MoCA_Interface.cpp.

◆ get_MaxEgressBW()

int MoCAInterface::get_MaxEgressBW ( HOSTIF_MsgData_t *  stMsgData,
bool *  pChanged = NULL 
)

Get the maximum bandwidth of this interface for flows from the MoCA network in Mbps.

This parameter is based on mocaIfMaxEgressNodeBw from [MOCA11-MIB].

This function provides the output as a numeric value available in Device.MoCA.Interface.{i}.MaxEgressBW parameter.

Returns
Returns 0 on success, otherwise will return the appropriate error code.

Definition at line 513 of file Device_MoCA_Interface.cpp.

◆ get_HighestVersion()

int MoCAInterface::get_HighestVersion ( HOSTIF_MsgData_t *  stMsgData,
bool *  pChanged = NULL 
)

Get the identifies the highest MoCA version that this interface supports.

This element MUST be in the form of dot-delimited integers, where each successive integer represents a more minor category of variation. For example, 1.0, where the components mean major.minor revision number. Possible patterns:

  • d+(.d+)* This parameter is based on mocaIfMocaVersion from [MOCA11-MIB].

This function provides the output as a string available in Device.MoCA.Interface.{i}.HighestVersion parameter.

Returns
Returns 0 on success, otherwise will return the appropriate error code.

Definition at line 534 of file Device_MoCA_Interface.cpp.

◆ get_CurrentVersion()

int MoCAInterface::get_CurrentVersion ( HOSTIF_MsgData_t *  stMsgData,
bool *  pChanged = NULL 
)

Get the MoCA version that the MoCA network is currently running.

This element MUST be in the form of dot-delimited integers, where each successive integer represents a more minor category of variation. For example, 1.0, where the components mean major.minor revision number.
Possible patterns:

  • \d+(\.\d+)*

This parameter is based on mocaIfNetworkVersion from [MOCA11-MIB].

This function provides the output as a string available in Device.MoCA.Interface.{i}.CurrentVersion parameter.

Returns
Returns 0 on success, otherwise will return the appropriate error code.

Definition at line 557 of file Device_MoCA_Interface.cpp.

◆ get_NetworkCoordinator()

int MoCAInterface::get_NetworkCoordinator ( HOSTIF_MsgData_t *  stMsgData,
bool *  pChanged = NULL 
)

Get the Node ID of the current Network Coordinator (NC) for the MoCA network.

This parameter is based on mocaIfNC from [MOCA11-MIB].

This function provides the output as a numeric value available in Device.MoCA.Interface.{i}.NetworkCoordinator parameter.

Returns
Returns 0 on success, otherwise will return the appropriate error code.

Definition at line 578 of file Device_MoCA_Interface.cpp.

◆ get_NodeID()

int MoCAInterface::get_NodeID ( HOSTIF_MsgData_t *  stMsgData,
bool *  pChanged = NULL 
)

Get the Node ID of the MoCA interface.

This parameter is based on mocaIfNodeID from [MOCA11-MIB].

This function provides the output as a numeric value available in Device.MoCA.Interface.{i}.NodeID parameter.

Returns
Returns 0 on success, otherwise will return the appropriate error code.

Definition at line 600 of file Device_MoCA_Interface.cpp.

◆ get_MaxNodes()

int MoCAInterface::get_MaxNodes ( HOSTIF_MsgData_t *  stMsgData,
bool *  pChanged = NULL 
)

Get the maximum network node capability supported by the interface. If MaxNodes is true then the interface supports 16 nodes (the maximum for a MoCA 1.1 network). If MaxNodes is false then the interface supports 8 nodes (the maximum for a MoCA 1.0 network).

This function provides true/false value based on the Device.MoCA.Interface.{i}.MaxNodes status.

Returns
Returns 0 on success, otherwise will return the appropriate error code.

Definition at line 622 of file Device_MoCA_Interface.cpp.

◆ get_PreferredNC()

int MoCAInterface::get_PreferredNC ( HOSTIF_MsgData_t *  stMsgData,
bool *  pChanged = NULL 
)

Check Whether this interface is a preferred Network Coordinator (NC).

This parameter is based on mocaIfPreferredNC from [MOCA11-MIB].

This function provides true/false value based on the Device.MoCA.Interface.{i}.PreferredNC status.

Returns
Returns 0 on success, otherwise will return the appropriate error code.

Definition at line 630 of file Device_MoCA_Interface.cpp.

◆ get_BackupNC()

int MoCAInterface::get_BackupNC ( HOSTIF_MsgData_t *  stMsgData,
bool *  pChanged = NULL 
)

Get the Node ID of the backup Network Coordinator node.

This parameter is based on mocaIfBackupNC from [MOCA11-MIB].

This function provides the output as a numeric value available in Device.MoCA.Interface.{i}.BackupNC parameter.

Returns
Returns 0 on success, otherwise will return the appropriate error code.

Definition at line 652 of file Device_MoCA_Interface.cpp.

◆ get_PrivacyEnabledSetting()

int MoCAInterface::get_PrivacyEnabledSetting ( HOSTIF_MsgData_t *  stMsgData,
bool *  pChanged = NULL 
)

Get the configured privacy mode. This indicates whether link-layer security is enabled (true) or disabled (false) for network admission.

The configured privacy setting MAY NOT match the current operational state (PrivacyEnabled), since this setting is only applied during network formation or admission.

This function provides true/false value based on the Device.MoCA.Interface.{i}.PrivacyEnabledSettting status.

Returns
Returns 0 on success, otherwise will return the appropriate error code.

Definition at line 673 of file Device_MoCA_Interface.cpp.

◆ get_PrivacyEnabled()

int MoCAInterface::get_PrivacyEnabled ( HOSTIF_MsgData_t *  stMsgData,
bool *  pChanged = NULL 
)

Check whether link-layer security is enabled or disabled.

This parameter is based on mocaIfPrivacyEnable from [MOCA11-MIB].

This function provides true/false value based on the Device.MoCA.Interface.{i}.PrivacyEnabled status.

Returns
Returns 0 on success, otherwise will return the appropriate error code.

Definition at line 693 of file Device_MoCA_Interface.cpp.

◆ get_FreqCapabilityMask()

int MoCAInterface::get_FreqCapabilityMask ( HOSTIF_MsgData_t *  stMsgData,
bool *  pChanged = NULL 
)

Get the hexadecimal encoded 64-bit mask of supported frequencies. This is the bit map of the spectrum that the interface supports, and each bit represents 25 MHz of spectrum. The least significant bit of the rightmost character corresponds to 800MHz, which is the lowest frequency.

For example, an interface that supports 1150 MHz through 1500 MHz would have a value of 0x000000001FFFC000.

This parameter is based on mocaIfCapabilityMask from [MOCA11-MIB].

This function provides the output as hex binary value available in Device.MoCA.Interface.{i}.FreqCapabilityMask parameter.

Returns
Returns 0 on success, otherwise will return the appropriate error code.

Definition at line 714 of file Device_MoCA_Interface.cpp.

◆ get_FreqCurrentMaskSetting()

int MoCAInterface::get_FreqCurrentMaskSetting ( HOSTIF_MsgData_t *  stMsgData,
bool *  pChanged = NULL 
)

Get the configured hexadecimal encoded 64-bit mask of enabled frequencies for network admission.

The configured frequencies MAY NOT match the current operational state (FreqCurrentMask), since this setting is only applied during network formation or admission.

This function provides the output as a hex binary value available in Device.MoCA.Interface.{i}.FreqCapabilityMask parameter.

Returns
Returns 0 on success, otherwise will return the appropriate error code.

Definition at line 743 of file Device_MoCA_Interface.cpp.

◆ get_FreqCurrentMask()

int MoCAInterface::get_FreqCurrentMask ( HOSTIF_MsgData_t *  stMsgData,
bool *  pChanged = NULL 
)

Get the hexadecimal encoded 64-bit mask of used frequencies. This is the bit map of the spectrum that can be used and is a subset of the FreqCapabilityMask. Each bit represents 25 MHz of spectrum. The least significant bit of the rightmost character corresponds to 800MHz, which is the lowest frequency.

This parameter is based on mocaIfChannelMask from [MOCA11-MIB].

This function provides the output as a hex binary value available in Device.MoCA.Interface.{i}.FreqCurrentMask parameter.

Returns
Returns 0 on success, otherwise will return the appropriate error code.

Definition at line 767 of file Device_MoCA_Interface.cpp.

◆ get_CurrentOperFreq()

int MoCAInterface::get_CurrentOperFreq ( HOSTIF_MsgData_t *  stMsgData,
bool *  pChanged = NULL 
)

Get the current Operational Frequency. The RF frequency in Hz to which the MoCA interface is currently tuned. This parameter is only valid when Status is Up.

This parameter is based on mocaIfRFChannel from [MOCA11-MIB].

This function provides the output as a numeric value available in Device.MoCA.Interface.{i}.CurrentOperFreq parameter.

Returns
Returns 0 on success, otherwise will return the appropriate error code.

Definition at line 791 of file Device_MoCA_Interface.cpp.

◆ get_LastOperFreq()

int MoCAInterface::get_LastOperFreq ( HOSTIF_MsgData_t *  stMsgData,
bool *  pChanged = NULL 
)

Get the last Operational Frequency. The RF frequency in Hz to which the MoCA interface was tuned when last in the Up state.

This parameter is based on mocaIfLOF from [MOCA11-MIB].

This function provides the output as a numeric value available in Device.MoCA.Interface.{i}.LastOperFreq parameter.

Returns
Returns 0 on success, otherwise will return the appropriate error code.

Definition at line 813 of file Device_MoCA_Interface.cpp.

◆ get_KeyPassphrase()

int MoCAInterface::get_KeyPassphrase ( HOSTIF_MsgData_t *  stMsgData,
bool *  pChanged = NULL 
)

Get the MoCA Password. The value consists of numeric characters (0-9).

The possible patterns is:

  • \d+ This parameter is based on mocaIfPassword from [MOCA11-MIB].

When read, this parameter returns an empty string, regardless of the actual value.

This function provides the output as a string available in Device.MoCA.Interface.{i}.KeyPassphrase parameter.

Returns
Returns 0 on success, otherwise will return the appropriate error code.

Definition at line 835 of file Device_MoCA_Interface.cpp.

◆ get_TxPowerLimit()

int MoCAInterface::get_TxPowerLimit ( HOSTIF_MsgData_t *  stMsgData,
bool *  pChanged = NULL 
)

Get the transmit Power attenuation in dB relative to the maximum transmit power.

The MoCA interface SHOULD have Enable set to false for any change in this configuration. If the parameter is modified when Enable is true then this change might take several minutes to complete.

This parameter is based on mocaIfTxPowerLimit from [MOCA11-MIB].

This function provides the output as a numeric value available in Device.MoCA.Interface.{i}.TxPowerLimit parameter.

Returns
Returns 0 on success, otherwise will return the appropriate error code.

Definition at line 844 of file Device_MoCA_Interface.cpp.

◆ get_PowerCntlPhyTarget()

int MoCAInterface::get_PowerCntlPhyTarget ( HOSTIF_MsgData_t *  stMsgData,
bool *  pChanged = NULL 
)

Get the target PHY rate in Mbps for the power control algorithm.

The MoCA interface SHOULD have Enable set to false for any change in this configuration. If the parameter is modified when Enable is true then this change might take several minutes to complete.

This parameter is based on mocaIfPowerControlTargetRate from [MOCA11-MIB].

This function provides the output as a numeric value available in Device.MoCA.Interface.{i}.PowerCntlPhyTarget parameter.

Returns
Returns 0 on success, otherwise will return the appropriate error code.

Definition at line 869 of file Device_MoCA_Interface.cpp.

◆ get_BeaconPowerLimit()

int MoCAInterface::get_BeaconPowerLimit ( HOSTIF_MsgData_t *  stMsgData,
bool *  pChanged = NULL 
)

Get the Beacon Transmit Power attenuation in dB relative to the maximum transmit power.

The MoCA interface SHOULD have Enable set to false for any change in this configuration. If the parameter is modified when Enable is true then this change might take several minutes to complete.

This parameter is based on mocaIfBeaconPowerLimit from [MOCA11-MIB].

This function provides the output as a numeric value available in Device.MoCA.Interface.{i}.BeaconPowerLimit parameter.

Returns
Returns 0 on success, otherwise will return the appropriate error code.

Definition at line 892 of file Device_MoCA_Interface.cpp.

◆ get_NetworkTabooMask()

int MoCAInterface::get_NetworkTabooMask ( HOSTIF_MsgData_t *  stMsgData,
bool *  pChanged = NULL 
)

Get the hexadecimal encoded 64-bit mask of MoCA taboo channels identified for the home network. This is the bit map of the spectrum that the interface supports, and each bit represents 25 MHz of spectrum. The least significant bit of the rightmost character corresponds to 800MHz, which is the lowest frequency.

This parameter is based on mocaIfTabooChannelMask from [MOCA11-MIB].

This function provides the output as a hex binary value available in Device.MoCA.Interface.{i}.NetworkTabooMask parameter.

Returns
Returns 0 on success, otherwise will return the appropriate error code.

Definition at line 918 of file Device_MoCA_Interface.cpp.

◆ get_NodeTabooMask()

int MoCAInterface::get_NodeTabooMask ( HOSTIF_MsgData_t *  stMsgData,
bool *  pChanged = NULL 
)

Get the hexadecimal encoded 64-bit mask of supported frequencies. This is the bit map of the spectrum that the interface supports, and each bit represents 25 MHz of spectrum. The least significant bit of the rightmost character corresponds to 800MHz, which is the lowest frequency.

This parameter is based on mocaIfNodeTabooChannelMask from [MOCA11-MIB].

This function provides the output as a hex binary value available in Device.MoCA.Interface.{i}.NodeTabooMask parameter.

Returns
Returns 0 on success, otherwise will return the appropriate error code.

Definition at line 940 of file Device_MoCA_Interface.cpp.

◆ get_TxBcastRate()

int MoCAInterface::get_TxBcastRate ( HOSTIF_MsgData_t *  stMsgData,
bool *  pChanged = NULL 
)

Get the broadcast PHY transmit rate in Mbps for this interface.

This parameter is based on mocaIfTxGcdRate from [MOCA11-MIB].

This function provides the output as a numeric value available in Device.MoCA.Interface.{i}.TxBcastRate parameter.

Returns
Returns 0 on success, otherwise will return the appropriate error code.

Definition at line 962 of file Device_MoCA_Interface.cpp.

◆ get_TxBcastPowerReduction()

int MoCAInterface::get_TxBcastPowerReduction ( HOSTIF_MsgData_t *  stMsgData,
bool *  pChanged = NULL 
)

Get the transmit Power attenuation in dB relative to the maximum transmit power for broadcast transmissions.

This parameter is based on mocaIfTxGcdPowerReduction from [MOCA11-MIB].

This function provides the output as numeric value available in Device.MoCA.Interface.{i}.TxBcastPowerReduction parameter.

Returns
Returns 0 on success, otherwise will return the appropriate error code.

Definition at line 981 of file Device_MoCA_Interface.cpp.

◆ get_QAM256Capable()

int MoCAInterface::get_QAM256Capable ( HOSTIF_MsgData_t *  stMsgData,
bool *  pChanged = NULL 
)

Check whether this interface supports the 256 QAM feature.

This parameter is based on mocaIfQAM256Capable from [MOCA11-MIB].

This function provides true/false value based on the Device.MoCA.Interface.{i}.QAM256Capable parameter.

Returns
Returns 0 on success, otherwise will return the appropriate error code.

Definition at line 1002 of file Device_MoCA_Interface.cpp.

◆ get_PacketAggregationCapability()

int MoCAInterface::get_PacketAggregationCapability ( HOSTIF_MsgData_t *  stMsgData,
bool *  pChanged = NULL 
)

Get the packet aggregation capability supported by the interface. Standard values are 0 (no support), 6 (6 packets) or 10 (10 packets).

This parameter is based on mocaIfPacketsAggrCapability from [MOCA11-MIB].

This function provides the output as a numeric values available in Device.MoCA.Interface.{i}.PacketAggregationCapability parameter.

Returns
Returns 0 on success, otherwise will return the appropriate error code.

Definition at line 1023 of file Device_MoCA_Interface.cpp.

◆ get_AssociatedDeviceNumberOfEntries()

int MoCAInterface::get_AssociatedDeviceNumberOfEntries ( HOSTIF_MsgData_t *  stMsgData,
bool *  pChanged = NULL 
)

The number of entries in the AssociatedDevice table.

This function provides the output as a numeric value available in Device.MoCA.Interface.{i}.AssociatedDeviceNumberOfEntries parameter.

Returns
Returns 0 on success, otherwise will return the appropriate error code.

Definition at line 1043 of file Device_MoCA_Interface.cpp.

◆ get_X_RDKCENTRAL_COM_MeshTableNumberOfEntries()

int MoCAInterface::get_X_RDKCENTRAL_COM_MeshTableNumberOfEntries ( HOSTIF_MsgData_t *  stMsgData,
bool *  pChanged = NULL 
)

Get the number of entries in the X_RDKCENTRAL_COM_MeshTable table of a MoCA Interface.

This function provides the number of entries in the X_RDKCENTRAL_COM_MeshTableNumberOfEntries table.

See dev_moca_if_getter

Definition at line 1053 of file Device_MoCA_Interface.cpp.

◆ get_X_RDKCENTRAL_COM_PrimaryChannelFreq()

int MoCAInterface::get_X_RDKCENTRAL_COM_PrimaryChannelFreq ( HOSTIF_MsgData_t *  stMsgData)

Get the X_RDKCENTRAL_COM_PrimaryChannelFreq of a MoCA Interface.

This function provides the X_RDKCENTRAL_COM_PrimaryChannelFreq value.

Returns
Returns 0 on success, otherwise will return the appropriate error code.

Definition at line 1063 of file Device_MoCA_Interface.cpp.

◆ get_X_RDKCENTRAL_COM_SecondaryChannelFreq()

int MoCAInterface::get_X_RDKCENTRAL_COM_SecondaryChannelFreq ( HOSTIF_MsgData_t *  stMsgData)

Get the MoCA status for BootStatus.

This function provides the infromation about:

  • Coax connection confirmed, MoCA enabled
  • Discovering MoCA Network Coordinator: MoCA MAC: xx:xx:xx:xx:xx:xx
  • Joining MoCA Network

Definition at line 1084 of file Device_MoCA_Interface.cpp.

◆ get_X_RDKCENTRAL_COM_TurboMode()

int MoCAInterface::get_X_RDKCENTRAL_COM_TurboMode ( HOSTIF_MsgData_t *  stMsgData)

Get the MoCA status for BootStatus.

This function provides the infromation about:

  • Coax connection confirmed, MoCA enabled
  • Discovering MoCA Network Coordinator: MoCA MAC: xx:xx:xx:xx:xx:xx
  • Joining MoCA Network

Definition at line 1125 of file Device_MoCA_Interface.cpp.

◆ get_X_RDKCENTRAL_COM_NodePowerState()

int MoCAInterface::get_X_RDKCENTRAL_COM_NodePowerState ( HOSTIF_MsgData_t *  stMsgData)

Get the MoCA status for BootStatus.

This function provides the infromation about:

  • Coax connection confirmed, MoCA enabled
  • Discovering MoCA Network Coordinator: MoCA MAC: xx:xx:xx:xx:xx:xx
  • Joining MoCA Network

Definition at line 1105 of file Device_MoCA_Interface.cpp.