Skip to content
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

[PXCT-88] - PLC IDE User Manual #2425

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

ArduinoBot
Copy link
Collaborator

What This PR Changes

  • This is the PR for the PLC IDE User Manual.

Contribution Guidelines

@ArduinoBot ArduinoBot added documentation Improvements or additions to documentation arduino Bugs and fixes added by the Arduino Team labels Mar 10, 2025
@mcmchris mcmchris self-requested a review March 10, 2025 21:09
Copy link
Collaborator

@mcmchris mcmchris left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Review completed of the Partial User Manual commit.


Through this user manual, you will learn how to set up, configure and leverage the full potential of the Arduino PLC IDE, including its IDE, debugging tools and industrial communication capabilities. Whether you are new to PLC programming or an experienced automation engineer, this guide will help you master the Arduino PLC IDE's features, tools and capabilities.

![ ](assets/hero-banner.png)
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Check text spacing in the banner image and font maybe?

- Windows 10 or newer (64-bit)
- Administrator account privileges

***<strong>Important</strong>: Before installing the latest release of the PLC IDE, ensure that any previous versions (including the PLC IDE Tools) are completely uninstalled using Windows "Add or remove programs" tool. Additionally, delete the "T" folder located in C:\Users<your username>\AppData\Local\T.***
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
***<strong>Important</strong>: Before installing the latest release of the PLC IDE, ensure that any previous versions (including the PLC IDE Tools) are completely uninstalled using Windows "Add or remove programs" tool. Additionally, delete the "T" folder located in C:\Users<your username>\AppData\Local\T.***
***<strong>Important</strong>: Before installing the latest release of the PLC IDE, ensure that any previous versions (including the PLC IDE Tools) are completely uninstalled using Windows "Add or remove programs" tool. Additionally, delete the "T" folder located in C:\Users\your username\AppData\Local\T.***

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do not use these "<" ">" symbols if not for HTML formatting, it breaks everything. In this case was avoiding preview to work and local render.


#### Installation Process Troubleshooting

After installation, you can launch the PLC IDE to see the welcome screen. If you encounter any issues with the software, try these troubleshooting steps:
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
After installation, you can launch the PLC IDE to see the welcome screen. If you encounter any issues with the software, try these troubleshooting steps:
After the installation, you can launch the PLC IDE to see the welcome screen. If you encounter any issues with the software, try these troubleshooting steps:


### Opta™ Connection to your Computer

After installing the PLC IDE software, you can connect your Opta™ device to your computer. Connect your Opta™ device directly to your computer using a [USB-C® cable](https://store.arduino.cc/products/usb-cable2in1-type-c), preferably to a USB port on your computer rather than through a USB hub. If you are using an external power supply, verify it meets the specifications of +12-24 VDC/0.5 A before connecting it to your Opta™ device.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
After installing the PLC IDE software, you can connect your Opta™ device to your computer. Connect your Opta™ device directly to your computer using a [USB-C® cable](https://store.arduino.cc/products/usb-cable2in1-type-c), preferably to a USB port on your computer rather than through a USB hub. If you are using an external power supply, verify it meets the specifications of +12-24 VDC/0.5 A before connecting it to your Opta™ device.
After installing the PLC IDE software, you can connect your Opta™ device to your computer. Connect your Opta™ directly to your computer using a [USB-C® cable](https://store.arduino.cc/products/usb-cable2in1-type-c), preferably to a USB port on your computer rather than through a USB hub. If you are using an external power supply, verify it meets the specifications of +12-24 VDC/0.5 A before connecting it to your Opta™ device.


### Project Setup

After installing and configuring your PLC IDE, you can begin creating your first project. The PLC IDE provides an intuitive interface for project creation and configuration.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
After installing and configuring your PLC IDE, you can begin creating your first project. The PLC IDE provides an intuitive interface for project creation and configuration.
After installing and configuring your PLC IDE, you can create your first project. The PLC IDE provides an intuitive interface for project creation and configuration.


![](assets/resources_tab.png)

This configuration page provides access to essential board settings and parameters that you will need for your project development.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think that using "Device" instead of "Board" is more accurate.


Follow these steps to install the runtime program on your Opta™:

- Navigate to the board configuration page
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think that using "Device" instead of "Board" is more accurate.


The default project structure includes a basic counter program that demonstrates core PLC IDE functionalities. To access and run this program:

1. Locate the `main` file in your **Project** window as shown below:
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Avoid the numbered lists separated by images or big spaces since the render messes up the numbers and shows the same:
image


Click **OK** to confirm and add the variable to the Watch window.

![](assets/variable_added.png)
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Image doesn't exists


***<strong>Tip</strong>: You can also add variables to be monitored by dragging them from the Project tree or the Main program directly into the Watch window.***

**Monitoring the Hello World Example:**
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This section is duplicated, please maintain the better developed one.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
arduino Bugs and fixes added by the Arduino Team documentation Improvements or additions to documentation preview
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants