From 7381d0137a35400457cc54e3952ebece62c4b782 Mon Sep 17 00:00:00 2001 From: TaddyHC Date: Mon, 15 May 2023 17:43:19 -0600 Subject: [PATCH 1/5] Initial commit - PLC IDE License Tutorial initial patch test --- .../plc-ide-setup-license/content.md | 31 ++++++++++--------- 1 file changed, 16 insertions(+), 15 deletions(-) diff --git a/content/hardware/05.pro-solutions/solutions-and-kits/portenta-machine-control/tutorials/plc-ide-setup-license/content.md b/content/hardware/05.pro-solutions/solutions-and-kits/portenta-machine-control/tutorials/plc-ide-setup-license/content.md index f6d7a081e6..db7181aef3 100644 --- a/content/hardware/05.pro-solutions/solutions-and-kits/portenta-machine-control/tutorials/plc-ide-setup-license/content.md +++ b/content/hardware/05.pro-solutions/solutions-and-kits/portenta-machine-control/tutorials/plc-ide-setup-license/content.md @@ -1,11 +1,11 @@ --- beta: true -title: Arduino PLC IDE Setup and Board's License Activation +title: Arduino® PLC IDE Setup and Board's License Activation difficulty: beginner tags: - PLC - PLC-IDE -description: Set up the PLC IDE, connect the board and activate its license. +description: Set up the PLC IDE, connect the board, and activate its license. author: 'Pablo Marquínez' hardware: - hardware/05.pro-solutions/solutions-and-kits/portenta-machine-control @@ -30,13 +30,13 @@ The **Arduino PLC IDE** offers the possibility to use **IEC IEC61131-3** program ### Required Hardware and Software -- Board compatible with the Arduino PLC IDE (Portenta Machine Control or Opta) -- Arduino PLC IDE ([Official Website](https://www.arduino.cc/pro/software-plc-ide)) -- If you have a Portenta Machine Control, you will need a unique PLC IDE License key for your device (https://store.arduino.cc/products/plc-key-portenta-machine-control) +- Board compatible with the Arduino PLC IDE (Portenta Machine Control or Opta). +- Arduino PLC IDE ([Official Website](https://www.arduino.cc/pro/software-plc-ide)). +- If you have a Portenta Machine Control, you will need a unique PLC IDE License key for your device (https://store.arduino.cc/products/plc-key-portenta-machine-control). - If you have an Opta, you do not need any license key to activate your product. Go to section __License Activation With Pre-Licensed Products (Opta)__ to know more. - [Arduino IDE 1.8.10+](https://www.arduino.cc/en/software), [Arduino IDE 2](https://www.arduino.cc/en/software), [Arduino Web Editor](https://create.arduino.cc/editor) or any program with a serial monitor in case you need to retrieve the _Hardware-ID_ of your device. -***To get the Arduino PLC IDE and the PLC IDE License for your device, please visit the [Arduino software page](https://www.arduino.cc/en/software) and the [store page](https://store.arduino.cc/plc-key-portenta-machine-control)*** +***To get the Arduino PLC IDE and the PLC IDE License for your device, please visit the [Arduino software page](https://www.arduino.cc/en/software) and the [store page](https://store.arduino.cc/plc-key-portenta-machine-control).*** ## Instructions @@ -44,24 +44,24 @@ The **Arduino PLC IDE** offers the possibility to use **IEC IEC61131-3** program To use the Arduino PLC IDE software, go to the [Arduino PLC IDE official website](https://www.arduino.cc/pro/software-plc-ide) and click on the download button. Download the following two executables: - * The Arduino PLC IDE Tools - * The Arduino PLC IDE +* The Arduino PLC IDE Tools +* The Arduino PLC IDE The first one will install all the required drivers, libraries and cores that you are going to need, while the second one will install the IDE software. -### 1. Arduino PLC IDE Tools +### 1. Arduino® PLC IDE Tools Before installing the Arduino PLC IDE you need to install all the required tools to make it work on your computer. Once you have downloaded the Arduino PLC IDE Tools executable, double-click on it and follow the installation instructions. Once the installation is finished, all the required drivers, libraries and Arduino cores will be installed and ready to be used. Your computer is now ready to install the Arduino PLC IDE. -***It is possible that during the installation some windows terminals will be opened and closed by the installation program. Do not worry about it, those windows are required by the program to install all the tools that your computer needs*** +***It is possible that during the installation some windows terminals will be opened and closed by the installation program. Do not worry about it, those windows are required by the program to install all the tools that your computer needs.*** -### 2. Arduino PLC IDE Installation +### 2. Arduino® PLC IDE Installation Once the Arduino PLC IDE Tools are installed, double-click on the executable of the Arduino Pro IDE that you downloaded. Follow the installation instructions and, once the process is done, click on finish. -***In case you have any problem, perform a reboot to be sure that all the drivers, libraries and dependencies are working and up to date.*** +***In case you have any problem, perform a reboot to be sure that all the drivers, libraries, and dependencies are working and up to date.*** Open the Arduino PLC IDE program to see the welcome screen. @@ -85,7 +85,7 @@ Plug your device to the computer, select the Serial Port of your board and click ***The device will show up two Serial Ports, the default one (generally with the lowest number) is the usual Serial Port, the secondary one (usually with the highest number) is a virtual port for Modbus communication from the device to your computer. Take note of the port number assigned to the secondary port (virtual port for Modbus) as it will be needed in a second step.*** -If during the download procedure the following message appears, double-tap the reset button using the tip of a pen or a similar pointed object. The led above the reset button will start blinking indicating that the Opta is ready to be flashed with a new firmware. Click the **Download** button to start the process again. +If during the download procedure the following message appears, double-tap the reset button using the tip of a pen or a similar pointed object. The led above the reset button will start blinking indicating that the Opta is ready to be flashed with a new firmware. Click the **Download** button to start the process again. ![Download error message](assets/downloadSketchError.png) @@ -103,7 +103,7 @@ Make sure the Modbus protocol is using the secondary Serial port number, the Mod ![Setting up the Modbus protocol](assets/onlineSetupProperties.png) -Click OK to save the settings and press the connect button on **On-line > connect**. +Click OK to save the settings and press the connect button on **On-line > Connect**. ![Connect to the board](assets/connect.png) @@ -133,7 +133,7 @@ Follow the instructions provided using our Contact [form](https://www.arduino.cc Once you receive the **Activation file**, drag and drop the file in the dashed rectangle or select it from the folder where it is stored to complete your Offline Activation. -### 7. License Activation with Pre-Licensed Products (Opta) +### 7. License Activation with Pre-Licensed Products (Opta™) When a product is **Pre-licensed**, the following scenario will be displayed: @@ -158,6 +158,7 @@ The IDE will then connect to a server, validate the hardware and recover the act ### 9. Getting the Hardware-ID of Your Device To do it follow the next steps: + - Be sure that your device is disconnected from the Arduino PLC IDE - Open the **Arduino IDE** software - Go to **Tools** > **Board** > **Arduino Mbed OS Portenta Boards** > **Arduino Portenta H7 (M7 Core)** From 4f626930694a3936ae609b8c599747c05e108cbd Mon Sep 17 00:00:00 2001 From: TaddyHC Date: Mon, 15 May 2023 18:26:38 -0600 Subject: [PATCH 2/5] Tutorial content update --- .../tutorials/plc-ide-setup-license/content.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/content/hardware/05.pro-solutions/solutions-and-kits/portenta-machine-control/tutorials/plc-ide-setup-license/content.md b/content/hardware/05.pro-solutions/solutions-and-kits/portenta-machine-control/tutorials/plc-ide-setup-license/content.md index db7181aef3..e6ce1a0356 100644 --- a/content/hardware/05.pro-solutions/solutions-and-kits/portenta-machine-control/tutorials/plc-ide-setup-license/content.md +++ b/content/hardware/05.pro-solutions/solutions-and-kits/portenta-machine-control/tutorials/plc-ide-setup-license/content.md @@ -28,7 +28,7 @@ The **Arduino PLC IDE** offers the possibility to use **IEC IEC61131-3** program - Activate the device license - Test the connection -### Required Hardware and Software +## Required Hardware and Software - Board compatible with the Arduino PLC IDE (Portenta Machine Control or Opta). - Arduino PLC IDE ([Official Website](https://www.arduino.cc/pro/software-plc-ide)). @@ -167,7 +167,9 @@ To do it follow the next steps: ### 10. Download a Program -Let's download and run the first program on your device. We are going to use the default program that is included in a project: a counter. Double-click on the file _main_ inside the _Project_ to see the counter program. To download that program to your PLC, it is needed to compile the program and send it to the target device. +Let's download and run the first program on your device. We are going to use the default program that is included in a project: a counter. + +Double-click on the file _main_ inside the _Project_ to see the counter program. To download that program to your PLC, it is needed to compile the program and send it to the target device. ![Send the program to the device (download)](assets/downloadCode.png) From 2152076937b040ed824855bcbdc8b11370461952 Mon Sep 17 00:00:00 2001 From: TaddyHC Date: Tue, 16 May 2023 17:04:26 -0600 Subject: [PATCH 3/5] Tutorial content feature test --- .../plc-ide-setup-license/content.md | 22 +++++++++---------- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/content/hardware/05.pro-solutions/solutions-and-kits/portenta-machine-control/tutorials/plc-ide-setup-license/content.md b/content/hardware/05.pro-solutions/solutions-and-kits/portenta-machine-control/tutorials/plc-ide-setup-license/content.md index e6ce1a0356..5f11eda58e 100644 --- a/content/hardware/05.pro-solutions/solutions-and-kits/portenta-machine-control/tutorials/plc-ide-setup-license/content.md +++ b/content/hardware/05.pro-solutions/solutions-and-kits/portenta-machine-control/tutorials/plc-ide-setup-license/content.md @@ -49,7 +49,7 @@ To use the Arduino PLC IDE software, go to the [Arduino PLC IDE official website The first one will install all the required drivers, libraries and cores that you are going to need, while the second one will install the IDE software. -### 1. Arduino® PLC IDE Tools +### Arduino® PLC IDE Tools Before installing the Arduino PLC IDE you need to install all the required tools to make it work on your computer. Once you have downloaded the Arduino PLC IDE Tools executable, double-click on it and follow the installation instructions. @@ -57,7 +57,7 @@ Once the installation is finished, all the required drivers, libraries and Ardui ***It is possible that during the installation some windows terminals will be opened and closed by the installation program. Do not worry about it, those windows are required by the program to install all the tools that your computer needs.*** -### 2. Arduino® PLC IDE Installation +### Arduino® PLC IDE Installation Once the Arduino PLC IDE Tools are installed, double-click on the executable of the Arduino Pro IDE that you downloaded. Follow the installation instructions and, once the process is done, click on finish. @@ -67,7 +67,7 @@ Open the Arduino PLC IDE program to see the welcome screen. ![Welcome screen](assets/welcome.png) -### 3. Project Setup +### Project Setup Create a new project by clicking the middle **New project ...** button or **File > New Project** @@ -77,7 +77,7 @@ After creating the project, there are some new windows on the screen, click on t ![Board configuration page](assets/projectWelcome.png) -### 4. Download the Runtime +### Download the Runtime The board needs to run a specific program (runtime) in order to interact with the **PLC IDE**. Go to the **"Other"** section below the **"Device Info"** block. @@ -89,7 +89,7 @@ If during the download procedure the following message appears, double-tap the r ![Download error message](assets/downloadSketchError.png) -### 5. Connect to the Device +### Connect to the Device After the runtime is up and running, set up the communication by going to **On-line > Set up communication**. @@ -107,7 +107,7 @@ Click OK to save the settings and press the connect button on **On-line > Connec ![Connect to the board](assets/connect.png) -### 6. License Activation with Product Key (Portenta Machine Control) +### License Activation with Product Key (Portenta Machine Control) If the communication is successful the main panel will show the license section to be filled in and a status indicator. @@ -133,7 +133,7 @@ Follow the instructions provided using our Contact [form](https://www.arduino.cc Once you receive the **Activation file**, drag and drop the file in the dashed rectangle or select it from the folder where it is stored to complete your Offline Activation. -### 7. License Activation with Pre-Licensed Products (Opta™) +### License Activation with Pre-Licensed Products (Opta™) When a product is **Pre-licensed**, the following scenario will be displayed: @@ -145,7 +145,7 @@ By clicking the **Activate PLC Runtime** button, the product activation will be Now the product is ready to be used with the PLC IDE. -### 8. Activation Recovery +### Activation Recovery In case the hardware is being reflashed and the key got lost, the license can be recovered just by clicking the "**Forgot your Product Key?**" button: @@ -155,7 +155,7 @@ The IDE will then connect to a server, validate the hardware and recover the act ![Online Activation Forgotten Key Activated](assets/activation-online_resized.png) -### 9. Getting the Hardware-ID of Your Device +### Getting the Hardware-ID of Your Device To do it follow the next steps: @@ -165,7 +165,7 @@ To do it follow the next steps: - Go to **Tools** > **Port** to select the proper port (the default one shown before in the PLC IDE inside the **Arduino PMC Configuration** > **Other** section) - Go to **Tools** > **Serial Monitor** and reset the board. Look at the end of the boot report to find the "Hardware-ID" and store it in a safe place. -### 10. Download a Program +### Download a Program Let's download and run the first program on your device. We are going to use the default program that is included in a project: a counter. @@ -173,7 +173,7 @@ Double-click on the file _main_ inside the _Project_ to see the counter program. ![Send the program to the device (download)](assets/downloadCode.png) -### 11. Communication Test +### Communication Test Open the **Watch** window by clicking on "View > Tool Windows > Watch", it will attach a new window on the right side called **Watch**. This window shows the real-time variables value. From d9056c14d5d1046c5eb141145439159832675c1b Mon Sep 17 00:00:00 2001 From: TaddyHC Date: Tue, 16 May 2023 17:26:30 -0600 Subject: [PATCH 4/5] Tutorial content feature patch --- .../plc-ide-setup-license/content.md | 24 +++++++++---------- 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/content/hardware/05.pro-solutions/solutions-and-kits/portenta-machine-control/tutorials/plc-ide-setup-license/content.md b/content/hardware/05.pro-solutions/solutions-and-kits/portenta-machine-control/tutorials/plc-ide-setup-license/content.md index 5f11eda58e..d7b757fbf4 100644 --- a/content/hardware/05.pro-solutions/solutions-and-kits/portenta-machine-control/tutorials/plc-ide-setup-license/content.md +++ b/content/hardware/05.pro-solutions/solutions-and-kits/portenta-machine-control/tutorials/plc-ide-setup-license/content.md @@ -32,7 +32,7 @@ The **Arduino PLC IDE** offers the possibility to use **IEC IEC61131-3** program - Board compatible with the Arduino PLC IDE (Portenta Machine Control or Opta). - Arduino PLC IDE ([Official Website](https://www.arduino.cc/pro/software-plc-ide)). -- If you have a Portenta Machine Control, you will need a unique PLC IDE License key for your device (https://store.arduino.cc/products/plc-key-portenta-machine-control). +- If you have a Portenta Machine Control, you will need a unique PLC IDE License key for your device. Get your license key [here](https://store.arduino.cc/products/plc-key-portenta-machine-control). - If you have an Opta, you do not need any license key to activate your product. Go to section __License Activation With Pre-Licensed Products (Opta)__ to know more. - [Arduino IDE 1.8.10+](https://www.arduino.cc/en/software), [Arduino IDE 2](https://www.arduino.cc/en/software), [Arduino Web Editor](https://create.arduino.cc/editor) or any program with a serial monitor in case you need to retrieve the _Hardware-ID_ of your device. @@ -49,7 +49,7 @@ To use the Arduino PLC IDE software, go to the [Arduino PLC IDE official website The first one will install all the required drivers, libraries and cores that you are going to need, while the second one will install the IDE software. -### Arduino® PLC IDE Tools +### 1. Arduino® PLC IDE Tools Before installing the Arduino PLC IDE you need to install all the required tools to make it work on your computer. Once you have downloaded the Arduino PLC IDE Tools executable, double-click on it and follow the installation instructions. @@ -57,7 +57,7 @@ Once the installation is finished, all the required drivers, libraries and Ardui ***It is possible that during the installation some windows terminals will be opened and closed by the installation program. Do not worry about it, those windows are required by the program to install all the tools that your computer needs.*** -### Arduino® PLC IDE Installation +### 2. Arduino® PLC IDE Installation Once the Arduino PLC IDE Tools are installed, double-click on the executable of the Arduino Pro IDE that you downloaded. Follow the installation instructions and, once the process is done, click on finish. @@ -67,7 +67,7 @@ Open the Arduino PLC IDE program to see the welcome screen. ![Welcome screen](assets/welcome.png) -### Project Setup +### 3. Project Setup Create a new project by clicking the middle **New project ...** button or **File > New Project** @@ -77,7 +77,7 @@ After creating the project, there are some new windows on the screen, click on t ![Board configuration page](assets/projectWelcome.png) -### Download the Runtime +### 4. Download the Runtime The board needs to run a specific program (runtime) in order to interact with the **PLC IDE**. Go to the **"Other"** section below the **"Device Info"** block. @@ -89,7 +89,7 @@ If during the download procedure the following message appears, double-tap the r ![Download error message](assets/downloadSketchError.png) -### Connect to the Device +### 5. Connect to the Device After the runtime is up and running, set up the communication by going to **On-line > Set up communication**. @@ -107,7 +107,7 @@ Click OK to save the settings and press the connect button on **On-line > Connec ![Connect to the board](assets/connect.png) -### License Activation with Product Key (Portenta Machine Control) +### 6. License Activation with Product Key (Portenta Machine Control) If the communication is successful the main panel will show the license section to be filled in and a status indicator. @@ -133,7 +133,7 @@ Follow the instructions provided using our Contact [form](https://www.arduino.cc Once you receive the **Activation file**, drag and drop the file in the dashed rectangle or select it from the folder where it is stored to complete your Offline Activation. -### License Activation with Pre-Licensed Products (Opta™) +### 7. License Activation with Pre-Licensed Products (Opta™) When a product is **Pre-licensed**, the following scenario will be displayed: @@ -145,7 +145,7 @@ By clicking the **Activate PLC Runtime** button, the product activation will be Now the product is ready to be used with the PLC IDE. -### Activation Recovery +### 8. Activation Recovery In case the hardware is being reflashed and the key got lost, the license can be recovered just by clicking the "**Forgot your Product Key?**" button: @@ -155,7 +155,7 @@ The IDE will then connect to a server, validate the hardware and recover the act ![Online Activation Forgotten Key Activated](assets/activation-online_resized.png) -### Getting the Hardware-ID of Your Device +### 9. Getting the Hardware-ID of Your Device To do it follow the next steps: @@ -165,7 +165,7 @@ To do it follow the next steps: - Go to **Tools** > **Port** to select the proper port (the default one shown before in the PLC IDE inside the **Arduino PMC Configuration** > **Other** section) - Go to **Tools** > **Serial Monitor** and reset the board. Look at the end of the boot report to find the "Hardware-ID" and store it in a safe place. -### Download a Program +### 10. Download the Program Let's download and run the first program on your device. We are going to use the default program that is included in a project: a counter. @@ -173,7 +173,7 @@ Double-click on the file _main_ inside the _Project_ to see the counter program. ![Send the program to the device (download)](assets/downloadCode.png) -### Communication Test +### 11. Communication Test Open the **Watch** window by clicking on "View > Tool Windows > Watch", it will attach a new window on the right side called **Watch**. This window shows the real-time variables value. From ca2628e247ced25629a060c1149540269bd61604 Mon Sep 17 00:00:00 2001 From: TaddyHC Date: Tue, 16 May 2023 18:13:22 -0600 Subject: [PATCH 5/5] Tutorial content feature test minor detail revert --- .../tutorials/plc-ide-setup-license/content.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/hardware/05.pro-solutions/solutions-and-kits/portenta-machine-control/tutorials/plc-ide-setup-license/content.md b/content/hardware/05.pro-solutions/solutions-and-kits/portenta-machine-control/tutorials/plc-ide-setup-license/content.md index d7b757fbf4..67d5f2cbcf 100644 --- a/content/hardware/05.pro-solutions/solutions-and-kits/portenta-machine-control/tutorials/plc-ide-setup-license/content.md +++ b/content/hardware/05.pro-solutions/solutions-and-kits/portenta-machine-control/tutorials/plc-ide-setup-license/content.md @@ -165,7 +165,7 @@ To do it follow the next steps: - Go to **Tools** > **Port** to select the proper port (the default one shown before in the PLC IDE inside the **Arduino PMC Configuration** > **Other** section) - Go to **Tools** > **Serial Monitor** and reset the board. Look at the end of the boot report to find the "Hardware-ID" and store it in a safe place. -### 10. Download the Program +### 10. Download a Program Let's download and run the first program on your device. We are going to use the default program that is included in a project: a counter.