This documentation is out of date.

The new version of the documentation is here: https://cannylogic.com/docs

Difference between revisions of "CANNY Lab"

From CANNY Wiki
Jump to: navigation, search
[unchecked revision][unchecked revision]
m (better wording)
 
(9 intermediate revisions by 2 users not shown)
Line 1: Line 1:
'''CANNY Lab''' — integrated software development environment for PLCs [[CANNY 7]].
+
'''CannyLab''' — integrated software development environment for PLCs [[CANNY 7]].
  
== Purpose of integrated development environment Canny Lab ==
+
== Purpose of integrated development environment CannyLab ==
  
IDE Canny Lab is a tool for application development using functional block diagram language - CFD. It is used to write, debug, and upload program to the internal memory of programmable logic controllers [[CANNY 7]].
+
IDE CannyLab is a tool for application development using function block diagram language - CFD. It is used to write, debug, and upload programs to the internal memory of programmable logic controllers [[CANNY 7]].
  
 
== Minimum system requirements for СannyLab operation ==
 
== Minimum system requirements for СannyLab operation ==
Line 33: Line 33:
 
== Installing and program launch ==
 
== Installing and program launch ==
  
Integrated Development Environment CannyLab is distributed in "portable" version. It does not require installation and can run from removable media. Download program archive from the website http://www.cannylogic.com/c7 and unzip it to a folder on your PC or an external drive. Run the file '''cannylab.exe''' from the program folder. It is not recommended to run multiple program instances.
+
Integrated Development Environment CannyLab is distributed as a "portable" version. It does not require installation and can be run from removable media. Download the program archive from the website http://www.cannylogic.com/c7 and unzip it to a folder on your PC or an external drive. Run the file '''cannylab.exe''' from the program folder. It is not recommended to run multiple program instances.
  
 
== The user interface ==
 
== The user interface ==
Line 57: Line 57:
 
Integrated Development Environment CannyLab supports three types of files:
 
Integrated Development Environment CannyLab supports three types of files:
  
* «cfd» functional diagram files;
+
* «cfd» function diagram files;
 
* «ccx» system software files;
 
* «ccx» system software files;
* «exe» executable files for standalone software upload to the controller without using CannyLab.
+
* «exe» standalone executable files for autonomous software upload to the controller without using CannyLab.
  
Functional diagram files and executable files for standalone software upload to the controller, can be created in CannyLab environment. System software files supplied by controller manufacturer and could be uploaded from CannyLab application or used during creation of standalone executable file.
+
Function diagram files and standalone executable files for software upload to the controller, can be created in the CannyLab environment. System software files are supplied by the controller manufacturer and can be uploaded directly to the controller from the CannyLab application or used during creation of a standalone executable file.
  
=== Creation of a new functional diagram file ===
+
=== Creating a new function diagram file ===
  
Create a new functional diagram file by selecting "File" → "New" in the main menu, with the hotkey «Ctrl+N», or by clicking [[File:4_5_1_1.png]] on the toolbar.
+
Create a new function diagram file by selecting "File" → "New" in the main menu, with the hotkey «Ctrl+N», or by clicking [[File:4_5_1_1.png]] on the toolbar.
  
Symbol "*" appears when making changes to the open file, at the end of the file name in the header of the main window. When there are changes in the open file at the time of exit from the editor or create a new functional diagram file, the user will be prompted to save the current file.
+
The symbol "*" appears at the end of the file name in the header of the main window if any changes were made to the currently open file. If there were any changes made to the file, the user will be prompted to save it upon exiting the editor or creating a new function diagram.
  
=== Saving the functional diagram file ===
+
=== Saving the function diagram file ===
  
Saving the functional diagram file with new name by selecting "File" → "Save as..." of the main menu, in this case the name of the saved file and the path to it is set in the pop-up dialog box.
+
Save the function diagram file under a new name by selecting "File" → "Save as..." in the main menu, in this case the name of the saved file and the path to it is set in the pop-up dialog box.
  
СSave the file under the same name by selecting "File" →  "Save" of the main menu, using hotkey «Ctrl+S» or by clicking button [[File:4_5_2_1.png]] on the toolbar.
+
Save the file under the same name by selecting "File" →  "Save" in the main menu, using the hotkey «Ctrl+S» or by clicking [[File:4_5_2_1.png]] on the toolbar.
  
If saving diagram will overwrite a file created in an earlier CannyLab version, a warning will show that the file will not be opened in previous versions CannyLab.
+
If the diagram being saved would overwrite a file created in an earlier CannyLab version, the user is presented with a warning stating that the file won’t be able to be opened in older versions of CannyLab.
  
=== Opening of the functional diagram file ===
+
=== Opening of the function diagram file ===
  
