Programming Interface Description of the Functions

Transcription

1 SIMATIC NET Programming Interface DP-Base Master Class 2 for CP 5613/CP 5614 Preface, Contents of the Functions of the DP Master Class 2 1 Manual C79000-G8976-C Release 07/2001

2 Classification of Safety-Related Notices This document contains notices which you should observe to ensure your own personal safety, as well as to protect the product and connected equipment. These notices are highlighted in the manual by a warning triangle and are marked as follows according to the level of danger:! Danger indicates that death or severe personal injury will result if proper precautions are not taken.! Warning indicates that death or severe personal injury can result if proper precautions are not taken.! Caution with warning triangle indicates that minor personal injury can result if proper precautions are not taken. Caution without warning triangle indicates that damage to property can result if proper precautions are not taken. Notice indicates that an undesirable result or status can occur if the relevant notice is ignored. Note highlights important information on the product, using the product, or part of the documentation that is of particular importance and that will be of benefit to the user. Copyright Siemens AG 2001, All rights reserved The reproduction, transmission or use of this document or its contents is not permitted without express written authority. Offenders will be liable for damages. All rights, including rights created by patent grant or registration of a utility or design, are reserved. Siemens AG Bereich Automatisierungs- und Antriebstechnik Postfach 48 48, D Nürnberg Siemens Aktiengesellschaft Disclaimer We have checked the contents of this manual for agreement with the hardware and software described. Since deviations cannot be precluded entirely, we cannot guarantee full agreement. However, the data in this manual are reviewed regularly and any necessary corrections included in subsequent editions. Suggestions for improvement are welcome. C79000-G8976-C Siemens AG 2001 Technical data subject to change. Printed in the Federal Republic of Germany

3 Trademarks SIMATIC, SIMATIC NET and SINEC are registered trademarks of Siemens AG. Third parties using for their own purposes any other names in this document which refer to trademarks might infringe upon the rights of the trademark owners. Safety Instructions Regarding your Product Before you use the product described here, read the safety instructions below thoroughly. Qualified Personnel Only qualified personnel should be allowed to install and work on this equipment. Qualified persons are defined as persons who are authorized to commission, to ground, and to tag circuits, equipment, and systems in accordance with established safety practices and standards. Correct Usage of Hardware Products Please note the following regarding the correct usage of hardware products: Caution This device and its components may only be used for the applications described in the catalog or the technical description, and only in connection with devices or components from other manufacturers which have been approved or recommended by Siemens. This product can only function correctly and safely if it is transported, stored, set up, and installed correctly, and operated and maintained as recommended. Before you use the supplied sample programs or programs you have written yourself, make certain that no injury to persons nor damage to equipment can result in your plant or process. EU Directive: Do not start up until you have established that the machine on which you intend to run this component complies with the directive 89/392/EEC. C79000-G8976-C

4 Correct Usage of Software Products Please note the following regarding the correct usage of software products: Caution This software may only be used for the applications described in the catalog or the technical description, and only in connection with devices or software products from other manufacturers which have been approved or recommended by Siemens. Before you use the supplied sample programs or programs you have written yourself, make certain that no injury to persons nor damage to equipment can result in your plant or process. Prior to Startup Before putting the product into operation, note the following warning: Caution Prior to startup you must observe the instructions in the relevant documentation. For ordering data of the documentation, please refer to catalogs or contact your local Siemens representative. 4 C79000-G8976-C165-01

5 Preface Purpose of the Manual This manual supplements the "Programming Interface DP-Base for CP 5613/CP 5614" manual. It supports you when creating DP master class 2 user programs for the DP programming interface of the CP 5613/CP It is assumed that you are familiar with writing user programs in the "C" programming language under Windows NT. Validity of the Manual This manual is valid for the following software versions: DP-5613 V6.0 (CD 07/2001) C79000-G8976-C

6 Preface 6 C79000-G8976-C165-01

7 Contents 1 of the Functions of the DP Master Class Where the DP Master Class 2 Fits Initializing and Shutting down Master Class 2 Operation List of Functions of the DP Master Class Overview Tables of the Functions of the DP Master Class DPMC2_get_slv_diag DPMC2_get_mst_diag DPMC2_get_slv_in DPMC2_get_slv_out DPMC2_get_slv_cfg DPMC2_set_slv_address DPMC2_upload_mst DPMC2_download_mst DPMC2_start_seq_mst DPMC2_end_seq_mst DPMC2_act_para_mst / DPMC2_act_para_brct_mst Receiving Confirmations from DP Master Class C79000-G8976-C

8 Contents 8 C79000-G8976-C165-01

9 of the Functions of the DP 1 Master Class 2 This chapter describes the functions of the DP master class 2 interface. It also explains how you integrate a DP master class 2 in a PROFIBUS network. C79000-G8976-C

10 1.1 Where the DP Master Class 2 Fits Different DP Master Types In PROFIBUS DP, there are two different master types known as DP master class 1 and DP master class 2. DP Master Class 1 A class 1 DP master exchanges data with the DP slaves. The communication includes central functions such as: Parameter assignment and configuration of the slaves during startup Cyclic transfer of data to the DP slaves (updating the process image) Processing diagnostic information and alarms of the DP slaves. DP Master Class 2 A class 2 DP master is used as an option for monitoring and online diagnostics of a PROFIBUS DP network. Additional management functions can also be performed (for example, assigning addresses). The essential DP master class 2 functions are as follows: Monitoring the current input and output data of DP slaves controlled by a remote DP master class 1 Reading out diagnostic data of the DP slaves and the DP master class 1 Reading out the actual configuration (modular structure) of the DP slaves Uploading and downloading data records to the DP master class 1 Setting the DP slave address over PROFIBUS if this is supported by the DP slave. 10 C79000-G8976-C165-01

