- PDF Free Download

Size: px

Start display at page:

Download ""

Sarah Harrington
5 years ago
Views:

1 "Get_Alarm Basics TIA Portal, S Siemens Industry Online Support

2 Siemens AG 2017 All rights reserved Warranty and Liability Warranty and Liability The Application Examples are not binding and do not claim to be complete regarding the circuits shown, equipping and any eventuality. The Application Examples do not represent customer-specific solutions. They are only intended to provide support for typical applications. You are responsible for ensuring that the described products are used correctly. These Application Examples do not relieve you of the responsibility to use safe practices in application, installation, operation and maintenance. When using these Application Examples, you recognize that we cannot be made liable for any damage/claims beyond the liability clause described. We reserve the right to make changes to these Application Examples at any time without prior notice. If there are any deviations between the recommendations provided in these Application Examples and other Siemens publications e.g. Catalogs the contents of the other documents have priority. We do not accept any liability for the information contained in this document. Any claims against us based on whatever legal reason resulting from the use of the examples, information, programs, engineering and performance data etc., described in this Application Example shall be excluded. Such an exclusion shall not apply in the case of mandatory liability, e.g. under the German Product Liability Act ( Produkthaftungsgesetz ), in case of intent, gross negligence, or injury of life, body or health, guarantee for the quality of a product, fraudulent concealment of a deficiency or breach of a condition which goes to the root of the contract ( wesentliche Vertragspflichten ). The damages for a breach of a substantial contractual obligation are, however, limited to the foreseeable damage, typical for the type of contract, except in the event of intent or gross negligence or injury to life, body or health. The above provisions do not imply a change of the burden of proof to your detriment. Any form of duplication or distribution of these Application Examples or excerpts hereof is prohibited without the expressed consent of the Siemens AG. Security information Siemens provides products and solutions with industrial security functions that support the secure operation of plants, systems, machines and networks. In order to protect plants, systems, machines and networks against cyber threats, it is necessary to implement and continuously maintain a holistic, state-of-the-art industrial security concept. Siemens products and solutions only form one element of such a concept. Customer is responsible to prevent unauthorized access to its plants, systems, machines and networks. Systems, machines and components should only be connected to the enterprise network or the internet if and to the extent necessary and with appropriate security measures (e.g. use of firewalls and network segmentation) in place. Additionally, Siemens guidance on appropriate security measures should be taken into account. For more information about industrial security, please visit Siemens products and solutions undergo continuous development to make them more secure. Siemens strongly recommends to apply product updates as soon as available and to always use the latest product versions. Use of product versions that are no longer supported, and failure to apply latest updates may increase customer s exposure to cyber threats. To stay informed about product updates, subscribe to the Siemens Industrial Security RSS Feed under Entry ID: , V1.0, 09/2017 2

3 Siemens AG 2017 All rights reserved Table of Contents Table of Contents Warranty and Liability Introduction Overview Prerequisites Mode of Operation Reading pending alarm "Get_Alarm" Structure of an "AlarmData" alarm Range of Functions Operation Log in Reading out alarms Special characters in alarms Annex Service and support Links and literature Change documentation Entry ID: , V1.0, 09/2017 3

4 Siemens AG 2017 All rights reserved 1 Introduction 1 Introduction Alarms enable you to quickly recognize, precisely localize, and remove processing errors within automation systems. SIMATIC STEP 7 provides a central alarm system on the PLC that supports SIMATIC components such as SIMATIC HMI or SIMATIC NET OPC Server by the system. Advantages of the PLC-based alarm system are time stamps that are accurate to the cycle, the time-accurate acquisition of process-associated value and the central administration of alarm status and acknowledgment. The acknowledgement on an operator station is instantly displayed on all other stations, without the customer having to program anything manually. Since there are also existing systems in the field that cannot connect to systeminternal solutions, there is the demand for an applicative connection. Since the publication of TIA Portal V14 it is possible to directly read out alarms from the alarm server of the S PLC using the "Get_Alarm" instruction. 1.1 Overview Using the "Get_Alarm" instruction, you can read out alarms in the user program via the alarm interface of the S PLC. The "Get_Alarm" instruction registers at an alarm system interface of the S PLC, just like a SIMATIC HMI, in order to read out an incoming our outgoing alarm. The following figure shows, how S PLC alarms are received by one or several HMIs or "Get_Alarm". Figure 1-1 HMI 1 HMI 2 HMI 3 S PLC Alarm Get_Alarm - Log in (HMI power on) - Receive alarms - Log off (HMI power off) Entry ID: , V1.0, 09/2017 4

