inveo NANO User manual

User manual
NANO Digital Input POE
Soft >= 1.0
Dear Customer!
INVEO s.c.
ul. Rzemieślnicza 21
43-340 Kozy
tel: [phone]
www.inveo.com.pl
[email protected]

Thank you very much for choosing our product. Please carefully read this user
manual as it contains most appropriate ways of dealing with this device, taking into
account the basic principles of safety and maintenance. Please also keep the user
guide that you can use it during subsequent use.
Manufacturer Liabilit !
The manufacturer is not liable for an damage caused b improper or
incompatible use of this device, as well for an faults to the device resulting
from improper use.
User manual NANO Digital Input 26-04-2018
Page 2 of 27

Contents:
1 PRELIMINARY INFORMATION...................................................................................................................4
2 DEVICE DESCRIPTION...................................................................................................................................5
3 WARRANTY AND LIABILITY OF THE MANUFACTURER...................................................................5
4 SAFETY GUIDELINES.....................................................................................................................................6
4.1 POWER SUPPLY...................................................................................................................................................6
4.2 STORAGE, WORKING ENVIRONMENT AND TRANSPORTATION.........................................................................................6
4.3 INSTALLATION AND USE OF THE MODULE.................................................................................................................6
4.4 UTILISATION OF THE MODULE................................................................................................................................6
5 MODULE DESCRIPTION................................................................................................................................7
5.1 GENERAL FEATURES............................................................................................................................................7
5.2 TECHNICAL SPECIFICATION ...................................................................................................................................7
5.3 MODULE INPUT/OUTPUT TERMINAL DESCRIPTION......................................................................................................8
6 MODULE CONFIGURATION.........................................................................................................................9
6.1 CHANGING THE PC SETTING FOR MODULE CONFIGURATION........................................................................................9
6.2 INPUT READOUT................................................................................................................................................11
6.3 ACCESS CONFIGURATION....................................................................................................................................11
6.4 CONFIGURATION OF THE INPUT CHANNEL..............................................................................................................13
6.5 TCP/IP COMMUNICATION..................................................................................................................................13
6.6 TCP FRAMES FORMAT.......................................................................................................................................14
6.7 SNMP CONFIGURATION....................................................................................................................................15
6.8 MANAGING THE MODULE USING WINDOWS COMMAND LINE SOFTWARE.......................................................................16
6.9 MANAGING THE MODULE USING LINUX COMMAND LINE SOFTWARE...........................................................................18
6.10 MANAGING THE MODULE USING MODBUS TCP..............................................................................................19
6.11 COMMUNICATION VIA THE MQTT INVEO PROTOCOL...........................................................................................19
6.12 COMMUNICATION WITH MODULE USING HTTP....................................................................................................20
6.13 COMMUNICATION PROTOCOL DESCRIPTION...........................................................................................................23
6.14 COMMUNICATION WITH MODULE FROM OUTSIDE NETWORK.....................................................................................24
7 CHEC ING THE IP ADDRESS.....................................................................................................................25
8 DHCP..................................................................................................................................................................25
9 RESTORING FACTORY DEFAULTS..........................................................................................................25
10 FIRMWARE UPDATE..................................................................................................................................26
NOTES..................................................................................................................................................................27
User manual NANO Digital Input 26-04-2018
Page 3 of 27

1 Preliminar information
Before using the module please read the user manual carefull and follow the
instructions contained within!
Description of visual symbols used in this user manual:
This symbol is responsible for reviewing the appropriate place in the
user instructions, warnings and important information. Failure to
follow warnings could cause injury or damage to the module.
Important information and guidelines.
Following this guidelines makes the use of the module easier.
Attention: The appearance of the screen shots shown in this manual may differ
slightly from the actual work with the module. The differences may relate to the size
and font type and size of symbols. There are no differences in the content of the
information.
User manual NANO Digital Input 26-04-2018
Page 4 of 27

2 Device description
The NANO Digital Input device is used to read state of the input through LAN network.
The readout can be done using www website, network protocols ( HTTP get, Modbus TCP,
SNMP, MQTT) TCP frame or software supplied by manufacturer.
3 Warrant and liabilit of the manufacturer
The manufacturer provides a 2-year warranty on the module. The manufacturer also
provides post-warranty service for 10 years from the date of the introducing the module
on the market. The warranty covers all defects in material and workmanship.
The manufacturer undertakes to comply with the contract of guarantee, if the following
conditions are met:
All repairs, alterations, extensions and device calibrations are performed by the
manufacturer or authorized service,
supply network installation meets applicable standards in this regard,
device is operated in accordance with the recommendations outlined in this manual,
device is used as intended.
The manufacturer assumes no responsibility for consequences resulting from improper
installation, improper use of the module, not following this manual and the repairs of the
module by individuals without permission.
This device doesn’t contain serviceable parts. The repairs can be done onl b
manufacturers approved repair service.
User manual NANO Digital Input 26-04-2018
Page 5 of 27

