FB_iec61850ClientClass

FB_iec61850ClientClass 1:

The function block FB_iec61850CommonClass implements interfaces for communication and data exchange between the TwinCAT PLC client application and the IEC 61850 server.

Namespace: Tc3_iec61850
Library: Tc3_iec61850 (Tc3_iec61850.compiled-library)

Inheritance hierarchy

FB_iec61850ClientClass

FUNCTION_BLOCK FB_iec61850ClientClass IMPLEMENTS 
    I_ScsmClientClass,
    I_ScsmSystemClockEventSink,
    I_ScsmAbortIndEventSink,
    I_ScsmAssociateCnfEventSink,
    I_ScsmReleaseIndEventSink,
    I_ScsmReleaseCnfEventSink,
    I_ScsmGetDataValuesCnfEventSink,
    I_ScsmSetDataValuesCnfEventSink,
    I_ScsmControlCnfEventSink,
    I_ScsmGetServerDirectoryCnfEventSink,
    I_ScsmGetLogicalDeviceDirectoryCnfEventSink,
    I_ScsmGetLogicalNodeDirectoryCnfEventSink,
    I_ScsmCreateDataSetCnfEventSink,
    I_ScsmDeleteDataSetCnfEventSink,
    I_ScsmGetDataSetDirectoryCnfEventSink,
    I_ScsmReportIndEventSink,
    I_ScsmLastApplErrorIndEventSink,
    I_ScsmCommandTerminationIndEventSink,
    I_ScsmIdentifyCnfEventSink,
    I_ScsmStatusCnfEventSink
VAR_INPUT
    settings : FB_ScsmClientSettingsClass;
END_VAR

FB_iec61850ClientClass 2: Interfaces

Type

Description

I_ScsmClientClass

Interfaces for establishment of communication and data exchange.

I_ScsmAbortIndEventSink

Interface of the Abort service event handling routine.

I_ScsmAssociateCnfEventSink

Interface of the Associate service event handling routine.

I_ScsmReleaseCnfEventSink

Interface of the Release service event handling routine.

I_ScsmReleaseIndEventSink

Interface of the Release service event handling routine.

I_ScsmGetDataValuesCnfEventSink

Interface of the GetDataValues service event handling routine.

I_ScsmSetDataValuesCnfEventSink

Interface of the SetDataValues event handling routine.

I_ScsmControlCnfEventSink

Interface of the control service event handling routine for switch control (Operate, Cancel, Select, SelectWithValue).

I_ScsmGetServerDirectoryCnfEventSink

Interface of the GetServerDirectory service event handling routine.

I_ScsmGetLogicalDeviceDirectoryCnfEventSink

Interface of the GetLogicalDeviceDirectory service event handling routine.

I_ScsmGetLogicalNodeDirectoryCnfEventSink

Interface of the GetLogicalNodeDirectory service event handling routine.

I_ScsmCreateDataSetCnfEventSink

Interface of the CreateDataSet service event handling routine.

I_ScsmDeleteDataSetCnfEventSink

Interface of the DeleteDataSet service event handling routine.

I_ScsmGetDataSetDirectoryCnfEventSink

Interface of the GetDataSetDirectory service event handling routine.

I_ScsmSystemClockEventSink

Interface of the SystemClock service event handling routine.

I_ScsmReportIndEventSink

Interface of the Report service event handling routine.

I_ScsmLastApplErrorIndEventSink

Interface of the LastAppError service event handling routine.

I_ScsmCommandTerminationIndEventSink

Interface of the command termination event handling routine interface for switch control.

I_ScsmIdentifyCnfEventSink

Interface of the MMS-Identify service event handling routine.

I_ScsmStatusCnfEventSink

Interface of the MMS-Status service event handling routine.

FB_iec61850ClientClass 3: Inputs

Name

Type

Description

settings

FB_ScsmClientSettingsClass

Protocol settings for the communication layer.

FB_iec61850ClientClass 4: Methods

Name

Description

Execute

This method triggers the execution of the communication layer.

AssociateReq

Enables the service: Associate.

ReleaseReq

Enables the service: Release.

ReleaseRsp

Responds to the service: Release.

AbortReq

Enables the service: Abort.

ControlCancelReq

Enables the service: Cancel.

ControlOperateReq

