2324_groov_RIO_Users_Guide
2324_groov_RIO_Users_Guide
groov RIO
USER’S GUIDE
groov RIO USER’S GUIDE
for
GRV-R7-MM1001-10
Wired+Wireless controllers and brains are licensed under one or more of the following patents: U.S. Patent No(s). 5282222,
RE37802, 6963617; Canadian Patent No. 2064975; European Patent No. 1142245; French Patent No. 1142245; British Patent
No. 1142245; Japanese Patent No. 2002535925A; German Patent No. 60011224.
Opto 22 FactoryFloor, groov, groov EPIC, groov RIO, mobile made simple, Optomux, and Pamux are registered trademarks of
Opto 22. Generation 4, groov Server, ioControl, ioDisplay, ioManager, ioProject, ioUtilities, mistic, Nvio, Nvio.net Web Portal,
OptoConnect, OptoControl, OptoDataLink, OptoDisplay, OptoEMU, OptoEMU Sensor, OptoEMU Server, OptoOPCServer,
OptoScript, OptoServer, OptoTerminal, OptoUtilities, PAC Control, PAC Display, PAC Manager, PAC Project, PAC Project Basic,
PAC Project Professional, SNAP Ethernet I/O, SNAP I/O, SNAP OEM I/O, SNAP PAC System, SNAP Simple I/O, SNAP Ultimate
I/O, and Wired+Wireless are trademarks of Opto 22.
ActiveX, JScript, Microsoft, MS-DOS, VBScript, Visual Basic, Visual C++, Windows, and Windows Vista are either registered
trademarks or trademarks of Microsoft Corporation in the United States and other countries. Linux is a registered
trademark of Linus Torvalds. ARCNET is a registered trademark of Datapoint Corporation. Modbus is a registered trademark
of Schneider Electric, licensed to the Modbus Organization, Inc. Wiegand is a registered trademark of Sensor Engineering
Corporation. Allen-Bradley, CompactLogix, ControlLogix, MicroLogix, SLC, and RSLogix are either registered trademarks or
trademarks of Rockwell Automation. CIP and EtherNet/IP are trademarks of ODVA. Raspberry Pi is a trademark of the
Raspberry Pi Foundation. The registered trademark Ignition by Inductive Automation® is owned by Inductive Automation
and is registered in the United States and may be pending or registered in other countries. CODESYS® is a registered
trademark of 3S-Smart Software Solutions GmbH.
groov includes software developed by the OpenSSL Project for use in the OpenSSL Toolkit. (http://www.openssl.org)
All other brand or product names are trademarks or registered trademarks of their respective companies or organizations.
Opto 22
Automation Made Simple.
Chapter 1: Welcome . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1
Welcome to groov RIO! . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
groov RIO as Edge I/O . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
groov RIO as Remote I/O in an Opto 22 Control System . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
groov RIO with Modbus/TCP or Custom PC-based Control Programs . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
Requirements. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
Power Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
Field Device Wiring . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
Software Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
About This Guide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
What’s In This Guide? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
Service and Maintenance. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
Service (Product Support) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
• Place the unit almost anywhere. groov RIO operates through a wide
range of operating temperatures (-20 to 70 °C), and is UL Hazardous
Locations approved and ATEX compliant. Mount it on a DIN rail or panel.
• Supply power to groov RIO and field I/O through the ETH1 network
interface using PoE connections, or provide 10-32 VDC power.
• Simplify field connections using the 26-pin removable field connector
with spring clamp wire retention. Supports wire sizes 16 to 12 AWG.
• Use web-based software to configure I/O channels: inputs or outputs;
signals including voltage, current, thermocouple, ICTD; mechanical
relays. Over 62,000 field I/O combinations are possible in one unit.
• Use intelligent features like counting, latching, clamping, and more.
• Connect additional devices like a Wi-Fi adapter, a USB memory stick (up
to 32 GB), or a USB-to-serial adapter via the groov RIO’s USB host port
(you supply the additional devices).
• Easily see the status of power, network, and I/O activity on the unit’s
LEDs.
• Use embedded software to quickly set up data communications.
REQUIREMENTS
Power Requirements
There are two ways to provide power to a groov RIO:
• An external 10 to 32 V DC power source or supply capable of providing at least 10 Watts
• Power over Ethernet (PoE) through the ETH1 port (star topology only)
Software Requirements
If you are using groov RIO as an independent edge I/O unit, all you need is a web browser to configure I/O,
security, and networking, and to create Node-RED flows.
If you are using groov RIO as remote I/O with an Opto 22 system running:
• a PAC Control strategy, you need to run PAC Project 10.3000 or higher. If you are running a PAC Control
strategy on a:
– groov EPIC processor, you need GRV-EPIC-PR1 firmware version 2.0.0 or higher.
– SNAP PAC controller, you need firmware 10.3a or higher.
• a CODESYS application, you need CODESYS Development System, V3.5 SP15 Patch 1 or newer (32-bit
version) with Opto 22 Library Package for CODESYS Development System version 2.0.0.0 installed.
Chapter 7: Configuring a groov RIO describes what to do after you finish initializing groov RIO, which
includes setting date, time, and time zones; attaching USB devices, and enabling Node-RED.
Chapter 8: Configuring I/O describes how to select the functions (input or output), signal types (discrete,
analog), and any corresponding features for each channel through groov Manage. It also describes where to
find information if you want to write a PAC Control strategy or custom application can access your RIO.
Chapter 9: Enabling MQTT introduces you to MQTT, how it works in RIO, and how to configure it.
Chapter 10: Developing Node-RED Flows describes what an experienced Node-RED developer needs to
know to start writing flows that access RIO’s data, as well as provide step-by-step instructions for those new to
Node-RED.
Chapter 11: Maintaining a groov RIO describes all the tasks you can do to keep your RIO performing
smoothly, how to install firmware updates, perform periodic backups, review guidance to do basic
troubleshooting, information to collect should you need to contact Product Support, and an overview of how
to conduct an OptoRSS (Remote Support Service) session.
Appendix A: Specifications lists the specifications for each channel of a RIO, as well as the specifications
common to all channels on a RIO.
Appendix B: Wiring Diagrams lists all the wiring diagrams for a GRV-R7-MM1001-10.
Appendix C: groov RIO Explorer describes our online app that helps you see different combinations and
arrangements of channel configurations, help you choose combinations and arrangements that are valid, and
create wiring diagrams for your chosen combination.
Fax: 951-695-3017
Email: [email protected]
Terminal connector
Power supply
connectors
USB port
Power supply
connectors
Extendable tabs for
panel mounting
MOUNTING
You can mount groov RIOs onto DIN rail or onto a panel.
Before mounting, make sure that there is a minimum of 2 inches clearance
2 inches
on the top, and 1 inch clearance on the bottom, on each side, and in front
of RIO after it is mounted. Mount RIO as shown in the diagram: with the
Opto 22 logo at the top. Compliance with these guidelines will help ensure
that the groov RIO performs as described in the specifications.
2. Push the bottom part of RIO upward, making sure that you feel the clip catch on to the rail, and
simultaneously push the top half of RIO toward the DIN rail until the top of the DIN rail adapter engages
the top lip of the DIN rail.
Before you release RIO, verify that the top and bottom of the DIN rail adapters have engaged the DIN rail.
Mounting on a Panel
Before mounting your RIO:
• Ensure that the vents around RIO are not obstructed.
• Review the clearances requirements described in the previous page.
1. First, extend the mounting tabs:
a. Turn the RIO so you can see the backside.
b. With a small Phillips screw driver, remove the
screw on one tabs.
c. Slide the tabs out so the middle hole on the tab
aligns with the screw hole on the RIO.
d. Reinsert the screw to the torque indicated in the
“Common Characteristics” section of the
specifications (see “Specifications” on page 109).
e. Repeat steps b through d with the other tab.
2. To mark holes on the panel and verify placement before attaching the RIO, use the RIO as a template.
3. Attach the RIO to the panel with screws (not provided).
• Select the appropriate wire. The terminal connectors are rated for 28–14 AWG wire. If you’re using
stranded wire, you can make an easier and better connection by tinning the strands or adding ferrules.
• Ensure that you have the spring clamp tool supplied with your groov RIO.
• If you are unfamiliar with the names of some of the parts of the groov RIO, review the diagrams on
page 11.
• It may be easier to insert wires if you remove the terminal connector from the RIO. To remove the
terminal connector, loosen the terminal connector screw at one end of the connector, then pull the
connector straight out to remove it from the groov RIO.
• If you have never used a spring-clamp wiring system, take a moment to familiarize yourself with the
diagram below. The clamp release hole is where you will insert the sprint clamp tool. The field wiring hole
is where you will insert your field wires.
If you look into the field wiring hole, you will see a highly reflective surface. If you can see that surface,
that means that the clamp is closed.
Pin numbers
Follow these instructions to connect your field wires to the terminal connector:
CAUTION: For electrical safety, turn off power to the groov RIO and de-energize field devices wired to the terminal
connector before starting.
1. Orient the groov RIO or terminal connector to match the wiring diagrams. To make it easier to handle the
spring clamp tool and the field wires, secure the groov RIO or terminal connector by doing one of the
following:
– If you are working with the terminal connector while it is attached to the groov RIO, make sure the
groov RIO is attached securely to the panel.
– If you are working only with the terminal connector, secure the terminal connector with a clamp.
2. Slide the spring clamp tool into the clamp release hole, along the left side, until you feel the end begin to
meet some resistance. Gently push the tool in a little more, until you feel it stop.
– Look into the field wiring hole. If it is dark, the clamp is open. You can go to the next step.
– If you can still see the highly reflective surface, gently pull the tool’s handle to the left until you feel it
stop. Hold the tool in that position. Look into the field wiring hole. If it is dark, the clamp is open. You
can go to the next step.
3. Insert the wire into the field wiring hole until it meets complete resistance. Then pull out the spring
clamp tool.
4. Test that the wire is secure by gently pulling on it. If the wire pulls out, repeat steps 2 through 3.
To remove a wire, push the spring clamp tool into the clamp release hole as described in step 2 above, and
then pull the wire out.
After you connect the external power source or supply, connect the Ethernet cable, and proceed to Chapter 3:
Initializing a groov RIO.
After you connect your groov RIO to a power supply and a network, it runs through its start-up sequence,
which includes obtaining an IP address from the DNS server on the network.
• If your network uses DNS and DHCP to assign and manage IP addresses, you can start with step 1
(below).
• If your network does not use DNS and DHCP to assign and manage IP addresses, you will need to install
and run (on a Windows machine) groov Find. (Make note of the IP address that groov Find identifies for
your groov RIO for future reference.) Then you can go to step 3 (below) and use the IP address instead of
the host name. If you are not familiar with groov Find, see “Downloading and Running groov Find” on
page 100.
Your first tasks will be to log into groov Manage, create the first administrator account, determine if you need
to run Quick Start, and check whether you have the latest firmware installed.
1. Wait for the STAT LED to stop blinking and show a solid green color.
2. From a computer or mobile device connected to the same network, open up a web browser.
3. In the URL bar, enter https://<RIO default hostname>, where
<RIO default hostname> is the host name listed on the label on the side of unit.
If, after a few minutes, you do not see the Welcome! screen or you can get an error from the browser,
check “Browser Reports that URL to RIO is Unreachable” on page 99.
4. Click Let’s get started! ( ). You’ll see the Create
an Account screen.
Read the information in the warning box. This first
administrator account is very important because it
provides administrator privileges over the groov RIO,
which gives you access to all the functions you need to
configure it, maintain it, and create other accounts.
It’s also important to remember the username and
password to this account. The groov RIO does not provide
a way to recover this password nor an alternate way to
access this account if you forget the password. Also,
Opto 22 cannot recover this password or provide access
to the account.
5. Type in a user ID and password for this administrator
account, then click Create Account.
It is a good idea to follow best practices regarding
passwords (for example, mixing cases and including
numbers) when you create your password. Your
password must be a minimum of 1 character and can be
a maximum of 128 characters.
– Quick Start—The quick start provides a list of suggested configuration steps that you should
complete first to get your groov RIO up and running. You may want to choose this option if this is
the first time you configure a groov RIO. If you select this option, go to the next step.
– Configure Device—If you select this option, groov Manage displays the Home page, where you
can make any configuration changes. You may want to choose this option if you have configured a
groov RIO before or you feel confident you have all the information and understand the technology
and software installed on the RIO to complete any configuration steps. If you select this option, skip
to step 8.
7. Click Quick Start. groov Manage displays the Quick Start page.
The boxes are organized to suggest an order in which to complete the configuration. However, you do
not have to follow this order nor do a configuration task for every box. Here’s why you might want to
complete each step:
– Networking—You might want to configure or change networking settings because you want to
change the IP address or hostname that was assigned to the unit. You might want to set the IP
address manually (which would make it a static IP address) or disable a network interface.
– Accounts—You might want to create additional accounts as required by the design of your site.
– Time—You can choose between manually setting the date and time, selecting a time zone from a
list, or selecting a time server that will synchronize your unit’s date and time with that time server’s
date and time.
After you finish each configuration task, click back to return to the Quick Start page.
8. In groov Manage, click the menu button ( ), then select Info and Help.
9. In the Info and Help page, click About.
10. In the groov RIO section, note the version in the System Version field.
When you connect to groov RIO through a web browser on a computer, you navigate through the web
browser in much the same way you navigate through any other web application on your computer. You can
click on navigation aides like the navigation bar or links, and scroll up and down with a mouse.
A A
C B C
B
A Menu button ( ). Click or tap on this button to access a list of important pages. This button can
help you quickly jump to these pages.
B Cancel or previous page. The upper-left area of the page provides a way to cancel any changes you
might have made to fields on the current page, return to the previous page, or both.
C Save, Configure, or Done. If there are settings on the page that you can change, the upper-right area
of the page displays the word Configure. Click on Configure to open up the page where you actually
make the changes.
If this area shows the word Save, you must click on it to save any changes you made to settings on
the page. If, after saving, the processor must restart an application or service, it displays a message to
let you know.
If this area is blank, that means you can’t make any changes to this page.
D Links. When you see these arrows, it indicates that clicking or tapping on the arrow will open another
page that displays more information and provides more functions related to the item. For example,
when you click Project Management in the Node-RED page, groov Manage displays another page
with information and functions to help you manage a Node-RED project.
Either action displays the I/O Channels page. The page displays a table where each row is a channel.
A B
A The grey box shows the channel number at the top, the function and signal type on the bottom.
B For each channel, this area shows the channel name (if one has been assigned) at the top and a
summary of the signal information on the bottom. The summary varies; it could be the state of a
discrete input or output, the temperature reading from an ICTD probe, or quality indication.
City or Locality—Name of the city or locality where your organization is located. Please spell out the
name of the city or locality. Do not abbreviate.
State—Name of state, province, region, territory where your organization is located. Please enter the full
name. Do not abbreviate.
Country Code—The two-letter International Organization for Standardization (ISO-) format country
code for the country in which your organization is legally registered. See
http://www.digicert.com/ssl-certificate-country-codes.htm for a list of codes. For example, the code for
the United States is US.
Days until expiration—Enter the number of days before the certificate is expired and has to be
replaced. Opto 22 recommends 3560 (10 years).
RSA key size—Enter the size of the RSA key. The default size of 2048 is a generally recommended value.
Higher values will take longer to create.
4. Click Create. groov Manage immediately installs the new private key and certificate, and then restarts
groov Manage.
Your groov RIO now has new copies of the Public Certificate, Private key, and CSR, which you can download
when you need to request a CA-signed certificate.
4. Navigate to the folder where you stored the certificate and select the certificate (.pem) file.
5. Click Open. groov Manage uploads the file and you’ll see it listed in the Certificates section.
b. Move the slider to the right so that it shows green ( ). groov Manage displays a new row
below the SSL row.
c. Click Select Certificate. groov Manage displays the CA Certificate window with a list of public key
certificates installed on the processor. Select the certificate you want.
groov Manage refreshes the MQTT Broker settings window to show the name of the certificate you
chose.
d. Click OK.
4. When you are done modifying all the MQTT Brokers that you wanted to change, click Save.
If there are any errors in any of changes you made, groov Manage highlights the broker with the error in red.
Select that broker to view more information about the errors. Make any necessary changes and try saving
again.
5. Click OK. If there are any errors in your selections groov Manage highlights the error and displays an error
message.
After groov Manage finishes saving and implementing the changes, it displays the Security page.
Please note that adding or changing firewall rules (which effectively opens ports in the firewall) does not start
the listening services that may or may not be behind those ports. If you encounter problems accessing those
services, check that the services are on and listening.
2. Click Security > Firewall. The Firewall page displays the rules currently in effect and may look similar to
this:
6. Click Save. groov Manage displays a message that it is configuring the firewall. If there are any conflicts
with existing rules, groov Manage will highlight the row with the conflict and then you can change the
rule to eliminate the conflict.
After groov Manage finishes saving and implementing the changes, it displays the Security page.
Please note that adding or changing firewall rules (which effectively opens ports in the firewall) does not start
the listening services that may or may not be behind those ports. If you encounter problems accessing those
services, check that the services are on and listening.
The topic of networking can be complex. In this chapter, we cover the following scenarios:
• Connecting groov RIO to a local area network, either wired or wireless.
• Connecting groov RIO to a virtual private network (VPN).
Network configuration changes will require a restart of the network connections on RIO. It’s important to have
groov Find ready to help you locate your RIO on the network. If you are not familiar with groov Find,
see“Downloading and Running groov Find” on page 100. Schedule this task at a time that minimizes the
impact on your application and equipment.
If you have an IT department, work with them as you complete these steps:
1. Review your current networking requirements and practices, as well as groov RIO’s networking
capabilities and default settings. Decide whether the default network settings are sufficient for your
network or if you need to change some of the defaults. For more information, see “Reviewing RIO’s
Network Capabilities and Default Settings” on page 34.
2. If you’ll be changing the default network settings or connecting to a virtual private network with
OpenVPN, gather up and verify the information you need before you begin changing settings. See
“Collecting Network Configuration Information” on page 38.
3. Configure the appropriate network interfaces (ETH0, WLAN0) on your groov RIO with the information you
collected from the previous step. See “Configuring the Network Interfaces” on page 42.
4. If you are connecting to a virtual private network with OpenVPN, configure the OpenVPN Tunnel 0
interface as described in “Connecting to a Virtual Private Network (VPN)” on page 44.
5. Test your network connections and fine-tune your security. See “Testing the Network Connections and
Fine-Tuning Security” on page 46.
The following illustrations show the correct and incorrect way to daisy-chain RIOs:
Ethernet Switch
Ethernet Switch
Ethernet Switch
For each physical network interface on a groov RIO that you are connecting to a network, you can choose one
of two connection methods:
• Automatic—The DHCP server assigns the IP address and subnet mask. Select this method if:
– Your network is simple and small with a DHCP server.
– The default network settings on groov RIO meet the needs of your network environment.
– The default network settings meet your networking requirements and you plan to add a wireless
adapter.
– The DHCP server can assign the IP address and subnet mask, but you want to be able to override the
gateway address or DNS IP address and name server.
For any of these situations, review “Collecting Information for Automatic Connections” on page 38.
• Manual—You or the IT administrator need to enter an IP address, a subnet mask, and, in the cases
described below, additional configuration information. Select this method if you or your IT department
require advanced network configurations.
For the unique cases described earlier, review the information below. Most of these options are available on all
the network interfaces (ETH0, WLAN0, and OpenVPN Tunnel 0).
• If you need to override the DNS server IP address and domain name assigned by the DHCP server, see
“Overriding the DNS Server IP Address and Domain Name Assigned by DHCP Server” (below).
• If you need to do either of the following, see “Adding DNS Servers and Specifying the Order in which DNS
Servers are Queried” (below):
– Add more DNS server IP addresses and domain names.
– Specify the order in which the DNS servers are added to the DNS resolver’s configuration.
• If you need to do either of the following, see “Adding Gateway IP Address or Overriding the Gateway IP
Address Assigned by the DHCP Server” (below).
– Add a gateway IP address or override the gateway IP address assigned by the DHCP server.
– Alter the order in which gateways are invoked. Gateway Order determines which interface's
gateway is used for off-subnet destination-based routing. The gateway associated with the active
interface with the lowest gateway order will be used as the default gateway. For more information
about this topic, see “G: Advanced Networking Configurations” on page 247.
Overriding the DNS Server IP Address and Domain Name Assigned by DHCP Server. If your
network policy is for the DHCP server to assign the IP address and subnet mask, but the IT administrator
manually assigns the domain name server (DNS), you will need the IP address and domain name of that server
when it’s time to configure groov RIO. Record this information “Table of Additional Gateway IP Addresses, DNS
IP Addresses and Name Servers, and Order” on page 40 (in the Automatic section, as DNS Server 1 Override
and DNS Domain 1 Override, under the network interface that requires this configuration) so that it is readily
available when you configure your RIO.
You can specify additional domain name servers, entering them as the second (DNS Server 2 Override with
DNS Domain 2 Override) and third (DNS Server 3 Override with DNS Domain 3 Override) entries in the table,
also in the Automatic section.
Adding DNS Servers and Specifying the Order in which DNS Servers are Queried. You can
assign up to three domain name servers to each network interface on RIO and indicate the order in which to
communicate with the servers. You can set the DNS Order of a network provisioning domain to specify the
priority that name servers and search domains are added to the DNS resolver's configuration, which has a
maximum limit of three name servers and six search domains. When a DNS request is made, the resolver
queries name servers in series in the order defined in the configuration. If a response is received with either a
successful resolution or with a reply code such as "Name not found", no other name servers are queried. If the
DNS request times out, the next name server is tried until all name servers are exhausted. Be aware that name
resolution of secondary and tertiary name servers may be slow due to the sequential nature of queries by the
DNS resolver.
For each network interface that requires this configuration, make a note of the DNS server IP addresses and
domain names in the Automatic section (for network interfaces where you selected Automatic connection) or
the Manual section (for network interfaces where you selected Manual connection) of “Table of Additional
Gateway IP Addresses, DNS IP Addresses and Name Servers, and Order” . The DNS Order is per network
interface, with 1 being the highest priority (the network interface queried first).
Adding Gateway IP Address or Overriding the Gateway IP Address Assigned by the DHCP
Server. If your network policy requires the assignment of a specific gateway IP address, review the
information in “Redirecting Traffic Initiated by an Incoming Connection Request” on page 247 to understand
how groov RIO manages gateway assignments and prioritizes their use.
For each network interface that requires this configuration, make a note of the gateway IP address in the
Automatic section (for network interfaces where you selected Automatic connection) or the Manual section
(for network interfaces where you selected Manual connection) of “Table of Additional Gateway IP Addresses,
DNS IP Addresses and Name Servers, and Order” . The Gateway Order is per network interface, with 1 being
the highest priority (the network interface queried first).
WIRED WIRELESS
ETH0 WLAN0
IP address IP address
Subnet mask Subnet mask
SSID
None
Encryption type
WEP WPA WPA2
Passphrase (ASCII)
Key type
PSK (HEX)
Key Do not write down.
TABLE OF ADDITIONAL GATEWAY IP ADDRESSES, DNS IP ADDRESSES AND NAME SERVERS, AND
ORDER
– LZO Compression–If the OpenVPN server uses LZO compression, then you will need to enable it
on your groov RIO.
Some of this information can be provided in a configuration file, which you can then upload into your
groov RIO. Uploading a configuration file could make configuring the processor easier and you will be less
likely to introduce typing errors. When you receive the configuration file, review it to make sure it has the
following information (and in the format indicated), as appropriate for your OpenVPN server’s security and
authentication configuration:
• Certificate Authority (CA)—The CA section should be surrounded by <ca> and </ca> tags. Inside those
tags, the certificate text should be surrounded by <cert> and </cert> tags.
• Private and Public Key—The key text should be surrounded by <key> and </key> tags.
• Open VPN static key—The key text should be surrounded by <tls-auth> and </tls-auth> tags.
If it doesn’t contain this information, you can edit the file and add it, making sure it is surrounded by the tags
described previously.
If the administrator can’t provide a configuration file, print the following table to collect the above
information, save it in a secure place, and have it handy when you follow the instructions in “Connecting to a
Virtual Private Network (VPN)” on page 44.
TABLE OF OpenVPN SETTINGS
Information Value
Protocol udp tcp-client
OpenVPN Server Host Name __________________________________________________________
OpenVPN Server Port Number _______________
Remote Public Certificate Path
and File Name __________________________________________________________
User Name ___________________________________
Password Do not write down.
Proxy User Name ___________________________________
Proxy Password Do not write down.
Encryption Cipher none ________________
LZO Compress yes no
Configuring ETH0
You’ll want to have the information you collected when you read through “Collecting Network Configuration
Information” on page 38 available as you follow these steps:
1. From the Network configuration page, click
the IPv4 Method currently assigned (the text
in green) to ETH0. groov Manage displays the
IPv4 Method window (see right).
2. Click the connection method you want. If
you choose Disable, skip to step 5.
3. If you selected Automatic and you don’t
want to override the DHCP server settings for gateway, DNS address, and DNS name server, skip to step 5.
Otherwise, now is when you enter those override values from “Table of Additional Gateway IP Addresses,
DNS IP Addresses and Name Servers, and Order” on page 40.
Configuring WLAN0
1. From the Network configuration page, click the IPv4 Method in the Wi-Fi section and select the
connection method you want. groov Manage updates the Network configuration page as shown below
(automatic on the left, manual on the right):
2. Enter the information you collected in “Collecting Network Configuration Information” on page 38.
3. Choose from the following:
– If you need to configure a network interface for wired communication, see “Configuring ETH0” on
page 42.
– If you are done configuring the network interfaces, go to “Saving the Configuration” on page 44.
After the network connections are restarted, if groov Manage doesn’t reappear and you can’t access your RIO
through any of the network connections you configured, start up groov Find to help you locate your RIO (see
“Downloading and Running groov Find” on page 100).
After you reconnect to your RIO, you can test the network connections and fine-tune your security settings. If
you need to set up a virtual private network (VPN), see “Connecting to a Virtual Private Network (VPN)” on
page 44.
4. Click Configure.
5. In the OpenVPN Tunnel 0 section, click IPv4 Method and select Automatic (DHCP).
6. Enter the configuration information you collected when you reviewed “Collecting Network Configuration
Information for OpenVPN Connection” on page 40.
– If your VPN information is in a client configuration file, click Upload Configuration File. Navigate to
the folder where you stored the configuration file, select it, then click Open. Click Set User
Credentials to enter the OpenVPN server user name and password. If necessary, click Set Proxy
Credentials to enter the proxy credentials. Go to step 7.
– If you need to enter the configuration information manually, slide the User Configuration Wizard
switch to the right, until it turns green.
a. Click Protocol to select the protocol used by your
OpenVPN server.
b. Enter the IP address or full domain name of the
OpenVPN server in the Remote Host field
c. To enter the port number, click in the space
between the - and + sign. Type in the port
number.
d. Click Select Certificate and select the certificate
you uploaded in step 2 on page 44.
e. In the Username and Password fields, type in the
OpenVPN server username and password. (Not
the proxy username and password.)
f. Click Encryption Cipher and select the cipher
used by your OpenVPN server from the list.
g. If the OpenVPN server users LZO compression,
slide the LZO Compress switch to the right, until it
turns green.
h. If you need to modify the Gateway and DNS order, click on those numbers and change them.
7. Click Save. If groov Manage reports any errors, fix those errors and click Save. Otherwise, groov Manage
displays a message that it will restart the network connections.
A user with administrator privileges is the only user that can change system features. System features provide
services like access control, device management, and time management.
Setting the Date, Time, and Time Zone by Synchronizing with Time Servers
If you are not familiar with time servers, you can learn more about them through the NTP Pool Project at
www.pool.ntp.org. When you are selecting a time server, remember the following:
• It is a good idea to select a couple of time servers to serve as backups in case groov RIO cannot establish
a connection to the primary time server or if that time server becomes unavailable. The steps below
instruct you to set two additional time servers.
• If you had set your date and time manually, setting the date and time as described in this section will
overwrite your manual settings.
Note: Changing the time manually will log out any users that are currently signed into your groov RIO. Carefully
choose when you will change the time to minimize any adverse affect on other users.
To select the primary time server and a few backups:
1. Log into groov RIO with a user ID that has administrator privileges.
2. Click System ( ), then Time ( ).
3. In the Time Servers section, click Time Server 1. Enter the host name of the time server.
4. Click Time Server 2. Enter the host name of a second time server.
5. Click Time Server 3. Enter the host name of a third time server.
6. Click Set NTP. groov Manage displays a message while it’s synchronizing with the time servers. When it
finishes, the message disappears.
Now your date and time are set, as well as the time zone. The date and time will be updated automatically
during the switches between Standard Time and Daylight Savings Time, according to the schedule set by the
time servers.
You can expand the number of serial devices you can connect to groov RIO by installing a USB hub to the USB
port. When you do this, it’s important to keep track of the device names and port numbers that groov RIO
assigns to the USB-to-serial adapter that you plug into each USB port on the hub (see “Understanding How
groov RIO Assigns Port Numbers and Device Names When Using a Hub” on page 50). One way to do this is:
1. Go to the Serial Devices page in groov Manage (Home > System > Serial Devices).
2. Insert an adapter into a port. groov Manage will detect the adapter, assign it a device name and port
number, then refresh the page to show the information.
3. Make note of the device name and port number so that you have it handy as you develop Node-RED
flows.
If you move a serial device from one USB port of the USB hub to another port on the hub, groov RIO assigns it
a new port number, and possibly a new device name. These changes might require changes to your
Node-RED flows.
Before you start connecting an adapter of USB hub to your RIO, see “Managing The USB Port” on page 49.
Understanding How groov RIO Assigns Port Numbers and Device Names When Using a Hub
If you connect a USB hub to the USB port, groov RIO includes a suffix to the device name and port number to
identify the port number on the USB hub. For example, if you connect a 4-port USB hub to the USB port, then
groov RIO assigns device names and port numbers as follows:
If a USB-to-serial adapter is plugged into port x of groov RIO assigns it a and a port
the USB hub... device name of... number of...
1 /dev/ttySer0.1 0.1
2 /dev/ttySer0.2 0.2
3 /dev/ttySer0.3 0.3
4 /dev/ttySer0.4 0.4
IMPORTANT: If you move the adapter from one USB port on the USB hub to another USB port, groov RIO will
assign a new port number and device name to the adapter. Any Node-RED flow that references the old port number
and device name will need to be modified to refer to the new port number and device name.
b. Click Safely Remove. groov Manage displays the following message; click OK to continue:
c. When groov Manage successfully unmounts the storage device, it displays the following message.
Click Close to continue.
Insert the USB storage device into the USB port. To verify that groov Manage has access to the USB storage
device, from the groov Manage Home page, click System > Files. groov Manage displays the Files page.
groov Manage lists the USB storage device in a section called USB Drive, typically followed by a number:
You can now copy, move, and download files (see “Copying, Moving, or Downloading a File on a USB Storage
Device” on page 54).
When groov Manage successfully unmounts the storage device, it displays the following message. Click
Close to continue.
Bottom View
USB port
3. In groov Manage, go to the Network page (Home > System > Network). If the Wi-Fi section of the
Network page now has a MAC Address, then groov RIO is communicating with the WiFi adapter.
No WiFi adapter inserted; no MAC address WiFi adapter installed; MAC address available
ENABLING Node-RED
Node-RED is an open-source, multi-platform software program, where you connect (wire) together devices,
databases, cloud applications, and APIs (application programming interfaces) to create simple logic flows to
accomplish specific goals. It is pre-installed on your groov RIO; you do not have to download and install it on a
computer or embedded device. You just have to enable it, then start creating Node-RED flows. This tight
integration also means that some RIO functions, like backup, apply to your Node-RED projects.
By default, Node-RED is disabled. To enable it:
1. Log into your groov RIO with a user ID that has system administrator privileges.
2. In the groov Manage Home page, click Node-RED.
3. Click Enable. After the Status field says Running, wait a few seconds before opening the Node-RED Editor.
• Only the first 10 MB of files that you uploaded are included in the backup file.
• The files stored on the USB storage device are not included in the backup file.
When groov Manage performs a backup, it lists all the files it included into the backup file in the groov Manage
log file. You can check the log file to determine which other files you need backup by other means. (See
“Backing up Your groov RIO Settings” on page 91.)
1. Log into your groov RIO with a user ID that has administrator privileges.
2. Click System > Files. groov Manage displays the Files page.
If you had correctly mounted a USB storage device, it would appear in the USB Drives section, like this:
3. Upload a file.
To the internal file system, click Secured Files > Upload File.
To the USB storage device, click the name of the partition where you want to store the file, then click
Upload File.
a. Navigate to the folder that contains the file you want to upload and select that file.
b. Click Open. groov Manage uploads the file and then refreshes the Dir Listing section to list the file
you just uploaded.
c. If you need to upload another file, click Upload File and repeats steps a and b. For USB storage
devices, if you need to upload another file to another partition, click Back, select the other partition,
click Upload File and then repeats steps a and b.
When you are done uploading files, click Done.
If you have not determined this yet, here are a couple of options to help you select the right combination:
• RIO Explorer— An Opto 22 web app that can help you select a combination of functions, signal types,
and features, and make sure you select channels that can support your choices. When you finish with the
RIO Explorer, you can save a wiring diagram, which will come in handy when it’s time to wire up your
devices. Another way to you can use the wiring diagram is to annotate it with specification information
like ranges and scaling for analog inputs, or feature selections for discrete inputs. To learn how to use the
RIO Explorer, see Appendix C: groov RIO Explorer.
• Reviewing spec tables, feature tables, and wiring diagrams—Review the information in Appendix
A: Specifications and Appendix B: Wiring Diagrams as you follow these steps:
a. Review the features table to select which function, signal type, and, if applicable, which feature you
want for each channel. If you are working with CODESYS Development System, check the table on
page 68 for the list of features supported in that environment. You might find it helpful to note your
selections in a table like the one on the following page:
b. For each channel, check the corresponding section of the specification table and verify that you’ve
correctly selected everything. For example, if you selected a discrete input with a counter feature for
channel 0, go to the “Discrete Counter Input” section of the chart and verify that channel 0 is within
the range listed for “Available Channels”. Also check that the signal that is coming in (for inputs) or
leaving (for outputs) meets the specifications listed.
c. Review the wiring diagrams and check for any additional requirements; for example, any fusing
requirements. It may be helpful to print relevant wiring diagrams and annotate them with
information you collected in the previous two steps or additional information you may need when
it’s time to wire your field devices.
Taking the time to check your selections will make it less likely that you’ll run into trouble later on, and save
you time.
2. From the groov Manage Home page, click I/O Channels. The I/O Channels page displays a quick summary
of any channel configurations. If you are configuring channels for the first time, the page looks like this:
Depending on the channel type you select, groov Manage may change the content of channel
page. The following images show a few examples of how the page changes depending on the
channel type you select:
e. If you are transmitting values through MQTT, you want to enable the Value (Read) switch in the
Public Access section. When you do, groov Manage displays another set of switches to help you
identify the specific values you want available to send, as well as whether to make them writable.
f. Review the rest of the fields on the channel page and make changes based on the needs of your
application. For example, you may want to set a Watchdog timer on a channel or set the scaling
values for a temperature probe.
g. Click Save. groov Manage displays the channel page with information based on your selected
channel type. For the same examples shows in step d, this is what the channel page may look like:
When you are done configuring all your channels, groov Manage displays your selections on the I/O Channels
page.
If you haven’t already done so, wire your field devices to your RIO as described in “Connecting Field Devices”
on page 11.
4. Select the signal types and configure the features for each channel by editing the “plugged in” device’s
parameters.
Note: Throughout this section, instructions may use CODESYS terminology that differs from standard Opto 22
terminology. For example:
• In the CODESYS Development System interface, the term “device” refers to many different objects: a
controller, an Ethernet adapter, a field device, or an I/O module. In this guide, “device” typically refers
to a field device (a valve, a pump, a quadrature encoder, etc.). When you read sections of the guide
that do not discuss CODESYS, you can interpret references to “device” to mean the latter definition.
• In CODESYS terminology, a groov EPIC processor, a groov RIO, and channels on a groov RIO are
referred to as devices; throughout other sections of this guide, a groov EPIC processor is referred to as
a processor, a groov RIO is referred to as a RIO module, and a channel is referred to as a channel.
• An application, in CODESYS terminology, is roughly equivalent to a PAC control strategy in Opto 22
terminology.
Updating Device Information with the Latest Version of Opto 22 Library Package
If this is the first time you are adding a groov RIO device to your project, you only have to do steps 1, 2, 10, and
11. If you are updating existing RIO devices in your projects, do all of the steps.
1. Download and install the latest version of the library package from our website.
a. Go to the Opto 22 website, www.opto22.com.
b. Enter “Opto 22 Library Package” in the search box to find the page “Opto 22 Library Package for
CODESYS Development System” and click the link.
c. Click Download and save the package to the same computer where you installed CODESYS
Development System.
d. Open CODESYS Development System and install the package. For instructions on how to do this,
see Installing/Uninstalling a Package in the CODESYS Online Help.
2. Review the readme for the Opto 22 Library Package for CODESYS Development System. Pay particular
attention to the following:
– If the package requires a newer version of CODESYS Development System than your current version,
install the new version before proceeding further.
– Make note of any additional tasks you may have to do after updating device information; for
example, installing a new version of RIO module firmware.
Remember: If you are adding a groov RIO device for the first time, you can skip down to step 10.
3. Open your CODESYS project and, in the Device tree, expand the RIO device to see all the channels.
4. Right-click the RIO device and select Update Device.
5. If the Update Device window does not automatically select the correct RIO device, navigate through the
window to find it and select it.
6. Click Update Device.
CODESYS Development installs the new information about the RIO device. Now you need to update device
information for each channel:
7. Right-click on a configured channel on the RIO device and click Update Device.
8. In the Update Device window, select the same device type (if it’s not already selected). If applicable,
choose the highest version number. Click Update Device.
9. Repeat step 7 and step 8 for each channel on the RIO.
10. Save your project.
11. If you noted any additional tasks in step 2, make those changes now. Then, rebuild your project, test the
changes, and verify that your application works as expected.
b. Click on the Value column for the Address parameter. Enter either the hostname or the IP address of
the RIO, surrounded by single quotes.
2. In the Plug Device window, expand Miscellaneous, then select which signal you want to assign to that
channel (device).
3. Click Plug Device.
You can continue adding/configuring channels by clicking on another channel, selecting a signal type in
the Plug Device window, then clicking Plug Device.
4. Click Close when you are done.
A Features for an ICTD signal on a channel of a GRV-R7-MM1001-10. Compare the parameters list with
the list of features on the table for an analog input ICTD signal. All but two features are available on
CODESYS.
B Features for a digital output signal on channel 0 of a GRV-R7-MM1001-10. Compare the parameters
list with the list of features on the table for a digital output DC sinking signal. Only one feature is
available on CODESYS: Watchdog Timeout Value.
The following table lists the features for the functions and signal types that you can select and configure on a
GRV-R7-MM1001-10.
3. Double-click the device (channel) you want to configure. CODESYS Development System opens the
object view for that device. Check that the Parameters tab is selected.
4. Find the parameter (feature) you want to configure:
– For devices (channels) with scaling: If you want to set scaling values, first determine the upper
and lower ends of the scale. For example, if your input range is ± 150 mV and it is connected to a
tank that can hold 1000 liters, you can set the lower end of the scale (-150 mV) to represent 0 liters
and the upper end of the scale (+150 mV) to represent 1000 liters. With a signal type of Analog In
±150 mv (for example, on a GRV-R7-MM1001-10):
– On the Upper Scaled row, double-click the Value cell and enter 1000.
– On the Lower Scaled row, double-click the Values cell and enter 0.
To set default scaling, leave the Value cells blank or enter 0.
– For devices (channels) with clamping: If you want to limit the output sent out from the device
(channel), first determine the upper and lower end of that range. For example, suppose you want
the output range to be 5–15 mA. On a signal type of Analog Out 0-20 mA (for example, on a
GRV-R7-MM1001-10), to limit the range to 5–15 mA:
– On the Upper Clamp row, double-click the Value cell and enter 15.
– On the Lower Clamp row, double-click the Value cell and enter 5.
To set no clamping, set both Values cells to 0.
– For devices (channels) with counting: If you want to use the counting feature, you must select it.
On the Feature row, double-click the Value cell to display the drop-down arrow.
The Quality field shows you a message with an error code number and a possible reason for the error.
This information can help you troubleshoot problems with a field device wired to that specific channel.
WHAT IS MQTT?
MQTT is a publish/subscribe (pub/sub) protocol that’s suited to many IIoT applications because of its
architecture.
In a pub/sub architecture, a central source, called a broker, receives, distributes, and in some cases, retains
data. MQTT clients can publish data to the broker or subscribe to get data from a broker (or both). Clients who
publish data send it only when they choose to publish. Clients who subscribe to data automatically receive it
from the broker only when the publishers sends data.
Contrast this with a client/server architecture. With this architecture, the client and server must be connected,
because the client requests data directly from the server. The client doesn’t know when the data changes, so it
must request it at regular intervals.
MQTT pub/sub offers three main advantages over client/server for IoT applications:
• Network traffic is reduced overall because data is published and sent only when it changes, rather than at
regular intervals.
• Because the broker is a central source that manages data, the broker can take over the data management
workload typically handled by a server in a client/server model, and the server now handles fewer clients.
And even remote devices with irregular connections or low bandwidth can publish or subscribe to data.
If a publisher can’t connect to the broker, for example, the publisher can optionally buffer its data and
send it at a later time.
• For data publishers and subscribers, there’s another important advantage: data is published and
subscriptions are initiated through an outbound connection. Most firewalls block inbound connection
requests (for example, an external OPC client requesting data from an internal OPC server), but they allow
outbound connections over secure TCP ports. A device (in this case, RIO) initiates an outbound
connection through a secure port, and the traffic travels both directions through that connection.
See mqtt.org for more information about the protocol.
– Your application requires automation data from groov RIO, but not from other PLCs.
– You are looking for a cost-effective option. This option does not require the purchase of additional
licenses.
With this option, you will need to:
– Convert data within your application. With payloads formatted as strings, you will need to add logic
to your application to convert strings to the correct data type, when necessary.
– Define the topic namespace.
• MQTT with Sparkplug payloads published from groov RIO—Select this option if:
– Your application requires that the payload be formatted to comply with the Sparkplug specification.
– Your application requires automation data from groov RIO, but not from other PLCs.
– You are looking for a cost-effective option. This option does not require the purchase of additional
licenses.
With this option, you’ll be able to queue data into RAM if network connectivity is lost, which will then be
transmitted when the service is available. However, because the queued data is stored in RAM, it can be
lost when power is cycled or space runs out.
Keep in mind that you will need to:
– Define the topic namespace.
– Provide the MQTT configuration information through groov Manage and then enable the service.
Note that you cannot combine these two options; you must choose one or the other.
• For MQTT with string payloads, see “Configuring and Enabling MQTT with String Payloads” on page 72.
• For MQTT with Sparkplug payloads published from groov RIO, see “Configuring and Enabling MQTT with
Sparkplug Payloads from groov RIO” on page 75.
Collecting Information
You’ll need to collect or create the following information to uniquely identify your groov RIO in your MQTT
infrastructure. If necessary, consult with someone who assigns topics to determine if RIO will be assigned a
specific set of topics, and whether you should follow a particular naming convention. All of the following
information is required:
• MQTT Base Topic—The base topic is prefixed to the MQTT topic used to publish data.
• MQTT Group Topic—Identifies the group that your groov RIO belongs to
• MQTT Subgroup Topic —Identifies a subdivision within the group
In addition, you’ll need:
• MQTT Device Topic—Identifies your groov RIO within the subgroup
• Use Comma in Floats—If your application uses a comma to separate values (for example, pi is denoted
as 3,14 instead of 3.14), you’ll want to indicate that when you enter configuration information in
groov Manage.
You may want to review the following settings, which can affect throughput in an MQTT infrastructure.
Changing the settings can help you fine-tune throughput:
• CommTimeout (ms)—The default connection timeout value is 5000 milliseconds. You can adjust this
value to account for slower or faster infrastructures. (For example, if your groov RIO is in an area with
“spotty” or slow connection, you may want to increase this value.) Minimum is 1000; maximum is 30,000.
• Scan Time (ms)—The scan interval in milliseconds. You may need to adjust this if the scans can’t finish
before the time is up.
Enter the information you collected in “Specifying Default Topics for groov RIO” on page 73.
3. Click Add MQTT Broker.
Enter the information you collected in “Collecting information about the MQTT broker” on page 72. Click
OK to close the MQTT Broker window and return to the MQTT page.
Enter the information you collected in “Reviewing groov RIO Performance Settings” on page 73.
Note: Ignore the Additional Host Tasks field; RIO does not have host tasks.
5. Click Save. groov Manage validates the information you entered.
If it passes this validation, click Yes to confirm that you want to save these settings and start the MQTT
service. This may take a minute. When it is done, groov Manage displays the MQTT page.
Collecting Information
• SSL—If your MQTT server requires SSL, you need to upload the correct SSL certificate to your groov RIO
before you begin configuring the MQTT service. For instructions, see “Managing the SSL Security Features
of your groov RIO” on page 24.
• ConnTimeout (ms)—The default connection timeout value is 5000 milliseconds. You can adjust this
value to account for slower or faster infrastructures. (For example, if your groov RIO is in an area with
“spotty” connection, you may want to increase this value.) Minimum is 1000; maximum is 30,000.
• Keep Alive (s)—The number of seconds between heartbeats. If there is no heartbeat for longer than the
keep alive time, the last will and testament is sent.
• Compression—If you must compress the payloads before they are published to the MQTT server,
determine if it uses gzip or deflate.
You’ll need to collect or create the following information to uniquely identify your groov RIO in your MQTT
infrastructure. If necessary, consult with someone who assigns these IDs to determine if the processor will be
assigned a specific set of IDs, and whether you should follow a particular naming convention.
• Group ID—Identifies the group that your groov RIO belongs to
• Edge Node ID—Identifies a subdivision within the group
• Device ID—Identifies your groov RIO within Edge node
You may also need the Primary Host ID, which enables notifications as to the “state” (offline or online) of the
MQTT server.
You may want to review the following settings, which can affect throughput in an MQTT infrastructure.
Changing the settings can help you fine-tune throughput:
• CommTimeout (ms)—The number of milliseconds that the MQTT service waits for RIO to respond to a
request. If you set this value too small, you may see erratic communication timeouts.
• Scan Time (ms)—The scan interval in milliseconds. You may need to adjust this if the scans can’t finish
before the time is up.
• Historic Queue—The maximum number of Sparkplug publications that may be historically queued
when the connection to the broker fails. The value may range from 0 to 65535. You may want to change
this value after considering the following factors:
– The publications are stored in RAM, so storage can be consumed quickly when you specify a large
value. Also keep in mind these three factors that can influence how many Sparkplug publications
are created: how many tags are scanned, the scan rate, and the rate of tag changes.
– If the number of publications exceeds this value, the oldest entries are discarded to make room for
newer entries.
1. From the groov Manage Home page, click MQTT, then Configuration.
If MQTT with Sparkplug payloads is not listed in the MQTT Payload field, click on the field and select it
from the MQTT Payload window.
2. In the Edge Node section, enter the information you collected in “Specifying Unique Identifiers for groov
RIO and Other Settings” on page 76.
3. Click Add MQTT Broker. In the MQTT Broker page, enter the information you collected in “Collecting
information about the MQTT broker” on page 75.
Click OK.
Enter the information you collected in “Reviewing Performance Settings” on page 76.
Note: Ignore the Additional Host Tasks field; RIO does not have host tasks.
5. Click Save. Confirm that you want to save these settings and start the MQTT with Sparkplug service. This
may take a minute. When it is done, groov Manage displays the MQTT page.
6. Enable the service by clicking Enable in the MQTT Status section.
If you are new to Node-RED, it might be helpful to review our Automation 101 video introducing Node-RED:
Intro to Node-RED: Part 1 - Fundamentals. (You can find other videos in the Support > Videos section of our
website, www.opto22.com.) The “Learning to Develop a Node-RED Flow” section (below) will take you
through a hands-on approach to learning how to develop a Node-RED flow. However, before you can begin
those exercises or do anything else with Node-RED on your groov RIO, make sure you:
• Enabled Node-RED as described in “Enabling Node-RED” on page 56.
• Configured the channels on your RIO by one of the following methods:
– As described in Chapter 8: Configuring I/O.
– Configured through a PAC Control strategy.
– Configured through a custom control program.
Debugging. With few programming restraints, it’s easy to accidentally introduce bugs into your flow. The
Node-RED Editor can help you debug flows. If Node-RED crashes, it automatically restarts. You can also start
and stop Node-RED yourself from within groov Manage.
Files. Your Node-RED project consists of two files: the main file with all your flows, and a separate file
containing all the sensitive credential information used by some nodes, such as usernames and passwords for
an email node. groov RIO provides ways to backup and restore Node-RED projects, either separately or as part
of the complete backup and restore.
If you are new to the Node-RED Editor, take a moment to review the following diagram to familiarize yourself
with the different parts of the editor.
Tips
box
Creating a Flow
1. In the Nodes palette on the left, locate the inject node. Click and hold on it, then drag it to the workspace.
The inject node lets you inject messages into a flow, either by clicking the button on the node or by
setting a time interval between injects.
The info tab on the right side-bar displays information about the inject node’s properties and a
description of what it does:
You might want to close the Tips box so that you can see more information in the info tab.
2. Scroll down in the Nodes palette and locate the debug node. Drag it to the workspace.
3. Wire the inject and debug nodes together by dragging from the output port of inject to the input port of
debug.
This number is a timestamp representing the number of milliseconds since January 1, 1970. This is the
default payload of the Inject node.
Install tab
Search field
4. Find node-red-contrib-groov-io in the list and click the Install button next to it.
5. The Node-RED Editor displays a message about checking dependencies and reviewing node
documentation. Click Install. When installation is finished, the small Install button changes color to gray
and changes text to Installed.
While you are here, you can also install the groov View nodes. This will help you save some steps in the next
section, “Installing groov View Nodes to Access Data Stores” on page 85. The following image shows both nodes
installed.
6. Click Close.
The new groov I/O and groov View nodes appear in the nodes palette, under the heading Opto22.
Install tab
Search field
4. Find node-red-contrib-groov in the list and click the Install button next to it.
The Node-RED Editor displays a message about checking dependencies and reviewing node
documentation. Click Install. When installation is finished, the small Install button changes color to gray
and changes text to Installed.
The following image shows both groov I/O and groov View nodes installed.
5. Click Close.
The new groov I/O and groov View nodes appear in the nodes palette, under the heading Opto22.
3. Near the bottom of the Nodes palette, click and hold on the pac read node and drag it to the workspace,
in between inject and debug (msg.payload).
The pac read node lets you read I/O and variable data in the PAC Control strategy.
4. Wire the pac node to the inject node and debug node, in the same way you wired the Function node.
5. Click the node and click the info tab to see helpful information about the node.
6. Double-click the pac read node to edit it.
a. Tag Name—Enter the exact I/O point or variable name from the PAC Control strategy running on
this controller. If you leave this field blank, you’ll receive values for all tags of this type (in this
example, all analog inputs).
b. Start Index and Length—For a table, enter the starting index and length of the data you want to
use.
c. Node Name—(Optional) By default, the tag name is used for this node. If you want to give it a
different name, enter it here.
d. Click Done.
10. Click the down arrow next to Deploy to see your choices.
The gray box around the icon shows what will happen when you
click the Deploy button. In this example, everything is deployed
(Full).
11. Click Deploy. Now click the inject button and see what message appears in the debug tab.
You should see the data from your PAC Control strategy. Here’s how our example looks:
You’ll want to maintain your groov RIO units regularly to keep them up-to-date, running smoothly, and to
make it easier to restore in the event of a reset:
• Back up your information regularly
• Apply firmware updates
If you encounter problems while operating your groov RIO unit, here are a few things you can do:
• You can troubleshoot some problems and, if you can’t resolve your problems, there are some steps you
can take to help Product Support solve your problems.
• If you had to restore your processor to factory defaults, you can restore the information that you backed
up.
3. On the Backup page, select the information you want to back up by moving the corresponding slider to
the right so that it shows green ( ). By default, everything except Server SSL Certificates and
network configurations are backed up. If you do not want certain information backed up, move the slider
to the left so that it shows grey ( ).
– I/O Configuration—Saves the changes you made to the channels at the time you ran the backup.
– Accounts—The user IDs and passwords, plus the scope of each user ID’s access.
– Networking—Saves all of the following:
– Hostname
– The settings for the Ethernet 0 (ETH0) and WiFi.
– The settings for the OpenVPN Tunnel 0.
– The settings for the Network Options (DNS server IP address(es) and domain name(s), gateway
IP address, the DNS order, and the gateway order).
This also includes sensitive information like the WiFi SSID and pre-shared key, and the OpenVPN
server login credentials. If you select this setting, it’s important that you apply your own security or
encryption to the backup file to protect this information.
– Firewall—The firewall settings you selected, as well as any rules you created.
– Time—The time zone and time servers configurations.
– Node-RED—Part of a Node-RED project can include a credentials file, which can contain sensitive
information like user names, passwords, and security keys. It’s important that you apply your own
security or encryption to the backup file to protect this information.
Remember that any nodes you installed (like Opto 22 nodes or nodes to access cloud services) are
not included in the backup.
– MQTT/Sparkplug—The information you entered or selected when you configured your groov RIO
unit to work with Sparkplug.
– Client SSL Certificates—The most recent SSL certificates you may have uploaded.
– User Files—Only the first 10 MB of files you uploaded manually or were placed there by control
programs. After you create the backup file, you can review the log file to see which user files were
stored in the backup file and which were not.
– USB Settings—The enable and automount settings you chose.
– Server SSL Certificates—The server SSL certificates include sensitive information, like the web
server’s private key. If you select this setting, it’s important that you apply your own security or
encryption to the backup file to protect this information.
4. Click Download Backup.
5. Navigate to the folder or media where you want to store the backup file. groov Manage includes the date
and time (in UTC) that you ran the backup as part of the file name. If you want to give it a different name,
change the name in the File name field. Click Save.
NOTE: Some browsers might automatically download the file to a specific folder. Check your browser’s
downloads settings to determine where the browser stored the backup file.
6. Opto 22 recommends that you apply some form of security on the backup file.
7. (Optional) To check which user files the backup may have missed, in groov Manage, click the menu
button ( ), then select Info and Help. Click Logs > groov Manage.
Review the log file for the list of user files that were and were not included in the backup file. Look for
lines like the following:
A—These lines indicate that groov Manage started backing up user files.
B—This line indicates the first user file that groov Manage backed up.
8. Compare the list of files in the log with the list of files in the Internal Drive section of the Files page. (From
the groov Manage Home page, click System > Files.) Note any differences and download those files.
8. Click Restore and Restart. groov Manage displays a message that shows progress:
9. When the restoration is done, groov Manage shows you this message:
Click Next.
10. groov Manage shows you a message that gives you a few tips about what you might need to do next.
Read the message and then click Close.
11. groov RIO restarts. Wait for the groov RIO login screen and log back in with any user ID that has
administrator authority and was stored in the backup file.
12. Review the configuration settings for things like I/O, date and time, and network, to assess whether you
need to make additional changes that were not stored in the backup file.
13. Because the backup files contain only the first 10 MB of user files, if there were any additional files that
weren’t included in those 10 MB, upload them.
2. Log on to opto22.com and enter the part number for your groov RIO in the Search box. Select the search
result that includes “Firmware” as part of the title; for example GRV-R7-MM1001-10 Firmware.
3. Click Download. Save the file to either:
– A computer or mobile device that can connect to your groov RIO, or
– Media that you can then install to a computer or mobile device that can connect to your groov RIO.
4. On the same computer or mobile device where you saved the firmware file, log into your groov RIO with
a user ID that has administrator privileges.
5. From the groov Manage Home page, click Maintenance > Update.
6. On the Update page, decide:
– If you want to save all your current settings and then have the groov RIO restore them after the
restart, leave the Back Up Settings slider in the default position (the slider shows green). Leaving this
setting on will also save you some steps later on.
If you created a backup file in step 1, note that the information in that backup file may not be the same as what
groov Manage stores in the backup it creates as part of this step.
– If you do not want the settings saved and restored after the restart, move the slider to the left so that
it shows gray ( ). You’ll want to select this if you want to restore your groov RIO with settings
from a different backup file; for example, the one you created in step 1.
10. If you are ready to proceed with the update, click Update and Restart.
groov Manage displays an Update message, which shows you the progress of the update. The update can
take several minutes to complete. During that time, the banner (in the background) changes color to
yellow.
11. Watch for the banner to turn red, which indicates that the update is finished and groov RIO is now offline.
Review the messages and then click Next.
12. Read the instructions on what to do after groov RIO restarts, and then click Close.
13. If you can see the groov RIO unit, monitor the STAT LED. When it shows solid green, the restart is finished
and the browser refreshes. If you can’t see the RIO unit, you will know that the restart is done when the
browser refreshes.
Note: If the browser doesn’t refresh after about 5 minutes, refresh it by pressing F5 or CTRL+R.
14. When the restart is done, you see one of the following screens.
If you see the Welcome! screen (you’ll see this screen if you deselected the Back Up Settings option in
step 6 on page 96):
a. Make a note of the IP address shown in the Eth0 IP Address box. You’ll need it in the next few steps.
b. Click Let’s get started! and create an administrator user ID and password. (It does not have to match
any that might be stored in a backup file; however, you still do have to remember to store it in a safe
location for later recall.)
c. Click on Configure Device.
d. If you want to restore a backup file, do that now.
If you see the login screen (you’ll see this screen if you selected the Back Up Settings option in step 6
on page 96), log into your groov RIO with a user ID that has administrator privileges.
If you see neither screen (likely because your network settings were not backed up as part of the
update), use groov Find to get the IP address or hostname of the unit. See “Downloading and Running
groov Find” on page 100.
15. If you were developing and running Node-RED flows, re-install any nodes required by your flows. For
example, to re-install the Opto 22 nodes:
a. Click the menu button ( ) > Manage palette > Install tab.
b. Search for node-red-contrib-pac.
c. Click the small Install button.
Repeat the previous steps for any other nodes required by your flows.
If you do not re-install these nodes and you try to run your flows, you’ll receive messages that your flows
cannot run due to missing nodes.
TROUBLESHOOTING
• Verify that the Ethernet cable that you inserted into the RIO’s Ethernet port is connected to the network.
• Make sure the STAT LED is solid green before you attempt to connect to your RIO. (For a diagram that
shows you where the STAT LED is located, see page 8.)
• Check that the LED of the Ethernet port (ETH0 or ETH1) is showing link speed and activity. (For an
explanation of LED activity, see page 8.)
• If the RIO is connected to a network that does not automatically assign IP addresses to new devices
(which typically means the network is not managed by a DHCP server), download groov Find to help you
locate your groov RIO on your network (see below). You must use groov Find if your network does not
have DNS.
groov Find is an application available on our website (for Windows PCs) or the Mac App Store (for Mac
computers) that can help locate groov RIOs, groov EPICs, and groov Boxes on your network.
NOTE 1: If you are using a Windows account that does not have Administrator privileges (such as Guest), you
will need to enter the Administrator User Name and Password in order to use groov Find. If you do not have this
information, contact your IT department.
NOTE 2: Clicking Yes permits Find to have temporary administrative privileges to create an additional temporary
IP address for each network interface on the computer. This enables Find to locate a groov device on a network
that does not have DNS and DHCP. If the network does not have DNS and DHCP, you will need to assign a static
IP address to the groov device in order to maintain communication. If the network does have DNS and DHCP,
the temporary IP address is not used and is removed when you exit Find.
3. Click Yes.
groov Find opens and automatically searches for groov RIOs, groov EPICs, and groov Boxes on the
network.
4. Locate the serial number on the groov device.
– On groov EPIC, open the LCD display and look at the label on the back of the display.
– On a groov Box, find the label on the bottom of the Box.
– On a groov RIO unit, the label is on the unit’s side. The serial number is indicated by SN.
Serial number
If you do not see the serial number right away, wait 60 seconds and click Search For Devices.
6. Click the link for groov Manage.
download your project. When this happens, you’ll see the following messages on the channels that are
incorrectly configured:
To correct this problem, move the problematic signal type to a channel further away. In this example, we
move the digital sinking output from channel 1 to channel 7:
2. When instructed, click Create RSC to initiate the session. For detailed instructions and an explanation of
what happens during this step, see “Initiating an RSS Session” on page 104.
3. After the session is successfully created, you and your OptoSupport team member will review details of
your situation and discuss additional steps. These steps might be:
– Continue active discussion of the problem over the phone while the OptoSupport team member
diagnosis and troubleshoots your groov RIO.
– Agree to a plan of action where you can end the phone call while the OptoSupport team member
continues to diagnose and troubleshoot your RIO.
If the session is lengthy, part of the plan might include pausing the session and continuing it at a later
time. For additional instructions on pausing and resuming a session, see “Pausing and Resuming an RSS
Session” on page 105.
4. When it’s time to end the RSS session, click Delete RSC. For important information on what happens
when you end an RSS session, see “Ending the RSS Session” on page 106
3. When instructed by the Opto 22 Support team member, click Create RSC.
The first thing you see is the OptoSupport Remote Support Service Permission and Release Agreement.
To proceed with the session, accept the agreement.
4. After you click Accept, groov Manage displays a message to indicate the progress of establishing the
connection before it starts a connection:
– While your groov RIO is trying to connect, you see this message on the OptoSupport RSS page:
– After the connection is established, you see this message on the OptoSupport RSS page:
Do not turn off your groov RIO after you start the session, or you will need to start this process over.
• To resume a session, click Continue RSC in the OptoSupport RSS page (Info and Help > OptoSupport
RSS). After the connection is re-established, the OptoSupport RSS page displays the status as Connected.
GRV-R7-MM1001-10
You can configure the GRV-R7-MM1001-10 (a multi-signal, multifunction edge I/O unit) with any combination
of the following inputs and outputs:
• Up to 2 electromechanical relays
• A combination of up to 8:
– discrete or analog inputs
– discrete or analog outputs
Features are listed on the next page; specifications are listed in the page that follows.
Features
Features
On/off State x x x x
On/off Latching x
Counting x
On/off Totalization x
Frequency Measurement x
Period Measurement x
Pulse Measurement x
Scaling x x x
Offset and Gain x x
Minimum/Maximum Values x x
Average Filter Weight x x
Simple Moving Average
Analog Totalizing x x
Output Pulsing / TPO x
Ramping x
Clamping x
Watchdog Timeout Value x x x
Quality Indication x x x
Specifications
Specification GRV-R7-MM1001-10
Voltage Input
Current Input
ICTD Input
Specification GRV-R7-MM1001-10
Thermocouple Input
Millivolt Input
Discrete DC Input
Specification GRV-R7-MM1001-10
Specification GRV-R7-MM1001-10
Available Channels 8, 9
Line Voltage Range 0–250 V AC or 5–30 V DC
Clamp Voltage 440 V nominal
Current Rating 5 A per channel
Surge Current 6 A peak for 1 second
Recommended Fuse / Circuit Breaker 5 A at 250 V AC / > 30 V DC per channel
Initial Contact Resistance < 100 milliohms
Turn On Time 8 ms
Turn Off Time 4 ms
Operating Life (to specification) Min. 30,000 cycles at max. ratings
Mechanical Life Min. 10,000,000 cycles
Voltage Output
Current Output
Specification GRV-R7-MM1001-10
Common Specifications
Two switched Gigabit ports; daisy-chainable; ETH1 with 802.3af PoE powered
Ethernet
device (PD)
USB One Port, USB 2.0 HS
Memory 1 GB RAM, 2.5 GB user space
Power Supply 802.3af PoE Class 0 or 10–32 V DC
Power Consumption 10 W
Max. Survivable Input (channels 0 - 7) 32 V DC
Isolation (between channels 0 - 7) None
Isolation (between channel 8 or 9 and all others) 3000 V ACrms 1 min.
Isolation (field to Ethernet / power input) 1500 V ACrms 1 min.
Minimum GRV-EPIC-PR1 Firmware Version 2.0.0
Minimum PAC Project Version 10.3000
Minimum Library Package for CODESYS Version 2.0.0.0
Field Connector Wire Size 28–14 AWG
Torque, field connector screw 2.5 in-lb (0.28 N-m)
Power Connector Wire Size 22–14 AWG
Torque, DC power connector screws 7.0 in-lb (0.79 N-m)
Torque, panel mount tab screw 2.0 in-lb (0.23 N-m)
Temperature (operating) -20 °C to +70 °C
Temperature (storage) -40 °C to +85 °C
Relative Humidity (non-condensing) 5–95%
Agency Approvals UL/cUL(Class 1 Div. 2); CE, ATEX(Category 3, Zone 2), RoHS; DFARS; CB Scheme
Warranty 30 months
Wiring Assignments
These assignments apply to the thermocouple input signal type.
Type - + Range
B Red Gray +90 °C to +1,820 °C
E Red Purple -80 °C to +1,000 °C
J Red White -100 °C to +1,200 °C
K Red Yellow -80 °C to +1,372 °C
N Red Orange -100 °C to +1,300 °C
R,S Red Black 100 °C to +1,768 °C
T Red Blue -60 °C to +400 °C
The groov RIO Explorer is an online app that helps you see different combinations and arrangements of
channel configurations and their associated wiring diagrams. With the app, you can:
• Identify which channels support a specific combination of function (input or output) and signal type
(analog, discrete, voltage, current, ICTD, thermocouple, etc.).
• Move any signal that you placed on one channel to another supported channel.
• Avoid assigning a combination of function and signal type to a channel that does not support that
particular combination.
• See a wiring diagram of the combination you built, plus different ways to arrange that combination.
• Export or import a combination into text description.
• See samples of wiring configurations from over 61,000 possible combinations.
I D
B
G H E
F
1. Look through the options on the right. Look in either the input or the output list and choose the signal
type you need.
For example, if you need an ICTD input, look in the Input Signals list and find ICTD.
If you need a voltage output, look in the Output Signals list and find Voltage Output.
2. Click Place next to the function and signal type you need.
The Explorer places that function and signal on a channel that supports that combination. For example,
your ICTD input might appear like this:
If you don’t like where the Explorer placed your signal, see “Moving and Deleting Signals” on page 120.
3. Repeat the previous steps for each additional channel you want to configure.
The Explorer will not let you place functions and signals into channels that don’t support them.
4. Click Show wiring to see a diagram that illustrates wiring for all your selections.
Below are three examples of images of wiring diagrams created by the groov RIO Explorer for function and
signal type assignments made to channels on a GRV-R7-MM1001-10.
5. If you want to save your wiring diagram as a re-sizable image file, click Download image as SVG file.
To leave the wiring diagram, click Explore signal connections.
To see which channels can be configured with a specific function and signal, find the function and
signal in the lists at right. Click the FIND CHANNELS button, and the Explorer highlights the channels that
support that combination.
For example, if you want to see which channels will accept a smart discrete input with features like counting,
latching, and totalization, click its Find Channels button. Channels 0 and 1 are highlighted, so you can place
that signal on either (or both) of those channels.
Replacing a Signal
1. Click the placed signal.
2. On the right side of the Explorer, find your new function and signal type.
4. Click Replace.
Exporting
1. To export a combination, click Import and Export
to expand that section.
2. Click Get Description.
The Explorer places abbreviations for the functions
and signal types in the text box. (See below for the
abbreviations used.)
3. Copy the text, paste it into a text file, and save it.
The following abbreviations identify functions and signal types:
Inputs Outputs
ai_voltage ao_current
ai_mv ao_voltage
ai_current do_sinking
ai_ictd do_formc_no
ai_thermocouple do_formc_nc
di_discrete
di_smart_discrete
di_switch_powered
• ai—analog input
• ao—analog output
• di—discrete input
• do—discrete output
Importing
1. To import a combination, click Import and Export to expand the section.
2. Paste all the text from the text file you saved into the box. Click Import Configuration.
The RIO Explorer assigns the functions and signals to the channels, verifying that they are correct. There
may be a delay while verifying.
Note that the channels may not end up in the same order you originally configured.
You can also type function/signal abbreviations into the field, and the Explorer will place them. It uses the
first eight valid signals for channels 0-7 and the first two for channels 8 and 9. (Any text not in the correct
abbreviation format is ignored.) So for example, to import channel assignments like the first wiring
diagram on page 120, you could type the following into the text box:
ai_mv,ai_current,ai_current,ai_ictd,di_discrete,di_discrete,
di_switch_powered,ao_current,do_formc_no,do_formc_nc
One sample in particular can give you a good idea of the versatility of GRV-R7-MM1001-10. To see it, click Load
Sample Configuration. The Explorer replaces any signals in the Placed signals area with the signals that are in
the sample configuration.
Samples are numbered 0 to 61259. Type in any number in that range in the text box, then click Load
Combination to view that sample configuration. Have some fun with the numbers: enter a special date, the
final score of your favorite football game, or the altitude of your favorite mountain.
How many ways are there to wire the same combination of functions and signals? For many samples
or even for a configuration that you created, the arrangement of functions and signals on the channels can be
changed. Seeing another way to wire the same signals can be useful if you have space constraints. The groov
RIO Explorer can calculate the number of ways a particular combination can be rearranged. To learn that
number and view the arrangements, click Calculate Arrangements for this Combination.
The RIO Explorer displays the result along with a drop-down list. Click the drop-down list and select any
number, and the Explorer shows that arrangement. You can scroll through the numbers by pressing the up
and down arrows on the keyboard. You’ll see the Explorer update the image with each new arrangement.