Differences

This shows you the differences between two versions of the page.

--- en:sw:01-mervis:creating-new-project-on-unipi11-hidden [2021/05/10 15:02]
avsetula
+++ en:sw:01-mervis:creating-new-project-on-unipi11-hidden [2021/09/10 13:07] (current)
avsetula [First project with Unipi 1.1/Lite]
@@ Line 1: / Line 1: @@
 <html><div class="version-switch">
   <a href="#first_project_with_unipi_11_lite"><div class="actual-version">IDE v2.4.0</div></a>
+  <a href="#first_project_with_unipi_11_lite"><div class="actual-version">IDE v2.3.0</div></a>
 </div></html>
 ====== First project with Unipi 1.1/Lite ======
@@ Line 21: / Line 22: @@
   - [[https://www.unipi.technology/2gb-prumyslova-microsd-pametova-karta-slc-p232|MicroSD card]] for the PLC
   - MicroSD->SD adapter or a microSD card reader with USB connector
-  - [[https://www.unipi.technology/napajeci-zdroj-pro-din-listu-5v-dc-2-4a-p65?categoryId=15|5 VDC / 2 A power supply]]
+  - [[https://www.unipi.technology/napajeci-zdroj-pro-din-listu-5v-dc-2-4a-p65?categoryId=15|5 V⎓ / 2 A power supply]]
-  - Downloaded archive with [[en:files:software:os-images:00-start#unipi_11_mervis_os|Mervis OS for Unipi 1.1/Lite]]
+  - Downloaded archive with [[en:hw:03-unipi11:download-image:01-mervis|Mervis OS for Unipi 1.1/Lite]]
-  - Computer with [[cs:files:software:mervis:00-start|Mervis IDE]] installed.
+  - Computer with [[en:files:software:mervis:00-start|Mervis IDE]] installed.
 {{ :files:img_breakline_2.png?nolink |}}
@@ Line 30: / Line 31: @@
   - [[en:sw:01-mervis:01-mervis-ide| Get to know Mervis IDE]]
   - [[en:sw:01-mervis:connecting-to-unipi-hidden| Connect the PLC to your computer]]
-  - [[en:sw:01-mervis:running-on-neuron-hidden#mervis_on_unipi_neuron_11| Deploy Mervis OS to the SD card]]
+  - [[en:sw:01-mervis:running-on-unipi11-hidden| Deploy Mervis OS to the SD card]]
   - Plug in the power supply and wait for at least a minute until the PLC's OS boots up.
 </WRAP>
@@ Line 44: / Line 45: @@
 {{ :en:sw:01-mervis:02_creating-new-project-on-unipi11_en.png?direct |}}
-/* FIXME - opravit následující EN text podle CZ verze:
+The second thing you need to specify when creating a solution is **Mode selection**. The mode determines the behaviour of the Mervis IDE during its use; **Simple Mode** pre-defines the whole core of the solution, i.e. defines basic programs, generates mapping of variables, etc. At the same time, however, this option will limit the selection of the programming method only to **Function Block Diagram (FBD)**. Simple mode is therefore especially suitable for beginners. For more experienced users, there is a **Full mode** from which you can switch to the Simple mode, but this step is irreversible. Full Mode does not create the initial project structure and the entire basic configuration is up to you.
-Druhou věcí, kterou je třeba při vytváření sestavy specifikovat, je **výběr režimu**. Režim určuje chování Mervis IDE -> **Zjednodušený mód** za Vás vytvoří celé jádro sestavy, tj. definuje základní programy, vygeneruje mapování proměnných apod. Zároveň Vám ale tato volba omezí výběr programovací metody pouze na **metodu funkčních bloků (FBD)**. Zjednodušený mód je proto vhodný především pro začátečníky. Pro zkušenější uživatele je určen **Plný mód** ze kteréhou se do zjednodušeného módu můžete přepnout, tento krok je však nevratný. Plný mód neprovádí automaticky nic a veškeré nastavení je proto zcela na Vás.
- */
-The second thing you need to specify when creating a solution is **mode selection**. Modes determine Mervis IDE's behaviour during its use; **Simple Mode** pre-defines the core of the solution, eg. defines the basic programs, generates variable mappings etc. The downside is you can use only the **Function Block Diagram (FBD)** programming method in this mode. Simple Mode is thus suitable, especially for beginners. More experienced users should opt for the **Full Mode**. It is not possible to switch between the modes. Full Mode does not do the initial creation of the project skeleton and the entire basic configuration is up to you.
-That said, it might be convenient (with the exception of some special cases) to create the solution's core automatically in **Simple Mode** and only then to switch to **Full Mode**.
+That said, it might be convenient (with the exception of some special cases) to create the solution's core automatically in a **Simple Mode** and only then to switch to **Full Mode**.
 {{ :en:sw:01-mervis:03_creating-new-project-on-unipi11_en.png?direct |}}
@@ Line 59: / Line 57: @@
 {{ :en:sw:01-mervis:04_creating-new-project-on-unipi11_en.png?direct |}}
 The **Attach Controller** dialogue will appear, in which we can specify, how the Mervis IDE should connect to the controller. If the PLC is in the same LAN network, you can use the **UDP Broadcast** and then click on **Next >**.
 {{ :en:sw:01-mervis:05_creating-new-project-on-unipi11_en.png?direct |}}
-/* FIXME - přeložit (tlačítko jsem přeložil)
+You will now be prompted to enter a username and password (SSCP access) to connect to the controller. The default setting is: **admin / rw**. Now leave and click **Next >**.
-Nyní se zobrazí výzva k vyplnění jména a hesla (SSCP přístup) pro připojení k jednotce. Výchozí údaje jsou: **admin / rw**. Nyní ponechcejte a klikněte na **Next >**.
 {{ :en:sw:01-mervis:06_creating-new-project-on-unipi11_en.png?direct |}}
-*/
 Next window will show a progress bar as the Mervis IDE is looking for controllers on all network cards your computer has.
@@ Line 73: / Line 69: @@
 {{ :en:sw:01-mervis:07_creating-new-project-on-unipi11_en.png?direct |}}
-After the searching is finished, you will be presented with the list of all detected controllers. The target controller has its name displayed in the **Platform** tab. This tutorial used Unipi 1.1 device - in your case, choose whatever controller you are using and click on **Next**.
+After the searching is finished, you will be presented with the list of all detected controllers. The target controller has its name displayed in the **Platform** tab. This tutorial used Unipi 1.1 device - in your case, choose whatever controller you are using and click on **Next >**.
 {{ :en:sw:01-mervis:08_creating-new-project-on-unipi11_en.png?direct |}}
@@ Line 85: / Line 81: @@
 The last dialogue of the controller attaching process asks you about configuration download. The configuration holds basic settings of the Unipi controller, such as IP address, usernames and passwords, connections to Mervis DB and Mervis Proxy and so on.
-/* FIXME - opravit následující překlad dle CZ textu:
+When assigning a new controller for the first time, we recommend that you always download the configuration.
-V případě prvního přiřazení nového kontroléru doporučujeme konfiguraci vždy stáhnout.
-*/
-We always recommend downloading the configuration during the initial attachment.
 {{ :en:sw:01-mervis:09_creating-new-project-on-unipi11_en.png?direct |}}
@@ Line 94: / Line 87: @@
 The controller has now connected.
-/* FIXME - nahradit následující text překladem CZ textu: (až po obrázek)
+Select the item **PLC** in the left panel, after selecting it the properties of the connected controller will be displayed in the right panel **Properties**. This property panel is crucial, since you are setting up the controller configuration there. The properties include, for example, network configuration, **security**, database connection, SSCP, proxy, etc.
-Označte v levém panelu položku **PLC**, po označení se v pravém panelu **Vlastnosti** zobrazí vlastnosti připojeného kontroléru. Tento panel vlastností je velice důležitý, nastavujete zde konfiguraci jednotky. Ve vlastnostech je např. nastavení síťových karet, **zabezpečení**, připojení k databázi, SSCP, proxy, aj.
-Po dvojtém poklepání na **PLC** se zase v **hlavním panelu** objeví záložka **PLC**, kde je dále možné nastavit např. definici uživatelů pro webové rozhraní (HMI), mapování programů a další nastavení.
+After double-clicking on **PLC**, the **PLC** tab will appear in the **main panel** again, where it is also possible to set e.g. user definitions for the web interface (HMI), program mapping and other settings.
-*/
-In the **left panel** in **Solution** a new **PLC** will appear. Double-click on it. In the **main panel** a **PLC** tab will be displayed and the PLCs properties will appear in the **Properties** panel.
 {{ :en:sw:01-mervis:10_creating-new-project-on-unipi11_en.png?direct |}}
@@ Line 109: / Line 99: @@
 ===== Connecting inputs/outputs =====
-In Mervis IDE you now have Unipi 1.1/Lite attached. Construction-wise, Unipi controllers consist of a computing module (Raspberry Pi in our case) and a circuit board with inputs and outputs. The board communicates with the computer using **Modbus TCP** and **I2C**. This is the reason why you need to set up **two** communication channels to control Unipi 1.1/1.1 Lite boards. The first channel is for controlling analog and digital I/Os via Modbus TCP protocol while the I2C channel controls relay outputs.
+In Mervis IDE you now have Unipi 1.1/Lite attached. Construction-wise, Unipi controllers consist of a computing module (Raspberry Pi in our case) and a circuit board with inputs and outputs. The board communicates with the computer using **Modbus TCP** and **I²C**. This is the reason why you need to set up **two** communication channels to control Unipi 1.1/1.1 Lite boards. The first channel is for controlling analog and digital I/Os via Modbus TCP protocol while the I²C channel controls relay outputs.
 Add two **communication channels** to the PLC. TO add a channel right-click on the **PLC** name and then click on **Add Channel**. Repeat for the second channel.
@@ Line 119: / Line 109: @@
 {{ :en:sw:01-mervis:12_creating-new-project-on-unipi11_en.png?direct |}}
-If you click on the first channel, its properties will appear in the right panel. The first item determines the channel's name; we recommend to give channels descriptive names - in this case, I2C will do.
+If you click on the first channel, its properties will appear in the right panel. The first item determines the channel's name; we recommend to give channels descriptive names - in this case, I²C will do.
-Click on **no protocol** and select **PlatformIO** from the list. By doing so more options will appear - all you need to do here is to make sure the **link protocol** is set to **I2C**.
+Click on **no protocol** and select **PlatformIO** from the list. By doing so more options will appear - all you need to do here is to make sure the **link protocol** is set to **I²C**.
 The first channel for relay outputs is already set.
@@ Line 135: / Line 125: @@
 With both channels configured we can now move to add individual devices. These device definitions **are different between Unipi 1.1 and Unipi 1.1 Lite**, making the correct selection of definition necessary.
-==== I2C ====
+==== I²C ====
-In the **left panel** right-click on the I2C channel. Select **Add Library Device** from the context menu.
+In the **left panel** right-click on the I²C channel. Select **Add Library Device** from the context menu.
 {{ :en:sw:01-mervis:15_creating-new-project-on-unipi11_en.png?direct |}}
-In the **Add Library Device** dialogue window you will see a list of devices. Find and expand the **Unipi (v1.1)** folder and move to the **I2C** subfolder. Select the suitable device definition accordingly (eg. **Analog-Inputs + Unipi1_Relays** for Unipi 1.1 and **Unipi1Lite_Relay** for Unipi 1.1 Lite). If you have the definition selected, click on the arrow icon {{:files:dialog_arrow_right.png?nolink|}} to add the controller into the list of the selected device. After that, you need only to confirm by clicking on OK.
+In the **Add Library Device** dialogue window you will see a list of devices. Find and expand the **Unipi (v1.1)** folder and move to the **I²C** subfolder. Select the suitable device definition accordingly (eg. **Analog-Inputs + Unipi1_Relays** for Unipi 1.1 and **Unipi1Lite_Relay** for Unipi 1.1 Lite). If you have the definition selected, click on the arrow icon {{:files:dialog_arrow_right.png?nolink|}} to add the controller into the list of the selected device. After that, you need only to confirm by clicking on OK.
 {{ :en:sw:01-mervis:16_creating-new-project-on-unipi11_en.png?direct |}}
@@ Line 155: / Line 145: @@
 {{ :en:sw:01-mervis:18_creating-new-project-on-unipi11_en.png?direct |}}
-The new device will appear below the corresponding I2C / Modbus TCP channel.
+The new device will appear below the corresponding I²C / Modbus TCP channel.
 {{ :en:sw:01-mervis:19_creating-new-project-on-unipi11_en.png?direct |}}
@@ Line 161: / Line 151: @@
 ===== Switching to Full Mode =====
-/* FIXME - opravit překlad dle CZ textu od "However" ("Výhodou") po konec odstavce
+As you created the solution in **Simple Mode**, you do not have access to some Mervis IDE functions such as history logs. The advantage of creating a project in Simple mode is that you create the basic structure of the project, including the creation of the main program **main.program.fbd** and the assignment of this program to the PLC task, so it is not necessary to set everything manually. Another advantage is that all data points in device definitions (e.g. in modbus tables) have automatically generated global variables. This is especially useful when getting to know the Mervis IDE to make everything a little easier.
-Jelikož jste projekt vytvořili ve **Zjednodušeném módu**, nemáte nyní přístup ke všem funkcím v Mervis IDE, například k ukládání záznamů historie proměnných. Výhodou vytváření projektu ve Zjednodušeném módu však je, že se vytvoří základní kostra projektu, včetně vytvoření hlavního programu **main.program.fbd** a přiřazení tohoto programu do tasku PLC, není tedy nutné vše nastavovat manuálně. Další výhodou je, že veškeré datové body v definicích zařízení (např. v modbus tabulkách) mají automaticky generovány globální proměnné. To je užitečné hlavně při seznamování s Mervis IDE, aby vše bylo o něco jednodušší.
-*/
-As you created the solution in **Simple Mode**, you do not have access to some Mervis IDE functions such as history logs. However, Simple Mode guarantees that all data point created from this moment onwards will have automatically generated global variables including definitions of input/output devices specified in the previous steps. Another advantage is the automatic creation of the **main.program.fbd** and its assignment to the PLC's task.
 With everything required configured, you can switch the solution to **Full Mode**.
@@ Line 176: / Line 163: @@
 {{ :en:sw:01-mervis:21_creating-new-project-on-unipi11_en.png?direct |}}
-The result is you now have access to other functions. The most visible change occurred in the left panel - at its bottom, the **History log** item appeared. **Executable Projects** now also displays **Globals** folder containing **generated.Mixed.st** file. This file contains variable definitions, in our case automatically generated by the Simple Mode. Don't delete, move or edit this file, its editing and creation are performed automatically. Autogen serves for automatic generation of variables from data points and can be applied to an entire device containing multiple data points, groups etc. [[autogen-hidden|More about Autogen here]].
+The result is you now have access to other functions. The most visible change occurred in the left panel - at its bottom, the **History log** item appeared. **Executable Projects** now also displays **generated.Mixed.st** file. This file contains variable definitions, in our case automatically generated by the Simple Mode. Don't delete, move or edit this file, its editing and creation are performed automatically. Autogen serves for automatic generation of variables from data points and can be applied to an entire device containing multiple data points, groups etc.
+<WRAP center round info 90%>
+[[autogen-hidden|More about Autogen here]].
+</WRAP>
 {{ :en:sw:01-mervis:22_creating-new-project-on-unipi11_en.png?direct |}}
-===== Building and uploading the solution (project) =====
+===== Building and Deploying the solution (project) =====
 ==== Solution building ====
@@ Line 199: / Line 190: @@
 ==== Deploying the solution ====
-/* FIXME - upravit překlad dle nové CZ verze textu:
+**Deploying a solution means:** compiling and then uploading the created binary file to the controller and running it in **Full run**. Click **Deploy Solution** on **upper ribbon** to deploy the solution.
-Nahrání sestavy znamená kompilaci a následné nahrání vytvořeného binárního souboru do kontroléru a spuštění v **Full run**. Pro nahrání sestavy klikněte na **Deploy Solution** na **upper ribbon**.
-*/
-Deploying the solution marks the process of uploading the compiled binary file into the controller and starting it in **Full run**. To deploy the solution click on **Deploy Solution** on the **upper ribbon**.
 {{ :en:sw:01-mervis:26_creating-new-project-on-unipi11_en.png?direct |}}
@@ Line 210: / Line 198: @@
 {{ :en:sw:01-mervis:27_creating-new-project-on-unipi11_en.png?direct |}}
-/* FIXME - upravit překlad dle nové CZ verze textu:
+The last step in deploying a solution is to set a new controller status. There are multiple options, but for the purposes of this tutorial, leave the default options and click **OK**.
-Posledním krokem nahrání sestavy je nastavit nový stav kontroléru. Máte zde několik možností, pro účely tohoto návodu ale ponechte výchozí nastavené možnosti a klikněte na **OK**.
-*/
-The last step of uploading the solution is to set a new state for the controller. There are multiple options; for this tutorial, keep only **Warm restart**, **Full Run** and **Memory Area 1+2**. Confirm by clicking on **OK**.
 {{ :en:sw:01-mervis:28_creating-new-project-on-unipi11_en.png?direct |}}
@@ Line 236: / Line 221: @@
 {{ :en:sw:01-mervis:32_creating-new-project-on-unipi11_en.png?direct |}}
-/* FIXME - zkontrolovat následující EN text dle CZ verze, liší se hlavně konec:
+For the demonstration and testing purposes you can create a simple logic for switching the above-mentioned **Relay1**. The entire logic will consist of predefined **function blocks (FB)** available in Mervis libraries. Each FB is designed for one specific function and consists of inputs, internal logic and outputs. The values on the inputs are processed by the internal logic and it then projects the result on the outputs, which can be connected to the inputs of other FBs or to the hardware outputs.
-Nyní pro ukázku a otestování můžete vytvořit jednoduchou logiku spínající právě výstup **Relay1**. Celá logika bude vytvářena z již předpřipravených **funkčních bloků (FB)**, které jsou obsaženy v knihovnách Mervis. Každý FB je navržen pro určitou specifickou funkci a je tvořen vstupy, vnitřní logiku a výstupy. Hodnoty na vstupech zpracovává vnitřní logika a ta následně promítá výsledek na výstupech, které dále můžete připojit na vstupy jiných FB, či k hardwarovým výstupům.
-*/
-For demonstration and testing purposes you can create a simple logic for switching the above-mentioned **Relay1**. The entire logic will consist of predefined **function blocks (FB)** available in Mervis libraries. Each FB is designed for one specific function and contains an internal logic, its inputs to provide input data and outputs that can be connected to other FBs or hardware outputs.
 Click on **FUPLA Box Explorer** - you can find it among tabs at the left panel's bottom edge.
@@ Line 253: / Line 235: @@
 {{ :en:sw:01-mervis:35_creating-new-project-on-unipi11_en.png?direct |}}
-/* FIXME - opravit první větu odstavce dle CZ textu:
+The **BD2 Pulse Generator** block contains simple logic - by default, the **Out** output periodically switches between ''True'' and ''False'' every second. Let's take a closer look at its inputs. **Enable** input and outputs **Out** and **OutN** are visible on the FB itself. However, if you double-click the block it will change its colour to yellow - an indication of selection. The **Properties** panel will then display a complete list of inputs and outputs. As you can see there are many more inputs than those visible in the main window, as most of the inputs/outputs are hidden by default. Visibility of the individual inputs/outputs can be toggled by the **Visible** property. As we need only the pulse generator's **Out** output, un-check the **Visible** box for all inputs/outputs except **Out**. Bear in mind Mervis IDE does not allow any unconnected inputs in the **logic section** and any attempt to build such a solution will fail. The last step is to set 5s interval for **Ttrue** and **Tfalse** - that will ensure the relay will switch open/close every 5 seconds.
-Blok **BD2 Pulse Generator** obsahuje jednoduchou logiku - ve výchozím nastavení výstup **Out** každou vteřinu periodicky přepíná  mezi ''True'' a ''False''.
-*/
-The **BD2 Pulse Generator** contains a simple logic - by default the block periodically alternates the **Out** output between ''True'' and ''False'' at 1 Hz frequency. Let's take a closer look at its inputs. **Enable** input and outputs **Out** and **OutN** are visible on the FB itself. However, if you double-click the block it will change its colour to yellow - an indication of selection. The **Properties** panel will then display a complete list of inputs and outputs. As you can see there are many more inputs than those visible in the main window, as most of the inputs/outputs are hidden by default. Visibility of the individual inputs/outputs can be toggled by the **Visible** property. As we need only the pulse generator's **Out** output, un-check the **Visible** box for all inputs/outputs except **Out**. Bear in mind Mervis IDE does not allow any unconnected inputs in the **logic section** and any attempt to build such a solution will fail. The last step is to set 5s interval for **Ttrue** and **Tfalse** - that will ensure the relay will switch open/close every 5 seconds.
 //**Note:**: you can display additional info about any block by selecting it and pressing F1 to open the help page for the block.//
@@ Line 262: / Line 241: @@
 {{ :en:sw:01-mervis:36_creating-new-project-on-unipi11_en.png?direct |}}
-You now need to connect the pulse generator's output to Relay1 input. Right-click on **input section** to display a context menu, move the cursor over **Global Variables** and from the submenu choose **Insert existing variable**.
+You now need to connect the pulse generator's output to **Relay1** input. Right-click on **input section** to display a context menu, move the cursor over **Global Variables** and from the submenu choose **Insert existing variable**.
 {{ :en:sw:01-mervis:37_creating-new-project-on-unipi11_en.png?direct |}}
-In the Insert existing variables, a list of all available variables, inputs and outputs of your controller will be displayed. If the list is nearly empty, you probably did not use Autogen to define variables available for your PLC. In that case, right-click on devices in both I2C and Modbus TCP channels and click on **Set autogen** in the context menu.
+In the **Insert existing variable**, a list of all available variables, inputs and outputs of your controller will be displayed. If the list is nearly empty, you probably did not use Autogen to define variables available for your PLC. In that case, right-click on devices in both I²C and Modbus TCP channels and click on **Set autogen** in the context menu.
 If you followed the guide closely, Simple Mode already generated all variables for the program.
@@ Line 280: / Line 259: @@
 {{ :en:sw:01-mervis:38_creating-new-project-on-unipi11_en.png?direct |}}
-/* FIXME - opravit následující text podle CZ varianty:
+The output variable appears in the **output section** at the marked location. Now it is necessary to connect the output of the function block of the pulse generator with the variable **Relay1**. Move the cursor to the black dot next to the **Out** output name of the pulse generator block. A small box will appear containing information about the type of output.
-Výstupní proměnná se objeví v **sekci výstupů** na označené místo. Nyní je třeba propojit výstup funkčního bloku generátoru pulzů s proměnnou **Relay1**. Přemistěte kurzor na černou tečku vedle jména výstupu **Out** bloku generátoru pulzů. Objeví se malý box obsahující údaje o typu výstupu.
-*/
-The output variable will appear in the **output section** in the location we right-clicked on previously. We now need to **connect** the **Relay1** output variable and the pulse generator's output. Move your cursor over the small black dot next to the **Out** name on the pulse generator. A small box will appear containing info about the output's type.
 {{ :en:sw:01-mervis:39_creating-new-project-on-unipi11_en.png?direct |}}
@@ Line 291: / Line 267: @@
 {{ :en:sw:01-mervis:40_creating-new-project-on-unipi11_en.png?direct |}}
-You can now try to **build the solution** - see [[#building_and_uploading_the_solution_project|Building and uploading the solution]]. If you did everything right, a **Build succeeded** message will appear in the **status bar**. **Warning** messages displayed in the **Results** tab can be safely ignored.
+Now you can **Build Solution** - see [[#building_and_uploading_the_solution_project|Building and uploading the solution]]. If you did everything right, a **Build succeeded** message will appear in the **status bar**. **Warning** messages displayed in the **Results** tab can be safely ignored.
 If the build succeeded and you followed the instructions above correctly, you can **upload** the solution into the controller - see [[#building_and_uploading_the_solution_project|Building and uploading the solution]].
-Upon uploading the solution the Relay1 relay output will be switched every 5 seconds.
+Upon deploying the solution the relay output **Relay1** will be switched every 5 seconds.
 ----