Modbus GPIO Modules

Numato Lab’s ZGX16/32/64 and EG16/32 Channel DIN Rail compatible Modbus RTU/TCP GPIO Module with Digital IO and Analog Inputs offers great flexibility at a lower cost.  Ease of use and wider operating system compatibility are the primary goals behind this product’s design. Built-in USB to serial conversion allows the module to be used without any USB specific knowledge. Industry-standard Modbus protocol support allows this product to be used with most automation software that supports Modbus. For power users, this module can be controlled by writing programs in various programming languages of their choice.

Features:

• Industry-standard Modbus protocol support
• DIN Rail compatible
• 16/32/64 TTL (3.3V) compatible Digital IOs for ZGX series and 16/32 TTL (3.3V) compatible Digital IOs for EG series devices
• 8/14/32 analog inputs for ZGX series and 8/14 analog inputs for EG series boards with 12-bit resolution (multiplexed with Digital IOs)
• USB interface with CDC support. As easy as using a serial port, no USB knowledge required
• Fully isolated design with optocouplers and built-in DC-DC converter
• 12V external power supply (included)
• Can be controlled by using industry-standard automation applications or custom applications

Some of the possible uses of this module include

• Home Automation
• Lighting Control
• Garden Equipment Control
• Industrial Automation
• Test Fixtures
• DIY and Hobby

This product is compatible with the following operating systems:

• Windows XP and later versions (Windows 7, 8/8.1, 10 and future versions)
• Windows 7 Embedded and later
• Linux
• Mac OS X
• Android
• Or any other operating system that supports USB CDC devices.

And these are some of the languages and software that can be used for programming:

• C/C++
• Visual Basic (VB6, VB2008, VB2010 express and other editions)
• Visual Basic for Applications (Microsoft Office VBA)
• Perl
• Python
• JAVA
• Android
• JavaScript (Node.js)
• LabVIEW
• And many more…

ZGX series has 16/32/64 on board General purpose I/Os multiplexed with 8/14/32 Analog Inputs and EG series has 16/32 onboard General purpose I/Os multiplexed with 8/14 Analog Inputs, each connected to individual screw terminals and associated drivers capable of controlling a variety of devices Sensors, LEDs, LCD displays, etc… The module communicates with host PC over a full-speed USB link, RS485, and Ethernet interface. When connected to PC using USB/RS485, the module will appear as a serial port in Windows Device Manager (or a serial tty device in Linux and Mac).

Using this product is very easy,  thanks to supporting industry-standard Modbus protocol, the RTU and the TCP/IP network interface that allows the device to be used with most readily available Data Communication Test Software like QModMaster.  This document has more information about using this device with the following software. But in no way limited to this software though.

• Windows
  • QModMaster
  • Radzio! Modbus Master Simulator
• Linux
  • Coming soon
• Mac OS X
  • Coming soon

Using this product with RTU involves the following simple steps.

1. Connect the device using a USB A to B cable or a USB to RS485 converter to the host system
   
2. Install driver if applicable
3. Open the COM port corresponding to the device using software that supports Modbus
   
4. Read/Write Coils and Registers
   
5. Optionally write a script or custom application to automate your task

Using this product with TCP/IP Network interface involves the following steps.

1. Connect the device using a CAT 5e Ethernet Cable(Straight through cable) to the host system
   
2. Connect to the IP corresponding to the device using software that supports Modbus TCP
   
3. Read/Write Coils and Registers
   
4. Optionally write a script or custom application to automate your task

All aspects of the above steps are covered in the following sections including step by step demonstration.

Along with your Prodigy ZGXxx/EGxx device, you will need the items in the list below for easy and fast installation.
1. USB A to B cable (Included) – For USB Interface.
2. CAT 5e Ethernet Cable(Straight through cable) – For Ethernet Interface.
3. USB to RS-485 Converter – For RS485 Interface.
4. 12V Power Supply (Included).
5. Medium size Philips screwdriver.

The picture above shows a basic connection diagram that can be used in most of the situations. The connection diagram is the same for both AC and DC loads. Please make sure to use a freewheeling diode or snubber circuit if the load is inductive. More details about using inductive loads are available elsewhere in this document. Use a USB A to B cable to connect the unit to a PC. It is important to make sure that the wires used to connect loads are sufficiently rated to handle the expected load current. Exercise caution while working with high voltages. Short circuits can cause damage to the module and the PC. The following sections identify individual connections in detail.

