ODK 1500S FileServer

Transcription

1 Application description 10/2015 Read/Write data blocks from/into files in various formats

2 Warranty and liability Warranty and liability Note 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, solutions, machines, equipment and/or networks. They are important components in a holistic industrial security concept. With this in mind, Siemens products and solutions undergo continuous development. Siemens recommends strongly that you regularly check for product updates. For the secure operation of Siemens products and solutions, it is necessary to take suitable preventive action (e.g. cell protection concept) and integrate each component into a holistic, state-of-the-art industrial security concept. Third-party products that may be in use should also be considered. For more information about industrial security, visit To stay informed about product updates as they occur, sign up for a productspecific newsletter. For more information, visit Entry-ID: , V1.0, 10/2015 2

3 Table of contents Table of contents Warranty and liability Task Overview Solution Solution Overview Hardware and Software Components Validity Used Components General overview Auxiliary functions for file handling Storing information about data block s structure Tool to create the configuration data block ( Config DB Creator ) Workflow for direct access to TIA Portal project Workflow for manual export / import of the data blocks Supported File Formats Binary file CSV Comma Separated Values ASCII American Standards Committee for Information Interchange XML - Extensible Markup Language INI Windows initialization file Supported STEP 7 data types Basic types Structured data types STEP 7 Function Blocks ODK1500S_FileServer Load ODK1500S_FileServer Unload ODK1500S_FileServer_FileOpen ODK1500S_FileServer_FileWrite ODK1500S_FileServer_FileRead ODK1500S_FileServer_FileHandling ODK1500S_FileServer_FileGetStat Error Codes Error codes of ODK 1500S Special error codes of the ODK 1500S File Server Installation and Startup Quick-start Install ODK 1500S driver on runtime system Install ODK 1500S driver on engineering system with TIA-Portal Example Application Provided TIA portal example project Further notes, tips and tricks Process measure data block with CSV Access network drives Related literature Entry-ID: , V1.0, 10/2015 3

4 Table of contents 9 History Entry-ID: , V1.0, 10/2015 4

5 1 Task 1.1 Overview 1 Task 1.1 Overview Introduction The S PLCs offer various options to handle CSV files (DataLog, Recipe). Some applications require a bigger functional range, e.g. reading and writing binary, ASCII, XML, CSV and Windows INI files. Such applications could be: Load complex recipes from XML files Use INI files for configuration parameters Write process variables into XML files Read/write binary files for know-how-protection purposes Entry-ID: , V1.0, 10/2015 5

6 2 Solution 2.1 Solution Overview 2 Solution 2.1 Solution Overview The provides functions to store and read data blocks in a structured format. Several file types are supported (XML, ASCII, Binary, CSV, INI). Additional some functions are provided for handling files. The driver provides the following functions: Access several files at same time Writing/Reading in structured format (XML, CSV, etc.) Continuous writing (e.g. measured values in append mode) Getting file status (size, date, etc.) File handling (delete, copy, etc.) NOTE The driver reads / writes entire data blocks by default The format of the XML file is fixed. The driver allows reading and writing data blocks in XML format. It is not possible to parse any user-defined XML files. 2.2 Hardware and Software Components Validity This application example is valid for STEP 7 V13 SP1 or newer S Software Controller S7-150xS V Used Components Hardware components The application was generated using the following components: Table 2-1 Component No. Order number Note ET 200SP Open Controller CPU 1515SP PC + HMI 128PT 4-GB RAM version with WES7 P (Multitouch) 64Bit and 16-GB CFast card 1 6ES7677-2AA41-0FK0 Entry-ID: , V1.0, 10/2015 6

7 2 Solution 2.2 Hardware and Software Components Standard software components Table 2-2 Component No. Order number Note STEP 7 Prof. V13 SP1 1 SIMATIC ODK 1500S V1 1 6ES7806-2CD00-0YA0 The ODK is not needed to use this driver application! NOTE The ODK (Open Development Kit) is not needed to use this application! Sample files and projects The following list includes all files and projects that are used in this example. Table 2-3 Component ODK1500S_FileServer_UserManual_en.pdf Driver \ ODK1500S-FileServer.dll Driver \ install.bat TIAv13-ODK1500S-FileServer-Example ConfigDbCreator \ Note This documentation The driver s DLL Setup batch for the driver STEP 7 example project including all function blocks of the driver Tool for creating configuration data blocks Version of the driver The driver DLL is located in the ODK 1500S ODK directory: <$ProgramData>\Siemens\Automation\ODK1500S\ODK1500S-FileServer.dll You can identify the version of the driver DLL in the file properties (Windows explorer right click properties) Entry-ID: , V1.0, 10/2015 7

8 2 Solution 2.2 Hardware and Software Components Figure 2-1 Properties of the driver DLL NOTICE If the version of the installed DLL does not match the installed STEP 7 function blocks, the following error code may returned: 0x ODK application could not be executed because the function is not supported. Entry-ID: , V1.0, 10/2015 8

9 3.1 General overview 3.1 General overview The driver consists of two parts: The STEP 7 function blocks The driver DLL The driver DLL must be installed on the runtime system. The STEP 7 function blocks are used in the TIA Portal on the Engineering station. The S Software Controller runtime system has NO information about the internal structure of the data blocks. To be able to read/write data blocks in structured format, the driver has to know about the internal structure of the data block (data types, arrays etc.). The needed information about the composition of the data block is stored in a configuration data block. The advantage of this concept is: all needed information is part of the STEP 7 project. If the information would be stored in some kind of INI file, the PLC projecting would consist of two parts (the driver FBs and an INI file). The INI file has to be copied to the runtime system. With the S PLC generation so called optimized data blocks were introduced. In this way there are no addresses for the variables available any more. The functionality of the is based on accessing absolute addresses. It uses a mapping mechanism from variable name to address offset, which is stored in the Config DB (see below). Therefore only not-optimized DBs are supported. NOTICE The FileServer driver cannot process optimized data blocks, because the data access in the data DBs is based on address offsets. Entry-ID: , V1.0, 10/2015 9

10 3.2 Auxiliary functions for file handling Figure 3-1 Structure of the solution The needed configuration data block can be created using the provided tool Config-DB-Creator. NOTICE A separate FB FileClose is not needed. After writing a file it is closed immediately. If another data block has to be written to a different file, just call the FB FileOpen again with modified parameters. NOTICE The reading and writing was designed to handle a single file. Therefore all file data must fit in one data block. 3.2 Auxiliary functions for file handling The driver includes function blocks for file handling. They provide the following functions: Delete files Rename files Check status (size, date) Copy files Entry-ID: , V1.0, 10/

