SRV_PCOUP_Set_Channel_Config Function

C

bool SRV_PCOUP_Set_Channel_Config(DRV_HANDLE handle, DRV_PLC_PHY_CHANNEL channel);

Summary

Set the PLC PHY Coupling parameters for the specified PRIME channel.

Description

This function allows to set the PLC PHY Coupling parameters for the specified PRIME channel, using the PLC Driver PIB interface (DRV_PLC_PHY_PIBSet).

Precondition

The PLC driver's open routine (DRV_PLC_PHY_Open) must have been called to obtain a valid opened device handle.

Parameters

ParamDescription
handleA valid instance handle, returned from the PLC driver's open routine
channelPRIME channel (DRV_PLC_PHY_CHANNEL Enum) for which the parameters will be set

Returns

  • true

    • Successful configuration

  • false

    • if channel parameter is not valid

    • if there is an error when using the PLC Driver PIB interface

Example

// 'handle', returned from DRV_PLC_PHY_Open
bool result;

result = SRV_PCOUP_Set_Channel_Config(handle, CHN5);

Remarks

This function is only generated by MCC if the PLC Driver uses PRIME PHY.