4 Safet guidelines
The module has been constructed using modern electronic components, according to the
latest trends in the global electronics.
In particular, much emphasis was placed on ensuring optimum safety and reliability
of control.
The device has a housing with high quality plastic.
4.1 Power supply
The device is designed to supply 10-24V DC and PoE IEEE 802.3af.
4.2 Storage, working environment and transportation
The module has to be used in closed environments free from fumes and corrosive
atmosphere.
Environmental conditions for storage:
Temperature: -30°C to +60°C,
Relative humidity: <90% (unacceptable condensation)
Atmospheric pressure: 700 – 1060hPa.
Environmental conditions for use:
Temperature: +10°C to + °C,
Relative humidity: 30% to 7 %,
Atmospheric pressure: 700 to 1060hPa.
4.3 Installation and use of the module
The module should be used following the guidelines shown in next part of the
user manual.
4.4 Utilisation of the module
When it becomes necessary to liquidate the device (e.g. after the time of use), please
contact the manufacturer or its representative, who are obliged to respond appropriately,
e.g. collecting the module from the user. You can also ask the companies involved
in utilization and / or liquidation of electrical or computer equipment. Under
no circumstances should you place the device along with other garbage.
User manual NANO Digital Input 26-04-2018
Page 6 of 27

5 Module description
.1 General features
Overall view of the module is shown on the picture below.
Module input can work as a pulse counter
There are several ways to communicate with the module:
•using built in WWW server via any web browser,
•windows / linux command line programs.
•MODBUS TCP protocol,
•SNMP protocol,
•HTTP protocol,
•MQTT Inveo protocol,
•User application – communication protocol available for user
NANO Digital Input module is equipped with LED display which displays actual state of
input: ON or OFF.
.2 Technical specification:
Power supply voltage: 10-24VDC or PoE according to PoE IEEE 802.3af
Power consumption: 1. W
Ethernet 10Mbit
7-segment LED display red
Weight: 60g
Distensions: height: 27 mm; width: 74.6 mm; length: 0.1 mm
User manual NANO Digital Input 26-04-2018
Page 7 of 27
NANO Digital Input

Input:
Input type - NO
Counter max value: 4 294 967 296
Max input frequency: 1 Hz
.3 Module input/output terminal description
Module Nano Digital Input has two connection terminals:
•LAN - LAN connection and PoE IEEE 802.3af power supply
•RESET – switch used to enabling DHCP service, checking the current IP address
and restoring the module to the factory settings.
User manual NANO Digital Input 26-04-2018
Page 8 of 27

•INPUT – binary opto-isolated input
•POWER -power connector. An additional power connector used in the event of a
PoE power failure. Supply voltage 12-24VDC.
6 Module configuration
If using the module for the first time it is needed to configure it as shown below
6.1 Changing the PC setting for module configuration.
After connecting the module to the network there is a need to change the PC setting. In
order to do that navigate to: Start->Control Panel->Network connections.
Then right click on the current network connection and click „Properties”.
The configuration screen as shown below should be visible on the screen:
Choose the „Internet Protocol (TCP/IP)” and press „Properties”:
User manual NANO Digital Input 26-04-2018
Page 9 of 27

TCP/IP example settings
Tick the box „Use the following IP address” and enter:
IP address: 192.168.111.1
Subnet mask: 255.255.255.0
The rest of the setting can be left blank.
Press OK to accept the changes.
Start the web browser and enter the following address into address bar:
192.168.111.15. Then select the "NETWORK" menu
The default user name is „admin” with password „admin00”
There are several fields used to configure the module network settings:
MAC Address – MAC address of the module,
User manual NANO Digital Input 26-04-2018
Page 10 of 27