Enables the service: Operate.

ControlSelectReq

Enables the service: Select.

ControlSelectWithValueReq

Enables the service: SelectWithValue.

CreateDataSetReq

Enables the service: CreateDataSet.

DeleteDataSetReq

Enables the service: DeleteDataSet.

GetAllDataValuesReq

Enables the service: GetAllDataValues.

GetAllLogicalDeviceValuesReq

Enables the service: GetAllLogicalDeviceValues (TwinCAT specific).

GetAllServerValuesReq

Enables the service: GetAllServerValues (TwinCAT specific).

GetBrCBValuesReq

Enables the service: GetBRCBValues.

GetDataSetDirectoryReq

Enables the service: GetDataSetDirectory.

GetDataSetValuesReq

Enables the service: GetDataSetValues.

GetDataValuesReq

Enables the service: GetDataValues.

GetGoCBValuesReq

Enables the service: GetGoCBValues.

GetGsCBValuesReq

Enables the service: GetGsCBValues.

GetLCBValuesReq

Enables the service: GetLCBValues.

GetLogicalDeviceDirectoryReq

Enables the service: GetLogicalDeviceDirectory.

GetLogicalNodeDirectoryReq

Enables the service: GetLogicalNodeDirectory.

GetMsvCBValuesReq

Enables the service: GetMSVCBValues.

GetServerDirectoryReq

Enables the service: GetServerDirectory.

GetSgCBValuesReq

Enables the service: GetSGCBValuesReq.

GetUrCBValuesReq

Enables the service: GetURCBValues.

GetUsvCBValuesReq

Enables the service: GetUSVCBValues.

SetAllDataValuesReq

Enables the service: SetAllDataValues (TwinCAT specific).

SetBrCBValuesReq

Enables the service: SetBRCBValues.

SetDataSetValuesReq

Enables the service: SetDataSetValues (TwinCAT specific).

SetDataValuesReq

Enables the service: SetDataValues.

SetGoCBValuesReq

Enables the service: SetGoCBValues.

SetGsCBValuesReq

Enables the service: SetGsCBValues.

SetLCBValuesReq

Enables the service: SetLCBValues.

SetMsvCBValuesReq

Enables the service: SetMSVCBValues.

SetSgCBValuesReq

Enables the service: SetSGCBValues.

SetUrCBValuesReq

Enables the service: SetURCBValues.

SetUsvCBValuesReq

Enables the service: SetUSVCBValues.

IdentifyReq

Enables the service: MMS-Identify.

StatusReq

Enables the service: MMS-Status.

FB_iec61850ClientClass 5: Methods of event handling (callback methods)

Name

Description

OnAssociateCnf

User-defined associate service event handling routine.

OnReleaseCnf

User-defined release service event handling routine.

OnReleaseInd

User-defined release service event handling routine.

OnAbortInd

User-defined abort service event handling routine.

OnControlCnf

User-defined control service event handling routine for switch control (Operate, Cancel, Select, SelectWithValue).

OnCreateDataSetCnf

User-defined CreateDataSet service event handling routine.

OnDeleteDataSetCnf

User-defined DeleteDataSet service event handling routine.

OnGetDataSetDirectoryCnf

User-defined GetDataSetDirectory service event handling routine.

OnGetDataValuesCnf

User-defined GetDataValues service event handling routine.

OnGetLogicalDeviceDirectoryCnf

User-defined GetLogicalDeviceDirectory service event handling routine.

OnGetLogicalNodeDirectoryCnf

User-defined GetLogicalNodeDirectory service event handling routine.

OnGetServerDirectoryCnf

User-defined GetServerDirectory service event handling routine.

OnLastApplErrorInd

User-defined LastApplError service event handling routine.

OnBufferedReportInd

User-defined buffered report service event handling routine.

OnUnbufferedReportInd

User-defined unbuffered report service event handling routine.

OnSetDataValuesCnf

User-defined SetDataValues service event handling routine.

OnGetSystemTime

User-defined system clock service event handling routine.

OnCommandTerminationInd

User-defined command termination event handling routine for switch control.

OnIdentifyCnf

User-defined MMS-identify service event handling routine.

OnStatusCnf

User-defined MMS-Status service event handling routine.

FB_iec61850ClientClass 6: Properties

Name

