Contents ENGLISH. SDKC Operating Modes Manual p. 3 FRANÇAIS. Manuel modes opératoires SDKC p.121

Transcription

1 Section Contents SDKC Operating Modes Manual p. 3 Page ENGLISH Manuel modes opératoires SDKC p.121 1

2 ENGLISH Section Contents Page 2

3 Contents Section Page 1 Introduction 9 ENGLISH 1.1 Introduction Installation Target machine PL7 SDKC product contents Installation procedure 11 2 Methodology for creating and using an EF in PL Creation The EF family The EF class The EF Automatic version management Generating the family in debug mode Installing/Uninstalling in the PL7 library for debugging Creating an application using the new EFs Testing each EF in PL Generating the family in release mode 18 3 Managing the EF using PL7 SDKC Creation The EF family The EF class The EF 23 3

4 Contents ENGLISH Section Page 3.2 Generating the family in debug mode Generating the family in release mode Installing/Uninstalling in the PL7 library 30 4 Testing the EF using the debugging tool Accessing EF debugging Selecting the family of the EF to be tested Opening the EF debug screen Presentation of the tool Debugging EFs Inserting and removing breakpoints Mixing C code and assembly language Registers Local variables 36 5 Additional SDKC functions Setting the tool parameters Modifying a family Importing/Exporting Class C Source Archiving/Restoring a family Archiving Restoring Restoring from Printing 46 4

5 Contents Section Page 6 The EF code 49 ENGLISH 6.1 Rules for implementing EFs C Language Managing family and EF versions Managing the size of the stack Using floating point numbers List of reserved words 56 7 System functions 59 value = rd_sysbit ( sysbit_range, status ) 62 status = wr_sysbit ( sysbit_range, value ) 63 value = rd_sysword ( sysword_range, status ) 64 status = wr_sysword ( sysword_range, value ) 65 value = rd_bit_attrib ( address ) 66 value = rd_bits ( address, number, status ) 68 status = wr_bits ( address, number, value, type ) 69 value = rd_16bits ( address ) 71 wr_16bits ( address, value ) 72 value = rd_1bit ( address ) 73 wr_1bit ( address, value ) 74 result = phy_ptr_init ( sel_off ) 75 5

6 Contents ENGLISH Section Page status = date_and_time ( date_ptr ) 76 value = cnt_100ms ( void ) 78 value = cnt_10ms ( void ) 79 info = proc_type ( void ) 80 info = proc_indic ( void ) 81 Res = ADD ( a, b ) 82 Res = SUB ( a, b ) 83 Res = MUL ( a, b ) 84 Res = DIV ( a, b ) 85 Res = EQU ( a, b ) 86 Res = SUP ( a, b ) 87 Res = INF ( a, b ) 88 Res = ABS ( a ) 89 Res = CHS ( a ) 90 Res = SQRT ( a ) 91 Res = FTOL ( a ) 92 Res = LTOF ( a ) 93 Res = EXP ( a ) 94 6

7 Contents Section Page Res = LN ( a ) 95 ENGLISH Res = SIN ( a ) 96 Res = COS ( a ) 97 Res = TAN ( a ) 98 Res = ASIN ( a ) 99 Res = ACOS ( a ) 100 Res = ATAN ( a ) Utilitary functions 103 value = GET_FLOATPL7 ( fvalpl7 ) 104 fvalpl7 = FLOAT_TOPL7 ( f ) 105 value = FLOAT_TO_DBG ( f ) 106 FLOAT_SETVALUE ( selector, offset, value ) 107 WORD_SETVALUE ( selector, offset, value ) 108 DWORD_SETVALUE ( selector, offset, value ) 109 ptr = GET_ADDR ( selector, offset ) Appendix Example Defining the EF Generating a diskette and installing the family 116 7

8 Contents ENGLISH Section Page 9.2 Keyboard equivalents In the event of a problem 117 8