The onboard full-speed USB controller helps a computer to communicate and control this module seamlessly. Use a USB A to B cable (Included) to connect the unit to a PC. The device can be connected directly to the host PC or connected through a compatible USB hub. For high-performance system integration, it is recommended to connect the device directly to one of the root ports.

A USB to RS485 converter helps a computer to communicate and control this module seamlessly. Use a USB to RS485 converter to connect the unit to a PC. The device can be connected directly to the host PC or connected through a compatible USB hub. For high-performance system integration, it is recommended to connect the device directly to one of the root ports.

The onboard Ethernet port supports Ethernet 10Mbps transmission speed that helps a computer to communicate and control this module easily. There are two basic network configurations for this board/can be used in two ways.

1. Direct connection to Local Area Network(LAN) via common straight-through Ethernet cable.
   Eg: Connecting the module to a switch in a network.
2. Direct connection to a PC through a cross over Ethernet cable. Eg: Connecting the module directly to the PC. Some PC/Laptops can detect and adapt to the cable type. In such situations, a straight-through cable also can be used.

Prodigy ZGXxx device has 16/32/64 General Purpose IO pins and Prodigy EGxx device has 16/32 General Purpose IO pins that can be used for various custom applications. ZGXxx has 8/14/32 Analog Inputs and EGxx has 8/14 Analog Inputs depending on the device. All IO pins support 3.3V TTL signals and the ADC input range is 0 to +3.3V. The ADC can acquire the analog signal at the resolution of 12 bits per sample. It is recommended to use a series resistor with the GPIO/ADC pins when interfacing with other circuits. In output mode, GPIOs can source up to 20mA. So no additional circuitry is needed to drive regular LEDs. A 470 Ohms series resistor is recommended for current limiting when connecting LED to a GPIO.

In contrast to GPIOs, Analog inputs can read voltages at any level between 0 to 3.3V. It is recommended to use a series resistor to protect the input from stray voltages and spikes. The internal Analog to Digital converter supports 12 bits resolution which is adequate for most applications. The table below summarizes the GPIO and Analog to Digital Converter input positions of ZGX16/EG16 on the screw terminals.

The table below summarizes the GPIO and Analog to Digital Converter input positions of ZGX32/EG32 on the screw terminals.

And the table below summarizes the GPIO and Analog to Digital Converter input positions of ZGX64 on the screw terminals.

This product requires an external 12V power supply to function. The power supply unit required is included with the product. Connect the power supply to the connector on the product marked as +12V power. This product uses single power supply for the digital circuitry and the GPIO coils. An internal isolated DC-DC converter and a set of optocouplers ensure galvanic isolation between the digital circuitry and the GPIO coil driver circuitry.

The driver package for Numato Lab’s Prodigy models can be downloaded from the product page at https://numato.com. To install the driver, unzip the contents of the downloaded driver package to a folder. Attach the USB cable to the PC and when asked by Windows device installation wizard, point to the folder where driver files are present. When driver installation is complete, the module should appear in Windows Device Manager as a serial port. The picture below shows a Prodigy ZGX64 visible in Windows Device Manager. For other ZGX/EG devices, the name will be different but how the device is displayed and used is exactly the same.

Note down the name of the serial port (COM1, COM2, etc..). This information is required to control the module from the PC.

You may notice that the driver package does not come with a .sys or .exe file as most driver packages do and are expected to be that way. The driver binary necessary in this case is shipped with all copies of Windows Desktop/Server editions and gets installed automatically while Windows is installed for the first time. The .inf and .cat files present in the driver package downloaded from http://numato.com merely associate this pre-existing driver with the attached Numato Lab device.

The following video demonstrates how to install the driver on Windows 10.

Windows Embedded editions do not install the infrastructure necessary for USB CDC by default in favor of a smaller footprint. This will cause the driver install to fail unless the necessary files are manually installed prior to installing the driver. Please follow the steps below to install the prerequisites and driver correctly. These steps are tested on Windows 7 Embedded Edition. The installation procedure may vary for other versions of Windows Embedded. Please contact Microsoft for more information.

1. Locate winemb-inf-mdmcpq.cab on Win 7 Embedded DVD/ISO image
2. Copy winemb-inf-mdmcpq.cab to a folder Ex: C:Temp
3. Run command DISM.exe /online /Add-Package /PackagePath:C:Temp
4. Wait for Windows to restart (Restart machine manually if DISM does not restart the machine automatically)
5. After the reboot is complete, plug the device to a USB port and install driver normally (Driver is available for download at the product page)