Type

Access

Description

ipIED

I_AcsiCommonIntelligentElectronicDeviceClass

Get,Set

Interface pointer of an object with the implementation of the top-level of the IEC 61850 data model.

eLinkStatus

E_ScsmLinkStatus

Get

Client-Link-Status. Link status of the network adapter (client sockets).

eState

E_AsyncEnvironmentState

Get

Environmental state of the communication connection.

ipSettings

I_ScsmClientSettingsClass

Get

Protocol settings for the communication layer.

ipAssociateCnf

I_ScsmAssociateCnfEventSink

Set

Interface pointer of an object with a user-defined implementation of the event handling routine: OnAssociateCnf.

ipReleaseCnf

I_ScsmReleaseCnfEventSink

Set

Interface pointer of an object with a user-defined implementation of the event handling routine: OnReleaseCnf.

ipReleaseInd

I_ScsmReleaseIndEventSink

Set

Interface pointer of an object with a user-defined implementation of the event handling routine: OnReleaseInd.

ipAbortInd

I_ScsmAbortIndEventSink

Set

Interface pointer of an object with a user-defined implementation of the event handling routine: OnAbortInd.

ipSystemClock

I_ScsmSystemClockEventSink

Set

Interface pointer of an object with a user-defined implementation of the event handling routine: OnGetSystemTime.

ipControlCnf

I_ScsmControlCnfEventSink

Set

Interface pointer of an object with a user-defined implementation of the event handling routine: OnControlCnf.

ipCreateDataSetCnf

I_ScsmCreateDataSetCnfEventSink

Set

Interface pointer of an object with a user-defined implementation of the event handling routine: OnCreateDataSetCnf.

ipDeleteDataSetCnf

I_ScsmDeleteDataSetCnfEventSink

Set

Interface pointer of an object with a user-defined implementation of the event handling routine: OnDeleteDataSetCnf.

ipGetDataSetDirectoryCnf

I_ScsmGetDataSetDirectoryEventSink

Set

Interface pointer of an object with a user-defined implementation of the event handling routine: OnGetDataSetDirectoryCnf.

ipGetDataValuesCnf

I_ScsmGetDataValuesCnfEventSink

Set

Interface pointer of an object with a user-defined implementation of the event handling routine: OnGetDataValuesCnf.

ipGetLogicalDeviceDirectoryCnf

I_ScsmGetLogicalDeviceDirectoryCnfEventSink

Set

Interface pointer of an object with a user-defined implementation of the event handling routine: OnGetLogicalDeviceDirectoryCnf.

ipGetLogicalNodeDirectoryCnf

I_ScsmGetLogicalNodeDirectoryCnfEventSink

Set

Interface pointer of an object with a user-defined implementation of the event handling routine: OnGetLogicalNodeDirectoryCnf.

ipGetServerDirectoryCnf

I_ScsmGetServerDirectoryCnfEventSink

Set

Interface pointer of an object with a user-defined implementation of the event handling routine: OnGetServerDirectoryCnf.

ipIdentifyCnf

I_ScsmIdentifyCnfEventSink

Set

Interface pointer of an object with a user-defined implementation of the event handling routine: OnIdentifyCnf.

ipLastApplErrorInd

I_ScsmLastApplErrorIndEventSink

Set

Interface pointer of an object with a user-defined implementation of the event handling routine: OnLastApplErrorInd.

ipReportInd

I_ScsmReportIndEventSink

Set

Interface pointer of an object with a user-defined implementation of the event handling routine: OnBufferedReportInd and OnUnbufferedReportInd.

ipSetDataValuesCnf

I_ScsmSetDataValuesCnfEventSink

Set

Interface pointer of an object with a user-defined implementation of the event handling routine: OnSetDataValuesCnf.

ipStatusCnf

I_ScsmStatusCnfEventSink

Set

Interface pointer of an object with a user-defined implementation of the event handling routine: OnStatusCnf.

ipCommandTerminationInd

I_ScsmCommandTerminationIndEventSink

Set

Interface pointer of an object with a user-defined implementation of the event handling routine: OnCommandTerminationInd.

ipAssociation

I_ScsmAssociationClass

Get

Interface pointer of an object that identifies the client connection.

sDesc

STRING

Get,Set

The description of the client connection.