SRV_PCOUP_Set_Config Function

C

bool SRV_PCOUP_Set_Config(DRV_HANDLE handle, uint8_t phyBand);

Summary

Set the PLC PHY Coupling parameters for the G3-PLC PHY band.

Description

This function allows to set the PLC PHY Coupling parameters for the G3-PLC PHY band, using the PLC Driver PIB interface (DRV_PLC_PHY_PIBSet or DRV_G3_MACRT_PIBSet).

Precondition

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

Parameters


Param	Description
handle	A valid instance handle, returned from the PLC driver's open routine
phyBand	G3-PLC PHY band for which for which the parameters will be set

Returns

true
- Successful configuration
false
- if phyBand parameter is not valid
- if there is an error when using the PLC Driver PIB interface

Example

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

result = SRV_PCOUP_Set_Config(handle, G3_FCC);

Remarks

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