11 3.3 Storing information about data block s structure 3.3 Storing information about data block s structure The driver needs information about the internal build-up of the written / read data block. Only with this information a structured file format is possible. There are two possibilities: Some kind of INI file Separate configuration data block The FileServer driver uses the second approach with a separate configuration data block. Therefore the entire information is stored in the STEP 7 project. Project download is done in STEP 7, only. There is no need to copy additional INI files to the runtime system. This solution has a drawback: the size of the DB is limited by the number of structure information stored in the configuration DB. Attention The present version of the driver can handle a maximum of 4000 items per file. The Configuration Data Block ( ConfigDB ) The configuration data block contains information needed for handling data in structured format. The principle build-up is shown below: Table 3-1 Example of data block to read / write (source code) STRUCT Par_Kp INT Par_Tn INT Heater STRUCT Ht_Topt INT Ht_Trcp INT END_STRUCT Par_Ti INT END_STRUCT Table 3-2 Matching configuration data block (STL source) // Header CONFIG_DB_VERSION : INT := 1; //Version of ConfigDB CSV_SEPERATOR : CHAR := ';'; //CSV-Seperator WITH_HEADER : BOOL := TRUE; //Use header for files RESERVE : ARRAY [ ] OF BYTE ; // Type information CFG_DATA_TYP_1 : BYTE := B#16#22; //INT CFG_DATA_NAM_1 : STRING [6] := 'Par_Kp'; CFG_DATA_TYP_2 : BYTE := B#16#22; //INT CFG_DATA_NAM_2 : STRING [6] := 'Par_Tn'; CFG_DATA_TYP_3 : BYTE := B#16#70; //STRUCT_START CFG_DATA_NAM_3 : STRING [7] := 'Heater'; Entry-ID: , V1.0, 10/

12 3.3 Storing information about data block s structure CFG_DATA_TYP_4 : BYTE := B#16#22; //INT CFG_DATA_NAM_4 : STRING [7] := 'Ht_Topt'; CFG_DATA_TYP_5 : BYTE := B#16#22; //INT CFG_DATA_NAM_5 : STRING [7] := 'hat_trcp'; CFG_DATA_TYP_6 : BYTE := B#16#71; //STRUCT_END CFG_DATA_NAM_6 : STRING [0] := ''; //Struct ends here CFG_DATA_TYP_7 : BYTE := B#16#22; //INT CFG_DATA_NAM_7 : STRING [6] := 'Par_Ki'; CFG_DATA_TYP_8 : BYTE := B#16#AA; //End of ConfigDB CFG_DATA_NAM_8 : STRING [0] := ''; To save space in the ConfigDB the generator tool Config DB Creator adjusts the length of the CFG_DATA_NAM_xx variables to the current length of the variable name (e.g. length of Ht_Topt = 7). This approach is memory optimal in comparison using just the default length of 254 characters for each variable name. Entry-ID: , V1.0, 10/

13 3.3 Storing information about data block s structure Coding of STEP 7 data types All available S7 data types have to be stored. Additional sizes of Arrays or maximum length of strings have to be known. This information is stored in the configuration DB, too. For arrays the start index is stored because it can be different than 0 Table 3-3 Coding of S7 data types in configuration DB HEX DEC Description h - 0d not used 01h - 1d - Type BOOL 10h - 16d - reserve 1 byte 11h - 17d - Type BYTE 12h - 18d - Type CHAR 13h - 19d - Type SINT 14h - 20d - Type USINT 20h - 32d - reserve 2 byte 21h - 33d - Type WORD 22h - 34d - Type INT 23h - 35d - Type S5TIME 24h - 36d - Type DATE 25h - 37d - Type UINT 40h - 64d - reserve 4 byte 41h - 65d - Type DWORD 42h - 66d - Type DINT 43h - 67d - Type REAL 44h - 68d - Type TIME 45h - 69d - Type TIME_OF_DAY 46h - 70d - Type UDINT 50h - 80d - Type STRING 51h - 81d - max. len. of string 60h - 96d - Type ARRAY 61h - 97d - start index of array 62h - 98d - length of array 63h - 99d - end of array 70h - 112d - Type STRUCT (start of struct) 71h - 113d - end of struct 72h - 114d - Type UDT (start of UDT) 73h - 115d - end of UDT 80h - 128d - reserve 8 bytes 81h - 129d - Type DATE_AND_TIME 82h - 130d - Type LWORD 83h - 131d - Type LINT 84h - 132d - Type ULINT 85h - 133d - Type LREAL 86h - 134d - Type LTIME 87h - 135d - Type LTIME_OF_DAY 88h - 129d - Type DATE_AND_LTIME AAh - 170d - 'END of DB' C0h - 192d - reserve 12 bytes C1h - 193d - Type DTL Entry-ID: , V1.0, 10/

14 3.4 Tool to create the configuration data block ( Config DB Creator ) Configuration of Data Block Header Some file related information, such as write CSV header Yes/No, is stored in the header of the configuration data block like the separator for the CSV file. Table 3-4 Parameters of config data block header Parameter Typ Beschreibung CONFIG_DB_VERSION INT Version of Config DBs *1) WITH_HEADER BOOL Create Header in data file *2) CSV_SEPERATOR CHAR Separator for CSV files RESERVE reserved *1) The configuration data block s version number is needed to guarantee a matching between configuration and FileServer Driver s version. If in future versions more information is stored in the header, it will be marked by a changed version number. *2) Creating a header is only used for CSV files. 3.4 Tool to create the configuration data block ( Config DB Creator ) This tool assists in creating a matching configuration data block. It creates a configuration data block for a selected data block. Note The "Config DB Creator" supports analyzing of global data blocks, only. It is not possible to analyze Instance DBs, because the sources of such blocks do not include the needed data type information. The user selects the STEP 7 project, the folder and the data block. The tool will then analyse the data block and generate the matching configuration data block. The TIA Portal provides an application programming interface (API) for external applications- TIA Portal Openness. Therfore there are two options for getting the information about the relevant data block: Manually export the source of the data block Select the data block directly in the Config DB Creator Entry-ID: , V1.0, 10/

15 3.4 Tool to create the configuration data block ( Config DB Creator ) Workflow for direct access to TIA Portal project Note For direct compilation, the "Config DB Creator" needs an installed TIA Portal V13 or newer. Figure 3-2 GUI of the Config DB Creator On the right side, a log window is shown. It can be hidden by pressing <<< Hide Log <<<. To change the STEP 7 target (Project / Device / Block) the button Select Block has to be pressed. The Properties area contains some additional settings, like the CSV separator. Parameter Use header This setting is used for CSV files only! If the checkbox is activated, it has effect for both reading and writing: When writing a CSV file, a first line containing the variable s names will be created. When reading a CSV file, this first line, containing the header, will be skipped. Pressing Create ConfigDB generates the new data block in the selected STEP 7 project. Generated blocks are named with _Cfg name extension, e.g. DBdata.db DBdata_Cfg.db. Entry-ID: , V1.0, 10/

