documentation/html/4diacIDE/otherUseful.html - gerrit/www.eclipse.org/4diac - Git at Google

 <!DOCTYPE html>
 <!--
  Copyright (c) 2016-2018 fortiss GmbH, Johannes Kepler University Linz
                2019 Andrea Zoitl
                2019 Jan Holzweber

  This program and the accompanying materials are made available under the
  terms of the Eclipse Public License 2.0 which is available at
  http://www.eclipse.org/legal/epl-2.0.

  SPDX-License-Identifier: EPL-2.0

  Contributors:
    Milan Vathoopan, Carolyn Oates, Alois Zoitl, Monika Wenger, Jose Cabral
      - initial API and implementation and/or initial documentation
    Bianca Wiesmayr
      - minor text corrections
    Andrea Zoitl
      - updated ToC, improved readability
    Jan Holzweber - added tutorial Step 7
 -->

 <html lang="en">
 <head>
   <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
 	<title>Step 5 - Other Basic Features</title>
 	<link rel="stylesheet" type="text/css" href="../help.css">
 </head>

 <body>

 <!--********************************************************************************************-->

 <h1 id="CreateTypes">Step 5 - Other Basic Features</h1>

 <p id="topOfPage">This page is part of a guide that gives a walk-through over the major 4diac&nbsp;IDE features.</p>

     <ol start="0">
       <li><a href="../../html/4diacIDE/overview.html">4diac&nbsp;IDE Overview</a></li>
       <li><a href="../../html/4diacIDE/use4diacLocally.html">Use 4diac Locally (Blinking tutorial)</a></li>
       <li><a href="../../html/4diacIDE/distribute4diac.html">Distribute 4diac Applications</a></li>
       <li><a href="../../html/4diacIDE/use4diacRemotely.html">Deploy Applications Remotely</a></li>
       <li><a href="../../html/4diacIDE/createOwnTypes.html">Create Your own Function Block Types</a></li>
       <li>Other Basic Features (YOU ARE HERE!)</li>
       <li><a href="../../html/4diacIDE/advancedFeatures.html">Advanced Features</a></li>
       <li><a href="../../html/4diacIDE/dynamicTypeLoader.html">Deploying new FBs with the Dynamic Type Loader</a></li>
     </ol>

 <p>This page shows the following interesting features in 4diac&nbsp;IDE that might improve your work:</p>
 <ol>
   <li><a href="#ImportSystem">Import an Existing System</a></li>
   <li><a href="#ImportType">Import Existing IEC&nbsp;61499 Types</a></li>
   <li><a href="#VirtualDNS">Virtual DNS Functionality</a></li>
   <li><a href="#CreateBootfiles">Creating Boot-Files</a></li>

 </ol>

 <!--********************************************************************************************-->

   <h2 id= "ImportSystem">Import an Existing System</h2>
     <p>Existing Systems can be imported as follows: </p>

 	<ol>
 		<li>Start 4diac&nbsp;IDE with the desired Workspace</li>
 		<li>Select File/Import/Existing Projects into Workspace and press Next</li>
 		<li>Choose the folder that contains the folder with the System you want to import</li>
 		<li>Mark the desired System within the project field below</li>
 		<li>If your project is not yet within your workspace and if you do not want to modify the original version of your project, mark Copy Projects into workspace and press Finish.
 		Consider that if you did not check Copy Projects into workspace and you delete your System within 4diac&nbsp;IDE, your System will be deleted permanently.</li>
 		<li>Verify that the System is completely there, that is the System Configuration with the Devices and Resources as well as the Application with FBs and both event and data connections.</li>
 	</ol>

 <!--********************************************************************************************-->

 	<h2 id= "ImportType">Import Existing IEC&nbsp;61499 Types</h2>
 	  <p>By default, new systems contain a copy of the IEC&nbsp;61499 types in the tool-library.
 	  If different types are needed, for example from another project or another IEC&nbsp;61499 engineering tool, these type files can be easily added by copying them into the project directory to the desired location.
 	  Furthermore, the Type Navigator allows to drag and drop types between projects as well as within a project to a different folder.</p>

 <!--********************************************************************************************-->

 	<h2 id= "VirtualDNS">Virtual DNS Functionality</h2>

 	  <p>The Properties View provides a Virtual DNS editor. This functionality allows defining a set of variables, which are replaced by a specified value.
 	  The variable names can be used for parameters of Function Blocks and Devices.
 	  During the deployment, all variables which are available in the VirtualDNS are replaced with the specified value.
 	  For using a variable, the variable name has to be written between %.
 	  In the example below, two Configurations were created: local and rasbpi.
 	  The configuration rasbpi has the ip variable set to a value of 192.168.0.7, and the local to 127.0.0.1.
 	  In the main view, the variable ip is used as the ip address of the 4diac&nbsp;FORTE device.
 	  When you want to use a local 4diac&nbsp;FORTE, just change the configuration and check Active Configuration instead of changing each time the value.</p>

 	<img src="../../html/4diacIDE/img/virtualDNS.png" alt="Virtual DNS"/>

 <!--********************************************************************************************-->

     <h2 id="CreateBootfiles">Creating Boot-Files</h2>
       <p>When the option
       <span class="specificText">FORTE_SUPPORT_BOOTFILE</span> is enabled for the FORTE you are using, on startup FORTE tries to load a so called boot-file.
       This boot-file has to be located in the same directory as your 4diac&nbsp;FORTE binary and needs to be named <span class="fileLocation">forte.fboot.</span>
       This file contains the FB network configuration for the device and will be automatically instantiated during startup of 4diac&nbsp;FORTE.</p>
    	  <p>In order to create such boot-files, you need to select one or more devices or resources in the <span class="view4diac">Download Selection View</span> and select <span class="menu4diac">Create FORTE boot-files...</span> from the context menu.</p>
       <p>
     <img src="../../html/4diacIDE/img/createBootFileContextMenu.png" alt="Create Boot-file context menu" />
       </p>
       <p>In the wizard, you can then select the devices and resources for which you wish to create boot-files as well as the directory where to place them.</p>
       <p>
     <img src="../../html/4diacIDE/img/createBootFileWizard.png" alt="Create Boot-file Wizard" />
       </p>
       <p>On pressing <span class="button4diac">Finish</span> one boot-file will be created per device.
       This boot-file will contain the selected resources and the FB networks contained in the resources.
       As only the resources selected are included in the boot-file, you can have a larger set of resources during development (e.g., for test-code) and use only the main resources for the boot-file.
       The name of the boot-file will be a combination of system and device name dot fboot.
       Before using it you need to rename it to forte.fboot.</p>

 <!--********************************************************************************************-->

 <h1>Where to go from here?</h1>

 <p>The last step is optional, and shows some advanced features of 4diac&nbsp;IDE that you might use in more complicated applications.</p>

 <p><a href="../../html/4diacIDE/advancedFeatures.html">Step 6 - Advanced Features</a></p>

 <p>If you want to see some examples, the following link is an index of the available examples in the documentation:</p>

 <p><a href="../../html/examples/examplesIndex.html">4diac Examples</a></p>

 <p>If you have a specific platform that has input and outputs that is supported by FORTE, for example a Raspberry Pi or a PLC, and you want to use them, go to following page:</p>

 <p><a href="../../html/parameters/parameters.html">Parameters for Different Platforms</a></p>

 <p>If you want to use a specific communication protocol supported by 4diac&nbsp;FORTE, for example MQTT, OPC UA, Modbus and so on, go to this page:</p>

 <p><a href="../../html/communication/communicationIndex.html">Supported Communication Protocols</a></p>

 <p>If you want to go back to see again how to create your own Function Blocks, here's a link:</p>

 <p><a href="../../html/4diacIDE/createOwnTypes.html">Step 4 - Create Your own Function Block Types</a></p>

 <p>If you want to go back to the Start Here page, we leave you here a fast access:</p>

 <p><a href="../../html/startHere/startHere.html">Where to Start</a></p>

 <p class="goToTop"><a href="#topOfPage">Go to top</a></p>

 </body>
 </html>
	<!DOCTYPE html>
	<!--
	Copyright (c) 2016-2018 fortiss GmbH, Johannes Kepler University Linz
	2019 Andrea Zoitl
	2019 Jan Holzweber

	This program and the accompanying materials are made available under the
	terms of the Eclipse Public License 2.0 which is available at
	http://www.eclipse.org/legal/epl-2.0.

	SPDX-License-Identifier: EPL-2.0

	Contributors:
	Milan Vathoopan, Carolyn Oates, Alois Zoitl, Monika Wenger, Jose Cabral
	- initial API and implementation and/or initial documentation
	Bianca Wiesmayr
	- minor text corrections
	Andrea Zoitl
	- updated ToC, improved readability
	Jan Holzweber - added tutorial Step 7
	-->

	<html lang="en">
	<head>
	<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
	<title>Step 5 - Other Basic Features</title>
	<link rel="stylesheet" type="text/css" href="../help.css">
	</head>

	<body>

	<!--********************************************************************************************-->

	<h1 id="CreateTypes">Step 5 - Other Basic Features</h1>

	<p id="topOfPage">This page is part of a guide that gives a walk-through over the major 4diac IDE features.</p>

	<ol start="0">
	<li><a href="../../html/4diacIDE/overview.html">4diac IDE Overview</a></li>
	<li><a href="../../html/4diacIDE/use4diacLocally.html">Use 4diac Locally (Blinking tutorial)</a></li>
	<li><a href="../../html/4diacIDE/distribute4diac.html">Distribute 4diac Applications</a></li>
	<li><a href="../../html/4diacIDE/use4diacRemotely.html">Deploy Applications Remotely</a></li>
	<li><a href="../../html/4diacIDE/createOwnTypes.html">Create Your own Function Block Types</a></li>
	<li>Other Basic Features (YOU ARE HERE!)</li>
	<li><a href="../../html/4diacIDE/advancedFeatures.html">Advanced Features</a></li>
	<li><a href="../../html/4diacIDE/dynamicTypeLoader.html">Deploying new FBs with the Dynamic Type Loader</a></li>
	</ol>

	<p>This page shows the following interesting features in 4diac IDE that might improve your work:</p>
	<ol>
	<li><a href="#ImportSystem">Import an Existing System</a></li>
	<li><a href="#ImportType">Import Existing IEC 61499 Types</a></li>
	<li><a href="#VirtualDNS">Virtual DNS Functionality</a></li>
	<li><a href="#CreateBootfiles">Creating Boot-Files</a></li>

	</ol>

	<!--********************************************************************************************-->

	<h2 id= "ImportSystem">Import an Existing System</h2>
	<p>Existing Systems can be imported as follows: </p>

	<ol>
	<li>Start 4diac IDE with the desired Workspace</li>
	<li>Select File/Import/Existing Projects into Workspace and press Next</li>
	<li>Choose the folder that contains the folder with the System you want to import</li>
	<li>Mark the desired System within the project field below</li>
	<li>If your project is not yet within your workspace and if you do not want to modify the original version of your project, mark Copy Projects into workspace and press Finish.
	Consider that if you did not check Copy Projects into workspace and you delete your System within 4diac IDE, your System will be deleted permanently.</li>
	<li>Verify that the System is completely there, that is the System Configuration with the Devices and Resources as well as the Application with FBs and both event and data connections.</li>
	</ol>

	<!--********************************************************************************************-->

	<h2 id= "ImportType">Import Existing IEC 61499 Types</h2>
	<p>By default, new systems contain a copy of the IEC 61499 types in the tool-library.
	If different types are needed, for example from another project or another IEC 61499 engineering tool, these type files can be easily added by copying them into the project directory to the desired location.
	Furthermore, the Type Navigator allows to drag and drop types between projects as well as within a project to a different folder.</p>

	<!--********************************************************************************************-->

	<h2 id= "VirtualDNS">Virtual DNS Functionality</h2>

	<p>The Properties View provides a Virtual DNS editor. This functionality allows defining a set of variables, which are replaced by a specified value.
	The variable names can be used for parameters of Function Blocks and Devices.
	During the deployment, all variables which are available in the VirtualDNS are replaced with the specified value.
	For using a variable, the variable name has to be written between %.
	In the example below, two Configurations were created: local and rasbpi.
	The configuration rasbpi has the ip variable set to a value of 192.168.0.7, and the local to 127.0.0.1.
	In the main view, the variable ip is used as the ip address of the 4diac FORTE device.
	When you want to use a local 4diac FORTE, just change the configuration and check Active Configuration instead of changing each time the value.</p>

	<img src="../../html/4diacIDE/img/virtualDNS.png" alt="Virtual DNS"/>

	<!--********************************************************************************************-->

	<h2 id="CreateBootfiles">Creating Boot-Files</h2>
	<p>When the option
	<span class="specificText">FORTE_SUPPORT_BOOTFILE</span> is enabled for the FORTE you are using, on startup FORTE tries to load a so called boot-file.
	This boot-file has to be located in the same directory as your 4diac FORTE binary and needs to be named <span class="fileLocation">forte.fboot.</span>
	This file contains the FB network configuration for the device and will be automatically instantiated during startup of 4diac FORTE.</p>
	<p>In order to create such boot-files, you need to select one or more devices or resources in the <span class="view4diac">Download Selection View</span> and select <span class="menu4diac">Create FORTE boot-files...</span> from the context menu.</p>
	<p>
	<img src="../../html/4diacIDE/img/createBootFileContextMenu.png" alt="Create Boot-file context menu" />
	</p>
	<p>In the wizard, you can then select the devices and resources for which you wish to create boot-files as well as the directory where to place them.</p>
	<p>
	<img src="../../html/4diacIDE/img/createBootFileWizard.png" alt="Create Boot-file Wizard" />
	</p>
	<p>On pressing <span class="button4diac">Finish</span> one boot-file will be created per device.
	This boot-file will contain the selected resources and the FB networks contained in the resources.
	As only the resources selected are included in the boot-file, you can have a larger set of resources during development (e.g., for test-code) and use only the main resources for the boot-file.
	The name of the boot-file will be a combination of system and device name dot fboot.
	Before using it you need to rename it to forte.fboot.</p>

	<!--********************************************************************************************-->

	<h1>Where to go from here?</h1>

	<p>The last step is optional, and shows some advanced features of 4diac IDE that you might use in more complicated applications.</p>

	<p><a href="../../html/4diacIDE/advancedFeatures.html">Step 6 - Advanced Features</a></p>

	<p>If you want to see some examples, the following link is an index of the available examples in the documentation:</p>

	<p><a href="../../html/examples/examplesIndex.html">4diac Examples</a></p>

	<p>If you have a specific platform that has input and outputs that is supported by FORTE, for example a Raspberry Pi or a PLC, and you want to use them, go to following page:</p>

	<p><a href="../../html/parameters/parameters.html">Parameters for Different Platforms</a></p>

	<p>If you want to use a specific communication protocol supported by 4diac FORTE, for example MQTT, OPC UA, Modbus and so on, go to this page:</p>

	<p><a href="../../html/communication/communicationIndex.html">Supported Communication Protocols</a></p>

	<p>If you want to go back to see again how to create your own Function Blocks, here's a link:</p>

	<p><a href="../../html/4diacIDE/createOwnTypes.html">Step 4 - Create Your own Function Block Types</a></p>

	<p>If you want to go back to the Start Here page, we leave you here a fast access:</p>

	<p><a href="../../html/startHere/startHere.html">Where to Start</a></p>

	<p class="goToTop"><a href="#topOfPage">Go to top</a></p>

	</body>
	</html>