To use any device that uses USB CDC protocol with Linux, USB CDC driver needs to be compiled into the kernel. Fortunately, most Linux distributions (Ubuntu, Redhat, Debian, etc..) have this driver pre-installed. The chances of you requiring to rebuild the kernel to include the USB CDC driver is very slim. When connected to a Linux machine, this product should appear as a serial port under /dev directory. Usually, the name of the device will be ttyACMx or similar. The name may be different depending on the Linux distribution you have. The image below shows the result of ls /dev command on a Linux Mint system with a USB GPIO/Relay device attached.

In this particular case, the device shows up as ttyACM0 (highlighted in orange color) but it could be ttyACM1 or ttyACM2, etc… depending on the specific system and other connected devices. Once the device is visible under /dev directory, it can be treated just like any other serial device. Commands can be sent to the device using any mechanism that is valid for regular serial ports such as screen command or Serial Terminal Emulation applications. If there are more than one device connected to the same host computer, each device will be displayed as separate serial devices with unique names. These separate serial devices can be used to control individual devices attached.

Mac OSX is usually shipped with USB CDC driver pre-installed. When connected to a Mac computer, this product should appear as a serial port under /dev directory. Usually, the name of the device will be tty.usbserialportx or tty.usbmodemx or similar. The name may be different depending on the Mac OSX version you have. The image below shows the result of ls /dev/*usb* command on a Mac OSX Yosemite system with a USB GPIO/Relay device attached.

In this particular case, the device shows up as tty.usbmodem141141 (highlighted on orange color) but it could be any name starting tty.usbmodem  or even a completely different name depending on the exact version of operating system and other connected devices. Once the device is visible under /dev directory, it can be treated just like any other serial device. If there is more than one device connected to the same host computer, each device will be displayed as separate serial devices with unique names. These separate serial devices can be used to control individual devices attached.

Prodigy ZGX/EG series Modbus GPIO Modules use the Modbus protocol for its primary interface. Modbus is a simple yet powerful industry-standard protocol that was originally developed by Modicon systems for transmitting/receiving information over serial links. Prodigy devices use USB/RS485 and TCP/IP as physical interfaces. Since the device uses the USB interface, it represents itself to the operating system as a classic serial device which makes Modbus a very suitable protocol for this product. This also completely hides the complexities of using USB protocol and thus making Prodigy devices as easy to use as a normal serial device.

Coils

Coils are a single bit data type that represents the output state of a single bit entity such as Relay or a GPO. Please note that Coils are always used to represent an output quantity. Writing to a coil will update the output quantity with the value written. Reading a coil will return the data that was previously written. For example, writing “1” to a coil that represents a GPIO will turn ON the GPO and vice versa. Reading from a Coil that represents a turned OFF GPO will return value “0”. The Address in the table below shows the position of each coil within the Modbus register map. There are a set of 16/32/64 coils corresponding to the GPIOs on ZGX16/EG16/ZGX32/EG32/ZGX64. The data address of the Coils can be used to access the corresponding GPO.

Discrete Inputs

Discrete Inputs are a single bit data type that represents the input state of a single bit entity such as a GPI. For example, by reading the Input bit corresponding to a GPI, the user can get the state of the logic (HIGH/LOW) externally applied to the GPI.

Holding Registers

Input Registers

Let’s look at how to write values to each register.

Holding registers and its format are explained in the table below:-

Similarly, input registers’ format is as follows:-

Prodigy ZGX/EG devices’ support for Modbus protocol makes it easier to use with virtually any software that supports Modbus. This section of the document demonstrates how to use Prodigy ZGX/EG devices with some of the software that is available in the market.

QModMaster is a free software that emulates Modbus master and can be used to access any device that is Modbus compatible. QModMaster can be downloaded for free at https://sourceforge.net/projects/qmodmaster/. Follow the steps below to see how to use Prodigy ZGX/EG devices with QModMaster using RTU and TCP.

Download and install QModMaster.

To control the device via Modbus RTU, follow the simple steps given below:

Step 1:

Run QModMaster and select “Modbus RTU” from the Options menu. Enter Serial Port name and other settings as in the image below and click OK. Serial Port name must match the port name assigned to the device by the Operating System.

Step 2:

1. Select RTU as Modbus mode.
2. Select the proper Slave ID of the device.
3. Then, click the “Connect” button to connect to the device.

Step 3:

1. Select the “Write Single Coil” function code in the Function Code combo box, enter the Data Address of the first GPO (GPO Index 0) in the Start Address box.
2. Enter value 1 (corresponds to GPO High state) in the data cell.
3. Now click the Read/Write button to send the new value to the device.

If everything works fine, you will see the circuitry connected to the GPIO will be activated. To read the status of a GPO, the same sequence apply but select the “Read Coils” function code instead.

Similarly, to control the device via Modbus TCP, follow the steps below:

Step 1:

Run QModMaster and select “Modbus TCP” from the Options menu. Enter the IP Address of the device and TCP port number as in the image below and click OK.

Step 2:

1. Select TCP as Modbus mode.
2. Then, click the “Connect” button to connect to the device.

Step 3:

1. Select the “Write Single Coil” function code in the Function Code combo box, enter the Data Address of the first GPO (GPO Index 0) in the Start Address box.
2. Enter value 1 (corresponds to GPO High state) in the data cell.
3. Now click the Read/Write button to send the new value to the device.

If everything works fine, you will see the circuitry connected to the GPIO will be activated. To read the status of a GPO, the same sequence apply but select the “Read Coils” function code instead.

Prodigy ZGX/EG devices do support Analog to Digital Conversion on some of the GPIO terminals. A list of GPIOs that supports analog function in this product is listed elsewhere in this document. GPIOs don’t need to be configured especially in order to use them as analog inputs. Simply reading the Analog Input Register corresponding to the IO will automatically put the IO into Analog Input mode and read the analog value. The resolution of the ADC on this product is 12 bits. The input voltage range of the ADC is 0 – 3.3V.

It is possible to read the position of a switch that is connected to a GPIO. An SPST or SPDT switch is recommended to use with GPIOs. Push switches that maintain the contacts closed only for a very short time so using them is discouraged. The fundamental idea of using a switch with GPIO is to have the switch cause a voltage level change at the GPIO pin when pressed. Usually, this is achieved by using an external pull-up resistor along with the switch. The pull up resistor is connected between the GPIO and VDD and the switch is connected between the GPIO and ground. When the switch is not pressed, the pull-up resistor will cause the GPIO to stay at the VDD voltage level. When the switch is pressed, the GPIO is short-circuited to the ground and stays at zero voltage. This change in voltage and thus the position of the switch can be read by simply reading the Discrete Input bit corresponding to the GPIO.

Q. What are the serial parameters I need to use when communicating with this board?
A. Since this module uses USB as the underlying transport mechanism, most of the serial parameters do not affect the communication. You can leave all parameters to any legal value (Eg:9600,19200,38400 etc… for baud rate) except Flow control. Flow control needs to be set to “None”.

Q. Where do I find the driver for this product?
A. Visit http://numato.com and navigate to the product page. There will be a link to download windows driver. Linux does not require driver installation since in most cases they are shipped with the driver pre-installed.

Q. Why there is no .sys or .exe file in the Windows driver package I downloaded?
A. This product uses the USB CDC driver binary which is already present on Windows. All Windows versions (with the exception of Embedded Editions) has this driver binary installed by default. The .inf and .cat files present in the zip file helps Windows identify the device properly and associate the appropriate driver (.sys) to the device

Q. Does this product work with Linux?
A. Yes, this product works with Linux. Please see more details on how to use this product with Linux elsewhere in this document.

Q. Does this product work with Mac OSX?
A. Yes, this product works with Mac OSX. Please see more details on how to use this product with Mac elsewhere in this document.

Q. What is the software that this product work with?
A. This product works with almost any software that has support for standard Modbus. Some examples can be found elsewhere in this document. Different software is written by different developers with different purposes in mind. So you may encounter some software that may not work with this product. But usually, alternatives are available in most if not all cases.

Q. I’m using x language for programming. How do I find out if this language can be used to program and control the GPIO module?
A. Find out if the language of interest supports some kind of APIs/Functions/Components for serial communication. If it does, most likely you should be able to use that language with this module. It may also be possible to find libraries such as libModbus that offers high-level APIs. Using such libraries can speed up development quite a bit.

Q. I need a customized version of this product, can Numato Lab do the customization for me?
A. Yes, we can definitely do customization but there may be minimum order requirements depending on the level of customization required. Please write to [email protected] for a quote.

Q. Where can I buy this product?
A. All Numato products can be ordered directly from our web store http://www.numato.com. We accept major credit cards and Paypal and ship to almost all countries with a few exceptions. We do have distributors in many countries where you can place your order. Please find the current list of distributors at http://numato.com/distrib.