11 Interaction of the Components The diagram below illustrates the principle of how a DP master class 2 is incorporated in a PROFIBUS network. The DP master class 1 is involved in cyclic communication with the DP slaves (updating the process image) while the DP master class 2 can send online diagnostic calls to the DP slaves and to the DP master class 1 over PROFIBUS. Polling cycle out in out in out in DP master class 1 Master diagnostics DP slave DP slave DP slave PROFIBUS DP master class 2 Slave diagnostics PC with CP 5613/CP 5614 C79000-G8976-C

12 1.2 Initializing and Shutting down Master Class 2 Operation Initialization The typical initialization of a CP 5613 or CP 5614 for master class 2 operation (productive operation) activates the CP. The following steps are necessary: Step Action Meaning 1 DP_start_cp CP is initialized. 2 DP_open Logon at the CP Productive Operation In productive operation, the master class 2 functions described in the following section can be used. Shutdown Sequence After productive operation, the CP must be shut down as described below: Step Action Meaning 1 DP_close Logoff at the CP 2 DP_reset_cp Stop the CP. 12 C79000-G8976-C165-01

13 1.3 List of Functions of the DP Master Class 2 Conventions in the Text In the descriptions in this chapter, the following conventions are used in the function declaration: Notation Meaning // in The value is provided by the user program as input for the function. // out The value is returned to the user program by the function. // inout The value must be initialized and is updated on completion of the function. // -- irrelevant. Uniform Call Structure of the Functions The functions have a uniform structure, as follows: Error class = DPMC2_... (job-defining parameter 1, job-defining parameter 2, DP_ERROR_T *error); Each function returns an error class as the return value. If an error occurs, the DP_ERROR_T structure contains detailed information depending on the error class (refer to "Error Handling" in the "DP Base Programming Interface" manual). All DP master class 2 functions are asynchronous functions. The functions only trigger execution and then terminate. The actual result of the function must then be fetched with the DP_get_result function. You will find a list of the error codes in the chapter on error codes in the "DP Base Programming Interface" manual. C79000-G8976-C

14 Header Files, Import Library Before you can use the DP master class 2 functions, you must include the header files dp_5613.h, 5613_ret.h and mc2_5613.h and the import library dp_base.lib in your program. 14 C79000-G8976-C165-01

15 1.3.1 Overview Tables of the Functions of the DP Master Class 2 Calls to DP Slaves The following calls can be sent to DP slaves for diagnostic and configuration purposes. DPMC2_get_slv_diag DPMC2_get_slv_in DPMC2_get_slv_out DPMC2_get_slv_cfg DPMC2_set_slv_ address Purpose Reading the diagnostic data of a DP slave. Reading the input data of a DP slave. Reading the output data of a DP slave. Reading the configuration (modular structure) of a DP slave. Assigning a new PROFIBUS address to a DP slave. Calls to remote DP master class 1 DPMC2_get_mst_diag DPMC2_upload_mst 1, 2 DPMC2_download_mst 1, 2 DPMC2_start_seq_mst 1 DPMC2_end_seq_mst 1 DPMC2_act_para_mst 1 DPMC2_act_para_brct_mst 1 Purpose Reading slave diagnostic data from the process image of the remote DP master and reading other additional information. Uploading data records of the remote DP master. Downloading data records to the remote DP master. Activating access protection on the remote DP master. Deactivating access protection on the remote DP master. Activating a data record on the remote DP master. 1) Please note that some class 1 DP masters do not support these services. These services are currently not supported by SIMATIC NET CPs (for example, CP 5511, CP 5611, CP 5613, CP 5614). 2) For a description of the data records of the remote DP master, refer to its documentation. C79000-G8976-C