16 3.4 Tool to create the configuration data block ( Config DB Creator ) Workflow for manual export / import of the data blocks If the export/import should be done manually, the following steps are needed: Generate source for the data DB Generate sources for the used UDTs (if UDTs are used in the data DB). Use Config DB Creator to build the source for the Config DB Import the source of the Config DB into the TIA Portal project This approach is described in the following section. Generate sources in TIA Portal To create a Config Data Block in TIA-Portal, the source of the DB is needed. This source is created by performing the following steps: - Right-click on the data block - Select Generate source from blocks (Figure 3-3) in the context menu - Save the file Figure 3-3 Generate source from blocks in context menu NOTE If UDTs are used in the data block, you have to export the sources for the UDTs, too. Make sure the file is named like the UDT in TIA Portal. Example TYPE MyUserDefinedType file name MyUserDefinedType_src.awl Store UDT sources in the same directory as the DB s sources. Analyzing and creating a Config DB with Config DB Creator - Start the Config DB Creator and click on the Source tab. - Select the file in the DB Source File text field - Define the path for storing the Config DB Entry-ID: , V1.0, 10/

17 3.4 Tool to create the configuration data block ( Config DB Creator ) - Click on Create ConfigDB Figure 3-4 ConfigDB Creator GUI - TIA Portal Import Config DB source into TIA portal project - In the folder external source you will find the submenu add external files". Double-clicking on the item will open a new dialog. In this dialog you can select the text file, containing the generated source of the Config DB. Figure 3-4 Project view in the TIA Portal ( add external files ) - Now you see the external source in the folder external source files. - Rightclick on the file, select generate block Entry-ID: , V1.0, 10/

18 3.4 Tool to create the configuration data block ( Config DB Creator ) Figure 3-5 generate block submenu - After generating the data block you find the block in the folder Program blocks NOTE Updating an external source file will not update the file in TIA portal, automatically! If the external source of the Config DB is changed, a new manually import into the TIA Portal project is needed. Entry-ID: , V1.0, 10/

19 3.5 Supported File Formats 3.5 Supported File Formats Table 3-5 Overview of features of supported file types File Type Write Append Mode Read File Header Repeat Counter Binary Yes No Yes No No CSV Yes Yes Yes Yes Yes ASCII Yes Yes Yes No No XML Yes Yes Yes No No INI Yes No Yes No No Write Append Mode Read File Header Repeat Counter The driver can write this file type If activated, the driver does not overwrite an existing file, but appends the new data to the existing file. The driver can read this file type. The driver writes one additional 1 st line, containing the header For functionality of repeat counter see chapter 7.1 Process measure data block with CSV, pg Binary file This file format is the right solution, if a minimum space is required or if the internal data should be hidden. If a file is read into a data block, it has to be guaranteed the file was generated from a data block with exact same structure CSV Comma Separated Values When using CSV, the data is stored flat, i.e. information about arrays or structures inside the data block will get lost. Some parameters are specific to CSV files: Separator (tabulator, space, comma, etc.) Header line with variable s names NOTE The separator character can be defined by the user. The separating character must not exist in the user data. Entry-ID: , V1.0, 10/

20 3.5 Supported File Formats Function of parameter Header Line If the property with header line is activated, it causes the following: When a file is written, a first header line with all variable names is written before the data. When a file is read, the first line is skipped, because it should include the header only and no data. Table 3-6 Example of a CSV file with header Par_Kp; Par_Tn; Par_Ti 1; 3.4; 7 Table 3-7 Example of a CSV file without header 1; 3.4; 7 Repeat Counter / Multiple read/write operations In some applications data, e.g. some measuring data, is collected in one data block (e.g. time, value 1, value 2, time, value 1, value 2). The goal is to create a CSV file like this: Table 3-8 Example of a CSV file multiple read/write (usage of repeat counter) time; value 1; value 2 TOD#10:23:29.123; 3.4; 7.7 TOD#10:24:31.123; 3.6; 8.6 TOD#10:25:28.123; 3.7; 9.8 You could create a file like this with multiple call of FB WriteFile with APPEND flag is set. But if all data is stored in one data block it is more effective to do it with one call. When using the repeat-counter you can write all lines with one call of FB WriteFile. For the example above the repeat-counter must have the value of 3. The repeat-counter can be used for reading, too. Note While using the repeat-counter, keep in mind that all data must fit in one data block For a more detailed example of repeat counter see chapter 7.1 Process measure data block with CSV, pg. 47. Entry-ID: , V1.0, 10/

21 3.5 Supported File Formats ASCII American Standards Committee for Information Interchange When using ASCII a header (line) is not needed, because the variable s name is written in front of every value. Table 3-9 Example of an ASCII file in append mode Par_Kp = 1 Par_Tn = 3.4 Par_Ti = 7 Par_Kp = 2 Par_Tn = 3.6 Par_Ti = 9 Table 3-10 Example of a n ASCII file with an array of struct StructArray[1].Flag21=FALSE StructArray[1].Flag22=FALSE StructArray[2].Flag21=FALSE StructArray[2].Flag22=FALSE Entry-ID: , V1.0, 10/

22 3.5 Supported File Formats XML - Extensible Markup Language Using the XML file type a data block, including all structure and type information, can be written into a XML file. Note The format of the XML file is fixed. It is not possible to parse any user-defined XML files. The following example shows a data block including an array and a structure. Table 3-11 Example of a XML file <?xml version="1.0"?> <!-- generated by ODK1500S file server, > <plc_data> <element name="par_kp" type="int" value="12"/> <element name="par_tn" type="int" value="24"/> <element name="heater" type="struct"> <element name="ht_topt" type="int" value="56"/> <element name="ht_trcp" type="int" value="78"/ > </element> <element name="par_ti" type="int" value="91"/> <array name="refpoints" type="int"> <arrayitem index="1" value="3"/> <arrayitem index="2" value="8"/> </array> <array name="structarray" type="struct"> <arrayitem index="1"> <element name="flag21" type="bool" value="false"/> <element name="flag22" type="bool" value="true"/> </arrayitem> <arrayitem index="2"> <element name="flag21" type="bool" value="false"/> <element name="flag22" type="bool" value="true"/> </arrayitem> </array> </plc_data> When the XML file is created, the generation date is automatically added to the header area (see example above). Entry-ID: , V1.0, 10/