Siemens AG 2017 All rights reserved 1 Introduction You can use the "Get_Alarm instruction for the following PLC alarms of the S7-1500: - Program_Alarm - System diagnostics - Standard Motion Control

5 Siemens AG 2017 All rights reserved 1 Introduction You can use the "Get_Alarm instruction for the following PLC alarms of the S7-1500: - Program_Alarm - System diagnostics - Standard Motion Control (T-CPU) - Security (e.g. wrong login) - SINUMERIK - S7-GRAPH - ProDiag There are four possible alarm states, depending on assignment to an alarm class with or without having to acknowledge it: - Incoming - Incoming acknowledged - Outgoing - Outgoing acknowledged When executing the "Get_Alarm" instruction only the incoming and outgoing alarm messages of the PLC are received. The acknowledgment messages are not considered. 1.2 Prerequisites For the use of the "Get_Alarm" instruction the following requirements apply: TIA Portal V14 S PLC as of firmware V2.0 The following setting is recommended for the use of "Get_Alarm": Enable the "Central alarm management in the PLC" property in the hardware configuration of the S PLC. This property is enabled by default for new projects. Figure 1-2 If you do not enable the PLC property "Central alarm management in the PLC" in the hardware configuration, only the IDs of the alarm text fields will be output instead of the alarm texts. Entry ID: , V1.0, 09/2017 5

6 Siemens AG 2017 All rights reserved 2 Mode of Operation 2 Mode of Operation 2.1 Reading pending alarm "Get_Alarm" The "Get_Alarm" logs on for alarms using the "OperateMode = 1" and receives the alarms sequentially from the S PLC. After log on, it is ensured that no alarms get lost. "Get_Alarm" benefits from the internal alarm management system of the PLC in "OperateMode = 2". The mechanism of "Get_Alarm" processes the pending alarms asynchronously and thus avoids long runtimes of the function block. You have to make sure to pick up the alarms in the moment they are transferred by "Get_Alarm" to the receive buffer (DataReady = TRUE) using the "AlarmData" data type. In the next cycle the receive buffer can theoretically be overwritten. This is why the content of the receive buffer of "Get_Alarm" generally has to be copied to another data area. In this data area the management of the alarms can be carried depending on own interests. Figure 2-1 Entry ID: , V1.0, 09/2017 6

7 Siemens AG 2017 All rights reserved 2 Mode of Operation The following table shows you the parameters of the "Get_Alarm" instruction: Table 2-1 Parameter Data type Description EN *) BOOL Enable input ENO *) BOOl Enable output OperateMode BYTE Possible values 1: Log in 2: Reading data 3: Log out DataMode BYTE Possible values: 0: Only read out column heading (no. 1-6 for AlarmData) 1: Read out alarm text incl. associated values 2: Read out alarm text incl. associated values and information text 3: Read out alarm text incl. associated values and all information texts DispClassNr ARRAY[0..31] of UINT Up to 32 different display classes : User-defined display classes (setting in HMI) - 257: System diagnostics - 259: Security Lcid UDINT Receipt of alarms up to three foreign languages 0: non parameters specified, all languages are registered (3 languages) 1: first language with smallest LC number 2: first language and second language with second smallest LC number 3: all languages or the precise LC number e.g. Microsoft Locale ID Values: List of locale ID Data "AlarmData" Destination area for the read alarm data DataReady BOOL Possible states: 0: Non data is available. 1: The data is available. Busy BOOL Possible states: 0: Execution of the instruction not yet started. 1: Execution of the instruction not yet completed. Error BOOL Possible states: 0: No error 1: While executing the instruction an error occurred. Init BOOL Possible states: 0: No action necessary. 1: A new login is required or after successful login. Status WORD Error and status information *) Only viable in the programming languages LAD and FBD Entry ID: , V1.0, 09/2017 7

