EtherNet/IP™ Adapter  1.04.00
User Reference Manual

◆ EI_API_ADP_setPortLogSyncInterval()

uint32_t EI_API_ADP_setPortLogSyncInterval ( T *  pAdp_p,
uint16_t  portLogSyncInterval_p 
)

Set the PortLogSyncInterval of the timeSync object of the adapter (Instance Attribute ID: 15).

Function that sets the Port Log Sync Interval attribute of the adapter selected by parameter pAdp_p. PortLogSyncIntervalCfg structure specifies the PTP sync interval between successive �Sync� messages issued by a master clock on each PTP port of the device. The units of the PortLogSyncInterval member are log base 2 seconds The PortLogSyncInterval is int16_t type. It's limited to values between -3 and 2. Note: The A port�s PortLogSyncInterval member should be less than or equal to its PortLogAnnounceInterval member.

Parameters
[in]pAdp_pPointer to the adapter.
[in]portLogSyncInterval_pint16_t Value of PTP Sync frame interval
Returns
EI_API_ADP_EError_t as uint32_t value.
Return values
EI_API_ADP_eERR_OKSuccess.
EI_API_ADP_eERR_GENERALGeneral error.
Example
#include <api/EI_API.h>
EI_API_ADP_T* pEI_API_ADP = NULL;
uint32_t errCode;
uint8_t numInterfaces = 1;
pEI_API_ADP = EI_API_ADP_new(numInterfaces);
// Set portLogSyncInterval in timeSync object
int16_t portLogSyncInterval = 1;
errCode = EI_API_ADP_setPortLogSyncInterval(pEI_API_ADP, portLogSyncInterval);
ETHIP_API T * EI_API_ADP_new(uint8_t numInterfaces_p)
Create a new EtherNet/IP adapter.
Definition: EI_API_ADP_main.c:232
ETHIP_API uint32_t EI_API_ADP_setPortLogSyncInterval(T *pAdp_p, uint16_t portLogSyncInterval_p)
Set the PortLogSyncInterval of the timeSync object of the adapter (Instance Attribute ID: 15).
Definition: EI_API_ADP_main.c:4802
See also
EI_API_ADP_EError_t