23 3.5 Supported File Formats INI Windows initialization file Note Using INI files, requires a specific data block structure, allowing the mapping of a data block to an INI file and vice versa (see example below). A Windows INI file has a well-defined format. It consists of sections (e.g. [MySection] ) and values (e.g. MyValue=5 ). In order to match such an INI file to a STEP 7 data block, the data block must have a corresponding structure, containing exactly one structure depth. If the data block has another format, using the INI format is not an option! The example below shows a matching INI file and data block. Table 3-12 Example of a Windows INI file [Parameter] KP=6 TN=5.3 [HMI] NUTZER=PAUL LEVEL=5 Table 3-13 Matching data block to the INI file above STRUCT Parameter : STRUCT KP : INT := 6; TN : REAL := e+000; END_STRUCT ; HMI : STRUCT Nutzer : STRING [254] := 'Paul'; Level : INT := 5; END_STRUCT ; END_STRUCT ; In the data block the sections of the INI file are represented by STRUCTs (or UDTs). Nested structures are not supported. If an INI file with the given name exists, the write command will just update the content of the INI file. If the INI file contains additional parameters, their values will not be altered. When reading an INI file, the driver retrieves only the needed information from the file. All additional information will be ignored. Entry-ID: , V1.0, 10/

24 3.6 Supported STEP 7 data types 3.6 Supported STEP 7 data types Basic types Most S data types are supported. The FileServer has to write and read the data as strings (except for binary files). The following table shows the supported STEP 7 data types. The writing format is fixed. Reading supports several formats (e.g. prefix 0x or B#16# for BYTE values). Table 3-14 Formatting of supported STEP 7 data types Data type Formats WRITE Valid formats READ BOOL TRUE / FALSE true false TRUE FALSE 1 0 BYTE B#16#AB B#16#AB 0xAB CHAR a ' ' (Space) ' (EUR) (see ASCII table) WORD W#16#ABCD W#16#ABCD 0xABCD DWORD DW#16#ABCDEF01 DW#16#ABCDEF01 0xABCDEF01 LWORD LW#16#ABCDEF LW#16#ABCDEF xABCDEF SINT USINT 2 2 INT 2 2 UINT 2 2 DINT UDINT LINT ULINT REAL e e+001 LREAL e e+001 STRING abcde abcde S5TIME *1) S5T#1M39S900MS S5T#1M39S900MS 1M39S900MS TIME T#4d20h31m23s647ms T#4d20h31m23s647ms 4d20h31m23s647ms LTIME LT#128d12h42m16s542ms36 2us507ns LT#128d12h42m16s542ms362 us507ns TIME_OF_DAY TOD#12:59: TOD#12:59: :59: LTIME_OF_DAY LTOD#12:59: LTOD#12:59: Entry-ID: , V1.0, 10/

25 3.6 Supported STEP 7 data types Data type Formats WRITE Valid formats READ 12:59: DATE D# D# DATE_AND_TIME DT# :54: DT# :54: :54: DATE_AND_LTIME DTL LDT# :54: DTL# :54: LDT# :54: :54: DTL# :54: :54: Note The data types ANY and POINTER are not supported! *1) Depending on the value of the time the data type S5TIME internally utilizes different time bases: 10ms, 100ms, 1s or 10s. Portions smaller than the used time base will get lost. Please refer to the SIMATIC documentation of data type S5TIME Structured data types STRUCT and UDTs are supported. An UDT is processed like a STRUCT. In XML files there is no difference between using a STRUCT and an UDT in a data block. Array inside arrays is supported. Multi-dimensional arrays are NOT supported! Entry-ID: , V1.0, 10/

26 3.7 STEP 7 Function Blocks 3.7 STEP 7 Function Blocks The provides a number of function blocks to access its functionality. The function block number can be changed by the user ODK1500S_FileServer Load Before using the, the driver has to be loaded using the following function block. Figure 3-3 Function block ODK1500S_FileServer Load Table 3-15 Parameter of ODK1500S_FileServer Load Parameter In/ Out Type Description REQ In Bool Positive edge triggers the function DONE Out Bool Function finished BUSY Out Bool Function still busy ERROR Out Bool Error occurred during function execution (ODK call) STATUS Out Int Status of the function execution. (ODK call) See chapter 4.1 Error codes of ODK 1500S pg. 35 PC Start-up The is implemented as Windows DLL. When the PC is switched on, the S Software Controller is ready some time before the Windows OS has booted completely. In this early phase it makes no sense to load a Windows based driver. Therefore the _Load function must take place after the Windows boot is completed. To achieve this, the Diagnostic Error Interrupt (OB 82) can be utilized. This mechanism is used in the provided demo application see chapter 6.1 Provided TIA portal example project, on page 45. Entry-ID: , V1.0, 10/

27 3.7 STEP 7 Function Blocks ODK1500S_FileServer Unload The explicit unload of the driver is only needed in very special cases, e.g. when updating the driver DLL. The explicit unload of the driver can be done using the following function: Figure 3-4 Function block ODK1500S_FileServer Unload Table 3-16 Parameter of ODK1500S_FileServer Unoad Parameter In/ Out Type Description REQ In Bool Positive edge triggers the function DONE Out Bool Function finished BUSY Out Bool Function still busy ERROR Out Bool Error occurred during function execution (ODK call) STATUS Out Int Status of the function execution. (ODK call) See chapter 4.1 Error codes of ODK 1500S pg. 35 Entry-ID: , V1.0, 10/

28 3.7 STEP 7 Function Blocks ODK1500S_FileServer_FileOpen This block opens a file. The structure information of the data block to read/write is provided. Technically this function builds an internal database with the structural information of the data block. There is no Windows file opened at this time. Figure 3-5 Function block ODK1500S_FileServer_FileOpen The function block works asynchronously. A rising edge of the REQ input starts the processing, a signaled DONE shows the end of processing. The parameter ID is used to identify a specific file. Up to 32 files are supported at the same time. Table 3-17 Parameter of ODK1500S_FileServer_FileOpen Parameter In/ Out Type Description REQ In Bool Positive edge triggers the function fileid In Int File identifier filename In String File name (incl. Path) fileformattype In Byte File format 1 - BIN, 2 - CSV, 3 - ASCII, 4 - XML, 5 INI append In Bool True append mode False overwrite mode maxfilecount In Int Max. number of files in the target directory. Oldest files are deleted by the driver. 0 no function configdb In Variant data block with structural information ( Config DB ) *1) ERROR Out Bool Error occurred during function execution (ODK call) DONE Out Bool Function finished Entry-ID: , V1.0, 10/