9 1.1 Introduction Section 1 Introduction 1 Introduction An EF (Elementary Function) is a function, designed to fulfil a certain task in the user program. As it will in due course form part of the PL7 library, like the manufacturer functions, it can be used in an identical way : accessible in all languages display via the PL7 library tool classified in families/functions ENGLISH The development kit in "C" language (PL7 option) is designed to implement the entire development cycle of an EF family : management of an EF family (creation, modification) development of each EF in C language individual debugging of an EF in the target PLC (TSX 37 or TSX 57) generation of an installable form containing the new EF family to be installed in the PL7 library, as well as its installation procedure on a user station. The ability to execute an EF on a given PLC depends on the version of the target PLC chosen when this EF was generated (see section 2.1-3). EFs created and intended for version 3.0 or later PLCs (with or without coprocessor), can contain floating point calculations. Users of this product will be systems developers and therefore will necessarily be familiar with : C language for development, PL7 (Micro, Junior, Pro) and their languages for debugging. Using the access key (*) supplied with the kit, it is possible to manage 5 families (up to 25,500 functions per family) using a code which varies according to the family. These codes are allocated by the manufacturer and are unique, which means that the family numbers are exclusive. 9

10 Introduction ENGLISH This manual comprises the following sections : Section 1 "Introduction" Section 2 "Methodology for creating and using an EF in PL7" Section 3 "Managing the EF using PL7SDKC" Section 4 "Testing the EF using the debugging tool" Section 5 "Additional SDKC functions" Section 6 "EF code" Section 7 "System functions" Section 8 "Utilitary functions" Section 9 "Appendix" 1.2 Installation Target machine The SDK C operates on : IBM PC or compatible microcomputer The minimum configuration is as follows : microprocessor 486 DX Mb of RAM 20 Mb available on disk VGA monitor COM serial port available (COM1 to COM4) for connecting to the PLC Win95, NT operating system PL7 Micro, Junior or Pro V3.0 minimum The typical machine configuration is as follows : microprocessor Pentium at 33 Mhz 48 Mb of RAM 10