Host Name – NETBIOS host name of the module,
Enable DHCP – When this box is ticked the module will get its address from DHCP
server,
IP Address – IP address of the module – when configured manually,
Gateway – Network gateway,
Subnet Mask – Subnet mask of the module,
Primary DNS, Secondary DNS – DNS servers addresses,
Destination IP – Network address of the server that the module will connect to -
optional,
Destination Port – Network port of the server that the module can connect to.
After changing the configuration press the „Save Config” button.
6.2 Input readout.
The Home tab shows the current status of the input channel and the status of the pulse
counter.
Input State icon show actual state of the input (red – inactive, green – active).
Impulse Counter impulses counted .
Click to reset – reset impulse counter
6.3 Access configuration
Web site used to configure the access to the module is shown below.
These settings allow for changing the access password and to enable/disable particular
services.
User manual NANO Digital Input 26-04-2018
Page 11 of 27

Changing the password
Enter old password into Current Password field.
Enter new password into New Password field and into Re-type Password field then press
„Save Config” to save new passwords.
Enabling/disabling particular service
This function enables/disables different services. By enabling the tick box next to a
service user can turn it on or off.
Module Access configuration
Enable Program Access – access service by a computer program (Windows, Linux)
and TCP / IP protocol operating on port 9761
Enable MODBUS TCP Protocol – enables/disables access using MODBUS TCP
protocol.
Enable SNMP – enables/disables access using SNMP protocol.
Enable Destination client – enables/disables connection service with a remote host
Enable MQTT Inveo -enables/disables service sending data to the INVEO MQTT
cloud
Enable Remote Network Config – enables/disables service of remote change of
network settings by the INVEO DISCOVERER program
Enable TFTP bootloader – enables/disables bootloader mode
Warning:
TFTP Bootloader should be disabled during normal operation. Enabling should
take place only before the software update.
User manual NANO Digital Input 26-04-2018
Page 12 of 27

6.4 Configuration of the input channel.
The module input configuration is carried out in the Channel tab.
The Client Mode field allows you to select the TCP frame format which will be sent to the
address set in the tab Network Destination IP, Destination Port. The TCP frame is sent
every seconds and at each change of the output state.
After making changes, click the Save button.
6. TCP/IP communication
The NANO Digital Input module is able to send an input status to another module or to
the server using the TCP protocol. This means that when a state of the input will change
a message will be sent to another device that can react, for example, by activating a
relay. The IP address of the device to which information is to be sent should be set in the
tab Network Destination IP, Destination Port. The message is sent whenever an input
status changes, and additional every seconds.
User manual NANO Digital Input 26-04-2018
Page 13 of 27

In the Client mode field, you can select the frame format:
•Off -sending frames disabled
•Dest: 1..8 -sending TCP frames in the format #1 (compatible with INVEO
devices)
•Status -sending TCP frames in the format #2
•MAC + Status -sending TCP frames in the format #3
6.6 TCP frames format
Format #1
The frame in the format #1 is sent in binary form.
An example of a TCP frame sent with active input and Dest:5 set
SOF CMD CH F_ID IN !IN CNT0 CNT1 CNT2 CNT3 CRC
0x0F 0x01 0x04 0xFF 0x01 0xFE 0x1E 0x00 0x00 0x00 0x30
An example TCP frame sent with inactive input and Dest:5 set
SOF CMD CH F_ID IN !IN CNT0 CNT1 CNT2 CNT3 CRC
0x0F 0x01 0x04 0xFF 0x00 0xFF 0x1E 0x00 0x00 0x00 0x30
Calculation CRC:
CRC = (BYTE) SUM (SOF+CMD+CH+F_ID+IN+!IN+CNT0+CNT1+CNT2+CNT3)
Format #2
The frame #2 is sent as a string (STRING).
<INPUT STATE>[SPACE]<COUNTER>
•INPUT STATE -value 1 means active input, 0 means inactive input
•COUNTER – the counter state
HEX value STRING
30 20 33 30 0 30
Format #3
The frame #3 is sent as a string (STRING).
<MAC>[SPACE]<INPUT STATE>[SPACE]<COUNTER>
•MAC -network address of the module
•INPUT STATE -value 1 means active input, 0 means inactive input
•COUNTER – the counter state
HEX value STRING
3 34 31 30 4 43 36 3 38 38 32 42 20 30 20 33 30 410EC6 882B 0 30
The TCP frame can be supported with your own software.
An example of using the netcat command for Linux:
User manual NANO Digital Input 26-04-2018
Page 14 of 27

Format #1
Format #2
Format #3
6.7 SNMP configuration
The module is equipped with an SNMP v2c server.
To enable this feature go to Administration tab-> Enable SNMP.
SNMP protocol enables user to retrieve and set the output status and to read state of
inputs and counters.
The MIB file describing the structure can be downloaded the SNMP tab.
User manual NANO Digital Input 26-04-2018
Page 15 of 27