29 3.7 STEP 7 Function Blocks Parameter In/ Out Type Description BUSY Out Bool Function still busy STATUS Out Int Status of the function execution. (ODK call) See chapter 4.1 Error codes of ODK 1500S pg. 35 funcerror Out Bool Error flag for issue in function execution funcstatus Out Word Status of the function execution See chapter 4.2 Special error codes of the ODK 1500S File Server pg. 37 diagnostic01 Out Dword Additional information (internal support information) diagnostic02 Out Dword Additional information (internal support information) *1) When using file type binary the parameter CFG_DB can stay empty as there is no need for additional configuration information ODK1500S_FileServer_FileWrite This block writes data into a file. The data block is provided as a parameter. The internal structure of the data block is known due to the previous FB FileOpen call. Figure 3-6 Function Block ODK1500S_FileServer_FileWrite The function block works asynchronously. A rising edge of the REQ input starts the processing, a signaled DONE indicates the end of processing. The parameter ID is used to identify a specific file. Up to 32 files are supported at the same time. Entry-ID: , V1.0, 10/

30 3.7 STEP 7 Function Blocks Table 3-18 Parameter of ODK1500S_FileServer_FileWrite Parameter In/ Out Type Description REQ In Bool Positive edge triggers the function fileid In Int File identifier repeatcount In Int Repeat counter: How often contains the data block (DATA_DB) the structure defined in CFG_DB (FBFileOpen) datadb In Variant data block to be written ERROR Out Bool Error occurred during function execution (ODK call) DONE Out Bool Function finished BUSY Out Bool Function still busy STATUS Out Int Status of the function execution. (ODK call) See chapter 4.1 Error codes of ODK 1500S pg. 35 funcerror Out Bool Error flag for issue in function execution funcstatus Out Word Status of the function execution See chapter 4.2 Special error codes of the ODK 1500S File Server pg. 37 diagnostic01 Out Dword Additional information (internal support information) diagnostic02 Out Dword Additional information (internal support information) NOTICE The path, where the file should be written, must exist before calling the function FB FileWrite. Entry-ID: , V1.0, 10/

31 3.7 STEP 7 Function Blocks ODK1500S_FileServer_FileRead This block reads data from a file into a data block. The data block is provided as a parameter. The internal structure of the data block is known due to the previous FB FileOpen call. Figure 3-7 Function Block ODK1500S_FileServer_FileRead The function block works asynchronously. A rising edge of the REQ input starts the processing, a signaled DONE shows the end of processing. The parameter ID is used to identify a specific file. Up to 32 files are supported at the same time. Table 3-19 Parameter of ODK1500S_FileServer_FileRead Parameter In/ Out Type Description REQ In Bool Positive edge triggers the function fileid In Int File identifier repeatcount In Int Repeat counter: How often contains the data block (DATA_DB) the structure defined in CFG_DB (FBFileOpen) datadb In Variant data block to be read ERROR Out Bool Error occurred during function execution (ODK call) DONE Out Bool Function finished BUSY Out Bool Function still busy STATUS Out Int Status of the function execution. (ODK call) See chapter 4.1 Error codes of ODK 1500S pg. 35 funcerror Out Bool Error flag for issue in function execution funcstatus Out Word Status of the function execution See chapter 4.2 Special error codes of the ODK 1500S File Server pg. 37 Entry-ID: , V1.0, 10/

32 3.7 STEP 7 Function Blocks Parameter In/ Out Type Description diagnostic01 Out Dword Additional information (internal support information) diagnostic02 Out Dword Additional information (internal support information) ODK1500S_FileServer_FileHandling This function block provides the following file operations: Copy Rename Delete Move Figure 3-8 Function Block ODK1500S_FileServer_FileHandling Table 3-20 Parameter of ODK1500S_FileServer_FileHandling Parameter In/ Out Type Description REQ In Bool Positive edge triggers the function filenamesrc In String Full path / filename of source file filenamedst In String Full path / filename of destination file rename In Bool True rename the file move In Bool True move the file copy In Bool True copy the file deletesrc In Bool True delete the source file overwrite In Bool True Overwrite if exists (only valid for COPY) ERROR Out Bool Error occurred during function execution (ODK call) Entry-ID: , V1.0, 10/

33 3.7 STEP 7 Function Blocks Parameter In/ Out Type Description DONE Out Bool Function finished BUSY Out Bool Function still busy STATUS Out Int Status of the function execution. (ODK call) See chapter 4.1 Error codes of ODK 1500S pg. 35 funcerror Out Bool Error flag for issue in function execution funcstatus Out Word Status of the function execution See chapter 4.2 Special error codes of the ODK 1500S File Server pg. 37 diagnostic01 Out Dword Additional information (internal support information) diagnostic02 Out Dword Additional information (internal support information) ODK1500S_FileServer_FileGetStat This function block provides the following basic status informations Free disk space File size File time stamp File attributes Figure 3-9 Function Block ODK1500S_FileServer_FileGetStat Entry-ID: , V1.0, 10/

34 3.7 STEP 7 Function Blocks Table 3-21 Parameter of ODK1500S_FileServer_FileHandling Parameter In/ Out Type Description REQ In Bool Positive edge triggers the function filename In String Full path / filename ERROR Out Bool Error occurred during function execution (ODK call) DONE Out Bool Function finished BUSY Out Bool Function still busy STATUS Out Int Status of the function execution. (ODK call) See chapter 4.1 Error codes of ODK 1500S pg. 35 funcerror Out Bool Error flag for issue in function execution funcstatus Out Word Status of the function execution See chapter 4.2 Special error codes of the ODK 1500S File Server pg. 37 diagnostic01 Out Dword Additional information (internal support information) diagnostic02 Out Dword Additional information (internal support information) freediscspace Out Dword Free disk space filesize Out Dword File size filetimestamp Out Date_and_ Time Last change of file fileattrib Out Dword File attributes Bit 0 - READONLY Bit 1 - HIDDEN Bit 2 - SYSTEM Bit 4 - DIRECTORY Bit 5 - ARCHIVE Bit 6 - ENCRYPTED Bit 7 - NORMAL Bit 8 - TEMPORARY Bit 9 - SPARSE_FILE Bit 10 - REPARSE_POINT Bit 11 - COMPRESSED Bit 12 - OFFLINE 0x x x x x x x x x x x x Entry-ID: , V1.0, 10/

35 4 Error Codes 4.1 Error codes of ODK 1500S 4 Error Codes The FileServer provides different classes of error messages: - A STATUS code according to the ODK 1500S (see chapter 8.1 in this document) - Special error codes of the FileServer (see chapter 8.2 on page 37 in this document) Figure 4-1 Sources of error / status information in a driver function call 4.1 Error codes of ODK 1500S The driver has been developed using the ODK (Open Development Kit). The ODK generates error codes, which are provided through the FB s STATUS. NOTICE The meaning of the STATUS value depends on the calling function! Table 4-1 ODK 1500S error messages ODK Code (HEX) Description 0x8090 0x8092 0x Success (Un)Load the ODK driver ODK application could not be (un)loaded. An error occurred during execution of the "OnLoad()" / "OnUnload()" function. Execute the ODK driver ODK application could not be executed. An error occurred during execution. ODK application could not be loaded because the library name is invalid. ODK application could not be loaded because the ODK application could not be found. Check the file name and path of the file. Entry-ID: , V1.0, 10/