8 Siemens AG 2017 All rights reserved 2 Mode of Operation 2.2 Structure of an "AlarmData" alarm The "AlarmData" data type reflects the structure of an alarm. Table 2-2 No. Name Data type Description 1. ProducerID UINT Possible values: 0: Program_Alarm 4: System diagnostics 5: Standard Motion Control 6: Security 7: SINUMERIK 8: GRAPH 9: ProDiag 2. ID_1 UINT Alarm ID is also displayed in alarm editor 3. ID_2 UINT ID of alarm runtime instance 4. PRIO UINT Priorities: TimeStamp LDT Time stamp 6. State BYTE Status parameter: 0: Outgoing 1: Incoming 7. LC_ID ARRAY[0..2] of UNIT Provides the Lcids of the languages selected that are defined in the hardware configuration. See lcid 8. AlarmText ARRAY[0..2] of WSTRING 9. InfoText ARRAY[0..2] of WSTRING 10. AddText_1-9 ARRAY[0..2] of WSTRING Alarm text up to 254 characters. (see also chapter 4.3) Information text Additional text 1-9 Entry ID: , V1.0, 09/2017 8

9 Siemens AG 2017 All rights reserved 3 Range of Functions 3 Range of Functions The "Get_Alarm" instruction and the SIMATIC HMI use the same interface to read out the alarms. This is why the range of functions, is that of the alarms read by the "Get_Alarm" instruction, which is output by SIMATIC HMI alarms. Information on acknowledged alarms is not included in the range of functions. The range of functions in overview: You can read out alarms in up to three configured foreign languages on the PLC or in a specific local language. You can specify for what display classes the "Get_Alarm" instruction is to receive the alarms, e.g. according to technological viewpoints. You can integrate additional information in the alarm text. Alarm text incl. associated values Alarm text with associated values and information text Alarm text with associated values incl. all additional texts (max. possible information content just as for WinCC Professional) How to insert the associated values in alarms can be found in the manual "STEP 7 Professional V14 SP1" in the chapter Insert associated values in alarms (S7-1500)". The time stamp of the PLC is stored in the alarm text on the basis of UTC (Universal Time Coordinated). The alarms are changed to the local time before being displayed on the client, e.g. HMI, winter/summer (daylight saving time) is observed. If the target system does not support this function, you have to carry out this conversion manually. Entry ID: , V1.0, 09/2017 9

10 Siemens AG 2017 All rights reserved 4 Operation 4 Operation 4.1 Log in The login process differs between HMI and "Get_Alarm". In Runtime, the HMI automatically logs in to the S PLC addressed and receives all pending alarms once. In order to read out the alarms directly from the alarm server of the S PLC via "Get_Alarm", proceed as follows: Table 4-1 No. Description 1. Establish a connection with the S PLC. 2. Log in the Get_Alarm instruction manually using "OperateMode = 1". 3. When logging in, define the display classes "DispClassNr". If no parameter is specified, all display classes are logged on. A change of the "DispClassNr" is only adopted in "OperateMode = 1". 4. When logging on, select the "Lcid" languages. (LcID=0, all languages) 5. Reading out the alarms is done in "OperateMode= 2". In the following cases it is necessary, that you log in the "Get_Alarm" instruction again using "OperateMode = 1": After automatic log out of "Get_Alarm" by the system, if the alarms cannot be read out within a minute. When changing the alarm configuration, e.g. ProDiag monitoring. The "Get_Alarm" recognizes the changes and logs out automatically. After a change of the PLC operating state from "STOP" to "RUN" or reversed, "Get_Alarm" automatically logs out. After manually logging out using "OperateMode = 3", e.g. when the connection to the target system fails (monitoring of the connection by the user from the program). Multiple login is not permitted. The following error message is displayed: Error code 0x8004: You already logged in to the user program via the "OperateMode = 1" parameter in order to read out pending alarms. A repeated login is only permissible and necessary if you log out using "OperateMode = 3", if have reconfigured alarms or performed a STOP > RUN transition". Entry ID: , V1.0, 09/

