Skip to content

Commit 54cd0e9

Browse files
authored
Merge pull request #301 from arduino/jcarolinares/opta/consistency-updates
Consistency updates to keep coherency across tutorials
2 parents 75b3667 + 595c4d2 commit 54cd0e9

File tree

5 files changed

+58
-49
lines changed

5 files changed

+58
-49
lines changed

content/hardware/05.pro-solutions/solutions-and-kits/opta/tutorials/getting-started-connectivity/content.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: 'Bluetooth® Low Energy, Wi-Fi® and Ethernet on Arduino Opta™'
3-
description: "Learn how to make use of the Arduino Opta's connectivity features"
3+
description: "Learn how to make use of the Opta's connectivity features."
44
difficulty: beginner
55
tags:
66
- Wi-Fi®
@@ -45,19 +45,19 @@ The Arduino Opta™ is a powerful micro PLC device that has many features, allow
4545

4646
Using the Arduino IDE we can easily work with the connectivity features, which have their own libraries that we can make use of. Make sure the latest version of the Arduino IDE is installed. The IDE can be downloaded [here](https://www.arduino.cc/en/software).
4747

48-
Then we need to install the appropriate core for the Arduino Opta. Go to **Tools > Board > Boards Manager**, in the boards manager section search for **Opta mbed** and install it. For more detailed instructions on setting up the Arduino Opta with the Arduino IDE, have a look at the [Getting started with opta™ tutorial](/tutorials/opta/getting-started).
48+
Then we need to install the appropriate core for the Arduino Opta. Go to **Tools > Board > Boards Manager**, in the board's manager section search for **Opta mbed** and install it. For more detailed instructions on setting up the Arduino Opta with the Arduino IDE, have a look at the [Getting started with opta™ tutorial](/tutorials/opta/getting-started).
4949

5050
### Wi-Fi®
5151

52-
The files necessary for using the Wi-Fi® on the Arduino Opta are included in the core. To try it out, we can go to **File > Examples**, and under **Examples for Opta** we can find the **WiFi** section. Inside there is an example sketch called **WiFiWebClient**. Open this example sketch and fill out the WiFi details in the **arduino_secrets.h** tab. The sketch will make the Arduino Opta® connect to desired website defined within `char server[] = "example.com";` variable. If the connection is successful, it will then print the websites' HTML content to the serial monitor. If the sketch ran successfully, the output should look like the image below.
52+
The files necessary for using the Wi-Fi® on the Arduino Opta are included in the core. To try it out, we can go to **File > Examples**, and under **Examples for Opta**, we can find the **WiFi** section. Inside there is an example sketch called **WiFiWebClient**. Open this example sketch and fill out the WiFi details in the **arduino_secrets.h** tab. The sketch will make the Arduino Opta® connect to the desired website defined within `char server[] = "example.com";` variable. If the connection is successful, it will then print the website's HTML content to the serial monitor. If the sketch ran successfully, the output should look like the image below.
5353

5454
![Running WiFi sketch on the Arduino Opta in the Arduino IDE](assets/opta-wifi.png)
5555

5656
If you want to take a deeper look at what features the **WiFi** library has to offer, [take a look at the API reference page](https://www.arduino.cc/reference/en/libraries/wifi/).
5757

5858
### Ethernet
5959

60-
The Arduino Opta has a RJ45 ethernet port with a LED that will indicate the status of the connected cable. The files necessary for using Ethernet with the Arduino Opta are included in the core. To try it out, we can go to **File > Examples** and under **Examples for Opta** we can find the **Ethernet** section. Inside there is an example sketch called **WebClient**. Connect the Ethernet cable to the Arduino Opta and upload the example. This example will function the same way as the one mentioned in the Wi-Fi® section. The device will connect to the website defined in the sketch and print the website's HTML content in the serial monitor. If the sketch ran successfully, the output should look like the image below.
60+
The Arduino Opta has an RJ45 ethernet port with a LED that will indicate the status of the connected cable. The files necessary for using Ethernet with the Arduino Opta are included in the core. To try it out, we can go to **File > Examples** and under **Examples for Opta** we can find the **Ethernet** section. Inside there is an example sketch called **WebClient**. Connect the Ethernet cable to the Arduino Opta and upload the example. This example will function the same way as the one mentioned in the Wi-Fi® section. The device will connect to the website defined in the sketch and print the website's HTML content in the serial monitor. If the sketch ran successfully, the output should look like the image below.
6161

6262
![Running the Ethernet sketch on the Arduino Opta in the Arduino IDE](assets/opta-ethernet.png)
6363

@@ -69,7 +69,7 @@ The Arduino Opta can be configured to use Modbus TCP protocol, which runs a Modb
6969

7070
### Bluetooth® Low Energy
7171

72-
To use the Bluetooth® Low Energy feature, you will need to download the **ArduinoBLE** library in the Arduino IDE. Go into the **library manager** and search for **ArduinoBLE**. if you can't find it, try sorting by official libraries published by Arduino. Once ArduinoBLE library is installed, let's try and run a simple example that scans for other Bluetooth® devices within range. The sketch will print the found devices address, local name and the advertised service UUIDs, if present. The example can be found under **File > Examples > ArduinoBLE > Central**, the sketch is called **Scan**. When the sketch is running on the Opta, the output on the serial monitor should look something like the image below.
72+
To use the Bluetooth® Low Energy feature, you will need to download the **ArduinoBLE** library in the Arduino IDE. Go into the **library manager** and search for **ArduinoBLE**. if you can't find it, try sorting by official libraries published by Arduino. Once the ArduinoBLE library is installed, let's try and run a simple example that scans for other Bluetooth® devices within range. The sketch will print the found devices address, local name and the advertised service UUIDs, if present. The example can be found under **File > Examples > ArduinoBLE > Central**, the sketch is called **Scan**. When the sketch is running on the Opta, the output on the serial monitor should look something like the image below.
7373

7474
![Bluetooth® sketch running on the Opta](assets/opta-ble.png)
7575

content/hardware/05.pro-solutions/solutions-and-kits/opta/tutorials/getting-started-with-modbus-rtu/content.md

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
2-
title: 'Getting Started with Modbus RTU on the Opta™'
3-
description: "Learn how to use the Modbus RTU serial protocol on the Opta™."
2+
title: 'Getting Started with Modbus RTU on the Arduino Opta™'
3+
description: "Learn how to use the Modbus RTU serial protocol on the Arduino Opta™."
44
difficulty: intermediate
55
tags:
66
- Getting started
@@ -64,7 +64,7 @@ First, let's ensure we have the latest Arduino IDE version installed on our comp
6464

6565
Now that we have the Arduino IDE configured and the libraries installed, let's connect both Opta™ devices via RS485, as shown in the image below:
6666

67-
![Connecting two Opta™ devices via RS485.](assets/opta-modbus-connection.png)
67+
![Connecting two Opta™ devices via RS485](assets/opta-modbus-connection.png)
6868

6969
### Code Overview
7070

@@ -459,8 +459,12 @@ void loop() {
459459

460460
Once you have uploaded the Modbus RTU Client and Server code for each Opta™ device, we can open the Serial Monitor on the Client side to debug the communication status between the devices. If everything is working correctly, you will be able to see `Success!` messages after each read-and-write task as shown in the image below:
461461

462-
![Modbus RTU Client and Server communication status.](assets/opta-modbus-client.png)
462+
![Modbus RTU Client and Server communication status](assets/opta-modbus-client.png)
463463

464464
## Conclusion
465465

466-
In this tutorial, we established a Modbus RTU connection between two Opta™ devices using the Arduino ecosystem tools, such as the Arduino IDE and Arduino libraries. The `ArduinoRS485` and `ArduinoModbus` libraries are essential components that enable communication with compatible Modbus RTU devices. With the demonstrative example described in this tutorial, we have established communication between a Modbus RTU Server and a Client; we can now configure and set a secondary Opta™ or use a Modbus RTU-compatible module for your project developments.
466+
In this tutorial, we established a Modbus RTU connection between two Opta™ devices using the Arduino ecosystem tools, such as the Arduino IDE and Arduino libraries. The `ArduinoRS485` and `ArduinoModbus` libraries are essential components that enable communication with compatible Modbus RTU devices. With the demonstrative example described in this tutorial, we have established communication between a Modbus RTU Server and a Client; we can now configure and set a secondary Opta™ or use a Modbus RTU-compatible module for your project developments.
467+
468+
### Next Steps
469+
470+
Now that you know how to create and use a Modbus RTU communication with Opta™, you can take a look at [Getting started with connectivity on the Opta™ tutorial](/tutorials/opta/getting-started-connectivity) to discover more about all the connectivity possibilities that Opta™ has.

content/hardware/05.pro-solutions/solutions-and-kits/opta/tutorials/getting-started-with-rs485/content.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
2-
title: 'Getting Started with RS-485 on the Opta™'
3-
description: "Learn how to make use of the RS-485 communication interface on the Opta™"
2+
title: 'Getting Started with RS-485 on the Arduino Opta™'
3+
description: "Learn how to make use of the RS-485 communication interface on the Arduino Opta™."
44
difficulty: beginner
55
tags:
66
- Getting started
@@ -57,7 +57,7 @@ Here are some important functions in the sketch:
5757

5858
Connect the Opta™ devices according to the image shown below:
5959

60-
![RS-485 connection between two Opta™ devices.](assets/opta-modbus-connection.png)
60+
![RS-485 connection between two Opta™ devices](assets/opta-modbus-connection.png)
6161

6262
### RS-485 Sender Sketch
6363

@@ -162,8 +162,8 @@ In this tutorial, we established an RS-485 connection between two Opta™ device
162162

163163
### Next Steps
164164

165-
Now that you are familiar with the RS-485 communication interface on the Opta™, look at our at our [getting started tutorial]() to get a better overview of other features on the device.
165+
Now that you are familiar with the RS-485 communication interface on the Opta™, look at our [getting started tutorial](/tutorials/opta/getting-started) to get a better overview of other features on the device.
166166

167-
If you wish to incorporate Wi-Fi/Bluetooth® Low Energy in your Opta™ solutions, have a look at our [connectivity tutorial]().
167+
If you wish to incorporate Wi-Fi/Bluetooth® Low Energy in your Opta™ solutions, have a look at our [connectivity tutorial](/tutorials/opta/getting-started-connectivity).
168168

169-
If you are interested in seeing the RS-485 interface and the Opta™ being put to work in a real life scenario, have a look at our [tank level application note]().
169+
If you are interested in seeing the RS-485 interface and the Opta™ being put to work in a real-life scenario, have a look at our [Tank level application note](/tutorials/opta/tank-level-app-note).

content/hardware/05.pro-solutions/solutions-and-kits/opta/tutorials/getting-started/content.md

Lines changed: 15 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,12 @@
11
---
2-
title: 'Getting Started With the Arduino Opta™'
2+
title: 'Getting Started with the Arduino Opta™'
33
description: 'Get started with the Opta™ and get to know some of its features.'
44
difficulty: beginner
55
tags:
66
- Getting started
77
- Relays
88
- Analog Input
9+
- Digital Input
910
author: 'Benjamin Dannegård'
1011
software:
1112
- ide-v1
@@ -43,7 +44,7 @@ Opta™ is a robust micro PLC solution with many engaging features. In this tuto
4344
### Setup With the Arduino IDE
4445

4546
Make sure the latest version of the Arduino IDE is installed. The IDE can be downloaded [here](https://www.arduino.cc/en/software).
46-
Within the Arduino IDE install the core for the Opta™. Go to **Tools > Board > Boards Manager**, in the boards manager section search for **Opta mbed** and install it.
47+
Within the Arduino IDE install the core for the Opta™. Go to **Tools > Board > Boards Manager**, in the board's manager section search for **Opta mbed** and install it.
4748

4849
![Finding the Opta™ Core in the Arduino IDE 2.0](assets/opta-core-install.png)
4950

@@ -103,7 +104,7 @@ void loop() {
103104

104105
### Configuring the Programmable Button on the Opta
105106

106-
Opta™ has a programmable button, shown on the image below and identified as USER. It can be programmed using the Arduino IDE to fit your needs. To show how much simple is to use it, let's create a sketch and program the button as a trigger to modify the status of the STATUS LEDs.
107+
Opta™ has a programmable button, shown on the image below and identified as USER. It can be programmed using the Arduino IDE to fit your needs. To show how simple is to use it, let's create a sketch and program the button as a trigger to modify the status of the STATUS LEDs.
107108

108109
![The button and STATUS LEDs that will light up on the Opta™](assets/opta-device-button.png)
109110

@@ -164,13 +165,13 @@ void changeLights() {
164165

165166
Once the sketch is uploaded, you can see that an additional LED is turned on each time you press the button, following the sequence:
166167

167-
| Interaction | Result |
168-
| ------------ | ----------------------------- |
169-
| First press | STATUS LED 1 ON. |
170-
| Second press | STATUS LEDs 1 and 2 ON. |
171-
| Third press | STATUS LEDs 1, 2 and 3 ON. |
172-
| Fourth press | STATUS LEDs 1, 2, 3 and 4 ON. |
173-
| Fifth press | All STATUS LEDs off and back. |
168+
| Interaction | Result |
169+
| ------------ | ---------------------------- |
170+
| First press | STATUS LED 1 ON |
171+
| Second press | STATUS LEDs 1 and 2 ON |
172+
| Third press | STATUS LEDs 1, 2 and 3 ON |
173+
| Fourth press | STATUS LEDs 1, 2, 3 and 4 ON |
174+
| Fifth press | All STATUS LEDs off and back |
174175

175176

176177
### Using Out Relays
@@ -190,14 +191,14 @@ The relays coils correspond to pins D0 to D3 as follows:
190191

191192
The Opta™ output contacts are "clean" contacts, which means they are contacts that are not alive in a "non-connection" situation. This type of contact can be used in any system and with any type of voltage. To properly function, the outputs must therefore be connected by bringing for example a power cable to one of the terminals and connecting the load to the exit of the other terminal.
192193

193-
This way, when the contact is closed by the logic set in the programming, the power supply signal will cross the contact carring the signal up to the reference load.
194+
This way, when the contact is closed by the logic set in the programming, the power supply signal will cross the contact carrying the signal up to the reference load.
194195

195196
The “clean” contact also allows carrying a different power system or type of load for each output contact, being possible to control multiple devices or signals that use different voltage levels.
196197

197198
![Clean contact on the Opta™](assets/opta-clean-contact.png)
198199

199200
Let's run a simple sketch to test the output relays on Opta™: in this sketch all the 4 relays are closing and reopening their contacts and after each relay's cycle a led will be turned on to provide visual feedback.
200-
To activate the relays and run this sketch you need to provide Opta™ with a voltage from 12 to 24 V DC by connecting it a proper power supply.
201+
To activate the relays and run this sketch you need to provide Opta™ with a voltage from 12 to 24 V DC by connecting it to a proper power supply.
201202

202203
Opta™ has dedicated terminals for power supply located in the upper part of Opta™ and next to the inputs. They are duplicated to help the user to connect the power supply and any common part to the input terminals but they have the same potential (upon polarity).
203204

@@ -331,11 +332,11 @@ void loop() {
331332

332333
Once you have uploaded the code, open the serial monitor to see the values read in each analog input. If you have connected a device with an analog voltage value in I1, I2, and/or I3 you will see the voltage or analog value of each of the signals. In case you did not connect anything to the analog inputs, you will see how the values oscillate between 0V and a very small value because the pins are floating.
333334

334-
You may notice from the output values that when the maximum value of 10V is reached, the corresponding numerical value is not 4095 as the maximum value with 12 bits resolution should be. The reason is that there is a precautional margin taken on the maximum voltage level applicable to the inputs to preserve the integrity of the microcontroller.
335+
You may notice from the output values that when the maximum value of 10V is reached, the corresponding numerical value is not 4095 as the maximum value with 12 bits resolution should be. The reason is that there is a precautional margin taken on the maximum voltage level applied to the inputs to preserve the integrity of the microcontroller.
335336

336337
### Connecting Opta™ to the Cloud
337338

338-
It is possible to use the Opta™ with the Arduino Cloud. To set up the Opta™ to the cloud go to the [Arduino Cloud](https://cloud.arduino.cc/). For help with how to get started with the cloud, go to our [Getting started with the cloud](https://docs.arduino.cc/arduino-cloud/getting-started/iot-cloud-getting-started) tutorial. We also have a number of other helpful tutorials for [the Arduino cloud](https://docs.arduino.cc/arduino-cloud/).
339+
It is possible to use the Opta™ with the Arduino Cloud. To set up the Opta™ to the cloud go to the [Arduino Cloud](https://cloud.arduino.cc/). For help with how to get started with the cloud, go to our [Getting started with the cloud](https://docs.arduino.cc/arduino-cloud/getting-started/iot-cloud-getting-started) tutorial. We also have some other helpful tutorials for [the Arduino cloud](https://docs.arduino.cc/arduino-cloud/).
339340

340341
## Conclusion
341342

0 commit comments

Comments
 (0)