36 4 Error Codes 4.1 Error codes of ODK 1500S ODK Code (HEX) 0x8094 0x8095 0x8096 0x8097 0x8098 0x8099 0x809A 0x809B 0x809C 0x80A4 Description ODK application could not be loaded. The ODK application was created for the Windows user context, but no user is logged on. ODK application could not be loaded due to the following reasons: The DLL file not an ODK application An attempt has been made to load 64-bit application into a 32-bit system Dependencies on other Windows DLL files could not be resolved (ensure that the release build of the ODK application is used. Execute the ODK driver ODK application could not be executed because the ODK application was not loaded or unloading is not yet finished. Unload the ODK driver ODK application could not be unloaded because the ODK application was not loaded or unloading is not yet finished. ODK application is already loaded. Load the ODK driver ODK application could not be loaded because the ODK application is currently being unloaded. Execute the ODK driver ODK application could not be executed because the function is not supported. ODK application could not be executed because the maximum amount of input data (declarations with "In" and "InOut") was exceeded ODK application could not be executed because the maximum amount of input data (declarations with "Out" and "InOut") was exceeded The function returns an invalid value (a value between 0001 and 6FFF is allowed) Function uses an invalid data type: IN_DATA INOUT_DATA OUT_DATA Load the ODK driver ODK application could not be loaded. Start the ODK service manually or restart Windows. Execute the ODK driver ODK application could not be executed for the following reasons: The "<STEP 7Prefix>_Unload" instruction was executed during a function execution. The function execution was aborted at the CPU end. Windows terminates the execution of the function normally. No return value is sent to the CPU. Wait until the "<STEP 7 Prefix>_Unload" instruction has ended. Then load the ODK application again. Windows is not available ODK service is not running Start the ODK service manually or restart Windows. Unload the ODK driver ODK application could not be unloaded for the following reasons: Windows is not available ODK service is not running Start the ODK service manually or restart Windows. Entry-ID: , V1.0, 10/

37 4 Error Codes 4.2 Special error codes of the ODK 1500S File Server ODK Code (HEX) 0x80C2 0x80C3 Description ODK application could not be (un)loaded. There is currently not enough memory available at the Windows end. ODK application could not be (un)loaded. The CPU currently does not have enough memory. 4.2 Special error codes of the ODK 1500S File Server Besides the general error bit of the driver FBs there is a special error code in the value of funcstatus to describe the reason of the problem. Note Several error messages provide additional information in the diagnostic1 and diagnostic2 values, indicating the reasons for the error. These additional values are helpful when contacting the Siemens support. Table 4-2 Error codes of 0 - no error Interface to PLC 0x error using Read function 0x error converting S7 string to C string 0x false ID for file 0x not supported file format State errors 0x update config is active 0x read file is active, update config not allowed 0x write file is active, update config not allowed 0x unknown internal state (no 'file open' called before?) 0x false internal state after changing config Analyzing the configuration 0x no file defined yet 0x config DB version not supported 0x too many items for internal storage 0x no start index of array found 0x no start index of array found 0x append mode not allowed for BIN files 0x append mode not allowed for INI files 0x no strlen for string found 0x max. strlen to small (0 or negative) 0x003a - max. strlen to long (> 254) 0x003b - unsupported data type found 0x003c - internal error - exception catched Errors writing file 0x no valid repeat counter for writing Entry-ID: , V1.0, 10/

38 4 Error Codes 4.2 Special error codes of the ODK 1500S File Server 0x no file handler (file format) assigned to this file ID 0x error writing to file 0x internal error - exception catched 0x cannot write data outside of struct (needed for section name) 0x nested structs not allowed for INI files 0x error writing parameter to INI file 0x unexpected data type when writing XML writing basic type 0x unexpected data type when writing XML writing array 0x unexpected data type when writing XML writing struct 0x error seeking file from end 0x error file get pos 0x error file fgetc 0x error writing BIN file 0x this S7 data type is not supported for writing 0x error writing BOOL - reading from PLC 0x error writing BYTE - reading from PLC 0x error writing CHAR - reading from PLC 0x error writing CHAR - range of character 0x error writing WORD - reading from PLC 0x error writing DWORD - reading from PLC 0x error writing INT - reading from PLC 0x error writing DINT - reading from PLC 0x008a - error writing REAL - reading from PLC 0x008b - error writing S5TIME - reading from PLC 0x008c - error writing S5TIME - problem with time base 0x008d - error writing STRING - internal buffer to small 0x008e - error writing STRING - reading from PLC 0x008f - error writing TIME - reading from PLC 0x008f - error writing LTIME - reading from PLC 0x error writing TIME_OF_DAY (TOD) - reading from PLC 0x error writing LTIME_OF_DAY (LTOD) - reading from PLC 0x error writing DATE - reading from PLC 0x error writing DATE - range error 0x error writing DATE_AND_TIME - reading from PLC 0x error writing LWORD - reading from PLC 0x error writing LINT - reading from PLC 0x error writing ULINT - reading from PLC 0x error writing LREAL - reading from PLC 0x error writing DATE_AND_LTIME (LDT) - reading from PLC 0x009a - error writing DATE_AND_LTIME (LDT) - range error 0x009b - error writing DTL - reading from PLC 0x009c - error writing SINT - reading from PLC 0x009d - error writing USINT - reading from PLC 0x009e - error writing UINT - reading from PLC 0x009f - error writing UDINT - reading from PLC Error reading a file 0x no valid repeat counter for reading 0x internal error - exception caught 0x given data DB does not fit configured size 0x given data DB size is to big Entry-ID: , V1.0, 10/

39 4 Error Codes 4.2 Special error codes of the ODK 1500S File Server 0x error getting file status 0x error file size does not match DB size 0x error reading file binary 0x no header line found in CSV file 0x end of file before all values read 0x value string too long 0x value string too short (CSV file to short?) 0x given INI parameter/section not found 0x a line in ASCII file is too long 0x line without '=' 0x got invalid index for item 0x got invalid index for item 0x empty parent 0x base address for XML read errors 0x XML read - Error 0x XML read - Failed to open file 0x XML read - Memory allocation failed. 0x XML read - Error parsing Element. 0x XML read - Failed to read Element name 0x XML read - Error reading Element value. 0x XML read - Error reading Attributes. 0x XML read - Error empty tag. 0x XML read - Error reading end tag. 0x020A - XML read - Error parsing Unknown. 0x020B - XML read - Error parsing Comment. 0x020C - XML read - Error parsing Declaration. 0x020D - XML read - Error document empty. 0x020E - XML read - Error null (0) or unexpected EOF found in input stream. 0x020F - XML read - Error parsing CDATA. 0x XML read - Error when XmlDocument added to document, because XmlDocument can only be at the root. 0x XML read - Error Error reading file - parsing value strings 0x this type is not supported for reading 0x error reading data type 'BOOL' - writing 'true' to PLC 0x error reading data type 'BOOL' - writing 'false' to PLC 0x error reading data type 'BOOL' - unknown value 0x error reading data type 'BYTE' - writing to PLC 0x error reading data type 'CHAR' - got no character 0x error reading data type 'CHAR' - got string with length > 1 0x error reading data type 'CHAR' - out of range 0x error reading data type 'CHAR' - writing to PLC 0x030a - error reading data type 'WORD' - writing to PLC 0x030b - error reading data type 'DWORD' - writing to PLC 0x030c - error reading data type 'INT' - writing to PLC 0x030c - error reading data type 'SINT' - writing to PLC 0x030d - error reading data type 'DINT' - writing to PLC 0x030d - error reading data type 'UDINT' - writing to PLC 0x030e - error reading data type 'REAL' - writing to PLC 0x030f - error converting hex value (false prefix?) Entry-ID: , V1.0, 10/

40 4 Error Codes 4.2 Special error codes of the ODK 1500S File Server 0x error reading data type 'LWORD' - writing to PLC 0x error reading data type 'LINT' - writing to PLC 0x error reading data type 'LUINT' - writing to PLC 0x error reading data type 'LREAL' - writing to PLC 0x error reading data type 'BYTE' - range error 0x error reading data type 'WORD' - range error 0x error reading data type 'SINT' - range error: value to big 0x error reading data type 'SINT' - range error: value to small 0x error reading data type 'USINT' - range error: value to big 0x error reading data type 'USINT' - range error: value to small 0x031a - error reading data type 'INT' - range error: value to big 0x031b - error reading data type 'INT' - range error: value to small 0x031c - error reading data type 'UINT' - range error: value to big 0x031d - error reading data type 'UINT' - range error: value to small 0x031e - error reading data type 'DINT' - range error: value to big 0x031f - error reading data type 'DINT' - range error: value to small 0x error reading data type 'UDINT' - range error: value to big 0x error reading data type 'UDINT' - range error: value to small 0x error reading S5TIME - writing value to PLC 0x error reading S5TIME - false prefix ('S5T#') 0x error reading S5TIME - [MS] resolution (divisible by 10) 0x error reading S5TIME - [MS] value 0x error reading S5TIME - [S] value 0x error reading S5TIME - [MIN] value 0x error reading S5TIME - [H] value 0x error reading S5TIME - value out of range 0x error reading S5TIME - value out of range 0x033a - error reading S5TIME - base out of range 0x error reading STRING - invalid pointer to string 0x error reading STRING - string is too large for the STEP 7 string 0x error reading STRING - string is too large for the output data buffer 0x error reading TIME - prefix 'T#' is missing 0x error reading TIME - [MS] value 0x error reading TIME - [S] value 0x error reading TIME - [MIN] value 0x error reading TIME - [H] value 0x error reading TIME - [D] value 0x error reading TIME - more than one negative number 0x error reading TIME - the negative number is not the highest used one 0x error reading TIME - writing value to PLC 0x035a - error reading TIME - range exceed 0x error reading LTIME - prefix 'LT#' is missing 0x error reading LTIME - [NS] value 0x error reading LTIME - [US] value 0x error reading LTIME - [MS] value 0x error reading LTIME - [S] value 0x error reading LTIME - [MIN] value 0x error reading LTIME - [H] value 0x error reading LTIME - [D] value 0x error reading LTIME - more than one negative number 0x error reading LTIME - the negative number is not the highest used one 0x036a - error reading LTIME - writing value to PLC Entry-ID: , V1.0, 10/

41 4 Error Codes 4.2 Special error codes of the ODK 1500S File Server 0x036b - error reading LTIME - range exceed 0x error reading TIME_OF_DAY - prefix 'TOD#' is missing 0x error reading TIME_OF_DAY - writing value to PLC 0x error reading LTIME_OF_DAY - prefix 'LTOD#' is missing 0x error reading LTIME_OF_DAY - writing value to PLC 0x error reading DATE - prefix 'D#' is missing 0x error reading DATE - range year exceed 0x error reading DATE - range month exceed 0x error reading DATE - range day exceed 0x error reading DATE - range exceed: computing seconds 0x error reading DATE - writing value to PLC 0x03a1 - error reading DATE_AND_LTIME (LDT) - prefix 'LDT#' is missing 0x03a2 - error reading DATE_AND_LTIME (LDT) - writing value to PLC 0x03b1 - error reading DATE_AND_TIME - prefix 'DT#' is missing 0x03b2 - error reading DATE_AND_TIME - writing value to PLC 0x03b3 - error reading DATE_AND_TIME - [MS] value 0x03b4 - error reading DATE_AND_TIME - [S] value 0x03b5 - error reading DATE_AND_TIME - [MIN] value 0x03b6 - error reading DATE_AND_TIME - [H] value 0x03b7 - error reading DATE_AND_TIME - [DAY] value 0x03b8 - error reading DATE_AND_TIME - [MON] value 0x03b9 - error reading DATE_AND_TIME - [Y] value 0x03bA - error reading DATE_AND_TIME - computing weekday 0x03c1 - error reading DTL - prefix 'DTL#' is missing 0x03c3 - error reading DTL - [NS] value 0x03c4 - error reading DTL - [S] value 0x03c5 - error reading DTL - [MIN] value 0x03c6 - error reading DTL - [H] value 0x03c7 - error reading DTL - [DAY] value 0x03c8 - error reading DTL - [MON] value 0x03c9 - error reading DTL - [Y] value 0x03cA - error reading DTL - computing weekday Other errors 0x write not implemented in reader classes 0x undefined return value 0x error open file 0x error rename file from temp. to final name 0x error deleting old file before renaming to final name Errors file handling 0x error deleting file 0x error copying file 0x error moving file 0x internal error - exception caught 0x error retrieving free disk space 0x error retrieving free disk space 0x error creating file 0x error get file size 0x error get file time Entry-ID: , V1.0, 10/

42 4 Error Codes 4.2 Special error codes of the ODK 1500S File Server 0x error converting file time 0x error get file attributes 0x internal error - exception caught Entry-ID: , V1.0, 10/

43 5 Installation and Startup 5.1 Quick-start 5 Installation and Startup 5.1 Quick-start Runtime system Install the driver DLL on the runtime system using the Install.bat script Engineering system TIA Portal Retrieve and open the archived STEP 7 project in TIA Portal Copy all driver function blocks in your project Used SIMATIC PLC must be a S Software Controller (S7-150xS). In other case the driver s function blocks are marked as faulty. Run the ConfigDBCreator.exe to create the needed Config DB (manual import / export of sources is needed) Call ODK1500S_FileServer_Load once, before using any other FB from the driver Call ODK1500S_FileServer_FileOpen with the desired file name Call ODK1500S_FileServer_FileRead / ODK1500S_FileServer_FileWrite for reading / writing Use auxiliary file functions (get status, copy/move, etc.) if needed Entry-ID: , V1.0, 10/

44 5 Installation and Startup 5.2 Install ODK 1500S driver on runtime system 5.2 Install ODK 1500S driver on runtime system To install the ODK 1500S driver on the runtime system run the setup.bat batch file as administrator. This will copy the driver DLL to the right folder on the S Software Controller and register the DLL in the registry. This installation works from a USB stick, too. 5.3 Install ODK 1500S driver on engineering system with TIA-Portal Components of the engineering environment: This documentation STEP 7 V1x (TIA-Portal) demo application Tool ConfigDB Creator The STEP 7 demo application contains the program blocks. You can copy the driver function blocks to your application The Config DB Creator does not require an installation. It can be run without administrative privileges. There is no need to install the ODK 1500S driver (Running setup.bat) on the engineering system. S7-150xS - CPU in the project If the driver function blocks are copied to a project without a S7-150xS CPU the FBs are marked with an error, because the used SFBs are only supported by S Software Controllers. Copy the elements (blocks, watch tables) To use the FileServer in a TIA Portal project the following components are needed: - The driver blocks (folder Program blocks ) A second instance of the TIA Portal is needed for copying. Open the target project in the second instance and copy the function blocks (e.g. drag and drop ) from the demo project. Compiling blocks In some cases the TIA portal may mark the driver function blocks red, because some functions are not recognized right. In this case you have to compile the function blocks again in order to update the function block s interfaces. Entry-ID: , V1.0, 10/

45 6 Example Application 6.1 Provided TIA portal example project 6 Example Application 6.1 Provided TIA portal example project The driver package includes a TIA Portal example project. The example application is realized in FBD (Function Block Diagram). This example aims to demonstrate all functions of the driver. The different functionalities are controlled using a set of watch tables. Figure 6-1 ODK 1500S Example Project Diagnostic Error Interrupt (OB 82) This Organization Block is called by the PLC when the Windows OS is ready. Its event is used to trigger the loading of the FileServer driver. The driver is based on Windows, therefore the loading is possible only when Windows is ready. Main (OB 1) The Main Organization Block just calls the function holding all the FileServer functionalities. ODK1500S_FileServer / FB_FileServer_Call This function block calls all the driver s function blocks. The calls are implemented as multi-instance calls. The call of the _Load FB in the network #1 is a little bit special: this call is triggered either by the flag from the Diagnostic Error Interrupt or by an explicit trigger from the watch table. Entry-ID: , V1.0, 10/

46 6 Example Application 6.1 Provided TIA portal example project ODK1500S_FileServer / DB_FileServer_g This global data block holds all the needed variables for calling the driver s function blocks incl. the request flags, status flags, etc. ODK1500S_FileServer / DB_ODK1500S_Startup In this global DB the request flag for loading the driver by the Diagnostic Error Interrupt event is stored. If you use additional ODK drivers with the same startup mechanism, you can merge this DB by including the needed bxxxload_req flags. ODK1500S_FileServer / ODK1500S_FileServer_ These function blocks provide the functionality of the driver. ODK1500S_FileServer_ SampleDBs / DBData, DBData_Cfg This folder contains various sample DBs. All sample DBs consists of a matching pair of DBs: the DB to be stored/loaded into/from file and the matching configuration DB holding the internal structure of the data DB. Watch and force tables The example project contains several watch tables to operate a specific functionality, e.g. load/unload the driver, open a file, etc. Entry-ID: , V1.0, 10/

47 7 Further notes, tips and tricks 7.1 Process measure data block with CSV 7 Further notes, tips and tricks 7.1 Process measure data block with CSV A data block stores uniform data (e.g. measure data: timestamp, value 1, value 2, etc.). This data block should be written in a CSV file or read from CSV file. The data block may have the following structure: Table 7-1 Example data block with measure values STRUCT data : ARRAY[0.999] OF STRUCT timestamp : TIME_OF_DAY ; voltage : REAL ; current : REAL ; current : REAL ; END_STRUCT ; END_STRUCT ; To fulfill the requirement there are different approaches: Write whole data block with one function call as a whole Write data block line by line Write whole data block with the repeat counter Write whole data block with one function call as a whole One can create a Configuration DB with the structural information for the whole measure value data block (tool ConfigDBCreator). With one call of FB FileOpen and FB FileWrite the data block can be written. Drawback: The configuration data block will get big size. It may contain more items than the supports. Write data block line by line In this case the Config-DB describes the measure data, only. After opening with FB FileOpen with APPEND flag set, the FBFileWrite must be called many times one time for every measure value. The input parameter DATA_DB (ANY) must point to the next measure value. Drawback: Because of the many single calls of FB FileWrite the writing will cost some time. Tip To create the Config-DB for the measure data only with the tool ConfigDBCreator one can reduce the size of the array to 1 temporally. Entry-ID: , V1.0, 10/

48 7 Further notes, tips and tricks 7.2 Access network drives Write whole data block with the repeat counter Also in this case the Config-DB describes the measure data, only. Now the FBFileWrite is called with repeatcnt = 100. Thus this single call processes the whole data block containing many measure values. The concept is shown in the following picture: Figure 7-1 Usage of the Repeat Counter 7.2 Access network drives The runs as user SYSTEM, i.e. system process. A system process runs with Zero Credentials, i.e. it is allowed only to access local resources. By default the driver cannot access any network drives. But it is possible to create a so called null session share which can be assessed without login name and password. Note The following settings have to be done on the remote PC. On this PC the directory is located for storing S Software Controller s data. Create directory and share e.g. PlcData ; full access for user Everyone Group Policy Editor (start e.g. by gpedit.msc) Computer configuration \ Windows settings \ Security Settings \ Local settings \ safety options + Network access: shares that can be accessed anonymously : add PlcData here Entry-ID: , V1.0, 10/