Opening a previously saved function diagram file, by selecting "File" → "Open..." on the main menu, hotkey «Ctrl+O» or button [[File:4_5_3_1.png]] on the toolbar.
+
Open an existing function diagram file, by selecting "File" → "Open..." in the main menu, using the hotkey «Ctrl+O» or by clicking [[File:4_5_3_1.png]] on the toolbar.
  
Alternately, the diagram file can be opened by dragging it into CannyLab open window.
+
Alternatively, the diagram file can be opened by dragging it into the CannyLab open window.
  
When opening file created in an earlier version of CannyLab, a warning message will be displayed. If the current version of CannyLab can not correctly display all the information contained in the legacy file format, a warning about this will be displayed.
+
The user is presented with a warning when they open a file created in an earlier version of CannyLab. An additional warning will appear if the current version of CannyLab can not correctly display all the information contained in the legacy file format.
  
== Functional Diagram Editor ==
+
== Function Diagram Editor ==
  
 
:''Main article'': '''[[CANNY Lab Functional Diagram Editor]]'''
 
:''Main article'': '''[[CANNY Lab Functional Diagram Editor]]'''
  
In the functional diagram editor mode, the user has the opportunity to:
+
The function diagram editor is the main method of working within CannyLab. In function diagram editor mode, the user can:
  
* Add function blocks to the diagram;
+
* add function blocks to the diagram;
 
* move function blocks within the diagram;
 
* move function blocks within the diagram;
 
* select and delete diagram elements;
 
* select and delete diagram elements;
* add connections to the  diagram between the functional blocks - networks;
+
* add connections between the function blocks to the diagram. These are called networks;
* add and edit names of the networks to the diagram;
+
* add and edit the names of networks on the diagram;
* merge, split and change networks configuration;
+
* merge, split and change the configuration of networks;
* change functional blocks numbering;
+
* change the numbering of function blocks;
* assign input data sources and recipients of function block output data, using constant and controller resources address.
+
* assign input data sources and output data recipients of function blocks by using constants and controller resource registers.
  
== CANNY Lab Simulator ==
+
== CannyLab Simulator ==
  
 
:''Main Article'': '''[[CANNY Lab Simulator]]'''
 
:''Main Article'': '''[[CANNY Lab Simulator]]'''
  
Working in the simulator mode, Canny Lab performs action to diagram data , equivalent to those to be carried with them by a computing controller kernel when running diagram on it, that allows to simulate the operation of the controller to the PC.
+
Working in simulator mode, CannyLab performs actions to diagram data that are equivalent to the compute actions that would be carried out on them by the controller kernel, which allows the user to simulate the operation of the controller on the PC.
  
