8.10. Hot Connect

8.10.1. emHCGetNumGroupMembers

EC_T_DWORD emHCGetNumGroupMembers(EC_T_DWORD dwInstanceID, EC_T_DWORD dwGroupIndex)

Get number of slaves belonging to a specific HotConnect group.

Parameters

  • dwInstanceID – [in] Instance ID (Multiple EtherCAT Network Support)

  • dwGroupIndex – [in] Index of HotConnect group, 0 is the mandatory group

Returns

Number of slaves belonging to specified HotConnect group

8.10.2. emHCGetSlaveIdsOfGroup

EC_T_DWORD emHCGetSlaveIdsOfGroup(EC_T_DWORD dwInstanceID, EC_T_DWORD dwGroupIndex, EC_T_DWORD *adwSlaveId, EC_T_DWORD dwMaxNumSlaveIds)

Return the list of ID referencing slaves belonging to a specific HotConnect group.

Parameters

  • dwInstanceID – [in] Instance ID (Multiple EtherCAT Network Support)

  • dwGroupIndex – [in] Index of HotConnect group, 0 is the mandatory group

  • adwSlaveId – [out] DWORD array to carry slave ids of specified HotConncet group

  • dwMaxNumSlaveIds – [in] size of adwSlaveId array

Returns

EC_E_NOERROR or error code

8.10.3. emNotify - EC_NOTIFY_HC_DETECTADDGROUPS

This notification is raised when HotConnect group detection is finished, after slave addition.

emNotify - EC_NOTIFY_HC_DETECTADDGROUPS
Parameter

  • pbyInBuf: [in] pointer to notification descriptor EC_T_HC_DETECTALLGROUP_NTFY_DESC

  • dwInBufSize: [in] sizeof(EC_T_HC_DETECTALLGROUP_NTFY_DESC)

  • pbyOutBuf: [out] Should be set to EC_NULL

  • dwOutBufSize: [in] Should be set to 0

  • pdwNumOutData: [out] Should be set to EC_NULL

struct EC_T_HC_DETECTALLGROUP_NTFY_DESC

Public Members

EC_T_DWORD dwResultCode

Result of Group detection

EC_T_DWORD dwGroupCount

Number of Groups

EC_T_DWORD dwGroupsPresent

Number of connected groups

EC_T_DWORD dwGroupMask

Bitmask of first 32 Groups 1 = present, 0 = absent

EC_T_DWORD adwGroupMask[100]

Bitmask of first 3200 Groups

8.10.4. emNotify - EC_NOTIFY_HC_PROBEALLGROUPS

This notification is raised when HotConnect Group Detection is finished, after Slave Disappearance.

emNotify - EC_NOTIFY_HC_PROBEALLGROUPS
Parameter

  • pbyInBuf: [in] pointer to notification descriptor EC_T_HC_DETECTALLGROUP_NTFY_DESC

  • dwInBufSize: [in] sizeof(EC_T_HC_DETECTALLGROUP_NTFY_DESC)

  • pbyOutBuf: [out] Should be set to EC_NULL

  • dwOutBufSize: [in] Should be set to 0

  • pdwNumOutData: [out] Should be set to EC_NULL

struct EC_T_HC_DETECTALLGROUP_NTFY_DESC
EC_T_DWORD dwResultCode
EC_T_DWORD dwGroupCount
EC_T_DWORD dwGroupsPresent
EC_T_DWORD dwGroupMask
EC_T_DWORD adwGroupMask[100]

8.10.5. emNotify - EC_NOTIFY_HC_TOPOCHGDONE

This notification is raised when HotConnect has completely processed a topology change.

emNotify - EC_NOTIFY_HC_TOPOCHGDONE
Parameter

  • pbyInBuf: [in] Pointer to EC_T_DWORD (EC_E_NOERROR on success, Error code otherwise)

  • dwInBufSize: [in] sizeof(EC_T_DWORD)

  • pbyOutBuf: [out] Should be set to EC_NULL

  • dwOutBufSize: [in] Should be set to 0

  • pdwNumOutData: [out] Should be set to EC_NULL

The notification is raised when the slaves reached the current bus state.