FB_ScsmClientSettingsClass

The function block FB_ScsmClientSettingsClass is used to configure the SCSM communication layer.

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

Inheritance hierarchy

FB_SocketClientSettingsClass -> FB_TpktClientSettingsClass -> FB_Rfc1006ClientSettingsClass -> FB_UlosiClientSettingsClass -> FB_MmsClientSerttingsClass -> FB_ScsmClientSettingsClass


FUNCTION_BLOCK FB_ScsmClientSettingsClass EXTENDS FB_MmsClientSettingsClass IMPLEMENTS I_ScsmClientSettingsClass

Interfaces

Type	Description
I_ScsmClientSettingsClass	Interface for configuring the SCSM communication layer

Methods

Name	Description
Defaults	Resets the configuration settings to the default values.

Inputs

Name	Type	Definition location	Description
services	FB_MmsServiceSupportOptions	Inherited from FB_MmsClientSettingsClass	Configuration of the supported MMS protocol services.
parameters	FB_MmsParameterSupportOptions	-//-	Configuration of the supported MMS protocol parameters.
extendedServices	FB_MmsAdditionalSupportOptions	-//-	Configuration of the additionally supported MMS protocol services.
extendedParameters	FB_MmsAdditionalCBBOptions	-//-	Configuration of the supported MMS-CBB protocol parameters.

Properties

Name	Type	Access	Definition location	Initial value	Description
bAutoCleanup	BOOL	Get,Set	Inherited from FB_SocketClientSettingsClass	TRUE	Enables/disables the automatic clean-up/closure of the unused sockets (e.g. after program download or PLC reset).
sSrvNetID	T_AmsNetID	Get,Set	-//-	‘‘	TwinCAT network address of the TwinCAT TCP/IP server (TF6310). With the empty string, the network address of the local TwinCAT system is used.
nRemotePort	UDINT	Get,Set	-//-	102	TCP/IP port number of the server.
sRemoteHost	T_Ipv4Addr	Get,Set	-//-	‘127.0.0.1‘	IPv4 network address of the server.
tConnect	TIME	Get,Set	-//-	T#45s	Earliest time on expiry of which a new connection can be established.
tAdsTimeout	TIME	Get,Set	-//-	DEFAULT_ADS_TIMEOUT	Maximum timeout time for ADS services that may not be exceeded.
tSocketTimeout	TIME	Get,Set	-//-	T#5s	Maximum timeout time during the execution of the confirmed services that may not be exceeded.
bThrottleMode	BOOL	Get,Set	-//-	TRUE	Enables/disables the receive data throttle polling mode.
throttleTimes	T_ThrottleTimes	Get,Set	-//-	Param_Sockets.cDefaultReceiverThrottleTimes	Configuration of the cycle times for the receive data throttle polling mode.
eTraceSocket	E_TraceLevel	Get,Set	-//-	E_TraceLevel.None	Configures the priority level for the logging of the error messages and log messages.
ipTLS	I_SocketTlsSettingsClass	Get,Set	-//-	0	Configuration parameters of the TLS (Transport Layer Security) protocol layer. Value null = not configured.
bEvaLinkStatusErr	BOOL	Get,Set	-//-	FALSE	Configures the evaluation mode for the link status error of the network adapter. If "FALSE" then disabled, short connection interruptions are bridged. If "TRUE" is enabled, the connection is terminated when a connection error is detected.

tTpktTimeout	TIME	Get,Set	Inherited from FB_TpktClientSettingsClass	T#10s	Maximum time that may not be exceeded during the execution of the confirmed services.
eTraceTpkt	E_TraceLevel	Get,Set	-//-	E_TraceLevel.None	Configures the priority level for the logging of the error messages and log messages.