11 Introduction PL7 SDKC product contents The product which you have just received comprises : installation diskettes (see the procedure on the following page) this manual a Visual C software pack (supplied for reasons to do with MICROSOFT licensing). This software must not be installed on the development station. It contains the tools for generating and editing links used to compile the EF. These tools are already incorporated on the installation diskettes of the PL7 SDKC product. ENGLISH Installation procedure The PL7 SDKC product should be installed on a development station, on which PL7 Micro, PL7 Junior or PL7 Pro has already been installed. Once the diskette has been inserted into the drive, proceed with installation by means of the following steps : Open the Windows explorer, select drive (A) then double-click on setup.exe or in Run from the Start Menu, type a:\setup then click on OK. Register your name and organization Select the installation language Enter the no. (your product's access key) marked on the delivery box (*). This key is used to access the five family codes assigned to the product. Installation cannot proceed if the number of this access key is incorrectly entered. (*) We strongly recommend making a note of the number of the access key on the space provided on the following page. Once installation is complete, simply double-click on the icon in the MODICON- TELEMECANIQUE directory to access PL7 SDKC. Warning : Following an updating or to a new installation of PL7 Micro, PL7 Junior or PL7 Pro, it is obligatory to proceed to a new installation of PL7 SDKC. 11

12 Introduction ENGLISH Space reserved for recording your products' access key numbers

13 Section 2 Methodology for creating and using an EF in PL7 2 Methodology for creating and using an EF in PL7 The diagram below outlines the development cycle. Development station Generate family in Debug mode error no error Develop the family error Pl7 Micro/Junior/Pro Install the family on the development station no error PL7 SDKC Generate family in release mode ENGLISH Debug an EF EF family + Setup.exe User station Pl7 Micro/Junior/Pro EF library The object of the following sections is to present the various screens which appear during this development cycle. 13

14 Methodology for creating and using an EF in PL7 Clicking on the PL7 SDKC icon displays the following initial screen : ENGLISH The left-hand side of this screen, which is empty the first time the kit is used, will be filled with names of EF families, as they are created (Current and/or Archived). A family consists of one or more classes, which themselves consist of one or more EFs as shown by the diagram below : Family name Class1 Class2 EF1 EF2 EF1 EF2 EF3 A family is made up of 100 Classes maximum and 255 EFs per class. The class is an entity which is only used while developing the family and which will not be displayed in the PL7 Library tool. The version, filled in when the description of the family is defined, is as displayed in the PL7 Library tool. 14

15 Methodology for creating and using an EF in PL7 2.1 Creation The EF family It is possible to create a family by selecting the Create function from the Family menu. Five families can be created. They correspond to five codes supplied by the product. - The Description tab contains the family characteristics. ENGLISH - The Datasheet tab is used to record additional information about the family The EF class Once the family has been validated, by selecting the Create Class function from the Utilities menu, it is possible to create one of the classes authorized by the family (1 to 100). - The Description tab contains the class characteristics. - The Class.h tab is used to define constants, types or structures common to all the EF in the class. 15

16 Methodology for creating and using an EF in PL The EF ENGLISH At the end of creation, the name of the class appears on the left-hand side of the screen, and an EF can then be created by selecting the function Create EF from the Utilities menu. 255 EFs can be created per class (1 to 255). The Description tab contains the EF characteristics. The ability to execute an EF on a given PLC depends on the version of the target PLC chosen in this tab (see the following table). Selection made at generation Target V < 3.0 V 3.0 or later V 3.0 or later (no coprocessor) (with coprocessor) PLC prior to V 3.0 Yes No No V 3.0 or later PLC Yes (if not used (no coprocessor) into a DFB) Yes No V 3.0 or later PLC Yes (if not used (with coprocessor) into a DFB) Yes Yes (Optimized) EFs created and intended for version 3.0 or later PLCs (with or without coprocessor), can contain floating point calculations. The Interface tab can be used to enter the EF call parameters. The Source.C tab is used to write the EF C code. The Source.H tab is used to define constants, types or structures specific to the EF. 16

17 Methodology for creating and using an EF in PL7 2.2 Automatic version management When the Generation Options... function is selected in the Utilities menu, the following dialog box is displayed, allowing the user to select the incrementation method for family and class versions. ENGLISH The default option (recommended) is automatic incrementation. 2.3 Generating the family in debug mode Generation is performed on the whole family. Once the family has been developed, it is advisable, at first, to generate it by selecting the Generate Debug function from the Family menu. This then makes it possible to test one of the EF of the family. Generate means compile and then edit the links with the debug options of each EF of this family. Once generation is complete, a log file summarizing the errors and warnings (resul.log) is created (see section 3.1-3), and the user should return to the.c or.h source screens of any EF(s) which may be causing a problem. 2.4 Installing/Uninstalling in the PL7 library for debugging Once the family has been generated without any errors (compilation or link editing), it is possible to launch the Install function from the Family menu so that it can be entered in the PL7 library. 17

18 Methodology for creating and using an EF in PL7 The family which is being edited can be removed from the PL7 library. To do this, launch the Uninstall function from the Family menu. ENGLISH This installation/uninstallation is only possible if PL7 (Micro, Junior or Pro) is not running (active elements in memory). 2.5 Creating an application using the new EFs Once the family has been installed, PL7 (Micro, Junior or Pro) should be launched. The user should test the new EF(s), by developing an application which calls them, and then transferring this application to the PLC. Since this application is designed to test behavior, it is advisable to include only one copy of each EF to be tested. 2.6 Testing each EF in PL7 To test the EF in the application, select Debug EF from the Tools menu of PL7 (Micro, Junior or Pro). It is then possible to insert breakpoints, proceed step by step, display local variables or registers, etc. If the tests are not conclusive, the user should return to the EF development environment to review the process and restart the cycle described above. 2.7 Generating the family in release mode Once all the tests on all the EF in the family have proved conclusive, it is then possible to generate this family, for use, by selecting the Generate Release function from the Family menu. This action makes it possible to create an installation medium for the selected family (diskette, local or networked hard disk directory, etc). This medium can then be broadcast. 18

19 3.1 Creation Section 3 Managing the EF using PL7 SDKC 3 Managing the EF using PL7 SDKC The EF family Create opens the Family area defined by the "Description" tab for data entry Entry of the family name (24 characters) Used to manage updating of the family by entering a VV.RR (*) type number ENGLISH A family number will be assigned automatically (any of the 5 possible) In family display mode, this will display the created and/or archived families in the list (see section 5.4) Integer beginning at 1. This is used to manage updates which would make the texts (family datasheet and comments) incompatible (*) The value of VV (version) or RR (release) must be between 0 and 99 inclusive. 19

20 Managing the EF using PL7 SDKC Clicking on the "Datasheet" tab opens the following area : ENGLISH The family is validated by this button, but only if all the fields in the "Description" tab have been filled in correctly This area where text can be entered (optional), is used to note down the main data concerning the family. This datasheet can, for example, be used to enter log data on the versions of the family. This datasheet only appears in PL7 if there is a conflict in versions between a family in the library and the same family in the application. It is possible to delete a family using the Delete command from the Utilities menu. When a family is deleted, its contents (class(es) and EF(s)) are also deleted. 20

21 Managing the EF using PL7 SDKC The EF class Create Class opens the Class fields for data entry and enters information in the area defined by the "Description" tab Reminder of the parameters defined for the family (read-only) ENGLISH Used to enter the name of the class being created (16 alphanumerical characters + the underscore character) Number between 1 and 100 inclusive used to ensure the uniqueness of the class developed. It is filled in automatically Used to manage updates to the class by entering a VV.RR (*) format number (*) The value of VV (version) or RR (release) must be between 0 and 99 inclusive. Classes which belong to the same family must, without fail, have different names and codes. It is only possible to exit from the description tab once all the fields have been filled in. This action confirms the parameters entered. It is possible to delete a class using the Delete command from the Utilities menu. When a class is deleted, the EF(s) which it comprises are also deleted. 21

22 Managing the EF using PL7 SDKC ENGLISH The "Import class" and "Export class" functions in the Utilities menu are used to import a class from another family and export a class to another family (see section 5.3). Clicking on the "Class.h" tab opens the following area : Toggle button (Normal size/full screen) reduces/enlarges the entry window This area is used to enter the (.h) interface file source code common to all the EFs in the class. This file is used to create for example special types or constants which will be reused in the C sources of all the EFs in the class. This file should be to 200 Kbytes. 22

23 Managing the EF using PL7 SDKC The EF Create EF opens the EF fields for data entry and enters information in the area defined by the "Description" tab Number between 1 and 100 inclusive used to ensure the uniqueness of the EF developed. It is filled in automatically Reminder of the parameters defined for the family and the class (read-only) ENGLISH The EF type is a procedure or a function The size of the EF generated Used to enter the name of the EF being created (16 alphanumerical characters + the underscore character) Used to enter a text commentary on the EF containing a maximum of 80 characters Used to define the size of the stack. Its default value is 512 bytes and it is used to store the EF parameters, local variables, and the parameters and variables of the functions which it calls (see section 6.1-3) Used to select the version of the target PLC for which this EF is developed EFs developed and installed in library mode must, without fail, have different names. Be careful not to use PL7 key words as names (see section 6.2). It is only possible to exit from the description tab once all the fields have been filled in. This action confirms the parameters entered. It is possible to delete an EF using the Delete command from the Utilities menu. 23

24 Managing the EF using PL7 SDKC ENGLISH Clicking on the "Interface" tab opens the following area, comprising three zones which are used to enter the EF formal parameters. These formal parameters are those for inputs, outputs, and I/O. These function call parameters are divided into three fields : the name, which contains a maximum of four characters (no spaces), the parameter type : Inputs, Outputs and I/O. One of the following must be selected : BOOL, EBOOL, WORD, DWORD, STRING, REAL, AR_D, AR_R, AR_W and AR_X (to check the meaning of all of these types, see section 6.1 and the PL7 manual). the comment, which contains a maximum of 80 characters. Example : Reminder of the name of the class and EF concerned Buttons used to change the order of the parameters in the selected grid At the formal parameters level, there is a maximum of 7 inputs, 7 outputs and 17 I/O. It is possible to delete one or more parameter lines by selecting the line and clicking on the corresponding number. Type Ctrl+x on the keyboard (Ctrl+v repastes what has been cut). For the correspondence between PL7 types defined in this tab and C types present in the function header, see the table in section

25 Managing the EF using PL7 SDKC Clicking on the ".C Source" tab opens the following area : Toggle button (Normal size/ Full screen) reduces/enlarges the entry window These buttons are used to import or export a C file ENGLISH This tab accesses C code editing. The user can use his own editor if he wishes or if the C file is greater than 200 K, using export and import. As with other standard tools on the market, comments containing special key words are generated. When PL7 SDKC creates the function header for the first time, the key words PL7SDK_BEGIN_FUNCTION_NAME and PL7SDK_END_FUNCTION_NAME are inserted automatically. On exiting this tab, or when modifying the interface in the previous tab, PL7 SDKC automatically generates this header, which ensures consistency between the declared interface and the interface in the code. Using the Edit menu, the current functions are offered by EditText (cut, copy, paste, find, replace). Other functions are available, such as : Selecting by double-clicking Displaying the line number corresponding to the present position of the cursor, in the Status Bar. 25

26 Managing the EF using PL7 SDKC ENGLISH To inform the user of errors resulting from the C source compilation, the source code line containing the error is indicated. A file giving the results of the compilation is generated. It can be accessed by the View generation results command in the Family menu and provides information on any errors. Definition of the EF interface automatically generates the prototype of the latter in the FILE MAINxxyy.C where xx is the class code and yy the EF code. The user can export the source if he wishes, work on it, and then re-import it. There is no subsequent check on any manual modifications made to the EF main function interface. If the user modifies the interface, these modifications will be ignored. The interface is automatically regenerated from the interface tab. If the file is too large to be displayed this will be indicated. However, the function prototype will still be generated automatically. the user works with the editor supplied, and reaches the limit of 200 K for the current EF. At that moment the following message is displayed : «Your file is too large to be edited using PL7SDKC. Please export it, then re-import it». the user prefers to work with his "favorite" editor. This is possible; work is made easier by exporting one file at a time. Use the following procedure : create your EF, create your interface then enter the code tab, export the C file, work in your editor then save, without changing the name, import into PL7 SDKC. 26

27 Managing the EF using PL7 SDKC Clicking on the ".H Source" tab opens the following area : Toggle button (Normal size/full screen) reduces/ enlarges the e n t r y window ENGLISH This area is used to define constants, types or structures specific to the EF. This file must be to 200 Kbytes. 27

28 Managing the EF using PL7 SDKC 3.2 Generating the family in debug mode ENGLISH Once the creation phase is complete, it is possible to proceed to generation of the family in debug mode. To do this, select Generate Debug from the Family menu as shown in the screen below. The role of this generation is to activate the various software tools used to obtain a new family (all classes) and to check data consistency along the whole generation string. If there is a problem, a screen indicating the nature of the error(s) to be corrected opens, so that generation can be relaunched. It is possible to monitor the generation process from the information line at the bottom of the screen. Once generation is complete, the message "x error(s), y warning(s)" is displayed and an audio beep emitted. A "Generated in Debug mode" status followed by a generation date is written in the family description zone, and this family can then be installed in the library. Information about the generation can be accessed by opening the results file (View generation results from the Family menu). The installation of this family thus generated, is not possible that since the product PL7SDKC. 28

29 Managing the EF using PL7 SDKC 3.3 Generating the family in release mode The last phase is to proceed to generation of the family in release mode (code size minimized). To do this, select Generate Release from the Family menu as shown in the screen below. ENGLISH The role of this generation is to activate the various software tools used to obtain a new family (all classes) and to create the corresponding files. It is possible to monitor the generation process from the information line at the bottom of the screen. Once generation is complete, the message "x error(s), y warning(s)" is displayed and an audio beep emitted. A "Generated in Release mode" status followed by a generation date is written in the family description zone. Information about the generation can be accessed by opening the results file (View generation results from the Family menu). Once generation is complete, the necessary elements (files) are automatically copied into the medium selected for broadcasting (diskette, network disk, etc). This space is part of the parameters defined in the tool customization menu (see section 5.1). 29

30 Managing the EF using PL7 SDKC 3.4 Installing/Uninstalling in the PL7 library ENGLISH It is possible to install a family generated in debug or release mode on the development station, but only families generated in debug mode can be debugged in PL7. To perform this installation, select Install from the Family menu. If the code of the family to be installed already exists in the library, a dialog box opens If the family is new and intended to replace an old one, click on "Overwrite". If an error is made, or the user is unsure, it is possible to cancel installation in the library by selecting Quit. When installation is complete, the message "The family has been installed in the library" appears and installation is effective. It is possible to uninstall a family from the PL7 library. It is necessary to select the Uninstall command from the Family menu when a family is being edited. 30

31 4.1 Accessing EF debugging Section 4 Testing the EF using the debugging tool 4 Testing the EF using the debugging tool Selecting the family of the EF to be tested As described in the previous section, the EFs of families generated in debug mode can be debugged, one at a time, in PL7 Micro, Junior or Pro. Once PL7 is launched and the program containing the EF to be tested loaded into the PLC, the Debug EF command in the Tools menu opens the following screen which is used to select the development directory (dvt_ef, by default), then the family containing the EF. ENGLISH The name of the family (generated in debug mode) and its code number appear Used to search for the drive and the development directory Summary of information about the family Once the family containing the EF to be tested has been found, clicking on OK opens the EF debug environment, described in the next paragraph. The EF should only be called once in the application, so that debugging can be performed Opening the EF debug screen This screen is made up of two parts : A command part with seven buttons, A part containing information about the test 31

32 Testing the EF using the debugging tool ENGLISH Opening the screen adds a "Debug EF" menu to the PL7 menu bar. Selecting the EF command from the Debug EF menu, or clicking on the button (2nd button from the left), opens the screen used to select the EF to be tested. In our example, there is only one EF in the family (the "MAX_TABW" EF which we wish to test), the code of the class to which it belongs, its EF code, its name and its comment appear. Clicking on OK opens a screen which gives the C source of the EF (see section 4.3-1). Depending on the complexity of the EF, it may take several seconds to access this screen. 32

33 Testing the EF using the debugging tool 4.2 Presentation of the tool The tool commands are accessed from a scrolling menu and/or by buttons. All the commands are described below : ENGLISH (1st button from the left) : is used to exit the EF debug tool. (3rd button from the left) : is used to insert/ remove a breakpoint. (4th button from the left) or the Go command from the Debug EF menu is used to relaunch the PLC from the breakpoint or current step. (5th button from the left) or the Step Into command from the Debug EF menu : is used to go inside a function (if the function is present in the C source of the EF). (6th button from the left) or the Step Over command from the Debug EF menu: is used to skip a function (step over). (7th button from the left) or the Step Out command from the Debug EF menu : is used to exit a C function comprising a EF. the Registers command in the Debug EF menu is used to display a list of all the registers used by the CPU microprocessor (see section 4.3-3). the Local variables command in the Debug EF menu is used to display a list of variables used locally (see section 4.3-4). the Mix C/Asm command in the Debug EF menu is used to change from a presentation in C language to a presentation in C language and in assembly language. the Breakpoints command from the Debug EF menu is used to display a screen giving information on the position of breakpoints. the Step to Cursor command from the Debug EF menu is used to relaunch the PLC, from the step where it is stopped back to the cursor. 33

34 Testing the EF using the debugging tool 4.3 Debugging EFs ENGLISH Following the procedure described above (see section 4.2-1), the C source code of the EF is displayed on-screen and debugging can begin. It will be possible, using the tool commands and buttons, to perform all the usual debug operations, namely : Insert and remove breakpoints, Proceed step by step, Scroll through part of the program, Go inside a function, Analyze using the lists of registers and local variables, Edit the EF in C code and assembly language, to meet the needs of a more precise analysis of part of the program which could cause problems Inserting and removing breakpoints Select a line by pointing the cursor at it, then press the button to insert a breakpoint on this line. The same button is used to remove a breakpoint. Up to 7 breakpoints can be inserted simultaneously. A breakpoint is indicated by a blue line. It is thus possible to insert or remove all the breakpoints desired. If the PLC is running and if the program moves to one of the breakpoints, the line in question becomes yellow. Using the,, buttons, it is easy to enter/exit from a function or skip a function. Extract of the EF C source code with two breakpoints (one blue line, one yellow line) 34

35 Testing the EF using the debugging tool Mixing C code and assembly language The Mix C/Asm command from the Debug EF menu is used to change from a presentation in C language to a presentation in C language and in assembly language. ENGLISH Registers The Registers command in the Debug EF menu is used to display a list of all the registers used by the CPU microprocessor, as well as the contents of the execution stack which contains the local variables and the parameters of the function in which the program has stopped. 35