Skip to content

[PC-1252] PLC IDE: Arduino PLC IDE Setup and Board's License Activation Tutorial Heading Patch #1049

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
May 18, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -28,40 +28,40 @@ 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))
- 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. 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.

***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

![Arduino IDE Download page](assets/IdeDownloadPage.png)

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.

Expand All @@ -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)

Expand All @@ -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)

Expand Down Expand Up @@ -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:

Expand All @@ -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)**
Expand All @@ -166,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)

Expand Down