sCalling_T_Selector	STRING	Get,Set	Inherited from FB_Rfc1006ClientSettingsClass	’00 00’	RFC 1006 parameter: Calling transport address selector (source).
sCalled_T_Selector	STRING	Get,Set	-//-	’00 01’	RFC 1006 parameter: Called transport address selector (destination).
eTpduSize	E_Rfc1006TpduSize	Get,Set	-//-	E_Rfc1006TpduSize.Size_1024	Maximum TPDU byte length.
tRfc1006Timeout	TIME	Get,Set	-//-	T#15s	Maximum time that may not be exceeded during the execution of the confirmed services.
eTraceRfc1006	E_TraceLevel	Get,Set	-//-	E_TraceLevel.None	Configures the priority level for the logging of the error messages and log messages.

sCalling_S_Selector	STRING	Get,Set	Inherited from FB_UlosiClientSettingsClass	’00 01‘	Calling-S-selector.
sCalled_S_Selector	STRING	Get,Set	-//-	’00 01‘	Called-S-selector.
nSessionRequirement	WORD	Get,Set	-//-	2	Session requirements. With the setting 16#FFFF, the value is optional and is not transmitted.
sCalling_P_Selector	STRING	Get,Set	-//-	’00 00 00 01‘	Calling-P-selector.
sCalled_P_Selector	STRING	Get,Set	-//-	’00 00 00 01‘	Called-P-selector.
nPresentRequirements	BYTE	Get,Set	-//-	0	Presentation requirements. With the setting: 0, the value is transmitted and with the setting 16#FF, the value is optional and is not transmitted.
nPresentProtocolVersion	BYTE	Get,Set	-//-	16#FF	Presentation protocol version. With the setting 1, the value is transmitted and with the setting 16#FF, the value is optional and is not transmitted.
nProtocol_Version	BYTE	Get,Set	-//-	16#FF	Association Control Service protocol version. With the setting 1, the value is transmitted and with the setting 16#FF, the value is optional and is not transmitted.
sContext_Name	STRING	Get,Set	-//-	'1.0.9506.2.3'	Application context name (object identifier, dotted presentation), MMS.
sCalled_AP_Title	STRING	Get,Set	-//-	'1.1.1.999.1'	Called-AP-title. With the empty string, the value is optional and is not transmitted.
nCalled_AE_Qualifier	UDINT	Get,Set	-//-	12	Called-AE-qualifier. With the setting 16#FFFFFFFFFF, the value is optional and is not transmitted.
nCalled_AP_InvID	UDINT	Get,Set	-//-	16#FFFFFFFF	Called-AP-invocation-identifier. With the setting 16#FFFFFFFFFF, the value is optional and is not transmitted.
nCalled_AE_InvID	UDINT	Get,Set	-//-	16#FFFFFFFF	Called-AE-invocation-identifier. With the setting 16#FFFFFFFFFF, the value is optional and is not transmitted.
sCalling_AP_Title	STRING	Get,Set	-//-	'1.1.1.999'	Calling-AP-title. With the empty string, the value is optional and is not transmitted.
nCalling_AE_Qualifier	UDINT	Get,Set	-//-	12	Calling-AE-qualifier. With the setting 16#FFFFFFFFFF, the value is optional and is not transmitted.
nCalling_AP_InvID	UDINT	Get,Set	-//-	16#FFFFFFFF	Calling-AP-invocation-identifier. With the setting 16#FFFFFFFFFF, the value is optional and is not transmitted.
nCalling_AE_InvID	UDINT	Get,Set	-//-	16#FFFFFFFF	Calling-AE-invocation-identifier. With the setting 16#FFFFFFFFFF, the value is optional and is not transmitted.
nRequirements	BYTE	Get,Set	-//-	0	Association Control Service requirements. The value: 1 enables the authentication function and the value: 0 disables it.
sMechanism_Name	STRING	Get,Set	-//-	'2.2.3.1'	Authentication mechanism name. If there is no empty string and the authentication function is enabled, the value is transmitted.
sAuthent_Value	STRING	Get,Set	-//-	‘‘	Authentication value (password). If there is no empty string and the authentication function is enabled, the value is transmitted.
sResponding_Value	STRING	Get,Set	-//-	‘‘	Responding authentication value (password). If there is no empty string and the authentication function is enabled and the authentication mode is mutual, the value is transmitted.
eAcse_Authent	E_AcseAuthentication	Get,Set	-//-	E_AcseAuthentication.Unilateral	Authentication mode.
tUlosiTimeout	TIME	Get,Set	-//-	T#20s	Maximum time that may not be exceeded during the execution of the confirmed services.
eTraceUlosi	E_TraceLevel	Get,Set	-//-	E_TraceLevel.None	Configures the priority level for the logging of the error messages and log messages.

