Figure 13 shows an overview of the SafetyConsumer interfaces. The Safety Application Program Interface (SAPI) is specified in Clause 7.4.1, the Safety Parameter Interface (SPI) is specified in Clause 7.4.3.
Figure 13 – SafetyConsumer interfaces
The SAPI of the SafetyConsumer represents the safety communication layer services of the SafetyConsumer. Table 26 lists all inputs and outputs of the SAPI of the SafetyConsumer. [RQ7.4] Each SafetyConsumer shall implement the SAPI as shown in Table 26, however, the details are vendor-specific.
Table 26 – SAPI of the SafetyConsumer
|SafetyData||Structure||O||This output either delivers the process values received from the SafetyProvider in the SPDU field SafetyData, or FSV.|
|NonSafetyData||Structure||O||This output delivers the non-safety process values (e.g. diagnostic information) which were sent together with safe data, see Clause 126.96.36.199|
|Enable||Boolean||I||By changing this input to “0” the SafetyConsumer will change each and every variable of the SafetyData to “0”1 and stop sending requests to the SafetyProvider. When changing Enable to “1” the SafetyConsumer will restart safe communication. The variable can be used to delay the start of the OPC UA Safety communication, after power on until “OPC UA connection ready” is set. The delay time is not monitored while enable is set to “0”.|
|FSV_Activated||Boolean||O||This output indicates via “1”, that on the output SafetyData FSV (all binary “0”) are provided. NOTE: If the ResponseSPDU is checked with error: ActivateFSV is set.|
|OperatorAckConsumer||Boolean||I||For motivation, see Clause 7.4.2. After an indication of OperatorAckRequested this input can be used to signal an operator acknowledgment. By changing this input from “0” to “1” (rising edge) the SafetyConsumer is instructed to switch SafetyData from FSV to PV. OperatorAckConsumer is processed only if this rising edge arrives after OperatorAckRequested was set to “1”, see Figure 20.If a rising edge of OperatorAckConsumer arrives before OperatorAckRequested becomes 1, this rising edge is ignored.|
|OperatorAckRequested||Boolean||O||This output indicates the request for operator acknowledgment. The bit is set to “1” by the SafetyConsumer, when three conditions are met: 1. Too many communication errors were detected in the past, so the SafetyConsumer decided to switch to fail-safe substitute values. 2. Currently, no communication errors occur, and hence operator acknowledgment is possible. 3. Operator acknowledgment (rising edge at input OperatorAckConsumer) has not yet occurred.The bit is reset to “0” when a rising edge at OperatorAckConsumer is detected.|
|OperatorAckProvider||Boolean||O||This output indicates that an operator acknowledgment has taken place on the SafetyProvider. If operator acknowledgment at the SafetyProvider should be allowed, this output is connected to OperatorAckConsumer, see Annex B.2.4 and B.2.5.NOTE: If the ResponseSPDU is checked with error, this output remains at its last good value.|
|TestModeActivated||Boolean||O||The safety application program is expected to evaluate this output for determining whether the communication partner is in test mode or not. A value of “1” indicates that the communication partner (source of data) is in test mode, e.g., during commissioning. Data coming from a device in test mode may be used for testing but is not intended to be used to control safety-critical processes. A value of “0” represents the “normal” safety-related mode.Motivation: Test mode enables the programmer and commissioner to validate the safety application using test data. NOTE: If the ResponseSPDU check results in an error and the SafetyErrorIntervalTimer (see Clause 7.4.3) is also not expired, TestModeActivated is reset.|
|SafetyProviderID||UInt32||I||For dynamic systems, this input can be set to a non-zero value. In this case, the SafetyConsumer uses this variable instead of the SPI-Parameter SafetyProviderIDConfigured. This input is only read in the first cycle, or when a rising edge occurs at the input Enable. See also Table 27. If it is changed to “0”, the value of SPI parameter SafetyProviderIDConfigured will be used (again). For static systems, this input is usually always kept at value “0”.|
|SafetyBaseID||GUID||I||For dynamic systems, this input can be set to a non-zero value. In this case, the SafetyConsumer uses this variable instead of the SPI-Parameter SafetyBaseIDConfigured. This input is only read in the first cycle, or when a rising edge occurs at the input Enable. See also Table 27. If it is changed to “0”, the SPI-parameter SafetyBaseIDConfigured will become activated. For static systems, this input is usually always kept at value “0”.|
|SafetyConsumerID||UInt32||I||For dynamic systems, this input can be set to a non-zero value. In this case, the SafetyConsumer uses this variable instead of the SPI-Parameter SafetyConsumerID. This input is only read in the first cycle, or when a rising edge occurs at the input Enable. See also Table 27. If it is changed to “0”, the SPI-parameter SafetyConsumerID will become activated. For static systems, this input is usually always kept at value “0”.|