GetSetting / SetSetting / RNtfSetting

GetSetting

GetSetting / SetSetting / RNtfSetting 1:

The GetSetting method is used to query the Boolean property of the OCA object. If the query was successful, the result is output in the property stSetting.

GetSetting / SetSetting / RNtfSetting 2:

Cyclic method call

Since several PLC cycles may pass between sending and the response from the device, this method should be executed cyclically.

Syntax

VAR_INPUT
   pLink    : POINTER TO ST_Link;
   bExecute : BOOL;
END_VAR

GetSetting / SetSetting / RNtfSetting 3: Inputs

Name

Type

Description

pLink

POINTER TO ST_Link

Pointer for establishing a connection between OCA objects and the OCA device

bExecute

BOOL

The method is executed with a positive edge at the bExecute input.

SetSetting

GetSetting / SetSetting / RNtfSetting 4:

The SetSetting method can be used to set the muting feature of an OCA object. If the method was executed successfully, the result is output in the property stMuteState.

GetSetting / SetSetting / RNtfSetting 5:

Cyclic method call

Since several PLC cycles may pass between sending and the response from the device, this method should be executed cyclically.

Syntax

VAR_INPUT
   pLink    : POINTER TO ST_Link;
   bExecute : BOOL;
   bSetting : BOOL;
   eCmdMode : E_OcaMessageTypeCmd;
END_VAR

GetSetting / SetSetting / RNtfSetting 6: Inputs

Name

Type

Description

pLink

POINTER TO ST_Link

Pointer for establishing a connection between OCA objects and the OCA device.

bExecute

BOOL

The method is executed with a positive edge at the bExecute input.

bSetting

BOOL

Value to be assigned to the property of the OCA object.

eCmdMode

OcaMessageTypeCmd

Depending on whether confirmation is required or not, this input variable is set to E_OcaMessageTypeCmd.OcaCmdRrq or E_OcaMessageTypeCmd.OcaCmd.

RNtfMuteState

GetSetting / SetSetting / RNtfSetting 7:

If the OCA object was prompted to notify changes (using the Subscription method), incoming notifications are read using the RNtfSetting method.

GetSetting / SetSetting / RNtfSetting 8:

Cyclic method call

Since several PLC cycles may pass between sending and the response from the device, this method should be executed cyclically.

Syntax

VAR_INPUT
   pLink           : POINTER TO ST_Link;
   bEnable         : BOOL;
   nSubscribtionNo : UDINT;
END_VAR

GetSetting / SetSetting / RNtfSetting 9: Inputs

Name

Type

Description

pLink

POINTER TO ST_Link

Pointer for establishing a connection between OCA objects and the OCA device.

bExecute

BOOL

The method is executed with a positive edge at the bExecute input.

nSubscribtionNo

UDINT

Unique number for localizing the respective subscription.