16 1.3.2 DPMC2_get_slv_diag Purpose With this function, the CP 5613/CP 5614 in the role of DP master class 2 reads out the diagnostic data of a DP slave. The function requests the diagnostic data directly from the DP slave. Syntax DPR_DWORD DPMC2_get_slv_diag (DPR_DWORD *user_handle, // in DPMCL2_REQ_T *request, // in DP_ERROR_T *error ); // out 16 C79000-G8976-C165-01

17 Parameters user_handle Request User handle assigned with the DP_open call. Pointer to structure DPMCL2_REQ_T with the entries for the diagnostic job. typedef struct DPMCL2_REQ_S DPR_WORD order_id; // in DPR_DWORD c_ref; // in union DP_DS_READ_T dp_ds_read; DP_DS_WRITE_T dp_ds_write; DP_ALARM_ACK_T dp_alarm_ack; DP_ENABLE_EVT_T dp_enable_evt; DP_GET_CFG_T dp_get_cfg; DP_MCL2_DATA_T dp_mcl2_data; }req; } DPMCL2_REQ_T; where typedef struct DP_MCL2_DATA_S DPR_BYTE ident_diag; // -- DPR_BYTE new_slv_add; // -- DPR_BYTE no_add_chg; // -- DPR_WORD ident_number; // -- DPR_WORD poll_timeout; // -- DPR_WORD poll_delay; // -- DPR_BYTE length_s; // inout DPR_BYTE data_s[dpr_slave_data_size]; // out } DP_MCL2_DATA_T; Table continued on next page C79000-G8976-C

18 Table continued from previous page "Request" continued error The order_id is a job identifier assigned by the user program. The identifier is returned unchanged in the asynchronous acknowledgment and can be used to identify the job to which the acknowledgment belongs. The c_ref element specifies the DP slave. The value of c_ref can be obtained using the function DP_get_cref(user_id, slv_add). The length_s element specifies the size of the receive buffer. DPR_SLAVE_DATA_SIZE should be entered as the job-defining value. After receiving the DPMC2_get_slv_diag confirmation, length_s contains the actual number of data received from the DP slave. The received data are entered in data_s. Address of a structure of the type DP_ERROR_T provided by the user program - If an error occurs, the structure contains details of the cause of the error (refer to "Error Handling" in the "DP Base Programming Interface" manual). Return Value DP_OK_ASYNC DP_ERROR_EVENT_NET and error->error_code == DP_RET_REQ_ACTIV other Execution of the function was activated successfully. There is still a DPMC2_get_slv_diag request active. Calling DPMC2_get_slv_diag again, is only permitted when the result of the previous call has been fetched with DP_get_result. Unsuccessful completion of function 18 C79000-G8976-C165-01

19 1.3.3 DPMC2_get_mst_diag Purpose With this function, the CP 5613/CP 5614 as DP master class 2 reads the diagnostic and status data stored on another DP master class 1. The following information can be requested from the DP master class 1: Diagnostic data of a DP slave System diagnostic data Master status Data transfer list Syntax DPR_DWORD DPMC2_get_mst_diag (DPR_DWORD *user_handle, // in DPMCL2_REQ_T *request, // in DP_ERROR_T *error ); // out C79000-G8976-C

20 Parameters user_handle Request User handle assigned with the DP_open call. Pointer to structure DPMCL2_REQ_T with the entries for the diagnostic job. typedef struct DPMCL2_REQ_S DPR_WORD order_id; // in DPR_DWORD c_ref; // in union DP_DS_READ_T dp_ds_read; DP_DS_WRITE_T dp_ds_write; DP_ALARM_ACK_T dp_alarm_ack; DP_ENABLE_EVT_T dp_enable_evt; DP_GET_CFG_T dp_get_cfg; DP_MCL2_DATA_T dp_mcl2_data; }req; } DPMCL2_REQ_T; where typedef struct DP_MCL2_DATA_S DPR_BYTE ident_diag; // in DPR_BYTE new_slv_add; // -- DPR_BYTE no_add_chg; // -- DPR_WORD ident_number; // -- DPR_WORD poll_timeout; // in DPR_WORD poll_delay; // in DPR_BYTE length_s; // inout DPR_BYTE data_s[dpr_slave_data_size]; // out } DP_MCL2_DATA_T; Table continued on next page 20 C79000-G8976-C165-01

21 Table continued from previous page "Request" continued error The order_id is a job identifier assigned by the user program. The identifier is returned unchanged in the asynchronous acknowledgment and can be used to identify the job to which the acknowledgment belongs. The c_ref element specifies the master. The value of c_ref can be obtained using the function DP_get_cref(user_id, mst_add). The length_s element specifies the size of the receive buffer. DPR_SLAVE_DATA_SIZE should be entered as the job-defining value. After receiving the DPMC2_get_mst_diag confirmation, length_s contains the actual number of data received from the DP master. The received data are entered in data_s. The data are selected with the parameter ident_diag (see below). The timeouts can be set with the poll_timeout and poll_delay parameters (see below). Address of a structure provided by the user program of the type DP_ERROR_T. If an error occurs, the structure contains details on the cause of the error (refer to "Error Handling" in the "DP Base Programming Interface" manual). C79000-G8976-C

22 of the ident_diag, poll_timeout and poll_delay Elements ident_diag poll_timeout poll_delay The type of diagnostic data is specified with the ident_diag parameter. The following values can be set: diagnostic data of a DP slave 126 system diagnostic data of the DP master 127 master status 128 data transfer list Monitoring time for the job in ms. 0 default value (recommended) > 0 job-defining value Time between two successive poll jobs to the DP master class 1 in ms. 0 default value (recommended) > 0 job-defining value Return Value DP_OK_ASYNC DP_ERROR_EVENT_NET and error->error_code == DP_RET_REQ_ACTIV other Execution of the function was activated successfully. There is still a DPMC2_get_mst_diag request active. Calling DPMC2_get_mst_diag again, is only permitted when the result of the previous call has been fetched with DP_get_result. Unsuccessful completion of function 22 C79000-G8976-C165-01

23 Format of the System Diagnostic Data The system diagnostic data consists of 16 bytes. Each bit within these bytes indicates whether the assigned slave has sent diagnostic data. The data are structured as follows: Byte bit Value Slave 0 has no extended diagnostics Slave 0 has extended diagnostics Slave 1 has no extended diagnostics Slave 1 has extended diagnostics. etc. etc. etc. etc Slave 125 has no extended diagnostics Slave 125 has extended diagnostics Not used Not used. Format of the Master Status Data The master status consists of 16 bytes. These bytes contain the current operating state and a certain amount of version information. The data are structured as follows: Byte 1 Operating state of the class 1 master 40 H - Stop 80 H - Clear C0 H - Operate 2 and 3 Ident_Number 4 Version of the hardware (DDLM/user interface) 5 Version of the firmware (DDLM/user interface) 6 Version of the hardware 7 Version of the firmware 8 to 16 reserved C79000-G8976-C

24 Formats of the Data Transfer List The system diagnostic data consists of 16 bytes. Each bit within these bytes indicates whether the assigned slave is in the productive phase. The data are structured as follows: Byte bit Value Slave 0 is not in the data transfer phase Slave 0 is in the data transfer phase Slave 1 is not in the data transfer phase Slave 1 is in the data transfer phase etc. etc. etc. etc Slave 125 is not in the data transfer phase Slave 125 is in the data transfer phase 16 6 Not used Not used. Format of the Slave Diagnostic Data The structure of the slave diagnostic data is described in the section "Formats of the Slave Diagnostic Data" in the "DP Base Programming Interface" manual. 24 C79000-G8976-C165-01

25 1.3.4 DPMC2_get_slv_in Purpose With this function, the CP 5613/CP 5614 in the role of DP master class 2 reads out the input data of a DP slave. The function requests the input data directly from the DP slave. Input data are only available when the DP slave is in the polling cycle of the remote class 1 DP master. Syntax DPR_DWORD DPMC2_get_slv_in (DPR_DWORD *user_handle, // in DPMCL2_REQ_T *request, // in DP_ERROR_T *error ); // out C79000-G8976-C

26 Parameters user_handle Request User handle assigned with the DP_open call. Pointer to structure DPMCL2_REQ_T with the entries for the diagnostic job. typedef struct DPMCL2_REQ_S DPR_WORD order_id; // in DPR_DWORD c_ref; // in union DP_DS_READ_T dp_ds_read; DP_DS_WRITE_T dp_ds_write; DP_ALARM_ACK_T dp_alarm_ack; DP_ENABLE_EVT_T dp_enable_evt; DP_GET_CFG_T dp_get_cfg; DP_MCL2_DATA_T dp_mcl2_data; }req; } DPMCL2_REQ_T; where typedef struct DP_MCL2_DATA_S DPR_BYTE ident_diag; // -- DPR_BYTE new_slv_add; // -- DPR_BYTE no_add_chg; // -- DPR_WORD ident_number; // -- DPR_WORD poll_timeout; // -- DPR_WORD poll_delay; // -- DPR_BYTE length_s; // inout DPR_BYTE data_s[dpr_slave_data_size]; // out } DP_MCL2_DATA_T; Table continued on next page 26 C79000-G8976-C165-01

27 Table continued from previous page "Request" continued error The order_id is a job identifier assigned by the user program. The identifier is returned unchanged in the asynchronous acknowledgment and can be used to identify the job to which the acknowledgment belongs. The c_ref element specifies the DP slave. The value of c_ref can be obtained using the function DP_get_cref(user_id, slv_add). The length_s element specifies the size of the receive buffer. DPR_SLAVE_DATA_SIZE should be entered as the job-defining value. After receiving the DPMC2_get_slv_in confirmation, length_s contains the actual number of data received from the DP slave. The received data are entered in data_s. Address of a structure provided by the user program of the type DP_ERROR_T. If an error occurs, the structure contains details on the cause of the error (refer to "Error Handling" in the "DP Base Programming Interface" manual). Return Value DP_OK_ASYNC DP_ERROR_EVENT_NET and error->error_code == DP_RET_REQ_ACTIV other Execution of the function was activated successfully. There is still a DPMC2_get_slv_in request active. Calling DPMC2_get_slv_in again, is only permitted when the result of the previous call has been fetched with DP_get_result. Unsuccessful completion of function C79000-G8976-C

28 1.3.5 DPMC2_get_slv_out Purpose With this function, the CP 5613/CP 5614 in the role of DP master class 2 reads out the output data of a DP slave. The function requests the output data directly from the DP slave. Output data are only available when the DP slave is in the polling cycle of the remote class 1 DP master. Syntax DPR_DWORD DPMC2_get_slv_out (DPR_DWORD *user_handle, // in DPMCL2_REQ_T *request, // in DP_ERROR_T *error ); // out 28 C79000-G8976-C165-01

29 Parameters user_handle Request User handle assigned with the DP_open call. Pointer to structure DPMCL2_REQ_T with the entries for the diagnostic job. typedef struct DPMCL2_REQ_S DPR_WORD order_id; // in DPR_DWORD c_ref; // in union DP_DS_READ_T dp_ds_read; DP_DS_WRITE_T dp_ds_write; DP_ALARM_ACK_T dp_alarm_ack; DP_ENABLE_EVT_T dp_enable_evt; DP_GET_CFG_T dp_get_cfg; DP_MCL2_DATA_T dp_mcl2_data; }req; } DPMCL2_REQ_T; where typedef struct DP_MCL2_DATA_S DPR_BYTE ident_diag; // -- DPR_BYTE new_slv_add; // -- DPR_BYTE no_add_chg; // -- DPR_WORD ident_number; // -- DPR_WORD poll_timeout; // -- DPR_WORD poll_delay; // -- DPR_BYTE length_s; // inout DPR_BYTE data_s[dpr_slave_data_size]; // out } DP_MCL2_DATA_T; Table continued on next page C79000-G8976-C

30 Table continued from previous page "Request" continued error The order_id is a job identifier assigned by the user program. The identifier is returned unchanged in the asynchronous acknowledgment and can be used to identify the job to which the acknowledgment belongs. The c_ref element specifies the DP slave. The value of c_ref can be obtained using the function DP_get_cref(user_id, slv_add). The length_s element specifies the size of the receive buffer. DPR_SLAVE_DATA_SIZE should be entered as the job-defining value. After receiving the DPMC2_get_slv_out confirmation, length_s contains the actual number of data received from the slave. The received data are entered in data_s. Address of a structure provided by the user program of the type DP_ERROR_T. If an error occurs, the structure contains details on the cause of the error (refer to "Error Handling" in the "DP Base Programming Interface" manual). Return Value DP_OK_ASYNC DP_ERROR_EVENT_NET and error->error_code == DP_RET_REQ_ACTIV other Execution of the function was activated successfully. There is still a DPMC2_get_slv_out request active. Calling DPMC2_get_slv_out again, is only permitted when the result of the previous call has been fetched with DP_get_result. Unsuccessful completion of function 30 C79000-G8976-C165-01

31 1.3.6 DPMC2_get_slv_cfg Purpose With this function, the CP 5613/CP 5614 in the role of DP master class 2 reads out the configuration data of a DP slave. The function requests the configuration data directly from the DP slave. Syntax DPR_DWORD DPMC2_get_slv_cfg (DPR_DWORD *user_handle, // in DPMCL2_REQ_T *request, // in DP_ERROR_T *error ); // out C79000-G8976-C

32 Parameters user_handle Request User handle assigned with the DP_open call. Pointer to structure DPMCL2_REQ_T with the entries for the diagnostic job. typedef struct DPMCL2_REQ_S DPR_WORD order_id; // in DPR_DWORD c_ref; // in union DP_DS_READ_T dp_ds_read; DP_DS_WRITE_T dp_ds_write; DP_ALARM_ACK_T dp_alarm_ack; DP_ENABLE_EVT_T dp_enable_evt; DP_GET_CFG_T dp_get_cfg; DP_MCL2_DATA_T dp_mcl2_data; }req; } DPMCL2_REQ_T; where typedef struct DP_MCL2_DATA_S DPR_BYTE ident_diag; // -- DPR_BYTE new_slv_add; // -- DPR_BYTE no_add_chg; // -- DPR_WORD ident_number; // -- DPR_WORD poll_timeout; // -- DPR_WORD poll_delay; // -- DPR_BYTE length_s; // inout DPR_BYTE data_s[dpr_slave_data_size]; // out } DP_MCL2_DATA_T; Table continued on next page 32 C79000-G8976-C165-01

33 Table continued from previous page "Request" continued Error The order_id is a job identifier assigned by the user program. The identifier is returned unchanged in the asynchronous acknowledgment and can be used to identify the job to which the acknowledgment belongs. The c_ref element specifies the DP slave. The value of c_ref can be obtained using the function DP_get_cref(user_id, slv_add). The length_s element specifies the size of the receive buffer. DPR_SLAVE_DATA_SIZE should be entered as the job-defining value. After receiving the DPMC2_get_slv_cfg confirmation, length_s contains the actual number of data received from the DP slave. The received data are entered in data_s. Address of a structure provided by the user program of the type DP_ERROR_T. If an error occurs, the structure contains details on the cause of the error (refer to "Error Handling" in the "DP Base Programming Interface" manual). Return Value DP_OK_ASYNC DP_ERROR_EVENT_NET and error->error_code == DP_RET_REQ_ACTIV other Execution of the function was activated successfully. There is still a DPMC2_get_slv_cfg request active. Calling DPMC2_get_slv_cfg again, is only permitted when the result of the previous call has been fetched with DP_get_result. Unsuccessful completion of function C79000-G8976-C

34 1.3.7 DPMC2_set_slv_address Purpose With this function, the CP 5613/CP 5614 as DP master class 2, can change the PROFIBUS address of a DP slave if this is supported by the DP slave. The identification number is also transferred to the DP slave with the call. The identification number is a unique identifier for a slave type. This number can, for example, be obtained from the GSD file of the DP slave. Note 1 A slave address that already exists in the PROFIBUS network must not be assigned a second time. Note 2 Remote address assignment is not supported by all DP slaves. Syntax DPR_DWORD DPMC2_set_slv_address (DPR_DWORD *user_handle, // in DPMCL2_REQ_T *request, // in DP_ERROR_T *error ); // out 34 C79000-G8976-C165-01

35 Parameters user_handle Request User handle assigned with the DP_open call. Pointer to structure DPMCL2_REQ_T with the entries for the diagnostic job. typedef struct DPMCL2_REQ_S DPR_WORD order_id; // in DPR_DWORD c_ref; // in union DP_DS_READ_T dp_ds_read; DP_DS_WRITE_T dp_ds_write; DP_ALARM_ACK_T dp_alarm_ack; DP_ENABLE_EVT_T dp_enable_evt; DP_GET_CFG_T dp_get_cfg; DP_MCL2_DATA_T dp_mcl2_data; }req; } DPMCL2_REQ_T; where typedef struct DP_MCL2_DATA_S DPR_BYTE ident_diag; // -- DPR_BYTE new_slv_add; // in DPR_BYTE no_add_chg; // in DPR_WORD ident_number; // in DPR_WORD poll_timeout; // -- DPR_WORD poll_delay; // -- DPR_BYTE length_s; // in DPR_BYTE data_s[dpr_slave_data_size]; // in } DP_MCL2_DATA_T; Table continued on next page C79000-G8976-C

36 Table continued from previous page "Request" continued error The order_id is a job identifier assigned by the user program. The identifier is returned unchanged in the asynchronous acknowledgment and can be used to identify the job to which the acknowledgment belongs. The c_ref element specifies the DP slave whose station address will be changed. The value of c_ref can be obtained using the function DP_get_cref(user_id, old_slv_add). The new_slv_add element contains the new station address of the DP slave. The no_add_chg element specifies whether the station address of the DP slave can be changed again later. The values true (0xff) or false (0x00) are permitted. true: Changing the station address is only possible after the initial reset of the DP slave. Here, the DP slave has station address 126. false: The station address can also be changed later. The use of this parameter depends on the DP slave type. For more detailed information, refer to the DP slave documentation of the manufacturer. The ident_number element specifies the device type of the station. The value depends on the DP slave type. More detailed information can be obtained from the GSD file or from the DP slave documentation of the manufacturer. Additional vendor-specific data can also be entered here data_s. For more detailed information, refer to the DP slave documentation of the manufacturer. The length_s element specifies the number of valid data in data_s. Address of a structure provided by the user program of the type DP_ERROR_T. If an error occurs, the structure contains details on the cause of the error (refer to "Error Handling" in the "DP Base Programming Interface" manual). 36 C79000-G8976-C165-01

37 Return Value DP_OK_ASYNC DP_ERROR_EVENT_NET and error->error_code == DP_RET_REQ_ACTIV other Execution of the function was activated successfully. There is still a DPMC2_set_slv_address request active. Calling DPMC2_set_slv_address again, is only permitted when the result of the previous call has been fetched with DP_get_result. Unsuccessful completion of function C79000-G8976-C

38 1.3.8 DPMC2_upload_mst Purpose With this function, the CP 5613/CP 5614 as DP master class 2 can read out various data records of another DP master class 1 if this is supported by the addressed DP master. Syntax DPR_DWORD DPMC2_upload_mst (DPR_DWORD *user_handle, // in DPMCL2_REQ_T *request, // in DP_ERROR_T *error ); // out 38 C79000-G8976-C165-01

39 Parameters user_handle Request User handle assigned with the DP_open call. Pointer to structure DPMCL2_REQ_T with the entries for the diagnostic job. typedef struct DPMCL2_REQ_S DPR_WORD order_id; // in DPR_DWORD c_ref; // in union DP_DS_READ_T dp_ds_read; DP_DS_WRITE_T dp_ds_write; DP_ALARM_ACK_T dp_alarm_ack; DP_ENABLE_EVT_T dp_enable_evt; DP_GET_CFG_T dp_get_cfg; DP_MCL2_DATA_T dp_mcl2_data; }req; } DPMCL2_REQ_T; where typedef struct DP_MCL2_DATA_S DPR_BYTE ident_diag; // in DPR_BYTE new_slv_add; // -- DPR_BYTE no_add_chg; // -- DPR_WORD ident_number; // in DPR_WORD poll_timeout; // in DPR_WORD poll_delay; // in DPR_BYTE length_s; // inout DPR_BYTE data_s[dpr_slave_data_size]; // in } DP_MCL2_DATA_T; Table continued on next page C79000-G8976-C

40 Table continued from previous page "Request" continued Error The order_id is a job identifier assigned by the user program. The identifier is returned unchanged in the asynchronous acknowledgment and can be used to identify the job to which the acknowledgment belongs. The c_ref element specifies the master. The value of c_ref can be obtained using the function DP_get_cref(user_id, mst_add). The length_s element specifies the number of bytes to be read (1-240). The received data are entered in data_s. The ident_diag element contains the "area code" of the remote DP master class 1. Using the area code, the various data areas on the remote DP master class 1 can be addressed. For more detailed information, refer to the DP master class 1 documentation of the manufacturer. The ident_number element contains the offset of the remote data record. For more detailed information, refer to the DP master class 1 documentation of the manufacturer. poll_timeout and poll_delay elements: refer to DPMC2_get_mst_diag function. Address of a structure provided by the user program of the type DP_ERROR_T. If an error occurs, the structure contains details on the cause of the error (refer to "Error Handling" in the "DP Base Programming Interface" manual). 40 C79000-G8976-C165-01

41 Return Value DP_OK_ASYNC DP_ERROR_EVENT_NET and error->error_code == DP_RET_REQ_ACTIV Others Execution of the function was activated successfully. There is still a further DPMC2 data record request active (DPMC2_upload/download or DPMC2_act_para(_brct)_mst). Calling DPMC2_upload_mst again, is only permitted when the result of the previous call has been fetched with DP_get_result. Unsuccessful completion of function C79000-G8976-C

42 1.3.9 DPMC2_download_mst Purpose With this function, the CP 5613/CP 5614 as DP master class 2 can download various data records to another DP master class 1 if this is supported by the addressed DP master. Syntax DPR_DWORD DPMC2_download_mst (DPR_DWORD *user_handle, // in DPMCL2_REQ_T *request, // in DP_ERROR_T *error ); // out 42 C79000-G8976-C165-01

43 Parameters user_handle Request User handle assigned with the DP_open call. Pointer to structure DPMCL2_REQ_T with the entries for the diagnostic job. typedef struct DPMCL2_REQ_S DPR_WORD order_id; // in DPR_DWORD c_ref; // in union DP_DS_READ_T dp_ds_read; DP_DS_WRITE_T dp_ds_write; DP_ALARM_ACK_T dp_alarm_ack; DP_ENABLE_EVT_T dp_enable_evt; DP_GET_CFG_T dp_get_cfg; DP_MCL2_DATA_T dp_mcl2_data; }req; } DPMCL2_REQ_T; where typedef struct DP_MCL2_DATA_S DPR_BYTE ident_diag; // in DPR_BYTE new_slv_add; // -- DPR_BYTE no_add_chg; // -- DPR_WORD ident_number; // in DPR_WORD poll_timeout; // in DPR_WORD poll_delay; // in DPR_BYTE length_s; // inout DPR_BYTE data_s[dpr_slave_data_size]; // out } DP_MCL2_DATA_T; Table continued on next page C79000-G8976-C

44 Table continued from previous page "Request" continued error The order_id is a job identifier assigned by the user program. The identifier is returned unchanged in the asynchronous acknowledgment and can be used to identify the job to which the acknowledgment belongs. The c_ref element specifies the master. The value of c_ref can be obtained using the function DP_get_cref(user_id, mst_add). Data_s contains the data to be sent. The length_s element specifies the number of bytes to be sent (1 to 240). The ident_diag element contains the area code of the remote master. The various data areas on the remote DP master class 2 can be addressed using the area code. For more detailed information, refer to the DP master class 1 documentation of the manufacturer. The ident_number element contains the offset of the remote data record. For more detailed information, refer to the DP master class 1 documentation of the manufacturer. poll_timeout and poll_delay elements: refer to DPMC2_get_mst_diag function. Address of a structure provided by the user program of the type DP_ERROR_T. If an error occurs, the structure contains details on the cause of the error (refer to "Error Handling" in the "DP Base Programming Interface" manual). 44 C79000-G8976-C165-01

45 Return Value DP_OK_ASYNC DP_ERROR_EVENT_NET and error->error_code == DP_RET_REQ_ACTIV other Execution of the function was activated successfully. There is still a further DPMC2 data record request active (DPMC2_upload/download or DPMC2_act_para(_brct)_mst). Calling DPMC2_download_mst again, is only permitted when the result of the previous call has been fetched with DP_get_result. Unsuccessful completion of function C79000-G8976-C

46 DPMC2_start_seq_mst Purpose With this function, the CP 5613/CP 5614 as DP master class 2 can activate access protection on the addressed DP master class 1 prior to the upload/download. This ensures the consistency of the transferred data if several blocks of data are transferred one after the other. After the upload/download, this access protection must be canceled again by calling DPMC2_end_seq_mst. Syntax DPR_DWORD DPMC2_start_seq_mst (DPR_DWORD *user_handle, // in DPMCL2_REQ_T *request, // in DP_ERROR_T *error ); // out 46 C79000-G8976-C165-01

47 Parameters user_handle Request User handle assigned with the DP_open call. Pointer to structure DPMCL2_REQ_T with the entries for the diagnostic job. typedef struct DPMCL2_REQ_S DPR_WORD order_id; // in DPR_DWORD c_ref; // in union DP_DS_READ_T dp_ds_read; DP_DS_WRITE_T dp_ds_write; DP_ALARM_ACK_T dp_alarm_ack; DP_ENABLE_EVT_T dp_enable_evt; DP_GET_CFG_T dp_get_cfg; DP_MCL2_DATA_T dp_mcl2_data; }req; } DPMCL2_REQ_T; where typedef struct DP_MCL2_DATA_S DPR_BYTE ident_diag; // in DPR_BYTE new_slv_add; // -- DPR_BYTE no_add_chg; // -- DPR_WORD ident_number; // in DPR_WORD poll_timeout; // in DPR_WORD poll_delay; // in DPR_BYTE length_s; // -- DPR_BYTE data_s[dpr_slave_data_size]; // -- } DP_MCL2_DATA_T; Table continued on next page C79000-G8976-C

48 Table continued from previous page "Request" continued Error The order_id is a job identifier assigned by the user program. The identifier is returned unchanged in the asynchronous acknowledgment and can be used to identify the job to which the acknowledgment belongs. The c_ref element specifies the master. The value of c_ref can be obtained using the function DP_get_cref(user_id, mst_add). The ident_diag element contains the area code of the remote master. The various data areas on the remote DP master class 2 can be addressed using the area code. For more detailed information, refer to the DP master class 1 documentation of the manufacturer. The ident_number element specifies the monitoring time in ms between two successive upload/download functions. If this time elapses, access protection is deactivated. The previously transferred data are invalid. For more detailed information, refer to the DP master class 1 documentation of the manufacturer. Address of a structure provided by the user program of the type DP_ERROR_T. If an error occurs, the structure contains details on the cause of the error (refer to "Error Handling" in the "DP Base Programming Interface" manual). Return Value DP_OK_ASYNC DP_ERROR_EVENT_NET and error->error_code == DP_RET_REQ_ACTIV other Execution of the function was activated successfully. There is still a further DPMC2 data record request active (DPMC2_upload/download or DPMC2_act_para(_brct)_mst). Calling DPMC2_start_seq_mst again, is only permitted when the result of the previous call has been fetched with DP_get_result. Unsuccessful completion of function 48 C79000-G8976-C165-01

49 DPMC2_end_seq_mst Purpose With this function, the CP 5613/CP 5614 as DP master class 2 can cancel access protection on the addressed DP master class 1 after the upload/download. Syntax DPR_DWORD DPMC2_end_seq_mst (DPR_DWORD *user_handle, // in DPMCL2_REQ_T *request, // in DP_ERROR_T *error ); // out C79000-G8976-C

50 Parameters user_handle Request User handle assigned with the DP_open call. Pointer to structure DPMCL2_REQ_T with the entries for the diagnostic job. typedef struct DPMCL2_REQ_S DPR_WORD order_id; // in DPR_DWORD c_ref; // in union DP_DS_READ_T dp_ds_read; DP_DS_WRITE_T dp_ds_write; DP_ALARM_ACK_T dp_alarm_ack; DP_ENABLE_EVT_T dp_enable_evt; DP_GET_CFG_T dp_get_cfg; DP_MCL2_DATA_T dp_mcl2_data; }req; } DPMCL2_REQ_T; where typedef struct DP_MCL2_DATA_S DPR_BYTE ident_diag; // -- DPR_BYTE new_slv_add; // -- DPR_BYTE no_add_chg; // -- DPR_WORD ident_number; // -- DPR_WORD poll_timeout; // in DPR_WORD poll_delay; // in DPR_BYTE length_s; // -- DPR_BYTE data_s[dpr_slave_data_size]; // -- } DP_MCL2_DATA_T; Table continued on next page 50 C79000-G8976-C165-01

51 Table continued from previous page "Request" continued Error The order_id is a job identifier assigned by the user program. The identifier is returned unchanged in the asynchronous acknowledgment and can be used to identify the job to which the acknowledgment belongs. The c_ref element specifies the DP master. The value of c_ref can be obtained using the function DP_get_cref(user_id, mst_add). Address of a structure provided by the user program of the type DP_ERROR_T. If an error occurs, the structure contains details on the cause of the error (refer to "Error Handling" in the "DP Base Programming Interface" manual). Return Value DP_OK_ASYNC DP_ERROR_EVENT_NET and error->error_code == DP_RET_REQ_ACTIV other Execution of the function was activated successfully. There is still a further DPMC2 data record request active (DPMC2_upload/download or DPMC2_act_para(_brct)_mst). Calling DPMC2_end_seq_mst again, is only permitted when the result of the previous call has been fetched with DP_get_result. Unsuccessful completion of function C79000-G8976-C

52 DPMC2_act_para_mst / DPMC2_act_para_brct_mst Purpose With these functions, the CP 5613/CP 5614 as DP master class 2 can enable a data record previously downloaded with DPMC2_download_mst on another master class 1. The DPMC2_act_para_mst call addresses the master directly, while DPMC2_act_para_brct_mst sends a broadcast call (with which several masters can be addressed at the same time). Note Note that with the DPMC_act_para_brct_mst call, no acknowledgment frame is sent. Syntax DPR_DWORD DPMC2_act_para_mst/DPMC2_act_para_brct_mst (DPR_DWORD *user_handle, // in DPMCL2_REQ_T *request, // in DP_ERROR_T *error ); // out 52 C79000-G8976-C165-01

53 Parameters user_handle Request User handle assigned with the DP_open call. Pointer to structure DPMCL2_REQ_T with the entries for the diagnostic job. Typedef struct DPMCL2_REQ_S DPR_WORD order_id; // in DPR_DWORD c_ref; // in union DP_DS_READ_T dp_ds_read; DP_DS_WRITE_T dp_ds_write; DP_ALARM_ACK_T dp_alarm_ack; DP_ENABLE_EVT_T dp_enable_evt; DP_GET_CFG_T dp_get_cfg; DP_MCL2_DATA_T dp_mcl2_data; }req; } DPMCL2_REQ_T; where typedef struct DP_MCL2_DATA_S DPR_BYTE ident_diag; // in DPR_BYTE new_slv_add; // -- DPR_BYTE no_add_chg; // -- DPR_WORD ident_number; // -- DPR_WORD poll_timeout; // in DPR_WORD poll_delay; // in DPR_BYTE length_s; // -- DPR_BYTE data_s[dpr_slave_data_size]; // -- } DP_MCL2_DATA_T; Table continued on next page C79000-G8976-C

54 Table continued from previous page "Request" continued error The order_id is a job identifier assigned by the user program. The identifier is returned unchanged in the asynchronous acknowledgment and can be used to identify the job to which the acknowledgment belongs. The c_ref element specifies the DP master. The value of c_ref can be obtained using the function DP_get_cref(user_id, mst_add). With the broadcast call, the value 127 must be used for mst_add if you want to address several DP masters at the same time. The ident_diag element contains the area code of the remote master. The various data areas on the remote DP master class 2 can be addressed using the area code. For more detailed information, refer to the DP master class 1 documentation of the manufacturer. Address of a structure provided by the user program of the type DP_ERROR_T. If an error occurs, the structure contains details on the cause of the error (refer to "Error Handling" in the "DP Base Programming Interface" manual). Return Value DP_OK_ASYNC DP_ERROR_EVENT_NET and error->error_code == DP_RET_REQ_ACTIV other Execution of the function was activated successfully. There is still a further DPMC2 data record request active (DPMC2_upload/download or DPMC2_act_para(_brct)_mst). Calling DPMC2_act_para_mst/DPMC2_act_para _brct_mst again, is only permitted when the result of the previous call has been fetched with DP_get_result. Unsuccessful completion of function 54 C79000-G8976-C165-01

55 Receiving Confirmations from DP Master Class 2 Purpose If a DP master class 2 request was acknowledged with DP_OK_ASYNC, the corresponding confirmation must be fetched with the DP_get_result call. The extra IDs are described below. The result return parameter points to a structure of the type DPMCL2_REQ_T. When a confirmation is received, the confirmation parameters are entered in the relevant substructures of this structure (according to the req_type entry). The job type is entered in the req_type return parameter of the DP_get_result call after receiving a confirmation. In addition to the return values described in the section "DP_get_result" in the "DP Base Programming Interface" manual, the following DP master class 2 job types are possible with the DP_get_result call. Additional IDs in the req_type parameter req_type Address of a variable for the job type - After receiving an acknowledgment (see DP_get_result function) the job type is entered here. With DP master class 2 acknowledgments, the following additional IDs are possible: ID Acknowledgment for... DP_MCL2_SLV_OUT DPMC2_get_slv_out DP_MCL2_SLV_DIAG DPMC2_get_slv_diag DP_MCL2_SLV_ADDR DPMC2_set_slv_address DP_MCL2_MST_DIAG DPMC2_get_mst_diag DP_MCL2_SLV_IN DPMC2_get_slv_in DP_MCL2_SLV_CFG DPMC2_get_slv_cfg DP_MCL2_UPLOAD_MST DPMC2_upload_mst DP_MCL2_DOWNLOAD_MST DPMC2_download_mst DP_MCL2_START_SEQ_MST DPMC2_start_seq_mst DP_MCL2_END_SEQ_MST DPMC2_end_seq_mst DP_MCL2_ACT_PARA_BRCT_MST DPMC2_act_para_brct_mst DP_MCL2_ACT_PARA_MST DPMC2_act_para_mst C79000-G8976-C

56 Return of Layer 2 Status Values If the DP_get_result function returns the value DP_ERROR_EVENT_NET for a DP master class 2 the confirmation, the return parameter contains error->error_decode the layer 2 error status. The following values are possible: DPMC2_FDL_ STATUS_NA DPMC2_FDL_ STATUS_WD DPMC2_FDL_ STATUS_RS DPMC2_FDL_ STATUS_RR DPMC2_FDL_ STATUS_UE Negative acknowledgment, no response received from the remote station. Negative acknowledgment, watchdog elapsed. Negative acknowledgment, resource problem on the remote LSAP or remote LSAP not activated. Negative acknowledgment, resources of the remote station not available. Negative acknowledgment, interface problem on the remote station. 56 C79000-G8976-C165-01