11 Siemens AG 2017 All rights reserved 4 Operation 4.2 Reading out alarms After login in "OperateMode = 1", the "Get_Alarm" has to be called for the regular operation on the next PLC cycle in "OperateMode = 2". The following operating states can occur using the "Get_Alarm" instruction in "OperateMode = 2": Table 4-2 Operating states Description Busy = TRUE DataReady = FALSE Error = FALSE Alarms pending, alarm processing is performed Busy = FALSE DataReady = TRUE Error = FALSE New alarm ready in receive buffer > fetch data *) Busy = FALSE DataReady = FALSE Error = FALSE No new alarms Busy = FALSE DataReady = FALSE Error = TRUE An error occurred (data is invalid) *) You have to copy the data in the same program cycle since it is only valid until the next call of the instruction. The "Get_Alarm" has to be repeatedly called in a cycle organization block. The duration of the alarm processing depends on the number of selected languages and other parameters. In order to ensure fast processing of the alarms by "Get_Alarm", only call the information that you really require. This is particularly the case for the number of alarm text blocks and also the languages required. The "Init" parameter gives you an indication to delete the data area (in which the alarms from the receive buffer have been copied) for new alarms. This is, for example, necessary when logging in "OperateMode = 1". In the following cases an Init parameter is set to TRUE: When logging in using "OperateMode = 1". If the PLC goes from "STOP" to "RUN". If you have reconfigured alarms and have loaded the changes via Download to device. Entry ID: , V1.0, 09/

12 Siemens AG 2017 All rights reserved 4 Operation 4.3 Special characters in alarms When using special characters, please note the following: For Cyrillic or oriental fonts, each character needs up to 4 byte. In this case you can display 60 character + 3 dots in 256 byte. For special characters, e.g. " " / "ß" etc. the PLC changes these characters in 2 byte so that they can be highlighted (extended ASCII range). The "Get_Alarm" instruction can use up to a max. of 256 byte per text field. Entry ID: , V1.0, 09/

13 Siemens AG 2017 All rights reserved 5 Annex 5 Annex 5.1 Service and support Industry Online Support Technical Support Do you have any questions or need support? Siemens Industry Online Support offers access to our entire service and support know-how as well as to our services. Siemens Industry Online Support is the central address for information on our products, solutions and services. Product information, manuals, downloads, FAQs and application examples all information is accessible with just a few mouse clicks at Siemens Industry's Technical Support offers quick and competent support regarding all technical queries with numerous tailor-made offers from basic support right up to individual support contracts. Please address your requests to the Technical Support via the web form: Service offer Our service offer comprises, among other things, the following services: Product Training Plant Data Services Spare Parts Services Repair Services On Site and Maintenance Services Retrofit and Modernization Services Service Programs and Agreements Detailed information on our service offer is available in the Service Catalog: Industry Online Support app Thanks to the "Siemens Industry Online Support" app, you will get optimum support even when you are on the move. The app is available for Apple ios, Android and Windows Phone: Entry ID: , V1.0, 09/

14 Siemens AG 2017 All rights reserved 5 Annex 5.2 Links and literature Table 5-1 No. \1\ Siemens Industry Online Support Topic \2\ Link to the entry page of the application example \3\ STEP 7 Professional V14 SP1 System Manual \4\ Microsoft Locale ID Values Change documentation Table 5-2 Version Date Modification V1.0 09/2017 First version Entry ID: , V1.0, 09/

https://support.industry.siemens.com/cs/ww/en/view/

Reading out the S7-1500 CPU Alarm using "" and sending it to an Alarm System TIA Portal, S7-1500, OPC UA Client https://support.industry.siemens.com/cs/ww/en/view/109748168 Siemens Industry Online Support