User has the ability to run the simulation of executing the functional diagram for debugging and testing at any stage of its development. In the simulator mode, it is possible to cycling and stepping through diagram, setting the conditions for suspension, forced IO values setting of the function blocks, and control of intermediate values.
+
The user has the ability to simulate the execution of the function diagram for debugging and testing at any stage of its development. In simulator mode, it is possible to run the diagram on a per-cycle and per-step basis, set the conditions for suspension of execution, forcibly set the input and output values of the function blocks, control intermediate values.
  
 
{|
 
{|
Line 117: Line 117:
 
:''Main article'': '''[[Interaction with equipment]]'''
 
:''Main article'': '''[[Interaction with equipment]]'''
  
IDE CannyLab gives users the ability to upload system software to the controller, required to perform the functional diagram, as well as the functional diagram itself.
+
IDE CannyLab gives users the ability to upload system software to the controller. System software is required for execution of the function diagram, as well as the function diagram itself.
  
== Executable files autonomous loading of software into the controller ==
+
== Executable files for autonomously uploading software into the controller ==
  
 
:''Main article'': '''[[Firmware Update Utility]]'''
 
:''Main article'': '''[[Firmware Update Utility]]'''
  
IDE CannyLab allows users to create a custom autonomous executable EXE-files containing controller system software and function diagram.
+
IDE CannyLab allows users to create a custom standalone executable EXE-file containing controller system software and a function diagram.
  
This file is a fast configure of the controller in comprehensible to the final consumer form and a simple software upload to the controller using a computer with no CannyLab IDE installed on it. In future, such a file will be called: automatic loading software utility to the controller or the SFX-file.txt
+
The purpose of this file is quick and easy controller configuration in a fashion that’s comprehensible to the end user, as well as uploading software to the controller without relying on CannyLab IDE. From now on, we will refer to such files as firmware update utilities or SFX-files (SFX standing for self-flashing).

Latest revision as of 12:06, 11 December 2020

CannyLab — integrated software development environment for PLCs CANNY 7.

Purpose of integrated development environment CannyLab

IDE CannyLab is a tool for application development using function block diagram language - CFD. It is used to write, debug, and upload programs to the internal memory of programmable logic controllers CANNY 7.

Minimum system requirements for СannyLab operation

CPU type, CPU clock speed: Intel ® Pentium ® 233MHz or higher.
OS: Windows ® 2000, Windows XP ™, or higher.
RAM size: 128 MB (256 MB recommended).
Video adapter and monitor: SVGA or higher resolution monitor (1024x768 recommended).
Free disk space: 110 MB (150 МB recommended).
Input Devices: Keyboard, mouse.
USB: 1.1 or higher.

Installing and program launch

Integrated Development Environment CannyLab is distributed as a "portable" version. It does not require installation and can be run from removable media. Download the program archive from the website http://www.cannylogic.com/c7 and unzip it to a folder on your PC or an external drive. Run the file cannylab.exe from the program folder. It is not recommended to run multiple program instances.

The user interface

Main artcle: CANNY Lab Main window

CannyLab user interface consists of a single window - the main application window.

The main window is divided into several areas:

  • window title;
  • main menu;
  • toolbar;
  • function block panel;
  • workspace;
  • status bar.

Depending on the current operating mode of the editor, some of CannyLab menu items and panels may not be available or hidden.

4 4 1.png

Working with Files

Integrated Development Environment CannyLab supports three types of files:

  • «cfd» function diagram files;
  • «ccx» system software files;
  • «exe» standalone executable files for autonomous software upload to the controller without using CannyLab.

Function diagram files and standalone executable files for software upload to the controller, can be created in the CannyLab environment. System software files are supplied by the controller manufacturer and can be uploaded directly to the controller from the CannyLab application or used during creation of a standalone executable file.

Creating a new function diagram file

Create a new function diagram file by selecting "File" → "New" in the main menu, with the hotkey «Ctrl+N», or by clicking 4 5 1 1.png on the toolbar.

The symbol "*" appears at the end of the file name in the header of the main window if any changes were made to the currently open file. If there were any changes made to the file, the user will be prompted to save it upon exiting the editor or creating a new function diagram.

Saving the function diagram file

Save the function diagram file under a new name by selecting "File" → "Save as..." in the main menu, in this case the name of the saved file and the path to it is set in the pop-up dialog box.

Save the file under the same name by selecting "File" → "Save" in the main menu, using the hotkey «Ctrl+S» or by clicking 4 5 2 1.png on the toolbar.

If the diagram being saved would overwrite a file created in an earlier CannyLab version, the user is presented with a warning stating that the file won’t be able to be opened in older versions of CannyLab.

Opening of the function diagram file

Open an existing function diagram file, by selecting "File" → "Open..." in the main menu, using the hotkey «Ctrl+O» or by clicking 4 5 3 1.png on the toolbar.

Alternatively, the diagram file can be opened by dragging it into the CannyLab open window.

The user is presented with a warning when they open a file created in an earlier version of CannyLab. An additional warning will appear if the current version of CannyLab can not correctly display all the information contained in the legacy file format.

Function Diagram Editor

Main article: CANNY Lab Functional Diagram Editor

The function diagram editor is the main method of working within CannyLab. In function diagram editor mode, the user can:

  • add function blocks to the diagram;
  • move function blocks within the diagram;
  • select and delete diagram elements;
  • add connections between the function blocks to the diagram. These are called networks;
  • add and edit the names of networks on the diagram;
  • merge, split and change the configuration of networks;
  • change the numbering of function blocks;
  • assign input data sources and output data recipients of function blocks by using constants and controller resource registers.

CannyLab Simulator

Main Article: CANNY Lab Simulator

Working in simulator mode, CannyLab performs actions to diagram data that are equivalent to the compute actions that would be carried out on them by the controller kernel, which allows the user to simulate the operation of the controller on the PC.

The user has the ability to simulate the execution of the function diagram for debugging and testing at any stage of its development. In simulator mode, it is possible to run the diagram on a per-cycle and per-step basis, set the conditions for suspension of execution, forcibly set the input and output values of the function blocks, control intermediate values.

Note: Current CannyLab simulator version is not supporting controller hardware resources, so the reading results of addresses and write to the address in the simulator may differ from the results obtained during diagram execution by the controller.

Interaction with the controller

Main article: Interaction with equipment

IDE CannyLab gives users the ability to upload system software to the controller. System software is required for execution of the function diagram, as well as the function diagram itself.

Executable files for autonomously uploading software into the controller

Main article: Firmware Update Utility

IDE CannyLab allows users to create a custom standalone executable EXE-file containing controller system software and a function diagram.

The purpose of this file is quick and easy controller configuration in a fashion that’s comprehensible to the end user, as well as uploading software to the controller without relying on CannyLab IDE. From now on, we will refer to such files as firmware update utilities or SFX-files (SFX standing for self-flashing).