nLocalDetail	T_MmsInteger32	Get,Set	Inherited from FB_MmsClientSettingsClass	65000	MMS Initiate-RequestPDU-Parameter: localDetailCalling.
nMaxServOutCalling	T_MmsInteger16	Get,Set	-//-	10	MMS Initiate-RequestPDU parameter: proposedMaxServOutstandingCalling
nMaxServOutCalled	T_MmsInteger16	Get,Set	-//-	10	MMS Initiate-RequestPDU parameter: proposedMaxServOutstandingCalled.
nNestingLevel	T_MmsInteger8	Get,Set	-//-	5	MMS Initiate-RequestPDU parameter: proposedDataStructureNestingLevel.
nMmsVersionNumber	T_MmsInteger16	Get,Set	-//-	16#0001	MMS initRequestDetail parameter: proposedVersionNumber.
ipParameters	I_MmsParameterSupportOptions	Get,Set	-//-	-	Interface pointer of the object for the configuration of the MMS initRequestDetail parameter: proposedParameterCBB.
ipServices	I_MmsServiceSupportOptions	Get,Set	-//-	-	Interface pointer of the object for the configuration of the MMS initRequestDetail parameter: servicesSupportedCalling.
ipExtendedServices	I_MmsAdditionalSupportOptions	Get,Set	-//-	-	Interface pointer of the object for the configuration of the MMS initRequestDetail parameter: additionalSupportedCalling.
ipExtendedParameters	I_MmsAdditionalCBBOptions	Get,Set	-//-	-	Interface pointer of the object for the configuration of the MMS initRequestDetail parameter: additionalCbbSupportedCalling.
sProvilegeClassIdentity	T_MmsVisibleString	Get,Set	-//-	‘‘	MMS-initRequestDetail parameter: privilegeClassIdentityCalled.
tMmsTimeout	TIME	Get,Set	-//-	T#25s	Maximum time that may not be exceeded during the execution of the confirmed services.
eTraceMms	E_TraceLevel	Get,Set	-//-	E_TraceLevel.None	Configures the priority level for the logging of the error messages and log messages.

bAutoInitDataSets	BOOL	Get	I_ScsmClientSettingsClass	TRUE	Enables/disables the automatic initialization of the DataSets/DataSet member.
bAutoInitDataSets	BOOL	Set	Local	TRUE
eScsmEdition	E_ScsmEdition	Get	I_ScsmClientSettingsClass	E_ScsmEdition.Ed2	IEC 61850 data model edition (1 or 2)
eScsmEdition	E_ScsmEdition	Set	Local	E_ScsmEdition.Ed2	IEC 61850 data model edition (1 or 2)
tScsmTimeout	TIME	Get	I_ScsmClientSettingsClass	T#30s	Maximum time that may not be exceeded during the execution of the confirmed services.
tScsmTimeout	TIME	Set	Local	T#30s
eTraceScsm	T_TraceLevel	Get	I_ScsmClientSettingsClass	E_TraceLevel.None	Configures the priority level for the logging of the error messages and log messages.
eTraceScsm	T_TraceLevel	Set	Local	E_TraceLevel.None