The basic parameters that can be read from the NANO Digital Input module can be found
in the table:
Name Format OID
State of the input channel INTEGER .1.3.6.1.4.1.42814.14.3.3.1.0
State of the counter INTEGER .1.3.6.1.4.1.42814.14.3.4.1.0
The module allows sending TRAP messages when the input channel is changed. The
destination address is entered in the fieldsTrap IP Address 1 and Trap IP Address 2.
6.8 Managing the module using windows command line software
The module can be operated using windows command line software – the software is
delivered with the module.
Syntax is as follows:
TCPRel.exe [Parameters]
User manual NANO Digital Input 26-04-2018
Page 16 of 27

Parameter Description
-in=1 Input number
-host=[HOST] Module IP address
-port=[PORT] Module Port number
-writecounter=0-4228250625 Set counter
-readcounter Read counter
-verb Enabled display of additional info
-stat Displays current state of inputs/outputs
Examples:
Read input state module address 192.168.111.1 listening on port 9761:
TCPRel -in=1 -host=192.168.111.15 -port=9761 -stat
Reset counter :
TCPRel -host=192.168.111.15 -port=9761 -in=1 -writecounter=0
Set counter 1 to value of 123:
TCPRel -host=192.168.111.15 -port=9761 -in=1 -writecounter=123
Read state of counter 1:
TCPRel -host=192.168.111.15 -port=9761 in=1 -readcounter
User manual NANO Digital Input 26-04-2018
Page 17 of 27

6.9 Managing the module using Linux command line software
The module can be configured using Linux command line software – the software is
delivered with the module.
Syntax is as follows:
./TcpRel.exe [Parameters]
Parameter Description
-i 1 Input number
-h [HOST] Module IP address
-p [PORT] Module Port number
-w 0-4228250625 Set counter
-r Read counter
-l Enabled display of additional info
Examples:
Read input state module address 192.168.111.1 listening on port 9761:
./tcprel -i 1 -h 192.168.111.15 -p 9761 -l
Reset counter :
./tcprel -h 192.168.111.15 -p 9761 -i 1 -w 0
Set counter 1 to value of 123:
./tcprel -h 192.168.111.15 -p 9761 -i 1 -w 123
Read state of counter 1:
./tcprel -h 192.168.111.15 -p 9761 i 1 -r
User manual NANO Digital Input 26-04-2018
Page 18 of 27

6.10 Managing the module using MODBUS TCP
MODBUS TCP protocol is listening on port 02.
The module supports following functions of MODBUS protocol:
- 0x01 Read Coils,
- 0x03 Read Holding Register,
- 0x0 Write Single Coil,
- 0x06 Write Single Register,
- 0x0F Write Multiple Coils,
- 0x10 Write Multiple Registers.
The registers description is shown in tables 2 and 3.
MODBUS TCP - Holding Registers.
Register Name Mode:
R-read
W-write
Description
4003 Counter1H R/W Counter 1 – Higher byte of counter
4004 Counter1L R/W Counter 1 – Lower byte of counter
MODBUS TCP - Coils
Register Name Mode:
R- read
W-write
Description
1000 On1 R Input 1 state
6.11 Communication via the MQTT Inveo protocol.
If the MQTT Inveo service has been enabled in the Administration menu, the module
sends to mqtt.inveo.com.pl server the state of the input every 1 minute and additionally
at each change.
Application configuration - MQTT client:
Address: mqtt.inveo.com.pl
Port: 1883
User name: nanouser
User password: nanouser
Topic: /nanoT/<MAC>
User manual NANO Digital Input 26-04-2018
Page 19 of 27

After click [Show Info] the settings for the MQTT client will be displayed:
There are many applications on Android, IOS or PC that can display data sent by the
module.
6.12 Communication with module using HTTP.
NANO modules can be controlled using HTTP get.
•status.xml -resource containing basic information about the module
To read the current state of the module, you can refer to the resource in the web
browser- http://192.168.111.1 /stat.php
XML file consist all of the information:
<response>
<prod_name>Nano-0-1</prod_name>
<sv>1.11</sv>
<mac>54:10:EC:65:88:2B</mac>
<out>00000000</out>
<on>00000000</on>
< n>00000000</ n>
<counter1>35</counter1>
<temp1>0.0</temp1>
</response>
User manual NANO Digital Input 26-04-2018
Page 20 of 27